iroh_net/magicsock/node_map/node_state.rs
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
use std::{
collections::{btree_map::Entry, BTreeSet, HashMap},
hash::Hash,
net::{IpAddr, SocketAddr},
time::{Duration, Instant},
};
use iroh_metrics::inc;
use netwatch::ip::is_unicast_link_local;
use serde::{Deserialize, Serialize};
use tokio::sync::mpsc;
use tracing::{debug, event, info, instrument, trace, warn, Level};
use watchable::{Watchable, WatcherStream};
use super::{
best_addr::{self, ClearReason, Source as BestAddrSource},
path_state::{summarize_node_paths, PathState},
udp_paths::{NodeUdpPaths, UdpSendAddr},
IpPort, Source,
};
use crate::{
disco::{self, SendAddr},
endpoint::AddrInfo,
key::PublicKey,
magicsock::{ActorMessage, MagicsockMetrics, QuicMappedAddr, Timer, HEARTBEAT_INTERVAL},
relay::RelayUrl,
stun,
util::relay_only_mode,
NodeAddr, NodeId,
};
/// Number of addresses that are not active that we keep around per node.
///
/// See [`NodeState::prune_direct_addresses`].
pub(super) const MAX_INACTIVE_DIRECT_ADDRESSES: usize = 20;
/// How long since an endpoint path was last alive before it might be pruned.
const LAST_ALIVE_PRUNE_DURATION: Duration = Duration::from_secs(120);
/// How long we wait for a pong reply before assuming it's never coming.
const PING_TIMEOUT_DURATION: Duration = Duration::from_secs(5);
/// The latency at or under which we don't try to upgrade to a better path.
const GOOD_ENOUGH_LATENCY: Duration = Duration::from_millis(5);
/// How long since the last activity we try to keep an established endpoint peering alive.
/// It's also the idle time at which we stop doing STUN queries to keep NAT mappings alive.
pub(super) const SESSION_ACTIVE_TIMEOUT: Duration = Duration::from_secs(45);
/// How often we try to upgrade to a better patheven if we have some non-relay route that works.
const UPGRADE_INTERVAL: Duration = Duration::from_secs(60);
/// How long until we send a stayin alive ping
const STAYIN_ALIVE_MIN_ELAPSED: Duration = Duration::from_secs(2);
#[derive(Debug)]
pub(in crate::magicsock) enum PingAction {
SendCallMeMaybe {
relay_url: RelayUrl,
dst_node: NodeId,
},
SendPing(SendPing),
}
#[derive(Debug)]
pub(in crate::magicsock) struct SendPing {
pub id: usize,
pub dst: SendAddr,
pub dst_node: NodeId,
pub tx_id: stun::TransactionId,
pub purpose: DiscoPingPurpose,
}
/// Indicating an [`NodeState`] has handled a ping.
#[derive(Debug)]
pub struct PingHandled {
/// What this ping did to the [`NodeState`].
pub role: PingRole,
/// Whether the sender path should also be pinged.
///
/// This is the case if an [`NodeState`] does not yet have a direct path, i.e. it has no
/// best_addr. In this case we want to ping right back to open the direct path in this
/// direction as well.
pub needs_ping_back: Option<SendPing>,
}
#[derive(Debug)]
pub enum PingRole {
Duplicate,
NewPath,
LikelyHeartbeat,
Activate,
}
/// An iroh node, which we can have connections with.
///
/// The whole point of the magicsock is that we can have multiple **paths** to a particular
/// node. One of these paths is via the endpoint's home relay node but as we establish a
/// connection we'll hopefully discover more direct paths.
#[derive(Debug)]
pub(super) struct NodeState {
/// The ID used as index in the [`NodeMap`].
///
/// [`NodeMap`]: super::NodeMap
id: usize,
/// The UDP address used on the QUIC-layer to address this node.
quic_mapped_addr: QuicMappedAddr,
/// The global identifier for this endpoint.
node_id: NodeId,
/// The last time we pinged all endpoints.
last_full_ping: Option<Instant>,
/// The url of relay node that we can relay over to communicate.
///
/// The fallback/bootstrap path, if non-zero (non-zero for well-behaved clients).
relay_url: Option<(RelayUrl, PathState)>,
udp_paths: NodeUdpPaths,
sent_pings: HashMap<stun::TransactionId, SentPing>,
/// Last time this node was used.
///
/// A node is marked as in use when sending datagrams to them, or when having received
/// datagrams from it. Regardless of whether the datagrams are payload or DISCO, and whether
/// they go via UDP or the relay.
///
/// Note that sending datagrams to a node does not mean the node receives them.
last_used: Option<Instant>,
/// Last time we sent a call-me-maybe.
///
/// When we do not have a direct connection and we try to send some data, we will try to
/// do a full ping + call-me-maybe. Usually each side only needs to send one
/// call-me-maybe to the other for holes to be punched in both directions however. So
/// we only try and send one per [`HEARTBEAT_INTERVAL`]. Each [`HEARTBEAT_INTERVAL`]
/// the [`NodeState::stayin_alive`] function is called, which will trigger new
/// call-me-maybe messages as backup.
last_call_me_maybe: Option<Instant>,
/// The type of connection we have to the node, either direct, relay, mixed, or none.
conn_type: Watchable<ConnectionType>,
/// Whether the conn_type was ever observed to be `Direct` at some point.
///
/// Used for metric reporting.
has_been_direct: bool,
}
/// Options for creating a new [`NodeState`].
#[derive(Debug)]
pub(super) struct Options {
pub(super) node_id: NodeId,
pub(super) relay_url: Option<RelayUrl>,
/// Is this endpoint currently active (sending data)?
pub(super) active: bool,
pub(super) source: super::Source,
}
impl NodeState {
pub(super) fn new(id: usize, options: Options) -> Self {
let quic_mapped_addr = QuicMappedAddr::generate();
if options.relay_url.is_some() {
// we potentially have a relay connection to the node
inc!(MagicsockMetrics, num_relay_conns_added);
}
let now = Instant::now();
NodeState {
id,
quic_mapped_addr,
node_id: options.node_id,
last_full_ping: None,
relay_url: options.relay_url.map(|url| {
(
url.clone(),
PathState::new(options.node_id, SendAddr::Relay(url), options.source, now),
)
}),
udp_paths: NodeUdpPaths::new(),
sent_pings: HashMap::new(),
last_used: options.active.then(Instant::now),
last_call_me_maybe: None,
conn_type: Watchable::new(ConnectionType::None),
has_been_direct: false,
}
}
pub(super) fn public_key(&self) -> &PublicKey {
&self.node_id
}
pub(super) fn quic_mapped_addr(&self) -> &QuicMappedAddr {
&self.quic_mapped_addr
}
pub(super) fn id(&self) -> usize {
self.id
}
pub(super) fn conn_type(&self) -> ConnectionType {
self.conn_type.get()
}
pub(super) fn conn_type_stream(&self) -> WatcherStream<ConnectionType> {
self.conn_type.watch().into_stream()
}
/// Returns info about this node.
pub(super) fn info(&self, now: Instant) -> RemoteInfo {
let conn_type = self.conn_type.get();
let latency = match conn_type {
ConnectionType::Direct(addr) => self
.udp_paths
.paths
.get(&addr.into())
.and_then(|state| state.latency()),
ConnectionType::Relay(ref url) => self
.relay_url
.as_ref()
.filter(|(relay_url, _)| relay_url == url)
.and_then(|(_, state)| state.latency()),
ConnectionType::Mixed(addr, ref url) => {
let addr_latency = self
.udp_paths
.paths
.get(&addr.into())
.and_then(|state| state.latency());
let relay_latency = self
.relay_url
.as_ref()
.filter(|(relay_url, _)| relay_url == url)
.and_then(|(_, state)| state.latency());
addr_latency.min(relay_latency)
}
ConnectionType::None => None,
};
let addrs = self
.udp_paths
.paths
.iter()
.map(|(addr, path_state)| DirectAddrInfo {
addr: SocketAddr::from(*addr),
latency: path_state.recent_pong.as_ref().map(|pong| pong.latency),
last_control: path_state.last_control_msg(now),
last_payload: path_state
.last_payload_msg
.as_ref()
.map(|instant| now.duration_since(*instant)),
last_alive: path_state
.last_alive()
.map(|instant| now.duration_since(instant)),
sources: path_state
.sources
.iter()
.map(|(source, instant)| (source.clone(), now.duration_since(*instant)))
.collect(),
})
.collect();
RemoteInfo {
node_id: self.node_id,
relay_url: self.relay_url.clone().map(|r| r.into()),
addrs,
conn_type,
latency,
last_used: self.last_used.map(|instant| now.duration_since(instant)),
}
}
/// Returns the relay url of this endpoint
pub(super) fn relay_url(&self) -> Option<RelayUrl> {
self.relay_url.as_ref().map(|(url, _state)| url.clone())
}
/// Returns the address(es) that should be used for sending the next packet.
///
/// This may return to send on one, both or no paths.
fn addr_for_send(
&mut self,
now: &Instant,
have_ipv6: bool,
) -> (Option<SocketAddr>, Option<RelayUrl>) {
if relay_only_mode() {
debug!("in `DEV_relay_ONLY` mode, giving the relay address as the only viable address for this endpoint");
return (None, self.relay_url());
}
let (best_addr, relay_url) = match self.udp_paths.send_addr(*now, have_ipv6) {
UdpSendAddr::Valid(addr) => {
// If we have a valid address we use it.
trace!(%addr, "UdpSendAddr is valid, use it");
(Some(addr), None)
}
UdpSendAddr::Outdated(addr) => {
// If the address is outdated we use it, but send via relay at the same time.
// We also send disco pings so that it will become valid again if it still
// works (i.e. we don't need to holepunch again).
trace!(%addr, "UdpSendAddr is outdated, use it together with relay");
(Some(addr), self.relay_url())
}
UdpSendAddr::Unconfirmed(addr) => {
trace!(%addr, "UdpSendAddr is unconfirmed, use it together with relay");
(Some(addr), self.relay_url())
}
UdpSendAddr::None => {
trace!("No UdpSendAddr, use relay");
(None, self.relay_url())
}
};
let typ = match (best_addr, relay_url.clone()) {
(Some(best_addr), Some(relay_url)) => ConnectionType::Mixed(best_addr, relay_url),
(Some(best_addr), None) => ConnectionType::Direct(best_addr),
(None, Some(relay_url)) => ConnectionType::Relay(relay_url),
(None, None) => ConnectionType::None,
};
if !self.has_been_direct && matches!(&typ, ConnectionType::Direct(_)) {
self.has_been_direct = true;
inc!(MagicsockMetrics, nodes_contacted_directly);
}
if let Ok(prev_typ) = self.conn_type.update(typ.clone()) {
// The connection type has changed.
event!(
target: "events.net.conn_type.changed",
Level::DEBUG,
remote_node = %self.node_id.fmt_short(),
conn_type = ?typ,
);
info!(%typ, "new connection type");
// Update some metrics
match (prev_typ, typ) {
(ConnectionType::Relay(_), ConnectionType::Direct(_))
| (ConnectionType::Mixed(_, _), ConnectionType::Direct(_)) => {
inc!(MagicsockMetrics, num_direct_conns_added);
inc!(MagicsockMetrics, num_relay_conns_removed);
}
(ConnectionType::Direct(_), ConnectionType::Relay(_))
| (ConnectionType::Direct(_), ConnectionType::Mixed(_, _)) => {
inc!(MagicsockMetrics, num_direct_conns_removed);
inc!(MagicsockMetrics, num_relay_conns_added);
}
(ConnectionType::None, ConnectionType::Direct(_)) => {
inc!(MagicsockMetrics, num_direct_conns_added)
}
(ConnectionType::Direct(_), ConnectionType::None) => {
inc!(MagicsockMetrics, num_direct_conns_removed)
}
(ConnectionType::None, ConnectionType::Relay(_))
| (ConnectionType::None, ConnectionType::Mixed(_, _)) => {
inc!(MagicsockMetrics, num_relay_conns_added)
}
(ConnectionType::Relay(_), ConnectionType::None)
| (ConnectionType::Mixed(_, _), ConnectionType::None) => {
inc!(MagicsockMetrics, num_relay_conns_removed)
}
_ => (),
}
}
(best_addr, relay_url)
}
/// Removes a direct address for this node.
///
/// If this is also the best address, it will be cleared as well.
pub(super) fn remove_direct_addr(&mut self, ip_port: &IpPort, reason: ClearReason) {
let Some(state) = self.udp_paths.paths.remove(ip_port) else {
return;
};
match state.last_alive().map(|instant| instant.elapsed()) {
Some(last_alive) => debug!(%ip_port, ?last_alive, ?reason, "pruning address"),
None => debug!(%ip_port, last_seen=%"never", ?reason, "pruning address"),
}
self.udp_paths.best_addr.clear_if_equals(
(*ip_port).into(),
reason,
self.relay_url.is_some(),
);
}
/// Whether we need to send another call-me-maybe to the endpoint.
///
/// Basically we need to send a call-me-maybe if we need to find a better path. Maybe
/// we only have a relay path, or our path is expired.
///
/// When a call-me-maybe message is sent we also need to send pings to all known paths
/// of the endpoint. The [`NodeState::send_call_me_maybe`] function takes care of this.
#[instrument("want_call_me_maybe", skip_all)]
fn want_call_me_maybe(&self, now: &Instant) -> bool {
trace!("full ping: wanted?");
let Some(last_full_ping) = self.last_full_ping else {
debug!("no previous full ping: need full ping");
return true;
};
match self.udp_paths.best_addr.state(*now) {
best_addr::State::Empty => {
debug!("best addr not set: need full ping");
true
}
best_addr::State::Outdated(_) => {
debug!("best addr expired: need full ping");
true
}
best_addr::State::Valid(addr) => {
if addr.latency > GOOD_ENOUGH_LATENCY && *now - last_full_ping >= UPGRADE_INTERVAL {
debug!(
"full ping interval expired and latency is only {}ms: need full ping",
addr.latency.as_millis()
);
true
} else {
trace!(?now, "best_addr valid: not needed");
false
}
}
}
}
/// Cleanup the expired ping for the passed in txid.
#[instrument("disco", skip_all, fields(node = %self.node_id.fmt_short()))]
pub(super) fn ping_timeout(&mut self, txid: stun::TransactionId) {
if let Some(sp) = self.sent_pings.remove(&txid) {
debug!(tx = %hex::encode(txid), addr = %sp.to, "pong not received in timeout");
match sp.to {
SendAddr::Udp(addr) => {
if let Some(path_state) = self.udp_paths.paths.get_mut(&addr.into()) {
path_state.last_ping = None;
let consider_alive = path_state
.last_alive()
.map(|last_alive| last_alive.elapsed() <= PING_TIMEOUT_DURATION)
.unwrap_or(false);
if !consider_alive {
// If there was no sign of life from this path during the time
// which we should have received the pong, clear best addr and
// pong. Both are used to select this path again, but we know
// it's not a usable path now.
path_state.recent_pong = None;
self.udp_paths.best_addr.clear_if_equals(
addr,
ClearReason::PongTimeout,
self.relay_url().is_some(),
)
}
} else {
// If we have no state for the best addr it should have been cleared
// anyway.
self.udp_paths.best_addr.clear_if_equals(
addr,
ClearReason::PongTimeout,
self.relay_url.is_some(),
);
}
}
SendAddr::Relay(ref url) => {
if let Some((home_relay, relay_state)) = self.relay_url.as_mut() {
if home_relay == url {
// lost connectivity via relay
relay_state.last_ping = None;
}
}
}
}
}
}
#[must_use = "pings must be handled"]
fn start_ping(&self, dst: SendAddr, purpose: DiscoPingPurpose) -> Option<SendPing> {
if relay_only_mode() && !dst.is_relay() {
// don't attempt any hole punching in relay only mode
warn!("in `DEV_relay_ONLY` mode, ignoring request to start a hole punching attempt.");
return None;
}
let tx_id = stun::TransactionId::default();
trace!(tx = %hex::encode(tx_id), %dst, ?purpose,
dst = %self.node_id.fmt_short(), "start ping");
event!(
target: "events.net.ping.sent",
Level::DEBUG,
remote_node = %self.node_id.fmt_short(),
?dst,
txn = ?tx_id,
?purpose,
);
Some(SendPing {
id: self.id,
dst,
dst_node: self.node_id,
tx_id,
purpose,
})
}
/// Record the fact that a ping has been sent out.
pub(super) fn ping_sent(
&mut self,
to: SendAddr,
tx_id: stun::TransactionId,
purpose: DiscoPingPurpose,
sender: mpsc::Sender<ActorMessage>,
) {
trace!(%to, tx = %hex::encode(tx_id), ?purpose, "record ping sent");
let now = Instant::now();
let mut path_found = false;
match to {
SendAddr::Udp(addr) => {
if let Some(st) = self.udp_paths.paths.get_mut(&addr.into()) {
st.last_ping.replace(now);
path_found = true
}
}
SendAddr::Relay(ref url) => {
if let Some((home_relay, relay_state)) = self.relay_url.as_mut() {
if home_relay == url {
relay_state.last_ping.replace(now);
path_found = true
}
}
}
}
if !path_found {
// Shouldn't happen. But don't ping an endpoint that's not active for us.
warn!(%to, ?purpose, "unexpected attempt to ping no longer live path");
return;
}
let id = self.id;
let timer = Timer::after(PING_TIMEOUT_DURATION, async move {
sender
.send(ActorMessage::EndpointPingExpired(id, tx_id))
.await
.ok();
});
self.sent_pings.insert(
tx_id,
SentPing {
to,
at: now,
purpose,
timer,
},
);
}
/// Send a DISCO call-me-maybe message to the peer.
///
/// This takes care of sending the needed pings beforehand. This ensures that we open
/// our firewall's port so that when the receiver sends us DISCO pings in response to
/// our call-me-maybe they will reach us and the other side establishes a direct
/// connection upon our subsequent pong response.
///
/// For [`SendCallMeMaybe::IfNoRecent`], **no** paths will be pinged if there already
/// was a recent call-me-maybe sent.
///
/// The caller is responsible for sending the messages.
#[must_use = "actions must be handled"]
fn send_call_me_maybe(&mut self, now: Instant, always: SendCallMeMaybe) -> Vec<PingAction> {
match always {
SendCallMeMaybe::Always => (),
SendCallMeMaybe::IfNoRecent => {
let had_recent_call_me_maybe = self
.last_call_me_maybe
.map(|when| when.elapsed() < HEARTBEAT_INTERVAL)
.unwrap_or(false);
if had_recent_call_me_maybe {
trace!("skipping call-me-maybe, still recent");
return Vec::new();
}
}
}
// We send pings regardless of whether we have a RelayUrl. If we were given any
// direct address paths to contact but no RelayUrl, we still need to send a DISCO
// ping to the direct address paths so that the other node will learn about us and
// accepts the connection.
let mut msgs = self.send_pings(now);
if let Some(url) = self.relay_url() {
debug!(%url, "queue call-me-maybe");
msgs.push(PingAction::SendCallMeMaybe {
relay_url: url,
dst_node: self.node_id,
});
self.last_call_me_maybe = Some(now);
} else {
debug!("can not send call-me-maybe, no relay URL");
}
msgs
}
/// Send DISCO Pings to all the paths of this node.
///
/// Any paths to the node which have not been recently pinged will be sent a disco
/// ping.
///
/// The caller is responsible for sending the messages.
#[must_use = "actions must be handled"]
fn send_pings(&mut self, now: Instant) -> Vec<PingAction> {
// We allocate +1 in case the caller wants to add a call-me-maybe message.
let mut ping_msgs = Vec::with_capacity(self.udp_paths.paths.len() + 1);
if let Some((url, state)) = self.relay_url.as_ref() {
if state.needs_ping(&now) {
debug!(%url, "relay path needs ping");
if let Some(msg) =
self.start_ping(SendAddr::Relay(url.clone()), DiscoPingPurpose::Discovery)
{
ping_msgs.push(PingAction::SendPing(msg))
}
}
}
if relay_only_mode() {
warn!(
"in `DEV_relay_ONLY` mode, ignoring request to respond to a hole punching attempt."
);
return ping_msgs;
}
self.prune_direct_addresses();
let mut ping_dsts = String::from("[");
self.udp_paths
.paths
.iter()
.filter_map(|(ipp, state)| state.needs_ping(&now).then_some(*ipp))
.filter_map(|ipp| {
self.start_ping(SendAddr::Udp(ipp.into()), DiscoPingPurpose::Discovery)
})
.for_each(|msg| {
use std::fmt::Write;
write!(&mut ping_dsts, " {} ", msg.dst).ok();
ping_msgs.push(PingAction::SendPing(msg));
});
ping_dsts.push(']');
debug!(
%ping_dsts,
dst = %self.node_id.fmt_short(),
paths = %summarize_node_paths(&self.udp_paths.paths),
"sending pings to node",
);
self.last_full_ping.replace(now);
ping_msgs
}
pub(super) fn update_from_node_addr(&mut self, n: &AddrInfo, source: super::Source) {
if self.udp_paths.best_addr.is_empty() {
// we do not have a direct connection, so changing the relay information may
// have an effect on our connection status
if self.relay_url.is_none() && n.relay_url.is_some() {
// we did not have a relay connection before, but now we do
inc!(MagicsockMetrics, num_relay_conns_added)
} else if self.relay_url.is_some() && n.relay_url.is_none() {
// we had a relay connection before but do not have one now
inc!(MagicsockMetrics, num_relay_conns_removed)
}
}
let now = Instant::now();
if n.relay_url.is_some() && n.relay_url != self.relay_url() {
debug!(
"Changing relay node from {:?} to {:?}",
self.relay_url, n.relay_url
);
self.relay_url = n.relay_url.as_ref().map(|url| {
(
url.clone(),
PathState::new(self.node_id, url.clone().into(), source.clone(), now),
)
});
}
for &addr in n.direct_addresses.iter() {
self.udp_paths
.paths
.entry(addr.into())
.and_modify(|path_state| {
path_state.add_source(source.clone(), now);
})
.or_insert_with(|| {
PathState::new(self.node_id, SendAddr::from(addr), source.clone(), now)
});
}
let paths = summarize_node_paths(&self.udp_paths.paths);
debug!(new = ?n.direct_addresses , %paths, "added new direct paths for endpoint");
}
/// Clears all the endpoint's p2p state, reverting it to a relay-only endpoint.
#[instrument(skip_all, fields(node = %self.node_id.fmt_short()))]
pub(super) fn reset(&mut self) {
self.last_full_ping = None;
self.udp_paths
.best_addr
.clear(ClearReason::Reset, self.relay_url.is_some());
for es in self.udp_paths.paths.values_mut() {
es.last_ping = None;
}
}
/// Handle a received Disco Ping.
///
/// - Ensures the paths the ping was received on is a known path for this endpoint.
///
/// - If there is no best_addr for this endpoint yet, sends a ping itself to try and
/// establish one.
///
/// This is called once we've already verified that we got a valid discovery message
/// from `self` via ep.
pub(super) fn handle_ping(
&mut self,
path: SendAddr,
tx_id: stun::TransactionId,
) -> PingHandled {
let now = Instant::now();
let role = match path {
SendAddr::Udp(addr) => match self.udp_paths.paths.entry(addr.into()) {
Entry::Occupied(mut occupied) => occupied.get_mut().handle_ping(tx_id, now),
Entry::Vacant(vacant) => {
info!(%addr, "new direct addr for node");
vacant.insert(PathState::with_ping(
self.node_id,
path.clone(),
tx_id,
Source::Udp,
now,
));
PingRole::NewPath
}
},
SendAddr::Relay(ref url) => {
match self.relay_url.as_mut() {
Some((home_url, _state)) if home_url != url => {
// either the node changed relays or we didn't have a relay address for the
// node. In both cases, trust the new confirmed url
info!(%url, "new relay addr for node");
self.relay_url = Some((
url.clone(),
PathState::with_ping(
self.node_id,
path.clone(),
tx_id,
Source::Relay,
now,
),
));
PingRole::NewPath
}
Some((_home_url, state)) => state.handle_ping(tx_id, now),
None => {
info!(%url, "new relay addr for node");
self.relay_url = Some((
url.clone(),
PathState::with_ping(
self.node_id,
path.clone(),
tx_id,
Source::Relay,
now,
),
));
PingRole::NewPath
}
}
}
};
event!(
target: "events.net.ping.recv",
Level::DEBUG,
remote_node = %self.node_id.fmt_short(),
src = ?path,
txn = ?tx_id,
?role,
);
if matches!(path, SendAddr::Udp(_)) && matches!(role, PingRole::NewPath) {
self.prune_direct_addresses();
}
// if the endpoint does not yet have a best_addrr
let needs_ping_back = if matches!(path, SendAddr::Udp(_))
&& matches!(
self.udp_paths.best_addr.state(now),
best_addr::State::Empty | best_addr::State::Outdated(_)
) {
// We also need to send a ping to make this path available to us as well. This
// is always sent together with a pong. So in the worst case the pong gets lost
// and this ping does not. In that case we ping-pong until both sides have
// received at least one pong. Once both sides have received one pong they both
// have a best_addr and this ping will stop being sent.
self.start_ping(path, DiscoPingPurpose::PingBack)
} else {
None
};
debug!(
?role,
needs_ping_back = ?needs_ping_back.is_some(),
paths = %summarize_node_paths(&self.udp_paths.paths),
"endpoint handled ping",
);
PingHandled {
role,
needs_ping_back,
}
}
/// Prune inactive paths.
///
/// This trims the list of inactive paths for an endpoint. At most
/// [`MAX_INACTIVE_DIRECT_ADDRESSES`] are kept.
pub(super) fn prune_direct_addresses(&mut self) {
// prune candidates are addresses that are not active
let mut prune_candidates: Vec<_> = self
.udp_paths
.paths
.iter()
.filter(|(_ip_port, state)| !state.is_active())
.map(|(ip_port, state)| (*ip_port, state.last_alive()))
.filter(|(_ipp, last_alive)| match last_alive {
Some(last_seen) => last_seen.elapsed() > LAST_ALIVE_PRUNE_DURATION,
None => true,
})
.collect();
let prune_count = prune_candidates
.len()
.saturating_sub(MAX_INACTIVE_DIRECT_ADDRESSES);
if prune_count == 0 {
// nothing to do, within limits
debug!(
paths = %summarize_node_paths(&self.udp_paths.paths),
"prune addresses: {prune_count} pruned",
);
return;
}
// sort leaving the worst addresses first (never contacted) and better ones (most recently
// used ones) last
prune_candidates.sort_unstable_by_key(|(_ip_port, last_alive)| *last_alive);
prune_candidates.truncate(prune_count);
for (ip_port, _last_alive) in prune_candidates.into_iter() {
self.remove_direct_addr(&ip_port, ClearReason::Inactive)
}
debug!(
paths = %summarize_node_paths(&self.udp_paths.paths),
"prune addresses: {prune_count} pruned",
);
}
/// Called when connectivity changes enough that we should question our earlier
/// assumptions about which paths work.
#[instrument("disco", skip_all, fields(node = %self.node_id.fmt_short()))]
pub(super) fn note_connectivity_change(&mut self) {
self.udp_paths.best_addr.clear_trust("connectivity changed");
for es in self.udp_paths.paths.values_mut() {
es.clear();
}
}
/// Handles a Pong message (a reply to an earlier ping).
///
/// It reports the address and key that should be inserted for the endpoint if any.
#[instrument(skip(self))]
pub(super) fn handle_pong(
&mut self,
m: &disco::Pong,
src: SendAddr,
) -> Option<(SocketAddr, PublicKey)> {
event!(
target: "events.net.pong.recv",
Level::DEBUG,
remote_node = self.node_id.fmt_short(),
?src,
txn = ?m.tx_id,
);
let is_relay = src.is_relay();
match self.sent_pings.remove(&m.tx_id) {
None => {
// This is not a pong for a ping we sent.
warn!(tx = %hex::encode(m.tx_id), "received pong with unknown transaction id");
None
}
Some(sp) => {
sp.timer.abort();
let mut node_map_insert = None;
let now = Instant::now();
let latency = now - sp.at;
debug!(
tx = %hex::encode(m.tx_id),
src = %src,
reported_ping_src = %m.ping_observed_addr,
ping_dst = %sp.to,
is_relay = %src.is_relay(),
latency = %latency.as_millis(),
"received pong",
);
match src {
SendAddr::Udp(addr) => {
match self.udp_paths.paths.get_mut(&addr.into()) {
None => {
warn!("ignoring pong: no state for src addr");
// This is no longer an endpoint we care about.
return node_map_insert;
}
Some(st) => {
node_map_insert = Some((addr, self.node_id));
st.add_pong_reply(PongReply {
latency,
pong_at: now,
from: src,
pong_src: m.ping_observed_addr.clone(),
});
}
}
debug!(
paths = %summarize_node_paths(&self.udp_paths.paths),
"handled pong",
);
}
SendAddr::Relay(ref url) => match self.relay_url.as_mut() {
Some((home_url, state)) if home_url == url => {
state.add_pong_reply(PongReply {
latency,
pong_at: now,
from: src,
pong_src: m.ping_observed_addr.clone(),
});
}
other => {
// if we are here then we sent this ping, but the url changed
// waiting for the response. It was either set to None or changed to
// another relay. This should either never happen or be extremely
// unlikely. Log and ignore for now
warn!(
stored=?other,
received=?url,
"ignoring pong via relay for different relay from last one",
);
}
},
}
// Promote this pong response to our current best address if it's lower latency.
// TODO(bradfitz): decide how latency vs. preference order affects decision
if let SendAddr::Udp(to) = sp.to {
debug_assert!(!is_relay, "mismatching relay & udp");
self.udp_paths.best_addr.insert_if_better_or_reconfirm(
to,
latency,
best_addr::Source::ReceivedPong,
now,
);
}
node_map_insert
}
}
}
/// Handles a DISCO CallMeMaybe discovery message.
///
/// The contract for use of this message is that the node has already pinged to us via
/// UDP, so their stateful firewall should be open. Now we can Ping back and make it
/// through.
///
/// However if the remote side has no direct path information to us, they would not have
/// had any [`IpPort`]s to send pings to and our pings might end up blocked. But at
/// least open the firewalls on our side, giving the other side another change of making
/// it through when it pings in response.
pub(super) fn handle_call_me_maybe(&mut self, m: disco::CallMeMaybe) -> Vec<PingAction> {
let now = Instant::now();
let mut call_me_maybe_ipps = BTreeSet::new();
for peer_sockaddr in &m.my_numbers {
if let IpAddr::V6(ip) = peer_sockaddr.ip() {
if is_unicast_link_local(ip) {
// We send these out, but ignore them for now.
// TODO: teach the ping code to ping on all interfaces for these.
continue;
}
}
let ipp = IpPort::from(*peer_sockaddr);
call_me_maybe_ipps.insert(ipp);
self.udp_paths
.paths
.entry(ipp)
.or_insert_with(|| {
PathState::new(
self.node_id,
SendAddr::from(*peer_sockaddr),
Source::Relay,
now,
)
})
.call_me_maybe_time
.replace(now);
}
// Zero out all the last_ping times to force send_pings to send new ones, even if
// it's been less than 5 seconds ago. Also clear pongs for direct addresses not
// included in the updated set.
for (ipp, st) in self.udp_paths.paths.iter_mut() {
st.last_ping = None;
if !call_me_maybe_ipps.contains(ipp) {
// TODO: This seems like a weird way to signal that the endpoint no longer
// thinks it has this IpPort as an available path.
if st.recent_pong.is_some() {
debug!(path=?ipp ,"clearing recent pong");
st.recent_pong = None;
}
}
}
// Clear trust on our best_addr if it is not included in the updated set. Also
// clear the last call-me-maybe send time so we will send one again.
if let Some(addr) = self.udp_paths.best_addr.addr() {
let ipp: IpPort = addr.into();
if !call_me_maybe_ipps.contains(&ipp) {
self.udp_paths
.best_addr
.clear_trust("best_addr not in new call-me-maybe");
self.last_call_me_maybe = None;
}
}
debug!(
paths = %summarize_node_paths(&self.udp_paths.paths),
"updated endpoint paths from call-me-maybe",
);
self.send_pings(now)
}
/// Marks this node as having received a UDP payload message.
pub(super) fn receive_udp(&mut self, addr: IpPort, now: Instant) {
let Some(state) = self.udp_paths.paths.get_mut(&addr) else {
debug_assert!(false, "node map inconsistency by_ip_port <-> direct addr");
return;
};
state.last_payload_msg = Some(now);
self.last_used = Some(now);
self.udp_paths
.best_addr
.reconfirm_if_used(addr.into(), BestAddrSource::Udp, now);
}
pub(super) fn receive_relay(&mut self, url: &RelayUrl, src: NodeId, now: Instant) {
match self.relay_url.as_mut() {
Some((current_home, state)) if current_home == url => {
// We received on the expected url. update state.
state.last_payload_msg = Some(now);
}
Some((_current_home, _state)) => {
// we have a different url. we only update on ping, not on receive_relay.
}
None => {
self.relay_url = Some((
url.clone(),
PathState::with_last_payload(
src,
SendAddr::from(url.clone()),
Source::Relay,
now,
),
));
}
}
self.last_used = Some(now);
}
pub(super) fn last_ping(&self, addr: &SendAddr) -> Option<Instant> {
match addr {
SendAddr::Udp(addr) => self
.udp_paths
.paths
.get(&(*addr).into())
.and_then(|ep| ep.last_ping),
SendAddr::Relay(url) => self
.relay_url
.as_ref()
.filter(|(home_url, _state)| home_url == url)
.and_then(|(_home_url, state)| state.last_ping),
}
}
/// Checks if this `Endpoint` is currently actively being used.
pub(super) fn is_active(&self, now: &Instant) -> bool {
match self.last_used {
Some(last_active) => now.duration_since(last_active) <= SESSION_ACTIVE_TIMEOUT,
None => false,
}
}
/// Send a heartbeat to the node to keep the connection alive, or trigger a full ping
/// if necessary.
#[instrument("stayin_alive", skip_all, fields(node = %self.node_id.fmt_short()))]
pub(super) fn stayin_alive(&mut self) -> Vec<PingAction> {
trace!("stayin_alive");
let now = Instant::now();
if !self.is_active(&now) {
trace!("skipping stayin alive: session is inactive");
return Vec::new();
}
// If we do not have an optimal addr, send pings to all known places.
if self.want_call_me_maybe(&now) {
debug!("sending a call-me-maybe");
return self.send_call_me_maybe(now, SendCallMeMaybe::Always);
}
// Send heartbeat ping to keep the current addr going as long as we need it.
if let Some(udp_addr) = self.udp_paths.best_addr.addr() {
let elapsed = self.last_ping(&SendAddr::Udp(udp_addr)).map(|l| now - l);
// Send a ping if the last ping is older than 2 seconds.
let needs_ping = match elapsed {
Some(e) => e >= STAYIN_ALIVE_MIN_ELAPSED,
None => false,
};
if needs_ping {
debug!(
dst = %udp_addr,
since_last_ping=?elapsed,
"send stayin alive ping",
);
if let Some(msg) =
self.start_ping(SendAddr::Udp(udp_addr), DiscoPingPurpose::StayinAlive)
{
return vec![PingAction::SendPing(msg)];
}
}
}
Vec::new()
}
/// Returns the addresses on which a payload should be sent right now.
///
/// This is in the hot path of `.poll_send()`.
#[instrument("get_send_addrs", skip_all, fields(node = %self.node_id.fmt_short()))]
pub(crate) fn get_send_addrs(
&mut self,
have_ipv6: bool,
) -> (Option<SocketAddr>, Option<RelayUrl>, Vec<PingAction>) {
let now = Instant::now();
let prev = self.last_used.replace(now);
if prev.is_none() {
// this is the first time we are trying to connect to this node
inc!(MagicsockMetrics, nodes_contacted);
}
let (udp_addr, relay_url) = self.addr_for_send(&now, have_ipv6);
let mut ping_msgs = Vec::new();
if self.want_call_me_maybe(&now) {
ping_msgs = self.send_call_me_maybe(now, SendCallMeMaybe::IfNoRecent);
}
trace!(
?udp_addr,
?relay_url,
pings = %ping_msgs.len(),
"found send address",
);
(udp_addr, relay_url, ping_msgs)
}
/// Get the direct addresses for this endpoint.
pub(super) fn direct_addresses(&self) -> impl Iterator<Item = IpPort> + '_ {
self.udp_paths.paths.keys().copied()
}
#[cfg(test)]
pub(super) fn direct_address_states(&self) -> impl Iterator<Item = (&IpPort, &PathState)> + '_ {
self.udp_paths.paths.iter()
}
pub(super) fn last_used(&self) -> Option<Instant> {
self.last_used
}
}
impl From<RemoteInfo> for NodeAddr {
fn from(info: RemoteInfo) -> Self {
let direct_addresses = info
.addrs
.into_iter()
.map(|info| info.addr)
.collect::<BTreeSet<_>>();
NodeAddr {
node_id: info.node_id,
info: AddrInfo {
relay_url: info.relay_url.map(Into::into),
direct_addresses,
},
}
}
}
/// Whether to send a call-me-maybe message after sending pings to all known paths.
///
/// `IfNoRecent` will only send a call-me-maybe if no previous one was sent in the last
/// [`HEARTBEAT_INTERVAL`].
#[derive(Debug)]
enum SendCallMeMaybe {
Always,
IfNoRecent,
}
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub(super) struct PongReply {
pub(super) latency: Duration,
/// When we received the pong.
pub(super) pong_at: Instant,
/// The pong's src (usually same as endpoint map key).
pub(super) from: SendAddr,
/// What they reported they heard.
pub(super) pong_src: SendAddr,
}
#[derive(Debug)]
pub(super) struct SentPing {
pub(super) to: SendAddr,
pub(super) at: Instant,
#[allow(dead_code)]
pub(super) purpose: DiscoPingPurpose,
pub(super) timer: Timer,
}
/// The reason why a discovery ping message was sent.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DiscoPingPurpose {
/// The purpose of a ping was to see if a path was valid.
Discovery,
/// Ping to ensure the current route is still valid.
StayinAlive,
/// When a ping was received and no direct connection exists yet.
///
/// When a ping was received we suspect a direct connection is possible. If we do not
/// yet have one that triggers a ping, indicated with this reason.
PingBack,
}
/// The type of control message we have received.
#[derive(Debug, Clone, Copy, Eq, PartialEq, Serialize, Deserialize, derive_more::Display)]
pub enum ControlMsg {
/// We received a Ping from the node.
#[display("ping←")]
Ping,
/// We received a Pong from the node.
#[display("pong←")]
Pong,
/// We received a CallMeMaybe.
#[display("call me")]
CallMeMaybe,
}
/// Information about a *direct address*.
///
/// The *direct addresses* of an iroh-net node are those that could be used by other nodes to
/// establish direct connectivity, depending on the network situation. Due to NAT configurations,
/// for example, not all direct addresses of a node are usable by all peers.
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
pub struct DirectAddrInfo {
/// The UDP address reported by the remote node.
pub addr: SocketAddr,
/// The latency to the remote node over this network path.
///
/// If there has never been any connectivity via this address no latency will be known.
pub latency: Option<Duration>,
/// Last control message received by this node about this address.
///
/// This contains the elapsed duration since the control message was received and the
/// kind of control message received at that time. Only the most recent control message
/// is returned.
///
/// Note that [`ControlMsg::CallMeMaybe`] is received via a relay path, while
/// [`ControlMsg::Ping`] and [`ControlMsg::Pong`] are received on the path to
/// [`DirectAddrInfo::addr`] itself and thus convey very different information.
pub last_control: Option<(Duration, ControlMsg)>,
/// Elapsed time since the last payload message was received on this network path.
///
/// This indicates how long ago a QUIC datagram was received from the remote node sent
/// from this [`DirectAddrInfo::addr`]. It indicates the network path was in use to
/// transport payload data.
pub last_payload: Option<Duration>,
/// Elapsed time since this network path was known to exist.
///
/// A network path is considered to exist only because the remote node advertised it.
/// It may not mean the path is usable. However, if there was any communication with
/// the remote node over this network path it also means the path exists.
///
/// The elapsed time since *any* confirmation of the path's existence was received is
/// returned. If the remote node moved networks and no longer has this path, this could
/// be a long duration. If the path was added via [`Endpoint::add_node_addr`] or some
/// node discovery the path may never have been known to exist.
///
/// [`Endpoint::add_node_addr`]: crate::endpoint::Endpoint::add_node_addr
pub last_alive: Option<Duration>,
/// A [`HashMap`] of [`Source`]s to [`Duration`]s.
///
/// The [`Duration`] indicates the elapsed time since this source last
/// recorded this address.
///
/// The [`Duration`] will always indicate the most recent time the source
/// recorded this address.
pub sources: HashMap<Source, Duration>,
}
/// Information about the network path to a remote node via a relay server.
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
pub struct RelayUrlInfo {
/// The relay URL.
pub relay_url: RelayUrl,
/// Elapsed time since this relay path last received payload or control data.
pub last_alive: Option<Duration>,
/// Latency to the remote node over this relayed network path.
pub latency: Option<Duration>,
}
impl From<(RelayUrl, PathState)> for RelayUrlInfo {
fn from(value: (RelayUrl, PathState)) -> Self {
RelayUrlInfo {
relay_url: value.0,
last_alive: value.1.last_alive().map(|i| i.elapsed()),
latency: value.1.latency(),
}
}
}
impl From<RelayUrlInfo> for RelayUrl {
fn from(value: RelayUrlInfo) -> Self {
value.relay_url
}
}
/// Details about a remote iroh-net node which is known to this node.
///
/// Having details of a node does not mean it can be connected to, nor that it has ever been
/// connected to in the past. There are various reasons a node might be known: it could have
/// been manually added via [`Endpoint::add_node_addr`], it could have been added by some
/// discovery mechanism, the node could have contacted this node, etc.
///
/// [`Endpoint::add_node_addr`]: crate::endpoint::Endpoint::add_node_addr
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
pub struct RemoteInfo {
/// The globally unique identifier for this node.
pub node_id: NodeId,
/// Relay server information, if available.
pub relay_url: Option<RelayUrlInfo>,
/// The addresses at which this node might be reachable.
///
/// Some of these addresses might only be valid for networks we are not part of, but the remote
/// node might be a part of.
pub addrs: Vec<DirectAddrInfo>,
/// The type of connection we have to the node, either direct or over relay.
pub conn_type: ConnectionType,
/// The latency of the current network path to the remote node.
pub latency: Option<Duration>,
/// Time elapsed time since last we have sent to or received from the node.
///
/// This is the duration since *any* data (payload or control messages) was sent or receive
/// from the remote node. Note that sending to the remote node does not imply
/// the remote node received anything.
pub last_used: Option<Duration>,
}
impl RemoteInfo {
/// Get the duration since the last activity we received from this endpoint
/// on any of its direct addresses.
pub fn last_received(&self) -> Option<Duration> {
self.addrs
.iter()
.filter_map(|addr| addr.last_control.map(|x| x.0).min(addr.last_payload))
.min()
}
/// Whether there is a possible known network path to the remote node.
///
/// Note that this does not provide any guarantees of whether any network path is
/// usable.
pub fn has_send_address(&self) -> bool {
self.relay_url.is_some() || !self.addrs.is_empty()
}
/// Returns a deduplicated list of [`Source`]s merged from all address in the [`RemoteInfo`].
///
/// Deduplication is on the (`Source`, `Duration`) tuple, so you will get multiple [`Source`]s
/// for each `Source` variant, if different addresses were discovered from the same [`Source`]
/// at different times.
///
/// The list is sorted from least to most recent [`Source`].
pub fn sources(&self) -> Vec<(Source, Duration)> {
let mut sources = vec![];
for addr in &self.addrs {
for source in &addr.sources {
let source = (source.0.clone(), *source.1);
if !sources.contains(&source) {
sources.push(source)
}
}
}
sources.sort_by(|a, b| b.1.cmp(&a.1));
sources
}
}
/// The type of connection we have to the endpoint.
#[derive(derive_more::Display, Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
pub enum ConnectionType {
/// Direct UDP connection
#[display("direct({_0})")]
Direct(SocketAddr),
/// Relay connection over relay
#[display("relay({_0})")]
Relay(RelayUrl),
/// Both a UDP and a relay connection are used.
///
/// This is the case if we do have a UDP address, but are missing a recent confirmation that
/// the address works.
#[display("mixed(udp: {_0}, relay: {_1})")]
Mixed(SocketAddr, RelayUrl),
/// We have no verified connection to this PublicKey
#[display("none")]
None,
}
#[cfg(test)]
mod tests {
use std::{collections::BTreeMap, net::Ipv4Addr};
use best_addr::BestAddr;
use super::*;
use crate::{
key::SecretKey,
magicsock::node_map::{NodeMap, NodeMapInner},
};
#[test]
fn test_remote_infos() {
let now = Instant::now();
let elapsed = Duration::from_secs(3);
let later = now + elapsed;
let send_addr: RelayUrl = "https://my-relay.com".parse().unwrap();
let pong_src = SendAddr::Udp("0.0.0.0:1".parse().unwrap());
let latency = Duration::from_millis(50);
let relay_and_state = |node_id: NodeId, url: RelayUrl| {
let relay_state = PathState::with_pong_reply(
node_id,
PongReply {
latency,
pong_at: now,
from: SendAddr::Relay(send_addr.clone()),
pong_src: pong_src.clone(),
},
);
Some((url, relay_state))
};
// endpoint with a `best_addr` that has a latency but no relay
let (a_endpoint, a_socket_addr) = {
let key = SecretKey::generate();
let node_id = key.public();
let ip_port = IpPort {
ip: Ipv4Addr::UNSPECIFIED.into(),
port: 10,
};
let endpoint_state = BTreeMap::from([(
ip_port,
PathState::with_pong_reply(
node_id,
PongReply {
latency,
pong_at: now,
from: SendAddr::Udp(ip_port.into()),
pong_src: pong_src.clone(),
},
),
)]);
(
NodeState {
id: 0,
quic_mapped_addr: QuicMappedAddr::generate(),
node_id: key.public(),
last_full_ping: None,
relay_url: None,
udp_paths: NodeUdpPaths::from_parts(
endpoint_state,
BestAddr::from_parts(
ip_port.into(),
latency,
now,
now + Duration::from_secs(100),
),
),
sent_pings: HashMap::new(),
last_used: Some(now),
last_call_me_maybe: None,
conn_type: Watchable::new(ConnectionType::Direct(ip_port.into())),
has_been_direct: true,
},
ip_port.into(),
)
};
// endpoint w/ no best addr but a relay w/ latency
let b_endpoint = {
// let socket_addr = "0.0.0.0:9".parse().unwrap();
let key = SecretKey::generate();
NodeState {
id: 1,
quic_mapped_addr: QuicMappedAddr::generate(),
node_id: key.public(),
last_full_ping: None,
relay_url: relay_and_state(key.public(), send_addr.clone()),
udp_paths: NodeUdpPaths::new(),
sent_pings: HashMap::new(),
last_used: Some(now),
last_call_me_maybe: None,
conn_type: Watchable::new(ConnectionType::Relay(send_addr.clone())),
has_been_direct: false,
}
};
// endpoint w/ no best addr but a relay w/ no latency
let c_endpoint = {
// let socket_addr = "0.0.0.0:8".parse().unwrap();
let key = SecretKey::generate();
NodeState {
id: 2,
quic_mapped_addr: QuicMappedAddr::generate(),
node_id: key.public(),
last_full_ping: None,
relay_url: Some((
send_addr.clone(),
PathState::new(
key.public(),
SendAddr::from(send_addr.clone()),
Source::App,
now,
),
)),
udp_paths: NodeUdpPaths::new(),
sent_pings: HashMap::new(),
last_used: Some(now),
last_call_me_maybe: None,
conn_type: Watchable::new(ConnectionType::Relay(send_addr.clone())),
has_been_direct: false,
}
};
// endpoint w/ expired best addr and relay w/ latency
let (d_endpoint, d_socket_addr) = {
let socket_addr: SocketAddr = "0.0.0.0:7".parse().unwrap();
let expired = now.checked_sub(Duration::from_secs(100)).unwrap();
let key = SecretKey::generate();
let node_id = key.public();
let endpoint_state = BTreeMap::from([(
IpPort::from(socket_addr),
PathState::with_pong_reply(
node_id,
PongReply {
latency,
pong_at: now,
from: SendAddr::Udp(socket_addr),
pong_src: pong_src.clone(),
},
),
)]);
(
NodeState {
id: 3,
quic_mapped_addr: QuicMappedAddr::generate(),
node_id: key.public(),
last_full_ping: None,
relay_url: relay_and_state(key.public(), send_addr.clone()),
udp_paths: NodeUdpPaths::from_parts(
endpoint_state,
BestAddr::from_parts(socket_addr, Duration::from_millis(80), now, expired),
),
sent_pings: HashMap::new(),
last_used: Some(now),
last_call_me_maybe: None,
conn_type: Watchable::new(ConnectionType::Mixed(
socket_addr,
send_addr.clone(),
)),
has_been_direct: false,
},
socket_addr,
)
};
let mut expect = Vec::from([
RemoteInfo {
node_id: a_endpoint.node_id,
relay_url: None,
addrs: Vec::from([DirectAddrInfo {
addr: a_socket_addr,
latency: Some(latency),
last_control: Some((elapsed, ControlMsg::Pong)),
last_payload: None,
last_alive: Some(elapsed),
sources: HashMap::new(),
}]),
conn_type: ConnectionType::Direct(a_socket_addr),
latency: Some(latency),
last_used: Some(elapsed),
},
RemoteInfo {
node_id: b_endpoint.node_id,
relay_url: Some(RelayUrlInfo {
relay_url: b_endpoint.relay_url.as_ref().unwrap().0.clone(),
last_alive: None,
latency: Some(latency),
}),
addrs: Vec::new(),
conn_type: ConnectionType::Relay(send_addr.clone()),
latency: Some(latency),
last_used: Some(elapsed),
},
RemoteInfo {
node_id: c_endpoint.node_id,
relay_url: Some(RelayUrlInfo {
relay_url: c_endpoint.relay_url.as_ref().unwrap().0.clone(),
last_alive: None,
latency: None,
}),
addrs: Vec::new(),
conn_type: ConnectionType::Relay(send_addr.clone()),
latency: None,
last_used: Some(elapsed),
},
RemoteInfo {
node_id: d_endpoint.node_id,
relay_url: Some(RelayUrlInfo {
relay_url: d_endpoint.relay_url.as_ref().unwrap().0.clone(),
last_alive: None,
latency: Some(latency),
}),
addrs: Vec::from([DirectAddrInfo {
addr: d_socket_addr,
latency: Some(latency),
last_control: Some((elapsed, ControlMsg::Pong)),
last_payload: None,
last_alive: Some(elapsed),
sources: HashMap::new(),
}]),
conn_type: ConnectionType::Mixed(d_socket_addr, send_addr.clone()),
latency: Some(Duration::from_millis(50)),
last_used: Some(elapsed),
},
]);
let node_map = NodeMap::from_inner(NodeMapInner {
by_node_key: HashMap::from([
(a_endpoint.node_id, a_endpoint.id),
(b_endpoint.node_id, b_endpoint.id),
(c_endpoint.node_id, c_endpoint.id),
(d_endpoint.node_id, d_endpoint.id),
]),
by_ip_port: HashMap::from([
(a_socket_addr.into(), a_endpoint.id),
(d_socket_addr.into(), d_endpoint.id),
]),
by_quic_mapped_addr: HashMap::from([
(a_endpoint.quic_mapped_addr, a_endpoint.id),
(b_endpoint.quic_mapped_addr, b_endpoint.id),
(c_endpoint.quic_mapped_addr, c_endpoint.id),
(d_endpoint.quic_mapped_addr, d_endpoint.id),
]),
by_id: HashMap::from([
(a_endpoint.id, a_endpoint),
(b_endpoint.id, b_endpoint),
(c_endpoint.id, c_endpoint),
(d_endpoint.id, d_endpoint),
]),
next_id: 5,
});
let mut got = node_map.list_remote_infos(later);
got.sort_by_key(|p| p.node_id);
expect.sort_by_key(|p| p.node_id);
remove_non_deterministic_fields(&mut got);
assert_eq!(expect, got);
}
fn remove_non_deterministic_fields(infos: &mut [RemoteInfo]) {
for info in infos.iter_mut() {
if info.relay_url.is_some() {
info.relay_url.as_mut().unwrap().last_alive = None;
}
}
}
#[test]
fn test_prune_direct_addresses() {
// When we handle a call-me-maybe with more than MAX_INACTIVE_DIRECT_ADDRESSES we do
// not want to prune them right away but send pings to all of them.
let key = SecretKey::generate();
let opts = Options {
node_id: key.public(),
relay_url: None,
active: true,
source: crate::magicsock::Source::NamedApp {
name: "test".into(),
},
};
let mut ep = NodeState::new(0, opts);
let my_numbers_count: u16 = (MAX_INACTIVE_DIRECT_ADDRESSES + 5).try_into().unwrap();
let my_numbers = (0u16..my_numbers_count)
.map(|i| SocketAddr::new(Ipv4Addr::LOCALHOST.into(), 1000 + i))
.collect();
let call_me_maybe = disco::CallMeMaybe { my_numbers };
let ping_messages = ep.handle_call_me_maybe(call_me_maybe);
// We have no relay server and no previous direct addresses, so we should get the same
// number of pings as direct addresses in the call-me-maybe.
assert_eq!(ping_messages.len(), my_numbers_count as usize);
}
}