use std::fs::File;
use std::mem::size_of;
use std::os::unix::io::{AsRawFd, FromRawFd, RawFd};
use std::os::unix::net::{UnixDatagram, UnixStream};
use std::ptr;
#[cfg(target_os = "linux")]
use libc::MSG_NOSIGNAL;
use libc::{self, c_void, cmsghdr, iovec, msghdr, recvmsg, sendmsg, SCM_RIGHTS, SOL_SOCKET};
use crate::common::{SysError, SysResult};
macro_rules! CMSG_ALIGN {
($len:expr) => {
(($len) as usize + ::std::mem::size_of::<libc::c_long>() - 1)
& !(::std::mem::size_of::<libc::c_long>() - 1)
};
}
macro_rules! CMSG_SPACE {
($len:expr) => {
::std::mem::size_of::<cmsghdr>() + CMSG_ALIGN!($len)
};
}
macro_rules! FD_LENGTH {
($count:expr) => {
std::mem::size_of::<RawFd>() * $count
};
}
#[allow(non_snake_case)]
#[inline(always)]
fn CMSG_DATA(cmsg_buffer: *mut libc::cmsghdr) -> *mut RawFd {
cmsg_buffer.wrapping_offset(1) as *mut RawFd
}
#[cfg(not(target_env = "musl"))]
fn new_msghdr(iovecs: &mut [libc::iovec]) -> libc::msghdr {
libc::msghdr {
msg_name: ptr::null_mut(),
msg_namelen: 0,
msg_iov: iovecs.as_mut_ptr(),
msg_iovlen: iovecs.len() as _,
msg_control: ptr::null_mut(),
msg_controllen: 0,
msg_flags: 0,
}
}
#[cfg(target_env = "musl")]
fn new_msghdr(iovecs: &mut [iovec]) -> msghdr {
assert!(iovecs.len() <= (std::i32::MAX as usize));
let mut msg: msghdr = unsafe { std::mem::zeroed() };
msg.msg_name = ptr::null_mut();
msg.msg_iov = iovecs.as_mut_ptr();
msg.msg_iovlen = iovecs.len() as i32;
msg.msg_control = ptr::null_mut();
msg
}
#[cfg(not(target_env = "musl"))]
fn set_msg_controllen(msg: &mut msghdr, cmsg_capacity: usize) {
msg.msg_controllen = cmsg_capacity as _;
}
#[cfg(target_env = "musl")]
fn set_msg_controllen(msg: &mut msghdr, cmsg_capacity: usize) {
assert!(cmsg_capacity <= (std::u32::MAX as usize));
msg.msg_controllen = cmsg_capacity as u32;
}
const CMSG_BUFFER_INLINE_CAPACITY: usize = CMSG_SPACE!(size_of::<RawFd>() * 32);
impl CmsgBuffer {
fn with_capacity(capacity: usize) -> CmsgBuffer {
let cap_in_cmsghdr_units =
(capacity.checked_add(size_of::<cmsghdr>()).unwrap() - 1) / size_of::<cmsghdr>();
if capacity <= CMSG_BUFFER_INLINE_CAPACITY {
CmsgBuffer::Inline([0u64; (CMSG_BUFFER_INLINE_CAPACITY + 7) / 8])
} else {
CmsgBuffer::Heap(
vec![
cmsghdr {
cmsg_len: 0,
cmsg_level: 0,
cmsg_type: 0,
#[cfg(all(target_env = "musl", target_pointer_width = "64"))]
__pad1: 0,
};
cap_in_cmsghdr_units
]
.into_boxed_slice(),
)
}
}
fn as_mut_ptr(&mut self) -> *mut libc::cmsghdr {
match self {
CmsgBuffer::Inline(a) => a.as_mut_ptr() as *mut cmsghdr,
CmsgBuffer::Heap(a) => a.as_mut_ptr(),
}
}
}
enum CmsgBuffer {
Inline([u64; (CMSG_BUFFER_INLINE_CAPACITY + 7) / 8]),
Heap(Box<[cmsghdr]>),
}
fn raw_sendmsg<D: IntoIovec>(fd: RawFd, out_data: &[D], out_fds: &[RawFd]) -> SysResult<usize> {
unsafe {
let fd_len = FD_LENGTH!(out_fds.len());
let cmsg_capacity = libc::CMSG_SPACE(fd_len as _);
let mut cmsg_buffer = CmsgBuffer::with_capacity(cmsg_capacity as _);
let mut iovecs = Vec::with_capacity(out_data.len());
for data in out_data {
iovecs.push(iovec {
iov_base: data.as_ptr() as *mut c_void,
iov_len: data.size(),
});
}
let mut msghdr = new_msghdr(&mut iovecs);
if !out_fds.is_empty() {
let cmsg = libc::cmsghdr {
cmsg_len: libc::CMSG_LEN(fd_len as u32) as _,
cmsg_level: SOL_SOCKET,
cmsg_type: SCM_RIGHTS,
#[cfg(all(target_env = "musl", target_pointer_width = "64"))]
__pad1: 0,
};
ptr::write_unaligned(cmsg_buffer.as_mut_ptr(), cmsg);
ptr::copy_nonoverlapping(
out_fds.as_ptr(),
libc::CMSG_DATA(cmsg_buffer.as_mut_ptr()) as *mut _,
out_fds.len(),
);
msghdr.msg_control = cmsg_buffer.as_mut_ptr() as *mut _;
set_msg_controllen(&mut msghdr, cmsg_capacity as _);
}
#[cfg(target_os = "linux")]
let write_count = sendmsg(fd, &msghdr, MSG_NOSIGNAL);
#[cfg(target_os = "macos")]
let write_count = sendmsg(fd, &msghdr, 0);
if write_count == -1 {
Err(SysError::last())
} else {
Ok(write_count as usize)
}
}
}
unsafe fn raw_recvmsg(
fd: RawFd,
iovecs: &mut [iovec],
in_fds: &mut [RawFd],
) -> SysResult<(usize, usize)> {
let fd_length = FD_LENGTH!(in_fds.len());
let cmsg_capacity = libc::CMSG_SPACE(fd_length as _) as usize;
let mut cmsg_buffer = CmsgBuffer::with_capacity(cmsg_capacity);
let mut msg = new_msghdr(iovecs);
if !in_fds.is_empty() {
msg.msg_control = cmsg_buffer.as_mut_ptr() as *mut c_void;
set_msg_controllen(&mut msg, cmsg_capacity);
}
let total_read = recvmsg(fd, &mut msg, 0);
if total_read == -1 {
return Err(SysError::last());
}
if total_read == 0 && (msg.msg_controllen as usize) < size_of::<cmsghdr>() {
return Ok((0, 0));
}
let mut cmsg_ptr = msg.msg_control as *mut cmsghdr;
let mut copied_fds_count = 0;
let mut teardown_control_data = msg.msg_flags & libc::MSG_CTRUNC != 0;
while !cmsg_ptr.is_null() {
let cmsg = (cmsg_ptr as *mut cmsghdr).read_unaligned();
if cmsg.cmsg_level == SOL_SOCKET && cmsg.cmsg_type == SCM_RIGHTS {
let fds_count =
(cmsg.cmsg_len as usize - libc::CMSG_LEN(0) as usize) / size_of::<RawFd>();
let fds_to_be_copied_count = std::cmp::min(in_fds.len() - copied_fds_count, fds_count);
teardown_control_data |= fds_count > fds_to_be_copied_count;
if teardown_control_data {
for fd_offset in 0..fds_count {
let raw_fds_ptr = CMSG_DATA(cmsg_ptr);
let raw_fd = *(raw_fds_ptr.wrapping_add(fd_offset)) as libc::c_int;
libc::close(raw_fd);
}
} else {
ptr::copy_nonoverlapping(
CMSG_DATA(cmsg_ptr),
in_fds[copied_fds_count..(copied_fds_count + fds_to_be_copied_count)]
.as_mut_ptr(),
fds_to_be_copied_count,
);
copied_fds_count += fds_to_be_copied_count;
}
}
if teardown_control_data {
for fd in in_fds.iter().take(copied_fds_count) {
libc::close(*fd);
}
return Err(SysError::new(libc::ENOBUFS));
}
cmsg_ptr = libc::CMSG_NXTHDR(&msg, cmsg_ptr); }
Ok((total_read as usize, copied_fds_count))
}
impl ScmSocket for UnixDatagram {
fn socket_fd(&self) -> RawFd {
self.as_raw_fd()
}
}
impl ScmSocket for UnixStream {
fn socket_fd(&self) -> RawFd {
self.as_raw_fd()
}
}
pub unsafe trait IntoIovec {
fn as_ptr(&self) -> *const libc::c_void;
fn size(&self) -> usize;
}
unsafe impl<'a> IntoIovec for &'a [u8] {
#[cfg_attr(feature = "cargo-clippy", allow(clippy::useless_asref))]
fn as_ptr(&self) -> *const libc::c_void {
self.as_ref().as_ptr() as *const libc::c_void
}
fn size(&self) -> usize {
self.len()
}
}
pub trait ScmSocket {
fn socket_fd(&self) -> RawFd;
fn send_with_fd<D: IntoIovec>(&self, buf: D, fd: RawFd) -> SysResult<usize> {
self.send_with_fds(&[buf], &[fd])
}
fn send_with_fds<D: IntoIovec>(&self, bufs: &[D], fds: &[RawFd]) -> SysResult<usize> {
raw_sendmsg(self.socket_fd(), bufs, fds)
}
fn recv_with_fd(&self, buf: &mut [u8]) -> SysResult<(usize, Option<File>)> {
let mut fd = [0];
let mut iovecs = [libc::iovec {
iov_base: buf.as_mut_ptr() as *mut libc::c_void,
iov_len: buf.len(),
}];
let (read_count, fd_count) = unsafe { self.recv_with_fds(&mut iovecs[..], &mut fd)? };
let file = if fd_count == 0 {
None
} else {
Some(unsafe { File::from_raw_fd(fd[0]) })
};
Ok((read_count, file))
}
unsafe fn recv_with_fds(
&self,
iovecs: &mut [libc::iovec],
fds: &mut [RawFd],
) -> SysResult<(usize, usize)> {
raw_recvmsg(self.socket_fd(), iovecs, fds)
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::io::{Read, Seek, SeekFrom, Write};
use std::mem::size_of;
use std::os::raw::c_long;
use std::os::unix::net::UnixDatagram;
use libc::cmsghdr;
use vmm_sys_util::tempfile::TempFile;
#[test]
fn buffer_len() {
assert_eq!(CMSG_SPACE!(0), size_of::<cmsghdr>());
assert_eq!(
CMSG_SPACE!(size_of::<RawFd>()),
size_of::<cmsghdr>() + size_of::<c_long>()
);
if size_of::<RawFd>() == 4 {
assert_eq!(
CMSG_SPACE!(2 * size_of::<RawFd>()),
size_of::<cmsghdr>() + size_of::<c_long>()
);
assert_eq!(
CMSG_SPACE!(3 * size_of::<RawFd>()),
size_of::<cmsghdr>() + size_of::<c_long>() * 2
);
assert_eq!(
CMSG_SPACE!(4 * size_of::<RawFd>()),
size_of::<cmsghdr>() + size_of::<c_long>() * 2
);
} else if size_of::<RawFd>() == 8 {
assert_eq!(
CMSG_SPACE!(2 * size_of::<RawFd>()),
size_of::<cmsghdr>() + size_of::<c_long>() * 2
);
assert_eq!(
CMSG_SPACE!(3 * size_of::<RawFd>()),
size_of::<cmsghdr>() + size_of::<c_long>() * 3
);
assert_eq!(
CMSG_SPACE!(4 * size_of::<RawFd>()),
size_of::<cmsghdr>() + size_of::<c_long>() * 4
);
}
}
#[test]
fn send_recv_no_fd() {
let (s1, s2) = UnixDatagram::pair().expect("failed to create socket pair");
let write_count = s1
.send_with_fds(&[[1u8, 1, 2].as_ref(), [21u8, 34, 55].as_ref()], &[])
.expect("failed to send data");
assert_eq!(write_count, 6);
let mut buf = [0u8; 6];
let mut files = [0; 1];
let mut iovecs = [iovec {
iov_base: buf.as_mut_ptr() as *mut c_void,
iov_len: buf.len(),
}];
let (read_count, file_count) = unsafe {
s2.recv_with_fds(&mut iovecs[..], &mut files)
.expect("failed to recv data")
};
assert_eq!(read_count, 6);
assert_eq!(file_count, 0);
assert_eq!(buf, [1, 1, 2, 21, 34, 55]);
}
#[test]
fn send_recv_only_fd() {
let (s1, s2) = UnixDatagram::pair().expect("failed to create socket pair");
let mut file1 = TempFile::new().unwrap().into_file();
file1.write_all(b"foo").unwrap();
file1.seek(SeekFrom::Start(0)).unwrap();
let write_count = s1
.send_with_fd([].as_ref(), file1.as_raw_fd())
.expect("failed to send fd");
assert_eq!(write_count, 0);
let (read_count, file_opt) = s2.recv_with_fd(&mut []).expect("failed to recv fd");
let mut file = file_opt.unwrap();
assert_eq!(read_count, 0);
assert!(file.as_raw_fd() >= 0);
assert_ne!(file.as_raw_fd(), s1.as_raw_fd());
assert_ne!(file.as_raw_fd(), s2.as_raw_fd());
assert_ne!(file.as_raw_fd(), file1.as_raw_fd());
let mut buf = String::new();
file.read_to_string(&mut buf).unwrap();
assert_eq!("foo".to_string(), buf);
}
#[test]
fn send_recv_with_fd() {
let (s1, s2) = UnixDatagram::pair().expect("failed to create socket pair");
let mut file1 = TempFile::new().unwrap().into_file();
file1.write_all(b"foo").unwrap();
file1.seek(SeekFrom::Start(0)).unwrap();
let write_count = s1
.send_with_fds(&[[237].as_ref()], &[file1.as_raw_fd()])
.expect("failed to send fd");
assert_eq!(write_count, 1);
let mut files = [0; 2];
let mut buf = [0u8];
let mut iovecs = [iovec {
iov_base: buf.as_mut_ptr() as *mut c_void,
iov_len: buf.len(),
}];
let (read_count, file_count) = unsafe {
s2.recv_with_fds(&mut iovecs[..], &mut files)
.expect("failed to recv fd")
};
assert_eq!(read_count, 1);
assert_eq!(buf[0], 237);
assert_eq!(file_count, 1);
assert!(files[0] >= 0);
assert_ne!(files[0], s1.as_raw_fd());
assert_ne!(files[0], s2.as_raw_fd());
assert_ne!(files[0], file1.as_raw_fd());
let mut file = unsafe { File::from_raw_fd(files[0]) };
let mut buf = String::new();
file.read_to_string(&mut buf).unwrap();
assert_eq!("foo".to_string(), buf);
assert_ne!("bar".to_string(), buf);
}
#[test]
fn send_more_recv_less1() {
let (s1, s2) = UnixDatagram::pair().expect("failed to create socket pair");
let mut file1 = TempFile::new().unwrap().into_file();
let mut file2 = TempFile::new().unwrap().into_file();
let mut file3 = TempFile::new().unwrap().into_file();
let mut file4 = TempFile::new().unwrap().into_file();
file1.write_all(b"foo").unwrap();
file1.seek(SeekFrom::Start(0)).unwrap();
file2.write_all(b"bar").unwrap();
file2.seek(SeekFrom::Start(0)).unwrap();
file3.write_all(b"foobar").unwrap();
file3.seek(SeekFrom::Start(0)).unwrap();
file4.write_all(b"foobarfoo").unwrap();
file4.seek(SeekFrom::Start(0)).unwrap();
let write_count = s1
.send_with_fds(
&[[237].as_ref()],
&[
file1.as_raw_fd(),
file2.as_raw_fd(),
file3.as_raw_fd(),
file4.as_raw_fd(),
],
)
.expect("failed to send fd");
assert_eq!(write_count, 1);
let mut files = [0; 2];
let mut buf = [0u8];
let mut iovecs = [iovec {
iov_base: buf.as_mut_ptr() as *mut c_void,
iov_len: buf.len(),
}];
assert!(unsafe { s2.recv_with_fds(&mut iovecs[..], &mut files).is_err() });
}
#[test]
fn send_more_recv_less2() {
let (s1, s2) = UnixDatagram::pair().expect("failed to create socket pair");
let mut file1 = TempFile::new().unwrap().into_file();
let mut file2 = TempFile::new().unwrap().into_file();
let mut file3 = TempFile::new().unwrap().into_file();
let mut file4 = TempFile::new().unwrap().into_file();
file1.write_all(b"foo").unwrap();
file1.seek(SeekFrom::Start(0)).unwrap();
file2.write_all(b"bar").unwrap();
file2.seek(SeekFrom::Start(0)).unwrap();
file3.write_all(b"foobar").unwrap();
file3.seek(SeekFrom::Start(0)).unwrap();
file4.write_all(b"foobarfoo").unwrap();
file4.seek(SeekFrom::Start(0)).unwrap();
let write_count = s1
.send_with_fds(
&[[237].as_ref()],
&[
file1.as_raw_fd(),
file2.as_raw_fd(),
file3.as_raw_fd(),
file4.as_raw_fd(),
],
)
.expect("failed to send fd");
assert_eq!(write_count, 1);
let mut files = [0; 1];
let mut buf = [0u8];
let mut iovecs = [iovec {
iov_base: buf.as_mut_ptr() as *mut c_void,
iov_len: buf.len(),
}];
assert!(unsafe { s2.recv_with_fds(&mut iovecs[..], &mut files).is_err() });
}
}