sof 0.18.2

Solana Observer Framework for low-latency shred ingestion and plugin-driven transaction observation
Documentation 
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

use super::*;

#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
struct OutstandingRepairKey {
    slot: u64,
    index: u32,
    kind: MissingShredRequestKind,
}

impl OutstandingRepairKey {
    #[cfg(any(feature = "gossip-bootstrap", test))]
    const fn from_request(request: &MissingShredRequest) -> Self {
        Self {
            slot: request.slot,
            index: request.index,
            kind: request.kind,
        }
    }
}

#[derive(Debug)]
pub struct OutstandingRepairRequests {
    entries: HashMap<OutstandingRepairKey, Instant>,
    #[cfg(any(feature = "gossip-bootstrap", test))]
    highest_window_by_slot: BTreeSet<(u64, u32)>,
    #[cfg(any(feature = "gossip-bootstrap", test))]
    /// Insertion order for expiry, including stale superseded timestamps.
    order: VecDeque<(OutstandingRepairKey, Instant)>,
    #[cfg(any(feature = "gossip-bootstrap", test))]
    timeout: Duration,
}

impl OutstandingRepairRequests {
    pub fn new(timeout: Duration) -> Self {
        #[cfg(not(any(feature = "gossip-bootstrap", test)))]
        let _ = timeout;
        Self {
            entries: HashMap::new(),
            #[cfg(any(feature = "gossip-bootstrap", test))]
            highest_window_by_slot: BTreeSet::new(),
            #[cfg(any(feature = "gossip-bootstrap", test))]
            order: VecDeque::new(),
            #[cfg(any(feature = "gossip-bootstrap", test))]
            timeout,
        }
    }

    #[cfg(any(feature = "gossip-bootstrap", test))]
    pub fn purge_expired(&mut self, now: Instant) -> usize {
        let mut removed = 0_usize;
        while let Some((_, front_sent_at)) = self.order.front() {
            if now.saturating_duration_since(*front_sent_at) < self.timeout {
                break;
            }
            let Some((key, queued_sent_at)) = self.order.pop_front() else {
                break;
            };
            if self.entries.get(&key) == Some(&queued_sent_at) {
                let _ = self.entries.remove(&key);
                self.remove_highest_window_index(key);
                removed = removed.saturating_add(1);
            }
        }
        removed
    }

    #[cfg(any(feature = "gossip-bootstrap", test))]
    pub fn try_reserve(&mut self, request: &MissingShredRequest, now: Instant) -> bool {
        let key = OutstandingRepairKey::from_request(request);
        if let Some(sent_at) = self.entries.get_mut(&key) {
            if now.saturating_duration_since(*sent_at) < self.timeout {
                return false;
            }
            *sent_at = now;
            self.insert_highest_window_index(key);
            self.order.push_back((key, now));
            return true;
        }
        let _ = self.entries.insert(key, now);
        self.insert_highest_window_index(key);
        self.order.push_back((key, now));
        true
    }

    #[cfg(feature = "gossip-bootstrap")]
    pub fn release(&mut self, request: &MissingShredRequest) {
        let key = OutstandingRepairKey::from_request(request);
        let _ = self.entries.remove(&key);
        self.remove_highest_window_index(key);
    }

    pub fn on_shred_received(&mut self, slot: u64, index: u32) -> usize {
        let mut removed = 0_usize;
        if self
            .entries
            .remove(&OutstandingRepairKey {
                slot,
                index,
                kind: MissingShredRequestKind::WindowIndex,
            })
            .is_some()
        {
            removed = removed.saturating_add(1);
        }
        #[cfg(any(feature = "gossip-bootstrap", test))]
        {
            let highest_to_clear: Vec<_> = self
                .highest_window_by_slot
                .range((slot, 0)..=(slot, index))
                .copied()
                .collect();
            for (highest_slot, highest_index) in highest_to_clear {
                if self
                    .entries
                    .remove(&OutstandingRepairKey {
                        slot: highest_slot,
                        index: highest_index,
                        kind: MissingShredRequestKind::HighestWindowIndex,
                    })
                    .is_some()
                {
                    removed = removed.saturating_add(1);
                }
                let _ = self
                    .highest_window_by_slot
                    .remove(&(highest_slot, highest_index));
            }
        }
        removed
    }

    pub fn len(&self) -> usize {
        self.entries.len()
    }

    #[cfg(any(feature = "gossip-bootstrap", test))]
    fn insert_highest_window_index(&mut self, key: OutstandingRepairKey) {
        if key.kind == MissingShredRequestKind::HighestWindowIndex {
            let _ = self.highest_window_by_slot.insert((key.slot, key.index));
        }
    }

    #[cfg(any(feature = "gossip-bootstrap", test))]
    fn remove_highest_window_index(&mut self, key: OutstandingRepairKey) {
        if key.kind == MissingShredRequestKind::HighestWindowIndex {
            let _ = self.highest_window_by_slot.remove(&(key.slot, key.index));
        }
    }
}