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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
//! Uname and other system-level functions.
//!
//! # Safety
//!
//! This function converts from `struct utsname` fields provided from the
//! kernel into `&str` references, which assumes that they're NUL-terminated.
#![allow(unsafe_code)]
use crate::backend;
#[cfg(target_os = "linux")]
use crate::backend::c;
use crate::ffi::CStr;
#[cfg(not(any(target_os = "espidf", target_os = "emscripten", target_os = "vita")))]
use crate::io;
use core::fmt;
#[cfg(linux_kernel)]
pub use backend::system::types::Sysinfo;
/// `uname()`—Returns high-level information about the runtime OS and
/// hardware.
///
/// For `gethostname()`, use [`Uname::nodename`] on the result.
///
/// # References
/// - [POSIX]
/// - [Linux]
/// - [Apple]
/// - [NetBSD]
/// - [FreeBSD]
/// - [OpenBSD]
/// - [DragonFly BSD]
/// - [illumos]
/// - [glibc]
///
/// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/uname.html
/// [Linux]: https://man7.org/linux/man-pages/man2/uname.2.html
/// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/uname.3.html
/// [NetBSD]: https://man.netbsd.org/uname.3
/// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=uname&sektion=3
/// [OpenBSD]: https://man.openbsd.org/uname.3
/// [DragonFly BSD]: https://man.dragonflybsd.org/?command=uname§ion=3
/// [illumos]: https://illumos.org/man/2/uname
/// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Platform-Type.html
#[doc(alias = "gethostname")]
#[inline]
pub fn uname() -> Uname {
Uname(backend::system::syscalls::uname())
}
/// `struct utsname`—Return type for [`uname`].
#[doc(alias = "utsname")]
pub struct Uname(backend::system::types::RawUname);
impl Uname {
/// `sysname`—Operating system release name
#[inline]
pub fn sysname(&self) -> &CStr {
Self::to_cstr(self.0.sysname.as_ptr().cast())
}
/// `nodename`—Name with vague meaning
///
/// This is intended to be a network name, however it's unable to convey
/// information about hosts that have multiple names, or any information
/// about where the names are visible.
///
/// This corresponds to the `gethostname` value.
#[inline]
pub fn nodename(&self) -> &CStr {
Self::to_cstr(self.0.nodename.as_ptr().cast())
}
/// `release`—Operating system release version string
#[inline]
pub fn release(&self) -> &CStr {
Self::to_cstr(self.0.release.as_ptr().cast())
}
/// `version`—Operating system build identifiers
#[inline]
pub fn version(&self) -> &CStr {
Self::to_cstr(self.0.version.as_ptr().cast())
}
/// `machine`—Hardware architecture identifier
#[inline]
pub fn machine(&self) -> &CStr {
Self::to_cstr(self.0.machine.as_ptr().cast())
}
/// `domainname`—NIS or YP domain identifier
#[cfg(linux_kernel)]
#[inline]
pub fn domainname(&self) -> &CStr {
Self::to_cstr(self.0.domainname.as_ptr().cast())
}
#[inline]
fn to_cstr<'a>(ptr: *const u8) -> &'a CStr {
// SAFETY: Strings returned from the kernel are always NUL-terminated.
unsafe { CStr::from_ptr(ptr.cast()) }
}
}
impl fmt::Debug for Uname {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
#[cfg(not(linux_kernel))]
{
write!(
fmt,
"{:?} {:?} {:?} {:?} {:?}",
self.sysname(),
self.nodename(),
self.release(),
self.version(),
self.machine(),
)
}
#[cfg(linux_kernel)]
{
write!(
fmt,
"{:?} {:?} {:?} {:?} {:?} {:?}",
self.sysname(),
self.nodename(),
self.release(),
self.version(),
self.machine(),
self.domainname(),
)
}
}
}
/// `sysinfo()`—Returns status information about the runtime OS.
///
/// # References
/// - [Linux]
///
/// [Linux]: https://man7.org/linux/man-pages/man2/uname.2.html
#[cfg(linux_kernel)]
#[inline]
pub fn sysinfo() -> Sysinfo {
backend::system::syscalls::sysinfo()
}
/// `sethostname(name)`—Sets the system host name.
///
/// # References
/// - [Linux]
///
/// [Linux]: https://man7.org/linux/man-pages/man2/sethostname.2.html
#[cfg(not(any(
target_os = "emscripten",
target_os = "espidf",
target_os = "redox",
target_os = "vita",
target_os = "wasi"
)))]
#[inline]
pub fn sethostname(name: &[u8]) -> io::Result<()> {
backend::system::syscalls::sethostname(name)
}
/// Reboot command for use with [`reboot`].
#[cfg(target_os = "linux")]
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[repr(i32)]
#[non_exhaustive]
pub enum RebootCommand {
/// Disables the Ctrl-Alt-Del keystroke.
///
/// When disabled, the keystroke will send a [`Signal::Int`] to pid 1.
///
/// [`Signal::Int`]: crate::process::Signal::Int
CadOff = c::LINUX_REBOOT_CMD_CAD_OFF,
/// Enables the Ctrl-Alt-Del keystroke.
///
/// When enabled, the keystroke will trigger a [`Restart`].
///
/// [`Restart`]: Self::Restart
CadOn = c::LINUX_REBOOT_CMD_CAD_ON,
/// Prints the message "System halted" and halts the system
Halt = c::LINUX_REBOOT_CMD_HALT,
/// Execute a kernel that has been loaded earlier with [`kexec_load`].
///
/// [`kexec_load`]: https://man7.org/linux/man-pages/man2/kexec_load.2.html
Kexec = c::LINUX_REBOOT_CMD_KEXEC,
/// Prints the message "Power down.", stops the system, and tries to remove
/// all power
PowerOff = c::LINUX_REBOOT_CMD_POWER_OFF,
/// Prints the message "Restarting system." and triggers a restart
Restart = c::LINUX_REBOOT_CMD_RESTART,
/// Hibernate the system by suspending to disk
SwSuspend = c::LINUX_REBOOT_CMD_SW_SUSPEND,
}
/// `reboot`—Reboot the system or enable/disable Ctrl-Alt-Del
///
/// The reboot syscall, despite the name, can actually do much more than
/// reboot.
///
/// Among other things, it can:
/// - Restart, Halt, Power Off, and Suspend the system
/// - Enable and disable the Ctrl-Alt-Del keystroke
/// - Execute other kernels
/// - Terminate init inside PID namespaces
///
/// It is highly recommended to carefully read the kernel documentation before
/// calling this function.
///
/// # References
/// - [Linux]
///
/// [Linux]: https://man7.org/linux/man-pages/man2/reboot.2.html
#[cfg(target_os = "linux")]
pub fn reboot(cmd: RebootCommand) -> io::Result<()> {
backend::system::syscalls::reboot(cmd)
}
|