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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
//! Boot pipeline for `KtstrVm`: virtio-blk wiring, KVM creation,
//! initramfs resolution and compression, COW overlay, deferred memory
//! computation, x86_64 / aarch64 memory and FDT layout, vCPU register
//! setup.
//!
//! These methods run on the calling thread (no vCPU work yet) and
//! produce a [`KtstrKvm`](super::kvm::KtstrKvm) ready for the
//! [`KtstrVm::run_vm`](super::KtstrVm::run_vm) loop. They are reopened
//! as additional [`impl KtstrVm`](super::KtstrVm) blocks; the canonical
//! struct definition lives in [`super`].
use anyhow::{Context, Result};
use std::path::PathBuf;
use std::sync::Arc;
use std::thread::JoinHandle;
use std::time::Instant;
use vm_memory::{Bytes, GuestAddress, GuestMemory, GuestMemoryMmap};
use super::KtstrVm;
use super::initramfs_cache::{BaseKey, BaseRef, get_or_build_base};
use super::memory_budget::{MemoryBudget, initramfs_min_memory_mib, read_kernel_init_size};
use super::pi_mutex::PiMutex;
use super::{disk_config, disk_template, host_topology, initramfs, virtio_blk, virtio_net};
#[cfg(target_arch = "aarch64")]
use super::aarch64;
#[cfg(target_arch = "aarch64")]
use super::aarch64::boot;
#[cfg(target_arch = "aarch64")]
use super::aarch64::kvm;
#[cfg(target_arch = "x86_64")]
use super::virtio_console;
#[cfg(target_arch = "x86_64")]
use super::x86_64::{acpi, boot, kvm, mptable};
/// Address where initramfs is loaded in guest memory.
#[cfg(target_arch = "x86_64")]
const INITRD_ADDR: u64 = 0x800_0000; // 128 MiB
/// Compute initramfs load address at the high end of DRAM, just below
/// the FDT. Matches Firecracker/Cloud Hypervisor placement pattern —
/// avoids conflicts with early kernel allocations near the kernel image.
///
/// Aligned to the host page size (not a hardcoded 4 KB). On Apple
/// Silicon hosts the kernel runs with 16 KB pages and the COW
/// `MAP_FIXED` mmap rejects targets that aren't host-page-aligned
/// with `EINVAL` — a 4 KB-aligned guest address that happens to fall
/// mid-host-page would clobber unrelated mappings if the kernel
/// accepted it, so the kernel correctly refuses. Round down here so
/// the overlay path reaches `mmap` with a valid alignment regardless
/// of host page size.
#[cfg(target_arch = "aarch64")]
fn aarch64_initrd_addr(memory_mib: u32, initrd_max_size: u64) -> u64 {
let fdt_addr = aarch64::fdt::fdt_address(memory_mib);
let page_size = host_page_size();
let mask = !(page_size - 1);
// Place initrd just below FDT, host-page-aligned.
let load_addr = (fdt_addr - initrd_max_size) & mask;
assert!(
load_addr >= kvm::DRAM_START,
"initrd load address underflows DRAM_START"
);
load_addr
}
/// Host page size in bytes. Reads from `sysconf(_SC_PAGESIZE)` once
/// per process and caches the result via `OnceLock`; subsequent calls
/// hit the cache. The kernel reports the actual MMU page size (4 KB
/// on x86_64 / common aarch64, 16 KB on Apple Silicon and some
/// aarch64 server SKUs). Falls back to 4 KB only when `sysconf`
/// returns an error code (≤0), which would itself indicate a libc bug
/// — the fallback exists so a downstream alignment computation never
/// produces 0.
#[allow(dead_code)]
pub(crate) fn host_page_size() -> u64 {
static CACHED: std::sync::OnceLock<u64> = std::sync::OnceLock::new();
*CACHED.get_or_init(|| {
// SAFETY: sysconf is a thread-safe libc function that takes a
// constant integer argument and returns a long. No invariants
// on the caller side.
let sz = unsafe { libc::sysconf(libc::_SC_PAGESIZE) };
if sz > 0 { sz as u64 } else { 0x1000 }
})
}
/// Build the auto-mount cmdline tokens for one disk. Returns an
/// empty string when no auto-mount is requested (Raw filesystem,
/// or `no_auto_mount` opt-out); otherwise returns the
/// space-prefixed `KTSTR_DISK0_FS=... KTSTR_DISK0_MOUNT=...`
/// pair, with `KTSTR_DISK0_RO=1` appended when `read_only` is
/// set.
///
/// Free fn so cfg(test) unit tests cover all branches without
/// driving a full `setup_memory` call.
///
/// Token contract (consumed by
/// `crate::vmm::rust_init::auto_mount_data_disks`):
/// * `KTSTR_DISK0_FS=<cache_tag>` — fstype string for the
/// `mount(2)` syscall. Reuses `Filesystem::cache_tag()` so the
/// on-disk-format identifier and the cmdline value stay in
/// lockstep.
/// * `KTSTR_DISK0_MOUNT=<path>` — guest-side mount point. Driven
/// by `DiskConfig::auto_mount_path` (`/mnt/<name>` when
/// `name` is set, `/mnt/disk0` otherwise).
/// * `KTSTR_DISK0_RO=1` — emitted only when `read_only` is set
/// (matches the host-side virtio-blk F_RO advertisement). The
/// guest sets `MS_RDONLY` proactively rather than letting the
/// kernel fail with -EROFS when bdev RO meets RW mount.
#[allow(dead_code)]
pub(crate) fn disk_auto_mount_cmdline_tokens(disk: &disk_config::DiskConfig) -> String {
if disk.filesystem == disk_config::Filesystem::Raw || disk.no_auto_mount {
return String::new();
}
let mut s = format!(
" KTSTR_DISK0_FS={} KTSTR_DISK0_MOUNT={}",
disk.filesystem.cache_tag(),
disk.auto_mount_path(),
);
if disk.read_only {
s.push_str(" KTSTR_DISK0_RO=1");
}
s
}
/// Pure helper: assemble the `extras` slice and the [`BaseKey`] from
/// the resolved scheduler/probe/worker/staged-binary paths. Extracted
/// out of [`KtstrVm::spawn_initramfs_resolve`] so the staged-extras
/// path-format contract, the per-staged iteration order, and the
/// shell-mode-vs-non-shell BaseKey threading can be unit-tested
/// without spawning the resolve thread or running the full
/// initramfs build.
///
/// Caller responsibilities:
/// - Pre-compute `staged_extras_names` as
/// `format!("{}/scheduler", staged_scheduler_archive_dir(&s.name))`
/// for each staged scheduler (the helper indexes into this vec by
/// position, so caller MUST keep order identical to
/// `staged_schedulers`). Materialized externally so the borrow
/// lifetime ties to the caller's owned Vec.
/// - Pre-compute `merged_includes` (operator's `include_files` plus
/// the optional alloc-worker binary).
/// - Pre-compute `has_jemalloc_extras` = `probe.is_some() ||
/// worker.is_some()` for shell-mode determination.
///
/// Returns `(extras, base_key)`. The extras vec borrows from
/// `scheduler`, `probe`, `staged_extras_names`, and
/// `staged_schedulers` — all `'a`-tied to the caller's lifetimes.
/// The base_key is owned `BaseKey`.
///
/// `#[allow(clippy::too_many_arguments)]` — the parameter set is
/// intrinsically flat (binaries + staging slice + flags); folding
/// into a builder or struct here would just rename the same
/// positional ordering. Sibling precedent: `build_vm_builder_base`
/// in `src/test_support/runtime.rs` uses the same allow for the
/// same reason.
#[allow(clippy::too_many_arguments)]
pub(crate) fn assemble_extras_and_key<'a>(
payload: &'a std::path::Path,
scheduler: Option<&'a std::path::Path>,
probe: Option<&'a std::path::Path>,
worker: Option<&'a std::path::Path>,
staged_schedulers: &'a [crate::vmm::builder::StagedScheduler],
staged_extras_names: &'a [String],
merged_includes: &'a [(String, PathBuf)],
busybox: bool,
has_jemalloc_extras: bool,
) -> Result<(Vec<(&'a str, &'a std::path::Path)>, BaseKey)> {
debug_assert_eq!(
staged_schedulers.len(),
staged_extras_names.len(),
"staged_schedulers and staged_extras_names must be co-indexed; \
caller mis-built the extras-names slice"
);
let mut extras: Vec<(&str, &std::path::Path)> = Vec::new();
if let Some(s) = scheduler {
extras.push(("scheduler", s));
}
if let Some(p) = probe {
extras.push(("bin/ktstr-jemalloc-probe", p));
}
for (idx, staged) in staged_schedulers.iter().enumerate() {
extras.push((staged_extras_names[idx].as_str(), staged.binary.as_path()));
}
// Shell-mode determination: busybox flag, non-empty includes,
// or any jemalloc extras (probe / worker present). Mirrors the
// pre-extraction logic in spawn_initramfs_resolve — kept
// explicit here so the helper is a closed unit under test
// without a hidden dependency on the caller's shell_mode
// computation.
let shell_mode = busybox || !merged_includes.is_empty() || has_jemalloc_extras;
let staged_for_key: Vec<(&str, &std::path::Path)> = staged_schedulers
.iter()
.map(|s| (s.name.as_str(), s.binary.as_path()))
.collect();
let key = if shell_mode {
BaseKey::new_shell(
payload,
scheduler,
probe,
worker,
&staged_for_key,
merged_includes,
busybox,
)?
} else {
BaseKey::new(payload, scheduler, probe, worker, &staged_for_key)?
};
Ok((extras, key))
}
impl KtstrVm {
/// Construct the optional virtio-blk device for the configured
/// disk in `self.disks`. Returns `Ok(None)` when no disk is
/// attached.
///
/// On `Ok(Some(_))`, the returned `Arc<PiMutex<VirtioBlk>>` has:
/// - the backing file open (sparse temp file when
/// `disk.backing_path` is `None`, otherwise the operator-supplied
/// path),
/// - the file extended to `disk.capacity_bytes()` (so unallocated
/// reads return zeros via short-read padding in `handle_read`),
/// - the throttle wired in,
/// - the irqfd registered with the VM,
/// - guest memory set so subsequent `process_requests` calls can
/// read/write descriptor data.
///
/// The framework reserves a single MMIO base + IRQ pair
/// (`VIRTIO_BLK_MMIO_BASE` / `VIRTIO_BLK_IRQ`); the builder's
/// `.disk()` enforces the single-disk constraint by overwriting
/// any previous disk on each call.
pub(super) fn init_virtio_blk(
&self,
vm: &kvm::KtstrKvm,
) -> Result<Option<Arc<PiMutex<virtio_blk::VirtioBlk>>>> {
if self.disks.is_empty() {
return Ok(None);
}
let disk = &self.disks[0];
let capacity = disk.capacity_bytes();
// Throttle sanity gate. `DiskThrottle::validate` rejects
// burst capacities below their refill rate (which would
// silently cap the steady-state at the lower capacity
// instead of the configured rate) and burst capacities set
// without a refill rate (a one-shot bucket that never
// refills). Run BEFORE allocating any backing-file resources
// so a misconfigured throttle bails before disk-side host
// commitments.
//
// The typed `DiskThrottleValidationError` carries the
// failing dimension (iops/bytes) so callers downcasting via
// `err.downcast_ref::<DiskThrottleValidationError>()` can
// route a programmatic recovery without parsing the
// rendered message.
disk.throttle
.validate()
.map_err(|e| anyhow::anyhow!(e).context("invalid disk throttle"))?;
// Per-test backing-file allocation forks on the configured
// [`disk_config::Filesystem`], with one override for the
// template-build VM driver:
//
// - **`template_staging_image` set** (internal-only — see
// [`KtstrVmBuilder::template_staging_image`]): open the
// caller-supplied path RW and hand it to the device. This
// branch exists exclusively for
// [`disk_template::build_template_via_vm`]: the driver
// materialises a sparse staging image, points the
// template-build guest at it via this field, and recovers
// the now-formatted file after VM exit for
// [`disk_template::store_atomic`]. Bypasses both the
// `Raw` tempfile and `Btrfs` ensure_template branches so
// the template-build VM cannot recursively re-enter the
// cache it is itself populating.
//
// - `Raw`: anonymous sparse `tempfile()`. The kernel
// reclaims storage when the device drops the File. No
// cache, no FICLONE.
//
// - `Btrfs`: FICLONE-clones the host-cached, guest-formatted
// template into a per-test tempfile under the cache root
// (so FICLONE source and dest share a filesystem), unlinks
// the dest immediately after open so the device sees the
// same anonymous-file semantics as the `Raw` path, and
// hands the open `File` to the `VirtioBlk` device. See
// [`crate::vmm::disk_template`] module docs.
let backing = if let Some(staging) = self.template_staging_image.as_ref() {
let f = std::fs::OpenOptions::new()
.read(true)
.write(true)
.open(staging)
.with_context(|| {
format!(
"open template staging image {} for virtio-blk",
staging.display(),
)
})?;
// Enforce the file-size = advertised-capacity invariant.
// The in-tree caller (`disk_template::build_template_via_vm`)
// sizes the staging file via
// `create_and_size_staging_image` before invoking the
// builder, so this is normally a no-op. Calling `set_len`
// here makes the contract local to the device-init path
// — a caller-supplied staging image that is too small or
// too large is normalised to `capacity` instead of
// letting virtio-blk advertise a size that disagrees with
// the backing file. Sparse-file semantics match the Raw
// branch above: holes don't consume disk space until
// written.
f.set_len(capacity)
.context("set template staging image length to capacity")?;
f
} else {
match disk.filesystem {
disk_config::Filesystem::Raw => {
let f = tempfile::tempfile()
.context("create virtio-blk sparse temp backing file")?;
// Make sure the file covers the advertised capacity.
// set_len creates a sparse file: holes don't consume
// disk space until written.
f.set_len(capacity)
.context("set virtio-blk backing file length")?;
f
}
disk_config::Filesystem::Btrfs => {
let template =
disk_template::ensure_template(disk_config::Filesystem::Btrfs, capacity)
.context("ensure btrfs disk template")?;
let cache_root = disk_template::cache_root()
.context("resolve disk-template cache root for per-test clone")?;
std::fs::create_dir_all(&cache_root)
.with_context(|| format!("create cache root {cache_root:?}"))?;
// Generate a unique per-test path under the cache
// root. Use pid + timestamp_ns + random_u64 so
// concurrent tests in the same process and across
// processes never collide.
let dest = cache_root.join(format!(
".per-test-{pid}-{ns:x}-{rnd:x}.img",
pid = std::process::id(),
ns = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.map(|d| d.as_nanos())
.unwrap_or(0),
rnd = rand::random::<u64>(),
));
let f = disk_template::clone_to_per_test(&template, &dest)
.context("FICLONE template into per-test backing")?;
// Unlink the dest path immediately. The open File
// keeps the inode alive for the device's lifetime;
// the kernel reclaims storage on drop, matching the
// `tempfile()` semantics of the Raw branch.
//
// If the unlink fails (very rare — ENOENT means a
// peer beat us to it, EACCES means the operator's
// cache permissions are broken, EBUSY can come from
// some FUSE backings), we keep the open File and
// warn — the device still works on the open fd, the
// only consequence is a stale path on disk that the
// next cache GC sweeps. Do NOT propagate the error,
// because the device's per-test backing is already
// valid and aborting VM init would be a regression
// versus the Raw branch where `tempfile::tempfile()`
// returns an already-unlinked file with no failure
// mode.
if let Err(e) = std::fs::remove_file(&dest) {
tracing::warn!(
path = %dest.display(),
error = %e,
"failed to unlink per-test btrfs backing after \
FICLONE; the open File still backs the device, \
but the leftover path will accumulate in the \
cache directory until manual cleanup or the \
next disk-template cache GC pass."
);
}
f
}
}
};
let mut blk =
virtio_blk::VirtioBlk::with_options(backing, capacity, disk.throttle, disk.read_only);
// Worker placement extracted from the host-topology plan.
// Perf-mode produces `pinning_plan.service_cpu` (a dedicated
// host CPU reserved away from vCPU pins) — the worker pins
// there to keep its cache footprint out of the workload-
// measured cpuset. Non-perf + `--cpu-cap` produces
// `no_perf_plan.cpus` (the LLC mask shared with vCPUs); the
// worker shares the LLC but stays inside the resource budget.
// The two paths are orthogonal (perf-mode never has
// `no_perf_plan` and vice versa); both `None` means inherit
// the parent's affinity (degraded-sysfs / non-cap-set
// fallback). The setter only takes effect on the next worker
// spawn — `with_options` deferred initial spawn to DRIVER_OK
// (matching the respawn path), so this call lands inside the
// window and the first worker observes the placement.
let placement = virtio_blk::WorkerPlacement {
service_cpu: self.pinning_plan.as_ref().and_then(|p| p.service_cpu),
no_perf_cpus: self.no_perf_plan.as_ref().map(|p| p.cpus.clone()),
};
blk.set_worker_placement(placement);
blk.set_mem((*vm.guest_mem).clone());
let blk_arc = Arc::new(PiMutex::new(blk));
// irqfd registration. On x86_64 with split irqchip, IOAPIC
// routing is unavailable: the kernel's split-irqchip mode
// emulates the LAPIC in-kernel and leaves PIC/IOAPIC to
// userspace. The framework does not implement userspace IOAPIC
// dispatch for virtio-mmio, and the kernel virtio_blk driver
// has no `mq_ops->timeout` (drivers/block/virtio_blk.c) and no
// polling fallback — without an IRQ delivery path, blk-mq
// hangs on every request until the hung-task watchdog fires
// (default 120 s). Reject loudly here so a topology that
// exceeds the 8-bit xAPIC limit (max APIC ID > 254) surfaces
// immediately instead of producing a silent guest hang.
#[cfg(target_arch = "x86_64")]
if vm.split_irqchip {
anyhow::bail!(
"virtio-blk requires irqfd; split-irqchip mode has no \
IOAPIC and the kernel virtio_mmio driver has no polling \
fallback — reduce topology so all APIC IDs are at or below 254 (MAX_XAPIC_ID)",
);
}
#[cfg(target_arch = "x86_64")]
{
vm.vm_fd
.register_irqfd(blk_arc.lock().irq_evt(), kvm::VIRTIO_BLK_IRQ)
.context("register virtio-blk irqfd")?;
}
#[cfg(target_arch = "aarch64")]
{
vm.vm_fd
.register_irqfd(blk_arc.lock().irq_evt(), kvm::VIRTIO_BLK_IRQ)
.context("register virtio-blk irqfd")?;
}
Ok(Some(blk_arc))
}
/// Construct the optional virtio-net device for the configured
/// network in `self.network`. Returns `Ok(None)` when no network
/// is attached.
///
/// On `Ok(Some(_))`, the returned `Arc<PiMutex<VirtioNet>>` has:
/// - the configured MAC baked into config space,
/// - guest memory set so subsequent `process_tx_loopback` calls
/// can read TX descriptor data and write into RX descriptors,
/// - the irqfd registered with the VM (rejected on x86 split
/// irqchip via `bail!()` below, matching virtio-blk).
///
/// The framework reserves a single MMIO base + IRQ pair
/// (`VIRTIO_NET_MMIO_BASE` / `VIRTIO_NET_IRQ`); the builder's
/// `.network()` enforces the single-device constraint by
/// overwriting any previous network on each call.
pub(super) fn init_virtio_net(
&self,
vm: &kvm::KtstrKvm,
) -> Result<Option<Arc<PiMutex<virtio_net::VirtioNet>>>> {
let Some(cfg) = self.network else {
return Ok(None);
};
let mut dev = virtio_net::VirtioNet::new(cfg);
dev.set_mem((*vm.guest_mem).clone());
let net_arc = Arc::new(PiMutex::new(dev));
// irqfd registration. Same split-irqchip rejection rationale
// as virtio-blk above: the kernel virtio_net driver depends
// on IRQ-driven NAPI to wake on RX, and an undelivered IRQ
// produces a silent guest hang. Reject loudly so the test
// setup is caught here.
#[cfg(target_arch = "x86_64")]
if vm.split_irqchip {
anyhow::bail!(
"virtio-net requires irqfd; split-irqchip mode has no \
IOAPIC and the kernel virtio_mmio driver has no polling \
fallback — reduce topology so all APIC IDs are at or below 254 (MAX_XAPIC_ID)",
);
}
#[cfg(target_arch = "x86_64")]
{
vm.vm_fd
.register_irqfd(net_arc.lock().irq_evt(), kvm::VIRTIO_NET_IRQ)
.context("register virtio-net irqfd")?;
}
#[cfg(target_arch = "aarch64")]
{
vm.vm_fd
.register_irqfd(net_arc.lock().irq_evt(), kvm::VIRTIO_NET_IRQ)
.context("register virtio-net irqfd")?;
}
Ok(Some(net_arc))
}
/// Create the KVM VM and optionally load the kernel.
///
/// When `memory_mib` is `Some`, allocates guest memory and loads the
/// kernel immediately (existing path). When `None` (deferred), creates
/// the VM without memory — allocation and kernel loading happen later
/// in `setup_memory` after the actual initramfs size is known.
pub(super) fn create_vm_and_load_kernel(
&self,
) -> Result<(kvm::KtstrKvm, Option<boot::KernelLoadResult>)> {
let t0 = Instant::now();
let use_hugepages = self.performance_mode
&& self.memory_mib.is_some_and(|mib| {
host_topology::hugepages_free() >= host_topology::hugepages_needed(mib)
});
let vm = match self.memory_mib {
Some(mib) => {
if use_hugepages {
kvm::KtstrKvm::new_with_hugepages(self.topology, mib, self.performance_mode)
.context("create VM with hugepages")?
} else {
kvm::KtstrKvm::new(self.topology, mib, self.performance_mode)
.context("create VM")?
}
}
None => {
kvm::KtstrKvm::new_deferred(self.topology, use_hugepages, self.performance_mode)
.context("create VM (deferred memory)")?
}
};
tracing::debug!(elapsed_us = t0.elapsed().as_micros(), "kvm_create");
// When memory is already allocated (non-deferred path), do mbind
// and load kernel now. Deferred path does this in setup_memory.
let kernel_result = if self.memory_mib.is_some() {
if self.performance_mode && !self.mbind_node_map.is_empty() {
let layout = vm.numa_layout.as_ref().expect(
"numa_layout is Some on the non-deferred allocation path: \
allocate_and_register_memory ran during `vm_new` because \
memory_mib was provided up front, and that call sets \
numa_layout to Some(...) in src/vmm/{x86_64,aarch64}/kvm.rs",
);
layout.mbind_regions(&vm.guest_mem, &self.mbind_node_map);
}
let t0 = Instant::now();
let kr = boot::load_kernel(&vm.guest_mem, &self.kernel).context("load kernel")?;
tracing::debug!(elapsed_us = t0.elapsed().as_micros(), "load_kernel");
Some(kr)
} else {
None
};
Ok((vm, kernel_result))
}
/// Spawn initramfs resolution on a background thread.
/// Returns the handle to join later (after KVM creation completes).
pub(super) fn spawn_initramfs_resolve(&self) -> Option<JoinHandle<Result<(BaseRef, BaseKey)>>> {
let bin = self.init_binary.as_ref()?;
let payload = bin.clone();
let scheduler = self.scheduler_binary.clone();
let probe = self.jemalloc_probe_binary.clone();
let worker = self.jemalloc_alloc_worker_binary.clone();
let include_files = self.include_files.clone();
let staged_schedulers = self.staged_schedulers.clone();
let busybox = self.busybox;
std::thread::Builder::new()
.name("initramfs-resolve".into())
.spawn(move || -> Result<(BaseRef, BaseKey)> {
// Extras are stripped by `build_initramfs_base`
// before write. The scheduler and probe can lose
// their DWARF without functional impact — the probe
// resolves `tsd_s.thread_allocated` offsets against
// the TARGET process's `/proc/<pid>/exe`, not against
// its own binary, so its own DWARF is dead weight.
// The worker (the probe's target) MUST retain DWARF:
// a stripped worker has no DWARF for the probe to
// walk. Route scheduler + probe through `extras`
// (stripped), worker through `include_files`
// (verbatim). Packing the probe unstripped inflated
// the initramfs by ~900MB per run in debug builds,
// which was enough to time out VM init before the
// test binary loaded.
//
// Staged schedulers ride the same `extras` path,
// packed under `staging/schedulers/<name>/scheduler`
// so the cpio extractor's silent parent-dir
// requirement gets satisfied via the auto-registered
// ancestor entries (see `build_initramfs_base`'s
// `register_parent_dirs` loop). Each staged binary
// contributes its own DT_NEEDED set to the shared-lib
// resolution chain — schedulers built against
// different libbpf revisions are correctly handled
// without operator intervention.
let staged_extras_names: Vec<String> = staged_schedulers
.iter()
.map(|s| {
format!(
"{}/scheduler",
crate::test_support::staged::staged_scheduler_archive_dir(&s.name),
)
})
.collect();
let has_jemalloc_extras = probe.as_deref().is_some() || worker.as_deref().is_some();
// Merge include_files with worker so both the cache
// key and the actual archive build see the same
// worker entry; the probe is added to extras inside
// `assemble_extras_and_key`.
let mut merged_includes: Vec<(String, PathBuf)> = include_files.clone();
if let Some(w) = worker.as_deref() {
merged_includes.push((
"bin/ktstr-jemalloc-alloc-worker".to_string(),
w.to_path_buf(),
));
}
let (extras, key) = assemble_extras_and_key(
&payload,
scheduler.as_deref(),
probe.as_deref(),
worker.as_deref(),
&staged_schedulers,
&staged_extras_names,
&merged_includes,
busybox,
has_jemalloc_extras,
)?;
let include_refs: Vec<(&str, &std::path::Path)> = merged_includes
.iter()
.map(|(a, p)| (a.as_str(), p.as_path()))
.collect();
let base = get_or_build_base(&payload, &extras, &include_refs, busybox, &key)?;
Ok((base, key))
})
.ok()
}
/// Compress base+suffix as separate LZ4 legacy streams, load into
/// guest memory via COW overlay (falling back to write_slice), and
/// verify the write. Returns `total_compressed_size`.
///
/// On a successful COW overlay, the returned `CowOverlayGuard` is
/// pushed onto `vm.cow_overlay_guards` IMMEDIATELY — before any
/// subsequent fallible operation (suffix write, read-back verify)
/// runs. This is deliberate: if a later `?` unwinds this function
/// after the MAP_FIXED overlay is in place, a locally-held guard
/// would drop first, releasing `LOCK_SH` while the COW VMAs are
/// still live. A concurrent writer could then take `LOCK_EX` and
/// truncate the segment → SIGBUS on the mapped pages. Pushing the
/// guard onto `vm` transfers ownership to the VM, where Drop
/// order is structurally enforced (guard drops AFTER
/// `_reservation` munmaps the COW VMAs).
fn compress_and_load_initrd(
&self,
vm: &mut kvm::KtstrKvm,
base_bytes: &[u8],
suffix: &[u8],
key: &BaseKey,
load_addr: u64,
) -> Result<u32> {
let uncompressed_size = base_bytes.len() + suffix.len();
// Compress base and suffix as separate LZ4 legacy streams. The
// kernel initramfs decompressor handles concatenated LZ4 natively
// (re-encountering the magic mid-stream resets the decoder).
// Keeping them separate lets us COW-map the base from SHM.
let t0 = Instant::now();
let lz4_base = self.get_or_compress_base(base_bytes, key)?;
let lz4_suffix = initramfs::lz4_legacy_compress(suffix);
let total_compressed = lz4_base.len() + lz4_suffix.len();
tracing::debug!(
elapsed_us = t0.elapsed().as_micros(),
uncompressed = uncompressed_size,
lz4_base = lz4_base.len(),
lz4_suffix = lz4_suffix.len(),
ratio = format!("{:.1}x", uncompressed_size as f64 / total_compressed as f64),
"lz4_initramfs",
);
tracing::debug!(
base_magic = format!(
"{:02x}{:02x}{:02x}{:02x}",
lz4_base[0], lz4_base[1], lz4_base[2], lz4_base[3]
),
suffix_magic = format!(
"{:02x}{:02x}{:02x}{:02x}",
lz4_suffix[0], lz4_suffix[1], lz4_suffix[2], lz4_suffix[3]
),
base_len = lz4_base.len(),
suffix_len = lz4_suffix.len(),
total = total_compressed,
load_addr = format!("{:#x}", load_addr),
suffix_addr = format!("{:#x}", load_addr + lz4_base.len() as u64),
"initrd_load_debug",
);
// Try COW overlay: mmap compressed base from SHM fd directly
// into guest memory, sharing physical pages across VMs.
let t0 = Instant::now();
let cow_guard = self.try_cow_overlay(&vm.guest_mem, key, lz4_base.len(), load_addr);
// IMPORTANT: stash the guard on the VM IMMEDIATELY — before
// any fallible operation below. If a `?` unwinds this function
// with a locally-held guard still on the stack, the guard
// drops first, releasing LOCK_SH while the COW VMAs are still
// live. Owned by `vm`, the guard drops with the VM's
// declared-order Drop, which is strictly after
// `_reservation` (and thus the COW VMAs). See
// `try_cow_overlay_rejects_cross_region_span` and the C4
// comment on `cow_overlay_guards` in kvm.rs.
let cow_active = cow_guard.is_some();
if let Some(guard) = cow_guard {
vm.cow_overlay_guards.push(guard);
}
if cow_active {
vm.guest_mem
.write_slice(&lz4_suffix, GuestAddress(load_addr + lz4_base.len() as u64))
.context("write lz4 suffix after COW base")?;
tracing::debug!(
elapsed_us = t0.elapsed().as_micros(),
cow = true,
"initrd_write"
);
} else {
initramfs::load_initramfs_parts(&vm.guest_mem, &[&lz4_base, &lz4_suffix], load_addr)?;
tracing::debug!(
elapsed_us = t0.elapsed().as_micros(),
cow = false,
"initrd_write"
);
}
// Read back first 8 bytes from guest memory to check write.
let mut check_buf = [0u8; 8];
vm.guest_mem
.read_slice(&mut check_buf, GuestAddress(load_addr))
.context("read-back initrd check")?;
tracing::debug!(
first_8 = format!(
"{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}",
check_buf[0],
check_buf[1],
check_buf[2],
check_buf[3],
check_buf[4],
check_buf[5],
check_buf[6],
check_buf[7]
),
expected_magic = "02214c18",
"initrd_verify",
);
Ok(total_compressed as u32)
}
/// Join the initramfs thread and load the result into guest memory.
/// Memory must already be allocated (non-deferred path). Validates
/// that allocated memory is sufficient for the initramfs.
///
/// x86_64-only: aarch64 uses
/// `Self::join_and_load_initramfs_aarch64`, which computes the
/// FDT-relative load address from the compressed size after the
/// suffix is built (the address depends on `memory_mib` AND the
/// total compressed size, neither of which is known until after
/// the suffix and compression run).
#[cfg(target_arch = "x86_64")]
fn join_and_load_initramfs(
&self,
vm: &mut kvm::KtstrKvm,
handle: JoinHandle<Result<(BaseRef, BaseKey)>>,
load_addr: u64,
) -> Result<(Option<u64>, Option<u32>)> {
let t0 = Instant::now();
let (base, key) = handle
.join()
.map_err(|_| anyhow::anyhow!("initramfs-resolve thread panicked"))??;
tracing::debug!(elapsed_us = t0.elapsed().as_micros(), "initramfs_join");
let base_bytes: &[u8] = base.as_ref();
let t0 = Instant::now();
let suffix = initramfs::build_suffix(base_bytes.len(), &self.suffix_params())?;
let uncompressed_size = base_bytes.len() + suffix.len();
tracing::debug!(
elapsed_us = t0.elapsed().as_micros(),
base_bytes = base_bytes.len(),
suffix_bytes = suffix.len(),
"build_suffix",
);
// Enforce minimum memory for initramfs extraction.
// This path is only reached when memory_mib was set explicitly.
let memory_mib = self.memory_mib.expect(
"join_and_load_initramfs called in deferred mode; \
use join_compute_memory_and_load instead",
);
// Compress first to get actual compressed size for validation.
let lz4_base = self.get_or_compress_base(base_bytes, &key)?;
let lz4_suffix = initramfs::lz4_legacy_compress(&suffix);
let compressed_size = lz4_base.len() + lz4_suffix.len();
let kernel_init_size = read_kernel_init_size(&self.kernel).unwrap_or(0) as u64;
let budget = MemoryBudget {
uncompressed_initramfs_bytes: uncompressed_size as u64,
compressed_initrd_bytes: compressed_size as u64,
kernel_init_size,
};
let min_mib = initramfs_min_memory_mib(&budget);
if memory_mib < min_mib {
anyhow::bail!(
"VM memory {}MiB insufficient for initramfs \
(uncompressed={}MiB, compressed={}MiB, \
init_size={}MiB): need {}MiB",
memory_mib,
uncompressed_size >> 20,
compressed_size >> 20,
kernel_init_size >> 20,
min_mib,
);
}
let size = self.compress_and_load_initrd(vm, base_bytes, &suffix, &key, load_addr)?;
Ok((Some(load_addr), Some(size)))
}
/// Deferred memory path: join initramfs, compute memory from actual
/// size, allocate guest memory, then load initramfs.
///
/// Returns `(initrd_addr, initrd_size, memory_mib)`.
///
/// x86_64-only: aarch64 uses
/// `Self::join_compute_memory_and_load_aarch64`, which orders
/// the load_addr computation after `allocate_and_register_memory`
/// (the FDT-relative initrd address depends on `memory_mib`,
/// which is itself computed from the post-compress total size).
#[cfg(target_arch = "x86_64")]
fn join_compute_memory_and_load(
&self,
vm: &mut kvm::KtstrKvm,
handle: JoinHandle<Result<(BaseRef, BaseKey)>>,
load_addr: u64,
) -> Result<(Option<u64>, Option<u32>, u32)> {
let t0 = Instant::now();
let (base, key) = handle
.join()
.map_err(|_| anyhow::anyhow!("initramfs-resolve thread panicked"))??;
tracing::debug!(elapsed_us = t0.elapsed().as_micros(), "initramfs_join");
let base_bytes: &[u8] = base.as_ref();
let t0 = Instant::now();
let suffix = initramfs::build_suffix(base_bytes.len(), &self.suffix_params())?;
let uncompressed_size = base_bytes.len() + suffix.len();
tracing::debug!(
elapsed_us = t0.elapsed().as_micros(),
base_bytes = base_bytes.len(),
suffix_bytes = suffix.len(),
"build_suffix",
);
let t0_compress = Instant::now();
let lz4_base = self.get_or_compress_base(base_bytes, &key)?;
let lz4_suffix = initramfs::lz4_legacy_compress(&suffix);
let compressed_size = lz4_base.len() + lz4_suffix.len();
tracing::debug!(
elapsed_us = t0_compress.elapsed().as_micros(),
uncompressed = uncompressed_size,
compressed = compressed_size,
ratio = format!("{:.1}x", uncompressed_size as f64 / compressed_size as f64),
"deferred_lz4_compress",
);
// Compute memory from actual sizes, honoring the
// topology-requested minimum when non-zero.
let kernel_init_size = read_kernel_init_size(&self.kernel).unwrap_or(0) as u64;
let budget = MemoryBudget {
uncompressed_initramfs_bytes: uncompressed_size as u64,
compressed_initrd_bytes: compressed_size as u64,
kernel_init_size,
};
let memory_mib = initramfs_min_memory_mib(&budget).max(self.memory_min_mib);
tracing::debug!(
uncompressed_mib = uncompressed_size >> 20,
compressed_mib = compressed_size >> 20,
init_size_mib = kernel_init_size >> 20,
memory_min_mib = self.memory_min_mib,
memory_mib,
"deferred_memory_computed",
);
// Allocate and register guest memory.
vm.allocate_and_register_memory(memory_mib)
.with_context(|| format!("allocate deferred memory ({memory_mib}MiB)"))?;
// Load pre-compressed data into guest memory. The base is already
// in the LZ4 SHM cache from get_or_compress_base above, so
// compress_and_load_initrd will hit the cache.
let size = self.compress_and_load_initrd(vm, base_bytes, &suffix, &key, load_addr)?;
Ok((Some(load_addr), Some(size), memory_mib))
}
pub(super) fn effective_memory_mib(&self, guest_mem: &GuestMemoryMmap) -> u32 {
use vm_memory::GuestMemoryRegion;
match self.memory_mib {
Some(mib) => mib,
None => {
let total_bytes: u64 = guest_mem.iter().map(|r| r.len()).sum();
(total_bytes >> 20) as u32
}
}
}
/// Get or build the compressed base. Checks LZ4 SHM first, then
/// compresses and stores.
fn get_or_compress_base(&self, base_bytes: &[u8], key: &BaseKey) -> Result<Vec<u8>> {
// Try loading compressed base from LZ4 SHM.
if let Some((fd, len)) = initramfs::shm_open_lz4(key.0) {
use std::os::fd::AsRawFd;
let mut buf = vec![0u8; len];
unsafe {
let ptr = libc::mmap(
std::ptr::null_mut(),
len,
libc::PROT_READ,
libc::MAP_SHARED,
fd.as_raw_fd(),
0,
);
if ptr != libc::MAP_FAILED {
std::ptr::copy_nonoverlapping(ptr as *const u8, buf.as_mut_ptr(), len);
libc::munmap(ptr, len);
initramfs::shm_close_fd(fd);
// Validate LZ4 legacy magic. Stale segments from a
// previous compression format (zstd) must be discarded.
if buf.len() >= 4 && buf[..4] == initramfs::LZ4_LEGACY_MAGIC {
tracing::debug!(bytes = len, "lz4_base cache hit (shm)");
return Ok(buf);
}
tracing::warn!(
bytes = len,
magic = format!("{:02x}{:02x}{:02x}{:02x}", buf[0], buf[1], buf[2], buf[3]),
"stale compressed shm segment (wrong magic), recompressing"
);
} else {
initramfs::shm_close_fd(fd);
}
}
}
// Compress with LZ4 legacy format.
let lz4 = initramfs::lz4_legacy_compress(base_bytes);
if let Err(e) = initramfs::shm_store_lz4(key.0, &lz4) {
tracing::warn!("shm_store_lz4: {e:#}");
}
Ok(lz4)
}
/// Try to COW-overlay the compressed base from LZ4 SHM into guest
/// memory. Returns `Some(CowOverlayGuard)` on success — the guard
/// owns the SHM fd and holds `LOCK_SH` for the mapping's lifetime,
/// and MUST be kept alive as long as the COW overlay is in use
/// (typically the VM lifetime). Validates the segment starts with
/// LZ4 legacy magic to reject stale data from a previous
/// compression format.
fn try_cow_overlay(
&self,
guest_mem: &GuestMemoryMmap,
key: &BaseKey,
expected_len: usize,
load_addr: u64,
) -> Option<initramfs::CowOverlayGuard> {
let (fd, len) = initramfs::shm_open_lz4(key.0)?;
if len != expected_len {
initramfs::shm_close_fd(fd);
return None;
}
// Validate LZ4 legacy magic before COW-mapping. pread the
// first 4 bytes directly — no need to mmap the entire segment
// just to peek at the header.
use std::os::fd::AsRawFd;
let mut magic = [0u8; 4];
// SAFETY: `fd` is owned by `shm_open_lz4` and remains valid
// until `shm_close_fd` below; `magic` is a 4-byte stack buffer
// and the read length is exactly 4. The fd refers to a SHM
// segment with `len >= expected_len` bytes (verified above and
// by `shm_open_lz4`'s fstat check).
let n = unsafe {
libc::pread(
fd.as_raw_fd(),
magic.as_mut_ptr() as *mut libc::c_void,
4,
0,
)
};
if n != 4 {
initramfs::shm_close_fd(fd);
return None;
}
if magic != initramfs::LZ4_LEGACY_MAGIC {
tracing::warn!(
magic = format!(
"{:02x}{:02x}{:02x}{:02x}",
magic[0], magic[1], magic[2], magic[3]
),
"stale compressed shm segment in COW path, skipping"
);
initramfs::shm_close_fd(fd);
return None;
}
// Refuse zero-length: mmap(len=0) is EINVAL and serves no
// purpose; the suffix-write fallback handles empty bases
// trivially. Also refuse load_addr + len overflow before
// bounds-checking, since GuestAddress arithmetic wraps
// silently on u64 overflow.
if len == 0 || load_addr.checked_add(len as u64).is_none() {
tracing::debug!(
load_addr = format!("{:#x}", load_addr),
len,
"cow_overlay: invalid range (zero-length or overflow), falling back"
);
initramfs::shm_close_fd(fd);
return None;
}
// The MAP_FIXED mmap rounds `len` up to the next host page
// boundary internally — Apple Silicon kernels run with 16 KB
// pages, so a 5000-byte segment mapped against a 16 KB-page
// host actually clobbers 16384 bytes of host VA. Bounds-check
// against the rounded-up length so we don't accept a mapping
// that overruns the guest region, and reject load_addr that
// isn't host-page-aligned (mmap returns EINVAL otherwise).
#[cfg(target_arch = "aarch64")]
let host_page = host_page_size();
// x86_64 hosts always run with 4 KB pages, and the call sites
// page-align load_addr to 4 KB; the rounded-up length matches
// `len` exactly. Use the constant instead of paying for a
// sysconf(2) on every overlay attempt.
#[cfg(target_arch = "x86_64")]
let host_page: u64 = 0x1000;
if load_addr & (host_page - 1) != 0 {
tracing::debug!(
load_addr = format!("{:#x}", load_addr),
host_page,
"cow_overlay: load_addr not host-page-aligned, falling back"
);
initramfs::shm_close_fd(fd);
return None;
}
let rounded_len = (len as u64)
.checked_add(host_page - 1)
.map(|v| v & !(host_page - 1));
let Some(rounded_len) = rounded_len else {
tracing::debug!(
load_addr = format!("{:#x}", load_addr),
len,
"cow_overlay: rounded length overflows u64, falling back"
);
initramfs::shm_close_fd(fd);
return None;
};
// Bounds-check [load_addr, load_addr + rounded_len) against
// guest memory BEFORE the MAP_FIXED mmap. `get_host_address`
// only validates the start address — without a length check,
// MAP_FIXED would silently overwrite whatever host VA happens
// to follow the region (other guest regions, reserved VA, or
// unrelated mappings). `get_slice` fails if the range extends
// past the region's end or spans a region boundary, which is
// exactly the guarantee MAP_FIXED needs.
let rounded_usize = match usize::try_from(rounded_len) {
Ok(v) => v,
Err(_) => {
tracing::debug!(
load_addr = format!("{:#x}", load_addr),
rounded_len,
"cow_overlay: rounded length exceeds usize, falling back"
);
initramfs::shm_close_fd(fd);
return None;
}
};
if guest_mem
.get_slice(GuestAddress(load_addr), rounded_usize)
.is_err()
{
tracing::debug!(
load_addr = format!("{:#x}", load_addr),
len,
rounded_len,
"cow_overlay: range exceeds guest memory region, falling back"
);
initramfs::shm_close_fd(fd);
return None;
}
let Ok(host_addr) = guest_mem.get_host_address(GuestAddress(load_addr)) else {
initramfs::shm_close_fd(fd);
return None;
};
// cow_overlay takes ownership of `fd` on both Some and None
// paths: on success the guard carries it; on failure
// cow_overlay itself closes it. Do NOT call shm_close_fd here.
unsafe { initramfs::cow_overlay(host_addr, len, fd) }
}
/// Write cmdline, boot params, and topology tables to guest memory.
///
/// When `kernel_result` is `None` (deferred memory mode), this method
/// first joins the initramfs thread to learn the actual size, allocates
/// guest memory from that size, does mbind, and loads the kernel — all
/// before proceeding with the normal initramfs load and boot param setup.
#[cfg(target_arch = "x86_64")]
pub(super) fn setup_memory(
&self,
vm: &mut kvm::KtstrKvm,
kernel_result: Option<boot::KernelLoadResult>,
initramfs_handle: Option<JoinHandle<Result<(BaseRef, BaseKey)>>>,
) -> Result<boot::KernelLoadResult> {
// Deferred memory path: join initramfs first to learn its size,
// then allocate memory, load kernel, and load initramfs — all in
// one shot with no estimation.
let (kernel_result, initrd_addr, initrd_size) = if let Some(kr) = kernel_result {
// Non-deferred: memory already allocated, kernel already loaded.
// compress_and_load_initrd transfers the CowOverlayGuard
// directly onto vm.cow_overlay_guards before any fallible
// operation, so a mid-function `?` cannot drop the guard
// before the COW VMAs are torn down.
let (initrd_addr, initrd_size) = match initramfs_handle {
Some(handle) => self.join_and_load_initramfs(vm, handle, INITRD_ADDR)?,
None => (None, None),
};
(kr, initrd_addr, initrd_size)
} else {
// Deferred memory path: join initramfs first to learn its size,
// then allocate memory, load kernel, and load initramfs — all in
// one shot with no estimation.
let (initrd_addr, initrd_size, _memory_mib) = match initramfs_handle {
Some(handle) => self.join_compute_memory_and_load(vm, handle, INITRD_ADDR)?,
None => {
// No initramfs — allocate minimum memory.
let memory_mib = 256u32;
vm.allocate_and_register_memory(memory_mib)
.context("allocate deferred memory (no initramfs)")?;
(None, None, memory_mib)
}
};
if self.performance_mode && !self.mbind_node_map.is_empty() {
let layout = vm.numa_layout.as_ref().expect(
"numa_layout is Some after the deferred allocate_and_register_memory \
call above: that call sets numa_layout to Some(...) in \
src/vmm/{x86_64,aarch64}/kvm.rs before this branch can reach here",
);
layout.mbind_regions(&vm.guest_mem, &self.mbind_node_map);
}
// Load kernel into the freshly allocated memory.
let t0 = Instant::now();
let kr = boot::load_kernel(&vm.guest_mem, &self.kernel).context("load kernel")?;
tracing::debug!(elapsed_us = t0.elapsed().as_micros(), "load_kernel");
(kr, initrd_addr, initrd_size)
};
// Resolve effective memory_mib for boot params / ACPI / SHM.
let memory_mib = self.effective_memory_mib(&vm.guest_mem);
// Kernel cmdline rationale (per flag):
// console=ttyS0 — serial console for host-visible output.
// nomodules — no out-of-tree modules are shipped; skip modprobe paths.
// mitigations=off — skip Spectre/Meltdown mitigations for VM perf.
// no_timer_check — suppress APIC timer-calibration failure under KVM.
// clocksource=kvm-clock — stable paravirt clock; avoid TSC drift under KVM.
// random.trust_cpu=on — seed RNG from RDRAND so userspace doesn't block on entropy.
// swiotlb=noforce — skip the IOMMU bounce buffer — no passthrough devices.
// i8042.*=noaux/nomux/nopnp/dumbkbd — skip legacy PS/2 probing; no keyboard/mouse in VM.
// pci=off — no PCI devices emulated; shave boot time by skipping the scan.
// reboot=k — use keyboard-controller reset method.
// panic=-1 — reboot immediately on panic; host detects via exit.
// lockdown=none — permit /dev/mem and unrestricted BPF needed by the test runtime.
// sysctl.kernel.unprivileged_bpf_disabled=0 — allow BPF load from the test runtime.
// sysctl.kernel.sched_schedstats=1 — enable /proc/schedstat for workload reports.
// delayacct — bare boot param consumed by the
// kernel's `__setup("delayacct", ...)`
// handler at kernel/delayacct.c:43-48.
// The handler sets `delayacct_on = 1`
// during EARLY boot, BEFORE
// `delayacct_init()` (line 50-55) reads
// the variable to decide whether to
// enable the static branch. This is the
// authoritative way to turn the
// delayacct subsystem on at boot.
// sysctl.kernel.task_delayacct=1 — backup runtime toggle that flips the
// delayacct_key static_branch via the
// `kernel.task_delayacct` sysctl declared
// at kernel/delayacct.c:80. This path
// fires later via deferred sysctl
// registration + proc_handler invocation,
// which has timing fragility relative to
// the early-boot increment paths
// (delayacct_blkio_start/_end gated by
// static_branch_unlikely(&delayacct_key)
// at kernel/delayacct.c). Both forms are
// specified — belt and suspenders — so
// the runtime toggle is on regardless of
// whether the early-boot or the deferred
// sysctl path runs first. Without either,
// /proc/<tid>/stat field 42 and the
// taskstats delay-accounting fields stay
// zero on every kernel built with
// CONFIG_TASK_DELAY_ACCT=y but boot-time
// off (the upstream default since v5.14).
let mut cmdline = concat!(
"console=ttyS0 nomodules mitigations=off ",
"no_timer_check clocksource=kvm-clock ",
"random.trust_cpu=on swiotlb=noforce ",
"i8042.noaux i8042.nomux i8042.nopnp i8042.dumbkbd ",
"pci=off reboot=k panic=-1 lockdown=none ",
"sysctl.kernel.unprivileged_bpf_disabled=0 ",
"sysctl.kernel.sched_schedstats=1 ",
"delayacct ",
"sysctl.kernel.task_delayacct=1 ",
// KASLR is ON by default — `ktstr.kconfig` pins
// `CONFIG_RANDOMIZE_BASE=y` (text-image slide) and
// `CONFIG_RANDOMIZE_MEMORY=y` (page_offset_base /
// vmalloc_base / vmemmap_base direct-map slides). The
// host's monitor + dump + freeze_coord consumers derive
// the runtime virt-KASLR offset via the
// [BSP MSR_LSTAR readback](src/vmm/x86_64/msr_kaslr.rs)
// PLUS the [KERN_ADDRS guest-channel `_text` path](src/vmm/guest_comms.rs::send_kern_addrs)
// and thread it through `coord_kaslr_offset()` into
// every kaslr-aware site (monitor::symbols::per_cpu_kva,
// monitor::dump::collect_per_cpu_time, capture_scx::
// compute_owned, kernel_op_dispatch::resolve_per_cpu_field_pa).
// The runtime `page_offset_base` is read host-side from
// /proc/kallsyms (see `vmm::rust_init::build_kern_addrs`)
// and shipped via `wire::KernAddrs.page_offset_base` for
// `monitor::symbols::kva_to_pa`. Tests that need
// determinism opt out via `#[ktstr_test(kaslr = false)]`
// or `Scheduler::kargs(&["nokaslr"])` — both re-add the
// `nokaslr` token through `runtime::build_cmdline_extra`.
// The `kaslr_offset_nonzero_post_boot` + sibling e2e
// regression tests guard the derivation chain.
"KTSTR_GUEST=1",
)
.to_string();
let verbose = std::env::var("KTSTR_VERBOSE")
.map(|v| v == "1")
.unwrap_or(false)
|| std::env::var("RUST_BACKTRACE").is_ok_and(|v| v == "1" || v == "full");
if verbose {
cmdline.push_str(" earlyprintk=serial loglevel=7");
} else {
cmdline.push_str(" loglevel=0");
}
if self.init_binary.is_some() {
cmdline.push_str(" rdinit=/init initramfs_options=size=90%");
}
// Virtio-console MMIO device on the kernel cmdline. The kernel's
// virtio_mmio_cmdline_devices driver parses this to register the
// MMIO transport at the given base address and IRQ.
cmdline.push_str(&format!(
" virtio_mmio.device={:#x}@{:#x}:{}",
virtio_console::VIRTIO_MMIO_SIZE,
kvm::VIRTIO_CONSOLE_MMIO_BASE,
kvm::VIRTIO_CONSOLE_IRQ,
));
// Virtio-block MMIO device — appended only when the builder
// attached at least one disk. The kernel's virtio_mmio_cmdline
// parser registers a MMIO transport per `virtio_mmio.device=`
// token; the order on the cmdline determines the device-probe
// order, which in turn determines the `/dev/vd{a,b,...}`
// assignment. Console-first then blk matches the expected
// `/dev/vda = first disk` mapping.
if !self.disks.is_empty() {
cmdline.push_str(&format!(
" virtio_mmio.device={:#x}@{:#x}:{}",
virtio_blk::VIRTIO_MMIO_SIZE,
kvm::VIRTIO_BLK_MMIO_BASE,
kvm::VIRTIO_BLK_IRQ,
));
// Auto-mount handshake. Emit a `KTSTR_DISK0_FS=<tag>`
// token whenever the first disk has been pre-formatted so
// the guest init at
// [`crate::vmm::rust_init::auto_mount_data_disks`]
// can mount `/dev/vda` at `/mnt/disk0` before the test
// dispatch runs. `Filesystem::Raw` skips the emission
// because there is no on-disk fs to mount; the guest
// sees only the absent token and short-circuits the
// mount path.
//
// `KTSTR_DISK0_RO=1` is emitted when the disk is
// configured `read_only`. The virtio_blk device
// advertises `VIRTIO_BLK_F_RO` for that case so the
// guest's gendisk is RO; mounting RW would fail with
// `-EROFS` (kernel `do_mount` path: `__btrfs_open_devices`
// probes the bdev's `bdev_read_only` and returns EROFS
// when the RW mount tries to write). The token lets the
// guest set `MS_RDONLY` proactively, surfacing the
// intent in the cmdline and avoiding the kernel-side
// EROFS path.
//
// The cache_tag() value is reused as the fstype string
// because it is already kebab-free, ≤8 chars, and
// matches the on-disk-format identifier the host
// selected — using the same value for both keeps the
// guest mount and host cache key in lockstep, so a
// future `Filesystem` variant rename only has to update
// one place (the `cache_tag` match in disk_config.rs)
// and the cmdline / mount automatically follow.
let disk = &self.disks[0];
cmdline.push_str(&disk_auto_mount_cmdline_tokens(disk));
}
// Virtio-net MMIO device — appended only when the builder
// attached a `NetConfig`. The kernel's virtio_mmio_cmdline
// parser registers a MMIO transport per `virtio_mmio.device=`
// token; placing this after virtio-blk does not affect device
// ordering on the guest's network stack (ifindex is assigned
// independently of cmdline order).
if self.network.is_some() {
cmdline.push_str(&format!(
" virtio_mmio.device={:#x}@{:#x}:{}",
virtio_net::VIRTIO_MMIO_SIZE,
kvm::VIRTIO_NET_MMIO_BASE,
kvm::VIRTIO_NET_IRQ,
));
}
if self.topology.has_memory_only_nodes() {
cmdline.push_str(" numa_balancing=enable");
} else {
cmdline.push_str(" numa_balancing=0");
}
if !self.cmdline_extra.is_empty() {
cmdline.push(' ');
cmdline.push_str(&self.cmdline_extra);
}
let t0 = Instant::now();
boot::write_cmdline(&vm.guest_mem, &cmdline)?;
boot::write_boot_params(
&vm.guest_mem,
&cmdline,
memory_mib,
initrd_addr,
initrd_size,
kernel_result.setup_header.as_ref(),
)?;
tracing::debug!(elapsed_us = t0.elapsed().as_micros(), "cmdline_boot_params");
let t0 = Instant::now();
mptable::setup_mptable(&vm.guest_mem, &self.topology)?;
let _acpi_layout = acpi::setup_acpi(
&vm.guest_mem,
&self.topology,
vm.numa_layout.as_ref().expect(
"numa_layout is Some by the time setup_acpi runs: \
memory allocation (whether deferred or not) ran earlier \
in this function and set numa_layout via \
allocate_and_register_memory in src/vmm/x86_64/kvm.rs",
),
)?;
tracing::debug!(elapsed_us = t0.elapsed().as_micros(), "mptable_acpi");
Ok(kernel_result)
}
/// Configure BSP and AP vCPUs.
#[cfg(target_arch = "x86_64")]
pub(super) fn setup_vcpus(&self, vm: &kvm::KtstrKvm, kernel_entry: u64) -> Result<()> {
let t0 = Instant::now();
boot::setup_sregs(&vm.guest_mem, &vm.vcpus[0], vm.split_irqchip)?;
boot::setup_regs(&vm.vcpus[0], kernel_entry)?;
boot::setup_fpu(&vm.vcpus[0])?;
boot::setup_msrs(&vm.vcpus[0], None)?;
boot::setup_lapic(&vm.vcpus[0], true)?;
vm.vcpus[0]
.set_mp_state(kvm_bindings::kvm_mp_state {
mp_state: kvm_bindings::KVM_MP_STATE_RUNNABLE,
})
.context("set BSP mp_state")?;
tracing::debug!(elapsed_us = t0.elapsed().as_micros(), "bsp_setup");
let t0 = Instant::now();
for vcpu in &vm.vcpus[1..] {
boot::setup_fpu(vcpu)?;
boot::setup_lapic(vcpu, false)?;
vcpu.set_mp_state(kvm_bindings::kvm_mp_state {
mp_state: kvm_bindings::KVM_MP_STATE_UNINITIALIZED,
})
.context("set AP mp_state")?;
}
tracing::debug!(
elapsed_us = t0.elapsed().as_micros(),
ap_count = vm.vcpus.len().saturating_sub(1),
"ap_setup"
);
Ok(())
}
}
#[cfg(target_arch = "aarch64")]
impl KtstrVm {
/// Allocate and register guest memory regions for aarch64, including
/// NUMA-aware placement.
///
/// Uses the same LZ4 SHM compress cache and COW overlay path as the
/// x86_64 [`Self::setup_memory`] flow. The shared helpers
/// ([`Self::get_or_compress_base`], [`Self::compress_and_load_initrd`],
/// [`Self::try_cow_overlay`]) are arch-neutral; this function differs
/// from the x86_64 driver only in (a) computing the initrd load
/// address from the dynamic FDT placement (`aarch64_initrd_addr`)
/// instead of the fixed `INITRD_ADDR`, and (b) handing off to
/// `finish_aarch64_setup` for FDT writing instead of boot_params /
/// ACPI emission.
pub(super) fn setup_memory_aarch64(
&self,
vm: &mut kvm::KtstrKvm,
kernel_result: Option<boot::KernelLoadResult>,
initramfs_handle: Option<JoinHandle<Result<(BaseRef, BaseKey)>>>,
) -> Result<boot::KernelLoadResult> {
// Deferred memory path for aarch64.
let (kernel_result, initrd_addr, initrd_size) = if let Some(kr) = kernel_result {
// Non-deferred: memory already allocated, kernel already loaded.
// compress_and_load_initrd transfers the CowOverlayGuard
// directly onto vm.cow_overlay_guards before any fallible
// operation, so a mid-function `?` cannot drop the guard
// before the COW VMAs are torn down.
let (initrd_addr, initrd_size) = match initramfs_handle {
Some(handle) => {
// `self.memory_mib` is required on the non-deferred
// path: deferred boots take the early-return branch
// below, so we only reach this site after the builder
// accepted a concrete `memory_mib`. Surface it as an
// error rather than `unwrap()` so a future refactor
// that drops the deferred guard fails loudly with an
// actionable diagnostic instead of an opaque panic.
let memory_mib = self.memory_mib.context(
"internal: non-deferred aarch64 path requires memory_mib to be set",
)?;
self.join_and_load_initramfs_aarch64(vm, handle, memory_mib)?
}
None => (None, None),
};
(kr, initrd_addr, initrd_size)
} else {
// Deferred memory path: join initramfs first to learn its
// size, allocate memory, then load kernel and initramfs.
let (initrd_addr, initrd_size) = match initramfs_handle {
Some(handle) => self.join_compute_memory_and_load_aarch64(vm, handle)?,
None => {
// No initramfs — allocate minimum memory.
let memory_mib = 256u32;
vm.allocate_and_register_memory(memory_mib)
.context("allocate deferred memory (no initramfs, aarch64)")?;
(None, None)
}
};
// Load kernel into the freshly allocated memory.
let t0 = Instant::now();
let kr =
boot::load_kernel(&vm.guest_mem, &self.kernel).context("load kernel (aarch64)")?;
tracing::debug!(elapsed_us = t0.elapsed().as_micros(), "load_kernel");
(kr, initrd_addr, initrd_size)
};
self.finish_aarch64_setup(vm, kernel_result, initrd_addr, initrd_size)
}
/// Non-deferred aarch64 initramfs load: join handle, build suffix,
/// compress base+suffix via the LZ4 SHM cache to learn the
/// compressed size, validate that `memory_mib` is sufficient, compute
/// the FDT-relative load address, then COW-or-copy the compressed
/// stream into guest memory via the shared
/// [`Self::compress_and_load_initrd`] path.
fn join_and_load_initramfs_aarch64(
&self,
vm: &mut kvm::KtstrKvm,
handle: JoinHandle<Result<(BaseRef, BaseKey)>>,
memory_mib: u32,
) -> Result<(Option<u64>, Option<u32>)> {
let t0 = Instant::now();
let (base, key) = handle
.join()
.map_err(|_| anyhow::anyhow!("initramfs-resolve thread panicked"))??;
tracing::debug!(elapsed_us = t0.elapsed().as_micros(), "initramfs_join");
let base_bytes: &[u8] = base.as_ref();
let t0 = Instant::now();
let suffix = initramfs::build_suffix(base_bytes.len(), &self.suffix_params())?;
let uncompressed_size = base_bytes.len() + suffix.len();
tracing::debug!(
elapsed_us = t0.elapsed().as_micros(),
base_bytes = base_bytes.len(),
suffix_bytes = suffix.len(),
"build_suffix",
);
// Compress to learn the compressed size for the load_addr
// calculation. Primes the LZ4 SHM cache so the subsequent
// compress_and_load_initrd call hits the cache instead of
// recompressing.
let lz4_base = self.get_or_compress_base(base_bytes, &key)?;
let lz4_suffix = initramfs::lz4_legacy_compress(&suffix);
let compressed_size = lz4_base.len() + lz4_suffix.len();
// Validate the operator-supplied memory_mib against the
// initramfs budget. Mirrors the x86_64 join_and_load_initramfs
// contract: a builder with too-small memory_mib fails fast here
// instead of OOMing during boot.
let kernel_init_size = read_kernel_init_size(&self.kernel).unwrap_or(0) as u64;
let budget = MemoryBudget {
uncompressed_initramfs_bytes: uncompressed_size as u64,
compressed_initrd_bytes: compressed_size as u64,
kernel_init_size,
};
let min_mib = initramfs_min_memory_mib(&budget);
if memory_mib < min_mib {
anyhow::bail!(
"VM memory {}MiB insufficient for initramfs \
(uncompressed={}MiB, compressed={}MiB, \
init_size={}MiB): need {}MiB",
memory_mib,
uncompressed_size >> 20,
compressed_size >> 20,
kernel_init_size >> 20,
min_mib,
);
}
let load_addr = aarch64_initrd_addr(memory_mib, compressed_size as u64);
let size = self.compress_and_load_initrd(vm, base_bytes, &suffix, &key, load_addr)?;
Ok((Some(load_addr), Some(size)))
}
/// Deferred aarch64 initramfs load: join handle, build suffix,
/// compress (priming the LZ4 SHM cache), compute memory budget,
/// allocate guest memory, then load initramfs via the shared
/// COW-overlay path. Returns `(Some(load_addr), Some(size))`.
fn join_compute_memory_and_load_aarch64(
&self,
vm: &mut kvm::KtstrKvm,
handle: JoinHandle<Result<(BaseRef, BaseKey)>>,
) -> Result<(Option<u64>, Option<u32>)> {
let t0 = Instant::now();
let (base, key) = handle
.join()
.map_err(|_| anyhow::anyhow!("initramfs-resolve thread panicked"))??;
tracing::debug!(elapsed_us = t0.elapsed().as_micros(), "initramfs_join");
let base_bytes: &[u8] = base.as_ref();
let t0 = Instant::now();
let suffix = initramfs::build_suffix(base_bytes.len(), &self.suffix_params())?;
let uncompressed_size = base_bytes.len() + suffix.len();
tracing::debug!(
elapsed_us = t0.elapsed().as_micros(),
base_bytes = base_bytes.len(),
suffix_bytes = suffix.len(),
"build_suffix",
);
// Compress before computing memory so the budget formula uses
// actual compressed size. Primes the LZ4 SHM cache so the
// subsequent compress_and_load_initrd call hits it.
let t0_compress = Instant::now();
let lz4_base = self.get_or_compress_base(base_bytes, &key)?;
let lz4_suffix = initramfs::lz4_legacy_compress(&suffix);
let compressed_size = lz4_base.len() + lz4_suffix.len();
tracing::debug!(
elapsed_us = t0_compress.elapsed().as_micros(),
uncompressed = uncompressed_size,
compressed = compressed_size,
ratio = format!("{:.1}x", uncompressed_size as f64 / compressed_size as f64),
"deferred_lz4_compress",
);
let kernel_init_size = read_kernel_init_size(&self.kernel).unwrap_or(0) as u64;
let budget = MemoryBudget {
uncompressed_initramfs_bytes: uncompressed_size as u64,
compressed_initrd_bytes: compressed_size as u64,
kernel_init_size,
};
let memory_mib = initramfs_min_memory_mib(&budget).max(self.memory_min_mib);
tracing::debug!(
uncompressed_mib = uncompressed_size >> 20,
compressed_mib = compressed_size >> 20,
init_size_mib = kernel_init_size >> 20,
memory_min_mib = self.memory_min_mib,
memory_mib,
"deferred_memory_computed",
);
vm.allocate_and_register_memory(memory_mib)
.with_context(|| format!("allocate deferred memory ({memory_mib}MiB, aarch64)"))?;
// Compute load_addr only AFTER memory_mib is known (it determines
// the FDT position, and the initrd sits just below FDT).
let load_addr = aarch64_initrd_addr(memory_mib, compressed_size as u64);
let size = self.compress_and_load_initrd(vm, base_bytes, &suffix, &key, load_addr)?;
Ok((Some(load_addr), Some(size)))
}
#[cfg(target_arch = "aarch64")]
fn finish_aarch64_setup(
&self,
vm: &kvm::KtstrKvm,
kernel_result: boot::KernelLoadResult,
initrd_addr: Option<u64>,
initrd_size: Option<u32>,
) -> Result<boot::KernelLoadResult> {
let memory_mib = self.effective_memory_mib(&vm.guest_mem);
// Kernel cmdline rationale (per flag) — aarch64 subset of the
// x86_64 block above. Flags present on both arches carry the
// same justification; see the x86_64 comment for details.
// aarch64-specific:
// kfence.sample_interval=0 — disable KFENCE sampling; no real
// driver faults to catch in the
// test VM, and KFENCE adds boot-time
// page-allocation pressure.
let mut cmdline = concat!(
"console=ttyS0 ",
"nomodules mitigations=off ",
"random.trust_cpu=on swiotlb=noforce ",
"panic=-1 lockdown=none ",
"sysctl.kernel.unprivileged_bpf_disabled=0 ",
"sysctl.kernel.sched_schedstats=1 ",
"delayacct sysctl.kernel.task_delayacct=1 ",
"kfence.sample_interval=0 ",
// KASLR is ON by default — see x86_64 cmdline above for
// the full host-side derivation chain rationale. On
// aarch64 the only KASLR axis is `CONFIG_RANDOMIZE_BASE`
// (kernel-image slide); arm64 has no
// `CONFIG_RANDOMIZE_MEMORY` equivalent (the kernel
// direct-map base is fixed by `VA_BITS` —
// `arch/arm64/include/asm/memory.h:43-45`). The
// KERN_ADDRS `_text` guest-channel path is the SOLE
// virt-KASLR derive on this arch (no MSR_LSTAR equivalent
// — MSR_LSTAR is x86 SYSCALL infrastructure). Tests opt
// out via `#[ktstr_test(kaslr = false)]` or
// `Scheduler::kargs(&["nokaslr"])` — same shape as x86.
"KTSTR_GUEST=1",
)
.to_string();
// earlycon is always enabled so the kernel has a console from
// the earliest boot stage. Without it, stdout-path auto-detection
// is the only path to early output — and that can fail silently
// if the FDT node isn't matched by OF_EARLYCON_DECLARE.
cmdline.push_str(" earlycon=uart,mmio,0x09000000");
let verbose = std::env::var("KTSTR_VERBOSE")
.map(|v| v == "1")
.unwrap_or(false)
|| std::env::var("RUST_BACKTRACE").is_ok_and(|v| v == "1" || v == "full");
if verbose {
cmdline.push_str(" loglevel=7");
} else {
cmdline.push_str(" loglevel=0");
}
if self.init_binary.is_some() {
cmdline.push_str(" rdinit=/init initramfs_options=size=90%");
}
// Auto-mount tokens for the configured disk. aarch64 advertises
// the virtio-blk MMIO transport via FDT (see
// `create_fdt(..., !self.disks.is_empty(), ...)` below), so the
// `virtio_mmio.device=` cmdline form used on x86_64 is omitted.
// The `KTSTR_DISK0_*` tokens, however, are env-style markers
// consumed by the guest init at
// `crate::vmm::rust_init::auto_mount_data_disks` — they are
// arch-neutral and required on aarch64 for the same auto-mount
// contract as x86_64.
if !self.disks.is_empty() {
let disk = &self.disks[0];
cmdline.push_str(&disk_auto_mount_cmdline_tokens(disk));
}
if self.topology.has_memory_only_nodes() {
cmdline.push_str(" numa_balancing=enable");
} else {
cmdline.push_str(" numa_balancing=0");
}
if !self.cmdline_extra.is_empty() {
cmdline.push(' ');
cmdline.push_str(&self.cmdline_extra);
}
let t0 = Instant::now();
boot::validate_cmdline(&cmdline)?;
let fdt_addr = aarch64::fdt::fdt_address(memory_mib);
let mpidrs =
aarch64::topology::read_mpidrs(&vm.vcpus).context("read vCPU MPIDRs for FDT")?;
let hw_cache_level = aarch64::topology::host_cache_levels();
let guest_l1_unified = aarch64::topology::host_l1_is_unified();
let dtb = aarch64::fdt::create_fdt(
&self.topology,
&mpidrs,
memory_mib,
&cmdline,
initrd_addr,
initrd_size,
hw_cache_level,
guest_l1_unified,
vm.numa_layout.as_ref().expect(
"numa_layout is Some by the time FDT creation runs: \
memory allocation (whether deferred or not) ran earlier \
in this function and set numa_layout via \
allocate_and_register_memory in src/vmm/aarch64/kvm.rs",
),
!self.disks.is_empty(),
self.network.is_some(),
vm.has_pmu,
)
.context("create FDT")?;
vm.guest_mem
.write_slice(&dtb, GuestAddress(fdt_addr))
.context("write FDT to guest memory")?;
tracing::debug!(
elapsed_us = t0.elapsed().as_micros(),
fdt_addr,
fdt_len = dtb.len(),
"cmdline_fdt",
);
Ok(kernel_result)
}
#[cfg(target_arch = "aarch64")]
pub(super) fn setup_vcpus_aarch64(&self, vm: &kvm::KtstrKvm, kernel_entry: u64) -> Result<()> {
let t0 = Instant::now();
let memory_mib = self.effective_memory_mib(&vm.guest_mem);
let fdt_addr = aarch64::fdt::fdt_address(memory_mib);
boot::setup_regs(&vm.vcpus[0], kernel_entry, fdt_addr)?;
tracing::debug!(elapsed_us = t0.elapsed().as_micros(), "bsp_setup");
// APs start powered off via PSCI — no register setup needed.
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
/// `Filesystem::Raw` disks emit no auto-mount cmdline tokens.
/// The host has nothing to advertise: no on-disk fs to mount,
/// the guest sees an unformatted `/dev/vda` and the
/// `auto_mount_data_disks` short-circuits at the absent
/// `KTSTR_DISK0_FS` check. Pin the empty-string contract so a
/// future regression that emits Raw-disk tokens (e.g. for a
/// "mount as raw block device" feature) surfaces here loudly.
#[test]
fn disk_auto_mount_cmdline_tokens_raw_emits_nothing() {
let disk = disk_config::DiskConfig::default();
assert_eq!(disk.filesystem, disk_config::Filesystem::Raw);
assert_eq!(disk_auto_mount_cmdline_tokens(&disk), "");
}
/// `Filesystem::Btrfs` with no name and no read_only emits the
/// FS + MOUNT pair only — no RO token. Default mount path is
/// `/mnt/disk0` (driven by `auto_mount_path()` returning the
/// disk0 fallback when `name` is `None`). The leading space
/// is the cmdline-concatenation contract: callers paste the
/// returned string directly.
#[test]
fn disk_auto_mount_cmdline_tokens_btrfs_default() {
let disk = disk_config::DiskConfig::default().filesystem(disk_config::Filesystem::Btrfs);
assert_eq!(
disk_auto_mount_cmdline_tokens(&disk),
" KTSTR_DISK0_FS=btrfs KTSTR_DISK0_MOUNT=/mnt/disk0",
);
}
/// Named `Filesystem::Btrfs` disk emits the name-driven mount
/// path `/mnt/<name>` instead of `/mnt/disk0`. Pin the name
/// → mount-path translation so a future `auto_mount_path`
/// regression (e.g. dropping the name and reverting to fixed
/// /mnt/disk0) surfaces here.
#[test]
fn disk_auto_mount_cmdline_tokens_btrfs_named() {
let disk = disk_config::DiskConfig::default()
.filesystem(disk_config::Filesystem::Btrfs)
.with_name("data");
assert_eq!(
disk_auto_mount_cmdline_tokens(&disk),
" KTSTR_DISK0_FS=btrfs KTSTR_DISK0_MOUNT=/mnt/data",
);
}
/// Read-only Btrfs disk emits the RO token in addition to FS
/// + MOUNT. The guest's `auto_mount_data_disks` checks
/// `KTSTR_DISK0_RO == "1"` and sets `MS_RDONLY` to avoid the
/// kernel-side -EROFS path on RW mount of a F_RO bdev.
#[test]
fn disk_auto_mount_cmdline_tokens_btrfs_read_only() {
let disk = disk_config::DiskConfig::default()
.filesystem(disk_config::Filesystem::Btrfs)
.read_only();
assert_eq!(
disk_auto_mount_cmdline_tokens(&disk),
" KTSTR_DISK0_FS=btrfs KTSTR_DISK0_MOUNT=/mnt/disk0 KTSTR_DISK0_RO=1",
);
}
/// `no_auto_mount` opt-out suppresses every auto-mount token,
/// even for a Btrfs disk that would otherwise emit them. The
/// host-side mkfs still happens (Filesystem::Btrfs drives the
/// template-cache lifecycle); only the guest auto-mount is
/// skipped, leaving raw `/dev/vda` access to the test author.
#[test]
fn disk_auto_mount_cmdline_tokens_no_auto_mount_suppresses() {
let disk = disk_config::DiskConfig::default()
.filesystem(disk_config::Filesystem::Btrfs)
.no_auto_mount();
assert_eq!(disk_auto_mount_cmdline_tokens(&disk), "");
// RO + named + no_auto_mount: still empty. The opt-out
// dominates every other config dimension.
let disk = disk_config::DiskConfig::default()
.filesystem(disk_config::Filesystem::Btrfs)
.with_name("data")
.read_only()
.no_auto_mount();
assert_eq!(disk_auto_mount_cmdline_tokens(&disk), "");
}
/// Raw disk + no_auto_mount: still empty. The Raw branch is
/// the gate; no_auto_mount is only meaningful for non-Raw
/// filesystems but the function tolerates the redundant
/// combination.
#[test]
fn disk_auto_mount_cmdline_tokens_raw_with_no_auto_mount() {
let disk = disk_config::DiskConfig::default().no_auto_mount();
assert_eq!(disk.filesystem, disk_config::Filesystem::Raw);
assert_eq!(disk_auto_mount_cmdline_tokens(&disk), "");
}
/// Pin the leading-space cmdline-concatenation contract. The
/// returned tokens MUST start with a space when non-empty so
/// they can be appended directly to the cmdline buffer in
/// `setup_memory`. A regression that drops the leading space
/// would create a glued-together token like
/// `virtio_mmio.device=...KTSTR_DISK0_FS=btrfs` which the
/// kernel cmdline parser would mis-classify as a single token.
#[test]
fn disk_auto_mount_cmdline_tokens_starts_with_space() {
let disk = disk_config::DiskConfig::default().filesystem(disk_config::Filesystem::Btrfs);
let s = disk_auto_mount_cmdline_tokens(&disk);
assert!(
s.starts_with(' '),
"non-empty tokens must start with a space for safe \
cmdline concatenation; got {s:?}",
);
}
/// Helper: build a temp dir with a payload binary + N staged-
/// scheduler binaries. Returns the tempdir guard (keep alive)
/// plus the payload path and a Vec<StagedScheduler> the test
/// can feed to `assemble_extras_and_key`.
fn build_synthetic_staged_set(
names: &[&str],
) -> (
tempfile::TempDir,
PathBuf,
Vec<crate::vmm::builder::StagedScheduler>,
) {
let dir = tempfile::Builder::new()
.prefix("ktstr-assemble-test-")
.tempdir()
.unwrap();
let payload = dir.path().join("payload");
std::fs::write(&payload, b"payload-content").unwrap();
let staged: Vec<crate::vmm::builder::StagedScheduler> = names
.iter()
.map(|name| {
let bin = dir.path().join(format!("staged_bin_{name}"));
std::fs::write(&bin, format!("staged-content-{name}").as_bytes()).unwrap();
crate::vmm::builder::StagedScheduler {
name: (*name).to_string(),
binary: bin,
sched_args: vec![format!("--variant={name}")],
}
})
.collect();
(dir, payload, staged)
}
/// Helper: pre-compute staged_extras_names the same way
/// spawn_initramfs_resolve does.
fn staged_extras_names_for(staged: &[crate::vmm::builder::StagedScheduler]) -> Vec<String> {
staged
.iter()
.map(|s| {
format!(
"{}/scheduler",
crate::test_support::staged::staged_scheduler_archive_dir(&s.name),
)
})
.collect()
}
/// T-3.1: each staged scheduler must land in `extras` under the
/// canonical `staging/schedulers/<name>/scheduler` archive path.
/// Pins the wire-up against a refactor that synthesizes the
/// archive path inline without going through
/// `staged_scheduler_archive_dir` — a drift would silently
/// desynchronize from the runtime resolver path.
#[test]
fn assemble_extras_and_key_emits_staged_binary_under_correct_archive_path() {
let (_tmp, payload, staged) = build_synthetic_staged_set(&["scx_foo", "scx_bar"]);
let names = staged_extras_names_for(&staged);
let (extras, _key) = assemble_extras_and_key(
payload.as_path(),
None,
None,
None,
&staged,
&names,
&[],
false,
false,
)
.unwrap();
let extras_names: Vec<&str> = extras.iter().map(|(n, _)| *n).collect();
assert!(
extras_names.contains(&"staging/schedulers/scx_foo/scheduler"),
"missing scx_foo at canonical archive path; got {extras_names:?}",
);
assert!(
extras_names.contains(&"staging/schedulers/scx_bar/scheduler"),
"missing scx_bar at canonical archive path; got {extras_names:?}",
);
}
/// T-3.2: staged_schedulers iteration order must align with the
/// extras-push order so `staged_extras_names[idx]` matches
/// `staged_schedulers[idx].binary`. Misalignment would silently
/// point name A at binary B's content — disastrous regression
/// where tests boot with wrong scheduler binaries under
/// correct-looking names.
#[test]
fn assemble_extras_and_key_preserves_staged_iteration_order_in_extras() {
let (_tmp, payload, staged) = build_synthetic_staged_set(&["alpha", "beta", "gamma"]);
let names = staged_extras_names_for(&staged);
let (extras, _key) = assemble_extras_and_key(
payload.as_path(),
None,
None,
None,
&staged,
&names,
&[],
false,
false,
)
.unwrap();
// Staged entries start after any of scheduler/probe (none
// here), so they occupy extras[0..3].
for (i, name) in ["alpha", "beta", "gamma"].iter().enumerate() {
let (entry_name, entry_path) = extras[i];
let expected_name = format!("staging/schedulers/{name}/scheduler");
assert_eq!(
entry_name, expected_name,
"extras[{i}] expected name '{expected_name}', got '{entry_name}'",
);
// The binary file is named staged_bin_<name> in the
// helper; verify the extras entry points at the matching
// binary path (binary owns the content for that name).
assert!(
entry_path
.to_string_lossy()
.ends_with(&format!("staged_bin_{name}")),
"extras[{i}] binary path '{}' does not match expected staged_bin_{name}",
entry_path.display(),
);
}
}
/// T-3.3: staged binaries must contribute to BaseKey in BOTH
/// shell-mode and non-shell-mode dispatch arms. A regression
/// dropping staged_for_key from one arm would silently un-
/// invalidate the cache for that mode, contaminating tests
/// across staged-set differences. Compares each mode's
/// "with-staged" key against an "empty-staged" baseline to
/// confirm the staged inputs participate in the digest.
#[test]
fn assemble_extras_and_key_threads_staged_into_basekey_in_both_modes() {
let (_tmp, payload, staged) = build_synthetic_staged_set(&["mitosis_a"]);
let names = staged_extras_names_for(&staged);
let empty: Vec<crate::vmm::builder::StagedScheduler> = vec![];
let empty_names: Vec<String> = vec![];
// Non-shell-mode arm (busybox=false, no includes, no
// jemalloc extras).
let (_, key_with_staged_nonshell) = assemble_extras_and_key(
payload.as_path(),
None,
None,
None,
&staged,
&names,
&[],
false,
false,
)
.unwrap();
let (_, key_empty_nonshell) = assemble_extras_and_key(
payload.as_path(),
None,
None,
None,
&empty,
&empty_names,
&[],
false,
false,
)
.unwrap();
assert_ne!(
key_with_staged_nonshell, key_empty_nonshell,
"non-shell-mode BaseKey must reflect staged contribution",
);
// Shell-mode arm (busybox=true forces shell mode without
// requiring any include_files / jemalloc extras).
let (_, key_with_staged_shell) = assemble_extras_and_key(
payload.as_path(),
None,
None,
None,
&staged,
&names,
&[],
true,
false,
)
.unwrap();
let (_, key_empty_shell) = assemble_extras_and_key(
payload.as_path(),
None,
None,
None,
&empty,
&empty_names,
&[],
true,
false,
)
.unwrap();
assert_ne!(
key_with_staged_shell, key_empty_shell,
"shell-mode BaseKey must reflect staged contribution",
);
// Belt-and-suspenders: shell-mode and non-shell-mode keys
// for the SAME staged set must differ (shell-mode keys mix
// a "ktstr-shell" sentinel — verify the shell-mode arm
// didn't accidentally call BaseKey::new).
assert_ne!(
key_with_staged_nonshell, key_with_staged_shell,
"shell-mode and non-shell-mode keys for same staged set \
must differ — confirms each arm calls its respective \
BaseKey constructor",
);
}
}