Skip to main content

starnix_core/vfs/
syscalls.rs

1// Copyright 2021 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::mm::{IOVecPtr, MemoryAccessor, MemoryAccessorExt, PAGE_SIZE};
6use crate::security;
7use crate::syscalls::time::{ITimerSpecPtr, TimeSpecPtr, TimeValPtr};
8use crate::task::{CurrentTask, EventHandler, ReadyItem, ReadyItemKey, Waiter};
9use crate::time::{Timeline, TimerWakeup};
10use crate::vfs::aio::AioContext;
11use crate::vfs::buffers::{UserBuffersInputBuffer, UserBuffersOutputBuffer};
12use crate::vfs::eventfd::{EventFdType, new_eventfd};
13use crate::vfs::fs_args::MountParams;
14use crate::vfs::pidfd::new_pidfd;
15use crate::vfs::pipe::{PipeFileObject, new_pipe};
16use crate::vfs::timer::TimerFile;
17use crate::vfs::{
18    AccessCheck, DirectoryMode, DirentSink64, EpollFileObject, FallocMode, FdFlags, FdNumber,
19    FileAsyncOwner, FileHandle, FileSystemOptions, FlockOperation, FsContext, FsStr, FsString,
20    LookupContext, Mount, NamespaceNode, PathWithReachability, RecordLockCommand, RenameFlags,
21    SeekTarget, StatxFlags, SymlinkMode, SymlinkTarget, TargetFdNumber, TimeUpdateType, UnlinkKind,
22    ValueOrSize, WhatToMount, XattrOp, checked_add_offset_and_length, new_memfd, splice,
23};
24use fuchsia_rcu::RcuReadScope;
25use starnix_logging::{log_trace, track_stub};
26use starnix_sync::{EventHandlerReadyQueueLock, LockDepMutex};
27use starnix_syscalls::{SUCCESS, SyscallArg, SyscallResult};
28use starnix_types::time::{
29    duration_from_poll_timeout, duration_from_timespec, time_from_timespec, timespec_from_duration,
30};
31use starnix_types::user_buffer::UserBuffer;
32use starnix_uapi::arc_key::PtrKey;
33use starnix_uapi::auth::{
34    CAP_BLOCK_SUSPEND, CAP_DAC_READ_SEARCH, CAP_LEASE, CAP_SYS_ADMIN, CAP_WAKE_ALARM, Capabilities,
35    Credentials, PTRACE_MODE_ATTACH_REALCREDS,
36};
37use starnix_uapi::device_id::DeviceId;
38use starnix_uapi::errors::{
39    EFAULT, EINTR, ENAMETOOLONG, ENOTSUP, ETIMEDOUT, Errno, ErrnoResultExt,
40};
41use starnix_uapi::file_lease::FileLeaseType;
42use starnix_uapi::file_mode::{Access, FileMode};
43use starnix_uapi::inotify_mask::InotifyMask;
44use starnix_uapi::mount_flags::MountFlags;
45use starnix_uapi::open_flags::OpenFlags;
46use starnix_uapi::personality::PersonalityFlags;
47use starnix_uapi::resource_limits::Resource;
48use starnix_uapi::seal_flags::SealFlags;
49use starnix_uapi::signals::SigSet;
50use starnix_uapi::unmount_flags::UnmountFlags;
51use starnix_uapi::user_address::{MultiArchUserRef, UserAddress, UserCString, UserRef};
52use starnix_uapi::user_value::UserValue;
53use starnix_uapi::vfs::{EpollEvent, FdEvents, ResolveFlags};
54use starnix_uapi::{
55    __kernel_fd_set, AT_EACCESS, AT_EMPTY_PATH, AT_NO_AUTOMOUNT, AT_REMOVEDIR, AT_SYMLINK_FOLLOW,
56    AT_SYMLINK_NOFOLLOW, CLOCK_BOOTTIME, CLOCK_BOOTTIME_ALARM, CLOCK_MONOTONIC, CLOCK_REALTIME,
57    CLOCK_REALTIME_ALARM, CLOSE_RANGE_CLOEXEC, CLOSE_RANGE_UNSHARE, EFD_CLOEXEC, EFD_NONBLOCK,
58    EFD_SEMAPHORE, EPOLL_CLOEXEC, EPOLL_CTL_ADD, EPOLL_CTL_DEL, EPOLL_CTL_MOD, F_ADD_SEALS,
59    F_DUPFD, F_DUPFD_CLOEXEC, F_GET_SEALS, F_GETFD, F_GETFL, F_GETLEASE, F_GETLK, F_GETLK64,
60    F_GETOWN, F_GETOWN_EX, F_OFD_GETLK, F_OFD_SETLK, F_OFD_SETLKW, F_SETFD, F_SETFL, F_SETLEASE,
61    F_SETLK, F_SETLK64, F_SETLKW, F_SETLKW64, F_SETOWN, F_SETOWN_EX, F_SETSIG, FIOCLEX, FIONCLEX,
62    MFD_ALLOW_SEALING, MFD_CLOEXEC, MFD_EXEC, MFD_HUGE_MASK, MFD_HUGE_SHIFT, MFD_HUGETLB,
63    MFD_NOEXEC_SEAL, NAME_MAX, O_CLOEXEC, O_CREAT, O_NOFOLLOW, O_NOTIFICATION_PIPE, O_PATH,
64    O_TMPFILE, PIDFD_NONBLOCK, POLLERR, POLLHUP, POLLIN, POLLOUT, POLLPRI, POLLRDBAND, POLLRDNORM,
65    POLLWRBAND, POLLWRNORM, POSIX_FADV_DONTNEED, POSIX_FADV_NOREUSE, POSIX_FADV_NORMAL,
66    POSIX_FADV_RANDOM, POSIX_FADV_SEQUENTIAL, POSIX_FADV_WILLNEED, RWF_SUPPORTED, TFD_CLOEXEC,
67    TFD_NONBLOCK, TFD_TIMER_ABSTIME, TFD_TIMER_CANCEL_ON_SET, XATTR_CREATE, XATTR_NAME_MAX,
68    XATTR_REPLACE, XATTR_SIZE_MAX, aio_context_t, errno, error, io_event, iocb, off_t, pid_t,
69    pollfd, pselect6_sigmask, sigset_t, statx, timespec, uapi, uid_t,
70};
71use std::collections::{HashSet, VecDeque};
72use std::marker::PhantomData;
73use std::sync::Arc;
74use zerocopy::{Immutable, IntoBytes};
75
76uapi::check_arch_independent_layout! {
77    pollfd {
78        fd,
79        events,
80        revents,
81    }
82
83    io_event {
84        data,
85        obj,
86        res,
87        res2,
88    }
89
90    iocb {
91        aio_data,
92        aio_key,
93        aio_rw_flags,
94        aio_lio_opcode,
95        aio_reqprio,
96        aio_fildes,
97        aio_buf,
98        aio_nbytes,
99        aio_offset,
100        aio_reserved2,
101        aio_flags,
102        aio_resfd,
103    }
104
105    statx_timestamp {
106        tv_sec,
107        tv_nsec,
108    }
109
110    statx {
111        stx_mask,
112        stx_blksize,
113        stx_attributes,
114        stx_nlink,
115        stx_uid,
116        stx_gid,
117        stx_mode,
118        stx_ino,
119        stx_size,
120        stx_blocks,
121        stx_attributes_mask,
122        stx_atime,
123        stx_btime,
124        stx_ctime,
125        stx_mtime,
126        stx_rdev_major,
127        stx_rdev_minor,
128        stx_dev_major,
129        stx_dev_minor,
130        stx_mnt_id,
131        stx_dio_mem_align,
132        stx_dio_offset_align,
133        stx_subvol,
134        stx_atomic_write_unit_min,
135        stx_atomic_write_unit_max,
136        stx_atomic_write_segments_max,
137    }
138
139    io_sqring_offsets {
140        head,
141        tail,
142        ring_mask,
143        ring_entries,
144        flags,
145        dropped,
146        array,
147        resv1,
148        user_addr,
149    }
150
151    io_cqring_offsets {
152        head,
153        tail,
154        ring_mask,
155        ring_entries,
156        overflow,
157        cqes,
158        flags,
159        resv1,
160        user_addr,
161    }
162
163    io_uring_params {
164        sq_entries,
165        cq_entries,
166        flags,
167        sq_thread_cpu,
168        sq_thread_idle,
169        features,
170        wq_fd,
171        resv,
172        sq_off,
173        cq_off,
174    }
175
176    io_uring_rsrc_update {
177        offset,
178        resv,
179        data,
180    }
181
182    io_uring_buf_reg {
183        ring_addr,
184        ring_entries,
185        bgid,
186        flags,
187        resv,
188    }
189}
190
191// Constants from bionic/libc/include/sys/stat.h
192const UTIME_NOW: i64 = 0x3fffffff;
193const UTIME_OMIT: i64 = 0x3ffffffe;
194
195pub type OffsetPtr = MultiArchUserRef<uapi::off_t, uapi::arch32::off_t>;
196pub type IocbPtr = MultiArchUserRef<iocb, iocb>;
197pub type IocbPtrPtr = MultiArchUserRef<IocbPtr, IocbPtr>;
198
199pub fn sys_read(
200    current_task: &CurrentTask,
201    fd: FdNumber,
202    address: UserAddress,
203    length: usize,
204) -> Result<usize, Errno> {
205    let file = current_task.files().get(fd)?;
206    file.read(
207        current_task,
208        &mut UserBuffersOutputBuffer::unified_new_at(current_task, address, length)?,
209    )
210    .map_eintr(|| errno!(ERESTARTSYS))
211}
212
213pub fn sys_write(
214    current_task: &CurrentTask,
215    fd: FdNumber,
216    address: UserAddress,
217    length: usize,
218) -> Result<usize, Errno> {
219    let file = current_task.files().get(fd)?;
220    file.write(
221        current_task,
222        &mut UserBuffersInputBuffer::unified_new_at(current_task, address, length)?,
223    )
224    .map_eintr(|| errno!(ERESTARTSYS))
225}
226
227pub fn sys_close(current_task: &CurrentTask, fd: FdNumber) -> Result<(), Errno> {
228    current_task.files().close(fd)?;
229    Ok(())
230}
231
232pub fn sys_close_range(
233    current_task: &CurrentTask,
234    first: u32,
235    last: u32,
236    flags: u32,
237) -> Result<(), Errno> {
238    // From close_range(2): "EINVAL: flags is not valid, or first is greater than last."
239    if first > last || flags & !(CLOSE_RANGE_UNSHARE | CLOSE_RANGE_CLOEXEC) != 0 {
240        return error!(EINVAL);
241    }
242    // CLOSE_RANGE_UNSHARE: "Unshare the specified file descriptors from any other processes
243    // before closing them."
244    if flags & CLOSE_RANGE_UNSHARE != 0 {
245        current_task.running_state().unshare_files(current_task);
246    }
247    let files = current_task.files();
248    let range = first..=last;
249    if flags & CLOSE_RANGE_CLOEXEC != 0 {
250        // CLOSE_RANGE_CLOEXEC: "Set the close-on-exec flag on the specified file descriptors,
251        // rather than immediately closing them."
252        files.retain(|fd, fd_flags| {
253            if range.contains(&(fd.raw() as u32)) {
254                *fd_flags |= FdFlags::CLOEXEC;
255            }
256            true
257        });
258    } else {
259        files.retain(|fd, _| !range.contains(&(fd.raw() as u32)));
260    }
261    Ok(())
262}
263
264pub fn sys_lseek(
265    current_task: &CurrentTask,
266    fd: FdNumber,
267    offset: off_t,
268    whence: u32,
269) -> Result<off_t, Errno> {
270    let file = current_task.files().get(fd)?;
271    file.seek(current_task, SeekTarget::from_raw(whence, offset)?)
272}
273
274pub fn sys_fcntl(
275    current_task: &CurrentTask,
276    fd: FdNumber,
277    cmd: u32,
278    arg: u64,
279) -> Result<SyscallResult, Errno> {
280    let file = match cmd {
281        F_DUPFD | F_DUPFD_CLOEXEC | F_GETFD | F_SETFD | F_GETFL => {
282            current_task.files().get_allowing_opath(fd)?
283        }
284        _ => current_task.files().get(fd)?,
285    };
286
287    security::check_file_fcntl_access(current_task, &file, cmd, arg)?;
288
289    match cmd {
290        F_DUPFD | F_DUPFD_CLOEXEC => {
291            let fd_number = arg as i32;
292            let flags = if cmd == F_DUPFD_CLOEXEC { FdFlags::CLOEXEC } else { FdFlags::empty() };
293            let newfd = current_task.files().duplicate(
294                current_task,
295                fd,
296                TargetFdNumber::Minimum(FdNumber::from_raw(fd_number)),
297                flags,
298            )?;
299            Ok(newfd.into())
300        }
301        F_GETOWN => Ok(file.get_async_owner().get_owner().into()),
302        F_GETOWN_EX => {
303            let owner = file.get_async_owner().get_owner_ex();
304            let user_owner = UserRef::<uapi::f_owner_ex>::new(UserAddress::from(arg));
305            current_task.write_object(user_owner, &owner)?;
306            Ok(SUCCESS)
307        }
308        F_SETOWN => {
309            let pid = (arg as u32) as i32;
310            let owner = FileAsyncOwner::new(current_task, pid)?;
311            // TODO: https://fxbug.dev/364569860 - Integrate with LSM file_setfowner hook.
312            file.set_async_owner(owner);
313            Ok(SUCCESS)
314        }
315        F_SETOWN_EX => {
316            let user_owner = UserRef::<uapi::f_owner_ex>::new(UserAddress::from(arg));
317            let requested_owner = current_task.read_object(user_owner)?;
318            let owner = FileAsyncOwner::new_ex(current_task, requested_owner)?;
319            file.set_async_owner(owner);
320            Ok(SUCCESS)
321        }
322        F_GETFD => Ok(current_task.files().get_fd_flags_allowing_opath(fd)?.into()),
323        F_SETFD => {
324            current_task
325                .files()
326                .set_fd_flags_allowing_opath(fd, FdFlags::from_bits_truncate(arg as u32))?;
327            Ok(SUCCESS)
328        }
329        F_GETFL => {
330            // O_PATH allowed for:
331            //
332            //   Retrieving open file status flags using the fcntl(2)
333            //   F_GETFL operation: the returned flags will include the
334            //   bit O_PATH.
335            //
336            // See https://man7.org/linux/man-pages/man2/open.2.html
337            Ok(file.flags().into())
338        }
339        F_SETFL => {
340            let settable_flags = OpenFlags::APPEND
341                | OpenFlags::DIRECT
342                | OpenFlags::NOATIME
343                | OpenFlags::NONBLOCK
344                | OpenFlags::ASYNC;
345            let requested_flags =
346                OpenFlags::from_bits_truncate((arg as u32) & settable_flags.bits());
347
348            // If `NOATIME` flag is being set then check that it's allowed.
349            if requested_flags.contains(OpenFlags::NOATIME)
350                && !file.flags().contains(OpenFlags::NOATIME)
351            {
352                file.name.check_o_noatime_allowed(current_task)?;
353            }
354
355            file.update_file_flags(requested_flags, settable_flags);
356            Ok(SUCCESS)
357        }
358        F_SETLK | F_SETLKW | F_GETLK => {
359            let flock_ref =
360                MultiArchUserRef::<uapi::flock, uapi::arch32::flock>::new(current_task, arg);
361            let flock = current_task.read_multi_arch_object(flock_ref)?;
362            let cmd = RecordLockCommand::from_raw(cmd).ok_or_else(|| errno!(EINVAL))?;
363            if let Some(flock) = file.record_lock(current_task, cmd, flock)? {
364                current_task.write_multi_arch_object(flock_ref, flock)?;
365            }
366            Ok(SUCCESS)
367        }
368        F_SETLK64 | F_SETLKW64 | F_GETLK64 | F_OFD_GETLK | F_OFD_SETLK | F_OFD_SETLKW => {
369            let flock_ref =
370                MultiArchUserRef::<uapi::flock, uapi::arch32::flock64>::new(current_task, arg);
371            let flock = current_task.read_multi_arch_object(flock_ref)?;
372            let cmd = RecordLockCommand::from_raw(cmd).ok_or_else(|| errno!(EINVAL))?;
373            if let Some(flock) = file.record_lock(current_task, cmd, flock)? {
374                current_task.write_multi_arch_object(flock_ref, flock)?;
375            }
376            Ok(SUCCESS)
377        }
378        F_ADD_SEALS => {
379            if !file.can_write() {
380                // Cannot add seals if the file is not writable
381                return error!(EPERM);
382            }
383            let mut state = file.name.entry.node.write_guard_state.lock();
384            let flags = SealFlags::from_bits_truncate(arg as u32);
385            state.try_add_seal(flags)?;
386            Ok(SUCCESS)
387        }
388        F_GET_SEALS => {
389            let state = file.name.entry.node.write_guard_state.lock();
390            Ok(state.get_seals()?.into())
391        }
392        F_SETLEASE => {
393            let fsuid = current_task.current_creds().fsuid;
394            if fsuid != file.node().info().uid {
395                security::check_task_capable(current_task, CAP_LEASE)?;
396            }
397            let lease = FileLeaseType::from_bits(arg as u32)?;
398            file.set_lease(current_task, lease)?;
399            Ok(SUCCESS)
400        }
401        F_GETLEASE => Ok(file.get_lease().into()),
402        F_SETSIG => {
403            track_stub!(TODO("https://fxbug.dev/437972675"), "F_SETSIG");
404            return error!(EINVAL);
405        }
406        _ => file.fcntl(current_task, cmd, arg),
407    }
408}
409
410pub fn sys_pread64(
411    current_task: &CurrentTask,
412    fd: FdNumber,
413    address: UserAddress,
414    length: usize,
415    offset: off_t,
416) -> Result<usize, Errno> {
417    let file = current_task.files().get(fd)?;
418    let offset = offset.try_into().map_err(|_| errno!(EINVAL))?;
419    file.read_at(
420        current_task,
421        offset,
422        &mut UserBuffersOutputBuffer::unified_new_at(current_task, address, length)?,
423    )
424}
425
426pub fn sys_pwrite64(
427    current_task: &CurrentTask,
428    fd: FdNumber,
429    address: UserAddress,
430    length: usize,
431    offset: off_t,
432) -> Result<usize, Errno> {
433    let file = current_task.files().get(fd)?;
434    let offset = offset.try_into().map_err(|_| errno!(EINVAL))?;
435    file.write_at(
436        current_task,
437        offset,
438        &mut UserBuffersInputBuffer::unified_new_at(current_task, address, length)?,
439    )
440}
441
442fn do_readv(
443    current_task: &CurrentTask,
444    fd: FdNumber,
445    iovec_addr: IOVecPtr,
446    iovec_count: UserValue<i32>,
447    offset: Option<off_t>,
448    flags: u32,
449) -> Result<usize, Errno> {
450    if flags & !RWF_SUPPORTED != 0 {
451        return error!(EOPNOTSUPP);
452    }
453    if flags != 0 {
454        track_stub!(TODO("https://fxbug.dev/322875072"), "preadv2 flags", flags);
455    }
456    let file = current_task.files().get(fd)?;
457    let iovec = current_task.read_iovec(iovec_addr, iovec_count)?;
458    let mut data = UserBuffersOutputBuffer::unified_new(current_task, iovec)?;
459    if let Some(offset) = offset {
460        file.read_at(current_task, offset.try_into().map_err(|_| errno!(EINVAL))?, &mut data)
461    } else {
462        file.read(current_task, &mut data)
463    }
464}
465
466pub fn sys_readv(
467    current_task: &CurrentTask,
468    fd: FdNumber,
469    iovec_addr: IOVecPtr,
470    iovec_count: UserValue<i32>,
471) -> Result<usize, Errno> {
472    do_readv(current_task, fd, iovec_addr, iovec_count, None, 0)
473}
474
475pub fn sys_preadv(
476    current_task: &CurrentTask,
477    fd: FdNumber,
478    iovec_addr: IOVecPtr,
479    iovec_count: UserValue<i32>,
480    offset: off_t,
481) -> Result<usize, Errno> {
482    do_readv(current_task, fd, iovec_addr, iovec_count, Some(offset), 0)
483}
484
485pub fn sys_preadv2(
486    current_task: &CurrentTask,
487    fd: FdNumber,
488    iovec_addr: IOVecPtr,
489    iovec_count: UserValue<i32>,
490    offset: off_t,
491    _unused: SyscallArg, // On 32-bit systems, holds the upper 32 bits of offset.
492    flags: u32,
493) -> Result<usize, Errno> {
494    let offset = if offset == -1 { None } else { Some(offset) };
495    do_readv(current_task, fd, iovec_addr, iovec_count, offset, flags)
496}
497
498fn do_writev(
499    current_task: &CurrentTask,
500    fd: FdNumber,
501    iovec_addr: IOVecPtr,
502    iovec_count: UserValue<i32>,
503    offset: Option<off_t>,
504    flags: u32,
505) -> Result<usize, Errno> {
506    if flags & !RWF_SUPPORTED != 0 {
507        return error!(EOPNOTSUPP);
508    }
509    if flags != 0 {
510        track_stub!(TODO("https://fxbug.dev/322874523"), "pwritev2 flags", flags);
511    }
512
513    let file = current_task.files().get(fd)?;
514    let iovec = current_task.read_iovec(iovec_addr, iovec_count)?;
515    let mut data = UserBuffersInputBuffer::unified_new(current_task, iovec)?;
516    let res = if let Some(offset) = offset {
517        file.write_at(current_task, offset.try_into().map_err(|_| errno!(EINVAL))?, &mut data)
518    } else {
519        file.write(current_task, &mut data)
520    };
521
522    match &res {
523        Err(e) if e.code == EFAULT => {
524            track_stub!(TODO("https://fxbug.dev/297370529"), "allow partial writes")
525        }
526        _ => (),
527    }
528
529    res
530}
531
532pub fn sys_writev(
533    current_task: &CurrentTask,
534    fd: FdNumber,
535    iovec_addr: IOVecPtr,
536    iovec_count: UserValue<i32>,
537) -> Result<usize, Errno> {
538    do_writev(current_task, fd, iovec_addr, iovec_count, None, 0)
539}
540
541pub fn sys_pwritev(
542    current_task: &CurrentTask,
543    fd: FdNumber,
544    iovec_addr: IOVecPtr,
545    iovec_count: UserValue<i32>,
546    offset: off_t,
547) -> Result<usize, Errno> {
548    do_writev(current_task, fd, iovec_addr, iovec_count, Some(offset), 0)
549}
550
551pub fn sys_pwritev2(
552    current_task: &CurrentTask,
553    fd: FdNumber,
554    iovec_addr: IOVecPtr,
555    iovec_count: UserValue<i32>,
556    offset: off_t,
557    _unused: SyscallArg, // On 32-bit systems, holds the upper 32 bits of offset.
558    flags: u32,
559) -> Result<usize, Errno> {
560    let offset = if offset == -1 { None } else { Some(offset) };
561    do_writev(current_task, fd, iovec_addr, iovec_count, offset, flags)
562}
563
564type StatFsPtr = MultiArchUserRef<uapi::statfs, uapi::arch32::statfs>;
565
566pub fn fstatfs<T32: IntoBytes + Immutable + TryFrom<uapi::statfs>>(
567    current_task: &CurrentTask,
568    fd: FdNumber,
569    user_buf: MultiArchUserRef<uapi::statfs, T32>,
570) -> Result<(), Errno> {
571    // O_PATH allowed for:
572    //
573    //   fstatfs(2) (since Linux 3.12).
574    //
575    // See https://man7.org/linux/man-pages/man2/open.2.html
576    let file = current_task.files().get_allowing_opath(fd)?;
577    let mut stat = file.fs.statfs(current_task)?;
578    stat.f_flags |= file.name.mount.flags().bits() as i64;
579    current_task.write_multi_arch_object(user_buf, stat)?;
580    Ok(())
581}
582
583pub fn sys_fstatfs(
584    current_task: &CurrentTask,
585    fd: FdNumber,
586    user_buf: StatFsPtr,
587) -> Result<(), Errno> {
588    fstatfs(current_task, fd, user_buf)
589}
590
591fn statfs<T32: IntoBytes + Immutable + TryFrom<uapi::statfs>>(
592    current_task: &CurrentTask,
593    user_path: UserCString,
594    user_buf: MultiArchUserRef<uapi::statfs, T32>,
595) -> Result<(), Errno> {
596    let name = lookup_at(current_task, FdNumber::AT_FDCWD, user_path, LookupFlags::default())?;
597    let fs = name.entry.node.fs();
598    let mut stat = fs.statfs(current_task)?;
599    stat.f_flags |= name.mount.flags().bits() as i64;
600    current_task.write_multi_arch_object(user_buf, stat)?;
601    Ok(())
602}
603
604pub fn sys_statfs(
605    current_task: &CurrentTask,
606    user_path: UserCString,
607    user_buf: StatFsPtr,
608) -> Result<(), Errno> {
609    statfs(current_task, user_path, user_buf)
610}
611
612pub fn sys_sendfile(
613    current_task: &CurrentTask,
614    out_fd: FdNumber,
615    in_fd: FdNumber,
616    user_offset: OffsetPtr,
617    count: i32,
618) -> Result<usize, Errno> {
619    splice::sendfile(current_task, out_fd, in_fd, user_offset, count)
620}
621
622/// A convenient wrapper for Task::open_file_at.
623///
624/// Reads user_path from user memory and then calls through to Task::open_file_at.
625fn open_file_at(
626    current_task: &CurrentTask,
627    dir_fd: FdNumber,
628    user_path: UserCString,
629    flags: u32,
630    mode: FileMode,
631    resolve_flags: ResolveFlags,
632) -> Result<FileHandle, Errno> {
633    let path = current_task.read_path(user_path)?;
634    let open_flags = OpenFlags::from_bits_truncate(flags);
635    log_trace!(dir_fd:%, path:%; "open_file_at");
636    current_task.open_file_at(dir_fd, path.as_ref(), open_flags, mode, resolve_flags)
637}
638
639fn lookup_parent_at<T, F>(
640    current_task: &CurrentTask,
641    dir_fd: FdNumber,
642    user_path: UserCString,
643    callback: F,
644) -> Result<T, Errno>
645where
646    F: Fn(LookupContext, NamespaceNode, &FsStr) -> Result<T, Errno>,
647{
648    let path = current_task.read_path(user_path)?;
649    log_trace!(dir_fd:%, path:%; "lookup_parent_at");
650    if path.is_empty() {
651        return error!(ENOENT);
652    }
653    let mut context = LookupContext::default();
654    let (parent, basename) = current_task.lookup_parent_at(&mut context, dir_fd, path.as_ref())?;
655    callback(context, parent, basename)
656}
657
658/// Options for lookup_at.
659#[derive(Debug, Default, Copy, Clone)]
660pub struct LookupFlags {
661    /// Whether AT_EMPTY_PATH was supplied.
662    allow_empty_path: bool,
663
664    /// Used to implement AT_SYMLINK_NOFOLLOW.
665    symlink_mode: SymlinkMode,
666
667    /// Automount directories on the path.
668    // TODO(https://fxbug.dev/297370602): Support the `AT_NO_AUTOMOUNT` flag.
669    #[allow(dead_code)]
670    automount: bool,
671
672    /// Whether the lookup requires the target to be a directory.
673    directory_mode: DirectoryMode,
674}
675
676impl LookupFlags {
677    pub fn no_follow() -> Self {
678        Self { symlink_mode: SymlinkMode::NoFollow, ..Default::default() }
679    }
680
681    pub fn directory() -> Self {
682        Self { directory_mode: DirectoryMode::MustBeDirectory, ..Default::default() }
683    }
684
685    fn from_bits(flags: u32, allowed_flags: u32) -> Result<Self, Errno> {
686        if flags & !allowed_flags != 0 {
687            return error!(EINVAL);
688        }
689        let follow_symlinks = if allowed_flags & AT_SYMLINK_FOLLOW != 0 {
690            flags & AT_SYMLINK_FOLLOW != 0
691        } else {
692            flags & AT_SYMLINK_NOFOLLOW == 0
693        };
694        let automount =
695            if allowed_flags & AT_NO_AUTOMOUNT != 0 { flags & AT_NO_AUTOMOUNT == 0 } else { false };
696        if automount {
697            track_stub!(TODO("https://fxbug.dev/297370602"), "LookupFlags::automount");
698        }
699        Ok(LookupFlags {
700            allow_empty_path: (flags & AT_EMPTY_PATH != 0)
701                || (flags & O_PATH != 0 && flags & O_NOFOLLOW != 0),
702            symlink_mode: if follow_symlinks { SymlinkMode::Follow } else { SymlinkMode::NoFollow },
703            automount,
704            directory_mode: DirectoryMode::AllowAny,
705        })
706    }
707}
708
709impl From<StatxFlags> for LookupFlags {
710    fn from(flags: StatxFlags) -> Self {
711        let lookup_flags = StatxFlags::AT_SYMLINK_NOFOLLOW
712            | StatxFlags::AT_EMPTY_PATH
713            | StatxFlags::AT_NO_AUTOMOUNT;
714        Self::from_bits((flags & lookup_flags).bits(), lookup_flags.bits()).unwrap()
715    }
716}
717
718pub fn lookup_at(
719    current_task: &CurrentTask,
720    dir_fd: FdNumber,
721    user_path: UserCString,
722    options: LookupFlags,
723) -> Result<NamespaceNode, Errno> {
724    let path = current_task.read_path(user_path)?;
725    log_trace!(dir_fd:%, path:%; "lookup_at");
726    if path.is_empty() {
727        if options.allow_empty_path {
728            let (node, _) =
729                current_task.resolve_dir_fd(dir_fd, path.as_ref(), ResolveFlags::empty())?;
730            return Ok(node);
731        }
732        return error!(ENOENT);
733    }
734
735    let mut parent_context = LookupContext::default();
736    let (parent, basename) =
737        current_task.lookup_parent_at(&mut parent_context, dir_fd, path.as_ref())?;
738
739    let directory_mode = match (parent_context.directory_mode, options.directory_mode) {
740        (DirectoryMode::MustBeDirectory, _) | (_, DirectoryMode::MustBeDirectory) => {
741            DirectoryMode::MustBeDirectory
742        }
743        _ => DirectoryMode::AllowAny,
744    };
745    let symlink_mode = if directory_mode == DirectoryMode::MustBeDirectory {
746        // The child must resolve to a directory. This is because a trailing slash
747        // was found in the path or the caller specified that the lookup must be a directory.
748        // If the child is a symlink, we should follow it.
749        // See https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xbd_chap03.html#tag_21_03_00_75
750        SymlinkMode::Follow
751    } else {
752        options.symlink_mode
753    };
754    let mut child_context = parent_context.with(symlink_mode, directory_mode);
755
756    parent.lookup_child(current_task, &mut child_context, basename)
757}
758
759fn do_openat(
760    current_task: &CurrentTask,
761    dir_fd: FdNumber,
762    user_path: UserCString,
763    flags: u32,
764    mode: FileMode,
765    resolve_flags: ResolveFlags,
766) -> Result<FdNumber, Errno> {
767    let file = open_file_at(current_task, dir_fd, user_path, flags, mode, resolve_flags)?;
768    let fd_flags = get_fd_flags(flags);
769    current_task.add_file(file, fd_flags)
770}
771
772pub fn sys_openat(
773    current_task: &CurrentTask,
774    dir_fd: FdNumber,
775    user_path: UserCString,
776    flags: u32,
777    mode: FileMode,
778) -> Result<FdNumber, Errno> {
779    do_openat(current_task, dir_fd, user_path, flags, mode, ResolveFlags::empty())
780}
781
782pub fn sys_openat2(
783    current_task: &CurrentTask,
784    dir_fd: FdNumber,
785    user_path: UserCString,
786    how_ref: UserRef<uapi::open_how>,
787    size: usize,
788) -> Result<FdNumber, Errno> {
789    const EXPECTED_SIZE: usize = std::mem::size_of::<uapi::open_how>();
790    if size < EXPECTED_SIZE {
791        return error!(EINVAL);
792    }
793
794    let how = current_task.read_object(how_ref)?;
795
796    // If the `size` is greater than expected, then we need to check that any extra bytes after
797    // `open_how` are set to 0. This is needed to properly handle the case when `open_how` is
798    // extended with new fields in the future. There is no upper limit on the buffer size, so we
799    // limit size of each read to one page.
800    let mut pos = EXPECTED_SIZE;
801    while pos < size {
802        let length = std::cmp::min(size - pos, *PAGE_SIZE as usize);
803        let extra_bytes =
804            current_task.read_buffer(&UserBuffer { address: (how_ref.addr() + pos)?, length })?;
805        for b in extra_bytes {
806            if b != 0 {
807                return error!(E2BIG);
808            }
809        }
810        pos += length;
811    }
812
813    let flags: u32 = how.flags.try_into().map_err(|_| errno!(EINVAL))?;
814
815    // `mode` can be specified only with `O_CREAT` or `O_TMPFILE`.
816    let allowed_mode_flags = if (flags & (O_CREAT | O_TMPFILE)) > 0 { 0o7777 } else { 0 };
817    if (how.mode & !allowed_mode_flags) != 0 {
818        return error!(EINVAL);
819    }
820
821    let mode = FileMode::from_bits(how.mode.try_into().map_err(|_| errno!(EINVAL))?);
822    let resolve_flags =
823        ResolveFlags::from_bits(how.resolve.try_into().map_err(|_| errno!(EINVAL))?)
824            .ok_or_else(|| errno!(EINVAL))?;
825
826    if resolve_flags.contains(ResolveFlags::CACHED) {
827        track_stub!(TODO("https://fxbug.dev/326474574"), "openat2: RESOLVE_CACHED");
828        return error!(EAGAIN);
829    }
830
831    do_openat(current_task, dir_fd, user_path, flags, mode, resolve_flags)
832}
833
834pub fn sys_faccessat(
835    current_task: &CurrentTask,
836    dir_fd: FdNumber,
837    user_path: UserCString,
838    mode: u32,
839) -> Result<(), Errno> {
840    sys_faccessat2(current_task, dir_fd, user_path, mode, 0)
841}
842
843pub fn sys_faccessat2(
844    current_task: &CurrentTask,
845    dir_fd: FdNumber,
846    user_path: UserCString,
847    mode: u32,
848    flags: u32,
849) -> Result<(), Errno> {
850    let access_check = || {
851        let mode = Access::try_from(mode)?;
852        let lookup_flags = LookupFlags::from_bits(flags, AT_SYMLINK_NOFOLLOW | AT_EACCESS)?;
853        let name = lookup_at(current_task, dir_fd, user_path, lookup_flags)?;
854        name.check_access(current_task, AccessCheck::for_access(mode))
855    };
856    // Unless `AT_ACCESS` is set, perform lookup & access-checking using real UID & GID.
857    if flags & AT_EACCESS == 0 {
858        let mut temporary_creds = Credentials::clone(&current_task.current_creds());
859        temporary_creds.fsuid = temporary_creds.uid;
860        temporary_creds.fsgid = temporary_creds.gid;
861
862        // access() for root users should use permitted capabilities instead of effective capabilities.
863        // access() for non-root users should use an empty set of capabilities.
864        if temporary_creds.uid == 0 {
865            temporary_creds.cap_effective = temporary_creds.cap_permitted;
866        } else {
867            temporary_creds.cap_effective = Capabilities::empty();
868        }
869
870        current_task.override_creds(temporary_creds.into(), access_check)
871    } else {
872        access_check()
873    }
874}
875
876pub fn sys_getdents64(
877    current_task: &CurrentTask,
878    fd: FdNumber,
879    user_buffer: UserAddress,
880    user_capacity: usize,
881) -> Result<usize, Errno> {
882    let file = current_task.files().get(fd)?;
883    let mut offset = file.offset.copy();
884    let mut sink = DirentSink64::new(current_task, &mut *offset, user_buffer, user_capacity);
885    let result = file.readdir(current_task, &mut sink);
886    let ret = sink.map_result_with_actual(result);
887    offset.update();
888    ret
889}
890
891pub fn sys_chroot(current_task: &CurrentTask, user_path: UserCString) -> Result<(), Errno> {
892    let name = lookup_at(current_task, FdNumber::AT_FDCWD, user_path, LookupFlags::directory())?;
893    current_task.fs().chroot(current_task, name)?;
894    Ok(())
895}
896
897pub fn sys_chdir(current_task: &CurrentTask, user_path: UserCString) -> Result<(), Errno> {
898    let name = lookup_at(current_task, FdNumber::AT_FDCWD, user_path, LookupFlags::directory())?;
899    current_task.fs().chdir(current_task, name)
900}
901
902pub fn sys_fchdir(current_task: &CurrentTask, fd: FdNumber) -> Result<(), Errno> {
903    // O_PATH allowed for:
904    //
905    //   fchdir(2), if the file descriptor refers to a directory
906    //   (since Linux 3.5).
907    //
908    // See https://man7.org/linux/man-pages/man2/open.2.html
909    let file = current_task.files().get_allowing_opath(fd)?;
910    if !file.name.entry.node.is_dir() {
911        return error!(ENOTDIR);
912    }
913    current_task.fs().chdir(current_task, file.name.to_passive())
914}
915
916pub fn sys_fstat(
917    current_task: &CurrentTask,
918    fd: FdNumber,
919    buffer: UserRef<uapi::stat>,
920) -> Result<(), Errno> {
921    // O_PATH allowed for:
922    //
923    //   fstat(2) (since Linux 3.6).
924    //
925    // See https://man7.org/linux/man-pages/man2/open.2.html
926    let file = current_task.files().get_allowing_opath(fd)?;
927    let result = file.node().stat(current_task)?;
928    current_task.write_object(buffer, &result)?;
929    Ok(())
930}
931
932type StatPtr = MultiArchUserRef<uapi::stat, uapi::arch32::stat64>;
933
934// TODO(https://fxbug.dev/485370648) remove when unnecessary
935fn get_fake_ion_stat() -> uapi::stat {
936    uapi::stat {
937        st_mode: uapi::S_IFCHR | 0o666,
938        st_rdev: DeviceId::new(10, 59).bits(),
939        st_nlink: 1,
940        st_blksize: 4096,
941        ..Default::default()
942    }
943}
944
945// TODO(https://fxbug.dev/485370648) remove when unnecessary
946fn get_fake_ion_statx() -> statx {
947    statx {
948        stx_mask: uapi::STATX_BASIC_STATS,
949        stx_mode: (uapi::S_IFCHR | 0o666) as u16,
950        stx_rdev_major: 10,
951        stx_rdev_minor: 59,
952        stx_nlink: 1,
953        stx_blksize: 4096,
954        ..Default::default()
955    }
956}
957
958pub fn sys_fstatat64(
959    current_task: &CurrentTask,
960    dir_fd: FdNumber,
961    user_path: UserCString,
962    buffer: StatPtr,
963    flags: u32,
964) -> Result<(), Errno> {
965    let lookup_flags =
966        LookupFlags::from_bits(flags, AT_EMPTY_PATH | AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT)?;
967    let result = match lookup_at(current_task, dir_fd, user_path, lookup_flags) {
968        Ok(name) => name.entry.node.stat(current_task)?,
969        // TODO(https://fxbug.dev/485370648) remove when unnecessary
970        Err(e) if e == errno!(ENOENT) && current_task.kernel().features.fake_ion => {
971            let path = current_task.read_path(user_path)?;
972            if path == b"/dev/ion" {
973                get_fake_ion_stat()
974            } else {
975                return Err(e);
976            }
977        }
978        Err(e) => return Err(e),
979    };
980    current_task.write_multi_arch_object(buffer, result)?;
981    Ok(())
982}
983
984pub use sys_fstatat64 as sys_newfstatat;
985
986pub fn sys_statx(
987    current_task: &CurrentTask,
988    dir_fd: FdNumber,
989    user_path: UserCString,
990    flags: u32,
991    mask: u32,
992    statxbuf: UserRef<statx>,
993) -> Result<(), Errno> {
994    let statx_flags = StatxFlags::from_bits(flags).ok_or_else(|| errno!(EINVAL))?;
995    if statx_flags & (StatxFlags::AT_STATX_FORCE_SYNC | StatxFlags::AT_STATX_DONT_SYNC)
996        == (StatxFlags::AT_STATX_FORCE_SYNC | StatxFlags::AT_STATX_DONT_SYNC)
997    {
998        return error!(EINVAL);
999    }
1000
1001    let result = match lookup_at(current_task, dir_fd, user_path, LookupFlags::from(statx_flags)) {
1002        Ok(name) => name.entry.node.statx(current_task, statx_flags, mask)?,
1003        // TODO(https://fxbug.dev/485370648) remove when unnecessary
1004        Err(e) if e == errno!(ENOENT) && current_task.kernel().features.fake_ion => {
1005            let path = current_task.read_path(user_path)?;
1006            if path == b"/dev/ion" {
1007                get_fake_ion_statx()
1008            } else {
1009                return Err(e);
1010            }
1011        }
1012        Err(e) => return Err(e),
1013    };
1014    current_task.write_object(statxbuf, &result)?;
1015    Ok(())
1016}
1017
1018pub fn sys_readlinkat(
1019    current_task: &CurrentTask,
1020    dir_fd: FdNumber,
1021    user_path: UserCString,
1022    buffer: UserAddress,
1023    buffer_size: usize,
1024) -> Result<usize, Errno> {
1025    let path = current_task.read_path(user_path)?;
1026    let lookup_flags = if path.is_empty() {
1027        if dir_fd == FdNumber::AT_FDCWD {
1028            return error!(ENOENT);
1029        }
1030        LookupFlags {
1031            allow_empty_path: true,
1032            symlink_mode: SymlinkMode::NoFollow,
1033            ..Default::default()
1034        }
1035    } else {
1036        LookupFlags::no_follow()
1037    };
1038    let name = lookup_at(current_task, dir_fd, user_path, lookup_flags)?;
1039
1040    let target = match name.readlink(current_task)? {
1041        SymlinkTarget::Path(path) => path,
1042        SymlinkTarget::Node(node) => node.path(&current_task.fs()),
1043    };
1044
1045    if buffer_size == 0 {
1046        return error!(EINVAL);
1047    }
1048    // Cap the returned length at buffer_size.
1049    let length = std::cmp::min(buffer_size, target.len());
1050    current_task.write_memory(buffer, &target[..length])?;
1051    Ok(length)
1052}
1053
1054pub fn sys_truncate(
1055    current_task: &CurrentTask,
1056    user_path: UserCString,
1057    length: off_t,
1058) -> Result<(), Errno> {
1059    let length = length.try_into().map_err(|_| errno!(EINVAL))?;
1060    let name = lookup_at(current_task, FdNumber::AT_FDCWD, user_path, LookupFlags::default())?;
1061    name.truncate(current_task, length)?;
1062    Ok(())
1063}
1064
1065pub fn sys_ftruncate(current_task: &CurrentTask, fd: FdNumber, length: off_t) -> Result<(), Errno> {
1066    let length = length.try_into().map_err(|_| errno!(EINVAL))?;
1067    let file = current_task.files().get(fd)?;
1068    file.ftruncate(current_task, length)?;
1069    Ok(())
1070}
1071
1072pub fn sys_mkdirat(
1073    current_task: &CurrentTask,
1074    dir_fd: FdNumber,
1075    user_path: UserCString,
1076    mode: FileMode,
1077) -> Result<(), Errno> {
1078    let path = current_task.read_path(user_path)?;
1079
1080    if path.is_empty() {
1081        return error!(ENOENT);
1082    }
1083    let (parent, basename) =
1084        current_task.lookup_parent_at(&mut LookupContext::default(), dir_fd, path.as_ref())?;
1085    parent.create_node(current_task, basename, mode.with_type(FileMode::IFDIR), DeviceId::NONE)?;
1086    Ok(())
1087}
1088
1089pub fn sys_mknodat(
1090    current_task: &CurrentTask,
1091    dir_fd: FdNumber,
1092    user_path: UserCString,
1093    mode: FileMode,
1094    dev: DeviceId,
1095) -> Result<(), Errno> {
1096    let file_type = match mode.fmt() {
1097        FileMode::IFREG
1098        | FileMode::IFCHR
1099        | FileMode::IFBLK
1100        | FileMode::IFIFO
1101        | FileMode::IFSOCK => mode.fmt(),
1102        FileMode::EMPTY => FileMode::IFREG,
1103        _ => return error!(EINVAL),
1104    };
1105    lookup_parent_at(current_task, dir_fd, user_path, |_, parent, basename| {
1106        parent.create_node(current_task, basename, mode.with_type(file_type), dev)
1107    })?;
1108    Ok(())
1109}
1110
1111pub fn sys_linkat(
1112    current_task: &CurrentTask,
1113    old_dir_fd: FdNumber,
1114    old_user_path: UserCString,
1115    new_dir_fd: FdNumber,
1116    new_user_path: UserCString,
1117    flags: u32,
1118) -> Result<(), Errno> {
1119    if flags & !(AT_SYMLINK_FOLLOW | AT_EMPTY_PATH) != 0 {
1120        track_stub!(TODO("https://fxbug.dev/322875706"), "linkat unknown flags", flags);
1121        return error!(EINVAL);
1122    }
1123
1124    if flags & AT_EMPTY_PATH != 0 {
1125        security::check_task_capable(current_task, CAP_DAC_READ_SEARCH)
1126            .map_err(|_| errno!(ENOENT))?;
1127    }
1128
1129    let flags = LookupFlags::from_bits(flags, AT_EMPTY_PATH | AT_SYMLINK_FOLLOW)?;
1130    let target = lookup_at(current_task, old_dir_fd, old_user_path, flags)?;
1131    lookup_parent_at(current_task, new_dir_fd, new_user_path, |context, parent, basename| {
1132        // The path to a new link cannot end in `/`. That would imply that we are dereferencing
1133        // the link to a directory.
1134        if context.directory_mode == DirectoryMode::MustBeDirectory {
1135            return error!(ENOENT);
1136        }
1137        if target.mount != parent.mount {
1138            return error!(EXDEV);
1139        }
1140        parent.link(current_task, basename, &target.entry.node)
1141    })?;
1142
1143    Ok(())
1144}
1145
1146pub fn sys_unlinkat(
1147    current_task: &CurrentTask,
1148    dir_fd: FdNumber,
1149    user_path: UserCString,
1150    flags: u32,
1151) -> Result<(), Errno> {
1152    if flags & !AT_REMOVEDIR != 0 {
1153        return error!(EINVAL);
1154    }
1155    let kind =
1156        if flags & AT_REMOVEDIR != 0 { UnlinkKind::Directory } else { UnlinkKind::NonDirectory };
1157    lookup_parent_at(current_task, dir_fd, user_path, |context, parent, basename| {
1158        parent.unlink(current_task, basename, kind, context.directory_mode)
1159    })?;
1160    Ok(())
1161}
1162
1163pub fn sys_renameat2(
1164    current_task: &CurrentTask,
1165    old_dir_fd: FdNumber,
1166    old_user_path: UserCString,
1167    new_dir_fd: FdNumber,
1168    new_user_path: UserCString,
1169    flags: u32,
1170) -> Result<(), Errno> {
1171    let flags = RenameFlags::from_bits(flags).ok_or_else(|| errno!(EINVAL))?;
1172    if flags.intersects(RenameFlags::INTERNAL) {
1173        return error!(EINVAL);
1174    };
1175
1176    // RENAME_EXCHANGE cannot be combined with the other flags.
1177    if flags.contains(RenameFlags::EXCHANGE)
1178        && flags.intersects(RenameFlags::NOREPLACE | RenameFlags::WHITEOUT)
1179    {
1180        return error!(EINVAL);
1181    }
1182
1183    // RENAME_WHITEOUT is not supported.
1184    if flags.contains(RenameFlags::WHITEOUT) {
1185        track_stub!(TODO("https://fxbug.dev/322875416"), "RENAME_WHITEOUT");
1186        return error!(ENOSYS);
1187    };
1188
1189    let lookup = |dir_fd, user_path| {
1190        lookup_parent_at(current_task, dir_fd, user_path, |_, parent, basename| {
1191            Ok((parent, basename.to_owned()))
1192        })
1193    };
1194
1195    let (old_parent, old_basename) = lookup(old_dir_fd, old_user_path)?;
1196    let (new_parent, new_basename) = lookup(new_dir_fd, new_user_path)?;
1197
1198    if new_basename.len() > NAME_MAX as usize {
1199        return error!(ENAMETOOLONG);
1200    }
1201
1202    NamespaceNode::rename(
1203        current_task,
1204        &old_parent,
1205        old_basename.as_ref(),
1206        &new_parent,
1207        new_basename.as_ref(),
1208        flags,
1209    )
1210}
1211
1212pub fn sys_fchmod(current_task: &CurrentTask, fd: FdNumber, mode: FileMode) -> Result<(), Errno> {
1213    // Remove the filetype from the mode.
1214    let mode = mode & FileMode::PERMISSIONS;
1215    let file = current_task.files().get(fd)?;
1216    file.name.entry.node.chmod(current_task, &file.name.mount, mode)?;
1217    file.name.entry.notify_ignoring_excl_unlink(InotifyMask::ATTRIB);
1218    Ok(())
1219}
1220
1221pub fn sys_fchmodat(
1222    current_task: &CurrentTask,
1223    dir_fd: FdNumber,
1224    user_path: UserCString,
1225    mode: FileMode,
1226) -> Result<(), Errno> {
1227    // Remove the filetype from the mode.
1228    let mode = mode & FileMode::PERMISSIONS;
1229    let name = lookup_at(current_task, dir_fd, user_path, LookupFlags::default())?;
1230    name.entry.node.chmod(current_task, &name.mount, mode)?;
1231    name.entry.notify_ignoring_excl_unlink(InotifyMask::ATTRIB);
1232    Ok(())
1233}
1234
1235fn maybe_uid(id: u32) -> Option<uid_t> {
1236    if id == u32::MAX { None } else { Some(id) }
1237}
1238
1239pub fn sys_fchown(
1240    current_task: &CurrentTask,
1241    fd: FdNumber,
1242    owner: u32,
1243    group: u32,
1244) -> Result<(), Errno> {
1245    let file = current_task.files().get(fd)?;
1246    file.name.entry.node.chown(
1247        current_task,
1248        &file.name.mount,
1249        maybe_uid(owner),
1250        maybe_uid(group),
1251    )?;
1252    file.name.entry.notify_ignoring_excl_unlink(InotifyMask::ATTRIB);
1253    Ok(())
1254}
1255
1256pub fn sys_fchownat(
1257    current_task: &CurrentTask,
1258    dir_fd: FdNumber,
1259    user_path: UserCString,
1260    owner: u32,
1261    group: u32,
1262    flags: u32,
1263) -> Result<(), Errno> {
1264    let flags = LookupFlags::from_bits(flags, AT_EMPTY_PATH | AT_SYMLINK_NOFOLLOW)?;
1265    let name = lookup_at(current_task, dir_fd, user_path, flags)?;
1266    name.entry.node.chown(current_task, &name.mount, maybe_uid(owner), maybe_uid(group))?;
1267    name.entry.notify_ignoring_excl_unlink(InotifyMask::ATTRIB);
1268    Ok(())
1269}
1270
1271fn read_xattr_name(current_task: &CurrentTask, name_addr: UserCString) -> Result<FsString, Errno> {
1272    let name = current_task
1273        .read_c_string_to_vec(name_addr, XATTR_NAME_MAX as usize + 1)
1274        .map_err(|e| if e == ENAMETOOLONG { errno!(ERANGE) } else { e })?;
1275    if name.is_empty() {
1276        return error!(ERANGE);
1277    }
1278    let dot_index = memchr::memchr(b'.', &name).ok_or_else(|| errno!(ENOTSUP))?;
1279    if name[dot_index + 1..].is_empty() {
1280        return error!(EINVAL);
1281    }
1282    match &name[..dot_index] {
1283        b"user" | b"security" | b"trusted" | b"system" => {}
1284        _ => return error!(ENOTSUP),
1285    }
1286    Ok(name)
1287}
1288
1289fn do_getxattr(
1290    current_task: &CurrentTask,
1291    node: &NamespaceNode,
1292    name_addr: UserCString,
1293    value_addr: UserAddress,
1294    size: usize,
1295) -> Result<usize, Errno> {
1296    let name = read_xattr_name(current_task, name_addr)?;
1297    let value = match node.entry.node.get_xattr(current_task, &node.mount, name.as_ref(), size)? {
1298        ValueOrSize::Size(s) => return Ok(s),
1299        ValueOrSize::Value(v) => v,
1300    };
1301    if size == 0 {
1302        return Ok(value.len());
1303    }
1304    if size < value.len() {
1305        return error!(ERANGE);
1306    }
1307    current_task.write_memory(value_addr, &value)
1308}
1309
1310pub fn sys_getxattr(
1311    current_task: &CurrentTask,
1312    path_addr: UserCString,
1313    name_addr: UserCString,
1314    value_addr: UserAddress,
1315    size: usize,
1316) -> Result<usize, Errno> {
1317    let node = lookup_at(current_task, FdNumber::AT_FDCWD, path_addr, LookupFlags::default())?;
1318    do_getxattr(current_task, &node, name_addr, value_addr, size)
1319}
1320
1321pub fn sys_fgetxattr(
1322    current_task: &CurrentTask,
1323    fd: FdNumber,
1324    name_addr: UserCString,
1325    value_addr: UserAddress,
1326    size: usize,
1327) -> Result<usize, Errno> {
1328    let file = current_task.files().get(fd)?;
1329    do_getxattr(current_task, &file.name, name_addr, value_addr, size)
1330}
1331
1332pub fn sys_lgetxattr(
1333    current_task: &CurrentTask,
1334    path_addr: UserCString,
1335    name_addr: UserCString,
1336    value_addr: UserAddress,
1337    size: usize,
1338) -> Result<usize, Errno> {
1339    let node = lookup_at(current_task, FdNumber::AT_FDCWD, path_addr, LookupFlags::no_follow())?;
1340    do_getxattr(current_task, &node, name_addr, value_addr, size)
1341}
1342
1343fn do_setxattr(
1344    current_task: &CurrentTask,
1345    node: &NamespaceNode,
1346    name_addr: UserCString,
1347    value_addr: UserAddress,
1348    size: usize,
1349    flags: u32,
1350) -> Result<(), Errno> {
1351    if size > XATTR_SIZE_MAX as usize {
1352        return error!(E2BIG);
1353    }
1354
1355    let op = match flags {
1356        0 => XattrOp::Set,
1357        XATTR_CREATE => XattrOp::Create,
1358        XATTR_REPLACE => XattrOp::Replace,
1359        _ => return error!(EINVAL),
1360    };
1361    let name = read_xattr_name(current_task, name_addr)?;
1362    let value = FsString::from(current_task.read_memory_to_vec(value_addr, size)?);
1363    node.entry.node.set_xattr(current_task, &node.mount, name.as_ref(), value.as_ref(), op)
1364}
1365
1366pub fn sys_fsetxattr(
1367    current_task: &CurrentTask,
1368    fd: FdNumber,
1369    name_addr: UserCString,
1370    value_addr: UserAddress,
1371    size: usize,
1372    flags: u32,
1373) -> Result<(), Errno> {
1374    let file = current_task.files().get(fd)?;
1375    do_setxattr(current_task, &file.name, name_addr, value_addr, size, flags)
1376}
1377
1378pub fn sys_lsetxattr(
1379    current_task: &CurrentTask,
1380    path_addr: UserCString,
1381    name_addr: UserCString,
1382    value_addr: UserAddress,
1383    size: usize,
1384    flags: u32,
1385) -> Result<(), Errno> {
1386    let node = lookup_at(current_task, FdNumber::AT_FDCWD, path_addr, LookupFlags::no_follow())?;
1387    do_setxattr(current_task, &node, name_addr, value_addr, size, flags)
1388}
1389
1390pub fn sys_setxattr(
1391    current_task: &CurrentTask,
1392    path_addr: UserCString,
1393    name_addr: UserCString,
1394    value_addr: UserAddress,
1395    size: usize,
1396    flags: u32,
1397) -> Result<(), Errno> {
1398    let node = lookup_at(current_task, FdNumber::AT_FDCWD, path_addr, LookupFlags::default())?;
1399    do_setxattr(current_task, &node, name_addr, value_addr, size, flags)
1400}
1401
1402fn do_removexattr(
1403    current_task: &CurrentTask,
1404    node: &NamespaceNode,
1405    name_addr: UserCString,
1406) -> Result<(), Errno> {
1407    let mode = node.entry.node.info().mode;
1408    if mode.is_chr() || mode.is_fifo() {
1409        return error!(EPERM);
1410    }
1411    let name = read_xattr_name(current_task, name_addr)?;
1412    node.entry.node.remove_xattr(current_task, &node.mount, name.as_ref())
1413}
1414
1415pub fn sys_removexattr(
1416    current_task: &CurrentTask,
1417    path_addr: UserCString,
1418    name_addr: UserCString,
1419) -> Result<(), Errno> {
1420    let node = lookup_at(current_task, FdNumber::AT_FDCWD, path_addr, LookupFlags::default())?;
1421    do_removexattr(current_task, &node, name_addr)
1422}
1423
1424pub fn sys_lremovexattr(
1425    current_task: &CurrentTask,
1426    path_addr: UserCString,
1427    name_addr: UserCString,
1428) -> Result<(), Errno> {
1429    let node = lookup_at(current_task, FdNumber::AT_FDCWD, path_addr, LookupFlags::no_follow())?;
1430    do_removexattr(current_task, &node, name_addr)
1431}
1432
1433pub fn sys_fremovexattr(
1434    current_task: &CurrentTask,
1435    fd: FdNumber,
1436    name_addr: UserCString,
1437) -> Result<(), Errno> {
1438    let file = current_task.files().get(fd)?;
1439    do_removexattr(current_task, &file.name, name_addr)
1440}
1441
1442fn do_listxattr(
1443    current_task: &CurrentTask,
1444    node: &NamespaceNode,
1445    list_addr: UserAddress,
1446    size: usize,
1447) -> Result<usize, Errno> {
1448    let security_xattr = security::fs_node_listsecurity(current_task, &node.entry.node);
1449    let xattrs = match node.entry.node.list_xattrs(current_task, size) {
1450        Ok(ValueOrSize::Size(s)) => return Ok(s + security_xattr.map_or(0, |s| s.len() + 1)),
1451        Ok(ValueOrSize::Value(mut v)) => {
1452            if let Some(security_value) = security_xattr {
1453                if !v.contains(&security_value) {
1454                    v.push(security_value);
1455                }
1456            }
1457            v
1458        }
1459        Err(e) => {
1460            if e.code != ENOTSUP || security_xattr.is_none() {
1461                return Err(e);
1462            }
1463            vec![security_xattr.unwrap()]
1464        }
1465    };
1466
1467    let mut list = vec![];
1468    for name in xattrs.iter() {
1469        list.extend_from_slice(name);
1470        list.push(b'\0');
1471    }
1472    if size == 0 {
1473        return Ok(list.len());
1474    }
1475    if size < list.len() {
1476        return error!(ERANGE);
1477    }
1478    current_task.write_memory(list_addr, &list)
1479}
1480
1481pub fn sys_listxattr(
1482    current_task: &CurrentTask,
1483    path_addr: UserCString,
1484    list_addr: UserAddress,
1485    size: usize,
1486) -> Result<usize, Errno> {
1487    let node = lookup_at(current_task, FdNumber::AT_FDCWD, path_addr, LookupFlags::default())?;
1488    do_listxattr(current_task, &node, list_addr, size)
1489}
1490
1491pub fn sys_llistxattr(
1492    current_task: &CurrentTask,
1493    path_addr: UserCString,
1494    list_addr: UserAddress,
1495    size: usize,
1496) -> Result<usize, Errno> {
1497    let node = lookup_at(current_task, FdNumber::AT_FDCWD, path_addr, LookupFlags::no_follow())?;
1498    do_listxattr(current_task, &node, list_addr, size)
1499}
1500
1501pub fn sys_flistxattr(
1502    current_task: &CurrentTask,
1503    fd: FdNumber,
1504    list_addr: UserAddress,
1505    size: usize,
1506) -> Result<usize, Errno> {
1507    let file = current_task.files().get(fd)?;
1508    do_listxattr(current_task, &file.name, list_addr, size)
1509}
1510
1511pub fn sys_getcwd(
1512    current_task: &CurrentTask,
1513    buf: UserAddress,
1514    size: usize,
1515) -> Result<usize, Errno> {
1516    let root = current_task.fs().root();
1517    let cwd = current_task.fs().cwd();
1518    let mut user_cwd = match cwd.path_from_root(Some(&root)) {
1519        PathWithReachability::Reachable(path) => path,
1520        PathWithReachability::Unreachable(mut path) => {
1521            let mut combined = vec![];
1522            combined.extend_from_slice(b"(unreachable)");
1523            combined.append(&mut path);
1524            combined.into()
1525        }
1526    };
1527    user_cwd.push(b'\0');
1528    if user_cwd.len() > size {
1529        return error!(ERANGE);
1530    }
1531    current_task.write_memory(buf, &user_cwd)?;
1532    Ok(user_cwd.len())
1533}
1534
1535pub fn sys_umask(current_task: &CurrentTask, umask: FileMode) -> Result<FileMode, Errno> {
1536    Ok(current_task.fs().set_umask(umask))
1537}
1538
1539fn get_fd_flags(flags: u32) -> FdFlags {
1540    if flags & O_CLOEXEC != 0 { FdFlags::CLOEXEC } else { FdFlags::empty() }
1541}
1542
1543pub fn sys_pipe2(
1544    current_task: &CurrentTask,
1545    user_pipe: UserRef<FdNumber>,
1546    flags: u32,
1547) -> Result<(), Errno> {
1548    let supported_file_flags = OpenFlags::NONBLOCK | OpenFlags::DIRECT;
1549    // Unknown flags take precedence over `O_NOTIFICATION_PIPE` and fail with EINVAL.
1550    if flags & !(O_CLOEXEC | O_NOTIFICATION_PIPE | supported_file_flags.bits()) != 0 {
1551        return error!(EINVAL);
1552    }
1553    if flags & O_NOTIFICATION_PIPE != 0 {
1554        // Since Starnix doesn't support notifications (CONFIG_WATCH_QUEUE) and
1555        // O_NOTIFICATION_PIPE was passed in flags, return ENOPKG (see pipe(2)).
1556        return error!(ENOPKG);
1557    }
1558    let (read, write) = new_pipe(current_task)?;
1559
1560    let file_flags = OpenFlags::from_bits_truncate(flags & supported_file_flags.bits());
1561    read.update_file_flags(file_flags, supported_file_flags);
1562    write.update_file_flags(file_flags, supported_file_flags);
1563
1564    let fd_flags = get_fd_flags(flags);
1565    let fd_read = current_task.add_file(read, fd_flags)?;
1566    let fd_write = current_task.add_file(write, fd_flags)?;
1567    log_trace!("pipe2 -> [{:#x}, {:#x}]", fd_read.raw(), fd_write.raw());
1568
1569    current_task.write_object(user_pipe, &fd_read)?;
1570    let user_pipe = user_pipe.next()?;
1571    current_task.write_object(user_pipe, &fd_write)?;
1572
1573    Ok(())
1574}
1575
1576pub fn sys_ioctl(
1577    current_task: &CurrentTask,
1578    fd: FdNumber,
1579    request: u32,
1580    arg: SyscallArg,
1581) -> Result<SyscallResult, Errno> {
1582    match request {
1583        FIOCLEX | FIONCLEX => {
1584            current_task.files().ioctl_fd_flags(current_task, fd, request)?;
1585            Ok(SUCCESS)
1586        }
1587        _ => {
1588            let file = current_task.files().get(fd)?;
1589            file.ioctl(current_task, request, arg)
1590        }
1591    }
1592}
1593
1594pub fn sys_symlinkat(
1595    current_task: &CurrentTask,
1596    user_target: UserCString,
1597    new_dir_fd: FdNumber,
1598    user_path: UserCString,
1599) -> Result<(), Errno> {
1600    let target = current_task.read_path(user_target)?;
1601    if target.is_empty() {
1602        return error!(ENOENT);
1603    }
1604
1605    let path = current_task.read_path(user_path)?;
1606    // TODO: This check could probably be moved into parent.symlink(..).
1607    if path.is_empty() {
1608        return error!(ENOENT);
1609    }
1610
1611    let res = lookup_parent_at(current_task, new_dir_fd, user_path, |context, parent, basename| {
1612        // The path to a new symlink cannot end in `/`. That would imply that we are dereferencing
1613        // the symlink to a directory.
1614        //
1615        // See https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xbd_chap03.html#tag_21_03_00_75
1616        if context.directory_mode == DirectoryMode::MustBeDirectory {
1617            return error!(ENOENT);
1618        }
1619        parent.create_symlink(current_task, basename, target.as_ref())
1620    });
1621    res?;
1622    Ok(())
1623}
1624
1625pub fn sys_dup(current_task: &CurrentTask, oldfd: FdNumber) -> Result<FdNumber, Errno> {
1626    current_task.files().duplicate(current_task, oldfd, TargetFdNumber::Default, FdFlags::empty())
1627}
1628
1629pub fn sys_dup3(
1630    current_task: &CurrentTask,
1631    oldfd: FdNumber,
1632    newfd: FdNumber,
1633    flags: u32,
1634) -> Result<FdNumber, Errno> {
1635    if oldfd == newfd {
1636        return error!(EINVAL);
1637    }
1638    if flags & !O_CLOEXEC != 0 {
1639        return error!(EINVAL);
1640    }
1641    let fd_flags = get_fd_flags(flags);
1642    current_task.files().duplicate(
1643        current_task,
1644        oldfd,
1645        TargetFdNumber::Specific(newfd),
1646        fd_flags,
1647    )?;
1648    Ok(newfd)
1649}
1650
1651/// A memfd file descriptor cannot have a name longer than 250 bytes, including
1652/// the null terminator.
1653///
1654/// See Errors section of https://man7.org/linux/man-pages/man2/memfd_create.2.html
1655const MEMFD_NAME_MAX_LEN: usize = 250;
1656
1657pub fn sys_memfd_create(
1658    current_task: &CurrentTask,
1659    user_name: UserCString,
1660    flags: u32,
1661) -> Result<FdNumber, Errno> {
1662    const HUGE_SHIFTED_MASK: u32 = MFD_HUGE_MASK << MFD_HUGE_SHIFT;
1663
1664    if flags
1665        & !(MFD_CLOEXEC
1666            | MFD_ALLOW_SEALING
1667            | MFD_HUGETLB
1668            | HUGE_SHIFTED_MASK
1669            | MFD_NOEXEC_SEAL
1670            | MFD_EXEC)
1671        != 0
1672    {
1673        track_stub!(TODO("https://fxbug.dev/322875665"), "memfd_create unknown flags", flags);
1674        return error!(EINVAL);
1675    }
1676
1677    let _huge_page_size = if flags & MFD_HUGETLB != 0 {
1678        Some(flags & HUGE_SHIFTED_MASK)
1679    } else {
1680        if flags & HUGE_SHIFTED_MASK != 0 {
1681            return error!(EINVAL);
1682        }
1683        None
1684    };
1685
1686    let name = current_task
1687        .read_c_string_to_vec(user_name, MEMFD_NAME_MAX_LEN)
1688        .map_err(|e| if e == ENAMETOOLONG { errno!(EINVAL) } else { e })?;
1689
1690    // This behavior matches MEMFD_NOEXEC_SCOPE_EXEC, which states:
1691    //   > memfd_create() without MFD_EXEC nor MFD_NOEXEC_SEAL acts like MFD_EXEC was set.
1692    //
1693    // This behavior can be changed on Linux via sysctl vm.memfd_noexec, which is pid namespaced.
1694    // We do not currently support changing this behavior.
1695    let seals = if flags & MFD_NOEXEC_SEAL != 0 {
1696        SealFlags::NO_EXEC
1697    } else if flags & MFD_ALLOW_SEALING != 0 {
1698        SealFlags::empty()
1699    } else {
1700        // Forbid sealing, by sealing the seal operation.
1701        SealFlags::SEAL
1702    };
1703
1704    let file = new_memfd(current_task, name, seals, OpenFlags::RDWR)?;
1705
1706    let mut fd_flags = FdFlags::empty();
1707    if flags & MFD_CLOEXEC != 0 {
1708        fd_flags |= FdFlags::CLOEXEC;
1709    }
1710    let fd = current_task.add_file(file, fd_flags)?;
1711    Ok(fd)
1712}
1713
1714pub fn sys_mount(
1715    current_task: &CurrentTask,
1716    source_addr: UserCString,
1717    target_addr: UserCString,
1718    filesystemtype_addr: UserCString,
1719    flags: u32,
1720    data_addr: UserCString,
1721) -> Result<(), Errno> {
1722    security::check_task_capable(current_task, CAP_SYS_ADMIN)?;
1723
1724    let flags = MountFlags::from_bits(flags).ok_or_else(|| {
1725        track_stub!(
1726            TODO("https://fxbug.dev/322875327"),
1727            "mount unknown flags",
1728            flags & !MountFlags::from_bits_truncate(flags).bits()
1729        );
1730        errno!(EINVAL)
1731    })?;
1732
1733    let target = lookup_at(current_task, FdNumber::AT_FDCWD, target_addr, LookupFlags::default())?;
1734
1735    security::sb_mount(current_task, &target, flags)?;
1736
1737    if flags.contains(MountFlags::REMOUNT) {
1738        do_mount_remount(current_task, target, flags, data_addr)
1739    } else if flags.contains(MountFlags::BIND) {
1740        do_mount_bind(current_task, source_addr, target, flags)
1741    } else if flags.intersects(MountFlags::SHARED | MountFlags::PRIVATE | MountFlags::DOWNSTREAM) {
1742        do_mount_change_propagation_type(current_task, target, flags)
1743    } else if flags.contains(MountFlags::MOVE) {
1744        do_mount_move(current_task, source_addr, target)
1745    } else {
1746        do_mount_create(current_task, source_addr, target, filesystemtype_addr, data_addr, flags)
1747    }
1748}
1749
1750fn do_mount_remount(
1751    current_task: &CurrentTask,
1752    target: NamespaceNode,
1753    flags: MountFlags,
1754    data_addr: UserCString,
1755) -> Result<(), Errno> {
1756    let mount = target.mount_if_root()?;
1757    // Prevent a detached mount from being modified via any lingering file descriptors to it.
1758    // Drop `mounts_lock()` immediately so the spinlock is not held across user-memory reads,
1759    // LSM hooks, or filesystem reconfiguration.
1760    if mount.is_detached(&current_task.kernel().mounts_lock()) {
1761        return error!(EINVAL);
1762    }
1763
1764    let data = current_task.read_path_if_non_null(data_addr)?;
1765    let mut mount_params = MountParams::parse(data.as_ref())?;
1766    let mount_options = security::sb_eat_lsm_opts(current_task.kernel(), &mut mount_params)?;
1767
1768    // From <https://man7.org/linux/man-pages/man2/mount.2.html>
1769    //
1770    //   Since Linux 2.6.26, the MS_REMOUNT flag can be used with MS_BIND
1771    //   to modify only the per-mount-point flags.  This is particularly
1772    //   useful for setting or clearing the "read-only" flag on a mount
1773    //   without changing the underlying filesystem.
1774    if !flags.contains(MountFlags::BIND) {
1775        security::sb_remount(current_task, &mount, mount_options)?;
1776        mount.reconfigure_fs(current_task, flags.file_system_flags(), &mount_params)?;
1777    }
1778
1779    let updated_flags = flags & MountFlags::CHANGEABLE_WITH_REMOUNT;
1780    mount.update_flags(updated_flags.mountpoint_flags());
1781
1782    Ok(())
1783}
1784
1785fn do_mount_bind(
1786    current_task: &CurrentTask,
1787    source_addr: UserCString,
1788    target: NamespaceNode,
1789    flags: MountFlags,
1790) -> Result<(), Errno> {
1791    let source = lookup_at(current_task, FdNumber::AT_FDCWD, source_addr, LookupFlags::default())?;
1792    log_trace!(
1793        source:% = source.path(&current_task.fs()),
1794        target:% = target.path(&current_task.fs()),
1795        flags:?;
1796        "do_mount_bind",
1797    );
1798    target.mount(WhatToMount::Bind(source), flags.mountpoint_flags())
1799}
1800
1801fn do_mount_change_propagation_type(
1802    current_task: &CurrentTask,
1803    target: NamespaceNode,
1804    flags: MountFlags,
1805) -> Result<(), Errno> {
1806    log_trace!(
1807        target:% = target.path(&current_task.fs()),
1808        flags:?;
1809        "do_mount_change_propagation_type",
1810    );
1811
1812    // Flag validation. Of the three propagation type flags, exactly one must be passed. The only
1813    // valid flags other than propagation type are MS_SILENT and MS_REC.
1814    //
1815    // Use if statements to find the first propagation type flag, then check for valid flags using
1816    // only the first propagation flag and MS_REC / MS_SILENT as valid flags.
1817    let propagation_flag = if flags.contains(MountFlags::SHARED) {
1818        MountFlags::SHARED
1819    } else if flags.contains(MountFlags::PRIVATE) {
1820        MountFlags::PRIVATE
1821    } else if flags.contains(MountFlags::DOWNSTREAM) {
1822        MountFlags::DOWNSTREAM
1823    } else {
1824        return error!(EINVAL);
1825    };
1826    if flags.intersects(!(propagation_flag | MountFlags::REC | MountFlags::SILENT)) {
1827        return error!(EINVAL);
1828    }
1829
1830    let mount = target.mount_if_root()?;
1831    let mounts_guard = current_task.kernel().mounts_lock();
1832    mount.change_propagation(&mounts_guard, propagation_flag, flags.contains(MountFlags::REC));
1833    Ok(())
1834}
1835
1836fn do_mount_move(
1837    current_task: &CurrentTask,
1838    source_addr: UserCString,
1839    target: NamespaceNode,
1840) -> Result<(), Errno> {
1841    let source = lookup_at(current_task, FdNumber::AT_FDCWD, source_addr, LookupFlags::default())?;
1842    let source_mount = source.mount_if_root()?;
1843    // A target node may not have a mount point if it's an anonymous node. Modern Linux (6.15+)
1844    // returns ENOENT in this case, rather than the more intuitive EINVAL.
1845    let target_mount = target.mount.as_ref().ok_or_else(|| errno!(ENOENT))?;
1846    Mount::move_mount(source_mount, target_mount, &target.entry)
1847}
1848
1849fn do_mount_create(
1850    current_task: &CurrentTask,
1851    source_addr: UserCString,
1852    target: NamespaceNode,
1853    filesystemtype_addr: UserCString,
1854    data_addr: UserCString,
1855    flags: MountFlags,
1856) -> Result<(), Errno> {
1857    let source = current_task.read_path_if_non_null(source_addr)?;
1858    let fs_type = current_task.read_path(filesystemtype_addr)?;
1859    let data = current_task.read_path_if_non_null(data_addr)?;
1860    log_trace!(
1861        source:%,
1862        target:% = target.path(&current_task.fs()),
1863        fs_type:%,
1864        data:%;
1865        "do_mount_create",
1866    );
1867
1868    let options = FileSystemOptions {
1869        source: source.into(),
1870        flags: flags.file_system_flags().into(),
1871        params: MountParams::parse(data.as_ref())?,
1872    };
1873
1874    let fs = current_task.create_filesystem(fs_type.as_ref(), options)?;
1875
1876    security::sb_kern_mount(current_task, &fs)?;
1877    target.mount(WhatToMount::Fs(fs), flags.mountpoint_flags())
1878}
1879
1880pub fn sys_umount2(
1881    current_task: &CurrentTask,
1882    target_addr: UserCString,
1883    flags: u32,
1884) -> Result<(), Errno> {
1885    security::check_task_capable(current_task, CAP_SYS_ADMIN)?;
1886
1887    let unmount_flags = UnmountFlags::from_bits(flags).ok_or_else(|| {
1888        track_stub!(
1889            TODO("https://fxbug.dev/322875327"),
1890            "unmount unknown flags",
1891            flags & !UnmountFlags::from_bits_truncate(flags).bits()
1892        );
1893        errno!(EINVAL)
1894    })?;
1895
1896    if unmount_flags.contains(UnmountFlags::EXPIRE)
1897        && (unmount_flags.contains(UnmountFlags::FORCE)
1898            || unmount_flags.contains(UnmountFlags::DETACH))
1899    {
1900        return error!(EINVAL);
1901    }
1902
1903    let lookup_flags = if unmount_flags.contains(UnmountFlags::NOFOLLOW) {
1904        LookupFlags::no_follow()
1905    } else {
1906        LookupFlags::default()
1907    };
1908    let target = lookup_at(current_task, FdNumber::AT_FDCWD, target_addr, lookup_flags)?;
1909
1910    security::sb_umount(current_task, &target, unmount_flags)?;
1911
1912    target.unmount(unmount_flags)
1913}
1914
1915pub fn sys_pivot_root(
1916    current_task: &CurrentTask,
1917    new_root_addr: UserCString,
1918    put_old_addr: UserCString,
1919) -> Result<(), Errno> {
1920    security::check_task_capable(current_task, CAP_SYS_ADMIN)?;
1921
1922    let new_root =
1923        lookup_at(current_task, FdNumber::AT_FDCWD, new_root_addr, LookupFlags::directory())?;
1924    let put_old =
1925        lookup_at(current_task, FdNumber::AT_FDCWD, put_old_addr, LookupFlags::directory())?;
1926
1927    let old_root = current_task.fs().root();
1928    let namespace = current_task.fs().namespace();
1929
1930    namespace.pivot_root(&old_root, &new_root, &put_old)?;
1931
1932    let mut seen_fs = HashSet::<PtrKey<FsContext>>::new();
1933    let current_fs = current_task.fs();
1934    current_fs.update_root_after_pivot(&old_root, &new_root);
1935    seen_fs.insert(PtrKey::from(&*current_fs));
1936
1937    let mut target_fs = Vec::new();
1938    let scope = RcuReadScope::new();
1939    let thread_groups = current_task.kernel().pids.get_thread_groups(&scope);
1940    // Note: There is a race condition here if another task forks without CLONE_FS
1941    // concurrently with pivot_root. The child's FsContext may be initialized with
1942    // `old_root` before being registered in `pids`, and if this loop does not observe
1943    // the new task, its root will not be updated. Linux has a similar race condition
1944    // when tasks are created concurrently with pivot_root.
1945    for tg in thread_groups {
1946        for task in tg.read().tasks() {
1947            if let Ok(task_fs) = task.fs() {
1948                if Arc::ptr_eq(&task_fs.namespace(), &namespace) {
1949                    if seen_fs.insert(PtrKey::from(&*task_fs)) {
1950                        target_fs.push(task_fs);
1951                    }
1952                }
1953            }
1954        }
1955    }
1956
1957    for fs in target_fs {
1958        fs.update_root_after_pivot(&old_root, &new_root);
1959    }
1960
1961    Ok(())
1962}
1963
1964pub fn sys_eventfd2(current_task: &CurrentTask, value: u32, flags: u32) -> Result<FdNumber, Errno> {
1965    if flags & !(EFD_CLOEXEC | EFD_NONBLOCK | EFD_SEMAPHORE) != 0 {
1966        return error!(EINVAL);
1967    }
1968    let blocking = (flags & EFD_NONBLOCK) == 0;
1969    let eventfd_type =
1970        if (flags & EFD_SEMAPHORE) == 0 { EventFdType::Counter } else { EventFdType::Semaphore };
1971    let file = new_eventfd(current_task, value, eventfd_type, blocking);
1972    let fd_flags = if flags & EFD_CLOEXEC != 0 { FdFlags::CLOEXEC } else { FdFlags::empty() };
1973    let fd = current_task.add_file(file, fd_flags)?;
1974    Ok(fd)
1975}
1976
1977pub fn sys_pidfd_open(
1978    current_task: &CurrentTask,
1979    pid: pid_t,
1980    flags: u32,
1981) -> Result<FdNumber, Errno> {
1982    if flags & !PIDFD_NONBLOCK != 0 {
1983        return error!(EINVAL);
1984    }
1985    if pid <= 0 {
1986        return error!(EINVAL);
1987    }
1988
1989    let blocking = (flags & PIDFD_NONBLOCK) == 0;
1990    let open_flags = if blocking { OpenFlags::empty() } else { OpenFlags::NONBLOCK };
1991
1992    let pid_entry = current_task.kernel().pids.get(pid)?;
1993    let file = new_pidfd(current_task, pid_entry, open_flags)?;
1994    current_task.add_file(file, FdFlags::CLOEXEC)
1995}
1996
1997pub fn sys_pidfd_getfd(
1998    current_task: &CurrentTask,
1999    pidfd: FdNumber,
2000    targetfd: FdNumber,
2001    flags: u32,
2002) -> Result<FdNumber, Errno> {
2003    if flags != 0 {
2004        return error!(EINVAL);
2005    }
2006
2007    let file = current_task.files().get(pidfd)?;
2008    let tg = file.as_pid()?.get_thread_group()?;
2009    let task = tg.read().get_running_task_with_files()?;
2010
2011    current_task.check_ptrace_access_mode(PTRACE_MODE_ATTACH_REALCREDS, &task)?;
2012
2013    let target_file = task.files()?.get(targetfd)?;
2014    security::file_receive(current_task, &target_file)?;
2015    current_task.add_file(target_file, FdFlags::CLOEXEC)
2016}
2017
2018pub fn sys_timerfd_create(
2019    current_task: &CurrentTask,
2020    clock_id: u32,
2021    flags: u32,
2022) -> Result<FdNumber, Errno> {
2023    let timeline = match clock_id {
2024        CLOCK_MONOTONIC => Timeline::Monotonic,
2025        CLOCK_BOOTTIME | CLOCK_BOOTTIME_ALARM => Timeline::BootInstant,
2026        CLOCK_REALTIME | CLOCK_REALTIME_ALARM => Timeline::RealTime,
2027        _ => return error!(EINVAL),
2028    };
2029    let timer_type = match clock_id {
2030        CLOCK_MONOTONIC | CLOCK_BOOTTIME | CLOCK_REALTIME => TimerWakeup::Regular,
2031        CLOCK_BOOTTIME_ALARM | CLOCK_REALTIME_ALARM => {
2032            security::check_task_capable(current_task, CAP_WAKE_ALARM)?;
2033            TimerWakeup::Alarm
2034        }
2035        _ => return error!(EINVAL),
2036    };
2037    if flags & !(TFD_NONBLOCK | TFD_CLOEXEC) != 0 {
2038        track_stub!(TODO("https://fxbug.dev/322875488"), "timerfd_create unknown flags", flags);
2039        return error!(EINVAL);
2040    }
2041    log_trace!("timerfd_create(clock_id={:?}, flags={:#x})", clock_id, flags);
2042
2043    let mut open_flags = OpenFlags::RDWR;
2044    if flags & TFD_NONBLOCK != 0 {
2045        open_flags |= OpenFlags::NONBLOCK;
2046    }
2047
2048    let mut fd_flags = FdFlags::empty();
2049    if flags & TFD_CLOEXEC != 0 {
2050        fd_flags |= FdFlags::CLOEXEC;
2051    };
2052
2053    let timer = TimerFile::new_file(current_task, timer_type, timeline, open_flags)?;
2054    let fd = current_task.add_file(timer, fd_flags)?;
2055    Ok(fd)
2056}
2057
2058pub fn sys_timerfd_gettime(
2059    current_task: &CurrentTask,
2060    fd: FdNumber,
2061    user_current_value: ITimerSpecPtr,
2062) -> Result<(), Errno> {
2063    let file = current_task.files().get(fd)?;
2064    let timer_file = file.downcast_file::<TimerFile>().ok_or_else(|| errno!(EINVAL))?;
2065    let timer_info = timer_file.current_timer_spec();
2066    log_trace!("timerfd_gettime(fd={:?}, current_value={:?})", fd, timer_info);
2067    current_task.write_multi_arch_object(user_current_value, timer_info)?;
2068    Ok(())
2069}
2070
2071pub fn sys_timerfd_settime(
2072    current_task: &CurrentTask,
2073    fd: FdNumber,
2074    flags: u32,
2075    user_new_value: ITimerSpecPtr,
2076    user_old_value: ITimerSpecPtr,
2077) -> Result<(), Errno> {
2078    if flags & !(TFD_TIMER_ABSTIME | TFD_TIMER_CANCEL_ON_SET) != 0 {
2079        track_stub!(TODO("https://fxbug.dev/322874722"), "timerfd_settime unknown flags", flags);
2080        return error!(EINVAL);
2081    }
2082
2083    let file = current_task.files().get(fd)?;
2084    let timer_file = file.downcast_file::<TimerFile>().ok_or_else(|| errno!(EINVAL))?;
2085
2086    if timer_file.wakeup_type() == TimerWakeup::Alarm {
2087        security::check_task_capable(current_task, CAP_WAKE_ALARM)?;
2088    }
2089
2090    let new_timer_spec = current_task.read_multi_arch_object(user_new_value)?;
2091    let old_timer_spec = timer_file.set_timer_spec(current_task, &file, new_timer_spec, flags)?;
2092    log_trace!(
2093        "timerfd_settime(fd={:?}, flags={:#x}, new_value={:?}, current_value={:?})",
2094        fd,
2095        flags,
2096        new_timer_spec,
2097        old_timer_spec
2098    );
2099    if !user_old_value.is_null() {
2100        current_task.write_multi_arch_object(user_old_value, old_timer_spec)?;
2101    }
2102    Ok(())
2103}
2104
2105fn deadline_after_timespec(
2106    current_task: &CurrentTask,
2107    user_timespec: TimeSpecPtr,
2108) -> Result<zx::MonotonicInstant, Errno> {
2109    if user_timespec.is_null() {
2110        Ok(zx::MonotonicInstant::INFINITE)
2111    } else {
2112        let timespec = current_task.read_multi_arch_object(user_timespec)?;
2113        Ok(zx::MonotonicInstant::after(duration_from_timespec(timespec)?))
2114    }
2115}
2116
2117static_assertions::assert_eq_size!(uapi::__kernel_fd_set, uapi::arch32::__kernel_fd_set);
2118
2119fn select(
2120    current_task: &mut CurrentTask,
2121    nfds: u32,
2122    readfds_addr: UserRef<__kernel_fd_set>,
2123    writefds_addr: UserRef<__kernel_fd_set>,
2124    exceptfds_addr: UserRef<__kernel_fd_set>,
2125    deadline: zx::MonotonicInstant,
2126    sigmask_addr: UserRef<pselect6_sigmask>,
2127) -> Result<i32, Errno> {
2128    const BITS_PER_BYTE: usize = 8;
2129
2130    fn sizeof<T>(_: &T) -> usize {
2131        BITS_PER_BYTE * std::mem::size_of::<T>()
2132    }
2133    fn is_fd_set(set: &__kernel_fd_set, fd: usize) -> bool {
2134        let index = fd / sizeof(&set.fds_bits[0]);
2135        let remainder = fd % sizeof(&set.fds_bits[0]);
2136        set.fds_bits[index] & (1 << remainder) > 0
2137    }
2138    fn add_fd_to_set(set: &mut __kernel_fd_set, fd: usize) {
2139        let index = fd / sizeof(&set.fds_bits[0]);
2140        let remainder = fd % sizeof(&set.fds_bits[0]);
2141
2142        set.fds_bits[index] |= 1 << remainder;
2143    }
2144    let read_fd_set = |addr: UserRef<__kernel_fd_set>| {
2145        if addr.is_null() { Ok(Default::default()) } else { current_task.read_object(addr) }
2146    };
2147
2148    if nfds as usize > BITS_PER_BYTE * std::mem::size_of::<__kernel_fd_set>() {
2149        return error!(EINVAL);
2150    }
2151
2152    let read_events =
2153        FdEvents::from_bits_truncate(POLLRDNORM | POLLRDBAND | POLLIN | POLLHUP | POLLERR);
2154    let write_events = FdEvents::from_bits_truncate(POLLWRBAND | POLLWRNORM | POLLOUT | POLLERR);
2155    let except_events = FdEvents::from_bits_truncate(POLLPRI);
2156
2157    let readfds = read_fd_set(readfds_addr)?;
2158    let writefds = read_fd_set(writefds_addr)?;
2159    let exceptfds = read_fd_set(exceptfds_addr)?;
2160
2161    let sets = &[(read_events, &readfds), (write_events, &writefds), (except_events, &exceptfds)];
2162    let waiter = FileWaiter::<FdNumber>::default();
2163
2164    for fd in 0..nfds {
2165        let mut aggregated_events = FdEvents::empty();
2166        for (events, fds) in sets.iter() {
2167            if is_fd_set(fds, fd as usize) {
2168                aggregated_events |= *events;
2169            }
2170        }
2171        if !aggregated_events.is_empty() {
2172            let fd = FdNumber::from_raw(fd as i32);
2173            let file = current_task.files().get(fd)?;
2174            waiter.add(current_task, fd, Some(&file), aggregated_events)?;
2175        }
2176    }
2177
2178    let mask = if !sigmask_addr.is_null() {
2179        let sigmask = current_task.read_object(sigmask_addr)?;
2180        let mask = if sigmask.ss.is_null() {
2181            current_task.read().signal_mask()
2182        } else {
2183            if sigmask.ss_len < std::mem::size_of::<sigset_t>() {
2184                return error!(EINVAL);
2185            }
2186            current_task.read_object(sigmask.ss.into())?
2187        };
2188        Some(mask)
2189    } else {
2190        None
2191    };
2192
2193    waiter.wait(current_task, mask, deadline)?;
2194
2195    let mut num_fds = 0;
2196    let mut readfds_out: __kernel_fd_set = Default::default();
2197    let mut writefds_out: __kernel_fd_set = Default::default();
2198    let mut exceptfds_out: __kernel_fd_set = Default::default();
2199    let mut sets = [
2200        (read_events, &readfds, &mut readfds_out),
2201        (write_events, &writefds, &mut writefds_out),
2202        (except_events, &exceptfds, &mut exceptfds_out),
2203    ];
2204    let mut ready_items = waiter.ready_items.lock();
2205    for ReadyItem { key: ready_key, events: ready_events } in ready_items.drain(..) {
2206        let ready_key = assert_matches::assert_matches!(
2207            ready_key,
2208            ReadyItemKey::FdNumber(v) => v
2209        );
2210
2211        sets.iter_mut().for_each(|(events, fds, fds_out)| {
2212            let fd = ready_key.raw() as usize;
2213            if events.intersects(ready_events) && is_fd_set(fds, fd) {
2214                add_fd_to_set(fds_out, fd);
2215                num_fds += 1;
2216            }
2217        });
2218    }
2219    drop(ready_items);
2220
2221    let write_fd_set =
2222        |addr: UserRef<__kernel_fd_set>, value: __kernel_fd_set| -> Result<(), Errno> {
2223            if !addr.is_null() {
2224                current_task.write_object(addr, &value)?;
2225            }
2226            Ok(())
2227        };
2228    write_fd_set(readfds_addr, readfds_out)?;
2229    write_fd_set(writefds_addr, writefds_out)?;
2230    write_fd_set(exceptfds_addr, exceptfds_out)?;
2231    Ok(num_fds)
2232}
2233
2234pub fn sys_pselect6(
2235    current_task: &mut CurrentTask,
2236    nfds: u32,
2237    readfds_addr: UserRef<__kernel_fd_set>,
2238    writefds_addr: UserRef<__kernel_fd_set>,
2239    exceptfds_addr: UserRef<__kernel_fd_set>,
2240    timeout_addr: TimeSpecPtr,
2241    sigmask_addr: UserRef<pselect6_sigmask>,
2242) -> Result<i32, Errno> {
2243    let deadline = deadline_after_timespec(current_task, timeout_addr)?;
2244
2245    let num_fds = select(
2246        current_task,
2247        nfds,
2248        readfds_addr,
2249        writefds_addr,
2250        exceptfds_addr,
2251        deadline,
2252        sigmask_addr,
2253    )?;
2254
2255    if !timeout_addr.is_null()
2256        && !current_task
2257            .thread_group()
2258            .read()
2259            .personality
2260            .contains(PersonalityFlags::STICKY_TIMEOUTS)
2261    {
2262        let now = zx::MonotonicInstant::get();
2263        let remaining = std::cmp::max(deadline - now, zx::MonotonicDuration::from_seconds(0));
2264        current_task.write_multi_arch_object(timeout_addr, timespec_from_duration(remaining))?;
2265    }
2266
2267    Ok(num_fds)
2268}
2269
2270pub fn sys_select(
2271    current_task: &mut CurrentTask,
2272    nfds: u32,
2273    readfds_addr: UserRef<__kernel_fd_set>,
2274    writefds_addr: UserRef<__kernel_fd_set>,
2275    exceptfds_addr: UserRef<__kernel_fd_set>,
2276    timeout_addr: TimeValPtr,
2277) -> Result<i32, Errno> {
2278    let start_time = zx::MonotonicInstant::get();
2279
2280    let deadline = if timeout_addr.is_null() {
2281        zx::MonotonicInstant::INFINITE
2282    } else {
2283        let timeval = current_task.read_multi_arch_object(timeout_addr)?;
2284        start_time + starnix_types::time::duration_from_timeval(timeval)?
2285    };
2286
2287    let num_fds = select(
2288        current_task,
2289        nfds,
2290        readfds_addr,
2291        writefds_addr,
2292        exceptfds_addr,
2293        deadline,
2294        UserRef::<pselect6_sigmask>::default(),
2295    )?;
2296
2297    if !timeout_addr.is_null()
2298        && !current_task
2299            .thread_group()
2300            .read()
2301            .personality
2302            .contains(PersonalityFlags::STICKY_TIMEOUTS)
2303    {
2304        let now = zx::MonotonicInstant::get();
2305        let remaining = std::cmp::max(deadline - now, zx::MonotonicDuration::from_seconds(0));
2306        current_task.write_multi_arch_object(
2307            timeout_addr,
2308            starnix_types::time::timeval_from_duration(remaining),
2309        )?;
2310    }
2311
2312    Ok(num_fds)
2313}
2314
2315pub fn sys_epoll_create1(current_task: &CurrentTask, flags: u32) -> Result<FdNumber, Errno> {
2316    if flags & !EPOLL_CLOEXEC != 0 {
2317        return error!(EINVAL);
2318    }
2319    let ep_file = EpollFileObject::new_file(current_task);
2320    let fd_flags = if flags & EPOLL_CLOEXEC != 0 { FdFlags::CLOEXEC } else { FdFlags::empty() };
2321    let fd = current_task.add_file(ep_file, fd_flags)?;
2322    Ok(fd)
2323}
2324
2325pub fn sys_epoll_ctl(
2326    current_task: &CurrentTask,
2327    epfd: FdNumber,
2328    op: u32,
2329    fd: FdNumber,
2330    event: UserRef<EpollEvent>,
2331) -> Result<(), Errno> {
2332    let file = current_task.files().get(epfd)?;
2333    let epoll_file = file.downcast_file::<EpollFileObject>().ok_or_else(|| errno!(EINVAL))?;
2334    let operand_file = current_task.files().get(fd)?;
2335
2336    if Arc::ptr_eq(&file, &operand_file) {
2337        return error!(EINVAL);
2338    }
2339
2340    let epoll_event = match current_task.read_object(event) {
2341        Ok(mut epoll_event) => {
2342            // If EPOLLWAKEUP is specified in flags, but the caller does not have the CAP_BLOCK_SUSPEND
2343            // capability, then the EPOLLWAKEUP flag is silently ignored.
2344            // See https://man7.org/linux/man-pages/man2/epoll_ctl.2.html
2345            if epoll_event.events().contains(FdEvents::EPOLLWAKEUP) {
2346                if !security::is_task_capable_noaudit(current_task, CAP_BLOCK_SUSPEND) {
2347                    epoll_event.ignore(FdEvents::EPOLLWAKEUP);
2348                }
2349            }
2350            Ok(epoll_event)
2351        }
2352        result => result,
2353    };
2354
2355    match op {
2356        EPOLL_CTL_ADD => {
2357            epoll_file.add(current_task, &operand_file, &file, epoll_event?)?;
2358            operand_file.register_epfd(&file);
2359        }
2360        EPOLL_CTL_MOD => {
2361            epoll_file.modify(current_task, &operand_file, epoll_event?)?;
2362        }
2363        EPOLL_CTL_DEL => {
2364            epoll_file.delete(current_task, &operand_file)?;
2365            operand_file.unregister_epfd(&file);
2366        }
2367        _ => return error!(EINVAL),
2368    }
2369    Ok(())
2370}
2371
2372// Backend for sys_epoll_pwait and sys_epoll_pwait2 that takes an already-decoded deadline.
2373fn do_epoll_pwait(
2374    current_task: &mut CurrentTask,
2375    epfd: FdNumber,
2376    events: UserRef<EpollEvent>,
2377    unvalidated_max_events: i32,
2378    deadline: zx::MonotonicInstant,
2379    user_sigmask: UserRef<SigSet>,
2380) -> Result<usize, Errno> {
2381    let file = current_task.files().get(epfd)?;
2382    let epoll_file = file.downcast_file::<EpollFileObject>().ok_or_else(|| errno!(EINVAL))?;
2383
2384    // Max_events must be greater than 0.
2385    let max_events: usize = unvalidated_max_events.try_into().map_err(|_| errno!(EINVAL))?;
2386    if max_events == 0 {
2387        return error!(EINVAL);
2388    }
2389
2390    // Return early if the user passes an obviously invalid pointer. This avoids dropping events
2391    // for common pointer errors. When we catch bad pointers after the wait is complete when the
2392    // memory is actually written, the events will be lost. This check is not a guarantee.
2393    current_task
2394        .mm()?
2395        .check_plausible(events.addr(), max_events * std::mem::size_of::<EpollEvent>())?;
2396
2397    let active_events = if !user_sigmask.is_null() {
2398        let signal_mask = current_task.read_object(user_sigmask)?;
2399        current_task.wait_with_temporary_mask(signal_mask, |current_task| {
2400            epoll_file.wait(current_task, max_events, deadline)
2401        })?
2402    } else {
2403        epoll_file.wait(current_task, max_events, deadline)?
2404    };
2405
2406    current_task.write_objects(events, &active_events)?;
2407    Ok(active_events.len())
2408}
2409
2410pub fn sys_epoll_pwait(
2411    current_task: &mut CurrentTask,
2412    epfd: FdNumber,
2413    events: UserRef<EpollEvent>,
2414    max_events: i32,
2415    timeout: i32,
2416    user_sigmask: UserRef<SigSet>,
2417) -> Result<usize, Errno> {
2418    let deadline = zx::MonotonicInstant::after(duration_from_poll_timeout(timeout)?);
2419    do_epoll_pwait(current_task, epfd, events, max_events, deadline, user_sigmask)
2420}
2421
2422pub fn sys_epoll_pwait2(
2423    current_task: &mut CurrentTask,
2424    epfd: FdNumber,
2425    events: UserRef<EpollEvent>,
2426    max_events: i32,
2427    user_timespec: TimeSpecPtr,
2428    user_sigmask: UserRef<SigSet>,
2429) -> Result<usize, Errno> {
2430    let deadline = deadline_after_timespec(current_task, user_timespec)?;
2431    do_epoll_pwait(current_task, epfd, events, max_events, deadline, user_sigmask)
2432}
2433
2434struct FileWaiter<Key: Into<ReadyItemKey>> {
2435    waiter: Waiter,
2436    ready_items: Arc<LockDepMutex<VecDeque<ReadyItem>, EventHandlerReadyQueueLock>>,
2437    _marker: PhantomData<Key>,
2438}
2439
2440impl<Key: Into<ReadyItemKey>> Default for FileWaiter<Key> {
2441    fn default() -> Self {
2442        Self { waiter: Waiter::new(), ready_items: Default::default(), _marker: PhantomData }
2443    }
2444}
2445
2446impl<Key: Into<ReadyItemKey>> FileWaiter<Key> {
2447    fn add(
2448        &self,
2449        current_task: &CurrentTask,
2450        key: Key,
2451        file: Option<&FileHandle>,
2452        requested_events: FdEvents,
2453    ) -> Result<(), Errno> {
2454        let key = key.into();
2455
2456        if let Some(file) = file {
2457            let sought_events = requested_events | FdEvents::POLLERR | FdEvents::POLLHUP;
2458
2459            let handler =
2460                EventHandler::Enqueue { key, queue: self.ready_items.clone(), sought_events };
2461            file.wait_async(current_task, &self.waiter, sought_events, handler);
2462            let current_events = file.query_events(current_task)? & sought_events;
2463            if !current_events.is_empty() {
2464                self.ready_items.lock().push_back(ReadyItem { key, events: current_events });
2465            }
2466        } else {
2467            self.ready_items.lock().push_back(ReadyItem { key, events: FdEvents::POLLNVAL });
2468        }
2469        Ok(())
2470    }
2471
2472    fn wait(
2473        &self,
2474        current_task: &mut CurrentTask,
2475        signal_mask: Option<SigSet>,
2476        deadline: zx::MonotonicInstant,
2477    ) -> Result<(), Errno> {
2478        if self.ready_items.lock().is_empty() {
2479            // When wait_until() returns Ok() it means there was a wake up; however there may not
2480            // be a ready item, for example if waiting on a sync file with multiple sync points.
2481            // Keep waiting until there's at least one ready item.
2482            let signal_mask = signal_mask.unwrap_or_else(|| current_task.read().signal_mask());
2483            let mut result = current_task.wait_with_temporary_mask(signal_mask, |current_task| {
2484                self.waiter.wait_until(current_task, deadline)
2485            });
2486            loop {
2487                match result {
2488                    Err(err) if err == ETIMEDOUT => return Ok(()),
2489                    Ok(()) => {
2490                        if !self.ready_items.lock().is_empty() {
2491                            break;
2492                        }
2493                    }
2494                    result => result?,
2495                };
2496                result = self.waiter.wait_until(current_task, deadline);
2497            }
2498        }
2499        Ok(())
2500    }
2501}
2502
2503pub fn poll(
2504    current_task: &mut CurrentTask,
2505    user_pollfds: UserRef<pollfd>,
2506    num_fds: i32,
2507    mask: Option<SigSet>,
2508    deadline: zx::MonotonicInstant,
2509) -> Result<usize, Errno> {
2510    if num_fds < 0 || num_fds as u64 > current_task.thread_group().get_rlimit(Resource::NOFILE) {
2511        return error!(EINVAL);
2512    }
2513
2514    let mut pollfds = vec![pollfd::default(); num_fds as usize];
2515    let waiter = FileWaiter::<usize>::default();
2516
2517    for (index, poll_descriptor) in pollfds.iter_mut().enumerate() {
2518        *poll_descriptor = current_task.read_object(user_pollfds.at(index)?)?;
2519        poll_descriptor.revents = 0;
2520        if poll_descriptor.fd < 0 {
2521            continue;
2522        }
2523        let file = current_task.files().get(FdNumber::from_raw(poll_descriptor.fd)).ok();
2524        waiter.add(
2525            current_task,
2526            index,
2527            file.as_ref(),
2528            FdEvents::from_bits_truncate(poll_descriptor.events as u32),
2529        )?;
2530    }
2531
2532    waiter.wait(current_task, mask, deadline)?;
2533
2534    let mut ready_items = waiter.ready_items.lock();
2535    let mut unique_ready_items =
2536        bit_vec::BitVec::from_elem(usize::try_from(num_fds).unwrap(), false);
2537    for ReadyItem { key: ready_key, events: ready_events } in ready_items.drain(..) {
2538        let ready_key = assert_matches::assert_matches!(
2539            ready_key,
2540            ReadyItemKey::Usize(v) => v
2541        );
2542        let interested_events = FdEvents::from_bits_truncate(pollfds[ready_key].events as u32)
2543            | FdEvents::POLLERR
2544            | FdEvents::POLLHUP
2545            | FdEvents::POLLNVAL;
2546        let return_events = (interested_events & ready_events).bits();
2547        pollfds[ready_key].revents = return_events as i16;
2548        unique_ready_items.set(ready_key, true);
2549    }
2550    drop(ready_items);
2551
2552    for (index, poll_descriptor) in pollfds.iter().enumerate() {
2553        current_task.write_object(user_pollfds.at(index)?, poll_descriptor)?;
2554    }
2555
2556    Ok(unique_ready_items.into_iter().filter(Clone::clone).count())
2557}
2558
2559/// Calls `poll` and arranges for an interrupted call to be restarted unless a signal handler runs.
2560///
2561/// Reporting EINTR directly would surface interruptions that userspace never asked about, as `poll`
2562/// cannot tell whether the signal that interrupted it was delivered at all.
2563pub fn poll_with_restart(
2564    current_task: &mut CurrentTask,
2565    user_fds: UserRef<pollfd>,
2566    num_fds: i32,
2567    deadline: zx::MonotonicInstant,
2568) -> Result<usize, Errno> {
2569    match poll(current_task, user_fds, num_fds, None, deadline) {
2570        Err(err) if err == EINTR => {
2571            // Restart through `restart_syscall` rather than through the original syscall, so that
2572            // the wait resumes with the absolute deadline instead of restarting its relative
2573            // timeout from scratch.
2574            current_task.set_syscall_restart_func(move |current_task| {
2575                poll_with_restart(current_task, user_fds, num_fds, deadline)
2576            });
2577            error!(ERESTART_RESTARTBLOCK)
2578        }
2579        result => result,
2580    }
2581}
2582
2583pub fn sys_ppoll(
2584    current_task: &mut CurrentTask,
2585    user_fds: UserRef<pollfd>,
2586    num_fds: i32,
2587    user_timespec: TimeSpecPtr,
2588    user_mask: UserRef<SigSet>,
2589    sigset_size: usize,
2590) -> Result<usize, Errno> {
2591    let start_time = zx::MonotonicInstant::get();
2592
2593    let timeout = if user_timespec.is_null() {
2594        // Passing -1 to poll is equivalent to an infinite timeout.
2595        -1
2596    } else {
2597        let ts = current_task.read_multi_arch_object(user_timespec)?;
2598        duration_from_timespec::<zx::MonotonicTimeline>(ts)?.into_millis() as i32
2599    };
2600
2601    let deadline = start_time + duration_from_poll_timeout(timeout)?;
2602
2603    let mask = if !user_mask.is_null() {
2604        if sigset_size != std::mem::size_of::<SigSet>() {
2605            return error!(EINVAL);
2606        }
2607        let mask = current_task.read_object(user_mask)?;
2608        Some(mask)
2609    } else {
2610        None
2611    };
2612
2613    let poll_result = poll(current_task, user_fds, num_fds, mask, deadline);
2614
2615    if !user_timespec.is_null() {
2616        let now = zx::MonotonicInstant::get();
2617        let remaining = std::cmp::max(deadline - now, zx::MonotonicDuration::from_seconds(0));
2618        let remaining_timespec = timespec_from_duration(remaining);
2619
2620        if current_task.write_multi_arch_object(user_timespec, remaining_timespec).is_err() {
2621            // From gVisor: "ppoll is normally restartable if interrupted by something other
2622            // than a signal handled by the application (i.e. returns ERESTARTNOHAND).
2623            // However, if [copy out] failed, then the restarted ppoll would use the wrong
2624            // timeout, so the error should be left as EINTR."
2625
2626            // Here the [copy out] failed, return the poll result unchanged.
2627            return poll_result;
2628        }
2629    }
2630
2631    // Restart ppoll if interrupted.
2632    match poll_result {
2633        Err(e) if e == EINTR => {
2634            error!(ERESTARTNOHAND)
2635        }
2636        poll_result => poll_result,
2637    }
2638}
2639
2640pub fn sys_flock(current_task: &CurrentTask, fd: FdNumber, operation: u32) -> Result<(), Errno> {
2641    let file = current_task.files().get(fd)?;
2642    let operation = FlockOperation::from_flags(operation)?;
2643    file.flock(current_task, operation)
2644}
2645
2646pub fn sys_sync(current_task: &CurrentTask) -> Result<(), Errno> {
2647    current_task.kernel().mounts.sync_all(current_task)
2648}
2649
2650pub fn sys_syncfs(current_task: &CurrentTask, fd: FdNumber) -> Result<(), Errno> {
2651    let file = current_task.files().get(fd)?;
2652    file.fs.sync(current_task)
2653}
2654
2655pub fn sys_fsync(current_task: &CurrentTask, fd: FdNumber) -> Result<(), Errno> {
2656    let file = current_task.files().get(fd)?;
2657    file.sync(current_task)
2658}
2659
2660pub fn sys_fdatasync(current_task: &CurrentTask, fd: FdNumber) -> Result<(), Errno> {
2661    let file = current_task.files().get(fd)?;
2662    file.data_sync(current_task)
2663}
2664
2665pub fn sys_sync_file_range(
2666    current_task: &CurrentTask,
2667    fd: FdNumber,
2668    offset: off_t,
2669    length: off_t,
2670    flags: u32,
2671) -> Result<(), Errno> {
2672    const KNOWN_FLAGS: u32 = uapi::SYNC_FILE_RANGE_WAIT_BEFORE
2673        | uapi::SYNC_FILE_RANGE_WRITE
2674        | uapi::SYNC_FILE_RANGE_WAIT_AFTER;
2675    if flags & !KNOWN_FLAGS != 0 {
2676        return error!(EINVAL);
2677    }
2678
2679    let file = current_task.files().get(fd)?;
2680
2681    if offset < 0 || length < 0 {
2682        return error!(EINVAL);
2683    }
2684
2685    checked_add_offset_and_length(offset as usize, length as usize)?;
2686
2687    // From <https://linux.die.net/man/2/sync_file_range>:
2688    //
2689    //   fd refers to something other than a regular file, a block device, a directory, or a symbolic link.
2690    let mode = file.node().info().mode;
2691    if !mode.is_reg() && !mode.is_blk() && !mode.is_dir() && !mode.is_lnk() {
2692        return error!(ESPIPE);
2693    }
2694
2695    if flags == 0 {
2696        return Ok(());
2697    }
2698
2699    // Syncing the whole file is much more than we need for sync_file_range, which only needs to
2700    // sync the specified data range.
2701    file.data_sync(current_task)
2702}
2703
2704pub fn sys_fadvise64(
2705    current_task: &CurrentTask,
2706    fd: FdNumber,
2707    offset: off_t,
2708    len: off_t,
2709    advice: u32,
2710) -> Result<(), Errno> {
2711    match advice {
2712        POSIX_FADV_NORMAL => track_stub!(TODO("https://fxbug.dev/297434181"), "POSIX_FADV_NORMAL"),
2713        POSIX_FADV_RANDOM => track_stub!(TODO("https://fxbug.dev/297434181"), "POSIX_FADV_RANDOM"),
2714        POSIX_FADV_SEQUENTIAL => {
2715            track_stub!(TODO("https://fxbug.dev/297434181"), "POSIX_FADV_SEQUENTIAL")
2716        }
2717        POSIX_FADV_WILLNEED => {
2718            track_stub!(TODO("https://fxbug.dev/297434181"), "POSIX_FADV_WILLNEED")
2719        }
2720        POSIX_FADV_DONTNEED => {
2721            track_stub!(TODO("https://fxbug.dev/297434181"), "POSIX_FADV_DONTNEED")
2722        }
2723        POSIX_FADV_NOREUSE => {
2724            track_stub!(TODO("https://fxbug.dev/297434181"), "POSIX_FADV_NOREUSE")
2725        }
2726        _ => {
2727            track_stub!(TODO("https://fxbug.dev/322875684"), "fadvise64 unknown advice", advice);
2728            return error!(EINVAL);
2729        }
2730    }
2731
2732    if offset < 0 || len < 0 {
2733        return error!(EINVAL);
2734    }
2735
2736    let file = current_task.files().get(fd)?;
2737    // fadvise does not work on pipes.
2738    if file.downcast_file::<PipeFileObject>().is_some() {
2739        return error!(ESPIPE);
2740    }
2741
2742    // fadvise does not work on paths.
2743    if file.flags().contains(OpenFlags::PATH) {
2744        return error!(EBADF);
2745    }
2746
2747    Ok(())
2748}
2749
2750pub fn sys_fallocate(
2751    current_task: &CurrentTask,
2752    fd: FdNumber,
2753    mode: u32,
2754    offset: off_t,
2755    len: off_t,
2756) -> Result<(), Errno> {
2757    let file = current_task.files().get(fd)?;
2758
2759    // Offset must not be less than 0.
2760    // Length must not be less than or equal to 0.
2761    // See https://man7.org/linux/man-pages/man2/fallocate.2.html#ERRORS
2762    if offset < 0 || len <= 0 {
2763        return error!(EINVAL);
2764    }
2765
2766    let mode = FallocMode::from_bits(mode).ok_or_else(|| errno!(EINVAL))?;
2767    file.fallocate(current_task, mode, offset as u64, len as u64)?;
2768
2769    Ok(())
2770}
2771
2772pub fn sys_utimensat(
2773    current_task: &CurrentTask,
2774    dir_fd: FdNumber,
2775    user_path: UserCString,
2776    user_times: TimeSpecPtr,
2777    flags: u32,
2778) -> Result<(), Errno> {
2779    let (atime, mtime) = if user_times.addr().is_null() {
2780        // If user_times is null, the timestamps are updated to the current time.
2781        (TimeUpdateType::Now, TimeUpdateType::Now)
2782    } else {
2783        let ts = current_task.read_multi_arch_objects_to_vec(user_times, 2)?;
2784        let atime = ts[0];
2785        let mtime = ts[1];
2786        let parse_timespec = |spec: timespec| match spec.tv_nsec {
2787            UTIME_NOW => Ok(TimeUpdateType::Now),
2788            UTIME_OMIT => Ok(TimeUpdateType::Omit),
2789            _ => time_from_timespec(spec).map(TimeUpdateType::Time),
2790        };
2791        (parse_timespec(atime)?, parse_timespec(mtime)?)
2792    };
2793
2794    if let (TimeUpdateType::Omit, TimeUpdateType::Omit) = (atime, mtime) {
2795        return Ok(());
2796    };
2797
2798    // From `utimensat(2)`:
2799    //
2800    //   On Linux, futimens() is a library function implemented on top of
2801    //   the utimensat() system call.  To support this, the Linux
2802    //   utimensat() system call implements a nonstandard feature: if
2803    //   pathname is NULL, then the call modifies the timestamps of the
2804    //   file referred to by the file descriptor dirfd (which may refer to
2805    //   any type of file).
2806    //
2807    //   EFAULT times pointed to an invalid address; or, dirfd was
2808    //          AT_FDCWD, and pathname is NULL or an invalid address.
2809    //
2810    //   EINVAL Invalid value in flags.
2811    //
2812    //   EINVAL pathname is NULL, dirfd is not AT_FDCWD, and flags
2813    //          contains AT_SYMLINK_NOFOLLOW.
2814    //
2815    // From `open(2)` (`O_PATH`):
2816    //
2817    //   The file itself is not opened, and other file operations (e.g.,
2818    //   read(2), write(2), fchmod(2), fchown(2), fgetxattr(2), ioctl(2),
2819    //   mmap(2)) fail with the error EBADF.
2820    //
2821    // Because a `NULL` pathname operates directly on the open file referred to by
2822    // `dir_fd` rather than performing path resolution relative to `dir_fd`,
2823    // look up `dir_fd` via `current_task.files().get` (which rejects `O_PATH` file descriptors
2824    // with `EBADF`) instead of `CurrentTask::resolve_dir_fd` (which calls
2825    // `get_allowing_opath`).
2826    let name = if user_path.addr().is_null() {
2827        if dir_fd == FdNumber::AT_FDCWD {
2828            return error!(EFAULT);
2829        }
2830        if flags != 0 {
2831            return error!(EINVAL);
2832        }
2833        current_task.files().get(dir_fd)?.name.to_passive()
2834    } else {
2835        let lookup_flags = LookupFlags::from_bits(flags, AT_EMPTY_PATH | AT_SYMLINK_NOFOLLOW)?;
2836        lookup_at(current_task, dir_fd, user_path, lookup_flags)?
2837    };
2838    name.entry.node.update_atime_mtime(current_task, &name.mount, atime, mtime)?;
2839    let event_mask = match (atime, mtime) {
2840        (_, TimeUpdateType::Omit) => InotifyMask::ACCESS,
2841        (TimeUpdateType::Omit, _) => InotifyMask::MODIFY,
2842        (_, _) => InotifyMask::ATTRIB,
2843    };
2844    name.entry.notify_ignoring_excl_unlink(event_mask);
2845    Ok(())
2846}
2847
2848pub fn sys_splice(
2849    current_task: &CurrentTask,
2850    fd_in: FdNumber,
2851    off_in: OffsetPtr,
2852    fd_out: FdNumber,
2853    off_out: OffsetPtr,
2854    len: usize,
2855    flags: u32,
2856) -> Result<usize, Errno> {
2857    splice::splice(current_task, fd_in, off_in, fd_out, off_out, len, flags)
2858}
2859
2860pub fn sys_vmsplice(
2861    current_task: &CurrentTask,
2862    fd: FdNumber,
2863    iovec_addr: IOVecPtr,
2864    iovec_count: UserValue<i32>,
2865    flags: u32,
2866) -> Result<usize, Errno> {
2867    splice::vmsplice(current_task, fd, iovec_addr, iovec_count, flags)
2868}
2869
2870pub fn sys_copy_file_range(
2871    current_task: &CurrentTask,
2872    fd_in: FdNumber,
2873    off_in: OffsetPtr,
2874    fd_out: FdNumber,
2875    off_out: OffsetPtr,
2876    len: usize,
2877    flags: u32,
2878) -> Result<usize, Errno> {
2879    splice::copy_file_range(current_task, fd_in, off_in, fd_out, off_out, len, flags)
2880}
2881
2882pub fn sys_tee(
2883    current_task: &CurrentTask,
2884    fd_in: FdNumber,
2885    fd_out: FdNumber,
2886    len: usize,
2887    flags: u32,
2888) -> Result<usize, Errno> {
2889    splice::tee(current_task, fd_in, fd_out, len, flags)
2890}
2891
2892pub fn sys_readahead(
2893    current_task: &CurrentTask,
2894    fd: FdNumber,
2895    offset: off_t,
2896    length: usize,
2897) -> Result<(), Errno> {
2898    let file = current_task.files().get(fd)?;
2899    // Allow only non-negative values of `offset`. Some versions of Linux allow it to be negative,
2900    // but GVisor tests require `readahead()` to fail in this case.
2901    let offset: usize = offset.try_into().map_err(|_| errno!(EINVAL))?;
2902    file.readahead(current_task, offset, length)
2903}
2904
2905pub fn sys_io_setup(
2906    current_task: &CurrentTask,
2907    user_nr_events: UserValue<u32>,
2908    user_ctx_idp: MultiArchUserRef<uapi::aio_context_t, uapi::arch32::aio_context_t>,
2909) -> Result<(), Errno> {
2910    // From https://man7.org/linux/man-pages/man2/io_setup.2.html:
2911    //
2912    //   EINVAL ctx_idp is not initialized, or the specified nr_events
2913    //   exceeds internal limits.  nr_events should be greater than
2914    //   0.
2915    //
2916    // TODO: Determine what "internal limits" means.
2917    let max_operations =
2918        user_nr_events.validate(0..(i32::MAX as u32)).ok_or_else(|| errno!(EINVAL))? as usize;
2919    if current_task.read_multi_arch_object(user_ctx_idp)? != 0 {
2920        return error!(EINVAL);
2921    }
2922    let ctx_id = AioContext::create(current_task, max_operations)?;
2923    current_task.write_multi_arch_object(user_ctx_idp, ctx_id).map_err(|e| {
2924        let _ = current_task
2925            .mm()
2926            .expect("previous sys_io_setup code verified mm exists")
2927            .destroy_aio_context(ctx_id.into());
2928        e
2929    })?;
2930    Ok(())
2931}
2932
2933pub fn sys_io_submit(
2934    current_task: &CurrentTask,
2935    ctx_id: aio_context_t,
2936    user_nr: UserValue<i32>,
2937    mut iocb_addrs: IocbPtrPtr,
2938) -> Result<i32, Errno> {
2939    let nr = user_nr.validate(0..i32::MAX).ok_or_else(|| errno!(EINVAL))?;
2940    if nr == 0 {
2941        return Ok(0);
2942    }
2943    let ctx = current_task.mm()?.get_aio_context(ctx_id.into()).ok_or_else(|| errno!(EINVAL))?;
2944
2945    // `iocbpp` is an array of addresses to iocb's.
2946    let mut num_submitted: i32 = 0;
2947    loop {
2948        let iocb_ref = current_task.read_multi_arch_ptr(iocb_addrs)?;
2949        let control_block = current_task.read_multi_arch_object(iocb_ref)?;
2950
2951        match (num_submitted, ctx.submit(current_task, control_block, iocb_ref)) {
2952            (0, Err(e)) => return Err(e),
2953            (_, Err(_)) => break,
2954            (_, Ok(())) => {
2955                num_submitted += 1;
2956                if num_submitted == nr {
2957                    break;
2958                }
2959            }
2960        };
2961
2962        iocb_addrs = iocb_addrs.next()?;
2963    }
2964
2965    Ok(num_submitted)
2966}
2967
2968pub fn sys_io_getevents(
2969    current_task: &CurrentTask,
2970    ctx_id: aio_context_t,
2971    min_nr: i64,
2972    nr: i64,
2973    events_ref: UserRef<io_event>,
2974    user_timeout: TimeSpecPtr,
2975) -> Result<i32, Errno> {
2976    if min_nr < 0 || min_nr > nr || nr < 0 {
2977        return error!(EINVAL);
2978    }
2979    let min_results = min_nr as usize;
2980    let max_results = nr as usize;
2981    let deadline = deadline_after_timespec(current_task, user_timeout)?;
2982
2983    let ctx = current_task.mm()?.get_aio_context(ctx_id.into()).ok_or_else(|| errno!(EINVAL))?;
2984    let events = ctx.get_events(current_task, min_results, max_results, deadline)?;
2985    current_task.write_objects(events_ref, &events)?;
2986
2987    Ok(events.len() as i32)
2988}
2989
2990pub fn sys_io_cancel(
2991    current_task: &CurrentTask,
2992    ctx_id: aio_context_t,
2993    user_iocb: IocbPtr,
2994    _result: UserRef<io_event>,
2995) -> Result<(), Errno> {
2996    let iocb = current_task.read_multi_arch_object(user_iocb)?;
2997    let ctx = current_task.mm()?.get_aio_context(ctx_id.into()).ok_or_else(|| errno!(EINVAL))?;
2998
2999    ctx.cancel(current_task, iocb, user_iocb)?;
3000    // TODO: Correctly handle return. If the operation is successfully canceled, the event should be copied into the memory pointed to by result without being placed into the completion queue.
3001    track_stub!(TODO("https://fxbug.dev/297433877"), "io_cancel");
3002    Ok(())
3003}
3004
3005pub fn sys_io_destroy(current_task: &CurrentTask, ctx_id: aio_context_t) -> Result<(), Errno> {
3006    let aio_context = current_task.mm()?.destroy_aio_context(ctx_id.into())?;
3007    std::mem::drop(aio_context);
3008    Ok(())
3009}
3010
3011// Syscalls for arch32 usage
3012#[cfg(target_arch = "aarch64")]
3013mod arch32 {
3014    use crate::mm::MemoryAccessorExt;
3015    use crate::task::CurrentTask;
3016    use crate::vfs::syscalls::{
3017        LookupFlags, OpenFlags, lookup_at, sys_dup3, sys_faccessat, sys_fallocate, sys_lseek,
3018        sys_mkdirat, sys_openat, sys_readlinkat, sys_unlinkat,
3019    };
3020    use crate::vfs::{FdNumber, FsNode};
3021    use linux_uapi::off_t;
3022    use starnix_syscalls::SyscallArg;
3023    use starnix_types::time::duration_from_poll_timeout;
3024    use starnix_uapi::errors::Errno;
3025    use starnix_uapi::file_mode::FileMode;
3026    use starnix_uapi::signals::SigSet;
3027    use starnix_uapi::user_address::{MultiArchUserRef, UserAddress, UserCString, UserRef};
3028    use starnix_uapi::vfs::EpollEvent;
3029    use starnix_uapi::{AT_REMOVEDIR, errno, error, uapi};
3030
3031    type StatFs64Ptr = MultiArchUserRef<uapi::statfs, uapi::arch32::statfs64>;
3032
3033    fn merge_low_and_high(low: u32, high: u32) -> off_t {
3034        ((high as off_t) << 32) | (low as off_t)
3035    }
3036
3037    pub fn sys_arch32_open(
3038        current_task: &CurrentTask,
3039        user_path: UserCString,
3040        flags: u32,
3041        mode: FileMode,
3042    ) -> Result<FdNumber, Errno> {
3043        sys_openat(current_task, FdNumber::AT_FDCWD, user_path, flags, mode)
3044    }
3045
3046    pub fn sys_arch32_access(
3047        current_task: &CurrentTask,
3048        user_path: UserCString,
3049        mode: u32,
3050    ) -> Result<(), Errno> {
3051        sys_faccessat(current_task, FdNumber::AT_FDCWD, user_path, mode)
3052    }
3053    pub fn stat64(
3054        current_task: &CurrentTask,
3055        node: &FsNode,
3056        arch32_stat_buf: UserRef<uapi::arch32::stat64>,
3057    ) -> Result<(), Errno> {
3058        let stat_buffer = node.stat(current_task)?;
3059        let result: uapi::arch32::stat64 = stat_buffer.try_into().map_err(|_| errno!(EINVAL))?;
3060        // Now we copy to the arch32 version and write.
3061        current_task.write_object(arch32_stat_buf, &result)?;
3062        Ok(())
3063    }
3064
3065    pub fn sys_arch32_fstat64(
3066        current_task: &CurrentTask,
3067        fd: FdNumber,
3068        arch32_stat_buf: UserRef<uapi::arch32::stat64>,
3069    ) -> Result<(), Errno> {
3070        let file = current_task.files().get_allowing_opath(fd)?;
3071        stat64(current_task, file.node(), arch32_stat_buf)
3072    }
3073
3074    pub fn sys_arch32_fallocate(
3075        current_task: &CurrentTask,
3076        fd: FdNumber,
3077        mode: u32,
3078        offset_low: u32,
3079        offset_high: u32,
3080        len_low: u32,
3081        len_high: u32,
3082    ) -> Result<(), Errno> {
3083        let offset = merge_low_and_high(offset_low, offset_high);
3084        let len = merge_low_and_high(len_low, len_high);
3085        sys_fallocate(current_task, fd, mode, offset, len)
3086    }
3087
3088    pub fn sys_arch32_stat64(
3089        current_task: &CurrentTask,
3090        user_path: UserCString,
3091        arch32_stat_buf: UserRef<uapi::arch32::stat64>,
3092    ) -> Result<(), Errno> {
3093        let name = lookup_at(current_task, FdNumber::AT_FDCWD, user_path, LookupFlags::default())?;
3094        stat64(current_task, &name.entry.node, arch32_stat_buf)
3095    }
3096
3097    pub fn sys_arch32_readlink(
3098        current_task: &CurrentTask,
3099        user_path: UserCString,
3100        buffer: UserAddress,
3101        buffer_size: usize,
3102    ) -> Result<usize, Errno> {
3103        sys_readlinkat(current_task, FdNumber::AT_FDCWD, user_path, buffer, buffer_size)
3104    }
3105
3106    pub fn sys_arch32_mkdir(
3107        current_task: &CurrentTask,
3108        user_path: UserCString,
3109        mode: FileMode,
3110    ) -> Result<(), Errno> {
3111        sys_mkdirat(current_task, FdNumber::AT_FDCWD, user_path, mode)
3112    }
3113
3114    pub fn sys_arch32_rmdir(
3115        current_task: &CurrentTask,
3116        user_path: UserCString,
3117    ) -> Result<(), Errno> {
3118        sys_unlinkat(&current_task, FdNumber::AT_FDCWD, user_path, AT_REMOVEDIR)
3119    }
3120
3121    #[allow(non_snake_case)]
3122    pub fn sys_arch32__llseek(
3123        current_task: &CurrentTask,
3124        fd: FdNumber,
3125        offset_high: u32,
3126        offset_low: u32,
3127        result: UserRef<off_t>,
3128        whence: u32,
3129    ) -> Result<(), Errno> {
3130        let offset = merge_low_and_high(offset_low, offset_high);
3131        let result_value = sys_lseek(current_task, fd, offset, whence)?;
3132        current_task.write_object(result, &result_value).map(|_| ())
3133    }
3134
3135    pub fn sys_arch32_dup2(
3136        current_task: &CurrentTask,
3137        oldfd: FdNumber,
3138        newfd: FdNumber,
3139    ) -> Result<FdNumber, Errno> {
3140        if oldfd == newfd {
3141            // O_PATH allowed for:
3142            //
3143            //  Duplicating the file descriptor (dup(2), fcntl(2)
3144            //  F_DUPFD, etc.).
3145            //
3146            // See https://man7.org/linux/man-pages/man2/open.2.html
3147            current_task.files().get_allowing_opath(oldfd)?;
3148            return Ok(newfd);
3149        }
3150        sys_dup3(current_task, oldfd, newfd, 0)
3151    }
3152
3153    pub fn sys_arch32_unlink(
3154        current_task: &CurrentTask,
3155        user_path: UserCString,
3156    ) -> Result<(), Errno> {
3157        sys_unlinkat(&current_task, FdNumber::AT_FDCWD, user_path, 0)
3158    }
3159
3160    pub fn sys_arch32_pread64(
3161        current_task: &CurrentTask,
3162        fd: FdNumber,
3163        address: UserAddress,
3164        length: usize,
3165        _: SyscallArg,
3166        offset_low: u32,
3167        offset_high: u32,
3168    ) -> Result<usize, Errno> {
3169        super::sys_pread64(
3170            current_task,
3171            fd,
3172            address,
3173            length,
3174            merge_low_and_high(offset_low, offset_high),
3175        )
3176    }
3177
3178    pub fn sys_arch32_pwrite64(
3179        current_task: &CurrentTask,
3180        fd: FdNumber,
3181        address: UserAddress,
3182        length: usize,
3183        _: SyscallArg,
3184        offset_low: u32,
3185        offset_high: u32,
3186    ) -> Result<usize, Errno> {
3187        super::sys_pwrite64(
3188            current_task,
3189            fd,
3190            address,
3191            length,
3192            merge_low_and_high(offset_low, offset_high),
3193        )
3194    }
3195
3196    pub fn sys_arch32_truncate64(
3197        current_task: &CurrentTask,
3198        user_path: UserCString,
3199        _unused: SyscallArg,
3200        length_low: u32,
3201        length_high: u32,
3202    ) -> Result<(), Errno> {
3203        super::sys_truncate(current_task, user_path, merge_low_and_high(length_low, length_high))
3204    }
3205
3206    pub fn sys_arch32_ftruncate64(
3207        current_task: &CurrentTask,
3208        fd: FdNumber,
3209        _: SyscallArg,
3210        length_low: u32,
3211        length_high: u32,
3212    ) -> Result<(), Errno> {
3213        super::sys_ftruncate(current_task, fd, merge_low_and_high(length_low, length_high))
3214    }
3215
3216    pub fn sys_arch32_chmod(
3217        current_task: &CurrentTask,
3218        user_path: UserCString,
3219        mode: FileMode,
3220    ) -> Result<(), Errno> {
3221        super::sys_fchmodat(current_task, FdNumber::AT_FDCWD, user_path, mode)
3222    }
3223
3224    pub fn sys_arch32_chown32(
3225        current_task: &CurrentTask,
3226        user_path: UserCString,
3227        owner: uapi::arch32::__kernel_uid32_t,
3228        group: uapi::arch32::__kernel_uid32_t,
3229    ) -> Result<(), Errno> {
3230        super::sys_fchownat(current_task, FdNumber::AT_FDCWD, user_path, owner, group, 0)
3231    }
3232
3233    pub fn sys_arch32_poll(
3234        current_task: &mut CurrentTask,
3235        user_fds: UserRef<uapi::pollfd>,
3236        num_fds: i32,
3237        timeout: i32,
3238    ) -> Result<usize, Errno> {
3239        let deadline = zx::MonotonicInstant::after(duration_from_poll_timeout(timeout)?);
3240        super::poll_with_restart(current_task, user_fds, num_fds, deadline)
3241    }
3242
3243    pub fn sys_arch32_epoll_create(
3244        current_task: &CurrentTask,
3245        size: i32,
3246    ) -> Result<FdNumber, Errno> {
3247        if size < 1 {
3248            // The man page for epoll_create says the size was used in a previous implementation as
3249            // a hint but no longer does anything. But it's still required to be >= 1 to ensure
3250            // programs are backwards-compatible.
3251            return error!(EINVAL);
3252        }
3253        super::sys_epoll_create1(current_task, 0)
3254    }
3255
3256    pub fn sys_arch32_epoll_wait(
3257        current_task: &mut CurrentTask,
3258        epfd: FdNumber,
3259        events: UserRef<EpollEvent>,
3260        max_events: i32,
3261        timeout: i32,
3262    ) -> Result<usize, Errno> {
3263        super::sys_epoll_pwait(
3264            current_task,
3265            epfd,
3266            events,
3267            max_events,
3268            timeout,
3269            UserRef::<SigSet>::default(),
3270        )
3271    }
3272
3273    pub fn sys_arch32_rename(
3274        current_task: &CurrentTask,
3275        old_user_path: UserCString,
3276        new_user_path: UserCString,
3277    ) -> Result<(), Errno> {
3278        super::sys_renameat2(
3279            current_task,
3280            FdNumber::AT_FDCWD,
3281            old_user_path,
3282            FdNumber::AT_FDCWD,
3283            new_user_path,
3284            0,
3285        )
3286    }
3287
3288    pub fn sys_arch32_creat(
3289        current_task: &CurrentTask,
3290        user_path: UserCString,
3291        mode: FileMode,
3292    ) -> Result<FdNumber, Errno> {
3293        super::sys_openat(
3294            current_task,
3295            FdNumber::AT_FDCWD,
3296            user_path,
3297            (OpenFlags::WRONLY | OpenFlags::CREAT | OpenFlags::TRUNC).bits(),
3298            mode,
3299        )
3300    }
3301
3302    pub fn sys_arch32_symlink(
3303        current_task: &CurrentTask,
3304        user_target: UserCString,
3305        user_path: UserCString,
3306    ) -> Result<(), Errno> {
3307        super::sys_symlinkat(current_task, user_target, FdNumber::AT_FDCWD, user_path)
3308    }
3309
3310    pub fn sys_arch32_eventfd(current_task: &CurrentTask, value: u32) -> Result<FdNumber, Errno> {
3311        super::sys_eventfd2(current_task, value, 0)
3312    }
3313
3314    pub fn sys_arch32_link(
3315        current_task: &CurrentTask,
3316        old_user_path: UserCString,
3317        new_user_path: UserCString,
3318    ) -> Result<(), Errno> {
3319        super::sys_linkat(
3320            current_task,
3321            FdNumber::AT_FDCWD,
3322            old_user_path,
3323            FdNumber::AT_FDCWD,
3324            new_user_path,
3325            0,
3326        )
3327    }
3328
3329    pub fn sys_arch32_fstatfs64(
3330        current_task: &CurrentTask,
3331        fd: FdNumber,
3332        user_buf_len: u32,
3333        user_buf: StatFs64Ptr,
3334    ) -> Result<(), Errno> {
3335        if (user_buf_len as usize) < std::mem::size_of::<uapi::arch32::statfs64>() {
3336            return error!(EINVAL);
3337        }
3338        super::fstatfs(current_task, fd, user_buf)
3339    }
3340
3341    pub fn sys_arch32_statfs64(
3342        current_task: &CurrentTask,
3343        user_path: UserCString,
3344        user_buf_len: u32,
3345        user_buf: StatFs64Ptr,
3346    ) -> Result<(), Errno> {
3347        if (user_buf_len as usize) < std::mem::size_of::<uapi::arch32::statfs64>() {
3348            return error!(EINVAL);
3349        }
3350        super::statfs(current_task, user_path, user_buf)
3351    }
3352
3353    pub fn sys_arch32_arm_fadvise64_64(
3354        current_task: &CurrentTask,
3355        fd: FdNumber,
3356        advice: u32,
3357        offset_low: u32,
3358        offset_high: u32,
3359        len_low: u32,
3360        len_high: u32,
3361    ) -> Result<(), Errno> {
3362        let offset = merge_low_and_high(offset_low, offset_high);
3363        let len = merge_low_and_high(len_low, len_high);
3364        super::sys_fadvise64(current_task, fd, offset, len, advice)
3365    }
3366
3367    pub fn sys_arch32_sendfile64(
3368        current_task: &CurrentTask,
3369        out_fd: FdNumber,
3370        in_fd: FdNumber,
3371        user_offset: UserRef<uapi::off_t>,
3372        count: i32,
3373    ) -> Result<usize, Errno> {
3374        super::sys_sendfile(current_task, out_fd, in_fd, user_offset.into(), count)
3375    }
3376
3377    pub use super::{
3378        sys_chdir as sys_arch32_chdir, sys_chroot as sys_arch32_chroot,
3379        sys_copy_file_range as sys_arch32_copy_file_range, sys_dup3 as sys_arch32_dup3,
3380        sys_epoll_create1 as sys_arch32_epoll_create1, sys_epoll_ctl as sys_arch32_epoll_ctl,
3381        sys_epoll_pwait as sys_arch32_epoll_pwait, sys_epoll_pwait2 as sys_arch32_epoll_pwait2,
3382        sys_eventfd2 as sys_arch32_eventfd2, sys_fchdir as sys_arch32_fchdir,
3383        sys_fchmod as sys_arch32_fchmod, sys_fchmodat as sys_arch32_fchmodat,
3384        sys_fchown as sys_arch32_fchown32, sys_fchown as sys_arch32_fchown,
3385        sys_fchownat as sys_arch32_fchownat, sys_fdatasync as sys_arch32_fdatasync,
3386        sys_flock as sys_arch32_flock, sys_fsetxattr as sys_arch32_fsetxattr,
3387        sys_fstatat64 as sys_arch32_fstatat64, sys_fstatfs as sys_arch32_fstatfs,
3388        sys_fsync as sys_arch32_fsync, sys_ftruncate as sys_arch32_ftruncate,
3389        sys_io_cancel as sys_arch32_io_cancel, sys_io_destroy as sys_arch32_io_destroy,
3390        sys_io_getevents as sys_arch32_io_getevents, sys_io_setup as sys_arch32_io_setup,
3391        sys_io_submit as sys_arch32_io_submit, sys_lgetxattr as sys_arch32_lgetxattr,
3392        sys_linkat as sys_arch32_linkat, sys_listxattr as sys_arch32_listxattr,
3393        sys_llistxattr as sys_arch32_llistxattr, sys_lsetxattr as sys_arch32_lsetxattr,
3394        sys_mkdirat as sys_arch32_mkdirat, sys_mknodat as sys_arch32_mknodat,
3395        sys_pidfd_getfd as sys_arch32_pidfd_getfd, sys_pidfd_open as sys_arch32_pidfd_open,
3396        sys_ppoll as sys_arch32_ppoll, sys_preadv as sys_arch32_preadv,
3397        sys_pselect6 as sys_arch32_pselect6, sys_readv as sys_arch32_readv,
3398        sys_removexattr as sys_arch32_removexattr, sys_renameat2 as sys_arch32_renameat2,
3399        sys_select as sys_arch32__newselect, sys_sendfile as sys_arch32_sendfile,
3400        sys_setxattr as sys_arch32_setxattr, sys_splice as sys_arch32_splice,
3401        sys_statfs as sys_arch32_statfs, sys_statx as sys_arch32_statx,
3402        sys_symlinkat as sys_arch32_symlinkat, sys_sync as sys_arch32_sync,
3403        sys_syncfs as sys_arch32_syncfs, sys_tee as sys_arch32_tee,
3404        sys_timerfd_create as sys_arch32_timerfd_create,
3405        sys_timerfd_gettime as sys_arch32_timerfd_gettime,
3406        sys_timerfd_settime as sys_arch32_timerfd_settime, sys_truncate as sys_arch32_truncate,
3407        sys_umask as sys_arch32_umask, sys_utimensat as sys_arch32_utimensat,
3408        sys_vmsplice as sys_arch32_vmsplice,
3409    };
3410}
3411
3412#[cfg(target_arch = "aarch64")]
3413pub use arch32::*;
3414
3415#[cfg(test)]
3416mod tests {
3417    use super::*;
3418    use crate::task::KernelFeatures;
3419    use crate::testing::*;
3420    use starnix_types::vfs::default_statfs;
3421    use starnix_uapi::{O_RDONLY, SEEK_CUR, SEEK_END, SEEK_SET};
3422    use zerocopy::IntoBytes;
3423
3424    #[::fuchsia::test]
3425    async fn test_sys_lseek() -> Result<(), Errno> {
3426        spawn_kernel_and_run_with_pkgfs(async |current_task| {
3427            let fd = FdNumber::from_raw(10);
3428            let file_handle =
3429                current_task.open_file("data/testfile.txt".into(), OpenFlags::RDONLY)?;
3430            let file_size = file_handle.node().stat(current_task).unwrap().st_size;
3431            current_task.files().insert(current_task, fd, file_handle).unwrap();
3432
3433            assert_eq!(sys_lseek(current_task, fd, 0, SEEK_CUR)?, 0);
3434            assert_eq!(sys_lseek(current_task, fd, 1, SEEK_CUR)?, 1);
3435            assert_eq!(sys_lseek(current_task, fd, 3, SEEK_SET)?, 3);
3436            assert_eq!(sys_lseek(current_task, fd, -3, SEEK_CUR)?, 0);
3437            assert_eq!(sys_lseek(current_task, fd, 0, SEEK_END)?, file_size);
3438            assert_eq!(sys_lseek(current_task, fd, -5, SEEK_SET), error!(EINVAL));
3439
3440            // Make sure that the failed call above did not change the offset.
3441            assert_eq!(sys_lseek(current_task, fd, 0, SEEK_CUR)?, file_size);
3442
3443            // Prepare for an overflow.
3444            assert_eq!(sys_lseek(current_task, fd, 3, SEEK_SET)?, 3);
3445
3446            // Check for overflow.
3447            assert_eq!(sys_lseek(current_task, fd, i64::MAX, SEEK_CUR), error!(EINVAL));
3448
3449            Ok(())
3450        })
3451        .await
3452    }
3453
3454    #[::fuchsia::test]
3455    async fn test_sys_dup() -> Result<(), Errno> {
3456        spawn_kernel_and_run_with_pkgfs(async |current_task| {
3457            let file_handle =
3458                current_task.open_file("data/testfile.txt".into(), OpenFlags::RDONLY)?;
3459            let oldfd = current_task.add_file(file_handle, FdFlags::empty())?;
3460            let newfd = sys_dup(current_task, oldfd)?;
3461
3462            assert_ne!(oldfd, newfd);
3463            let files = current_task.files();
3464            assert!(Arc::ptr_eq(&files.get(oldfd).unwrap(), &files.get(newfd).unwrap()));
3465
3466            assert_eq!(sys_dup(current_task, FdNumber::from_raw(3)), error!(EBADF));
3467
3468            Ok(())
3469        })
3470        .await
3471    }
3472
3473    #[::fuchsia::test]
3474    async fn test_sys_dup3() -> Result<(), Errno> {
3475        spawn_kernel_and_run_with_pkgfs(async |current_task| {
3476            let file_handle =
3477                current_task.open_file("data/testfile.txt".into(), OpenFlags::RDONLY)?;
3478            let oldfd = current_task.add_file(file_handle, FdFlags::empty())?;
3479            let newfd = FdNumber::from_raw(2);
3480            sys_dup3(current_task, oldfd, newfd, O_CLOEXEC)?;
3481
3482            assert_ne!(oldfd, newfd);
3483            let files = current_task.files();
3484            assert!(Arc::ptr_eq(&files.get(oldfd).unwrap(), &files.get(newfd).unwrap()));
3485            assert_eq!(files.get_fd_flags_allowing_opath(oldfd).unwrap(), FdFlags::empty());
3486            assert_eq!(files.get_fd_flags_allowing_opath(newfd).unwrap(), FdFlags::CLOEXEC);
3487
3488            assert_eq!(sys_dup3(current_task, oldfd, oldfd, O_CLOEXEC), error!(EINVAL));
3489
3490            // Pass invalid flags.
3491            let invalid_flags = 1234;
3492            assert_eq!(sys_dup3(current_task, oldfd, newfd, invalid_flags), error!(EINVAL));
3493
3494            // Makes sure that dup closes the old file handle before the fd points
3495            // to the new file handle.
3496            let second_file_handle =
3497                current_task.open_file("data/testfile.txt".into(), OpenFlags::RDONLY)?;
3498            let different_file_fd = current_task.add_file(second_file_handle, FdFlags::empty())?;
3499            assert!(!Arc::ptr_eq(
3500                &files.get(oldfd).unwrap(),
3501                &files.get(different_file_fd).unwrap()
3502            ));
3503            sys_dup3(current_task, oldfd, different_file_fd, O_CLOEXEC)?;
3504            assert!(Arc::ptr_eq(
3505                &files.get(oldfd).unwrap(),
3506                &files.get(different_file_fd).unwrap()
3507            ));
3508
3509            Ok(())
3510        })
3511        .await
3512    }
3513
3514    #[::fuchsia::test]
3515    async fn test_sys_open_cloexec() -> Result<(), Errno> {
3516        spawn_kernel_and_run_with_pkgfs(async |current_task| {
3517            let path_addr = map_memory(&current_task, UserAddress::default(), *PAGE_SIZE);
3518            let path = b"data/testfile.txt\0";
3519            current_task.write_memory(path_addr, path)?;
3520            let fd = sys_openat(
3521                &current_task,
3522                FdNumber::AT_FDCWD,
3523                UserCString::new(current_task, path_addr),
3524                O_RDONLY | O_CLOEXEC,
3525                FileMode::default(),
3526            )?;
3527            assert!(
3528                current_task.files().get_fd_flags_allowing_opath(fd)?.contains(FdFlags::CLOEXEC)
3529            );
3530            Ok(())
3531        })
3532        .await
3533    }
3534
3535    #[::fuchsia::test]
3536    async fn test_sys_epoll() -> Result<(), Errno> {
3537        spawn_kernel_and_run_with_pkgfs(async |current_task| {
3538            let epoll_fd = sys_epoll_create1(current_task, 0).expect("sys_epoll_create1 failed");
3539            sys_close(current_task, epoll_fd).expect("sys_close failed");
3540
3541            Ok(())
3542        })
3543        .await
3544    }
3545
3546    #[::fuchsia::test]
3547    async fn test_fstat_tmp_file() {
3548        spawn_kernel_and_run(async |current_task| {
3549            // Create the file that will be used to stat.
3550            let file_path = "testfile.txt";
3551            let _file_handle = current_task
3552                .open_file_at(
3553                    FdNumber::AT_FDCWD,
3554                    file_path.into(),
3555                    OpenFlags::RDWR | OpenFlags::CREAT,
3556                    FileMode::ALLOW_ALL,
3557                    ResolveFlags::empty(),
3558                )
3559                .unwrap();
3560
3561            // Write the path to user memory.
3562            let path_addr = map_memory(&current_task, UserAddress::default(), *PAGE_SIZE);
3563            current_task
3564                .write_memory(path_addr, file_path.as_bytes())
3565                .expect("failed to clear struct");
3566
3567            let memory_len = (path_addr + file_path.len()).expect("OOB memory allocation!");
3568            let user_stat = UserRef::new(memory_len);
3569            current_task
3570                .write_object(user_stat, &default_statfs(0))
3571                .expect("failed to clear struct");
3572
3573            let user_path = UserCString::new(current_task, path_addr);
3574
3575            assert_eq!(sys_statfs(current_task, user_path, user_stat.into()), Ok(()));
3576
3577            let returned_stat = current_task.read_object(user_stat).expect("failed to read struct");
3578            let expected_stat = starnix_uapi::statfs {
3579                f_blocks: 0x100000000,
3580                f_bavail: 0x100000000,
3581                f_bfree: 0x100000000,
3582                f_flags: starnix_uapi::MS_RELATIME as i64,
3583                ..default_statfs(starnix_uapi::TMPFS_MAGIC)
3584            };
3585            assert!(
3586                returned_stat.as_bytes() == expected_stat.as_bytes(),
3587                "Expected {:?}, got {:?}",
3588                expected_stat,
3589                returned_stat
3590            );
3591        })
3592        .await;
3593    }
3594
3595    #[::fuchsia::test]
3596    async fn test_unlinkat_dir() {
3597        spawn_kernel_and_run(async |current_task| {
3598            // Create the dir that we will attempt to unlink later.
3599            let no_slash_path = b"testdir";
3600            let no_slash_path_addr = map_memory(&current_task, UserAddress::default(), *PAGE_SIZE);
3601            current_task
3602                .write_memory(no_slash_path_addr, no_slash_path)
3603                .expect("failed to write path");
3604            let no_slash_user_path = UserCString::new(current_task, no_slash_path_addr);
3605            sys_mkdirat(
3606                &current_task,
3607                FdNumber::AT_FDCWD,
3608                no_slash_user_path,
3609                FileMode::ALLOW_ALL.with_type(FileMode::IFDIR),
3610            )
3611            .unwrap();
3612
3613            let slash_path = b"testdir/";
3614            let slash_path_addr = map_memory(&current_task, UserAddress::default(), *PAGE_SIZE);
3615            current_task.write_memory(slash_path_addr, slash_path).expect("failed to write path");
3616            let slash_user_path = UserCString::new(current_task, slash_path_addr);
3617
3618            // Try to remove a directory without specifying AT_REMOVEDIR.
3619            // This should fail with EISDIR, irrespective of the terminating slash.
3620            let error =
3621                sys_unlinkat(&current_task, FdNumber::AT_FDCWD, slash_user_path, 0).unwrap_err();
3622            assert_eq!(error, errno!(EISDIR));
3623            let error =
3624                sys_unlinkat(&current_task, FdNumber::AT_FDCWD, no_slash_user_path, 0).unwrap_err();
3625            assert_eq!(error, errno!(EISDIR));
3626
3627            // Success with AT_REMOVEDIR.
3628            sys_unlinkat(&current_task, FdNumber::AT_FDCWD, slash_user_path, AT_REMOVEDIR).unwrap();
3629        })
3630        .await;
3631    }
3632
3633    #[::fuchsia::test]
3634    async fn test_rename_noreplace() {
3635        spawn_kernel_and_run(async |current_task| {
3636            // Create the file that will be renamed.
3637            let old_user_path = "testfile.txt";
3638            let _old_file_handle = current_task
3639                .open_file_at(
3640                    FdNumber::AT_FDCWD,
3641                    old_user_path.into(),
3642                    OpenFlags::RDWR | OpenFlags::CREAT,
3643                    FileMode::ALLOW_ALL,
3644                    ResolveFlags::empty(),
3645                )
3646                .unwrap();
3647
3648            // Write the path to user memory.
3649            let old_path_addr = map_memory(&current_task, UserAddress::default(), *PAGE_SIZE);
3650            current_task
3651                .write_memory(old_path_addr, old_user_path.as_bytes())
3652                .expect("failed to clear struct");
3653
3654            // Create a second file that we will attempt to rename to.
3655            let new_user_path = "testfile2.txt";
3656            let _new_file_handle = current_task
3657                .open_file_at(
3658                    FdNumber::AT_FDCWD,
3659                    new_user_path.into(),
3660                    OpenFlags::RDWR | OpenFlags::CREAT,
3661                    FileMode::ALLOW_ALL,
3662                    ResolveFlags::empty(),
3663                )
3664                .unwrap();
3665
3666            // Write the path to user memory.
3667            let new_path_addr = map_memory(&current_task, UserAddress::default(), *PAGE_SIZE);
3668            current_task
3669                .write_memory(new_path_addr, new_user_path.as_bytes())
3670                .expect("failed to clear struct");
3671
3672            // Try to rename first file to second file's name with RENAME_NOREPLACE flag.
3673            // This should fail with EEXIST.
3674            let error = sys_renameat2(
3675                &current_task,
3676                FdNumber::AT_FDCWD,
3677                UserCString::new(current_task, old_path_addr),
3678                FdNumber::AT_FDCWD,
3679                UserCString::new(current_task, new_path_addr),
3680                RenameFlags::NOREPLACE.bits(),
3681            )
3682            .unwrap_err();
3683            assert_eq!(error, errno!(EEXIST));
3684        })
3685        .await;
3686    }
3687
3688    #[::fuchsia::test]
3689    async fn test_sys_sync() -> Result<(), Errno> {
3690        spawn_kernel_and_run(async |current_task| {
3691            sys_sync(current_task)?;
3692            Ok(())
3693        })
3694        .await
3695    }
3696
3697    #[::fuchsia::test]
3698    async fn test_sys_syncfs() -> Result<(), Errno> {
3699        spawn_kernel_and_run(async |current_task| {
3700            let file_handle = current_task.open_file(".".into(), OpenFlags::RDONLY)?;
3701            let fd = current_task.add_file(file_handle, FdFlags::empty())?;
3702            sys_syncfs(current_task, fd)?;
3703            Ok(())
3704        })
3705        .await
3706    }
3707
3708    // TODO(https://fxbug.dev/485370648) remove when unnecessary
3709    #[::fuchsia::test]
3710    async fn test_fake_ion_stat() {
3711        // Test with fake_ion disabled (default).
3712        spawn_kernel_and_run(async |current_task| {
3713            let ion_path = b"/dev/ion\0";
3714            let path_addr = map_memory(&current_task, UserAddress::default(), *PAGE_SIZE);
3715            current_task.write_memory(path_addr, ion_path).expect("failed to write path");
3716            let user_path = UserCString::new(current_task, path_addr);
3717
3718            let stat_addr = map_memory(&current_task, UserAddress::default(), *PAGE_SIZE);
3719            let stat_ptr = StatPtr::new(current_task, stat_addr);
3720
3721            let error = sys_fstatat64(&current_task, FdNumber::AT_FDCWD, user_path, stat_ptr, 0)
3722                .unwrap_err();
3723            assert_eq!(error, errno!(ENOENT));
3724        })
3725        .await;
3726
3727        // Test with fake_ion enabled.
3728        let mut features = KernelFeatures::default();
3729        features.fake_ion = true;
3730        spawn_kernel_with_features_and_run(
3731            async |current_task| {
3732                let ion_path = b"/dev/ion\0";
3733                let path_addr = map_memory(&current_task, UserAddress::default(), *PAGE_SIZE);
3734                current_task.write_memory(path_addr, ion_path).expect("failed to write path");
3735                let user_path = UserCString::new(current_task, path_addr);
3736
3737                let stat_addr = map_memory(&current_task, UserAddress::default(), *PAGE_SIZE);
3738                let stat_ptr = StatPtr::new(current_task, stat_addr);
3739
3740                sys_fstatat64(&current_task, FdNumber::AT_FDCWD, user_path, stat_ptr, 0)
3741                    .expect("sys_fstatat64 should succeed with fake_ion");
3742
3743                let stat_result: uapi::stat =
3744                    current_task.read_object(stat_addr.into()).expect("failed to read stat");
3745                assert_eq!(stat_result.st_mode, uapi::S_IFCHR | 0o666);
3746                assert_eq!(stat_result.st_rdev, DeviceId::new(10, 59).bits());
3747
3748                // Test statx as well.
3749                let statx_addr = map_memory(&current_task, UserAddress::default(), *PAGE_SIZE);
3750                let statx_ptr = UserRef::new(statx_addr);
3751                sys_statx(
3752                    &current_task,
3753                    FdNumber::AT_FDCWD,
3754                    user_path,
3755                    0,
3756                    uapi::STATX_BASIC_STATS,
3757                    statx_ptr,
3758                )
3759                .expect("sys_statx should succeed with fake_ion");
3760
3761                let statx_result: statx =
3762                    current_task.read_object(statx_ptr).expect("failed to read statx");
3763                assert_eq!(statx_result.stx_mode, (uapi::S_IFCHR | 0o666) as u16);
3764                assert_eq!(statx_result.stx_rdev_major, 10);
3765                assert_eq!(statx_result.stx_rdev_minor, 59);
3766            },
3767            features,
3768        )
3769        .await;
3770    }
3771
3772    #[::fuchsia::test]
3773    async fn test_lookup_at_directory() {
3774        spawn_kernel_and_run(async |current_task| {
3775            let dir_path = b"testdir\0";
3776            let dir_path_addr = map_memory(&current_task, UserAddress::default(), *PAGE_SIZE);
3777            current_task.write_memory(dir_path_addr, dir_path).expect("failed to write path");
3778            let dir_user_path = UserCString::new(current_task, dir_path_addr);
3779            sys_mkdirat(
3780                &current_task,
3781                FdNumber::AT_FDCWD,
3782                dir_user_path,
3783                FileMode::ALLOW_ALL.with_type(FileMode::IFDIR),
3784            )
3785            .unwrap();
3786
3787            let file_path = b"testfile\0";
3788            let file_path_addr = map_memory(&current_task, UserAddress::default(), *PAGE_SIZE);
3789            current_task.write_memory(file_path_addr, file_path).expect("failed to write path");
3790            let file_user_path = UserCString::new(current_task, file_path_addr);
3791            current_task
3792                .open_file_at(
3793                    FdNumber::AT_FDCWD,
3794                    "testfile".into(),
3795                    OpenFlags::CREAT | OpenFlags::RDWR,
3796                    FileMode::ALLOW_ALL,
3797                    ResolveFlags::empty(),
3798                )
3799                .unwrap();
3800
3801            // Directory lookup on directory succeeds.
3802            assert!(
3803                lookup_at(
3804                    &current_task,
3805                    FdNumber::AT_FDCWD,
3806                    dir_user_path,
3807                    LookupFlags::directory()
3808                )
3809                .is_ok()
3810            );
3811
3812            // Directory lookup on regular file fails with ENOTDIR.
3813            let error = lookup_at(
3814                &current_task,
3815                FdNumber::AT_FDCWD,
3816                file_user_path,
3817                LookupFlags::directory(),
3818            )
3819            .unwrap_err();
3820            assert_eq!(error, errno!(ENOTDIR));
3821        })
3822        .await;
3823    }
3824}