rustix/backend/linux_raw/fs/
types.rs

1use crate::ffi;
2use bitflags::bitflags;
3
4bitflags! {
5    /// `*_OK` constants for use with [`accessat`].
6    ///
7    /// [`accessat`]: fn.accessat.html
8    #[repr(transparent)]
9    #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
10    pub struct Access: ffi::c_uint {
11        /// `R_OK`
12        const READ_OK = linux_raw_sys::general::R_OK;
13
14        /// `W_OK`
15        const WRITE_OK = linux_raw_sys::general::W_OK;
16
17        /// `X_OK`
18        const EXEC_OK = linux_raw_sys::general::X_OK;
19
20        /// `F_OK`
21        const EXISTS = linux_raw_sys::general::F_OK;
22
23        /// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
24        const _ = !0;
25    }
26}
27
28bitflags! {
29    /// `AT_*` constants for use with [`openat`], [`statat`], and other `*at`
30    /// functions.
31    ///
32    /// [`openat`]: crate::fs::openat
33    /// [`statat`]: crate::fs::statat
34    #[repr(transparent)]
35    #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
36    pub struct AtFlags: ffi::c_uint {
37        /// `AT_SYMLINK_NOFOLLOW`
38        const SYMLINK_NOFOLLOW = linux_raw_sys::general::AT_SYMLINK_NOFOLLOW;
39
40        /// `AT_EACCESS`
41        const EACCESS = linux_raw_sys::general::AT_EACCESS;
42
43        /// `AT_REMOVEDIR`
44        const REMOVEDIR = linux_raw_sys::general::AT_REMOVEDIR;
45
46        /// `AT_SYMLINK_FOLLOW`
47        const SYMLINK_FOLLOW = linux_raw_sys::general::AT_SYMLINK_FOLLOW;
48
49        /// `AT_NO_AUTOMOUNT`
50        const NO_AUTOMOUNT = linux_raw_sys::general::AT_NO_AUTOMOUNT;
51
52        /// `AT_EMPTY_PATH`
53        const EMPTY_PATH = linux_raw_sys::general::AT_EMPTY_PATH;
54
55        /// `AT_STATX_SYNC_AS_STAT`
56        const STATX_SYNC_AS_STAT = linux_raw_sys::general::AT_STATX_SYNC_AS_STAT;
57
58        /// `AT_STATX_FORCE_SYNC`
59        const STATX_FORCE_SYNC = linux_raw_sys::general::AT_STATX_FORCE_SYNC;
60
61        /// `AT_STATX_DONT_SYNC`
62        const STATX_DONT_SYNC = linux_raw_sys::general::AT_STATX_DONT_SYNC;
63
64        /// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
65        const _ = !0;
66    }
67}
68
69bitflags! {
70    /// `S_I*` constants for use with [`openat`], [`chmodat`], and [`fchmod`].
71    ///
72    /// [`openat`]: crate::fs::openat
73    /// [`chmodat`]: crate::fs::chmodat
74    /// [`fchmod`]: crate::fs::fchmod
75    #[repr(transparent)]
76    #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
77    pub struct Mode: RawMode {
78        /// `S_IRWXU`
79        const RWXU = linux_raw_sys::general::S_IRWXU;
80
81        /// `S_IRUSR`
82        const RUSR = linux_raw_sys::general::S_IRUSR;
83
84        /// `S_IWUSR`
85        const WUSR = linux_raw_sys::general::S_IWUSR;
86
87        /// `S_IXUSR`
88        const XUSR = linux_raw_sys::general::S_IXUSR;
89
90        /// `S_IRWXG`
91        const RWXG = linux_raw_sys::general::S_IRWXG;
92
93        /// `S_IRGRP`
94        const RGRP = linux_raw_sys::general::S_IRGRP;
95
96        /// `S_IWGRP`
97        const WGRP = linux_raw_sys::general::S_IWGRP;
98
99        /// `S_IXGRP`
100        const XGRP = linux_raw_sys::general::S_IXGRP;
101
102        /// `S_IRWXO`
103        const RWXO = linux_raw_sys::general::S_IRWXO;
104
105        /// `S_IROTH`
106        const ROTH = linux_raw_sys::general::S_IROTH;
107
108        /// `S_IWOTH`
109        const WOTH = linux_raw_sys::general::S_IWOTH;
110
111        /// `S_IXOTH`
112        const XOTH = linux_raw_sys::general::S_IXOTH;
113
114        /// `S_ISUID`
115        const SUID = linux_raw_sys::general::S_ISUID;
116
117        /// `S_ISGID`
118        const SGID = linux_raw_sys::general::S_ISGID;
119
120        /// `S_ISVTX`
121        const SVTX = linux_raw_sys::general::S_ISVTX;
122
123        /// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
124        const _ = !0;
125    }
126}
127
128impl Mode {
129    /// Construct a `Mode` from the mode bits of the `st_mode` field of a
130    /// `Mode`.
131    #[inline]
132    pub const fn from_raw_mode(st_mode: RawMode) -> Self {
133        Self::from_bits_truncate(st_mode & !linux_raw_sys::general::S_IFMT)
134    }
135
136    /// Construct an `st_mode` value from a `Mode`.
137    #[inline]
138    pub const fn as_raw_mode(self) -> RawMode {
139        self.bits()
140    }
141}
142
143impl From<RawMode> for Mode {
144    /// Support conversions from raw mode values to `Mode`.
145    ///
146    /// ```
147    /// use rustix::fs::{Mode, RawMode};
148    /// assert_eq!(Mode::from(0o700), Mode::RWXU);
149    /// ```
150    #[inline]
151    fn from(st_mode: RawMode) -> Self {
152        Self::from_raw_mode(st_mode)
153    }
154}
155
156impl From<Mode> for RawMode {
157    /// Support conversions from `Mode` to raw mode values.
158    ///
159    /// ```
160    /// use rustix::fs::{Mode, RawMode};
161    /// assert_eq!(RawMode::from(Mode::RWXU), 0o700);
162    /// ```
163    #[inline]
164    fn from(mode: Mode) -> Self {
165        mode.as_raw_mode()
166    }
167}
168
169bitflags! {
170    /// `O_*` constants for use with [`openat`].
171    ///
172    /// [`openat`]: crate::fs::openat
173    #[repr(transparent)]
174    #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
175    pub struct OFlags: ffi::c_uint {
176        /// `O_ACCMODE`
177        const ACCMODE = linux_raw_sys::general::O_ACCMODE;
178
179        /// Similar to `ACCMODE`, but just includes the read/write flags, and
180        /// no other flags.
181        ///
182        /// On some platforms, `PATH` may be included in `ACCMODE`, when
183        /// sometimes we really just want the read/write bits. Caution is
184        /// indicated, as the presence of `PATH` may mean that the read/write
185        /// bits don't have their usual meaning.
186        const RWMODE = linux_raw_sys::general::O_RDONLY |
187                       linux_raw_sys::general::O_WRONLY |
188                       linux_raw_sys::general::O_RDWR;
189
190        /// `O_APPEND`
191        const APPEND = linux_raw_sys::general::O_APPEND;
192
193        /// `O_CREAT`
194        #[doc(alias = "CREAT")]
195        const CREATE = linux_raw_sys::general::O_CREAT;
196
197        /// `O_DIRECTORY`
198        const DIRECTORY = linux_raw_sys::general::O_DIRECTORY;
199
200        /// `O_DSYNC`
201        const DSYNC = linux_raw_sys::general::O_SYNC;
202
203        /// `O_EXCL`
204        const EXCL = linux_raw_sys::general::O_EXCL;
205
206        /// `O_FSYNC`
207        const FSYNC = linux_raw_sys::general::O_SYNC;
208
209        /// `O_NOFOLLOW`
210        const NOFOLLOW = linux_raw_sys::general::O_NOFOLLOW;
211
212        /// `O_NONBLOCK`
213        const NONBLOCK = linux_raw_sys::general::O_NONBLOCK;
214
215        /// `O_RDONLY`
216        const RDONLY = linux_raw_sys::general::O_RDONLY;
217
218        /// `O_WRONLY`
219        const WRONLY = linux_raw_sys::general::O_WRONLY;
220
221        /// `O_RDWR`
222        ///
223        /// This is not equal to `RDONLY | WRONLY`. It's a distinct flag.
224        const RDWR = linux_raw_sys::general::O_RDWR;
225
226        /// `O_NOCTTY`
227        const NOCTTY = linux_raw_sys::general::O_NOCTTY;
228
229        /// `O_RSYNC`
230        const RSYNC = linux_raw_sys::general::O_SYNC;
231
232        /// `O_SYNC`
233        const SYNC = linux_raw_sys::general::O_SYNC;
234
235        /// `O_TRUNC`
236        const TRUNC = linux_raw_sys::general::O_TRUNC;
237
238        /// `O_PATH`
239        const PATH = linux_raw_sys::general::O_PATH;
240
241        /// `O_CLOEXEC`
242        const CLOEXEC = linux_raw_sys::general::O_CLOEXEC;
243
244        /// `O_TMPFILE`
245        const TMPFILE = linux_raw_sys::general::O_TMPFILE;
246
247        /// `O_NOATIME`
248        const NOATIME = linux_raw_sys::general::O_NOATIME;
249
250        /// `O_DIRECT`
251        const DIRECT = linux_raw_sys::general::O_DIRECT;
252
253        /// `O_LARGEFILE`
254        ///
255        /// Rustix and/or libc will automatically set this flag when
256        /// appropriate in the [`rustix::fs::open`] family of functions, so
257        /// typical users do not need to care about it. It may be reported in
258        /// the return of `fcntl_getfl`, though.
259        const LARGEFILE = linux_raw_sys::general::O_LARGEFILE;
260
261        /// `O_ASYNC`, `FASYNC`
262        ///
263        /// This flag can't be used with the [`rustix::fs::open`] family of
264        /// functions, use [`rustix::fs::fcntl_setfl`] instead.
265        const ASYNC = linux_raw_sys::general::FASYNC;
266
267        /// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
268        const _ = !0;
269    }
270}
271
272bitflags! {
273    /// `RESOLVE_*` constants for use with [`openat2`].
274    ///
275    /// [`openat2`]: crate::fs::openat2
276    #[repr(transparent)]
277    #[derive(Default, Copy, Clone, Eq, PartialEq, Hash, Debug)]
278    pub struct ResolveFlags: u64 {
279        /// `RESOLVE_NO_XDEV`
280        const NO_XDEV = linux_raw_sys::general::RESOLVE_NO_XDEV as u64;
281
282        /// `RESOLVE_NO_MAGICLINKS`
283        const NO_MAGICLINKS = linux_raw_sys::general::RESOLVE_NO_MAGICLINKS as u64;
284
285        /// `RESOLVE_NO_SYMLINKS`
286        const NO_SYMLINKS = linux_raw_sys::general::RESOLVE_NO_SYMLINKS as u64;
287
288        /// `RESOLVE_BENEATH`
289        const BENEATH = linux_raw_sys::general::RESOLVE_BENEATH as u64;
290
291        /// `RESOLVE_IN_ROOT`
292        const IN_ROOT = linux_raw_sys::general::RESOLVE_IN_ROOT as u64;
293
294        /// `RESOLVE_CACHED` (since Linux 5.12)
295        const CACHED = linux_raw_sys::general::RESOLVE_CACHED as u64;
296
297        /// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
298        const _ = !0;
299    }
300}
301
302bitflags! {
303    /// `RENAME_*` constants for use with [`renameat_with`].
304    ///
305    /// [`renameat_with`]: crate::fs::renameat_with
306    #[repr(transparent)]
307    #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
308    pub struct RenameFlags: ffi::c_uint {
309        /// `RENAME_EXCHANGE`
310        const EXCHANGE = linux_raw_sys::general::RENAME_EXCHANGE;
311
312        /// `RENAME_NOREPLACE`
313        const NOREPLACE = linux_raw_sys::general::RENAME_NOREPLACE;
314
315        /// `RENAME_WHITEOUT`
316        const WHITEOUT = linux_raw_sys::general::RENAME_WHITEOUT;
317
318        /// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
319        const _ = !0;
320    }
321}
322
323/// `S_IF*` constants for use with [`mknodat`] and [`Stat`]'s `st_mode` field.
324///
325/// [`mknodat`]: crate::fs::mknodat
326/// [`Stat`]: crate::fs::Stat
327#[derive(Clone, Copy, Debug, PartialEq, Eq)]
328pub enum FileType {
329    /// `S_IFREG`
330    RegularFile = linux_raw_sys::general::S_IFREG as isize,
331
332    /// `S_IFDIR`
333    Directory = linux_raw_sys::general::S_IFDIR as isize,
334
335    /// `S_IFLNK`
336    Symlink = linux_raw_sys::general::S_IFLNK as isize,
337
338    /// `S_IFIFO`
339    #[doc(alias = "IFO")]
340    Fifo = linux_raw_sys::general::S_IFIFO as isize,
341
342    /// `S_IFSOCK`
343    Socket = linux_raw_sys::general::S_IFSOCK as isize,
344
345    /// `S_IFCHR`
346    CharacterDevice = linux_raw_sys::general::S_IFCHR as isize,
347
348    /// `S_IFBLK`
349    BlockDevice = linux_raw_sys::general::S_IFBLK as isize,
350
351    /// An unknown filesystem object.
352    Unknown,
353}
354
355impl FileType {
356    /// Construct a `FileType` from the `S_IFMT` bits of the `st_mode` field of
357    /// a `Stat`.
358    #[inline]
359    pub const fn from_raw_mode(st_mode: RawMode) -> Self {
360        match st_mode & linux_raw_sys::general::S_IFMT {
361            linux_raw_sys::general::S_IFREG => Self::RegularFile,
362            linux_raw_sys::general::S_IFDIR => Self::Directory,
363            linux_raw_sys::general::S_IFLNK => Self::Symlink,
364            linux_raw_sys::general::S_IFIFO => Self::Fifo,
365            linux_raw_sys::general::S_IFSOCK => Self::Socket,
366            linux_raw_sys::general::S_IFCHR => Self::CharacterDevice,
367            linux_raw_sys::general::S_IFBLK => Self::BlockDevice,
368            _ => Self::Unknown,
369        }
370    }
371
372    /// Construct an `st_mode` value from a `FileType`.
373    #[inline]
374    pub const fn as_raw_mode(self) -> RawMode {
375        match self {
376            Self::RegularFile => linux_raw_sys::general::S_IFREG,
377            Self::Directory => linux_raw_sys::general::S_IFDIR,
378            Self::Symlink => linux_raw_sys::general::S_IFLNK,
379            Self::Fifo => linux_raw_sys::general::S_IFIFO,
380            Self::Socket => linux_raw_sys::general::S_IFSOCK,
381            Self::CharacterDevice => linux_raw_sys::general::S_IFCHR,
382            Self::BlockDevice => linux_raw_sys::general::S_IFBLK,
383            Self::Unknown => linux_raw_sys::general::S_IFMT,
384        }
385    }
386
387    /// Construct a `FileType` from the `d_type` field of a `c::dirent`.
388    #[inline]
389    pub(crate) const fn from_dirent_d_type(d_type: u8) -> Self {
390        match d_type as u32 {
391            linux_raw_sys::general::DT_REG => Self::RegularFile,
392            linux_raw_sys::general::DT_DIR => Self::Directory,
393            linux_raw_sys::general::DT_LNK => Self::Symlink,
394            linux_raw_sys::general::DT_SOCK => Self::Socket,
395            linux_raw_sys::general::DT_FIFO => Self::Fifo,
396            linux_raw_sys::general::DT_CHR => Self::CharacterDevice,
397            linux_raw_sys::general::DT_BLK => Self::BlockDevice,
398            // linux_raw_sys::general::DT_UNKNOWN |
399            _ => Self::Unknown,
400        }
401    }
402}
403
404/// `POSIX_FADV_*` constants for use with [`fadvise`].
405///
406/// [`fadvise`]: crate::fs::fadvise
407#[derive(Debug, Copy, Clone, Eq, PartialEq)]
408#[repr(u32)]
409pub enum Advice {
410    /// `POSIX_FADV_NORMAL`
411    Normal = linux_raw_sys::general::POSIX_FADV_NORMAL,
412
413    /// `POSIX_FADV_SEQUENTIAL`
414    Sequential = linux_raw_sys::general::POSIX_FADV_SEQUENTIAL,
415
416    /// `POSIX_FADV_RANDOM`
417    Random = linux_raw_sys::general::POSIX_FADV_RANDOM,
418
419    /// `POSIX_FADV_NOREUSE`
420    NoReuse = linux_raw_sys::general::POSIX_FADV_NOREUSE,
421
422    /// `POSIX_FADV_WILLNEED`
423    WillNeed = linux_raw_sys::general::POSIX_FADV_WILLNEED,
424
425    /// `POSIX_FADV_DONTNEED`
426    DontNeed = linux_raw_sys::general::POSIX_FADV_DONTNEED,
427}
428
429bitflags! {
430    /// `MFD_*` constants for use with [`memfd_create`].
431    ///
432    /// [`memfd_create`]: crate::fs::memfd_create
433    #[repr(transparent)]
434    #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
435    pub struct MemfdFlags: ffi::c_uint {
436        /// `MFD_CLOEXEC`
437        const CLOEXEC = linux_raw_sys::general::MFD_CLOEXEC;
438
439        /// `MFD_ALLOW_SEALING`
440        const ALLOW_SEALING = linux_raw_sys::general::MFD_ALLOW_SEALING;
441
442        /// `MFD_HUGETLB` (since Linux 4.14)
443        const HUGETLB = linux_raw_sys::general::MFD_HUGETLB;
444
445        /// `MFD_NOEXEC_SEAL` (since Linux 6.3)
446        const NOEXEC_SEAL = linux_raw_sys::general::MFD_NOEXEC_SEAL;
447        /// `MFD_EXEC` (since Linux 6.3)
448        const EXEC = linux_raw_sys::general::MFD_EXEC;
449
450        /// `MFD_HUGE_64KB`
451        const HUGE_64KB = linux_raw_sys::general::MFD_HUGE_64KB;
452        /// `MFD_HUGE_512KB`
453        const HUGE_512KB = linux_raw_sys::general::MFD_HUGE_512KB;
454        /// `MFD_HUGE_1MB`
455        const HUGE_1MB = linux_raw_sys::general::MFD_HUGE_1MB;
456        /// `MFD_HUGE_2MB`
457        const HUGE_2MB = linux_raw_sys::general::MFD_HUGE_2MB;
458        /// `MFD_HUGE_8MB`
459        const HUGE_8MB = linux_raw_sys::general::MFD_HUGE_8MB;
460        /// `MFD_HUGE_16MB`
461        const HUGE_16MB = linux_raw_sys::general::MFD_HUGE_16MB;
462        /// `MFD_HUGE_32MB`
463        const HUGE_32MB = linux_raw_sys::general::MFD_HUGE_32MB;
464        /// `MFD_HUGE_256MB`
465        const HUGE_256MB = linux_raw_sys::general::MFD_HUGE_256MB;
466        /// `MFD_HUGE_512MB`
467        const HUGE_512MB = linux_raw_sys::general::MFD_HUGE_512MB;
468        /// `MFD_HUGE_1GB`
469        const HUGE_1GB = linux_raw_sys::general::MFD_HUGE_1GB;
470        /// `MFD_HUGE_2GB`
471        const HUGE_2GB = linux_raw_sys::general::MFD_HUGE_2GB;
472        /// `MFD_HUGE_16GB`
473        const HUGE_16GB = linux_raw_sys::general::MFD_HUGE_16GB;
474
475        /// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
476        const _ = !0;
477    }
478}
479
480bitflags! {
481    /// `F_SEAL_*` constants for use with [`fcntl_add_seals`] and
482    /// [`fcntl_get_seals`].
483    ///
484    /// [`fcntl_add_seals`]: crate::fs::fcntl_add_seals
485    /// [`fcntl_get_seals`]: crate::fs::fcntl_get_seals
486    #[repr(transparent)]
487    #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
488    pub struct SealFlags: u32 {
489        /// `F_SEAL_SEAL`
490        const SEAL = linux_raw_sys::general::F_SEAL_SEAL;
491        /// `F_SEAL_SHRINK`
492        const SHRINK = linux_raw_sys::general::F_SEAL_SHRINK;
493        /// `F_SEAL_GROW`
494        const GROW = linux_raw_sys::general::F_SEAL_GROW;
495        /// `F_SEAL_WRITE`
496        const WRITE = linux_raw_sys::general::F_SEAL_WRITE;
497        /// `F_SEAL_FUTURE_WRITE` (since Linux 5.1)
498        const FUTURE_WRITE = linux_raw_sys::general::F_SEAL_FUTURE_WRITE;
499
500        /// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
501        const _ = !0;
502    }
503}
504
505bitflags! {
506    /// `FALLOC_FL_*` constants for use with [`fallocate`].
507    ///
508    /// [`fallocate`]: crate::fs::fallocate
509    #[repr(transparent)]
510    #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
511    pub struct FallocateFlags: u32 {
512        /// `FALLOC_FL_KEEP_SIZE`
513        const KEEP_SIZE = linux_raw_sys::general::FALLOC_FL_KEEP_SIZE;
514        /// `FALLOC_FL_PUNCH_HOLE`
515        const PUNCH_HOLE = linux_raw_sys::general::FALLOC_FL_PUNCH_HOLE;
516        /// `FALLOC_FL_NO_HIDE_STALE`
517        const NO_HIDE_STALE = linux_raw_sys::general::FALLOC_FL_NO_HIDE_STALE;
518        /// `FALLOC_FL_COLLAPSE_RANGE`
519        const COLLAPSE_RANGE = linux_raw_sys::general::FALLOC_FL_COLLAPSE_RANGE;
520        /// `FALLOC_FL_ZERO_RANGE`
521        const ZERO_RANGE = linux_raw_sys::general::FALLOC_FL_ZERO_RANGE;
522        /// `FALLOC_FL_INSERT_RANGE`
523        const INSERT_RANGE = linux_raw_sys::general::FALLOC_FL_INSERT_RANGE;
524        /// `FALLOC_FL_UNSHARE_RANGE`
525        const UNSHARE_RANGE = linux_raw_sys::general::FALLOC_FL_UNSHARE_RANGE;
526
527        /// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
528        const _ = !0;
529    }
530}
531
532bitflags! {
533    /// `ST_*` constants for use with [`StatVfs`].
534    #[repr(transparent)]
535    #[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
536    pub struct StatVfsMountFlags: u64 {
537        /// `ST_MANDLOCK`
538        const MANDLOCK = linux_raw_sys::general::MS_MANDLOCK as u64;
539
540        /// `ST_NOATIME`
541        const NOATIME = linux_raw_sys::general::MS_NOATIME as u64;
542
543        /// `ST_NODEV`
544        const NODEV = linux_raw_sys::general::MS_NODEV as u64;
545
546        /// `ST_NODIRATIME`
547        const NODIRATIME = linux_raw_sys::general::MS_NODIRATIME as u64;
548
549        /// `ST_NOEXEC`
550        const NOEXEC = linux_raw_sys::general::MS_NOEXEC as u64;
551
552        /// `ST_NOSUID`
553        const NOSUID = linux_raw_sys::general::MS_NOSUID as u64;
554
555        /// `ST_RDONLY`
556        const RDONLY = linux_raw_sys::general::MS_RDONLY as u64;
557
558        /// `ST_RELATIME`
559        const RELATIME = linux_raw_sys::general::MS_RELATIME as u64;
560
561        /// `ST_SYNCHRONOUS`
562        const SYNCHRONOUS = linux_raw_sys::general::MS_SYNCHRONOUS as u64;
563
564        /// <https://docs.rs/bitflags/*/bitflags/#externally-defined-flags>
565        const _ = !0;
566    }
567}
568
569/// `LOCK_*` constants for use with [`flock`] and [`fcntl_lock`].
570///
571/// [`flock`]: crate::fs::flock
572/// [`fcntl_lock`]: crate::fs::fcntl_lock
573#[derive(Clone, Copy, Debug, PartialEq, Eq)]
574#[repr(u32)]
575pub enum FlockOperation {
576    /// `LOCK_SH`
577    LockShared = linux_raw_sys::general::LOCK_SH,
578    /// `LOCK_EX`
579    LockExclusive = linux_raw_sys::general::LOCK_EX,
580    /// `LOCK_UN`
581    Unlock = linux_raw_sys::general::LOCK_UN,
582    /// `LOCK_SH | LOCK_NB`
583    NonBlockingLockShared = linux_raw_sys::general::LOCK_SH | linux_raw_sys::general::LOCK_NB,
584    /// `LOCK_EX | LOCK_NB`
585    NonBlockingLockExclusive = linux_raw_sys::general::LOCK_EX | linux_raw_sys::general::LOCK_NB,
586    /// `LOCK_UN | LOCK_NB`
587    NonBlockingUnlock = linux_raw_sys::general::LOCK_UN | linux_raw_sys::general::LOCK_NB,
588}
589
590/// `struct stat` for use with [`statat`] and [`fstat`].
591///
592/// [`statat`]: crate::fs::statat
593/// [`fstat`]: crate::fs::fstat
594// On 32-bit with `struct stat64` and mips64 with `struct stat`, Linux's
595// `st_mtime` and friends are 32-bit, so we use our own struct, populated from
596// `statx` where possible, to avoid the y2038 bug.
597#[cfg(any(
598    target_pointer_width = "32",
599    target_arch = "mips64",
600    target_arch = "mips64r6"
601))]
602#[derive(Debug, Copy, Clone)]
603#[allow(missing_docs)]
604#[non_exhaustive]
605pub struct Stat {
606    pub st_dev: u64,
607    pub st_mode: u32,
608    pub st_nlink: u32,
609    pub st_uid: u32,
610    pub st_gid: u32,
611    pub st_rdev: u64,
612    pub st_size: i64,
613    pub st_blksize: u32,
614    pub st_blocks: u64,
615    pub st_atime: i64,
616    pub st_atime_nsec: u32,
617    pub st_mtime: i64,
618    pub st_mtime_nsec: u32,
619    pub st_ctime: i64,
620    pub st_ctime_nsec: u32,
621    pub st_ino: u64,
622}
623
624/// `struct stat` for use with [`statat`] and [`fstat`].
625///
626/// [`statat`]: crate::fs::statat
627/// [`fstat`]: crate::fs::fstat
628#[repr(C)]
629#[derive(Debug, Copy, Clone)]
630#[allow(missing_docs)]
631#[non_exhaustive]
632#[cfg(target_arch = "x86_64")]
633pub struct Stat {
634    pub st_dev: ffi::c_ulong,
635    pub st_ino: ffi::c_ulong,
636    pub st_nlink: ffi::c_ulong,
637    pub st_mode: ffi::c_uint,
638    pub st_uid: ffi::c_uint,
639    pub st_gid: ffi::c_uint,
640    pub(crate) __pad0: ffi::c_uint,
641    pub st_rdev: ffi::c_ulong,
642    pub st_size: ffi::c_long,
643    pub st_blksize: ffi::c_long,
644    pub st_blocks: ffi::c_long,
645    pub st_atime: ffi::c_long,
646    pub st_atime_nsec: ffi::c_ulong,
647    pub st_mtime: ffi::c_long,
648    pub st_mtime_nsec: ffi::c_ulong,
649    pub st_ctime: ffi::c_long,
650    pub st_ctime_nsec: ffi::c_ulong,
651    pub(crate) __unused: [ffi::c_long; 3],
652}
653#[repr(C)]
654#[derive(Debug, Copy, Clone)]
655#[allow(missing_docs)]
656#[non_exhaustive]
657#[cfg(target_arch = "aarch64")]
658pub struct Stat {
659    pub st_dev: ffi::c_ulong,
660    pub st_ino: ffi::c_ulong,
661    pub st_mode: ffi::c_uint,
662    pub st_nlink: ffi::c_uint,
663    pub st_uid: ffi::c_uint,
664    pub st_gid: ffi::c_uint,
665    pub st_rdev: ffi::c_ulong,
666    pub(crate) __pad1: ffi::c_ulong,
667    pub st_size: ffi::c_long,
668    pub st_blksize: ffi::c_int,
669    pub(crate) __pad2: ffi::c_int,
670    pub st_blocks: ffi::c_long,
671    pub st_atime: ffi::c_long,
672    pub st_atime_nsec: ffi::c_ulong,
673    pub st_mtime: ffi::c_long,
674    pub st_mtime_nsec: ffi::c_ulong,
675    pub st_ctime: ffi::c_long,
676    pub st_ctime_nsec: ffi::c_ulong,
677    pub(crate) __unused4: ffi::c_uint,
678    pub(crate) __unused5: ffi::c_uint,
679}
680#[repr(C)]
681#[derive(Debug, Copy, Clone)]
682#[allow(missing_docs)]
683#[non_exhaustive]
684#[cfg(target_arch = "riscv64")]
685pub struct Stat {
686    pub st_dev: ffi::c_ulong,
687    pub st_ino: ffi::c_ulong,
688    pub st_mode: ffi::c_uint,
689    pub st_nlink: ffi::c_uint,
690    pub st_uid: ffi::c_uint,
691    pub st_gid: ffi::c_uint,
692    pub st_rdev: ffi::c_ulong,
693    pub(crate) __pad1: ffi::c_ulong,
694    pub st_size: ffi::c_long,
695    pub st_blksize: ffi::c_int,
696    pub(crate) __pad2: ffi::c_int,
697    pub st_blocks: ffi::c_long,
698    pub st_atime: ffi::c_long,
699    pub st_atime_nsec: ffi::c_ulong,
700    pub st_mtime: ffi::c_long,
701    pub st_mtime_nsec: ffi::c_ulong,
702    pub st_ctime: ffi::c_long,
703    pub st_ctime_nsec: ffi::c_ulong,
704    pub(crate) __unused4: ffi::c_uint,
705    pub(crate) __unused5: ffi::c_uint,
706}
707// This follows `stat`. powerpc64 defines a `stat64` but it's not used.
708#[repr(C)]
709#[derive(Debug, Copy, Clone)]
710#[allow(missing_docs)]
711#[non_exhaustive]
712#[cfg(target_arch = "powerpc64")]
713pub struct Stat {
714    pub st_dev: ffi::c_ulong,
715    pub st_ino: ffi::c_ulong,
716    pub st_nlink: ffi::c_ulong,
717    pub st_mode: ffi::c_uint,
718    pub st_uid: ffi::c_uint,
719    pub st_gid: ffi::c_uint,
720    pub st_rdev: ffi::c_ulong,
721    pub st_size: ffi::c_long,
722    pub st_blksize: ffi::c_ulong,
723    pub st_blocks: ffi::c_ulong,
724    pub st_atime: ffi::c_long,
725    pub st_atime_nsec: ffi::c_ulong,
726    pub st_mtime: ffi::c_long,
727    pub st_mtime_nsec: ffi::c_ulong,
728    pub st_ctime: ffi::c_long,
729    pub st_ctime_nsec: ffi::c_ulong,
730    pub(crate) __unused4: ffi::c_ulong,
731    pub(crate) __unused5: ffi::c_ulong,
732    pub(crate) __unused6: ffi::c_ulong,
733}
734#[repr(C)]
735#[derive(Debug, Copy, Clone)]
736#[allow(missing_docs)]
737#[non_exhaustive]
738#[cfg(target_arch = "s390x")]
739pub struct Stat {
740    pub st_dev: ffi::c_ulong,
741    pub st_ino: ffi::c_ulong,
742    pub st_nlink: ffi::c_ulong,
743    pub st_mode: ffi::c_uint,
744    pub st_uid: ffi::c_uint,
745    pub st_gid: ffi::c_uint,
746    pub(crate) __pad1: ffi::c_uint,
747    pub st_rdev: ffi::c_ulong,
748    pub st_size: ffi::c_long, // Linux has `c_ulong` but we make it signed.
749    pub st_atime: ffi::c_long,
750    pub st_atime_nsec: ffi::c_ulong,
751    pub st_mtime: ffi::c_long,
752    pub st_mtime_nsec: ffi::c_ulong,
753    pub st_ctime: ffi::c_long,
754    pub st_ctime_nsec: ffi::c_ulong,
755    pub st_blksize: ffi::c_ulong,
756    pub st_blocks: ffi::c_long,
757    pub(crate) __unused: [ffi::c_ulong; 3],
758}
759
760/// `struct statfs` for use with [`statfs`] and [`fstatfs`].
761///
762/// [`statfs`]: crate::fs::statfs
763/// [`fstatfs`]: crate::fs::fstatfs
764#[allow(clippy::module_name_repetitions)]
765#[repr(C)]
766#[cfg_attr(target_arch = "arm", repr(packed(4)))]
767#[derive(Debug, Copy, Clone)]
768#[allow(missing_docs)]
769#[non_exhaustive]
770pub struct StatFs {
771    pub f_type: FsWord,
772    #[cfg(not(any(target_arch = "arm", target_arch = "s390x")))]
773    pub f_bsize: ffi::c_long,
774    #[cfg(any(target_arch = "arm", target_arch = "s390x"))]
775    pub f_bsize: ffi::c_uint,
776    pub f_blocks: u64,
777    pub f_bfree: u64,
778    pub f_bavail: u64,
779    pub f_files: u64,
780    pub f_ffree: u64,
781    pub f_fsid: Fsid,
782    #[cfg(not(any(target_arch = "arm", target_arch = "s390x")))]
783    pub f_namelen: ffi::c_long,
784    #[cfg(any(target_arch = "arm", target_arch = "s390x"))]
785    pub f_namelen: ffi::c_uint,
786    #[cfg(not(any(target_arch = "arm", target_arch = "s390x")))]
787    pub f_frsize: ffi::c_long,
788    #[cfg(any(target_arch = "arm", target_arch = "s390x"))]
789    pub f_frsize: ffi::c_uint,
790    #[cfg(not(any(target_arch = "arm", target_arch = "s390x")))]
791    pub f_flags: ffi::c_long,
792    #[cfg(any(target_arch = "arm", target_arch = "s390x"))]
793    pub f_flags: ffi::c_uint,
794    #[cfg(not(target_arch = "s390x"))]
795    pub(crate) f_spare: [ffi::c_long; 4],
796    #[cfg(target_arch = "s390x")]
797    pub(crate) f_spare: [ffi::c_uint; 5],
798}
799
800/// `fsid_t` for use with [`StatFs`].
801#[repr(C)]
802#[derive(Debug, Copy, Clone)]
803#[allow(missing_docs)]
804pub struct Fsid {
805    pub(crate) val: [ffi::c_int; 2],
806}
807
808/// `struct statvfs` for use with [`statvfs`] and [`fstatvfs`].
809///
810/// [`statvfs`]: crate::fs::statvfs
811/// [`fstatvfs`]: crate::fs::fstatvfs
812#[allow(missing_docs)]
813pub struct StatVfs {
814    pub f_bsize: u64,
815    pub f_frsize: u64,
816    pub f_blocks: u64,
817    pub f_bfree: u64,
818    pub f_bavail: u64,
819    pub f_files: u64,
820    pub f_ffree: u64,
821    pub f_favail: u64,
822    pub f_fsid: u64,
823    pub f_flag: StatVfsMountFlags,
824    pub f_namemax: u64,
825}
826
827/// `mode_t`
828pub type RawMode = ffi::c_uint;
829
830/// `dev_t`
831// Within the kernel the `dev_t` is 32-bit, but userspace uses a 64-bit field.
832pub type Dev = u64;
833
834/// `__fsword_t`
835#[cfg(not(any(
836    target_arch = "mips64",
837    target_arch = "mips64r6",
838    target_arch = "s390x"
839)))]
840pub type FsWord = ffi::c_long;
841
842/// `__fsword_t`
843#[cfg(any(target_arch = "mips64", target_arch = "mips64r6"))]
844pub type FsWord = i64;
845
846/// `__fsword_t`
847#[cfg(target_arch = "s390x")]
848pub type FsWord = u32;
rustix/backend/linux_raw/fs/types.rs

rustix/backend/linux_raw/fs/
types.rs
