Data.Elf

Parse/serialize ELF files into structured data

Elf

newtype ElfList c

Elf is a forrest of trees of type ElfXX. Trees are composed of ElfXX nodes, ElfSegment can contain subtrees

Constructors

ElfList [ElfXX c]

type Elf = Sigma ElfClass (TyCon1 ElfList)

Elf is a sigma type where ElfClass defines the type of ElfList

data ElfSectionData c

Section data may contain a string table. If a section contains a string table with section names, the data for such a section is generated and esData should contain ElfSectionDataStringTable

Constructors

ElfSectionData

Regular section data

Fields

• esdData :: ByteString

  The content of the section

ElfSectionDataStringTable

Section data will be generated from section names

ElfSectionDataNoBits

SHT_NOBITS uninitialized section data: section has size but no content

Fields

• esdSize :: WordXX c

  Size of the section

data ElfXX c

The type of node that defines Elf structure.

Constructors

ElfHeader

Fields

• ehData :: ElfData

  Data encoding (big- or little-endian)

• ehOSABI :: ElfOSABI

  OS/ABI identification

• ehABIVersion :: Word8

  ABI version

• ehType :: ElfType

  Object file type

• ehMachine :: ElfMachine

  Machine type

• ehEntry :: WordXX c

  Entry point address

• ehFlags :: Word32

  Processor-specific flags

ElfSectionTable

ElfSegmentTable

ElfSection

Fields

• esName :: String

  Section name (NB: string, not offset in the string table)

• esType :: ElfSectionType

  Section type

• esFlags :: ElfSectionFlag

  Section attributes

• esAddr :: WordXX c

  Virtual address in memory

• esAddrAlign :: WordXX c

  Address alignment boundary

• esEntSize :: WordXX c

  Size of entries, if section has table

• esN :: ElfSectionIndex

  Section number

• esInfo :: Word32

  Miscellaneous information

• esLink :: Word32

  Link to other section

• esData :: ElfSectionData c

  The content of the section

ElfSegment

Fields

• epType :: ElfSegmentType

  Type of segment

• epFlags :: ElfSegmentFlag

  Segment attributes

• epVirtAddr :: WordXX c

  Virtual address in memory

• epPhysAddr :: WordXX c

  Physical address

• epAddMemSize :: WordXX c

  Add this amount of memory after the section when the section is loaded to memory by execution system. Or, in other words this is how much pMemSize is bigger than pFileSize

• epAlign :: WordXX c

  Alignment of segment

• epData :: [ElfXX c]

  Content of the segment

ElfRawData

Some ELF files (some executables) don't bother to define sections for linking and have just raw data in segments.

Fields

• edData :: ByteString

  Raw data in ELF file

ElfRawAlign

Align the next data in the ELF file. The offset of the next data in the ELF file will be the minimal x such that x mod eaAlign == eaOffset mod eaAlign

Fields

• eaOffset :: WordXX c

  Align value

• eaAlign :: WordXX c

  Align module

parseElf :: MonadCatch m => ByteString -> m Elf

Parse ELF file

serializeElf :: MonadThrow m => Elf -> m ByteString

Serialze ELF file

Misc

getSectionData

Arguments

:: IsElfClass a

=> ByteString

ELF file

-> SectionXX a

Parsed section entry

-> ByteString

Section Data

Get section data

getString

Arguments

:: ByteString

Section data of a string table section

-> Int64

Offset to the start of the string in that data

-> String

Get string from string table

elfFindSection

Arguments

:: forall a m b. (SingI a, MonadThrow m, Integral b, Show b)

=> [ElfXX a]

Structured ELF data

-> b

Number of the section

-> m (ElfXX a)

The section in question

Find section with a given number

elfFindSectionByName

Arguments

:: forall a m. (SingI a, MonadThrow m)

=> [ElfXX a]

Structured ELF data

-> String

Section name

-> m (ElfXX a)

The section in question

Find section with a given name

elfFindHeader

Arguments

:: forall a m. (SingI a, MonadThrow m)

=> [ElfXX a]

Structured ELF data

-> m (ElfXX a)

ELF header

Find ELF header

Symbol table

data ElfSymbolXX c

Parsed ELF symbol table entry. NB: This is work in progress

Constructors

ElfSymbolXX

Fields

• steName :: String

  Symbol name (NB: String, not string index)

• steBind :: ElfSymbolBinding

  Symbol binding attributes

• steType :: ElfSymbolType

  Symbol Type

• steShNdx :: ElfSectionIndex

  Section table index

• steValue :: WordXX c

  Symbol value

• steSize :: WordXX c

  Size of object

parseSymbolTable

Arguments

:: (MonadThrow m, SingI a)

=> ElfData

Endianness of the ELF file

-> ElfXX a

Parsed section such that sectionIsSymbolTable . sType is true.

-> [ElfXX a]

Structured ELF data

-> m [ElfSymbolXX a]

Symbol table

Parse symbol table

serializeSymbolTable

Arguments

:: (MonadThrow m, SingI a)

=> ElfData

Endianness of the ELF file

-> [ElfSymbolXX a]

Symbol table

-> m (ByteString, ByteString)

Pair of symbol table section data and string table section data

Serialize symbol table