rustix/backend/linux_raw/
c.rs

1//! Adapt the Linux API to resemble a POSIX-style libc API.
2//!
3//! The linux_raw backend doesn't use actual libc; this just defines certain
4//! types that are convenient to have defined.
5
6#![allow(unused_imports)]
7#![allow(non_camel_case_types)]
8
9pub(crate) type size_t = usize;
10pub(crate) use linux_raw_sys::ctypes::*;
11pub(crate) use linux_raw_sys::errno::EINVAL;
12pub(crate) use linux_raw_sys::ioctl::{FIONBIO, FIONREAD};
13// Import the kernel's `uid_t` and `gid_t` if they're 32-bit.
14#[cfg(not(any(target_arch = "arm", target_arch = "sparc", target_arch = "x86")))]
15pub(crate) use linux_raw_sys::general::{__kernel_gid_t as gid_t, __kernel_uid_t as uid_t};
16pub(crate) use linux_raw_sys::general::{
17    __kernel_pid_t as pid_t, __kernel_time64_t as time_t, __kernel_timespec as timespec, iovec,
18    O_CLOEXEC, O_NOCTTY, O_NONBLOCK, O_RDWR,
19};
20
21#[cfg(feature = "event")]
22#[cfg(test)]
23pub(crate) use linux_raw_sys::general::epoll_event;
24
25#[cfg(any(
26    feature = "fs",
27    all(
28        not(feature = "use-libc-auxv"),
29        not(feature = "use-explicitly-provided-auxv"),
30        any(
31            feature = "param",
32            feature = "runtime",
33            feature = "time",
34            target_arch = "x86",
35        )
36    )
37))]
38pub(crate) use linux_raw_sys::general::{
39    AT_FDCWD, NFS_SUPER_MAGIC, O_LARGEFILE, PROC_SUPER_MAGIC, UTIME_NOW, UTIME_OMIT, XATTR_CREATE,
40    XATTR_REPLACE,
41};
42
43pub(crate) use linux_raw_sys::ioctl::{BLKPBSZGET, BLKSSZGET, FICLONE};
44
45#[cfg(feature = "io_uring")]
46pub(crate) use linux_raw_sys::{general::open_how, io_uring::*};
47
48#[cfg(feature = "net")]
49pub(crate) use linux_raw_sys::{
50    cmsg_macros::*,
51    general::{O_CLOEXEC as SOCK_CLOEXEC, O_NONBLOCK as SOCK_NONBLOCK},
52    if_ether::*,
53    net::{
54        linger, msghdr, sockaddr, sockaddr_in, sockaddr_in6, sockaddr_un, socklen_t, AF_DECnet,
55        __kernel_sa_family_t as sa_family_t, __kernel_sockaddr_storage as sockaddr_storage,
56        cmsghdr, in6_addr, in_addr, ip_mreq, ip_mreq_source, ip_mreqn, ipv6_mreq, AF_APPLETALK,
57        AF_ASH, AF_ATMPVC, AF_ATMSVC, AF_AX25, AF_BLUETOOTH, AF_BRIDGE, AF_CAN, AF_ECONET,
58        AF_IEEE802154, AF_INET, AF_INET6, AF_IPX, AF_IRDA, AF_ISDN, AF_IUCV, AF_KEY, AF_LLC,
59        AF_NETBEUI, AF_NETLINK, AF_NETROM, AF_PACKET, AF_PHONET, AF_PPPOX, AF_RDS, AF_ROSE,
60        AF_RXRPC, AF_SECURITY, AF_SNA, AF_TIPC, AF_UNIX, AF_UNSPEC, AF_WANPIPE, AF_X25,
61        IP6T_SO_ORIGINAL_DST, IPPROTO_FRAGMENT, IPPROTO_ICMPV6, IPPROTO_MH, IPPROTO_ROUTING,
62        IPV6_ADD_MEMBERSHIP, IPV6_DROP_MEMBERSHIP, IPV6_FREEBIND, IPV6_MULTICAST_HOPS,
63        IPV6_MULTICAST_LOOP, IPV6_RECVTCLASS, IPV6_TCLASS, IPV6_UNICAST_HOPS, IPV6_V6ONLY,
64        IP_ADD_MEMBERSHIP, IP_ADD_SOURCE_MEMBERSHIP, IP_DROP_MEMBERSHIP, IP_DROP_SOURCE_MEMBERSHIP,
65        IP_FREEBIND, IP_MULTICAST_LOOP, IP_MULTICAST_TTL, IP_RECVTOS, IP_TOS, IP_TTL,
66        MSG_CMSG_CLOEXEC, MSG_CONFIRM, MSG_DONTROUTE, MSG_DONTWAIT, MSG_EOR, MSG_ERRQUEUE,
67        MSG_MORE, MSG_NOSIGNAL, MSG_OOB, MSG_PEEK, MSG_TRUNC, MSG_WAITALL, SCM_CREDENTIALS,
68        SCM_RIGHTS, SHUT_RD, SHUT_RDWR, SHUT_WR, SOCK_DGRAM, SOCK_RAW, SOCK_RDM, SOCK_SEQPACKET,
69        SOCK_STREAM, SOL_SOCKET, SO_ACCEPTCONN, SO_BROADCAST, SO_COOKIE, SO_DOMAIN, SO_ERROR,
70        SO_INCOMING_CPU, SO_KEEPALIVE, SO_LINGER, SO_OOBINLINE, SO_ORIGINAL_DST, SO_PASSCRED,
71        SO_PROTOCOL, SO_RCVBUF, SO_RCVTIMEO_NEW, SO_RCVTIMEO_NEW as SO_RCVTIMEO, SO_RCVTIMEO_OLD,
72        SO_REUSEADDR, SO_REUSEPORT, SO_SNDBUF, SO_SNDTIMEO_NEW, SO_SNDTIMEO_NEW as SO_SNDTIMEO,
73        SO_SNDTIMEO_OLD, SO_TYPE, TCP_CONGESTION, TCP_CORK, TCP_KEEPCNT, TCP_KEEPIDLE,
74        TCP_KEEPINTVL, TCP_NODELAY, TCP_QUICKACK, TCP_THIN_LINEAR_TIMEOUTS, TCP_USER_TIMEOUT,
75    },
76    netlink::*,
77};
78
79// Cast away bindgen's `enum` type to make these consistent with the other
80// `setsockopt`/`getsockopt` level values.
81#[cfg(feature = "net")]
82pub(crate) const IPPROTO_IP: u32 = linux_raw_sys::net::IPPROTO_IP as _;
83#[cfg(feature = "net")]
84pub(crate) const IPPROTO_ICMP: u32 = linux_raw_sys::net::IPPROTO_ICMP as _;
85#[cfg(feature = "net")]
86pub(crate) const IPPROTO_IGMP: u32 = linux_raw_sys::net::IPPROTO_IGMP as _;
87#[cfg(feature = "net")]
88pub(crate) const IPPROTO_IPIP: u32 = linux_raw_sys::net::IPPROTO_IPIP as _;
89#[cfg(feature = "net")]
90pub(crate) const IPPROTO_TCP: u32 = linux_raw_sys::net::IPPROTO_TCP as _;
91#[cfg(feature = "net")]
92pub(crate) const IPPROTO_EGP: u32 = linux_raw_sys::net::IPPROTO_EGP as _;
93#[cfg(feature = "net")]
94pub(crate) const IPPROTO_PUP: u32 = linux_raw_sys::net::IPPROTO_PUP as _;
95#[cfg(feature = "net")]
96pub(crate) const IPPROTO_UDP: u32 = linux_raw_sys::net::IPPROTO_UDP as _;
97#[cfg(feature = "net")]
98pub(crate) const IPPROTO_IDP: u32 = linux_raw_sys::net::IPPROTO_IDP as _;
99#[cfg(feature = "net")]
100pub(crate) const IPPROTO_TP: u32 = linux_raw_sys::net::IPPROTO_TP as _;
101#[cfg(feature = "net")]
102pub(crate) const IPPROTO_DCCP: u32 = linux_raw_sys::net::IPPROTO_DCCP as _;
103#[cfg(feature = "net")]
104pub(crate) const IPPROTO_IPV6: u32 = linux_raw_sys::net::IPPROTO_IPV6 as _;
105#[cfg(feature = "net")]
106pub(crate) const IPPROTO_RSVP: u32 = linux_raw_sys::net::IPPROTO_RSVP as _;
107#[cfg(feature = "net")]
108pub(crate) const IPPROTO_GRE: u32 = linux_raw_sys::net::IPPROTO_GRE as _;
109#[cfg(feature = "net")]
110pub(crate) const IPPROTO_ESP: u32 = linux_raw_sys::net::IPPROTO_ESP as _;
111#[cfg(feature = "net")]
112pub(crate) const IPPROTO_AH: u32 = linux_raw_sys::net::IPPROTO_AH as _;
113#[cfg(feature = "net")]
114pub(crate) const IPPROTO_MTP: u32 = linux_raw_sys::net::IPPROTO_MTP as _;
115#[cfg(feature = "net")]
116pub(crate) const IPPROTO_BEETPH: u32 = linux_raw_sys::net::IPPROTO_BEETPH as _;
117#[cfg(feature = "net")]
118pub(crate) const IPPROTO_ENCAP: u32 = linux_raw_sys::net::IPPROTO_ENCAP as _;
119#[cfg(feature = "net")]
120pub(crate) const IPPROTO_PIM: u32 = linux_raw_sys::net::IPPROTO_PIM as _;
121#[cfg(feature = "net")]
122pub(crate) const IPPROTO_COMP: u32 = linux_raw_sys::net::IPPROTO_COMP as _;
123#[cfg(feature = "net")]
124pub(crate) const IPPROTO_SCTP: u32 = linux_raw_sys::net::IPPROTO_SCTP as _;
125#[cfg(feature = "net")]
126pub(crate) const IPPROTO_UDPLITE: u32 = linux_raw_sys::net::IPPROTO_UDPLITE as _;
127#[cfg(feature = "net")]
128pub(crate) const IPPROTO_MPLS: u32 = linux_raw_sys::net::IPPROTO_MPLS as _;
129#[cfg(feature = "net")]
130pub(crate) const IPPROTO_ETHERNET: u32 = linux_raw_sys::net::IPPROTO_ETHERNET as _;
131#[cfg(feature = "net")]
132pub(crate) const IPPROTO_RAW: u32 = linux_raw_sys::net::IPPROTO_RAW as _;
133#[cfg(feature = "net")]
134pub(crate) const IPPROTO_MPTCP: u32 = linux_raw_sys::net::IPPROTO_MPTCP as _;
135
136#[cfg(any(feature = "process", feature = "runtime"))]
137pub(crate) use linux_raw_sys::general::siginfo_t;
138
139#[cfg(any(feature = "process", feature = "runtime"))]
140pub(crate) const EXIT_SUCCESS: c_int = 0;
141#[cfg(any(feature = "process", feature = "runtime"))]
142pub(crate) const EXIT_FAILURE: c_int = 1;
143#[cfg(feature = "process")]
144pub(crate) const EXIT_SIGNALED_SIGABRT: c_int = 128 + linux_raw_sys::general::SIGABRT as c_int;
145
146#[cfg(feature = "process")]
147pub(crate) use linux_raw_sys::{
148    general::{
149        CLD_CONTINUED, CLD_DUMPED, CLD_EXITED, CLD_KILLED, CLD_STOPPED, CLD_TRAPPED,
150        O_NONBLOCK as PIDFD_NONBLOCK, P_ALL, P_PGID, P_PID, P_PIDFD,
151    },
152    ioctl::TIOCSCTTY,
153};
154
155#[cfg(feature = "pty")]
156pub(crate) use linux_raw_sys::ioctl::TIOCGPTPEER;
157
158#[cfg(feature = "termios")]
159pub(crate) use linux_raw_sys::{
160    general::{
161        cc_t, speed_t, tcflag_t, termios, termios2, winsize, B0, B1000000, B110, B115200, B1152000,
162        B1200, B134, B150, B1500000, B1800, B19200, B200, B2000000, B230400, B2400, B2500000, B300,
163        B3000000, B3500000, B38400, B4000000, B460800, B4800, B50, B500000, B57600, B576000, B600,
164        B75, B921600, B9600, BOTHER, BRKINT, BS0, BS1, BSDLY, CBAUD, CBAUDEX, CIBAUD, CLOCAL,
165        CMSPAR, CR0, CR1, CR2, CR3, CRDLY, CREAD, CRTSCTS, CS5, CS6, CS7, CS8, CSIZE, CSTOPB, ECHO,
166        ECHOCTL, ECHOE, ECHOK, ECHOKE, ECHONL, ECHOPRT, EXTA, EXTB, EXTPROC, FF0, FF1, FFDLY,
167        FLUSHO, HUPCL, IBSHIFT, ICANON, ICRNL, IEXTEN, IGNBRK, IGNCR, IGNPAR, IMAXBEL, INLCR,
168        INPCK, ISIG, ISTRIP, IUCLC, IUTF8, IXANY, IXOFF, IXON, NCCS, NL0, NL1, NLDLY, NOFLSH,
169        OCRNL, OFDEL, OFILL, OLCUC, ONLCR, ONLRET, ONOCR, OPOST, PARENB, PARMRK, PARODD, PENDIN,
170        TAB0, TAB1, TAB2, TAB3, TABDLY, TCIFLUSH, TCIOFF, TCIOFLUSH, TCION, TCOFLUSH, TCOOFF,
171        TCOON, TCSADRAIN, TCSAFLUSH, TCSANOW, TOSTOP, VDISCARD, VEOF, VEOL, VEOL2, VERASE, VINTR,
172        VKILL, VLNEXT, VMIN, VQUIT, VREPRINT, VSTART, VSTOP, VSUSP, VSWTC, VT0, VT1, VTDLY, VTIME,
173        VWERASE, XCASE, XTABS,
174    },
175    ioctl::{TCGETS2, TCSETS2, TCSETSF2, TCSETSW2, TIOCEXCL, TIOCNXCL},
176};
177
178// On MIPS, `TCSANOW` et al have `TCSETS` added to them, so we need it to
179// subtract it out.
180#[cfg(all(
181    feature = "termios",
182    any(
183        target_arch = "mips",
184        target_arch = "mips32r6",
185        target_arch = "mips64",
186        target_arch = "mips64r6"
187    )
188))]
189pub(crate) use linux_raw_sys::ioctl::TCSETS;
190
191// Define our own `uid_t` and `gid_t` if the kernel's versions are not 32-bit.
192#[cfg(any(target_arch = "arm", target_arch = "sparc", target_arch = "x86"))]
193pub(crate) type uid_t = u32;
194#[cfg(any(target_arch = "arm", target_arch = "sparc", target_arch = "x86"))]
195pub(crate) type gid_t = u32;
196
197// Bindgen infers `u32` for many of these macro types which meant to be
198// used with `c_int` in the C APIs, so cast them to `c_int`.
199
200// Convert the signal constants from `u32` to `c_int`.
201pub(crate) const SIGHUP: c_int = linux_raw_sys::general::SIGHUP as _;
202pub(crate) const SIGINT: c_int = linux_raw_sys::general::SIGINT as _;
203pub(crate) const SIGQUIT: c_int = linux_raw_sys::general::SIGQUIT as _;
204pub(crate) const SIGILL: c_int = linux_raw_sys::general::SIGILL as _;
205pub(crate) const SIGTRAP: c_int = linux_raw_sys::general::SIGTRAP as _;
206pub(crate) const SIGABRT: c_int = linux_raw_sys::general::SIGABRT as _;
207pub(crate) const SIGBUS: c_int = linux_raw_sys::general::SIGBUS as _;
208pub(crate) const SIGFPE: c_int = linux_raw_sys::general::SIGFPE as _;
209pub(crate) const SIGKILL: c_int = linux_raw_sys::general::SIGKILL as _;
210pub(crate) const SIGUSR1: c_int = linux_raw_sys::general::SIGUSR1 as _;
211pub(crate) const SIGSEGV: c_int = linux_raw_sys::general::SIGSEGV as _;
212pub(crate) const SIGUSR2: c_int = linux_raw_sys::general::SIGUSR2 as _;
213pub(crate) const SIGPIPE: c_int = linux_raw_sys::general::SIGPIPE as _;
214pub(crate) const SIGALRM: c_int = linux_raw_sys::general::SIGALRM as _;
215pub(crate) const SIGTERM: c_int = linux_raw_sys::general::SIGTERM as _;
216#[cfg(not(any(
217    target_arch = "mips",
218    target_arch = "mips32r6",
219    target_arch = "mips64",
220    target_arch = "mips64r6",
221    target_arch = "sparc",
222    target_arch = "sparc64"
223)))]
224pub(crate) const SIGSTKFLT: c_int = linux_raw_sys::general::SIGSTKFLT as _;
225pub(crate) const SIGCHLD: c_int = linux_raw_sys::general::SIGCHLD as _;
226pub(crate) const SIGCONT: c_int = linux_raw_sys::general::SIGCONT as _;
227pub(crate) const SIGSTOP: c_int = linux_raw_sys::general::SIGSTOP as _;
228pub(crate) const SIGTSTP: c_int = linux_raw_sys::general::SIGTSTP as _;
229pub(crate) const SIGTTIN: c_int = linux_raw_sys::general::SIGTTIN as _;
230pub(crate) const SIGTTOU: c_int = linux_raw_sys::general::SIGTTOU as _;
231pub(crate) const SIGURG: c_int = linux_raw_sys::general::SIGURG as _;
232pub(crate) const SIGXCPU: c_int = linux_raw_sys::general::SIGXCPU as _;
233pub(crate) const SIGXFSZ: c_int = linux_raw_sys::general::SIGXFSZ as _;
234pub(crate) const SIGVTALRM: c_int = linux_raw_sys::general::SIGVTALRM as _;
235pub(crate) const SIGPROF: c_int = linux_raw_sys::general::SIGPROF as _;
236pub(crate) const SIGWINCH: c_int = linux_raw_sys::general::SIGWINCH as _;
237pub(crate) const SIGIO: c_int = linux_raw_sys::general::SIGIO as _;
238pub(crate) const SIGPWR: c_int = linux_raw_sys::general::SIGPWR as _;
239pub(crate) const SIGSYS: c_int = linux_raw_sys::general::SIGSYS as _;
240#[cfg(any(
241    target_arch = "mips",
242    target_arch = "mips32r6",
243    target_arch = "mips64",
244    target_arch = "mips64r6",
245    target_arch = "sparc",
246    target_arch = "sparc64"
247))]
248pub(crate) const SIGEMT: c_int = linux_raw_sys::general::SIGEMT as _;
249
250#[cfg(feature = "stdio")]
251pub(crate) const STDIN_FILENO: c_int = linux_raw_sys::general::STDIN_FILENO as _;
252#[cfg(feature = "stdio")]
253pub(crate) const STDOUT_FILENO: c_int = linux_raw_sys::general::STDOUT_FILENO as _;
254#[cfg(feature = "stdio")]
255pub(crate) const STDERR_FILENO: c_int = linux_raw_sys::general::STDERR_FILENO as _;
256
257pub(crate) const PIPE_BUF: usize = linux_raw_sys::general::PIPE_BUF as _;
258
259pub(crate) const CLOCK_MONOTONIC: c_int = linux_raw_sys::general::CLOCK_MONOTONIC as _;
260pub(crate) const CLOCK_REALTIME: c_int = linux_raw_sys::general::CLOCK_REALTIME as _;
261pub(crate) const CLOCK_MONOTONIC_RAW: c_int = linux_raw_sys::general::CLOCK_MONOTONIC_RAW as _;
262pub(crate) const CLOCK_MONOTONIC_COARSE: c_int =
263    linux_raw_sys::general::CLOCK_MONOTONIC_COARSE as _;
264pub(crate) const CLOCK_REALTIME_COARSE: c_int = linux_raw_sys::general::CLOCK_REALTIME_COARSE as _;
265pub(crate) const CLOCK_THREAD_CPUTIME_ID: c_int =
266    linux_raw_sys::general::CLOCK_THREAD_CPUTIME_ID as _;
267pub(crate) const CLOCK_PROCESS_CPUTIME_ID: c_int =
268    linux_raw_sys::general::CLOCK_PROCESS_CPUTIME_ID as _;
269
270#[cfg(feature = "system")]
271mod reboot_symbols {
272    use super::c_int;
273
274    pub(crate) const LINUX_REBOOT_MAGIC1: c_int = linux_raw_sys::general::LINUX_REBOOT_MAGIC1 as _;
275    pub(crate) const LINUX_REBOOT_MAGIC2: c_int = linux_raw_sys::general::LINUX_REBOOT_MAGIC2 as _;
276
277    pub(crate) const LINUX_REBOOT_CMD_RESTART: c_int =
278        linux_raw_sys::general::LINUX_REBOOT_CMD_RESTART as _;
279    pub(crate) const LINUX_REBOOT_CMD_HALT: c_int =
280        linux_raw_sys::general::LINUX_REBOOT_CMD_HALT as _;
281    pub(crate) const LINUX_REBOOT_CMD_CAD_ON: c_int =
282        linux_raw_sys::general::LINUX_REBOOT_CMD_CAD_ON as _;
283    pub(crate) const LINUX_REBOOT_CMD_CAD_OFF: c_int =
284        linux_raw_sys::general::LINUX_REBOOT_CMD_CAD_OFF as _;
285    pub(crate) const LINUX_REBOOT_CMD_POWER_OFF: c_int =
286        linux_raw_sys::general::LINUX_REBOOT_CMD_POWER_OFF as _;
287    pub(crate) const LINUX_REBOOT_CMD_SW_SUSPEND: c_int =
288        linux_raw_sys::general::LINUX_REBOOT_CMD_SW_SUSPEND as _;
289    pub(crate) const LINUX_REBOOT_CMD_KEXEC: c_int =
290        linux_raw_sys::general::LINUX_REBOOT_CMD_KEXEC as _;
291}
292#[cfg(feature = "system")]
293pub(crate) use reboot_symbols::*;