mirror of
https://github.com/RGBCube/serenity
synced 2025-10-31 03:02:45 +00:00
7413a7c509
This is a new NotesEntry type which will allow applications to embed arbitrary metadata in crashdumps (stored as a JSON string). It will be used to store an assertion message, for example.
111 lines
3.8 KiB
C++
111 lines
3.8 KiB
C++
/*
|
|
* 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.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/HashMap.h>
|
|
#include <AK/MappedFile.h>
|
|
#include <AK/Noncopyable.h>
|
|
#include <AK/OwnPtr.h>
|
|
#include <LibCoreDump/Forward.h>
|
|
#include <LibELF/CoreDump.h>
|
|
#include <LibELF/Image.h>
|
|
|
|
namespace CoreDump {
|
|
|
|
class Reader {
|
|
AK_MAKE_NONCOPYABLE(Reader);
|
|
|
|
public:
|
|
static OwnPtr<Reader> create(const String&);
|
|
~Reader();
|
|
|
|
Reader(OwnPtr<MappedFile>&&);
|
|
|
|
const ELF::Core::ProcessInfo& process_info() const;
|
|
|
|
template<typename Func>
|
|
void for_each_memory_region_info(Func func) const;
|
|
|
|
template<typename Func>
|
|
void for_each_thread_info(Func func) const;
|
|
|
|
const ELF::Image& image() const { return m_coredump_image; }
|
|
|
|
Optional<uint32_t> peek_memory(FlatPtr address) const;
|
|
const ELF::Core::MemoryRegionInfo* region_containing(FlatPtr address) const;
|
|
|
|
const Backtrace backtrace() const;
|
|
const HashMap<String, String> metadata() const;
|
|
|
|
private:
|
|
class NotesEntryIterator {
|
|
public:
|
|
NotesEntryIterator(const u8* notes_data);
|
|
|
|
ELF::Core::NotesEntryHeader::Type type() const;
|
|
const ELF::Core::NotesEntry* current() const;
|
|
|
|
void next();
|
|
bool at_end() const;
|
|
|
|
private:
|
|
const ELF::Core::NotesEntry* m_current { nullptr };
|
|
const u8* start { nullptr };
|
|
};
|
|
|
|
OwnPtr<MappedFile> m_coredump_file;
|
|
ELF::Image m_coredump_image;
|
|
ssize_t m_notes_segment_index { -1 };
|
|
};
|
|
|
|
template<typename Func>
|
|
void Reader::for_each_memory_region_info(Func func) 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::MemoryRegionInfo)
|
|
continue;
|
|
auto& memory_region_info = reinterpret_cast<const ELF::Core::MemoryRegionInfo&>(*it.current());
|
|
IterationDecision decision = func(memory_region_info);
|
|
if (decision == IterationDecision::Break)
|
|
return;
|
|
}
|
|
}
|
|
|
|
template<typename Func>
|
|
void Reader::for_each_thread_info(Func func) 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::ThreadInfo)
|
|
continue;
|
|
auto& thread_info = reinterpret_cast<const ELF::Core::ThreadInfo&>(*it.current());
|
|
IterationDecision decision = func(thread_info);
|
|
if (decision == IterationDecision::Break)
|
|
return;
|
|
}
|
|
}
|
|
|
|
}
|