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 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
use std::{
os::unix::{
io::{AsRawFd, RawFd},
net::UnixStream,
},
sync::{Arc, Mutex, RwLock},
};
use nix::poll::PollFlags;
use once_cell::sync::OnceCell;
use crate::{
fdo,
handshake::{Authenticated, ClientHandshake, ServerHandshake},
raw::Connection as RawConnection,
utils::wait_on,
Error, Guid, Message, MessageType, Result,
};
type MessageHandlerFn = Box<(dyn FnMut(Message) -> Option<Message> + Send)>;
pub(crate) const DEFAULT_MAX_QUEUED: usize = 32;
const LOCK_FAIL_MSG: &str = "Failed to lock a mutex or read-write lock";
#[derive(derivative::Derivative)]
#[derivative(Debug)]
struct ConnectionInner<S> {
server_guid: Guid,
cap_unix_fd: bool,
bus_conn: bool,
unique_name: OnceCell<String>,
raw_conn: RwLock<RawConnection<S>>,
// Serial number for next outgoing message
serial: Mutex<u32>,
// Queue of incoming messages
incoming_queue: Mutex<Vec<Message>>,
// Max number of messages to queue
max_queued: RwLock<usize>,
#[derivative(Debug = "ignore")]
default_msg_handler: Mutex<Option<MessageHandlerFn>>,
}
/// A D-Bus connection.
///
/// A connection to a D-Bus bus, or a direct peer.
///
/// Once created, the connection is authenticated and negotiated and messages can be sent or
/// received, such as [method calls] or [signals].
///
/// For higher-level message handling (typed functions, introspection, documentation reasons etc),
/// it is recommended to wrap the low-level D-Bus messages into Rust functions with the
/// [`dbus_proxy`] and [`dbus_interface`] macros instead of doing it directly on a `Connection`.
///
/// For lower-level handling of the connection (such as nonblocking socket handling), see the
/// documentation of the [`new_authenticated_unix`] constructor.
///
/// Typically, a connection is made to the session bus with [`new_session`], or to the system bus
/// with [`new_system`]. Then the connection is shared with the [`Proxy`] and [`ObjectServer`]
/// instances.
///
/// `Connection` implements [`Clone`] and cloning it is a very cheap operation, as the underlying
/// data is not cloned. This makes it very convenient to share the connection between different
/// parts of your code. `Connection` also implements [`std::marker::Sync`] and[`std::marker::Send`]
/// so you can send and share a connection instance across threads as well.
///
/// NB: If you want to send and receive messages from multiple threads at the same time, it's
/// usually better to create unique connections for each thread. Otherwise you can end up with
/// deadlocks. For example, if one thread tries to send a message on a connection, while another is
/// waiting to receive a message on the bus, the former will block until the latter receives a
/// message.
///
/// Since there are times when important messages arrive between a method call message is sent and
/// its reply is received, `Connection` keeps an internal queue of incoming messages so that these
/// messages are not lost and subsequent calls to [`receive_message`] will retreive messages from
/// this queue first. The size of this queue is configurable through the [`set_max_queued`] method.
/// The default size is 32. All messages that are received after the queue is full, are dropped.
///
/// [method calls]: struct.Connection.html#method.call_method
/// [signals]: struct.Connection.html#method.emit_signal
/// [`new_system`]: struct.Connection.html#method.new_system
/// [`new_session`]: struct.Connection.html#method.new_session
/// [`new_authenticated_unix`]: struct.Connection.html#method.new_authenticated_unix
/// [`Proxy`]: struct.Proxy.html
/// [`ObjectServer`]: struct.ObjectServer.html
/// [`dbus_proxy`]: attr.dbus_proxy.html
/// [`dbus_interface`]: attr.dbus_interface.html
/// [`Clone`]: https://doc.rust-lang.org/std/clone/trait.Clone.html
/// [file an issue]: https://gitlab.freedesktop.org/dbus/zbus/-/issues/new
/// [`receive_message`]: struct.Connection.html#method.receive_message
/// [`set_max_queued`]: struct.Connection.html#method.set_max_queued
#[derive(Debug, Clone)]
pub struct Connection(Arc<ConnectionInner<UnixStream>>);
impl AsRawFd for Connection {
fn as_raw_fd(&self) -> RawFd {
self.0
.raw_conn
.read()
.expect(LOCK_FAIL_MSG)
.socket()
.as_raw_fd()
}
}
impl Connection {
/// Create and open a D-Bus connection from a `UnixStream`.
///
/// The connection may either be set up for a *bus* connection, or not (for peer-to-peer
/// communications).
///
/// Upon successful return, the connection is fully established and negotiated: D-Bus messages
/// can be sent and received.
pub fn new_unix_client(stream: UnixStream, bus_connection: bool) -> Result<Self> {
// SASL Handshake
let auth = ClientHandshake::new(stream).blocking_finish()?;
if bus_connection {
Connection::new_authenticated_unix_bus(auth)
} else {
Ok(Connection::new_authenticated_unix(auth))
}
}
/// Create a `Connection` to the session/user message bus.
pub fn new_session() -> Result<Self> {
ClientHandshake::new_session()?
.blocking_finish()
.and_then(Self::new_authenticated_unix_bus)
}
/// Create a `Connection` to the system-wide message bus.
pub fn new_system() -> Result<Self> {
ClientHandshake::new_system()?
.blocking_finish()
.and_then(Self::new_authenticated_unix_bus)
}
/// Create a `Connection` for the given [D-Bus address].
///
/// [D-Bus address]: https://dbus.freedesktop.org/doc/dbus-specification.html#addresses
pub fn new_for_address(address: &str, bus_connection: bool) -> Result<Self> {
let auth = ClientHandshake::new_for_address(address)?.blocking_finish()?;
if bus_connection {
Connection::new_authenticated_unix_bus(auth)
} else {
Ok(Connection::new_authenticated_unix(auth))
}
}
/// Create a server `Connection` for the given `UnixStream` and the server `guid`.
///
/// The connection will wait for incoming client authentication handshake & negotiation messages,
/// for peer-to-peer communications.
///
/// Upon successful return, the connection is fully established and negotiated: D-Bus messages
/// can be sent and received.
pub fn new_unix_server(stream: UnixStream, guid: &Guid) -> Result<Self> {
use nix::sys::socket::{getsockopt, sockopt::PeerCredentials};
let creds = getsockopt(stream.as_raw_fd(), PeerCredentials)
.map_err(|e| Error::Handshake(format!("Failed to get peer credentials: {}", e)))?;
let handshake = ServerHandshake::new(stream, guid.clone(), creds.uid());
handshake
.blocking_finish()
.map(Connection::new_authenticated_unix)
}
/// Max number of messages to queue.
pub fn max_queued(&self) -> usize {
*self.0.max_queued.read().expect(LOCK_FAIL_MSG)
}
/// Set the max number of messages to queue.
///
/// Since typically you'd want to set this at instantiation time, this method takes ownership
/// of `self` and returns an owned `Connection` instance so you can use the builder pattern to
/// set the value.
///
/// # Example
///
/// ```
///# use std::error::Error;
///#
/// let conn = zbus::Connection::new_session()?.set_max_queued(30);
/// assert_eq!(conn.max_queued(), 30);
///
/// // Do something usefull with `conn`..
///# Ok::<_, Box<dyn Error + Send + Sync>>(())
/// ```
pub fn set_max_queued(self, max: usize) -> Self {
*self.0.max_queued.write().expect(LOCK_FAIL_MSG) = max;
self
}
/// The server's GUID.
pub fn server_guid(&self) -> &str {
self.0.server_guid.as_str()
}
/// The unique name as assigned by the message bus or `None` if not a message bus connection.
pub fn unique_name(&self) -> Option<&str> {
self.0.unique_name.get().map(|s| s.as_str())
}
/// Fetch the next message from the connection.
///
/// Read from the connection until a message is received or an error is reached. Return the
/// message on success. If the connection is in non-blocking mode, this will return a
/// `WouldBlock` error instead of blocking. If there are pending messages in the queue, the
/// first one from the queue is returned instead of attempting to read the connection.
///
/// If a default message handler has been registered on this connection through
/// [`set_default_message_handler`], it will first get to decide the fate of the received
/// message.
///
/// [`set_default_message_handler`]: struct.Connection.html#method.set_default_message_handler
pub fn receive_message(&self) -> Result<Message> {
loop {
let mut queue = self.0.incoming_queue.lock().expect(LOCK_FAIL_MSG);
if let Some(msg) = queue.pop() {
return Ok(msg);
}
if let Some(msg) = self.receive_message_raw()? {
return Ok(msg);
}
}
}
/// Receive a specific message.
///
/// This is the same as [`Self::receive_message`], except that it takes a predicate function that
/// decides if the message received should be returned by this method or not. Message received
/// during this call that are not returned by it, are pushed to the queue to be picked by the
/// susubsequent call to `receive_message`] or this method.
pub fn receive_specific<P>(&self, predicate: P) -> Result<Message>
where
P: Fn(&Message) -> Result<bool>,
{
loop {
let mut queue = self.0.incoming_queue.lock().expect(LOCK_FAIL_MSG);
for (i, msg) in queue.iter().enumerate() {
if predicate(msg)? {
return Ok(queue.remove(i));
}
}
let msg = match self.receive_message_raw()? {
Some(msg) => msg,
None => continue,
};
if predicate(&msg)? {
return Ok(msg);
} else if queue.len() < *self.0.max_queued.read().expect(LOCK_FAIL_MSG) {
queue.push(msg);
}
}
}
/// Send `msg` to the peer.
///
/// The connection sets a unique serial number on the message before sending it off.
///
/// On successfully sending off `msg`, the assigned serial number is returned.
///
/// **Note:** if this connection is in non-blocking mode, the message may not actually
/// have been sent when this method returns, and you need to call the [`flush`] method
/// so that pending messages are written to the socket.
///
/// [`flush`]: struct.Connection.html#method.flush
pub fn send_message(&self, mut msg: Message) -> Result<u32> {
if !msg.fds().is_empty() && !self.0.cap_unix_fd {
return Err(Error::Unsupported);
}
let serial = self.next_serial();
msg.modify_primary_header(|primary| {
primary.set_serial_num(serial);
Ok(())
})?;
let mut conn = self.0.raw_conn.write().expect(LOCK_FAIL_MSG);
conn.enqueue_message(msg);
// Swallow a potential WouldBLock error, but propagate the others
if let Err(e) = conn.try_flush() {
if e.kind() != std::io::ErrorKind::WouldBlock {
return Err(e.into());
}
}
Ok(serial)
}
/// Flush pending outgoing messages to the server
///
/// This method is only useful if the connection is in non-blocking mode. It will
/// write as many pending outgoing messages as possible to the socket.
///
/// It will return `Ok(())` if all messages could be sent, and error otherwise. A
/// `WouldBlock` error means that the internal buffer of the connection transport is
/// full, and you need to wait for write-readiness before calling this method again.
///
/// If the connection is in blocking mode, this will return `Ok(())` and do nothing.
pub fn flush(&self) -> Result<()> {
self.0.raw_conn.write().expect(LOCK_FAIL_MSG).try_flush()?;
Ok(())
}
/// Send a method call.
///
/// Create a method-call message, send it over the connection, then wait for the reply. Incoming
/// messages are received through [`receive_message`] (and by the default message handler)
/// until the matching method reply (error or return) is received.
///
/// On succesful reply, an `Ok(Message)` is returned. On error, an `Err` is returned. D-Bus
/// error replies are returned as [`MethodError`].
///
/// *Note:* This method will block until the response is received even if the connection is
/// in non-blocking mode. If you don't want to block like this, use [`Connection::send_message`].
///
/// [`receive_message`]: struct.Connection.html#method.receive_message
/// [`MethodError`]: enum.Error.html#variant.MethodError
/// [`sent_message`]: struct.Connection.html#method.send_message
pub fn call_method<B>(
&self,
destination: Option<&str>,
path: &str,
iface: Option<&str>,
method_name: &str,
body: &B,
) -> Result<Message>
where
B: serde::ser::Serialize + zvariant::Type,
{
let m = Message::method(
self.unique_name(),
destination,
path,
iface,
method_name,
body,
)?;
let serial = self.send_message(m)?;
// loop & sleep until the message is completely sent
loop {
match self.flush() {
Ok(()) => break,
Err(Error::Io(e)) if e.kind() == std::io::ErrorKind::WouldBlock => {
wait_on(self.as_raw_fd(), PollFlags::POLLOUT)?;
}
Err(e) => return Err(e),
}
}
loop {
match self.receive_specific(|m| {
let h = m.header()?;
Ok(h.reply_serial()? == Some(serial))
}) {
Ok(m) => match m.header()?.message_type()? {
MessageType::Error => return Err(m.into()),
MessageType::MethodReturn => return Ok(m),
_ => (),
},
Err(Error::Io(e)) if e.kind() == std::io::ErrorKind::WouldBlock => {
wait_on(self.as_raw_fd(), PollFlags::POLLIN)?;
}
Err(e) => return Err(e),
};
}
}
/// Emit a signal.
///
/// Create a signal message, and send it over the connection.
pub fn emit_signal<B>(
&self,
destination: Option<&str>,
path: &str,
iface: &str,
signal_name: &str,
body: &B,
) -> Result<()>
where
B: serde::ser::Serialize + zvariant::Type,
{
let m = Message::signal(
self.unique_name(),
destination,
path,
iface,
signal_name,
body,
)?;
self.send_message(m)?;
Ok(())
}
/// Reply to a message.
///
/// Given an existing message (likely a method call), send a reply back to the caller with the
/// given `body`.
///
/// Returns the message serial number.
pub fn reply<B>(&self, call: &Message, body: &B) -> Result<u32>
where
B: serde::ser::Serialize + zvariant::Type,
{
let m = Message::method_reply(self.unique_name(), call, body)?;
self.send_message(m)
}
/// Reply an error to a message.
///
/// Given an existing message (likely a method call), send an error reply back to the caller
/// with the given `error_name` and `body`.
///
/// Returns the message serial number.
pub fn reply_error<B>(&self, call: &Message, error_name: &str, body: &B) -> Result<u32>
where
B: serde::ser::Serialize + zvariant::Type,
{
let m = Message::method_error(self.unique_name(), call, error_name, body)?;
self.send_message(m)
}
/// Set a default handler for incoming messages on this connection.
///
/// This is the handler that will be called on all messages received during [`receive_message`]
/// call. If the handler callback returns a message (which could be a different message than it
/// was given), `receive_message` will return it to its caller.
///
/// [`receive_message`]: struct.Connection.html#method.receive_message
#[deprecated(
since = "1.4.0",
note = "You shouldn't need this anymore since Connection queues messages"
)]
pub fn set_default_message_handler(&mut self, handler: MessageHandlerFn) {
self.0
.default_msg_handler
.lock()
.expect(LOCK_FAIL_MSG)
.replace(handler);
}
/// Reset the default message handler.
///
/// Remove the previously set message handler from `set_default_message_handler`.
#[deprecated(
since = "1.4.0",
note = "You shouldn't need this anymore since Connection queues messages"
)]
pub fn reset_default_message_handler(&mut self) {
self.0
.default_msg_handler
.lock()
.expect(LOCK_FAIL_MSG)
.take();
}
/// Create a `Connection` from an already authenticated unix socket
///
/// This method can be used in conjunction with [`ClientHandshake`] or [`ServerHandshake`] to handle
/// the initial handshake of the D-Bus connection asynchronously. The [`Authenticated`] argument required
/// by this method is the result provided by these handshake utilities.
///
/// If the aim is to initialize a client *bus* connection, you need to send the [client hello] and assign
/// the resulting unique name using [`set_unique_name`] before doing anything else.
///
/// [`ClientHandshake`]: ./handshake/struct.ClientHandshake.html
/// [`ServerHandshake`]: ./handshake/struct.ServerHandshake.html
/// [`Authenticated`]: ./handshake/struct.Authenticated.html
/// [client hello]: ./fdo/struct.DBusProxy.html#method.hello
/// [`set_unique_name`]: struct.Connection.html#method.set_unique_name
pub fn new_authenticated_unix(auth: Authenticated<UnixStream>) -> Self {
Self::new_authenticated_unix_(auth, false)
}
/// Sets the unique name for this connection
///
/// This method should only be used when initializing a client *bus* connection with
/// [`new_authenticated_unix`]. Setting the unique name to anything other than the return value of the bus
/// hello is a protocol violation.
///
/// Returns and error if the name has already been set.
///
/// [`new_authenticated_unix`]: struct.Connection.html#method.new_authenticated_unix
pub fn set_unique_name(&self, name: String) -> std::result::Result<(), String> {
self.0.unique_name.set(name)
}
/// Checks if `self` is a connection to a message bus.
///
/// This will return `false` for p2p connections.
pub fn is_bus(&self) -> bool {
self.0.bus_conn
}
fn new_authenticated_unix_bus(auth: Authenticated<UnixStream>) -> Result<Self> {
let connection = Connection::new_authenticated_unix_(auth, true);
// Now that the server has approved us, we must send the bus Hello, as per specs
let name = fdo::DBusProxy::new(&connection)?
.hello()
.map_err(|e| Error::Handshake(format!("Hello failed: {}", e)))?;
connection
.0
.unique_name
.set(name)
// programmer (probably our) error if this fails.
.expect("Attempted to set unique_name twice");
Ok(connection)
}
fn new_authenticated_unix_(auth: Authenticated<UnixStream>, bus_conn: bool) -> Self {
Self(Arc::new(ConnectionInner {
raw_conn: RwLock::new(auth.conn),
server_guid: auth.server_guid,
cap_unix_fd: auth.cap_unix_fd,
bus_conn,
serial: Mutex::new(1),
unique_name: OnceCell::new(),
incoming_queue: Mutex::new(vec![]),
max_queued: RwLock::new(DEFAULT_MAX_QUEUED),
default_msg_handler: Mutex::new(None),
}))
}
fn next_serial(&self) -> u32 {
let mut serial = self.0.serial.lock().expect(LOCK_FAIL_MSG);
let current = *serial;
*serial = current + 1;
current
}
// Get the message directly from the socket (ignoring the queue).
fn receive_message_raw(&self) -> Result<Option<Message>> {
let incoming = self
.0
.raw_conn
.write()
.expect(LOCK_FAIL_MSG)
.try_receive_message()?;
if let Some(ref mut handler) = &mut *self.0.default_msg_handler.lock().expect(LOCK_FAIL_MSG)
{
// Let's see if the default handler wants the message first
Ok(handler(incoming))
} else {
Ok(Some(incoming))
}
}
}
#[cfg(test)]
mod tests {
use std::{os::unix::net::UnixStream, thread};
use crate::{Connection, Guid};
#[test]
fn unix_p2p() {
let guid = Guid::generate();
let (p0, p1) = UnixStream::pair().unwrap();
let server_thread = thread::spawn(move || {
let c = Connection::new_unix_server(p0, &guid).unwrap();
let reply = c
.call_method(None, "/", Some("org.zbus.p2p"), "Test", &())
.unwrap();
assert_eq!(reply.to_string(), "Method return");
let val: String = reply.body().unwrap();
val
});
let c = Connection::new_unix_client(p1, false).unwrap();
let m = c.receive_message().unwrap();
assert_eq!(m.to_string(), "Method call Test");
c.reply(&m, &("yay")).unwrap();
let val = server_thread.join().expect("failed to join server thread");
assert_eq!(val, "yay");
}
#[test]
fn serial_monotonically_increases() {
let c = Connection::new_session().unwrap();
let serial = c.next_serial() + 1;
for next in serial..serial + 10 {
assert_eq!(next, c.next_serial());
}
}
}