LIEF: Library to Instrument Executable Formats Version 0.15.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
LIEF::ELF::Note Class Reference

Class which represents an ELF note. This class can be instantiated using the static Note::create functions. More...

#include <Note.hpp>

Inheritance diagram for LIEF::ELF::Note:
Inheritance graph
[legend]
Collaboration diagram for LIEF::ELF::Note:
Collaboration graph
[legend]

Public Types

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
}
 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

Noteoperator= (const Note &copy)=default
 
 Note (const Note &copy)=default
 
virtual std::unique_ptr< Noteclone () const
 Clone the current note and keep its polymorphic type.
 
const std::string & name () const
 Return the name of the note (also known as 'owner' )
 
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.
 
virtual void dump (std::ostream &os) const
 
void accept (Visitor &visitor) const override
 
- Public Member Functions inherited from LIEF::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
 

Static Public Member Functions

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< const char * > 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, 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, 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, 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 which represents an ELF note. This class can be instantiated using the static Note::create functions.

Member Enumeration Documentation

◆ TYPE

enum class LIEF::ELF::Note::TYPE
strong

LIEF representation of the ELF NT_ values.

Enumerator
GNU_ABI_TAG 

Match NT_GNU_ABI_TAG: Operating system (OS) ABI information.

See: NoteAbi

GNU_HWCAP 

Match NT_HWCAP: Synthetic hardware capabilities information.

GNU_BUILD_ID 

Match NT_GNU_BUILD_ID: Unique build ID as generated by the GNU ld.

GNU_GOLD_VERSION 

Match NT_GNU_GOLD_VERSION: The version of gold used to link.

GNU_PROPERTY_TYPE_0 

Match NT_GNU_PROPERTY_TYPE_0: Program property note, as described in "Linux Extensions to the gABI".

CRASHPAD 

Crashpad note used by the Chromium project.

CORE_PRSTATUS 

Coredump that wraps the elf_prstatus structure.

CORE_PRPSINFO 

Coredump that wraps the elf_prpsinfo structure.

See: CorePrPsInfo

CORE_AUXV 

Coredump that contains a copy of all the auxiliary vectors (auxv)

See: CoreAuxv

CORE_FPREGS 

Coredump that wraps the fpregset structure.

CORE_PSINFO 

Coredump that wraps the psinfo structure.

ANDROID_IDENT 

Note that is specific to Android and that describes information such as the NDK version or the SDK build number.

See AndroidIdent

GO_BUILDID 

Note specific to Go binaries.

STAPSDT 

Note for SystemTap probes.

Member Function Documentation

◆ accept()

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

Implements LIEF::Object.

◆ clone()

virtual std::unique_ptr< Note > LIEF::ELF::Note::clone ( ) const
inlinevirtual

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