-
Notifications
You must be signed in to change notification settings - Fork 13.3k
Implement unix pipes in libnative #12103
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,285 @@ | ||
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT | ||
// file at the top-level directory of this distribution and at | ||
// http://rust-lang.org/COPYRIGHT. | ||
// | ||
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or | ||
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license | ||
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your | ||
// option. This file may not be copied, modified, or distributed | ||
// except according to those terms. | ||
|
||
use std::c_str::CString; | ||
use std::cast; | ||
use std::io; | ||
use std::libc; | ||
use std::mem; | ||
use std::rt::rtio; | ||
use std::sync::arc::UnsafeArc; | ||
use std::unstable::intrinsics; | ||
|
||
use super::{IoResult, retry}; | ||
use super::file::{keep_going, fd_t}; | ||
|
||
fn unix_socket(ty: libc::c_int) -> IoResult<fd_t> { | ||
match unsafe { libc::socket(libc::AF_UNIX, ty, 0) } { | ||
-1 => Err(super::last_error()), | ||
fd => Ok(fd) | ||
} | ||
} | ||
|
||
fn addr_to_sockaddr_un(addr: &CString) -> IoResult<(libc::sockaddr_storage, uint)> { | ||
// the sun_path length is limited to SUN_LEN (with null) | ||
assert!(mem::size_of::<libc::sockaddr_storage>() >= | ||
mem::size_of::<libc::sockaddr_un>()); | ||
let mut storage: libc::sockaddr_storage = unsafe { intrinsics::init() }; | ||
let s: &mut libc::sockaddr_un = unsafe { cast::transmute(&mut storage) }; | ||
|
||
let len = addr.len(); | ||
if len > s.sun_path.len() - 1 { | ||
return Err(io::IoError { | ||
kind: io::InvalidInput, | ||
desc: "path must be smaller than SUN_LEN", | ||
detail: None, | ||
}) | ||
} | ||
s.sun_family = libc::AF_UNIX as libc::sa_family_t; | ||
for (slot, value) in s.sun_path.mut_iter().zip(addr.iter()) { | ||
*slot = value; | ||
} | ||
|
||
// count the null terminator | ||
let len = mem::size_of::<libc::sa_family_t>() + len + 1; | ||
return Ok((storage, len)); | ||
} | ||
|
||
fn sockaddr_to_unix(storage: &libc::sockaddr_storage, | ||
len: uint) -> IoResult<CString> { | ||
match storage.ss_family as libc::c_int { | ||
libc::AF_UNIX => { | ||
assert!(len as uint <= mem::size_of::<libc::sockaddr_un>()); | ||
let storage: &libc::sockaddr_un = unsafe { | ||
cast::transmute(storage) | ||
}; | ||
unsafe { | ||
Ok(CString::new(storage.sun_path.as_ptr(), false).clone()) | ||
} | ||
} | ||
_ => Err(io::standard_error(io::InvalidInput)) | ||
} | ||
} | ||
|
||
struct Inner { | ||
fd: fd_t, | ||
} | ||
|
||
impl Drop for Inner { | ||
fn drop(&mut self) { unsafe { let _ = libc::close(self.fd); } } | ||
} | ||
|
||
fn connect(addr: &CString, ty: libc::c_int) -> IoResult<Inner> { | ||
let (addr, len) = if_ok!(addr_to_sockaddr_un(addr)); | ||
let inner = Inner { fd: if_ok!(unix_socket(ty)) }; | ||
let addrp = &addr as *libc::sockaddr_storage; | ||
match retry(|| unsafe { | ||
libc::connect(inner.fd, addrp as *libc::sockaddr, | ||
len as libc::socklen_t) | ||
}) { | ||
-1 => Err(super::last_error()), | ||
_ => Ok(inner) | ||
} | ||
} | ||
|
||
fn bind(addr: &CString, ty: libc::c_int) -> IoResult<Inner> { | ||
let (addr, len) = if_ok!(addr_to_sockaddr_un(addr)); | ||
let inner = Inner { fd: if_ok!(unix_socket(ty)) }; | ||
let addrp = &addr as *libc::sockaddr_storage; | ||
match unsafe { | ||
libc::bind(inner.fd, addrp as *libc::sockaddr, len as libc::socklen_t) | ||
} { | ||
-1 => Err(super::last_error()), | ||
_ => Ok(inner) | ||
} | ||
} | ||
|
||
//////////////////////////////////////////////////////////////////////////////// | ||
// Unix Streams | ||
//////////////////////////////////////////////////////////////////////////////// | ||
|
||
pub struct UnixStream { | ||
priv inner: UnsafeArc<Inner>, | ||
} | ||
|
||
impl UnixStream { | ||
pub fn connect(addr: &CString) -> IoResult<UnixStream> { | ||
connect(addr, libc::SOCK_STREAM).map(|inner| { | ||
UnixStream { inner: UnsafeArc::new(inner) } | ||
}) | ||
} | ||
|
||
fn fd(&self) -> fd_t { unsafe { (*self.inner.get()).fd } } | ||
} | ||
|
||
impl rtio::RtioPipe for UnixStream { | ||
fn read(&mut self, buf: &mut [u8]) -> IoResult<uint> { | ||
let ret = retry(|| unsafe { | ||
libc::recv(self.fd(), | ||
buf.as_ptr() as *mut libc::c_void, | ||
buf.len() as libc::size_t, | ||
0) as libc::c_int | ||
}); | ||
if ret == 0 { | ||
Err(io::standard_error(io::EndOfFile)) | ||
} else if ret < 0 { | ||
Err(super::last_error()) | ||
} else { | ||
Ok(ret as uint) | ||
} | ||
} | ||
|
||
fn write(&mut self, buf: &[u8]) -> IoResult<()> { | ||
let ret = keep_going(buf, |buf, len| unsafe { | ||
libc::send(self.fd(), | ||
buf as *mut libc::c_void, | ||
len as libc::size_t, | ||
0) as i64 | ||
}); | ||
if ret < 0 { | ||
Err(super::last_error()) | ||
} else { | ||
Ok(()) | ||
} | ||
} | ||
|
||
fn clone(&self) -> ~rtio::RtioPipe { | ||
~UnixStream { inner: self.inner.clone() } as ~rtio::RtioPipe | ||
} | ||
} | ||
|
||
//////////////////////////////////////////////////////////////////////////////// | ||
// Unix Datagram | ||
//////////////////////////////////////////////////////////////////////////////// | ||
|
||
pub struct UnixDatagram { | ||
priv inner: UnsafeArc<Inner>, | ||
} | ||
|
||
impl UnixDatagram { | ||
pub fn connect(addr: &CString) -> IoResult<UnixDatagram> { | ||
connect(addr, libc::SOCK_DGRAM).map(|inner| { | ||
UnixDatagram { inner: UnsafeArc::new(inner) } | ||
}) | ||
} | ||
|
||
pub fn bind(addr: &CString) -> IoResult<UnixDatagram> { | ||
bind(addr, libc::SOCK_DGRAM).map(|inner| { | ||
UnixDatagram { inner: UnsafeArc::new(inner) } | ||
}) | ||
} | ||
|
||
fn fd(&self) -> fd_t { unsafe { (*self.inner.get()).fd } } | ||
|
||
pub fn recvfrom(&mut self, buf: &mut [u8]) -> IoResult<(uint, CString)> { | ||
let mut storage: libc::sockaddr_storage = unsafe { intrinsics::init() }; | ||
let storagep = &mut storage as *mut libc::sockaddr_storage; | ||
let mut addrlen: libc::socklen_t = | ||
mem::size_of::<libc::sockaddr_storage>() as libc::socklen_t; | ||
let ret = retry(|| unsafe { | ||
libc::recvfrom(self.fd(), | ||
buf.as_ptr() as *mut libc::c_void, | ||
buf.len() as libc::size_t, | ||
0, | ||
storagep as *mut libc::sockaddr, | ||
&mut addrlen) as libc::c_int | ||
}); | ||
if ret < 0 { return Err(super::last_error()) } | ||
sockaddr_to_unix(&storage, addrlen as uint).and_then(|addr| { | ||
Ok((ret as uint, addr)) | ||
}) | ||
} | ||
|
||
pub fn sendto(&mut self, buf: &[u8], dst: &CString) -> IoResult<()> { | ||
let (dst, len) = if_ok!(addr_to_sockaddr_un(dst)); | ||
let dstp = &dst as *libc::sockaddr_storage; | ||
let ret = retry(|| unsafe { | ||
libc::sendto(self.fd(), | ||
buf.as_ptr() as *libc::c_void, | ||
buf.len() as libc::size_t, | ||
0, | ||
dstp as *libc::sockaddr, | ||
len as libc::socklen_t) as libc::c_int | ||
}); | ||
match ret { | ||
-1 => Err(super::last_error()), | ||
n if n as uint != buf.len() => { | ||
Err(io::IoError { | ||
kind: io::OtherIoError, | ||
desc: "couldn't send entire packet at once", | ||
detail: None, | ||
}) | ||
} | ||
_ => Ok(()) | ||
} | ||
} | ||
|
||
pub fn clone(&mut self) -> UnixDatagram { | ||
UnixDatagram { inner: self.inner.clone() } | ||
} | ||
} | ||
|
||
//////////////////////////////////////////////////////////////////////////////// | ||
// Unix Listener | ||
//////////////////////////////////////////////////////////////////////////////// | ||
|
||
pub struct UnixListener { | ||
priv inner: Inner, | ||
} | ||
|
||
impl UnixListener { | ||
pub fn bind(addr: &CString) -> IoResult<UnixListener> { | ||
bind(addr, libc::SOCK_STREAM).map(|fd| UnixListener { inner: fd }) | ||
} | ||
|
||
fn fd(&self) -> fd_t { self.inner.fd } | ||
|
||
pub fn native_listen(self, backlog: int) -> IoResult<UnixAcceptor> { | ||
match unsafe { libc::listen(self.fd(), backlog as libc::c_int) } { | ||
-1 => Err(super::last_error()), | ||
_ => Ok(UnixAcceptor { listener: self }) | ||
} | ||
} | ||
} | ||
|
||
impl rtio::RtioUnixListener for UnixListener { | ||
fn listen(~self) -> IoResult<~rtio::RtioUnixAcceptor> { | ||
self.native_listen(128).map(|a| ~a as ~rtio::RtioUnixAcceptor) | ||
} | ||
} | ||
|
||
pub struct UnixAcceptor { | ||
priv listener: UnixListener, | ||
} | ||
|
||
impl UnixAcceptor { | ||
fn fd(&self) -> fd_t { self.listener.fd() } | ||
|
||
pub fn native_accept(&mut self) -> IoResult<UnixStream> { | ||
let mut storage: libc::sockaddr_storage = unsafe { intrinsics::init() }; | ||
let storagep = &mut storage as *mut libc::sockaddr_storage; | ||
let size = mem::size_of::<libc::sockaddr_storage>(); | ||
let mut size = size as libc::socklen_t; | ||
match retry(|| unsafe { | ||
libc::accept(self.fd(), | ||
storagep as *mut libc::sockaddr, | ||
&mut size as *mut libc::socklen_t) as libc::c_int | ||
}) { | ||
-1 => Err(super::last_error()), | ||
fd => Ok(UnixStream { inner: UnsafeArc::new(Inner { fd: fd }) }) | ||
} | ||
} | ||
} | ||
|
||
impl rtio::RtioUnixAcceptor for UnixAcceptor { | ||
fn accept(&mut self) -> IoResult<~rtio::RtioPipe> { | ||
self.native_accept().map(|s| ~s as ~rtio::RtioPipe) | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is something of an off-by-one error. On Linux, the path doesn't have to be zero-terminated if it's sizeof(s.sun_path) bytes long while on (most of?) the BSDs it's possible to use a path that's longer than that by passing sizeof(struct sockaddr_un) + extra_bytes as the addrlen argument.
(On that subject, I found a nice little local exploit when checking whether that works on XNU: https://gist.github.com/bnoordhuis/8882643)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another issue is that it won't allow abstract namespace sockets because those start with a zero byte. They're Linux-only however so maybe they're out of scope.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting, so in general this should probably malloc a
sockaddr_un
with the header + entire length of theCString
? I figure for platform compatibility it could null terminate it, and then the length would be the size of the entire structure? (header + cstring length + 1 for null)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Taking a look at the libuv implementation, it looks like the requested path is truncated to
sizeof(s.sun_path)
(just for comparison). Do you know if that was intentional or "just because"?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's mostly right. There's still an upper limit that's lower than PATH_MAX, I think it's usually 256 or 1024 bytes, but you could leave it to the user to deal with that.
Pretty much just because, I'm afraid. I wrote libuv's initial pipes implementation under time pressure with the idea of coming back to it once long paths started becoming an issue. But it never became an issue and there were always more critical bugs to squash so yeah...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The sun_path element is limited to 108 or 104 characters, depending on the platform. On Linux, it seems it must be null-terminated (and the terminating character is counted in the size): http://man7.org/linux/man-pages/man7/unix.7.html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm after thinking about this, I think I'm tempted to leave this as-is for the sake of simplicity for now. I'm thinking we can revisit if this comes up to be a problem in the future, but I can also open an issue on it.