Files
raddebugger/src/linker/codeview_ext/codeview.c
T

1991 lines
60 KiB
C

// Copyright (c) Epic Games Tools
// Licensed under the MIT license (https://opensource.org/license/mit/)
////////////////////////////////
internal U64
hash_from_cv_symbol(CV_Symbol *symbol)
{
XXH3_state_t hasher;
XXH3_64bits_reset(&hasher);
XXH3_64bits_update(&hasher, &symbol->kind, sizeof(symbol->kind));
XXH3_64bits_update(&hasher, &symbol->data.size, sizeof(symbol->data.size));
XXH3_64bits_update(&hasher, symbol->data.str, symbol->data.size);
XXH64_hash_t hash = XXH3_64bits_digest(&hasher);
return hash;
}
////////////////////////////////
//~ Leaf Helpers
internal U64
cv_size_from_leaf(String8 data, U64 align)
{
U64 size = 0;
size += sizeof(CV_LeafSize);
size += sizeof(CV_LeafKind);
size += data.size;
size = AlignPow2(size, align);
return size;
}
internal U64
cv_write_leaf(U8 *buffer, U64 buffer_cursor, U64 buffer_size, CV_LeafKind kind, String8 data, U64 align)
{
U64 buffer_cursor_start = buffer_cursor;
// compute record size
U64 record_size = sizeof(kind) + data.size;
Assert(record_size <= CV_LeafSize_Max);
CV_LeafSize record_size16 = (CV_LeafSize)record_size;
// compute pad
static U8 LEAF_PAD_ARR[] = { 0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7, 0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff };
U64 pad_size = AlignPadPow2(data.size, align);
Assert(pad_size <= ArrayCount(LEAF_PAD_ARR));
// write header
CV_LeafHeader *header_ptr = (CV_LeafHeader *)(buffer + buffer_cursor);
header_ptr->size = record_size16;
header_ptr->kind = kind;
buffer_cursor += sizeof(*header_ptr);
// write body
U8 *leaf_data_ptr = buffer + buffer_cursor;
MemoryCopy(leaf_data_ptr, data.str, data.size);
buffer_cursor += data.size;
// write pad
U8 *pad_data_ptr = buffer + buffer_cursor;
MemoryCopy(pad_data_ptr, &LEAF_PAD_ARR[0], pad_size);
buffer_cursor += pad_size;
U64 write_size = buffer_cursor - buffer_cursor_start;
return write_size;
}
internal String8
cv_make_leaf(Arena *arena, CV_LeafKind kind, String8 data, U64 align)
{
U64 buffer_size = cv_size_from_leaf(data, align);
U8 *buffer = push_array_no_zero(arena, U8, buffer_size);
U64 size = cv_write_leaf(buffer, 0, buffer_size, kind, data, align);
String8 raw_leaf = str8(buffer, size);
return raw_leaf;
}
internal String8
cv_data_from_leaf(Arena *arena, CV_Leaf *leaf, U64 align)
{
return cv_make_leaf(arena, leaf->kind, leaf->data, align);
}
internal U64
cv_read_leaf(String8 raw_data, U64 off, U64 align, CV_Leaf *leaf_out)
{
// do we have enough bytes to read header?
if (raw_data.size < sizeof(CV_LeafHeader)) { return 0; }
U8 *leaf_ptr = raw_data.str + off;
StaticAssert(sizeof(CV_LeafHeader) == 4, g_leaf_header_size_check);
CV_LeafHeader header = { .v = memory_read32(leaf_ptr) };
// leaf size must have enough bytes for the kind enum
if (header.size < sizeof(CV_LeafKind)) { return 0; }
// do we have enough bytes to read leaf data?
if (sizeof(CV_LeafSize) + header.size > raw_data.size) { return 0; }
// fill out leaf
leaf_out->kind = header.kind;
leaf_out->data = str8(leaf_ptr + sizeof(CV_LeafHeader), header.size - sizeof(CV_LeafKind));
U64 leaf_size = AlignPow2(sizeof(CV_LeafHeader) + leaf_out->data.size, align);
if (leaf_size > raw_data.size) { return 0; }
return leaf_size;
}
internal CV_Leaf
cv_leaf_from_string(String8 raw_data)
{
CV_Leaf result;
cv_read_leaf(raw_data, 0, 1, &result);
return result;
}
internal CV_Leaf
cv_leaf_from_ptr(U8 *ptr)
{
CV_Leaf leaf = {0};
cv_read_leaf(str8(ptr, max_U64), 0, 1, &leaf);
return leaf;
}
internal U16
cv_leaf_size_from_ptr(U8 *ptr)
{
CV_LeafSize size = memory_read16(ptr);
return size + sizeof(size);
}
internal String8
cv_raw_leaf_from_ptr(U8 *ptr)
{
return str8(ptr, cv_leaf_size_from_ptr(ptr));
}
internal CV_TypeServerInfo
cv_type_server_info_from_leaf(CV_Leaf leaf)
{
CV_TypeServerInfo result = {0};
switch (leaf.kind) {
case CV_LeafKind_TYPESERVER: {
CV_LeafTypeServer *ts = (CV_LeafTypeServer *) leaf.data.str;
result.name = str8_cstring_capped(ts + 1, leaf.data.str + leaf.data.size);
result.sig.data1 = ts->sig;
result.age = ts->age;
} break;
case CV_LeafKind_TYPESERVER2: {
CV_LeafTypeServer2 *ts = (CV_LeafTypeServer2 *) leaf.data.str;
Assert(sizeof(result.sig) == sizeof(ts->sig70));
MemoryCopy(&result.sig, &ts->sig70, sizeof(ts->sig70));
result.name = str8_cstring_capped(ts + 1, leaf.data.str + leaf.data.size);
result.age = ts->age;
} break;
case CV_LeafKind_TYPESERVER_ST: {
Assert("TODO: LF_TYPESERVER_ST");
} break;
default: InvalidPath;
}
return result;
}
internal CV_PrecompInfo
cv_precomp_info_from_leaf(CV_Leaf leaf)
{
CV_PrecompInfo result = {0};
switch (leaf.kind) {
case CV_LeafKind_PRECOMP: {
CV_LeafPreComp *precomp = (CV_LeafPreComp*)leaf.data.str;
result.start_index = precomp->start_index;
result.sig = precomp->sig;
result.leaf_count = precomp->count;
str8_deserial_read_cstr(leaf.data, sizeof(CV_LeafPreComp), &result.obj_name);
} break;
case CV_LeafKind_PRECOMP_16t: {
NotImplemented;
} break;
case CV_LeafKind_PRECOMP_ST: {
NotImplemented;
} break;
default: {
InvalidPath;
} break;
}
return result;
}
////////////////////////////////
//~ Symbol Helpers
internal U64
cv_write_symbol_buf(String8Node *buf, U64 *buf_pos, CV_Symbol *symbol, U64 align)
{
CV_SymbolHeader header = { .size = sizeof(CV_SymKind) + symbol->data.size, .kind = symbol->kind };
U64 pad_size = AlignPadPow2(header.size + sizeof(CV_SymSize), align);
header.size += pad_size;
U64 write_size = 0;
write_size += str8_buffer_write(buf, buf_pos, str8_struct(&header));
write_size += str8_buffer_write(buf, buf_pos, symbol->data);
write_size += str8_buffer_write_zeroes(buf, buf_pos, pad_size);
return write_size;
}
internal U64
cv_write_symbol(U8 *buffer, U64 buffer_cursor, U64 buffer_size, CV_Symbol *symbol, U64 align)
{
String8Node dummy_curr = { .string = str8(buffer + buffer_cursor, buffer_size - buffer_cursor) };
U64 dummy_pos = 0;
return cv_write_symbol_buf(&dummy_curr, &dummy_pos, symbol, align);
}
internal U64
cv_size_from_symbol(CV_Symbol *symbol, U64 align)
{
return cv_write_symbol_buf(0, 0, symbol, align);
}
internal String8
cv_data_from_symbol(Arena *arena, CV_Symbol *symbol, U64 align)
{
U64 buffer_size = cv_size_from_symbol(symbol, align);
U8 *buffer = push_array(arena, U8, buffer_size);
cv_write_symbol(buffer, 0, buffer_size, symbol, align);
String8 result = str8(buffer, buffer_size);
return result;
}
internal U64
cv_read_symbol(String8 raw_data, U64 off, U64 align, CV_Symbol *symbol_out)
{
Assert(raw_data.size >= sizeof(CV_SymbolHeader));
U8 *symbol_ptr = raw_data.str + off;
CV_SymbolHeader header = { .v = memory_read32(symbol_ptr) };
Assert(header.size >= sizeof(CV_SymKind));
Assert(sizeof(CV_SymSize) + header.size <= raw_data.size);
symbol_out->kind = header.kind;
symbol_out->data = str8(symbol_ptr + sizeof(CV_SymbolHeader), header.size - sizeof(CV_SymKind));
U64 symbol_size = AlignPow2(sizeof(CV_SymSize) + header.size, align);
Assert(symbol_size <= raw_data.size);
return symbol_size;
}
internal U8 *
cv_ptr_from_symbol(CV_Symbol symbol)
{
return symbol.data.str - sizeof(CV_SymbolHeader);
}
internal CV_SymKind *
cv_kind_ptr_from_symbol(CV_Symbol symbol)
{
return &((CV_SymbolHeader *)cv_ptr_from_symbol(symbol))->kind;
}
internal CV_Symbol
cv_symbol_from_ptr(U8 *ptr)
{
CV_Symbol symbol = {0};
cv_read_symbol(str8(ptr, max_U64), 0, 1, &symbol);
return symbol;
}
internal String8
cv_raw_from_symbol(void *ptr)
{
CV_SymbolHeader *header = ptr;
return str8(ptr, header->size + sizeof(header->size));
}
internal B32
cv_symbol_match(CV_Symbol a, CV_Symbol b)
{
B32 is_match = 0;
CV_SymbolHeader *a_ptr = (CV_SymbolHeader *)cv_ptr_from_symbol(a);
CV_SymbolHeader *b_ptr = (CV_SymbolHeader *)cv_ptr_from_symbol(b);
if (a_ptr->size == b_ptr->size) {
is_match = MemoryMatch((U8*)a_ptr + sizeof(CV_SymSize), (U8*)b_ptr + sizeof(CV_SymSize), a_ptr->size);
}
return is_match;
}
internal String8
cv_make_symbol(Arena *arena, CV_SymKind kind, String8 data)
{
ProfBeginFunction();
Temp scratch = scratch_begin(&arena, 1);
AssertAlways((data.size + sizeof(kind)) <= CV_SymSize_Max);
CV_SymSize symbol_size = (CV_SymSize)data.size + sizeof(kind);
String8List srl = {0};
str8_serial_begin(scratch.arena, &srl);
str8_serial_push_struct(scratch.arena, &srl, &symbol_size);
str8_serial_push_struct(scratch.arena, &srl, &kind);
str8_serial_push_string(scratch.arena, &srl, data);
String8 symbol = str8_serial_end(arena, &srl);
scratch_end(scratch);
ProfEnd();
return symbol;
}
internal String8
cv_make_obj_name(Arena *arena, String8 obj_path, U32 sig)
{
ProfBeginFunction();
Temp scratch = scratch_begin(&arena, 1);
CV_SymObjName obj = {0};
obj.sig = sig;
String8List serial = {0};
str8_serial_begin(scratch.arena, &serial);
str8_serial_push_struct(scratch.arena, &serial, &obj);
str8_serial_push_cstr(scratch.arena, &serial, obj_path);
String8 result = str8_serial_end(arena, &serial);
scratch_end(scratch);
ProfEnd();
return result;
}
internal String8
cv_make_comp3(Arena *arena,
CV_Compile3Flags flags, CV_Language lang, CV_Arch arch,
U16 ver_fe_major, U16 ver_fe_minor, U16 ver_fe_build, U16 ver_feqfe,
U16 ver_major, U16 ver_minor, U16 ver_build, U16 ver_qfe,
String8 version_string)
{
ProfBeginFunction();
Temp scratch = scratch_begin(&arena, 1);
CV_SymCompile3 comp = {0};
comp.flags = flags | lang;
comp.machine = arch;
comp.ver_fe_major = ver_fe_major;
comp.ver_fe_minor = ver_fe_minor;
comp.ver_fe_build = ver_fe_build;
comp.ver_feqfe = ver_feqfe;
comp.ver_major = ver_major;
comp.ver_minor = ver_minor;
comp.ver_build = ver_build;
comp.ver_qfe = ver_qfe;
String8List serial = {0};
str8_serial_begin(scratch.arena, &serial);
str8_serial_push_struct(scratch.arena, &serial, &comp);
str8_serial_push_cstr(scratch.arena, &serial, version_string);
String8 result = str8_serial_end(arena, &serial);
scratch_end(scratch);
ProfEnd();
return result;
}
internal String8
cv_make_envblock(Arena *arena, String8List string_list)
{
ProfBeginFunction();
Temp scratch = scratch_begin(&arena, 1);
String8List serial = {0};
str8_serial_begin(scratch.arena, &serial);
CV_SymEnvBlock envblock = {0};
str8_serial_push_struct(scratch.arena, &serial, &envblock);
for (String8Node *n = string_list.first; n != NULL; n = n->next) {
str8_serial_push_cstr(scratch.arena, &serial, n->string);
}
String8 result = str8_serial_end(arena, &serial);
scratch_end(scratch);
ProfEnd();
return result;
}
internal String8
cv_make_proc32(Arena *arena, CV_SymProc32 proc, String8 name)
{
U64 buf_size = sizeof(proc) + name.size + 1;
U8 *buf = push_array(arena, U8, buf_size);
CV_SymProc32 *proc_dst = (CV_SymProc32 *)buf;
MemoryCopy(proc_dst, &proc, sizeof(proc));
MemoryCopy(proc_dst + 1, name.str, name.size);
MemorySet((U8 *)(proc_dst + 1) + name.size , 0, 1);
String8 result = str8(buf, buf_size);
return result;
}
internal String8
cv_make_end(Arena *arena)
{ (void)arena;
return str8_zero();
}
internal String8
cv_make_data32(Arena *arena, CV_SymData32 data, String8 name)
{
U64 buf_size = sizeof(data) + name.size + 1;
U8 *buf = push_array(arena, U8, buf_size);
CV_SymData32 *data_dst = (CV_SymData32 *)buf;
MemoryCopy(data_dst, &data, sizeof(data));
MemoryCopy(data_dst + 1, name.str, name.size);
buf[sizeof(data) + name.size] = 0;
return str8(buf, buf_size);
}
internal String8
cv_make_const(Arena *arena, CV_SymConstant v, U16 value, String8 name)
{
U64 buf_size = sizeof(v) + sizeof(value) + name.size + 1;
U8 *buf = push_array(arena, U8, buf_size);
CV_SymConstant *data_dst = (CV_SymConstant *)buf;
MemoryCopy(buf, &v, sizeof(v));
MemoryCopy(buf + sizeof(v), &value, sizeof(value));
MemoryCopy(buf + sizeof(v) + sizeof(value), name.str, name.size);
buf[sizeof(v) + sizeof(value) + name.size] = 0;
return str8(buf, buf_size);
}
internal String8
cv_make_udt(Arena *arena, CV_SymUDT v, String8 name)
{
U64 buf_size = sizeof(v) + name.size + 1;
U8 *buf = push_array(arena, U8, buf_size);
CV_SymUDT *data_dst = (CV_SymUDT *)buf;
MemoryCopy(data_dst, &v, sizeof(v));
MemoryCopy(data_dst + 1, name.str, name.size);
buf[sizeof(v) + name.size] = 0;
return str8(buf, buf_size);
}
internal String8
cv_make_inline_site(Arena *arena, CV_SymInlineSite inline_site, String8 annots)
{
U64 buf_size = sizeof(inline_site) + annots.size;
U8 *buf = push_array(arena, U8, buf_size);
CV_SymInlineSite *inline_dst = (CV_SymInlineSite *)buf;
MemoryCopy(inline_dst, &inline_site, sizeof(inline_site));
MemoryCopy(inline_dst + 1, annots.str, annots.size);
String8 result = str8(buf, buf_size);
return result;
}
internal String8
cv_make_inline_site_end(Arena *arena)
{ (void)arena;
return str8_zero();
}
internal CV_Symbol
cv_make_proc_ref(Arena *arena, CV_ModIndex imod, U32 stream_offset, String8 name, B32 is_local)
{
U64 buffer_size = sizeof(CV_SymRef2) + name.size + 1;
U8 *buffer = push_array_no_zero(arena, U8, buffer_size);
CV_SymRef2 *ref = (CV_SymRef2*)buffer;
ref->suc_name = 0;
ref->sym_off = stream_offset;
ref->imod = imod + 1; // MSVC adds one
U8 *name_ptr = (U8*)(ref + 1);
MemoryCopy(name_ptr, name.str, name.size);
name_ptr[name.size] = '\0';
CV_Symbol symbol;
symbol.kind = is_local ? CV_SymKind_LPROCREF : CV_SymKind_PROCREF;
symbol.data = str8(buffer, buffer_size);
symbol.offset = max_U64;
return symbol;
}
internal CV_Symbol
cv_make_pub32(Arena *arena, CV_Pub32Flags flags, U32 off, U16 isect, String8 name)
{
U64 buffer_size = sizeof(CV_SymPub32) + name.size + 1;
U8 *buffer = push_array_no_zero(arena, U8, buffer_size);
CV_SymPub32 *pub = (CV_SymPub32 *)buffer;
pub->flags = flags;
pub->off = off;
pub->sec = isect;
U8 *name_ptr = (U8*)(pub + 1);
MemoryCopy(name_ptr, name.str, name.size);
name_ptr[name.size] = '\0';
CV_Symbol symbol;
symbol.kind = CV_SymKind_PUB32;
symbol.data = str8(buffer, buffer_size);
return symbol;
}
internal B32
cv_is_gproc(CV_Symbol symbol)
{
return symbol.kind == CV_SymKind_GPROC32 ||
symbol.kind == CV_SymKind_GPROCMIPS ||
symbol.kind == CV_SymKind_GPROCIA64 ||
symbol.kind == CV_SymKind_GPROC32_ID ||
symbol.kind == CV_SymKind_GPROCMIPS_ID ||
symbol.kind == CV_SymKind_GPROCIA64_ID ||
symbol.kind == CV_SymKind_GPROC16 ||
symbol.kind == CV_SymKind_GPROC32_16t ||
symbol.kind == CV_SymKind_GPROCMIPS_16t ||
symbol.kind == CV_SymKind_GPROC32_ST ||
symbol.kind == CV_SymKind_GPROCMIPS_ST ||
symbol.kind == CV_SymKind_GPROCIA64_ST;
}
internal B32
cv_is_lproc(CV_Symbol symbol)
{
return symbol.kind == CV_SymKind_LPROC32 ||
symbol.kind == CV_SymKind_LPROCMIPS ||
symbol.kind == CV_SymKind_LPROCIA64 ||
symbol.kind == CV_SymKind_LPROC32_ID ||
symbol.kind == CV_SymKind_LPROCMIPS_ID ||
symbol.kind == CV_SymKind_LPROCIA64_ID ||
symbol.kind == CV_SymKind_LPROC32_DPC ||
symbol.kind == CV_SymKind_LPROC32_DPC_ID ||
symbol.kind == CV_SymKind_LPROC16 ||
symbol.kind == CV_SymKind_LPROC32_16t ||
symbol.kind == CV_SymKind_LPROCMIPS_16t ||
symbol.kind == CV_SymKind_LPROC32_ST ||
symbol.kind == CV_SymKind_LPROCMIPS_ST ||
symbol.kind == CV_SymKind_LPROCIA64_ST;
}
internal B32
cv_is_obj_info(CV_Symbol symbol)
{
return symbol.kind == CV_SymKind_OBJNAME;
}
internal CV_ObjInfo
cv_obj_info_from_symbol(CV_Symbol symbol)
{
CV_ObjInfo result; MemoryZeroStruct(&result);
switch (symbol.kind) {
case CV_SymKind_OBJNAME: {
CV_SymObjName *obj_name = (CV_SymObjName *) symbol.data.str;
result.sig = obj_name->sig;
str8_deserial_read_cstr(symbol.data, sizeof(CV_SymObjName), &result.name);
} break;
default: { InvalidPath; } break;
}
return result;
}
////////////////////////////////
//~ .debug$S helpers
internal void
cv_debug_s_from_data_c13_(Arena *arena, CV_DebugS *debug_s, String8 raw_debug_s)
{
for (U64 cursor = 0; cursor + sizeof(CV_C13SubSectionHeader) <= raw_debug_s.size; ) {
// read header
CV_C13SubSectionHeader header = {0};
cursor += str8_deserial_read_struct(raw_debug_s, cursor, &header);
if (~header.kind & CV_C13SubSectionKind_IgnoreFlag) {
// pick sub-section list
U64 sub_sect_idx = cv_c13_sub_section_idx_from_kind(header.kind);
String8List *sub_sect_list = debug_s->data_list + sub_sect_idx;
// push data to sub-section
Rng1U64 sub_sect_range = r1u64(cursor, cursor + header.size);
String8 sub_sect_data = str8_substr(raw_debug_s, sub_sect_range);
str8_list_push(arena, sub_sect_list, sub_sect_data);
}
// advance
cursor += header.size;
cursor = AlignPow2(cursor, CV_C13SubSectionAlign);
}
}
internal force_inline UBSAN_NO_ALIGN CV_Signature
cv_signature_from_debug_s(String8 raw_debug_s)
{
CV_Signature sig;
MemoryCopy(&sig, raw_debug_s.str, sizeof(sig));
return sig;
}
internal CV_DebugS
cv_debug_s_from_data_c13(Arena *arena, String8 raw_debug_s)
{
CV_DebugS debug_s = {0};
cv_debug_s_from_data_c13_(arena, &debug_s, raw_debug_s);
return debug_s;
}
internal CV_DebugS
cv_debug_s_from_data(Arena *arena, String8 raw_debug_s)
{
CV_DebugS result; MemoryZeroStruct(&result);
if (raw_debug_s.size >= sizeof(CV_Signature)) {
CV_Signature sig = cv_signature_from_debug_s(raw_debug_s);
switch (sig) {
case CV_Signature_C13: {
String8 raw_debug_s_past_sig = str8_substr(raw_debug_s, r1u64(sizeof(sig), raw_debug_s.size));
result = cv_debug_s_from_data_c13(arena, raw_debug_s_past_sig);
} break;
case CV_Signature_C6: {
Assert(!"TODO: handle C6");
} break;
case CV_Signature_C7: {
Assert(!"TODO: handle C7");
} break;
case CV_Signature_C11: {
Assert(!"TODO: handle C11");
} break;
default: Assert(!"invalid signature"); break;
}
}
return result;
}
internal void
cv_debug_s_concat_in_place(CV_DebugS *dst, CV_DebugS *src)
{
for (U64 sub_sect_idx = 0; sub_sect_idx < ArrayCount(dst->data_list); sub_sect_idx += 1) {
str8_list_concat_in_place(&dst->data_list[sub_sect_idx], &src->data_list[sub_sect_idx]);
}
}
internal U64
cv_size_from_debug_s(CV_DebugS *debug_s, U64 align)
{
U64 size = 0;
for EachElement(i, debug_s->data_list) {
if (i == CV_C13SubSectionIdxKind_Lines) { continue; }
if (debug_s->data_list[i].total_size == 0) { continue; }
size += sizeof(CV_C13SubSectionKind) + sizeof(U32); // header
size += debug_s->data_list[i].total_size;
size = AlignPow2(size, align);
}
String8List *line_data = cv_sub_section_ptr_from_debug_s(debug_s, CV_C13SubSectionKind_Lines);
for EachNode(line_n, String8Node, line_data->first) {
if (line_n->string.size == 0) { continue; }
size += sizeof(CV_C13SubSectionKind) + sizeof(U32); // header
size += line_n->string.size;
size = AlignPow2(size, align);
}
return size;
}
internal String8List
cv_data_from_debug_s_c13(Arena *arena, CV_DebugS *debug_s, B32 write_sig)
{
String8List srl = {0};
str8_serial_begin(arena, &srl);
if (write_sig) {
CV_Signature sig = CV_Signature_C13;
str8_serial_push_struct(arena, &srl, &sig);
}
for EachIndex(i, CV_C13SubSectionIdxKind_COUNT) {
if (i == CV_C13SubSectionIdxKind_Lines) { continue; }
CV_C13SubSectionKind kind = cv_c13_sub_section_kind_from_idx(i);
String8List *data = cv_sub_section_ptr_from_debug_s(debug_s, kind);
if (data->total_size > 0) {
U32 size32 = safe_cast_u32(data->total_size);
str8_serial_push_u32(arena, &srl, kind);
str8_serial_push_u32(arena, &srl, size32);
str8_serial_push_data_list(arena, &srl, data->first);
str8_serial_push_align(arena, &srl, 4);
}
}
String8List *line_data = cv_sub_section_ptr_from_debug_s(debug_s, CV_C13SubSectionKind_Lines);
for EachNode(line_n, String8Node, line_data->first) {
str8_serial_push_u32(arena, &srl, CV_C13SubSectionKind_Lines);
str8_serial_push_u32(arena, &srl, safe_cast_u32(line_n->string.size));
str8_serial_push_string(arena, &srl, line_n->string);
str8_serial_push_align(arena, &srl, 4);
}
return srl;
}
internal CV_C13SubSectionKind
cv_c13_sub_section_kind_from_idx(CV_C13SubSectionIdxKind idx)
{
switch (idx) {
#define X(n, c) case CV_C13SubSectionIdxKind_##n: return c;
CV_C13SubSectionKindXList(X)
#undef X
}
return 0;
}
internal CV_C13SubSectionIdxKind
cv_c13_sub_section_idx_from_kind(CV_C13SubSectionKind kind)
{
switch (kind) {
#define X(n,c) case CV_C13SubSectionKind_##n: return CV_C13SubSectionIdxKind_##n;
CV_C13SubSectionKindXList(X)
#undef X
}
return CV_C13SubSectionIdxKind_NULL;
}
internal String8List *
cv_sub_section_ptr_from_debug_s(CV_DebugS *debug_s, CV_C13SubSectionKind kind)
{
CV_C13SubSectionIdxKind idx = cv_c13_sub_section_idx_from_kind(kind);
return &debug_s->data_list[idx];
}
internal String8List
cv_sub_section_from_debug_s(CV_DebugS debug_s, CV_C13SubSectionKind kind)
{
String8List *list_ptr = cv_sub_section_ptr_from_debug_s(&debug_s, kind);
return *list_ptr;
}
internal String8
cv_string_table_from_debug_s(CV_DebugS debug_s)
{
String8List data_list = cv_sub_section_from_debug_s(debug_s, CV_C13SubSectionKind_StringTable);
String8 string_data = str8_zero();
if (data_list.node_count > 0) {
string_data = data_list.first->string;
}
return string_data;
}
internal String8
cv_file_chksms_from_debug_s(CV_DebugS debug_s)
{
String8List data_list = cv_sub_section_from_debug_s(debug_s, CV_C13SubSectionKind_FileChksms);
String8 file_chksms = str8_zero();
if (data_list.node_count > 0) {
file_chksms = data_list.first->string;
}
return file_chksms;
}
////////////////////////////////
//~ String Table Deduper
internal U64
cv_string_hash_table_hash(String8 string)
{
return u64_hash_from_str8(string);
}
internal int
cv_string_bucket_is_before(void *raw_a, void *raw_b)
{
CV_StringBucket **a = raw_a;
CV_StringBucket **b = raw_b;
int is_before;
if ((*a)->u.idx0 == (*b)->u.idx0) {
is_before = (*a)->u.idx1 < (*b)->u.idx1;
} else {
is_before = (*a)->u.idx0 < (*b)->u.idx0;
}
return is_before;
}
internal CV_StringBucket *
cv_string_hash_table_insert_or_update(CV_StringBucket **buckets, U64 cap, U64 hash, CV_StringBucket *new_bucket)
{
CV_StringBucket *result = 0;
B32 was_bucket_inserted_or_updated = 0;
U64 best_idx = hash % cap;
U64 idx = best_idx;
do {
retry:;
CV_StringBucket *curr_bucket = buckets[idx];
if (curr_bucket == 0) {
CV_StringBucket *compare_bucket = ins_atomic_ptr_eval_cond_assign(&buckets[idx], new_bucket, curr_bucket);
if (compare_bucket == curr_bucket) {
// success, bucket was inserted
was_bucket_inserted_or_updated = 1;
break;
}
// another thread took the bucket...
goto retry;
} else if (str8_match(curr_bucket->string, new_bucket->string, 0)) {
if (cv_string_bucket_is_before(&curr_bucket, &new_bucket)) {
// recycle bucket
result = new_bucket;
// don't need to update, more recent leaf is in the bucket
was_bucket_inserted_or_updated = 1;
break;
}
CV_StringBucket *compare_bucket = ins_atomic_ptr_eval_cond_assign(&buckets[idx], new_bucket, curr_bucket);
if (compare_bucket == curr_bucket) {
// recycle bucket
result = compare_bucket;
// new bucket is in the hash table, exit
was_bucket_inserted_or_updated = 1;
break;
}
// another thread took the bucket...
goto retry;
}
// advance
idx = (idx + 1) % cap;
} while (idx != best_idx);
// are there enough free buckets?
Assert(was_bucket_inserted_or_updated);
return result;
}
internal
THREAD_POOL_TASK_FUNC(cv_count_strings_in_debug_s_arr_task)
{
ProfBeginFunction();
CV_DedupStringTablesTask *task = raw_task;
CV_StringTableRange *range_list = task->range_lists[task_id];
for (CV_StringTableRange *range_n = range_list; range_n != 0; range_n = range_n->next) {
CV_DebugS debug_s = task->arr[range_n->debug_s_idx];
String8 string_buffer = cv_string_table_from_debug_s(debug_s);
Assert(range_n->range.min <= range_n->range.max);
Assert(range_n->range.min <= string_buffer.size);
Assert(range_n->range.max <= string_buffer.size);
U64 count = 0;
for (U64 i = range_n->range.min; i < range_n->range.max; ++i) {
U8 b = string_buffer.str[i];
if (b == '\0') {
count += 1;
}
}
ins_atomic_u64_add_eval(&task->string_counts[range_n->debug_s_idx], count);
}
ProfEnd();
}
internal
THREAD_POOL_TASK_FUNC(cv_dedup_strings_in_debug_s_arr_task)
{
ProfBeginFunction();
Temp scratch = scratch_begin(&arena, 1);
U64 debug_s_idx = task_id;
CV_DedupStringTablesTask *task = raw_task;
CV_DebugS debug_s = task->arr[debug_s_idx];
String8 string_table = cv_string_table_from_debug_s(debug_s);
String8List strings_list = str8_split_by_string_chars(scratch.arena, string_table, str8_lit("\0"), 0);
CV_StringBucket *bucket = 0;
U64 total_string_size = 0;
U64 total_insert_count = 0;
U64 string_idx = 0;
for (String8Node *string_n = strings_list.first; string_n != 0; string_n = string_n->next, ++string_idx) {
if (bucket == 0) {
bucket = push_array_no_zero(arena, CV_StringBucket, 1);
}
bucket->u.idx0 = debug_s_idx;
bucket->u.idx1 = string_idx;
bucket->string = string_n->string;
U64 hash = cv_string_hash_table_hash(string_n->string);
CV_StringBucket *insert_or_update = cv_string_hash_table_insert_or_update(task->buckets, task->bucket_cap, hash, bucket);
if (insert_or_update == 0) {
total_string_size += string_n->string.size;
total_insert_count += 1;
}
if (insert_or_update != bucket) {
bucket = 0;
}
}
ins_atomic_u64_add_eval(&task->total_string_size, total_string_size);
ins_atomic_u64_add_eval(&task->total_insert_count, total_insert_count);
scratch_end(scratch);
ProfEnd();
}
internal CV_StringHashTable
cv_dedup_string_tables(TP_Arena *arena, TP_Context *tp, U64 count, CV_DebugS *arr)
{
ProfBeginFunction();
Temp scratch = scratch_begin(arena->v, arena->count);
ProfBegin("Compute Total Weight");
U64 total_weight = 0;
for (U64 i = 0; i < count; ++i) {
String8 string_table = cv_string_table_from_debug_s(arr[i]);
total_weight += string_table.size;
}
ProfEnd();
U64 per_task_weight = CeilIntegerDiv(total_weight, tp->worker_count);
U64 task_weight = 0;
U64 task_id = 0;
CV_StringTableRange **range_lists = push_array(scratch.arena, CV_StringTableRange *, tp->worker_count);
ProfBegin("Divide Work");
for (U64 debug_s_idx = 0; debug_s_idx < count; ++debug_s_idx) {
String8 string_table = cv_string_table_from_debug_s(arr[debug_s_idx]);
for (U64 cursor = 0; cursor < string_table.size; cursor += per_task_weight) {
if (task_weight >= per_task_weight) {
task_id = (task_id + 1) % tp->worker_count;
task_weight = 0;
}
U64 max_range_weight = Min(per_task_weight, string_table.size - cursor);
CV_StringTableRange *node = push_array(scratch.arena, CV_StringTableRange, 1);
node->range = rng_1u64(cursor, cursor + max_range_weight);
node->debug_s_idx = debug_s_idx;
SLLStackPush(range_lists[task_id], node);
task_weight += max_range_weight;
}
}
ProfEnd();
ProfBegin("Count");
CV_DedupStringTablesTask task = {0};
task.arr = arr;
task.range_lists = range_lists;
task.string_counts = push_array(scratch.arena, U64, count);
tp_for_parallel(tp, 0, tp->worker_count, cv_count_strings_in_debug_s_arr_task, &task);
ProfEnd();
ProfBegin("Dedup");
U64 total_string_count = sum_array_u64(count, task.string_counts);
task.bucket_cap = (U64)((F64)total_string_count * 1.3);
task.buckets = push_array(arena->v[0], CV_StringBucket *, task.bucket_cap);
tp_for_parallel(tp, arena, count, cv_dedup_strings_in_debug_s_arr_task, &task);
ProfEnd();
CV_StringHashTable string_ht = {0};
string_ht.total_string_size = task.total_string_size;
string_ht.total_insert_count = task.total_insert_count;
string_ht.bucket_cap = task.bucket_cap;
string_ht.buckets = task.buckets;
scratch_end(scratch);
ProfEnd();
return string_ht;
}
internal void
cv_string_hash_table_assign_buffer_offsets(TP_Context *tp, CV_StringHashTable string_ht)
{
ProfBeginFunction();
Temp scratch = scratch_begin(0,0);
ProfBegin("Count Strings");
U64 string_count = 0;
for (U64 i = 0; i < string_ht.bucket_cap; ++i) {
if (string_ht.buckets[i] != 0) {
string_count += 1;
}
}
ProfEnd();
ProfBegin("Push");
CV_StringBucket **strings = push_array_no_zero(scratch.arena, CV_StringBucket *, string_count);
ProfEnd();
ProfBegin("Copy Present Buckets");
for (U64 i = 0, string_idx = 0; i < string_ht.bucket_cap; ++i) {
if (string_ht.buckets[i] != 0) {
strings[string_idx++] = string_ht.buckets[i];
}
}
ProfEnd();
ProfBegin("Sort");
radsort(strings, string_count, cv_string_bucket_is_before);
ProfEnd();
ProfBegin("Assign Offsets");
for (U64 i = 0, offset_cursor = 0; i < string_count; ++i) {
CV_StringBucket *s = strings[i];
s->u.offset = offset_cursor;
offset_cursor += s->string.size + 1;
}
ProfEnd();
scratch_end(scratch);
ProfEnd();
}
internal CV_StringBucket *
cv_string_hash_table_lookup(CV_StringHashTable ht, String8 string)
{
U64 hash = cv_string_hash_table_hash(string);
U64 best_idx = hash % ht.bucket_cap;
U64 idx = best_idx;
do {
if (ht.buckets[idx] == 0) {
break;
}
if (str8_match(ht.buckets[idx]->string, string, 0)) {
return ht.buckets[idx];
}
idx = (idx + 1) % ht.bucket_cap;
} while (idx != best_idx);
return 0;
}
internal
THREAD_POOL_TASK_FUNC(cv_pack_string_hash_table_task)
{
ProfBeginFunction();
CV_PackStringHashTableTask *task = raw_task;
Rng1U64 range = task->ranges[task_id];
for (U64 bucket_idx = range.min; bucket_idx < range.max; ++bucket_idx) {
CV_StringBucket *bucket = task->buckets[bucket_idx];
if (bucket) {
MemoryCopy(task->buffer + bucket->u.offset, bucket->string.str, bucket->string.size);
task->buffer[bucket->u.offset + bucket->string.size] = '\0';
}
}
ProfEnd();
}
internal String8
cv_pack_string_hash_table(Arena *arena, TP_Context *tp, CV_StringHashTable string_ht)
{
ProfBeginFunction();
Temp scratch = scratch_begin(&arena, 1);
U64 buffer_size = string_ht.total_string_size + /* nulls: */ string_ht.total_insert_count;
U8 *buffer = push_array_no_zero(arena, U8, buffer_size);
CV_PackStringHashTableTask task = {0};
task.buckets = string_ht.buckets;
task.buffer = buffer;
task.ranges = tp_divide_work(scratch.arena, string_ht.bucket_cap, tp->worker_count);
tp_for_parallel(tp, 0, tp->worker_count, cv_pack_string_hash_table_task, &task);
String8 result = str8(buffer, buffer_size);
scratch_end(scratch);
ProfEnd();
return result;
}
////////////////////////////////
//~ Symbol Deduper
internal void *
cv_symbol_deduper_insert_or_update(void **buckets, U64 bucket_cap, U64 hash, void *symbol_ptr)
{
CV_Symbol symbol = cv_symbol_from_ptr(symbol_ptr);
U8 *result = 0;
B32 is_inserted_or_updated = 0;
U64 best_idx = hash % bucket_cap;
U64 bucket_idx = best_idx;
do {
retry:;
void *curr_ptr = buckets[bucket_idx];
Assert(curr_ptr != symbol_ptr);
if (curr_ptr == 0) {
U8 *cmp = ins_atomic_ptr_eval_cond_assign(&buckets[bucket_idx], symbol_ptr, curr_ptr);
if (cmp == curr_ptr) {
// success, bucket was inserted
is_inserted_or_updated = 1;
break;
}
// another thread took the bucket...
goto retry;
} else {
CV_Symbol curr = cv_symbol_from_ptr(curr_ptr);
if (cv_symbol_match(curr, symbol)) {
if (curr_ptr < symbol_ptr) {
// do not update, more recent symbol is in the bucket
result = symbol_ptr;
is_inserted_or_updated = 1;
break;
}
void *cmp = ins_atomic_ptr_eval_cond_assign(&buckets[bucket_idx], symbol_ptr, curr_ptr);
if (cmp == curr_ptr) {
result = cmp;
is_inserted_or_updated = 1;
break;
}
// another thread took the bucket...
goto retry;
}
}
// advance
bucket_idx = (bucket_idx + 1) == bucket_cap ? 0 : bucket_idx + 1;
} while (bucket_idx != best_idx);
Assert(is_inserted_or_updated);
return result;
}
////////////////////////////////
//~ .debug$T helpers
internal CV_DebugT
cv_debug_t_from_data(Arena *arena, String8 data, U64 align)
{
CV_DebugT debug_t = { .data = data };
ProfBegin("Upfront parse for counts");
for (U64 cursor = 0, prev_cursor = 0, ti = CV_MinComplexTypeIndex; cursor < data.size; ti += 1) {
CV_Leaf leaf = {0};
TryRead(cv_read_leaf(data, cursor, align, &leaf), cursor, count_stop);
debug_t.source_counts[cv_type_index_source_from_leaf_kind(leaf.kind)] += 1;
}
count_stop:
ProfEnd();
for EachElement(i, debug_t.source_counts) { debug_t.count += debug_t.source_counts[i]; }
ProfBegin("store leaf offsets");
debug_t.offsets = push_array_no_zero(arena, U32, debug_t.count);
for (U64 cursor = 0, idx = 0; cursor < data.size && idx < debug_t.count; idx += 1) {
debug_t.offsets[idx] = cursor;
TryRead(cv_read_leaf(data, cursor, align, &(CV_Leaf){0}), cursor, store_stop);
}
store_stop:
for EachElement(i, debug_t.ti_ranges) { debug_t.ti_ranges[i] = r1u64(CV_MinComplexTypeIndex, CV_MinComplexTypeIndex + debug_t.count); }
// shift upper type index bound to include precompiled types
CV_Leaf leaf = cv_debug_t_get_leaf(&debug_t, 0);
if (leaf.kind == CV_LeafKind_PRECOMP) {
CV_PrecompInfo precomp_info = cv_precomp_info_from_leaf(leaf);
for EachElement(i, debug_t.ti_ranges) { debug_t.ti_ranges[i].max += precomp_info.leaf_count; }
}
ProfEnd();
return debug_t;
}
internal CV_Leaf
cv_debug_t_get_leaf(CV_DebugT *debug_t, U64 leaf_idx)
{
CV_Leaf leaf = {0};
if (debug_t->count > 0) {
Assert(leaf_idx < debug_t->count);
cv_read_leaf(debug_t->data, debug_t->offsets[leaf_idx], 1, &leaf);
Assert(cv_header_struct_size_from_leaf_kind(leaf.kind) <= leaf.data.size);
}
return leaf;
}
internal U64
cv_leaf_idx_from_ti(CV_DebugT *debug_t, CV_TypeIndexSource source, CV_TypeIndex ti)
{
// validate TI
Assert(contains_1u64(debug_t->ti_ranges[source], ti));
// no PCH indirection
Assert(!contains_1u64(debug_t->pch_ti_range[source], ti));
U64 leaf_idx = ti;
Assert(leaf_idx >= debug_t->ti_ranges[source].min);
// strip type index range
leaf_idx -= debug_t->ti_ranges[source].min;
Assert(leaf_idx >= dim_1u64(debug_t->pch_ti_range[source]));
// strip PCH indirection
leaf_idx -= dim_1u64(debug_t->pch_ti_range[source]);
leaf_idx += debug_t->source_offsets[source];
Assert(leaf_idx < debug_t->count);
return leaf_idx;
}
internal CV_TypeIndex
cv_ti_from_leaf_idx(CV_DebugT *debug_t, CV_TypeIndexSource source, U64 leaf_idx)
{
U64 pch_count = dim_1u64(debug_t->pch_ti_range[source]);
CV_TypeIndex ti = debug_t->ti_ranges[source].min + pch_count + leaf_idx;
return ti;
}
internal CV_Leaf
cv_leaf_from_ti(CV_DebugT *debug_t, CV_TypeIndexSource source, CV_TypeIndex ti)
{
U64 leaf_idx = cv_leaf_idx_from_ti(debug_t, source, ti);
return cv_debug_t_get_leaf(debug_t, leaf_idx);
}
internal String8
cv_debug_t_get_raw_leaf(CV_DebugT *debug_t, U64 leaf_idx)
{
Assert(leaf_idx < debug_t->count);
U8 *leaf_ptr = debug_t->data.str + debug_t->offsets[leaf_idx];
CV_LeafSize leaf_size = memory_read16(leaf_ptr);
return str8(leaf_ptr, leaf_size + sizeof(leaf_size));
}
internal CV_LeafHeader *
cv_debug_t_get_leaf_header(CV_DebugT *debug_t, U64 leaf_idx)
{
CV_LeafHeader *header = 0;
if (leaf_idx < debug_t->count) {
header = (CV_LeafHeader *)(debug_t->data.str + debug_t->offsets[leaf_idx]);
}
return header;
}
internal CV_TypeIndex
cv_debug_t_get_type_index(CV_DebugT *debug_t, CV_TypeIndexSource ti_source, U64 leaf_idx)
{
CV_TypeIndex ti = debug_t->ti_ranges[ti_source].min + leaf_idx;
Assert(contains_1u64(debug_t->ti_ranges[ti_source], ti));
return ti;
}
internal U64
cv_debug_t_get_leaf_index(CV_DebugT *debug_t, CV_TypeIndexSource ti_source, CV_TypeIndex ti)
{
Assert(contains_1u64(debug_t->ti_ranges[ti_source], ti));
U64 leaf_idx = ti - debug_t->ti_ranges[ti_source].min;
return leaf_idx;
}
internal B32
cv_debug_t_is_pch(CV_DebugT *debug_t)
{
return cv_is_leaf_pch(cv_debug_t_get_leaf(debug_t, 0).kind);
}
internal B32
cv_debug_t_is_type_server_ref(CV_DebugT *debug_t)
{
return cv_is_leaf_type_server(cv_debug_t_get_leaf(debug_t, 0).kind);
}
// $$Symbols
internal void
cv_symbol_list_push_node(CV_SymbolList *list, CV_SymbolNode *node)
{
node->prev = 0;
node->next = 0;
DLLPushBack(list->first, list->last, node);
list->count += 1;
}
internal CV_SymbolNode *
cv_symbol_list_push(Arena *arena, CV_SymbolList *list, CV_Symbol v)
{
CV_SymbolNode *node = push_array(arena, CV_SymbolNode, 1);
node->data = v;
cv_symbol_list_push_node(list, node);
return node;
}
internal U64
cv_patch_symbol_tree_offsets(String8List raw_symbols, U64 base_offset, U64 align)
{
Temp scratch = scratch_begin(0, 0);
struct Stack { struct Stack *next; String8Node symbol_buf; U64 symbol_pos; U64 offset; };
struct Stack *stack = 0, *free_list = 0;
String8Node buf = *raw_symbols.first;
U64 buf_pos = 0;
U64 symbol_offset = base_offset;
U64 depth = 0;
for (;;) {
CV_SymbolHeader symbol_header;
if (str8_buffer_peek(&buf, &buf_pos, sizeof(symbol_header), &symbol_header) != sizeof(symbol_header)) { break; }
if (cv_is_scope_symbol(symbol_header.kind)) {
// NOTE: We don't patch 'next' offset in PROC symbols because
// it's not used by visual studio and MSVC leaves the offsets
// zeroed. LLD is on the same page.
Assert(symbol_header.size >= sizeof(CV_SymKind) + sizeof(U32)*2);
// patch parent symbol offset
if (stack) {
String8Node temp_buf = buf;
U64 temp_pos = buf_pos + sizeof(CV_SymbolHeader);
str8_buffer_write_u32(&temp_buf, &temp_pos, stack->offset);
}
// reuse/alloc frame
struct Stack *frame = free_list;
if (frame) { SLLStackPop(free_list); }
else { frame = push_array_no_zero(scratch.arena, struct Stack, 1); }
// push frame to the stack
frame->symbol_buf = buf;
frame->symbol_pos = buf_pos + sizeof(CV_SymbolHeader);
frame->offset = safe_cast_u32(symbol_offset);
SLLStackPush(stack, frame);
depth += 1;
} else if (cv_is_end_symbol(symbol_header.kind)) {
// patch symbol end
String8Node temp_buf = stack->symbol_buf;
U64 temp_pos = stack->symbol_pos;
str8_buffer_skip(&temp_buf, &temp_pos, sizeof(U32)); // skip parent offset
str8_buffer_write_u32(&temp_buf, &temp_pos, symbol_offset);
// recycle frame
struct Stack *free_frame = stack;
SLLStackPop(stack);
SLLStackPush(free_list, free_frame);
if (depth == 0) { Assert(0 && "malformed symbol stream"); continue; }
depth -= 1;
}
// advance symbol offset
symbol_offset += AlignPow2(sizeof(CV_SymSize) + symbol_header.size, align);
str8_buffer_skip(&buf, &buf_pos, AlignPow2(symbol_header.size + sizeof(CV_SymSize), align));
}
scratch_end(scratch);
return symbol_offset - base_offset;
}
// $$FileChksms
internal void
cv_parse_checksum_data(Arena *arena, CV_ChecksumList *list, String8 checksum_data)
{
for (U64 cursor = 0, cursor_opl = checksum_data.size; cursor < cursor_opl; ) {
U64 expected_cursor_after_checksum = cursor + sizeof(CV_C13Checksum);
if (expected_cursor_after_checksum > cursor_opl) {
break;
}
CV_C13Checksum *header = (CV_C13Checksum *)str8_deserial_get_raw_ptr(checksum_data, cursor, sizeof(CV_C13Checksum));
cursor += sizeof(CV_C13Checksum);
U64 expected_cursor_after_value = cursor + header->len;
if (expected_cursor_after_value > cursor_opl) {
break;
}
String8 value = str8(0,0);
cursor += str8_deserial_read_block(checksum_data, cursor, header->len, &value);
cursor = AlignPow2(cursor, 4);
CV_ChecksumNode *node = push_array(arena, CV_ChecksumNode, 1);
node->next = 0;
CV_Checksum *data = &node->data;
data->header = header;
data->value = value;
SLLQueuePush(list->first, list->last, node);
list->count += 1;
}
}
internal CV_ChecksumList
cv_c13_parse_checksum_data_list(Arena *arena, String8List checksum_data_list)
{
CV_ChecksumList result = {0};
for EachNode(n, String8Node, checksum_data_list.first) {
cv_parse_checksum_data(arena, &result, n->string);
}
return result;
}
internal void
cv_c13_patch_string_offsets_in_checksum_list(CV_ChecksumList checksum_list, String8 string_data, U64 string_data_base_offset, CV_StringHashTable string_ht)
{
for EachNode(node, CV_ChecksumNode, checksum_list.first) {
CV_Checksum *checksum = &node->data;
CV_C13Checksum *header = checksum->header;
String8 name = str8_cstring_capped(string_data.str + header->name_off, string_data.str + string_data.size);
CV_StringBucket *bucket = cv_string_hash_table_lookup(string_ht, name);
U64 name_off64 = string_data_base_offset + bucket->u.offset;
header->name_off = safe_cast_u32(name_off64);
}
}
internal String8List
cv_c13_collect_source_file_names(Arena *arena, CV_ChecksumList checksum_list, String8 string_data)
{
String8List source_file_name_list = {0};
for (CV_ChecksumNode *node = checksum_list.first; node != 0; node = node->next) {
CV_Checksum *checksum = &node->data;
CV_C13Checksum *header = checksum->header;
Assert(header->name_off < string_data.size);
String8 name = str8_cstring_capped(string_data.str + header->name_off, string_data.str + string_data.size);
str8_list_push(arena, &source_file_name_list, name);
}
return source_file_name_list;
}
// $$Lines
internal void
cv_c13_lines_header_list_concat_in_place(CV_C13LinesHeaderList *list, CV_C13LinesHeaderList *to_concat)
{
SLLConcatInPlace(list, to_concat);
}
internal CV_C13LinesHeaderList
cv_c13_lines_from_sub_sections(Arena *arena, String8 c13_data, Rng1U64 ss_range)
{
ProfBeginFunction();
CV_C13LinesHeaderList parsed_line_list = {0};
String8 sub_sect_data = str8_substr(c13_data, ss_range);
for (U64 cursor = 0; cursor + sizeof(CV_C13SubSecLinesHeader) <= sub_sect_data.size; ) {
CV_C13SubSecLinesHeader *hdr = (CV_C13SubSecLinesHeader *)(sub_sect_data.str + cursor);
cursor += sizeof(*hdr);
// read files
for (; cursor + sizeof(CV_C13File) <= sub_sect_data.size; ) {
// grab next file header
CV_C13File *file = (CV_C13File *)(sub_sect_data.str + cursor);
cursor += sizeof(CV_C13File);
// parse lines and columns
//
// TODO: export columns
U64 max_line_count = (sub_sect_data.size - cursor) / sizeof(CV_C13Line);
U32 line_count = Min(file->num_lines, max_line_count);
// TODO(allen): check order correctness here
U64 line_array_off = cursor;
//U64 col_array_off = line_array_off + line_count * sizeof(CV_C13Line);
// compute line entry size
U64 line_entry_size = sizeof(CV_C13Line);
if (hdr->flags & CV_C13SubSecLinesFlag_HasColumns) {
line_entry_size += sizeof(CV_C13Column);
}
// advance past line and column entries
cursor += line_count * line_entry_size;
// emit parsed lines
CV_C13LinesHeaderNode *lines_parsed_node = push_array_no_zero(arena, CV_C13LinesHeaderNode, 1);
lines_parsed_node->next = 0;
CV_C13LinesHeader *lines_parsed = &lines_parsed_node->v;
lines_parsed->sec_idx = hdr->sec;
lines_parsed->sec_off_lo = hdr->sec_off;
lines_parsed->sec_off_hi = hdr->sec_off + hdr->len;
lines_parsed->file_off = file->file_off;
lines_parsed->line_count = line_count;
lines_parsed->col_count = 0; // TODO: columns
lines_parsed->line_array_off = ss_range.min + line_array_off;
lines_parsed->col_array_off = 0; // TODO: columns
SLLQueuePush(parsed_line_list.first, parsed_line_list.last, lines_parsed_node);
parsed_line_list.count += 1;
}
}
ProfEnd();
return parsed_line_list;
}
internal CV_LineArray
cv_c13_line_array_from_data(Arena *arena, String8 c13_data, U64 sec_base, CV_C13LinesHeader parsed_lines)
{
CV_LineArray result;
result.file_off = parsed_lines.file_off;
result.line_count = parsed_lines.line_count;
result.col_count = parsed_lines.col_count;
result.voffs = push_array_no_zero(arena, U64, parsed_lines.line_count + 1);
result.line_nums = push_array_no_zero(arena, U32, parsed_lines.line_count);
result.col_nums = 0;
CV_C13Line *raw_lines = (CV_C13Line *)str8_deserial_get_raw_ptr(c13_data, parsed_lines.line_array_off, parsed_lines.line_count * sizeof(raw_lines[0]));
for(U64 line_idx = 0; line_idx < parsed_lines.line_count; line_idx += 1)
{
CV_C13Line line = raw_lines[line_idx];
result.voffs[line_idx] = sec_base + parsed_lines.sec_off_lo + line.off;
result.line_nums[line_idx] = CV_C13LineFlags_Extract_LineNumber(line.flags);
}
// emit voff ender
result.voffs[result.line_count] = sec_base + parsed_lines.sec_off_hi;
return result;
}
internal void
cv_c13_patch_checksum_offsets_in_line_data_list(String8List line_data, U64 checksum_rebase)
{
for(String8Node *node = line_data.first; node != 0; node = node->next)
{
String8 raw_data = node->string;
if(raw_data.size < sizeof(CV_C13SubSecLinesHeader))
{
Assert(!"unable to patch checksum in line sub seciton header");
continue;
}
CV_C13File *file_header = (CV_C13File *)(raw_data.str + sizeof(CV_C13SubSecLinesHeader));
U64 rebased_file_off = file_header->file_off + checksum_rebase;
file_header->file_off = safe_cast_u32(rebased_file_off);
}
}
// $$InlineeLines
internal CV_C13InlineeLinesParsedList
cv_c13_inlinee_lines_from_sub_sections(Arena *arena, String8List raw_inlinee_lines)
{
ProfBeginFunction();
CV_C13InlineeLinesParsedList inlinee_lines_list = {0};
for (String8Node *raw_data_node = raw_inlinee_lines.first; raw_data_node != 0; raw_data_node = raw_data_node->next) {
U64 cursor = 0;
CV_C13InlineeLinesSig sig = 0;
cursor += str8_deserial_read_struct(raw_data_node->string, cursor, &sig);
for (; cursor + sizeof(CV_C13InlineeSourceLineHeader) <= raw_data_node->string.size; ) {
CV_C13InlineeSourceLineHeader *hdr = (CV_C13InlineeSourceLineHeader *)(raw_data_node->string.str + cursor);
cursor += sizeof(*hdr);
CV_C13InlineeLinesParsedNode *inlinee_parsed_node = push_array_no_zero(arena, CV_C13InlineeLinesParsedNode, 1);
inlinee_parsed_node->next = 0;
SLLQueuePush(inlinee_lines_list.first, inlinee_lines_list.last, inlinee_parsed_node);
inlinee_lines_list.count += 1;
CV_C13InlineeLinesParsed *inlinee_parsed = &inlinee_parsed_node->v;
inlinee_parsed->inlinee = hdr->inlinee;
inlinee_parsed->file_off = hdr->file_off;
inlinee_parsed->first_source_ln = hdr->first_source_ln;
inlinee_parsed->extra_file_count = 0;
inlinee_parsed->extra_files = 0;
if (sig == CV_C13InlineeLinesSig_EXTRA_FILES) {
if (cursor + sizeof(U32) <= raw_data_node->string.size) {
U32 *extra_file_count_ptr = (U32 *)(raw_data_node->string.str + cursor);
cursor += sizeof(*extra_file_count_ptr);
U32 max_extra_file_count = (raw_data_node->string.size - cursor) / sizeof(U32);
U32 extra_file_count = Min(*extra_file_count_ptr, max_extra_file_count);
U32 *extra_files = (U32 *)(raw_data_node->string.str + cursor);
cursor += sizeof(*extra_files) * extra_file_count;
inlinee_parsed->extra_file_count = extra_file_count;
inlinee_parsed->extra_files = extra_files;
}
}
}
}
ProfEnd();
return inlinee_lines_list;
}
// $$FrameData
internal void
cv_c13_patch_checksum_offsets_in_frame_data_list(String8List frame_data, U32 checksum_rebase)
{
for(String8Node *node = frame_data.first; node != 0; node = node->next)
{
String8 raw_data = node->string;
U64 count = raw_data.size / sizeof(CV_C13FrameData);
CV_C13FrameData *arr = (CV_C13FrameData *)raw_data.str;
CV_C13FrameData *ptr = arr;
CV_C13FrameData *opl = arr + count;
for(; ptr < opl; ptr += 1)
{
U64 rebased_frame_func = ptr->frame_func + checksum_rebase;
ptr->frame_func = safe_cast_u32(rebased_frame_func);
}
}
}
////////////////////////////////
// $$Lines Accel
internal int
cv_c13_voff_map_compar(const void *raw_a, const void *raw_b)
{
CV_Line *a = (CV_Line*)raw_a;
CV_Line *b = (CV_Line*)raw_b;
int cmp = a->voff < b->voff ? -1 :
a->voff > b->voff ? +1 :
0;
return cmp;
}
internal CV_LinesAccel *
cv_c13_make_lines_accel(Arena *arena, U64 lines_count, CV_LineArray *lines)
{
ProfBeginFunction();
U64 total_voff_count = 0;
for(U64 arr_idx = 0; arr_idx < lines_count; arr_idx += 1) {
total_voff_count += lines[arr_idx].line_count + 1;
}
CV_Line *map = push_array_no_zero(arena, CV_Line, total_voff_count);
U64 map_idx = 0;
for(U64 line_idx = 0; line_idx < lines_count; line_idx += 1) {
CV_LineArray *l = lines + line_idx;
if (l->line_count > 0) {
for(U64 voff_idx = 0; voff_idx < l->line_count; voff_idx += 1) {
map[map_idx].voff = l->voffs[voff_idx];
map[map_idx].file_off = l->file_off;
map[map_idx].line_num = l->line_nums[voff_idx];
map[map_idx].col_num = 0; // TODO: columns
map_idx += 1;
}
map[map_idx].voff = l->voffs[l->line_count];
map[map_idx].file_off = l->file_off;
map[map_idx].line_num = 0;
map[map_idx].col_num = 0;
map_idx += 1;
}
}
Assert(map_idx == total_voff_count);
qsort(map, total_voff_count, sizeof(map[0]), cv_c13_voff_map_compar);
CV_LinesAccel *accel = push_array(arena, CV_LinesAccel, 1);
accel->map_count = total_voff_count;
accel->map = map;
ProfEnd();
return accel;
}
internal CV_LinesAccel *
cv_lines_accel_from_debug_s(Arena *arena, CV_DebugS debug_s)
{
// parse $$LINES
U64 c13_lines_count = 0;
CV_LineArray *c13_lines = 0;
{
String8List raw_lines_list = cv_sub_section_from_debug_s(debug_s, CV_C13SubSectionKind_Lines);
for (String8Node *raw_lines_node = raw_lines_list.first; raw_lines_node != 0; raw_lines_node = raw_lines_node->next) {
Temp temp = temp_begin(arena);
CV_C13LinesHeaderList parsed_list = cv_c13_lines_from_sub_sections(temp.arena, raw_lines_node->string, rng_1u64(0, raw_lines_node->string.size));
c13_lines_count += parsed_list.count;
temp_end(temp);
}
c13_lines = push_array_no_zero(arena, CV_LineArray, c13_lines_count);
U64 c13_lines_idx = 0;
for (String8Node *raw_lines_node = raw_lines_list.first; raw_lines_node != 0; raw_lines_node = raw_lines_node->next) {
String8 raw_lines = raw_lines_node->string;
CV_C13LinesHeaderList parsed_list = cv_c13_lines_from_sub_sections(arena, raw_lines, rng_1u64(0, raw_lines.size));
for(CV_C13LinesHeaderNode *header_node = parsed_list.first; header_node != 0; header_node = header_node->next) {
c13_lines[c13_lines_idx++] = cv_c13_line_array_from_data(arena, raw_lines, 0, header_node->v);
}
}
}
return cv_c13_make_lines_accel(arena, c13_lines_count, c13_lines);
}
internal U64
cv_nearest_line(CV_Line *arr, U64 count, U64 value)
{
if(count > 1 && arr[0].voff <= value && value < arr[count-1].voff)
{
U64 l = 0;
U64 r = count - 1;
for (; l <= r; ) {
U64 m = l + (r - l) / 2;
if (arr[m].voff == value) {
return m;
} else if (arr[m].voff < value) {
l = m + 1;
} else {
r = m - 1;
}
}
return l;
}
else if (count == 1 && arr[0].voff == value)
{
return 0;
}
return max_U64;
}
internal CV_Line *
cv_line_from_voff(CV_LinesAccel *accel, U64 voff, U64 *out_line_count)
{
ProfBeginFunction();
U64 voff_line_count = 0;
CV_Line *lines = 0;
U64 map_idx = cv_nearest_line(accel->map, accel->map_count, voff);
if(map_idx < accel->map_count) {
U64 near_voff = accel->map[map_idx].voff;
for (; map_idx > 0; map_idx -= 1) {
if(accel->map[map_idx - 1].voff != near_voff) {
break;
}
}
lines = accel->map + map_idx;
for(; map_idx < (accel->map_count-1); map_idx += 1) {
if(accel->map[map_idx].voff != near_voff) {
break;
}
voff_line_count += 1;
}
}
*out_line_count = voff_line_count;
ProfEnd();
return lines;
}
////////////////////////////////
// $$InlineeLines Accel
internal U64
cv_c13_inlinee_lines_accel_hash(void *buffer, U64 size)
{
XXH64_hash_t hash64 = XXH3_64bits(buffer, size);
return hash64;
}
internal B32
cv_c13_inlinee_lines_accel_push(CV_InlineeLinesAccel *accel, CV_C13InlineeLinesParsed *parsed)
{
U64 load_factor = accel->bucket_max * 2/3 + 1;
if(accel->bucket_count > load_factor) {
Assert("TODO: increase max count and rehash buckets");
}
B32 is_pushed = 0;
U64 hash = cv_c13_inlinee_lines_accel_hash(&parsed->inlinee, sizeof(parsed->inlinee));
U64 best_idx = hash % accel->bucket_max;
U64 idx = best_idx;
do {
if(accel->buckets[idx] == 0) {
accel->buckets[idx] = parsed;
accel->bucket_count += 1;
is_pushed = 1;
break;
}
idx = (idx + 1) % accel->bucket_max;
} while(idx != best_idx);
return is_pushed;
}
internal CV_C13InlineeLinesParsed *
cv_c13_inlinee_lines_accel_find(CV_InlineeLinesAccel *accel, CV_ItemId inlinee)
{
CV_C13InlineeLinesParsed *match = 0;
U64 hash = cv_c13_inlinee_lines_accel_hash(&inlinee, sizeof(inlinee));
U64 best_idx = hash % accel->bucket_max;
U64 idx = best_idx;
do {
if(accel->buckets[idx] != 0) {
if(accel->buckets[idx]->inlinee == inlinee) {
match = accel->buckets[idx];
break;
}
}
idx = (idx + 1) % accel->bucket_max;
} while(idx != best_idx);
return match;
}
internal CV_InlineeLinesAccel *
cv_c13_make_inlinee_lines_accel(Arena *arena, CV_C13InlineeLinesParsedList inlinee_lines)
{
ProfBeginFunction();
// alloc hash table
CV_InlineeLinesAccel *accel = push_array(arena, CV_InlineeLinesAccel, 1);
accel->bucket_count = 0;
accel->bucket_max = (U64)((F64)inlinee_lines.count * 2.5);
accel->buckets = push_array(arena, CV_C13InlineeLinesParsed *, accel->bucket_max);
// push parsed inlinees
for(CV_C13InlineeLinesParsedNode *inlinee = inlinee_lines.first; inlinee != 0; inlinee = inlinee->next) {
cv_c13_inlinee_lines_accel_push(accel, &inlinee->v);
}
ProfEnd();
return accel;
}
////////////////////////////////
internal CV_InlineBinaryAnnotsParsed
cv_c13_parse_inline_binary_annots(Arena *arena,
U64 parent_voff,
CV_C13InlineeLinesParsed *inlinee_parsed,
String8 binary_annots)
{
Temp scratch = scratch_begin(&arena, 1);
struct CodeRange {
struct CodeRange *next;
Rng1U64 range;
};
struct SourceLine {
struct SourceLine *next;
U64 voff;
U64 length;
U64 ln;
U64 cn;
CV_InlineRangeKind kind;
};
struct SourceFile {
struct SourceFile *next;
struct SourceLine *line_first;
struct SourceLine *line_last;
U64 line_count;
U64 checksum_off;
Rng1U64 last_code_range;
};
Rng1U64List code_ranges = {0};
struct SourceFile *file_first = 0;
struct SourceFile *file_last = 0;
U64 file_count = 0;
CV_C13InlineSiteDecoder decoder = cv_c13_inline_site_decoder_init(inlinee_parsed->file_off, inlinee_parsed->first_source_ln, parent_voff);
for (;;) {
CV_C13InlineSiteDecoderStep step = cv_c13_inline_site_decoder_step(&decoder, binary_annots);
if (step.flags == 0) {
break;
}
if (step.flags & CV_C13InlineSiteDecoderStepFlag_EmitRange) {
rng1u64_list_push(arena, &code_ranges, step.range);
}
if (step.flags & CV_C13InlineSiteDecoderStepFlag_ExtendLastRange) {
if (code_ranges.last) {
code_ranges.last->v = step.range;
}
}
if (step.flags & CV_C13InlineSiteDecoderStepFlag_EmitFile) {
struct SourceFile *file = push_array(scratch.arena, struct SourceFile, 1);
file->checksum_off = step.file_off;
SLLQueuePush(file_first, file_last, file);
++file_count;
}
if (step.flags & CV_C13InlineSiteDecoderStepFlag_EmitLine) {
struct SourceLine *line = push_array(scratch.arena, struct SourceLine, 1);
line->voff = step.line_voff;
line->ln = step.ln;
line->cn = step.cn;
SLLQueuePush(file_last->line_first, file_last->line_last, line);
++file_last->line_count;
}
}
CV_LineArray *lines = push_array(arena, CV_LineArray, file_count);
{
U64 lines_idx = 0;
for (struct SourceFile *file = file_first; file != 0; file = file->next, lines_idx += 1) {
CV_LineArray *l = lines + lines_idx;
l->file_off = file->checksum_off;
l->line_count = file->line_count;
l->col_count = 0;
if (file->line_count > 0) {
l->voffs = push_array_no_zero(arena, U64, file->line_count + 1);
l->line_nums = push_array_no_zero(arena, U32, file->line_count);
l->col_nums = 0; // TODO: column info
U64 line_idx = 0;
for (struct SourceLine *line = file->line_first; line != NULL; line = line->next, ++line_idx) {
// emit line voff and line number
l->voffs[line_idx] = line->voff;
l->line_nums[line_idx] = (U32)line->ln;
}
Assert(line_idx == file->line_count);
l->voffs[line_idx] = file->last_code_range.max;
}
}
}
// fill out result
CV_InlineBinaryAnnotsParsed result = {0};
result.lines_count = file_count;
result.lines = lines;
result.code_ranges = code_ranges;
scratch_end(scratch);
return result;
}
////////////////////////////////
internal Rng1U64List
cv_make_defined_range_list_from_gaps(Arena *arena, Rng1U64 defrange, CV_LvarAddrGap *gaps, U64 gap_count)
{
Rng1U64List result = {0};
if (gap_count == 0) {
// no gaps, push whole range
rng1u64_list_push(arena, &result, defrange);
} else {
U64 cursor = defrange.min;
for (U64 gap_idx = 0; gap_idx < gap_count; ++gap_idx) {
// make range
Rng1U64 range = rng_1u64(cursor, cursor + gaps[gap_idx].off);
rng1u64_list_push(arena, &result, range);
// advance
cursor = defrange.min + gaps[gap_idx].off + gaps[gap_idx].len;
}
// emit range past last gap
if (gap_count > 0) {
CV_LvarAddrGap last_gap = gaps[gap_count - 1];
U64 last_range_byte_size = dim_1u64(defrange) - (last_gap.off + last_gap.len);
if (last_range_byte_size) {
Rng1U64 last_range = rng_1u64(defrange.min + last_gap.off + last_gap.len, defrange.max);
rng1u64_list_push(arena, &result, last_range);
}
}
}
return result;
}