kh-runtime 0.1.8

Kakehashi native ARM64 execution context, memory layout, traps, and bottle
Documentation
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
//! Guest virtual memory backed by host `mmap` / `mprotect` / `munmap`.
//!
//! Mapping policy:
//! - Lengths and host addresses are rounded to the **host** page size.
//! - Preferred guest VAs are tried first (`MAP_FIXED_NOREPLACE` on Linux).
//! - On failure, a **contiguous host span** covering the whole image is
//!   reserved, a uniform slide is derived, and each segment is placed with
//!   `MAP_FIXED` inside that span. (Placing only the first segment free and
//!   then `MAP_FIXED_NOREPLACE` neighbours fails on Linux when ASLR put the
//!   first mapping next to another VMA — common for preferred base `0` dylibs.)
//! - `__PAGEZERO`-style regions (no access, no file, huge span) are skipped.
//! - File-backed content is copied into private anonymous pages (simpler than
//!   partial-page `MAP_PRIVATE` file maps). Executable pages start RW, then
//!   `mprotect` applies final permissions (W^X friendly).

use std::fs::File;
use std::io::{Read, Seek, SeekFrom};
use std::ptr;

use thiserror::Error;

use crate::host;

use super::layout::{HostPageSize, PageLayout};

/// Darwin `VM_PROT_*` bits (same numeric values as XNU).
pub const VM_PROT_READ: u32 = 0x1;
pub const VM_PROT_WRITE: u32 = 0x2;
pub const VM_PROT_EXECUTE: u32 = 0x4;

/// One mapped guest region (host-owned).
#[derive(Debug)]
pub struct MappedRegion {
    /// Segment / region name (for diagnostics).
    pub name: String,
    /// Guest virtual address (preferred + slide).
    pub guest_addr: u64,
    /// Host mapping base pointer.
    ptr: *mut u8,
    /// Host mapping length in bytes (host-page multiple).
    len: usize,
    /// Final protection bits (Darwin `VM_PROT_*`).
    pub prot: u32,
    /// File bytes copied into the mapping (0 for pure BSS / anonymous).
    pub file_bytes: u64,
    /// Virtual size requested by the image (may be smaller than host map).
    pub vmsize: u64,
}

// SAFETY: `MappedRegion` uniquely owns the mapping; the pointer is never shared
// across threads without external synchronization. `Send` is required so
// `GuestMemory` can move between threads before execution starts.
unsafe impl Send for MappedRegion {}

impl MappedRegion {
    /// Host base as a mutable byte slice covering the whole mapping.
    #[must_use]
    pub fn host_bytes_mut(&mut self) -> &mut [u8] {
        // SAFETY: we own this mapping for `len` bytes; it is RW until final
        // protect, and callers only use this before RX mprotect or on RW pages.
        unsafe { std::slice::from_raw_parts_mut(self.ptr, self.len) }
    }

    /// Host base as an immutable byte slice.
    #[must_use]
    pub fn host_bytes(&self) -> &[u8] {
        // SAFETY: mapping is live and owned; length is exact.
        unsafe { std::slice::from_raw_parts(self.ptr, self.len) }
    }

    /// Host virtual address of the mapping base.
    #[must_use]
    pub fn host_addr(&self) -> u64 {
        host::ptr_addr_u64(self.ptr)
    }

    /// Host mapping length.
    #[must_use]
    pub const fn host_len(&self) -> usize {
        self.len
    }
}

impl Drop for MappedRegion {
    fn drop(&mut self) {
        if !self.ptr.is_null() && self.len > 0 {
            if !host::munmap(self.ptr, self.len) {
                tracing::warn!(
                    name = %self.name,
                    len = self.len,
                    "munmap failed during MappedRegion drop"
                );
            }
            self.ptr = ptr::null_mut();
        }
    }
}

/// Request to map one segment-like region from a Mach-O image.
#[derive(Debug, Clone)]
pub struct MapRequest {
    /// Segment name.
    pub name: String,
    /// Preferred guest VA (slide 0).
    pub preferred_va: u64,
    /// Virtual size (`vmsize`).
    pub vmsize: u64,
    /// File offset of the first mapped byte (`fileoff`).
    pub fileoff: u64,
    /// Bytes to load from the file (`filesize`).
    pub filesize: u64,
    /// Initial protection (`initprot`, Darwin bits).
    pub initprot: u32,
    /// Maximum protection (`maxprot`, Darwin bits).
    pub maxprot: u32,
}

impl MapRequest {
    /// True when this region should not be mapped (null-catch / empty).
    #[must_use]
    pub fn should_skip(&self) -> bool {
        if self.vmsize == 0 {
            return true;
        }
        let is_pagezero = self.name == "__PAGEZERO"
            || (self.initprot == 0 && self.fileoff == 0 && self.filesize == 0);
        // PAGEZERO is typically 4 GiB — never materialize it.
        is_pagezero
    }
}

/// Fully mapped guest image address space (slide applied).
#[derive(Debug)]
pub struct GuestMemory {
    regions: Vec<MappedRegion>,
    /// Byte slide applied to preferred guest VAs (`actual = preferred + slide`).
    slide: u64,
    host: HostPageSize,
    preferred_base: u64,
}

/// Errors while mapping guest memory.
#[derive(Debug, Error)]
pub enum MapError {
    /// Invalid argument (zero length, overflow, …).
    #[error("invalid map request: {0}")]
    Invalid(&'static str),

    /// `mmap` / `mprotect` failed.
    #[error("mmap/mprotect failed for {name}: {source}")]
    Sys {
        /// Region name.
        name: String,
        /// Underlying OS error.
        #[source]
        source: std::io::Error,
    },

    /// File I/O while filling a mapping.
    #[error("file I/O while mapping {name}: {source}")]
    File {
        /// Region name.
        name: String,
        /// Underlying I/O error.
        #[source]
        source: std::io::Error,
    },

    /// Could not place the image (fixed and slid attempts failed).
    #[error("could not place guest image in host VA space")]
    PlacementFailed,
}

/// Upper bound on a single slid reservation (guards sparse / pathological layouts).
const MAX_SLIDE_SPAN: u64 = 512 * 1024 * 1024; // 512 MiB

impl GuestMemory {
    /// Maps all non-skipped requests into the host address space.
    ///
    /// Tries preferred addresses first; on failure reserves a contiguous host
    /// span for the whole image and places each segment with a uniform slide
    /// (guest VA == host VA after placement).
    pub fn map_image(
        host: HostPageSize,
        preferred_base: u64,
        requests: &[MapRequest],
        file: &mut File,
    ) -> Result<Self, MapError> {
        let active: Vec<&MapRequest> = requests.iter().filter(|r| !r.should_skip()).collect();
        if active.is_empty() {
            return Ok(Self {
                regions: Vec::new(),
                slide: 0,
                host,
                preferred_base,
            });
        }

        // Attempt 1: preferred VAs (slide = 0, never clobber host maps).
        match Self::try_map_all(host, preferred_base, 0, &active, file, FixedMode::NoReplace) {
            Ok(regions) => {
                return Ok(Self {
                    regions,
                    slide: 0,
                    host,
                    preferred_base,
                });
            }
            Err(err) => {
                tracing::debug!(error = %err, "preferred-base map failed; trying slid placement");
            }
        }

        // Attempt 2: reserve full image span, slide every segment into it.
        match Self::try_map_slid_reserved(host, preferred_base, &active, file) {
            Ok(mem) => return Ok(mem),
            Err(err) => {
                tracing::debug!(error = %err, "reserved-span slid map failed; trying first-region slide");
            }
        }

        // Attempt 3 (legacy): free-place first region, fixed-relative rest.
        // Works when the image is a single segment or the kernel left a hole.
        Self::try_map_slid_first_region(host, preferred_base, &active, file)
    }

    /// Kernel-chosen contiguous span for the whole image, then `MAP_FIXED` each segment.
    fn try_map_slid_reserved(
        host: HostPageSize,
        preferred_base: u64,
        active: &[&MapRequest],
        file: &mut File,
    ) -> Result<Self, MapError> {
        let (span_lo, span_hi) = image_preferred_span(host, active)?;
        let span_len_u64 = span_hi.saturating_sub(span_lo);
        if span_len_u64 == 0 {
            return Err(MapError::Invalid("empty image span"));
        }
        if span_len_u64 > MAX_SLIDE_SPAN {
            return Err(MapError::Invalid(
                "image span too large for slid reservation",
            ));
        }
        let span_len =
            usize::try_from(span_len_u64).map_err(|_| MapError::Invalid("span too large"))?;

        // Reserve with PROT_NONE so the VA range cannot be stolen before we carve it.
        let flags = libc::MAP_PRIVATE | libc::MAP_ANONYMOUS;
        let Some(reserve_ptr) = host::mmap(None, span_len, libc::PROT_NONE, flags, -1, 0) else {
            return Err(MapError::Sys {
                name: "__RESERVE".into(),
                source: std::io::Error::last_os_error(),
            });
        };
        let reserve_base = host::ptr_addr_u64(reserve_ptr);
        let slide = reserve_base.wrapping_sub(span_lo);

        tracing::debug!(
            span_lo = format_args!("{span_lo:#x}"),
            span_hi = format_args!("{span_hi:#x}"),
            reserve = format_args!("{reserve_base:#x}"),
            slide = format_args!("{slide:#x}"),
            "reserved contiguous host span for slid image"
        );

        // Carve segments with MAP_FIXED (replaces PROT_NONE pages in place).
        match Self::try_map_all(
            host,
            preferred_base,
            slide,
            active,
            file,
            FixedMode::Replace,
        ) {
            Ok(regions) => {
                // Carve-outs leave PROT_NONE residue in gaps; release it so the
                // address space does not retain untracked maps.
                unmap_span_gaps(reserve_base, span_len_u64, &regions);
                Ok(Self {
                    regions,
                    slide,
                    host,
                    preferred_base,
                })
            }
            Err(err) => {
                // Successful segment maps were already dropped by `try_map_all`.
                // Drop any leftover PROT_NONE from the original reservation.
                // (May no-op for ranges already replaced+dropped.)
                let _ = host::munmap(reserve_ptr, span_len);
                Err(err)
            }
        }
    }

    /// Free-place the first region; map the rest at preferred + slide (fixed, no-replace).
    fn try_map_slid_first_region(
        host: HostPageSize,
        preferred_base: u64,
        active: &[&MapRequest],
        file: &mut File,
    ) -> Result<Self, MapError> {
        let first = active
            .first()
            .copied()
            .ok_or(MapError::Invalid("no active regions"))?;
        let first_map = map_one(host, first, first.preferred_va, file, FixedMode::Free)?;
        let slide = first_map.guest_addr.wrapping_sub(first.preferred_va);

        let mut regions = vec![first_map];
        for req in active.iter().skip(1) {
            let target = req.preferred_va.wrapping_add(slide);
            match map_one(host, req, target, file, FixedMode::NoReplace) {
                Ok(region) => regions.push(region),
                Err(err) => {
                    drop(regions);
                    tracing::debug!(error = %err, "slid fixed map failed");
                    return Err(MapError::PlacementFailed);
                }
            }
        }

        Ok(Self {
            regions,
            slide,
            host,
            preferred_base,
        })
    }

    fn try_map_all(
        host: HostPageSize,
        preferred_base: u64,
        slide: u64,
        active: &[&MapRequest],
        file: &mut File,
        fixed: FixedMode,
    ) -> Result<Vec<MappedRegion>, MapError> {
        let mut regions = Vec::with_capacity(active.len());
        for req in active {
            let target = req.preferred_va.wrapping_add(slide);
            match map_one(host, req, target, file, fixed) {
                Ok(region) => regions.push(region),
                Err(err) => {
                    drop(regions);
                    return Err(err);
                }
            }
        }
        let _ = preferred_base;
        Ok(regions)
    }

    /// Applied slide in bytes.
    #[must_use]
    pub const fn slide(&self) -> u64 {
        self.slide
    }

    /// Preferred base used when planning.
    #[must_use]
    pub const fn preferred_base(&self) -> u64 {
        self.preferred_base
    }

    /// Host page size policy.
    #[must_use]
    pub const fn host(&self) -> HostPageSize {
        self.host
    }

    /// Mapped regions in plan order (skips omitted).
    #[must_use]
    pub fn regions(&self) -> &[MappedRegion] {
        &self.regions
    }

    /// Mutable access to regions (e.g. SVC rewrite before protect).
    pub fn regions_mut(&mut self) -> &mut [MappedRegion] {
        &mut self.regions
    }

    /// Translates a guest VA to a host pointer if it falls in a mapped region.
    #[must_use]
    pub fn guest_to_host(&self, guest_va: u64) -> Option<*const u8> {
        for region in &self.regions {
            let start = region.guest_addr;
            let end = start.saturating_add(region.vmsize);
            if guest_va >= start && guest_va < end {
                let offset = usize::try_from(guest_va.saturating_sub(start)).ok()?;
                if offset >= region.len {
                    return None;
                }
                // SAFETY: offset < len, pointer derived from owned mapping base.
                return Some(unsafe { region.ptr.add(offset) });
            }
        }
        None
    }

    /// Translates guest VA to a mutable host pointer.
    #[must_use]
    pub fn guest_to_host_mut(&mut self, guest_va: u64) -> Option<*mut u8> {
        for region in &mut self.regions {
            let start = region.guest_addr;
            let end = start.saturating_add(region.vmsize);
            if guest_va >= start && guest_va < end {
                let offset = usize::try_from(guest_va.saturating_sub(start)).ok()?;
                if offset >= region.len {
                    return None;
                }
                return Some(unsafe { region.ptr.add(offset) });
            }
        }
        None
    }

    /// Reads a little-endian `u32` from a mapped guest VA.
    #[must_use]
    pub fn read_u32_le(&self, guest_va: u64) -> Option<u32> {
        let mut buf = [0_u8; 4];
        self.read_exact(guest_va, &mut buf)?;
        Some(u32::from_le_bytes(buf))
    }

    /// Reads a little-endian `u64` from a mapped guest VA.
    #[must_use]
    pub fn read_u64_le(&self, guest_va: u64) -> Option<u64> {
        let mut buf = [0_u8; 8];
        self.read_exact(guest_va, &mut buf)?;
        Some(u64::from_le_bytes(buf))
    }

    /// Writes a little-endian `u64` to a mapped guest VA.
    ///
    /// Caller must ensure the region is writable (`mprotect_rw` if needed).
    pub fn write_u64_le(&mut self, guest_va: u64, value: u64) -> Option<()> {
        self.write_exact(guest_va, &value.to_le_bytes())
    }

    /// Copies `buf.len()` bytes from a mapped guest VA into `buf`.
    pub fn read_exact(&self, guest_va: u64, buf: &mut [u8]) -> Option<()> {
        if buf.is_empty() {
            return Some(());
        }
        for region in &self.regions {
            let start = region.guest_addr;
            let end = start.saturating_add(region.vmsize);
            if guest_va >= start && guest_va < end {
                let offset = usize::try_from(guest_va.saturating_sub(start)).ok()?;
                let need = buf.len();
                let avail = region.len.saturating_sub(offset);
                if need > avail {
                    return None;
                }
                let host = region.host_bytes();
                let src = host.get(offset..offset.saturating_add(need))?;
                buf.copy_from_slice(src);
                return Some(());
            }
        }
        None
    }

    /// Copies `buf` into a mapped guest VA (region must be host-writable).
    pub fn write_exact(&mut self, guest_va: u64, buf: &[u8]) -> Option<()> {
        if buf.is_empty() {
            return Some(());
        }
        for region in &mut self.regions {
            let start = region.guest_addr;
            let end = start.saturating_add(region.vmsize);
            if guest_va >= start && guest_va < end {
                let offset = usize::try_from(guest_va.saturating_sub(start)).ok()?;
                let need = buf.len();
                let avail = region.len.saturating_sub(offset);
                if need > avail {
                    return None;
                }
                let host = region.host_bytes_mut();
                let dst = host.get_mut(offset..offset.saturating_add(need))?;
                dst.copy_from_slice(buf);
                return Some(());
            }
        }
        None
    }

    /// Testing helper: pretends the image was slid by `delta` without remapping.
    ///
    /// Updates [`Self::slide`] and each region's `guest_addr`. Host pointers are
    /// unchanged (identity is intentionally broken). Used by loader unit tests when
    /// true preferred-base collisions are unavailable (macOS `MAP_FIXED` clobbers
    /// blockers). Not for production load paths.
    #[doc(hidden)]
    pub fn test_offset_guest_vas(&mut self, delta: u64) {
        self.slide = self.slide.wrapping_add(delta);
        for region in &mut self.regions {
            region.guest_addr = region.guest_addr.wrapping_add(delta);
        }
    }
}

/// How to place a single region relative to a preferred / slid guest VA.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum FixedMode {
    /// Kernel chooses address (`guest_addr` becomes host base).
    Free,
    /// Fixed address; do not clobber existing maps (`MAP_FIXED_NOREPLACE` on Linux).
    NoReplace,
    /// Fixed address; replace any mapping already at that VA (`MAP_FIXED`).
    /// Used after a PROT_NONE span reservation so carve-outs succeed.
    Replace,
}

fn map_one(
    host: HostPageSize,
    req: &MapRequest,
    target_guest: u64,
    file: &mut File,
    mode: FixedMode,
) -> Result<MappedRegion, MapError> {
    let host_page = host.bytes();
    let map_len_u64 = PageLayout::align_up(req.vmsize, host_page)
        .ok_or(MapError::Invalid("vmsize align overflow"))?;
    let map_len =
        usize::try_from(map_len_u64).map_err(|_| MapError::Invalid("vmsize too large"))?;
    if map_len == 0 {
        return Err(MapError::Invalid("zero map length"));
    }

    let mut flags = libc::MAP_PRIVATE | libc::MAP_ANONYMOUS;
    let fixed = matches!(mode, FixedMode::NoReplace | FixedMode::Replace);
    match mode {
        FixedMode::Free => {}
        FixedMode::NoReplace => flags |= host::fixed_map_flag(),
        FixedMode::Replace => flags |= libc::MAP_FIXED,
    }

    // Map RW first so we can fill file content; tighten with mprotect after.
    let prot_rw = libc::PROT_READ | libc::PROT_WRITE;
    let fixed_addr = if fixed { Some(target_guest) } else { None };

    let Some(base) = host::mmap(fixed_addr, map_len, prot_rw, flags, -1, 0) else {
        return Err(MapError::Sys {
            name: req.name.clone(),
            source: std::io::Error::last_os_error(),
        });
    };

    let actual_host = host::ptr_addr_u64(base);
    // For non-fixed maps, guest VA becomes the host address (identity slide).
    let guest_addr = if fixed { target_guest } else { actual_host };

    let mut region = MappedRegion {
        name: req.name.clone(),
        guest_addr,
        ptr: base,
        len: map_len,
        prot: req.initprot,
        file_bytes: 0,
        vmsize: req.vmsize,
    };

    // Copy file-backed bytes into the mapping.
    if req.filesize > 0 {
        let copy_len = usize::try_from(req.filesize.min(req.vmsize))
            .map_err(|_| MapError::Invalid("filesize too large"))?;
        if copy_len > map_len {
            return Err(MapError::Invalid("filesize exceeds map length"));
        }
        file.seek(SeekFrom::Start(req.fileoff))
            .map_err(|source| MapError::File {
                name: req.name.clone(),
                source,
            })?;
        let dst = region.host_bytes_mut();
        let Some(slice) = dst.get_mut(..copy_len) else {
            return Err(MapError::Invalid("copy slice out of range"));
        };
        file.read_exact(slice).map_err(|source| MapError::File {
            name: req.name.clone(),
            source,
        })?;
        region.file_bytes = u64::try_from(copy_len).unwrap_or(0);
    }

    // Apply final protection. Empty initprot → PROT_NONE.
    let host_prot = darwin_to_host_prot(req.initprot);
    if !host::mprotect(base, map_len, host_prot) {
        return Err(MapError::Sys {
            name: req.name.clone(),
            source: std::io::Error::last_os_error(),
        });
    }

    // When fixed, require exact placement.
    if fixed && actual_host != target_guest {
        return Err(MapError::Sys {
            name: req.name.clone(),
            source: std::io::Error::new(
                std::io::ErrorKind::AddrNotAvailable,
                format!("kernel placed map at {actual_host:#x}, wanted {target_guest:#x}"),
            ),
        });
    }

    Ok(region)
}

/// Preferred VA span covering every active segment (host-page aligned ends).
fn image_preferred_span(
    host: HostPageSize,
    active: &[&MapRequest],
) -> Result<(u64, u64), MapError> {
    let host_page = host.bytes();
    let mut lo = u64::MAX;
    let mut hi = 0_u64;
    for req in active {
        lo = lo.min(req.preferred_va);
        let end = req
            .preferred_va
            .checked_add(
                PageLayout::align_up(req.vmsize, host_page)
                    .ok_or(MapError::Invalid("vmsize align overflow"))?,
            )
            .ok_or(MapError::Invalid("segment end overflow"))?;
        hi = hi.max(end);
    }
    if lo == u64::MAX || hi <= lo {
        return Err(MapError::Invalid("no span from active segments"));
    }
    // Align span start down so MAP_FIXED bases stay host-page aligned when preferred is.
    let lo = PageLayout::align_down(lo, host_page).unwrap_or(lo);
    Ok((lo, hi))
}

/// Best-effort: release PROT_NONE pages left in the reserved span outside mapped segments.
fn unmap_span_gaps(reserve_base: u64, span_len: u64, regions: &[MappedRegion]) {
    if span_len == 0 || regions.is_empty() {
        return;
    }
    let span_end = reserve_base.saturating_add(span_len);
    let mut covered: Vec<(u64, u64)> = regions
        .iter()
        .map(|r| {
            let start = r.guest_addr;
            let end = start.saturating_add(u64::try_from(r.len).unwrap_or(0));
            (start, end)
        })
        .collect();
    covered.sort_by_key(|(s, _)| *s);

    let mut cursor = reserve_base;
    for (start, end) in covered {
        if start > cursor && start <= span_end {
            let gap_len = start.saturating_sub(cursor);
            if let Ok(len) = usize::try_from(gap_len)
                && len > 0
            {
                let ptr = host::u64_as_void_ptr(cursor).cast::<u8>();
                let _ = host::munmap(ptr, len);
            }
        }
        cursor = cursor.max(end);
    }
    if cursor < span_end {
        let gap_len = span_end.saturating_sub(cursor);
        if let Ok(len) = usize::try_from(gap_len)
            && len > 0
        {
            let ptr = host::u64_as_void_ptr(cursor).cast::<u8>();
            let _ = host::munmap(ptr, len);
        }
    }
}

/// Converts Darwin `VM_PROT_*` to host `PROT_*`.
#[must_use]
pub const fn darwin_to_host_prot(darwin: u32) -> libc::c_int {
    if darwin == 0 {
        return libc::PROT_NONE;
    }
    let mut prot = 0;
    if darwin & VM_PROT_READ != 0 {
        prot |= libc::PROT_READ;
    }
    if darwin & VM_PROT_WRITE != 0 {
        prot |= libc::PROT_WRITE;
    }
    if darwin & VM_PROT_EXECUTE != 0 {
        prot |= libc::PROT_EXEC;
    }
    prot
}

/// Maps an anonymous RW stack region (guest VA == host VA, kernel-chosen).
///
/// `size` is rounded up to the host page size. The returned region's
/// `guest_addr` is the low address of the mapping; the stack pointer should be
/// near `guest_addr + vmsize`.
pub fn map_stack(host: HostPageSize, size: u64) -> Result<MappedRegion, MapError> {
    let host_page = host.bytes();
    let map_len_u64 =
        PageLayout::align_up(size.max(1), host_page).ok_or(MapError::Invalid("stack align"))?;
    let map_len = usize::try_from(map_len_u64).map_err(|_| MapError::Invalid("stack too large"))?;

    let flags = libc::MAP_PRIVATE | libc::MAP_ANONYMOUS;
    let prot = libc::PROT_READ | libc::PROT_WRITE;
    let Some(base) = host::mmap(None, map_len, prot, flags, -1, 0) else {
        return Err(MapError::Sys {
            name: "__STACK".into(),
            source: std::io::Error::last_os_error(),
        });
    };
    Ok(MappedRegion {
        name: "__STACK".into(),
        guest_addr: host::ptr_addr_u64(base),
        ptr: base,
        len: map_len,
        prot: VM_PROT_READ | VM_PROT_WRITE,
        file_bytes: 0,
        vmsize: map_len_u64,
    })
}

/// Temporarily makes a region read/write (for SVC patching / bind writes).
///
/// No-op when Darwin `prot` already includes write (host mapping is already RW).
pub fn mprotect_rw(region: &MappedRegion) -> Result<(), MapError> {
    if region.prot & VM_PROT_WRITE != 0 {
        return Ok(());
    }
    if host::mprotect(region.ptr, region.len, libc::PROT_READ | libc::PROT_WRITE) {
        Ok(())
    } else {
        Err(MapError::Sys {
            name: region.name.clone(),
            source: std::io::Error::last_os_error(),
        })
    }
}

/// Restores Darwin-derived host protection on a region.
pub fn mprotect_darwin(region: &MappedRegion, darwin_prot: u32) -> Result<(), MapError> {
    let host_prot = darwin_to_host_prot(darwin_prot);
    if host::mprotect(region.ptr, region.len, host_prot) {
        Ok(())
    } else {
        Err(MapError::Sys {
            name: region.name.clone(),
            source: std::io::Error::last_os_error(),
        })
    }
}

#[cfg(test)]
#[allow(clippy::expect_used, clippy::unwrap_used)]
mod tests {
    use super::*;
    use std::io::{Seek, SeekFrom, Write};
    use std::path::PathBuf;

    fn temp_file_with(bytes: &[u8]) -> (File, PathBuf) {
        use std::fs::OpenOptions;
        let path = std::env::temp_dir().join(format!(
            "kh-map-test-{}-{}",
            std::process::id(),
            bytes.len()
        ));
        let mut f = OpenOptions::new()
            .read(true)
            .write(true)
            .create(true)
            .truncate(true)
            .open(&path)
            .expect("create temp");
        f.write_all(bytes).expect("write");
        f.seek(SeekFrom::Start(0)).expect("seek");
        (f, path)
    }

    #[test]
    fn skip_pagezero() {
        let req = MapRequest {
            name: "__PAGEZERO".into(),
            preferred_va: 0,
            vmsize: 0x1_0000_0000,
            fileoff: 0,
            filesize: 0,
            initprot: 0,
            maxprot: 0,
        };
        assert!(req.should_skip());
    }

    #[test]
    fn map_anonymous_rw_region() {
        let host = HostPageSize::detect().expect("host page");
        let page = u64::from(host.bytes());
        let payload = b"hello-guest-map";
        let (mut file, path) = temp_file_with(payload);

        // Prefer a high VA; may fail and slide — both OK for this test.
        let preferred = 0x0000_0001_0000_0000_u64;
        let reqs = [MapRequest {
            name: "__TEST".into(),
            preferred_va: preferred,
            vmsize: page,
            fileoff: 0,
            filesize: u64::try_from(payload.len()).unwrap(),
            initprot: VM_PROT_READ | VM_PROT_WRITE,
            maxprot: VM_PROT_READ | VM_PROT_WRITE,
        }];

        let mem = GuestMemory::map_image(host, preferred, &reqs, &mut file).expect("map");
        assert_eq!(mem.regions().len(), 1);
        let region = mem.regions().first().expect("region");
        assert!(region.host_len() >= payload.len());
        let got = region.host_bytes().get(..payload.len()).expect("bytes");
        assert_eq!(got, payload);
        assert_eq!(region.file_bytes, u64::try_from(payload.len()).unwrap());
        drop(mem);
        drop(std::fs::remove_file(path));
    }

    #[test]
    fn prot_conversion() {
        assert_eq!(darwin_to_host_prot(0), libc::PROT_NONE);
        assert_eq!(darwin_to_host_prot(VM_PROT_READ), libc::PROT_READ);
        assert_eq!(
            darwin_to_host_prot(VM_PROT_READ | VM_PROT_EXECUTE),
            libc::PROT_READ | libc::PROT_EXEC
        );
    }

    /// Real `kh-libsystem` ships with preferred base 0 (`__TEXT` at 0, BSS DATA,
    /// LINKEDIT). Preferred fixed maps fail on Linux; slid reserved-span must work.
    #[test]
    fn map_base0_multi_segment_like_libsystem() {
        let host = HostPageSize::detect().expect("host page");
        let page = u64::from(host.bytes());
        // Layout mirrors staged libSystem.B.dylib (16 KiB TEXT + ~272 KiB DATA BSS + LINKEDIT).
        let text_sz = page.max(0x4000);
        let data_sz = 0x4_4000_u64;
        let link_sz = page.max(0x4000);
        let text_va = 0_u64;
        let data_va = text_sz;
        let link_va = data_va + data_sz;

        let payload = b"base0-text-payload";
        let (mut file, path) = temp_file_with(payload);

        let reqs = [
            MapRequest {
                name: "__TEXT".into(),
                preferred_va: text_va,
                vmsize: text_sz,
                fileoff: 0,
                filesize: u64::try_from(payload.len()).unwrap(),
                initprot: VM_PROT_READ | VM_PROT_EXECUTE,
                maxprot: VM_PROT_READ | VM_PROT_EXECUTE,
            },
            MapRequest {
                name: "__DATA".into(),
                preferred_va: data_va,
                vmsize: data_sz,
                fileoff: 0,
                filesize: 0,
                initprot: VM_PROT_READ | VM_PROT_WRITE,
                maxprot: VM_PROT_READ | VM_PROT_WRITE,
            },
            MapRequest {
                name: "__LINKEDIT".into(),
                preferred_va: link_va,
                vmsize: link_sz,
                fileoff: 0,
                filesize: 0,
                initprot: VM_PROT_READ,
                maxprot: VM_PROT_READ,
            },
        ];

        let mem = GuestMemory::map_image(host, 0, &reqs, &mut file).expect("map base0 image");
        assert_eq!(mem.regions().len(), 3);
        // Relative layout must be preserved under slide.
        let text = mem.regions().first().expect("text");
        let data = mem.regions().get(1).expect("data");
        let link = mem.regions().get(2).expect("link");
        assert_eq!(
            data.guest_addr.wrapping_sub(text.guest_addr),
            data_va.wrapping_sub(text_va)
        );
        assert_eq!(
            link.guest_addr.wrapping_sub(text.guest_addr),
            link_va.wrapping_sub(text_va)
        );
        let got = text.host_bytes().get(..payload.len()).expect("text bytes");
        assert_eq!(got, payload);
        // Preferred base 0 never sticks on Linux; slide may be 0 only if the
        // kernel actually accepted fixed maps at 0 (rare). Either is fine.
        let _ = mem.slide();
        drop(mem);
        drop(std::fs::remove_file(path));
    }

    #[test]
    fn image_span_covers_aligned_ends() {
        let host = HostPageSize::detect().expect("host page");
        let page = u64::from(host.bytes());
        let reqs = [
            MapRequest {
                name: "a".into(),
                preferred_va: 0,
                vmsize: page,
                fileoff: 0,
                filesize: 0,
                initprot: VM_PROT_READ,
                maxprot: VM_PROT_READ,
            },
            MapRequest {
                name: "b".into(),
                preferred_va: page * 2,
                vmsize: page,
                fileoff: 0,
                filesize: 0,
                initprot: VM_PROT_READ,
                maxprot: VM_PROT_READ,
            },
        ];
        let refs: Vec<&MapRequest> = reqs.iter().collect();
        let (lo, hi) = image_preferred_span(host, &refs).expect("span");
        assert_eq!(lo, 0);
        assert_eq!(hi, page * 3);
    }
}