mirror of
https://github.com/Ed94/raddebugger.git
synced 2026-07-27 18:00:12 +00:00
268 lines
15 KiB
C
268 lines
15 KiB
C
// Copyright (c) Epic Games Tools
|
|
// Licensed under the MIT license (https://opensource.org/license/mit/)
|
|
|
|
#ifndef RADDUMP_H
|
|
#define RADDUMP_H
|
|
|
|
#define RD_INDENT_WIDTH 2
|
|
#define RD_INDENT_MAX 4096
|
|
|
|
#define rd_printf(f, ...) str8_list_pushf(arena, out, "%S" f, indent, __VA_ARGS__)
|
|
#define rd_newline() str8_list_pushf(arena, out, "");
|
|
#define rd_errorf(f, ...) rd_stderr("ERROR: "f, __VA_ARGS__)
|
|
#define rd_warningf(f, ...) rd_stderr("WARNING: "f, __VA_ARGS__)
|
|
#define rd_indent() do { if (indent.size + RD_INDENT_WIDTH <= RD_INDENT_MAX) { indent.size += RD_INDENT_WIDTH; } else { Assert(!"indent overflow"); } } while (0)
|
|
#define rd_unindent() do { if (indent.size >= RD_INDENT_WIDTH) { indent.size -= RD_INDENT_WIDTH; } else { Assert(!"unbalanced indent"); } } while (0)
|
|
|
|
typedef U64 RD_Option;
|
|
|
|
#define RD_Option_Help (1ull << 0)
|
|
#define RD_Option_Version (1ull << 1)
|
|
#define RD_Option_Headers (1ull << 2)
|
|
#define RD_Option_Sections (1ull << 3)
|
|
#define RD_Option_Debug (1ull << 4)
|
|
#define RD_Option_Imports (1ull << 5)
|
|
#define RD_Option_Exports (1ull << 6)
|
|
#define RD_Option_Disasm (1ull << 7)
|
|
#define RD_Option_Rawdata (1ull << 8)
|
|
#define RD_Option_Tls (1ull << 9)
|
|
#define RD_Option_Codeview (1ull << 10)
|
|
#define RD_Option_Symbols (1ull << 11)
|
|
#define RD_Option_Relocs (1ull << 12)
|
|
#define RD_Option_Exceptions (1ull << 13)
|
|
#define RD_Option_LoadConfig (1ull << 14)
|
|
#define RD_Option_Resources (1ull << 15)
|
|
#define RD_Option_LongNames (1ull << 16)
|
|
// DWARF
|
|
#define RD_Option_DebugInfo (1ull << 17)
|
|
#define RD_Option_DebugAbbrev (1ull << 18)
|
|
#define RD_Option_DebugLine (1ull << 19)
|
|
#define RD_Option_DebugStr (1ull << 20)
|
|
#define RD_Option_DebugLoc (1ull << 21)
|
|
#define RD_Option_DebugRanges (1ull << 22)
|
|
#define RD_Option_DebugARanges (1ull << 23)
|
|
#define RD_Option_DebugAddr (1ull << 24)
|
|
#define RD_Option_DebugLocLists (1ull << 25)
|
|
#define RD_Option_DebugRngLists (1ull << 26)
|
|
#define RD_Option_DebugPubNames (1ull << 27)
|
|
#define RD_Option_DebugPubTypes (1ull << 28)
|
|
#define RD_Option_DebugLineStr (1ull << 29)
|
|
#define RD_Option_DebugStrOffsets (1ull << 30)
|
|
#define RD_Option_Dwarf \
|
|
(RD_Option_DebugInfo | \
|
|
RD_Option_DebugAbbrev | \
|
|
RD_Option_DebugLine | \
|
|
RD_Option_DebugStr | \
|
|
RD_Option_DebugLoc | \
|
|
RD_Option_DebugRanges | \
|
|
RD_Option_DebugARanges | \
|
|
RD_Option_DebugAddr | \
|
|
RD_Option_DebugLocLists | \
|
|
RD_Option_DebugRngLists | \
|
|
RD_Option_DebugPubNames | \
|
|
RD_Option_DebugPubTypes | \
|
|
RD_Option_DebugLineStr | \
|
|
RD_Option_DebugStrOffsets)
|
|
#define RD_Option_RelaxDwarfParser (1ull << 31ull)
|
|
// RDI
|
|
#define RD_Option_NoRdi (1ull << 32ull)
|
|
#define RD_Option_RdiDataSections (1ull << 33ull)
|
|
#define RD_Option_RdiTopLevelInfo (1ull << 34ull)
|
|
#define RD_Option_RdiBinarySections (1ull << 35ull)
|
|
#define RD_Option_RdiFilePaths (1ull << 36ull)
|
|
#define RD_Option_RdiSourceFiles (1ull << 37ull)
|
|
#define RD_Option_RdiLineTables (1ull << 38ull)
|
|
#define RD_Option_RdiSourceLineMaps (1ull << 39ull)
|
|
#define RD_Option_RdiUnits (1ull << 40ull)
|
|
#define RD_Option_RdiUnitVMap (1ull << 41ull)
|
|
#define RD_Option_RdiTypeNodes (1ull << 42ull)
|
|
#define RD_Option_RdiUserDefinedTypes (1ull << 43ull)
|
|
#define RD_Option_RdiGlobalVars (1ull << 44ull)
|
|
#define RD_Option_RdiGlobalVarsVMap (1ull << 45ull)
|
|
#define RD_Option_RdiThreadVars (1ull << 46ull)
|
|
#define RD_Option_RdiConstants (1ull << 47ull)
|
|
#define RD_Option_RdiProcedures (1ull << 48ull)
|
|
#define RD_Option_RdiScopes (1ull << 49ull)
|
|
#define RD_Option_RdiScopeVMap (1ull << 50ull)
|
|
#define RD_Option_RdiInlineSites (1ull << 51ull)
|
|
#define RD_Option_RdiNameMaps (1ull << 52ull)
|
|
#define RD_Option_RdiStrings (1ull << 53ull)
|
|
#define RD_Option_RdiAll (RD_Option_RdiDataSections | \
|
|
RD_Option_RdiTopLevelInfo | \
|
|
RD_Option_RdiBinarySections | \
|
|
RD_Option_RdiFilePaths | \
|
|
RD_Option_RdiSourceFiles | \
|
|
RD_Option_RdiLineTables | \
|
|
RD_Option_RdiSourceLineMaps | \
|
|
RD_Option_RdiUnits | \
|
|
RD_Option_RdiUnitVMap | \
|
|
RD_Option_RdiTypeNodes | \
|
|
RD_Option_RdiUserDefinedTypes | \
|
|
RD_Option_RdiGlobalVars | \
|
|
RD_Option_RdiGlobalVarsVMap | \
|
|
RD_Option_RdiThreadVars | \
|
|
RD_Option_RdiConstants | \
|
|
RD_Option_RdiProcedures | \
|
|
RD_Option_RdiScopes | \
|
|
RD_Option_RdiScopeVMap | \
|
|
RD_Option_RdiInlineSites | \
|
|
RD_Option_RdiNameMaps | \
|
|
RD_Option_RdiStrings)
|
|
|
|
|
|
typedef struct RD_Marker
|
|
{
|
|
U64 off;
|
|
String8 string;
|
|
} RD_Marker;
|
|
|
|
typedef struct RD_MarkerArray
|
|
{
|
|
U64 count;
|
|
RD_Marker *v;
|
|
} RD_MarkerArray;
|
|
|
|
typedef struct MarkerNode
|
|
{
|
|
struct MarkerNode *next;
|
|
RD_Marker v;
|
|
} RD_MarkerNode;
|
|
|
|
typedef struct RD_MarkerList
|
|
{
|
|
U64 count;
|
|
RD_MarkerNode *first;
|
|
RD_MarkerNode *last;
|
|
} RD_MarkerList;
|
|
|
|
typedef struct RD_DisasmResult
|
|
{
|
|
String8 text;
|
|
U64 size;
|
|
} RD_DisasmResult;
|
|
|
|
typedef struct RD_Section
|
|
{
|
|
String8 name;
|
|
String8 raw_data;
|
|
} RD_Section;
|
|
|
|
typedef struct RD_SectionArray
|
|
{
|
|
U64 count;
|
|
RD_Section *v;
|
|
} RD_SectionArray;
|
|
|
|
typedef struct RD_Line
|
|
{
|
|
String8 file_path;
|
|
U32 line_num;
|
|
} RD_Line;
|
|
|
|
////////////////////////////////
|
|
|
|
// raddump
|
|
|
|
internal B32 rd_is_rdi(String8 raw_data);
|
|
|
|
internal String8 rd_string_from_flags(Arena *arena, String8List list, U64 remaining_flags);
|
|
|
|
internal void rd_format_preamble(Arena *arena, String8List *out, String8 indent, String8 input_path, String8 raw_data);
|
|
|
|
// Markers
|
|
|
|
internal RD_MarkerArray * rd_section_markers_from_coff_symbol_table(Arena *arena, String8 string_table, U64 section_count, COFF_Symbol32Array symbols);
|
|
|
|
// Sections
|
|
|
|
internal RD_SectionArray rd_sections_from_coff_section_table(Arena *arnea, String8 raw_image, U64 string_table_off, U64 section_count, COFF_SectionHeader *sections);
|
|
|
|
// Disasm
|
|
|
|
internal RD_DisasmResult rd_disasm_next_instruction(Arena *arena, Arch arch, U64 addr, String8 raw_code);
|
|
internal void rd_print_disasm (Arena *arena, String8List *out, String8 indent, Arch arch, U64 image_base, U64 sect_off, U64 marker_count, RD_Marker *markers, String8 raw_code);
|
|
|
|
// Raw Data
|
|
|
|
internal String8 rd_format_hex_array(Arena *arena, U8 *ptr, U64 size);
|
|
internal void rd_print_raw_data (Arena *arena, String8List *out, String8 indent, U64 bytes_per_row, U64 marker_count, RD_Marker *markers, String8 raw_data);
|
|
|
|
// DWARF
|
|
|
|
internal String8List dw_string_list_from_expression (Arena *arena, String8 raw_data, U64 cu_base, U64 address_size, Arch arch, DW_Version ver, DW_Ext ext, DW_Format format);
|
|
internal String8 dw_format_expression_single_line(Arena *arena, String8 raw_data, U64 cu_base, U64 address_size, Arch arch, DW_Version ver, DW_Ext ext, DW_Format format);
|
|
internal String8 dw_format_eh_ptr_enc (Arena *arena, DW_EhPtrEnc enc);
|
|
internal void dw_print_cfi_program (Arena *arena, String8List *out, String8 indent, String8 raw_data, DW_CIEUnpacked *cie, DW_EhPtrCtx *ptr_ctx, Arch arch, DW_Version ver, DW_Ext ext, DW_Format format);
|
|
|
|
internal void dw_print_eh_frame (Arena *arena, String8List *out, String8 indent, String8 raw_eh_frame, Arch arch, DW_Version ver, DW_Ext ext, DW_EhPtrCtx *ptr_ctx);
|
|
internal void dw_print_debug_info (Arena *arena, String8List *out, String8 indent, DW_Input *input, DW_ListUnitInput lu_input, Arch arch, B32 relaxed);
|
|
internal void dw_print_debug_abbrev (Arena *arena, String8List *out, String8 indent, DW_Input *input);
|
|
internal void dw_print_debug_line (Arena *arena, String8List *out, String8 indent, DW_Input *input, DW_ListUnitInput lu_input, B32 relaxed);
|
|
internal void dw_print_debug_str (Arena *arena, String8List *out, String8 indent, DW_Input *input);
|
|
internal void dw_print_debug_loc (Arena *arena, String8List *out, String8 indent, DW_Input *input, Arch arch, ExecutableImageKind image_type, B32 relaxed);
|
|
internal void dw_print_debug_ranges (Arena *arena, String8List *out, String8 indent, DW_Input *input, Arch arch, ExecutableImageKind image_type, B32 relaxed);
|
|
internal void dw_print_debug_aranges (Arena *arena, String8List *out, String8 indent, DW_Input *input);
|
|
internal void dw_print_debug_addr (Arena *arena, String8List *out, String8 indent, DW_Input *input);
|
|
internal void dw_print_debug_loclists (Arena *arena, String8List *out, String8 indent, DW_Input *input, Rng1U64Array segment_vranges, Arch arch);
|
|
internal void dw_print_debug_rnglists (Arena *arena, String8List *out, String8 indent, DW_Input *input, Rng1U64Array segment_vranges);
|
|
internal void dw_print_debug_pubnames (Arena *arena, String8List *out, String8 indent, DW_Input *input);
|
|
internal void dw_print_debug_pubtypes (Arena *arena, String8List *out, String8 indent, DW_Input *input);
|
|
internal void dw_print_debug_line_str (Arena *arena, String8List *out, String8 indent, DW_Input *input);
|
|
internal void dw_print_debug_str_offsets(Arena *arena, String8List *out, String8 indent, DW_Input *input);
|
|
|
|
// CodeView
|
|
|
|
internal void cv_print_binary_annots (Arena *arena, String8List *out, String8 indent, CV_Arch arch, String8 raw_data);
|
|
internal void cv_print_lvar_addr_range(Arena *arena, String8List *out, String8 indent, CV_LvarAddrRange range);
|
|
internal void cv_print_lvar_addr_gap (Arena *arena, String8List *out, String8 indent, String8 raw_data);
|
|
internal void cv_print_lvar_attr (Arena *arena, String8List *out, String8 indent, CV_LocalVarAttr attr);
|
|
internal void cv_print_symbol (Arena *arena, String8List *out, String8 indent, CV_Arch arch, CV_TypeIndex min_itype, CV_SymKind type, String8 raw_symbol);
|
|
internal U64 cv_print_leaf (Arena *arena, String8List *out, String8 indent, CV_TypeIndex min_itype, CV_LeafKind kind, String8 raw_leaf);
|
|
internal void cv_print_debug_t (Arena *arena, String8List *out, String8 indent, CV_DebugT debug_t);
|
|
internal void cv_print_symbols_c13 (Arena *arena, String8List *out, String8 indent, CV_Arch arch, String8 raw_data);
|
|
internal void cv_print_lines_c13 (Arena *arena, String8List *out, String8 indent, String8 raw_lines);
|
|
internal void cv_print_file_checksums (Arena *arena, String8List *out, String8 indent, String8 raw_chksums);
|
|
internal void cv_print_string_table (Arena *arena, String8List *out, String8 indent, String8 raw_strtab);
|
|
internal void cv_print_inlinee_lines (Arena *arena, String8List *out, String8 indent, String8 raw_data);
|
|
internal void cv_print_symbols_section(Arena *arena, String8List *out, String8 indent, CV_Arch arch, String8 raw_ss);
|
|
|
|
// COFF
|
|
|
|
internal void coff_print_archive_member_header(Arena *arena, String8List *out, String8 indent, COFF_ParsedArchiveMemberHeader header, String8 long_names);
|
|
internal void coff_print_section_table (Arena *arena, String8List *out, String8 indent, String8 string_table, COFF_Symbol32Array symbols, U64 sect_count, COFF_SectionHeader *sect_headers);
|
|
internal void coff_disasm_sections (Arena *arena, String8List *out, String8 indent, String8 raw_data, COFF_MachineType machine, U64 image_base, B32 is_obj, RD_MarkerArray *section_markers, U64 section_count, COFF_SectionHeader *sections);
|
|
internal void coff_raw_data_sections (Arena *arena, String8List *out, String8 indent, String8 raw_data, B32 is_obj, RD_MarkerArray *section_markers, U64 section_count, COFF_SectionHeader *sections);
|
|
internal void coff_print_relocs (Arena *arena, String8List *out, String8 indent, String8 raw_data, String8 string_table, COFF_MachineType machine, U64 sect_count, COFF_SectionHeader *sect_headers, COFF_Symbol32Array symbols);
|
|
internal void coff_print_symbol_table (Arena *arena, String8List *out, String8 indent, String8 raw_data, B32 is_big_obj, String8 string_table, COFF_Symbol32Array symbols);
|
|
internal void coff_print_big_obj_header (Arena *arena, String8List *out, String8 indent, COFF_BigObjHeader *header);
|
|
internal void coff_print_file_header (Arena *arena, String8List *out, String8 indent, COFF_FileHeader *header);
|
|
internal void coff_print_import (Arena *arena, String8List *out, String8 indent, COFF_ParsedArchiveImportHeader *header);
|
|
internal void coff_print_big_obj (Arena *arena, String8List *out, String8 indent, String8 raw_data, RD_Option opts);
|
|
internal void coff_print_obj (Arena *arena, String8List *out, String8 indent, String8 raw_data, RD_Option opts);
|
|
internal void coff_print_archive (Arena *arena, String8List *out, String8 indent, String8 raw_archive, RD_Option opts);
|
|
|
|
// MSVC CRT
|
|
|
|
internal void mscrt_print_eh_handler_type32(Arena *arena, String8List *out, String8 indent, RDI_Parsed *rdi, MSCRT_EhHandlerType32 *handler);
|
|
|
|
// PE
|
|
|
|
internal void pe_print_data_directory_ranges(Arena *arena, String8List *out, String8 indent, U64 count, PE_DataDirectory *dirs);
|
|
internal void pe_print_optional_header32 (Arena *arena, String8List *out, String8 indent, PE_OptionalHeader32 *opt_header, PE_DataDirectory *dirs);
|
|
internal void pe_print_optional_header32plus(Arena *arena, String8List *out, String8 indent, PE_OptionalHeader32Plus *opt_header, PE_DataDirectory *dirs);
|
|
internal void pe_print_load_config32 (Arena *arena, String8List *out, String8 indent, PE_LoadConfig32 *lc);
|
|
internal void pe_print_load_config64 (Arena *arena, String8List *out, String8 indent, PE_LoadConfig64 *lc);
|
|
internal void pe_print_tls (Arena *arena, String8List *out, String8 indent, PE_ParsedTLS tls);
|
|
internal void pe_print_debug_diretory (Arena *arena, String8List *out, String8 indent, String8 raw_data, String8 raw_dir);
|
|
internal void pe_print_export_table (Arena *arena, String8List *out, String8 indent, PE_ParsedExportTable exptab);
|
|
internal void pe_print_static_import_table (Arena *arena, String8List *out, String8 indent, U64 image_base, PE_ParsedStaticImportTable imptab);
|
|
internal void pe_print_delay_import_table (Arena *arena, String8List *out, String8 indent, U64 image_base, PE_ParsedDelayImportTable imptab);
|
|
internal void pe_print_resources (Arena *arena, String8List *out, String8 indent, PE_ResourceDir *root);
|
|
internal void pe_print_exceptions_x8664 (Arena *arena, String8List *out, String8 indent, U64 section_count, COFF_SectionHeader *sections, String8 raw_data, Rng1U64 except_frange, RDI_Parsed *rdi);
|
|
internal void pe_print_exceptions (Arena *arena, String8List *out, String8 indent, COFF_MachineType machine, U64 section_count, COFF_SectionHeader *sections, String8 raw_data, Rng1U64 except_frange, RDI_Parsed *rdi);
|
|
internal void pe_print_base_relocs (Arena *arena, String8List *out, String8 indent, COFF_MachineType machine, U64 image_base, U64 section_count, COFF_SectionHeader *sections, String8 raw_data, Rng1U64 base_reloc_franges, RDI_Parsed *rdi);
|
|
internal void pe_print (Arena *arena, String8List *out, String8 indent, String8 raw_data, RD_Option opts, RDI_Parsed *rdi);
|
|
|
|
#endif // RADDUMP_H
|
|
|