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
use std::{
    collections::VecDeque,
    fmt::Display,
    num::NonZeroUsize,
    sync::{
        atomic::{AtomicUsize, Ordering},
        Arc,
    },
};

use futures::{lock::Mutex, StreamExt};
use generic_array::GenericArray;

use rasi::task::spawn_ok;
use xstack::{events, identity::PeerId, EventSource, ProtocolStream, Switch};

use crate::Result;

mod uint {
    use uint::construct_uint;
    construct_uint! {
        pub(super) struct U256(4);
    }
}

#[derive(Default)]
struct KBucket<const K: usize>(VecDeque<PeerId>);

impl<const K: usize> KBucket<K> {
    fn new(peer_id: PeerId) -> Self {
        let mut q = VecDeque::new();
        q.push_back(peer_id);
        Self(q)
    }
    fn try_insert(&mut self, peer_id: PeerId) -> Option<PeerId> {
        // already existing, move to the tail
        if let Some(index) =
            self.0
                .iter()
                .enumerate()
                .find_map(|(index, item)| if *item == peer_id { Some(index) } else { None })
        {
            self.0.remove(index);
            self.0.push_back(peer_id);
            return Some(peer_id);
        }

        if self.0.len() == K {
            let lru = self.0.pop_front();
            return lru;
        }

        self.0.push_back(peer_id);

        return None;
    }

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

/// The distance type outlined in the Kademlia [**paper**]
///
/// [**paper**]: https://doi.org/10.1007/3-540-45748-8_5
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct KBucketDistance(uint::U256);

impl KBucketDistance {
    /// Returns the integer part of the base 2 logarithm of the [`KBucketDistance`].
    ///
    /// Returns `None` if the distance is zero.
    pub fn k_index(&self) -> Option<u32> {
        (256 - self.0.leading_zeros()).checked_sub(1)
    }
}

impl Display for KBucketDistance {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "k_distance({:#066x})", self.0)
    }
}

/// The key type of [`KBucketTable`]
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct KBucketKey(uint::U256);

impl KBucketKey {
    pub fn distance(&self, rhs: &KBucketKey) -> KBucketDistance {
        KBucketDistance(self.0 ^ rhs.0)
    }
}

impl From<Vec<u8>> for KBucketKey {
    fn from(value: Vec<u8>) -> Self {
        Self::from(value.as_slice())
    }
}

impl From<&Vec<u8>> for KBucketKey {
    fn from(value: &Vec<u8>) -> Self {
        Self::from(value.as_slice())
    }
}

impl From<&[u8]> for KBucketKey {
    fn from(value: &[u8]) -> Self {
        use sha2::Digest;

        let mut hasher = sha2::Sha256::new();

        hasher.update(value);

        let buf: [u8; 32] = hasher.finalize().into();

        Self(buf.into())
    }
}

impl From<PeerId> for KBucketKey {
    fn from(value: PeerId) -> Self {
        Self::from(&value)
    }
}

impl From<&PeerId> for KBucketKey {
    fn from(value: &PeerId) -> Self {
        Self::from(value.to_bytes().as_slice())
    }
}

#[allow(unused)]
struct RawKBucketTable<const K: usize> {
    local_key: KBucketKey,
    /// k-bucket list with lazy initialization.
    k_buckets: Vec<KBucket<K>>,
    /// index of k_bucket in `k_buckets`
    k_index: GenericArray<Option<usize>, generic_array::typenum::U256>,
}

impl<const K: usize> RawKBucketTable<K> {
    /// On success, returns None.
    fn try_insert(&mut self, peer_id: PeerId) -> Option<PeerId> {
        let k_index = KBucketKey::from(peer_id)
            .distance(&self.local_key)
            .k_index()
            .expect("Insert local peer's id") as usize;

        if let Some(index) = self.k_index[k_index] {
            let r = self.k_buckets[index].try_insert(peer_id);

            if r.is_none() {
                log::trace!("peer_id={}, insert k-bucket({})", peer_id, k_index);
            }

            r
        } else {
            log::trace!("peer_id={}, insert k-bucket({})", peer_id, k_index,);
            self.k_buckets.push(KBucket::new(peer_id));
            self.k_index[k_index] = Some(self.k_buckets.len() - 1);
            None
        }
    }

    fn closest(&mut self, key: KBucketKey) -> Result<Vec<PeerId>> {
        let k_index = key.distance(&self.local_key).k_index().unwrap_or(1) as usize;

        let mut peers = vec![];

        if let Some(bucket) = self.bucket(k_index) {
            peers = bucket.0.iter().rev().cloned().collect();
        }

        let mut step = 1usize;

        while peers.len() < K {
            if k_index >= step {
                if let Some(bucket) = self.bucket(k_index - step) {
                    if bucket.len() + peers.len() > K {
                        let offset = bucket.len() + peers.len() - K;

                        for peer_id in bucket.0.iter().collect::<Vec<_>>()[offset..].iter().rev() {
                            peers.push(**peer_id);
                        }

                        break;
                    }

                    for peer_id in bucket.0.iter().rev() {
                        peers.push(*peer_id);
                    }
                }
            } else if k_index + step >= self.k_index.len() {
                break;
            }

            if k_index + step < self.k_index.len() {
                if let Some(bucket) = self.bucket(k_index + step) {
                    if bucket.len() + peers.len() > K {
                        let offset = bucket.len() + peers.len() - K;

                        for peer_id in bucket.0.iter().collect::<Vec<_>>()[offset..].iter().rev() {
                            peers.push(**peer_id);
                        }

                        break;
                    }

                    for peer_id in bucket.0.iter().rev() {
                        peers.push(*peer_id);
                    }
                }
            } else if k_index < step {
                break;
            }

            step += 1;
        }

        Ok(peers)
    }

    fn bucket(&self, index: usize) -> Option<&KBucket<K>> {
        self.k_index[index].map(|index| &self.k_buckets[index])
    }
}

/// A rust implementation of the k-bucket data structure outlined in the Kademlia [**paper**]
///
///
/// Unlike the paper description, the only data stored by this implementation is the [`PeerId`],
/// develpers can call [`lookup_peer_info`] function to get the more data associated with the it.
///
/// [**paper**]: https://doi.org/10.1007/3-540-45748-8_5
/// [`lookup_peer_info`]: xstack::Switch::lookup_peer_info
/// [`PeerId`]: xstack::identity::PeerId
#[derive(Clone)]
pub struct KBucketTable<const K: usize> {
    #[allow(unused)]
    /// The switch instance to which this table belongs
    switch: Switch,
    /// the size of this table,
    len: Arc<AtomicUsize>,
    /// The inner raw KBucketTable instance.
    table: Arc<Mutex<RawKBucketTable<K>>>,
}

impl<const K: usize> KBucketTable<K> {
    async fn insert_prv(&self, peer_id: PeerId) -> Option<PeerId> {
        match self.table.lock().await.try_insert(peer_id) {
            Some(pop) => {
                if pop != peer_id {
                    self.len.fetch_sub(1, Ordering::Relaxed);
                }

                Some(pop)
            }
            None => {
                self.len.fetch_add(1, Ordering::Relaxed);
                None
            }
        }
    }
}

impl<const K: usize> KBucketTable<K> {
    /// Create a `k-bucket` table for provides `switch`
    pub async fn bind(switch: &Switch) -> Self {
        assert!(K > 0, "the k must greater than zero");

        let mut event_connected = EventSource::<events::HandshakeSuccess>::bind_with(
            &switch,
            NonZeroUsize::new(100).unwrap(),
        )
        .await;

        let table = Self {
            len: Default::default(),
            table: Arc::new(Mutex::new(RawKBucketTable {
                local_key: switch.local_id().into(),
                k_buckets: Default::default(),
                k_index: Default::default(),
            })),
            switch: switch.clone(),
        };

        let table_cloned = table.clone();

        // create background update task.
        spawn_ok(async move {
            while let Some((_, peer_id)) = event_connected.next().await {
                table_cloned.insert(peer_id).await;
            }
        });

        table
    }
    /// Returns the const k value of the k-bucket.
    pub fn k_const(&self) -> usize {
        K
    }

    /// Get the size of the *routing table*.
    pub fn len(&self) -> usize {
        self.len.load(Ordering::Acquire)
    }

    /// Try insert a peer into the *routing table*,
    /// If you need to understand why `PeerId` is probabilistically inserted into the *routing table*, see the  Kademlia [**paper**]
    ///
    ///
    /// [**paper**]: https://doi.org/10.1007/3-540-45748-8_5
    pub async fn insert(&self, peer_id: PeerId) {
        if let Some(lru) = self.insert_prv(peer_id.clone()).await {
            let this = self.clone();

            spawn_ok(async move {
                // ping the lru to decide what to do.
                if let Err(err) = ProtocolStream::ping_with(&this.switch, &lru).await {
                    log::trace!("ping lru node, {}", err);
                    this.insert_prv(lru.clone()).await;
                } else {
                    this.insert_prv(peer_id).await;
                }
            });

            // let this = self.clone();

            // // ping the lru to decide what to do.
            // if let Err(err) = ProtocolStream::ping_with(&this.switch, &lru).await {
            //     log::trace!("ping lru node, {}", err);
            //     this.insert_prv(lru).await;
            // } else {
            //     this.insert_prv(peer_id).await;
            // }
        }
    }

    /// Return the closest `K` peers for the input `key`.
    pub async fn closest<Q>(&self, key: Q) -> Result<Vec<PeerId>>
    where
        Q: Into<KBucketKey>,
    {
        let key: KBucketKey = key.into();

        self.table.lock().await.closest(key)
    }
}

#[cfg(test)]
mod tests {

    use std::sync::Once;

    use super::{uint::U256, *};

    use quickcheck::*;
    use rasi_mio::{net::register_mio_network, timer::register_mio_timer};
    use xstack_tcp::TcpTransport;

    impl Arbitrary for KBucketKey {
        fn arbitrary(_: &mut Gen) -> KBucketKey {
            KBucketKey::from(PeerId::random())
        }
    }

    #[test]
    fn distance_symmetry() {
        fn prop(a: KBucketKey, b: KBucketKey) -> bool {
            a.distance(&b) == b.distance(&a)
        }
        quickcheck(prop as fn(_, _) -> _)
    }

    #[test]
    fn test_generic_array() {
        let mut array = GenericArray::<Option<usize>, generic_array::typenum::U256>::default();

        assert_eq!(array[254], None);

        array[254] = Some(1);

        assert_eq!(array[254], Some(1));
    }

    #[test]
    fn k_distance_0() {
        assert_eq!(KBucketDistance(U256::from(0)).k_index(), None);
        assert_eq!(KBucketDistance(U256::from(1)).k_index(), Some(0));
        assert_eq!(KBucketDistance(U256::from(2)).k_index(), Some(1));
        assert_eq!(KBucketDistance(U256::from(3)).k_index(), Some(1));
        assert_eq!(KBucketDistance(U256::from(4)).k_index(), Some(2));
        assert_eq!(KBucketDistance(U256::from(5)).k_index(), Some(2));
        assert_eq!(KBucketDistance(U256::from(6)).k_index(), Some(2));
        assert_eq!(KBucketDistance(U256::from(7)).k_index(), Some(2));
    }

    #[test]
    fn distance_self() {
        let key = KBucketKey::from(PeerId::random());

        let distance = key.distance(&key);

        assert_eq!(distance.0, U256::from(0));
    }

    async fn init() -> Switch {
        static INIT: Once = Once::new();

        INIT.call_once(|| {
            // _ = pretty_env_logger::try_init_timed();

            register_mio_network();
            register_mio_timer();
        });

        Switch::new("kad-test")
            .transport(TcpTransport::default())
            .create()
            .await
            .unwrap()
    }

    #[futures_test::test]
    async fn test_table() {
        let switch = init().await;

        let k_bucket_table = KBucketTable::<20>::bind(&switch).await;

        k_bucket_table.insert(PeerId::random()).await;

        assert_eq!(k_bucket_table.len(), 1);

        let closest = k_bucket_table.closest(PeerId::random()).await.unwrap();

        assert_eq!(closest.len(), 1);

        for _ in 1..20 {
            k_bucket_table.insert(PeerId::random()).await;
        }

        assert_eq!(k_bucket_table.len(), 20);

        let closest = k_bucket_table.closest(PeerId::random()).await.unwrap();

        assert_eq!(closest.len(), 20);

        loop {
            k_bucket_table.insert(PeerId::random()).await;

            if k_bucket_table.len() > 20 {
                break;
            }
        }

        let closest = k_bucket_table.closest(PeerId::random()).await.unwrap();

        assert_eq!(closest.len(), 20);
    }
}