Crate nc

source ·
Expand description

Execute system call directly without std or libc.

§Usage

Add this to Cargo.toml:

[dependencies]
nc = "0.8"

§Examples

Get file stat:

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:

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:

let ret = unsafe { nc::kill(1, nc::SIGTERM) };
assert_eq!(ret, Err(nc::EPERM));

Or get system info:

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

Re-exports§

Modules§

Constants§

Functions§

  • accept⚠
    Accept a connection on a socket.
  • accept_nocancel⚠
    Accept a connection on a socket.
  • access⚠
    Check user’s permission for a file.
  • acct⚠
    Switch process accounting.
  • adjtime⚠
    Correct the time to allow synchronization of the system clock.
  • aio_cancel⚠
    Cancel an outstanding asynchronous I/O operation (REALTIME)
  • aio_error⚠
    Retrieve error status of asynchronous I/O operation
  • aio_fsync⚠
    Asynchronous file synchronization (REALTIME)
  • aio_read⚠
    Asynchronous read from a file (REALTIME)
  • aio_return⚠
    Retrieve return status of asynchronous I/O operation (REALTIME)
  • aio_suspend⚠
    Suspend until asynchronous I/O operations or timeout complete (REALTIME)
  • aio_write⚠
    Asynchronous write to a file (REALTIME)
  • audit⚠
    Commit BSM audit record to audit log
  • auditctl⚠
    Configure system audit parameters
  • auditon⚠
    Configure system audit parameters
  • bind⚠
    Bind a name to a socket.
  • chdir⚠
    Change working directory.
  • chflags⚠
    Set file flags.
  • chmod⚠
    Change permissions of a file.
  • chmod_extended⚠
    Change permissions of a file.
  • chown⚠
    Change ownership of a file.
  • chroot⚠
    Change the root directory.
  • close⚠
    Close a file descriptor.
  • close_nocancel⚠
    Close a file descriptor.
  • connect⚠
    Initialize a connection on a socket.
  • connect_nocancel⚠
    Initialize a connection on a socket.
  • copyfile⚠
    Copy a file.
  • delete⚠
  • dup⚠
    Create a copy of the file descriptor oldfd, using the lowest available file descriptor.
  • dup2⚠
    Create a copy of the file descriptor oldfd, using the speficified file descriptor newfd.
  • execve⚠
    Execute a new program.
  • exit⚠
    Terminate current process.
  • faccessat⚠
    Check user’s permission for a file.
  • fchdir⚠
    Change working directory.
  • fchflags⚠
    Set file flags.
  • fchmod⚠
    Change permissions of a file.
  • fchmodat⚠
    Change permissions of a file.
  • fchown⚠
    Change ownership of a file.
  • fchownat⚠
    Change ownership of a file.
  • fcntl⚠
    manipulate file descriptor.
  • fdatasync⚠
    Flush all modified in-core data (exclude metadata) refered by fd to disk.
  • fgetxattr⚠
    Get extended attribute value.
  • fhopen⚠
    Opens the file referenced by fh for reading and/or writing, and returns the file descriptor to the calling process.
  • flistxattr⚠
    List extended attribute names.
  • flock⚠
    Apply or remove an advisory lock on an open file.
  • fmount⚠
    Mount filesystem.
  • fork⚠
    Create a child process.
  • fpathconf⚠
    Get configurable pathname variables
  • fremovexattr⚠
    Remove an extended attribute.
  • fsetxattr⚠
    Set extended attribute value.
  • fstat⚠
    Get file status about a file descriptor.
  • fstat64⚠
    Get file status.
  • fstatat⚠
    Get file status.
  • fstatat64⚠
    Get file status.
  • fstatfs⚠
    Get filesystem statistics.
  • fstatfs64⚠
    Get filesystem statistics.
  • fsync⚠
    Flush all modified in-core data refered by fd to disk.
  • fsync_nocancel⚠
    Flush all modified in-core data refered by fd to disk.
  • ftruncate⚠
    Truncate an opened file to a specified length.
  • futimes⚠
    Change timestamp of a file.
  • getaudit_addr⚠
    Retrieve audit session state
  • getauid⚠
    Retrieve audit session ID
  • getdirentries⚠
    Get directory entries in a file system independent format
  • getdtablesize⚠
    Get file descriptor limit
  • getegid⚠
    Get the effective group ID of the calling process.
  • geteuid⚠
    Get the effective user ID of the calling process.
  • getfh⚠
    Get file handle.
  • getfsstat⚠
    Get list of all mounted file systems.
  • getgid⚠
    Get the real group ID of the calling process.
  • getgroups⚠
    Get list of supplementary group Ids.
  • getitimer⚠
    Get value of an interval timer.
  • getlogin⚠
    Get login name.
  • getpeername⚠
    Get name of connected peer socket.
  • getpgid⚠
    Returns the PGID(process group ID) of the process specified by pid.
  • getpgrp⚠
    Get the process group ID of the calling process.
  • getpid⚠
    Get the process ID (PID) of the calling process.
  • getppid⚠
    Get the process ID of the parent of the calling process.
  • getpriority⚠
    Get program scheduling priority.
  • getrlimit⚠
    Get resource limit.
  • getrusage⚠
    Get resource usage.
  • getsid⚠
    Get session Id.
  • getsockname⚠
    Get current address to which the socket sockfd is bound.
  • getsockopt⚠
    Get options on sockets
  • gettid⚠
    Get the caller’s thread ID (TID).
  • gettimeofday⚠
    Get time.
  • getuid⚠
    Get the real user ID of the calling process.
  • getxattr⚠
    Get extended attribute value.
  • ioctl⚠
    Control device.
  • issetugid⚠
    Is current process tainted by uid or gid changes
  • kill⚠
    Send signal to a process.
  • kqueue⚠
    Creates a new kernel event queue and returns a descriptor.
  • lchown⚠
    Change ownership of a file. Does not deference symbolic link.
  • link⚠
    Make a new name for a file.
  • linkat⚠
    Make a new name for a file.
  • lio_listio⚠
    List directed I/O (REALTIME)
  • listen⚠
    Listen for connections on a socket.
  • listxattr⚠
    List extended attribute names.
  • lseek⚠
    Reposition file offset.
  • lstat⚠
    Get file status about a file, without following symbolic.
  • lstat64⚠
    Get file status about a file, without following symbolic.
  • madvise⚠
    Give advice about use of memory.
  • mincore⚠
    mincore() returns the memory residency status of the pages in the current process’s address space specified by [addr, addr + len). The status is returned in a vector of bytes. The least significant bit of each byte is 1 if the referenced page is in memory, otherwise it is zero.
  • minherit⚠
    Control the inheritance of pages
  • mkdir⚠
    Create a directory.
  • mkdirat⚠
    Create a directory.
  • mkfifo⚠
    Create a fifo file.
  • mknod⚠
    Create a special or ordinary file.
  • mlock⚠
    Lock memory.
  • mlockall⚠
    Lock memory.
  • mmap⚠
    Map files or devices into memory.
  • mount⚠
    Mount filesystem.
  • mprotect⚠
    Set protection on a region of memory.
  • msgctl⚠
    System V message control operations.
  • msgget⚠
    Get a System V message queue identifier.
  • msgrcv⚠
    Receive messages from a System V message queue.
  • msgsnd⚠
    Append the message to a System V message queue.
  • msgsys⚠
  • msync⚠
    Synchronize a file with memory map.
  • munlock⚠
    Unlock memory.
  • munlockall⚠
    Unlock memory.
  • munmap⚠
    Unmap files or devices from memory.
  • nfssvc⚠
    Used by the NFS daemons to pass information into and out of the kernel and also to enter the kernel as a server daemon.
  • ntp_adjtime⚠
    Used by the NTP daemon to adjust the system clock to an externally derived time.
  • ntp_gettime⚠
    Provides the time, maximum error (sync distance) and estimated error (dispersion) to client user application programs.
  • open⚠
    Open and possibly create a file.
  • openat⚠
    Open and possibly create a file within a directory.
  • openat_nocancel⚠
    Open and possibly create a file within a directory.
  • pathconf⚠
    Get configurable pathname variables
  • pid_hibernate⚠
    Freeze the specified process (provided in args->pid), or find and freeze a PID.
  • pid_resume⚠
  • pid_shutdown_sockets⚠
  • pid_suspend⚠
  • pipe⚠
    Create a pipe.
  • pivot_root⚠
    Change the root filesystem.
  • poll⚠
    Wait for some event on file descriptors.
  • pread⚠
    Read from a file descriptor without changing file offset.
  • preadv⚠
    Read from a file descriptor without changing file offset.
  • ptrace⚠
    Process trace.
  • pwrite⚠
    Write to a file descriptor without changing file offset.
  • pwritev⚠
    Write to a file descriptor without changing file offset.
  • quotactl⚠
    Manipulate disk quotes.
  • read⚠
    Read from a file descriptor.
  • readlink⚠
    Read value of a symbolic link.
  • readlinkat⚠
    Read value of a symbolic link.
  • readv⚠
    Read from a file descriptor into multiple buffers.
  • reboot⚠
    Reboot or enable/disable Ctrl-Alt-Del.
  • recvfrom⚠
    Receive a message from a socket.
  • recvmsg⚠
    Receive a msg from a socket.
  • removexattr⚠
    Remove an extended attribute.
  • rename⚠
    Change name or location of a file.
  • renameat⚠
    Change name or location of a file.
  • revoke⚠
    Revoke file access
  • rmdir⚠
    Delete a directory.
  • select⚠
    Sychronous I/O multiplexing.
  • select_nocancel⚠
    Sychronous I/O multiplexing.
  • sem_close⚠
    Close an semaphore.
  • sem_open⚠
    Creates or opens the named semaphore specified by name.
  • sem_post⚠
    Increment (unlock) a semaphore.
  • sem_trywait⚠
    Decrement (lock) a semaphore.
  • sem_unlink⚠
    Remove an semaphore.
  • sem_wait⚠
    Decrement (lock) a semaphore.
  • sem_wait_nocancel⚠
    Decrement (lock) a semaphore.
  • semctl⚠
    System V semaphore control operations
  • semget⚠
    Get a System V semphore set identifier.
  • semop⚠
    System V semphore operations.
  • semsys⚠
  • sendfile⚠
    Transfer data between two file descriptors.
  • sendmsg⚠
    Send a message on a socket. Allow sending ancillary data.
  • sendmsg_nocancel⚠
    Send a message on a socket. Allow sending ancillary data.
  • sendto⚠
    Send a message on a socket.
  • sendto_nocancel⚠
    Send a message on a socket.
  • setaudit_addr⚠
    Set audit session state
  • setauid⚠
    Set audit session ID
  • setegid⚠
    Set the effective group ID of the calling process to gid.
  • seteuid⚠
    Set the effective user ID of the calling process to uid.
  • setgid⚠
    Set the group ID of the calling process to gid.
  • setgroups⚠
    Set list of supplementary group Ids.
  • setitimer⚠
    Set value of an interval timer.
  • setlogin⚠
    Set login name.
  • setpgid⚠
    Set the process group ID (PGID) of the process specified by pid to pgid.
  • setpriority⚠
    Set program scheduling priority.
  • setregid⚠
    Set real and effective group IDs of the calling process.
  • setreuid⚠
    Set real and effective user IDs of the calling process.
  • setrlimit⚠
    Set resource limit.
  • setsid⚠
    Create a new session if the calling process is not a process group leader.
  • setsockopt⚠
    Set options on sockets.
  • settid⚠
    Set the per-thread override identity.
  • settid_with_pid⚠
    Set the per-thread override identity.
  • settimeofday⚠
    Set system time and timezone.
  • setuid⚠
    Set user ID of the calling process to uid.
  • setxattr⚠
    Set extended attribute value.
  • shm_open⚠
    Opens (or optionally creates) a POSIX shared memory object named path.
  • shm_unlink⚠
    Removes a shared memory object named path.
  • shmat⚠
    Attach the System V shared memory segment.
  • shmctl⚠
    System V shared memory control.
  • shmdt⚠
    Detach the System V shared memory segment.
  • shmget⚠
    Allocates a System V shared memory segment.
  • shmsys⚠
  • shutdown⚠
    Shutdown part of a full-duplex connection.
  • sigaction⚠
    Examine and change a signal action.
  • sigaltstack⚠
    Get/set signal stack context.
  • sigpending⚠
    Examine pending signals.
  • sigprocmask⚠
    Examine and change blocked signals.
  • sigreturn⚠
    Return from signal handler and cleanup stack frame. Never returns.
  • sigsuspend⚠
    Wait for a signal.
  • socket⚠
    Create an endpoint for communication.
  • socketpair⚠
    Create a pair of connected socket.
  • stat⚠
    Get file status about a file.
  • stat64⚠
    Get file status about a file.
  • statfs⚠
    Get filesystem statistics.
  • statfs64⚠
    Get filesystem statistics.
  • strerror
    Get errno description.
  • swapon⚠
    Start swapping to file/device.
  • symlink⚠
    Make a new name for a file.
  • symlinkat⚠
    Make a new name for a file.
  • sync⚠
    Commit filesystem caches to disk.
  • truncate⚠
    Truncate a file to a specified length.
  • umask⚠
    Set file mode creation mask.
  • undelete⚠
    Attempt to recover a deleted file
  • unlink⚠
    Delete a name and possibly the file it refers to.
  • unlinkat⚠
    Delete a name and possibly the file it refers to.
  • unmount⚠
    Unmount filesystem.
  • utimes⚠
    Change file last access and modification time.
  • vfork⚠
    Create a child process and wait until it is terminated.
  • wait4⚠
    Wait for process to change state.
  • waitid⚠
    Wait for process to change state.
  • write⚠
    Write to a file descriptor.
  • writev⚠
    Write to a file descriptor from multiple buffers.