linux_api/
fcntl.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
use num_enum::{IntoPrimitive, TryFromPrimitive};

use crate::{bindings, const_conversions};

bitflags::bitflags! {
    /// Open flags, as used e.g. with `open`.
    #[derive(Copy, Clone, Debug, Default, Eq, PartialEq)]
    pub struct OFlag: i32 {
        const O_ACCMODE = const_conversions::i32_from_u32(bindings::LINUX_O_ACCMODE);
        const O_RDONLY = const_conversions::i32_from_u32(bindings::LINUX_O_RDONLY);
        const O_WRONLY = const_conversions::i32_from_u32(bindings::LINUX_O_WRONLY);
        const O_RDWR = const_conversions::i32_from_u32(bindings::LINUX_O_RDWR);
        const O_CREAT = const_conversions::i32_from_u32(bindings::LINUX_O_CREAT);
        const O_EXCL = const_conversions::i32_from_u32(bindings::LINUX_O_EXCL);
        const O_NOCTTY = const_conversions::i32_from_u32(bindings::LINUX_O_NOCTTY);
        const O_TRUNC = const_conversions::i32_from_u32(bindings::LINUX_O_TRUNC);
        const O_APPEND = const_conversions::i32_from_u32(bindings::LINUX_O_APPEND);
        const O_NONBLOCK = const_conversions::i32_from_u32(bindings::LINUX_O_NONBLOCK);
        const O_DSYNC = const_conversions::i32_from_u32(bindings::LINUX_O_DSYNC);
        const O_DIRECT = const_conversions::i32_from_u32(bindings::LINUX_O_DIRECT);
        const O_LARGEFILE = const_conversions::i32_from_u32(bindings::LINUX_O_LARGEFILE);
        const O_DIRECTORY = const_conversions::i32_from_u32(bindings::LINUX_O_DIRECTORY);
        const O_NOFOLLOW = const_conversions::i32_from_u32(bindings::LINUX_O_NOFOLLOW);
        const O_NOATIME = const_conversions::i32_from_u32(bindings::LINUX_O_NOATIME);
        const O_CLOEXEC = const_conversions::i32_from_u32(bindings::LINUX_O_CLOEXEC);
        const O_SYNC = const_conversions::i32_from_u32(bindings::LINUX_O_SYNC);
        const O_PATH = const_conversions::i32_from_u32(bindings::LINUX_O_PATH);
        const O_TMPFILE = const_conversions::i32_from_u32(bindings::LINUX_O_TMPFILE);
        const O_NDELAY = const_conversions::i32_from_u32(bindings::LINUX_O_NDELAY);
        const O_ASYNC = const_conversions::i32_from_u32(bindings::LINUX_FASYNC);
    }
}

/// fcntl commands, as used with `fcntl`.
#[derive(Debug, Copy, Clone, Eq, PartialEq, IntoPrimitive, TryFromPrimitive)]
#[repr(u32)]
#[allow(non_camel_case_types)]
pub enum FcntlCommand {
    F_DUPFD = bindings::LINUX_F_DUPFD,
    F_GETFD = bindings::LINUX_F_GETFD,
    F_SETFD = bindings::LINUX_F_SETFD,
    F_GETFL = bindings::LINUX_F_GETFL,
    F_SETFL = bindings::LINUX_F_SETFL,
    F_GETLK = bindings::LINUX_F_GETLK,
    F_SETLK = bindings::LINUX_F_SETLK,
    F_SETLKW = bindings::LINUX_F_SETLKW,
    F_SETOWN = bindings::LINUX_F_SETOWN,
    F_GETOWN = bindings::LINUX_F_GETOWN,
    F_SETSIG = bindings::LINUX_F_SETSIG,
    F_GETSIG = bindings::LINUX_F_GETSIG,
    F_SETOWN_EX = bindings::LINUX_F_SETOWN_EX,
    F_GETOWN_EX = bindings::LINUX_F_GETOWN_EX,
    F_GETOWNER_UIDS = bindings::LINUX_F_GETOWNER_UIDS,
    F_OFD_GETLK = bindings::LINUX_F_OFD_GETLK,
    F_OFD_SETLK = bindings::LINUX_F_OFD_SETLK,
    F_OFD_SETLKW = bindings::LINUX_F_OFD_SETLKW,
    F_SETLEASE = bindings::LINUX_F_SETLEASE,
    F_GETLEASE = bindings::LINUX_F_GETLEASE,
    F_NOTIFY = bindings::LINUX_F_NOTIFY,
    F_DUPFD_QUERY = bindings::LINUX_F_DUPFD_QUERY,
    F_CREATED_QUERY = bindings::LINUX_F_CREATED_QUERY,
    F_DUPFD_CLOEXEC = bindings::LINUX_F_DUPFD_CLOEXEC,
    F_SETPIPE_SZ = bindings::LINUX_F_SETPIPE_SZ,
    F_GETPIPE_SZ = bindings::LINUX_F_GETPIPE_SZ,
    F_ADD_SEALS = bindings::LINUX_F_ADD_SEALS,
    F_GET_SEALS = bindings::LINUX_F_GET_SEALS,
    F_CANCELLK = bindings::LINUX_F_CANCELLK,
    F_GET_RW_HINT = bindings::LINUX_F_GET_RW_HINT,
    F_SET_RW_HINT = bindings::LINUX_F_SET_RW_HINT,
    F_GET_FILE_RW_HINT = bindings::LINUX_F_GET_FILE_RW_HINT,
    F_SET_FILE_RW_HINT = bindings::LINUX_F_SET_FILE_RW_HINT,
}

/// Owner, as used with [`FcntlCommand::F_SETOWN_EX`] and [`FcntlCommand::F_GETOWN_EX`]
#[derive(Debug, Copy, Clone, Eq, PartialEq, IntoPrimitive, TryFromPrimitive)]
#[repr(u32)]
#[allow(non_camel_case_types)]
pub enum FcntlOwner {
    F_OWNER_TID = bindings::LINUX_F_OWNER_TID,
    F_OWNER_PID = bindings::LINUX_F_OWNER_PID,
    F_OWNER_PGRP = bindings::LINUX_F_OWNER_PGRP,
}

/// Lease type, as used with [`FcntlCommand::F_SETLEASE`]
#[derive(Debug, Copy, Clone, Eq, PartialEq, IntoPrimitive, TryFromPrimitive)]
#[repr(u32)]
#[allow(non_camel_case_types)]
pub enum FcntlLeaseType {
    F_RDLCK = bindings::LINUX_F_RDLCK,
    F_WRLCK = bindings::LINUX_F_WRLCK,
    F_UNLCK = bindings::LINUX_F_UNLCK,
    F_EXLCK = bindings::LINUX_F_EXLCK,
    F_SHLCK = bindings::LINUX_F_SHLCK,
}

/// Seal type, as used with [`FcntlCommand::F_ADD_SEALS`] and [`FcntlCommand::F_GET_SEALS`].
#[derive(Debug, Copy, Clone, Eq, PartialEq, IntoPrimitive, TryFromPrimitive)]
#[repr(u32)]
#[allow(non_camel_case_types)]
pub enum FcntlSealType {
    F_SEAL_SEAL = bindings::LINUX_F_SEAL_SEAL,
    F_SEAL_SHRINK = bindings::LINUX_F_SEAL_SHRINK,
    F_SEAL_GROW = bindings::LINUX_F_SEAL_GROW,
    F_SEAL_WRITE = bindings::LINUX_F_SEAL_WRITE,
    F_SEAL_FUTURE_WRITE = bindings::LINUX_F_SEAL_FUTURE_WRITE,
    F_SEAL_EXEC = bindings::LINUX_F_SEAL_EXEC,
}

/// Read-write hint, as used with [`FcntlCommand::F_GET_RW_HINT`] and [`FcntlCommand::F_SET_RW_HINT`].
#[derive(Debug, Copy, Clone, Eq, PartialEq, IntoPrimitive, TryFromPrimitive)]
#[repr(u32)]
#[allow(non_camel_case_types)]
pub enum FcntlRwHint {
    RWH_WRITE_LIFE_NOT_SET = bindings::LINUX_RWH_WRITE_LIFE_NOT_SET,
    RWH_WRITE_LIFE_NONE = bindings::LINUX_RWH_WRITE_LIFE_NONE,
    RWH_WRITE_LIFE_SHORT = bindings::LINUX_RWH_WRITE_LIFE_SHORT,
    RWH_WRITE_LIFE_MEDIUM = bindings::LINUX_RWH_WRITE_LIFE_MEDIUM,
    RWH_WRITE_LIFE_LONG = bindings::LINUX_RWH_WRITE_LIFE_LONG,
    RWH_WRITE_LIFE_EXTREME = bindings::LINUX_RWH_WRITE_LIFE_EXTREME,
}

bitflags::bitflags! {
    /// Descriptor flags, as used with [`FcntlCommand::F_GETFL`] and [`FcntlCommand::F_SETFL`].
    #[derive(Copy, Clone, Debug, Default, Eq, PartialEq)]
    pub struct DescriptorFlags: i32 {
        const FD_CLOEXEC = const_conversions::i32_from_u32(bindings::LINUX_FD_CLOEXEC);
    }
}

impl DescriptorFlags {
    pub fn as_o_flags(&self) -> OFlag {
        let mut flags = OFlag::empty();
        if self.contains(Self::FD_CLOEXEC) {
            flags.insert(OFlag::O_CLOEXEC);
        }
        flags
    }

    /// Returns a tuple of the `DescriptorFlags` and any remaining flags.
    pub fn from_o_flags(flags: OFlag) -> (Self, OFlag) {
        let mut remaining = flags;
        let mut flags = Self::empty();

        if remaining.contains(OFlag::O_CLOEXEC) {
            remaining.remove(OFlag::O_CLOEXEC);
            flags.insert(Self::FD_CLOEXEC);
        }

        (flags, remaining)
    }
}

bitflags::bitflags! {
    /// flags for execveat.
    #[derive(Copy, Clone, Debug, Default, Eq, PartialEq)]
    pub struct ExecveAtFlags: i32 {
        const AT_EMPTY_PATH = const_conversions::i32_from_u32(bindings::LINUX_AT_EMPTY_PATH);
        const AT_SYMLINK_NOFOLLOW = const_conversions::i32_from_u32(bindings::LINUX_AT_SYMLINK_NOFOLLOW);
    }
}