Data.Dwarf

Description

Parses the DWARF 2 and DWARF 3 specifications at http:www.dwarfstd.org given the debug sections in ByteString form.

Synopsis

Documentation

Arguments

:: Bool	True for little endian target addresses. False for big endian.
-> ByteString	ByteString for the .debug_info section.
-> ByteString	ByteString for the .debug_abbrev section.
-> ByteString	ByteString for the .debug_str section.
-> Map Word64 DIE	A map from the unique ids to their corresponding DWARF information entries.

Parses the .debug_info section (as ByteString) using the .debug_abbrev and .debug_str sections.

infoCompileUnit Source

Arguments

:: ByteString	Contents of .debug_info
-> Word64	Offset into .debug_info header
-> Word64	Offset of compile unit DIE.

Returns compilation unit id given the header offset into .debug_info

parseDwarfAranges :: Bool -> Bool -> ByteString -> [([(Word64, Word64)], Word64)]Source

Parses the .debug_aranges section (as ByteString) into a map from an address range to a debug info id that indexes the DwarfInfo.

parseDwarfPubnames :: Bool -> Bool -> ByteString -> Map String [Word64]Source

Parses the .debug_pubnames section (as ByteString) into a map from a value name to a debug info id in the DwarfInfo.

parseDwarfPubtypes :: Bool -> Bool -> ByteString -> Map String [Word64]Source

Parses the .debug_pubtypes section (as ByteString) into a map from a type name to a debug info id in the DwarfInfo.

parseDwarfMacInfo :: ByteString -> [DW_MACINFO]Source

Retrieves the macro information for a compilation unit from a given substring of the .debug_macinfo section. The offset into the .debug_macinfo section is obtained from the DW_AT_macro_info attribute of a compilation unit DIE.

parseDwarfRanges :: DwarfReader -> ByteString -> [Either Word64 (Word64, Word64)]Source

Retrieves the non-contiguous address ranges for a compilation unit from a given substring of the .debug_ranges section. The offset into the .debug_ranges section is obtained from the DW_AT_ranges attribute of a compilation unit DIE. Left results are base address entries. Right results are address ranges.

parseDwarfLoc :: DwarfReader -> ByteString -> [Either Word64 (Word64, Word64, ByteString)]Source

Retrieves the location list expressions from a given substring of the .debug_loc section. The offset into the .debug_loc section is obtained from an attribute of class loclistptr for a given DIE. Left results are base address entries. Right results are address ranges and a location expression.

parseDwarfLine :: Bool -> Bool -> ByteString -> ([String], [DW_LNE])Source

Retrieves the line information for a DIE from a given substring of the .debug_line section. The offset into the .debug_line section is obtained from the DW_AT_stmt_list attribute of a DIE.

parseDwarfFrame Source

Arguments

:: Bool	True for little endian data. False for big endian.
-> Bool	True for 64-bit target addresses. False of 32-bit target addresses.
-> ByteString	ByteString for the .debug_frame section.
-> [DW_CIEFDE]

Parse the .debug_frame section into a list of DW_CIEFDE records.

parseDW_OP :: DwarfReader -> ByteString -> DW_OP Source

Parse a ByteString into a DWARF opcode. This will be needed for further decoding of DIE attributes.

dw_ate :: Num a => a -> DW_ATE Source

dw_ds :: Num a => a -> DW_DS Source

dw_end :: Num a => a -> DW_END Source

dw_access :: Num a => a -> DW_ACCESS Source

dw_vis :: Num a => a -> DW_VIS Source

dw_virtuality :: Num a => a -> DW_VIRTUALITY Source

dw_lang :: Num a => a -> DW_LANG Source

dw_inl :: Num a => a -> DW_INL Source

dw_cc :: Num a => a -> DW_CC Source

dw_ord :: Num a => a -> DW_ORD Source

dw_dsc :: Num a => a -> DW_DSC Source

(!?) :: DIE -> DW_AT -> [DW_ATVAL]Source

Utility function for retrieving the list of values for a specified attribute from a DWARF information entry.

data DwarfReader Source

Type containing functions and data needed for decoding DWARF information.

Constructors

DwarfReader

Fields

littleEndian :: Bool: True for little endian encoding.
dwarf64 :: Bool: True for 64-bit DWARF encoding.
target64 :: Bool: True for 64-bit pointers on target machine.
largestOffset :: Word64: Largest permissible file offset.
largestTargetAddress :: Word64: Largest permissible target address.
getWord16 :: Get Word16: Action for reading a 16-bit word.
getWord32 :: Get Word32: Action for reading a 32-bit word.
getWord64 :: Get Word64: Action for reading a 64-bit word.
getDwarfOffset :: Get Word64: Action for reading a offset for the DWARF file.
getDwarfTargetAddress :: Get Word64: Action for reading a pointer for the target machine.

Instances

Eq DwarfReader
Show DwarfReader

data DIE Source

The dwarf information entries form a graph of nodes tagged with attributes. Please refer to the DWARF specification for semantics. Although it looks like a tree, there can be attributes which have adjacency information which will introduce cross-branch edges.

Constructors

DIE

Fields

dieId :: Word64: Unique identifier for this entry.
dieParent :: Maybe Word64: Unique identifier of this entry's parent.
dieChildren :: [Word64]: Unique identifiers of this entry's children.
dieSiblingLeft :: Maybe Word64: Unique identifier of the left sibling in the DIE tree, if one exists.
dieSiblingRight :: Maybe Word64: Unique identifier of the right sibling in the DIE tree, if one exists.
dieTag :: DW_TAG: Type tag.
dieAttributes :: [(DW_AT, DW_ATVAL)]: Attribute tag and value pairs.
dieReader :: DwarfReader: Decoder used to decode this entry. May be needed to further parse attribute values.

Instances

Eq DIE
Show DIE

data DW_MACINFO Source

Constructors

DW_MACINFO_define Word64 String	Line number and defined symbol with definition
DW_MACINFO_undef Word64 String	Line number and undefined symbol
DW_MACINFO_start_file Word64 Word64	Marks start of file with the line where the file was included from and a source file index
DW_MACINFO_end_file	Marks end of file
DW_MACINFO_vendor_ext Word64 String	Implementation defined

Instances

Eq DW_MACINFO
Show DW_MACINFO

data DW_CIEFDE Source

Constructors

DW_CIE
Fields cieAugmentation :: String cieCodeAlignmentFactor :: Word64 cieDataAlignmentFactor :: Int64 cieReturnAddressRegister :: Word64 cieInitialInstructions :: [DW_CFA]
DW_FDE
Fields fdeCiePointer :: Word64 fdeInitialLocation :: Word64 fdeAddressRange :: Word64 fdeInstructions :: [DW_CFA]

Instances

Eq DW_CIEFDE
Show DW_CIEFDE

data DW_OP Source

Constructors

DW_OP_addr Word64
DW_OP_deref
DW_OP_const1u Word8
DW_OP_const1s Int8
DW_OP_const2u Word16
DW_OP_const2s Int16
DW_OP_const4u Word32
DW_OP_const4s Int32
DW_OP_const8u Word64
DW_OP_const8s Int64
DW_OP_constu Word64
DW_OP_consts Int64
DW_OP_dup
DW_OP_drop
DW_OP_over
DW_OP_pick Word8
DW_OP_swap
DW_OP_rot
DW_OP_xderef
DW_OP_abs
DW_OP_and
DW_OP_div
DW_OP_minus
DW_OP_mod
DW_OP_mul
DW_OP_neg
DW_OP_not
DW_OP_or
DW_OP_plus
DW_OP_plus_uconst Word64
DW_OP_shl
DW_OP_shr
DW_OP_shra
DW_OP_xor
DW_OP_skip Int16
DW_OP_bra Int16
DW_OP_eq
DW_OP_ge
DW_OP_gt
DW_OP_le
DW_OP_lt
DW_OP_ne
DW_OP_lit0
DW_OP_lit1
DW_OP_lit2
DW_OP_lit3
DW_OP_lit4
DW_OP_lit5
DW_OP_lit6
DW_OP_lit7
DW_OP_lit8
DW_OP_lit9
DW_OP_lit10
DW_OP_lit11
DW_OP_lit12
DW_OP_lit13
DW_OP_lit14
DW_OP_lit15
DW_OP_lit16
DW_OP_lit17
DW_OP_lit18
DW_OP_lit19
DW_OP_lit20
DW_OP_lit21
DW_OP_lit22
DW_OP_lit23
DW_OP_lit24
DW_OP_lit25
DW_OP_lit26
DW_OP_lit27
DW_OP_lit28
DW_OP_lit29
DW_OP_lit30
DW_OP_lit31
DW_OP_reg0
DW_OP_reg1
DW_OP_reg2
DW_OP_reg3
DW_OP_reg4
DW_OP_reg5
DW_OP_reg6
DW_OP_reg7
DW_OP_reg8
DW_OP_reg9
DW_OP_reg10
DW_OP_reg11
DW_OP_reg12
DW_OP_reg13
DW_OP_reg14
DW_OP_reg15
DW_OP_reg16
DW_OP_reg17
DW_OP_reg18
DW_OP_reg19
DW_OP_reg20
DW_OP_reg21
DW_OP_reg22
DW_OP_reg23
DW_OP_reg24
DW_OP_reg25
DW_OP_reg26
DW_OP_reg27
DW_OP_reg28
DW_OP_reg29
DW_OP_reg30
DW_OP_reg31
DW_OP_breg0 Int64
DW_OP_breg1 Int64
DW_OP_breg2 Int64
DW_OP_breg3 Int64
DW_OP_breg4 Int64
DW_OP_breg5 Int64
DW_OP_breg6 Int64
DW_OP_breg7 Int64
DW_OP_breg8 Int64
DW_OP_breg9 Int64
DW_OP_breg10 Int64
DW_OP_breg11 Int64
DW_OP_breg12 Int64
DW_OP_breg13 Int64
DW_OP_breg14 Int64
DW_OP_breg15 Int64
DW_OP_breg16 Int64
DW_OP_breg17 Int64
DW_OP_breg18 Int64
DW_OP_breg19 Int64
DW_OP_breg20 Int64
DW_OP_breg21 Int64
DW_OP_breg22 Int64
DW_OP_breg23 Int64
DW_OP_breg24 Int64
DW_OP_breg25 Int64
DW_OP_breg26 Int64
DW_OP_breg27 Int64
DW_OP_breg28 Int64
DW_OP_breg29 Int64
DW_OP_breg30 Int64
DW_OP_breg31 Int64
DW_OP_regx Word64
DW_OP_fbreg Int64
DW_OP_bregx Word64 Int64
DW_OP_piece Word64
DW_OP_deref_size Word8
DW_OP_xderef_size Word8
DW_OP_nop
DW_OP_push_object_address
DW_OP_call2 Word16
DW_OP_call4 Word32
DW_OP_call_ref Word64
DW_OP_form_tls_address
DW_OP_call_frame_cfa
DW_OP_bit_piece Word64 Word64

Instances

Eq DW_OP
Show DW_OP

data DW_TAG Source

Constructors

DW_TAG_array_type
DW_TAG_class_type
DW_TAG_entry_point
DW_TAG_enumeration_type
DW_TAG_formal_parameter
DW_TAG_imported_declaration
DW_TAG_label
DW_TAG_lexical_block
DW_TAG_member
DW_TAG_pointer_type
DW_TAG_reference_type
DW_TAG_compile_unit
DW_TAG_string_type
DW_TAG_structure_type
DW_TAG_subroutine_type
DW_TAG_typedef
DW_TAG_union_type
DW_TAG_unspecified_parameters
DW_TAG_variant
DW_TAG_common_block
DW_TAG_common_inclusion
DW_TAG_inheritance
DW_TAG_inlined_subroutine
DW_TAG_module
DW_TAG_ptr_to_member_type
DW_TAG_set_type
DW_TAG_subrange_type
DW_TAG_with_stmt
DW_TAG_access_declaration
DW_TAG_base_type
DW_TAG_catch_block
DW_TAG_const_type
DW_TAG_constant
DW_TAG_enumerator
DW_TAG_file_type
DW_TAG_friend
DW_TAG_namelist
DW_TAG_namelist_item
DW_TAG_packed_type
DW_TAG_subprogram
DW_TAG_template_type_parameter
DW_TAG_template_value_parameter
DW_TAG_thrown_type
DW_TAG_try_block
DW_TAG_variant_part
DW_TAG_variable
DW_TAG_volatile_type
DW_TAG_dwarf_procedure
DW_TAG_restrict_type
DW_TAG_interface_type
DW_TAG_namespace
DW_TAG_imported_module
DW_TAG_unspecified_type
DW_TAG_partial_unit
DW_TAG_imported_unit
DW_TAG_condition
DW_TAG_shared_type

Instances

Eq DW_TAG
Show DW_TAG

data DW_AT Source

Constructors

DW_AT_sibling	reference
DW_AT_location	block, loclistptr
DW_AT_name	string
DW_AT_ordering	constant
DW_AT_byte_size	block, constant, reference
DW_AT_bit_offset	block, constant, reference
DW_AT_bit_size	block, constant, reference
DW_AT_stmt_list	lineptr
DW_AT_low_pc	address
DW_AT_high_pc	address
DW_AT_language	constant
DW_AT_discr	reference
DW_AT_discr_value	constant
DW_AT_visibility	constant
DW_AT_import	reference
DW_AT_string_length	block, loclistptr
DW_AT_common_reference	reference
DW_AT_comp_dir	string
DW_AT_const_value	block, constant, string
DW_AT_containing_type	reference
DW_AT_default_value	reference
DW_AT_inline	constant
DW_AT_is_optional	flag
DW_AT_lower_bound	block, constant, reference
DW_AT_producer	string
DW_AT_prototyped	flag
DW_AT_return_addr	block, loclistptr
DW_AT_start_scope	constant
DW_AT_bit_stride	constant
DW_AT_upper_bound	block, constant, reference
DW_AT_abstract_origin	reference
DW_AT_accessibility	constant
DW_AT_address_class	constant
DW_AT_artificial	flag
DW_AT_base_types	reference
DW_AT_calling_convention	constant
DW_AT_count	block, constant, reference
DW_AT_data_member_location	block, constant, loclistptr
DW_AT_decl_column	constant
DW_AT_decl_file	constant
DW_AT_decl_line	constant
DW_AT_declaration	flag
DW_AT_discr_list	block
DW_AT_encoding	constant
DW_AT_external	flag
DW_AT_frame_base	block, loclistptr
DW_AT_friend	reference
DW_AT_identifier_case	constant
DW_AT_macro_info	macptr
DW_AT_namelist_item	block
DW_AT_priority	reference
DW_AT_segment	block, loclistptr
DW_AT_specification	reference
DW_AT_static_link	block, loclistptr
DW_AT_type	reference
DW_AT_use_location	block, loclistptr
DW_AT_variable_parameter	flag
DW_AT_virtuality	constant
DW_AT_vtable_elem_location	block, loclistptr
DW_AT_allocated	block, constant, reference
DW_AT_associated	block, constant, reference
DW_AT_data_location	block
DW_AT_byte_stride	block, constant, reference
DW_AT_entry_pc	address
DW_AT_use_UTF8	flag
DW_AT_extension	reference
DW_AT_ranges	rangelistptr
DW_AT_trampoline	address, flag, reference, string
DW_AT_call_column	constant
DW_AT_call_file	constant
DW_AT_call_line	constant
DW_AT_description	string
DW_AT_binary_scale	constant
DW_AT_decimal_scale	constant
DW_AT_small	reference
DW_AT_decimal_sign	constant
DW_AT_digit_count	constant
DW_AT_picture_string	string
DW_AT_mutable	flag
DW_AT_threads_scaled	flag
DW_AT_explicit	flag
DW_AT_object_pointer	reference
DW_AT_endianity	constant
DW_AT_elemental	flag
DW_AT_pure	flag
DW_AT_recursive	flag
DW_AT_user Word64	user extension

Instances

Eq DW_AT
Show DW_AT

data DW_ATVAL Source

Constructors

DW_ATVAL_INT Int64
DW_ATVAL_UINT Word64
DW_ATVAL_STRING String
DW_ATVAL_BLOB ByteString
DW_ATVAL_BOOL Bool

Instances

Eq DW_ATVAL
Show DW_ATVAL

data DW_LNE Source

Constructors

DW_LNE
Fields lnmAddress :: Word64 lnmFile :: Word64 lnmLine :: Word64 lnmColumn :: Word64 lnmStatement :: Bool lnmBasicBlock :: Bool lnmEndSequence :: Bool lnmPrologueEnd :: Bool lnmEpilogueBegin :: Bool lnmISA :: Word64 lnmFiles :: [(String, Word64, Word64, Word64)]

Instances

Eq DW_LNE
Show DW_LNE

data DW_DS Source

Constructors

DW_DS_unsigned
DW_DS_leading_overpunch
DW_DS_trailing_overpunch
DW_DS_leading_separate
DW_DS_trailing_separate

Instances

Eq DW_DS
Show DW_DS

data DW_END Source

Constructors

DW_END_default
DW_END_big
DW_END_little

Instances

Eq DW_END
Show DW_END

data DW_ACCESS Source

Constructors

DW_ACCESS_public
DW_ACCESS_protected
DW_ACCESS_private

Instances

Eq DW_ACCESS
Show DW_ACCESS

data DW_VIS Source

Constructors

DW_VIS_local
DW_VIS_exported
DW_VIS_qualified

Instances

Eq DW_VIS
Show DW_VIS

data DW_VIRTUALITY Source

Constructors

DW_VIRTUALITY_none
DW_VIRTUALITY_virtual
DW_VIRTUALITY_pure_virtual

Instances

Eq DW_VIRTUALITY
Show DW_VIRTUALITY

data DW_ID Source

Constructors

DW_ID_case_sensitive
DW_ID_up_case
DW_ID_down_case
DW_ID_case_insensitive

Instances

Eq DW_ID
Show DW_ID

data DW_INL Source

Constructors

DW_INL_not_inlined
DW_INL_inlined
DW_INL_declared_not_inlined
DW_INL_declared_inlined

Instances

Eq DW_INL
Show DW_INL

data DW_CC Source

Constructors

DW_CC_normal
DW_CC_program
DW_CC_nocall

Instances

Eq DW_CC
Show DW_CC

data DW_ORD Source

Constructors

DW_ORD_row_major
DW_ORD_col_major

Instances

Eq DW_ORD
Show DW_ORD

data DW_DSC Source

Constructors

DW_DSC_label
DW_DSC_range

Instances

Eq DW_DSC
Show DW_DSC

DW_CFA_advance_loc Word8
DW_CFA_offset Word8 Word64
DW_CFA_restore Word8
DW_CFA_nop
DW_CFA_set_loc Word64
DW_CFA_advance_loc1 Word8
DW_CFA_advance_loc2 Word16
DW_CFA_advance_loc4 Word32
DW_CFA_offset_extended Word64 Word64
DW_CFA_restore_extended Word64
DW_CFA_undefined Word64
DW_CFA_same_value Word64
DW_CFA_register Word64 Word64
DW_CFA_remember_state
DW_CFA_restore_state
DW_CFA_def_cfa Word64 Word64
DW_CFA_def_cfa_register Word64
DW_CFA_def_cfa_offset Word64
DW_CFA_def_cfa_expression ByteString
DW_CFA_expression Word64 ByteString
DW_CFA_offset_extended_sf Word64 Int64
DW_CFA_def_cfa_sf Word64 Int64
DW_CFA_def_cfa_offset_sf Int64
DW_CFA_val_offset Word64 Word64
DW_CFA_val_offset_sf Word64 Int64
DW_CFA_val_expression Word64 ByteString

DW_ATE_address
DW_ATE_boolean
DW_ATE_complex_float
DW_ATE_float
DW_ATE_signed
DW_ATE_signed_char
DW_ATE_unsigned
DW_ATE_unsigned_char
DW_ATE_imaginary_float
DW_ATE_packed_decimal
DW_ATE_numeric_string
DW_ATE_edited
DW_ATE_signed_fixed
DW_ATE_unsigned_fixed
DW_ATE_decimal_float

DW_LANG_C89
DW_LANG_C
DW_LANG_Ada83
DW_LANG_C_plus_plus
DW_LANG_Cobol74
DW_LANG_Cobol85
DW_LANG_Fortran77
DW_LANG_Fortran90
DW_LANG_Pascal83
DW_LANG_Modula2
DW_LANG_Java
DW_LANG_C99
DW_LANG_Ada95
DW_LANG_Fortran95
DW_LANG_PLI
DW_LANG_ObjC
DW_LANG_ObjC_plus_plus
DW_LANG_UPC
DW_LANG_D