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
// Copyright John Nunley, 2022.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE or copy at
// https://www.boost.org/LICENSE_1_0.txt)
//! Implementation of the [`Connection`] type, which is used as a byte
//! transport for the actual X11 protocol.
//!
//! X11 communication can take place over "any reliable byte stream"
//! ([source]). Although this byte stream is most often a TCP connection
//! or a Unix domain socket, it can be anything else. The [`Connection`]
//! trait aims to define the interface for this byte stream.
//!
//! Note that in the overwhelming majority of cases, [`NameConnection`] will
//! fulfill all of your connection-related needs. All other connection types
//! exist to give the user as much freedom as possible in using the protocol.
//!
//! ## Details
//!
//! In X11, the requirements for a byte stream include:
//!
//! - Being able to write bytes.
//! - Being able to read bytes.
//! - Being able to read bytes without blocking.
//!
//! In addition, certain extensions requires the ability to pass file
//! descriptors between the client and the server. This is not a requirement.
//!
//! - [`StdConnection`] (enabled with the `std` feature) is a wrapper around
//! any type that implements [`Read`] and [`Write`]. In addition, it also
//! requires [`AsRawFd`] on Unix and [`AsRawSocket`] on Windows, in order to
//! take advantage of system APIs for non-blocking I/O.
//! - [`SendmsgConnection`] (requires Unix) is a wrapper around a Unix domain
//! socket that includes message passing functionality.
//! - [`BufConnection`] is a wrapper around anything that implements [`Connection`]
//! that buffers all data written to and read from it.
//!
//! [`Connection`]: crate::connection::Connection
//! [source]: https://www.x.org/releases/X11R7.5/doc/x11proto/proto.pdf
//! [`NameConnection`]: crate::name::NameConnection
//! [`StdConnection`]: crate::connection::StdConnection
//! [`Read`]: std::io::Read
//! [`Write`]: std::io::Write
//! [`AsRawFd`]: std::os::unix::io::AsRawFd
//! [`AsRawSocket`]: std::os::windows::io::AsRawSocket
//! [`SendmsgConnection`]: crate::connection::SendmsgConnection
//! [`BufConnection`]: crate::connection::BufConnection
use crate::{Error, Fd, InvalidState, Result};
use alloc::vec::Vec;
mod buffered;
pub use buffered::BufConnection;
cfg_std_unix! {
mod sendmsg;
pub use sendmsg::SendmsgConnection;
}
cfg_test! {
mod test;
pub(crate) use test::with_test_connection;
}
cfg_std! {
pub(crate) type IoSlice<'a> = std::io::IoSlice<'a>;
pub(crate) type IoSliceMut<'a> = std::io::IoSliceMut<'a>;
mod std_wrapper;
pub use std_wrapper::StdConnection;
}
cfg_no_std! {
pub(crate) type IoSlice<'a> = &'a [u8];
pub(crate) type IoSliceMut<'a> = &'a mut [u8];
}
/// A "suitable byte stream" where communication with the X11 server can occur.
///
/// See the [module level documentation](index.html) for more details.
pub trait Connection {
/// Write a series of I/O slices and a series of file descriptors to
/// the X11 server.
///
/// This calls the platform's writing utility to write the slices and
/// file descriptors, and returns the number of bytes written. If
/// the call succeeded, the `fds` array should be empty after operation.
///
/// If the `fds` array is empty, this function call is allowed to
/// degenerate to a standard vectored write.
///
/// # Blocking
///
/// This operation may block under normal circumstances. However, if this
/// type implements `AsRawFd` or `AsRawSocket`, and if `set_nonblocking`
/// or an equivalent method has been called on this object earlier, then
/// this operation should not block, and return a `WouldBlock` error if
/// it would.
///
/// # Errors
///
/// Some `Connection` implementations do not support FD passing. If an
/// FD is passed into these implementations, an `unsupported()` [`Error`]
/// will be raised.
///
/// In addition, any platform I/O errors will be bubbled up to the user.
fn send_slices_and_fds(&mut self, slices: &[IoSlice<'_>], fds: &mut Vec<Fd>) -> Result<usize>;
/// Write a series of I/O slices to the X11 server.
///
/// This calls the platform's writing utility to write the slices, and
/// returns the number of bytes written. By default, this is implemented
/// as a call to `send_slices_and_fds` without any file descriptors.
/// Certain implementations can optimize away having to keep track
/// of file descriptors.
///
/// # Blocking
///
/// Same as `send_slices_and_fds`.
///
/// # Errors
///
/// Same as `send_slices_and_fds`.
fn send_slices(&mut self, slices: &[IoSlice<'_>]) -> Result<usize> {
self.send_slices_and_fds(slices, &mut Vec::new())
}
/// Write a slice of data to the X11 server.
///
/// This calls the platform's writing utility to write the slice, and
/// returs the number of bytes written. By default, this is implemented
/// as a call to `send_slices`.
///
/// # Blocking
///
/// Same as `send_slices_and_fds`.
///
/// # Errors
///
/// Same as `send_slices`.
fn send_slice(&mut self, slice: &[u8]) -> Result<usize> {
self.send_slices(&[new_io_slice(slice)])
}
/// Read data to a series of I/O slices and a buffer for file
/// descriptors.
///
/// This calls the platform's reading utility to read into the buffers,
/// and returns the total number of bytes read.
///
/// # Blocking
///
/// This operation may block under normal circumstances. However, if this
/// type implements `AsRawFd` or `AsRawSocket`, and if `set_nonblocking`
/// or an equivalent method has been called on this object earlier, then
/// this operation should not block, and return a `WouldBlock` error if
/// it would.
///
/// # Errors
///
/// Any platform I/O errors will be bubbled up to the user.
fn recv_slices_and_fds(
&mut self,
slices: &mut [IoSliceMut<'_>],
fds: &mut Vec<Fd>,
) -> Result<usize>;
/// Read data to a single I/O slice and a buffer for file
/// descriptors.
///
/// This calls the platform's reading utility to read into the buffers,
/// and returns the total number of bytes read. By default, this is
/// implemented as a call to `recv_slices_and_fds` with a single
/// slice.
///
/// # Blocking
///
/// Same as `recv_slices_and_fds`.
///
/// # Errors
///
/// Any platform I/O errors will be bubbled up to the user.
fn recv_slice_and_fds(&mut self, slice: &mut [u8], fds: &mut Vec<Fd>) -> Result<usize> {
self.recv_slices_and_fds(&mut [new_io_slice_mut(slice)], fds)
}
/// Read data for a single I/O slice.
///
/// This calls the platform's reading utility to read into the buffer,
/// and returns the total number of bytes read. By default, this is
/// implemented as a call to `recv_slice_and_fds` with a single slice.
///
/// # Blocking
///
/// Same as `recv_slices_and_fds`.
///
/// # Errors
///
/// If `recv_slice_and_fds` returns any file descriptors, this
/// function will return an `invalid_state()` error. It is encouraged
/// for implementors to override this behavior so that this check is
/// not necessary.
///
/// In addition, any platform I/O errors will be bubbled up to the
/// user.
fn recv_slice(&mut self, slice: &mut [u8]) -> Result<usize> {
let mut fds = Vec::new();
let result = self.recv_slice_and_fds(slice, &mut fds);
// check to ensure fds is empty
if fds.is_empty() {
result
} else {
Err(Error::make_invalid_state(InvalidState::UnexpectedFds))
}
}
/// Flush all data in this connection's buffer.
///
/// # Blocking
///
/// Unless this connection has been set into non-blocking mode, this
/// method is expected to block until all bytes in the buffer are
/// written.
///
/// # Errors
///
/// Any platform I/O errors will be bubbled up to the user.
fn flush(&mut self) -> Result<()>;
/// Receive data from the X11 server into a set of I/O slices, in a
/// non-blocking manner.
///
/// # Blocking
///
/// Even if the connection is in blocking mode, this function should
/// never block.
///
/// # Errors
///
/// This will return a `WouldBlock` I/O error if the function would
/// block. Otherwise, it should bubble up any platform I/O errors.
fn non_blocking_recv_slices_and_fds(
&mut self,
slices: &mut [IoSliceMut<'_>],
fds: &mut Vec<Fd>,
) -> Result<usize>;
/// Receive data from the X11 server into a single slice, in a
/// non-blocking manner.
///
/// # Errors
///
/// Same as `non_blocking_recv_slices_and_fds`.
fn non_blocking_recv_slice_and_fds(
&mut self,
slice: &mut [u8],
fds: &mut Vec<Fd>,
) -> Result<usize> {
self.non_blocking_recv_slices_and_fds(&mut [new_io_slice_mut(slice)], fds)
}
/// Shutdown this connection.
///
/// This should have the same effect as dropping this object, but
/// any OS errors should be able to be caught.
///
/// # Blocking
///
/// This function should never block.
///
/// # Errors
///
/// Any OS errors should be bubbled up to the user.
fn shutdown(&self) -> Result<()>;
}
// implement Connection for all &mut impl Connection
impl<C: Connection + ?Sized> Connection for &mut C {
fn send_slices_and_fds(&mut self, slices: &[IoSlice<'_>], fds: &mut Vec<Fd>) -> Result<usize> {
(**self).send_slices_and_fds(slices, fds)
}
fn send_slices(&mut self, slices: &[IoSlice<'_>]) -> Result<usize> {
(**self).send_slices(slices)
}
fn send_slice(&mut self, slice: &[u8]) -> Result<usize> {
(**self).send_slice(slice)
}
fn recv_slices_and_fds(
&mut self,
slices: &mut [IoSliceMut<'_>],
fds: &mut Vec<Fd>,
) -> Result<usize> {
(**self).recv_slices_and_fds(slices, fds)
}
fn recv_slice_and_fds(&mut self, slice: &mut [u8], fds: &mut Vec<Fd>) -> Result<usize> {
(**self).recv_slice_and_fds(slice, fds)
}
fn recv_slice(&mut self, slice: &mut [u8]) -> Result<usize> {
(**self).recv_slice(slice)
}
fn flush(&mut self) -> Result<()> {
(**self).flush()
}
fn non_blocking_recv_slices_and_fds(
&mut self,
slices: &mut [IoSliceMut<'_>],
fds: &mut Vec<Fd>,
) -> Result<usize> {
(**self).non_blocking_recv_slices_and_fds(slices, fds)
}
fn non_blocking_recv_slice_and_fds(
&mut self,
slice: &mut [u8],
fds: &mut Vec<Fd>,
) -> Result<usize> {
(**self).non_blocking_recv_slice_and_fds(slice, fds)
}
fn shutdown(&self) -> Result<()> {
(**self).shutdown()
}
}
cfg_std! {
pub(crate) fn new_io_slice(sl: &[u8]) -> IoSlice<'_> {
IoSlice::new(sl)
}
pub(crate) fn new_io_slice_mut(sl: &mut [u8]) -> IoSliceMut<'_> {
IoSliceMut::new(sl)
}
pub(crate) fn advance_io(sl: &mut IoSlice<'_>, bytes: usize) {
advance::advance(sl, bytes);
}
}
cfg_no_std! {
pub(crate) fn new_io_slice(sl: &[u8]) -> IoSlice<'_> {
sl
}
pub(crate) fn new_io_slice_mut(sl: &mut [u8]) -> IoSliceMut<'_> {
sl
}
pub(crate) fn advance_io(sl: &mut IoSlice<'_>, bytes: usize) {
*sl = &sl[bytes..];
}
}