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 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
use async_broadcast::{broadcast, InactiveReceiver, Receiver, Sender as Broadcaster};
use enumflags2::BitFlags;
use event_listener::{Event, EventListener};
use once_cell::sync::OnceCell;
use ordered_stream::{OrderedFuture, OrderedStream, PollResult};
use static_assertions::assert_impl_all;
use std::{
collections::HashMap,
convert::TryInto,
io::{self, ErrorKind},
ops::Deref,
pin::Pin,
sync::{
self,
atomic::{AtomicU32, Ordering::SeqCst},
Arc, Weak,
},
task::{Context, Poll},
};
use tracing::{debug, info_span, instrument, trace, trace_span, warn, Instrument};
use zbus_names::{BusName, ErrorName, InterfaceName, MemberName, OwnedUniqueName, WellKnownName};
use zvariant::ObjectPath;
use futures_core::{ready, Future};
use futures_sink::Sink;
use futures_util::{sink::SinkExt, StreamExt};
use crate::{
async_lock::Mutex,
blocking,
fdo::{self, ConnectionCredentials, RequestNameFlags, RequestNameReply},
raw::{Connection as RawConnection, Socket},
socket_reader::SocketReader,
Authenticated, CacheProperties, ConnectionBuilder, DBusError, Error, Executor, Guid, MatchRule,
Message, MessageBuilder, MessageFlags, MessageStream, MessageType, ObjectServer,
OwnedMatchRule, Result, Task,
};
const DEFAULT_MAX_QUEUED: usize = 64;
const DEFAULT_MAX_METHOD_RETURN_QUEUED: usize = 8;
/// Inner state shared by Connection and WeakConnection
#[derive(Debug)]
pub(crate) struct ConnectionInner {
server_guid: Guid,
#[cfg(unix)]
cap_unix_fd: bool,
bus_conn: bool,
unique_name: OnceCell<OwnedUniqueName>,
registered_names: Mutex<HashMap<WellKnownName<'static>, NameStatus>>,
raw_conn: Arc<sync::Mutex<RawConnection<Box<dyn Socket>>>>,
// Serial number for next outgoing message
serial: AtomicU32,
// Our executor
executor: Executor<'static>,
// Socket reader task
#[allow(unused)]
socket_reader_task: OnceCell<Task<()>>,
pub(crate) msg_receiver: InactiveReceiver<Result<Arc<Message>>>,
pub(crate) method_return_receiver: InactiveReceiver<Result<Arc<Message>>>,
msg_senders: Arc<Mutex<HashMap<Option<OwnedMatchRule>, MsgBroadcaster>>>,
subscriptions: Mutex<Subscriptions>,
object_server: OnceCell<blocking::ObjectServer>,
object_server_dispatch_task: OnceCell<Task<()>>,
}
type Subscriptions = HashMap<OwnedMatchRule, (u64, InactiveReceiver<Result<Arc<Message>>>)>;
pub(crate) type MsgBroadcaster = Broadcaster<Result<Arc<Message>>>;
/// 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`.
///
/// Typically, a connection is made to the session bus with [`Connection::session`], or to the
/// system bus with [`Connection::system`]. Then the connection is used with [`crate::Proxy`]
/// instances or the on-demand [`ObjectServer`] instance that can be accessed through
/// [`Connection::object_server`].
///
/// `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.
///
/// `Connection` keeps internal queues of incoming message. The default capacity of each of these is
/// 64. The capacity of the main (unfiltered) queue is configurable through the [`set_max_queued`]
/// method. When the queue is full, no more messages can be received until room is created for more.
/// This is why it's important to ensure that all [`crate::MessageStream`] and
/// [`crate::blocking::MessageIterator`] instances are continuously polled and iterated on,
/// respectively.
///
/// For sending messages you can either use [`Connection::send_message`] method or make use of the
/// [`Sink`] implementation. For latter, you might find [`SinkExt`] API very useful. Keep in mind
/// that [`Connection`] will not manage the serial numbers (cookies) on the messages for you when
/// they are sent through the [`Sink`] implementation. You can manually assign unique serial numbers
/// to them using the [`Connection::assign_serial_num`] method before sending them off, if needed.
/// Having said that, the [`Sink`] is mainly useful for sending out signals, as they do not expect
/// a reply, and serial numbers are not very useful for signals either for the same reason.
///
/// Since you do not need exclusive access to a `zbus::Connection` to send messages on the bus,
/// [`Sink`] is also implemented on `&Connection`.
///
/// # Caveats
///
/// At the moment, a simultaneous [flush request] from multiple tasks/threads could
/// potentially create a busy loop, thus wasting CPU time. This limitation may be removed in the
/// future.
///
/// [flush request]: https://docs.rs/futures/0.3.15/futures/sink/trait.SinkExt.html#method.flush
///
/// [method calls]: struct.Connection.html#method.call_method
/// [signals]: struct.Connection.html#method.emit_signal
/// [`dbus_proxy`]: attr.dbus_proxy.html
/// [`dbus_interface`]: attr.dbus_interface.html
/// [`Clone`]: https://doc.rust-lang.org/std/clone/trait.Clone.html
/// [`set_max_queued`]: struct.Connection.html#method.set_max_queued
///
/// ### Examples
///
/// #### Get the session bus ID
///
/// ```
/// # zbus::block_on(async {
/// use zbus::Connection;
///
/// let connection = Connection::session().await?;
///
/// let reply = connection
/// .call_method(
/// Some("org.freedesktop.DBus"),
/// "/org/freedesktop/DBus",
/// Some("org.freedesktop.DBus"),
/// "GetId",
/// &(),
/// )
/// .await?;
///
/// let id: &str = reply.body()?;
/// println!("Unique ID of the bus: {}", id);
/// # Ok::<(), zbus::Error>(())
/// # }).unwrap();
/// ```
///
/// #### Monitoring all messages
///
/// Let's eavesdrop on the session bus 😈 using the [Monitor] interface:
///
/// ```rust,no_run
/// # zbus::block_on(async {
/// use futures_util::stream::TryStreamExt;
/// use zbus::{Connection, MessageStream};
///
/// let connection = Connection::session().await?;
///
/// connection
/// .call_method(
/// Some("org.freedesktop.DBus"),
/// "/org/freedesktop/DBus",
/// Some("org.freedesktop.DBus.Monitoring"),
/// "BecomeMonitor",
/// &(&[] as &[&str], 0u32),
/// )
/// .await?;
///
/// let mut stream = MessageStream::from(connection);
/// while let Some(msg) = stream.try_next().await? {
/// println!("Got message: {}", msg);
/// }
///
/// # Ok::<(), zbus::Error>(())
/// # }).unwrap();
/// ```
///
/// This should print something like:
///
/// ```console
/// Got message: Signal NameAcquired from org.freedesktop.DBus
/// Got message: Signal NameLost from org.freedesktop.DBus
/// Got message: Method call GetConnectionUnixProcessID from :1.1324
/// Got message: Error org.freedesktop.DBus.Error.NameHasNoOwner:
/// Could not get PID of name ':1.1332': no such name from org.freedesktop.DBus
/// Got message: Method call AddMatch from :1.918
/// Got message: Method return from org.freedesktop.DBus
/// ```
///
/// [Monitor]: https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-become-monitor
#[derive(Clone, Debug)]
#[must_use = "Dropping a `Connection` will close the underlying socket."]
pub struct Connection {
pub(crate) inner: Arc<ConnectionInner>,
}
assert_impl_all!(Connection: Send, Sync, Unpin);
/// A method call whose completion can be awaited or joined with other streams.
///
/// This is useful for cache population method calls, where joining the [`JoinableStream`] with
/// an update signal stream can be used to ensure that cache updates are not overwritten by a cache
/// population whose task is scheduled later.
#[derive(Debug)]
pub(crate) struct PendingMethodCall {
stream: Option<MessageStream>,
serial: u32,
}
impl Future for PendingMethodCall {
type Output = Result<Arc<Message>>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
self.poll_before(cx, None).map(|ret| {
ret.map(|(_, r)| r).unwrap_or_else(|| {
Err(crate::Error::InputOutput(
io::Error::new(ErrorKind::BrokenPipe, "socket closed").into(),
))
})
})
}
}
impl OrderedFuture for PendingMethodCall {
type Output = Result<Arc<Message>>;
type Ordering = zbus::MessageSequence;
fn poll_before(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
before: Option<&Self::Ordering>,
) -> Poll<Option<(Self::Ordering, Self::Output)>> {
let this = self.get_mut();
if let Some(stream) = &mut this.stream {
loop {
match Pin::new(&mut *stream).poll_next_before(cx, before) {
Poll::Ready(PollResult::Item {
data: Ok(msg),
ordering,
}) => {
if msg.reply_serial() != Some(this.serial) {
continue;
}
let res = match msg.message_type() {
MessageType::Error => Err(msg.into()),
MessageType::MethodReturn => Ok(msg),
_ => continue,
};
this.stream = None;
return Poll::Ready(Some((ordering, res)));
}
Poll::Ready(PollResult::Item {
data: Err(e),
ordering,
}) => {
return Poll::Ready(Some((ordering, Err(e))));
}
Poll::Ready(PollResult::NoneBefore) => {
return Poll::Ready(None);
}
Poll::Ready(PollResult::Terminated) => {
return Poll::Ready(None);
}
Poll::Pending => return Poll::Pending,
}
}
}
Poll::Ready(None)
}
}
impl Connection {
/// Send `msg` to the peer.
///
/// Unlike our [`Sink`] implementation, this method sets a unique (to this connection) serial
/// number on the message before sending it off, for you.
///
/// On successfully sending off `msg`, the assigned serial number is returned.
pub async fn send_message(&self, mut msg: Message) -> Result<u32> {
let serial = self.assign_serial_num(&mut msg)?;
trace!("Sending message: {:?}", msg);
(&mut &*self).send(msg).await?;
trace!("Sent message with serial: {}", serial);
Ok(serial)
}
/// Send a method call.
///
/// Create a method-call message, send it over the connection, then wait for the reply.
///
/// On successful reply, an `Ok(Message)` is returned. On error, an `Err` is returned. D-Bus
/// error replies are returned as [`Error::MethodError`].
pub async fn call_method<'d, 'p, 'i, 'm, D, P, I, M, B>(
&self,
destination: Option<D>,
path: P,
interface: Option<I>,
method_name: M,
body: &B,
) -> Result<Arc<Message>>
where
D: TryInto<BusName<'d>>,
P: TryInto<ObjectPath<'p>>,
I: TryInto<InterfaceName<'i>>,
M: TryInto<MemberName<'m>>,
D::Error: Into<Error>,
P::Error: Into<Error>,
I::Error: Into<Error>,
M::Error: Into<Error>,
B: serde::ser::Serialize + zvariant::DynamicType,
{
self.call_method_raw(
destination,
path,
interface,
method_name,
BitFlags::empty(),
body,
)
.await?
.expect("no reply")
.await
}
/// Send a method call.
///
/// Send the given message, which must be a method call, over the connection and return an
/// object that allows the reply to be retrieved. Typically you'd want to use
/// [`Connection::call_method`] instead.
///
/// If the `flags` do not contain `MethodFlags::NoReplyExpected`, the return value is
/// guaranteed to be `Ok(Some(_))`, if there was no error encountered.
///
/// INTERNAL NOTE: If this method is ever made pub, flags should become `BitFlags<MethodFlags>`.
pub(crate) async fn call_method_raw<'d, 'p, 'i, 'm, D, P, I, M, B>(
&self,
destination: Option<D>,
path: P,
interface: Option<I>,
method_name: M,
flags: BitFlags<MessageFlags>,
body: &B,
) -> Result<Option<PendingMethodCall>>
where
D: TryInto<BusName<'d>>,
P: TryInto<ObjectPath<'p>>,
I: TryInto<InterfaceName<'i>>,
M: TryInto<MemberName<'m>>,
D::Error: Into<Error>,
P::Error: Into<Error>,
I::Error: Into<Error>,
M::Error: Into<Error>,
B: serde::ser::Serialize + zvariant::DynamicType,
{
let mut builder = MessageBuilder::method_call(path, method_name)?;
if let Some(sender) = self.unique_name() {
builder = builder.sender(sender)?
}
if let Some(destination) = destination {
builder = builder.destination(destination)?
}
if let Some(interface) = interface {
builder = builder.interface(interface)?
}
for flag in flags {
builder = builder.with_flags(flag)?;
}
let msg = builder.build(body)?;
let msg_receiver = self.inner.method_return_receiver.activate_cloned();
let stream = Some(MessageStream::for_subscription_channel(
msg_receiver,
// This is a lie but we only use the stream internally so it's fine.
None,
self,
));
let serial = self.send_message(msg).await?;
if flags.contains(MessageFlags::NoReplyExpected) {
Ok(None)
} else {
Ok(Some(PendingMethodCall { stream, serial }))
}
}
/// Emit a signal.
///
/// Create a signal message, and send it over the connection.
pub async fn emit_signal<'d, 'p, 'i, 'm, D, P, I, M, B>(
&self,
destination: Option<D>,
path: P,
interface: I,
signal_name: M,
body: &B,
) -> Result<()>
where
D: TryInto<BusName<'d>>,
P: TryInto<ObjectPath<'p>>,
I: TryInto<InterfaceName<'i>>,
M: TryInto<MemberName<'m>>,
D::Error: Into<Error>,
P::Error: Into<Error>,
I::Error: Into<Error>,
M::Error: Into<Error>,
B: serde::ser::Serialize + zvariant::DynamicType,
{
let m = Message::signal(
self.unique_name(),
destination,
path,
interface,
signal_name,
body,
)?;
self.send_message(m).await.map(|_| ())
}
/// 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 async fn reply<B>(&self, call: &Message, body: &B) -> Result<u32>
where
B: serde::ser::Serialize + zvariant::DynamicType,
{
let m = Message::method_reply(self.unique_name(), call, body)?;
self.send_message(m).await
}
/// 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 async fn reply_error<'e, E, B>(
&self,
call: &Message,
error_name: E,
body: &B,
) -> Result<u32>
where
B: serde::ser::Serialize + zvariant::DynamicType,
E: TryInto<ErrorName<'e>>,
E::Error: Into<Error>,
{
let m = Message::method_error(self.unique_name(), call, error_name, body)?;
self.send_message(m).await
}
/// Reply an error to a message.
///
/// Given an existing message (likely a method call), send an error reply back to the caller
/// using one of the standard interface reply types.
///
/// Returns the message serial number.
pub async fn reply_dbus_error(
&self,
call: &zbus::MessageHeader<'_>,
err: impl DBusError,
) -> Result<u32> {
let m = err.create_reply(call);
self.send_message(m?).await
}
/// Register a well-known name for this connection.
///
/// When connecting to a bus, the name is requested from the bus. In case of p2p connection, the
/// name (if requested) is used of self-identification.
///
/// You can request multiple names for the same connection. Use [`Connection::release_name`] for
/// deregistering names registered through this method.
///
/// Note that exclusive ownership without queueing is requested (using
/// [`RequestNameFlags::ReplaceExisting`] and [`RequestNameFlags::DoNotQueue`] flags) since that
/// is the most typical case. If that is not what you want, you should use
/// [`Connection::request_name_with_flags`] instead (but make sure then that name is requested
/// **after** you've setup your service implementation with the `ObjectServer`).
///
/// # Caveats
///
/// The associated `ObjectServer` will only handle method calls destined for the unique name of
/// this connection or any of the registered well-known names. If no well-known name is
/// registered, the method calls destined to all well-known names will be handled.
///
/// Since names registered through any other means than `Connection` or [`ConnectionBuilder`]
/// API are not known to the connection, method calls destined to those names will only be
/// handled by the associated `ObjectServer` if none of the names are registered through
/// `Connection*` API. Simply put, either register all the names through `Connection*` API or
/// none of them.
///
/// # Errors
///
/// Fails with `zbus::Error::NameTaken` if the name is already owned by another peer.
pub async fn request_name<'w, W>(&self, well_known_name: W) -> Result<()>
where
W: TryInto<WellKnownName<'w>>,
W::Error: Into<Error>,
{
self.request_name_with_flags(
well_known_name,
RequestNameFlags::ReplaceExisting | RequestNameFlags::DoNotQueue,
)
.await
.map(|_| ())
}
/// Register a well-known name for this connection.
///
/// This is the same as [`Connection::request_name`] but allows to specify the flags to use when
/// requesting the name.
///
/// If the [`RequestNameFlags::DoNotQueue`] flag is not specified and request ends up in the
/// queue, you can use [`fdo::NameAcquiredStream`] to be notified when the name is acquired. A
/// queued name request can be cancelled using [`Connection::release_name`].
///
/// If the [`RequestNameFlags::AllowReplacement`] flag is specified, the requested name can be
/// lost if another peer requests the same name. You can use [`fdo::NameLostStream`] to be
/// notified when the name is lost
///
/// # Example
///
/// ```
/// #
/// # zbus::block_on(async {
/// use zbus::{Connection, fdo::{DBusProxy, RequestNameFlags, RequestNameReply}};
/// use enumflags2::BitFlags;
/// use futures_util::stream::StreamExt;
///
/// let name = "org.freedesktop.zbus.QueuedNameTest";
/// let conn1 = Connection::session().await?;
/// // This should just work right away.
/// conn1.request_name(name).await?;
///
/// let conn2 = Connection::session().await?;
/// // A second request from the another connection will fail with `DoNotQueue` flag, which is
/// // implicit with `request_name` method.
/// assert!(conn2.request_name(name).await.is_err());
///
/// // Now let's try w/o `DoNotQueue` and we should be queued.
/// let reply = conn2
/// .request_name_with_flags(name, RequestNameFlags::AllowReplacement.into())
/// .await?;
/// assert_eq!(reply, RequestNameReply::InQueue);
/// // Another request should just give us the same response.
/// let reply = conn2
/// // The flags on subsequent requests will however be ignored.
/// .request_name_with_flags(name, BitFlags::empty())
/// .await?;
/// assert_eq!(reply, RequestNameReply::InQueue);
/// let mut acquired_stream = DBusProxy::new(&conn2)
/// .await?
/// .receive_name_acquired()
/// .await?;
/// assert!(conn1.release_name(name).await?);
/// // This would have waited forever if `conn1` hadn't just release the name.
/// let acquired = acquired_stream.next().await.unwrap();
/// assert_eq!(acquired.args().unwrap().name, name);
///
/// // conn2 made the mistake of being too nice and allowed name replacemnt, so conn1 should be
/// // able to take it back.
/// let mut lost_stream = DBusProxy::new(&conn2)
/// .await?
/// .receive_name_lost()
/// .await?;
/// conn1.request_name(name).await?;
/// let lost = lost_stream.next().await.unwrap();
/// assert_eq!(lost.args().unwrap().name, name);
///
/// # Ok::<(), zbus::Error>(())
/// # }).unwrap();
/// ```
///
/// # Caveats
///
/// * Same as that of [`Connection::request_name`].
/// * If you wish to track changes to name ownership after this call, make sure that the
/// [`fdo::NameAcquired`] and/or [`fdo::NameLostStream`] instance(s) are created **before**
/// calling this method. Otherwise, you may loose the signal if it's emitted after this call but
/// just before the stream instance get created.
pub async fn request_name_with_flags<'w, W>(
&self,
well_known_name: W,
flags: BitFlags<RequestNameFlags>,
) -> Result<RequestNameReply>
where
W: TryInto<WellKnownName<'w>>,
W::Error: Into<Error>,
{
let well_known_name = well_known_name.try_into().map_err(Into::into)?;
// We keep the lock until the end of this function so that the (possibly) spawned task
// doesn't end up accessing the name entry before it's inserted.
let mut names = self.inner.registered_names.lock().await;
match names.get(&well_known_name) {
Some(NameStatus::Owner(_)) => return Ok(RequestNameReply::AlreadyOwner),
Some(NameStatus::Queued(_)) => return Ok(RequestNameReply::InQueue),
None => (),
}
if !self.is_bus() {
names.insert(well_known_name.to_owned(), NameStatus::Owner(None));
return Ok(RequestNameReply::PrimaryOwner);
}
let dbus_proxy = fdo::DBusProxy::builder(self)
.cache_properties(CacheProperties::No)
.build()
.await?;
let mut acquired_stream = dbus_proxy.receive_name_acquired().await?;
let mut lost_stream = dbus_proxy.receive_name_lost().await?;
let reply = dbus_proxy
.request_name(well_known_name.clone(), flags)
.await?;
let lost_task_name = format!("monitor name {well_known_name} lost");
let name_lost_fut = if flags.contains(RequestNameFlags::AllowReplacement) {
let weak_conn = WeakConnection::from(self);
let well_known_name = well_known_name.to_owned();
Some(
async move {
loop {
let signal = lost_stream.next().await;
let inner = match weak_conn.upgrade() {
Some(conn) => conn.inner.clone(),
None => break,
};
match signal {
Some(signal) => match signal.args() {
Ok(args) if args.name == well_known_name => {
tracing::info!(
"Connection `{}` lost name `{}`",
// SAFETY: This is bus connection so unique name can't be
// None.
inner.unique_name.get().unwrap(),
well_known_name
);
inner.registered_names.lock().await.remove(&well_known_name);
break;
}
Ok(_) => (),
Err(e) => warn!("Failed to parse `NameLost` signal: {}", e),
},
None => {
trace!("`NameLost` signal stream closed");
// This is a very strange state we end up in. Now the name is
// question remains in the queue
// forever. Maybe we can do better here but I
// think it's a very unlikely scenario anyway.
//
// Can happen if the connection is lost/dropped but then the whole
// `Connection` instance will go away soon anyway and hence this
// strange state along with it.
break;
}
}
}
}
.instrument(info_span!("{}", lost_task_name)),
)
} else {
None
};
let status = match reply {
RequestNameReply::InQueue => {
let weak_conn = WeakConnection::from(self);
let well_known_name = well_known_name.to_owned();
let task_name = format!("monitor name {well_known_name} acquired");
let task = self.executor().spawn(
async move {
loop {
let signal = acquired_stream.next().await;
let inner = match weak_conn.upgrade() {
Some(conn) => conn.inner.clone(),
None => break,
};
match signal {
Some(signal) => match signal.args() {
Ok(args) if args.name == well_known_name => {
let mut names = inner.registered_names.lock().await;
if let Some(status) = names.get_mut(&well_known_name) {
let task = name_lost_fut.map(|fut| {
inner.executor.spawn(fut, &lost_task_name)
});
*status = NameStatus::Owner(task);
break;
}
// else the name was released in the meantime. :shrug:
}
Ok(_) => (),
Err(e) => warn!("Failed to parse `NameAcquired` signal: {}", e),
},
None => {
trace!("`NameAcquired` signal stream closed");
// See comment above for similar state in case of `NameLost`
// stream.
break;
}
}
}
}
.instrument(info_span!("{}", task_name)),
&task_name,
);
NameStatus::Queued(task)
}
RequestNameReply::PrimaryOwner | RequestNameReply::AlreadyOwner => {
let task = name_lost_fut.map(|fut| self.executor().spawn(fut, &lost_task_name));
NameStatus::Owner(task)
}
RequestNameReply::Exists => return Err(Error::NameTaken),
};
names.insert(well_known_name.to_owned(), status);
Ok(reply)
}
/// Deregister a previously registered well-known name for this service on the bus.
///
/// Use this method to deregister a well-known name, registered through
/// [`Connection::request_name`].
///
/// Unless an error is encountered, returns `Ok(true)` if name was previously registered with
/// the bus through `self` and it has now been successfully deregistered, `Ok(false)` if name
/// was not previously registered or already deregistered.
pub async fn release_name<'w, W>(&self, well_known_name: W) -> Result<bool>
where
W: TryInto<WellKnownName<'w>>,
W::Error: Into<Error>,
{
let well_known_name: WellKnownName<'w> = well_known_name.try_into().map_err(Into::into)?;
let mut names = self.inner.registered_names.lock().await;
// FIXME: Should be possible to avoid cloning/allocation here
if names.remove(&well_known_name.to_owned()).is_none() {
return Ok(false);
};
if !self.is_bus() {
return Ok(true);
}
fdo::DBusProxy::builder(self)
.cache_properties(CacheProperties::No)
.build()
.await?
.release_name(well_known_name)
.await
.map(|_| true)
.map_err(Into::into)
}
/// Checks if `self` is a connection to a message bus.
///
/// This will return `false` for p2p connections.
pub fn is_bus(&self) -> bool {
self.inner.bus_conn
}
/// Assigns a serial number to `msg` that is unique to this connection.
///
/// This method can fail if `msg` is corrupted.
pub fn assign_serial_num(&self, msg: &mut Message) -> Result<u32> {
let mut serial = 0;
msg.modify_primary_header(|primary| {
serial = *primary.serial_num_or_init(|| self.next_serial());
Ok(())
})?;
Ok(serial)
}
/// The unique name of the connection, if set/applicable.
///
/// The unique name is assigned by the message bus or set manually using
/// [`Connection::set_unique_name`].
pub fn unique_name(&self) -> Option<&OwnedUniqueName> {
self.inner.unique_name.get()
}
/// Sets the unique name of the connection (if not already set).
///
/// # Panics
///
/// This method panics if the unique name is already set. It will always panic if the connection
/// is to a message bus as it's the bus that assigns peers their unique names. This is mainly
/// provided for bus implementations. All other users should not need to use this method.
pub fn set_unique_name<U>(&self, unique_name: U) -> Result<()>
where
U: TryInto<OwnedUniqueName>,
U::Error: Into<Error>,
{
let name = unique_name.try_into().map_err(Into::into)?;
self.inner
.unique_name
.set(name)
.expect("unique name already set");
Ok(())
}
/// The capacity of the main (unfiltered) queue.
pub fn max_queued(&self) -> usize {
self.inner.msg_receiver.capacity()
}
/// Set the capacity of the main (unfiltered) queue.
pub fn set_max_queued(&mut self, max: usize) {
self.inner.msg_receiver.clone().set_capacity(max);
}
/// The server's GUID.
pub fn server_guid(&self) -> &str {
self.inner.server_guid.as_str()
}
/// The underlying executor.
///
/// When a connection is built with internal_executor set to false, zbus will not spawn a
/// thread to run the executor. You're responsible to continuously [tick the executor][tte].
/// Failure to do so will result in hangs.
///
/// # Examples
///
/// Here is how one would typically run the zbus executor through async-std's single-threaded
/// scheduler:
///
/// ```
/// # // Disable on windows because somehow it triggers a stack overflow there:
/// # // https://gitlab.freedesktop.org/zeenix/zbus/-/jobs/34023494
/// # #[cfg(all(not(feature = "tokio"), not(target_os = "windows")))]
/// # {
/// use zbus::ConnectionBuilder;
/// use async_std::task::{block_on, spawn};
///
/// # struct SomeIface;
/// #
/// # #[zbus::dbus_interface]
/// # impl SomeIface {
/// # }
/// #
/// block_on(async {
/// let conn = ConnectionBuilder::session()
/// .unwrap()
/// .internal_executor(false)
/// # // This is only for testing a deadlock that used to happen with this combo.
/// # .serve_at("/some/iface", SomeIface)
/// # .unwrap()
/// .build()
/// .await
/// .unwrap();
/// {
/// let conn = conn.clone();
/// spawn(async move {
/// loop {
/// conn.executor().tick().await;
/// }
/// });
/// }
///
/// // All your other async code goes here.
/// });
/// # }
/// ```
///
/// **Note**: zbus 2.1 added support for tight integration with tokio. This means, if you use
/// zbus with tokio, you do not need to worry about this at all. All you need to do is enable
/// `tokio` feature. You should also disable the (default) `async-io` feature in your
/// `Cargo.toml` to avoid unused dependencies. Also note that **prior** to zbus 3.0, disabling
/// `async-io` was required to enable tight `tokio` integration.
///
/// [tte]: https://docs.rs/async-executor/1.4.1/async_executor/struct.Executor.html#method.tick
pub fn executor(&self) -> &Executor<'static> {
&self.inner.executor
}
/// Get a reference to the associated [`ObjectServer`].
///
/// The `ObjectServer` is created on-demand.
///
/// **Note**: Once the `ObjectServer` is created, it will be replying to all method calls
/// received on `self`. If you want to manually reply to method calls, do not use this
/// method (or any of the `ObjectServer` related API).
pub fn object_server(&self) -> impl Deref<Target = ObjectServer> + '_ {
// FIXME: Maybe it makes sense after all to implement Deref<Target= ObjectServer> for
// crate::ObjectServer instead of this wrapper?
struct Wrapper<'a>(&'a blocking::ObjectServer);
impl<'a> Deref for Wrapper<'a> {
type Target = ObjectServer;
fn deref(&self) -> &Self::Target {
self.0.inner()
}
}
Wrapper(self.sync_object_server(true, None))
}
pub(crate) fn sync_object_server(
&self,
start: bool,
started_event: Option<Event>,
) -> &blocking::ObjectServer {
self.inner
.object_server
.get_or_init(move || self.setup_object_server(start, started_event))
}
fn setup_object_server(
&self,
start: bool,
started_event: Option<Event>,
) -> blocking::ObjectServer {
if start {
self.start_object_server(started_event);
}
blocking::ObjectServer::new(self)
}
#[instrument(skip(self))]
pub(crate) fn start_object_server(&self, started_event: Option<Event>) {
self.inner.object_server_dispatch_task.get_or_init(|| {
trace!("starting ObjectServer task");
let weak_conn = WeakConnection::from(self);
let obj_server_task_name = "ObjectServer task";
self.inner.executor.spawn(
async move {
let mut stream = match weak_conn.upgrade() {
Some(conn) => {
let mut builder = MatchRule::builder().msg_type(MessageType::MethodCall);
if let Some(unique_name) = conn.unique_name() {
builder = builder.destination(&**unique_name).expect("unique name");
}
let rule = builder.build();
match conn.add_match(rule.into(), None).await {
Ok(stream) => stream,
Err(e) => {
// Very unlikely but can happen I guess if connection is closed.
debug!("Failed to create message stream: {}", e);
return;
}
}
}
None => {
trace!("Connection is gone, stopping associated object server task");
return;
}
};
if let Some(started_event) = started_event {
started_event.notify(1);
}
trace!("waiting for incoming method call messages..");
while let Some(msg) = stream.next().await.and_then(|m| {
if let Err(e) = &m {
debug!("Error while reading from object server stream: {:?}", e);
}
m.ok()
}) {
if let Some(conn) = weak_conn.upgrade() {
let hdr = match msg.header() {
Ok(hdr) => hdr,
Err(e) => {
warn!("Failed to parse header: {}", e);
continue;
}
};
match hdr.destination() {
// Unique name is already checked by the match rule.
Ok(Some(BusName::Unique(_))) | Ok(None) => (),
Ok(Some(BusName::WellKnown(dest))) => {
let names = conn.inner.registered_names.lock().await;
// destination doesn't matter if no name has been registered
// (probably means name it's registered through external means).
if !names.is_empty() && !names.contains_key(dest) {
trace!("Got a method call for a different destination: {}", dest);
continue;
}
}
Err(e) => {
warn!("Failed to parse destination: {}", e);
continue;
}
}
let member = match msg.member() {
Some(member) => member,
None => {
warn!("Got a method call with no `MEMBER` field: {}", msg);
continue;
}
};
trace!("Got `{}`. Will spawn a task for dispatch..", msg);
let executor = conn.inner.executor.clone();
let task_name = format!("`{member}` method dispatcher");
executor
.spawn(
async move {
trace!("spawned a task to dispatch `{}`.", msg);
let server = conn.object_server();
if let Err(e) = server.dispatch_message(&msg).await {
debug!(
"Error dispatching message. Message: {:?}, error: {:?}",
msg, e
);
}
}
.instrument(trace_span!("{}", task_name)),
&task_name,
)
.detach();
} else {
// If connection is completely gone, no reason to keep running the task anymore.
trace!("Connection is gone, stopping associated object server task");
break;
}
}
}
.instrument(info_span!("{}", obj_server_task_name)),
obj_server_task_name,
)
});
}
pub(crate) async fn add_match(
&self,
rule: OwnedMatchRule,
max_queued: Option<usize>,
) -> Result<Receiver<Result<Arc<Message>>>> {
use std::collections::hash_map::Entry;
if self.inner.msg_senders.lock().await.is_empty() {
// This only happens if socket reader task has errored out.
return Err(Error::InputOutput(Arc::new(io::Error::new(
io::ErrorKind::BrokenPipe,
"Socket reader task has errored out",
))));
}
let mut subscriptions = self.inner.subscriptions.lock().await;
let msg_type = rule.msg_type().unwrap_or(MessageType::Signal);
match subscriptions.entry(rule.clone()) {
Entry::Vacant(e) => {
let max_queued = max_queued.unwrap_or(DEFAULT_MAX_QUEUED);
let (sender, mut receiver) = broadcast(max_queued);
receiver.set_await_active(false);
if self.is_bus() && msg_type == MessageType::Signal {
fdo::DBusProxy::builder(self)
.cache_properties(CacheProperties::No)
.build()
.await?
.add_match_rule(e.key().inner().clone())
.await?;
}
e.insert((1, receiver.clone().deactivate()));
self.inner
.msg_senders
.lock()
.await
.insert(Some(rule), sender);
Ok(receiver)
}
Entry::Occupied(mut e) => {
let (num_subscriptions, receiver) = e.get_mut();
*num_subscriptions += 1;
if let Some(max_queued) = max_queued {
if max_queued > receiver.capacity() {
receiver.set_capacity(max_queued);
}
}
Ok(receiver.activate_cloned())
}
}
}
pub(crate) async fn remove_match(&self, rule: OwnedMatchRule) -> Result<bool> {
use std::collections::hash_map::Entry;
let mut subscriptions = self.inner.subscriptions.lock().await;
// TODO when it becomes stable, use HashMap::raw_entry and only require expr: &str
// (both here and in add_match)
let msg_type = rule.msg_type().unwrap_or(MessageType::Signal);
match subscriptions.entry(rule) {
Entry::Vacant(_) => Ok(false),
Entry::Occupied(mut e) => {
let rule = e.key().inner().clone();
e.get_mut().0 -= 1;
if e.get().0 == 0 {
if self.is_bus() && msg_type == MessageType::Signal {
fdo::DBusProxy::builder(self)
.cache_properties(CacheProperties::No)
.build()
.await?
.remove_match_rule(rule.clone())
.await?;
}
e.remove();
self.inner
.msg_senders
.lock()
.await
.remove(&Some(rule.into()));
}
Ok(true)
}
}
}
pub(crate) fn queue_remove_match(&self, rule: OwnedMatchRule) {
let conn = self.clone();
let task_name = format!("Remove match `{}`", *rule);
let remove_match =
async move { conn.remove_match(rule).await }.instrument(trace_span!("{}", task_name));
self.inner.executor.spawn(remove_match, &task_name).detach()
}
pub(crate) async fn hello_bus(&self) -> Result<()> {
let dbus_proxy = fdo::DBusProxy::builder(self)
.cache_properties(CacheProperties::No)
.build()
.await?;
let name = dbus_proxy.hello().await?;
self.inner
.unique_name
.set(name)
// programmer (probably our) error if this fails.
.expect("Attempted to set unique_name twice");
Ok(())
}
pub(crate) async fn new(
auth: Authenticated<Box<dyn Socket>>,
bus_connection: bool,
executor: Executor<'static>,
) -> Result<Self> {
#[cfg(unix)]
let cap_unix_fd = auth.cap_unix_fd;
macro_rules! create_msg_broadcast_channel {
($size:expr) => {{
let (msg_sender, msg_receiver) = broadcast($size);
let mut msg_receiver = msg_receiver.deactivate();
msg_receiver.set_await_active(false);
(msg_sender, msg_receiver)
}};
}
// The unfiltered message channel.
let (msg_sender, msg_receiver) = create_msg_broadcast_channel!(DEFAULT_MAX_QUEUED);
let mut msg_senders = HashMap::new();
msg_senders.insert(None, msg_sender);
// The special method return & error channel.
let (method_return_sender, method_return_receiver) =
create_msg_broadcast_channel!(DEFAULT_MAX_METHOD_RETURN_QUEUED);
let rule = MatchRule::builder()
.msg_type(MessageType::MethodReturn)
.build()
.into();
msg_senders.insert(Some(rule), method_return_sender.clone());
let rule = MatchRule::builder()
.msg_type(MessageType::Error)
.build()
.into();
msg_senders.insert(Some(rule), method_return_sender);
let msg_senders = Arc::new(Mutex::new(msg_senders));
let subscriptions = Mutex::new(HashMap::new());
let raw_conn = Arc::new(sync::Mutex::new(auth.conn));
let connection = Self {
inner: Arc::new(ConnectionInner {
raw_conn,
server_guid: auth.server_guid,
#[cfg(unix)]
cap_unix_fd,
bus_conn: bus_connection,
serial: AtomicU32::new(1),
unique_name: OnceCell::new(),
subscriptions,
object_server: OnceCell::new(),
object_server_dispatch_task: OnceCell::new(),
executor,
socket_reader_task: OnceCell::new(),
msg_senders,
msg_receiver,
method_return_receiver,
registered_names: Mutex::new(HashMap::new()),
}),
};
Ok(connection)
}
fn next_serial(&self) -> u32 {
self.inner.serial.fetch_add(1, SeqCst)
}
/// Create a `Connection` to the session/user message bus.
pub async fn session() -> Result<Self> {
ConnectionBuilder::session()?.build().await
}
/// Create a `Connection` to the system-wide message bus.
pub async fn system() -> Result<Self> {
ConnectionBuilder::system()?.build().await
}
/// Returns a listener, notified on various connection activity.
///
/// This function is meant for the caller to implement idle or timeout on inactivity.
pub fn monitor_activity(&self) -> EventListener {
self.inner
.raw_conn
.lock()
.expect("poisoned lock")
.monitor_activity()
}
/// Returns the peer process ID, or Ok(None) if it cannot be returned for the associated socket.
#[deprecated(
since = "3.13.0",
note = "Use `peer_credentials` instead, which returns `ConnectionCredentials` which includes
the peer PID."
)]
pub fn peer_pid(&self) -> io::Result<Option<u32>> {
self.inner
.raw_conn
.lock()
.expect("poisoned lock")
.socket()
.peer_pid()
}
/// Returns the peer credentials.
///
/// The fields are populated on the best effort basis. Some or all fields may not even make
/// sense for certain sockets or on certain platforms and hence will be set to `None`.
///
/// # Caveats
///
/// Currently `unix_group_ids` and `linux_security_label` fields are not populated.
#[allow(deprecated)]
pub async fn peer_credentials(&self) -> io::Result<ConnectionCredentials> {
let raw_conn = self.inner.raw_conn.lock().expect("poisoned lock");
let socket = raw_conn.socket();
Ok(ConnectionCredentials {
process_id: socket.peer_pid()?,
#[cfg(unix)]
unix_user_id: socket.uid()?,
#[cfg(not(unix))]
unix_user_id: None,
// Should we beother providing all the groups of user? What's the use case?
unix_group_ids: None,
#[cfg(windows)]
windows_sid: socket.peer_sid(),
#[cfg(not(windows))]
windows_sid: None,
// TODO: Populate this field (see the field docs for pointers).
linux_security_label: None,
})
}
pub(crate) fn init_socket_reader(&self) {
let inner = &self.inner;
inner
.socket_reader_task
.set(
SocketReader::new(inner.raw_conn.clone(), inner.msg_senders.clone())
.spawn(&inner.executor),
)
.expect("Attempted to set `socket_reader_task` twice");
}
}
impl<T> Sink<T> for Connection
where
T: Into<Arc<Message>>,
{
type Error = Error;
fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>> {
<&Connection as Sink<Arc<Message>>>::poll_ready(Pin::new(&mut &*self), cx)
}
fn start_send(self: Pin<&mut Self>, msg: T) -> Result<()> {
Pin::new(&mut &*self).start_send(msg)
}
fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>> {
<&Connection as Sink<Arc<Message>>>::poll_flush(Pin::new(&mut &*self), cx)
}
fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>> {
<&Connection as Sink<Arc<Message>>>::poll_close(Pin::new(&mut &*self), cx)
}
}
impl<'a, T> Sink<T> for &'a Connection
where
T: Into<Arc<Message>>,
{
type Error = Error;
fn poll_ready(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>> {
// TODO: We should have a max queue length in raw::Socket for outgoing messages.
Poll::Ready(Ok(()))
}
fn start_send(self: Pin<&mut Self>, msg: T) -> Result<()> {
let msg = msg.into();
#[cfg(unix)]
if !msg.fds().is_empty() && !self.inner.cap_unix_fd {
return Err(Error::Unsupported);
}
self.inner
.raw_conn
.lock()
.expect("poisoned lock")
.enqueue_message(msg);
Ok(())
}
fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>> {
self.inner.raw_conn.lock().expect("poisoned lock").flush(cx)
}
fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>> {
let mut raw_conn = self.inner.raw_conn.lock().expect("poisoned lock");
let res = raw_conn.flush(cx);
match ready!(res) {
Ok(_) => (),
Err(e) => return Poll::Ready(Err(e)),
}
Poll::Ready(raw_conn.close())
}
}
impl From<crate::blocking::Connection> for Connection {
fn from(conn: crate::blocking::Connection) -> Self {
conn.into_inner()
}
}
// Internal API that allows keeping a weak connection ref around.
#[derive(Debug)]
pub(crate) struct WeakConnection {
inner: Weak<ConnectionInner>,
}
impl WeakConnection {
/// Upgrade to a Connection.
pub fn upgrade(&self) -> Option<Connection> {
self.inner.upgrade().map(|inner| Connection { inner })
}
}
impl From<&Connection> for WeakConnection {
fn from(conn: &Connection) -> Self {
Self {
inner: Arc::downgrade(&conn.inner),
}
}
}
#[derive(Debug)]
enum NameStatus {
// The task waits for name lost signal if owner allows replacement.
Owner(#[allow(unused)] Option<Task<()>>),
// The task waits for name acquisition signal.
Queued(#[allow(unused)] Task<()>),
}
#[cfg(test)]
mod tests {
use futures_util::stream::TryStreamExt;
use ntest::timeout;
use test_log::test;
use crate::{fdo::DBusProxy, AuthMechanism};
use super::*;
// Same numbered client and server are already paired up. We make use of the
// `futures_util::stream::Forward` to connect the two pipes and hence test one of the benefits
// of our Stream and Sink impls.
async fn test_p2p(
server1: Connection,
client1: Connection,
server2: Connection,
client2: Connection,
) -> Result<()> {
let forward1 = MessageStream::from(server1.clone()).forward(client2.clone());
let forward2 = MessageStream::from(&client2).forward(server1);
let _forward_task = client1.executor().spawn(
async move { futures_util::try_join!(forward1, forward2) },
"forward_task",
);
let server_ready = Event::new();
let server_ready_listener = server_ready.listen();
let client_done = Event::new();
let client_done_listener = client_done.listen();
let server_future = async move {
let mut stream = MessageStream::from(&server2);
server_ready.notify(1);
let method = loop {
let m = stream.try_next().await?.unwrap();
if m.to_string() == "Method call Test" {
break m;
}
};
// Send another message first to check the queueing function on client side.
server2
.emit_signal(None::<()>, "/", "org.zbus.p2p", "ASignalForYou", &())
.await?;
server2.reply(&method, &("yay")).await?;
client_done_listener.await;
Ok(())
};
let client_future = async move {
let mut stream = MessageStream::from(&client1);
server_ready_listener.await;
let reply = client1
.call_method(None::<()>, "/", Some("org.zbus.p2p"), "Test", &())
.await?;
assert_eq!(reply.to_string(), "Method return");
// Check we didn't miss the signal that was sent during the call.
let m = stream.try_next().await?.unwrap();
client_done.notify(1);
assert_eq!(m.to_string(), "Signal ASignalForYou");
reply.body::<String>()
};
let (val, _) = futures_util::try_join!(client_future, server_future,)?;
assert_eq!(val, "yay");
Ok(())
}
#[test]
#[timeout(15000)]
fn tcp_p2p() {
crate::utils::block_on(test_tcp_p2p()).unwrap();
}
async fn test_tcp_p2p() -> Result<()> {
let (server1, client1) = tcp_p2p_pipe().await?;
let (server2, client2) = tcp_p2p_pipe().await?;
test_p2p(server1, client1, server2, client2).await
}
async fn tcp_p2p_pipe() -> Result<(Connection, Connection)> {
let guid = Guid::generate();
#[cfg(not(feature = "tokio"))]
let (server_conn_builder, client_conn_builder) = {
let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
let addr = listener.local_addr().unwrap();
let p1 = std::net::TcpStream::connect(addr).unwrap();
let p0 = listener.incoming().next().unwrap().unwrap();
(
ConnectionBuilder::tcp_stream(p0)
.server(&guid)
.p2p()
.auth_mechanisms(&[AuthMechanism::Anonymous]),
ConnectionBuilder::tcp_stream(p1).p2p(),
)
};
#[cfg(feature = "tokio")]
let (server_conn_builder, client_conn_builder) = {
let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
let addr = listener.local_addr().unwrap();
let p1 = tokio::net::TcpStream::connect(addr).await.unwrap();
let p0 = listener.accept().await.unwrap().0;
(
ConnectionBuilder::tcp_stream(p0)
.server(&guid)
.p2p()
.auth_mechanisms(&[AuthMechanism::Anonymous]),
ConnectionBuilder::tcp_stream(p1).p2p(),
)
};
futures_util::try_join!(server_conn_builder.build(), client_conn_builder.build())
}
#[cfg(unix)]
#[test]
#[timeout(15000)]
fn unix_p2p() {
crate::utils::block_on(test_unix_p2p()).unwrap();
}
#[cfg(unix)]
async fn test_unix_p2p() -> Result<()> {
let (server1, client1) = unix_p2p_pipe().await?;
let (server2, client2) = unix_p2p_pipe().await?;
test_p2p(server1, client1, server2, client2).await
}
#[cfg(unix)]
async fn unix_p2p_pipe() -> Result<(Connection, Connection)> {
#[cfg(not(feature = "tokio"))]
use std::os::unix::net::UnixStream;
#[cfg(feature = "tokio")]
use tokio::net::UnixStream;
#[cfg(all(windows, not(feature = "tokio")))]
use uds_windows::UnixStream;
let guid = Guid::generate();
let (p0, p1) = UnixStream::pair().unwrap();
futures_util::try_join!(
ConnectionBuilder::unix_stream(p1).p2p().build(),
ConnectionBuilder::unix_stream(p0)
.server(&guid)
.p2p()
.build(),
)
}
// Compile-test only since we don't have a VM setup to run this with/in.
#[cfg(any(
all(feature = "vsock", not(feature = "tokio")),
feature = "tokio-vsock"
))]
#[test]
#[timeout(15000)]
#[ignore]
fn vsock_p2p() {
crate::utils::block_on(test_vsock_p2p()).unwrap();
}
#[cfg(any(
all(feature = "vsock", not(feature = "tokio")),
feature = "tokio-vsock"
))]
async fn test_vsock_p2p() -> Result<()> {
let (server1, client1) = vsock_p2p_pipe().await?;
let (server2, client2) = vsock_p2p_pipe().await?;
test_p2p(server1, client1, server2, client2).await
}
#[cfg(all(feature = "vsock", not(feature = "tokio")))]
async fn vsock_p2p_pipe() -> Result<(Connection, Connection)> {
let guid = Guid::generate();
let listener = vsock::VsockListener::bind_with_cid_port(vsock::VMADDR_CID_ANY, 42).unwrap();
let addr = listener.local_addr().unwrap();
let client = vsock::VsockStream::connect(&addr).unwrap();
let server = listener.incoming().next().unwrap().unwrap();
futures_util::try_join!(
ConnectionBuilder::vsock_stream(server)
.server(&guid)
.p2p()
.auth_mechanisms(&[AuthMechanism::Anonymous])
.build(),
ConnectionBuilder::vsock_stream(client).p2p().build(),
)
}
#[cfg(feature = "tokio-vsock")]
async fn vsock_p2p_pipe() -> Result<(Connection, Connection)> {
let guid = Guid::generate();
let listener = tokio_vsock::VsockListener::bind(2, 42).unwrap();
let client = tokio_vsock::VsockStream::connect(3, 42).await.unwrap();
let server = listener.incoming().next().await.unwrap().unwrap();
futures_util::try_join!(
ConnectionBuilder::vsock_stream(server)
.server(&guid)
.p2p()
.auth_mechanisms(&[AuthMechanism::Anonymous])
.build(),
ConnectionBuilder::vsock_stream(client).p2p().build(),
)
}
#[test]
#[timeout(15000)]
fn serial_monotonically_increases() {
crate::utils::block_on(test_serial_monotonically_increases());
}
async fn test_serial_monotonically_increases() {
let c = Connection::session().await.unwrap();
let serial = c.next_serial() + 1;
for next in serial..serial + 10 {
assert_eq!(next, c.next_serial());
}
}
#[cfg(all(windows, feature = "windows-gdbus"))]
#[test]
fn connect_gdbus_session_bus() {
let addr = crate::win32::windows_autolaunch_bus_address()
.expect("Unable to get GDBus session bus address");
crate::block_on(async { addr.connect().await }).expect("Unable to connect to session bus");
}
#[cfg(target_os = "macos")]
#[test]
fn connect_launchd_session_bus() {
crate::block_on(async {
let addr = crate::address::macos_launchd_bus_address("DBUS_LAUNCHD_SESSION_BUS_SOCKET")
.await
.expect("Unable to get Launchd session bus address");
addr.connect().await
})
.expect("Unable to connect to session bus");
}
#[test]
#[timeout(15000)]
fn disconnect_on_drop() {
// Reproducer for https://github.com/dbus2/zbus/issues/308 where setting up the
// objectserver would cause the connection to not disconnect on drop.
crate::utils::block_on(test_disconnect_on_drop());
}
async fn test_disconnect_on_drop() {
#[derive(Default)]
struct MyInterface {}
#[crate::dbus_interface(name = "dev.peelz.FooBar.Baz")]
impl MyInterface {
fn do_thing(&self) {}
}
let name = "dev.peelz.foobar";
let connection = ConnectionBuilder::session()
.unwrap()
.name(name)
.unwrap()
.serve_at("/dev/peelz/FooBar", MyInterface::default())
.unwrap()
.build()
.await
.unwrap();
let connection2 = Connection::session().await.unwrap();
let dbus = DBusProxy::new(&connection2).await.unwrap();
let mut stream = dbus
.receive_name_owner_changed_with_args(&[(0, name), (2, "")])
.await
.unwrap();
drop(connection);
// If the connection is not dropped, this will hang forever.
stream.next().await.unwrap();
// Let's still make sure the name is gone.
let name_has_owner = dbus.name_has_owner(name.try_into().unwrap()).await.unwrap();
assert!(!name_has_owner);
}
#[cfg(any(unix, not(feature = "tokio")))]
#[test]
#[timeout(15000)]
fn unix_p2p_cookie_auth() {
use crate::utils::block_on;
use std::{
fs::{create_dir_all, remove_file, write},
time::{SystemTime as Time, UNIX_EPOCH},
};
#[cfg(unix)]
use std::{
fs::{set_permissions, Permissions},
os::unix::fs::PermissionsExt,
};
use xdg_home::home_dir;
let cookie_context = "zbus-test-cookie-context";
let cookie_id = 123456789;
let cookie = hex::encode(b"our cookie");
// Ensure cookie directory exists.
let cookie_dir = home_dir().unwrap().join(".dbus-keyrings");
create_dir_all(&cookie_dir).unwrap();
#[cfg(unix)]
set_permissions(&cookie_dir, Permissions::from_mode(0o700)).unwrap();
// Create a cookie file.
let cookie_file = cookie_dir.join(cookie_context);
let ts = Time::now().duration_since(UNIX_EPOCH).unwrap().as_secs();
let cookie_entry = format!("{cookie_id} {ts} {cookie}");
write(&cookie_file, cookie_entry).unwrap();
// Explicit cookie ID.
let res1 = block_on(test_unix_p2p_cookie_auth(cookie_context, Some(cookie_id)));
// Implicit cookie ID (first one should be picked).
let res2 = block_on(test_unix_p2p_cookie_auth(cookie_context, None));
// Remove the cookie file.
remove_file(&cookie_file).unwrap();
res1.unwrap();
res2.unwrap();
}
#[cfg(any(unix, not(feature = "tokio")))]
async fn test_unix_p2p_cookie_auth(
cookie_context: &'static str,
cookie_id: Option<usize>,
) -> Result<()> {
#[cfg(all(unix, not(feature = "tokio")))]
use std::os::unix::net::UnixStream;
#[cfg(all(unix, feature = "tokio"))]
use tokio::net::UnixStream;
#[cfg(all(windows, not(feature = "tokio")))]
use uds_windows::UnixStream;
let guid = Guid::generate();
let (p0, p1) = UnixStream::pair().unwrap();
let mut server_builder = ConnectionBuilder::unix_stream(p0)
.server(&guid)
.p2p()
.auth_mechanisms(&[AuthMechanism::Cookie])
.cookie_context(cookie_context)
.unwrap();
if let Some(cookie_id) = cookie_id {
server_builder = server_builder.cookie_id(cookie_id);
}
futures_util::try_join!(
ConnectionBuilder::unix_stream(p1).p2p().build(),
server_builder.build(),
)
.map(|_| ())
}
}