Libraries: Move to Userland/Libraries/

Userland/Libraries/LibCoreDump/Reader.cpp

@@ -0,0 +1,215 @@
+/*
+ * Copyright (c) 2020, Itamar S. <itamar8910@gmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <AK/JsonObject.h>
+#include <AK/JsonValue.h>
+#include <LibCoreDump/Backtrace.h>
+#include <LibCoreDump/Reader.h>
+#include <string.h>
+#include <sys/stat.h>
+
+namespace CoreDump {
+
+OwnPtr<Reader> Reader::create(const String& path)
+{
+    auto file_or_error = MappedFile::map(path);
+    if (file_or_error.is_error())
+        return {};
+    return adopt_own(*new Reader(file_or_error.release_value()));
+}
+
+Reader::Reader(NonnullRefPtr<MappedFile> coredump_file)
+    : m_coredump_file(move(coredump_file))
+    , m_coredump_image(m_coredump_file->bytes())
+{
+    size_t index = 0;
+    m_coredump_image.for_each_program_header([this, &index](auto pheader) {
+        if (pheader.type() == PT_NOTE) {
+            m_notes_segment_index = index;
+            return IterationDecision::Break;
+        }
+        ++index;
+        return IterationDecision::Continue;
+    });
+    ASSERT(m_notes_segment_index != -1);
+}
+
+Reader::~Reader()
+{
+}
+
+Reader::NotesEntryIterator::NotesEntryIterator(const u8* notes_data)
+    : m_current((const ELF::Core::NotesEntry*)notes_data)
+    , start(notes_data)
+{
+}
+
+ELF::Core::NotesEntryHeader::Type Reader::NotesEntryIterator::type() const
+{
+    ASSERT(m_current->header.type == ELF::Core::NotesEntryHeader::Type::ProcessInfo
+        || m_current->header.type == ELF::Core::NotesEntryHeader::Type::MemoryRegionInfo
+        || m_current->header.type == ELF::Core::NotesEntryHeader::Type::ThreadInfo
+        || m_current->header.type == ELF::Core::NotesEntryHeader::Type::Metadata
+        || m_current->header.type == ELF::Core::NotesEntryHeader::Type::Null);
+    return m_current->header.type;
+}
+
+const ELF::Core::NotesEntry* Reader::NotesEntryIterator::current() const
+{
+    return m_current;
+}
+
+void Reader::NotesEntryIterator::next()
+{
+    ASSERT(!at_end());
+    switch (type()) {
+    case ELF::Core::NotesEntryHeader::Type::ProcessInfo: {
+        const auto* current = reinterpret_cast<const ELF::Core::ProcessInfo*>(m_current);
+        m_current = reinterpret_cast<const ELF::Core::NotesEntry*>(current->executable_path + strlen(current->executable_path) + 1);
+        break;
+    }
+    case ELF::Core::NotesEntryHeader::Type::ThreadInfo: {
+        const auto* current = reinterpret_cast<const ELF::Core::ThreadInfo*>(m_current);
+        m_current = reinterpret_cast<const ELF::Core::NotesEntry*>(current + 1);
+        break;
+    }
+    case ELF::Core::NotesEntryHeader::Type::MemoryRegionInfo: {
+        const auto* current = reinterpret_cast<const ELF::Core::MemoryRegionInfo*>(m_current);
+        m_current = reinterpret_cast<const ELF::Core::NotesEntry*>(current->region_name + strlen(current->region_name) + 1);
+        break;
+    }
+    case ELF::Core::NotesEntryHeader::Type::Metadata: {
+        const auto* current = reinterpret_cast<const ELF::Core::Metadata*>(m_current);
+        m_current = reinterpret_cast<const ELF::Core::NotesEntry*>(current->json_data + strlen(current->json_data) + 1);
+        break;
+    }
+    default:
+        ASSERT_NOT_REACHED();
+    }
+}
+
+bool Reader::NotesEntryIterator::at_end() const
+{
+    return type() == ELF::Core::NotesEntryHeader::Type::Null;
+}
+
+Optional<uint32_t> Reader::peek_memory(FlatPtr address) const
+{
+    const auto* region = region_containing(address);
+    if (!region)
+        return {};
+
+    FlatPtr offset_in_region = address - region->region_start;
+    const char* region_data = image().program_header(region->program_header_index).raw_data();
+    return *(const uint32_t*)(&region_data[offset_in_region]);
+}
+
+const ELF::Core::ProcessInfo& Reader::process_info() const
+{
+    for (NotesEntryIterator it((const u8*)m_coredump_image.program_header(m_notes_segment_index).raw_data()); !it.at_end(); it.next()) {
+        if (it.type() != ELF::Core::NotesEntryHeader::Type::ProcessInfo)
+            continue;
+        return reinterpret_cast<const ELF::Core::ProcessInfo&>(*it.current());
+    }
+    ASSERT_NOT_REACHED();
+}
+
+const ELF::Core::MemoryRegionInfo* Reader::region_containing(FlatPtr address) const
+{
+    const ELF::Core::MemoryRegionInfo* ret = nullptr;
+    for_each_memory_region_info([&ret, address](const ELF::Core::MemoryRegionInfo& region_info) {
+        if (region_info.region_start <= address && region_info.region_end >= address) {
+            ret = &region_info;
+            return IterationDecision::Break;
+        }
+        return IterationDecision::Continue;
+    });
+    return ret;
+}
+
+const Backtrace Reader::backtrace() const
+{
+    return Backtrace(*this);
+}
+
+const HashMap<String, String> Reader::metadata() const
+{
+    const ELF::Core::Metadata* metadata_notes_entry = nullptr;
+    for (NotesEntryIterator it((const u8*)m_coredump_image.program_header(m_notes_segment_index).raw_data()); !it.at_end(); it.next()) {
+        if (it.type() != ELF::Core::NotesEntryHeader::Type::Metadata)
+            continue;
+        metadata_notes_entry = reinterpret_cast<const ELF::Core::Metadata*>(it.current());
+        break;
+    }
+    if (!metadata_notes_entry)
+        return {};
+    auto metadata_json_value = JsonValue::from_string(metadata_notes_entry->json_data);
+    if (!metadata_json_value.has_value())
+        return {};
+    if (!metadata_json_value.value().is_object())
+        return {};
+    HashMap<String, String> metadata;
+    metadata_json_value.value().as_object().for_each_member([&](auto& key, auto& value) {
+        metadata.set(key, value.as_string_or({}));
+    });
+    return metadata;
+}
+
+struct LibraryData {
+    String name;
+    OwnPtr<MappedFile> file;
+    ELF::Image lib_elf;
+};
+
+const Reader::LibraryData* Reader::library_containing(FlatPtr address) const
+{
+    static HashMap<String, OwnPtr<LibraryData>> cached_libs;
+    auto* region = region_containing(address);
+    if (!region)
+        return {};
+
+    auto name = region->object_name();
+
+    String path;
+    if (name.contains(".so"))
+        path = String::format("/usr/lib/%s", name.characters());
+    else {
+        path = name;
+    }
+
+    if (!cached_libs.contains(path)) {
+        auto file_or_error = MappedFile::map(path);
+        if (file_or_error.is_error())
+            return {};
+        auto image = ELF::Image(file_or_error.value()->bytes());
+        cached_libs.set(path, make<LibraryData>(name, region->region_start, file_or_error.release_value(), move(image)));
+    }
+
+    auto lib_data = cached_libs.get(path).value();
+    return lib_data;
+}
+
+}