/
pool.rs
391 lines (351 loc) · 12.6 KB
/
pool.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
use crate::{
blockcfg::{ApplyBlockLedger, LedgerParameters},
fragment::{
selection::{FragmentSelectionAlgorithm, FragmentSelectionAlgorithmParams, OldestFirst},
Fragment, FragmentId, Logs,
},
intercom::{NetworkMsg, PropagateMsg},
utils::async_msg::MessageBox,
};
use chain_core::property::Fragment as _;
use chain_impl_mockchain::{fragment::Contents, transaction::Transaction};
use futures::channel::mpsc::SendError;
use futures::sink::SinkExt;
use jormungandr_lib::interfaces::{FragmentLog, FragmentOrigin, FragmentStatus};
use thiserror::Error;
pub struct Pools {
logs: Logs,
pools: Vec<internal::Pool>,
network_msg_box: MessageBox<NetworkMsg>,
}
#[derive(Debug, Error)]
pub enum Error {
#[error("cannot propagate a fragment to the network")]
CannotPropagate(#[source] SendError),
}
impl Pools {
pub fn new(
max_entries: usize,
n_pools: usize,
logs: Logs,
network_msg_box: MessageBox<NetworkMsg>,
) -> Self {
let pools = (0..=n_pools)
.map(|_| internal::Pool::new(max_entries))
.collect();
Pools {
logs,
pools,
network_msg_box,
}
}
pub fn logs(&mut self) -> &mut Logs {
&mut self.logs
}
/// Returns number of registered fragments
pub async fn insert_and_propagate_all(
&mut self,
origin: FragmentOrigin,
mut fragments: Vec<Fragment>,
) -> Result<usize, Error> {
tracing::debug!(origin = ?origin, "received {} fragments", fragments.len());
fragments.retain(is_fragment_valid);
if fragments.is_empty() {
tracing::debug!("none of the received fragments are valid");
return Ok(0);
}
let mut network_msg_box = self.network_msg_box.clone();
let fragment_ids = fragments.iter().map(Fragment::id).collect::<Vec<_>>();
let fragments_exist_in_logs = self.logs.exist_all(fragment_ids);
let new_fragments = fragments
.into_iter()
.zip(fragments_exist_in_logs)
.filter(|(_, exists_in_logs)| !exists_in_logs)
.map(|(fragment, _)| fragment);
let mut max_added = 0;
for (i, pool) in self.pools.iter_mut().enumerate() {
let new_fragments = pool.insert_all(new_fragments.clone());
let count = new_fragments.len();
tracing::debug!(
"{} of the received fragments were added to the pool number {}",
count,
i
);
let fragment_logs = new_fragments
.iter()
.map(move |fragment| FragmentLog::new(fragment.id(), origin))
.collect::<Vec<_>>();
self.logs.insert_all(fragment_logs);
if count > max_added {
max_added = count;
}
}
for fragment in new_fragments.into_iter() {
let fragment_msg = NetworkMsg::Propagate(PropagateMsg::Fragment(fragment));
network_msg_box
.send(fragment_msg)
.await
.map_err(Error::CannotPropagate)?;
}
Ok(max_added)
}
pub fn remove_added_to_block(&mut self, fragment_ids: Vec<FragmentId>, status: FragmentStatus) {
for pool in &mut self.pools {
pool.remove_all(fragment_ids.iter());
}
self.logs.modify_all(fragment_ids, status);
}
pub async fn select(
&mut self,
pool_idx: usize,
ledger: ApplyBlockLedger,
ledger_params: LedgerParameters,
selection_alg: FragmentSelectionAlgorithmParams,
soft_deadline_future: futures::channel::oneshot::Receiver<()>,
hard_deadline_future: futures::channel::oneshot::Receiver<()>,
) -> (Contents, ApplyBlockLedger) {
let Pools { logs, pools, .. } = self;
let pool = &mut pools[pool_idx];
match selection_alg {
FragmentSelectionAlgorithmParams::OldestFirst => {
let mut selection_alg = OldestFirst::new();
selection_alg
.select(
ledger,
&ledger_params,
logs,
pool,
soft_deadline_future,
hard_deadline_future,
)
.await
}
}
}
}
fn is_fragment_valid(fragment: &Fragment) -> bool {
match fragment {
// never valid in the pool, only acceptable in genesis
Fragment::Initial(_) => false,
Fragment::OldUtxoDeclaration(_) => false,
// general transactions stuff
Fragment::Transaction(ref tx) => is_transaction_valid(tx),
Fragment::StakeDelegation(ref tx) => is_transaction_valid(tx),
Fragment::OwnerStakeDelegation(ref tx) => is_transaction_valid(tx),
Fragment::PoolRegistration(ref tx) => is_transaction_valid(tx),
Fragment::PoolRetirement(ref tx) => is_transaction_valid(tx),
Fragment::PoolUpdate(ref tx) => is_transaction_valid(tx),
// vote stuff
Fragment::UpdateProposal(_) => false, // TODO: enable when ready
Fragment::UpdateVote(_) => false, // TODO: enable when ready
Fragment::VotePlan(ref tx) => is_transaction_valid(tx),
Fragment::VoteCast(ref tx) => is_transaction_valid(tx),
Fragment::VoteTally(ref tx) => is_transaction_valid(tx),
Fragment::EncryptedVoteTally(ref tx) => is_transaction_valid(tx),
}
}
fn is_transaction_valid<E>(tx: &Transaction<E>) -> bool {
tx.verify_possibly_balanced().is_ok()
}
pub(super) mod internal {
use super::*;
use std::{
collections::HashMap,
hash::{Hash, Hasher},
ptr,
};
/// Doubly-linked queue with the possibility to remove elements from the middle of the list by
/// their keys.
struct IndexedDeqeue<K, V> {
head: *mut IndexedDequeueEntry<K, V>,
tail: *mut IndexedDequeueEntry<K, V>,
index: HashMap<IndexedDequeueKeyRef<K>, Box<IndexedDequeueEntry<K, V>>>,
}
struct IndexedDequeueEntry<K, V> {
key: K,
value: V,
prev: *mut IndexedDequeueEntry<K, V>,
next: *mut IndexedDequeueEntry<K, V>,
}
/// A wrapper around the pointer to the key of the queue element. This wrapper forwards the
/// implementations of `Eq` and `Hash` to `K`. This is required becuase by default the
/// implementations of `Eq` and `Hash` from the pointer itself will be used.
struct IndexedDequeueKeyRef<K>(*const K);
impl<K, V> IndexedDeqeue<K, V>
where
K: Eq + Hash,
{
fn new() -> Self {
Self {
head: ptr::null_mut(),
tail: ptr::null_mut(),
index: HashMap::new(),
}
}
fn push_front(&mut self, key: K, value: V) {
let mut entry = Box::new(IndexedDequeueEntry {
key,
value,
prev: ptr::null_mut(),
next: self.head,
});
if let Some(head) = unsafe { self.head.as_mut() } {
head.prev = &mut *entry;
} else {
self.tail = &mut *entry;
}
self.head = &mut *entry;
if self
.index
.insert(IndexedDequeueKeyRef(&entry.key), entry)
.is_some()
{
panic!("inserted an already existing key");
}
}
fn push_back(&mut self, key: K, value: V) {
let mut entry = Box::new(IndexedDequeueEntry {
key,
value,
prev: self.tail,
next: ptr::null_mut(),
});
if let Some(tail) = unsafe { self.tail.as_mut() } {
tail.next = &mut *entry;
} else {
self.head = &mut *entry;
}
self.tail = &mut *entry;
if self
.index
.insert(IndexedDequeueKeyRef(&entry.key), entry)
.is_some()
{
panic!("inserted an already existing key");
}
}
fn pop_back(&mut self) -> Option<(K, V)> {
let tail = unsafe { self.tail.as_mut() }?;
let entry = self.index.remove(&IndexedDequeueKeyRef(&tail.key)).unwrap();
self.tail = tail.prev;
if let Some(prev) = unsafe { tail.prev.as_mut() } {
prev.next = ptr::null_mut();
} else {
self.head = ptr::null_mut();
}
Some((entry.key, entry.value))
}
fn remove(&mut self, key: &K) -> Option<V> {
let entry = self.index.remove(&IndexedDequeueKeyRef(key))?;
if let Some(prev) = unsafe { entry.prev.as_mut() } {
prev.next = entry.next;
} else {
self.head = entry.next;
}
if let Some(next) = unsafe { entry.next.as_mut() } {
next.prev = entry.prev;
} else {
self.tail = entry.prev;
}
Some(entry.value)
}
fn len(&self) -> usize {
self.index.len()
}
fn contains(&self, key: &K) -> bool {
self.index.contains_key(&IndexedDequeueKeyRef(key))
}
}
unsafe impl<K: Send, V: Send> Send for IndexedDeqeue<K, V> {}
impl<K: PartialEq> PartialEq for IndexedDequeueKeyRef<K> {
fn eq(&self, other: &IndexedDequeueKeyRef<K>) -> bool {
unsafe { (*self.0).eq(&*other.0) }
}
}
impl<K: PartialEq> Eq for IndexedDequeueKeyRef<K> {}
impl<K: Hash> Hash for IndexedDequeueKeyRef<K> {
fn hash<H: Hasher>(&self, state: &mut H) {
unsafe { (*self.0).hash(state) }
}
}
pub struct Pool {
entries: IndexedDeqeue<FragmentId, Fragment>,
max_entries: usize,
}
impl Pool {
pub fn new(max_entries: usize) -> Self {
Pool {
entries: IndexedDeqeue::new(),
max_entries,
}
}
/// Returns clones of registered fragments
pub fn insert_all(
&mut self,
fragments: impl IntoIterator<Item = Fragment>,
) -> Vec<Fragment> {
let max_fragments = self.max_entries - self.entries.len();
fragments
.into_iter()
.filter(|fragment| {
let fragment_id = fragment.id();
if self.entries.contains(&fragment_id) {
false
} else {
self.entries.push_front(fragment_id, fragment.clone());
true
}
})
.take(max_fragments)
.collect()
}
pub fn remove_all<'a>(&mut self, fragment_ids: impl IntoIterator<Item = &'a FragmentId>) {
for fragment_id in fragment_ids {
self.entries.remove(fragment_id);
}
}
pub fn remove_oldest(&mut self) -> Option<Fragment> {
self.entries.pop_back().map(|(_, value)| value)
}
pub fn return_to_pool(&mut self, fragments: impl IntoIterator<Item = Fragment>) {
for fragment in fragments.into_iter() {
self.entries.push_back(fragment.id(), fragment);
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use quickcheck_macros::quickcheck;
#[quickcheck]
fn overflowing_pool_should_reject_new_fragments(
fragments1_in: (Fragment, Fragment, Fragment),
fragments2_in: (Fragment, Fragment),
) {
let fragments1 = vec![
fragments1_in.0.clone(),
fragments1_in.1.clone(),
fragments1_in.2.clone(),
];
let fragments2 = vec![
fragments1_in.2.clone(),
fragments2_in.0.clone(),
fragments2_in.1.clone(),
];
let fragments2_expected = vec![fragments2_in.0.clone()];
let final_expected = vec![
fragments1_in.0,
fragments1_in.1,
fragments1_in.2,
fragments2_in.0,
];
let mut pool = Pool::new(4);
assert_eq!(fragments1, pool.insert_all(fragments1.clone()));
assert_eq!(fragments2_expected, pool.insert_all(fragments2));
for expected in final_expected.into_iter() {
assert_eq!(expected, pool.remove_oldest().unwrap());
}
assert!(pool.remove_oldest().is_none());
}
}
}