p2p_channel 0.5.0

Simple, fast and easy Nat traversal for peer-to-peer
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
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
use std::hash::Hash;
use std::io;
use std::io::{Error, ErrorKind};
use std::net::{Ipv4Addr, SocketAddr, UdpSocket};
use std::sync::atomic::{AtomicI64, AtomicU64, Ordering};
use std::sync::Arc;
use std::time::Duration;

use crossbeam::atomic::AtomicCell;
use crossbeam::channel::{Sender as PunchSender, TrySendError};
use crossbeam::sync::Unparker;
use crossbeam_skiplist::SkipMap;
use dashmap::DashMap;
use mio::net::UdpSocket as MioUdpSocket;
use mio::{Events, Interest, Poll, Token, Waker};
use parking_lot::{Mutex, RwLock};

use crate::channel::sender::{SendAll, Sender};
use crate::punch::{NatInfo, NatType};
use crate::stun::socket::LocalInterface;

pub mod sender;

#[derive(Copy, Clone, Debug)]
pub struct Route {
    index: usize,
    pub addr: SocketAddr,
    pub metric: u8,
    pub rt: i64,
}

impl Route {
    pub fn new(index: usize, addr: SocketAddr, metric: u8, rt: i64) -> Self {
        Self {
            index,
            addr,
            metric,
            rt,
        }
    }
    pub fn from(route_key: RouteKey, metric: u8, rt: i64) -> Self {
        Self {
            index: route_key.index,
            addr: route_key.addr,
            metric,
            rt,
        }
    }
    pub fn route_key(&self) -> RouteKey {
        RouteKey {
            index: self.index,
            addr: self.addr,
        }
    }
}

#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
pub struct RouteKey {
    index: usize,
    pub addr: SocketAddr,
}

impl RouteKey {
    pub(crate) fn new(index: usize, addr: SocketAddr) -> Self {
        Self { index, addr }
    }
}

#[derive(Copy, Clone, Eq, PartialEq)]
pub(crate) enum Status {
    Cone,
    Symmetric,
    Close,
}

pub struct Channel<ID> {
    channel_flag_gen: Arc<AtomicU64>,
    channel_flag: u64,
    src_default_udp: UdpSocket,
    default_udp: MioUdpSocket,
    share_info: Arc<RwLock<Vec<UdpSocket>>>,
    udp_list: Vec<MioUdpSocket>,
    direct_route_table: Arc<DashMap<ID, Route>>,
    direct_route_table_time: Arc<SkipMap<RouteKey, (Mutex<Vec<ID>>, AtomicI64, AtomicI64)>>,
    poll: Poll,
    change_waker_list: Arc<Mutex<Vec<(u64, Waker)>>>,
    events: Events,
    size: usize,
    status: Arc<AtomicCell<Status>>,
    cone_sender: PunchSender<(ID, NatInfo)>,
    symmetric_sender: PunchSender<(ID, NatInfo)>,
    lock: Arc<Mutex<()>>,
    un_parker: Unparker,
}

impl<ID> Drop for Channel<ID> {
    fn drop(&mut self) {
        let mut guard = self.change_waker_list.lock();
        let channel_flag = self.channel_flag;
        guard.retain(|(flag, _)| *flag != channel_flag);
    }
}

const DEFAULT_TOKEN_INDEX: usize = 10_0000;
const DEFAULT_TOKEN: Token = Token(DEFAULT_TOKEN_INDEX);
const CHANGE_TOKEN: Token = Token(10_0001);

impl<ID: Eq + Hash> Channel<ID> {
    pub(crate) fn new(
        size: usize,
        cone_sender: PunchSender<(ID, NatInfo)>,
        symmetric_sender: PunchSender<(ID, NatInfo)>,
        direct_route_table_time: Arc<SkipMap<RouteKey, (Mutex<Vec<ID>>, AtomicI64, AtomicI64)>>,
        un_parker: Unparker,
        status: Arc<AtomicCell<Status>>,
    ) -> io::Result<Channel<ID>> {
        let channel_flag_gen = Arc::new(AtomicU64::new(1));
        let channel_flag = 0;
        let src_default_udp = UdpSocket::bind("0.0.0.0:0")?;
        src_default_udp.set_nonblocking(true)?;
        let mut default_udp = MioUdpSocket::from_std(src_default_udp.try_clone()?);
        let share_info = Arc::new(RwLock::new(Vec::with_capacity(size)));
        let udp_list = Vec::with_capacity(size);
        let direct_route_table = Arc::new(DashMap::with_capacity(64));
        let poll = Poll::new()?;
        let waker = Waker::new(poll.registry(), CHANGE_TOKEN)?;
        poll.registry()
            .register(&mut default_udp, DEFAULT_TOKEN, Interest::READABLE)?;
        let mut change_waker_list = Vec::with_capacity(16);
        change_waker_list.push((channel_flag, waker));
        let change_waker_list = Arc::new(Mutex::new(change_waker_list));
        let events = Events::with_capacity(256);
        let size = size;
        let lock = Arc::new(Mutex::new(()));
        Ok(Channel {
            channel_flag_gen,
            channel_flag,
            src_default_udp,
            default_udp,
            share_info,
            udp_list,
            direct_route_table,
            direct_route_table_time,
            poll,
            change_waker_list,
            events,
            size,
            status,
            cone_sender,
            symmetric_sender,
            lock,
            un_parker,
        })
    }
    pub fn sender(&self) -> io::Result<Sender<ID>> {
        Ok(Sender {
            src_default_udp: self.src_default_udp.try_clone()?,
            share_info: self.share_info.clone(),
            direct_route_table: self.direct_route_table.clone(),
            direct_route_table_time: self.direct_route_table_time.clone(),
            status: self.status.clone(),
            un_parker: self.un_parker.clone(),
            lock: self.lock.clone(),
        })
    }
    pub fn try_clone(&self) -> io::Result<Channel<ID>> {
        let channel_flag_gen = self.channel_flag_gen.clone();
        let channel_flag = channel_flag_gen.fetch_add(1, Ordering::Relaxed);
        let src_default_udp = self.src_default_udp.try_clone()?;
        let mut default_udp = MioUdpSocket::from_std(src_default_udp.try_clone()?);
        let share_info = self.share_info.clone();
        let mut udp_list = Vec::with_capacity(self.size);
        let direct_route_table = self.direct_route_table.clone();
        let direct_route_table_time = self.direct_route_table_time.clone();
        let poll = Poll::new()?;
        let waker = Waker::new(poll.registry(), CHANGE_TOKEN)?;
        poll.registry()
            .register(&mut default_udp, DEFAULT_TOKEN, Interest::READABLE)?;
        let change_waker_list = self.change_waker_list.clone();
        change_waker_list.lock().push((channel_flag, waker));
        let events = Events::with_capacity(256);
        let size = self.size;
        let status = self.status.clone();
        let cone_sender = self.cone_sender.clone();
        let symmetric_sender = self.symmetric_sender.clone();
        Channel::<ID>::change(&status, &share_info, &mut udp_list, &poll, size)?;
        let lock = self.lock.clone();
        let un_parker = self.un_parker.clone();
        let channel = Channel {
            channel_flag_gen,
            channel_flag,
            src_default_udp,
            default_udp,
            share_info,
            udp_list,
            direct_route_table,
            direct_route_table_time,
            poll,
            change_waker_list,
            events,
            size,
            status,
            cone_sender,
            symmetric_sender,
            lock,
            un_parker,
        };
        Ok(channel)
    }
}

impl<ID> Channel<ID> {
    #[inline]
    fn update_time(
        direct_route_table_time: &SkipMap<RouteKey, (Mutex<Vec<ID>>, AtomicI64, AtomicI64)>,
        route: &RouteKey,
    ) {
        if let Some(time) = direct_route_table_time.get(route) {
            time.value()
                .1
                .store(chrono::Local::now().timestamp_millis(), Ordering::Relaxed);
        }
    }
    #[inline]
    fn udp_recv_(
        direct_route_table_time: &SkipMap<RouteKey, (Mutex<Vec<ID>>, AtomicI64, AtomicI64)>,
        udp: &MioUdpSocket,
        index: usize,
        buf: &mut [u8],
    ) -> Option<io::Result<(usize, RouteKey)>> {
        return match udp.recv_from(buf) {
            Ok((len, addr)) => {
                let route = RouteKey::new(index, addr);
                Self::update_time(direct_route_table_time, &route);
                Some(Ok((len, RouteKey::new(index, addr))))
            }
            Err(e) => {
                if e.kind() != ErrorKind::WouldBlock {
                    return Some(Err(e));
                }
                None
            }
        };
    }
    /// 接收数据
    /// 如果当前是对称网络,将监听一组udp socket,提高打洞效率
    pub fn recv_from(
        &mut self,
        buf: &mut [u8],
        timeout: Option<Duration>,
    ) -> io::Result<(usize, RouteKey)> {
        loop {
            if let Some(rs) = Self::udp_recv_(
                &self.direct_route_table_time,
                &self.default_udp,
                DEFAULT_TOKEN_INDEX,
                buf,
            ) {
                return rs;
            }
            for index in 0..self.udp_list.len() {
                if let Some(rs) = Self::udp_recv_(
                    &self.direct_route_table_time,
                    &self.udp_list[index],
                    index,
                    buf,
                ) {
                    return rs;
                }
            }
            self.poll.poll(&mut self.events, timeout)?;
            for event in self.events.iter() {
                let (index, udp) = match event.token() {
                    DEFAULT_TOKEN => (DEFAULT_TOKEN_INDEX, &self.default_udp),
                    CHANGE_TOKEN => {
                        Channel::<ID>::change(
                            &self.status,
                            &self.share_info,
                            &mut self.udp_list,
                            &self.poll,
                            self.size,
                        )?;
                        continue;
                    }
                    Token(index) => {
                        if let Some(udp) = self.udp_list.get(index) {
                            (index, udp)
                        } else {
                            continue;
                        }
                    }
                };
                if let Some(rs) = Self::udp_recv_(&self.direct_route_table_time, &udp, index, buf) {
                    return rs;
                }
            }
        }
    }

    fn change(
        status: &AtomicCell<Status>,
        share_info: &RwLock<Vec<UdpSocket>>,
        udp_list: &mut Vec<MioUdpSocket>,
        poll: &Poll,
        size: usize,
    ) -> io::Result<()> {
        match status.load() {
            Status::Cone => {
                let mut list = share_info.write();
                for udp in udp_list.iter_mut() {
                    let _ = poll.registry().deregister(udp);
                }
                udp_list.clear();
                list.clear();
                drop(list);
            }
            Status::Symmetric => {
                let mut list = share_info.write();
                for udp in udp_list.iter_mut() {
                    let _ = poll.registry().deregister(udp);
                }
                udp_list.clear();
                if list.is_empty() {
                    for _ in 0..size {
                        let udp = UdpSocket::bind("0.0.0.0:0")?;
                        // println!("list  {:?}", udp.local_addr()?);
                        udp.set_nonblocking(true)?;
                        list.push(udp);
                    }
                }
                let mut token = 0;
                for udp in list.iter() {
                    let mut mio_udp = MioUdpSocket::from_std(udp.try_clone()?);
                    let _ =
                        poll.registry()
                            .register(&mut mio_udp, Token(token), Interest::READABLE);
                    udp_list.push(mio_udp);
                    token += 1;
                }
            }
            Status::Close => {
                return Err(Error::new(ErrorKind::Other, "channel close"));
            }
        }
        Ok(())
    }
}

impl<ID: Hash + Eq + Clone + Send + 'static> Channel<ID> {
    /// 添加路由
    pub fn add_route(&self, id: ID, route: Route) {
        Sender::<ID>::add_route_(
            id,
            route,
            &self.lock,
            &self.direct_route_table_time,
            &self.direct_route_table,
            &self.un_parker,
        );
    }
    /// 更新路由信息
    pub fn update_route(&self, id: &ID, metric: u8, rt: i64) {
        Sender::<ID>::update_route_(id, metric, rt, &self.direct_route_table)
    }
    /// 查询路由
    pub fn route(&self, id: &ID) -> Option<Route> {
        Sender::<ID>::route_(id, &self.direct_route_table)
    }
    /// 删除路由
    pub fn remove_route(&self, id: &ID) {
        Sender::<ID>::remove_route_(
            id,
            &self.lock,
            &self.direct_route_table_time,
            &self.direct_route_table,
        );
    }
    /// 查第一个id
    pub fn route_to_id(&self, route_key: &RouteKey) -> Option<ID> {
        Sender::<ID>::route_to_id_(route_key, &self.direct_route_table_time)
    }
    /// 查路由表
    pub fn route_table(&self) -> Vec<(ID, Route)> {
        Sender::<ID>::route_table_(&self.direct_route_table)
    }
}

impl<ID: Hash + Eq + Clone> Channel<ID> {
    /// 发送到指定id
    pub fn send_to_id(&self, buf: &[u8], id: &ID) -> io::Result<usize> {
        match self.direct_route_table.get(id) {
            None => Err(Error::new(ErrorKind::Other, "not fount")),
            Some(e) => self.send_to_route(buf, &e.value().route_key()),
        }
    }
    /// 发送到指定路由
    pub fn send_to_route(&self, buf: &[u8], route_key: &RouteKey) -> io::Result<usize> {
        if let Some(time) = self.direct_route_table_time.get(&route_key) {
            let now = chrono::Local::now().timestamp_millis();
            time.value().2.store(now, Ordering::Relaxed);
        }
        if route_key.index == DEFAULT_TOKEN_INDEX {
            self.src_default_udp.send_all(buf, route_key.addr)
        } else {
            if let Some(udp) = self.udp_list.get(route_key.index) {
                udp.send_all(buf, route_key.addr)
            } else {
                Err(Error::new(ErrorKind::Other, "not fount"))
            }
        }
    }
    /// 发送到指定地址,将使用默认udpSocket发送
    pub fn send_to_addr(&self, buf: &[u8], addr: SocketAddr) -> io::Result<usize> {
        if self.is_close() {
            return Err(Error::new(ErrorKind::Other, "closed"));
        }
        self.src_default_udp.send_all(buf, addr)
    }
    /// 添加到打洞队列
    pub fn punch(&self, peer_id: ID, nat_info: NatInfo) -> io::Result<()> {
        let rs;
        match nat_info.nat_type {
            NatType::Symmetric => {
                rs = self.symmetric_sender.try_send((peer_id, nat_info));
            }
            NatType::Cone => {
                rs = self.cone_sender.try_send((peer_id, nat_info));
            }
        }
        if let Err(e) = rs {
            return match e {
                TrySendError::Full(_) => Err(Error::new(ErrorKind::Other, "busy")),
                TrySendError::Disconnected(_) => Err(Error::new(ErrorKind::Other, "closed")),
            };
        }
        Ok(())
    }
    /// 设置当前设备所处的NAT类型
    pub fn set_nat_type(&self, nat_type: NatType) -> io::Result<()> {
        let guard = self.change_waker_list.lock();
        match self.status.load() {
            Status::Cone => {
                if nat_type == NatType::Symmetric {
                    self.status.store(Status::Symmetric);
                } else {
                    return Ok(());
                }
            }
            Status::Symmetric => {
                if nat_type == NatType::Cone {
                    self.status.store(Status::Cone);
                } else {
                    return Ok(());
                }
            }
            Status::Close => {
                return Err(Error::new(ErrorKind::Other, "closed"));
            }
        }
        for (_, waker) in guard.iter() {
            waker.wake()?;
        }
        Ok(())
    }

    /// 通过stun服务器检测并设定本地Nat类型
    pub fn set_nat_type_with_stun(
        &self,
        stun_servers: Vec<String>,
        default_interface: Option<LocalInterface>,
    ) -> io::Result<(NatType, Vec<Ipv4Addr>, u16)> {
        let (nat_type, public_ips, port_range) =
            crate::stun::stun_test_nat(stun_servers, default_interface.as_ref())
                .map_err(|e| std::io::Error::other(e.to_string()))?;
        self.set_nat_type(nat_type)?;
        Ok((nat_type, public_ips, port_range))
    }

    pub fn nat_type(&self) -> io::Result<NatType> {
        match self.status.load() {
            Status::Cone => Ok(NatType::Cone),
            Status::Symmetric => Ok(NatType::Symmetric),
            Status::Close => Err(Error::new(ErrorKind::Other, "closed")),
        }
    }
    /// 关闭通道,recv将返回Err
    pub fn close(&self) -> io::Result<()> {
        let guard = self.change_waker_list.lock();
        self.status.store(Status::Close);
        self.un_parker.unpark();
        for (_, waker) in guard.iter() {
            waker.wake()?;
        }
        Ok(())
    }
    pub fn is_close(&self) -> bool {
        self.status.load() == Status::Close
    }
    pub fn local_addr(&self) -> io::Result<SocketAddr> {
        self.src_default_udp.local_addr()
    }
}