aboutsummaryrefslogtreecommitdiff
path: root/src/codegen
diff options
context:
space:
mode:
authorRobin Voetter <robin@voetter.nl>2023-04-09 01:29:39 +0200
committerRobin Voetter <robin@voetter.nl>2023-04-09 01:51:53 +0200
commit8bbfbfc956af163434c734e196d5c2a77e77ff07 (patch)
tree8ed95f240d2736a4d82e915ecc9269f15ba834e2 /src/codegen
parent80b84355692606ac840584baa62aaafdd8ecd425 (diff)
downloadzig-8bbfbfc956af163434c734e196d5c2a77e77ff07.tar.gz
zig-8bbfbfc956af163434c734e196d5c2a77e77ff07.zip
spirv: improve linking globals
SPIR-V globals must be emitted in order, so that any declaration precedes usage. Zig, however, generates globals in random order. To this end we keep for each global a list of dependencies and perform a topological sort when flushing the module.
Diffstat (limited to 'src/codegen')
-rw-r--r--src/codegen/spirv.zig288
-rw-r--r--src/codegen/spirv/Module.zig127
2 files changed, 293 insertions, 122 deletions
diff --git a/src/codegen/spirv.zig b/src/codegen/spirv.zig
index eb67f8e1c3..b58f889f8e 100644
--- a/src/codegen/spirv.zig
+++ b/src/codegen/spirv.zig
@@ -32,12 +32,28 @@ const IncomingBlock = struct {
break_value_id: IdRef,
};
-pub const BlockMap = std.AutoHashMapUnmanaged(Air.Inst.Index, struct {
+const BlockMap = std.AutoHashMapUnmanaged(Air.Inst.Index, struct {
label_id: IdRef,
incoming_blocks: *std.ArrayListUnmanaged(IncomingBlock),
});
-pub const DeclMap = std.AutoHashMap(Module.Decl.Index, IdResult);
+/// Linking information about a particular decl.
+/// The active field of this enum depends on the type of the corresponding decl.
+const DeclLink = union {
+ /// Linking information about a function.
+ /// Active when the decl is a function.
+ func: struct {
+ /// Result-id of the OpFunction instruction.
+ result_id: IdResult,
+ },
+ /// Linking information about a global. This index points into the
+ /// SPIR-V module's `globals` array.
+ /// Active when the decl is a variable.
+ global: SpvModule.Global.Index,
+};
+
+/// Maps Zig decl indices to linking SPIR-V linking information.
+pub const DeclLinkMap = std.AutoHashMap(Module.Decl.Index, DeclLink);
/// This structure is used to compile a declaration, and contains all relevant meta-information to deal with that.
pub const DeclGen = struct {
@@ -61,8 +77,8 @@ pub const DeclGen = struct {
/// Note: If the declaration is not a function, this value will be undefined!
liveness: Liveness,
- /// Maps Zig Decl indices to SPIR-V result indices.
- decl_ids: *DeclMap,
+ /// Maps Zig Decl indices to SPIR-V globals.
+ decl_link: *DeclLinkMap,
/// An array of function argument result-ids. Each index corresponds with the
/// function argument of the same index.
@@ -152,7 +168,7 @@ pub const DeclGen = struct {
allocator: Allocator,
module: *Module,
spv: *SpvModule,
- decl_ids: *DeclMap,
+ decl_link: *DeclLinkMap,
) DeclGen {
return .{
.gpa = allocator,
@@ -161,7 +177,7 @@ pub const DeclGen = struct {
.decl_index = undefined,
.air = undefined,
.liveness = undefined,
- .decl_ids = decl_ids,
+ .decl_link = decl_link,
.next_arg_index = undefined,
.current_block_label_id = undefined,
.error_msg = undefined,
@@ -235,7 +251,8 @@ pub const DeclGen = struct {
.function => val.castTag(.function).?.data.owner_decl,
else => unreachable,
};
- return try self.resolveDecl(fn_decl_index);
+ const link = try self.resolveDecl(fn_decl_index);
+ return link.func.result_id;
}
return try self.constant(ty, val);
@@ -246,17 +263,22 @@ pub const DeclGen = struct {
/// Fetch or allocate a result id for decl index. This function also marks the decl as alive.
/// Note: Function does not actually generate the decl.
- fn resolveDecl(self: *DeclGen, decl_index: Module.Decl.Index) !IdResult {
+ fn resolveDecl(self: *DeclGen, decl_index: Module.Decl.Index) !DeclLink {
const decl = self.module.declPtr(decl_index);
self.module.markDeclAlive(decl);
- const entry = try self.decl_ids.getOrPut(decl_index);
- if (entry.found_existing) {
- return entry.value_ptr.*;
- }
+ const entry = try self.decl_link.getOrPut(decl_index);
const result_id = self.spv.allocId();
- entry.value_ptr.* = result_id;
- return result_id;
+
+ if (!entry.found_existing) {
+ if (decl.val.castTag(.function)) |_| {
+ entry.value_ptr.* = .{.func = .{ .result_id = result_id }};
+ } else {
+ entry.value_ptr.* = .{ .global = try self.spv.allocGlobal() };
+ }
+ }
+
+ return entry.value_ptr.*;
}
/// Start a new SPIR-V block, Emits the label of the new block, and stores which
@@ -363,7 +385,7 @@ pub const DeclGen = struct {
// As of yet, there is no vector support in the self-hosted compiler.
.Vector => self.todo("implement arithmeticTypeInfo for Vector", .{}),
// TODO: For which types is this the case?
- else => self.todo("implement arithmeticTypeInfo for {}", .{ty.fmtDebug()}),
+ else => self.todo("implement arithmeticTypeInfo for {}", .{ty.fmt(self.module)}),
};
}
@@ -399,7 +421,7 @@ pub const DeclGen = struct {
try self.spv.sections.types_globals_constants.emit(
self.spv.gpa,
.OpUndef,
- .{ .id_result_type = self.typeId(ty_ref), .id_result = result_id },
+ .{ .id_result_type = self.typeId(ty_ref), .id_result = result_id }
);
return result_id;
}
@@ -423,6 +445,11 @@ pub const DeclGen = struct {
/// If full, its flushed.
partial_word: std.BoundedArray(u8, @sizeOf(Word)) = .{},
+ /// Utility function to get the section that instructions should be lowered to.
+ fn section(self: *@This()) *SpvSection {
+ return &self.dg.spv.globals.section;
+ }
+
/// Flush the partial_word to the members. If the partial_word is not
/// filled, this adds padding bytes (which are undefined).
fn flush(self: *@This()) !void {
@@ -438,6 +465,7 @@ pub const DeclGen = struct {
const word = @bitCast(Word, self.partial_word.buffer);
const result_id = self.dg.spv.allocId();
+ // TODO: Integrate with caching mechanism
try self.dg.spv.emitConstant(self.u32_ty_id, result_id, .{ .uint32 = word });
try self.members.append(.{ .ty = self.u32_ty_ref });
try self.initializers.append(result_id);
@@ -523,10 +551,52 @@ pub const DeclGen = struct {
try self.addBytes(std.mem.asBytes(&int_bits)[0..@intCast(usize, len)]);
}
+ fn addDeclRef(self: *@This(), ty: Type, decl_index: Decl.Index) !void {
+ const dg = self.dg;
+
+ const ty_ref = try self.dg.resolveType(ty, .indirect);
+ const ty_id = dg.typeId(ty_ref);
+
+ const decl = dg.module.declPtr(decl_index);
+ const link = try dg.resolveDecl(decl_index);
+
+ switch (decl.val.tag()) {
+ .function => {
+ // TODO: Properly lower function pointers. For now we are going to hack around it and
+ // just generate an empty pointer. Function pointers are represented by usize for now,
+ // though.
+ try self.addInt(Type.usize, Value.initTag(.zero));
+ return;
+ },
+ .extern_fn => unreachable, // TODO
+ else => {
+ const result_id = dg.spv.allocId();
+ log.debug("addDeclRef {s} = {}", .{ decl.name, result_id.id });
+
+ const global = dg.spv.globalPtr(link.global);
+ try dg.spv.addGlobalDependency(link.global);
+ // TODO: Do we need a storage class cast here?
+ // TODO: We can probably eliminate these casts
+ try dg.spv.globals.section.emitSpecConstantOp(dg.spv.gpa, .OpBitcast, .{
+ .id_result_type = ty_id,
+ .id_result = result_id,
+ .operand = global.result_id,
+ });
+
+ try self.addPtr(ty_ref, result_id);
+ },
+ }
+ }
+
fn lower(self: *@This(), ty: Type, val: Value) !void {
const target = self.dg.getTarget();
const dg = self.dg;
+ if (val.isUndef()) {
+ const size = ty.abiSize(target);
+ return try self.addUndef(size);
+ }
+
switch (ty.zigTypeTag()) {
.Int => try self.addInt(ty, val),
.Bool => try self.addConstBool(val.toBool()),
@@ -558,22 +628,20 @@ pub const DeclGen = struct {
try self.addByte(@intCast(u8, sentinel.toUnsignedInt(target)));
}
},
+ .bytes => {
+ const bytes = val.castTag(.bytes).?.data;
+ try self.addBytes(bytes);
+ },
else => |tag| return dg.todo("indirect array constant with tag {s}", .{@tagName(tag)}),
},
.Pointer => switch (val.tag()) {
.decl_ref_mut => {
- const ptr_ty_ref = try dg.resolveType(ty, .indirect);
- const ptr_id = dg.spv.allocId();
const decl_index = val.castTag(.decl_ref_mut).?.data.decl_index;
- try dg.genDeclRef(ptr_ty_ref, ptr_id, decl_index);
- try self.addPtr(ptr_ty_ref, ptr_id);
+ try self.addDeclRef(ty, decl_index);
},
.decl_ref => {
- const ptr_ty_ref = try dg.resolveType(ty, .indirect);
- const ptr_id = dg.spv.allocId();
const decl_index = val.castTag(.decl_ref).?.data;
- try dg.genDeclRef(ptr_ty_ref, ptr_id, decl_index);
- try self.addPtr(ptr_ty_ref, ptr_id);
+ try self.addDeclRef(ty, decl_index);
},
.slice => {
const slice = val.castTag(.slice).?.data;
@@ -730,22 +798,31 @@ pub const DeclGen = struct {
// - Underaligned pointers. These need to be packed into the word array by using a mixture of
// OpSpecConstantOp instructions such as OpConvertPtrToU, OpBitcast, OpShift, etc.
- log.debug("lowerIndirectConstant: ty = {}, val = {}", .{ ty.fmtDebug(), val.fmtDebug() });
+ assert(storage_class != .Generic and storage_class != .Function);
- const constant_section = &self.spv.sections.types_globals_constants;
+ log.debug("lowerIndirectConstant: ty = {}, val = {}", .{ ty.fmt(self.module), val.fmtDebug() });
+
+ const section = &self.spv.globals.section;
const ty_ref = try self.resolveType(ty, .indirect);
const ptr_ty_ref = try self.spv.ptrType(ty_ref, storage_class, alignment);
+ const target = self.getTarget();
+
if (val.isUndef()) {
// Special case: the entire value is undefined. In this case, we can just
// generate an OpVariable with no initializer.
- try constant_section.emit(self.spv.gpa, .OpVariable, .{
+ return try section.emit(self.spv.gpa, .OpVariable, .{
.id_result_type = self.typeId(ptr_ty_ref),
.id_result = result_id,
.storage_class = storage_class,
});
- return;
+ } else if (ty.abiSize(target) == 0) {
+ // Special case: if the type has no size, then return an undefined pointer.
+ return try section.emit(self.spv.gpa, .OpUndef, .{
+ .id_result_type = self.typeId(ptr_ty_ref),
+ .id_result = result_id,
+ });
}
const u32_ty_ref = try self.intType(.unsigned, 32);
@@ -757,62 +834,42 @@ pub const DeclGen = struct {
.initializers = std.ArrayList(IdRef).init(self.gpa),
};
- try icl.lower(ty, val);
- try icl.flush();
-
defer icl.members.deinit();
defer icl.initializers.deinit();
+ try icl.lower(ty, val);
+ try icl.flush();
+
const constant_struct_ty_ref = try self.spv.simpleStructType(icl.members.items);
const ptr_constant_struct_ty_ref = try self.spv.ptrType(constant_struct_ty_ref, storage_class, alignment);
const constant_struct_id = self.spv.allocId();
- try constant_section.emit(self.spv.gpa, .OpSpecConstantComposite, .{
+ try section.emit(self.spv.gpa, .OpSpecConstantComposite, .{
.id_result_type = self.typeId(constant_struct_ty_ref),
.id_result = constant_struct_id,
.constituents = icl.initializers.items,
});
const var_id = self.spv.allocId();
- switch (storage_class) {
- .Generic => unreachable,
- .Function => {
- try self.func.prologue.emit(self.spv.gpa, .OpVariable, .{
- .id_result_type = self.typeId(ptr_constant_struct_ty_ref),
- .id_result = var_id,
- .storage_class = storage_class,
- .initializer = constant_struct_id,
- });
- // TODO: Set alignment of OpVariable.
-
- try self.func.body.emit(self.spv.gpa, .OpBitcast, .{
- .id_result_type = self.typeId(ptr_ty_ref),
- .id_result = result_id,
- .operand = var_id,
- });
- },
- else => {
- try constant_section.emit(self.spv.gpa, .OpVariable, .{
- .id_result_type = self.typeId(ptr_constant_struct_ty_ref),
- .id_result = var_id,
- .storage_class = storage_class,
- .initializer = constant_struct_id,
- });
- // TODO: Set alignment of OpVariable.
-
- try constant_section.emitSpecConstantOp(self.spv.gpa, .OpBitcast, .{
- .id_result_type = self.typeId(ptr_ty_ref),
- .id_result = result_id,
- .operand = var_id,
- });
- },
- }
+ try section.emit(self.spv.gpa, .OpVariable, .{
+ .id_result_type = self.typeId(ptr_constant_struct_ty_ref),
+ .id_result = var_id,
+ .storage_class = storage_class,
+ .initializer = constant_struct_id,
+ });
+ // TODO: Set alignment of OpVariable.
+ // TODO: We may be able to eliminate this cast.
+ try section.emitSpecConstantOp(self.spv.gpa, .OpBitcast, .{
+ .id_result_type = self.typeId(ptr_ty_ref),
+ .id_result = result_id,
+ .operand = var_id,
+ });
}
/// This function generates a load for a constant in direct (ie, non-memory) representation.
/// When the constant is simple, it can be generated directly using OpConstant instructions. When
/// the constant is more complicated however, it needs to be lowered to an indirect constant, which
- /// is then loaded using OpLoad. Such values are loaded into the Function address space by default.
+ /// is then loaded using OpLoad. Such values are loaded into the UniformConstant storage class by default.
/// This function should only be called during function code generation.
fn constant(self: *DeclGen, ty: Type, val: Value) !IdRef {
const target = self.getTarget();
@@ -846,53 +903,27 @@ pub const DeclGen = struct {
}
},
else => {
- // The value cannot be generated directly, so generate it as an indirect function-local
- // constant, and then perform an OpLoad.
- const ptr_id = self.spv.allocId();
+ // The value cannot be generated directly, so generate it as an indirect constant,
+ // and then perform an OpLoad.
const alignment = ty.abiAlignment(target);
- try self.lowerIndirectConstant(ptr_id, ty, val, .Function, alignment);
+ const global_index = try self.spv.allocGlobal();
+ log.debug("constant {}", .{global_index});
+ const ptr_id = self.spv.beginGlobal(global_index);
+ defer self.spv.endGlobal();
+ try self.lowerIndirectConstant(ptr_id, ty, val, .UniformConstant, alignment);
try self.func.body.emit(self.spv.gpa, .OpLoad, .{
.id_result_type = result_ty_id,
.id_result = result_id,
.pointer = ptr_id,
});
- // TODO: Convert bools? This logic should hook into `load`.
+ // TODO: Convert bools? This logic should hook into `load`. It should be a dead
+ // path though considering .Bool is handled above.
},
}
return result_id;
}
- fn genDeclRef(self: *DeclGen, result_ty_ref: SpvType.Ref, result_id: IdRef, decl_index: Decl.Index) Error!void {
- // TODO: Clean up
- const decl = self.module.declPtr(decl_index);
- self.module.markDeclAlive(decl);
- // _ = result_ty_ref;
- // const decl_id = try self.constant(decl.ty, decl.val, .indirect);
- // try self.variable(.global, result_id, result_ty_ref, decl_id);
- const result_storage_class = self.spv.typeRefType(result_ty_ref).payload(.pointer).storage_class;
- const indirect_result_id = if (result_storage_class != .CrossWorkgroup)
- self.spv.allocId()
- else
- result_id;
-
- try self.lowerIndirectConstant(
- indirect_result_id,
- decl.ty,
- decl.val,
- .CrossWorkgroup, // TODO: Make this .Function if required
- decl.@"align",
- );
- const section = &self.spv.sections.types_globals_constants;
- if (result_storage_class != .CrossWorkgroup) {
- try section.emitSpecConstantOp(self.spv.gpa, .OpPtrCastToGeneric, .{
- .id_result_type = self.typeId(result_ty_ref),
- .id_result = result_id,
- .pointer = indirect_result_id,
- });
- }
- }
-
/// Turn a Zig type into a SPIR-V Type, and return its type result-id.
fn resolveTypeId(self: *DeclGen, ty: Type) !IdResultType {
const type_ref = try self.resolveType(ty, .direct);
@@ -996,7 +1027,7 @@ pub const DeclGen = struct {
/// Turn a Zig type into a SPIR-V Type, and return a reference to it.
fn resolveType(self: *DeclGen, ty: Type, repr: Repr) Error!SpvType.Ref {
- log.debug("resolveType: ty = {}", .{ty.fmtDebug()});
+ log.debug("resolveType: ty = {}", .{ty.fmt(self.module)});
const target = self.getTarget();
switch (ty.zigTypeTag()) {
.Void, .NoReturn => return try self.spv.resolveType(SpvType.initTag(.void)),
@@ -1042,23 +1073,30 @@ pub const DeclGen = struct {
};
return try self.spv.arrayType(total_len, elem_ty_ref);
},
- .Fn => {
- // TODO: Put this somewhere in Sema.zig
- if (ty.fnIsVarArgs())
- return self.fail("VarArgs functions are unsupported for SPIR-V", .{});
+ .Fn => switch (repr) {
+ .direct => {
+ // TODO: Put this somewhere in Sema.zig
+ if (ty.fnIsVarArgs())
+ return self.fail("VarArgs functions are unsupported for SPIR-V", .{});
- // TODO: Parameter passing convention etc.
+ // TODO: Parameter passing convention etc.
- const param_types = try self.spv.arena.alloc(SpvType.Ref, ty.fnParamLen());
- for (param_types, 0..) |*param, i| {
- param.* = try self.resolveType(ty.fnParamType(i), .direct);
- }
+ const param_types = try self.spv.arena.alloc(SpvType.Ref, ty.fnParamLen());
+ for (param_types, 0..) |*param, i| {
+ param.* = try self.resolveType(ty.fnParamType(i), .direct);
+ }
- const return_type = try self.resolveType(ty.fnReturnType(), .direct);
+ const return_type = try self.resolveType(ty.fnReturnType(), .direct);
- const payload = try self.spv.arena.create(SpvType.Payload.Function);
- payload.* = .{ .return_type = return_type, .parameters = param_types };
- return try self.spv.resolveType(SpvType.initPayload(&payload.base));
+ const payload = try self.spv.arena.create(SpvType.Payload.Function);
+ payload.* = .{ .return_type = return_type, .parameters = param_types };
+ return try self.spv.resolveType(SpvType.initPayload(&payload.base));
+ },
+ .indirect => {
+ // TODO: Represent function pointers properly.
+ // For now, just use an usize type.
+ return try self.sizeType();
+ },
},
.Pointer => {
const ptr_info = ty.ptrInfo().data;
@@ -1196,14 +1234,16 @@ pub const DeclGen = struct {
fn genDecl(self: *DeclGen) !void {
const decl = self.module.declPtr(self.decl_index);
- const result_id = try self.resolveDecl(self.decl_index);
+ const link = try self.resolveDecl(self.decl_index);
if (decl.val.castTag(.function)) |_| {
+ log.debug("genDecl function {s} = {}", .{decl.name, link.func.result_id.id});
+
assert(decl.ty.zigTypeTag() == .Fn);
const prototype_id = try self.resolveTypeId(decl.ty);
try self.func.prologue.emit(self.spv.gpa, .OpFunction, .{
.id_result_type = try self.resolveTypeId(decl.ty.fnReturnType()),
- .id_result = result_id,
+ .id_result = link.func.result_id,
.function_control = .{}, // TODO: We can set inline here if the type requires it.
.function_type = prototype_id,
});
@@ -1243,7 +1283,7 @@ pub const DeclGen = struct {
defer self.module.gpa.free(fqn);
try self.spv.sections.debug_names.emit(self.gpa, .OpName, .{
- .target = result_id,
+ .target = link.func.result_id,
.name = fqn,
});
} else {
@@ -1264,9 +1304,13 @@ pub const DeclGen = struct {
else => storage_class,
};
+ const global_result_id = self.spv.beginGlobal(link.global);
+ defer self.spv.endGlobal();
+ log.debug("genDecl {}", .{link.global});
+
const var_result_id = switch (storage_class) {
.Generic => self.spv.allocId(),
- else => result_id,
+ else => global_result_id,
};
try self.lowerIndirectConstant(
@@ -1278,12 +1322,13 @@ pub const DeclGen = struct {
);
if (storage_class == .Generic) {
- const section = &self.spv.sections.types_globals_constants;
+ const section = &self.spv.globals.section;
const ty_ref = try self.resolveType(decl.ty, .indirect);
const ptr_ty_ref = try self.spv.ptrType(ty_ref, storage_class, decl.@"align");
+ // TODO: Can we eliminate this cast?
try section.emitSpecConstantOp(self.spv.gpa, .OpPtrCastToGeneric, .{
.id_result_type = self.typeId(ptr_ty_ref),
- .id_result = result_id,
+ .id_result = global_result_id,
.pointer = var_result_id,
});
}
@@ -1972,6 +2017,7 @@ pub const DeclGen = struct {
.id_result = result_id,
.pointer = alloc_result_id,
}),
+ // TODO: Can we do without this cast or move it to runtime?
else => try section.emitSpecConstantOp(self.spv.gpa, .OpPtrCastToGeneric, .{
.id_result_type = self.typeId(ptr_ty_ref),
.id_result = result_id,
diff --git a/src/codegen/spirv/Module.zig b/src/codegen/spirv/Module.zig
index dc5e8053c1..7501ec5d92 100644
--- a/src/codegen/spirv/Module.zig
+++ b/src/codegen/spirv/Module.zig
@@ -55,6 +55,27 @@ pub const Fn = struct {
}
};
+/// Globals must be kept in order: operations involving globals must be ordered
+/// so that the global declaration precedes any usage.
+pub const Global = struct {
+ /// Index type to refer to a global by.
+ pub const Index = enum(u32) { _ };
+
+ /// The result-id to be used for this global declaration. Note that this does not
+ /// necessarily refer to an OpVariable instruction - it may also be the final result
+ /// id of a number of OpSpecConstantOp instructions.
+ result_id: IdRef,
+ /// The offset into `self.globals.section` of the first instruction of this global
+ /// declaration.
+ begin_inst: u32,
+ /// The past-end offset into `self.flobals.section`.
+ end_inst: u32,
+ /// The first dependency in the `self.globals.dependencies` array list.
+ begin_dep: u32,
+ /// The past-end dependency in `self.globals.dependencies`.
+ end_dep: u32,
+};
+
/// A general-purpose allocator which may be used to allocate resources for this module
gpa: Allocator,
@@ -102,6 +123,20 @@ source_file_names: std.StringHashMapUnmanaged(IdRef) = .{},
/// Note: Uses ArrayHashMap which is insertion ordered, so that we may refer to other types by index (Type.Ref).
type_cache: TypeCache = .{},
+/// The fields in this structure help to maintain the required order for global variables.
+globals: struct {
+ /// The graph nodes of global variables present in the module.
+ nodes: std.ArrayListUnmanaged(Global) = .{},
+ /// This pseudo-section contains the initialization code for all the globals. Instructions from
+ /// here are reordered when flushing the module. Its contents should be part of the
+ /// `types_globals_constants` SPIR-V section.
+ section: Section = .{},
+ /// Holds a list of dependent global variables for each global variable.
+ dependencies: std.ArrayListUnmanaged(Global.Index) = .{},
+ /// The global that initialization code/dependencies are currently being generated for, if any.
+ current_global: ?Global.Index = null,
+} = .{},
+
pub fn init(gpa: Allocator, arena: Allocator) Module {
return .{
.gpa = gpa,
@@ -124,6 +159,10 @@ pub fn deinit(self: *Module) void {
self.source_file_names.deinit(self.gpa);
self.type_cache.deinit(self.gpa);
+ self.globals.nodes.deinit(self.gpa);
+ self.globals.section.deinit(self.gpa);
+ self.globals.dependencies.deinit(self.gpa);
+
self.* = undefined;
}
@@ -141,18 +180,60 @@ pub fn idBound(self: Module) Word {
return self.next_result_id;
}
+fn orderGlobalsInto(
+ self: Module,
+ global_index: Global.Index,
+ section: *Section,
+ seen: *std.DynamicBitSetUnmanaged,
+) !void {
+ const node = self.globals.nodes.items[@enumToInt(global_index)];
+ const deps = self.globals.dependencies.items[node.begin_dep .. node.end_dep];
+ const insts = self.globals.section.instructions.items[node.begin_inst .. node.end_inst];
+
+ seen.set(@enumToInt(global_index));
+
+ for (deps) |dep| {
+ if (!seen.isSet(@enumToInt(dep))) {
+ try self.orderGlobalsInto(dep, section, seen);
+ }
+ }
+
+ try section.instructions.appendSlice(self.gpa, insts);
+}
+
+fn orderGlobals(self: Module) !Section {
+ const nodes = self.globals.nodes.items;
+
+ var seen = try std.DynamicBitSetUnmanaged.initEmpty(self.gpa, nodes.len);
+ defer seen.deinit(self.gpa);
+
+ var ordered_globals = Section{};
+
+ for (0..nodes.len) |global_index| {
+ if (!seen.isSet(global_index)) {
+ try self.orderGlobalsInto(@intToEnum(Global.Index, @intCast(u32, global_index)), &ordered_globals, &seen);
+ }
+ }
+
+ return ordered_globals;
+}
+
/// Emit this module as a spir-v binary.
pub fn flush(self: Module, file: std.fs.File) !void {
// See SPIR-V Spec section 2.3, "Physical Layout of a SPIR-V Module and Instruction"
const header = [_]Word{
spec.magic_number,
- (1 << 16) | (5 << 8),
+ (1 << 16) | (4 << 8), // TODO: From cpu features
0, // TODO: Register Zig compiler magic number.
self.idBound(),
0, // Schema (currently reserved for future use)
};
+ // TODO: Perform topological sort on the globals.
+ var globals = try self.orderGlobals();
+ defer globals.deinit(self.gpa);
+
// Note: needs to be kept in order according to section 2.3!
const buffers = &[_][]const Word{
&header,
@@ -164,6 +245,7 @@ pub fn flush(self: Module, file: std.fs.File) !void {
self.sections.debug_names.toWords(),
self.sections.annotations.toWords(),
self.sections.types_globals_constants.toWords(),
+ globals.toWords(),
self.sections.functions.toWords(),
};
@@ -279,6 +361,8 @@ pub fn emitType(self: *Module, ty: Type) error{OutOfMemory}!IdResultType {
.i64,
.int,
=> {
+ // TODO: Kernels do not support OpTypeInt that is signed. We can probably
+ // can get rid of the signedness all together, in Shaders also.
const bits = ty.intFloatBits();
const signedness: spec.LiteralInteger = switch (ty.intSignedness()) {
.unsigned => 0,
@@ -634,3 +718,44 @@ pub fn decorateMember(
.decoration = decoration,
});
}
+
+pub fn allocGlobal(self: *Module) !Global.Index {
+ try self.globals.nodes.append(self.gpa, .{
+ .result_id = self.allocId(),
+ .begin_inst = undefined,
+ .end_inst = undefined,
+ .begin_dep = undefined,
+ .end_dep = undefined,
+ });
+ return @intToEnum(Global.Index, @intCast(u32, self.globals.nodes.items.len - 1));
+}
+
+pub fn globalPtr(self: *Module, index: Global.Index) *Global {
+ return &self.globals.nodes.items[@enumToInt(index)];
+}
+
+/// Begin generating the global for `index`. The previous global is finalized
+/// at this point, and the global for `index` is made active. Any new calls to
+/// `addGlobalDependency` will affect this global. After a new call to this function,
+/// the prior active global cannot be modified again.
+pub fn beginGlobal(self: *Module, index: Global.Index) IdRef {
+ const global = self.globalPtr(index);
+ global.begin_inst = @intCast(u32, self.globals.section.instructions.items.len);
+ global.begin_dep = @intCast(u32, self.globals.dependencies.items.len);
+ self.globals.current_global = index;
+ return global.result_id;
+}
+
+/// Finalize the global. After this point, the current global cannot be modified anymore.
+pub fn endGlobal(self: *Module) void {
+ const global = self.globalPtr(self.globals.current_global.?);
+ global.end_inst = @intCast(u32, self.globals.section.instructions.items.len);
+ global.end_dep = @intCast(u32, self.globals.dependencies.items.len);
+ self.globals.current_global = null;
+}
+
+pub fn addGlobalDependency(self: *Module, dependency: Global.Index) !void {
+ assert(self.globals.current_global != null);
+ assert(self.globals.current_global.? != dependency);
+ try self.globals.dependencies.append(self.gpa, dependency);
+}