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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
#![cfg_attr(sendfd_docs, feature(doc_cfg))]
extern crate libc;
#[cfg(feature = "tokio")]
extern crate tokio;
use std::os::unix::io::{AsRawFd, RawFd};
use std::os::unix::net;
use std::{alloc, io, mem, ptr};
#[cfg(feature = "tokio")]
use tokio::io::Interest;
pub mod changelog;
pub trait SendWithFd {
fn send_with_fd(&self, bytes: &[u8], fds: &[RawFd]) -> io::Result<usize>;
}
pub trait RecvWithFd {
fn recv_with_fd(&self, bytes: &mut [u8], fds: &mut [RawFd]) -> io::Result<(usize, usize)>;
}
unsafe fn ptr_offset_from(this: *const u8, origin: *const u8) -> isize {
isize::wrapping_sub(this as _, origin as _)
}
unsafe fn construct_msghdr_for(
iov: &mut libc::iovec,
fd_count: usize,
) -> (libc::msghdr, alloc::Layout, usize) {
let fd_len = mem::size_of::<RawFd>() * fd_count;
let cmsg_buffer_len = libc::CMSG_SPACE(fd_len as u32) as usize;
let layout = alloc::Layout::from_size_align(cmsg_buffer_len, mem::align_of::<libc::cmsghdr>());
let (cmsg_buffer, cmsg_layout) = if let Ok(layout) = layout {
const NULL_MUT_U8: *mut u8 = ptr::null_mut();
match alloc::alloc(layout) {
NULL_MUT_U8 => alloc::handle_alloc_error(layout),
x => (x as *mut _, layout),
}
} else {
alloc::handle_alloc_error(alloc::Layout::from_size_align_unchecked(
cmsg_buffer_len,
mem::align_of::<libc::cmsghdr>(),
))
};
let mut msghdr = mem::zeroed::<libc::msghdr>();
msghdr.msg_name = ptr::null_mut();
msghdr.msg_namelen = 0;
msghdr.msg_iov = iov as *mut _;
msghdr.msg_iovlen = 1;
msghdr.msg_control = cmsg_buffer;
msghdr.msg_controllen = cmsg_buffer_len as _;
(msghdr, cmsg_layout, fd_len)
}
fn send_with_fd(socket: RawFd, bs: &[u8], fds: &[RawFd]) -> io::Result<usize> {
unsafe {
let mut iov = libc::iovec {
iov_base: bs.as_ptr() as *const _ as *mut _,
iov_len: bs.len(),
};
let (mut msghdr, cmsg_layout, fd_len) = construct_msghdr_for(&mut iov, fds.len());
let cmsg_buffer = msghdr.msg_control;
let cmsg_header = libc::CMSG_FIRSTHDR(&mut msghdr as *mut _);
let mut cmsghdr = mem::zeroed::<libc::cmsghdr>();
cmsghdr.cmsg_level = libc::SOL_SOCKET;
cmsghdr.cmsg_type = libc::SCM_RIGHTS;
cmsghdr.cmsg_len = libc::CMSG_LEN(fd_len as u32) as _;
ptr::write(cmsg_header, cmsghdr);
let cmsg_data = libc::CMSG_DATA(cmsg_header) as *mut RawFd;
for (i, fd) in fds.iter().enumerate() {
ptr::write_unaligned(cmsg_data.add(i), *fd);
}
let count = libc::sendmsg(socket, &msghdr as *const _, 0);
if count < 0 {
let error = io::Error::last_os_error();
alloc::dealloc(cmsg_buffer as *mut _, cmsg_layout);
Err(error)
} else {
alloc::dealloc(cmsg_buffer as *mut _, cmsg_layout);
Ok(count as usize)
}
}
}
fn recv_with_fd(socket: RawFd, bs: &mut [u8], mut fds: &mut [RawFd]) -> io::Result<(usize, usize)> {
unsafe {
let mut iov = libc::iovec {
iov_base: bs.as_mut_ptr() as *mut _,
iov_len: bs.len(),
};
let (mut msghdr, cmsg_layout, _) = construct_msghdr_for(&mut iov, fds.len());
let cmsg_buffer = msghdr.msg_control;
let count = libc::recvmsg(socket, &mut msghdr as *mut _, 0);
if count < 0 {
let error = io::Error::last_os_error();
alloc::dealloc(cmsg_buffer as *mut _, cmsg_layout);
return Err(error);
}
let mut descriptor_count = 0;
let mut cmsg_header = libc::CMSG_FIRSTHDR(&mut msghdr as *mut _);
while !cmsg_header.is_null() {
if (*cmsg_header).cmsg_level == libc::SOL_SOCKET
&& (*cmsg_header).cmsg_type == libc::SCM_RIGHTS
{
let data_ptr = libc::CMSG_DATA(cmsg_header);
let data_offset = ptr_offset_from(data_ptr, cmsg_header as *const _);
debug_assert!(data_offset >= 0);
let data_byte_count = (*cmsg_header).cmsg_len as usize - data_offset as usize;
debug_assert!((*cmsg_header).cmsg_len as isize > data_offset);
debug_assert!(data_byte_count % mem::size_of::<RawFd>() == 0);
let rawfd_count = (data_byte_count / mem::size_of::<RawFd>()) as isize;
let fd_ptr = data_ptr as *const RawFd;
for i in 0..rawfd_count {
if let Some((dst, rest)) = { fds }.split_first_mut() {
*dst = ptr::read_unaligned(fd_ptr.offset(i));
descriptor_count += 1;
fds = rest;
} else {
unreachable!();
}
}
}
cmsg_header = libc::CMSG_NXTHDR(&mut msghdr as *mut _, cmsg_header);
}
alloc::dealloc(cmsg_buffer as *mut _, cmsg_layout);
Ok((count as usize, descriptor_count))
}
}
impl SendWithFd for net::UnixStream {
fn send_with_fd(&self, bytes: &[u8], fds: &[RawFd]) -> io::Result<usize> {
send_with_fd(self.as_raw_fd(), bytes, fds)
}
}
#[cfg(feature = "tokio")]
#[cfg_attr(sendfd_docs, doc(cfg(feature = "tokio")))]
impl SendWithFd for tokio::net::UnixStream {
fn send_with_fd(&self, bytes: &[u8], fds: &[RawFd]) -> io::Result<usize> {
self.try_io(Interest::WRITABLE, || send_with_fd(self.as_raw_fd(), bytes, fds))
}
}
#[cfg(feature = "tokio")]
#[cfg_attr(sendfd_docs, doc(cfg(feature = "tokio")))]
impl SendWithFd for tokio::net::unix::WriteHalf<'_> {
fn send_with_fd(&self, bytes: &[u8], fds: &[RawFd]) -> io::Result<usize> {
let unix_stream: &tokio::net::UnixStream = self.as_ref();
unix_stream.send_with_fd(bytes, fds)
}
}
impl SendWithFd for net::UnixDatagram {
fn send_with_fd(&self, bytes: &[u8], fds: &[RawFd]) -> io::Result<usize> {
send_with_fd(self.as_raw_fd(), bytes, fds)
}
}
#[cfg(feature = "tokio")]
#[cfg_attr(sendfd_docs, doc(cfg(feature = "tokio")))]
impl SendWithFd for tokio::net::UnixDatagram {
fn send_with_fd(&self, bytes: &[u8], fds: &[RawFd]) -> io::Result<usize> {
self.try_io(Interest::WRITABLE, || send_with_fd(self.as_raw_fd(), bytes, fds))
}
}
impl RecvWithFd for net::UnixStream {
fn recv_with_fd(&self, bytes: &mut [u8], fds: &mut [RawFd]) -> io::Result<(usize, usize)> {
recv_with_fd(self.as_raw_fd(), bytes, fds)
}
}
#[cfg(feature = "tokio")]
#[cfg_attr(sendfd_docs, doc(cfg(feature = "tokio")))]
impl RecvWithFd for tokio::net::UnixStream {
fn recv_with_fd(&self, bytes: &mut [u8], fds: &mut [RawFd]) -> io::Result<(usize, usize)> {
self.try_io(Interest::READABLE, || recv_with_fd(self.as_raw_fd(), bytes, fds))
}
}
#[cfg(feature = "tokio")]
#[cfg_attr(sendfd_docs, doc(cfg(feature = "tokio")))]
impl RecvWithFd for tokio::net::unix::ReadHalf<'_> {
fn recv_with_fd(&self, bytes: &mut [u8], fds: &mut [RawFd]) -> io::Result<(usize, usize)> {
let unix_stream: &tokio::net::UnixStream = self.as_ref();
unix_stream.recv_with_fd(bytes, fds)
}
}
impl RecvWithFd for net::UnixDatagram {
fn recv_with_fd(&self, bytes: &mut [u8], fds: &mut [RawFd]) -> io::Result<(usize, usize)> {
recv_with_fd(self.as_raw_fd(), bytes, fds)
}
}
#[cfg(feature = "tokio")]
#[cfg_attr(sendfd_docs, doc(cfg(feature = "tokio")))]
impl RecvWithFd for tokio::net::UnixDatagram {
fn recv_with_fd(&self, bytes: &mut [u8], fds: &mut [RawFd]) -> io::Result<(usize, usize)> {
self.try_io(Interest::READABLE, || recv_with_fd(self.as_raw_fd(), bytes, fds))
}
}
#[cfg(test)]
mod tests {
use super::{RecvWithFd, SendWithFd};
use std::os::unix::io::{AsRawFd, FromRawFd};
use std::os::unix::net;
#[test]
fn stream_works() {
let (l, r) = net::UnixStream::pair().expect("create UnixStream pair");
let sent_bytes = b"hello world!";
let sent_fds = [l.as_raw_fd(), r.as_raw_fd()];
assert_eq!(
l.send_with_fd(&sent_bytes[..], &sent_fds[..])
.expect("send should be successful"),
sent_bytes.len()
);
let mut recv_bytes = [0; 128];
let mut recv_fds = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
assert_eq!(
r.recv_with_fd(&mut recv_bytes, &mut recv_fds)
.expect("recv should be successful"),
(sent_bytes.len(), sent_fds.len())
);
assert_eq!(recv_bytes[..sent_bytes.len()], sent_bytes[..]);
for (&sent, &recvd) in sent_fds.iter().zip(&recv_fds[..]) {
let expected_value = Some(std::time::Duration::from_secs(42));
unsafe {
let s = net::UnixStream::from_raw_fd(sent);
s.set_read_timeout(expected_value)
.expect("set read timeout");
std::mem::forget(s);
assert_eq!(
net::UnixStream::from_raw_fd(recvd)
.read_timeout()
.expect("get read timeout"),
expected_value
);
}
}
}
#[test]
fn datagram_works() {
let (l, r) = net::UnixDatagram::pair().expect("create UnixDatagram pair");
let sent_bytes = b"hello world!";
let sent_fds = [l.as_raw_fd(), r.as_raw_fd()];
assert_eq!(
l.send_with_fd(&sent_bytes[..], &sent_fds[..])
.expect("send should be successful"),
sent_bytes.len()
);
let mut recv_bytes = [0; 128];
let mut recv_fds = [0, 0, 0, 0, 0, 0, 0];
assert_eq!(
r.recv_with_fd(&mut recv_bytes, &mut recv_fds)
.expect("recv should be successful"),
(sent_bytes.len(), sent_fds.len())
);
assert_eq!(recv_bytes[..sent_bytes.len()], sent_bytes[..]);
for (&sent, &recvd) in sent_fds.iter().zip(&recv_fds[..]) {
let expected_value = Some(std::time::Duration::from_secs(42));
unsafe {
let s = net::UnixDatagram::from_raw_fd(sent);
s.set_read_timeout(expected_value)
.expect("set read timeout");
std::mem::forget(s);
assert_eq!(
net::UnixDatagram::from_raw_fd(recvd)
.read_timeout()
.expect("get read timeout"),
expected_value
);
}
}
}
#[test]
fn datagram_works_across_processes() {
let (l, r) = net::UnixDatagram::pair().expect("create UnixDatagram pair");
let sent_bytes = b"hello world!";
let sent_fds = [l.as_raw_fd(), r.as_raw_fd()];
unsafe {
match libc::fork() {
-1 => panic!("fork failed!"),
0 => {
l.send_with_fd(&sent_bytes[..], &sent_fds[..])
.expect("send should be successful");
::std::process::exit(0);
}
_ => {
}
}
let mut recv_bytes = [0; 128];
let mut recv_fds = [0, 0, 0, 0, 0, 0, 0];
assert_eq!(
r.recv_with_fd(&mut recv_bytes, &mut recv_fds)
.expect("recv should be successful"),
(sent_bytes.len(), sent_fds.len())
);
assert_eq!(recv_bytes[..sent_bytes.len()], sent_bytes[..]);
for (&sent, &recvd) in sent_fds.iter().zip(&recv_fds[..]) {
let expected_value = Some(std::time::Duration::from_secs(42));
let s = net::UnixDatagram::from_raw_fd(sent);
s.set_read_timeout(expected_value)
.expect("set read timeout");
std::mem::forget(s);
assert_eq!(
net::UnixDatagram::from_raw_fd(recvd)
.read_timeout()
.expect("get read timeout"),
expected_value
);
}
}
}
#[test]
fn sending_junk_fails() {
let (l, _) = net::UnixDatagram::pair().expect("create UnixDatagram pair");
let sent_bytes = b"hello world!";
if let Ok(_) = l.send_with_fd(&sent_bytes[..], &[i32::max_value()][..]) {
panic!("expected an error when sending a junk file descriptor");
}
if let Ok(_) = l.send_with_fd(&sent_bytes[..], &[0xffi32][..]) {
panic!("expected an error when sending a junk file descriptor");
}
}
}