Error or crash when compiling vulkan spir-v shaders on windows

[EtienneParmentier]

Zig Version

0.14.0

Steps to Reproduce and Observed Behavior

Put these files in a directory on Windows. Enter zig build into a terminal, it crashes with a NotOpenForWrite error.

Expected Behavior

There should be no error, as a linux user inside this gist pointed out.

[alexrp]

cc @alichraghi

[igaryhe]

on windows 11, with 0.15.0-dev.552+bc2f7c754 and the following build.zig:

const std = @import("std");

pub fn build(b: *std.Build) void {
    const vulkan12_target = b.resolveTargetQuery(.{
        .cpu_arch = .spirv64,
        .cpu_model = .{ .explicit = &std.Target.spirv.cpu.vulkan_v1_2 },
        .cpu_features_add = std.Target.spirv.featureSet(&.{.int64}),
        .os_tag = .vulkan,
        .ofmt = .spirv,
    });
    const shader = b.addObject(.{
        .name = "shader",
        .root_source_file = b.path("shader.zig"),
        .target = vulkan12_target,
        .optimize = .ReleaseFast,
        .use_llvm = false,
        .use_lld = false,
    });
    b.getInstallStep().dependOn(&b.addInstallFile(shader.getEmittedBin(), "shader").step);
}

(the shader.zig is copied from https://gist.github.com/alichraghi/cc4b1db0a0a556de4f85cf06f0e7a400?permalink_comment_id=5578634#file-zig-shaders-md)
when running zig build, i get the following output:

install
└─ install generated to shader
   └─ zig build-obj shader ReleaseFast spirv64-vulkan 1 errors
error: failed to write: NotOpenForWriting
error: the following command failed with 1 compilation errors:
D:\scoop\apps\zig-dev\0.15.0-dev.552\zig.exe build-obj -fno-llvm -fno-lld -ofmt=spirv -OReleaseFast -target spirv64-vulkan -mcpu vulkan_v1_2+int64 -Mroot=D:\workspace\zig\spirv_test\shader.zig --cache-dir D:\workspace\zig\spirv_test\.zig-cache --global-cache-dir C:\Users\dan\AppData\Local\zig --name shader --zig-lib-dir D:\scoop\apps\zig-dev\0.15.0-dev.552\lib\ --listen=-
Build Summary: 0/3 steps succeeded; 1 failed
install transitive failure
└─ install generated to shader transitive failure
   └─ zig build-obj shader ReleaseFast spirv64-vulkan 1 errors
error: the following build command failed with exit code 1:
D:\workspace\zig\spirv_test\.zig-cache\o\f1fde4ae46da0dfe4860ad5beb821ae8\build.exe D:\scoop\apps\zig-dev\0.15.0-dev.552\zig.exe D:\scoop\apps\zig-dev\0.15.0-dev.552\lib D:\workspace\zig\spirv_test D:\workspace\zig\spirv_test\.zig-cache C:\Users\dan\AppData\Local\zig --seed 0xfd7b3823 -Z92f1552a33fca86

however if i ran the following command manually:

D:\scoop\apps\zig-dev\0.15.0-dev.552\zig.exe build-obj -fno-llvm -fno-lld -ofmt=spirv -OReleaseFast -target spirv64-vulkan -mcpu vulkan_v1_2+int64 -Mroot=D:\workspace\zig\spirv_test\shader.zig --cache-dir D:\workspace\zig\spirv_test\.zig-cache --global-cache-dir C:\Users\dan\AppData\Local\zig --name shader --zig-lib-dir D:\scoop\apps\zig-dev\0.15.0-dev.552\lib\

the compilation seems complete successfully.

searching for "shader.spv" on my disk, it seems all the "shader.spv" under .zig-cache is 0KB:

searching zig codebase, the "NotOpenForWriting" seems like come from

zig/src/link/SpirV.zig

Lines 266 to 268 in cc1475c

	self.base.file.?.writeAll(std.mem.sliceAsBytes(linked_module)) catch |err|
	return diags.fail("failed to write: {s}", .{@errorName(err)});
	}

is this file created at the following lines?

zig/src/link/SpirV.zig

Lines 95 to 98 in cc1475c

	self.base.file = try emit.root_dir.handle.createFile(emit.sub_path, .{
	.truncate = true,
	.read = true,
	});

[nuIIpointerexception]

Fixed in PR #24296

The issue was that the SPIR-V linker was trying to write to an uninitialized file handle. The fix adds:

1. .spirv case to makeWritable() switch in link.zig to properly initialize the file handle
2. Call to makeWritable() before writeAll() in SpirV.zig flush function with proper error handling

SPIR-V shader compilation now works correctly:

zig build-obj shader.zig -target spirv64-vulkan
# Successfully creates shader.spv

[ivanstepanovftw]

Same for tm2.zig

While compiling SPIR-V kernel on Windows, I get the same error: failed to write: NotOpenForWriting. It does compile on Linux though.

Details

PS C:\Users\User\p\tm2.zig.bug> rm -r .zig-cache
PS C:\Users\User\p\tm2.zig.bug> zig build run-test-spirv-autoregression
run-test-spirv-autoregression
└─ run test-spirv-autoregression
   └─ compile exe test-spirv-autoregression Debug native
      └─ compile lib root.spv Debug spirv64-opencl-none 1 errors
error: failed to write: NotOpenForWriting
error: the following command failed with 1 compilation errors:
C:\Users\User\AppData\Roaming\Code\User\globalStorage\ziglang.vscode-zig\zig\x86_64-windows-0.15.0-dev.734+adc4418ba\zig.exe build-lib -fno-llvm -fno-lld -ODebug -target spirv64-opencl-none -mcpu baseline+float16+float64+generic_pointer+int64+vector16 --dep config -Mroot=C:\Users\User\p\tm2.zig.bug\src\root.zig -Mconfig=.zig-cache\c\53c34440202d8a7b0fa42477dc4e02a5\options.zig --cache-dir .zig-cache --global-cache-dir C:\Users\User\AppData\Local\zig --name root.spv -static --zig-lib-dir C:\Users\User\AppData\Roaming\Code\User\globalStorage\ziglang.vscode-zig\zig\x86_64-windows-0.15.0-dev.734+adc4418ba\lib\ --listen=- 
Build Summary: 1/5 steps succeeded; 1 failed
run-test-spirv-autoregression transitive failure
└─ run test-spirv-autoregression transitive failure
   └─ compile exe test-spirv-autoregression Debug native transitive failure
      └─ compile lib root.spv Debug spirv64-opencl-none 1 errors
error: the following build command failed with exit code 1:
.zig-cache\o\150903a7b287d4372bc9894e918ddfbb\build.exe C:\Users\User\AppData\Roaming\Code\User\globalStorage\ziglang.vscode-zig\zig\x86_64-windows-0.15.0-dev.734+adc4418ba\zig.exe C:\Users\User\AppData\Roaming\Code\User\globalStorage\ziglang.vscode-zig\zig\x86_64-windows-0.15.0-dev.734+adc4418ba\lib C:\Users\User\p\tm2.zig.bug .zig-cache C:\Users\User\AppData\Local\zig --seed 0x8a39559 -Z2ac1a6d0f423f408 run-test-spirv-autoregression

Haven't checked the fix.