mirror of
https://github.com/RGBCube/serenity
synced 2025-05-17 23:55:07 +00:00
9f656b6fa9
Most coredumps contain large amounts of consecutive null bytes and as such are a prime candidate for compression. This commit makes CrashDaemon compress files once the kernel finishes emitting them, as well as adds the functionality needed in LibCoreDump to then parse them.
128 lines
4.4 KiB
C++
128 lines
4.4 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 <LibELF/CoreDump.h>
|
|
#include <LibELF/Image.h>
|
|
|
|
namespace CoreDump {
|
|
|
|
class Reader {
|
|
AK_MAKE_NONCOPYABLE(Reader);
|
|
AK_MAKE_NONMOVABLE(Reader);
|
|
|
|
public:
|
|
static OwnPtr<Reader> create(const String&);
|
|
~Reader();
|
|
|
|
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;
|
|
|
|
struct LibraryData {
|
|
String name;
|
|
FlatPtr base_address { 0 };
|
|
NonnullRefPtr<MappedFile> file;
|
|
ELF::Image lib_elf;
|
|
};
|
|
const LibraryData* library_containing(FlatPtr address) const;
|
|
|
|
int process_pid() const;
|
|
u8 process_termination_signal() const;
|
|
String process_executable_path() const;
|
|
Vector<String> process_arguments() const;
|
|
Vector<String> process_environment() const;
|
|
HashMap<String, String> metadata() const;
|
|
|
|
private:
|
|
Reader(ReadonlyBytes);
|
|
|
|
static ByteBuffer decompress_coredump(const ReadonlyBytes&);
|
|
|
|
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 };
|
|
};
|
|
|
|
// Private as we don't need anyone poking around in this JsonObject
|
|
// manually - we know very well what should be included and expose that
|
|
// as getters with the appropriate (non-JsonValue) types.
|
|
const JsonObject process_info() const;
|
|
|
|
ByteBuffer m_coredump_buffer;
|
|
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;
|
|
}
|
|
}
|
|
|
|
}
|