Copyright	(c) Aleksey Makarov 2021
License	BSD 3-Clause License
Maintainer	aleksey.makarov@gmail.com
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Data.Elf

Contents

Elf
Misc
Symbol table

Description

Parse/serialize ELF files into structured data

Synopsis

data ElfListXX (c :: ElfClass) where
- ElfListCons :: forall (t :: ElfNodeType) (c :: ElfClass). ElfXX t c -> ElfListXX c -> ElfListXX c
- ElfListNull :: forall (c :: ElfClass). ElfListXX c
(~:) :: forall (t :: ElfNodeType) (a :: ElfClass). ElfXX t a -> ElfListXX a -> ElfListXX a
data ElfNodeType
- = Header
- | SectionTable
- | SegmentTable
- | Section
- | Segment
- | RawData
- | RawAlign
data ElfSectionData (c :: ElfClass)
- = ElfSectionData {
  - esdData :: ByteString
  }
- | ElfSectionDataStringTable
- | ElfSectionDataNoBits {
  - esdSize :: WordXX c
  }
data ElfXX (t :: ElfNodeType) (c :: ElfClass) where
- ElfHeader :: forall (c :: ElfClass). {..} -> ElfXX 'Header c
- ElfSectionTable :: forall (c :: ElfClass). ElfXX 'SectionTable c
- ElfSegmentTable :: forall (c :: ElfClass). ElfXX 'SegmentTable c
- ElfSection :: forall (c :: ElfClass). {..} -> ElfXX 'Section c
- ElfSegment :: forall (c :: ElfClass). {..} -> ElfXX 'Segment c
- ElfRawData :: forall (c :: ElfClass). {..} -> ElfXX 'RawData c
- ElfRawAlign :: forall (c :: ElfClass). {..} -> ElfXX 'RawAlign c
data Elf = Elf (SingElfClass a) (ElfListXX a)
parseElf :: MonadCatch m => ByteString -> m Elf
serializeElf :: MonadCatch m => Elf -> m ByteString
elfFindSection :: forall (a :: ElfClass) m b. (SingElfClassI a, MonadThrow m, Integral b, Show b) => ElfListXX a -> b -> m (ElfXX 'Section a)
elfFindSectionByName :: forall (a :: ElfClass) m. (SingElfClassI a, MonadThrow m) => ElfListXX a -> String -> m (ElfXX 'Section a)
elfFindHeader :: forall (a :: ElfClass) m. (SingElfClassI a, MonadThrow m) => ElfListXX a -> m (ElfXX 'Header a)
data ElfSymbolXX (c :: ElfClass) = ElfSymbolXX {
- steName :: String
- steBind :: ElfSymbolBinding
- steType :: ElfSymbolType
- steShNdx :: ElfSectionIndex
- steValue :: WordXX c
- steSize :: WordXX c
}
parseSymbolTable :: forall m (a :: ElfClass). (MonadThrow m, SingElfClassI a) => ElfData -> ElfXX 'Section a -> ElfListXX a -> m [ElfSymbolXX a]
serializeSymbolTable :: forall m (a :: ElfClass). (MonadThrow m, SingElfClassI a) => ElfData -> [ElfSymbolXX a] -> m (ByteString, ByteString)

Elf

data ElfListXX (c :: ElfClass) where Source #

List of ELF nodes.

Constructors

ElfListCons :: forall (t :: ElfNodeType) (c :: ElfClass). ElfXX t c -> ElfListXX c -> ElfListXX c
ElfListNull :: forall (c :: ElfClass). ElfListXX c

(~:) :: forall (t :: ElfNodeType) (a :: ElfClass). ElfXX t a -> ElfListXX a -> ElfListXX a infixr 9 Source #

Helper for ElfListCons

data ElfNodeType Source #

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

Constructors

Header
SectionTable
SegmentTable
Section
Segment
RawData
RawAlign

data ElfSectionData (c :: ElfClass) Source #

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 (t :: ElfNodeType) (c :: ElfClass) where Source #

The type of node that defines Elf structure.

Constructors

ElfHeader
Fields :: forall (c :: ElfClass). { 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 } -> ElfXX 'Header c
ElfSectionTable :: forall (c :: ElfClass). ElfXX 'SectionTable c
ElfSegmentTable :: forall (c :: ElfClass). ElfXX 'SegmentTable c
ElfSection
Fields :: forall (c :: ElfClass). { 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 } -> ElfXX 'Section c
ElfSegment
Fields :: forall (c :: ElfClass). { 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 :: ElfListXX c Content of the segment } -> ElfXX 'Segment c
ElfRawData	Some ELF files (some executables) don't bother to define sections for linking and have just raw data in segments.
Fields :: forall (c :: ElfClass). { edData :: ByteString Raw data in ELF file } -> ElfXX 'RawData c
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 :: forall (c :: ElfClass). { eaOffset :: WordXX c Align value , eaAlign :: WordXX c Align module } -> ElfXX 'RawAlign c

data Elf Source #

Elf is a sigma type where the first entry defines the type of the second one

Constructors

Elf (SingElfClass a) (ElfListXX a)

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

Parse ELF file

serializeElf :: MonadCatch m => Elf -> m ByteString Source #

Serialze ELF file

Misc

elfFindSection Source #

Arguments

:: forall (a :: ElfClass) m b. (SingElfClassI a, MonadThrow m, Integral b, Show b)
=> ElfListXX a	Structured ELF data
-> b	Number of the section
-> m (ElfXX 'Section a)	The section in question

Find section with a given number

elfFindSectionByName Source #

Arguments

:: forall (a :: ElfClass) m. (SingElfClassI a, MonadThrow m)
=> ElfListXX a	Structured ELF data
-> String	Section name
-> m (ElfXX 'Section a)	The section in question

Find section with a given name

elfFindHeader Source #

Arguments

:: forall (a :: ElfClass) m. (SingElfClassI a, MonadThrow m)
=> ElfListXX a	Structured ELF data
-> m (ElfXX 'Header a)	ELF header

Find ELF header

Symbol table

data ElfSymbolXX (c :: ElfClass) Source #

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 Source #

Arguments

:: forall m (a :: ElfClass). (MonadThrow m, SingElfClassI a)
=> ElfData	Endianness of the ELF file
-> ElfXX 'Section a	Parsed section such that `sectionIsSymbolTable . sType` is true.
-> ElfListXX a	Structured ELF data
-> m [ElfSymbolXX a]	Symbol table

Parse symbol table

serializeSymbolTable Source #

Arguments

:: forall m (a :: ElfClass). (MonadThrow m, SingElfClassI 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