Data.Elf.Headers

Parse headers and table entries of ELF files

Data definition

elfMagic :: Be Word32

The first 4 bytes of the ELF file

data ElfClass

ELF class. Tells if ELF defines 32- or 64-bit objects

Constructors

ELFCLASS32

ELFCLASS64

Instances

Show ElfClass

Defined in Data.Elf.Headers

Methods

showsPrec :: Int -> ElfClass -> ShowS

show :: ElfClass -> String

showList :: [ElfClass] -> ShowS

Binary ElfClass

Defined in Data.Elf.Headers

Methods

put :: ElfClass -> Put

get :: Get ElfClass

putList :: [ElfClass] -> Put

Binary Header

Defined in Data.Elf.Headers

Methods

put :: Header -> Put

get :: Get Header

putList :: [Header] -> Put

Eq ElfClass

Defined in Data.Elf.Headers

Methods

(==) :: ElfClass -> ElfClass -> Bool

(/=) :: ElfClass -> ElfClass -> Bool

SingKind ElfClass

Defined in Data.Elf.Headers

Associated Types

type Demote ElfClass = (r :: Type)

Methods

fromSing :: forall (a :: ElfClass). Sing a -> Demote ElfClass

toSing :: Demote ElfClass -> SomeSing ElfClass

SDecide ElfClass

Defined in Data.Elf.Headers

Methods

(%~) :: forall (a :: ElfClass) (b :: ElfClass). Sing a -> Sing b -> Decision (a :~: b)

PEq ElfClass

Defined in Data.Elf.Headers

Associated Types

type arg == arg1 :: Bool

type arg /= arg1 :: Bool

SEq ElfClass

Defined in Data.Elf.Headers

Methods

(%==) :: forall (t1 :: ElfClass) (t2 :: ElfClass). Sing t1 -> Sing t2 -> Sing (Apply (Apply (==@#@$) t1) t2)

(%/=) :: forall (t1 :: ElfClass) (t2 :: ElfClass). Sing t1 -> Sing t2 -> Sing (Apply (Apply (/=@#@$) t1) t2)

PShow ElfClass

Defined in Data.Elf.Headers

Associated Types

type ShowsPrec arg arg1 arg2 :: Symbol

type Show_ arg :: Symbol

type ShowList arg arg1 :: Symbol

SShow ElfClass

Defined in Data.Elf.Headers

Methods

sShowsPrec :: forall (t1 :: Natural) (t2 :: ElfClass) (t3 :: Symbol). Sing t1 -> Sing t2 -> Sing t3 -> Sing (Apply (Apply (Apply ShowsPrecSym0 t1) t2) t3)

sShow_ :: forall (t :: ElfClass). Sing t -> Sing (Apply Show_Sym0 t)

sShowList :: forall (t1 :: [ElfClass]) (t2 :: Symbol). Sing t1 -> Sing t2 -> Sing (Apply (Apply ShowListSym0 t1) t2)

TestCoercion SElfClass

Defined in Data.Elf.Headers

Methods

testCoercion :: forall (a :: k) (b :: k). SElfClass a -> SElfClass b -> Maybe (Coercion a b)

TestEquality SElfClass

Defined in Data.Elf.Headers

Methods

testEquality :: forall (a :: k) (b :: k). SElfClass a -> SElfClass b -> Maybe (a :~: b)

SingI 'ELFCLASS32

Defined in Data.Elf.Headers

Methods

sing :: Sing 'ELFCLASS32

SingI 'ELFCLASS64

Defined in Data.Elf.Headers

Methods

sing :: Sing 'ELFCLASS64

type Demote ElfClass

Defined in Data.Elf.Headers

type Demote ElfClass = ElfClass

type Sing

Defined in Data.Elf.Headers

type Sing = SElfClass

type Show_ (arg :: ElfClass)

Defined in Data.Elf.Headers

type Show_ (arg :: ElfClass) = Apply (Show__6989586621679997126Sym0 :: TyFun ElfClass Symbol -> Type) arg

type (arg :: ElfClass) /= (arg1 :: ElfClass)

Defined in Data.Elf.Headers

type (arg :: ElfClass) /= (arg1 :: ElfClass) = Apply (Apply (TFHelper_6989586621679146855Sym0 :: TyFun ElfClass (ElfClass ~> Bool) -> Type) arg) arg1

type (a1 :: ElfClass) == (a2 :: ElfClass)

Defined in Data.Elf.Headers

type (a1 :: ElfClass) == (a2 :: ElfClass)

type ShowList (arg :: [ElfClass]) arg1

Defined in Data.Elf.Headers

type ShowList (arg :: [ElfClass]) arg1 = Apply (Apply (ShowList_6989586621679997142Sym0 :: TyFun [ElfClass] (Symbol ~> Symbol) -> Type) arg) arg1

type ShowsPrec a1 (a2 :: ElfClass) a3

Defined in Data.Elf.Headers

type ShowsPrec a1 (a2 :: ElfClass) a3

data SElfClass :: ElfClass -> Type where

Constructors

SELFCLASS32 :: SElfClass (ELFCLASS32 :: ElfClass)

SELFCLASS64 :: SElfClass (ELFCLASS64 :: ElfClass)

Instances

TestCoercion SElfClass

Defined in Data.Elf.Headers

Methods

testCoercion :: forall (a :: k) (b :: k). SElfClass a -> SElfClass b -> Maybe (Coercion a b)

TestEquality SElfClass

Defined in Data.Elf.Headers

Methods

testEquality :: forall (a :: k) (b :: k). SElfClass a -> SElfClass b -> Maybe (a :~: b)

Show (SElfClass z)

Defined in Data.Elf.Headers

Methods

showsPrec :: Int -> SElfClass z -> ShowS

show :: SElfClass z -> String

showList :: [SElfClass z] -> ShowS

data ElfData

ELF data. Specifies the endianness of the ELF data

Constructors

ELFDATA2LSB

Little-endian ELF format

ELFDATA2MSB

Big-endian ELF format

Instances

Show ElfData

Defined in Data.Elf.Headers

Methods

showsPrec :: Int -> ElfData -> ShowS

show :: ElfData -> String

showList :: [ElfData] -> ShowS

Binary ElfData

Defined in Data.Elf.Headers

Methods

put :: ElfData -> Put

get :: Get ElfData

putList :: [ElfData] -> Put

Eq ElfData

Defined in Data.Elf.Headers

Methods

(==) :: ElfData -> ElfData -> Bool

(/=) :: ElfData -> ElfData -> Bool

class (SingI c, Typeable c, Typeable (WordXX c), Data (WordXX c), Show (WordXX c), Read (WordXX c), Eq (WordXX c), Ord (WordXX c), Bounded (WordXX c), Enum (WordXX c), Num (WordXX c), Integral (WordXX c), Real (WordXX c), Bits (WordXX c), FiniteBits (WordXX c), Binary (Be (WordXX c)), Binary (Le (WordXX c))) => IsElfClass (c :: ElfClass)

IsElfClass a is defined for each constructor of ElfClass. It defines WordXX a, which is Word32 for ELFCLASS32 and Word64 for ELFCLASS64.

Associated Types

type WordXX c = r | r -> c

Instances

IsElfClass 'ELFCLASS32

Defined in Data.Elf.Headers

Associated Types

type WordXX 'ELFCLASS32 = (r :: Type)

IsElfClass 'ELFCLASS64

Defined in Data.Elf.Headers

Associated Types

type WordXX 'ELFCLASS64 = (r :: Type)

wordSize :: Num a => ElfClass -> a

Size of WordXX a in bytes.

withElfClass :: Sing c -> (IsElfClass c => a) -> a

Convenience function for creating a context with an implicit ElfClass available.

Types of ELF header

data HeaderXX c

Parsed ELF header

Constructors

HeaderXX

Fields

• hData :: ElfData

  Data encoding (big- or little-endian)

• hOSABI :: ElfOSABI

  OS/ABI identification

• hABIVersion :: Word8

  ABI version

• hType :: ElfType

  Object file type

• hMachine :: ElfMachine

  Machine type

• hEntry :: WordXX c

  Entry point address

• hPhOff :: WordXX c

  Program header offset

• hShOff :: WordXX c

  Section header offset

• hFlags :: Word32

  Processor-specific flags

• hPhEntSize :: Word16

  Size of program header entry

• hPhNum :: Word16

  Number of program header entries

• hShEntSize :: Word16

  Size of section header entry

• hShNum :: Word16

  Number of section header entries

• hShStrNdx :: ElfSectionIndex

  Section name string table index

Instances

Binary Header

Defined in Data.Elf.Headers

Methods

put :: Header -> Put

get :: Get Header

putList :: [Header] -> Put

headerSize :: Num a => ElfClass -> a

Size of ELF header.

type Header = Sigma ElfClass (TyCon1 HeaderXX)

Sigma type where ElfClass defines the type of HeaderXX

Types of ELF tables

Section table

data SectionXX c

Parsed ELF section table entry

Constructors

SectionXX

Fields

• sName :: Word32

  Section name

• sType :: ElfSectionType

  Section type

• sFlags :: WordXX c

  Section attributes

• sAddr :: WordXX c

  Virtual address in memory

• sOffset :: WordXX c

  Offset in file

• sSize :: WordXX c

  Size of section

• sLink :: Word32

  Link to other section

• sInfo :: Word32

  Miscellaneous information

• sAddrAlign :: WordXX c

  Address alignment boundary

• sEntSize :: WordXX c

  Size of entries, if section has table

Instances

SingI a => Binary (Be (SectionXX a))

Defined in Data.Elf.Headers

Methods

put :: Be (SectionXX a) -> Put

get :: Get (Be (SectionXX a))

putList :: [Be (SectionXX a)] -> Put

SingI a => Binary (Le (SectionXX a))

Defined in Data.Elf.Headers

Methods

put :: Le (SectionXX a) -> Put

get :: Get (Le (SectionXX a))

putList :: [Le (SectionXX a)] -> Put

sectionTableEntrySize :: Num a => ElfClass -> a

Size of section table entry.

Segment table

data SegmentXX c

Parsed ELF segment table entry

Constructors

SegmentXX

Fields

• pType :: ElfSegmentType

  Type of segment

• pFlags :: ElfSegmentFlag

  Segment attributes

• pOffset :: WordXX c

  Offset in file

• pVirtAddr :: WordXX c

  Virtual address in memory

• pPhysAddr :: WordXX c

  Physical address

• pFileSize :: WordXX c

  Size of segment in file

• pMemSize :: WordXX c

  Size of segment in memory

• pAlign :: WordXX c

  Alignment of segment

Instances

SingI a => Binary (Be (SegmentXX a))

Defined in Data.Elf.Headers

Methods

put :: Be (SegmentXX a) -> Put

get :: Get (Be (SegmentXX a))

putList :: [Be (SegmentXX a)] -> Put

SingI a => Binary (Le (SegmentXX a))

Defined in Data.Elf.Headers

Methods

put :: Le (SegmentXX a) -> Put

get :: Get (Le (SegmentXX a))

putList :: [Le (SegmentXX a)] -> Put

segmentTableEntrySize :: Num a => ElfClass -> a

Size of segment table entry.

Sybmol table

data SymbolXX c

Parsed ELF symbol table entry

Constructors

SymbolXX

Fields

• stName :: Word32

  Symbol name

• stInfo :: Word8

  Type and Binding attributes

• stOther :: Word8

  Reserved

• stShNdx :: ElfSectionIndex

  Section table index

• stValue :: WordXX c

  Symbol value

• stSize :: WordXX c

  Size of object

Instances

SingI a => Binary (Be (SymbolXX a))

Defined in Data.Elf.Headers

Methods

put :: Be (SymbolXX a) -> Put

get :: Get (Be (SymbolXX a))

putList :: [Be (SymbolXX a)] -> Put

SingI a => Binary (Le (SymbolXX a))

Defined in Data.Elf.Headers

Methods

put :: Le (SymbolXX a) -> Put

get :: Get (Le (SymbolXX a))

putList :: [Le (SymbolXX a)] -> Put

symbolTableEntrySize :: Num a => ElfClass -> a

Size of symbol table entry.

Relocation table

data RelaXX c

Parsed relocation table entry (ElfXX_Rela)

Constructors

RelaXX

Fields

• relaOffset :: WordXX c

  Address of reference

• relaSym :: Word32

  Symbol table index

• relaType :: Word32

  Relocation type

• relaAddend :: WordXX c

  Constant part of expression

Instances

SingI a => Binary (Be (RelaXX a))

Defined in Data.Elf.Headers

Methods

put :: Be (RelaXX a) -> Put

get :: Get (Be (RelaXX a))

putList :: [Be (RelaXX a)] -> Put

SingI a => Binary (Le (RelaXX a))

Defined in Data.Elf.Headers

Methods

put :: Le (RelaXX a) -> Put

get :: Get (Le (RelaXX a))

putList :: [Le (RelaXX a)] -> Put

relocationTableAEntrySize :: forall a. IsElfClass a => WordXX a

Size of RelaXX a in bytes.

Parse header and section and segment tables

newtype HeadersXX a

The type that helps to make the sigma type of the result of the parseHeaders function

Constructors

HeadersXX (HeaderXX a, [SectionXX a], [SegmentXX a])

parseHeaders :: MonadThrow m => ByteString -> m (Sigma ElfClass (TyCon1 HeadersXX))

Parse ELF file and produce header and section and segment tables

Parse/serialize array of data

BList is an internal newtype for [a] that is an instance of Binary. When serializing, the Binary instance for BList does not write the length of the array to the stream. Instead, parser just reads all the stream till the end.

parseBList

Arguments

:: (MonadThrow m, Binary (Le a), Binary (Be a))

=> ElfData

Tells if parser should expect big or little endian data

-> ByteString

Data for parsing

-> m [a]

Parse an array

serializeBList

Arguments

:: (Binary (Le a), Binary (Be a))

=> ElfData

Tells if serializer should tread the data as bit or little endian

-> [a]

The array to serialize

-> ByteString

Serialize an array

Misc helpers

sectionIsSymbolTable :: ElfSectionType -> Bool

Test if the section with such integer value of section type field (sType) contains symbol table