Work on making name mangling deterministic

1 files changed, 419 insertions, 0 deletions

diff --git a/src/name_canonicalization.cpp b/src/name_canonicalization.cpp
new file mode 100644
index 000000000..fa09f27c0
--- /dev/null
+++ b/src/name_canonicalization.cpp
@@ -0,0 +1,419 @@
+gb_internal gbString write_type_to_canonical_string(gbString w, Type *type);
+gb_internal gbString write_canonical_params(gbString w, Type *params) {
+	w = gb_string_appendc(w, "(");
+	if (params) {
+		GB_ASSERT(params->kind == Type_Tuple);
+		for_array(i, params->Tuple.variables) {
+			Entity *v = params->Tuple.variables[i];
+			if (i > 0) {
+				w = gb_string_appendc(w, ",");
+			}
+			if (v->kind == Entity_Variable) {
+				if (v->flags&EntityFlag_CVarArg) {
+					w = gb_string_appendc(w, "#c_vararg");
+				}
+				if (v->flags&EntityFlag_Ellipsis) {
+					Type *slice = base_type(v->type);
+					w = gb_string_appendc(w, "..");
+					GB_ASSERT(v->type->kind == Type_Slice);
+					w = write_type_to_canonical_string(w, slice->Slice.elem);
+				} else {
+					w = write_type_to_canonical_string(w, v->type);
+				}
+			} else if (v->kind == Entity_TypeName) {
+				w = gb_string_appendc(w, "$");
+				w = write_type_to_canonical_string(w, v->type);
+			} else if (v->kind == Entity_Constant) {
+				w = gb_string_appendc(w, "$$");
+				w = write_exact_value_to_string(w, v->Constant.value);
+			} else {
+				GB_PANIC("TODO(bill): handle non type/const parapoly parameter values");
+			}
+		}
+	}
+	return gb_string_appendc(w, ")");
+}
+
+gb_internal u64 type_hash_canonical_type(Type *type) {
+	if (type == nullptr) {
+		return 0;
+	}
+	TEMPORARY_ALLOCATOR_GUARD();
+	gbString w = write_type_to_canonical_string(gb_string_make(temporary_allocator(), ""), type);
+	u64 hash = fnv64a(w, gb_string_length(w));
+	return hash;
+}
+
+gb_internal String type_to_canonical_string(gbAllocator allocator, Type *type) {
+	gbString w = gb_string_make(allocator, "");
+	w = write_type_to_canonical_string(w, type);
+	return make_string(cast(u8 const *)w, gb_string_length(w));
+}
+
+gb_internal void print_scope_flags(Scope *s) {
+	if (s->flags & ScopeFlag_Pkg)             gb_printf_err("Pkg ");
+	if (s->flags & ScopeFlag_Builtin)         gb_printf_err("Builtin ");
+	if (s->flags & ScopeFlag_Global)          gb_printf_err("Global ");
+	if (s->flags & ScopeFlag_File)            gb_printf_err("File ");
+	if (s->flags & ScopeFlag_Init)            gb_printf_err("Init ");
+	if (s->flags & ScopeFlag_Proc)            gb_printf_err("Proc ");
+	if (s->flags & ScopeFlag_Type)            gb_printf_err("Type ");
+	if (s->flags & ScopeFlag_HasBeenImported) gb_printf_err("HasBeenImported ");
+	if (s->flags & ScopeFlag_ContextDefined)  gb_printf_err("ContextDefined ");
+	gb_printf_err("\n");
+}
+
+
+
+gb_internal gbString write_canonical_parent_prefix(gbString w, Entity *e, bool ignore_final_dot=false) {
+	GB_ASSERT(e != nullptr);
+
+	// auto const &parent_entity = [](Scope *s) -> Entity* {
+	// 	while ((s->flags & (ScopeFlag_Proc|ScopeFlag_File)) == 0 && s->decl_info == nullptr) {
+	// 		s = s->parent;
+	// 	}
+	// 	if (s->decl_info && s->decl_info->entity) {
+	// 		return s->decl_info->entity;
+	// 	}
+	// 	return nullptr;
+	// };
+
+	if (e->kind == Entity_Procedure) {
+		if (e->Procedure.is_export || e->Procedure.is_foreign) {
+			// no prefix
+			return w;
+		}
+		if (e->parent_proc_decl) {
+			Entity *p = e->parent_proc_decl->entity;
+			w = write_canonical_parent_prefix(w, p);
+			w = gb_string_append_length(w, p->token.string.text, p->token.string.len);
+			if (is_type_polymorphic(p->type)) {
+				w = gb_string_appendc(w, "::");
+				w = write_type_to_canonical_string(w, p->type);
+			}
+			w = gb_string_appendc(w, ".");
+
+		} else if (e->pkg && (scope_lookup_current(e->pkg->scope, e->token.string) == e)) {
+			w = gb_string_append_length(w, e->pkg->name.text, e->pkg->name.len);
+			if (e->pkg->name == "llvm") {
+				gb_string_appendc(w, "$");
+			}
+			w = gb_string_appendc(w, ".");
+		} else {
+			String file_name = filename_without_directory(e->file->fullpath);
+			w = gb_string_append_length(w, e->pkg->name.text, e->pkg->name.len);
+			if (e->pkg->name == "llvm") {
+				gb_string_appendc(w, "$");
+			}
+			w = gb_string_appendc(w, gb_bprintf(".[%.*s].", LIT(file_name)));
+		}
+	} else if (e->kind == Entity_Procedure) {
+		if (e->Procedure.is_export || e->Procedure.is_foreign) {
+			// no prefix
+			return w;
+		}
+		GB_PANIC("TODO(bill): handle entity kind: %d", e->kind);
+	}
+
+	if (e->kind == Entity_Procedure && e->Procedure.is_anonymous) {
+		w = gb_string_appendc(w, gb_bprintf("$anon%d", e->token.pos.offset));
+	} else {
+		w = gb_string_append_length(w, e->token.string.text, e->token.string.len);
+	}
+
+	if (is_type_polymorphic(e->type)) {
+		w = gb_string_appendc(w, "::");
+		w = write_type_to_canonical_string(w, e->type);
+	}
+	if (!ignore_final_dot) {
+		w = gb_string_appendc(w, ".");
+	}
+
+	return w;
+}
+
+gb_internal gbString write_canonical_entity_name(gbString w, Entity *e) {
+	GB_ASSERT(e != nullptr);
+
+	if (e->token.string == "_") {
+		GB_PANIC("_ string");
+	}
+	if (e->token.string.len == 0) {
+		GB_PANIC("empty string");
+	}
+
+	if (e->kind == Entity_Variable) {
+		bool is_foreign = e->Variable.is_foreign;
+		bool is_export  = e->Variable.is_export;
+		if (e->Variable.link_name.len > 0) {
+			w = gb_string_append_length(w, e->Variable.link_name.text, e->Variable.link_name.len);
+			return w;
+		} else if (is_foreign || is_export) {
+			w = gb_string_append_length(w, e->token.string.text, e->token.string.len);
+			return w;
+		}
+	} else if (e->kind == Entity_Procedure && e->Procedure.link_name.len > 0) {
+		w = gb_string_append_length(w, e->Procedure.link_name.text, e->Procedure.link_name.len);
+		return w;
+	} else if (e->kind == Entity_Procedure && e->Procedure.is_export) {
+		w = gb_string_append_length(w, e->token.string.text, e->token.string.len);
+		return w;
+	}
+
+	if ((e->scope->flags & (ScopeFlag_File | ScopeFlag_Pkg)) == 0 ||
+	    e->flags & EntityFlag_NotExported) {
+
+		Scope *s = e->scope;
+		while ((s->flags & (ScopeFlag_Proc|ScopeFlag_File)) == 0 && s->decl_info == nullptr) {
+			s = s->parent;
+		}
+
+		if (s->decl_info != nullptr && s->decl_info->entity)  {
+			w = write_canonical_parent_prefix(w, s->decl_info->entity);
+			goto write_base_name;
+		} else if ((s->flags & ScopeFlag_File) && s->file != nullptr) {
+			String file_name = filename_without_directory(s->file->fullpath);
+			w = gb_string_append_length(w, e->pkg->name.text, e->pkg->name.len);
+			if (e->pkg->name == "llvm") {
+				gb_string_appendc(w, "$");
+			}
+			w = gb_string_appendc(w, gb_bprintf(".[%.*s].", LIT(file_name)));
+			goto write_base_name;
+		}
+		gb_printf_err("%s HERE %s %u %p\n", token_pos_to_string(e->token.pos), type_to_string(e->type), s->flags, s->decl_info);
+		print_scope_flags(s);
+		GB_PANIC("weird entity");
+	}
+	if (e->pkg != nullptr) {
+		w = gb_string_append_length(w, e->pkg->name.text, e->pkg->name.len);
+		w = gb_string_appendc(w, ".");
+	}
+
+write_base_name:
+
+	switch (e->kind) {
+	case Entity_TypeName:
+		{
+			Type *params = nullptr;
+			Entity *parent = type_get_polymorphic_parent(e->type, &params);
+			if (parent) {
+				w = gb_string_append_length(w, parent->token.string.text, parent->token.string.len);
+				w = write_canonical_params(w, params);
+			} else {
+				w = gb_string_append_length(w, e->token.string.text, e->token.string.len);
+			}
+		}
+		// Handle parapoly stuff here?
+		return w;
+
+	case Entity_Procedure:
+	case Entity_Variable:
+		w = gb_string_append_length(w, e->token.string.text, e->token.string.len);
+		if (is_type_polymorphic(e->type)) {
+			w = gb_string_appendc(w, "::");
+			w = write_type_to_canonical_string(w, e->type);
+		}
+		return w;
+
+	default:
+		GB_PANIC("TODO(bill): entity kind %d", e->kind);
+		break;
+	}
+	return w;
+}
+
+// NOTE(bill): This exists so that we deterministically hash a type by serializing it to a canonical string
+gb_internal gbString write_type_to_canonical_string(gbString w, Type *type) {
+	if (type == nullptr) {
+		return gb_string_appendc(w, "<>"); // none/void type
+	}
+
+	type = default_type(type);
+	GB_ASSERT(!is_type_untyped(type));
+
+	switch (type->kind) {
+	case Type_Basic:
+		return gb_string_append_length(w, type->Basic.name.text, type->Basic.name.len);
+	case Type_Pointer:
+		w = gb_string_append_rune(w, '^');
+		return write_type_to_canonical_string(w, type->Pointer.elem);
+	case Type_MultiPointer:
+		w = gb_string_appendc(w, "[^]");
+		return write_type_to_canonical_string(w, type->Pointer.elem);
+	case Type_SoaPointer:
+		w = gb_string_appendc(w, "#soa^");
+		return write_type_to_canonical_string(w, type->Pointer.elem);
+	case Type_EnumeratedArray:
+		if (type->EnumeratedArray.is_sparse) {
+			w = gb_string_appendc(w, "#sparse");
+		}
+		w = gb_string_append_rune(w, '[');
+		w = write_type_to_canonical_string(w, type->EnumeratedArray.index);
+		w = gb_string_append_rune(w, ']');
+		return write_type_to_canonical_string(w, type->EnumeratedArray.elem);
+	case Type_Array:
+		w = gb_string_appendc(w, gb_bprintf("[%lld]", cast(long long)type->Array.count));
+		return write_type_to_canonical_string(w, type->Array.elem);
+	case Type_Slice:
+		w = gb_string_appendc(w, "[]");
+		return write_type_to_canonical_string(w, type->Array.elem);
+	case Type_DynamicArray:
+		w = gb_string_appendc(w, "[dynamic]");
+		return write_type_to_canonical_string(w, type->DynamicArray.elem);
+	case Type_SimdVector:
+		w = gb_string_appendc(w, gb_bprintf("#simd[%lld]", cast(long long)type->SimdVector.count));
+		return write_type_to_canonical_string(w, type->SimdVector.elem);
+	case Type_Matrix:
+		if (type->Matrix.is_row_major) {
+			w = gb_string_appendc(w, "#row_major ");
+		}
+		w = gb_string_appendc(w, gb_bprintf("matrix[%lld, %lld]", cast(long long)type->Matrix.row_count, cast(long long)type->Matrix.column_count));
+		return write_type_to_canonical_string(w, type->Matrix.elem);
+	case Type_Map:
+		w = gb_string_appendc(w, "map[");
+		w = write_type_to_canonical_string(w, type->Map.key);
+		w = gb_string_appendc(w, "]");
+		return write_type_to_canonical_string(w, type->Map.value);
+
+	case Type_Enum:
+		w = gb_string_appendc(w, "enum");
+		if (type->Enum.base_type != nullptr) {
+			w = gb_string_append_rune(w, ' ');
+			w = write_type_to_canonical_string(w, type->Enum.base_type);
+			w = gb_string_append_rune(w, ' ');
+		}
+		w = gb_string_append_rune(w, '{');
+		for_array(i, type->Enum.fields) {
+			Entity *f = type->Enum.fields[i];
+			GB_ASSERT(f->kind == Entity_Constant);
+			if (i > 0) {
+				w = gb_string_appendc(w, ",");
+			}
+			w = gb_string_append_length(w, f->token.string.text, f->token.string.len);
+			w = gb_string_appendc(w, "=");
+			w = write_exact_value_to_string(w, f->Constant.value);
+		}
+		return gb_string_append_rune(w, '}');
+	case Type_BitSet:
+		w = gb_string_appendc(w, "bit_set[");
+		if (type->BitSet.elem == nullptr) {
+			w = write_type_to_canonical_string(w, type->BitSet.elem);
+		} else if (is_type_enum(type->BitSet.elem)) {
+			w = write_type_to_canonical_string(w, type->BitSet.elem);
+		} else {
+			w = gb_string_append_fmt(w, "%lld", type->BitSet.lower);
+			w = gb_string_append_fmt(w, "..=");
+			w = gb_string_append_fmt(w, "%lld", type->BitSet.upper);
+		}
+		if (type->BitSet.underlying != nullptr) {
+			w = gb_string_appendc(w, ";");
+			w = write_type_to_canonical_string(w, type->BitSet.underlying);
+		}
+		return gb_string_appendc(w, "]");
+
+	case Type_Union:
+		w = gb_string_appendc(w, "union");
+
+		switch (type->Union.kind) {
+		case UnionType_no_nil:     w = gb_string_appendc(w, "#no_nil");     break;
+		case UnionType_shared_nil: w = gb_string_appendc(w, "#shared_nil"); break;
+		}
+		if (type->Union.custom_align != 0) {
+			w = gb_string_append_fmt(w, "#align(%lld)", cast(long long)type->Union.custom_align);
+		}
+		w = gb_string_appendc(w, "{");
+		for_array(i, type->Union.variants) {
+			Type *t = type->Union.variants[i];
+			if (i > 0) w = gb_string_appendc(w, ", ");
+			w = write_type_to_canonical_string(w, t);
+		}
+		return gb_string_appendc(w, "}");
+	case Type_Struct:
+		if (type->Struct.soa_kind != StructSoa_None) {
+			switch (type->Struct.soa_kind) {
+			case StructSoa_Fixed:   w = gb_string_append_fmt(w, "#soa[%lld]", cast(long long)type->Struct.soa_count); break;
+			case StructSoa_Slice:   w = gb_string_appendc(w,    "#soa[]");                                    break;
+			case StructSoa_Dynamic: w = gb_string_appendc(w,    "#soa[dynamic]");                             break;
+			default: GB_PANIC("Unknown StructSoaKind"); break;
+			}
+			return write_type_to_canonical_string(w, type->Struct.soa_elem);
+		}
+
+		w = gb_string_appendc(w, "struct");
+		if (type->Struct.is_packed)    w = gb_string_appendc(w, "#packed");
+		if (type->Struct.is_raw_union) w = gb_string_appendc(w, "#raw_union");
+		if (type->Struct.is_no_copy)   w = gb_string_appendc(w, "#no_copy");
+		if (type->Struct.custom_min_field_align != 0) w = gb_string_append_fmt(w, "#min_field_align(%lld)", cast(long long)type->Struct.custom_min_field_align);
+		if (type->Struct.custom_max_field_align != 0) w = gb_string_append_fmt(w, "#max_field_align(%lld)", cast(long long)type->Struct.custom_max_field_align);
+		if (type->Struct.custom_align != 0)           w = gb_string_append_fmt(w, "#align(%lld)",           cast(long long)type->Struct.custom_align);
+		w = gb_string_appendc(w, "{");
+		for_array(i, type->Struct.fields) {
+			Entity *f = type->Struct.fields[i];
+			GB_ASSERT(f->kind == Entity_Variable);
+			if (i > 0) {
+				w = gb_string_appendc(w, ",");
+			}
+			w = gb_string_append_length       (w, f->token.string.text, f->token.string.len);
+			w = gb_string_appendc             (w, ":");
+			w = write_type_to_canonical_string(w, f->type);
+			String tag = type->Struct.tags[i];
+			if (tag.len != 0) {
+				String s = quote_to_ascii(heap_allocator(), tag);
+				w = gb_string_append_length(w, s.text, s.len);
+				gb_free(heap_allocator(), s.text);
+			}
+		}
+		return gb_string_appendc(w, "}");
+
+	case Type_BitField:
+		w = gb_string_appendc(w, "bit_field");
+		w = write_type_to_canonical_string(w, type->BitField.backing_type);
+		w = gb_string_appendc(w, " {");
+		for (isize i = 0; i < type->BitField.fields.count; i++) {
+			Entity *f = type->BitField.fields[i];
+			if (i > 0) {
+				w = gb_string_appendc(w, ",");
+			}
+			w = gb_string_append_length(w, f->token.string.text, f->token.string.len);
+			w = gb_string_appendc(w, ":");
+			w = write_type_to_canonical_string(w, f->type);
+			w = gb_string_appendc(w, "|");
+			w = gb_string_appendc(w, gb_bprintf("%u", type->BitField.bit_sizes[i]));
+		}
+		return gb_string_appendc(w, " }");
+
+	case Type_Proc:
+		w = gb_string_appendc(w, "proc");
+		if (default_calling_convention() != type->Proc.calling_convention) {
+			w = gb_string_appendc(w, "\"");
+			w = gb_string_appendc(w, proc_calling_convention_strings[type->Proc.calling_convention]);
+			w = gb_string_appendc(w, "\"");
+		}
+
+		w = write_canonical_params(w, type->Proc.params);
+		if (type->Proc.result_count > 0) {
+			w = gb_string_appendc(w, "->");
+			w = write_canonical_params(w, type->Proc.results);
+		}
+		return w;
+
+	case Type_Generic:
+		GB_PANIC("Type_Generic should never be hit");
+		return w;
+
+	case Type_Named:
+		if (type->Named.type_name != nullptr) {
+			return write_canonical_entity_name(w, type->Named.type_name);
+		} else {
+			w = gb_string_append_length(w, type->Named.name.text, type->Named.name.len);
+		}
+		// Handle parapoly stuff here?
+		return w;
+
+	default:
+		GB_PANIC("unknown type kind %d", type->kind);
+		break;
+	}
+
+	return w;
+}
\ No newline at end of file