diff options
Diffstat (limited to 'source/Plugins/ObjectFile/ELF/ELFHeader.h')
| -rw-r--r-- | source/Plugins/ObjectFile/ELF/ELFHeader.h | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/source/Plugins/ObjectFile/ELF/ELFHeader.h b/source/Plugins/ObjectFile/ELF/ELFHeader.h index 4e2d3155ebb9..faaf8be99d68 100644 --- a/source/Plugins/ObjectFile/ELF/ELFHeader.h +++ b/source/Plugins/ObjectFile/ELF/ELFHeader.h @@ -8,14 +8,14 @@ //===----------------------------------------------------------------------===// // /// @file -/// @brief Generic structures and typedefs for ELF files. +/// Generic structures and typedefs for ELF files. /// /// This file provides definitions for the various entities comprising an ELF /// file. The structures are generic in the sense that they do not correspond /// to the exact binary layout of an ELF, but can be used to hold the /// information present in both 32 and 64 bit variants of the format. Each -/// entity provides a \c Parse method which is capable of transparently reading -/// both 32 and 64 bit instances of the object. +/// entity provides a \c Parse method which is capable of transparently +/// reading both 32 and 64 bit instances of the object. //===----------------------------------------------------------------------===// #ifndef liblldb_ELFHeader_h_ @@ -35,8 +35,9 @@ namespace elf { //------------------------------------------------------------------------------ /// @name ELF type definitions. /// -/// Types used to represent the various components of ELF structures. All types -/// are signed or unsigned integral types wide enough to hold values from both +/// Types used to represent the various components of ELF structures. All +/// types are signed or unsigned integral types wide enough to hold values +/// from both /// 32 and 64 bit ELF variants. //@{ typedef uint64_t elf_addr; @@ -51,10 +52,10 @@ typedef int64_t elf_sxword; //------------------------------------------------------------------------------ /// @class ELFHeader -/// @brief Generic representation of an ELF file header. +/// Generic representation of an ELF file header. /// -/// This object is used to identify the general attributes on an ELF file and to -/// locate additional sections within the file. +/// This object is used to identify the general attributes on an ELF file and +/// to locate additional sections within the file. struct ELFHeader { unsigned char e_ident[llvm::ELF::EI_NIDENT]; ///< ELF file identification. elf_addr e_entry; ///< Virtual address program entry point. @@ -118,9 +119,9 @@ struct ELFHeader { bool HasHeaderExtension() const; //-------------------------------------------------------------------------- - /// Parse an ELFHeader entry starting at position \p offset and - /// update the data extractor with the address size and byte order - /// attributes as defined by the header. + /// Parse an ELFHeader entry starting at position \p offset and update the + /// data extractor with the address size and byte order attributes as + /// defined by the header. /// /// @param[in,out] data /// The DataExtractor to read from. Updated with the address size and @@ -157,8 +158,8 @@ struct ELFHeader { private: //-------------------------------------------------------------------------- - /// Parse an ELFHeader header extension entry. This method is called - /// by Parse(). + /// Parse an ELFHeader header extension entry. This method is called by + /// Parse(). /// /// @param[in] data /// The DataExtractor to read from. @@ -167,7 +168,7 @@ private: //------------------------------------------------------------------------------ /// @class ELFSectionHeader -/// @brief Generic representation of an ELF section header. +/// Generic representation of an ELF section header. struct ELFSectionHeader { elf_word sh_name; ///< Section name string index. elf_word sh_type; ///< Section type. @@ -202,7 +203,7 @@ struct ELFSectionHeader { //------------------------------------------------------------------------------ /// @class ELFProgramHeader -/// @brief Generic representation of an ELF program header. +/// Generic representation of an ELF program header. struct ELFProgramHeader { elf_word p_type; ///< Type of program segment. elf_word p_flags; ///< Segment attributes. @@ -235,7 +236,7 @@ struct ELFProgramHeader { //------------------------------------------------------------------------------ /// @class ELFSymbol -/// @brief Represents a symbol within an ELF symbol table. +/// Represents a symbol within an ELF symbol table. struct ELFSymbol { elf_addr st_value; ///< Absolute or relocatable address. elf_xword st_size; ///< Size of the symbol or zero. @@ -288,7 +289,7 @@ struct ELFSymbol { //------------------------------------------------------------------------------ /// @class ELFDynamic -/// @brief Represents an entry in an ELF dynamic table. +/// Represents an entry in an ELF dynamic table. struct ELFDynamic { elf_sxword d_tag; ///< Type of dynamic table entry. union { @@ -318,7 +319,7 @@ struct ELFDynamic { //------------------------------------------------------------------------------ /// @class ELFRel -/// @brief Represents a relocation entry with an implicit addend. +/// Represents a relocation entry with an implicit addend. struct ELFRel { elf_addr r_offset; ///< Address of reference. elf_xword r_info; ///< symbol index and type of relocation. @@ -360,7 +361,7 @@ struct ELFRel { //------------------------------------------------------------------------------ /// @class ELFRela -/// @brief Represents a relocation entry with an explicit addend. +/// Represents a relocation entry with an explicit addend. struct ELFRela { elf_addr r_offset; ///< Address of reference. elf_xword r_info; ///< Symbol index and type of relocation. |