LIEF: Library to Instrument Executable Formats Version 0.16.0
Loading...
Searching...
No Matches
LIEF::ELF::CoreFile Class Reference

Class representing a core NT_FILE which describes the mapped files of the process. More...

#include <CoreFile.hpp>

Inheritance diagram for LIEF::ELF::CoreFile:
Collaboration diagram for LIEF::ELF::CoreFile:

Classes

struct  entry_t
 Core file entry. More...
 

Public Types

using files_t = std::vector<entry_t>
 
using iterator = files_t::iterator
 
using const_iterator = files_t::const_iterator
 
- Public Types inherited from LIEF::ELF::Note
enum class  TYPE {
  UNKNOWN = 0 , GNU_ABI_TAG , GNU_HWCAP , GNU_BUILD_ID ,
  GNU_GOLD_VERSION , GNU_PROPERTY_TYPE_0 , GNU_BUILD_ATTRIBUTE_OPEN , GNU_BUILD_ATTRIBUTE_FUNC ,
  CRASHPAD , CORE_PRSTATUS , CORE_FPREGSET , CORE_PRPSINFO ,
  CORE_TASKSTRUCT , CORE_AUXV , CORE_PSTATUS , CORE_FPREGS ,
  CORE_PSINFO , CORE_LWPSTATUS , CORE_LWPSINFO , CORE_WIN32PSTATUS ,
  CORE_FILE , CORE_PRXFPREG , CORE_SIGINFO , CORE_ARM_VFP ,
  CORE_ARM_TLS , CORE_ARM_HW_BREAK , CORE_ARM_HW_WATCH , CORE_ARM_SYSTEM_CALL ,
  CORE_ARM_SVE , CORE_ARM_PAC_MASK , CORE_ARM_PACA_KEYS , CORE_ARM_PACG_KEYS ,
  CORE_TAGGED_ADDR_CTRL , CORE_PAC_ENABLED_KEYS , CORE_X86_TLS , CORE_X86_IOPERM ,
  CORE_X86_XSTATE , CORE_X86_CET , ANDROID_IDENT , ANDROID_MEMTAG ,
  ANDROID_KUSER , GO_BUILDID , STAPSDT , QNX_STACK
}
 LIEF representation of the ELF NT_ values. More...
 
using description_t = std::vector<uint8_t>
 Container used to handle the description data.
 
- Public Types inherited from LIEF::Object
template<class T >
using output_t = add_pointer_t<decay_t<T>>
 
template<class T >
using output_const_t = add_pointer_t<add_const_t<decay_t<T>>>
 

Public Member Functions

 CoreFile (ARCH arch, Header::CLASS cls, std::string name, uint32_t type, Note::description_t description)
 
std::unique_ptr< Noteclone () const override
 Clone the current note and keep its polymorphic type.
 
uint64_t count () const
 Number of coredump file entries.
 
const files_tfiles () const
 Coredump file entries.
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
void files (const files_t &file)
 
void dump (std::ostream &os) const override
 
void accept (Visitor &visitor) const override
 
 ~CoreFile () override=default
 
- Public Member Functions inherited from LIEF::ELF::Note
Noteoperator= (const Note &copy)=default
 
 Note (const Note &copy)=default
 
 ~Note () override=default
 
const std::string & name () const
 Return the name of the note (also known as 'owner' )
 
const std::string & section_name () const
 Return the section name in which the note is or should be stored.
 
TYPE type () const
 Return the type of the note. This type does not match the NT_ type value. For accessing the original NT_ value, check original_type()
 
uint32_t original_type () const
 The original NT_xxx integer value. The meaning of this value likely depends on the owner of the note.
 
span< const uint8_t > description () const
 Return the description associated with the note.
 
span< uint8_t > description ()
 
void name (std::string name)
 
void description (description_t description)
 Change the description of the note.
 
uint64_t size () const
 Size of the raw note which includes padding.
 
void accept (Visitor &visitor) const override
 
template<class T >
const T * cast () const
 
template<class T >
T * cast ()
 
- Public Member Functions inherited from LIEF::Object
 Object ()
 
 Object (const Object &other)
 
Objectoperator= (const Object &other)
 
template<class T >
output_t< T > as ()
 
template<class T >
output_const_t< T > as () const
 
virtual bool operator== (const Object &other) const
 
virtual bool operator!= (const Object &other) const
 
virtual ~Object ()
 

Static Public Member Functions

static bool classof (const Note *note)
 
- Static Public Member Functions inherited from LIEF::ELF::Note
static result< TYPEconvert_type (Header::FILE_TYPE ftype, uint32_t type, const std::string &name)
 Convert the raw integer note type into a TYPE according to the owner.
 
static result< const char * > type_to_section (TYPE type)
 Try to determine the ELF section name associated with the TYPE provided in parameter.
 
static result< std::string > note_to_section (const Note &note)
 
static result< const char * > type_owner (TYPE type)
 Try to determine the owner's name of the TYPE provided in parameter.
 
static std::unique_ptr< Notecreate (const std::string &name, uint32_t type, description_t description, std::string section_name, Header::FILE_TYPE ftype=Header::FILE_TYPE::NONE, ARCH arch=ARCH::NONE, Header::CLASS cls=Header::CLASS::NONE)
 Create a new note from the given parameters. Additional information such as the architecture or the ELF class could be required for creating notes like Coredump notes.
 
static std::unique_ptr< Notecreate (const std::string &name, TYPE type, description_t description, std::string section_name, ARCH arch=ARCH::NONE, Header::CLASS cls=Header::CLASS::NONE)
 Create a new note from the given parameters. Additional information such as the architecture or the ELF class could be required for creating notes like Coredump notes.
 
static std::unique_ptr< Notecreate (BinaryStream &stream, std::string section_name, Header::FILE_TYPE ftype=Header::FILE_TYPE::NONE, ARCH arch=ARCH::NONE, Header::CLASS cls=Header::CLASS::NONE)
 Create a new note from the given stream. Additional information such as the architecture or the ELF class could be required for creating notes like Coredump notes.
 

Detailed Description

Class representing a core NT_FILE which describes the mapped files of the process.

Member Typedef Documentation

◆ const_iterator

using LIEF::ELF::CoreFile::const_iterator = files_t::const_iterator

◆ files_t

using LIEF::ELF::CoreFile::files_t = std::vector<entry_t>

◆ iterator

using LIEF::ELF::CoreFile::iterator = files_t::iterator

Constructor & Destructor Documentation

◆ CoreFile()

LIEF::ELF::CoreFile::CoreFile ( ARCH arch,
Header::CLASS cls,
std::string name,
uint32_t type,
Note::description_t description )

◆ ~CoreFile()

LIEF::ELF::CoreFile::~CoreFile ( )
overridedefault

Member Function Documentation

◆ accept()

void LIEF::ELF::CoreFile::accept ( Visitor & visitor) const
overridevirtual

Implements LIEF::Object.

◆ begin() [1/2]

iterator LIEF::ELF::CoreFile::begin ( )
inline

◆ begin() [2/2]

const_iterator LIEF::ELF::CoreFile::begin ( ) const
inline

◆ classof()

static bool LIEF::ELF::CoreFile::classof ( const Note * note)
inlinestatic

◆ clone()

std::unique_ptr< Note > LIEF::ELF::CoreFile::clone ( ) const
inlineoverridevirtual

Clone the current note and keep its polymorphic type.

Reimplemented from LIEF::ELF::Note.

◆ count()

uint64_t LIEF::ELF::CoreFile::count ( ) const
inline

Number of coredump file entries.

◆ dump()

void LIEF::ELF::CoreFile::dump ( std::ostream & os) const
overridevirtual

Reimplemented from LIEF::ELF::Note.

Referenced by operator<<.

◆ end() [1/2]

iterator LIEF::ELF::CoreFile::end ( )
inline

◆ end() [2/2]

const_iterator LIEF::ELF::CoreFile::end ( ) const
inline

◆ files() [1/2]

const files_t & LIEF::ELF::CoreFile::files ( ) const
inline

Coredump file entries.

◆ files() [2/2]

void LIEF::ELF::CoreFile::files ( const files_t & file)

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