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
/*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
*
* Copyright 2023 Robert D. French
*/
//! A Rust-friendly interface for [illumos Doors][1].
//!
//! [Doors][2] are a high-speed, RPC-style interprocess communication facility
//! for the [illumos][3] operating system. They enable rapid dialogue between
//! client and server without giving up the CPU timeslice, and are an excellent
//! alternative to pipes or UNIX domain sockets in situations where IPC latency
//! matters.
//!
//! This crate makes it easier to interact with the Doors API from Rust. It can
//! help you create clients, define server procedures, and open or create doors
//! on the filesystem.
//!
//! ## Example
//! ```
//! // In the Server --------------------------------------- //
//! use doors::server::Door;
//! use doors::server::Request;
//! use doors::server::Response;
//!
//! #[doors::server_procedure]
//! fn double(x: Request) -> Response<[u8; 1]> {
//! if x.data.len() > 0 {
//! return Response::new([x.data[0] * 2]);
//! } else {
//! // We were given nothing, and 2 times nothing is zero...
//! return Response::new([0]);
//! }
//! }
//!
//! let door = Door::create(double).unwrap();
//! door.force_install("/tmp/double.door").unwrap();
//!
//! // In the Client --------------------------------------- //
//! use doors::Client;
//!
//! let client = Client::open("/tmp/double.door").unwrap();
//!
//! let response = client.call_with_data(&[111]).unwrap();
//! assert_eq!(response.data()[0], 222);
//! ```
//!
//! [1]: https://github.com/robertdfrench/revolving-doors
//! [2]: https://illumos.org/man/3C/door_create
//! [3]: https://illumos.org
pub use door_macros::server_procedure;
pub mod illumos;
pub mod server;
use crate::illumos::door_h::door_arg_t;
use crate::illumos::door_h::door_call;
use crate::illumos::errno_h::errno;
use crate::illumos::DoorArg;
use crate::illumos::DoorFd;
use std::fs::File;
use std::io;
use std::os::fd::FromRawFd;
use std::os::fd::IntoRawFd;
use std::os::fd::RawFd;
use std::path::Path;
/// Failure conditions for [`door_call`].
///
/// According to [`door_call(3C)`], if a [`door_call`] fails, errno will be set
/// to one of these values. While this enum is not strictly derived from
/// anything in [doors.h][1], it is spelled out in the man page.
///
/// [`door_call(3C)`]: https://illumos.org/man/3C/door_call
/// [1]: https://github.com/illumos/illumos-gate/blob/master/usr/src/uts/common/sys/door.h
#[derive(Debug, PartialEq)]
pub enum DoorCallError {
/// Arguments were too big for server thread stack.
E2BIG,
/// Server was out of available resources.
EAGAIN,
/// Invalid door descriptor was passed.
EBADF,
/// Argument pointers pointed outside the allocated address space.
EFAULT,
/// A signal was caught in the client, the client called [`fork(2)`], or the
/// server exited during invocation.
///
/// [`fork(2)`]: https://illumos.org/man/2/fork
EINTR,
/// Bad arguments were passed.
EINVAL,
/// The client or server has too many open descriptors.
EMFILE,
/// The desc_num argument is larger than the door's `DOOR_PARAM_DESC_MAX`
/// parameter (see [`door_getparam(3C)`]), and the door does not have the
/// [`DOOR_REFUSE_DESC`][crate::illumos::door_h::DOOR_REFUSE_DESC] set.
///
/// [`door_getparam(3C)`]: https://illumos.org/man/3C/door_getparam
ENFILE,
/// The data_size argument is larger than the door's `DOOR_PARAM_DATA_MAX`
/// parameter, or smaller than the door's `DOOR_PARAM_DATA_MIN` parameter
/// (see [`door_getparam(3C)`]).
///
/// [`door_getparam(3C)`]: https://illumos.org/man/3C/door_getparam
ENOBUFS,
/// The desc_num argument is non-zero and the door has the
/// [`DOOR_REFUSE_DESC`][crate::illumos::door_h::DOOR_REFUSE_DESC] flag set.
ENOTSUP,
/// System could not create overflow area in caller for results.
EOVERFLOW,
}
/// Less unsafe door client (compared to raw file descriptors)
///
/// Clients are automatically closed when they go out of scope. Errors detected
/// on closing are ignored by the implementation of `Drop`, just like in
/// [`File`].
pub struct Client(RawFd);
impl FromRawFd for Client {
unsafe fn from_raw_fd(raw: RawFd) -> Self {
Self(raw)
}
}
impl Drop for Client {
/// Automatically close the door on your way out.
///
/// This will close the file descriptor associated with this door, so that
/// this process will no longer be able to call this door. For that reason,
/// it is a programming error to [`Clone`] this type.
fn drop(&mut self) {
unsafe { libc::close(self.0) };
}
}
pub enum DoorArgument {
BorrowedRbuf(DoorArg),
OwnedRbuf(DoorArg),
}
impl DoorArgument {
pub fn new(
data: &[u8],
descriptors: &[DoorFd],
response: &mut [u8],
) -> Self {
Self::borrowed_rbuf(data, descriptors, response)
}
pub fn borrowed_rbuf(
data: &[u8],
descriptors: &[DoorFd],
response: &mut [u8],
) -> Self {
Self::BorrowedRbuf(DoorArg::new(data, descriptors, response))
}
pub fn owned_rbuf(
data: &[u8],
descriptors: &[DoorFd],
response: &mut [u8],
) -> Self {
Self::OwnedRbuf(DoorArg::new(data, descriptors, response))
}
fn inner(&self) -> &DoorArg {
match self {
Self::BorrowedRbuf(inner) => inner,
Self::OwnedRbuf(inner) => inner,
}
}
fn inner_mut(&mut self) -> &mut DoorArg {
match self {
Self::BorrowedRbuf(inner) => inner,
Self::OwnedRbuf(inner) => inner,
}
}
pub fn as_door_arg_t(&self) -> &door_arg_t {
self.inner().as_door_arg_t()
}
pub fn data(&self) -> &[u8] {
self.inner().data()
}
pub fn rbuf(&self) -> &[u8] {
self.inner().rbuf()
}
}
impl Drop for DoorArgument {
fn drop(&mut self) {
if let Self::OwnedRbuf(arg) = self {
// If munmap fails, we do want to panic, because it means we've
// tried to munmap something that wasn't mapped into our address
// space. That should never happen, but if it does, it's worth
// crashing, because something else is seriously wrong.
arg.munmap_rbuf().unwrap()
}
}
}
impl Client {
/// Open a door client like you would a file
pub fn open<P: AsRef<Path>>(path: P) -> io::Result<Self> {
let file = File::open(path)?;
Ok(Self(file.into_raw_fd()))
}
/// Issue a door call
///
/// You are responsible for managing this memory. See [`DOOR_CALL(3C)`].
/// Particularly, if, after a `door_call`, the `rbuf` property of
/// [`door_arg_t`] is different than what it was before the `door_call`, you
/// are responsible for reclaiming this area with [`MUNMAP(2)`] when you are
/// done with it.
///
/// This crate cannot yet handle this for you. See [Issue
/// #11](https://github.com/robertdfrench/rusty-doors/issues/11).
///
/// [`DOOR_CALL(3C)`]: https://illumos.org/man/3C/door_call
/// [`MUNMAP(2)`]: https://illumos.org/man/2/munmap
pub fn call(
&self,
mut arg: DoorArgument,
) -> Result<DoorArgument, DoorCallError> {
let a = arg.inner().rbuf_addr();
let x = arg.inner_mut().as_mut_door_arg_t();
match unsafe { door_call(self.0, x) } {
0 => match (x.rbuf as u64) == a {
true => Ok(arg),
false => {
let data = unsafe {
std::slice::from_raw_parts(
x.data_ptr as *const u8,
x.data_size,
)
};
let desc = unsafe {
std::slice::from_raw_parts(
x.desc_ptr as *const DoorFd,
x.desc_num.try_into().unwrap(),
)
};
let rbuf = unsafe {
std::slice::from_raw_parts_mut(
x.rbuf as *mut u8,
x.rsize,
)
};
Ok(DoorArgument::owned_rbuf(data, desc, rbuf))
}
},
_ => Err(match errno() {
libc::E2BIG => DoorCallError::E2BIG,
libc::EAGAIN => DoorCallError::EAGAIN,
libc::EBADF => DoorCallError::EBADF,
libc::EFAULT => DoorCallError::EFAULT,
libc::EINTR => DoorCallError::EINTR,
libc::EINVAL => DoorCallError::EINVAL,
libc::EMFILE => DoorCallError::EMFILE,
libc::ENFILE => DoorCallError::ENFILE,
libc::ENOBUFS => DoorCallError::ENOBUFS,
libc::ENOTSUP => DoorCallError::ENOTSUP,
libc::EOVERFLOW => DoorCallError::EOVERFLOW,
_ => unreachable!(),
}),
}
}
/// Issue a door call with Data only
///
/// ## Example
///
/// ```rust
/// use doors::Client;
/// use std::ffi::CString;
/// use std::ffi::CStr;
///
/// let capitalize = Client::open("/tmp/barebones_capitalize.door")
/// .unwrap();
/// let text = CString::new("Hello, World!").unwrap();
/// let response = capitalize.call_with_data(text.as_bytes()).unwrap();
/// let caps = unsafe {
/// CStr::from_ptr(response.data().as_ptr() as *const i8)
/// };
/// assert_eq!(caps.to_str(), Ok("HELLO, WORLD!"));
/// ```
pub fn call_with_data(
&self,
data: &[u8],
) -> Result<DoorArgument, DoorCallError> {
let arg = DoorArgument::new(data, &[], &mut []);
self.call(arg)
}
}