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 221 222 223
// Copyright (c) 2020 Xu Shaohua <shaohua@biofan.org>. All rights reserved.
// Use of this source is governed by Apache-2.0 License that can be found
// in the LICENSE file.
//! Execute system call directly without `std` or `libc`.
//!
//! - [Documentation](https://docs.rs/nc)
//! - [Release notes](https://github.com/xushaohua/nc/releases)
//!
//! ## Usage
//! Add this to `Cargo.toml`:
//! ```toml
//! [dependencies]
//! nc = "0.8"
//! ```
//!
//! ## Examples
//! Get file stat:
//! ```rust
//! let mut statbuf = nc::stat_t::default();
//! let path = "/etc/passwd";
//! #[cfg(not(target_arch = "aarch64"))]
//! let ret = unsafe { nc::stat(path, &mut statbuf) };
//! #[cfg(all(target_os = "linux", target_arch = "aarch64"))]
//! let ret = unsafe { nc::fstatat(nc::AT_FDCWD, path, &mut statbuf, 0) };
//! match ret {
//! Ok(_) => println!("s: {:?}", statbuf),
//! Err(errno) => eprintln!("Failed to get file status, got errno: {}", errno),
//! }
//! ```
//!
//! Fork process:
//! ```rust
//! let pid = unsafe { nc::fork() };
//! match pid {
//! Ok(pid) => {
//! if pid == 0 {
//! println!("child process: {}", pid);
//! let args = [""];
//! let env = [""];
//! match unsafe { nc::execve("/bin/ls", &args, &env) } {
//! Ok(_) => {},
//! Err(errno) => eprintln!("`ls` got err: {}", errno),
//! }
//! } else if pid < 0 {
//! eprintln!("fork() error!");
//! } else {
//! println!("parent process!");
//! }
//! },
//! Err(errno) => eprintln!("errno: {}", errno),
//! }
//! ```
//!
//! Kill init process:
//! ```rust
//! let ret = unsafe { nc::kill(1, nc::SIGTERM) };
//! assert_eq!(ret, Err(nc::EPERM));
//! ```
//!
//! Or get system info:
//! ```rust
//! pub fn cstr_to_str(input: &[u8]) -> &str {
//! let nul_index = input.iter().position(|&b| b == 0).unwrap_or(input.len());
//! std::str::from_utf8(&input[0..nul_index]).unwrap()
//! }
//!
//! fn main() {
//! let mut uts = nc::utsname_t::default();
//! let ret = unsafe { nc::uname(&mut uts) };
//! assert!(ret.is_ok());
//!
//! let mut result = Vec::new();
//!
//! result.push(cstr_to_str(&uts.sysname));
//! result.push(cstr_to_str(&uts.nodename));
//! result.push(cstr_to_str(&uts.release));
//! result.push(cstr_to_str(&uts.version));
//! result.push(cstr_to_str(&uts.machine));
//! let domain_name = cstr_to_str(&uts.domainname);
//! if domain_name != "(none)" {
//! result.push(domain_name);
//! }
//!
//! let result = result.join(" ");
//! println!("{}", result);
//! }
//! ```
//!
//! ## Stable version
//! For stable version of rustc, please install a C compiler (`gcc` or `clang`) first.
//! As `asm!` feature is unavailable in stable version.
//!
//! ## Supported Operating Systems and Architectures
//! - linux
//! - aarch64
//! - arm
//! - loongarch64
//! - mips
//! - mips64
//! - mips64el
//! - mipsel
//! - powerpc64
//! - riscv64
//! - s390x
//! - x86
//! - x86-64
//! - android
//! - aarch64
//! - freebsd
//! - x86-64
//! - netbsd
//! - x86-64
//! - mac os
//! - x86-64
//!
//! ## Related projects
//! * [nix][nix]
//! * [syscall][syscall]
//! * [relibc][relibc]
//!
//! [syscall]: https://github.com/kmcallister/syscall.rs
//! [relibc]: https://gitlab.redox-os.org/redox-os/relibc.git
//! [nix]: https://github.com/nix-rust/nix
#![deny(
warnings,
clippy::all,
clippy::cargo,
clippy::nursery,
clippy::pedantic
)]
#![allow(dead_code)]
#![allow(unknown_lints)]
#![cfg_attr(not(feature = "std"), no_std)]
#[macro_use]
extern crate alloc;
#[cfg(test)]
extern crate std;
pub mod c_str;
pub mod path;
pub mod syscalls;
pub use syscalls::Errno;
#[cfg(target_os = "macos")]
#[path = "platform/darwin-types/mod.rs"]
pub mod types;
#[cfg(target_os = "freebsd")]
#[path = "platform/freebsd-types/mod.rs"]
pub mod types;
#[cfg(any(target_os = "linux", target_os = "android"))]
#[path = "platform/linux-types/mod.rs"]
pub mod types;
#[cfg(target_os = "netbsd")]
#[path = "platform/netbsd-types/mod.rs"]
pub mod types;
#[cfg(all(
any(target_os = "linux", target_os = "android"),
target_arch = "aarch64"
))]
#[path = "platform/linux-aarch64/mod.rs"]
mod platform;
#[cfg(all(target_os = "linux", target_arch = "arm"))]
#[path = "platform/linux-arm/mod.rs"]
mod platform;
#[cfg(all(target_os = "linux", target_arch = "loongarch64"))]
#[path = "platform/linux-loongarch64/mod.rs"]
mod platform;
#[cfg(all(target_os = "linux", target_arch = "mips"))]
#[path = "platform/linux-mips/mod.rs"]
mod platform;
#[cfg(all(target_os = "linux", target_arch = "mips64"))]
#[path = "platform/linux-mips64/mod.rs"]
mod platform;
#[cfg(all(target_os = "linux", target_arch = "powerpc64"))]
#[path = "platform/linux-ppc64/mod.rs"]
mod platform;
#[cfg(all(target_os = "linux", target_arch = "riscv64"))]
#[path = "platform/linux-riscv64/mod.rs"]
mod platform;
#[cfg(all(target_os = "linux", target_arch = "s390x"))]
#[path = "platform/linux-s390x/mod.rs"]
mod platform;
#[cfg(all(target_os = "linux", target_arch = "x86"))]
#[path = "platform/linux-x86/mod.rs"]
mod platform;
#[cfg(all(target_os = "linux", target_arch = "x86_64"))]
#[path = "platform/linux-x86_64/mod.rs"]
mod platform;
#[cfg(all(target_os = "freebsd", target_arch = "x86_64"))]
#[path = "platform/freebsd-x86_64/mod.rs"]
mod platform;
#[cfg(all(target_os = "netbsd", target_arch = "x86_64"))]
#[path = "platform/netbsd-x86_64/mod.rs"]
mod platform;
#[cfg(all(target_os = "macos", target_arch = "x86_64"))]
#[path = "platform/darwin-x86_64/mod.rs"]
mod platform;
pub mod util;
// Re-export functions
pub use platform::*;
pub use types::*;