rusl 0.5.0

Rust linux interface layer
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

use core::mem::MaybeUninit;
use sc::syscall;

use crate::platform::{
    AddressFamily, Fd, SocketAddressInet, SocketAddressUnix, SocketArgUnix, SocketOptions,
};
use crate::Result;

/// Create a socket with the specified `Domain`, `SocketType`, and `protocol`
/// See [linux docs for details](https://man7.org/linux/man-pages/man2/socket.2.html)
/// # Errors
/// See above
#[inline]
pub fn socket(domain: AddressFamily, options: SocketOptions, protocol: i32) -> Result<Fd> {
    let res = unsafe { syscall!(SOCKET, domain.0, options.0, protocol) };
    Fd::coerce_from_register(res, "`SOCKET` syscall failed")
}

/// Get the socket name of the provided Unix socket [`Fd`].
/// See [Linux docs for details](https://man7.org/linux/man-pages/man2/getsockname.2.html)
/// # Errors
/// See above
pub fn get_unix_sock_name(sock_fd: Fd) -> Result<SocketArgUnix> {
    let mut addr = MaybeUninit::zeroed();
    let mut addr_len = core::mem::size_of::<SocketAddressUnix>();
    let res = unsafe {
        syscall!(
            GETSOCKNAME,
            sock_fd.into_usize(),
            core::ptr::addr_of_mut!(addr),
            core::ptr::addr_of_mut!(addr_len)
        )
    };
    bail_on_below_zero!(res, "`GETSOCKNAME` syscall failed");
    unsafe {
        Ok(SocketArgUnix {
            addr: addr.assume_init(),
            addr_len,
        })
    }
}

/// Get the socket name of the provided Inet socket [`Fd`].
/// See [Linux docs for details](https://man7.org/linux/man-pages/man2/getsockname.2.html)
/// # Errors
/// See above
pub fn get_inet_sock_name(sock_fd: Fd) -> Result<SocketAddressInet> {
    let mut addr = MaybeUninit::zeroed();
    let mut addr_len = core::mem::size_of::<SocketAddressInet>();
    let res = unsafe {
        syscall!(
            GETSOCKNAME,
            sock_fd.into_usize(),
            core::ptr::addr_of_mut!(addr),
            core::ptr::addr_of_mut!(addr_len)
        )
    };
    bail_on_below_zero!(res, "`GETSOCKNAME` syscall failed");
    unsafe { Ok(addr.assume_init()) }
}

/// Send a message on a socket, [`crate::unistd::write`] should be prefered if not sending fds.
/// See [linux docs for details](https://man7.org/linux/man-pages/man2/send.2.html)
/// # Errors
/// See above
#[cfg(feature = "alloc")]
pub fn sendmsg(sock_fd: Fd, send: &crate::platform::SendDropGuard, flags: i32) -> Result<usize> {
    let res = unsafe { syscall!(SENDMSG, sock_fd.0, core::ptr::addr_of!(send.msghdr), flags) };
    bail_on_below_zero!(res, "`SENDMSG` syscall failed");
    Ok(res)
}

/// Read a message from a socket, [`crate::unistd::read`] should be prefered if not expecting to receive fds.
/// See [linux docs for details](https://man7.org/linux/man-pages/man2/recv.2.html)
/// # Errors
/// See above
#[cfg(feature = "alloc")]
pub fn recvmsg(sock_fd: Fd, recv: &mut crate::platform::MsgHdrBorrow, flags: i32) -> Result<usize> {
    let res = unsafe {
        syscall!(
            RECVMSG,
            sock_fd.0,
            core::ptr::from_mut::<crate::platform::MsgHdrBorrow>(recv),
            flags
        )
    };
    bail_on_below_zero!(res, "`RECVMSG` syscall failed");
    Ok(res)
}