Crashpad
Public Member Functions | Protected Member Functions | List of all members
crashpad::MinidumpModuleCrashpadInfoListWriter Class Referencefinal

The writer for a MinidumpModuleCrashpadInfoList object in a minidump file, containing a list of MinidumpModuleCrashpadInfo objects. More...

#include "minidump/minidump_module_crashpad_info_writer.h"

Inheritance diagram for crashpad::MinidumpModuleCrashpadInfoListWriter:
crashpad::internal::MinidumpWritable

Public Member Functions

void InitializeFromSnapshot (const std::vector< const ModuleSnapshot * > &module_snapshots)
 Adds an initialized MinidumpModuleCrashpadInfo for modules in module_snapshots to the MinidumpModuleCrashpadInfoList. More...
 
void AddModule (std::unique_ptr< MinidumpModuleCrashpadInfoWriter > module_crashpad_info, size_t minidump_module_list_index)
 Adds a MinidumpModuleCrashpadInfo to the MinidumpModuleCrashpadInfoList. More...
 
bool IsUseful () const
 Determines whether the object is useful. More...
 
- Public Member Functions inherited from crashpad::internal::MinidumpWritable
virtual bool WriteEverything (FileWriterInterface *file_writer)
 Writes an object and all of its children to a minidump file. More...
 
void RegisterRVA (RVA *rva)
 Registers a file offset pointer as one that should point to the object on which this method is called. More...
 
void RegisterLocationDescriptor (MINIDUMP_LOCATION_DESCRIPTOR *location_descriptor)
 Registers a location descriptor as one that should point to the object on which this method is called. More...
 

Protected Member Functions

bool Freeze () override
 Transitions the object from kStateMutable to kStateFrozen. More...
 
size_t SizeOfObject () override
 Returns the amount of space that this object will consume when written to a minidump file, in bytes, not including any leading or trailing padding necessary to maintain proper alignment. More...
 
std::vector< MinidumpWritable * > Children () override
 Returns the object’s children. More...
 
bool WriteObject (FileWriterInterface *file_writer) override
 Writes the object’s content. More...
 
- Protected Member Functions inherited from crashpad::internal::MinidumpWritable
State state () const
 The state of the object.
 
virtual size_t Alignment ()
 Returns the object’s desired byte-boundary alignment. More...
 
virtual Phase WritePhase ()
 Returns the object’s desired write phase. More...
 
size_t WillWriteAtOffset (Phase phase, FileOffset *offset, std::vector< MinidumpWritable * > *write_sequence)
 Prepares the object to be written at a known file offset, transitioning it from kStateFrozen to kStateWritable. More...
 
virtual bool WillWriteAtOffsetImpl (FileOffset offset)
 Called once an object’s writable file offset is determined, as it transitions into kStateWritable. More...
 
bool WritePaddingAndObject (FileWriterInterface *file_writer)
 Writes the object, transitioning it from kStateWritable to kStateWritten. More...
 

Additional Inherited Members

- Protected Types inherited from crashpad::internal::MinidumpWritable
enum  State
 Identifies the state of an object. More...
 
enum  Phase
 Identifies the phase during which an object will be written to a minidump file. More...
 
- Static Protected Attributes inherited from crashpad::internal::MinidumpWritable
static constexpr size_t kInvalidSize = std::numeric_limits<size_t>::max()
 A size value used to signal failure by methods that return size_t.
 

Detailed Description

The writer for a MinidumpModuleCrashpadInfoList object in a minidump file, containing a list of MinidumpModuleCrashpadInfo objects.

Member Function Documentation

◆ AddModule()

void crashpad::MinidumpModuleCrashpadInfoListWriter::AddModule ( std::unique_ptr< MinidumpModuleCrashpadInfoWriter module_crashpad_info,
size_t  minidump_module_list_index 
)

Adds a MinidumpModuleCrashpadInfo to the MinidumpModuleCrashpadInfoList.

Parameters
[in]module_crashpad_infoExtended Crashpad-specific information about the module. This object takes ownership of module_crashpad_info and becomes its parent in the overall tree of internal::MinidumpWritable objects.
[in]minidump_module_list_indexThe index of the MINIDUMP_MODULE in the minidump file’s MINIDUMP_MODULE_LIST stream that corresponds to module_crashpad_info.
Note
Valid in kStateMutable.

◆ Children()

std::vector< internal::MinidumpWritable * > crashpad::MinidumpModuleCrashpadInfoListWriter::Children ( )
overrideprotectedvirtual

Returns the object’s children.

Note
Valid in kStateFrozen or any subsequent state.

Reimplemented from crashpad::internal::MinidumpWritable.

◆ Freeze()

bool crashpad::MinidumpModuleCrashpadInfoListWriter::Freeze ( )
overrideprotectedvirtual

Transitions the object from kStateMutable to kStateFrozen.

The default implementation marks the object as frozen and recursively calls Freeze() on all of its children. Subclasses may override this method to perform processing that should only be done once callers have finished populating an object with data. Typically, a subclass implementation would call RegisterRVA() or RegisterLocationDescriptor() on other objects as appropriate, because at the time Freeze() runs, the in-memory locations of RVAs and location descriptors are known and will not change for the remaining duration of an object’s lifetime.

Returns
true on success. false on failure, with an appropriate message logged.

Reimplemented from crashpad::internal::MinidumpWritable.

◆ InitializeFromSnapshot()

void crashpad::MinidumpModuleCrashpadInfoListWriter::InitializeFromSnapshot ( const std::vector< const ModuleSnapshot * > &  module_snapshots)

Adds an initialized MinidumpModuleCrashpadInfo for modules in module_snapshots to the MinidumpModuleCrashpadInfoList.

Only modules in module_snapshots that would produce a useful MinidumpModuleCrashpadInfo structure are included. Usefulness is determined by MinidumpModuleCrashpadInfoWriter::IsUseful().

Parameters
[in]module_snapshotsThe module snapshots to use as source data.
Note
Valid in kStateMutable. AddModule() may not be called before this method, and it is not normally necessary to call AddModule() after this method.

◆ IsUseful()

bool crashpad::MinidumpModuleCrashpadInfoListWriter::IsUseful ( ) const

Determines whether the object is useful.

A useful object is one that carries data that makes a meaningful contribution to a minidump file. An object carrying children would be considered useful.

Returns
true if the object is useful, false otherwise.

◆ SizeOfObject()

size_t crashpad::MinidumpModuleCrashpadInfoListWriter::SizeOfObject ( )
overrideprotectedvirtual

Returns the amount of space that this object will consume when written to a minidump file, in bytes, not including any leading or trailing padding necessary to maintain proper alignment.

Note
Valid in kStateFrozen or any subsequent state.

Implements crashpad::internal::MinidumpWritable.

◆ WriteObject()

bool crashpad::MinidumpModuleCrashpadInfoListWriter::WriteObject ( FileWriterInterface file_writer)
overrideprotectedvirtual

Writes the object’s content.

Parameters
[in]file_writerThe file writer to receive the object’s content.
Returns
true on success. false on error, indicating that the content could not be written to the minidump file.
Note
Valid in kStateWritable. The object will transition to kStateWritten after this method returns.

Implements crashpad::internal::MinidumpWritable.


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