rawsys-linux 1.0.1

Direct Linux kernel syscalls in Rust — no libc required, per-ISA and multi-version aware.
Documentation 
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
161
162

//! Macros: ergonomic syscall invocation helpers
//!
//! - `syscall!`: returns `Result<SyscallWord, Errno>` and is suitable for
//!   general use.
//! - `raw_syscall!`: returns the raw machine word for cases where the call is
//!   guaranteed to succeed and you do not want `Errno` conversion.
//! - `syscall_args!`: builds a `SyscallArgs` value from up to 6 expressions.
//!
//! Safety
//! - All macros expand to `unsafe` calls because invoking a syscall is unsafe.
//!   You are responsible for pointer validity, buffer sizes, and respecting the
//!   kernel ABI for the selected architecture.
//!
//! Example
//! ```no_run
//! use rawsys_linux::{Sysno, syscall};
//!
//! match unsafe { syscall!(Sysno::getpid) } {
//!     Ok(pid) => println!("pid={pid}"),
//!     Err(err) => eprintln!("getpid failed: {err}"),
//! }
//! ```
/// Performs a syscall and returns a `Result<SyscallWord, Errno>`.
///
/// Accepts a syscall number and a variable number of arguments (0 to 6).
#[macro_export]
macro_rules! syscall {
    ($nr:expr) => {
        $crate::syscall0($nr)
    };

    ($nr:expr, $a1:expr) => {
        $crate::syscall1($nr, $a1 as $crate::SyscallWord)
    };

    ($nr:expr, $a1:expr, $a2:expr) => {
        $crate::syscall2(
            $nr,
            $a1 as $crate::SyscallWord,
            $a2 as $crate::SyscallWord,
        )
    };

    ($nr:expr, $a1:expr, $a2:expr, $a3:expr) => {
        $crate::syscall3(
            $nr,
            $a1 as $crate::SyscallWord,
            $a2 as $crate::SyscallWord,
            $a3 as $crate::SyscallWord,
        )
    };

    ($nr:expr, $a1:expr, $a2:expr, $a3:expr, $a4:expr) => {
        $crate::syscall4(
            $nr,
            $a1 as $crate::SyscallWord,
            $a2 as $crate::SyscallWord,
            $a3 as $crate::SyscallWord,
            $a4 as $crate::SyscallWord,
        )
    };

    ($nr:expr, $a1:expr, $a2:expr, $a3:expr, $a4:expr, $a5:expr) => {
        $crate::syscall5(
            $nr,
            $a1 as $crate::SyscallWord,
            $a2 as $crate::SyscallWord,
            $a3 as $crate::SyscallWord,
            $a4 as $crate::SyscallWord,
            $a5 as $crate::SyscallWord,
        )
    };

    ($nr:expr, $a1:expr, $a2:expr, $a3:expr, $a4:expr, $a5:expr, $a6:expr) => {
        $crate::syscall6(
            $nr,
            $a1 as $crate::SyscallWord,
            $a2 as $crate::SyscallWord,
            $a3 as $crate::SyscallWord,
            $a4 as $crate::SyscallWord,
            $a5 as $crate::SyscallWord,
            $a6 as $crate::SyscallWord,
        )
    };
}

/// Performs a raw syscall and returns a `SyscallWord`.
///
/// Prefer [`syscall!`] unless you are certain the syscall cannot fail (e.g.,
/// `gettid`).
///
/// Accepts a syscall number and a variable number of arguments (0 to 6).
///
/// # Example
/// ```no_run
/// use rawsys_linux::{Sysno, raw_syscall};
/// let tid = unsafe { raw_syscall!(Sysno::gettid) };
/// println!("tid={tid}");
/// ```
#[macro_export]
macro_rules! raw_syscall {
    ($nr:expr) => {
        $crate::raw::syscall0($nr as $crate::SyscallWord)
    };

    ($nr:expr, $a1:expr) => {
        $crate::raw::syscall1(
            $nr as $crate::SyscallWord,
            $a1 as $crate::SyscallWord,
        )
    };

    ($nr:expr, $a1:expr, $a2:expr) => {
        $crate::raw::syscall2(
            $nr as $crate::SyscallWord,
            $a1 as $crate::SyscallWord,
            $a2 as $crate::SyscallWord,
        )
    };

    ($nr:expr, $a1:expr, $a2:expr, $a3:expr) => {
        $crate::raw::syscall3(
            $nr as $crate::SyscallWord,
            $a1 as $crate::SyscallWord,
            $a2 as $crate::SyscallWord,
            $a3 as $crate::SyscallWord,
        )
    };

    ($nr:expr, $a1:expr, $a2:expr, $a3:expr, $a4:expr) => {
        $crate::raw::syscall4(
            $nr as $crate::SyscallWord,
            $a1 as $crate::SyscallWord,
            $a2 as $crate::SyscallWord,
            $a3 as $crate::SyscallWord,
            $a4 as $crate::SyscallWord,
        )
    };

    ($nr:expr, $a1:expr, $a2:expr, $a3:expr, $a4:expr, $a5:expr) => {
        $crate::raw::syscall5(
            $nr as $crate::SyscallWord,
            $a1 as $crate::SyscallWord,
            $a2 as $crate::SyscallWord,
            $a3 as $crate::SyscallWord,
            $a4 as $crate::SyscallWord,
            $a5 as $crate::SyscallWord,
        )
    };

    ($nr:expr, $a1:expr, $a2:expr, $a3:expr, $a4:expr, $a5:expr, $a6:expr) => {
        $crate::raw::syscall6(
            $nr as $crate::SyscallWord,
            $a1 as $crate::SyscallWord,
            $a2 as $crate::SyscallWord,
            $a3 as $crate::SyscallWord,
            $a4 as $crate::SyscallWord,
            $a5 as $crate::SyscallWord,
            $a6 as $crate::SyscallWord,
        )
    };
}