ed/Odin
1
0
Fork 0
mirror of https://github.com/Ed94/Odin.git synced 2026-08-06 07:38:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup comments/todos.

Browse Source
This commit is contained in:
lachsinc
2018-09-26 02:17:05 +10:00
parent 0f6c1f3482
commit 7acb49eefb
2 changed files with 11 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ir.cpp
+8 -15
View File
@@ -577,7 +577,7 @@ struct irDebugInfo {
} Proc; } Proc;
struct { struct {
Array<irDebugInfo *> procs; Array<irDebugInfo *> procs;
} AllProcs; // TODO(lach): Redundant w/ DebugInfoArray. Merge. } AllProcs; // TODO(lachsinc): Redundant w/ DebugInfoArray. Merge.
// NOTE(lachsinc): Many of the following fields could be removed/resolved as we print it? // NOTE(lachsinc): Many of the following fields could be removed/resolved as we print it?
struct { struct {
@@ -613,7 +613,7 @@ struct irDebugInfo {
i32 size; i32 size;
i32 align; i32 align;
irDebugInfo * elements; irDebugInfo * elements;
i32 array_count; // TODO(lach): We could define a new !DISubrange and place ptr to it inside above elements array instead. i32 array_count; // for DISubrange
} CompositeType; } CompositeType;
struct { struct {
String name; String name;
@@ -1680,16 +1680,13 @@ irDebugInfo *ir_add_debug_info_enumerator(irModule *module, Entity *e) {
} }
irDebugInfo *ir_add_debug_info_dynamic_array(irModule *module, irDebugInfo *scope, Entity *e, Type *type, irDebugInfo *file) { irDebugInfo *ir_add_debug_info_dynamic_array(irModule *module, irDebugInfo *scope, Entity *e, Type *type, irDebugInfo *file) {
// // TODO(lachsinc): Cleanup hardcode.
// TODO(lachsinc): Hardcode McGee.
//
// TODO(lachsinc): SPEED? I assume this will create a bunch of new debug infos for _every single_ // TODO(lachsinc): SPEED? I assume this will create a bunch of new debug infos for _every single_
// dynamic array type. Maybe that's what we want, but with ability to refer to the _same_ // dynamic array type. Maybe that's what we want, but with ability to refer to the _same_
// derived types for the len/cap/allocator fields. // derived types for the len/cap/allocator fields.
// TODO(lachsinc): HACK we should handle named's as derived types to // TODO(lachsinc): HACK named should be handled as derived types, see above.
// minimise duplication of work / ir output
Type *named = nullptr; Type *named = nullptr;
if (is_type_named(type)) { if (is_type_named(type)) {
named = type; named = type;
@@ -1754,7 +1751,7 @@ irDebugInfo *ir_add_debug_info_dynamic_array(irModule *module, irDebugInfo *scop
array_add(&di->CompositeType.elements->DebugInfoArray.elements, cap_di); array_add(&di->CompositeType.elements->DebugInfoArray.elements, cap_di);
array_add(&di->CompositeType.elements->DebugInfoArray.elements, alloc_di); array_add(&di->CompositeType.elements->DebugInfoArray.elements, alloc_di);
// NOTE(lach): This isn't particularly robust; we create a new one for every type. A potential workaround // NOTE(lachsinc): This isn't particularly robust; we create a new one for every type. A potential workaround
// is to store a pointer for each of these "custom" types inside irModule, creating if not exists // is to store a pointer for each of these "custom" types inside irModule, creating if not exists
// (and either adding to debug_info map, or assigning id's manually to them). // (and either adding to debug_info map, or assigning id's manually to them).
map_set(&module->debug_info, hash_pointer(data_ptr_di), data_ptr_di); map_set(&module->debug_info, hash_pointer(data_ptr_di), data_ptr_di);
@@ -1770,11 +1767,7 @@ irDebugInfo *ir_add_debug_info_dynamic_array(irModule *module, irDebugInfo *scop
} }
irDebugInfo *ir_add_debug_info_string(irModule *module, irDebugInfo *scope, Entity *e, Type *type, irDebugInfo *file) { irDebugInfo *ir_add_debug_info_string(irModule *module, irDebugInfo *scope, Entity *e, Type *type, irDebugInfo *file) {
// TODO(lach): Is there a cleaner way to set up these types without hardcoding values ?? // TODO(lachsinc): Cleanup hardcode.
// Also we may want to just create hardcoded "base type" for things like strings etc.
// and just create a derived (named) type to "inherit" from. That way we can look them up directly
// inside irModule, and avoid lots of map lookups and array creations for their elements.
// In theory this should only occur once, as we hash the type t_string once and return it.
GB_ASSERT(type->kind == Type_Basic); GB_ASSERT(type->kind == Type_Basic);
GB_ASSERT(type->Basic.kind == Basic_string); GB_ASSERT(type->Basic.kind == Basic_string);
@@ -1803,7 +1796,7 @@ irDebugInfo *ir_add_debug_info_string(irModule *module, irDebugInfo *scope, Enti
array_add(&di->CompositeType.elements->DebugInfoArray.elements, data_di); array_add(&di->CompositeType.elements->DebugInfoArray.elements, data_di);
array_add(&di->CompositeType.elements->DebugInfoArray.elements, len_di); array_add(&di->CompositeType.elements->DebugInfoArray.elements, len_di);
// NOTE(lach): This isn't particularly robust, it assumes all strings will be caught // NOTE(lachsinc): This isn't particularly robust, it assumes all strings will be caught
// by the map lookup (ie this will only be created once). // by the map lookup (ie this will only be created once).
map_set(&module->debug_info, hash_pointer(data_di), data_di); map_set(&module->debug_info, hash_pointer(data_di), data_di);
map_set(&module->debug_info, hash_pointer(len_di), len_di); map_set(&module->debug_info, hash_pointer(len_di), len_di);
@@ -2062,7 +2055,7 @@ irDebugInfo *ir_add_debug_info_proc(irProcedure *proc, Entity *entity, String na
if (e->kind != Entity_Variable) { if (e->kind != Entity_Variable) {
continue; // TODO(lachsinc): Confirm correct? continue; // TODO(lachsinc): Confirm correct?
} }
// TODO(lach): Could technically be a local? // TODO(lachsinc): Could technically be a local?
irDebugInfo *type_di = ir_add_debug_info_type(proc->module, di, e, e->type, file); irDebugInfo *type_di = ir_add_debug_info_type(proc->module, di, e, e->type, file);
GB_ASSERT_NOT_NULL(type_di); GB_ASSERT_NOT_NULL(type_di);
array_add(&di->Proc.types->DebugInfoArray.elements, type_di); array_add(&di->Proc.types->DebugInfoArray.elements, type_di);
src/ir_print.cpp
+3 -5
View File
@@ -1955,7 +1955,7 @@ void print_llvm_ir(irGen *ir) {
", runtimeVersion: 0" ", runtimeVersion: 0"
", isOptimized: false" ", isOptimized: false"
", emissionKind: FullDebug" ", emissionKind: FullDebug"
", retainedTypes: !0" // TODO(lachsinc) ", retainedTypes: !0" // TODO(lachsinc)
", enums: !%d" ", enums: !%d"
", globals: !%d" ", globals: !%d"
")", ")",
@@ -1966,7 +1966,6 @@ void print_llvm_ir(irGen *ir) {
break; break;
} }
case irDebugInfo_File: case irDebugInfo_File:
// TODO(lachsinc): Does windows debug info expect '/' or '\5C' path separators ??
ir_fprintf(f, "!DIFile(filename: \""); ir_print_escape_path(f, di->File.filename); ir_fprintf(f, "!DIFile(filename: \""); ir_print_escape_path(f, di->File.filename);
ir_fprintf(f, "\", directory: \""); ir_print_escape_path(f, di->File.directory); ir_fprintf(f, "\", directory: \""); ir_print_escape_path(f, di->File.directory);
ir_fprintf(f, "\""); ir_fprintf(f, "\"");
@@ -2004,7 +2003,6 @@ void print_llvm_ir(irGen *ir) {
di->GlobalVariableExpression.var->id); di->GlobalVariableExpression.var->id);
if (di->GlobalVariableExpression.var->GlobalVariable.variable->Global.is_constant) { if (di->GlobalVariableExpression.var->GlobalVariable.variable->Global.is_constant) {
ir_write_str_lit(f, "DW_OP_constu, "); ir_write_str_lit(f, "DW_OP_constu, ");
// TODO(lachsinc): Confirm this prints the type as llvm expects eg. hex representation for float is safe etc.
ir_print_value(f, m, di->GlobalVariable.variable, ir_type(di->GlobalVariable.variable)); ir_print_value(f, m, di->GlobalVariable.variable, ir_type(di->GlobalVariable.variable));
ir_write_str_lit(f, ", DW_OP_stack_value"); ir_write_str_lit(f, ", DW_OP_stack_value");
} else { } else {
@@ -2043,7 +2041,7 @@ void print_llvm_ir(irGen *ir) {
di->LocalVariable.pos.line, di->LocalVariable.pos.line,
di->LocalVariable.type->id); di->LocalVariable.type->id);
if (di->LocalVariable.arg > 0) { if (di->LocalVariable.arg > 0) {
GB_ASSERT(false); // TODO(lachsinc): "Arg" debug info not implemented yet GB_PANIC("Param 'Arg' debug info not yet implemented"); // TODO(lachsinc):
ir_fprintf(f, ", arg: %d", di->LocalVariable.arg); ir_fprintf(f, ", arg: %d", di->LocalVariable.arg);
} }
ir_write_byte(f, ')'); ir_write_byte(f, ')');
@@ -2127,7 +2125,7 @@ void print_llvm_ir(irGen *ir) {
case irDebugInfo_Enumerator: { case irDebugInfo_Enumerator: {
ir_fprintf(f, "!DIEnumerator(" ir_fprintf(f, "!DIEnumerator("
"name: \"%.*s\"" "name: \"%.*s\""
", value: %d)", // TODO(lachsinc): PRId64 equiv? ", value: %lld)",
LIT(di->Enumerator.name), LIT(di->Enumerator.name),
di->Enumerator.value); di->Enumerator.value);
break; break;