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
//! SWIM protocol implementation for cluster membership
//!
//! SWIM (Scalable Weakly-consistent Infection-style Process Group Membership Protocol)
//! provides:
//! - O(1) message complexity per node per protocol period
//! - Failure detection in O(log N) time
//! - No single point of failure (no leader required for membership)
//!
//! Reference: <https://www.cs.cornell.edu/projects/Quicksilver/public_pdfs/SWIM.pdf>
use crate::config::SwimConfig;
use crate::error::{ClusterError, Result};
use crate::node::{Node, NodeGossipState, NodeId, NodeInfo, NodeState};
use dashmap::DashMap;
use serde::{Deserialize, Serialize};
use std::net::SocketAddr;
use std::sync::Arc;
use std::time::{Duration, Instant};
use tokio::net::UdpSocket;
use tokio::sync::{broadcast, RwLock};
use tracing::{debug, error, info, trace, warn};
use zeroize::Zeroizing;
#[cfg(feature = "swim")]
use hmac::{Hmac, Mac};
#[cfg(feature = "swim")]
use sha2::Sha256;
/// HMAC tag length in bytes (SHA-256 → 32 bytes)
const HMAC_TAG_LEN: usize = 32;
/// Maximum gossip items piggybacked per message
const MAX_GOSSIP_PER_MSG: usize = 8;
/// A gossip item queued for dissemination via piggyback
#[derive(Debug, Clone, Serialize, Deserialize)]
struct GossipItem {
/// The state-change message to disseminate
message: SwimMessage,
/// Number of times this item has been piggybacked
#[serde(skip)]
transmissions: u32,
}
/// SWIM message types
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum SwimMessage {
/// Direct ping to check liveness
Ping { source: NodeId, incarnation: u64 },
/// Response to ping
Ack { source: NodeId, incarnation: u64 },
/// Request indirect ping through another node
PingReq {
source: NodeId,
target: NodeId,
incarnation: u64,
},
/// State sync request
Sync {
source: NodeId,
states: Vec<NodeGossipState>,
},
/// Node joining announcement
Join { info: NodeInfo },
/// Node leaving announcement
Leave { node_id: NodeId, incarnation: u64 },
/// Suspect a node
Suspect {
node_id: NodeId,
incarnation: u64,
from: NodeId,
},
/// Refute a suspicion
Alive { node_id: NodeId, incarnation: u64 },
/// Confirm a node is dead
Dead { node_id: NodeId, incarnation: u64 },
}
/// Membership change event
#[derive(Debug, Clone)]
pub enum MembershipEvent {
/// A new node joined the cluster
NodeJoined(NodeInfo),
/// A node left the cluster gracefully
NodeLeft(NodeId),
/// A node failed (detected as dead)
NodeFailed(NodeId),
/// A node is suspected to be failing
NodeSuspected(NodeId),
/// A suspected node recovered
NodeRecovered(NodeId),
/// A node's state changed
NodeStateChanged {
node_id: NodeId,
old: NodeState,
new: NodeState,
},
}
/// Cluster membership manager using SWIM protocol
pub struct Membership {
/// Our node info
local_node: NodeInfo,
/// Our incarnation number (increases when we refute suspicion)
incarnation: Arc<RwLock<u64>>,
/// All known cluster members
members: Arc<DashMap<NodeId, Node>>,
/// SWIM configuration
config: SwimConfig,
/// UDP socket for gossip
socket: Arc<UdpSocket>,
/// Pending pings awaiting ack
pending_pings: Arc<DashMap<NodeId, Instant>>,
/// Pending indirect ping requests: key = (requester, target), value = (requester_addr, timestamp)
pending_ping_reqs: Arc<DashMap<(NodeId, NodeId), (SocketAddr, Instant)>>,
/// Event broadcaster
event_tx: broadcast::Sender<MembershipEvent>,
/// Shutdown signal receiver (held for lifecycle management)
#[allow(dead_code)]
shutdown: broadcast::Receiver<()>,
/// Pre-validated HMAC key for message authentication (None = no auth)
/// Wrapped in Zeroizing to scrub key material from memory on drop.
hmac_key: Option<Zeroizing<String>>,
/// Gossip dissemination queue — items piggyback on Ping/Ack messages
gossip_queue: Arc<tokio::sync::Mutex<Vec<GossipItem>>>,
}
impl Membership {
/// Create new membership manager
pub async fn new(
local_node: NodeInfo,
config: SwimConfig,
shutdown: broadcast::Receiver<()>,
) -> Result<Self> {
let socket = UdpSocket::bind(local_node.cluster_addr)
.await
.map_err(|e| ClusterError::Network(e.to_string()))?;
let (event_tx, _) = broadcast::channel(1000);
let members = Arc::new(DashMap::new());
// Add ourselves
let mut self_node = Node::new(local_node.clone());
self_node.mark_alive(0);
members.insert(local_node.id.clone(), self_node);
// Pre-compute HMAC key if auth is configured
#[cfg(feature = "swim")]
let hmac_key = config
.auth_token
.as_ref()
.map(|token| {
Hmac::<Sha256>::new_from_slice(token.as_bytes())
.expect("HMAC can accept key of any length")
})
.map(|_| Zeroizing::new(config.auth_token.clone().unwrap()));
#[cfg(not(feature = "swim"))]
let hmac_key: Option<Zeroizing<String>> = {
if config.auth_token.is_some() {
tracing::warn!(
"auth_token is configured but the 'swim' feature is disabled — \
HMAC message authentication is inactive. Enable the 'swim' feature \
or remove auth_token to suppress this warning."
);
}
None
};
Ok(Self {
local_node,
incarnation: Arc::new(RwLock::new(0)),
members: members.clone(),
config,
socket: Arc::new(socket),
pending_pings: Arc::new(DashMap::new()),
pending_ping_reqs: Arc::new(DashMap::new()),
event_tx,
shutdown,
hmac_key,
gossip_queue: Arc::new(tokio::sync::Mutex::new(Vec::new())),
})
}
/// Send a SWIM message to a target address with optional HMAC authentication
async fn send_message(&self, msg: &SwimMessage, addr: SocketAddr) -> Result<()> {
let data = postcard::to_allocvec(msg)?;
let packet = self.sign_message(&data);
self.socket.send_to(&packet, addr).await?;
Ok(())
}
/// Sign a serialized message by prepending an 8-byte timestamp (millis
/// since epoch) and appending an HMAC-SHA256 tag over (timestamp ‖ data).
///
/// Wire format: `[timestamp:8][payload:N][hmac_tag:32]`
///
/// The timestamp is included in the HMAC input to prevent replay attacks
/// (CLUSTER-H1 fix). The receiver rejects messages whose timestamp
/// falls outside a configurable window (default ±60 s).
fn sign_message(&self, data: &[u8]) -> Vec<u8> {
#[cfg(feature = "swim")]
if let Some(ref key) = self.hmac_key {
let ts_millis = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.unwrap_or_default()
.as_millis() as u64;
let ts_bytes = ts_millis.to_be_bytes();
let mut mac =
Hmac::<Sha256>::new_from_slice(key.as_bytes()).expect("HMAC key always valid");
mac.update(&ts_bytes);
mac.update(data);
let tag = mac.finalize().into_bytes();
let mut signed = Vec::with_capacity(8 + data.len() + HMAC_TAG_LEN);
signed.extend_from_slice(&ts_bytes);
signed.extend_from_slice(data);
signed.extend_from_slice(&tag);
return signed;
}
data.to_vec()
}
/// Verify and strip an HMAC-SHA256 tag and timestamp from received data.
///
/// Rejects messages whose embedded timestamp is more than 60 seconds
/// from the local clock to prevent replay attacks. Returns the payload
/// (timestamp and tag stripped) on success.
fn verify_message<'a>(&self, data: &'a [u8]) -> std::result::Result<&'a [u8], &'static str> {
#[cfg(feature = "swim")]
if let Some(ref key) = self.hmac_key {
// Minimum: 8 (timestamp) + 0 (payload) + 32 (HMAC tag)
if data.len() < 8 + HMAC_TAG_LEN {
return Err("message too short for timestamp + HMAC tag");
}
let (ts_bytes, rest) = data.split_at(8);
let (payload, tag) = rest.split_at(rest.len() - HMAC_TAG_LEN);
// Verify HMAC over (timestamp ‖ payload)
let mut mac =
Hmac::<Sha256>::new_from_slice(key.as_bytes()).expect("HMAC key always valid");
mac.update(ts_bytes);
mac.update(payload);
mac.verify_slice(tag)
.map_err(|_| "HMAC verification failed")?;
// Replay protection: reject messages outside ±60s window
let msg_millis =
u64::from_be_bytes(ts_bytes.try_into().map_err(|_| "invalid timestamp")?);
let now_millis = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.unwrap_or_default()
.as_millis() as u64;
let drift = now_millis.abs_diff(msg_millis);
if drift > 60_000 {
return Err("message timestamp outside acceptable window (replay protection)");
}
return Ok(payload);
}
Ok(data)
}
/// Subscribe to membership events
pub fn subscribe(&self) -> broadcast::Receiver<MembershipEvent> {
self.event_tx.subscribe()
}
/// Get all healthy members
pub fn healthy_members(&self) -> Vec<Node> {
self.members
.iter()
.filter(|r| r.value().is_healthy())
.map(|r| r.value().clone())
.collect()
}
/// Get a specific member
pub fn get_member(&self, node_id: &NodeId) -> Option<Node> {
self.members.get(node_id).map(|r| r.value().clone())
}
/// Get member count
pub fn member_count(&self) -> usize {
self.members.len()
}
/// Get healthy member count
pub fn healthy_count(&self) -> usize {
self.members
.iter()
.filter(|r| r.value().is_healthy())
.count()
}
/// Join cluster via seed nodes
pub async fn join(&self, seeds: &[String]) -> Result<()> {
if seeds.is_empty() {
return Err(ClusterError::NoSeedNodes);
}
let join_msg = SwimMessage::Join {
info: self.local_node.clone(),
};
let mut joined = false;
for seed in seeds {
let addr: SocketAddr = match seed.parse() {
Ok(a) => a,
Err(_) => {
warn!("Invalid seed address: {}", seed);
continue;
}
};
// Skip if this is ourselves
if addr == self.local_node.cluster_addr {
continue;
}
match self.send_message(&join_msg, addr).await {
Ok(()) => {
info!("Sent join request to seed {}", seed);
joined = true;
}
Err(e) => {
warn!("Failed to contact seed {}: {}", seed, e);
}
}
}
if !joined {
return Err(ClusterError::JoinFailed(
"Could not contact any seed nodes".into(),
));
}
Ok(())
}
/// Gracefully leave the cluster
pub async fn leave(&self) -> Result<()> {
let incarnation = *self.incarnation.read().await;
let leave_msg = SwimMessage::Leave {
node_id: self.local_node.id.clone(),
incarnation,
};
// Broadcast to all known members
self.broadcast(&leave_msg).await?;
info!("Sent leave announcements to cluster");
Ok(())
}
/// Start the SWIM protocol
///
/// The background loops (receiver, failure detector, sync) are
/// now gated on a shutdown signal. When the broadcast sender is dropped or
/// a shutdown message is sent, the `select!` below fires and all spawned
/// tasks are aborted, preventing leaked background loops.
pub async fn run(mut self) -> Result<()> {
// Extract the shutdown receiver before wrapping `self` in Arc, because
// broadcast::Receiver is not accessible through Arc without interior
// mutability. Replace with a dummy receiver so the struct stays valid.
let (_shutdown_placeholder_tx, shutdown_placeholder_rx) = broadcast::channel::<()>(1);
let mut shutdown_rx = std::mem::replace(&mut self.shutdown, shutdown_placeholder_rx);
let membership = Arc::new(self);
// Spawn receiver task
let recv_membership = membership.clone();
let mut recv_handle = tokio::spawn(async move { recv_membership.run_receiver().await });
// Spawn failure detector task
let detector_membership = membership.clone();
let mut detector_handle =
tokio::spawn(async move { detector_membership.run_failure_detector().await });
// Spawn sync task
let sync_membership = membership.clone();
let mut sync_handle = tokio::spawn(async move { sync_membership.run_sync().await });
// Wait for any task to complete or shutdown signal
tokio::select! {
r = &mut recv_handle => {
error!("Receiver task ended: {:?}", r);
}
r = &mut detector_handle => {
error!("Failure detector task ended: {:?}", r);
}
r = &mut sync_handle => {
error!("Sync task ended: {:?}", r);
}
_ = shutdown_rx.recv() => {
info!("SWIM protocol received shutdown signal");
}
}
// Abort all remaining tasks to prevent leaks
recv_handle.abort();
detector_handle.abort();
sync_handle.abort();
Ok(())
}
/// Receive and process SWIM messages
async fn run_receiver(&self) -> Result<()> {
let mut buf = vec![0u8; 65536];
// Maximum expected SWIM message size.
// SWIM messages (Ping, Ack, PingReq, Sync, etc.) are small—typically
// under 1 KB even with piggybacked gossip. Reject oversized payloads
// before deserialization to prevent memory exhaustion attacks.
const MAX_SWIM_PAYLOAD_SIZE: usize = 8192;
// Rate-limit inbound UDP processing to prevent a flood from
// exhausting CPU. 10,000 messages/sec is well above normal SWIM traffic
// but caps attack surface during a UDP flood.
const MAX_MSGS_PER_SEC: u32 = 10_000;
let mut msg_count: u32 = 0;
let mut window_start = tokio::time::Instant::now();
loop {
// Reset counter every second
if window_start.elapsed() >= std::time::Duration::from_secs(1) {
msg_count = 0;
window_start = tokio::time::Instant::now();
}
if msg_count >= MAX_MSGS_PER_SEC {
// Budget exhausted — sleep until next window
tokio::time::sleep_until(window_start + std::time::Duration::from_secs(1)).await;
continue;
}
let (len, from) = match self.socket.recv_from(&mut buf).await {
Ok(r) => r,
Err(e) => {
error!("Socket recv error: {}", e);
continue;
}
};
msg_count += 1;
// reject oversized payloads before any processing
if len > MAX_SWIM_PAYLOAD_SIZE {
warn!(
"Dropping oversized UDP payload ({} bytes, max {}) from {}",
len, MAX_SWIM_PAYLOAD_SIZE, from
);
continue;
}
// Verify HMAC if authentication is enabled
let payload = match self.verify_message(&buf[..len]) {
Ok(p) => p,
Err(reason) => {
warn!("Dropping unauthenticated message from {}: {}", from, reason);
continue;
}
};
let msg: SwimMessage = match postcard::from_bytes(payload) {
Ok(m) => m,
Err(e) => {
warn!("Failed to deserialize message from {}: {}", from, e);
continue;
}
};
trace!("Received {:?} from {}", msg, from);
if let Err(e) = self.handle_message(msg, from).await {
warn!("Error handling message from {}: {}", from, e);
}
}
}
/// Handle incoming SWIM message
async fn handle_message(&self, msg: SwimMessage, from: SocketAddr) -> Result<()> {
match msg {
SwimMessage::Ping {
source,
incarnation,
} => {
self.handle_ping(&source, incarnation, from).await?;
}
SwimMessage::Ack {
source,
incarnation,
} => {
self.handle_ack(&source, incarnation).await?;
}
SwimMessage::PingReq {
source,
target,
incarnation,
} => {
self.handle_ping_req(&source, &target, incarnation, from)
.await?;
}
SwimMessage::Sync { source, states } => {
self.handle_sync(&source, states).await?;
}
SwimMessage::Join { info } => {
self.handle_join(info).await?;
}
SwimMessage::Leave {
node_id,
incarnation,
} => {
self.handle_leave(&node_id, incarnation).await?;
}
SwimMessage::Suspect {
node_id,
incarnation,
from: suspect_from,
} => {
self.handle_suspect(&node_id, incarnation, &suspect_from)
.await?;
}
SwimMessage::Alive {
node_id,
incarnation,
} => {
self.handle_alive(&node_id, incarnation).await?;
}
SwimMessage::Dead {
node_id,
incarnation,
} => {
self.handle_dead(&node_id, incarnation).await?;
}
}
Ok(())
}
/// Handle ping message
async fn handle_ping(
&self,
source: &NodeId,
_incarnation: u64,
from: SocketAddr,
) -> Result<()> {
let our_incarnation = *self.incarnation.read().await;
let ack = SwimMessage::Ack {
source: self.local_node.id.clone(),
incarnation: our_incarnation,
};
// Send Ack with piggybacked gossip
self.send_with_gossip(&ack, from).await?;
// Update member last seen
if let Some(mut member) = self.members.get_mut(source) {
member.touch();
}
Ok(())
}
/// Handle ack message
async fn handle_ack(&self, source: &NodeId, incarnation: u64) -> Result<()> {
// Remove from pending pings
self.pending_pings.remove(source);
// Forward ack to any requester waiting for an indirect probe result
let mut to_remove = Vec::new();
for entry in self.pending_ping_reqs.iter() {
let (requester, target) = entry.key();
if target == source {
let (requester_addr, _) = entry.value();
let ack = SwimMessage::Ack {
source: source.clone(),
incarnation,
};
let _ = self.send_message(&ack, *requester_addr).await;
to_remove.push((requester.clone(), target.clone()));
}
}
for key in to_remove {
self.pending_ping_reqs.remove(&key);
}
// Update member state
if let Some(mut member) = self.members.get_mut(source) {
let old_state = member.state;
if member.mark_alive(incarnation) && old_state != NodeState::Alive {
let _ = self
.event_tx
.send(MembershipEvent::NodeRecovered(source.clone()));
}
}
Ok(())
}
/// Handle indirect ping request
///
/// When we receive PingReq{source=A, target=B}, we ping B on A's behalf.
/// We use *our own* source ID so the target sends the Ack back to us via UDP,
/// and we store A's address so we can forward the Ack.
async fn handle_ping_req(
&self,
source: &NodeId,
target: &NodeId,
_incarnation: u64,
from: SocketAddr,
) -> Result<()> {
// Try to ping the target on behalf of the requester
if let Some(target_node) = self.members.get(target) {
let our_incarnation = *self.incarnation.read().await;
let ping = SwimMessage::Ping {
source: self.local_node.id.clone(),
incarnation: our_incarnation,
};
self.send_message(&ping, target_node.cluster_addr()).await?;
// Track that we're doing an indirect ping so we can forward acks
self.pending_ping_reqs
.insert((source.clone(), target.clone()), (from, Instant::now()));
}
Ok(())
}
/// Handle state sync message
async fn handle_sync(&self, _source: &NodeId, states: Vec<NodeGossipState>) -> Result<()> {
for state in states {
self.merge_state(state).await?;
}
Ok(())
}
/// Handle join message
async fn handle_join(&self, info: NodeInfo) -> Result<()> {
let node_id = info.id.clone();
// Check if already known
if self.members.contains_key(&node_id) {
debug!("Node {} already known, updating info", node_id);
} else {
info!("Node {} joining cluster", node_id);
}
// Add/update member
let mut node = Node::new(info.clone());
node.mark_alive(0);
self.members.insert(node_id.clone(), node);
// Send current membership state back
let states: Vec<NodeGossipState> = self
.members
.iter()
.map(|r| NodeGossipState::from(r.value()))
.collect();
let sync = SwimMessage::Sync {
source: self.local_node.id.clone(),
states,
};
self.send_message(&sync, info.cluster_addr).await?;
// Broadcast join event
let _ = self.event_tx.send(MembershipEvent::NodeJoined(info));
Ok(())
}
/// Handle leave message
async fn handle_leave(&self, node_id: &NodeId, _incarnation: u64) -> Result<()> {
if let Some(mut member) = self.members.get_mut(node_id) {
member.mark_leaving();
}
info!("Node {} leaving cluster gracefully", node_id);
let _ = self
.event_tx
.send(MembershipEvent::NodeLeft(node_id.clone()));
// Remove after a delay to allow propagation.
// The task is bounded (5s) and benign if it runs after shutdown.
let members = self.members.clone();
let node_id = node_id.clone();
let _handle = tokio::spawn(async move {
tokio::time::sleep(Duration::from_secs(5)).await;
if members.remove(&node_id).is_some() {
tracing::debug!(node = %node_id, "Removed leaving node after propagation delay");
}
});
Ok(())
}
/// Handle suspect message
async fn handle_suspect(
&self,
node_id: &NodeId,
incarnation: u64,
_from: &NodeId,
) -> Result<()> {
// If it's about us, refute it
if node_id == &self.local_node.id {
let mut our_incarnation = self.incarnation.write().await;
if incarnation >= *our_incarnation {
*our_incarnation = incarnation + 1;
// Enqueue alive message to refute (piggybacked on next Ping/Ack)
let alive = SwimMessage::Alive {
node_id: self.local_node.id.clone(),
incarnation: *our_incarnation,
};
self.enqueue_gossip(alive).await;
}
return Ok(());
}
// Update member state if incarnation is newer
if let Some(mut member) = self.members.get_mut(node_id) {
if incarnation >= member.incarnation && member.mark_suspect() {
let _ = self
.event_tx
.send(MembershipEvent::NodeSuspected(node_id.clone()));
}
}
Ok(())
}
/// Handle alive message
async fn handle_alive(&self, node_id: &NodeId, incarnation: u64) -> Result<()> {
if let Some(mut member) = self.members.get_mut(node_id) {
if incarnation > member.incarnation {
let old_state = member.state;
if member.mark_alive(incarnation) && old_state == NodeState::Suspect {
let _ = self
.event_tx
.send(MembershipEvent::NodeRecovered(node_id.clone()));
}
}
}
Ok(())
}
/// Handle dead message
async fn handle_dead(&self, node_id: &NodeId, incarnation: u64) -> Result<()> {
// Can't kill ourselves
if node_id == &self.local_node.id {
return Ok(());
}
if let Some(mut member) = self.members.get_mut(node_id) {
if incarnation >= member.incarnation && member.mark_dead() {
let _ = self
.event_tx
.send(MembershipEvent::NodeFailed(node_id.clone()));
}
}
Ok(())
}
/// Merge state from another node
async fn merge_state(&self, state: NodeGossipState) -> Result<()> {
if let Some(mut member) = self.members.get_mut(&state.id) {
// Only update if incarnation is newer
if state.incarnation > member.incarnation {
match state.state {
NodeState::Alive => {
member.mark_alive(state.incarnation);
}
NodeState::Suspect => {
member.mark_suspect();
}
NodeState::Dead => {
member.mark_dead();
}
NodeState::Leaving => {
member.mark_leaving();
}
_ => {}
}
}
} else if state.state != NodeState::Dead {
// Add new member
let info = NodeInfo {
id: state.id.clone(),
name: None,
rack: state.rack,
client_addr: state.client_addr,
cluster_addr: state.cluster_addr,
capabilities: state.capabilities,
version: env!("CARGO_PKG_VERSION").to_string(),
tags: std::collections::HashMap::new(),
};
let mut node = Node::new(info.clone());
match state.state {
NodeState::Alive => {
node.mark_alive(state.incarnation);
}
NodeState::Suspect => {
node.mark_suspect();
}
_ => {}
}
self.members.insert(state.id.clone(), node);
let _ = self.event_tx.send(MembershipEvent::NodeJoined(info));
}
Ok(())
}
/// Run the SWIM failure detector loop
///
/// **Detection latency**: O(N × ping_interval) in the worst case, since
/// a single random target is probed per interval. This matches the basic
/// SWIM paper design (Section 3.1). Indirect probes (§4) are used when
/// the direct ping times out, delegating to K random healthy members,
/// which improves accuracy but does not reduce worst-case detection time.
///
/// For faster detection in large clusters, consider increasing the
/// number of concurrent probes per interval or using SWIM+Inf’s
/// suspicion sub-protocol with adaptive timeouts.
async fn run_failure_detector(&self) -> Result<()> {
let mut interval = tokio::time::interval(self.config.ping_interval);
loop {
interval.tick().await;
// Select up to K targets to probe concurrently
let targets = self.select_probe_targets(self.config.probes_per_round);
if !targets.is_empty() {
let incarnation = *self.incarnation.read().await;
let mut join_set = tokio::task::JoinSet::new();
for target_node in targets {
let target_id = target_node.id().to_string();
let target_addr = target_node.cluster_addr();
let source_id = self.local_node.id.clone();
let pending_pings = Arc::clone(&self.pending_pings);
let members = Arc::clone(&self.members);
let socket = Arc::clone(&self.socket);
let gossip_queue = Arc::clone(&self.gossip_queue);
let hmac_key = self.hmac_key.clone();
let event_tx = self.event_tx.clone();
let ping_timeout = self.config.ping_timeout;
let indirect_probes_k = self.config.indirect_probes;
let incarnation_lock = Arc::clone(&self.incarnation);
join_set.spawn(async move {
// Send direct ping with piggybacked gossip
let ping = SwimMessage::Ping {
source: source_id.clone(),
incarnation,
};
if let Err(e) = Self::send_with_gossip_static(
&ping,
target_addr,
&socket,
&gossip_queue,
&members,
&hmac_key,
)
.await
{
warn!(target = %target_id, error = %e, "failed to send ping");
return;
}
// Track pending ping
pending_pings.insert(target_id.clone(), Instant::now());
// Wait for ack or timeout
tokio::time::sleep(ping_timeout).await;
// Check if we got an ack
if pending_pings.contains_key(&target_id) {
// No ack, try indirect probes
let _ = Self::send_indirect_probes_static(
&target_id,
&source_id,
&members,
&socket,
&hmac_key,
&incarnation_lock,
indirect_probes_k,
)
.await;
// Wait again
tokio::time::sleep(ping_timeout * 2).await;
// Still no ack? Mark as suspect
if pending_pings.remove(&target_id).is_some() {
// Inline mark_suspect logic for the spawned task
if let Some(mut member) = members.get_mut(&target_id) {
if member.mark_suspect() {
let suspect = SwimMessage::Suspect {
node_id: target_id.clone(),
incarnation: member.incarnation,
from: source_id.clone(),
};
drop(member);
gossip_queue.lock().await.push(GossipItem {
message: suspect,
transmissions: 0,
});
let _ = event_tx
.send(MembershipEvent::NodeSuspected(target_id));
}
}
}
}
});
}
// Await all probe tasks
while let Some(res) = join_set.join_next().await {
if let Err(e) = res {
warn!(error = %e, "probe task panicked");
}
}
}
// Check for suspect timeouts
self.check_suspect_timeouts().await?;
}
}
/// Select up to `k` random members to probe concurrently.
fn select_probe_targets(&self, k: usize) -> Vec<Node> {
use rand::seq::IteratorRandom;
self.members
.iter()
.filter(|r| r.key() != &self.local_node.id)
.filter(|r| r.value().state.is_reachable())
.choose_multiple(&mut rand::thread_rng(), k)
.into_iter()
.map(|r| r.value().clone())
.collect()
}
/// Static version of `send_with_gossip` for use inside spawned tasks.
async fn send_with_gossip_static(
msg: &SwimMessage,
addr: SocketAddr,
socket: &Arc<UdpSocket>,
gossip_queue: &Arc<tokio::sync::Mutex<Vec<GossipItem>>>,
members: &Arc<DashMap<NodeId, Node>>,
hmac_key: &Option<Zeroizing<String>>,
) -> Result<()> {
// Send the primary message
Self::send_message_static(msg, addr, socket, hmac_key).await?;
// Piggyback pending gossip items
let gossip = Self::drain_gossip_static(gossip_queue, members).await;
for item in gossip {
Self::send_message_static(&item, addr, socket, hmac_key).await?;
}
Ok(())
}
/// Static version of `send_message` for use inside spawned tasks.
async fn send_message_static(
msg: &SwimMessage,
addr: SocketAddr,
socket: &Arc<UdpSocket>,
hmac_key: &Option<Zeroizing<String>>,
) -> Result<()> {
let data = postcard::to_allocvec(msg)?;
let packet = Self::sign_message_static(&data, hmac_key);
socket.send_to(&packet, addr).await?;
Ok(())
}
/// Static version of `sign_message` for use inside spawned tasks.
///
/// Wire format must match `sign_message`: `[timestamp:8][payload:N][hmac_tag:32]`
fn sign_message_static(data: &[u8], hmac_key: &Option<Zeroizing<String>>) -> Vec<u8> {
#[cfg(feature = "swim")]
if let Some(ref key) = hmac_key {
let ts_millis = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.unwrap_or_default()
.as_millis() as u64;
let ts_bytes = ts_millis.to_be_bytes();
let mut mac =
Hmac::<Sha256>::new_from_slice(key.as_bytes()).expect("HMAC key always valid");
mac.update(&ts_bytes);
mac.update(data);
let tag = mac.finalize().into_bytes();
let mut signed = Vec::with_capacity(8 + data.len() + HMAC_TAG_LEN);
signed.extend_from_slice(&ts_bytes);
signed.extend_from_slice(data);
signed.extend_from_slice(&tag);
return signed;
}
data.to_vec()
}
/// Static version of `drain_gossip` for use inside spawned tasks.
async fn drain_gossip_static(
gossip_queue: &Arc<tokio::sync::Mutex<Vec<GossipItem>>>,
members: &Arc<DashMap<NodeId, Node>>,
) -> Vec<SwimMessage> {
let member_count = members.len().max(2) as f64;
let max_transmissions = (member_count.log2().ceil() as u32) + 1;
let mut queue = gossip_queue.lock().await;
let take = queue.len().min(MAX_GOSSIP_PER_MSG);
let mut items = Vec::with_capacity(take);
for item in queue.iter_mut().take(take) {
item.transmissions += 1;
items.push(item.message.clone());
}
queue.retain(|item| item.transmissions < max_transmissions);
items
}
/// Static version of `send_indirect_probes` for use inside spawned tasks.
async fn send_indirect_probes_static(
target: &NodeId,
source_id: &NodeId,
members: &Arc<DashMap<NodeId, Node>>,
socket: &Arc<UdpSocket>,
hmac_key: &Option<Zeroizing<String>>,
incarnation: &Arc<RwLock<u64>>,
indirect_probes_k: usize,
) -> Result<()> {
use rand::seq::IteratorRandom;
let intermediaries: Vec<_> = members
.iter()
.filter(|r| r.key() != source_id && r.key() != target)
.filter(|r| r.value().is_healthy())
.choose_multiple(&mut rand::thread_rng(), indirect_probes_k);
let inc = *incarnation.read().await;
let ping_req = SwimMessage::PingReq {
source: source_id.clone(),
target: target.clone(),
incarnation: inc,
};
for intermediate in intermediaries {
let _ = Self::send_message_static(
&ping_req,
intermediate.value().cluster_addr(),
socket,
hmac_key,
)
.await;
}
Ok(())
}
/// Check for suspects that have timed out
async fn check_suspect_timeouts(&self) -> Result<()> {
let timeout = self.config.ping_interval * self.config.suspicion_multiplier;
let now = Instant::now();
let mut dead_nodes = vec![];
for member in self.members.iter() {
if member.state == NodeState::Suspect && now.duration_since(member.last_seen) > timeout
{
dead_nodes.push(member.key().clone());
}
}
for node_id in dead_nodes {
if let Some(mut member) = self.members.get_mut(&node_id) {
if member.mark_dead() {
// Enqueue death notice for piggyback dissemination
let dead = SwimMessage::Dead {
node_id: node_id.clone(),
incarnation: member.incarnation,
};
self.enqueue_gossip(dead).await;
let _ = self.event_tx.send(MembershipEvent::NodeFailed(node_id));
}
}
}
Ok(())
}
/// Periodically sync full state with random members
async fn run_sync(&self) -> Result<()> {
let mut interval = tokio::time::interval(self.config.sync_interval);
loop {
interval.tick().await;
// Select random member to sync with
let targets = self.select_probe_targets(1);
if let Some(target) = targets.first() {
let states: Vec<NodeGossipState> = self
.members
.iter()
.map(|r| NodeGossipState::from(r.value()))
.collect();
let sync = SwimMessage::Sync {
source: self.local_node.id.clone(),
states,
};
let _ = self.send_message(&sync, target.cluster_addr()).await;
}
}
}
/// Enqueue a state-change message for piggyback dissemination.
///
/// Instead of O(N) broadcasting, items are piggybacked onto
/// routine Ping/Ack messages. Each item is retransmitted up to
/// ⌈log₂(N)⌉+1 times before being dropped (SWIM protocol guarantee).
async fn enqueue_gossip(&self, msg: SwimMessage) {
let mut queue = self.gossip_queue.lock().await;
queue.push(GossipItem {
message: msg,
transmissions: 0,
});
}
/// Drain up to `MAX_GOSSIP_PER_MSG` items from the gossip queue,
/// incrementing their transmission counter. Items that have been
/// transmitted enough times (≥ ⌈log₂(N)⌉+1) are removed.
async fn drain_gossip(&self) -> Vec<SwimMessage> {
let member_count = self.members.len().max(2) as f64;
let max_transmissions = (member_count.log2().ceil() as u32) + 1;
let mut queue = self.gossip_queue.lock().await;
let take = queue.len().min(MAX_GOSSIP_PER_MSG);
let mut items = Vec::with_capacity(take);
for item in queue.iter_mut().take(take) {
item.transmissions += 1;
items.push(item.message.clone());
}
// Remove items that have been transmitted enough times
queue.retain(|item| item.transmissions < max_transmissions);
items
}
/// Send a primary message with piggybacked gossip items to `addr`.
async fn send_with_gossip(&self, msg: &SwimMessage, addr: SocketAddr) -> Result<()> {
// Always send the primary message
self.send_message(msg, addr).await?;
// Piggyback pending gossip items
let gossip = self.drain_gossip().await;
for item in gossip {
self.send_message(&item, addr).await?;
}
Ok(())
}
/// Broadcast a message to all members (used only for leave/join announcements
/// where immediate dissemination is required).
async fn broadcast(&self, msg: &SwimMessage) -> Result<()> {
for member in self.members.iter() {
if member.key() != &self.local_node.id {
let _ = self.send_message(msg, member.value().cluster_addr()).await;
}
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
#[tokio::test]
async fn test_membership_creation() {
let node_info = NodeInfo::new(
"test-node",
"127.0.0.1:9092".parse().unwrap(),
"127.0.0.1:0".parse().unwrap(),
);
let config = SwimConfig::default();
let (_shutdown_tx, shutdown_rx) = broadcast::channel(1);
let membership = Membership::new(node_info, config, shutdown_rx)
.await
.unwrap();
assert_eq!(membership.member_count(), 1);
assert_eq!(membership.healthy_count(), 1);
}
}