dumper for SHT_NOTE

This commit is contained in:
Nikita Smith
2025-11-07 14:39:46 -08:00
committed by Ryan Fleury
parent 8bc1e4b21c
commit b596a6ed8a
8 changed files with 694 additions and 197 deletions
+53 -184
View File
@@ -151,40 +151,42 @@ enum
ELF_PFlag_Read = (1 << 2),
};
typedef U32 ELF_SectionCode;
typedef U32 ELF_ShType;
enum
{
ELF_SectionCode_Null = 0,
ELF_SectionCode_ProgBits = 1,
ELF_SectionCode_Symtab = 2,
ELF_SectionCode_Strtab = 3,
ELF_SectionCode_Rela = 4,
ELF_SectionCode_Hash = 5,
ELF_SectionCode_Dynamic = 6,
ELF_SectionCode_Note = 7,
ELF_SectionCode_NoBits = 8,
ELF_SectionCode_Rel = 9,
ELF_SectionCode_Shlib = 10,
ELF_SectionCode_Dynsym = 11,
ELF_SectionCode_InitArray = 14,
ELF_SectionCode_FiniArray = 15, // Array of ptrs to init functions
ELF_SectionCode_PreinitArray = 16, // Array of ptrs to finish functions
ELF_SectionCode_Group = 17, // Array of ptrs to pre-init funcs
ELF_SectionCode_SymtabShndx = 18, // Section contains a section group
ELF_SectionCode_GNU_IncrementalInputs = 0x6fff4700, // Indices for SHN_XINDEX entries
ELF_SectionCode_GNU_Attributes = 0x6ffffff5, // Incremental build data
ELF_SectionCode_GNU_Hash = 0x6ffffff6, // Object attributes
ELF_SectionCode_GNU_LibList = 0x6ffffff7, // GNU style symbol hash table
ELF_SectionCode_SUNW_verdef = 0x6ffffffd,
ELF_SectionCode_SUNW_verneed = 0x6ffffffe, // Versions defined by file
ELF_SectionCode_SUNW_versym = 0x6fffffff, // Versions needed by file
ELF_ShType_Null = 0,
ELF_ShType_ProgBits = 1,
ELF_ShType_Symtab = 2,
ELF_ShType_Strtab = 3,
ELF_ShType_Rela = 4,
ELF_ShType_Hash = 5,
ELF_ShType_Dynamic = 6,
ELF_ShType_Note = 7,
ELF_ShType_NoBits = 8,
ELF_ShType_Rel = 9,
ELF_ShType_Shlib = 10,
ELF_ShType_Dynsym = 11,
ELF_ShType_InitArray = 14,
ELF_ShType_FiniArray = 15, // Array of ptrs to init functions
ELF_ShType_PreinitArray = 16, // Array of ptrs to finish functions
ELF_ShType_Group = 17, // Array of ptrs to pre-init funcs
ELF_ShType_SymtabShndx = 18, // Section contains a section group
ELF_ShType_GNU_IncrementalInputs = 0x6fff4700, // Indices for SHN_XINDEX entries
ELF_ShType_GNU_Attributes = 0x6ffffff5, // Incremental build data
ELF_ShType_GNU_Hash = 0x6ffffff6, // Object attributes
ELF_ShType_GNU_LibList = 0x6ffffff7, // GNU style symbol hash table
ELF_ShType_SUNW_verdef = 0x6ffffffd,
ELF_ShType_SUNW_verneed = 0x6ffffffe, // Versions defined by file
ELF_ShType_SUNW_versym = 0x6fffffff, // Versions needed by file
// Symbol versions
ELF_SectionCode_GNU_verdef = ELF_SectionCode_SUNW_verdef,
ELF_SectionCode_GNU_verneed = ELF_SectionCode_SUNW_verneed,
ELF_SectionCode_GNU_versym = ELF_SectionCode_SUNW_versym,
ELF_SectionCode_Proc,
ELF_SectionCode_User,
ELF_ShType_GNU_verdef = ELF_ShType_SUNW_verdef,
ELF_ShType_GNU_verneed = ELF_ShType_SUNW_verneed,
ELF_ShType_GNU_versym = ELF_ShType_SUNW_versym,
ELF_ShType_Proc,
ELF_ShType_User,
};
typedef U32 ELF_SectionIndex;
@@ -527,140 +529,7 @@ enum
typedef U32 ELF_NoteType;
enum
{
ELF_NoteType_GNU_Abi = 1,
ELF_NoteType_GNU_HwCap = 2,
ELF_NoteType_GNU_BuildId = 3,
ELF_NoteType_GNU_GoldVersion = 4,
ELF_NoteType_GNU_PropertyType0 = 5,
};
typedef U32 ELF_GnuABITag;
enum
{
ELF_GnuABITag_Linux = 0,
ELF_GnuABITag_Hurd = 1,
ELF_GnuABITag_Solaris = 2,
ELF_GnuABITag_FreeBsd = 3,
ELF_GnuABITag_NetBsd = 4,
ELF_GnuABITag_Syllable = 5,
ELF_GnuABITag_Nacl = 6,
};
typedef S32 ELF_GnuProperty;
enum
{
ELF_GnuProperty_LoProc = 0xc0000000,
// processor-specific range
ELF_GnuProperty_HiProc = 0xdfffffff,
ELF_GnuProperty_LoUser = 0xe0000000,
// application-specific range
ELF_GnuProperty_HiUser = 0xffffffff,
ELF_GnuProperty_StackSize = 1,
ELF_GnuProperty_NoCopyOnProtected = 2,
};
typedef U32 ELF_GnuPropertyX86Isa1;
enum
{
ELF_GnuPropertyX86Isa1_BaseLine = (1 << 0),
ELF_GnuPropertyX86Isa1_V2 = (1 << 1),
ELF_GnuPropertyX86Isa1_V3 = (1 << 2),
ELF_GnuPropertyX86Isa1_V4 = (1 << 3),
};
typedef U32 ELF_GnuPropertyX86Compat1Isa1;
enum
{
ELF_GnuPropertyX86Compat1Isa1_486 = (1 << 0),
ELF_GnuPropertyX86Compat1Isa1_586 = (1 << 1),
ELF_GnuPropertyX86Compat1Isa1_686 = (1 << 2),
ELF_GnuPropertyX86Compat1Isa1_SSE = (1 << 3),
ELF_GnuPropertyX86Compat1Isa1_SSE2 = (1 << 4),
ELF_GnuPropertyX86Compat1Isa1_SSE3 = (1 << 5),
ELF_GnuPropertyX86Compat1Isa1_SSSE3 = (1 << 6),
ELF_GnuPropertyX86Compat1Isa1_SSE4_1 = (1 << 7),
ELF_GnuPropertyX86Compat1Isa1_SSE4_2 = (1 << 8),
ELF_GnuPropertyX86Compat1Isa1_AVX = (1 << 9),
ELF_GnuPropertyX86Compat1Isa1_AVX2 = (1 << 10),
ELF_GnuPropertyX86Compat1Isa1_AVX512F = (1 << 11),
ELF_GnuPropertyX86Compat1Isa1_AVX512ER = (1 << 12),
ELF_GnuPropertyX86Compat1Isa1_AVX512PF = (1 << 13),
ELF_GnuPropertyX86Compat1Isa1_AVX512VL = (1 << 14),
ELF_GnuPropertyX86Compat1Isa1_AVX512DQ = (1 << 15),
ELF_GnuPropertyX86Compat1Isa1_AVX512BW = (1 << 16),
};
typedef U32 ELF_GnuPropertyX86Compat2Isa1;
enum
{
ELF_GnuPropertyX86Compat2Isa1_CMOVE = (1 << 0),
ELF_GnuPropertyX86Compat2Isa1_SSE = (1 << 1),
ELF_GnuPropertyX86Compat2Isa1_SSE2 = (1 << 2),
ELF_GnuPropertyX86Compat2Isa1_SSE3 = (1 << 3),
ELF_GnuPropertyX86Compat2Isa1_SSE4_1 = (1 << 4),
ELF_GnuPropertyX86Compat2Isa1_SSE4_2 = (1 << 5),
ELF_GnuPropertyX86Compat2Isa1_AVX = (1 << 6),
ELF_GnuPropertyX86Compat2Isa1_AVX2 = (1 << 7),
ELF_GnuPropertyX86Compat2Isa1_FMA = (1 << 8),
ELF_GnuPropertyX86Compat2Isa1_AVX512F = (1 << 9),
ELF_GnuPropertyX86Compat2Isa1_AVX512CD = (1 << 10),
ELF_GnuPropertyX86Compat2Isa1_AVX512ER = (1 << 11),
ELF_GnuPropertyX86Compat2Isa1_AVX512PF = (1 << 12),
ELF_GnuPropertyX86Compat2Isa1_AVX512VL = (1 << 13),
ELF_GnuPropertyX86Compat2Isa1_AVX512DQ = (1 << 14),
ELF_GnuPropertyX86Compat2Isa1_AVX512BW = (1 << 15),
ELF_GnuPropertyX86Compat2Isa1_AVX512_4FMAPS = (1 << 16),
ELF_GnuPropertyX86Compat2Isa1_AVX512_4VNNIW = (1 << 17),
ELF_GnuPropertyX86Compat2Isa1_AVX512_BITALG = (1 << 18),
ELF_GnuPropertyX86Compat2Isa1_AVX512_IFMA = (1 << 19),
ELF_GnuPropertyX86Compat2Isa1_AVX512_VBMI = (1 << 20),
ELF_GnuPropertyX86Compat2Isa1_AVX512_VBMI2 = (1 << 21),
ELF_GnuPropertyX86Compat2Isa1_AVX512_VNNI = (1 << 22),
ELF_GnuPropertyX86Compat2Isa1_AVX512_BF16 = (1 << 23),
};
typedef S32 ELF_GnuPropertyX86;
enum
{
ELF_GnuPropertyX86_Feature1And = 0xc0000002,
ELF_GnuPropertyX86_Feature2Used = 0xc0010001,
ELF_GnuPropertyX86_Isa1needed = 0xc0008002,
ELF_GnuPropertyX86_Isa2Needed = 0xc0008001,
ELF_GnuPropertyX86_Isa1Used = 0xc0010002,
ELF_GnuPropertyX86_Compat_isa_1_used = 0xc0000000,
ELF_GnuPropertyX86_Compat_isa_1_needed = 0xc0000001,
ELF_GnuPropertyX86_UInt32AndLo = ELF_GnuPropertyX86_Feature1And,
ELF_GnuPropertyX86_UInt32AndHi = 0xc0007fff,
ELF_GnuPropertyX86_UInt32OrLo = 0xc0008000,
ELF_GnuPropertyX86_UInt32OrHi = 0xc000ffff,
ELF_GnuPropertyX86_UInt32OrAndLo = 0xc0010000,
ELF_GnuPropertyX86_UInt32OrAndHi = 0xc0017fff,
};
typedef U32 ELF_GnuPropertyX86Feature1;
enum
{
ELF_GnuPropertyX86Feature1_Ibt = (1 << 0),
ELF_GnuPropertyX86Feature1_Shstk = (1 << 1),
ELF_GnuPropertyX86Feature1_LamU48 = (1 << 2),
ELF_GnuPropertyX86Feature1_LamU57 = (1 << 3),
};
typedef U32 ELF_GnuPropertyX86Feature2;
enum
{
ELF_GnuPropertyX86Feature2_X86 = (1 << 0),
ELF_GnuPropertyX86Feature2_X87 = (1 << 1),
ELF_GnuPropertyX86Feature2_MMX = (1 << 2),
ELF_GnuPropertyX86Feature2_XMM = (1 << 3),
ELF_GnuPropertyX86Feature2_YMM = (1 << 4),
ELF_GnuPropertyX86Feature2_ZMM = (1 << 5),
ELF_GnuPropertyX86Feature2_FXSR = (1 << 6),
ELF_GnuPropertyX86Feature2_XSAVE = (1 << 7),
ELF_GnuPropertyX86Feature2_XSAVEOPT = (1 << 8),
ELF_GnuPropertyX86Feature2_XSAVEC = (1 << 9),
ELF_GnuPropertyX86Feature2_TMM = (1 << 10),
ELF_GnuPropertyX86Feature2_MASK = (1 << 11),
ELF_NoteType_STapSdt = 3, // System Tap probes
};
#define ELF_HdrIs64Bit(e_ident) (e_ident[ELF_Identifier_Class] == ELF_Class_64)
@@ -721,30 +590,30 @@ typedef struct ELF_Hdr32
typedef struct ELF_Shdr64
{
U32 sh_name;
U32 sh_type;
U64 sh_flags;
U64 sh_addr;
U64 sh_offset;
U64 sh_size;
U32 sh_link;
U32 sh_info;
U64 sh_addralign;
U64 sh_entsize;
U32 sh_name;
ELF_ShType sh_type;
U64 sh_flags;
U64 sh_addr;
U64 sh_offset;
U64 sh_size;
U32 sh_link;
U32 sh_info;
U64 sh_addralign;
U64 sh_entsize;
} ELF_Shdr64;
typedef struct ELF_Shdr32
{
U32 sh_name;
U32 sh_type;
U32 sh_flags;
U32 sh_addr;
U32 sh_offset;
U32 sh_size;
U32 sh_link;
U32 sh_info;
U32 sh_addralign;
U32 sh_entsize;
U32 sh_name;
ELF_ShType sh_type;
U32 sh_flags;
U32 sh_addr;
U32 sh_offset;
U32 sh_size;
U32 sh_link;
U32 sh_info;
U32 sh_addralign;
U32 sh_entsize;
} ELF_Shdr32;
typedef struct ELF_Phdr64
+215
View File
@@ -0,0 +1,215 @@
// Copyright (c) Epic Games Tools
// Licensed under the MIT license (https://opensource.org/license/mit/)
internal String8List
elf_dump_note(Arena *arena, String8 raw_notes, ELF_Class elf_class, ELF_MachineKind e_machine)
{
Temp scratch = scratch_begin(&arena, 1);
B32 is_bad_parse = 1;
String8List strings = {0};
U64 cursor = 0;
for (;cursor < raw_notes.size;) {
U32 owner_size;
U64 owner_size_size = str8_deserial_read_struct(raw_notes, cursor, &owner_size);
if (owner_size_size == 0) { goto exit; }
cursor += owner_size_size;
U32 desc_size;
U64 desc_size_size = str8_deserial_read_struct(raw_notes, cursor, &desc_size);
if (desc_size_size == 0) { goto exit; }
cursor += desc_size_size;
ELF_NoteType note_type;
U64 type_size = str8_deserial_read_struct(raw_notes, cursor, &note_type);
if (type_size == 0) { goto exit; }
cursor += type_size;
if (cursor + owner_size > raw_notes.size) { goto exit; }
String8 owner = str8_cstring_capped(raw_notes.str + cursor, raw_notes.str + cursor + owner_size);
cursor += owner_size;
if (cursor + desc_size > raw_notes.size) { goto exit; }
String8 raw_desc = str8_substr(raw_notes, r1u64(cursor, cursor + desc_size));
cursor += desc_size;
cursor = AlignPow2(cursor, 4);
String8List desc_fmt = {0};
String8 note_type_str = {0};
if (str8_match(owner, str8_lit("GNU"), StringMatchFlag_CaseInsensitive)) {
// format description
switch (note_type) {
case GNU_NoteType_Abi: {
U64 desc_cursor = 0;
GNU_AbiTag os = 0;
U64 os_size = str8_deserial_read_struct(raw_desc, desc_cursor, &os);
if (os_size == 0) { goto exit; }
cursor += os_size;
U32 major = 0;
U64 major_size = str8_deserial_read_struct(raw_desc, desc_cursor, &major);
if (major_size == 0) { goto exit; }
cursor += major_size;
U32 minor = 0;
U64 minor_size = str8_deserial_read_struct(raw_desc, desc_cursor, &minor);
if (minor_size == 0) { goto exit; }
cursor += minor_size;
U32 sub_minor = 0;
U64 sub_minor_size = str8_deserial_read_struct(raw_desc, desc_cursor, &sub_minor);
if (sub_minor_size == 0) { goto exit; }
cursor += sub_minor_size;
String8 os_str = gnu_string_from_abi_tag(os);
if (os_str.size == 0) os_str = str8f(scratch.arena, "0x%x", os);
str8_list_pushf(scratch.arena, &desc_fmt, "OS: %S, ABI: %u.%u.%u", os_str, major, minor, sub_minor);
} break;
case GNU_NoteType_BuildId: {
String8List build_id = {0};
for EachIndex(desc_cursor, desc_size) {
U8 v = 0;
U64 v_size = str8_deserial_read_struct(raw_desc, desc_cursor, &v);
if (v_size == 0) { goto exit; }
desc_cursor += v_size;
str8_list_pushf(scratch.arena, &build_id, "%02x", v);
}
String8 build_id_str = str8_list_join(scratch.arena, &build_id, 0);
str8_list_pushf(scratch.arena, &desc_fmt, "Build ID: %S", build_id_str);
} break;
case GNU_NoteType_PropertyType0: {
U64 align = elf_class == ELF_Class_64 ? 8 : 4;
for (U64 desc_cursor = 0; desc_cursor < raw_desc.size; ) {
GNU_Property type = 0;
U64 type_size = str8_deserial_read_struct(raw_desc, desc_cursor, &type);
if (type_size == 0) { goto exit; }
desc_cursor += type_size;
U32 size = 0;
U64 size_size = str8_deserial_read_struct(raw_desc, desc_cursor, &size);
if (size_size == 0) { goto exit; }
desc_cursor += size_size;
U32 flags = 0;
if (size == 4) {
U64 flags_size = str8_deserial_read_struct(raw_desc, desc_cursor, &flags);
if (flags_size == 0) { goto exit; }
desc_cursor += flags_size;
}
switch (e_machine) {
case ELF_MachineKind_None: break;
case ELF_MachineKind_X86_64: {
String8 features = gnu_string_from_property_flags_x86(scratch.arena, type, flags);
str8_list_pushf(scratch.arena, &desc_fmt, "x86 features: %S", features);
} break;
default: NotImplemented; break;
}
desc_cursor = AlignPow2(desc_cursor, align);
}
} break;
default: NotImplemented; break;
}
note_type_str = gnu_string_from_note_type(note_type);
} else if (str8_match(owner, str8_lit("stapsdt"), StringMatchFlag_CaseInsensitive)) {
if (note_type == ELF_NoteType_STapSdt) {
U64 desc_cursor = 0;
U64 addr_size = elf_class == ELF_Class_64 ? 8 : 4;
U64 pc = 0;
U64 pc_size = str8_deserial_read(raw_desc, desc_cursor, &pc, addr_size, addr_size);
if (pc_size == 0) { goto exit; }
desc_cursor += pc_size;
U64 base_addr = 0;
U64 base_addr_size = str8_deserial_read(raw_desc, desc_cursor, &base_addr, addr_size, addr_size);
if (base_addr_size == 0) { goto exit; }
desc_cursor += base_addr_size;
U64 semaphore = 0;
U64 semaphore_size = str8_deserial_read(raw_desc, desc_cursor, &semaphore, addr_size, addr_size);
if (semaphore_size == 0) { goto exit; }
desc_cursor += semaphore_size;
String8 provider = str8_cstring_capped(raw_desc.str + desc_cursor, raw_desc.str + raw_desc.size);
desc_cursor += provider.size + 1;
if (desc_cursor > raw_desc.size) { goto exit; }
String8 probe = str8_cstring_capped(raw_desc.str + desc_cursor, raw_desc.str + raw_desc.size);
desc_cursor += probe.size + 1;
if (desc_cursor > raw_desc.size) { goto exit; }
String8 args = str8_cstring_capped(raw_desc.str + desc_cursor, raw_desc.str + raw_desc.size);
desc_cursor += args.size + 1;
if (desc_cursor > raw_desc.size) { goto exit; }
str8_list_pushf(scratch.arena, &desc_fmt, "Provider: %S", provider);
str8_list_pushf(scratch.arena, &desc_fmt, "Probe: %S", probe);
str8_list_pushf(scratch.arena, &desc_fmt, "PC: 0x%I64x", pc);
str8_list_pushf(scratch.arena, &desc_fmt, "Base: 0x%I64x", base_addr);
str8_list_pushf(scratch.arena, &desc_fmt, "Semaphore: 0x%I64x", semaphore);
str8_list_pushf(scratch.arena, &desc_fmt, "Arguments: %S", args);
note_type_str = str8_lit("NT_STAPSDT");
}
}
if (note_type_str.size == 0) note_type_str = str8f(scratch.arena, "0x%x", note_type);
str8_list_pushf(arena, &strings, "{");
str8_list_pushf(arena, &strings, " Owner: %S", owner);
str8_list_pushf(arena, &strings, " Data Size: 0x%x", desc_size);
str8_list_pushf(arena, &strings, " Type: %S", note_type_str);
if (desc_fmt.node_count) {
str8_list_pushf(arena, &strings, " Description:");
str8_list_pushf(arena, &strings, " {");
for EachNode(n, String8Node, desc_fmt.first) { str8_list_pushf(arena, &strings, " %S", n->string); }
str8_list_pushf(arena, &strings, " }");
}
str8_list_pushf(arena, &strings, "}");
}
is_bad_parse = 0;
exit:;
if (is_bad_parse) {
str8_list_pushf(arena, &strings, "ERROR: unable to parse data @ 0x%Ix64", cursor);
}
scratch_end(scratch);
return strings;
}
internal String8List
elf_dump(Arena *arena, String8 raw_elf, ELF_DumpSubsetFlags flags)
{
Temp scratch = scratch_begin(&arena, 1);
String8List strings = {0};
ELF_Bin elf = elf_bin_from_data(scratch.arena, raw_elf);
if (flags & ELF_DumpSubsetFlag_Note) {
for EachIndex(sect_idx, elf.shdrs.count) {
ELF_Shdr64 *shdr = &elf.shdrs.v[sect_idx];
if (shdr->sh_type == ELF_ShType_Note) {
String8 raw_notes = str8_substr(raw_elf, r1u64(shdr->sh_offset, shdr->sh_offset + shdr->sh_size));
String8 shdr_name = elf_name_from_shdr64(raw_elf, &elf, shdr);
str8_list_pushf(scratch.arena, &strings, "//");
str8_list_pushf(scratch.arena, &strings, "// %S", shdr_name);
str8_list_pushf(scratch.arena, &strings, "//");
String8List note_strings = elf_dump_note(scratch.arena, raw_notes, elf.hdr.e_ident[ELF_Identifier_Class], elf.hdr.e_machine);
str8_list_concat_in_place(&strings, &note_strings);
}
}
}
String8 out = str8_list_join(arena, &strings, &(StringJoin){.sep=str8_lit("\n"), .post=str8_lit("\n")});
String8List result = {0};
str8_list_push(arena, &result, out);
scratch_end(scratch);
return result;
}
+30
View File
@@ -0,0 +1,30 @@
// Copyright (c) Epic Games Tools
// Licensed under the MIT license (https://opensource.org/license/mit/)
#ifndef ELF_DUMP_H
#define ELF_DUMP_H
#define ELF_DumpSubset_XList \
X(Note, note, "NOTE")
typedef U32 ELF_DumpSubset;
enum
{
#define X(name, name_lower, title) ELF_DumpSubset_##name,
ELF_DumpSubset_XList
#undef X
};
typedef U32 ELF_DumpSubsetFlags;
enum
{
#define X(name, name_lower, title) ELF_DumpSubsetFlag_##name = (1 << ELF_DumpSubset_##name),
ELF_DumpSubset_XList
#undef X
ELF_DumpSubsetFlag_All = ~0,
};
internal String8List elf_dump(Arena *arena, String8 raw_elf, ELF_DumpSubsetFlags flags);
#endif // ELF_DUMP_H