1mod common;
21mod fd;
22mod fs;
23mod helpers;
24mod io;
25mod mem_sys;
26mod net;
27mod process;
28mod signal;
29mod sysctl;
30mod table;
31mod thread_sys;
32mod time_sys;
33
34use crate::process as proc_state;
35use crate::trap::TrapOutcome;
36
37pub use common::{
38 EBADF, EEXIST, EFAULT, EINVAL, ENOENT, ENOMEM, ENOSYS, EPERM, SyscallArgs, SyscallResult,
39};
40pub use table::{BsdSyscall, known_syscalls, lookup, name_of};
41
42pub fn reset_syscall_state(max_syscalls: usize) {
44 proc_state::reset_run(max_syscalls);
45 helpers::reset_futex_stats();
46}
47
48pub(crate) fn dump_futex_stats_if_enabled() {
50 helpers::dump_futex_stats_if_enabled();
51}
52
53pub fn dispatch(args: SyscallArgs) -> SyscallResult {
55 if proc_state::tick_syscall() {
57 return SyscallResult {
58 name: "max_syscalls",
59 outcome: TrapOutcome::Exit { code: 1 },
60 retval: Some(1),
61 error: false,
62 };
63 }
64
65 match args.number {
67 n if helpers::is_helper(n) => return helpers::dispatch_helper(args),
69 3 | 396 => return io::handle_read(args),
70 4 | 397 => return io::handle_write(args),
71 5 | 398 => return fd::handle_open(args),
72 6 | 399 => return fd::handle_close(args),
73 199 => return fd::handle_lseek(args),
74 92 => return fd::handle_fcntl(args),
75 _ => {}
76 }
77
78 match lookup(args.number) {
79 Some(BsdSyscall::Exit) => process::handle_exit(args),
80 Some(BsdSyscall::Write) => io::handle_write(args),
81 Some(BsdSyscall::Read) => io::handle_read(args),
82 Some(BsdSyscall::Open) => fd::handle_open(args),
83 Some(BsdSyscall::Close) => fd::handle_close(args),
84 Some(BsdSyscall::Getpid) => process::handle_getpid(),
85 Some(BsdSyscall::Getppid) => process::handle_getppid(),
86 Some(BsdSyscall::Access) => fs::handle_access(args),
87 Some(BsdSyscall::Issetugid) => process::handle_issetugid(),
88 Some(BsdSyscall::Munmap) => mem_sys::handle_munmap(args),
89 Some(BsdSyscall::Mprotect) => mem_sys::handle_mprotect(args),
90 Some(BsdSyscall::Mmap) => mem_sys::handle_mmap(args),
91 Some(BsdSyscall::Msync) => mem_sys::handle_msync(args),
92 Some(BsdSyscall::Dup) => fd::handle_dup(args),
93 Some(BsdSyscall::Fcntl) => fd::handle_fcntl(args),
94 Some(BsdSyscall::Lseek) => fd::handle_lseek(args),
95 Some(BsdSyscall::Stat) => fs::handle_stat(args),
96 Some(BsdSyscall::Fstat) => fs::handle_fstat(args),
97 Some(BsdSyscall::Lstat) => fs::handle_lstat(args),
98 Some(BsdSyscall::Unlink) => fs::handle_unlink(args),
99 Some(BsdSyscall::Link) => fs::handle_link(args),
100 Some(BsdSyscall::Symlink) => fs::handle_symlink(args),
101 Some(BsdSyscall::Readlink) => fs::handle_readlink(args),
102 Some(BsdSyscall::Mkdir) => fs::handle_mkdir(args),
103 Some(BsdSyscall::Rmdir) => fs::handle_rmdir(args),
104 Some(BsdSyscall::Rename) => fs::handle_rename(args),
105 Some(BsdSyscall::Ftruncate) => fs::handle_ftruncate(args),
106 Some(BsdSyscall::Fsync) => fs::handle_fsync(args),
107 Some(BsdSyscall::Openat) => fd::handle_openat(args),
108 Some(BsdSyscall::Fstatat) => fs::handle_fstatat(args),
109 Some(BsdSyscall::Gettimeofday) => time_sys::handle_gettimeofday(args),
110 Some(BsdSyscall::ClockGettime) => time_sys::handle_clock_gettime(args),
111 Some(BsdSyscall::Sysctl) => sysctl::handle_sysctl(args),
112 Some(BsdSyscall::Sysctlbyname) => sysctl::handle_sysctlbyname(args),
113 Some(BsdSyscall::Sigprocmask) => signal::handle_sigprocmask(args),
114 Some(BsdSyscall::Sigaction) => signal::handle_sigaction(args),
115 Some(BsdSyscall::BsdthreadCreate) => thread_sys::handle_bsdthread_create(args),
116 Some(BsdSyscall::BsdthreadTerminate) => thread_sys::handle_bsdthread_terminate(args),
117 Some(BsdSyscall::BsdthreadRegister) => thread_sys::handle_bsdthread_register(args),
118 Some(BsdSyscall::ThreadSelfid) => thread_sys::handle_thread_selfid(),
119 Some(BsdSyscall::Pipe) => net::handle_pipe(args),
120 Some(BsdSyscall::Socket) => net::handle_socket(args),
121 Some(BsdSyscall::Connect) => net::handle_connect(args),
122 Some(BsdSyscall::Bind) => net::handle_bind(args),
123 Some(BsdSyscall::Listen) => net::handle_listen(args),
124 Some(BsdSyscall::Accept) => net::handle_accept(args),
125 Some(BsdSyscall::Setsockopt) => net::handle_setsockopt(args),
126 Some(BsdSyscall::Getsockopt) => net::handle_getsockopt(args),
127 Some(BsdSyscall::Shutdown) => net::handle_shutdown(args),
128 Some(BsdSyscall::Sendto | BsdSyscall::Send) => net::handle_sendto(args),
129 Some(BsdSyscall::Recvfrom | BsdSyscall::Recv) => net::handle_recvfrom(args),
130 Some(BsdSyscall::Poll) => net::handle_poll(args),
131 Some(BsdSyscall::Select) => net::handle_select(args),
132 Some(BsdSyscall::Getsockname) => net::handle_getsockname(args),
133 Some(BsdSyscall::Getpeername) => net::handle_getpeername(args),
134 None => {
135 log_unknown_syscall(args.number, args.x0, args.x1, args.x2);
138 SyscallResult::err("unknown", ENOSYS)
139 }
140 }
141}
142
143fn log_unknown_syscall(number: u32, x0: u64, x1: u64, x2: u64) {
144 use std::sync::atomic::{AtomicU32, Ordering};
145 static SEEN: AtomicU32 = AtomicU32::new(0);
146 let n = SEEN.fetch_add(1, Ordering::Relaxed);
147 if n >= 32 {
148 return;
149 }
150 let msg = format!("kh: unknown BSD syscall #{number} x0={x0:#x} x1={x1:#x} x2={x2:#x}\n");
151 drop(std::io::Write::write_all(
152 &mut std::io::stderr(),
153 msg.as_bytes(),
154 ));
155}
156
157#[cfg(test)]
158#[allow(clippy::expect_used, clippy::unwrap_used)]
159mod tests {
160 use super::common::{guest_read_i32, guest_read_u64, guest_slice, guest_write};
161 use super::mem_sys::{DARWIN_MAP_ANON, DARWIN_MAP_PRIVATE, DARWIN_MAP_SHARED, host_page_size};
162 use super::*;
163 use crate::mem::{
164 HostPageSize, VM_PROT_EXECUTE, VM_PROT_READ, VM_PROT_WRITE, map_stack, register_borrowed,
165 registry_clear,
166 };
167 use std::io::Write;
168
169 fn lock_syscalls() -> std::sync::MutexGuard<'static, ()> {
170 proc_state::test_lock()
171 }
172
173 fn args(number: u32, x0: u64, x1: u64, x2: u64) -> SyscallArgs {
174 SyscallArgs {
175 pc: 0,
176 number,
177 x0,
178 x1,
179 x2,
180 x3: 0,
181 x4: 0,
182 x5: 0,
183 x6: 0,
184 }
185 }
186
187 fn guest_va(base: u64, off: usize) -> u64 {
188 base.wrapping_add(u64::try_from(off).unwrap())
189 }
190
191 fn write_cstr(base: u64, off: usize, s: &str) -> u64 {
192 let va = guest_va(base, off);
193 guest_write(va, s.as_bytes());
194 guest_write(va.wrapping_add(u64::try_from(s.len()).unwrap()), &[0]);
195 va
196 }
197
198 #[test]
199 fn lookup_common_numbers() {
200 assert_eq!(lookup(1), Some(BsdSyscall::Exit));
201 assert_eq!(lookup(4), Some(BsdSyscall::Write));
202 assert_eq!(lookup(5), Some(BsdSyscall::Open));
203 assert_eq!(lookup(20), Some(BsdSyscall::Getpid));
204 assert_eq!(lookup(41), Some(BsdSyscall::Dup));
205 assert_eq!(lookup(46), Some(BsdSyscall::Sigaction));
206 assert_eq!(lookup(48), Some(BsdSyscall::Sigprocmask));
207 assert_eq!(lookup(65), Some(BsdSyscall::Msync));
208 assert_eq!(lookup(92), Some(BsdSyscall::Fcntl));
209 assert_eq!(lookup(116), Some(BsdSyscall::Gettimeofday));
210 assert_eq!(lookup(199), Some(BsdSyscall::Lseek));
211 assert_eq!(lookup(202), Some(BsdSyscall::Sysctl));
212 assert_eq!(lookup(266), Some(BsdSyscall::ClockGettime));
213 assert_eq!(lookup(274), Some(BsdSyscall::Sysctlbyname));
214 assert_eq!(lookup(360), Some(BsdSyscall::BsdthreadCreate));
215 assert_eq!(lookup(361), Some(BsdSyscall::BsdthreadTerminate));
216 assert_eq!(lookup(366), Some(BsdSyscall::BsdthreadRegister));
217 assert_eq!(lookup(372), Some(BsdSyscall::ThreadSelfid));
218 assert_eq!(lookup(463), Some(BsdSyscall::Openat));
219 assert_eq!(lookup(9999), None);
220 }
221
222 #[test]
223 fn name_table_stable() {
224 assert_eq!(name_of(1), Some("exit"));
225 assert_eq!(name_of(4), Some("write"));
226 assert_eq!(name_of(339), Some("fstat"));
227 assert_eq!(name_of(42), Some("pipe"));
228 assert_eq!(name_of(97), Some("socket"));
229 assert_eq!(name_of(98), Some("connect"));
230 assert_eq!(name_of(9999), None);
231 }
232
233 #[test]
234 fn exit_dispatch() {
235 let _g = lock_syscalls();
236 reset_syscall_state(256);
237 let r = dispatch(args(1, 7, 0, 0));
238 assert_eq!(r.name, "exit");
239 assert_eq!(r.outcome, TrapOutcome::Exit { code: 7 });
240 assert!(!r.error);
241 }
242
243 #[test]
244 fn unknown_returns_enosys_with_error_flag() {
245 let _g = lock_syscalls();
246 reset_syscall_state(256);
247 let r = dispatch(args(0xDEAD, 0, 0, 0));
248 assert_eq!(r.name, "unknown");
249 assert!(r.error);
250 assert_eq!(r.retval, Some(u64::try_from(ENOSYS).unwrap_or(0)));
251 }
252
253 #[test]
254 fn max_syscalls_trips() {
255 let _g = lock_syscalls();
256 reset_syscall_state(2);
257 let a = args(20, 0, 0, 0);
258 assert_eq!(dispatch(a).name, "getpid");
259 assert_eq!(dispatch(a).name, "getpid");
260 let r = dispatch(a);
261 assert_eq!(r.name, "max_syscalls");
262 assert_eq!(r.outcome, TrapOutcome::Exit { code: 1 });
263 }
264
265 #[test]
266 fn getpid_positive() {
267 let _g = lock_syscalls();
268 reset_syscall_state(256);
269 let r = dispatch(args(20, 0, 0, 0));
270 assert_eq!(r.name, "getpid");
271 assert!(!r.error);
272 assert!(r.retval.unwrap_or(0) > 0);
273 }
274
275 #[test]
276 fn getppid_positive() {
277 let _g = lock_syscalls();
278 reset_syscall_state(256);
279 let r = dispatch(args(39, 0, 0, 0));
280 assert_eq!(r.name, "getppid");
281 assert!(!r.error);
282 assert!(r.retval.unwrap_or(0) > 0);
283 }
284
285 #[test]
286 fn ok_err_helpers() {
287 let ok = SyscallResult::ok("write", 3);
288 assert!(!ok.error);
289 assert_eq!(ok.retval, Some(3));
290 let err = SyscallResult::err("write", EBADF);
291 assert!(err.error);
292 assert_eq!(err.retval, Some(9));
293 }
294
295 #[test]
296 fn mmap_anon_private_roundtrip() {
297 let _g = lock_syscalls();
298 reset_syscall_state(256);
299 registry_clear();
300 let page = host_page_size();
301 let page_u = u64::try_from(page).unwrap_or(4096);
302 let r = dispatch(SyscallArgs {
303 pc: 0,
304 number: 197,
305 x0: 0,
306 x1: page_u,
307 x2: u64::from(VM_PROT_READ | VM_PROT_WRITE),
308 x3: DARWIN_MAP_ANON | DARWIN_MAP_PRIVATE,
309 x4: u64::MAX,
310 x5: 0,
311 x6: 0,
312 });
313 assert_eq!(r.name, "mmap");
314 assert!(!r.error, "mmap failed: {:?}", r.retval);
315 let addr = r.retval.expect("addr");
316 assert_ne!(addr, u64::MAX);
317 assert_ne!(addr, 0);
318
319 let r2 = dispatch(SyscallArgs {
320 pc: 0,
321 number: 74,
322 x0: addr,
323 x1: page_u,
324 x2: u64::from(VM_PROT_READ | VM_PROT_EXECUTE),
325 x3: 0,
326 x4: 0,
327 x5: 0,
328 x6: 0,
329 });
330 assert!(!r2.error);
331
332 let r3 = dispatch(SyscallArgs {
333 pc: 0,
334 number: 73,
335 x0: addr,
336 x1: page_u,
337 x2: 0,
338 x3: 0,
339 x4: 0,
340 x5: 0,
341 x6: 0,
342 });
343 assert!(!r3.error);
344 registry_clear();
345 }
346
347 #[test]
348 fn mmap_file_backed_shared_msync() {
349 let _g = lock_syscalls();
350 reset_syscall_state(256);
351 registry_clear();
352 let host = HostPageSize::detect().expect("host");
353 let stack = map_stack(host, 256 * 1024).expect("stack");
354 register_borrowed(&stack);
355
356 let dir = std::env::temp_dir().join(format!("kh-mmap-file-{}", std::process::id()));
357 drop(std::fs::create_dir_all(&dir));
358 let path = dir.join("payload.bin");
359 std::fs::write(&path, b"KAKEMAP01\n").expect("write payload");
360
361 let base = stack.guest_addr;
362 let path_str = path.to_str().unwrap();
363 let path_va = write_cstr(base, 0x1000, path_str);
364 let open = dispatch(args(5, path_va, 2, 0)); assert!(!open.error, "open: {:?}", open.retval);
366 let gfd = open.retval.expect("fd");
367
368 let page = host_page_size();
369 let page_u = u64::try_from(page).unwrap();
370 let map = dispatch(SyscallArgs {
371 pc: 0,
372 number: 197,
373 x0: 0,
374 x1: page_u,
375 x2: u64::from(VM_PROT_READ | VM_PROT_WRITE),
376 x3: DARWIN_MAP_SHARED,
377 x4: gfd,
378 x5: 0,
379 x6: 0,
380 });
381 assert!(!map.error, "mmap file: {:?}", map.retval);
382 let addr = map.retval.expect("map");
383 assert_eq!(guest_slice(addr, 9), b"KAKEMAP01");
384 guest_write(addr, b"X");
385
386 let sync = dispatch(SyscallArgs {
387 pc: 0,
388 number: 65,
389 x0: addr,
390 x1: page_u,
391 x2: 0x10, x3: 0,
393 x4: 0,
394 x5: 0,
395 x6: 0,
396 });
397 assert!(!sync.error, "msync: {:?}", sync.retval);
398
399 let unmap = dispatch(SyscallArgs {
400 pc: 0,
401 number: 73,
402 x0: addr,
403 x1: page_u,
404 x2: 0,
405 x3: 0,
406 x4: 0,
407 x5: 0,
408 x6: 0,
409 });
410 assert!(!unmap.error);
411 assert!(!dispatch(args(6, gfd, 0, 0)).error);
412
413 let on_disk = std::fs::read(&path).expect("reread");
414 assert_eq!(on_disk.first().copied(), Some(b'X'));
415 assert_eq!(on_disk.get(1..9), Some(b"AKEMAP01".as_slice()));
416
417 registry_clear();
418 drop(stack);
419 drop(std::fs::remove_file(&path));
420 drop(std::fs::remove_dir(&dir));
421 }
422
423 #[test]
424 fn gettimeofday_and_clock_gettime() {
425 let _g = lock_syscalls();
426 reset_syscall_state(256);
427 registry_clear();
428 let host = HostPageSize::detect().expect("host");
429 let stack = map_stack(host, 64 * 1024).expect("stack");
430 register_borrowed(&stack);
431 let base = stack.guest_addr;
432 let tv_va = guest_va(base, 0x400);
433 let ts_va = guest_va(base, 0x500);
434
435 let r = dispatch(args(116, tv_va, 0, 0));
436 assert!(!r.error, "gettimeofday: {:?}", r.retval);
437 let sec = guest_read_u64(tv_va);
438 let sec = i64::from_ne_bytes(sec.to_ne_bytes());
439 assert!(sec > 1_600_000_000, "tv_sec={sec}");
440
441 let r2 = dispatch(args(266, 0, ts_va, 0)); assert!(!r2.error, "clock_gettime: {:?}", r2.retval);
443 let sec2 = guest_read_u64(ts_va);
444 let sec2 = i64::from_ne_bytes(sec2.to_ne_bytes());
445 assert!((sec2 - sec).abs() < 5);
446
447 registry_clear();
448 drop(stack);
449 }
450
451 #[test]
452 fn sysctlbyname_hw_ncpu() {
453 let _g = lock_syscalls();
454 reset_syscall_state(256);
455 registry_clear();
456 let host = HostPageSize::detect().expect("host");
457 let stack = map_stack(host, 64 * 1024).expect("stack");
458 register_borrowed(&stack);
459 let base = stack.guest_addr;
460 let key_va = write_cstr(base, 0x200, "hw.ncpu");
461 let val_va = guest_va(base, 0x300);
462 let len_va = guest_va(base, 0x310);
463 guest_write(len_va, &8_u64.to_le_bytes());
464
465 let r = dispatch(SyscallArgs {
466 pc: 0,
467 number: 274,
468 x0: key_va,
469 x1: val_va,
470 x2: len_va,
471 x3: 0,
472 x4: 0,
473 x5: 0,
474 x6: 0,
475 });
476 assert!(!r.error, "sysctlbyname: {:?}", r.retval);
477 let ncpu = guest_read_i32(val_va);
478 assert!(ncpu >= 1);
479
480 registry_clear();
481 drop(stack);
482 }
483
484 #[test]
485 fn sigprocmask_soft_roundtrip() {
486 let _g = lock_syscalls();
487 reset_syscall_state(256);
488 registry_clear();
489 let host = HostPageSize::detect().expect("host");
490 let stack = map_stack(host, 64 * 1024).expect("stack");
491 register_borrowed(&stack);
492 let base = stack.guest_addr;
493 let set_va = guest_va(base, 0x100);
494 let oset_va = guest_va(base, 0x110);
495 guest_write(set_va, &0x00FF_u32.to_le_bytes());
496 let r = dispatch(SyscallArgs {
498 pc: 0,
499 number: 48,
500 x0: 3,
501 x1: set_va,
502 x2: oset_va,
503 x3: 0,
504 x4: 0,
505 x5: 0,
506 x6: 0,
507 });
508 assert!(!r.error, "sigprocmask: {:?}", r.retval);
509
510 registry_clear();
511 drop(stack);
512 }
513
514 #[test]
515 fn write_efault_when_registry_active_and_bad_ptr() {
516 let _g = lock_syscalls();
517 reset_syscall_state(256);
518 registry_clear();
519 let host = HostPageSize::detect().expect("host");
520 let stack = map_stack(host, 64 * 1024).expect("stack");
521 register_borrowed(&stack);
522
523 let r = dispatch(args(4, 1, 0x1, 4));
524 assert_eq!(r.name, "write");
525 assert!(r.error);
526 assert_eq!(r.retval, Some(u64::try_from(EFAULT).unwrap_or(0)));
527 registry_clear();
528 drop(stack);
529 }
530
531 #[test]
532 fn open_read_lseek_fstat_dup_roundtrip() {
533 let _g = lock_syscalls();
534 reset_syscall_state(256);
535 registry_clear();
536 let host = HostPageSize::detect().expect("host");
537 let stack = map_stack(host, 256 * 1024).expect("stack");
538 register_borrowed(&stack);
539
540 let dir = std::env::temp_dir().join(format!("kh-fd-test-{}", std::process::id()));
541 drop(std::fs::create_dir_all(&dir));
542 let path = dir.join("data.txt");
543 {
544 let mut f = std::fs::File::create(&path).expect("create");
545 f.write_all(b"hello-DEF").expect("write");
546 }
547
548 let base = stack.guest_addr;
549 let path_str = path.to_str().expect("utf8 path");
550 let path_va = write_cstr(base, 0x1000, path_str);
551 let open = dispatch(args(5, path_va, 0, 0)); assert!(!open.error, "open: {:?}", open.retval);
553 let gfd = open.retval.expect("fd");
554
555 let read_va = guest_va(base, 0x2000);
556 let rd = dispatch(args(3, gfd, read_va, 5)); assert!(!rd.error, "read: {:?}", rd.retval);
558 assert_eq!(rd.retval, Some(5));
559 assert_eq!(guest_slice(read_va, 5), b"hello");
560
561 let seek = dispatch(args(199, gfd, 0, 0)); assert!(!seek.error);
563 assert_eq!(seek.retval, Some(0));
564
565 let stat_va = guest_va(base, 0x3000);
566 let st = dispatch(args(339, gfd, stat_va, 0));
567 assert!(!st.error, "fstat: {:?}", st.retval);
568 let size = guest_read_u64(stat_va + 96);
570 let size = i64::from_ne_bytes(size.to_ne_bytes());
571 assert_eq!(size, 9);
572
573 let dup = dispatch(args(41, gfd, 0, 0));
574 assert!(!dup.error);
575 let gfd2 = dup.retval.expect("dup fd");
576 assert_ne!(gfd2, gfd);
577
578 let fl = dispatch(args(92, gfd, 3, 0));
579 assert!(!fl.error);
580
581 assert!(!dispatch(args(6, gfd, 0, 0)).error);
582 assert!(!dispatch(args(6, gfd2, 0, 0)).error);
583
584 registry_clear();
585 drop(stack);
586 drop(std::fs::remove_file(&path));
587 drop(std::fs::remove_dir(&dir));
588 }
589
590 #[test]
591 fn openat_at_fdcwd() {
592 let _g = lock_syscalls();
593 reset_syscall_state(256);
594 registry_clear();
595 let host = HostPageSize::detect().expect("host");
596 let stack = map_stack(host, 64 * 1024).expect("stack");
597 register_borrowed(&stack);
598
599 let dir = std::env::temp_dir().join(format!("kh-openat-{}", std::process::id()));
600 drop(std::fs::create_dir_all(&dir));
601 let path = dir.join("x.txt");
602 std::fs::write(&path, b"z").expect("write");
603
604 let base = stack.guest_addr;
605 let path_str = path.to_str().unwrap();
606 let path_va = write_cstr(base, 0x800, path_str);
607 let r = dispatch(SyscallArgs {
608 pc: 0,
609 number: 463,
610 x0: u64::from_ne_bytes(i64::from(fd::AT_FDCWD).to_ne_bytes()),
611 x1: path_va,
612 x2: 0,
613 x3: 0,
614 x4: 0,
615 x5: 0,
616 x6: 0,
617 });
618 assert!(!r.error, "openat: {:?}", r.retval);
619 let gfd = r.retval.unwrap();
620 assert!(!dispatch(args(6, gfd, 0, 0)).error);
621
622 registry_clear();
623 drop(stack);
624 drop(std::fs::remove_file(&path));
625 drop(std::fs::remove_dir(&dir));
626 }
627}