-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathbuild.zig
More file actions
1303 lines (1170 loc) · 54.8 KB
/
Copy pathbuild.zig
File metadata and controls
1303 lines (1170 loc) · 54.8 KB
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");
pub fn build(b: *std.Build) void {
const target = b.standardTargetOptions(.{});
const optimize = b.standardOptimizeOption(.{});
const exe = b.addExecutable(.{
.name = "ccc",
.root_module = b.createModule(.{
.root_source_file = b.path("src/emulator/main.zig"),
.target = target,
.optimize = optimize,
// Link libc on the native build so devices/clint.zig's
// std.c.clock_gettime + cpu.zig's std.c.nanosleep resolve.
// macOS's libSystem auto-links so the omission was invisible
// there; Linux needs the explicit opt-in. The wasm build uses
// a separate module rooted at demo/web_main.zig and stays
// libc-free via the comptime branches in cpu.zig + clint.zig.
.link_libc = true,
}),
});
// Expose tests/fixtures/minimal.elf as an importable module so that
// src/elf.zig's test can embed it without escaping src/'s package root.
exe.root_module.addAnonymousImport("minimal_elf_fixture", .{
.root_source_file = b.path("tests/fixtures/minimal_elf.zig"),
});
b.installArtifact(exe);
const run_cmd = b.addRunArtifact(exe);
run_cmd.step.dependOn(b.getInstallStep());
if (b.args) |args| {
run_cmd.addArgs(args);
}
const run_step = b.step("run", "Run the emulator");
run_step.dependOn(&run_cmd.step);
const tests = b.addTest(.{
.root_module = exe.root_module,
});
const test_run = b.addRunArtifact(tests);
const test_step = b.step("test", "Run all unit tests");
test_step.dependOn(&test_run.step);
// Host-runnable tests for kernel-side modules whose algorithms can run
// outside the cross-compiled kernel (e.g., elfload's parser).
const kernel_host_tests = b.addTest(.{
.root_module = b.createModule(.{
.root_source_file = b.path("src/kernel/elfload.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
kernel_host_tests.root_module.addAnonymousImport("minimal_elf_fixture", .{
.root_source_file = b.path("tests/fixtures/minimal_elf.zig"),
});
const kernel_host_tests_run = b.addRunArtifact(kernel_host_tests);
test_step.dependOn(&kernel_host_tests_run.step);
// Host-runnable tests for vm.zig's pure-arithmetic helpers
// (Plan 3.C Task 1: freeLeavesInL0 walk over a synthetic L0 table).
// vm.zig's page_alloc + kprintf imports are lazily evaluated; tests
// exercise only the pure helpers and never reach the freestanding-only
// code paths, so a host-targeted compile succeeds without stubs.
const vm_host_tests = b.addTest(.{
.root_module = b.createModule(.{
.root_source_file = b.path("src/kernel/vm.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
const vm_host_tests_run = b.addRunArtifact(vm_host_tests);
test_step.dependOn(&vm_host_tests_run.step);
// === Hand-crafted hello world demo (Task 17) ===
// The encoder is a host tool that emits a raw RV32I binary.
const hello_encoder = b.addExecutable(.{
.name = "encode_hello",
.root_module = b.createModule(.{
.root_source_file = b.path("programs/hello/encode_hello.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
const hello_run = b.addRunArtifact(hello_encoder);
const hello_bin = hello_run.addOutputFileArg("hello.bin");
const install_hello = b.addInstallFile(hello_bin, "hello.bin");
const hello_step = b.step("hello", "Build the hand-crafted hello world binary");
hello_step.dependOn(&install_hello.step);
// End-to-end test: run the emulator against the freshly-built hello.bin
// and assert the UART output equals "hello world\n".
const e2e_run = b.addRunArtifact(exe);
e2e_run.addArgs(&.{ "--raw", "0x80000000" });
e2e_run.addFileArg(hello_bin);
e2e_run.expectStdOutEqual("hello world\n");
const e2e_step = b.step("e2e", "Run the end-to-end hello world test");
e2e_step.dependOn(&e2e_run.step);
// === Hand-crafted RV32IMA mul/amo/div demo (Plan 1.B Task 9) ===
const mul_demo_encoder = b.addExecutable(.{
.name = "encode_mul_demo",
.root_module = b.createModule(.{
.root_source_file = b.path("programs/mul_demo/encode_mul_demo.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
const mul_demo_run = b.addRunArtifact(mul_demo_encoder);
const mul_demo_bin = mul_demo_run.addOutputFileArg("mul_demo.bin");
const install_mul_demo = b.addInstallFile(mul_demo_bin, "mul_demo.bin");
const mul_demo_step = b.step("mul-demo", "Build the hand-crafted RV32IMA demo binary");
mul_demo_step.dependOn(&install_mul_demo.step);
// End-to-end test: run the emulator against mul_demo.bin, assert output.
const e2e_mul_run = b.addRunArtifact(exe);
e2e_mul_run.addArgs(&.{ "--raw", "0x80000000" });
e2e_mul_run.addFileArg(mul_demo_bin);
e2e_mul_run.expectStdOutEqual("42\n");
const e2e_mul_step = b.step("e2e-mul", "Run the end-to-end RV32IMA demo test");
e2e_mul_step.dependOn(&e2e_mul_run.step);
// === Hand-crafted trap/privilege demo (Plan 1.C Task 17) ===
const trap_demo_encoder = b.addExecutable(.{
.name = "encode_trap_demo",
.root_module = b.createModule(.{
.root_source_file = b.path("programs/trap_demo/encode_trap_demo.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
const trap_demo_run = b.addRunArtifact(trap_demo_encoder);
const trap_demo_bin = trap_demo_run.addOutputFileArg("trap_demo.bin");
const install_trap_demo = b.addInstallFile(trap_demo_bin, "trap_demo.bin");
const trap_demo_step = b.step("trap-demo", "Build the hand-crafted trap/privilege demo binary");
trap_demo_step.dependOn(&install_trap_demo.step);
const e2e_trap_run = b.addRunArtifact(exe);
e2e_trap_run.addArgs(&.{ "--raw", "0x80000000" });
e2e_trap_run.addFileArg(trap_demo_bin);
e2e_trap_run.expectStdOutEqual("trap ok\n");
const e2e_trap_step = b.step("e2e-trap", "Run the end-to-end trap/privilege demo test");
e2e_trap_step.dependOn(&e2e_trap_run.step);
// === Shared RV32 cross-compile target (hello.elf + riscv-tests) ===
// Use generic_rv32 (explicit CPU model) so compressed (C) is OFF.
// baseline_rv32 silently includes C, which breaks us: our decoder is
// strictly 32-bit-wide. Plus M + A features.
const rv_target = b.resolveTargetQuery(.{
.cpu_arch = .riscv32,
.os_tag = .freestanding,
.abi = .none,
.cpu_model = .{ .explicit = &std.Target.riscv.cpu.generic_rv32 },
.cpu_features_add = blk: {
const features = std.Target.riscv.Feature;
var set = std.Target.Cpu.Feature.Set.empty;
set.addFeature(@intFromEnum(features.m));
set.addFeature(@intFromEnum(features.a));
break :blk set;
},
});
// === Zig-compiled hello.elf (Plan 1.D — Phase 1 §Definition of done) ===
// Two-object link: monitor.S provides _start + trap_vector (M-mode);
// hello.zig provides u_entry + msg (U-mode). linker.ld places .text.init
// at 0x80000000 and defines _stack_top.
const hello_monitor_obj = b.addObject(.{
.name = "hello-monitor",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
}),
});
hello_monitor_obj.root_module.addAssemblyFile(b.path("programs/hello/monitor.S"));
const hello_umode_obj = b.addObject(.{
.name = "hello-umode",
.root_module = b.createModule(.{
.root_source_file = b.path("programs/hello/hello.zig"),
.target = rv_target,
.optimize = .ReleaseSmall,
// Keep the Zig compiler from stripping u_entry / msg as "unused".
.strip = false,
.single_threaded = true,
}),
});
const hello_elf = b.addExecutable(.{
.name = "hello.elf",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
hello_elf.root_module.addObject(hello_monitor_obj);
hello_elf.root_module.addObject(hello_umode_obj);
hello_elf.setLinkerScript(b.path("programs/hello/linker.ld"));
hello_elf.entry = .{ .symbol_name = "_start" };
const install_hello_elf = b.addInstallArtifact(hello_elf, .{});
const hello_elf_step = b.step("hello-elf", "Build the Zig-compiled hello.elf (Phase 1 §Definition of done)");
hello_elf_step.dependOn(&install_hello_elf.step);
// End-to-end: run our emulator against hello.elf and assert UART output.
const e2e_hello_elf_run = b.addRunArtifact(exe);
e2e_hello_elf_run.addFileArg(hello_elf.getEmittedBin());
e2e_hello_elf_run.expectStdOutEqual("hello world\n");
const e2e_hello_elf_step = b.step("e2e-hello-elf", "Run the Phase 1 §Definition of done demo (ccc hello.elf)");
e2e_hello_elf_step.dependOn(&e2e_hello_elf_run.step);
// === Kernel.elf (Plan 2.C) ===
//
// Two-piece build:
// 1. userprog.bin — a flat RV32 U-mode binary produced by objcopy
// (added in Task 14). For now (Task 2), userprog.bin does not
// exist yet and the kernel does not embed it.
// 2. kernel.elf — M-mode boot.S + mtimer.S + trampoline.S + kernel
// Zig (kmain, vm, page_alloc, trap, syscall, uart, kprintf) all
// linked per kernel/linker.ld, entry _M_start.
//
// Task 2 state: only boot.S + kmain.zig exist; the other .zig / .S
// files and the userprog embed arrive in later tasks.
const kernel_boot_obj = b.addObject(.{
.name = "kernel-boot",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
}),
});
kernel_boot_obj.root_module.addAssemblyFile(b.path("src/kernel/boot.S"));
const kernel_trampoline_obj = b.addObject(.{
.name = "kernel-trampoline",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
}),
});
kernel_trampoline_obj.root_module.addAssemblyFile(b.path("src/kernel/trampoline.S"));
const kernel_mtimer_obj = b.addObject(.{
.name = "kernel-mtimer",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
}),
});
kernel_mtimer_obj.root_module.addAssemblyFile(b.path("src/kernel/mtimer.S"));
const kernel_swtch_obj = b.addObject(.{
.name = "kernel-swtch",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
}),
});
kernel_swtch_obj.root_module.addAssemblyFile(b.path("src/kernel/swtch.S"));
// === User program (Plan 2.C) ===
const userprog_obj = b.addObject(.{
.name = "userprog",
.root_module = b.createModule(.{
.root_source_file = b.path("src/kernel/user/userprog.zig"),
.target = rv_target,
.optimize = .ReleaseSmall,
.strip = false,
.single_threaded = true,
}),
});
const userprog_elf = b.addExecutable(.{
.name = "userprog.elf",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .ReleaseSmall,
.strip = false,
.single_threaded = true,
}),
});
userprog_elf.root_module.addObject(userprog_obj);
userprog_elf.setLinkerScript(b.path("src/kernel/user/user_linker.ld"));
userprog_elf.entry = .{ .symbol_name = "_start" };
const userprog_elf_bin = userprog_elf.getEmittedBin();
const boot_config_stub_dir = b.addWriteFiles();
const boot_config_zig = boot_config_stub_dir.add(
"boot_config.zig",
\\const std = @import("std");
\\pub const MULTI_PROC: bool = false;
\\pub const FORK_DEMO: bool = false;
\\pub const FS_DEMO: bool = false;
\\pub const USERPROG_ELF: []const u8 = @embedFile("userprog.elf");
\\pub const USERPROG2_ELF: []const u8 = "";
\\pub const INIT_ELF: []const u8 = "";
\\pub const HELLO_ELF: []const u8 = "";
\\pub fn lookupBlob(path: []const u8) ?[]const u8 {
\\ _ = path;
\\ return null;
\\}
,
);
_ = boot_config_stub_dir.addCopyFile(userprog_elf_bin, "userprog.elf");
const install_userprog_elf = b.addInstallFile(userprog_elf_bin, "userprog.elf");
const kernel_user_step = b.step("kernel-user", "Build the Phase 3.B userprog.elf");
kernel_user_step.dependOn(&install_userprog_elf.step);
const userprog2_obj = b.addObject(.{
.name = "userprog2",
.root_module = b.createModule(.{
.root_source_file = b.path("src/kernel/user/userprog2.zig"),
.target = rv_target,
.optimize = .ReleaseSmall,
.strip = false,
.single_threaded = true,
}),
});
const userprog2_elf = b.addExecutable(.{
.name = "userprog2.elf",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .ReleaseSmall,
.strip = false,
.single_threaded = true,
}),
});
userprog2_elf.root_module.addObject(userprog2_obj);
userprog2_elf.setLinkerScript(b.path("src/kernel/user/user_linker.ld"));
userprog2_elf.entry = .{ .symbol_name = "_start" };
const userprog2_elf_bin = userprog2_elf.getEmittedBin();
const install_userprog2_elf = b.addInstallFile(userprog2_elf_bin, "userprog2.elf");
const userprog2_step = b.step("kernel-user2", "Build the Phase 3.B userprog2.elf");
userprog2_step.dependOn(&install_userprog2_elf.step);
const kernel_init_obj = b.addObject(.{
.name = "init",
.root_module = b.createModule(.{
.root_source_file = b.path("src/kernel/user/init.zig"),
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
const kernel_init_elf = b.addExecutable(.{
.name = "init.elf",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
kernel_init_elf.root_module.addObject(kernel_init_obj);
kernel_init_elf.setLinkerScript(b.path("src/kernel/user/user_linker.ld"));
kernel_init_elf.entry = .{ .symbol_name = "_start" };
const kernel_init_elf_bin = kernel_init_elf.getEmittedBin();
const install_kernel_init_elf = b.addInstallFile(kernel_init_elf_bin, "init.elf");
const kernel_init_step = b.step("kernel-init", "Build the Phase 3.C init.elf");
kernel_init_step.dependOn(&install_kernel_init_elf.step);
const kernel_hello_obj = b.addObject(.{
.name = "hello",
.root_module = b.createModule(.{
.root_source_file = b.path("src/kernel/user/hello.zig"),
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
const kernel_hello_elf = b.addExecutable(.{
.name = "hello.elf",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
kernel_hello_elf.root_module.addObject(kernel_hello_obj);
kernel_hello_elf.setLinkerScript(b.path("src/kernel/user/user_linker.ld"));
kernel_hello_elf.entry = .{ .symbol_name = "_start" };
const kernel_hello_elf_bin = kernel_hello_elf.getEmittedBin();
const install_kernel_hello_elf = b.addInstallFile(kernel_hello_elf_bin, "hello.elf");
const kernel_hello_step = b.step("kernel-hello", "Build the Phase 3.C hello.elf");
kernel_hello_step.dependOn(&install_kernel_hello_elf.step);
const kernel_fs_init_obj = b.addObject(.{
.name = "kernel-fs-init",
.root_module = b.createModule(.{
.root_source_file = b.path("src/kernel/user/fs_init.zig"),
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
const kernel_fs_init_elf = b.addExecutable(.{
.name = "fs_init.elf",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
kernel_fs_init_elf.root_module.addObject(kernel_fs_init_obj);
kernel_fs_init_elf.setLinkerScript(b.path("src/kernel/user/user_linker.ld"));
kernel_fs_init_elf.entry = .{ .symbol_name = "_start" };
const kernel_fs_init_elf_bin = kernel_fs_init_elf.getEmittedBin();
const install_kernel_fs_init_elf = b.addInstallFile(kernel_fs_init_elf_bin, "fs_init.elf");
const kernel_fs_init_step = b.step("kernel-fs-init", "Build the Phase 3.D fs_init.elf");
kernel_fs_init_step.dependOn(&install_kernel_fs_init_elf.step);
const init_shell_exe = addUserBinary(
b,
"init_shell",
"src/kernel/user/init_shell.zig",
rv_target,
.ReleaseSmall,
);
const install_init_shell = b.addInstallFile(init_shell_exe.getEmittedBin(), "init_shell.elf");
const kernel_init_shell_step = b.step("kernel-init-shell", "Build init_shell.elf (Phase 3.E /bin/init)");
kernel_init_shell_step.dependOn(&install_init_shell.step);
const echo_exe = addUserBinary(b, "echo", "src/kernel/user/echo.zig", rv_target, .ReleaseSmall);
const install_echo = b.addInstallFile(echo_exe.getEmittedBin(), "echo.elf");
const kernel_echo_step = b.step("kernel-echo", "Build echo.elf (Phase 3.E)");
kernel_echo_step.dependOn(&install_echo.step);
const cat_exe = addUserBinary(b, "cat", "src/kernel/user/cat.zig", rv_target, .ReleaseSmall);
const install_cat = b.addInstallFile(cat_exe.getEmittedBin(), "cat.elf");
const kernel_cat_step = b.step("kernel-cat", "Build cat.elf (Phase 3.E)");
kernel_cat_step.dependOn(&install_cat.step);
const ls_exe = addUserBinary(b, "ls", "src/kernel/user/ls.zig", rv_target, .ReleaseSmall);
const install_ls = b.addInstallFile(ls_exe.getEmittedBin(), "ls.elf");
const kernel_ls_step = b.step("kernel-ls", "Build ls.elf (Phase 3.E)");
kernel_ls_step.dependOn(&install_ls.step);
const mkdir_exe = addUserBinary(b, "mkdir", "src/kernel/user/mkdir.zig", rv_target, .ReleaseSmall);
const install_mkdir = b.addInstallFile(mkdir_exe.getEmittedBin(), "mkdir.elf");
const kernel_mkdir_step = b.step("kernel-mkdir", "Build mkdir.elf (Phase 3.E)");
kernel_mkdir_step.dependOn(&install_mkdir.step);
const rm_exe = addUserBinary(b, "rm", "src/kernel/user/rm.zig", rv_target, .ReleaseSmall);
const install_rm = b.addInstallFile(rm_exe.getEmittedBin(), "rm.elf");
const kernel_rm_step = b.step("kernel-rm", "Build rm.elf (Phase 3.E)");
kernel_rm_step.dependOn(&install_rm.step);
const sh_exe = addUserBinary(b, "sh", "src/kernel/user/sh.zig", rv_target, .ReleaseSmall);
const install_sh = b.addInstallFile(sh_exe.getEmittedBin(), "sh.elf");
const kernel_sh_step = b.step("kernel-sh", "Build sh.elf (Phase 3.E)");
kernel_sh_step.dependOn(&install_sh.step);
const edit_exe = addUserBinary(b, "edit", "src/kernel/user/edit.zig", rv_target, .ReleaseSmall);
const install_edit = b.addInstallFile(edit_exe.getEmittedBin(), "edit.elf");
const kernel_edit_step = b.step("kernel-edit", "Build edit.elf (Phase 3.F)");
kernel_edit_step.dependOn(&install_edit.step);
// Phase 3.D: mkfs host tool.
const mkfs_exe = b.addExecutable(.{
.name = "mkfs",
.root_module = b.createModule(.{
.root_source_file = b.path("src/kernel/mkfs.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
const install_mkfs = b.addInstallArtifact(mkfs_exe, .{});
const mkfs_step = b.step("mkfs", "Build the host-side mkfs tool");
mkfs_step.dependOn(&install_mkfs.step);
// Stage --bin: copy fs_init.elf into a temp dir as `init`.
const fs_bin_stage = b.addWriteFiles();
_ = fs_bin_stage.addCopyFile(kernel_fs_init_elf_bin, "init");
// Run mkfs to produce fs.img.
const fs_img_run = b.addRunArtifact(mkfs_exe);
fs_img_run.addArg("--root");
fs_img_run.addDirectoryArg(b.path("src/kernel/userland/fs"));
fs_img_run.addArg("--bin");
fs_img_run.addDirectoryArg(fs_bin_stage.getDirectory());
fs_img_run.addArg("--out");
const fs_img = fs_img_run.addOutputFileArg("fs.img");
const install_fs_img = b.addInstallFile(fs_img, "fs.img");
const fs_img_step = b.step("fs-img", "Build fs.img from staged userland + mkfs");
fs_img_step.dependOn(&install_fs_img.step);
// Phase 3.E: shell-fs.img — install init_shell as /bin/init plus the
// six utility binaries (sh, ls, cat, echo, mkdir, rm). The shell-fs/
// staging tree carries /etc/motd and the empty /tmp/ directory.
const shell_fs_bin_stage = b.addWriteFiles();
_ = shell_fs_bin_stage.addCopyFile(init_shell_exe.getEmittedBin(), "init");
_ = shell_fs_bin_stage.addCopyFile(sh_exe.getEmittedBin(), "sh");
_ = shell_fs_bin_stage.addCopyFile(ls_exe.getEmittedBin(), "ls");
_ = shell_fs_bin_stage.addCopyFile(cat_exe.getEmittedBin(), "cat");
_ = shell_fs_bin_stage.addCopyFile(echo_exe.getEmittedBin(), "echo");
_ = shell_fs_bin_stage.addCopyFile(mkdir_exe.getEmittedBin(), "mkdir");
_ = shell_fs_bin_stage.addCopyFile(rm_exe.getEmittedBin(), "rm");
_ = shell_fs_bin_stage.addCopyFile(edit_exe.getEmittedBin(), "edit");
const shell_fs_img_run = b.addRunArtifact(mkfs_exe);
shell_fs_img_run.addArg("--root");
shell_fs_img_run.addDirectoryArg(b.path("src/kernel/userland/shell-fs"));
shell_fs_img_run.addArg("--bin");
shell_fs_img_run.addDirectoryArg(shell_fs_bin_stage.getDirectory());
shell_fs_img_run.addArg("--out");
const shell_fs_img = shell_fs_img_run.addOutputFileArg("shell-fs.img");
const install_shell_fs_img = b.addInstallFile(shell_fs_img, "shell-fs.img");
const shell_fs_img_step = b.step("shell-fs-img", "Build shell-fs.img with all Phase 3.E binaries");
shell_fs_img_step.dependOn(&install_shell_fs_img.step);
const multi_boot_config_stub_dir = b.addWriteFiles();
const multi_boot_config_zig = multi_boot_config_stub_dir.add(
"boot_config.zig",
\\const std = @import("std");
\\pub const MULTI_PROC: bool = true;
\\pub const FORK_DEMO: bool = false;
\\pub const FS_DEMO: bool = false;
\\pub const USERPROG_ELF: []const u8 = @embedFile("userprog.elf");
\\pub const USERPROG2_ELF: []const u8 = @embedFile("userprog2.elf");
\\pub const INIT_ELF: []const u8 = "";
\\pub const HELLO_ELF: []const u8 = "";
\\pub fn lookupBlob(path: []const u8) ?[]const u8 {
\\ _ = path;
\\ return null;
\\}
,
);
_ = multi_boot_config_stub_dir.addCopyFile(userprog_elf_bin, "userprog.elf");
_ = multi_boot_config_stub_dir.addCopyFile(userprog2_elf_bin, "userprog2.elf");
const fork_boot_config_stub_dir = b.addWriteFiles();
const fork_boot_config_zig = fork_boot_config_stub_dir.add(
"boot_config.zig",
\\const std = @import("std");
\\pub const MULTI_PROC: bool = false;
\\pub const FORK_DEMO: bool = true;
\\pub const FS_DEMO: bool = false;
\\pub const USERPROG_ELF: []const u8 = "";
\\pub const USERPROG2_ELF: []const u8 = "";
\\pub const INIT_ELF: []const u8 = @embedFile("init.elf");
\\pub const HELLO_ELF: []const u8 = @embedFile("hello.elf");
\\pub fn lookupBlob(path: []const u8) ?[]const u8 {
\\ if (std.mem.eql(u8, path, "/bin/hello")) return HELLO_ELF;
\\ return null;
\\}
,
);
_ = fork_boot_config_stub_dir.addCopyFile(kernel_init_elf_bin, "init.elf");
_ = fork_boot_config_stub_dir.addCopyFile(kernel_hello_elf_bin, "hello.elf");
const fs_boot_config_stub_dir = b.addWriteFiles();
const fs_boot_config_zig = fs_boot_config_stub_dir.add(
"boot_config.zig",
\\const std = @import("std");
\\pub const MULTI_PROC: bool = false;
\\pub const FORK_DEMO: bool = false;
\\pub const FS_DEMO: bool = true;
\\pub const USERPROG_ELF: []const u8 = "";
\\pub const USERPROG2_ELF: []const u8 = "";
\\pub const INIT_ELF: []const u8 = "";
\\pub const HELLO_ELF: []const u8 = "";
\\pub fn lookupBlob(path: []const u8) ?[]const u8 {
\\ _ = path;
\\ return null;
\\}
,
);
const kernel_kmain_obj = b.addObject(.{
.name = "kernel-kmain",
.root_module = b.createModule(.{
.root_source_file = b.path("src/kernel/kmain.zig"),
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
kernel_kmain_obj.root_module.addAnonymousImport("boot_config", .{
.root_source_file = boot_config_zig,
});
const kernel_kmain_multi_obj = b.addObject(.{
.name = "kernel-kmain-multi",
.root_module = b.createModule(.{
.root_source_file = b.path("src/kernel/kmain.zig"),
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
kernel_kmain_multi_obj.root_module.addAnonymousImport("boot_config", .{
.root_source_file = multi_boot_config_zig,
});
const kernel_kmain_fork_obj = b.addObject(.{
.name = "kernel-kmain-fork",
.root_module = b.createModule(.{
.root_source_file = b.path("src/kernel/kmain.zig"),
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
kernel_kmain_fork_obj.root_module.addAnonymousImport("boot_config", .{
.root_source_file = fork_boot_config_zig,
});
const kernel_kmain_fs_obj = b.addObject(.{
.name = "kernel-kmain-fs",
.root_module = b.createModule(.{
.root_source_file = b.path("src/kernel/kmain.zig"),
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
kernel_kmain_fs_obj.root_module.addAnonymousImport("boot_config", .{
.root_source_file = fs_boot_config_zig,
});
const kernel_elf = b.addExecutable(.{
.name = "kernel.elf",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
kernel_elf.root_module.addObject(kernel_boot_obj);
kernel_elf.root_module.addObject(kernel_trampoline_obj);
kernel_elf.root_module.addObject(kernel_mtimer_obj);
kernel_elf.root_module.addObject(kernel_swtch_obj);
kernel_elf.root_module.addObject(kernel_kmain_obj);
kernel_elf.setLinkerScript(b.path("src/kernel/linker.ld"));
kernel_elf.entry = .{ .symbol_name = "_M_start" };
const install_kernel_elf = b.addInstallArtifact(kernel_elf, .{});
const kernel_elf_step = b.step("kernel-elf", "Build the Plan 2.C kernel.elf");
kernel_elf_step.dependOn(&install_kernel_elf.step);
const kernel_step = b.step("kernel", "Alias for kernel-elf");
kernel_step.dependOn(&install_kernel_elf.step);
const kernel_multi_elf = b.addExecutable(.{
.name = "kernel-multi.elf",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
kernel_multi_elf.root_module.addObject(kernel_boot_obj);
kernel_multi_elf.root_module.addObject(kernel_trampoline_obj);
kernel_multi_elf.root_module.addObject(kernel_mtimer_obj);
kernel_multi_elf.root_module.addObject(kernel_swtch_obj);
kernel_multi_elf.root_module.addObject(kernel_kmain_multi_obj);
kernel_multi_elf.setLinkerScript(b.path("src/kernel/linker.ld"));
kernel_multi_elf.entry = .{ .symbol_name = "_M_start" };
const install_kernel_multi_elf = b.addInstallArtifact(kernel_multi_elf, .{});
const kernel_multi_step = b.step("kernel-multi", "Build the Phase 3.B multi-proc kernel.elf");
kernel_multi_step.dependOn(&install_kernel_multi_elf.step);
const kernel_fork_elf = b.addExecutable(.{
.name = "kernel-fork.elf",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
kernel_fork_elf.root_module.addObject(kernel_boot_obj);
kernel_fork_elf.root_module.addObject(kernel_trampoline_obj);
kernel_fork_elf.root_module.addObject(kernel_mtimer_obj);
kernel_fork_elf.root_module.addObject(kernel_swtch_obj);
kernel_fork_elf.root_module.addObject(kernel_kmain_fork_obj);
kernel_fork_elf.setLinkerScript(b.path("src/kernel/linker.ld"));
kernel_fork_elf.entry = .{ .symbol_name = "_M_start" };
const install_kernel_fork_elf = b.addInstallArtifact(kernel_fork_elf, .{});
const kernel_fork_step = b.step("kernel-fork", "Build the Phase 3.C fork-demo kernel.elf");
kernel_fork_step.dependOn(&install_kernel_fork_elf.step);
const kernel_fs_elf = b.addExecutable(.{
.name = "kernel-fs.elf",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
kernel_fs_elf.root_module.addObject(kernel_boot_obj);
kernel_fs_elf.root_module.addObject(kernel_trampoline_obj);
kernel_fs_elf.root_module.addObject(kernel_mtimer_obj);
kernel_fs_elf.root_module.addObject(kernel_swtch_obj);
kernel_fs_elf.root_module.addObject(kernel_kmain_fs_obj);
kernel_fs_elf.setLinkerScript(b.path("src/kernel/linker.ld"));
kernel_fs_elf.entry = .{ .symbol_name = "_M_start" };
const install_kernel_fs_elf = b.addInstallArtifact(kernel_fs_elf, .{});
const kernel_fs_step = b.step("kernel-fs", "Build the Phase 3.D fs-mode kernel.elf");
kernel_fs_step.dependOn(&install_kernel_fs_elf.step);
// End-to-end: Plan 2.D uses a host-compiled verifier that spawns ccc
// on kernel.elf, captures stdout, and asserts the Phase 2 §Definition
// of done shape ("hello from u-mode\nticks observed: N\n" with N > 0
// and exit code 0). Replaces expectStdOutEqual which couldn't express
// a variable N.
const verify_e2e = b.addExecutable(.{
.name = "verify_e2e",
.root_module = b.createModule(.{
.root_source_file = b.path("tests/e2e/kernel.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
const e2e_kernel_run = b.addRunArtifact(verify_e2e);
e2e_kernel_run.addFileArg(exe.getEmittedBin());
e2e_kernel_run.addFileArg(kernel_elf.getEmittedBin());
e2e_kernel_run.expectExitCode(0);
const e2e_kernel_step = b.step("e2e-kernel", "Run the Phase 2 kernel e2e test (hello + ticks)");
e2e_kernel_step.dependOn(&e2e_kernel_run.step);
const multiproc_verify = b.addExecutable(.{
.name = "multiproc_verify_e2e",
.root_module = b.createModule(.{
.root_source_file = b.path("tests/e2e/multiproc.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
const e2e_multiproc_run = b.addRunArtifact(multiproc_verify);
e2e_multiproc_run.addFileArg(exe.getEmittedBin());
e2e_multiproc_run.addFileArg(kernel_multi_elf.getEmittedBin());
e2e_multiproc_run.expectExitCode(0);
const e2e_multiproc_step = b.step("e2e-multiproc-stub", "Run the Phase 3.B multi-proc e2e test (PID 1 + PID 2)");
e2e_multiproc_step.dependOn(&e2e_multiproc_run.step);
const fork_verify = b.addExecutable(.{
.name = "fork_verify_e2e",
.root_module = b.createModule(.{
.root_source_file = b.path("tests/e2e/fork.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
const e2e_fork_run = b.addRunArtifact(fork_verify);
e2e_fork_run.addFileArg(exe.getEmittedBin());
e2e_fork_run.addFileArg(kernel_fork_elf.getEmittedBin());
e2e_fork_run.expectExitCode(0);
const e2e_fork_step = b.step("e2e-fork", "Run the Phase 3.C fork+exec+wait+exit e2e test");
e2e_fork_step.dependOn(&e2e_fork_run.step);
const fs_verify = b.addExecutable(.{
.name = "fs_verify_e2e",
.root_module = b.createModule(.{
.root_source_file = b.path("tests/e2e/fs.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
const e2e_fs_run = b.addRunArtifact(fs_verify);
e2e_fs_run.addFileArg(exe.getEmittedBin());
e2e_fs_run.addFileArg(fs_img);
e2e_fs_run.addFileArg(kernel_fs_elf.getEmittedBin());
e2e_fs_run.expectExitCode(0);
const e2e_fs_step = b.step("e2e-fs", "Run the Phase 3.D fs-read e2e test (init opens /etc/motd)");
e2e_fs_step.dependOn(&e2e_fs_run.step);
const shell_e2e_exe = b.addExecutable(.{
.name = "e2e-shell",
.root_module = b.createModule(.{
.root_source_file = b.path("tests/e2e/shell.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
const shell_e2e_run = b.addRunArtifact(shell_e2e_exe);
shell_e2e_run.step.dependOn(b.getInstallStep());
shell_e2e_run.step.dependOn(shell_fs_img_step);
shell_e2e_run.addFileArg(exe.getEmittedBin());
shell_e2e_run.addFileArg(shell_fs_img);
shell_e2e_run.addFileArg(kernel_fs_elf.getEmittedBin());
shell_e2e_run.addFileArg(b.path("tests/e2e/shell_input.txt"));
const e2e_shell_step = b.step("e2e-shell", "Run the Phase 3.E shell e2e test");
e2e_shell_step.dependOn(&shell_e2e_run.step);
const editor_e2e_exe = b.addExecutable(.{
.name = "e2e-editor",
.root_module = b.createModule(.{
.root_source_file = b.path("tests/e2e/editor.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
const editor_e2e_run = b.addRunArtifact(editor_e2e_exe);
editor_e2e_run.step.dependOn(b.getInstallStep());
editor_e2e_run.step.dependOn(shell_fs_img_step);
editor_e2e_run.addFileArg(exe.getEmittedBin());
editor_e2e_run.addFileArg(shell_fs_img);
editor_e2e_run.addFileArg(kernel_fs_elf.getEmittedBin());
editor_e2e_run.addFileArg(b.path("tests/e2e/editor_input.txt"));
const e2e_editor_step = b.step("e2e-editor", "Run the Phase 3.F editor e2e test");
e2e_editor_step.dependOn(&editor_e2e_run.step);
const persist_e2e_exe = b.addExecutable(.{
.name = "e2e-persist",
.root_module = b.createModule(.{
.root_source_file = b.path("tests/e2e/persist.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
const persist_e2e_run = b.addRunArtifact(persist_e2e_exe);
persist_e2e_run.step.dependOn(b.getInstallStep());
persist_e2e_run.step.dependOn(shell_fs_img_step);
persist_e2e_run.addFileArg(exe.getEmittedBin());
persist_e2e_run.addFileArg(shell_fs_img);
persist_e2e_run.addFileArg(kernel_fs_elf.getEmittedBin());
persist_e2e_run.addFileArg(b.path("tests/e2e/persist_input1.txt"));
persist_e2e_run.addFileArg(b.path("tests/e2e/persist_input2.txt"));
const e2e_persist_step = b.step("e2e-persist", "Run the Phase 3.F disk-persistence e2e test");
e2e_persist_step.dependOn(&persist_e2e_run.step);
const cancel_e2e_exe = b.addExecutable(.{
.name = "e2e-cancel",
.root_module = b.createModule(.{
.root_source_file = b.path("tests/e2e/cancel.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
const cancel_e2e_run = b.addRunArtifact(cancel_e2e_exe);
cancel_e2e_run.step.dependOn(b.getInstallStep());
cancel_e2e_run.step.dependOn(shell_fs_img_step);
cancel_e2e_run.addFileArg(exe.getEmittedBin());
cancel_e2e_run.addFileArg(shell_fs_img);
cancel_e2e_run.addFileArg(kernel_fs_elf.getEmittedBin());
cancel_e2e_run.addFileArg(b.path("tests/e2e/cancel_input.txt"));
const e2e_cancel_step = b.step("e2e-cancel", "Run the Phase 3 ^C kill-flag e2e test (proves console.feedByte(0x03) → proc.kill(fg_pid) chain)");
e2e_cancel_step.dependOn(&cancel_e2e_run.step);
// qemu-diff-kernel: debug-only trace diff against QEMU. Requires
// qemu-system-riscv32 on PATH; not run by CI.
const qemu_diff_kernel_cmd = b.addSystemCommand(&.{
"bash",
"scripts/qemu-diff-kernel.sh",
});
qemu_diff_kernel_cmd.step.dependOn(&install_kernel_elf.step);
const qemu_diff_kernel_step = b.step(
"qemu-diff-kernel",
"Diff kernel.elf instruction trace against qemu-system-riscv32 (debug aid)",
);
qemu_diff_kernel_step.dependOn(&qemu_diff_kernel_cmd.step);
// === Phase 3.A integration test ===
const plic_block_boot = b.addObject(.{
.name = "plic-block-boot",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
}),
});
plic_block_boot.root_module.addAssemblyFile(b.path("programs/plic_block_test/boot.S"));
const plic_block_test_obj = b.addObject(.{
.name = "plic-block-test",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
}),
});
plic_block_test_obj.root_module.addAssemblyFile(b.path("programs/plic_block_test/test.S"));
const plic_block_elf = b.addExecutable(.{
.name = "plic_block_test.elf",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
.strip = false,
.single_threaded = true,
}),
});
plic_block_elf.root_module.addObject(plic_block_boot);
plic_block_elf.root_module.addObject(plic_block_test_obj);
plic_block_elf.setLinkerScript(b.path("programs/plic_block_test/linker.ld"));
plic_block_elf.entry = .{ .symbol_name = "_M_start" };
const install_plic_block_elf = b.addInstallArtifact(plic_block_elf, .{});
const plic_block_step = b.step("plic-block-test", "Build the Phase 3.A integration test ELF");
plic_block_step.dependOn(&install_plic_block_elf.step);
// Build the 4 MB test image (sector 0 = 0xCC, rest zero).
const make_img = b.addExecutable(.{
.name = "make_plic_block_img",
.root_module = b.createModule(.{
.root_source_file = b.path("programs/plic_block_test/make_img.zig"),
.target = b.graph.host,
.optimize = .Debug,
}),
});
const make_img_run = b.addRunArtifact(make_img);
const test_img = make_img_run.addOutputFileArg("plic_block_test.img");
// Run e2e-plic-block: ccc --disk <img> <elf>; expect exit 0.
const e2e_plic_block_run = b.addRunArtifact(exe);
e2e_plic_block_run.addArg("--disk");
e2e_plic_block_run.addFileArg(test_img);
e2e_plic_block_run.addFileArg(plic_block_elf.getEmittedBin());
e2e_plic_block_run.expectExitCode(0);
const e2e_plic_block_step = b.step("e2e-plic-block", "Run the Phase 3.A PLIC + block integration test");
e2e_plic_block_step.dependOn(&e2e_plic_block_run.step);
// === Snake demo (Phase 3) ===
const snake_monitor_obj = b.addObject(.{
.name = "snake-monitor",
.root_module = b.createModule(.{
.root_source_file = null,
.target = rv_target,
.optimize = .Debug,
}),
});
snake_monitor_obj.root_module.addAssemblyFile(b.path("programs/snake/monitor.S"));
const snake_zig_obj = b.addObject(.{
.name = "snake-zig",
.root_module = b.createModule(.{
.root_source_file = b.path("programs/snake/snake.zig"),
.target = rv_target,
.optimize = .ReleaseSmall,
.strip = false,
.single_threaded = true,
}),
});
const snake_elf = b.addExecutable(.{
.name = "snake.elf",
.root_module = b.createModule(.{