forked from hexops/mach-dxcompiler
-
Notifications
You must be signed in to change notification settings - Fork 2
/
build.zig
2211 lines (2043 loc) · 113 KB
/
build.zig
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
const std = @import("std");
const builtin = @import("builtin");
const Build = std.Build;
/// The latest binary release available at https://github.com/hexops/mach-dxcompiler/releases
const latest_binary_release = "2024.06.02+6e2c403.1";
/// When building from source, which repository and revision to clone.
const source_repository = "https://github.com/hexops/DirectXShaderCompiler";
const source_revision = "4190bb0c90d374c6b4d0b0f2c7b45b604eda24b6"; // main branch
const log = std.log.scoped(.mach_dxcompiler);
const prefix = "libs/DirectXShaderCompiler";
pub fn build(b: *Build) !void {
const optimize = b.standardOptimizeOption(.{});
const target = b.standardTargetOptions(.{});
const from_source = b.option(bool, "from_source", "Build dxcompiler from source (large C++ codebase)") orelse false;
const debug_symbols = b.option(bool, "debug_symbols", "Whether to produce detailed debug symbols (g0) or not. These increase binary size considerably.") orelse false;
const build_shared = b.option(bool, "shared", "Build dxcompiler shared libraries") orelse false;
const build_spirv = b.option(bool, "spirv", "Build spir-v compilation support") orelse false;
const skip_executables = b.option(bool, "skip_executables", "Skip building executables") orelse false;
const skip_tests = b.option(bool, "skip_tests", "Skip building tests") orelse false;
const machdxcompiler: struct { lib: *std.Build.Step.Compile, lib_path: ?[]const u8 } = blk: {
if (!from_source) {
// We can't express that an std.Build.Module should depend on our DownloadBinaryStep.
// But we can express that an std.Build.Module should link a library, which depends on
// our DownloadBinaryStep.
const linkage = b.addStaticLibrary(.{
.name = "machdxcompiler-linkage",
.optimize = optimize,
.target = target,
});
var download_step = DownloadBinaryStep.init(b, target.result, optimize);
linkage.step.dependOn(&download_step.step);
const cache_dir = binaryCacheDirPath(b, target.result, optimize) catch |err| std.debug.panic("unable to construct binary cache dir path: {}", .{err});
linkage.addLibraryPath(.{ .cwd_relative = cache_dir });
linkage.linkSystemLibrary("machdxcompiler");
linkMachDxcDependenciesModule(&linkage.root_module);
// not entirely sure this will work
if (build_shared)
{
buildShared(b, linkage, optimize, target);
}
break :blk .{ .lib = linkage, .lib_path = cache_dir };
} else {
const lib = b.addStaticLibrary(.{
.name = "machdxcompiler",
.optimize = optimize,
.target = target,
});
b.installArtifact(lib);
// Microsoft does some shit.
lib.root_module.sanitize_c = false;
lib.root_module.sanitize_thread = false; // sometimes in parallel, too.
var download_step = DownloadSourceStep.init(b);
lib.step.dependOn(&download_step.step);
lib.addCSourceFile(.{
.file = b.path("src/mach_dxc.cpp"),
.flags = &.{
"-fms-extensions", // __uuidof and friends (on non-windows targets)
},
});
if (target.result.os.tag != .windows) lib.defineCMacro("HAVE_DLFCN_H", "1");
// The Windows 10 SDK winrt/wrl/client.h is incompatible with clang due to #pragma pack usages
// (unclear why), so instead we use the wrl/client.h headers from https://github.com/ziglang/zig/tree/225fe6ddbfae016395762850e0cd5c51f9e7751c/lib/libc/include/any-windows-any
// which seem to work fine.
if (target.result.os.tag == .windows and target.result.abi == .msvc) lib.addIncludePath(b.path("msvc/"));
var cflags = std.ArrayList([]const u8).init(b.allocator);
var cppflags = std.ArrayList([]const u8).init(b.allocator);
if (!debug_symbols) {
try cflags.append("-g0");
try cppflags.append("-g0");
}
try cppflags.append("-std=c++17");
const base_flags = &.{
"-Wno-unused-command-line-argument",
"-Wno-unused-variable",
"-Wno-missing-exception-spec",
"-Wno-macro-redefined",
"-Wno-unknown-attributes",
"-Wno-implicit-fallthrough",
"-fms-extensions", // __uuidof and friends (on non-windows targets)
};
try cflags.appendSlice(base_flags);
try cppflags.appendSlice(base_flags);
addConfigHeaders(b, lib);
addIncludes(b, lib);
const cpp_sources =
tools_clang_lib_lex_sources ++
tools_clang_lib_basic_sources ++
tools_clang_lib_driver_sources ++
tools_clang_lib_analysis_sources ++
tools_clang_lib_index_sources ++
tools_clang_lib_parse_sources ++
tools_clang_lib_ast_sources ++
tools_clang_lib_edit_sources ++
tools_clang_lib_sema_sources ++
tools_clang_lib_codegen_sources ++
tools_clang_lib_astmatchers_sources ++
tools_clang_lib_tooling_core_sources ++
tools_clang_lib_tooling_sources ++
tools_clang_lib_format_sources ++
tools_clang_lib_rewrite_sources ++
tools_clang_lib_frontend_sources ++
tools_clang_tools_libclang_sources ++
tools_clang_tools_dxcompiler_sources ++
lib_bitcode_reader_sources ++
lib_bitcode_writer_sources ++
lib_ir_sources ++
lib_irreader_sources ++
lib_linker_sources ++
lib_asmparser_sources ++
lib_analysis_sources ++
lib_mssupport_sources ++
lib_transforms_utils_sources ++
lib_transforms_instcombine_sources ++
lib_transforms_ipo_sources ++
lib_transforms_scalar_sources ++
lib_transforms_vectorize_sources ++
lib_target_sources ++
lib_profiledata_sources ++
lib_option_sources ++
lib_passprinters_sources ++
lib_passes_sources ++
lib_hlsl_sources ++
lib_support_cpp_sources ++
lib_dxcsupport_sources ++
lib_dxcbindingtable_sources ++
lib_dxil_sources ++
lib_dxilcontainer_sources ++
lib_dxilpixpasses_sources ++
lib_dxilcompression_cpp_sources ++
lib_dxilrootsignature_sources;
const c_sources =
lib_support_c_sources ++
lib_dxilcompression_c_sources;
// Link lazy-loaded SPIRV-Tools
if (build_spirv)
{
lib.defineCMacro("ENABLE_SPIRV_CODEGEN", "");
addSPIRVIncludes(b, lib);
// Add clang SPIRV tooling sources
lib.addCSourceFiles(.{
.files = &lib_spirv,
.flags = cppflags.items,
});
if (b.lazyDependency("spirv-tools", .{
.target = target,
.optimize = optimize,
})) |dep| lib.linkLibrary(dep.artifact("spirv-opt"));
}
lib.addCSourceFiles(.{
.files = &cpp_sources,
.flags = cppflags.items,
});
lib.addCSourceFiles(.{
.files = &c_sources,
.flags = cflags.items,
});
if (target.result.abi != .msvc) lib.defineCMacro("NDEBUG", ""); // disable assertions
if (target.result.os.tag == .windows) {
lib.defineCMacro("LLVM_ON_WIN32", "1");
if (target.result.abi == .msvc) lib.defineCMacro("CINDEX_LINKAGE", "");
lib.linkSystemLibrary("version");
} else {
lib.defineCMacro("LLVM_ON_UNIX", "1");
}
if (build_shared) {
lib.defineCMacro("MACH_DXC_C_SHARED_LIBRARY", "");
lib.defineCMacro("MACH_DXC_C_IMPLEMENTATION", "");
}
linkMachDxcDependencies(lib);
lib.addIncludePath(b.path("src"));
// TODO: investigate SSE2 #define / cmake option for CPU target
//
// TODO: investigate how projects/dxilconv/lib/DxbcConverter/DxbcConverterImpl.h is getting pulled
// in, we can get rid of dxbc conversion presumably
if (!skip_executables)
{
// dxc.exe builds
const dxc_exe = b.addExecutable(.{
.name = "dxc",
.optimize = optimize,
.target = target,
});
const install_dxc_step = b.step("dxc", "Build and install dxc.exe");
install_dxc_step.dependOn(&b.addInstallArtifact(dxc_exe, .{}).step);
dxc_exe.addCSourceFile(.{
.file = b.path(prefix ++ "/tools/clang/tools/dxc/dxcmain.cpp"),
.flags = &.{"-std=c++17"},
});
dxc_exe.defineCMacro("NDEBUG", ""); // disable assertions
if (target.result.os.tag != .windows) dxc_exe.defineCMacro("HAVE_DLFCN_H", "1");
dxc_exe.addIncludePath(b.path(prefix ++ "/tools/clang/tools"));
dxc_exe.addIncludePath(b.path(prefix ++ "/include"));
addConfigHeaders(b, dxc_exe);
addIncludes(b, dxc_exe);
dxc_exe.addCSourceFile(.{
.file = b.path(prefix ++ "/tools/clang/tools/dxclib/dxc.cpp"),
.flags = cppflags.items,
});
b.installArtifact(dxc_exe);
dxc_exe.linkLibrary(lib);
if (target.result.os.tag == .windows) {
// windows must be built with LTO disabled due to:
// https://github.com/ziglang/zig/issues/15958
dxc_exe.want_lto = false;
if (builtin.os.tag == .windows and target.result.abi == .msvc) {
const msvc_lib_dir: ?[]const u8 = try @import("msvc.zig").MsvcLibDir.find(b.allocator);
// The MSVC lib dir looks like this:
// C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.38.33130\Lib\x64
// But we need the atlmfc lib dir:
// C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.38.33130\atlmfc\lib\x64
const msvc_dir = try std.fs.path.resolve(b.allocator, &.{ msvc_lib_dir.?, "..\\.." });
const lib_dir_path = try std.mem.concat(b.allocator, u8, &.{
msvc_dir,
"\\atlmfc\\lib\\",
if (target.result.cpu.arch == .aarch64) "arm64" else "x64",
});
const lib_path = try std.mem.concat(b.allocator, u8, &.{ lib_dir_path, "\\atls.lib" });
const pdb_name = if (target.result.cpu.arch == .aarch64)
"atls.arm64.pdb"
else
"atls.amd64.pdb";
const pdb_path = try std.mem.concat(b.allocator, u8, &.{ lib_dir_path, "\\", pdb_name });
// For some reason, msvc target needs atls.lib to be in the 'zig build' working directory.
// Addomg tp the library path like this has no effect:
dxc_exe.addLibraryPath(b.path(lib_dir_path));
// So instead we must copy the lib into this directory:
try std.fs.cwd().copyFile(lib_path, std.fs.cwd(), "atls.lib", .{});
try std.fs.cwd().copyFile(pdb_path, std.fs.cwd(), pdb_name, .{});
// This is probably a bug in the Zig linker.
}
}
}
if (build_shared) buildShared(b, lib, optimize, target);
break :blk .{ .lib = lib, .lib_path = null };
}
};
if (skip_executables)
return;
// Zig bindings
const mach_dxcompiler = b.addModule("mach-dxcompiler", .{
.root_source_file = b.path("src/main.zig"),
.target = target,
.optimize = optimize,
});
mach_dxcompiler.addIncludePath(b.path("src"));
mach_dxcompiler.linkLibrary(machdxcompiler.lib);
if (machdxcompiler.lib_path) |p| mach_dxcompiler.addLibraryPath(.{ .cwd_relative = p });
if (skip_tests)
return;
const main_tests = b.addTest(.{
.name = "dxcompiler-tests",
.root_source_file = b.path("src/main.zig"),
.target = target,
.optimize = optimize,
});
main_tests.addIncludePath(b.path("src"));
main_tests.linkLibrary(machdxcompiler.lib);
if (machdxcompiler.lib_path) |p| main_tests.addLibraryPath(.{ .cwd_relative = p });
b.installArtifact(main_tests);
const test_step = b.step("test", "Run library tests");
test_step.dependOn(&b.addRunArtifact(main_tests).step);
}
fn buildShared(b: *Build, lib: *Build.Step.Compile, optimize: std.builtin.OptimizeMode, target: std.Build.ResolvedTarget) void
{
const sharedlib = b.addSharedLibrary(.{
.name = "machdxcompiler",
.optimize = optimize,
.target = target,
});
sharedlib.addCSourceFile(.{
.file = b.path("src/shared_main.cpp"),
.flags = &.{ "-std=c++17" },
});
const shared_install_step = b.step("machdxcompiler", "Build and install the machdxcompiler shared library");
shared_install_step.dependOn(&b.addInstallArtifact(sharedlib, .{}).step);
b.installArtifact(sharedlib);
sharedlib.linkLibrary(lib);
}
fn linkMachDxcDependencies(step: *std.Build.Step.Compile) void {
const target = step.rootModuleTarget();
if (target.abi == .msvc) {
// https://github.com/ziglang/zig/issues/5312
step.linkLibC();
} else step.linkLibCpp();
if (target.os.tag == .windows) {
step.linkSystemLibrary("ole32");
step.linkSystemLibrary("oleaut32");
}
}
fn linkMachDxcDependenciesModule(mod: *std.Build.Module) void {
const target = mod.resolved_target.?.result;
if (target.abi == .msvc) {
// https://github.com/ziglang/zig/issues/5312
mod.link_libc = true;
} else {
mod.link_libcpp = true;
}
if (target.os.tag == .windows) {
mod.linkSystemLibrary("ole32", .{});
mod.linkSystemLibrary("oleaut32", .{});
}
}
fn addConfigHeaders(b: *Build, step: *std.Build.Step.Compile) void {
// /tools/clang/include/clang/Config/config.h.cmake
step.addConfigHeader(b.addConfigHeader(
.{
.style = .{ .cmake = b.path("config-headers/tools/clang/include/clang/Config/config.h.cmake") },
.include_path = "clang/Config/config.h",
},
.{
.BUG_REPORT_URL = "",
.CLANG_DEFAULT_OPENMP_RUNTIME = "",
.CLANG_LIBDIR_SUFFIX = "",
.CLANG_RESOURCE_DIR = "",
.C_INCLUDE_DIRS = "",
.DEFAULT_SYSROOT = "",
.GCC_INSTALL_PREFIX = "",
.CLANG_HAVE_LIBXML = 0,
.BACKEND_PACKAGE_STRING = "",
.HOST_LINK_VERSION = "",
},
));
// /include/llvm/Config/AsmParsers.def.in
step.addConfigHeader(b.addConfigHeader(
.{
.style = .{ .cmake = b.path("config-headers/include/llvm/Config/AsmParsers.def.in") },
.include_path = "llvm/Config/AsmParsers.def",
},
.{
.LLVM_ENUM_ASM_PARSERS = ""
},
));
// /include/llvm/Config/Disassemblers.def.in
step.addConfigHeader(b.addConfigHeader(
.{
.style = .{ .cmake = b.path("config-headers/include/llvm/Config/Disassemblers.def.in") },
.include_path = "llvm/Config/Disassemblers.def",
},
.{
.LLVM_ENUM_DISASSEMBLERS = "",
},
));
// /include/llvm/Config/Targets.def.in
step.addConfigHeader(b.addConfigHeader(
.{
.style = .{ .cmake = b.path("config-headers/include/llvm/Config/Targets.def.in") },
.include_path = "llvm/Config/Targets.def",
},
.{
.LLVM_ENUM_TARGETS = "",
},
));
// /include/llvm/Config/AsmPrinters.def.in
step.addConfigHeader(b.addConfigHeader(
.{
.style = .{ .cmake = b.path("config-headers/include/llvm/Config/AsmPrinters.def.in") },
.include_path = "llvm/Config/AsmPrinters.def",
},
.{
.LLVM_ENUM_ASM_PRINTERS = "",
},
));
// /include/llvm/Support/DataTypes.h.cmake
step.addConfigHeader(b.addConfigHeader(
.{
.style = .{ .cmake = b.path("config-headers/include/llvm/Support/DataTypes.h.cmake") },
.include_path = "llvm/Support/DataTypes.h",
},
.{
.HAVE_INTTYPES_H = 1,
.HAVE_STDINT_H = 1,
.HAVE_UINT64_T = 1,
.HAVE_U_INT64_T = 0,
},
));
// /include/llvm/Config/abi-breaking.h.cmake
step.addConfigHeader(b.addConfigHeader(
.{
.style = .{ .cmake = b.path("config-headers/include/llvm/Config/abi-breaking.h.cmake") },
.include_path = "llvm/Config/abi-breaking.h",
},
.{},
));
const target = step.rootModuleTarget();
step.addConfigHeader(addConfigHeaderLLVMConfig(b, target, .llvm_config_h));
step.addConfigHeader(addConfigHeaderLLVMConfig(b, target, .config_h));
// /include/dxc/config.h.cmake
step.addConfigHeader(b.addConfigHeader(
.{
.style = .{ .cmake = b.path("config-headers/include/dxc/config.h.cmake") },
.include_path = "dxc/config.h",
},
.{
.DXC_DISABLE_ALLOCATOR_OVERRIDES = false,
},
));
}
fn addIncludes(b: *Build, step: *std.Build.Step.Compile) void {
// TODO: replace unofficial external/DIA submodule with something else (or eliminate dep on it)
step.addIncludePath(b.path(prefix ++ "/external/DIA/include"));
// TODO: replace generated-include with logic to actually generate this code
step.addIncludePath(b.path("generated-include/"));
step.addIncludePath(b.path(prefix ++ "/tools/clang/include"));
step.addIncludePath(b.path(prefix ++ "/include"));
step.addIncludePath(b.path(prefix ++ "/include/llvm"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/llvm_assert"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/Bitcode"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/IR"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/IRReader"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/Linker"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/Analysis"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/Transforms"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/Transforms/Utils"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/Transforms/InstCombine"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/Transforms/IPO"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/Transforms/Scalar"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/Transforms/Vectorize"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/Target"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/ProfileData"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/Option"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/PassPrinters"));
step.addIncludePath(b.path(prefix ++ "/include/llvm/Passes"));
step.addIncludePath(b.path(prefix ++ "/include/dxc"));
step.addIncludePath(b.path(prefix ++ "/external/DirectX-Headers/include/directx"));
const target = step.rootModuleTarget();
if (target.os.tag != .windows) step.addIncludePath(b.path(prefix ++ "/external/DirectX-Headers/include/wsl/stubs"));
}
fn addSPIRVIncludes(b: *Build, step: *std.Build.Step.Compile) void
{
step.addIncludePath(b.path(prefix ++ "/external/SPIRV-Tools"));
step.addIncludePath(b.path(prefix ++ "/external/SPIRV-Tools/include"));
step.addIncludePath(b.path(prefix ++ "/external/SPIRV-Tools/source"));
step.addIncludePath(b.path(prefix ++ "/external/SPIRV-Headers/include"));
}
// /include/llvm/Config/llvm-config.h.cmake
// /include/llvm/Config/config.h.cmake (derives llvm-config.h.cmake)
fn addConfigHeaderLLVMConfig(b: *Build, target: std.Target, which: anytype) *std.Build.Step.ConfigHeader {
// Note: LLVM_HOST_TRIPLEs can be found by running $ llc --version | grep Default
// Note: arm64 is an alias for aarch64, we always use aarch64 over arm64.
const cross_platform = .{
.LLVM_PREFIX = "/usr/local",
.LLVM_DEFAULT_TARGET_TRIPLE = "dxil-ms-dx",
.LLVM_ENABLE_THREADS = 1,
.LLVM_HAS_ATOMICS = 1,
.LLVM_VERSION_MAJOR = 3,
.LLVM_VERSION_MINOR = 7,
.LLVM_VERSION_PATCH = 0,
.PACKAGE_VERSION = "3.7-v1.4.0.2274-1812-machdxcompiler",
.LLVM_BINDIR = "",
.LLVM_CONFIGTIME = "",
.LLVM_DATADIR = "",
.LLVM_DOCSDIR = "",
.LLVM_ETCDIR = "",
.LLVM_INCLUDEDIR = "",
.LLVM_INFODIR = "",
.LLVM_MANDIR = "",
.LLVM_NATIVE_ARCH = ""
};
const LLVMConfigH = struct {
LLVM_HOST_TRIPLE: []const u8,
LLVM_ON_WIN32: ?i64 = null,
LLVM_ON_UNIX: ?i64 = null,
HAVE_SYS_MMAN_H: ?i64 = null,
};
const llvm_config_h = blk: {
if (target.os.tag == .windows) {
break :blk switch (target.abi) {
.msvc => switch (target.cpu.arch) {
.x86_64 => merge(cross_platform, LLVMConfigH{
.LLVM_HOST_TRIPLE = "x86_64-w64-msvc",
.LLVM_ON_WIN32 = 1,
}),
.aarch64 => merge(cross_platform, LLVMConfigH{
.LLVM_HOST_TRIPLE = "aarch64-w64-msvc",
.LLVM_ON_WIN32 = 1,
}),
else => @panic("target architecture not supported"),
},
.gnu => switch (target.cpu.arch) {
.x86_64 => merge(cross_platform, LLVMConfigH{
.LLVM_HOST_TRIPLE = "x86_64-w64-mingw32",
.LLVM_ON_WIN32 = 1,
}),
.aarch64 => merge(cross_platform, LLVMConfigH{
.LLVM_HOST_TRIPLE = "aarch64-w64-mingw32",
.LLVM_ON_WIN32 = 1,
}),
else => @panic("target architecture not supported"),
},
else => @panic("target ABI not supported"),
};
} else if (target.os.tag.isDarwin()) {
break :blk switch (target.cpu.arch) {
.aarch64 => merge(cross_platform, LLVMConfigH{
.LLVM_HOST_TRIPLE = "aarch64-apple-darwin",
.LLVM_ON_UNIX = 1,
.HAVE_SYS_MMAN_H = 1,
}),
.x86_64 => merge(cross_platform, LLVMConfigH{
.LLVM_HOST_TRIPLE = "x86_64-apple-darwin",
.LLVM_ON_UNIX = 1,
.HAVE_SYS_MMAN_H = 1,
}),
else => @panic("target architecture not supported"),
};
} else {
// Assume linux-like
// TODO: musl support?
break :blk switch (target.cpu.arch) {
.aarch64 => merge(cross_platform, LLVMConfigH{
.LLVM_HOST_TRIPLE = "aarch64-linux-gnu",
.LLVM_ON_UNIX = 1,
.HAVE_SYS_MMAN_H = 1,
}),
.x86_64 => merge(cross_platform, LLVMConfigH{
.LLVM_HOST_TRIPLE = "x86_64-linux-gnu",
.LLVM_ON_UNIX = 1,
.HAVE_SYS_MMAN_H = 1,
}),
else => @panic("target architecture not supported"),
};
}
};
const tag = target.os.tag;
const if_windows: ?i64 = if (tag == .windows) 1 else null;
const if_not_windows: ?i64 = if (tag == .windows) null else 1;
const if_windows_or_linux: ?i64 = if (tag == .windows and !tag.isDarwin()) 1 else null;
const if_darwin: ?i64 = if (tag.isDarwin()) 1 else null;
const if_not_msvc: ?i64 = if (target.abi != .msvc) 1 else null;
const config_h = merge(llvm_config_h, .{
.HAVE_STRERROR = if_windows,
.HAVE_STRERROR_R = if_not_windows,
.HAVE_MALLOC_H = if_windows_or_linux,
.HAVE_MALLOC_MALLOC_H = if_darwin,
.HAVE_MALLOC_ZONE_STATISTICS = if_not_windows,
.HAVE_GETPAGESIZE = if_not_windows,
.HAVE_PTHREAD_H = if_not_windows,
.HAVE_PTHREAD_GETSPECIFIC = if_not_windows,
.HAVE_PTHREAD_MUTEX_LOCK = if_not_windows,
.HAVE_PTHREAD_RWLOCK_INIT = if_not_windows,
.HAVE_DLOPEN = if_not_windows,
.HAVE_DLFCN_H = if_not_windows, //
.HAVE_UNISTD_H = if_not_msvc,
.BUG_REPORT_URL = "http://llvm.org/bugs/",
.ENABLE_BACKTRACES = 0,
.ENABLE_CRASH_OVERRIDES = 0,
.DISABLE_LLVM_DYLIB_ATEXIT = 0,
.ENABLE_PIC = 0,
.ENABLE_TIMESTAMPS = 1,
.HAVE_CLOSEDIR = 1,
.HAVE_CXXABI_H = 1,
.HAVE_DECL_STRERROR_S = 1,
.HAVE_DIRENT_H = 1,
.HAVE_ERRNO_H = 1,
.HAVE_FCNTL_H = 1,
.HAVE_FENV_H = 1,
.HAVE_GETCWD = 1,
.HAVE_GETTIMEOFDAY = 1,
.HAVE_INT64_T = 1,
.HAVE_INTTYPES_H = 1,
.HAVE_ISATTY = 1,
.HAVE_LIBPSAPI = 1,
.HAVE_LIBSHELL32 = 1,
.HAVE_LIMITS_H = 1,
.HAVE_LINK_EXPORT_DYNAMIC = 1,
.HAVE_MKSTEMP = 1,
.HAVE_MKTEMP = 1,
.HAVE_OPENDIR = 1,
.HAVE_READDIR = 1,
.HAVE_SIGNAL_H = 1,
.HAVE_STDINT_H = 1,
.HAVE_STRTOLL = 1,
.HAVE_SYS_PARAM_H = 1,
.HAVE_SYS_STAT_H = 1,
.HAVE_SYS_TIME_H = 1,
.HAVE_UINT64_T = 1,
.HAVE_UTIME_H = 1,
.HAVE__ALLOCA = 1,
.HAVE___ASHLDI3 = 1,
.HAVE___ASHRDI3 = 1,
.HAVE___CMPDI2 = 1,
.HAVE___DIVDI3 = 1,
.HAVE___FIXDFDI = 1,
.HAVE___FIXSFDI = 1,
.HAVE___FLOATDIDF = 1,
.HAVE___LSHRDI3 = 1,
.HAVE___MAIN = 1,
.HAVE___MODDI3 = 1,
.HAVE___UDIVDI3 = 1,
.HAVE___UMODDI3 = 1,
.HAVE____CHKSTK_MS = 1,
.LLVM_ENABLE_ZLIB = 0,
.PACKAGE_BUGREPORT = "http://llvm.org/bugs/",
.PACKAGE_NAME = "LLVM",
.PACKAGE_STRING = "LLVM 3.7-v1.4.0.2274-1812-g84da60c6c-dirty",
.RETSIGTYPE = "void",
.WIN32_ELMCB_PCSTR = "PCSTR",
.HAVE__CHSIZE_S = 1,
.HAVE_DECL_ARC4RANDOM = 0,
.HAVE_BACKTRACE = 0,
.HAVE_DIA_SDK = 0,
.HAVE_DLERROR = 0,
.HAVE_EXECINFO_H = 0,
.HAVE_FFI_CALL = 0,
.HAVE_FFI_FFI_H = 0,
.HAVE_FFI_H = 0,
.HAVE_FUTIMES = 0,
.HAVE_FUTIMENS = 0,
.HAVE_GETRLIMIT = 0,
.HAVE_GETRUSAGE = 0,
.HAVE_LIBDL = 0,
.HAVE_LIBPTHREAD = 0,
.HAVE_LIBZ = 0,
.HAVE_LIBEDIT = 0,
.HAVE_LINK_H = 0,
.HAVE_LONGJMP = 0,
.HAVE_MACH_MACH_H = 0,
.HAVE_MACH_O_DYLD_H = 0,
.HAVE_MALLINFO = 0,
.HAVE_MALLINFO2 = 0,
.HAVE_MALLCTL = 0,
.HAVE_MKDTEMP = 0,
.HAVE_NDIR_H = 0,
.HAVE_POSIX_SPAWN = 0,
.HAVE_PREAD = 0,
.HAVE_RAND48 = 0,
.HAVE_REALPATH = 0,
.HAVE_SBRK = 0,
.HAVE_SETENV = 0,
.HAVE_SETJMP = 0,
.HAVE_SETRLIMIT = 0,
.HAVE_SIGLONGJMP = 0,
.HAVE_SIGSETJMP = 0,
.HAVE_SYS_DIR_H = 0,
.HAVE_STRDUP = 0,
.HAVE_STRTOQ = 0,
.HAVE_SYS_IOCTL_H = 0,
.HAVE_SYS_NDIR_H = 0,
.HAVE_SYS_RESOURCE_H = 0,
.HAVE_SYS_TYPES_H = 0,
.HAVE_SYS_UIO_H = 0,
.HAVE_SYS_WAIT_H = 0,
.HAVE_TERMINFO = 0,
.HAVE_TERMIOS_H = 0,
.HAVE_U_INT64_T = 0,
.HAVE_VALGRIND_VALGRIND_H = 0,
.HAVE_WRITEV = 0,
.HAVE_ZLIB_H = 0,
.HAVE___ALLOCA = 0,
.HAVE___CHKSTK = 0,
.HAVE___CHKSTK_MS = 0,
.HAVE____CHKSTK = 0,
.LTDL_DLOPEN_DEPLIBS = 0,
.LTDL_SHLIB_EXT = "",
.LTDL_SYSSEARCHPATH = "",
.strtoll = "",
.strtoull = "",
.stricmp = "",
.strdup = "",
});
return switch (which) {
.llvm_config_h => b.addConfigHeader(.{
.style = .{ .cmake = b.path("config-headers/include/llvm/Config/llvm-config.h.cmake") },
.include_path = "llvm/Config/llvm-config.h",
}, llvm_config_h),
.config_h => b.addConfigHeader(.{
.style = .{ .cmake = b.path("config-headers/include/llvm/Config/config.h.cmake") },
.include_path = "llvm/Config/config.h",
}, config_h),
else => unreachable,
};
}
fn ensureCommandExists(allocator: std.mem.Allocator, name: []const u8, exist_check: []const u8) bool
{
const result = std.process.Child.run(.{
.allocator = allocator,
.argv = &[_][]const u8{ name, exist_check },
.cwd = ".",
})
catch // e.g. FileNotFound
{
return false;
};
defer
{
allocator.free(result.stderr);
allocator.free(result.stdout);
}
if (result.term.Exited != 0)
return false;
return true;
}
// ------------------------------------------
// Source cloning logic
// ------------------------------------------
fn ensureGitRepoCloned(allocator: std.mem.Allocator, clone_url: []const u8, revision: []const u8, dir: []const u8) !void
{
if (isEnvVarTruthy(allocator, "NO_ENSURE_SUBMODULES") or isEnvVarTruthy(allocator, "NO_ENSURE_GIT")) {
return;
}
ensureGit(allocator);
if (std.fs.openDirAbsolute(dir, .{})) |_| {
const current_revision = try getCurrentGitRevision(allocator, dir);
if (!std.mem.eql(u8, current_revision, revision)) {
// Reset to the desired revision
exec(allocator, &[_][]const u8{ "git", "fetch" }, dir) catch |err| log.warn("failed to 'git fetch' in {s}: {s}\n", .{ dir, @errorName(err) });
try exec(allocator, &[_][]const u8{ "git", "checkout", "--quiet", "--force", revision }, dir);
try exec(allocator, &[_][]const u8{ "git", "submodule", "update", "--init", "--recursive" }, dir);
}
return;
} else |err| return switch (err) {
error.FileNotFound => {
log.info("cloning required dependency..\ngit clone {s} {s}..\n", .{ clone_url, dir });
try exec(allocator, &[_][]const u8{ "git", "clone", "-c", "core.longpaths=true", clone_url, dir }, sdkPath("/"));
try exec(allocator, &[_][]const u8{ "git", "checkout", "--quiet", "--force", revision }, dir);
try exec(allocator, &[_][]const u8{ "git", "submodule", "update", "--init", "--recursive" }, dir);
return;
},
else => err,
};
}
fn getCurrentGitRevision(allocator: std.mem.Allocator, cwd: []const u8) ![]const u8 {
const result = try std.process.Child.run(.{ .allocator = allocator, .argv = &.{ "git", "rev-parse", "HEAD" }, .cwd = cwd });
allocator.free(result.stderr);
if (result.stdout.len > 0) return result.stdout[0 .. result.stdout.len - 1]; // trim newline
return result.stdout;
}
// Command validation logic moved to ensureCommandExists()
fn ensureGit(allocator: std.mem.Allocator) void
{
if (!ensureCommandExists(allocator, "git", "--version"))
{
log.err("'git --version' failed. Is git not installed?", .{});
std.process.exit(1);
}
}
fn exec(allocator: std.mem.Allocator, argv: []const []const u8, cwd: []const u8) !void {
log.info("cd {s}", .{cwd});
var buf = std.ArrayList(u8).init(allocator);
for (argv) |arg| {
try std.fmt.format(buf.writer(), "{s} ", .{arg});
}
log.info("{s}", .{buf.items});
var child = std.process.Child.init(argv, allocator);
child.cwd = cwd;
_ = try child.spawnAndWait();
}
fn isEnvVarTruthy(allocator: std.mem.Allocator, name: []const u8) bool {
if (std.process.getEnvVarOwned(allocator, name)) |truthy| {
defer allocator.free(truthy);
if (std.mem.eql(u8, truthy, "true")) return true;
return false;
} else |_| {
return false;
}
}
// Merge struct types A and B
fn Merge(comptime a: type, comptime b: type) type {
const a_fields = @typeInfo(a).Struct.fields;
const b_fields = @typeInfo(b).Struct.fields;
return @Type(std.builtin.Type{
.Struct = .{
.layout = .auto,
.fields = a_fields ++ b_fields,
.decls = &.{},
.is_tuple = false,
},
});
}
// Merge struct values A and B
fn merge(a: anytype, b: anytype) Merge(@TypeOf(a), @TypeOf(b)) {
var merged: Merge(@TypeOf(a), @TypeOf(b)) = undefined;
inline for (@typeInfo(@TypeOf(merged)).Struct.fields) |f| {
if (@hasField(@TypeOf(a), f.name)) @field(merged, f.name) = @field(a, f.name);
if (@hasField(@TypeOf(b), f.name)) @field(merged, f.name) = @field(b, f.name);
}
return merged;
}
fn sdkPath(comptime suffix: []const u8) []const u8 {
if (suffix[0] != '/') @compileError("suffix must be an absolute path");
return comptime blk: {
const root_dir = std.fs.path.dirname(@src().file) orelse ".";
break :blk root_dir ++ suffix;
};
}
const DownloadSourceStep = struct {
step: std.Build.Step,
b: *std.Build,
fn init(b: *std.Build) *DownloadSourceStep {
const download_step = b.allocator.create(DownloadSourceStep) catch unreachable;
download_step.* = .{
.step = std.Build.Step.init(.{
.id = .custom,
.name = "download github.com/hexops/DirectXShaderCompiler source",
.owner = b,
.makeFn = &make,
}),
.b = b,
};
return download_step;
}
fn make(step_ptr: *std.Build.Step, prog_node: std.Progress.Node) anyerror!void {
_ = prog_node;
const download_step: *DownloadSourceStep = @fieldParentPtr("step", step_ptr);
const b = download_step.b;
// Zig will run build steps in parallel if possible, so if there were two invocations of
// then this function would be called in parallel. We're manipulating the FS here
// and so need to prevent that.
download_mutex.lock();
defer download_mutex.unlock();
try ensureGitRepoCloned(b.allocator, source_repository, source_revision, sdkPath("/libs/DirectXShaderCompiler"));
}
};
// ------------------------------------------
// Binary download logic
// ------------------------------------------
const project_name = "dxcompiler";
var download_mutex = std.Thread.Mutex{};
fn binaryZigTriple(arena: std.mem.Allocator, target: std.Target) ![]const u8 {
// Craft a zig_triple string that we will use to create the binary download URL. Remove OS
// version range / glibc version from triple, as we don't include that in our download URL.
var binary_target = std.zig.CrossTarget.fromTarget(target);
binary_target.os_version_min = .{ .none = undefined };
binary_target.os_version_max = .{ .none = undefined };
binary_target.glibc_version = null;
return try binary_target.zigTriple(arena);
}
fn binaryOptimizeMode(optimize: std.builtin.OptimizeMode) []const u8 {
return switch (optimize) {
.Debug => "Debug",
// All Release* are mapped to ReleaseFast, as we only provide ReleaseFast and Debug binaries.
.ReleaseSafe => "ReleaseFast",
.ReleaseFast => "ReleaseFast",
.ReleaseSmall => "ReleaseFast",
};
}
fn binaryCacheDirPath(b: *std.Build, target: std.Target, optimize: std.builtin.OptimizeMode) ![]const u8 {
// Global Mach project cache directory, e.g. $HOME/.cache/zig/mach/<project_name>
// TODO: remove this once https://github.com/ziglang/zig/issues/16149 is fixed.
const global_cache_root = if (@hasField(std.Build, "graph")) b.graph.global_cache_root else b.global_cache_root;
const project_cache_dir_rel = try global_cache_root.join(b.allocator, &.{ "mach", project_name });
// Release-specific cache directory, e.g. $HOME/.cache/zig/mach/<project_name>/<latest_binary_release>/<zig_triple>/<optimize>
// where we will download the binary release to.
return try std.fs.path.join(b.allocator, &.{
project_cache_dir_rel,
latest_binary_release,
try binaryZigTriple(b.allocator, target),
binaryOptimizeMode(optimize),
});
}
const DownloadBinaryStep = struct {
target: std.Target,
optimize: std.builtin.OptimizeMode,
step: std.Build.Step,
b: *std.Build,
fn init(b: *std.Build, target: std.Target, optimize: std.builtin.OptimizeMode) *DownloadBinaryStep {
const download_step = b.allocator.create(DownloadBinaryStep) catch unreachable;
download_step.* = .{
.target = target,
.optimize = optimize,
.step = std.Build.Step.init(.{
.id = .custom,
.name = "download mach-dxcompiler prebuilt binary",
.owner = b,
.makeFn = &make,
}),
.b = b,
};
return download_step;
}
fn make(step_ptr: *std.Build.Step, prog_node: std.Progress.Node) anyerror!void {
_ = prog_node;
const download_step: *DownloadBinaryStep = @fieldParentPtr("step", step_ptr);
const b = download_step.b;
const target = download_step.target;
const optimize = download_step.optimize;
// Zig will run build steps in parallel if possible, so if there were two invocations of
// then this function would be called in parallel. We're manipulating the FS here
// and so need to prevent that.
download_mutex.lock();
defer download_mutex.unlock();
// Check if we've already downloaded binaries to the cache dir
const cache_dir = try binaryCacheDirPath(b, target, optimize);
if (dirExists(cache_dir)) {
// Nothing to do.
return;
}
std.fs.cwd().makePath(cache_dir) catch |err| {
log.err("unable to create cache dir '{s}': {s}", .{ cache_dir, @errorName(err) });
return error.DownloadFailed;
};
// Compose the download URL, e.g.
// https://github.com/hexops/mach-dxcompiler/releases/download/2023.11.30%2Ba451866.3/aarch64-linux-gnu_Debug_bin.tar.gz