Minidump writer for Linux. More...

#include <MinidumpFileBuilder.h>

Public Member Functions
	MinidumpFileBuilder (lldb::FileUP &&core_file, const lldb::ProcessSP &process_sp, lldb_private::SaveCoreOptions &save_core_options)
	MinidumpFileBuilder (const MinidumpFileBuilder &)=delete
MinidumpFileBuilder &	operator= (const MinidumpFileBuilder &)=delete
	MinidumpFileBuilder (MinidumpFileBuilder &&other)=default
MinidumpFileBuilder &	operator= (MinidumpFileBuilder &&other)=default
	~MinidumpFileBuilder ()=default
lldb_private::Status	AddHeaderAndCalculateDirectories ()
lldb_private::Status	AddSystemInfo ()
lldb_private::Status	AddModuleList ()
lldb_private::Status	AddThreadList ()
lldb_private::Status	AddExceptions ()
lldb_private::Status	AddMemoryList ()
lldb_private::Status	AddMiscInfo ()
lldb_private::Status	AddLinuxFileStreams ()
lldb_private::Status	DumpFile ()
void	DeleteFile () noexcept

Private Member Functions
lldb_private::Status	AddLLDBGeneratedStream ()
lldb_private::Status	AddData (const void *data, uint64_t size)
lldb_private::Status	AddMemoryList_64 (std::vector< lldb_private::CoreFileMemoryRange > &ranges, lldb_private::Progress &progress)
lldb_private::Status	AddMemoryList_32 (std::vector< lldb_private::CoreFileMemoryRange > &ranges, lldb_private::Progress &progress)
lldb_private::Status	FixThreadStacks ()
lldb_private::Status	FlushBufferToDisk ()
lldb_private::Status	DumpHeader () const
lldb_private::Status	DumpDirectories () const
lldb_private::Status	AddDirectory (llvm::minidump::StreamType type, uint64_t stream_size)
lldb::offset_t	GetCurrentDataEndOffset () const
lldb_private::Status	ReadWriteMemoryInChunks (lldb_private::DataBufferHeap &data_buffer, const lldb_private::CoreFileMemoryRange &range, uint64_t &bytes_read)

Private Attributes
std::vector< llvm::minidump::Directory >	m_directories
std::unordered_map< lldb::addr_t, llvm::minidump::Thread >	m_thread_by_range_end
lldb_private::DataBufferHeap	m_data
lldb::ProcessSP	m_process_sp
size_t	m_expected_directories = 0
uint64_t	m_saved_data_size = 0
lldb::offset_t	m_thread_list_start = 0
std::unordered_map< lldb::tid_t, llvm::minidump::LocationDescriptor >	m_tid_to_reg_ctx
lldb::FileUP	m_core_file
lldb_private::SaveCoreOptions	m_save_core_options

Static Private Attributes
static constexpr uint64_t	MAX_WRITE_CHUNK_SIZE = (1024 * 1024 * 128)
static constexpr size_t	HEADER_SIZE = sizeof(llvm::minidump::Header)
static constexpr size_t	DIRECTORY_SIZE = sizeof(llvm::minidump::Directory)

Detailed Description

Minidump writer for Linux.

This class provides a Minidump writer that is able to snapshot the current process state.

Minidumps are a Microsoft format for dumping process state. This class constructs the minidump on disk starting with Headers and Directories are written at the top of the file, with the amount of bytes being precalculates before any writing takes place Then the smaller data sections are written SystemInfo, ModuleList, Misc Info. Then Threads are emitted, threads are the first section that needs to be 'fixed up' this happens when later we emit the memory stream, we identify if that stream is the expected stack, and if so we update the stack with the current RVA. Lastly the Memory lists are added. For Memory List, this will contain everything that can fit within 4.2gb. MemoryList has it's descriptors written at the end so it cannot be allowed to overflow.

Memory64List is a special case where it has to be begin before 4.2gb but can expand forever The difference in Memory64List is there are no RVA's and all the addresses are figured out by starting at the base RVA, and adding the antecedent memory sections.

Because Memory64List can be arbitrarily large, this class has to write chunks to disk this means we have to precalculate the descriptors and write them first, and if we encounter any error, or are unable to read the same number of bytes we have to go back and update them on disk.

And as the last step, after all the directories have been added, we go back to the top of the file to fill in the header and the redirectory sections that we preallocated.

Definition at line 77 of file MinidumpFileBuilder.h.

Constructor & Destructor Documentation

◆ MinidumpFileBuilder() [1/3]

MinidumpFileBuilder::MinidumpFileBuilder	(	lldb::FileUP &&	core_file,
		const lldb::ProcessSP &	process_sp,
		lldb_private::SaveCoreOptions &	save_core_options )

inline

Definition at line 79 of file MinidumpFileBuilder.h.

References m_core_file, m_process_sp, and m_save_core_options.

Referenced by MinidumpFileBuilder(), MinidumpFileBuilder(), operator=(), and operator=().

◆ MinidumpFileBuilder() [2/3]

MinidumpFileBuilder::MinidumpFileBuilder ( const MinidumpFileBuilder & )

delete

References MinidumpFileBuilder().

◆ MinidumpFileBuilder() [3/3]

MinidumpFileBuilder::MinidumpFileBuilder ( MinidumpFileBuilder && other )

default

References MinidumpFileBuilder().

◆ ~MinidumpFileBuilder()

MinidumpFileBuilder::~MinidumpFileBuilder ( )

default

References AddData(), AddDirectory(), AddLLDBGeneratedStream(), AddMemoryList_32(), AddMemoryList_64(), DumpDirectories(), DumpHeader(), FixThreadStacks(), FlushBufferToDisk(), GetCurrentDataEndOffset(), and ReadWriteMemoryInChunks().

Member Function Documentation

◆ AddData()

Status MinidumpFileBuilder::AddData	(	const void *	data,
		uint64_t	size )

private

Definition at line 1222 of file MinidumpFileBuilder.cpp.

References FlushBufferToDisk(), m_data, MAX_WRITE_CHUNK_SIZE, and lldb_private::Status.

Referenced by ReadWriteMemoryInChunks(), and ~MinidumpFileBuilder().

◆ AddDirectory()

Status MinidumpFileBuilder::AddDirectory	(	llvm::minidump::StreamType	type,
		uint64_t	stream_size )

private

Definition at line 100 of file MinidumpFileBuilder.cpp.

References error(), lldb_private::Status::FromErrorStringWithFormat(), GetCurrentDataEndOffset(), m_directories, m_expected_directories, and UINT32_MAX.

Referenced by AddExceptions(), AddLinuxFileStreams(), AddLLDBGeneratedStream(), AddMemoryList_32(), AddMemoryList_64(), AddMiscInfo(), AddModuleList(), AddSystemInfo(), AddThreadList(), and ~MinidumpFileBuilder().

◆ AddExceptions()

Status MinidumpFileBuilder::AddExceptions ( )

Definition at line 700 of file MinidumpFileBuilder.cpp.

References AddDirectory(), error(), lldb::eStopReasonInvalid, lldb_private::Exception, m_data, m_process_sp, m_save_core_options, and m_tid_to_reg_ctx.

Referenced by ObjectFileMinidump::SaveCore().

◆ AddHeaderAndCalculateDirectories()

Status MinidumpFileBuilder::AddHeaderAndCalculateDirectories ( )

Definition at line 52 of file MinidumpFileBuilder.cpp.

References AddLLDBGeneratedStream(), error(), lldb::eStopReasonInvalid, lldb_private::Status::FromErrorStringWithFormat(), lldb_private::Target::GetArchitecture(), lldb_private::ArchSpec::GetTriple(), HEADER_SIZE, m_core_file, m_expected_directories, m_process_sp, m_save_core_options, and m_saved_data_size.

Referenced by ObjectFileMinidump::SaveCore().

◆ AddLinuxFileStreams()

Status MinidumpFileBuilder::AddLinuxFileStreams ( )

Definition at line 788 of file MinidumpFileBuilder.cpp.

References AddDirectory(), error(), getFileStreamHelper(), lldb_private::ProcessInfo::GetProcessID(), m_data, m_process_sp, and lldb_private::ProcessInfo::ProcessIDIsValid().

Referenced by ObjectFileMinidump::SaveCore().

◆ AddLLDBGeneratedStream()

Status MinidumpFileBuilder::AddLLDBGeneratedStream ( )

private

Definition at line 133 of file MinidumpFileBuilder.cpp.

References AddDirectory(), and error().

Referenced by AddHeaderAndCalculateDirectories(), and ~MinidumpFileBuilder().

◆ AddMemoryList()

Status MinidumpFileBuilder::AddMemoryList ( )

Definition at line 840 of file MinidumpFileBuilder.cpp.

References AddMemoryList_32(), AddMemoryList_64(), error(), FixThreadStacks(), lldb_private::Status::FromError(), lldb_private::Status::FromErrorStringWithFormat(), GetCurrentDataEndOffset(), lldb_private::RangeDataVector< B, S, T, N, Compare >::GetSize(), lldb_private::RangeDataVector< B, S, T, N, Compare >::IsEmpty(), m_save_core_options, m_thread_by_range_end, and UINT32_MAX.

Referenced by ObjectFileMinidump::SaveCore().

◆ AddMemoryList_32()

Status MinidumpFileBuilder::AddMemoryList_32	(	std::vector< lldb_private::CoreFileMemoryRange > &	ranges,
		lldb_private::Progress &	progress )

private

Definition at line 1051 of file MinidumpFileBuilder.cpp.

References AddDirectory(), error(), GetCurrentDataEndOffset(), GetLargestRangeSize(), lldb_private::GetLog(), lldb_private::Progress::Increment(), LLDB_LOGF, m_data, m_thread_by_range_end, MAX_WRITE_CHUNK_SIZE, lldb_private::Object, and ReadWriteMemoryInChunks().

Referenced by AddMemoryList(), and ~MinidumpFileBuilder().

◆ AddMemoryList_64()

Status MinidumpFileBuilder::AddMemoryList_64	(	std::vector< lldb_private::CoreFileMemoryRange > &	ranges,
		lldb_private::Progress &	progress )

private

Definition at line 1122 of file MinidumpFileBuilder.cpp.

References AddDirectory(), error(), FlushBufferToDisk(), lldb_private::Status::FromErrorStringWithFormat(), GetCurrentDataEndOffset(), GetLargestRangeSize(), lldb_private::GetLog(), lldb_private::Progress::Increment(), LLDB_LOGF, m_core_file, m_data, MAX_WRITE_CHUNK_SIZE, lldb_private::Object, and ReadWriteMemoryInChunks().

Referenced by AddMemoryList(), and ~MinidumpFileBuilder().

◆ AddMiscInfo()

lldb_private::Status MinidumpFileBuilder::AddMiscInfo ( )

Definition at line 750 of file MinidumpFileBuilder.cpp.

References AddDirectory(), error(), lldb_private::minidump::MinidumpMiscInfo::flags1, lldb_private::ProcessInfo::GetProcessID(), m_data, m_process_sp, lldb_private::minidump::MinidumpMiscInfo::process_id, lldb_private::minidump::ProcessID, lldb_private::ProcessInfo::ProcessIDIsValid(), and lldb_private::minidump::MinidumpMiscInfo::size.

Referenced by ObjectFileMinidump::SaveCore().

◆ AddModuleList()

Status MinidumpFileBuilder::AddModuleList ( )

◆ AddSystemInfo()

Status MinidumpFileBuilder::AddSystemInfo ( )

Definition at line 139 of file MinidumpFileBuilder.cpp.

References AddDirectory(), error(), lldb_private::Status::FromErrorString(), lldb_private::Status::FromErrorStringWithFormat(), GetCurrentDataEndOffset(), m_data, m_process_sp, and WriteString().

Referenced by ObjectFileMinidump::SaveCore().

◆ AddThreadList()

Status MinidumpFileBuilder::AddThreadList ( )

Definition at line 614 of file MinidumpFileBuilder.cpp.

References AddDirectory(), lldb_private::DataBufferHeap::AppendData(), ArchThreadContexts::data(), error(), lldb::eStateSuspended, lldb_private::Status::FromErrorString(), lldb_private::Status::FromErrorStringWithFormat(), lldb_private::Target::GetArchitecture(), lldb_private::WritableDataBuffer::GetBytes(), lldb_private::DataBufferHeap::GetByteSize(), GetCurrentDataEndOffset(), lldb_private::GetLog(), lldb_private::ArchSpec::GetMachine(), lldb_private::MemoryRegionInfo::GetRange(), lldb_private::Range< B, S >::GetRangeEnd(), lldb_private::RegisterContext::GetSP(), lldb_private::ArchSpec::GetTriple(), LLDB_LOGF, m_data, m_process_sp, m_save_core_options, m_thread_by_range_end, m_thread_list_start, m_tid_to_reg_ctx, lldb_private::Object, ArchThreadContexts::prepareRegisterContext(), ArchThreadContexts::size(), sp, and lldb_private::Status.

Referenced by ObjectFileMinidump::SaveCore().

◆ DeleteFile()

void MinidumpFileBuilder::DeleteFile ( )

noexcept

Definition at line 1281 of file MinidumpFileBuilder.cpp.

References error(), lldb_private::GetLog(), LLDB_LOGF, m_core_file, and lldb_private::Object.

◆ DumpDirectories()

Status MinidumpFileBuilder::DumpDirectories ( ) const

private

Definition at line 947 of file MinidumpFileBuilder.cpp.

References DIRECTORY_SIZE, error(), lldb_private::Status::FromErrorStringWithFormat(), HEADER_SIZE, m_core_file, and m_directories.

Referenced by DumpFile(), and ~MinidumpFileBuilder().

◆ DumpFile()

Status MinidumpFileBuilder::DumpFile ( )

Definition at line 1261 of file MinidumpFileBuilder.cpp.

References DumpDirectories(), DumpHeader(), error(), and FlushBufferToDisk().

Referenced by ObjectFileMinidump::SaveCore().

◆ DumpHeader()

Status MinidumpFileBuilder::DumpHeader ( ) const

private

Definition at line 908 of file MinidumpFileBuilder.cpp.

References error(), lldb_private::Status::FromErrorStringWithFormat(), HEADER_SIZE, m_core_file, and m_directories.

Referenced by DumpFile(), and ~MinidumpFileBuilder().

◆ FixThreadStacks()

Status MinidumpFileBuilder::FixThreadStacks ( )

private

Definition at line 591 of file MinidumpFileBuilder.cpp.

References error(), FlushBufferToDisk(), lldb_private::Status::FromErrorStringWithFormat(), m_core_file, m_thread_by_range_end, and m_thread_list_start.

Referenced by AddMemoryList(), and ~MinidumpFileBuilder().

◆ FlushBufferToDisk()

Status MinidumpFileBuilder::FlushBufferToDisk ( )

private

Definition at line 1231 of file MinidumpFileBuilder.cpp.

References error(), lldb_private::Status::FromErrorStringWithFormat(), m_core_file, m_data, and m_saved_data_size.

Referenced by AddData(), AddMemoryList_64(), DumpFile(), FixThreadStacks(), and ~MinidumpFileBuilder().

◆ GetCurrentDataEndOffset()

offset_t MinidumpFileBuilder::GetCurrentDataEndOffset ( ) const

private

Definition at line 943 of file MinidumpFileBuilder.cpp.

References m_data, and m_saved_data_size.

Referenced by AddDirectory(), AddMemoryList(), AddMemoryList_32(), AddMemoryList_64(), AddModuleList(), AddSystemInfo(), AddThreadList(), and ~MinidumpFileBuilder().

◆ operator=() [1/2]

MinidumpFileBuilder & MinidumpFileBuilder::operator= ( const MinidumpFileBuilder & )

delete

References MinidumpFileBuilder().

◆ operator=() [2/2]

MinidumpFileBuilder & MinidumpFileBuilder::operator= ( MinidumpFileBuilder && other )

default

References MinidumpFileBuilder().

◆ ReadWriteMemoryInChunks()

Status MinidumpFileBuilder::ReadWriteMemoryInChunks	(	lldb_private::DataBufferHeap &	data_buffer,
		const lldb_private::CoreFileMemoryRange &	range,
		uint64_t &	bytes_read )

private

Definition at line 966 of file MinidumpFileBuilder.cpp.

References AddData(), lldb_private::Continue, error(), lldb_private::Status::Fail(), lldb_private::Status::FromErrorStringWithFormat(), lldb_private::WritableDataBuffer::GetBytes(), lldb_private::DataBufferHeap::GetByteSize(), lldb_private::GetLog(), LLDB_LOGF, m_process_sp, lldb_private::Object, lldb_private::CoreFileMemoryRange::range, and lldb_private::Stop.

Referenced by AddMemoryList_32(), AddMemoryList_64(), and ~MinidumpFileBuilder().

Member Data Documentation

◆ DIRECTORY_SIZE

size_t MinidumpFileBuilder::DIRECTORY_SIZE = sizeof(llvm::minidump::Directory)

staticconstexprprivate

Definition at line 177 of file MinidumpFileBuilder.h.

Referenced by DumpDirectories().

◆ HEADER_SIZE

size_t MinidumpFileBuilder::HEADER_SIZE = sizeof(llvm::minidump::Header)

staticconstexprprivate

Definition at line 176 of file MinidumpFileBuilder.h.

Referenced by AddHeaderAndCalculateDirectories(), DumpDirectories(), and DumpHeader().

◆ m_core_file

lldb::FileUP MinidumpFileBuilder::m_core_file

private

Definition at line 184 of file MinidumpFileBuilder.h.

Referenced by AddHeaderAndCalculateDirectories(), AddMemoryList_64(), DeleteFile(), DumpDirectories(), DumpHeader(), FixThreadStacks(), FlushBufferToDisk(), and MinidumpFileBuilder().

◆ m_data

lldb_private::DataBufferHeap MinidumpFileBuilder::m_data

private

Definition at line 164 of file MinidumpFileBuilder.h.

Referenced by AddData(), AddExceptions(), AddLinuxFileStreams(), AddMemoryList_32(), AddMemoryList_64(), AddMiscInfo(), AddModuleList(), AddSystemInfo(), AddThreadList(), FlushBufferToDisk(), and GetCurrentDataEndOffset().

◆ m_directories

std::vector<llvm::minidump::Directory> MinidumpFileBuilder::m_directories

private

Definition at line 154 of file MinidumpFileBuilder.h.

Referenced by AddDirectory(), DumpDirectories(), and DumpHeader().

◆ m_expected_directories

size_t MinidumpFileBuilder::m_expected_directories = 0

private

Definition at line 167 of file MinidumpFileBuilder.h.

Referenced by AddDirectory(), and AddHeaderAndCalculateDirectories().

◆ m_process_sp

lldb::ProcessSP MinidumpFileBuilder::m_process_sp

private

Definition at line 165 of file MinidumpFileBuilder.h.

Referenced by AddExceptions(), AddHeaderAndCalculateDirectories(), AddLinuxFileStreams(), AddMiscInfo(), AddModuleList(), AddSystemInfo(), AddThreadList(), MinidumpFileBuilder(), and ReadWriteMemoryInChunks().

◆ m_save_core_options

lldb_private::SaveCoreOptions MinidumpFileBuilder::m_save_core_options

private

Definition at line 185 of file MinidumpFileBuilder.h.

Referenced by AddExceptions(), AddHeaderAndCalculateDirectories(), AddMemoryList(), AddThreadList(), and MinidumpFileBuilder().

◆ m_saved_data_size

uint64_t MinidumpFileBuilder::m_saved_data_size = 0

private

Definition at line 168 of file MinidumpFileBuilder.h.

Referenced by AddHeaderAndCalculateDirectories(), FlushBufferToDisk(), and GetCurrentDataEndOffset().

◆ m_thread_by_range_end

std::unordered_map<lldb::addr_t, llvm::minidump::Thread> MinidumpFileBuilder::m_thread_by_range_end

private

Definition at line 161 of file MinidumpFileBuilder.h.

Referenced by AddMemoryList(), AddMemoryList_32(), AddThreadList(), and FixThreadStacks().

◆ m_thread_list_start

lldb::offset_t MinidumpFileBuilder::m_thread_list_start = 0

private

Definition at line 169 of file MinidumpFileBuilder.h.

Referenced by AddThreadList(), and FixThreadStacks().

◆ m_tid_to_reg_ctx

std::unordered_map<lldb::tid_t, llvm::minidump::LocationDescriptor> MinidumpFileBuilder::m_tid_to_reg_ctx

private

Definition at line 183 of file MinidumpFileBuilder.h.

Referenced by AddExceptions(), and AddThreadList().

◆ MAX_WRITE_CHUNK_SIZE

uint64_t MinidumpFileBuilder::MAX_WRITE_CHUNK_SIZE = (1024 * 1024 * 128)

staticconstexprprivate

Definition at line 174 of file MinidumpFileBuilder.h.

Referenced by AddData(), AddMemoryList_32(), and AddMemoryList_64().

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MinidumpFileBuilder() [1/3]

◆ MinidumpFileBuilder() [2/3]

◆ MinidumpFileBuilder() [3/3]

◆ ~MinidumpFileBuilder()

Member Function Documentation

◆ AddData()

◆ AddDirectory()

◆ AddExceptions()

◆ AddHeaderAndCalculateDirectories()

◆ AddLinuxFileStreams()

◆ AddLLDBGeneratedStream()

◆ AddMemoryList()

◆ AddMemoryList_32()

◆ AddMemoryList_64()

◆ AddMiscInfo()

◆ AddModuleList()

◆ AddSystemInfo()

◆ AddThreadList()

◆ DeleteFile()

◆ DumpDirectories()

◆ DumpFile()

◆ DumpHeader()

◆ FixThreadStacks()

◆ FlushBufferToDisk()

◆ GetCurrentDataEndOffset()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ReadWriteMemoryInChunks()

Member Data Documentation

◆ DIRECTORY_SIZE

◆ HEADER_SIZE

◆ m_core_file

◆ m_data

◆ m_directories

◆ m_expected_directories

◆ m_process_sp

◆ m_save_core_options

◆ m_saved_data_size

◆ m_thread_by_range_end

◆ m_thread_list_start

◆ m_tid_to_reg_ctx

◆ MAX_WRITE_CHUNK_SIZE