hermit-run 0.4.0

Hermit: a deterministic Linux execution engine for reproducible runs, record and replay, and concurrency-race search.
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
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
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

use std::os::fd::AsRawFd;
use std::os::unix::ffi::OsStringExt;
use std::os::unix::fs::FileExt;
use std::os::unix::fs::FileTypeExt;
use std::os::unix::fs::OpenOptionsExt;

use reverie::Errno;
use reverie::Guest;
use reverie::syscalls::Addr;
use reverie::syscalls::AddrMut;
use reverie::syscalls::Ftruncate;
use reverie::syscalls::Getcwd;
use reverie::syscalls::Getdents;
use reverie::syscalls::Getdents64;
use reverie::syscalls::Ioctl;
use reverie::syscalls::MemoryAccess;
use reverie::syscalls::Pread64;
use reverie::syscalls::Read;
use reverie::syscalls::ReadAddr;
use reverie::syscalls::Readlink;
use reverie::syscalls::Statx;
use reverie::syscalls::Syscall;
use reverie::syscalls::family::StatFamily;
use reverie::syscalls::family::WriteFamily;
use reverie::syscalls::ioctl;

use super::Recorder;
use crate::event::FileCloneEvent;
use crate::event::FileCloneImage;
use crate::event::FileExtent;
use crate::event::FtruncateEvent;
use crate::event::ReadEvent;
use crate::event::ReplayFdKind;
use crate::event::StatEvent;
use crate::event::SyscallEvent;
use crate::event::WriteEvent;
use crate::event::deterministic_ioctl_error;
use crate::event::xattr_query_output;
use crate::vectored_offset;

/// Read the first `length` output bytes of a vectored read from the guest's
/// `iovec` array, flattened in read order. `length` is the syscall return value,
/// which may be smaller than the total iovec capacity (a short read), so we stop
/// once `length` bytes have been collected.
fn read_iovec_output<M: MemoryAccess>(
    memory: &M,
    iov_addr: Option<usize>,
    iovcnt: usize,
    length: usize,
) -> Result<Vec<u8>, Errno> {
    let mut buf = vec![0u8; length];
    if length == 0 {
        return Ok(buf);
    }
    let addr = iov_addr
        .and_then(Addr::<libc::iovec>::from_raw)
        .ok_or(Errno::EFAULT)?;
    let mut iovecs = vec![
        libc::iovec {
            iov_base: std::ptr::null_mut(),
            iov_len: 0,
        };
        iovcnt
    ];
    memory.read_values(addr, &mut iovecs)?;

    let mut filled = 0;
    for iovec in iovecs {
        if filled == length {
            break;
        }
        let take = (length - filled).min(iovec.iov_len);
        if take == 0 {
            continue;
        }
        let src = Addr::<u8>::from_raw(iovec.iov_base as usize).ok_or(Errno::EFAULT)?;
        memory.read_exact(src, &mut buf[filled..filled + take])?;
        filled += take;
    }
    Ok(buf)
}

fn consumed_sigpipe_count(pid: libc::pid_t, fd: libc::c_int, bytes: &[u8]) -> u64 {
    let path = format!("/proc/{pid}/fd/{fd}");
    if !std::fs::read_link(path)
        .is_ok_and(|target| target == std::path::Path::new("anon_inode:[signalfd]"))
    {
        return 0;
    }

    let (records, _) = bytes.as_chunks::<{ std::mem::size_of::<libc::signalfd_siginfo>() }>();
    records
        .iter()
        .filter(|info| {
            u32::from_ne_bytes(info[..std::mem::size_of::<u32>()].try_into().unwrap())
                == libc::SIGPIPE as u32
        })
        .count()
        .try_into()
        .expect("SIGPIPE signalfd record count overflow")
}

fn write_advances_output_offset(syscall: WriteFamily) -> bool {
    match syscall {
        WriteFamily::Write(_) | WriteFamily::Writev(_) => true,
        WriteFamily::Pwritev2(call) => vectored_offset(call.pos_l(), call.pos_h()) == -1,
        WriteFamily::Pwrite64(_) | WriteFamily::Pwritev(_) => false,
    }
}

fn uses_append_offset(status_flags: libc::c_int, write_flags: libc::c_int) -> bool {
    write_flags & libc::RWF_APPEND != 0
        || (status_flags & libc::O_APPEND != 0 && write_flags & libc::RWF_NOAPPEND == 0)
}

#[cfg(test)]
fn shares_open_file_description(left: libc::c_int, right: libc::c_int) -> bool {
    match crate::fd::same_open_file_description(left, right) {
        Ok(shared) => shared,
        Err(error) => {
            tracing::debug!(
                %error,
                left,
                right,
                "could not compare captured open-file descriptions"
            );
            false
        }
    }
}

fn output_file_offset(
    pid: libc::pid_t,
    syscall: WriteFamily,
    metadata: &std::fs::Metadata,
    count: i64,
) -> Option<i64> {
    if !metadata.file_type().is_file() {
        return None;
    }

    let fdinfo = std::fs::read_to_string(format!("/proc/{pid}/fdinfo/{}", syscall.fd())).ok()?;
    let position = fdinfo
        .lines()
        .find_map(|line| line.strip_prefix("pos:\t"))
        .and_then(|value| value.parse::<i64>().ok())?;
    let status_flags = fdinfo
        .lines()
        .find_map(|line| line.strip_prefix("flags:\t"))
        .and_then(|value| i32::from_str_radix(value, 8).ok())
        .unwrap_or_default();
    let write_flags = match syscall {
        WriteFamily::Pwritev2(call) => call.flags(),
        _ => 0,
    };
    if uses_append_offset(status_flags, write_flags) {
        return i64::try_from(metadata.len()).ok()?.checked_sub(count);
    }

    match syscall {
        WriteFamily::Pwrite64(call) => Some(call.offset()),
        WriteFamily::Pwritev(call) => Some(vectored_offset(call.pos_l(), call.pos_h())),
        WriteFamily::Pwritev2(call) => {
            let offset = vectored_offset(call.pos_l(), call.pos_h());
            (offset != -1)
                .then_some(offset)
                .or_else(|| position.checked_sub(count))
        }
        WriteFamily::Write(_) | WriteFamily::Writev(_) => position.checked_sub(count),
    }
}

const MAX_CLONE_SNAPSHOT_BYTES: u64 = 64 * 1024 * 1024;
const MAX_CLONE_SIDECAR_BYTES: u64 = 1024 * 1024 * 1024;
const CLONE_COPY_CHUNK_BYTES: usize = 1024 * 1024;

fn read_dense_clone_snapshot(
    file: &std::fs::File,
    source_offset: u64,
    length: u64,
) -> std::io::Result<FileCloneImage> {
    if length > MAX_CLONE_SNAPSHOT_BYTES {
        return Err(std::io::Error::new(
            std::io::ErrorKind::FileTooLarge,
            format!("clone snapshot is {length} bytes; limit is {MAX_CLONE_SNAPSHOT_BYTES}"),
        ));
    }
    let mut bytes = vec![0; length as usize];
    file.read_exact_at(&mut bytes, source_offset)?;
    Ok(FileCloneImage::Extents(
        (!bytes.is_empty())
            .then_some(FileExtent { offset: 0, bytes })
            .into_iter()
            .collect(),
    ))
}

fn clone_snapshot(
    file: &std::fs::File,
    source_offset: u64,
    length: u64,
) -> std::io::Result<FileCloneImage> {
    let mut extents = Vec::new();
    let mut total = 0u64;
    let mut cursor = source_offset;
    let end = source_offset.checked_add(length).ok_or_else(|| {
        std::io::Error::new(
            std::io::ErrorKind::InvalidInput,
            "clone source range overflow",
        )
    })?;

    while cursor < end {
        // SAFETY: file is an owned descriptor and cursor fits off_t on x86_64.
        let data = unsafe {
            libc::lseek(
                file.as_raw_fd(),
                cursor.try_into().unwrap(),
                libc::SEEK_DATA,
            )
        };
        if data == -1 {
            let error = std::io::Error::last_os_error();
            if error.raw_os_error() == Some(libc::ENXIO) {
                break;
            }
            if error.raw_os_error() == Some(libc::EINVAL) {
                return read_dense_clone_snapshot(file, source_offset, length);
            }
            return Err(error);
        }
        // SAFETY: file is an owned descriptor and data was returned by lseek.
        let hole = unsafe { libc::lseek(file.as_raw_fd(), data, libc::SEEK_HOLE) };
        if hole == -1 {
            let error = std::io::Error::last_os_error();
            if error.raw_os_error() != Some(libc::ENXIO) {
                return Err(error);
            }
        }
        let data = data as u64;
        let hole = if hole == -1 {
            end
        } else {
            (hole as u64).min(end)
        };
        if data >= end {
            break;
        }
        let extent_length = hole.saturating_sub(data);
        total = total.checked_add(extent_length).ok_or_else(|| {
            std::io::Error::new(
                std::io::ErrorKind::FileTooLarge,
                "clone snapshot size overflow",
            )
        })?;
        if total > MAX_CLONE_SNAPSHOT_BYTES {
            return Err(std::io::Error::new(
                std::io::ErrorKind::FileTooLarge,
                format!(
                    "clone data extents total {total} bytes; limit is {MAX_CLONE_SNAPSHOT_BYTES}"
                ),
            ));
        }
        let mut bytes = vec![0; extent_length as usize];
        file.read_exact_at(&mut bytes, data)?;
        extents.push(FileExtent {
            offset: data - source_offset,
            bytes,
        });
        cursor = hole;
    }

    Ok(FileCloneImage::Extents(extents))
}

fn spool_clone_snapshot(
    source: &std::fs::File,
    source_offset: u64,
    length: u64,
    data: &std::path::Path,
) -> std::io::Result<FileCloneImage> {
    let directory = data.join("clone");
    std::fs::create_dir_all(&directory)?;

    let sidecar = tempfile::Builder::new()
        .prefix("image-")
        .tempfile_in(&directory)?;
    sidecar.as_file().set_len(length)?;

    let mut total = 0u64;
    let mut cursor = source_offset;
    let end = source_offset.checked_add(length).ok_or_else(|| {
        std::io::Error::new(
            std::io::ErrorKind::InvalidInput,
            "clone source range overflow",
        )
    })?;
    let mut buffer = vec![0; CLONE_COPY_CHUNK_BYTES];
    while cursor < end {
        // SAFETY: source is owned and cursor fits off_t on x86_64.
        let data_offset = unsafe {
            libc::lseek(
                source.as_raw_fd(),
                cursor.try_into().unwrap(),
                libc::SEEK_DATA,
            )
        };
        let (data_offset, hole) = if data_offset == -1 {
            let error = std::io::Error::last_os_error();
            match error.raw_os_error() {
                Some(libc::ENXIO) => break,
                Some(libc::EINVAL) => (source_offset, end),
                _ => return Err(error),
            }
        } else {
            // SAFETY: source is owned and data_offset came from lseek.
            let hole = unsafe { libc::lseek(source.as_raw_fd(), data_offset, libc::SEEK_HOLE) };
            if hole == -1 {
                let error = std::io::Error::last_os_error();
                if error.raw_os_error() != Some(libc::ENXIO) {
                    return Err(error);
                }
            }
            (
                data_offset as u64,
                if hole == -1 {
                    end
                } else {
                    (hole as u64).min(end)
                },
            )
        };
        let extent_length = hole.saturating_sub(data_offset);
        if data_offset >= end {
            break;
        }
        total = total.checked_add(extent_length).ok_or_else(|| {
            std::io::Error::new(
                std::io::ErrorKind::FileTooLarge,
                "clone sidecar size overflow",
            )
        })?;
        if total > MAX_CLONE_SIDECAR_BYTES {
            return Err(std::io::Error::new(
                std::io::ErrorKind::FileTooLarge,
                format!(
                    "clone sidecar data exceeds {MAX_CLONE_SIDECAR_BYTES} byte recording quota"
                ),
            ));
        }

        let mut offset = data_offset;
        while offset < hole {
            let count = usize::try_from((hole - offset).min(buffer.len() as u64)).unwrap();
            source.read_exact_at(&mut buffer[..count], offset)?;
            sidecar
                .as_file()
                .write_all_at(&buffer[..count], offset - source_offset)?;
            offset += count as u64;
        }
        cursor = hole;
    }
    sidecar.as_file().sync_data()?;
    let (_, path) = sidecar.keep().map_err(|error| error.error)?;
    let relative = path.strip_prefix(data).map_err(|error| {
        std::io::Error::new(
            std::io::ErrorKind::InvalidData,
            format!("clone sidecar escaped recording directory: {error}"),
        )
    })?;

    Ok(FileCloneImage::Sidecar(
        relative.to_string_lossy().into_owned(),
    ))
}

fn capture_clone_snapshot(
    source: &std::fs::File,
    source_offset: u64,
    length: u64,
    data: &std::path::Path,
) -> std::io::Result<FileCloneImage> {
    let inline_error = match clone_snapshot(source, source_offset, length) {
        Ok(snapshot) => return Ok(snapshot),
        Err(error) => error,
    };

    tracing::warn!(
        error = %inline_error,
        "inline clone snapshot unavailable; spooling sparse replay sidecar"
    );
    spool_clone_snapshot(source, source_offset, length, data)
}

fn private_clone_snapshot(
    pid: reverie::Pid,
    destination_fd: libc::c_int,
    source: &std::fs::File,
    source_offset: u64,
    length: u64,
) -> std::io::Result<std::fs::File> {
    let destination = std::fs::read_link(format!("/proc/{}/fd/{destination_fd}", pid.as_raw()))?;
    let relative = destination.strip_prefix("/").map_err(|_| {
        std::io::Error::new(
            std::io::ErrorKind::InvalidData,
            format!("clone destination is not an absolute path: {destination:?}"),
        )
    })?;
    let parent = relative.parent().ok_or_else(|| {
        std::io::Error::new(
            std::io::ErrorKind::InvalidData,
            format!("clone destination has no parent: {destination:?}"),
        )
    })?;
    let parent = std::path::PathBuf::from(format!("/proc/{}/root", pid.as_raw())).join(parent);
    let private = std::fs::OpenOptions::new()
        .read(true)
        .write(true)
        .custom_flags(libc::O_TMPFILE | libc::O_CLOEXEC)
        .mode(0o600)
        .open(&parent)?;

    if length == 0 {
        return Ok(private);
    }
    let range = libc::file_clone_range {
        src_fd: source.as_raw_fd() as i64,
        src_offset: source_offset,
        src_length: length,
        dest_offset: 0,
    };
    // SAFETY: private and source are valid regular-file descriptors, and range
    // points to an initialized file_clone_range for the duration of ioctl.
    let result = unsafe {
        libc::ioctl(
            private.as_raw_fd(),
            libc::FICLONERANGE,
            std::ptr::addr_of!(range),
        )
    };
    if result == -1 {
        return Err(std::io::Error::last_os_error());
    }
    Ok(private)
}

impl Recorder {
    /// Records the vectored read family (`readv`/`preadv`/`preadv2`). Writes only
    /// need their return count (see `handle_write_family`), but vectored reads
    /// scatter output across guest `iovec` buffers, so we capture the exact
    /// returned bytes flattened in read order.
    pub(super) async fn handle_readv_family<G: Guest<Self>>(
        &self,
        guest: &mut G,
        iov_addr: Option<usize>,
        iovcnt: usize,
        fd: libc::c_int,
        syscall: Syscall,
    ) -> Result<i64, Errno> {
        let result = guest.inject(syscall).await;

        self.record_event(
            guest,
            result.and_then(|length| {
                let bytes = read_iovec_output(&guest.memory(), iov_addr, iovcnt, length as usize)?;
                Ok(SyscallEvent::ReadvV2(ReadEvent {
                    consumed_sigpipe_count: consumed_sigpipe_count(
                        guest.pid().as_raw(),
                        fd,
                        &bytes,
                    ),
                    replay_fd_kind: self.fd_replay_kind(guest.pid(), fd),
                    bytes,
                }))
            }),
        );

        result
    }

    pub(super) async fn handle_read<G: Guest<Self>>(
        &self,
        guest: &mut G,
        syscall: Read,
    ) -> Result<i64, Errno> {
        let result = guest.inject(syscall).await;

        self.record_event(
            guest,
            result.and_then(|length| {
                let mut buf = vec![0; length as usize];
                // A read that transfers nothing never touches the buffer,
                // which may then be NULL.
                if !buf.is_empty() {
                    let addr = syscall.buf().ok_or(Errno::EFAULT)?;
                    guest.memory().read_exact(addr, &mut buf)?;
                }
                Ok(SyscallEvent::ReadV2(ReadEvent {
                    consumed_sigpipe_count: consumed_sigpipe_count(
                        guest.pid().as_raw(),
                        syscall.fd(),
                        &buf,
                    ),
                    bytes: buf,
                    replay_fd_kind: self.fd_replay_kind(guest.pid(), syscall.fd()),
                }))
            }),
        );

        result
    }

    pub(super) async fn handle_pread64<G: Guest<Self>>(
        &self,
        guest: &mut G,
        syscall: Pread64,
    ) -> Result<i64, Errno> {
        let result = guest.inject(syscall).await;

        self.record_event(
            guest,
            result.and_then(|length| {
                let mut buf = vec![0; length as usize];
                // A read that transfers nothing never touches the buffer,
                // which may then be NULL.
                if !buf.is_empty() {
                    let addr = syscall.buf().ok_or(Errno::EFAULT)?;
                    guest.memory().read_exact(addr, &mut buf)?;
                }
                Ok(SyscallEvent::Bytes(buf))
            }),
        );

        result
    }

    pub(super) async fn handle_write_family<G: Guest<Self>>(
        &self,
        guest: &mut G,
        syscall: WriteFamily,
    ) -> Result<i64, Errno> {
        let result = guest.inject(Syscall::from(syscall)).await;

        let metadata = std::fs::metadata(format!(
            "/proc/{}/fd/{}",
            guest.pid().as_raw(),
            syscall.fd()
        ))
        .ok();
        let (output_fd, shares_output_ofd) = metadata.as_ref().map_or((None, false), |metadata| {
            let stdout_matches = self
                .stdout
                .is_some_and(|identity| identity.matches(metadata));
            let stderr_matches = self
                .stderr
                .is_some_and(|identity| identity.matches(metadata));
            let candidate = (metadata.file_type().is_file() && (stdout_matches || stderr_matches))
                .then(|| crate::fd::duplicate_guest_fd(guest.pid(), syscall.fd()).ok())
                .flatten();
            let stdout_shares = stdout_matches
                && candidate.as_ref().is_some_and(|candidate| {
                    self.output_ofd_matches(libc::STDOUT_FILENO, candidate)
                });
            let stderr_shares = stderr_matches
                && candidate.as_ref().is_some_and(|candidate| {
                    self.output_ofd_matches(libc::STDERR_FILENO, candidate)
                });

            if stdout_shares {
                (Some(libc::STDOUT_FILENO), true)
            } else if stderr_shares {
                (Some(libc::STDERR_FILENO), true)
            } else if stdout_matches {
                (Some(libc::STDOUT_FILENO), false)
            } else if stderr_matches {
                (Some(libc::STDERR_FILENO), false)
            } else {
                (None, false)
            }
        });
        let file_offset = match (result, metadata.as_ref()) {
            (Ok(count), Some(metadata)) => {
                output_file_offset(guest.pid().as_raw(), syscall, metadata, count)
            }
            _ => None,
        };
        let output_offset = output_fd.and(file_offset);
        let advances_output_offset =
            output_offset.is_some() && shares_output_ofd && write_advances_output_offset(syscall);
        let generated_sigpipe = result == Err(Errno::EPIPE)
            && metadata.is_some_and(|metadata| {
                metadata.file_type().is_fifo() || metadata.file_type().is_socket()
            });
        let replay_fd_kind = if result.is_ok() && output_fd.is_none() {
            self.fd_replay_kind(guest.pid(), syscall.fd())
        } else {
            ReplayFdKind::None
        };
        let replay_file_offset = (replay_fd_kind == ReplayFdKind::RegularFile)
            .then_some(file_offset)
            .flatten();
        let replay_file_advances_offset =
            replay_file_offset.is_some() && write_advances_output_offset(syscall);
        self.record_event(
            guest,
            Ok(SyscallEvent::WriteV2(WriteEvent {
                result,
                output_fd,
                output_offset,
                generated_sigpipe,
                advances_output_offset,
                replay_fd_kind,
                replay_file_offset,
                replay_file_advances_offset,
            })),
        );

        result
    }

    // TODO-HUMAN-REVIEW(#557): Audit captured-output ftruncate recording.
    pub(super) async fn handle_ftruncate<G: Guest<Self>>(
        &self,
        guest: &mut G,
        syscall: Ftruncate,
    ) -> Result<i64, Errno> {
        let result = guest.inject(syscall).await;
        let metadata = std::fs::metadata(format!(
            "/proc/{}/fd/{}",
            guest.pid().as_raw(),
            syscall.fd()
        ))
        .ok();
        let output_fd = if result.is_ok() {
            metadata.as_ref().and_then(|metadata| {
                if self
                    .stdout
                    .is_some_and(|identity| identity.matches(metadata))
                {
                    Some(libc::STDOUT_FILENO)
                } else if self
                    .stderr
                    .is_some_and(|identity| identity.matches(metadata))
                {
                    Some(libc::STDERR_FILENO)
                } else {
                    None
                }
            })
        } else {
            None
        };
        self.record_event(
            guest,
            Ok(SyscallEvent::FtruncateV2(FtruncateEvent {
                result,
                output_fd,
                length: syscall.length(),
                replay_regular_file: result.is_ok()
                    && metadata.is_some_and(|metadata| metadata.file_type().is_file()),
            })),
        );
        result
    }
    pub(super) async fn handle_stat_family<G: Guest<Self>>(
        &self,
        guest: &mut G,
        syscall: StatFamily,
    ) -> Result<i64, Errno> {
        let result = guest.inject(Syscall::from(syscall)).await;

        self.record_event(
            guest,
            result.and_then(|ret| {
                debug_assert_eq!(ret, 0);
                let statbuf = syscall.stat().ok_or(Errno::EFAULT)?.read(&guest.memory())?;
                Ok(SyscallEvent::Stat(StatEvent { statbuf }))
            }),
        );

        result
    }

    pub(super) async fn handle_statfs<G: Guest<Self>>(
        &self,
        guest: &mut G,
        syscall: Syscall,
        buf: Option<AddrMut<'_, libc::statfs>>,
    ) -> Result<i64, Errno> {
        let result = guest.inject(syscall).await;

        self.record_event(
            guest,
            result.and_then(|ret| {
                debug_assert_eq!(ret, 0);
                let mut bytes = vec![0; std::mem::size_of::<libc::statfs>()];
                guest
                    .memory()
                    .read_exact(buf.ok_or(Errno::EFAULT)?.cast(), &mut bytes)?;
                Ok(SyscallEvent::Statfs(bytes))
            }),
        );

        result
    }

    pub(super) async fn handle_statx<G: Guest<Self>>(
        &self,
        guest: &mut G,
        syscall: Statx,
    ) -> Result<i64, Errno> {
        let result = guest.inject(syscall).await;

        self.record_event(
            guest,
            result.and_then(|ret| {
                debug_assert_eq!(ret, 0);
                let statbuf = syscall
                    .statx()
                    .ok_or(Errno::EFAULT)?
                    .read(&guest.memory())?;
                Ok(SyscallEvent::Statx(statbuf.into()))
            }),
        );

        result
    }

    /// ioctl is a beast of a syscall. We try to handle the common cases here.
    pub(super) async fn handle_ioctl<G: Guest<Self>>(
        &self,
        guest: &mut G,
        syscall: Ioctl,
    ) -> Result<i64, Errno> {
        let request = syscall.request();

        if let Some(error) = deterministic_ioctl_error(&request) {
            self.record_event(guest, Err(error));
            return Err(error);
        }

        let ret = guest.inject(syscall).await.inspect_err(|&err| {
            self.record_event(guest, Err(err));
        })?;

        if matches!(
            request,
            ioctl::Request::FICLONE(_) | ioctl::Request::FICLONERANGE(_)
        ) {
            let (source_fd, source_offset, requested_length, destination_offset, truncate) =
                match request {
                    ioctl::Request::FICLONE(fd) => (fd, 0, None, 0, true),
                    ioctl::Request::FICLONERANGE(Some(address)) => {
                        let range: libc::file_clone_range = guest
                            .memory()
                            .read_value(address)
                            .expect("successful FICLONERANGE has a readable argument");
                        (
                            range.src_fd as libc::c_int,
                            range.src_offset,
                            (range.src_length != 0).then_some(range.src_length),
                            range.dest_offset,
                            false,
                        )
                    }
                    ioctl::Request::FICLONERANGE(None) => {
                        unreachable!("successful FICLONERANGE has a non-null argument")
                    }
                    _ => unreachable!(),
                };
            let source = std::fs::File::from(
                crate::fd::duplicate_guest_fd(guest.pid(), source_fd)
                    .expect("failed to duplicate clone source descriptor"),
            );
            let source_length = source
                .metadata()
                .expect("failed to stat clone source descriptor")
                .len();
            let replacement_length = requested_length.unwrap_or_else(|| {
                source_length
                    .checked_sub(source_offset)
                    .expect("successful clone source offset exceeds file length")
            });
            let private = private_clone_snapshot(
                guest.pid(),
                syscall.fd(),
                &source,
                source_offset,
                replacement_length,
            )
            .unwrap_or_else(|error| panic!("failed to make private clone snapshot: {error}"));
            let image = capture_clone_snapshot(&private, 0, replacement_length, &self.data)
                .unwrap_or_else(|error| panic!("failed to snapshot private clone: {error}"));
            let destination_path = format!("/proc/{}/fd/{}", guest.pid().as_raw(), syscall.fd());
            let length = std::fs::metadata(&destination_path)
                .unwrap_or_else(|error| {
                    panic!("failed to stat cloned destination {destination_path}: {error}")
                })
                .len();
            self.record_event(
                guest,
                Ok(SyscallEvent::FileClone(FileCloneEvent {
                    length,
                    destination_offset,
                    replacement_length,
                    truncate_destination: truncate,
                    image,
                })),
            );
        } else if matches!(
            request,
            ioctl::Request::FIOCLEX | ioctl::Request::FIONCLEX | ioctl::Request::FIONBIO(_)
        ) {
            self.record_event(guest, Ok(SyscallEvent::Return(ret)));
        } else if let Some(output) = request.read_output(&guest.memory()).transpose() {
            // This ioctl request has an associated output.
            self.record_event(guest, output.map(SyscallEvent::Ioctl));
        } else {
            self.record_event(guest, Ok(SyscallEvent::Return(ret)));
        }

        Ok(ret)
    }

    pub(super) async fn handle_readlink<G: Guest<Self>>(
        &self,
        guest: &mut G,
        syscall: Readlink,
    ) -> Result<i64, Errno> {
        let result = guest.inject(syscall).await;

        self.record_event(
            guest,
            result.and_then(|length| {
                let mut buf = vec![0; length as usize];
                let addr = syscall.buf().ok_or(Errno::EFAULT)?.cast::<u8>();
                guest.memory().read_exact(addr, &mut buf)?;
                Ok(SyscallEvent::Bytes(buf))
            }),
        );

        result
    }

    // TODO-HUMAN-REVIEW(PR-3601)
    /// Records an xattr query. A sized query records the bytes the kernel
    /// copied out, whose count is the return value. A zero-size query copies
    /// nothing and returns the length the value needs, so that is recorded
    /// instead.
    pub(super) async fn handle_xattr_query<G: Guest<Self>>(
        &self,
        guest: &mut G,
        syscall: Syscall,
    ) -> Result<i64, Errno> {
        let (buf, size) = xattr_query_output(&syscall)
            .unwrap_or_else(|| unreachable!("xattr query recording called for {syscall:?}"));
        let result = guest.inject(syscall).await;

        if size == 0 {
            self.record_event(guest, result.map(SyscallEvent::Return));
        } else {
            self.record_event(
                guest,
                result.and_then(|length| {
                    let mut bytes = vec![0; length as usize];
                    // An empty list succeeds without touching the buffer,
                    // which may then be NULL.
                    if !bytes.is_empty() {
                        guest
                            .memory()
                            .read_exact(buf.ok_or(Errno::EFAULT)?, &mut bytes)?;
                    }
                    Ok(SyscallEvent::Bytes(bytes))
                }),
            );
        }

        result
    }

    // TODO-HUMAN-REVIEW(#3598)
    /// Records the path `getcwd` copied out. The raw syscall returns the
    /// length including the terminating NUL, so the recorded bytes include it.
    pub(super) async fn handle_getcwd<G: Guest<Self>>(
        &self,
        guest: &mut G,
        syscall: Getcwd,
    ) -> Result<i64, Errno> {
        let result = guest.inject(syscall).await;

        self.record_event(
            guest,
            result.and_then(|length| {
                let mut buf = vec![0; length as usize];
                let addr = syscall.buf().ok_or(Errno::EFAULT)?.cast::<u8>();
                guest.memory().read_exact(addr, &mut buf)?;
                Ok(SyscallEvent::Bytes(buf))
            }),
        );

        result
    }

    // TODO-HUMAN-REVIEW(#3598)
    /// Record a successful `chdir(2)` or `fchdir(2)` as the directory it
    /// actually entered. The spelled path may go through host symlinks or `..`
    /// components that the replay root lacks, and an fchdir descriptor may be
    /// a replay placeholder, so replay moves to this resolved name instead.
    pub(super) async fn handle_working_directory_change<G: Guest<Self>>(
        &self,
        guest: &mut G,
        syscall: Syscall,
    ) -> Result<i64, Errno> {
        let result = guest.inject(syscall).await;

        self.record_event(
            guest,
            result.map(|_| {
                let cwd = crate::record_replay_path::process_cwd_path(guest.tid()).unwrap_or_else(
                    |error| panic!("could not record the directory {syscall:?} entered: {error}"),
                );
                SyscallEvent::Bytes(cwd.into_os_string().into_vec())
            }),
        );

        result
    }

    pub(super) async fn handle_getdents<G: Guest<Self>>(
        &self,
        guest: &mut G,
        syscall: Getdents,
    ) -> Result<i64, Errno> {
        let result = guest.inject(syscall).await;

        self.record_event(
            guest,
            result.and_then(|length| {
                let mut buf = vec![0; length as usize];
                let addr = syscall.dirent().ok_or(Errno::EFAULT)?.cast::<u8>();
                guest.memory().read_exact(addr, &mut buf)?;
                Ok(SyscallEvent::Bytes(buf))
            }),
        );

        result
    }

    pub(super) async fn handle_getdents64<G: Guest<Self>>(
        &self,
        guest: &mut G,
        syscall: Getdents64,
    ) -> Result<i64, Errno> {
        let result = guest.inject(syscall).await;

        self.record_event(
            guest,
            result.and_then(|length| {
                let mut buf = vec![0; length as usize];
                let addr = syscall.dirent().ok_or(Errno::EFAULT)?.cast::<u8>();
                guest.memory().read_exact(addr, &mut buf)?;
                Ok(SyscallEvent::Bytes(buf))
            }),
        );

        result
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn vectored_offsets_combine_both_abi_halves() {
        if std::mem::size_of::<usize>() == 8 {
            assert_eq!(vectored_offset(0x1_0000_0002, 0), 0x1_0000_0002);
            assert_eq!(vectored_offset(u64::MAX, 0), -1);
        } else {
            assert_eq!(vectored_offset(2, 1), 0x1_0000_0002);
            assert_eq!(vectored_offset(u32::MAX as u64, u32::MAX as u64), -1);
        }
    }

    #[test]
    fn rwf_noappend_overrides_descriptor_append_mode() {
        assert!(uses_append_offset(libc::O_APPEND, 0));
        assert!(uses_append_offset(0, libc::RWF_APPEND));
        assert!(!uses_append_offset(libc::O_APPEND, libc::RWF_NOAPPEND));
    }

    #[test]
    fn kcmp_distinguishes_dup_from_reopened_file() {
        use std::os::fd::AsRawFd as _;
        use std::os::fd::FromRawFd as _;

        let file = tempfile::NamedTempFile::new().unwrap();
        let original = file.as_file().as_raw_fd();
        // SAFETY: original is open and F_DUPFD_CLOEXEC returns a new descriptor.
        let duplicate =
            unsafe { libc::fcntl(original, libc::F_DUPFD_CLOEXEC, libc::STDERR_FILENO + 1) };
        assert_ne!(duplicate, -1);
        // SAFETY: fcntl returned a descriptor owned by this test.
        let duplicate = unsafe { std::os::fd::OwnedFd::from_raw_fd(duplicate) };
        let reopened = std::fs::OpenOptions::new()
            .read(true)
            .write(true)
            .open(file.path())
            .unwrap();
        assert!(shares_open_file_description(
            original,
            duplicate.as_raw_fd()
        ));
        assert!(!shares_open_file_description(
            original,
            reopened.as_raw_fd()
        ));
    }
}