unix_socket-0.5.0/.gitignore000064400017500001750000000000231262254243700142610ustar0000000000000000Cargo.lock target/ unix_socket-0.5.0/.travis.yml000064400017500001750000000001031262254243700144010ustar0000000000000000language: rust rust: - nightly - beta - 1.4.0 script: - cargo test unix_socket-0.5.0/Cargo.toml000064400017500001750000000020041262254244400142200ustar0000000000000000# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies # # If you believe there's an error in this file please file an # issue against the rust-lang/cargo repository. If you're # editing this file be aware that the upstream Cargo.toml # will likely look very different (and much more reasonable) [package] name = "unix_socket" version = "0.5.0" authors = ["Steven Fackler "] description = "Unix domain socket bindings" documentation = "https://doc.rust-lang.org/unix-socket/doc/v0.5.0/unix_socket" readme = "README.md" keywords = ["posix", "unix", "socket", "domain"] license = "MIT/Apache-2.0" repository = "https://github.com/rust-lang-nursery/unix-socket" [dependencies.cfg-if] version = "0.1" [dependencies.libc] version = "0.2.1" [dev-dependencies.tempdir] version = "0.3" unix_socket-0.5.0/Cargo.toml.orig000064400017500001750000000007211262254244400151630ustar0000000000000000[package] name = "unix_socket" version = "0.5.0" authors = ["Steven Fackler "] license = "MIT/Apache-2.0" description = "Unix domain socket bindings" repository = "https://github.com/rust-lang-nursery/unix-socket" documentation = "https://doc.rust-lang.org/unix-socket/doc/v0.5.0/unix_socket" readme = "README.md" keywords = ["posix", "unix", "socket", "domain"] [dependencies] libc = "0.2.1" cfg-if = "0.1" [dev-dependencies] tempdir = "0.3" unix_socket-0.5.0/LICENSE-APACHE000064400017500001750000000251371262254243700142320ustar0000000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. unix_socket-0.5.0/LICENSE-MIT000064400017500001750000000020721262254243700137330ustar0000000000000000The MIT License (MIT) Copyright (c) 2015 Steven Fackler Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. unix_socket-0.5.0/README.md000064400017500001750000000006141262254262200135520ustar0000000000000000# unix-socket [![Build Status](https://travis-ci.org/rust-lang-nursery/unix-socket.svg?branch=master)](https://travis-ci.org/rust-lang-nursery/unix-socket) [![Latest Version](https://img.shields.io/crates/v/unix_socket.svg)](https://crates.io/crates/unix_socket) Support for Unix domain socket clients and servers. [Documentation](https://doc.rust-lang.org/unix-socket/doc/v0.4.6/unix_socket) unix_socket-0.5.0/src/lib.rs000064400017500001750000001165771262254244400142200ustar0000000000000000//! Support for Unix domain socket clients and servers. #![warn(missing_docs)] #![doc(html_root_url="https://doc.rust-lang.org/unix-socket/doc/v0.5.0")] #[macro_use] extern crate cfg_if; extern crate libc; use std::ascii; use std::cmp::Ordering; use std::convert::AsRef; use std::ffi::OsStr; use std::fmt; use std::io; use std::iter::IntoIterator; use std::mem; use std::mem::size_of; use std::net::Shutdown; use std::os::unix::ffi::OsStrExt; use std::os::unix::io::{RawFd, AsRawFd, FromRawFd, IntoRawFd}; use std::path::Path; use std::time::Duration; fn sun_path_offset() -> usize { unsafe { // Work with an actual instance of the type since using a null pointer is UB let addr: libc::sockaddr_un = mem::uninitialized(); let base = &addr as *const _ as usize; let path = &addr.sun_path as *const _ as usize; path - base } } fn cvt(v: libc::c_int) -> io::Result { if v < 0 { Err(io::Error::last_os_error()) } else { Ok(v) } } fn cvt_s(v: libc::ssize_t) -> io::Result { if v < 0 { Err(io::Error::last_os_error()) } else { Ok(v) } } struct Inner(RawFd); impl Drop for Inner { fn drop(&mut self) { unsafe { libc::close(self.0); } } } impl Inner { fn new(kind: libc::c_int) -> io::Result { unsafe { cvt(libc::socket(libc::AF_UNIX, kind, 0)).map(Inner) } } fn new_pair(kind: libc::c_int) -> io::Result<(Inner, Inner)> { unsafe { let mut fds = [0, 0]; try!(cvt(libc::socketpair(libc::AF_UNIX, kind, 0, fds.as_mut_ptr()))); Ok((Inner(fds[0]), Inner(fds[1]))) } } fn try_clone(&self) -> io::Result { unsafe { cvt(libc::dup(self.0)).map(Inner) } } fn shutdown(&self, how: Shutdown) -> io::Result<()> { let how = match how { Shutdown::Read => libc::SHUT_RD, Shutdown::Write => libc::SHUT_WR, Shutdown::Both => libc::SHUT_RDWR, }; unsafe { cvt(libc::shutdown(self.0, how)).map(|_| ()) } } fn timeout(&self, kind: libc::c_int) -> io::Result> { let timeout = unsafe { let mut timeout: libc::timeval = mem::zeroed(); let mut size = mem::size_of::() as libc::socklen_t; try!(cvt(libc::getsockopt(self.0, libc::SOL_SOCKET, kind, &mut timeout as *mut _ as *mut _, &mut size as *mut _ as *mut _))); timeout }; if timeout.tv_sec == 0 && timeout.tv_usec == 0 { Ok(None) } else { Ok(Some(Duration::new(timeout.tv_sec as u64, (timeout.tv_usec as u32) * 1000))) } } fn set_timeout(&self, dur: Option, kind: libc::c_int) -> io::Result<()> { let timeout = match dur { Some(dur) => { if dur.as_secs() == 0 && dur.subsec_nanos() == 0 { return Err(io::Error::new(io::ErrorKind::InvalidInput, "cannot set a 0 duration timeout")); } let (secs, usecs) = if dur.as_secs() > libc::time_t::max_value() as u64 { (libc::time_t::max_value(), 999_999) } else { (dur.as_secs() as libc::time_t, (dur.subsec_nanos() / 1000) as libc::suseconds_t) }; let mut timeout = libc::timeval { tv_sec: secs, tv_usec: usecs, }; if timeout.tv_sec == 0 && timeout.tv_usec == 0 { timeout.tv_usec = 1; } timeout } None => { libc::timeval { tv_sec: 0, tv_usec: 0, } } }; unsafe { cvt(libc::setsockopt(self.0, libc::SOL_SOCKET, kind, &timeout as *const _ as *const _, mem::size_of::() as libc::socklen_t)) .map(|_| ()) } } fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> { let mut nonblocking = nonblocking as libc::c_ulong; unsafe { cvt(libc::ioctl(self.0, libc::FIONBIO, &mut nonblocking)).map(|_| ()) } } fn take_error(&self) -> io::Result> { let mut errno: libc::c_int = 0; unsafe { try!(cvt(libc::getsockopt(self.0, libc::SOL_SOCKET, libc::SO_ERROR, &mut errno as *mut _ as *mut _, &mut mem::size_of_val(&errno) as *mut _ as *mut _))); } if errno == 0 { Ok(None) } else { Ok(Some(io::Error::from_raw_os_error(errno))) } } } unsafe fn sockaddr_un>(path: P) -> io::Result<(libc::sockaddr_un, libc::socklen_t)> { let mut addr: libc::sockaddr_un = mem::zeroed(); addr.sun_family = libc::AF_UNIX as libc::sa_family_t; let bytes = path.as_ref().as_os_str().as_bytes(); match (bytes.get(0), bytes.len().cmp(&addr.sun_path.len())) { // Abstract paths don't need a null terminator (Some(&0), Ordering::Greater) => { return Err(io::Error::new(io::ErrorKind::InvalidInput, "path must be no longer than SUN_LEN")); } (_, Ordering::Greater) | (_, Ordering::Equal) => { return Err(io::Error::new(io::ErrorKind::InvalidInput, "path must be shorter than SUN_LEN")); } _ => {} } for (dst, src) in addr.sun_path.iter_mut().zip(bytes.iter()) { *dst = *src as libc::c_char; } // null byte for pathname addresses is already there because we zeroed the // struct let mut len = sun_path_offset() + bytes.len(); match bytes.get(0) { Some(&0) | None => {} Some(_) => len += 1, } Ok((addr, len as libc::socklen_t)) } enum AddressKind<'a> { Unnamed, Pathname(&'a Path), Abstract(&'a [u8]), } /// An address associated with a Unix socket. #[derive(Clone)] pub struct SocketAddr { addr: libc::sockaddr_un, len: libc::socklen_t, } impl SocketAddr { fn new(f: F) -> io::Result where F: FnOnce(*mut libc::sockaddr, *mut libc::socklen_t) -> libc::c_int { unsafe { let mut addr: libc::sockaddr_un = mem::zeroed(); let mut len = mem::size_of::() as libc::socklen_t; try!(cvt(f(&mut addr as *mut _ as *mut _, &mut len))); if len == 0 { // When there is a datagram from unnamed unix socket // linux returns zero bytes of address len = sun_path_offset() as libc::socklen_t; // i.e. zero-length address } else if addr.sun_family != libc::AF_UNIX as libc::sa_family_t { return Err(io::Error::new(io::ErrorKind::InvalidInput, "file descriptor did not correspond to a Unix socket")); } Ok(SocketAddr { addr: addr, len: len, }) } } /// Returns true iff the address is unnamed. pub fn is_unnamed(&self) -> bool { if let AddressKind::Unnamed = self.address() { true } else { false } } /// Returns the contents of this address if it is a `pathname` address. pub fn as_pathname(&self) -> Option<&Path> { if let AddressKind::Pathname(path) = self.address() { Some(path) } else { None } } fn address<'a>(&'a self) -> AddressKind<'a> { let len = self.len as usize - sun_path_offset(); let path = unsafe { mem::transmute::<&[libc::c_char], &[u8]>(&self.addr.sun_path) }; // OSX seems to return a len of 16 and a zeroed sun_path for unnamed addresses if len == 0 || (cfg!(not(target_os = "linux")) && self.addr.sun_path[0] == 0) { AddressKind::Unnamed } else if self.addr.sun_path[0] == 0 { AddressKind::Abstract(&path[1..len]) } else { AddressKind::Pathname(OsStr::from_bytes(&path[..len - 1]).as_ref()) } } } impl fmt::Debug for SocketAddr { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { match self.address() { AddressKind::Unnamed => write!(fmt, "(unnamed)"), AddressKind::Abstract(name) => write!(fmt, "{} (abstract)", AsciiEscaped(name)), AddressKind::Pathname(path) => write!(fmt, "{:?} (pathname)", path), } } } struct AsciiEscaped<'a>(&'a [u8]); impl<'a> fmt::Display for AsciiEscaped<'a> { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { try!(write!(fmt, "\"")); for byte in self.0.iter().cloned().flat_map(ascii::escape_default) { try!(write!(fmt, "{}", byte as char)); } write!(fmt, "\"") } } /// OS specific extension traits. pub mod os { /// Linux specific extension traits. #[cfg(target_os = "linux")] pub mod linux { use {AddressKind, SocketAddr}; /// Linux specific extensions for the `SocketAddr` type. pub trait SocketAddrExt { /// Returns the contents of this address (without the leading /// null byte) if it is an `abstract` address. fn as_abstract(&self) -> Option<&[u8]>; } impl SocketAddrExt for SocketAddr { fn as_abstract(&self) -> Option<&[u8]> { if let AddressKind::Abstract(path) = self.address() { Some(path) } else { None } } } } } /// A Unix stream socket. /// /// # Examples /// /// ```rust,no_run /// use unix_socket::UnixStream; /// use std::io::prelude::*; /// /// let mut stream = UnixStream::connect("/path/to/my/socket").unwrap(); /// stream.write_all(b"hello world").unwrap(); /// let mut response = String::new(); /// stream.read_to_string(&mut response).unwrap(); /// println!("{}", response); /// ``` pub struct UnixStream { inner: Inner, } impl fmt::Debug for UnixStream { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { let mut builder = fmt.debug_struct("UnixStream"); builder.field("fd", &self.inner.0); if let Ok(addr) = self.local_addr() { builder.field("local", &addr); } if let Ok(addr) = self.peer_addr() { builder.field("peer", &addr); } builder.finish() } } impl UnixStream { /// Connects to the socket named by `path`. /// /// Linux provides, as a nonportable extension, a separate "abstract" /// address namespace as opposed to filesystem-based addressing. If `path` /// begins with a null byte, it will be interpreted as an "abstract" /// address. Otherwise, it will be interpreted as a "pathname" address, /// corresponding to a path on the filesystem. pub fn connect>(path: P) -> io::Result { unsafe { let inner = try!(Inner::new(libc::SOCK_STREAM)); let (addr, len) = try!(sockaddr_un(path)); let ret = libc::connect(inner.0, &addr as *const _ as *const _, len); if ret < 0 { Err(io::Error::last_os_error()) } else { Ok(UnixStream { inner: inner }) } } } /// Creates an unnamed pair of connected sockets. /// /// Returns two `UnixStream`s which are connected to each other. pub fn pair() -> io::Result<(UnixStream, UnixStream)> { let (i1, i2) = try!(Inner::new_pair(libc::SOCK_STREAM)); Ok((UnixStream { inner: i1 }, UnixStream { inner: i2 })) } /// Creates a new independently owned handle to the underlying socket. /// /// The returned `UnixStream` is a reference to the same stream that this /// object references. Both handles will read and write the same stream of /// data, and options set on one stream will be propogated to the other /// stream. pub fn try_clone(&self) -> io::Result { Ok(UnixStream { inner: try!(self.inner.try_clone()) }) } /// Returns the socket address of the local half of this connection. pub fn local_addr(&self) -> io::Result { SocketAddr::new(|addr, len| unsafe { libc::getsockname(self.inner.0, addr, len) }) } /// Returns the socket address of the remote half of this connection. pub fn peer_addr(&self) -> io::Result { SocketAddr::new(|addr, len| unsafe { libc::getpeername(self.inner.0, addr, len) }) } /// Sets the read timeout for the socket. /// /// If the provided value is `None`, then `read` calls will block /// indefinitely. It is an error to pass the zero `Duration` to this /// method. pub fn set_read_timeout(&self, timeout: Option) -> io::Result<()> { self.inner.set_timeout(timeout, libc::SO_RCVTIMEO) } /// Sets the write timeout for the socket. /// /// If the provided value is `None`, then `write` calls will block /// indefinitely. It is an error to pass the zero `Duration` to this /// method. pub fn set_write_timeout(&self, timeout: Option) -> io::Result<()> { self.inner.set_timeout(timeout, libc::SO_SNDTIMEO) } /// Returns the read timeout of this socket. pub fn read_timeout(&self) -> io::Result> { self.inner.timeout(libc::SO_RCVTIMEO) } /// Returns the write timeout of this socket. pub fn write_timeout(&self) -> io::Result> { self.inner.timeout(libc::SO_SNDTIMEO) } /// Moves the socket into or out of nonblocking mode. pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> { self.inner.set_nonblocking(nonblocking) } /// Returns the value of the `SO_ERROR` option. pub fn take_error(&self) -> io::Result> { self.inner.take_error() } /// Shuts down the read, write, or both halves of this connection. /// /// This function will cause all pending and future I/O calls on the /// specified portions to immediately return with an appropriate value /// (see the documentation of `Shutdown`). pub fn shutdown(&self, how: Shutdown) -> io::Result<()> { self.inner.shutdown(how) } } impl io::Read for UnixStream { fn read(&mut self, buf: &mut [u8]) -> io::Result { io::Read::read(&mut &*self, buf) } } impl<'a> io::Read for &'a UnixStream { fn read(&mut self, buf: &mut [u8]) -> io::Result { unsafe { cvt_s(libc::recv(self.inner.0, buf.as_mut_ptr() as *mut _, buf.len(), 0)) .map(|r| r as usize) } } } impl io::Write for UnixStream { fn write(&mut self, buf: &[u8]) -> io::Result { io::Write::write(&mut &*self, buf) } fn flush(&mut self) -> io::Result<()> { io::Write::flush(&mut &*self) } } impl<'a> io::Write for &'a UnixStream { fn write(&mut self, buf: &[u8]) -> io::Result { unsafe { cvt_s(libc::send(self.inner.0, buf.as_ptr() as *const _, buf.len(), 0)) .map(|r| r as usize) } } fn flush(&mut self) -> io::Result<()> { Ok(()) } } impl AsRawFd for UnixStream { fn as_raw_fd(&self) -> RawFd { self.inner.0 } } impl FromRawFd for UnixStream { unsafe fn from_raw_fd(fd: RawFd) -> UnixStream { UnixStream { inner: Inner(fd) } } } impl IntoRawFd for UnixStream { fn into_raw_fd(self) -> RawFd { let fd = self.inner.0; mem::forget(self); fd } } /// A structure representing a Unix domain socket server. /// /// # Examples /// /// ```rust,no_run /// use std::thread; /// use unix_socket::{UnixStream, UnixListener}; /// /// fn handle_client(stream: UnixStream) { /// // ... /// } /// /// let listener = UnixListener::bind("/path/to/the/socket").unwrap(); /// /// // accept connections and process them, spawning a new thread for each one /// for stream in listener.incoming() { /// match stream { /// Ok(stream) => { /// /* connection succeeded */ /// thread::spawn(|| handle_client(stream)); /// } /// Err(err) => { /// /* connection failed */ /// break; /// } /// } /// } /// /// // close the listener socket /// drop(listener); /// ``` pub struct UnixListener { inner: Inner, } impl fmt::Debug for UnixListener { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { let mut builder = fmt.debug_struct("UnixListener"); builder.field("fd", &self.inner.0); if let Ok(addr) = self.local_addr() { builder.field("local", &addr); } builder.finish() } } impl UnixListener { /// Creates a new `UnixListener` bound to the specified socket. /// /// Linux provides, as a nonportable extension, a separate "abstract" /// address namespace as opposed to filesystem-based addressing. If `path` /// begins with a null byte, it will be interpreted as an "abstract" /// address. Otherwise, it will be interpreted as a "pathname" address, /// corresponding to a path on the filesystem. pub fn bind>(path: P) -> io::Result { unsafe { let inner = try!(Inner::new(libc::SOCK_STREAM)); let (addr, len) = try!(sockaddr_un(path)); try!(cvt(libc::bind(inner.0, &addr as *const _ as *const _, len))); try!(cvt(libc::listen(inner.0, 128))); Ok(UnixListener { inner: inner }) } } /// Accepts a new incoming connection to this listener. /// /// This function will block the calling thread until a new Unix connection /// is established. When established, the corersponding `UnixStream` and /// the remote peer's address will be returned. pub fn accept(&self) -> io::Result<(UnixStream, SocketAddr)> { unsafe { let mut fd = 0; let addr = try!(SocketAddr::new(|addr, len| { fd = libc::accept(self.inner.0, addr, len); fd })); Ok((UnixStream { inner: Inner(fd) }, addr)) } } /// Creates a new independently owned handle to the underlying socket. /// /// The returned `UnixListener` is a reference to the same socket that this /// object references. Both handles can be used to accept incoming /// connections and options set on one listener will affect the other. pub fn try_clone(&self) -> io::Result { Ok(UnixListener { inner: try!(self.inner.try_clone()) }) } /// Returns the local socket address of this listener. pub fn local_addr(&self) -> io::Result { SocketAddr::new(|addr, len| unsafe { libc::getsockname(self.inner.0, addr, len) }) } /// Moves the socket into or out of nonblocking mode. pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> { self.inner.set_nonblocking(nonblocking) } /// Returns the value of the `SO_ERROR` option. pub fn take_error(&self) -> io::Result> { self.inner.take_error() } /// Returns an iterator over incoming connections. /// /// The iterator will never return `None` and will also not yield the /// peer's `SocketAddr` structure. pub fn incoming<'a>(&'a self) -> Incoming<'a> { Incoming { listener: self } } } impl AsRawFd for UnixListener { fn as_raw_fd(&self) -> RawFd { self.inner.0 } } impl FromRawFd for UnixListener { unsafe fn from_raw_fd(fd: RawFd) -> UnixListener { UnixListener { inner: Inner(fd) } } } impl IntoRawFd for UnixListener { fn into_raw_fd(self) -> RawFd { let fd = self.inner.0; mem::forget(self); fd } } impl<'a> IntoIterator for &'a UnixListener { type Item = io::Result; type IntoIter = Incoming<'a>; fn into_iter(self) -> Incoming<'a> { self.incoming() } } /// An iterator over incoming connections to a `UnixListener`. /// /// It will never return `None`. #[derive(Debug)] pub struct Incoming<'a> { listener: &'a UnixListener, } impl<'a> Iterator for Incoming<'a> { type Item = io::Result; fn next(&mut self) -> Option> { Some(self.listener.accept().map(|s| s.0)) } fn size_hint(&self) -> (usize, Option) { (usize::max_value(), None) } } /// A Unix datagram socket. /// /// # Examples /// /// ```rust,no_run /// use unix_socket::UnixDatagram; /// /// let socket = UnixDatagram::bind("/path/to/my/socket").unwrap(); /// socket.send_to(b"hello world", "/path/to/other/socket").unwrap(); /// let mut buf = [0; 100]; /// let (count, address) = socket.recv_from(&mut buf).unwrap(); /// println!("socket {:?} sent {:?}", address, &buf[..count]); /// ``` pub struct UnixDatagram { inner: Inner, } impl fmt::Debug for UnixDatagram { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { let mut builder = fmt.debug_struct("UnixDatagram"); builder.field("fd", &self.inner.0); if let Ok(addr) = self.local_addr() { builder.field("local", &addr); } if let Ok(addr) = self.peer_addr() { builder.field("peer", &addr); } builder.finish() } } impl UnixDatagram { /// Creates a Unix datagram socket bound to the given path. /// /// Linux provides, as a nonportable extension, a separate "abstract" /// address namespace as opposed to filesystem-based addressing. If `path` /// begins with a null byte, it will be interpreted as an "abstract" /// address. Otherwise, it will be interpreted as a "pathname" address, /// corresponding to a path on the filesystem. pub fn bind>(path: P) -> io::Result { unsafe { let inner = try!(Inner::new(libc::SOCK_DGRAM)); let (addr, len) = try!(sockaddr_un(path)); try!(cvt(libc::bind(inner.0, &addr as *const _ as *const _, len))); Ok(UnixDatagram { inner: inner }) } } /// Creates a Unix Datagram socket which is not bound to any address. pub fn unbound() -> io::Result { let inner = try!(Inner::new(libc::SOCK_DGRAM)); Ok(UnixDatagram { inner: inner }) } /// Create an unnamed pair of connected sockets. /// /// Returns two `UnixDatagrams`s which are connected to each other. pub fn pair() -> io::Result<(UnixDatagram, UnixDatagram)> { let (i1, i2) = try!(Inner::new_pair(libc::SOCK_DGRAM)); Ok((UnixDatagram { inner: i1 }, UnixDatagram { inner: i2 })) } /// Connects the socket to the specified address. /// /// The `send` method may be used to send data to the specified address. /// `recv` and `recv_from` will only receive data from that address. pub fn connect>(&self, path: P) -> io::Result<()> { unsafe { let (addr, len) = try!(sockaddr_un(path)); try!(cvt(libc::connect(self.inner.0, &addr as *const _ as *const _, len))); Ok(()) } } /// Returns the address of this socket. pub fn local_addr(&self) -> io::Result { SocketAddr::new(|addr, len| unsafe { libc::getsockname(self.inner.0, addr, len) }) } /// Returns the address of this socket's peer. /// /// The `connect` method will connect the socket to a peer. pub fn peer_addr(&self) -> io::Result { SocketAddr::new(|addr, len| unsafe { libc::getpeername(self.inner.0, addr, len) }) } /// Receives data from the socket. /// /// On success, returns the number of bytes read and the address from /// whence the data came. pub fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { let mut count = 0; let addr = try!(SocketAddr::new(|addr, len| { unsafe { count = libc::recvfrom(self.inner.0, buf.as_mut_ptr() as *mut _, buf.len(), 0, addr, len); if count > 0 { 1 } else if count == 0 { 0 } else { -1 } } })); Ok((count as usize, addr)) } /// Receives data from the socket. /// /// On success, returns the number of bytes read. pub fn recv(&self, buf: &mut [u8]) -> io::Result { unsafe { let count = try!(cvt_s(libc::recv(self.inner.0, buf.as_mut_ptr() as *mut _, buf.len(), 0))); Ok(count as usize) } } /// Sends data on the socket to the specified address. /// /// On success, returns the number of bytes written. pub fn send_to>(&self, buf: &[u8], path: P) -> io::Result { unsafe { let (addr, len) = try!(sockaddr_un(path)); let count = try!(cvt_s(libc::sendto(self.inner.0, buf.as_ptr() as *const _, buf.len(), 0, &addr as *const _ as *const _, len))); Ok(count as usize) } } /// Sends data on the socket to the socket's peer. /// /// The peer address may be set by the `connect` method, and this method /// will return an error if the socket has not already been connected. /// /// On success, returns the number of bytes written. pub fn send(&self, buf: &[u8]) -> io::Result { unsafe { let count = try!(cvt_s(libc::send(self.inner.0, buf.as_ptr() as *const _, buf.len(), 0))); Ok(count as usize) } } /// Sets the read timeout for the socket. /// /// If the provided value is `None`, then `recv` and `recv_from` calls will /// block indefinitely. It is an error to pass the zero `Duration` to this /// method. pub fn set_read_timeout(&self, timeout: Option) -> io::Result<()> { self.inner.set_timeout(timeout, libc::SO_RCVTIMEO) } /// Sets the write timeout for the socket. /// /// If the provided value is `None`, then `send` and `send_to` calls will /// block indefinitely. It is an error to pass the zero `Duration` to this /// method. pub fn set_write_timeout(&self, timeout: Option) -> io::Result<()> { self.inner.set_timeout(timeout, libc::SO_SNDTIMEO) } /// Returns the read timeout of this socket. pub fn read_timeout(&self) -> io::Result> { self.inner.timeout(libc::SO_RCVTIMEO) } /// Returns the write timeout of this socket. pub fn write_timeout(&self) -> io::Result> { self.inner.timeout(libc::SO_SNDTIMEO) } /// Moves the socket into or out of nonblocking mode. pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> { self.inner.set_nonblocking(nonblocking) } /// Returns the value of the `SO_ERROR` option. pub fn take_error(&self) -> io::Result> { self.inner.take_error() } /// Shut down the read, write, or both halves of this connection. /// /// This function will cause all pending and future I/O calls on the /// specified portions to immediately return with an appropriate value /// (see the documentation of `Shutdown`). pub fn shutdown(&self, how: Shutdown) -> io::Result<()> { self.inner.shutdown(how) } } impl AsRawFd for UnixDatagram { fn as_raw_fd(&self) -> RawFd { self.inner.0 } } impl FromRawFd for UnixDatagram { unsafe fn from_raw_fd(fd: RawFd) -> UnixDatagram { UnixDatagram { inner: Inner(fd) } } } impl IntoRawFd for UnixDatagram { fn into_raw_fd(self) -> RawFd { let fd = self.inner.0; mem::forget(self); fd } } #[cfg(test)] mod test { extern crate tempdir; use std::thread; use std::io; use std::io::prelude::*; use std::time::Duration; use self::tempdir::TempDir; use super::*; macro_rules! or_panic { ($e:expr) => { match $e { Ok(e) => e, Err(e) => panic!("{}", e), } } } #[test] fn basic() { let dir = or_panic!(TempDir::new("unix_socket")); let socket_path = dir.path().join("sock"); let msg1 = b"hello"; let msg2 = b"world!"; let listener = or_panic!(UnixListener::bind(&socket_path)); let thread = thread::spawn(move || { let mut stream = or_panic!(listener.accept()).0; let mut buf = [0; 5]; or_panic!(stream.read(&mut buf)); assert_eq!(&msg1[..], &buf[..]); or_panic!(stream.write_all(msg2)); }); let mut stream = or_panic!(UnixStream::connect(&socket_path)); assert_eq!(Some(&*socket_path), stream.peer_addr().unwrap().as_pathname()); or_panic!(stream.write_all(msg1)); let mut buf = vec![]; or_panic!(stream.read_to_end(&mut buf)); assert_eq!(&msg2[..], &buf[..]); drop(stream); thread.join().unwrap(); } #[test] fn pair() { let msg1 = b"hello"; let msg2 = b"world!"; let (mut s1, mut s2) = or_panic!(UnixStream::pair()); let thread = thread::spawn(move || { // s1 must be moved in or the test will hang! let mut buf = [0; 5]; or_panic!(s1.read(&mut buf)); assert_eq!(&msg1[..], &buf[..]); or_panic!(s1.write_all(msg2)); }); or_panic!(s2.write_all(msg1)); let mut buf = vec![]; or_panic!(s2.read_to_end(&mut buf)); assert_eq!(&msg2[..], &buf[..]); drop(s2); thread.join().unwrap(); } #[test] #[cfg(target_os = "linux")] fn abstract_address() { use os::linux::SocketAddrExt; let socket_path = "\0the path"; let msg1 = b"hello"; let msg2 = b"world!"; let listener = or_panic!(UnixListener::bind(&socket_path)); let thread = thread::spawn(move || { let mut stream = or_panic!(listener.accept()).0; let mut buf = [0; 5]; or_panic!(stream.read(&mut buf)); assert_eq!(&msg1[..], &buf[..]); or_panic!(stream.write_all(msg2)); }); let mut stream = or_panic!(UnixStream::connect(&socket_path)); assert_eq!(Some(&b"the path"[..]), stream.peer_addr().unwrap().as_abstract()); or_panic!(stream.write_all(msg1)); let mut buf = vec![]; or_panic!(stream.read_to_end(&mut buf)); assert_eq!(&msg2[..], &buf[..]); drop(stream); thread.join().unwrap(); } #[test] fn try_clone() { let dir = or_panic!(TempDir::new("unix_socket")); let socket_path = dir.path().join("sock"); let msg1 = b"hello"; let msg2 = b"world"; let listener = or_panic!(UnixListener::bind(&socket_path)); let thread = thread::spawn(move || { let mut stream = or_panic!(listener.accept()).0; or_panic!(stream.write_all(msg1)); or_panic!(stream.write_all(msg2)); }); let mut stream = or_panic!(UnixStream::connect(&socket_path)); let mut stream2 = or_panic!(stream.try_clone()); let mut buf = [0; 5]; or_panic!(stream.read(&mut buf)); assert_eq!(&msg1[..], &buf[..]); or_panic!(stream2.read(&mut buf)); assert_eq!(&msg2[..], &buf[..]); thread.join().unwrap(); } #[test] fn iter() { let dir = or_panic!(TempDir::new("unix_socket")); let socket_path = dir.path().join("sock"); let listener = or_panic!(UnixListener::bind(&socket_path)); let thread = thread::spawn(move || { for stream in listener.incoming().take(2) { let mut stream = or_panic!(stream); let mut buf = [0]; or_panic!(stream.read(&mut buf)); } }); for _ in 0..2 { let mut stream = or_panic!(UnixStream::connect(&socket_path)); or_panic!(stream.write_all(&[0])); } thread.join().unwrap(); } #[test] fn long_path() { let dir = or_panic!(TempDir::new("unix_socket")); let socket_path = dir.path() .join("asdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfasdfa\ sasdfasdfasdasdfasdfasdfadfasdfasdfasdfasdfasdf"); match UnixStream::connect(&socket_path) { Err(ref e) if e.kind() == io::ErrorKind::InvalidInput => {} Err(e) => panic!("unexpected error {}", e), Ok(_) => panic!("unexpected success"), } match UnixListener::bind(&socket_path) { Err(ref e) if e.kind() == io::ErrorKind::InvalidInput => {} Err(e) => panic!("unexpected error {}", e), Ok(_) => panic!("unexpected success"), } match UnixDatagram::bind(&socket_path) { Err(ref e) if e.kind() == io::ErrorKind::InvalidInput => {} Err(e) => panic!("unexpected error {}", e), Ok(_) => panic!("unexpected success"), } } #[test] fn timeouts() { let dir = or_panic!(TempDir::new("unix_socket")); let socket_path = dir.path().join("sock"); let _listener = or_panic!(UnixListener::bind(&socket_path)); let stream = or_panic!(UnixStream::connect(&socket_path)); let dur = Duration::new(15410, 0); assert_eq!(None, or_panic!(stream.read_timeout())); or_panic!(stream.set_read_timeout(Some(dur))); assert_eq!(Some(dur), or_panic!(stream.read_timeout())); assert_eq!(None, or_panic!(stream.write_timeout())); or_panic!(stream.set_write_timeout(Some(dur))); assert_eq!(Some(dur), or_panic!(stream.write_timeout())); or_panic!(stream.set_read_timeout(None)); assert_eq!(None, or_panic!(stream.read_timeout())); or_panic!(stream.set_write_timeout(None)); assert_eq!(None, or_panic!(stream.write_timeout())); } #[test] fn test_read_timeout() { let dir = or_panic!(TempDir::new("unix_socket")); let socket_path = dir.path().join("sock"); let _listener = or_panic!(UnixListener::bind(&socket_path)); let mut stream = or_panic!(UnixStream::connect(&socket_path)); or_panic!(stream.set_read_timeout(Some(Duration::from_millis(1000)))); let mut buf = [0; 10]; let kind = stream.read(&mut buf).err().expect("expected error").kind(); assert!(kind == io::ErrorKind::WouldBlock || kind == io::ErrorKind::TimedOut); } #[test] fn test_read_with_timeout() { let dir = or_panic!(TempDir::new("unix_socket")); let socket_path = dir.path().join("sock"); let listener = or_panic!(UnixListener::bind(&socket_path)); let mut stream = or_panic!(UnixStream::connect(&socket_path)); or_panic!(stream.set_read_timeout(Some(Duration::from_millis(1000)))); let mut other_end = or_panic!(listener.accept()).0; or_panic!(other_end.write_all(b"hello world")); let mut buf = [0; 11]; or_panic!(stream.read(&mut buf)); assert_eq!(b"hello world", &buf[..]); let kind = stream.read(&mut buf).err().expect("expected error").kind(); assert!(kind == io::ErrorKind::WouldBlock || kind == io::ErrorKind::TimedOut); } #[test] fn test_unix_datagram() { let dir = or_panic!(TempDir::new("unix_socket")); let path1 = dir.path().join("sock1"); let path2 = dir.path().join("sock2"); let sock1 = or_panic!(UnixDatagram::bind(&path1)); let sock2 = or_panic!(UnixDatagram::bind(&path2)); let msg = b"hello world"; or_panic!(sock1.send_to(msg, &path2)); let mut buf = [0; 11]; or_panic!(sock2.recv_from(&mut buf)); assert_eq!(msg, &buf[..]); } #[test] fn test_unnamed_unix_datagram() { let dir = or_panic!(TempDir::new("unix_socket")); let path1 = dir.path().join("sock1"); let sock1 = or_panic!(UnixDatagram::bind(&path1)); let sock2 = or_panic!(UnixDatagram::unbound()); let msg = b"hello world"; or_panic!(sock2.send_to(msg, &path1)); let mut buf = [0; 11]; let (usize, addr) = or_panic!(sock1.recv_from(&mut buf)); assert_eq!(usize, 11); assert!(addr.is_unnamed()); assert_eq!(msg, &buf[..]); } #[test] fn test_connect_unix_datagram() { let dir = or_panic!(TempDir::new("unix_socket")); let path1 = dir.path().join("sock1"); let path2 = dir.path().join("sock2"); let bsock1 = or_panic!(UnixDatagram::bind(&path1)); let bsock2 = or_panic!(UnixDatagram::bind(&path2)); let sock = or_panic!(UnixDatagram::unbound()); or_panic!(sock.connect(&path1)); // Check send() let msg = b"hello there"; or_panic!(sock.send(msg)); let mut buf = [0; 11]; let (usize, addr) = or_panic!(bsock1.recv_from(&mut buf)); assert_eq!(usize, 11); assert!(addr.is_unnamed()); assert_eq!(msg, &buf[..]); // Changing default socket works too or_panic!(sock.connect(&path2)); or_panic!(sock.send(msg)); or_panic!(bsock2.recv_from(&mut buf)); } #[test] fn test_unix_datagram_recv() { let dir = or_panic!(TempDir::new("unix_socket")); let path1 = dir.path().join("sock1"); let sock1 = or_panic!(UnixDatagram::bind(&path1)); let sock2 = or_panic!(UnixDatagram::unbound()); or_panic!(sock2.connect(&path1)); let msg = b"hello world"; or_panic!(sock2.send(msg)); let mut buf = [0; 11]; let size = or_panic!(sock1.recv(&mut buf)); assert_eq!(size, 11); assert_eq!(msg, &buf[..]); } #[test] fn datagram_pair() { let msg1 = b"hello"; let msg2 = b"world!"; let (s1, s2) = or_panic!(UnixDatagram::pair()); let thread = thread::spawn(move || { // s1 must be moved in or the test will hang! let mut buf = [0; 5]; or_panic!(s1.recv(&mut buf)); assert_eq!(&msg1[..], &buf[..]); or_panic!(s1.send(msg2)); }); or_panic!(s2.send(msg1)); let mut buf = [0; 6]; or_panic!(s2.recv(&mut buf)); assert_eq!(&msg2[..], &buf[..]); drop(s2); thread.join().unwrap(); } }