spirv: remove deduplication ISel

This commit is contained in:
Ali Cheraghi
2025-08-02 08:35:44 +03:30
parent 31de2c873f
commit 5525a90a47
7 changed files with 511 additions and 1016 deletions
-10
View File
@@ -553,11 +553,6 @@ set(ZIG_STAGE2_SOURCES
src/codegen/c/Type.zig
src/codegen/llvm.zig
src/codegen/llvm/bindings.zig
src/codegen/spirv.zig
src/codegen/spirv/Assembler.zig
src/codegen/spirv/Module.zig
src/codegen/spirv/Section.zig
src/codegen/spirv/spec.zig
src/crash_report.zig
src/dev.zig
src/libs/freebsd.zig
@@ -620,11 +615,6 @@ set(ZIG_STAGE2_SOURCES
src/link/Plan9.zig
src/link/Plan9/aout.zig
src/link/Queue.zig
src/link/SpirV.zig
src/link/SpirV/BinaryModule.zig
src/link/SpirV/deduplicate.zig
src/link/SpirV/lower_invocation_globals.zig
src/link/SpirV/prune_unused.zig
src/link/StringTable.zig
src/link/Wasm.zig
src/link/Wasm/Archive.zig
+1 -3
View File
@@ -3646,9 +3646,7 @@ pub fn errorSetBits(zcu: *const Zcu) u16 {
if (zcu.error_limit == 0) return 0;
if (target.cpu.arch.isSpirV()) {
if (!target.cpu.has(.spirv, .storage_push_constant16)) {
return 32;
}
if (zcu.comp.config.is_test) return 32;
}
return @as(u16, std.math.log2_int(ErrorInt, zcu.error_limit)) + 1;
+3 -4
View File
@@ -267,9 +267,7 @@ fn processTypeInstruction(self: *Assembler) !AsmValue {
const ids = try gpa.alloc(Id, operands[1..].len);
defer gpa.free(ids);
for (operands[1..], ids) |op, *id| id.* = try self.resolveRefId(op.ref_id);
const result_id = module.allocId();
try module.structType(result_id, ids, null);
break :blk result_id;
break :blk try module.structType(ids, null, null, .none);
},
.OpTypeImage => blk: {
const sampled_type = try self.resolveRefId(operands[1].ref_id);
@@ -324,6 +322,7 @@ fn processTypeInstruction(self: *Assembler) !AsmValue {
/// - Target section is determined from instruction type.
fn processGenericInstruction(self: *Assembler) !?AsmValue {
const module = self.cg.module;
const target = module.zcu.getTarget();
const operands = self.inst.operands.items;
var maybe_spv_decl_index: ?Decl.Index = null;
const section = switch (self.inst.opcode.class()) {
@@ -337,7 +336,7 @@ fn processGenericInstruction(self: *Assembler) !?AsmValue {
const storage_class: spec.StorageClass = @enumFromInt(operands[2].value);
if (storage_class == .function) break :section &self.cg.prologue;
maybe_spv_decl_index = try module.allocDecl(.global);
if (!module.target.cpu.has(.spirv, .v1_4) and storage_class != .input and storage_class != .output) {
if (!target.cpu.has(.spirv, .v1_4) and storage_class != .input and storage_class != .output) {
// Before version 1.4, the interfaces storage classes are limited to the Input and Output
break :section &module.sections.globals;
}
+215 -296
View File
@@ -181,8 +181,7 @@ const Error = error{ CodegenFail, OutOfMemory };
pub fn genNav(cg: *CodeGen, do_codegen: bool) Error!void {
const gpa = cg.module.gpa;
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ip = &zcu.intern_pool;
const nav = ip.getNav(cg.owner_nav);
@@ -198,7 +197,7 @@ pub fn genNav(cg: *CodeGen, do_codegen: bool) Error!void {
.func => {
const fn_info = zcu.typeToFunc(ty).?;
const return_ty_id = try cg.resolveFnReturnType(.fromInterned(fn_info.return_type));
const is_test = cg.pt.zcu.test_functions.contains(cg.owner_nav);
const is_test = zcu.test_functions.contains(cg.owner_nav);
const func_result_id = if (is_test) cg.module.allocId() else result_id;
const prototype_ty_id = try cg.resolveType(ty, .direct);
@@ -354,7 +353,7 @@ pub fn genNav(cg: *CodeGen, do_codegen: bool) Error!void {
pub fn fail(cg: *CodeGen, comptime format: []const u8, args: anytype) Error {
@branchHint(.cold);
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const src_loc = zcu.navSrcLoc(cg.owner_nav);
assert(cg.error_msg == null);
cg.error_msg = try Zcu.ErrorMsg.create(zcu.gpa, src_loc, format, args);
@@ -368,7 +367,7 @@ pub fn todo(cg: *CodeGen, comptime format: []const u8, args: anytype) Error {
/// This imports the "default" extended instruction set for the target
/// For OpenCL, OpenCL.std.100. For Vulkan and OpenGL, GLSL.std.450.
fn importExtendedSet(cg: *CodeGen) !Id {
const target = cg.module.target;
const target = cg.module.zcu.getTarget();
return switch (target.os.tag) {
.opencl, .amdhsa => try cg.module.importInstructionSet(.@"OpenCL.std"),
.vulkan, .opengl => try cg.module.importInstructionSet(.@"GLSL.std.450"),
@@ -379,7 +378,7 @@ fn importExtendedSet(cg: *CodeGen) !Id {
/// Fetch the result-id for a previously generated instruction or constant.
fn resolve(cg: *CodeGen, inst: Air.Inst.Ref) !Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ip = &zcu.intern_pool;
if (try cg.air.value(inst, pt)) |val| {
const ty = cg.typeOf(inst);
@@ -405,7 +404,7 @@ fn resolveUav(cg: *CodeGen, val: InternPool.Index) !Id {
// TODO: This cannot be a function at this point, but it should probably be handled anyway.
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const ty: Type = .fromInterned(zcu.intern_pool.typeOf(val));
const decl_ptr_ty_id = try cg.ptrType(ty, cg.module.storageClass(.generic), .indirect);
@@ -499,7 +498,8 @@ fn resolveUav(cg: *CodeGen, val: InternPool.Index) !Id {
}
fn addFunctionDep(cg: *CodeGen, decl_index: Module.Decl.Index, storage_class: StorageClass) !void {
if (cg.module.target.cpu.has(.spirv, .v1_4)) {
const target = cg.module.zcu.getTarget();
if (target.cpu.has(.spirv, .v1_4)) {
try cg.decl_deps.put(cg.module.gpa, decl_index, {});
} else {
// Before version 1.4, the interfaces storage classes are limited to the Input and Output
@@ -510,7 +510,8 @@ fn addFunctionDep(cg: *CodeGen, decl_index: Module.Decl.Index, storage_class: St
}
fn castToGeneric(cg: *CodeGen, type_id: Id, ptr_id: Id) !Id {
if (cg.module.target.cpu.has(.spirv, .generic_pointer)) {
const target = cg.module.zcu.getTarget();
if (target.cpu.has(.spirv, .generic_pointer)) {
const result_id = cg.module.allocId();
try cg.body.emit(cg.module.gpa, .OpPtrCastToGeneric, .{
.id_result_type = type_id,
@@ -541,10 +542,12 @@ fn beginSpvBlock(cg: *CodeGen, label: Id) !void {
/// The result is valid to be used with OpTypeInt.
/// TODO: Should the result of this function be cached?
fn backingIntBits(cg: *CodeGen, bits: u16) struct { u16, bool } {
const target = cg.module.zcu.getTarget();
// The backend will never be asked to compiler a 0-bit integer, so we won't have to handle those in this function.
assert(bits != 0);
if (cg.module.target.cpu.has(.spirv, .arbitrary_precision_integers) and bits <= 32) {
if (target.cpu.has(.spirv, .arbitrary_precision_integers) and bits <= 32) {
return .{ bits, false };
}
@@ -556,7 +559,7 @@ fn backingIntBits(cg: *CodeGen, bits: u16) struct { u16, bool } {
.{ .bits = 32, .enabled = true },
.{
.bits = 64,
.enabled = cg.module.target.cpu.has(.spirv, .int64) or cg.module.target.cpu.arch == .spirv64,
.enabled = target.cpu.has(.spirv, .int64) or target.cpu.arch == .spirv64,
},
};
@@ -575,7 +578,8 @@ fn backingIntBits(cg: *CodeGen, bits: u16) struct { u16, bool } {
/// is no way of knowing whether those are actually supported.
/// TODO: Maybe this should be cached?
fn largestSupportedIntBits(cg: *CodeGen) u16 {
if (cg.module.target.cpu.has(.spirv, .int64) or cg.module.target.cpu.arch == .spirv64) {
const target = cg.module.zcu.getTarget();
if (target.cpu.has(.spirv, .int64) or target.cpu.arch == .spirv64) {
return 64;
}
return 32;
@@ -618,8 +622,8 @@ const ArithmeticTypeInfo = struct {
};
fn arithmeticTypeInfo(cg: *CodeGen, ty: Type) ArithmeticTypeInfo {
const zcu = cg.pt.zcu;
const target = cg.module.target;
const zcu = cg.module.zcu;
const target = cg.module.zcu.getTarget();
var scalar_ty = ty.scalarType(zcu);
if (scalar_ty.zigTypeTag(zcu) == .@"enum") {
scalar_ty = scalar_ty.intTagType(zcu);
@@ -663,7 +667,8 @@ fn arithmeticTypeInfo(cg: *CodeGen, ty: Type) ArithmeticTypeInfo {
/// Checks whether the type can be directly translated to SPIR-V vectors
fn isSpvVector(cg: *CodeGen, ty: Type) bool {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const target = cg.module.zcu.getTarget();
if (ty.zigTypeTag(zcu) != .vector) return false;
// TODO: This check must be expanded for types that can be represented
@@ -683,7 +688,7 @@ fn isSpvVector(cg: *CodeGen, ty: Type) bool {
if (elem_ty.isNumeric(zcu) or elem_ty.toIntern() == .bool_type) {
if (len > 1 and len <= 4) return true;
if (cg.module.target.cpu.has(.spirv, .vector16)) return (len == 8 or len == 16);
if (target.cpu.has(.spirv, .vector16)) return (len == 8 or len == 16);
}
return false;
@@ -701,7 +706,8 @@ fn constBool(cg: *CodeGen, value: bool, repr: Repr) !Id {
/// This function, unlike Module.constInt, takes care to bitcast
/// the value to an unsigned int first for Kernels.
fn constInt(cg: *CodeGen, ty: Type, value: anytype) !Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const target = cg.module.zcu.getTarget();
const scalar_ty = ty.scalarType(zcu);
const int_info = scalar_ty.intInfo(zcu);
// Use backing bits so that negatives are sign extended
@@ -726,7 +732,7 @@ fn constInt(cg: *CodeGen, ty: Type, value: anytype) !Id {
});
}
const final_value: spec.LiteralContextDependentNumber = switch (cg.module.target.os.tag) {
const final_value: spec.LiteralContextDependentNumber = switch (target.os.tag) {
.opencl, .amdhsa => blk: {
const value64: u64 = switch (signedness) {
.signed => @bitCast(@as(i64, @intCast(value))),
@@ -773,7 +779,7 @@ pub fn constructComposite(cg: *CodeGen, result_ty_id: Id, constituents: []const
/// ty must be an aggregate type.
fn constructCompositeSplat(cg: *CodeGen, ty: Type, constituent: Id) !Id {
const gpa = cg.module.gpa;
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const n: usize = @intCast(ty.arrayLen(zcu));
const constituents = try gpa.alloc(Id, n);
@@ -801,8 +807,8 @@ fn constant(cg: *CodeGen, ty: Type, val: Value, repr: Repr) Error!Id {
}
const pt = cg.pt;
const zcu = pt.zcu;
const target = cg.module.target;
const zcu = cg.module.zcu;
const target = cg.module.zcu.getTarget();
const result_ty_id = try cg.resolveType(ty, repr);
const ip = &zcu.intern_pool;
@@ -874,39 +880,35 @@ fn constant(cg: *CodeGen, ty: Type, val: Value, repr: Repr) Error!Id {
.error_union => |error_union| {
// TODO: Error unions may be constructed with constant instructions if the payload type
// allows it. For now, just generate it here regardless.
const err_int_ty = try pt.errorIntType();
const err_ty = switch (error_union.val) {
.err_name => ty.errorUnionSet(zcu),
.payload => err_int_ty,
};
const err_val = switch (error_union.val) {
.err_name => |err_name| Value.fromInterned(try pt.intern(.{ .err = .{
.ty = ty.errorUnionSet(zcu).toIntern(),
.name = err_name,
} })),
.payload => try pt.intValue(err_int_ty, 0),
};
const err_ty = ty.errorUnionSet(zcu);
const payload_ty = ty.errorUnionPayload(zcu);
const err_val_id = switch (error_union.val) {
.err_name => |err_name| try cg.constInt(
err_ty,
try pt.getErrorValue(err_name),
),
.payload => try cg.constInt(err_ty, 0),
};
const eu_layout = cg.errorUnionLayout(payload_ty);
if (!eu_layout.payload_has_bits) {
// We use the error type directly as the type.
break :cache try cg.constant(err_ty, err_val, .indirect);
break :cache err_val_id;
}
const payload_val: Value = .fromInterned(switch (error_union.val) {
.err_name => try pt.intern(.{ .undef = payload_ty.toIntern() }),
.payload => |payload| payload,
});
const payload_val_id = switch (error_union.val) {
.err_name => try cg.constant(payload_ty, .undef, .indirect),
.payload => |p| try cg.constant(payload_ty, .fromInterned(p), .indirect),
};
var constituents: [2]Id = undefined;
var types: [2]Type = undefined;
if (eu_layout.error_first) {
constituents[0] = try cg.constant(err_ty, err_val, .indirect);
constituents[1] = try cg.constant(payload_ty, payload_val, .indirect);
constituents[0] = err_val_id;
constituents[1] = payload_val_id;
types = .{ err_ty, payload_ty };
} else {
constituents[0] = try cg.constant(payload_ty, payload_val, .indirect);
constituents[1] = try cg.constant(err_ty, err_val, .indirect);
constituents[0] = payload_val_id;
constituents[1] = err_val_id;
types = .{ payload_ty, err_ty };
}
@@ -1055,10 +1057,11 @@ fn constant(cg: *CodeGen, ty: Type, val: Value, repr: Repr) Error!Id {
fn constantPtr(cg: *CodeGen, ptr_val: Value) !Id {
const pt = cg.pt;
const zcu = cg.module.zcu;
const gpa = cg.module.gpa;
if (ptr_val.isUndef(pt.zcu)) {
const result_ty = ptr_val.typeOf(pt.zcu);
if (ptr_val.isUndef(zcu)) {
const result_ty = ptr_val.typeOf(zcu);
const result_ty_id = try cg.resolveType(result_ty, .direct);
return cg.module.constUndef(result_ty_id);
}
@@ -1072,7 +1075,7 @@ fn constantPtr(cg: *CodeGen, ptr_val: Value) !Id {
fn derivePtr(cg: *CodeGen, derivation: Value.PointerDeriveStep) !Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
switch (derivation) {
.comptime_alloc_ptr, .comptime_field_ptr => unreachable,
.int => |int| {
@@ -1152,8 +1155,7 @@ fn constantUavRef(
) !Id {
// TODO: Merge this function with constantDeclRef.
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ip = &zcu.intern_pool;
const ty_id = try cg.resolveType(ty, .direct);
const uav_ty: Type = .fromInterned(ip.typeOf(uav.val));
@@ -1190,8 +1192,7 @@ fn constantUavRef(
}
fn constantNavRef(cg: *CodeGen, ty: Type, nav_index: InternPool.Nav.Index) !Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ip = &zcu.intern_pool;
const ty_id = try cg.resolveType(ty, .direct);
const nav = ip.getNav(nav_index);
@@ -1264,6 +1265,8 @@ fn resolveTypeName(cg: *CodeGen, ty: Type) ![]const u8 {
/// actual operations (as well as store) a Zig type of a particular number of bits. To create
/// a type with an exact size, use Module.intType.
fn intType(cg: *CodeGen, signedness: std.builtin.Signedness, bits: u16) !Id {
const target = cg.module.zcu.getTarget();
const backing_bits, const big_int = cg.backingIntBits(bits);
if (big_int) {
if (backing_bits > 64) {
@@ -1273,7 +1276,7 @@ fn intType(cg: *CodeGen, signedness: std.builtin.Signedness, bits: u16) !Id {
return cg.arrayType(backing_bits / big_int_bits, int_ty);
}
return switch (cg.module.target.os.tag) {
return switch (target.os.tag) {
// Kernel only supports unsigned ints.
.opencl, .amdhsa => return cg.module.intType(.unsigned, backing_bits),
else => cg.module.intType(signedness, backing_bits),
@@ -1287,9 +1290,12 @@ fn arrayType(cg: *CodeGen, len: u32, child_ty: Id) !Id {
fn ptrType(cg: *CodeGen, child_ty: Type, storage_class: StorageClass, child_repr: Repr) !Id {
const gpa = cg.module.gpa;
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const ip = &zcu.intern_pool;
const key = .{ child_ty.toIntern(), storage_class, child_repr };
const target = cg.module.zcu.getTarget();
const child_ty_id = try cg.resolveType(child_ty, child_repr);
const key = .{ child_ty_id, storage_class };
const entry = try cg.module.ptr_types.getOrPut(gpa, key);
if (entry.found_existing) {
const fwd_id = entry.value_ptr.ty_id;
@@ -1309,9 +1315,7 @@ fn ptrType(cg: *CodeGen, child_ty: Type, storage_class: StorageClass, child_repr
.fwd_emitted = false,
};
const child_ty_id = try cg.resolveType(child_ty, child_repr);
switch (cg.module.target.os.tag) {
switch (target.os.tag) {
.vulkan, .opengl => {
if (child_ty.zigTypeTag(zcu) == .@"struct") {
switch (storage_class) {
@@ -1374,7 +1378,7 @@ fn functionType(cg: *CodeGen, return_ty: Type, param_types: []const Type) !Id {
/// If any of the fields' size is 0, it will be omitted.
fn resolveUnionType(cg: *CodeGen, ty: Type) !Id {
const gpa = cg.module.gpa;
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const ip = &zcu.intern_pool;
const union_obj = zcu.typeToUnion(ty).?;
@@ -1417,8 +1421,12 @@ fn resolveUnionType(cg: *CodeGen, ty: Type) !Id {
member_names[layout.padding_index] = "(padding)";
}
const result_id = cg.module.allocId();
try cg.module.structType(result_id, member_types[0..layout.total_fields], member_names[0..layout.total_fields]);
const result_id = try cg.module.structType(
member_types[0..layout.total_fields],
member_names[0..layout.total_fields],
null,
.none,
);
const type_name = try cg.resolveTypeName(ty);
defer gpa.free(type_name);
@@ -1428,7 +1436,7 @@ fn resolveUnionType(cg: *CodeGen, ty: Type) !Id {
}
fn resolveFnReturnType(cg: *CodeGen, ret_ty: Type) !Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
if (!ret_ty.hasRuntimeBitsIgnoreComptime(zcu)) {
// If the return type is an error set or an error union, then we make this
// anyerror return type instead, so that it can be coerced into a function
@@ -1443,28 +1451,14 @@ fn resolveFnReturnType(cg: *CodeGen, ret_ty: Type) !Id {
return try cg.resolveType(ret_ty, .direct);
}
/// Turn a Zig type into a SPIR-V Type, and return a reference to it.
fn resolveType(cg: *CodeGen, ty: Type, repr: Repr) !Id {
const gpa = cg.module.gpa;
if (cg.module.intern_map.get(.{ ty.toIntern(), repr })) |id| {
return id;
}
const id = try cg.resolveTypeInner(ty, repr);
try cg.module.intern_map.put(gpa, .{ ty.toIntern(), repr }, id);
return id;
}
fn resolveTypeInner(cg: *CodeGen, ty: Type, repr: Repr) Error!Id {
fn resolveType(cg: *CodeGen, ty: Type, repr: Repr) Error!Id {
const gpa = cg.module.gpa;
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ip = &zcu.intern_pool;
log.debug("resolveType: ty = {f}", .{ty.fmt(pt)});
const target = cg.module.target;
const target = cg.module.zcu.getTarget();
const section = &cg.module.sections.globals;
log.debug("resolveType: ty = {f}", .{ty.fmt(pt)});
switch (ty.zigTypeTag(zcu)) {
.noreturn => {
@@ -1472,18 +1466,8 @@ fn resolveTypeInner(cg: *CodeGen, ty: Type, repr: Repr) Error!Id {
return try cg.module.voidType();
},
.void => switch (repr) {
.direct => {
return try cg.module.voidType();
},
// Pointers to void
.indirect => {
const result_id = cg.module.allocId();
try section.emit(cg.module.gpa, .OpTypeOpaque, .{
.id_result = result_id,
.literal_string = "void",
});
return result_id;
},
.direct => return try cg.module.voidType(),
.indirect => return try cg.module.opaqueType("void"),
},
.bool => switch (repr) {
.direct => return try cg.module.boolType(),
@@ -1492,36 +1476,26 @@ fn resolveTypeInner(cg: *CodeGen, ty: Type, repr: Repr) Error!Id {
.int => {
const int_info = ty.intInfo(zcu);
if (int_info.bits == 0) {
// Some times, the backend will be asked to generate a pointer to i0. OpTypeInt
// with 0 bits is invalid, so return an opaque type in this case.
assert(repr == .indirect);
const result_id = cg.module.allocId();
try section.emit(cg.module.gpa, .OpTypeOpaque, .{
.id_result = result_id,
.literal_string = "u0",
});
return result_id;
return try cg.module.opaqueType("u0");
}
return try cg.intType(int_info.signedness, int_info.bits);
},
.@"enum" => {
const tag_ty = ty.intTagType(zcu);
return try cg.resolveType(tag_ty, repr);
},
.@"enum" => return try cg.resolveType(ty.intTagType(zcu), repr),
.float => {
// We can (and want) not really emulate floating points with other floating point types like with the integer types,
// so if the float is not supported, just return an error.
const bits = ty.floatBits(target);
const supported = switch (bits) {
16 => cg.module.target.cpu.has(.spirv, .float16),
// 32-bit floats are always supported (see spec, 2.16.1, Data rules).
16 => target.cpu.has(.spirv, .float16),
32 => true,
64 => cg.module.target.cpu.has(.spirv, .float64),
64 => target.cpu.has(.spirv, .float64),
else => false,
};
if (!supported) {
return cg.fail("Floating point width of {} bits is not supported for the current SPIR-V feature set", .{bits});
return cg.fail(
"floating point width of {} bits is not supported for the current SPIR-V feature set",
.{bits},
);
}
return try cg.module.floatType(bits);
@@ -1534,36 +1508,27 @@ fn resolveTypeInner(cg: *CodeGen, ty: Type, repr: Repr) Error!Id {
};
if (!elem_ty.hasRuntimeBitsIgnoreComptime(zcu)) {
// The size of the array would be 0, but that is not allowed in SPIR-V.
// This path can be reached when the backend is asked to generate a pointer to
// an array of some zero-bit type. This should always be an indirect path.
assert(repr == .indirect);
// We cannot use the child type here, so just use an opaque type.
const result_id = cg.module.allocId();
try section.emit(cg.module.gpa, .OpTypeOpaque, .{
.id_result = result_id,
.literal_string = "zero-sized array",
});
return result_id;
return try cg.module.opaqueType("zero-sized-array");
} else if (total_len == 0) {
// The size of the array would be 0, but that is not allowed in SPIR-V.
// This path can be reached for example when there is a slicing of a pointer
// that produces a zero-length array. In all cases where this type can be generated,
// this should be an indirect path.
assert(repr == .indirect);
// In this case, we have an array of a non-zero sized type. In this case,
// generate an array of 1 element instead, so that ptr_elem_ptr instructions
// can be lowered to ptrAccessChain instead of manually performing the math.
return try cg.arrayType(1, elem_ty_id);
} else {
const result_id = try cg.arrayType(total_len, elem_ty_id);
switch (cg.module.target.os.tag) {
switch (target.os.tag) {
.vulkan, .opengl => {
try cg.module.decorate(result_id, .{ .array_stride = .{
.array_stride = @intCast(elem_ty.abiSize(zcu)),
} });
try cg.module.decorate(result_id, .{
.array_stride = .{
.array_stride = @intCast(elem_ty.abiSize(zcu)),
},
});
},
else => {},
}
@@ -1574,18 +1539,15 @@ fn resolveTypeInner(cg: *CodeGen, ty: Type, repr: Repr) Error!Id {
const elem_ty = ty.childType(zcu);
const elem_ty_id = try cg.resolveType(elem_ty, repr);
const len = ty.vectorLen(zcu);
if (cg.isSpvVector(ty)) {
return try cg.module.vectorType(len, elem_ty_id);
} else {
return try cg.arrayType(len, elem_ty_id);
}
if (cg.isSpvVector(ty)) return try cg.module.vectorType(len, elem_ty_id);
return try cg.arrayType(len, elem_ty_id);
},
.@"fn" => switch (repr) {
.direct => {
const fn_info = zcu.typeToFunc(ty).?;
comptime assert(zig_call_abi_ver == 3);
assert(!fn_info.is_var_args);
switch (fn_info.cc) {
.auto,
.spirv_kernel,
@@ -1596,11 +1558,7 @@ fn resolveTypeInner(cg: *CodeGen, ty: Type, repr: Repr) Error!Id {
else => unreachable,
}
// Guaranteed by callConvSupportsVarArgs, there are no SPIR-V CCs which support
// varargs.
assert(!fn_info.is_var_args);
// Note: Logic is different from functionType().
const return_ty_id = try cg.resolveFnReturnType(.fromInterned(fn_info.return_type));
const param_ty_ids = try gpa.alloc(Id, fn_info.param_types.len);
defer gpa.free(param_ty_ids);
var param_index: usize = 0;
@@ -1612,16 +1570,7 @@ fn resolveTypeInner(cg: *CodeGen, ty: Type, repr: Repr) Error!Id {
param_index += 1;
}
const return_ty_id = try cg.resolveFnReturnType(.fromInterned(fn_info.return_type));
const result_id = cg.module.allocId();
try section.emit(cg.module.gpa, .OpTypeFunction, .{
.id_result = result_id,
.return_type = return_ty_id,
.id_ref_2 = param_ty_ids[0..param_index],
});
return result_id;
return try cg.module.functionType(return_ty_id, param_ty_ids[0..param_index]);
},
.indirect => {
// TODO: Represent function pointers properly.
@@ -1641,13 +1590,12 @@ fn resolveTypeInner(cg: *CodeGen, ty: Type, repr: Repr) Error!Id {
}
const size_ty_id = try cg.resolveType(.usize, .direct);
const result_id = cg.module.allocId();
try cg.module.structType(
result_id,
return try cg.module.structType(
&.{ ptr_ty_id, size_ty_id },
&.{ "ptr", "len" },
null,
.none,
);
return result_id;
},
.@"struct" => {
const struct_type = switch (ip.indexToKey(ty.toIntern())) {
@@ -1663,13 +1611,15 @@ fn resolveTypeInner(cg: *CodeGen, ty: Type, repr: Repr) Error!Id {
member_index += 1;
}
const result_id = cg.module.allocId();
try cg.module.structType(result_id, member_types[0..member_index], null);
const result_id = try cg.module.structType(
member_types[0..member_index],
null,
null,
.none,
);
const type_name = try cg.resolveTypeName(ty);
defer gpa.free(type_name);
try cg.module.debugName(result_id, type_name);
return result_id;
},
.struct_type => ip.loadStructType(ty.toIntern()),
@@ -1686,34 +1636,27 @@ fn resolveTypeInner(cg: *CodeGen, ty: Type, repr: Repr) Error!Id {
var member_names = std.ArrayList([]const u8).init(gpa);
defer member_names.deinit();
var index: u32 = 0;
var member_offsets = std.ArrayList(u32).init(gpa);
defer member_offsets.deinit();
var it = struct_type.iterateRuntimeOrder(ip);
const result_id = cg.module.allocId();
while (it.next()) |field_index| {
const field_ty: Type = .fromInterned(struct_type.field_types.get(ip)[field_index]);
if (!field_ty.hasRuntimeBitsIgnoreComptime(zcu)) {
// This is a zero-bit field - we only needed it for the alignment.
continue;
}
switch (cg.module.target.os.tag) {
.vulkan, .opengl => {
try cg.module.decorateMember(result_id, index, .{ .offset = .{
.byte_offset = @intCast(ty.structFieldOffset(field_index, zcu)),
} });
},
else => {},
}
if (!field_ty.hasRuntimeBitsIgnoreComptime(zcu)) continue;
const field_name = struct_type.fieldName(ip, field_index).unwrap() orelse
try ip.getOrPutStringFmt(zcu.gpa, pt.tid, "{d}", .{field_index}, .no_embedded_nulls);
try member_types.append(try cg.resolveType(field_ty, .indirect));
try member_names.append(field_name.toSlice(ip));
index += 1;
try member_offsets.append(@intCast(ty.structFieldOffset(field_index, zcu)));
}
try cg.module.structType(result_id, member_types.items, member_names.items);
const result_id = try cg.module.structType(
member_types.items,
member_names.items,
member_offsets.items,
ty.toIntern(),
);
const type_name = try cg.resolveTypeName(ty);
defer gpa.free(type_name);
@@ -1738,13 +1681,12 @@ fn resolveTypeInner(cg: *CodeGen, ty: Type, repr: Repr) Error!Id {
const bool_ty_id = try cg.resolveType(.bool, .indirect);
const result_id = cg.module.allocId();
try cg.module.structType(
result_id,
return try cg.module.structType(
&.{ payload_ty_id, bool_ty_id },
&.{ "payload", "valid" },
null,
.none,
);
return result_id;
},
.@"union" => return try cg.resolveUnionType(ty),
.error_set => {
@@ -1753,7 +1695,8 @@ fn resolveTypeInner(cg: *CodeGen, ty: Type, repr: Repr) Error!Id {
},
.error_union => {
const payload_ty = ty.errorUnionPayload(zcu);
const error_ty_id = try cg.resolveType(.anyerror, .indirect);
const err_ty = ty.errorUnionSet(zcu);
const error_ty_id = try cg.resolveType(err_ty, .indirect);
const eu_layout = cg.errorUnionLayout(payload_ty);
if (!eu_layout.payload_has_bits) {
@@ -1776,20 +1719,12 @@ fn resolveTypeInner(cg: *CodeGen, ty: Type, repr: Repr) Error!Id {
// TODO: ABI padding?
}
const result_id = cg.module.allocId();
try cg.module.structType(result_id, &member_types, &member_names);
return result_id;
return try cg.module.structType(&member_types, &member_names, null, .none);
},
.@"opaque" => {
const type_name = try cg.resolveTypeName(ty);
defer gpa.free(type_name);
const result_id = cg.module.allocId();
try section.emit(cg.module.gpa, .OpTypeOpaque, .{
.id_result = result_id,
.literal_string = type_name,
});
return result_id;
return try cg.module.opaqueType(type_name);
},
.null,
@@ -1820,8 +1755,7 @@ const ErrorUnionLayout = struct {
};
fn errorUnionLayout(cg: *CodeGen, payload_ty: Type) ErrorUnionLayout {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const error_align = Type.abiAlignment(.anyerror, zcu);
const payload_align = payload_ty.abiAlignment(zcu);
@@ -1852,8 +1786,7 @@ const UnionLayout = struct {
};
fn unionLayout(cg: *CodeGen, ty: Type) UnionLayout {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ip = &zcu.intern_pool;
const layout = ty.unionGetLayout(zcu);
const union_obj = zcu.typeToUnion(ty).?;
@@ -1944,7 +1877,7 @@ const Temporary = struct {
fn materialize(temp: Temporary, cg: *CodeGen) !Id {
const gpa = cg.module.gpa;
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
switch (temp.value) {
.singleton => |id| return id,
.exploded_vector => |range| {
@@ -1975,7 +1908,7 @@ const Temporary = struct {
/// 'Explode' a temporary into separate elements. This turns a vector
/// into a bag of elements.
fn explode(temp: Temporary, cg: *CodeGen) !IdRange {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
// If the value is a scalar, then this is a no-op.
if (!temp.ty.isVector(zcu)) {
@@ -2029,7 +1962,7 @@ const Vectorization = union(enum) {
/// Derive a vectorization from a particular type
fn fromType(ty: Type, cg: *CodeGen) Vectorization {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
if (!ty.isVector(zcu)) return .scalar;
return .{ .unrolled = ty.vectorLen(zcu) };
}
@@ -2063,7 +1996,8 @@ const Vectorization = union(enum) {
/// `ty` may be a scalar or vector, it doesn't matter.
fn resultType(vec: Vectorization, cg: *CodeGen, ty: Type) !Type {
const pt = cg.pt;
const scalar_ty = ty.scalarType(pt.zcu);
const zcu = cg.module.zcu;
const scalar_ty = ty.scalarType(zcu);
return switch (vec) {
.scalar => scalar_ty,
.unrolled => |n| try pt.vectorType(.{ .len = n, .child = scalar_ty.toIntern() }),
@@ -2074,8 +2008,8 @@ const Vectorization = union(enum) {
/// this setup, and returns a new type that holds the relevant information on how to access
/// elements of the input.
fn prepare(vec: Vectorization, cg: *CodeGen, tmp: Temporary) !PreparedOperand {
const pt = cg.pt;
const is_vector = tmp.ty.isVector(pt.zcu);
const zcu = cg.module.zcu;
const is_vector = tmp.ty.isVector(zcu);
const value: PreparedOperand.Value = switch (tmp.value) {
.singleton => |id| switch (vec) {
.scalar => blk: {
@@ -2174,7 +2108,7 @@ fn vectorization(cg: *CodeGen, args: anytype) Vectorization {
/// This function builds an OpSConvert of OpUConvert depending on the
/// signedness of the types.
fn buildConvert(cg: *CodeGen, dst_ty: Type, src: Temporary) !Temporary {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const dst_ty_id = try cg.resolveType(dst_ty.scalarType(zcu), .direct);
const src_ty_id = try cg.resolveType(src.ty.scalarType(zcu), .direct);
@@ -2217,8 +2151,8 @@ fn buildConvert(cg: *CodeGen, dst_ty: Type, src: Temporary) !Temporary {
}
fn buildFma(cg: *CodeGen, a: Temporary, b: Temporary, c: Temporary) !Temporary {
const zcu = cg.pt.zcu;
const target = cg.module.target;
const zcu = cg.module.zcu;
const target = cg.module.zcu.getTarget();
const v = cg.vectorization(.{ a, b, c });
const ops = v.components();
@@ -2258,7 +2192,7 @@ fn buildFma(cg: *CodeGen, a: Temporary, b: Temporary, c: Temporary) !Temporary {
}
fn buildSelect(cg: *CodeGen, condition: Temporary, lhs: Temporary, rhs: Temporary) !Temporary {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const v = cg.vectorization(.{ condition, lhs, rhs });
const ops = v.components();
@@ -2377,8 +2311,8 @@ const UnaryOp = enum {
};
fn buildUnary(cg: *CodeGen, op: UnaryOp, operand: Temporary) !Temporary {
const zcu = cg.pt.zcu;
const target = cg.module.target;
const zcu = cg.module.zcu;
const target = cg.module.zcu.getTarget();
const v = cg.vectorization(.{operand});
const ops = v.components();
const results = cg.module.allocIds(ops);
@@ -2497,8 +2431,8 @@ const BinaryOp = enum {
};
fn buildBinary(cg: *CodeGen, op: BinaryOp, lhs: Temporary, rhs: Temporary) !Temporary {
const zcu = cg.pt.zcu;
const target = cg.module.target;
const zcu = cg.module.zcu;
const target = cg.module.zcu.getTarget();
const v = cg.vectorization(.{ lhs, rhs });
const ops = v.components();
@@ -2595,8 +2529,8 @@ fn buildWideMul(
rhs: Temporary,
) !struct { Temporary, Temporary } {
const pt = cg.pt;
const zcu = pt.zcu;
const target = cg.module.target;
const zcu = cg.module.zcu;
const target = cg.module.zcu.getTarget();
const ip = &zcu.intern_pool;
const v = lhs.vectorization(cg).unify(rhs.vectorization(cg));
@@ -2718,8 +2652,8 @@ fn generateTestEntryPoint(
test_id: Id,
) !void {
const gpa = cg.module.gpa;
const zcu = cg.pt.zcu;
const target = cg.module.target;
const zcu = cg.module.zcu;
const target = cg.module.zcu.getTarget();
const anyerror_ty_id = try cg.resolveType(.anyerror, .direct);
const ptr_anyerror_ty = try cg.pt.ptrType(.{
@@ -2762,8 +2696,12 @@ fn generateTestEntryPoint(
const spv_err_decl_index = try cg.module.allocDecl(.global);
try cg.module.declareDeclDeps(spv_err_decl_index, &.{});
const buffer_struct_ty_id = cg.module.allocId();
try cg.module.structType(buffer_struct_ty_id, &.{anyerror_ty_id}, &.{"error_out"});
const buffer_struct_ty_id = try cg.module.structType(
&.{anyerror_ty_id},
&.{"error_out"},
null,
.none,
);
try cg.module.decorate(buffer_struct_ty_id, .block);
try cg.module.decorateMember(buffer_struct_ty_id, 0, .{ .offset = .{ .byte_offset = 0 } });
@@ -2871,14 +2809,14 @@ fn intFromBool2(cg: *CodeGen, value: Temporary, result_ty: Type) !Temporary {
/// This converts the argument type from resolveType(ty, .indirect) to resolveType(ty, .direct).
fn convertToDirect(cg: *CodeGen, ty: Type, operand_id: Id) !Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
switch (ty.scalarType(zcu).zigTypeTag(zcu)) {
.bool => {
const false_id = try cg.constBool(false, .indirect);
const operand_ty = blk: {
if (!ty.isVector(pt.zcu)) break :blk Type.u1;
if (!ty.isVector(zcu)) break :blk Type.u1;
break :blk try pt.vectorType(.{
.len = ty.vectorLen(pt.zcu),
.len = ty.vectorLen(zcu),
.child = .u1_type,
});
};
@@ -2897,7 +2835,7 @@ fn convertToDirect(cg: *CodeGen, ty: Type, operand_id: Id) !Id {
/// Convert representation from direct (in 'register) to direct (in memory)
/// This converts the argument type from resolveType(ty, .direct) to resolveType(ty, .indirect).
fn convertToIndirect(cg: *CodeGen, ty: Type, operand_id: Id) !Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
switch (ty.scalarType(zcu).zigTypeTag(zcu)) {
.bool => {
const result = try cg.intFromBool(Temporary.init(ty, operand_id));
@@ -2940,7 +2878,7 @@ const MemoryOptions = struct {
};
fn load(cg: *CodeGen, value_ty: Type, ptr_id: Id, options: MemoryOptions) !Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const alignment: u32 = @intCast(value_ty.abiAlignment(zcu).toByteUnits().?);
const indirect_value_ty_id = try cg.resolveType(value_ty, .indirect);
const result_id = cg.module.allocId();
@@ -2975,7 +2913,7 @@ fn genBody(cg: *CodeGen, body: []const Air.Inst.Index) !void {
fn genInst(cg: *CodeGen, inst: Air.Inst.Index) Error!void {
const gpa = cg.module.gpa;
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const ip = &zcu.intern_pool;
if (cg.liveness.isUnused(inst) and !cg.air.mustLower(inst, ip))
return;
@@ -3159,7 +3097,7 @@ fn airBinOpSimple(cg: *CodeGen, inst: Air.Inst.Index, op: BinaryOp) !?Id {
}
fn airShift(cg: *CodeGen, inst: Air.Inst.Index, unsigned: BinaryOp, signed: BinaryOp) !?Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const bin_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].bin_op;
if (cg.typeOf(bin_op.lhs).isVector(zcu) and !cg.typeOf(bin_op.rhs).isVector(zcu)) {
@@ -3241,7 +3179,7 @@ fn minMax(cg: *CodeGen, lhs: Temporary, rhs: Temporary, op: MinMax) !Temporary {
/// All other values are returned unmodified (this makes strange integer
/// wrapping easier to use in generic operations).
fn normalize(cg: *CodeGen, value: Temporary, info: ArithmeticTypeInfo) !Temporary {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const ty = value.ty;
switch (info.class) {
.composite_integer, .integer, .bool, .float => return value,
@@ -3391,7 +3329,8 @@ fn airAbs(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn abs(cg: *CodeGen, result_ty: Type, value: Temporary) !Temporary {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const target = cg.module.zcu.getTarget();
const operand_info = cg.arithmeticTypeInfo(value.ty);
switch (operand_info.class) {
@@ -3399,7 +3338,7 @@ fn abs(cg: *CodeGen, result_ty: Type, value: Temporary) !Temporary {
.integer, .strange_integer => {
const abs_value = try cg.buildUnary(.i_abs, value);
switch (cg.module.target.os.tag) {
switch (target.os.tag) {
.vulkan, .opengl => {
if (value.ty.intInfo(zcu).signedness == .signed) {
return cg.todo("perform bitcast after @abs", .{});
@@ -3657,7 +3596,7 @@ fn airMulOverflow(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airShlOverflow(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const ty_pl = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_pl;
const extra = cg.air.extraData(Air.Bin, ty_pl.payload).data;
@@ -3716,7 +3655,7 @@ fn airMulAdd(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
fn airClzCtz(cg: *CodeGen, inst: Air.Inst.Index, op: UnaryOp) !?Id {
if (cg.liveness.isUnused(inst)) return null;
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const ty_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_op;
const operand = try cg.temporary(ty_op.operand);
@@ -3759,7 +3698,7 @@ fn airSplat(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airReduce(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const reduce = cg.air.instructions.items(.data)[@intFromEnum(inst)].reduce;
const operand = try cg.resolve(reduce.operand);
const operand_ty = cg.typeOf(reduce.operand);
@@ -3831,8 +3770,7 @@ fn airReduce(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airShuffleOne(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const gpa = zcu.gpa;
const unwrapped = cg.air.unwrapShuffleOne(zcu, inst);
@@ -3856,8 +3794,7 @@ fn airShuffleOne(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airShuffleTwo(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const gpa = zcu.gpa;
const unwrapped = cg.air.unwrapShuffleTwo(zcu, inst);
@@ -3934,11 +3871,12 @@ fn ptrAccessChain(
indices: []const u32,
) !Id {
const gpa = cg.module.gpa;
const target = cg.module.zcu.getTarget();
const ids = try cg.indicesToIds(indices);
defer gpa.free(ids);
const result_id = cg.module.allocId();
switch (cg.module.target.os.tag) {
switch (target.os.tag) {
.opencl, .amdhsa => {
try cg.body.emit(cg.module.gpa, .OpInBoundsPtrAccessChain, .{
.id_result_type = result_ty_id,
@@ -3962,7 +3900,7 @@ fn ptrAccessChain(
}
fn ptrAdd(cg: *CodeGen, result_ty: Type, ptr_ty: Type, ptr_id: Id, offset_id: Id) !Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const result_ty_id = try cg.resolveType(result_ty, .direct);
switch (ptr_ty.ptrSize(zcu)) {
@@ -4019,7 +3957,7 @@ fn cmp(
rhs: Temporary,
) !Temporary {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ip = &zcu.intern_pool;
const scalar_ty = lhs.ty.scalarType(zcu);
const is_vector = lhs.ty.isVector(zcu);
@@ -4216,7 +4154,7 @@ fn bitCast(
src_ty: Type,
src_id: Id,
) !Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const src_ty_id = try cg.resolveType(src_ty, .direct);
const dst_ty_id = try cg.resolveType(dst_ty, .direct);
@@ -4408,8 +4346,7 @@ fn airNot(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airArrayToSlice(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ty_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_op;
const array_ptr_ty = cg.typeOf(ty_op.operand);
const array_ty = array_ptr_ty.childType(zcu);
@@ -4445,8 +4382,9 @@ fn airSlice(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
fn airAggregateInit(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const gpa = cg.module.gpa;
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ip = &zcu.intern_pool;
const target = cg.module.zcu.getTarget();
const ty_pl = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_pl;
const result_ty = cg.typeOfIndex(inst);
const len: usize = @intCast(result_ty.arrayLen(zcu));
@@ -4467,7 +4405,7 @@ fn airAggregateInit(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const field_int_ty = try cg.pt.intType(.unsigned, ty_bit_size);
const field_int_id = blk: {
if (field_ty.isPtrAtRuntime(zcu)) {
assert(cg.module.target.cpu.arch == .spirv64 and
assert(target.cpu.arch == .spirv64 and
field_ty.ptrAddressSpace(zcu) == .storage_buffer);
break :blk try cg.intFromPtr(field_id);
}
@@ -4567,8 +4505,7 @@ fn airAggregateInit(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn sliceOrArrayLen(cg: *CodeGen, operand_id: Id, ty: Type) !Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
switch (ty.ptrSize(zcu)) {
.slice => return cg.extractField(.usize, operand_id, 1),
.one => {
@@ -4583,7 +4520,7 @@ fn sliceOrArrayLen(cg: *CodeGen, operand_id: Id, ty: Type) !Id {
}
fn sliceOrArrayPtr(cg: *CodeGen, operand_id: Id, ty: Type) !Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
if (ty.isSlice(zcu)) {
const ptr_ty = ty.slicePtrFieldType(zcu);
return cg.extractField(ptr_ty, operand_id, 0);
@@ -4620,7 +4557,7 @@ fn airSliceField(cg: *CodeGen, inst: Air.Inst.Index, field: u32) !?Id {
}
fn airSliceElemPtr(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const ty_pl = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_pl;
const bin_op = cg.air.extraData(Air.Bin, ty_pl.payload).data;
const slice_ty = cg.typeOf(bin_op.lhs);
@@ -4637,7 +4574,7 @@ fn airSliceElemPtr(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airSliceElemVal(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const bin_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].bin_op;
const slice_ty = cg.typeOf(bin_op.lhs);
if (!slice_ty.isVolatilePtr(zcu) and cg.liveness.isUnused(inst)) return null;
@@ -4654,7 +4591,7 @@ fn airSliceElemVal(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn ptrElemPtr(cg: *CodeGen, ptr_ty: Type, ptr_id: Id, index_id: Id) !Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
// Construct new pointer type for the resulting pointer
const elem_ty = ptr_ty.elemType2(zcu); // use elemType() so that we get T for *[N]T.
const elem_ptr_ty_id = try cg.ptrType(elem_ty, cg.module.storageClass(ptr_ty.ptrAddressSpace(zcu)), .indirect);
@@ -4669,8 +4606,7 @@ fn ptrElemPtr(cg: *CodeGen, ptr_ty: Type, ptr_id: Id, index_id: Id) !Id {
}
fn airPtrElemPtr(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ty_pl = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_pl;
const bin_op = cg.air.extraData(Air.Bin, ty_pl.payload).data;
const src_ptr_ty = cg.typeOf(bin_op.lhs);
@@ -4687,7 +4623,7 @@ fn airPtrElemPtr(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airArrayElemVal(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const bin_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].bin_op;
const array_ty = cg.typeOf(bin_op.lhs);
const elem_ty = array_ty.childType(zcu);
@@ -4737,7 +4673,7 @@ fn airArrayElemVal(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airPtrElemVal(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const bin_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].bin_op;
const ptr_ty = cg.typeOf(bin_op.lhs);
const elem_ty = cg.typeOfIndex(inst);
@@ -4748,7 +4684,7 @@ fn airPtrElemVal(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airVectorStoreElem(cg: *CodeGen, inst: Air.Inst.Index) !void {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const data = cg.air.instructions.items(.data)[@intFromEnum(inst)].vector_store_elem;
const extra = cg.air.extraData(Air.Bin, data.payload).data;
@@ -4770,7 +4706,7 @@ fn airVectorStoreElem(cg: *CodeGen, inst: Air.Inst.Index) !void {
}
fn airSetUnionTag(cg: *CodeGen, inst: Air.Inst.Index) !void {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const bin_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].bin_op;
const un_ptr_ty = cg.typeOf(bin_op.lhs);
const un_ty = un_ptr_ty.childType(zcu);
@@ -4796,7 +4732,7 @@ fn airGetUnionTag(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const ty_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_op;
const un_ty = cg.typeOf(ty_op.operand);
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const layout = cg.unionLayout(un_ty);
if (layout.tag_size == 0) return null;
@@ -4820,7 +4756,7 @@ fn unionInit(
// Note: The result here is not cached, because it generates runtime code.
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ip = &zcu.intern_pool;
const union_ty = zcu.typeToUnion(ty).?;
const tag_ty: Type = .fromInterned(union_ty.enum_tag_ty);
@@ -4898,8 +4834,7 @@ fn unionInit(
}
fn airUnionInit(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ip = &zcu.intern_pool;
const ty_pl = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_pl;
const extra = cg.air.extraData(Air.UnionInit, ty_pl.payload).data;
@@ -4916,7 +4851,7 @@ fn airUnionInit(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
fn airStructFieldVal(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ty_pl = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_pl;
const struct_field = cg.air.extraData(Air.StructField, ty_pl.payload).data;
@@ -5000,8 +4935,7 @@ fn airStructFieldVal(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airFieldParentPtr(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ty_pl = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_pl;
const extra = cg.air.extraData(Air.FieldParentPtr, ty_pl.payload).data;
@@ -5041,7 +4975,7 @@ fn structFieldPtr(
) !Id {
const result_ty_id = try cg.resolveType(result_ptr_ty, .direct);
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const object_ty = object_ptr_ty.childType(zcu);
switch (object_ty.zigTypeTag(zcu)) {
.pointer => {
@@ -5106,6 +5040,7 @@ fn alloc(
ty: Type,
options: AllocOptions,
) !Id {
const target = cg.module.zcu.getTarget();
const ptr_fn_ty_id = try cg.ptrType(ty, .function, .indirect);
// SPIR-V requires that OpVariable declarations for locals go into the first block, so we are just going to
@@ -5118,7 +5053,7 @@ fn alloc(
.initializer = options.initializer,
});
switch (cg.module.target.os.tag) {
switch (target.os.tag) {
.vulkan, .opengl => return var_id,
else => {},
}
@@ -5135,7 +5070,7 @@ fn alloc(
}
fn airAlloc(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const ptr_ty = cg.typeOfIndex(inst);
const child_ty = ptr_ty.childType(zcu);
return try cg.alloc(child_ty, .{
@@ -5314,8 +5249,7 @@ fn lowerBlock(cg: *CodeGen, inst: Air.Inst.Index, body: []const Air.Inst.Index)
// ir.Block in a different SPIR-V block.
const gpa = cg.module.gpa;
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ty = cg.typeOfIndex(inst);
const have_block_result = ty.isFnOrHasRuntimeBitsIgnoreComptime(zcu);
@@ -5448,7 +5382,7 @@ fn lowerBlock(cg: *CodeGen, inst: Air.Inst.Index, body: []const Air.Inst.Index)
fn airBr(cg: *CodeGen, inst: Air.Inst.Index) !void {
const gpa = cg.module.gpa;
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const br = cg.air.instructions.items(.data)[@intFromEnum(inst)].br;
const operand_ty = cg.typeOf(br.operand);
@@ -5592,7 +5526,7 @@ fn airLoop(cg: *CodeGen, inst: Air.Inst.Index) !void {
}
fn airLoad(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const ty_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_op;
const ptr_ty = cg.typeOf(ty_op.operand);
const elem_ty = cg.typeOfIndex(inst);
@@ -5603,7 +5537,7 @@ fn airLoad(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airStore(cg: *CodeGen, inst: Air.Inst.Index) !void {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const bin_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].bin_op;
const ptr_ty = cg.typeOf(bin_op.lhs);
const elem_ty = ptr_ty.childType(zcu);
@@ -5614,8 +5548,7 @@ fn airStore(cg: *CodeGen, inst: Air.Inst.Index) !void {
}
fn airRet(cg: *CodeGen, inst: Air.Inst.Index) !void {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const operand = cg.air.instructions.items(.data)[@intFromEnum(inst)].un_op;
const ret_ty = cg.typeOf(operand);
if (!ret_ty.hasRuntimeBitsIgnoreComptime(zcu)) {
@@ -5636,8 +5569,7 @@ fn airRet(cg: *CodeGen, inst: Air.Inst.Index) !void {
}
fn airRetLoad(cg: *CodeGen, inst: Air.Inst.Index) !void {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const un_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].un_op;
const ptr_ty = cg.typeOf(un_op);
const ret_ty = ptr_ty.childType(zcu);
@@ -5663,7 +5595,7 @@ fn airRetLoad(cg: *CodeGen, inst: Air.Inst.Index) !void {
}
fn airTry(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const pl_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].pl_op;
const err_union_id = try cg.resolve(pl_op.operand);
const extra = cg.air.extraData(Air.Try, pl_op.payload);
@@ -5733,7 +5665,7 @@ fn airTry(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airErrUnionErr(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const ty_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_op;
const operand_id = try cg.resolve(ty_op.operand);
const err_union_ty = cg.typeOf(ty_op.operand);
@@ -5769,7 +5701,7 @@ fn airErrUnionPayload(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airWrapErrUnionErr(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const ty_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_op;
const err_union_ty = cg.typeOfIndex(inst);
const payload_ty = err_union_ty.errorUnionPayload(zcu);
@@ -5818,8 +5750,7 @@ fn airWrapErrUnionPayload(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airIsNull(cg: *CodeGen, inst: Air.Inst.Index, is_pointer: bool, pred: enum { is_null, is_non_null }) !?Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const un_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].un_op;
const operand_id = try cg.resolve(un_op);
const operand_ty = cg.typeOf(un_op);
@@ -5895,7 +5826,7 @@ fn airIsNull(cg: *CodeGen, inst: Air.Inst.Index, is_pointer: bool, pred: enum {
}
fn airIsErr(cg: *CodeGen, inst: Air.Inst.Index, pred: enum { is_err, is_non_err }) !?Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const un_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].un_op;
const operand_id = try cg.resolve(un_op);
const err_union_ty = cg.typeOf(un_op);
@@ -5933,8 +5864,7 @@ fn airIsErr(cg: *CodeGen, inst: Air.Inst.Index, pred: enum { is_err, is_non_err
}
fn airUnwrapOptional(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ty_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_op;
const operand_id = try cg.resolve(ty_op.operand);
const optional_ty = cg.typeOf(ty_op.operand);
@@ -5950,8 +5880,7 @@ fn airUnwrapOptional(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airUnwrapOptionalPtr(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ty_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_op;
const operand_id = try cg.resolve(ty_op.operand);
const operand_ty = cg.typeOf(ty_op.operand);
@@ -5975,8 +5904,7 @@ fn airUnwrapOptionalPtr(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn airWrapOptional(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const ty_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_op;
const payload_ty = cg.typeOf(ty_op.operand);
@@ -6000,8 +5928,8 @@ fn airWrapOptional(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
fn airSwitchBr(cg: *CodeGen, inst: Air.Inst.Index) !void {
const gpa = cg.module.gpa;
const pt = cg.pt;
const zcu = pt.zcu;
const target = cg.module.target;
const zcu = cg.module.zcu;
const target = cg.module.zcu.getTarget();
const switch_br = cg.air.unwrapSwitch(inst);
const cond_ty = cg.typeOf(switch_br.operand);
const cond = try cg.resolve(switch_br.operand);
@@ -6157,29 +6085,21 @@ fn airUnreach(cg: *CodeGen) !void {
}
fn airDbgStmt(cg: *CodeGen, inst: Air.Inst.Index) !void {
const gpa = cg.module.gpa;
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const dbg_stmt = cg.air.instructions.items(.data)[@intFromEnum(inst)].dbg_stmt;
const path = zcu.navFileScope(cg.owner_nav).sub_file_path;
if (cg.file_path_id == .none) {
cg.file_path_id = cg.module.allocId();
try cg.module.sections.debug_strings.emit(gpa, .OpString, .{
.id_result = cg.file_path_id,
.string = path,
});
}
if (zcu.comp.config.root_strip) return;
try cg.body.emit(cg.module.gpa, .OpLine, .{
.file = cg.file_path_id,
.file = try cg.module.debugString(path),
.line = cg.base_line + dbg_stmt.line + 1,
.column = dbg_stmt.column + 1,
});
}
fn airDbgInlineBlock(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const inst_datas = cg.air.instructions.items(.data);
const extra = cg.air.extraData(Air.DbgInlineBlock, inst_datas[@intFromEnum(inst)].ty_pl.payload);
const old_base_line = cg.base_line;
@@ -6197,7 +6117,7 @@ fn airDbgVar(cg: *CodeGen, inst: Air.Inst.Index) !void {
fn airAssembly(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
const gpa = cg.module.gpa;
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
const ty_pl = cg.air.instructions.items(.data)[@intFromEnum(inst)].ty_pl;
const extra = cg.air.extraData(Air.Asm, ty_pl.payload);
@@ -6360,8 +6280,7 @@ fn airCall(cg: *CodeGen, inst: Air.Inst.Index, modifier: std.builtin.CallModifie
_ = modifier;
const gpa = cg.module.gpa;
const pt = cg.pt;
const zcu = pt.zcu;
const zcu = cg.module.zcu;
const pl_op = cg.air.instructions.items(.data)[@intFromEnum(inst)].pl_op;
const extra = cg.air.extraData(Air.Call, pl_op.payload);
const args: []const Air.Inst.Ref = @ptrCast(cg.air.extra.items[extra.end..][0..extra.data.args_len]);
@@ -6455,11 +6374,11 @@ fn airWorkGroupId(cg: *CodeGen, inst: Air.Inst.Index) !?Id {
}
fn typeOf(cg: *CodeGen, inst: Air.Inst.Ref) Type {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
return cg.air.typeOf(inst, &zcu.intern_pool);
}
fn typeOfIndex(cg: *CodeGen, inst: Air.Inst.Index) Type {
const zcu = cg.pt.zcu;
const zcu = cg.module.zcu;
return cg.air.typeOfIndex(inst, &zcu.intern_pool);
}
+254 -114
View File
@@ -7,20 +7,96 @@
//! is detected by the magic word in the header. Therefore, we can ignore any byte
//! order throughout the implementation, and just use the host byte order, and make
//! this a problem for the consumer.
const Module = @This();
const std = @import("std");
const Allocator = std.mem.Allocator;
const assert = std.debug.assert;
const autoHashStrat = std.hash.autoHashStrat;
const Wyhash = std.hash.Wyhash;
const Zcu = @import("../../Zcu.zig");
const InternPool = @import("../../InternPool.zig");
const Section = @import("Section.zig");
const spec = @import("spec.zig");
const Word = spec.Word;
const Id = spec.Id;
const Section = @import("Section.zig");
const Module = @This();
gpa: Allocator,
arena: Allocator,
zcu: *Zcu,
nav_link: std.AutoHashMapUnmanaged(InternPool.Nav.Index, Decl.Index) = .empty,
uav_link: std.AutoHashMapUnmanaged(struct { InternPool.Index, spec.StorageClass }, Decl.Index) = .empty,
intern_map: std.AutoHashMapUnmanaged(struct { InternPool.Index, Repr }, Id) = .empty,
decls: std.ArrayListUnmanaged(Decl) = .empty,
decl_deps: std.ArrayListUnmanaged(Decl.Index) = .empty,
entry_points: std.AutoArrayHashMapUnmanaged(Id, EntryPoint) = .empty,
/// This map serves a dual purpose:
/// - It keeps track of pointers that are currently being emitted, so that we can tell
/// if they are recursive and need an OpTypeForwardPointer.
/// - It caches pointers by child-type. This is required because sometimes we rely on
/// ID-equality for pointers, and pointers constructed via `ptrType()` aren't interned
/// via the usual `intern_map` mechanism.
ptr_types: std.AutoHashMapUnmanaged(
struct { Id, spec.StorageClass },
struct { ty_id: Id, fwd_emitted: bool },
) = .{},
/// For test declarations compiled for Vulkan target, we have to add a buffer.
/// We only need to generate this once, this holds the link information related to that.
error_buffer: ?Decl.Index = null,
/// SPIR-V instructions return result-ids.
/// This variable holds the module-wide counter for these.
next_result_id: Word = 1,
/// Some types shouldn't be emitted more than one time, but cannot be caught by
/// the `intern_map` during codegen. Sometimes, IDs are compared to check if
/// types are the same, so we can't delay until the dedup pass. Therefore,
/// this is an ad-hoc structure to cache types where required.
/// According to the SPIR-V specification, section 2.8, this includes all non-aggregate
/// non-pointer types.
/// Additionally, this is used for other values which can be cached, for example,
/// built-in variables.
cache: struct {
bool_type: ?Id = null,
void_type: ?Id = null,
opaque_types: std.StringHashMapUnmanaged(Id) = .empty,
int_types: std.AutoHashMapUnmanaged(std.builtin.Type.Int, Id) = .empty,
float_types: std.AutoHashMapUnmanaged(std.builtin.Type.Float, Id) = .empty,
vector_types: std.AutoHashMapUnmanaged(struct { Id, u32 }, Id) = .empty,
array_types: std.AutoHashMapUnmanaged(struct { Id, Id }, Id) = .empty,
struct_types: std.ArrayHashMapUnmanaged(StructType, Id, StructType.HashContext, true) = .empty,
fn_types: std.ArrayHashMapUnmanaged(FnType, Id, FnType.HashContext, true) = .empty,
capabilities: std.AutoHashMapUnmanaged(spec.Capability, void) = .empty,
extensions: std.StringHashMapUnmanaged(void) = .empty,
extended_instruction_set: std.AutoHashMapUnmanaged(spec.InstructionSet, Id) = .empty,
decorations: std.AutoHashMapUnmanaged(struct { Id, spec.Decoration }, void) = .empty,
builtins: std.AutoHashMapUnmanaged(struct { Id, spec.BuiltIn }, Decl.Index) = .empty,
strings: std.StringArrayHashMapUnmanaged(Id) = .empty,
bool_const: [2]?Id = .{ null, null },
constants: std.ArrayHashMapUnmanaged(Constant, Id, Constant.HashContext, true) = .empty,
} = .{},
/// Module layout, according to SPIR-V Spec section 2.4, "Logical Layout of a Module".
sections: struct {
capabilities: Section = .{},
extensions: Section = .{},
extended_instruction_set: Section = .{},
memory_model: Section = .{},
execution_modes: Section = .{},
debug_strings: Section = .{},
debug_names: Section = .{},
annotations: Section = .{},
globals: Section = .{},
functions: Section = .{},
} = .{},
/// Data can be lowered into in two basic representations: indirect, which is when
/// a type is stored in memory, and direct, which is how a type is stored when its
/// a direct SPIR-V value.
pub const Repr = enum {
/// A SPIR-V value as it would be used in operations.
direct,
/// A SPIR-V value as it is stored in memory.
indirect,
};
/// Declarations, both functions and globals, can have dependencies. These are used for 2 things:
/// - Globals must be declared before they are used, also between globals. The compiler processes
@@ -66,76 +142,68 @@ pub const EntryPoint = struct {
exec_mode: ?spec.ExecutionMode = null,
};
gpa: Allocator,
target: *const std.Target,
nav_link: std.AutoHashMapUnmanaged(InternPool.Nav.Index, Decl.Index) = .empty,
uav_link: std.AutoHashMapUnmanaged(struct { InternPool.Index, spec.StorageClass }, Decl.Index) = .empty,
intern_map: std.AutoHashMapUnmanaged(struct { InternPool.Index, Repr }, Id) = .empty,
decls: std.ArrayListUnmanaged(Decl) = .empty,
decl_deps: std.ArrayListUnmanaged(Decl.Index) = .empty,
entry_points: std.AutoArrayHashMapUnmanaged(Id, EntryPoint) = .empty,
/// This map serves a dual purpose:
/// - It keeps track of pointers that are currently being emitted, so that we can tell
/// if they are recursive and need an OpTypeForwardPointer.
/// - It caches pointers by child-type. This is required because sometimes we rely on
/// ID-equality for pointers, and pointers constructed via `ptrType()` aren't interned
/// via the usual `intern_map` mechanism.
ptr_types: std.AutoHashMapUnmanaged(
struct { InternPool.Index, spec.StorageClass, Repr },
struct { ty_id: Id, fwd_emitted: bool },
) = .{},
/// For test declarations compiled for Vulkan target, we have to add a buffer.
/// We only need to generate this once, this holds the link information related to that.
error_buffer: ?Decl.Index = null,
/// SPIR-V instructions return result-ids.
/// This variable holds the module-wide counter for these.
next_result_id: Word = 1,
/// Some types shouldn't be emitted more than one time, but cannot be caught by
/// the `intern_map` during codegen. Sometimes, IDs are compared to check if
/// types are the same, so we can't delay until the dedup pass. Therefore,
/// this is an ad-hoc structure to cache types where required.
/// According to the SPIR-V specification, section 2.8, this includes all non-aggregate
/// non-pointer types.
/// Additionally, this is used for other values which can be cached, for example,
/// built-in variables.
cache: struct {
bool_type: ?Id = null,
void_type: ?Id = null,
int_types: std.AutoHashMapUnmanaged(std.builtin.Type.Int, Id) = .empty,
float_types: std.AutoHashMapUnmanaged(std.builtin.Type.Float, Id) = .empty,
vector_types: std.AutoHashMapUnmanaged(struct { Id, u32 }, Id) = .empty,
array_types: std.AutoHashMapUnmanaged(struct { Id, Id }, Id) = .empty,
const StructType = struct {
fields: []const Id,
ip_index: InternPool.Index,
capabilities: std.AutoHashMapUnmanaged(spec.Capability, void) = .empty,
extensions: std.StringHashMapUnmanaged(void) = .empty,
extended_instruction_set: std.AutoHashMapUnmanaged(spec.InstructionSet, Id) = .empty,
decorations: std.AutoHashMapUnmanaged(struct { Id, spec.Decoration }, void) = .empty,
builtins: std.AutoHashMapUnmanaged(struct { Id, spec.BuiltIn }, Decl.Index) = .empty,
const HashContext = struct {
pub fn hash(_: @This(), ty: StructType) u32 {
var hasher = std.hash.Wyhash.init(0);
hasher.update(std.mem.sliceAsBytes(ty.fields));
hasher.update(std.mem.asBytes(&ty.ip_index));
return @truncate(hasher.final());
}
bool_const: [2]?Id = .{ null, null },
} = .{},
/// Module layout, according to SPIR-V Spec section 2.4, "Logical Layout of a Module".
sections: struct {
capabilities: Section = .{},
extensions: Section = .{},
extended_instruction_set: Section = .{},
memory_model: Section = .{},
execution_modes: Section = .{},
debug_strings: Section = .{},
debug_names: Section = .{},
annotations: Section = .{},
globals: Section = .{},
functions: Section = .{},
} = .{},
pub fn eql(_: @This(), a: StructType, b: StructType, _: usize) bool {
return a.ip_index == b.ip_index and std.mem.eql(Id, a.fields, b.fields);
}
};
};
/// Data can be lowered into in two basic representations: indirect, which is when
/// a type is stored in memory, and direct, which is how a type is stored when its
/// a direct SPIR-V value.
pub const Repr = enum {
/// A SPIR-V value as it would be used in operations.
direct,
/// A SPIR-V value as it is stored in memory.
indirect,
const FnType = struct {
return_ty: Id,
params: []const Id,
const HashContext = struct {
pub fn hash(_: @This(), ty: FnType) u32 {
var hasher = std.hash.Wyhash.init(0);
hasher.update(std.mem.asBytes(&ty.return_ty));
hasher.update(std.mem.sliceAsBytes(ty.params));
return @truncate(hasher.final());
}
pub fn eql(_: @This(), a: FnType, b: FnType, _: usize) bool {
return a.return_ty == b.return_ty and
std.mem.eql(Id, a.params, b.params);
}
};
};
const Constant = struct {
ty: Id,
value: spec.LiteralContextDependentNumber,
const HashContext = struct {
pub fn hash(_: @This(), value: Constant) u32 {
const Tag = @typeInfo(spec.LiteralContextDependentNumber).@"union".tag_type.?;
var hasher = std.hash.Wyhash.init(0);
hasher.update(std.mem.asBytes(&value.ty));
hasher.update(std.mem.asBytes(&@as(Tag, value.value)));
switch (value.value) {
inline else => |v| hasher.update(std.mem.asBytes(&v)),
}
return @truncate(hasher.final());
}
pub fn eql(_: @This(), a: Constant, b: Constant, _: usize) bool {
if (a.ty != b.ty) return false;
const Tag = @typeInfo(spec.LiteralContextDependentNumber).@"union".tag_type.?;
if (@as(Tag, a.value) != @as(Tag, b.value)) return false;
return switch (a.value) {
inline else => |v, tag| v == @field(b.value, @tagName(tag)),
};
}
};
};
pub fn deinit(module: *Module) void {
@@ -155,15 +223,21 @@ pub fn deinit(module: *Module) void {
module.sections.globals.deinit(module.gpa);
module.sections.functions.deinit(module.gpa);
module.cache.opaque_types.deinit(module.gpa);
module.cache.int_types.deinit(module.gpa);
module.cache.float_types.deinit(module.gpa);
module.cache.vector_types.deinit(module.gpa);
module.cache.array_types.deinit(module.gpa);
module.cache.struct_types.deinit(module.gpa);
module.cache.fn_types.deinit(module.gpa);
module.cache.capabilities.deinit(module.gpa);
module.cache.extensions.deinit(module.gpa);
module.cache.extended_instruction_set.deinit(module.gpa);
module.cache.decorations.deinit(module.gpa);
module.cache.builtins.deinit(module.gpa);
module.cache.strings.deinit(module.gpa);
module.cache.constants.deinit(module.gpa);
module.decls.deinit(module.gpa);
module.decl_deps.deinit(module.gpa);
@@ -234,6 +308,8 @@ pub fn addEntryPointDeps(
}
fn entryPoints(module: *Module) !Section {
const target = module.zcu.getTarget();
var entry_points = Section{};
errdefer entry_points.deinit(module.gpa);
@@ -256,7 +332,7 @@ fn entryPoints(module: *Module) !Section {
});
if (entry_point.exec_mode == null and entry_point.exec_model == .fragment) {
switch (module.target.os.tag) {
switch (target.os.tag) {
.vulkan, .opengl => |tag| {
try module.sections.execution_modes.emit(module.gpa, .OpExecutionMode, .{
.entry_point = entry_point_id,
@@ -273,7 +349,7 @@ fn entryPoints(module: *Module) !Section {
}
pub fn finalize(module: *Module, gpa: Allocator) ![]Word {
const target = module.target;
const target = module.zcu.getTarget();
// Emit capabilities and extensions
switch (target.os.tag) {
@@ -434,20 +510,6 @@ pub fn importInstructionSet(module: *Module, set: spec.InstructionSet) !Id {
return result_id;
}
pub fn structType(module: *Module, result_id: Id, types: []const Id, maybe_names: ?[]const []const u8) !void {
try module.sections.globals.emit(module.gpa, .OpTypeStruct, .{
.id_result = result_id,
.id_ref = types,
});
if (maybe_names) |names| {
assert(names.len == types.len);
for (names, 0..) |name, i| {
try module.memberDebugName(result_id, @intCast(i), name);
}
}
}
pub fn boolType(module: *Module) !Id {
if (module.cache.bool_type) |id| return id;
@@ -471,6 +533,19 @@ pub fn voidType(module: *Module) !Id {
return result_id;
}
pub fn opaqueType(module: *Module, name: []const u8) !Id {
if (module.cache.opaque_types.get(name)) |id| return id;
const result_id = module.allocId();
const name_dup = try module.arena.dupe(u8, name);
try module.sections.globals.emit(module.gpa, .OpTypeOpaque, .{
.id_result = result_id,
.literal_string = name_dup,
});
try module.debugName(result_id, name_dup);
try module.cache.opaque_types.put(module.gpa, name_dup, result_id);
return result_id;
}
pub fn intType(module: *Module, signedness: std.builtin.Signedness, bits: u16) !Id {
assert(bits > 0);
const entry = try module.cache.int_types.getOrPut(module.gpa, .{ .signedness = signedness, .bits = bits });
@@ -537,27 +612,89 @@ pub fn arrayType(module: *Module, len_id: Id, child_ty_id: Id) !Id {
return entry.value_ptr.*;
}
pub fn functionType(module: *Module, return_ty_id: Id, param_type_ids: []const Id) !Id {
pub fn structType(
module: *Module,
types: []const Id,
maybe_names: ?[]const []const u8,
maybe_offsets: ?[]const u32,
ip_index: InternPool.Index,
) !Id {
const target = module.zcu.getTarget();
if (module.cache.struct_types.get(.{ .fields = types, .ip_index = ip_index })) |id| return id;
const result_id = module.allocId();
try module.sections.globals.emit(module.gpa, .OpTypeFunction, .{
const types_dup = try module.arena.dupe(Id, types);
try module.sections.globals.emit(module.gpa, .OpTypeStruct, .{
.id_result = result_id,
.return_type = return_ty_id,
.id_ref_2 = param_type_ids,
.id_ref = types_dup,
});
if (maybe_names) |names| {
assert(names.len == types.len);
for (names, 0..) |name, i| {
try module.memberDebugName(result_id, @intCast(i), name);
}
}
switch (target.os.tag) {
.vulkan, .opengl => {
if (maybe_offsets) |offsets| {
assert(offsets.len == types.len);
for (offsets, 0..) |offset, i| {
try module.decorateMember(
result_id,
@intCast(i),
.{ .offset = .{ .byte_offset = offset } },
);
}
}
},
else => {},
}
try module.cache.struct_types.put(
module.gpa,
.{
.fields = types_dup,
.ip_index = if (module.zcu.comp.config.root_strip) .none else ip_index,
},
result_id,
);
return result_id;
}
pub fn constant(module: *Module, result_ty_id: Id, value: spec.LiteralContextDependentNumber) !Id {
pub fn functionType(module: *Module, return_ty_id: Id, param_type_ids: []const Id) !Id {
if (module.cache.fn_types.get(.{
.return_ty = return_ty_id,
.params = param_type_ids,
})) |id| return id;
const result_id = module.allocId();
const section = &module.sections.globals;
try section.emit(module.gpa, .OpConstant, .{
.id_result_type = result_ty_id,
const params_dup = try module.arena.dupe(Id, param_type_ids);
try module.sections.globals.emit(module.gpa, .OpTypeFunction, .{
.id_result = result_id,
.value = value,
.return_type = return_ty_id,
.id_ref_2 = params_dup,
});
try module.cache.fn_types.put(module.gpa, .{
.return_ty = return_ty_id,
.params = params_dup,
}, result_id);
return result_id;
}
pub fn constant(module: *Module, ty_id: Id, value: spec.LiteralContextDependentNumber) !Id {
const entry = try module.cache.constants.getOrPut(module.gpa, .{ .ty = ty_id, .value = value });
if (!entry.found_existing) {
entry.value_ptr.* = module.allocId();
try module.sections.globals.emit(module.gpa, .OpConstant, .{
.id_result_type = ty_id,
.id_result = entry.value_ptr.*,
.value = value,
});
}
return entry.value_ptr.*;
}
pub fn constBool(module: *Module, value: bool) !Id {
if (module.cache.bool_const[@intFromBool(value)]) |b| return b;
@@ -711,28 +848,31 @@ pub fn memberDebugName(module: *Module, target: Id, member: u32, name: []const u
});
}
pub fn debugString(module: *Module, string: []const u8) !Id {
const entry = try module.cache.strings.getOrPut(module.gpa, string);
if (!entry.found_existing) {
entry.value_ptr.* = module.allocId();
try module.sections.debug_strings.emit(module.gpa, .OpString, .{
.id_result = entry.value_ptr.*,
.string = string,
});
}
return entry.value_ptr.*;
}
pub fn storageClass(module: *Module, as: std.builtin.AddressSpace) spec.StorageClass {
const target = module.zcu.getTarget();
return switch (as) {
.generic => if (module.target.cpu.has(.spirv, .generic_pointer)) .generic else .function,
.global => switch (module.target.os.tag) {
.generic => if (target.cpu.has(.spirv, .generic_pointer)) .generic else .function,
.global => switch (target.os.tag) {
.opencl, .amdhsa => .cross_workgroup,
else => .storage_buffer,
},
.push_constant => {
return .push_constant;
},
.output => {
return .output;
},
.uniform => {
return .uniform;
},
.storage_buffer => {
return .storage_buffer;
},
.physical_storage_buffer => {
return .physical_storage_buffer;
},
.push_constant => .push_constant,
.output => .output,
.uniform => .uniform,
.storage_buffer => .storage_buffer,
.physical_storage_buffer => .physical_storage_buffer,
.constant => .uniform_constant,
.shared => .workgroup,
.local => .function,
+38 -36
View File
@@ -46,8 +46,8 @@ pub fn createEmpty(
else => unreachable, // Caught by Compilation.Config.resolve.
}
const self = try arena.create(Linker);
self.* = .{
const linker = try arena.create(Linker);
linker.* = .{
.base = .{
.tag = .spirv,
.comp = comp,
@@ -59,16 +59,20 @@ pub fn createEmpty(
.file = null,
.build_id = options.build_id,
},
.module = .{ .gpa = gpa, .target = comp.getTarget() },
.module = .{
.gpa = gpa,
.arena = arena,
.zcu = comp.zcu.?,
},
};
errdefer self.deinit();
errdefer linker.deinit();
self.base.file = try emit.root_dir.handle.createFile(emit.sub_path, .{
linker.base.file = try emit.root_dir.handle.createFile(emit.sub_path, .{
.truncate = true,
.read = true,
});
return self;
return linker;
}
pub fn open(
@@ -80,12 +84,12 @@ pub fn open(
return createEmpty(arena, comp, emit, options);
}
pub fn deinit(self: *Linker) void {
self.module.deinit();
pub fn deinit(linker: *Linker) void {
linker.module.deinit();
}
fn genNav(
self: *Linker,
fn generate(
linker: *Linker,
pt: Zcu.PerThread,
nav_index: InternPool.Nav.Index,
air: Air,
@@ -96,9 +100,9 @@ fn genNav(
const gpa = zcu.gpa;
const structured_cfg = zcu.navFileScope(nav_index).mod.?.structured_cfg;
var nav_gen: CodeGen = .{
var cg: CodeGen = .{
.pt = pt,
.module = &self.module,
.module = &linker.module,
.owner_nav = nav_index,
.air = air,
.liveness = liveness,
@@ -108,17 +112,17 @@ fn genNav(
},
.base_line = zcu.navSrcLine(nav_index),
};
defer nav_gen.deinit();
defer cg.deinit();
nav_gen.genNav(do_codegen) catch |err| switch (err) {
error.CodegenFail => switch (zcu.codegenFailMsg(nav_index, nav_gen.error_msg.?)) {
cg.genNav(do_codegen) catch |err| switch (err) {
error.CodegenFail => switch (zcu.codegenFailMsg(nav_index, cg.error_msg.?)) {
error.CodegenFail => {},
error.OutOfMemory => |e| return e,
},
else => |other| {
// There might be an error that happened *after* self.error_msg
// There might be an error that happened *after* linker.error_msg
// was already allocated, so be sure to free it.
if (nav_gen.error_msg) |error_msg| {
if (cg.error_msg) |error_msg| {
error_msg.deinit(gpa);
}
@@ -128,7 +132,7 @@ fn genNav(
}
pub fn updateFunc(
self: *Linker,
linker: *Linker,
pt: Zcu.PerThread,
func_index: InternPool.Index,
air: *const Air,
@@ -136,17 +140,17 @@ pub fn updateFunc(
) !void {
const nav = pt.zcu.funcInfo(func_index).owner_nav;
// TODO: Separate types for generating decls and functions?
try self.genNav(pt, nav, air.*, liveness.*.?, true);
try linker.generate(pt, nav, air.*, liveness.*.?, true);
}
pub fn updateNav(self: *Linker, pt: Zcu.PerThread, nav: InternPool.Nav.Index) link.File.UpdateNavError!void {
pub fn updateNav(linker: *Linker, pt: Zcu.PerThread, nav: InternPool.Nav.Index) link.File.UpdateNavError!void {
const ip = &pt.zcu.intern_pool;
log.debug("lowering nav {f}({d})", .{ ip.getNav(nav).fqn.fmt(ip), nav });
try self.genNav(pt, nav, undefined, undefined, false);
try linker.generate(pt, nav, undefined, undefined, false);
}
pub fn updateExports(
self: *Linker,
linker: *Linker,
pt: Zcu.PerThread,
exported: Zcu.Exported,
export_indices: []const Zcu.Export.Index,
@@ -163,7 +167,7 @@ pub fn updateExports(
const nav_ty = ip.getNav(nav_index).typeOf(ip);
const target = zcu.getTarget();
if (ip.isFunctionType(nav_ty)) {
const spv_decl_index = try self.module.resolveNav(ip, nav_index);
const spv_decl_index = try linker.module.resolveNav(ip, nav_index);
const cc = Type.fromInterned(nav_ty).fnCallingConvention(zcu);
const exec_model: spec.ExecutionModel = switch (target.os.tag) {
.vulkan, .opengl => switch (cc) {
@@ -185,7 +189,7 @@ pub fn updateExports(
for (export_indices) |export_idx| {
const exp = export_idx.ptr(zcu);
try self.module.declareEntryPoint(
try linker.module.declareEntryPoint(
spv_decl_index,
exp.opts.name.toSlice(ip),
exec_model,
@@ -198,7 +202,7 @@ pub fn updateExports(
}
pub fn flush(
self: *Linker,
linker: *Linker,
arena: Allocator,
tid: Zcu.PerThread.Id,
prog_node: std.Progress.Node,
@@ -214,18 +218,18 @@ pub fn flush(
const sub_prog_node = prog_node.start("Flush Module", 0);
defer sub_prog_node.end();
const comp = self.base.comp;
const comp = linker.base.comp;
const diags = &comp.link_diags;
const gpa = comp.gpa;
// We need to export the list of error names somewhere so that we can pretty-print them in the
// executor. This is not really an important thing though, so we can just dump it in any old
// nonsemantic instruction. For now, just put it in OpSourceExtension with a special name.
var error_info: std.io.Writer.Allocating = .init(self.module.gpa);
var error_info: std.io.Writer.Allocating = .init(linker.module.gpa);
defer error_info.deinit();
error_info.writer.writeAll("zig_errors:") catch return error.OutOfMemory;
const ip = &self.base.comp.zcu.?.intern_pool;
const ip = &linker.base.comp.zcu.?.intern_pool;
for (ip.global_error_set.getNamesFromMainThread()) |name| {
// Errors can contain pretty much any character - to encode them in a string we must escape
// them somehow. Easiest here is to use some established scheme, one which also preseves the
@@ -245,28 +249,27 @@ pub fn flush(
}.isValidChar,
) catch return error.OutOfMemory;
}
try self.module.sections.debug_strings.emit(gpa, .OpSourceExtension, .{
try linker.module.sections.debug_strings.emit(gpa, .OpSourceExtension, .{
.extension = error_info.getWritten(),
});
const module = try self.module.finalize(arena);
const module = try linker.module.finalize(arena);
errdefer arena.free(module);
const linked_module = self.linkModule(arena, module, sub_prog_node) catch |err| switch (err) {
const linked_module = linker.linkModule(arena, module, sub_prog_node) catch |err| switch (err) {
error.OutOfMemory => return error.OutOfMemory,
else => |other| return diags.fail("error while linking: {s}", .{@errorName(other)}),
};
self.base.file.?.writeAll(std.mem.sliceAsBytes(linked_module)) catch |err|
linker.base.file.?.writeAll(std.mem.sliceAsBytes(linked_module)) catch |err|
return diags.fail("failed to write: {s}", .{@errorName(err)});
}
fn linkModule(self: *Linker, arena: Allocator, module: []Word, progress: std.Progress.Node) ![]Word {
_ = self;
fn linkModule(linker: *Linker, arena: Allocator, module: []Word, progress: std.Progress.Node) ![]Word {
_ = linker;
const lower_invocation_globals = @import("SpirV/lower_invocation_globals.zig");
const prune_unused = @import("SpirV/prune_unused.zig");
const dedup = @import("SpirV/deduplicate.zig");
var parser = try BinaryModule.Parser.init(arena);
defer parser.deinit();
@@ -274,7 +277,6 @@ fn linkModule(self: *Linker, arena: Allocator, module: []Word, progress: std.Pro
try lower_invocation_globals.run(&parser, &binary, progress);
try prune_unused.run(&parser, &binary, progress);
try dedup.run(&parser, &binary, progress);
return binary.finalize(arena);
}
-553
View File
@@ -1,553 +0,0 @@
const std = @import("std");
const Allocator = std.mem.Allocator;
const log = std.log.scoped(.spirv_link);
const assert = std.debug.assert;
const BinaryModule = @import("BinaryModule.zig");
const Section = @import("../../arch/spirv/Section.zig");
const spec = @import("../../arch/spirv/spec.zig");
const Opcode = spec.Opcode;
const ResultId = spec.Id;
const Word = spec.Word;
fn canDeduplicate(opcode: Opcode) bool {
return switch (opcode) {
.OpTypeForwardPointer => false, // Don't need to handle these
.OpGroupDecorate, .OpGroupMemberDecorate => {
// These are deprecated, so don't bother supporting them for now.
return false;
},
// Debug decoration-style instructions
.OpName, .OpMemberName => true,
else => switch (opcode.class()) {
.type_declaration,
.constant_creation,
.annotation,
=> true,
else => false,
},
};
}
const ModuleInfo = struct {
/// This models a type, decoration or constant instruction
/// and its dependencies.
const Entity = struct {
/// The type that this entity represents. This is just
/// the instruction opcode.
kind: Opcode,
/// The offset of this entity's operands, in
/// `binary.instructions`.
first_operand: u32,
/// The number of operands in this entity
num_operands: u16,
/// The (first_operand-relative) offset of the result-id,
/// or the entity that is affected by this entity if this entity
/// is a decoration.
result_id_index: u16,
/// The first decoration in `self.decorations`.
first_decoration: u32,
fn operands(self: Entity, binary: *const BinaryModule) []const Word {
return binary.instructions[self.first_operand..][0..self.num_operands];
}
};
/// Maps result-id to Entity's
entities: std.AutoArrayHashMapUnmanaged(ResultId, Entity),
/// A bit set that keeps track of which operands are result-ids.
/// Note: This also includes any result-id!
/// Because we need these values when recoding the module anyway,
/// it contains the status of ALL operands in the module.
operand_is_id: std.DynamicBitSetUnmanaged,
/// Store of decorations for each entity.
decorations: []const Entity,
pub fn parse(
arena: Allocator,
parser: *BinaryModule.Parser,
binary: BinaryModule,
) !ModuleInfo {
var entities = std.AutoArrayHashMap(ResultId, Entity).init(arena);
var id_offsets = std.ArrayList(u16).init(arena);
var operand_is_id = try std.DynamicBitSetUnmanaged.initEmpty(arena, binary.instructions.len);
var decorations = std.MultiArrayList(struct { target_id: ResultId, entity: Entity }){};
var it = binary.iterateInstructions();
while (it.next()) |inst| {
id_offsets.items.len = 0;
try parser.parseInstructionResultIds(binary, inst, &id_offsets);
const first_operand_offset: u32 = @intCast(inst.offset + 1);
for (id_offsets.items) |offset| {
operand_is_id.set(first_operand_offset + offset);
}
if (!canDeduplicate(inst.opcode)) continue;
const result_id_index: u16 = switch (inst.opcode.class()) {
.type_declaration, .annotation, .debug => 0,
.constant_creation => 1,
else => unreachable,
};
const result_id: ResultId = @enumFromInt(inst.operands[id_offsets.items[result_id_index]]);
const entity = Entity{
.kind = inst.opcode,
.first_operand = first_operand_offset,
.num_operands = @intCast(inst.operands.len),
.result_id_index = result_id_index,
.first_decoration = undefined, // Filled in later
};
switch (inst.opcode.class()) {
.annotation, .debug => {
try decorations.append(arena, .{
.target_id = result_id,
.entity = entity,
});
},
.type_declaration, .constant_creation => {
const entry = try entities.getOrPut(result_id);
if (entry.found_existing) {
log.err("type or constant {f} has duplicate definition", .{result_id});
return error.DuplicateId;
}
entry.value_ptr.* = entity;
},
else => unreachable,
}
}
// Sort decorations by the index of the result-id in `entities.
// This ensures not only that the decorations of a particular reuslt-id
// are continuous, but the subsequences also appear in the same order as in `entities`.
const SortContext = struct {
entities: std.AutoArrayHashMapUnmanaged(ResultId, Entity),
ids: []const ResultId,
pub fn lessThan(ctx: @This(), a_index: usize, b_index: usize) bool {
// If any index is not in the entities set, its because its not a
// deduplicatable result-id. Those should be considered largest and
// float to the end.
const entity_index_a = ctx.entities.getIndex(ctx.ids[a_index]) orelse return false;
const entity_index_b = ctx.entities.getIndex(ctx.ids[b_index]) orelse return true;
return entity_index_a < entity_index_b;
}
};
decorations.sort(SortContext{
.entities = entities.unmanaged,
.ids = decorations.items(.target_id),
});
// Now go through the decorations and add the offsets to the entities list.
var decoration_i: u32 = 0;
const target_ids = decorations.items(.target_id);
for (entities.keys(), entities.values()) |id, *entity| {
entity.first_decoration = decoration_i;
// Scan ahead to the next decoration
while (decoration_i < target_ids.len and target_ids[decoration_i] == id) {
decoration_i += 1;
}
}
return .{
.entities = entities.unmanaged,
.operand_is_id = operand_is_id,
// There may be unrelated decorations at the end, so make sure to
// slice those off.
.decorations = decorations.items(.entity)[0..decoration_i],
};
}
fn entityDecorationsByIndex(self: ModuleInfo, index: usize) []const Entity {
const values = self.entities.values();
const first_decoration = values[index].first_decoration;
if (index == values.len - 1) {
return self.decorations[first_decoration..];
} else {
const next_first_decoration = values[index + 1].first_decoration;
return self.decorations[first_decoration..next_first_decoration];
}
}
};
const EntityContext = struct {
a: Allocator,
ptr_map_a: std.AutoArrayHashMapUnmanaged(ResultId, void) = .empty,
ptr_map_b: std.AutoArrayHashMapUnmanaged(ResultId, void) = .empty,
info: *const ModuleInfo,
binary: *const BinaryModule,
fn deinit(self: *EntityContext) void {
self.ptr_map_a.deinit(self.a);
self.ptr_map_b.deinit(self.a);
self.* = undefined;
}
fn equalizeMapCapacity(self: *EntityContext) !void {
const cap = @max(self.ptr_map_a.capacity(), self.ptr_map_b.capacity());
try self.ptr_map_a.ensureTotalCapacity(self.a, cap);
try self.ptr_map_b.ensureTotalCapacity(self.a, cap);
}
fn hash(self: *EntityContext, id: ResultId) !u64 {
var hasher = std.hash.Wyhash.init(0);
self.ptr_map_a.clearRetainingCapacity();
try self.hashInner(&hasher, id);
return hasher.final();
}
fn hashInner(self: *EntityContext, hasher: *std.hash.Wyhash, id: ResultId) error{OutOfMemory}!void {
const index = self.info.entities.getIndex(id) orelse {
// Index unknown, the type or constant may depend on another result-id
// that couldn't be deduplicated and so it wasn't added to info.entities.
// In this case, just has the ID itself.
std.hash.autoHash(hasher, id);
return;
};
const entity = self.info.entities.values()[index];
// If the current pointer is recursive, don't immediately add it to the map. This is to ensure that
// if the current pointer is already recursive, it gets the same hash a pointer that points to the
// same child but has a different result-id.
if (entity.kind == .OpTypePointer) {
// This may be either a pointer that is forward-referenced in the future,
// or a forward reference to a pointer.
// Note: We use the **struct** here instead of the pointer itself, to avoid an edge case like this:
//
// A - C*'
// \
// C - C*'
// /
// B - C*"
//
// In this case, hashing A goes like
// A -> C*' -> C -> C*' recursion
// And hashing B goes like
// B -> C*" -> C -> C*' -> C -> C*' recursion
// The are several calls to ptrType in codegen that may C*' and C*" to be generated as separate
// types. This is not a problem for C itself though - this can only be generated through resolveType()
// and so ensures equality by Zig's type system. Technically the above problem is still present, but it
// would only be present in a structure such as
//
// A - C*' - C'
// \
// C*" - C - C*
// /
// B
//
// where there is a duplicate definition of struct C. Resolving this requires a much more time consuming
// algorithm though, and because we don't expect any correctness issues with it, we leave that for now.
// TODO: Do we need to mind the storage class here? Its going to be recursive regardless, right?
const struct_id: ResultId = @enumFromInt(entity.operands(self.binary)[2]);
const entry = try self.ptr_map_a.getOrPut(self.a, struct_id);
if (entry.found_existing) {
// Pointer already seen. Hash the index instead of recursing into its children.
std.hash.autoHash(hasher, entry.index);
return;
}
}
try self.hashEntity(hasher, entity);
// Process decorations.
const decorations = self.info.entityDecorationsByIndex(index);
for (decorations) |decoration| {
try self.hashEntity(hasher, decoration);
}
if (entity.kind == .OpTypePointer) {
const struct_id: ResultId = @enumFromInt(entity.operands(self.binary)[2]);
assert(self.ptr_map_a.swapRemove(struct_id));
}
}
fn hashEntity(self: *EntityContext, hasher: *std.hash.Wyhash, entity: ModuleInfo.Entity) !void {
std.hash.autoHash(hasher, entity.kind);
// Process operands
const operands = entity.operands(self.binary);
for (operands, 0..) |operand, i| {
if (i == entity.result_id_index) {
// Not relevant, skip...
continue;
} else if (self.info.operand_is_id.isSet(entity.first_operand + i)) {
// Operand is ID
try self.hashInner(hasher, @enumFromInt(operand));
} else {
// Operand is merely data
std.hash.autoHash(hasher, operand);
}
}
}
fn eql(self: *EntityContext, a: ResultId, b: ResultId) !bool {
self.ptr_map_a.clearRetainingCapacity();
self.ptr_map_b.clearRetainingCapacity();
return try self.eqlInner(a, b);
}
fn eqlInner(self: *EntityContext, id_a: ResultId, id_b: ResultId) error{OutOfMemory}!bool {
const maybe_index_a = self.info.entities.getIndex(id_a);
const maybe_index_b = self.info.entities.getIndex(id_b);
if (maybe_index_a == null and maybe_index_b == null) {
// Both indices unknown. In this case the type or constant
// may depend on another result-id that couldn't be deduplicated
// (so it wasn't added to info.entities). In this case, that particular
// result-id should be the same one.
return id_a == id_b;
}
const index_a = maybe_index_a orelse return false;
const index_b = maybe_index_b orelse return false;
const entity_a = self.info.entities.values()[index_a];
const entity_b = self.info.entities.values()[index_b];
if (entity_a.kind != entity_b.kind) {
return false;
}
if (entity_a.kind == .OpTypePointer) {
// May be a forward reference, or should be saved as a potential
// forward reference in the future. Whatever the case, it should
// be the same for both a and b.
const struct_id_a: ResultId = @enumFromInt(entity_a.operands(self.binary)[2]);
const struct_id_b: ResultId = @enumFromInt(entity_b.operands(self.binary)[2]);
const entry_a = try self.ptr_map_a.getOrPut(self.a, struct_id_a);
const entry_b = try self.ptr_map_b.getOrPut(self.a, struct_id_b);
if (entry_a.found_existing != entry_b.found_existing) return false;
if (entry_a.index != entry_b.index) return false;
if (entry_a.found_existing) {
// No need to recurse.
return true;
}
}
if (!try self.eqlEntities(entity_a, entity_b)) {
return false;
}
// Compare decorations.
const decorations_a = self.info.entityDecorationsByIndex(index_a);
const decorations_b = self.info.entityDecorationsByIndex(index_b);
if (decorations_a.len != decorations_b.len) {
return false;
}
for (decorations_a, decorations_b) |decoration_a, decoration_b| {
if (!try self.eqlEntities(decoration_a, decoration_b)) {
return false;
}
}
if (entity_a.kind == .OpTypePointer) {
const struct_id_a: ResultId = @enumFromInt(entity_a.operands(self.binary)[2]);
const struct_id_b: ResultId = @enumFromInt(entity_b.operands(self.binary)[2]);
assert(self.ptr_map_a.swapRemove(struct_id_a));
assert(self.ptr_map_b.swapRemove(struct_id_b));
}
return true;
}
fn eqlEntities(self: *EntityContext, entity_a: ModuleInfo.Entity, entity_b: ModuleInfo.Entity) !bool {
if (entity_a.kind != entity_b.kind) {
return false;
} else if (entity_a.result_id_index != entity_a.result_id_index) {
return false;
}
const operands_a = entity_a.operands(self.binary);
const operands_b = entity_b.operands(self.binary);
// Note: returns false for operands that have explicit defaults in optional operands... oh well
if (operands_a.len != operands_b.len) {
return false;
}
for (operands_a, operands_b, 0..) |operand_a, operand_b, i| {
const a_is_id = self.info.operand_is_id.isSet(entity_a.first_operand + i);
const b_is_id = self.info.operand_is_id.isSet(entity_b.first_operand + i);
if (a_is_id != b_is_id) {
return false;
} else if (i == entity_a.result_id_index) {
// result-id for both...
continue;
} else if (a_is_id) {
// Both are IDs, so recurse.
if (!try self.eqlInner(@enumFromInt(operand_a), @enumFromInt(operand_b))) {
return false;
}
} else if (operand_a != operand_b) {
return false;
}
}
return true;
}
};
/// This struct is a wrapper around EntityContext that adapts it for
/// use in a hash map. Because EntityContext allocates, it cannot be
/// used. This wrapper simply assumes that the maps have been allocated
/// the max amount of memory they are going to use.
/// This is done by pre-hashing all keys.
const EntityHashContext = struct {
entity_context: *EntityContext,
pub fn hash(self: EntityHashContext, key: ResultId) u64 {
return self.entity_context.hash(key) catch unreachable;
}
pub fn eql(self: EntityHashContext, a: ResultId, b: ResultId) bool {
return self.entity_context.eql(a, b) catch unreachable;
}
};
pub fn run(parser: *BinaryModule.Parser, binary: *BinaryModule, progress: std.Progress.Node) !void {
const sub_node = progress.start("deduplicate", 0);
defer sub_node.end();
var arena = std.heap.ArenaAllocator.init(parser.a);
defer arena.deinit();
const a = arena.allocator();
const info = try ModuleInfo.parse(a, parser, binary.*);
// Hash all keys once so that the maps can be allocated the right size.
var ctx = EntityContext{
.a = a,
.info = &info,
.binary = binary,
};
for (info.entities.keys()) |id| {
_ = try ctx.hash(id);
}
// hash only uses ptr_map_a, so allocate ptr_map_b too
try ctx.equalizeMapCapacity();
// Figure out which entities can be deduplicated.
var map = std.HashMap(ResultId, void, EntityHashContext, 80).initContext(a, .{
.entity_context = &ctx,
});
var replace = std.AutoArrayHashMap(ResultId, ResultId).init(a);
for (info.entities.keys()) |id| {
const entry = try map.getOrPut(id);
if (entry.found_existing) {
try replace.putNoClobber(id, entry.key_ptr.*);
}
}
sub_node.setEstimatedTotalItems(binary.instructions.len);
// Now process the module, and replace instructions where needed.
var section = Section{};
var it = binary.iterateInstructions();
var new_functions_section: ?usize = null;
var new_operands = std.ArrayList(u32).init(a);
var emitted_ptrs = std.AutoHashMap(ResultId, void).init(a);
while (it.next()) |inst| {
defer sub_node.setCompletedItems(inst.offset);
// Result-id can only be the first or second operand
const inst_spec = parser.getInstSpec(inst.opcode).?;
const maybe_result_id_offset: ?u16 = for (0..2) |i| {
if (inst_spec.operands.len > i and inst_spec.operands[i].kind == .id_result) {
break @intCast(i);
}
} else null;
if (maybe_result_id_offset) |offset| {
const result_id: ResultId = @enumFromInt(inst.operands[offset]);
if (replace.contains(result_id)) continue;
}
switch (inst.opcode) {
.OpFunction => if (new_functions_section == null) {
new_functions_section = section.instructions.items.len;
},
.OpTypeForwardPointer => continue, // We re-emit these where needed
else => {},
}
switch (inst.opcode.class()) {
.annotation, .debug => {
// For decoration-style instructions, only emit them
// if the target is not removed.
const target: ResultId = @enumFromInt(inst.operands[0]);
if (replace.contains(target)) continue;
},
else => {},
}
// Re-emit the instruction, but replace all the IDs.
new_operands.items.len = 0;
try new_operands.appendSlice(inst.operands);
for (new_operands.items, 0..) |*operand, i| {
const is_id = info.operand_is_id.isSet(inst.offset + 1 + i);
if (!is_id) continue;
if (replace.get(@enumFromInt(operand.*))) |new_id| {
operand.* = @intFromEnum(new_id);
}
if (maybe_result_id_offset == null or maybe_result_id_offset.? != i) {
// Only emit forward pointers before type, constant, and global instructions.
// Debug and Annotation instructions don't need the forward pointer, and it
// messes up the logical layout of the module.
switch (inst.opcode.class()) {
.type_declaration, .constant_creation, .memory => {},
else => continue,
}
const id: ResultId = @enumFromInt(operand.*);
const index = info.entities.getIndex(id) orelse continue;
const entity = info.entities.values()[index];
if (entity.kind == .OpTypePointer and !emitted_ptrs.contains(id)) {
// Grab the pointer's storage class from its operands in the original
// module.
const storage_class: spec.StorageClass = @enumFromInt(entity.operands(binary)[1]);
try section.emit(a, .OpTypeForwardPointer, .{
.pointer_type = id,
.storage_class = storage_class,
});
try emitted_ptrs.put(id, {});
}
}
}
if (inst.opcode == .OpTypePointer) {
const result_id: ResultId = @enumFromInt(new_operands.items[maybe_result_id_offset.?]);
try emitted_ptrs.put(result_id, {});
}
try section.emitRawInstruction(a, inst.opcode, new_operands.items);
}
for (replace.keys()) |key| {
_ = binary.ext_inst_map.remove(key);
_ = binary.arith_type_width.remove(key);
}
binary.instructions = try parser.a.dupe(Word, section.toWords());
binary.sections.functions = new_functions_section orelse binary.instructions.len;
}