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
use std::{
collections::{HashMap, HashSet, VecDeque},
fmt::Debug,
future::Future,
num::NonZeroUsize,
sync::Arc,
};
use futures::StreamExt;
use futures_map::FuturesUnorderedMap;
use rasi::timer::TimeoutExt;
use xstack::{global_switch, identity::PeerId, multiaddr::Multiaddr, PeerInfo, Switch};
use crate::{
syscall::DriverKadStore, Error, KBucketKey, KBucketTable, KadMemoryStore, KadStore,
KademliaRpc, Result,
};
/// protocol name of libp2p kad.
pub const PROTOCOL_IPFS_KAD: &str = "/ipfs/kad/1.0.0";
pub const PROTOCOL_IPFS_LAN_KAD: &str = "/ipfs/lan/kad/1.0.0";
/// The varaint returns by call `routing` fn rpc on `peers`
pub enum Routing {
/// Need to continue recursive routing `closest` peers.
Closest(Vec<PeerId>),
/// No need to continue recursive routing
Finished,
}
/// A recursive routing algorithm must implement this trait.
pub trait RoutingAlogrithm {
/// Create a future to execute the routing algorithm.
///
/// - `peer_id`, The peer's id on that the routing algorithm executes.
fn route(
&self,
peer_id: &PeerId,
) -> impl Future<Output = std::io::Result<Routing>> + Send + 'static;
}
/// The context data for recursive routing algorithms.
pub struct Recursively<'a> {
label: Option<&'a str>,
/// The search key.
key: &'a KBucketKey,
/// The result k closest nodes.
closest_k: Vec<PeerId>,
/// The track set of peers we've already queried.
queried: HashSet<PeerId>,
/// The set of next query candidates
candidates: VecDeque<PeerId>,
/// the maximum concurrency tasks that this route process can starts.
concurrency: usize,
/// The replication parameter.
const_k: usize,
}
impl<'a> Recursively<'a> {
/// Create a new recursive routing context data with provides `seeds`.
/// # parameters
///
/// - `concurrency`, the maximum concurrency tasks that this route process can starts.
pub fn new(
label: Option<&'a str>,
key: &'a KBucketKey,
const_k: NonZeroUsize,
concurrency: NonZeroUsize,
seeds: Vec<PeerId>,
) -> Self {
Self {
const_k: const_k.into(),
label,
key,
candidates: seeds.into(),
closest_k: Default::default(),
queried: Default::default(),
concurrency: concurrency.into(),
}
}
/// Invoke the recursive routing algorithm.
pub async fn route<R>(mut self, alg: &R) -> Result<Vec<PeerId>>
where
R: RoutingAlogrithm,
{
let concurrency = self.concurrency.into();
let mut unorderd = FuturesUnorderedMap::new();
while let Some(peer_id) = self.candidates.pop_front() {
loop {
if !self.queried.insert(peer_id) {
log::trace!(
"{}, queried peer_id={}",
self.label.unwrap_or("routing"),
peer_id
);
break;
}
if !self.is_closer(&peer_id) {
log::trace!(
"{}, farther peer_id={}",
self.label.unwrap_or("routing"),
peer_id
);
break;
}
log::debug!(
"{}, query peer_id={}",
self.label.unwrap_or("routing"),
peer_id
);
let fut = alg.route(&peer_id);
unorderd.insert(peer_id, fut);
break;
}
log::trace!(
"{}, candidates={} pending={} concurrency={}",
self.label.unwrap_or("routing"),
self.candidates.len(),
unorderd.len(),
concurrency
);
while (self.candidates.is_empty() && !unorderd.is_empty())
|| unorderd.len() == concurrency
{
let (peer_id, result) = unorderd.next().await.unwrap();
match result {
Ok(Routing::Closest(peers)) => {
log::trace!(
"{}, query peer_id={}, rx closest={}",
self.label.unwrap_or("routing"),
peer_id,
peers.len()
);
for peer_id in peers {
if self.queried.contains(&peer_id) {
continue;
}
if !self.is_closer(&peer_id) {
continue;
}
self.candidates.push_back(peer_id);
}
self.add_closest_k(peer_id);
}
Ok(Routing::Finished) => {
log::trace!(
"{}, query peer_id={}, done",
self.label.unwrap_or("routing"),
peer_id,
);
self.add_closest_k(peer_id);
return Ok(self.closest_k);
}
Err(err) => {
log::error!(
"{}, query peer_id={}, err={}",
self.label.unwrap_or("routing"),
peer_id,
err
);
}
}
}
}
return Ok(self.closest_k);
}
fn add_closest_k(&mut self, peer_id: PeerId) {
self.closest_k.push(peer_id);
self.closest_k.sort_by(|lhs, rhs| {
let lhs = KBucketKey::from(lhs).distance(self.key);
let rhs = KBucketKey::from(rhs).distance(self.key);
lhs.cmp(&rhs)
});
let const_k = self.const_k.into();
if self.closest_k.len() > const_k {
self.closest_k.truncate(const_k);
}
log::trace!(
"{}, update closest_k={}",
self.label.unwrap_or("routing"),
self.closest_k.len(),
);
}
fn is_closer(&self, peer_id: &PeerId) -> bool {
if self.closest_k.len() < self.const_k {
return true;
}
if let Some(last) = self.closest_k.last() {
let last_distance = KBucketKey::from(last).distance(self.key);
let distance = KBucketKey::from(peer_id).distance(self.key);
distance < last_distance
} else {
true
}
}
}
/// The configuration for creating [`KademliaRouter`] instance.
#[derive(Clone)]
pub struct KademliaOptions {
switch: Switch,
/// The kad record store.
store: Arc<KadStore>,
/// the maximum concurrency tasks that this route process can starts.
concurrency: NonZeroUsize,
}
impl KademliaOptions {
fn new(switch: Switch) -> Self {
Self {
switch,
store: Arc::new(KadMemoryStore::new().into()),
concurrency: NonZeroUsize::new(20).unwrap(),
}
}
}
impl KademliaOptions {
/// Set the maximum concurrency tasks that this route process can starts,
/// the default value is a `3`.
pub fn set_concurrency(mut self, value: NonZeroUsize) -> Self {
self.concurrency = value;
self
}
/// Set the [`KadStore`] instance used by the router,
/// the default value is a instance of [`KadMemoryStore`].
pub fn set_store<S>(mut self, value: S) -> Self
where
S: DriverKadStore + 'static,
{
self.store = Arc::new(value.into());
self
}
/// Create a new kad router instance with provides boostrap peer `seeds`.
pub async fn with_seeds<S, E>(self, seeds: S) -> Result<KademliaRouter>
where
S: IntoIterator,
S::Item: TryInto<Multiaddr, Error = E>,
E: Debug,
{
let mut peer_addrs = HashMap::<PeerId, Vec<Multiaddr>>::new();
for raddr in seeds.into_iter() {
let raddr = raddr
.try_into()
.map_err(|err| Error::Other(format!("{:?}", err)))?;
match raddr
.clone()
.pop()
.ok_or_else(|| Error::WithoutP2p(raddr.clone()))?
{
xstack::multiaddr::Protocol::P2p(id) => {
if let Some(addrs) = peer_addrs.get_mut(&id) {
addrs.push(raddr);
} else {
peer_addrs.insert(id, vec![raddr]);
}
}
_ => {
return Err(Error::WithoutP2p(raddr.clone()));
}
}
}
let k_bucket_table = KBucketTable::bind(&self.switch).await;
for (id, addrs) in peer_addrs {
k_bucket_table.insert(id).await;
let peer_info = PeerInfo {
id: id.clone(),
addrs,
..Default::default()
};
self.switch.insert_peer_info(peer_info).await?;
}
Ok(KademliaRouter {
ops: self,
k_bucket_table,
})
}
}
/// A network node that implement the [***ibp2p Kademlia DHT specification***]
///
/// [***ibp2p Kademlia DHT specification***]: https://github.com/libp2p/specs/tree/master/kad-dht
#[derive(Clone)]
pub struct KademliaRouter {
ops: KademliaOptions,
k_bucket_table: KBucketTable<20>,
}
impl KademliaRouter {
/// Create a new kad router instance.
#[cfg(feature = "global_register")]
#[cfg_attr(docsrs, doc(cfg(feature = "global_register")))]
pub fn new() -> KademliaOptions {
KademliaOptions::new(global_switch().clone())
}
/// Use provides `Switch` to create a new `KademliaRouter` instance.
pub fn with(switch: &Switch) -> KademliaOptions {
KademliaOptions::new(switch.clone())
}
/// Try get the routing path by [`PeerId`].
pub async fn find_node(&self, peer_id: &PeerId) -> Result<Option<PeerInfo>> {
let key = KBucketKey::from(peer_id);
let seeds = self.k_bucket_table.closest(key).await?;
let find_node = FindNode {
target: peer_id,
router: self,
};
Recursively::new(
Some("FIND_NODE"),
&key,
NonZeroUsize::new(20).unwrap(),
self.ops.concurrency,
seeds,
)
.route(&find_node)
.await?;
Ok(self.ops.switch.lookup_peer_info(peer_id).await?)
}
/// Returns the routing_table length.
pub fn len(&self) -> usize {
self.k_bucket_table.len()
}
}
/// FIND_NODE algorithm implementation.
pub struct FindNode<'a> {
target: &'a PeerId,
router: &'a KademliaRouter,
}
impl<'a> RoutingAlogrithm for FindNode<'a> {
fn route(
&self,
peer_id: &PeerId,
) -> impl Future<Output = std::io::Result<Routing>> + Send + 'static {
let peer_id = peer_id.clone();
let switch = self.router.ops.switch.clone();
let target = self.target.clone();
let max_packet_size = switch.max_packet_size;
let timeout = switch.timeout;
// let kbucket = self.router.kbucket.clone();
async move {
if peer_id == target {
return Ok(Routing::Finished);
}
let (stream, _) = switch
.connect(peer_id, [PROTOCOL_IPFS_KAD, PROTOCOL_IPFS_LAN_KAD])
.timeout(timeout)
.await
.ok_or(Error::Timeout)??;
let closest_k = stream
.kad_find_node(target.to_bytes(), max_packet_size)
.timeout(timeout)
.await
.ok_or(Error::Timeout)??;
let mut candidates = vec![];
let mut finished = false;
for peer_info in closest_k {
if peer_info.id == target {
finished = true;
}
candidates.push(peer_info.id);
switch.insert_peer_info(peer_info).await?;
}
if finished {
Ok(Routing::Finished)
} else {
Ok(Routing::Closest(candidates))
}
}
}
}