forked from driftluo/tentacle
-
Notifications
You must be signed in to change notification settings - Fork 22
/
config.rs
486 lines (431 loc) · 13.2 KB
/
config.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
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
use crate::{
builder::{BeforeReceiveFn, CodecFn, NameFn, SelectVersionFn, SessionHandleFn},
traits::{Codec, ServiceProtocol, SessionProtocol},
yamux::config::Config as YamuxConfig,
ProtocolId, SessionId,
};
use std::collections::HashSet;
use std::sync::Arc;
use std::time::Duration;
/// Default max buffer size
const MAX_BUF_SIZE: usize = 24 * 1024 * 1024;
pub(crate) struct ServiceConfig {
pub timeout: Duration,
pub session_config: SessionConfig,
pub max_frame_length: usize,
/// event output or callback output
pub event: HashSet<ProtocolId>,
pub keep_buffer: bool,
pub upnp: bool,
pub max_connection_number: usize,
}
impl Default for ServiceConfig {
fn default() -> Self {
ServiceConfig {
timeout: Duration::from_secs(10),
session_config: SessionConfig::default(),
max_frame_length: 1024 * 1024 * 8,
event: HashSet::default(),
keep_buffer: false,
upnp: false,
max_connection_number: 65535,
}
}
}
#[derive(Clone, Copy)]
pub(crate) struct SessionConfig {
pub yamux_config: YamuxConfig,
/// default is 1Mb
pub send_buffer_size: usize,
/// default is 1Mb
pub recv_buffer_size: usize,
}
impl SessionConfig {
/// see https://github.com/rust-lang/rust/issues/57563
/// can't use `if` to filter out 0, so add one to avoid this case
pub const fn recv_event_size(&self) -> usize {
(self.recv_buffer_size / self.yamux_config.max_stream_window_size as usize) + 1
}
/// see https://github.com/rust-lang/rust/issues/57563
/// can't use `if` to filter out 0, so add one to avoid this case
pub const fn send_event_size(&self) -> usize {
(self.send_buffer_size / self.yamux_config.max_stream_window_size as usize) + 1
}
}
impl Default for SessionConfig {
fn default() -> Self {
SessionConfig {
recv_buffer_size: MAX_BUF_SIZE,
send_buffer_size: MAX_BUF_SIZE,
yamux_config: YamuxConfig::default(),
}
}
}
/// When dial, specify which protocol want to open
#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd)]
pub enum TargetProtocol {
/// Try open all protocol
All,
/// Try open one protocol
Single(ProtocolId),
/// Try open some protocol
Multi(Vec<ProtocolId>),
}
impl From<ProtocolId> for TargetProtocol {
fn from(id: ProtocolId) -> Self {
TargetProtocol::Single(id)
}
}
impl From<usize> for TargetProtocol {
fn from(id: usize) -> Self {
TargetProtocol::Single(id.into())
}
}
/// When sending a message, select the specified session
#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd)]
pub enum TargetSession {
/// Try broadcast
All,
/// Try send to only one
Single(SessionId),
/// Try send to some session
Multi(Vec<SessionId>),
}
impl From<SessionId> for TargetSession {
fn from(id: SessionId) -> Self {
TargetSession::Single(id)
}
}
impl From<usize> for TargetSession {
fn from(id: usize) -> Self {
TargetSession::Single(id.into())
}
}
/// Define the minimum data required for a custom protocol
pub struct ProtocolMeta {
pub(crate) inner: Arc<Meta>,
pub(crate) service_handle: ProtocolHandle<Box<dyn ServiceProtocol + Send + 'static + Unpin>>,
pub(crate) session_handle: SessionHandleFn,
pub(crate) before_send: Option<Box<dyn Fn(bytes::Bytes) -> bytes::Bytes + Send + 'static>>,
pub(crate) flag: BlockingFlag,
}
impl ProtocolMeta {
/// Protocol id
#[inline]
pub fn id(&self) -> ProtocolId {
self.inner.id
}
/// Protocol name, default is "/p2p/protocol_id"
#[inline]
pub fn name(&self) -> String {
(self.inner.name)(self.inner.id)
}
/// Protocol supported version
#[inline]
pub fn support_versions(&self) -> Vec<String> {
self.inner.support_versions.clone()
}
/// The codec used by the custom protocol, such as `LengthDelimitedCodec` by tokio
#[inline]
pub fn codec(&self) -> Box<dyn Codec + Send + 'static> {
(self.inner.codec)()
}
/// A service level callback handle for a protocol.
///
/// ---
///
/// #### Behavior
///
/// This function is called when the protocol is first opened in the service
/// and remains in memory until the entire service is closed.
///
/// #### Warning
///
/// Only can be called once, and will return `ProtocolHandle::Neither` or later.
#[inline]
pub fn service_handle(
&mut self,
) -> ProtocolHandle<Box<dyn ServiceProtocol + Send + 'static + Unpin>> {
::std::mem::replace(&mut self.service_handle, ProtocolHandle::Neither)
}
/// A session level callback handle for a protocol.
///
/// ---
///
/// #### Behavior
///
/// When a session is opened, whenever the protocol of the session is opened,
/// the function will be called again to generate the corresponding exclusive handle.
///
/// Correspondingly, whenever the protocol is closed, the corresponding exclusive handle is cleared.
#[inline]
pub fn session_handle(
&mut self,
) -> ProtocolHandle<Box<dyn SessionProtocol + Send + 'static + Unpin>> {
(self.session_handle)()
}
/// Control whether the protocol handle method requires blocking to run
pub fn blocking_flag(&self) -> BlockingFlag {
self.flag
}
}
pub(crate) struct Meta {
pub(crate) id: ProtocolId,
pub(crate) name: NameFn,
pub(crate) support_versions: Vec<String>,
pub(crate) codec: CodecFn,
pub(crate) select_version: SelectVersionFn,
pub(crate) before_receive: BeforeReceiveFn,
}
/// Protocol handle Contains four modes, each of which has a corresponding behavior,
/// please carefully consider which mode should be used in the protocol
pub enum ProtocolHandle<T: Sized> {
/// No operation: Receive messages, but do not process, silently discard
Neither,
/// Event output: It is only received through the `ServiceHandle::handle_proto` interface.
/// Any protocol that registers this mode will pass the protocol behavior out of the interface.
/// Therefore, this makes the interface a single point of performance bottleneck.
/// Please carefully consider whether you need to use this behavior mode.
Event,
/// Both event and callback: This is the result of permutation and combination, but this mode is generally not recommended.
/// It makes a copy of all protocol data and outputs it to both the Event and Callback receivers.
/// This means that it not only has a single point of performance problems,
/// but also has data replication consumption and redundant execution actions
///
/// ---
///
/// By the way, if a protocol registers `ServiceProtocol` and `SessionProtocol` at the same time,
/// it is also sent to two receiving ends at the same time, and if use both mode, there will be three copies
Both(T),
/// Callback handle: The behavior of receiving the protocol through the corresponding
/// `ServiceProtocol` or `SessionProtocol`, according to the registered trait, has different
/// behaviors, each has its own advantages and disadvantages, please carefully consider.
/// This is also the recommended way to use this crate.
Callback(T),
}
impl<T> ProtocolHandle<T> {
/// Returns true if the enum is a callback value.
#[inline]
pub fn is_callback(&self) -> bool {
if let ProtocolHandle::Callback(_) = self {
true
} else {
false
}
}
/// Returns true if the enum is a empty value.
#[inline]
pub fn is_neither(&self) -> bool {
if let ProtocolHandle::Neither = self {
true
} else {
false
}
}
/// Returns true if the enum is a event value.
#[inline]
pub fn is_event(&self) -> bool {
if let ProtocolHandle::Event = self {
true
} else {
false
}
}
/// Returns true if the enum is a both value.
#[inline]
pub fn is_both(&self) -> bool {
if let ProtocolHandle::Both(_) = self {
true
} else {
false
}
}
/// Returns true if the enum is a both value.
#[inline]
pub fn has_event(&self) -> bool {
self.is_event() || self.is_both()
}
}
/// Control whether the protocol handle method requires blocking to run
/// default is 0b1111, all function use blocking
///
/// flag & 0b1000 > 0 means `connected` use blocking
/// flag & 0b0100 > 0 means `disconnected` use blocking
/// flag & 0b0010 > 0 means `received` use blocking
/// flag & 0b0001 > 0 means `notify` use blocking
#[derive(Copy, Clone, Debug)]
pub struct BlockingFlag(u8);
impl BlockingFlag {
/// connected don't use blocking
#[inline]
pub fn disable_connected(&mut self) {
self.0 &= 0b0111
}
/// disconnected don't use blocking
#[inline]
pub fn disable_disconnected(&mut self) {
self.0 &= 0b1011
}
/// received don't use blocking
#[inline]
pub fn disable_received(&mut self) {
self.0 &= 0b1101
}
/// notify don't use blocking
pub fn disable_notify(&mut self) {
self.0 &= 0b1110
}
/// all function use blocking
#[inline]
pub fn enable_all(&mut self) {
self.0 |= 0b1111
}
/// all function don't use blocking
#[inline]
pub fn disable_all(&mut self) {
self.0 &= 0b0000
}
/// return true if connected enable
#[inline]
pub const fn connected(self) -> bool {
self.0 & 0b1000 > 0
}
/// return true if disconnected enable
#[inline]
pub const fn disconnected(self) -> bool {
self.0 & 0b0100 > 0
}
/// return true if received enable
#[inline]
pub const fn received(self) -> bool {
self.0 & 0b0010 > 0
}
/// return true if notify enable
#[inline]
pub const fn notify(self) -> bool {
self.0 & 0b0001 > 0
}
}
impl Default for BlockingFlag {
fn default() -> Self {
BlockingFlag(0b1111)
}
}
impl From<u8> for BlockingFlag {
fn from(inner: u8) -> BlockingFlag {
BlockingFlag(inner)
}
}
/// Service state
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
pub enum State {
/// Calculate the number of connection requests that need to be sent externally
Running(usize),
Forever,
PreShutdown,
}
impl State {
/// new
pub fn new(forever: bool) -> Self {
if forever {
State::Forever
} else {
State::Running(0)
}
}
/// Can it be shutdown?
#[inline]
pub fn is_shutdown(&self) -> bool {
match self {
State::Running(num) if num == &0 => true,
State::PreShutdown => true,
State::Running(_) | State::Forever => false,
}
}
/// Convert to pre shutdown state
#[inline]
pub fn pre_shutdown(&mut self) {
*self = State::PreShutdown
}
/// Add one task count
#[inline]
pub fn increase(&mut self) {
match self {
State::Running(num) => *num += 1,
State::PreShutdown | State::Forever => (),
}
}
/// Reduce one task count
#[inline]
pub fn decrease(&mut self) {
match self {
State::Running(num) => *num -= 1,
State::PreShutdown | State::Forever => (),
}
}
#[inline]
pub fn into_inner(self) -> Option<usize> {
match self {
State::Running(num) => Some(num),
State::PreShutdown | State::Forever => None,
}
}
}
#[cfg(test)]
mod test {
use super::{BlockingFlag, State};
#[test]
fn test_state_no_forever() {
let mut state = State::new(false);
state.increase();
state.increase();
assert_eq!(state, State::Running(2));
state.decrease();
state.decrease();
assert_eq!(state, State::Running(0));
state.increase();
state.increase();
state.increase();
state.increase();
state.pre_shutdown();
assert_eq!(state, State::PreShutdown);
}
#[test]
fn test_state_forever() {
let mut state = State::new(true);
state.increase();
state.increase();
assert_eq!(state, State::Forever);
state.decrease();
state.decrease();
assert_eq!(state, State::Forever);
state.increase();
state.increase();
state.increase();
state.increase();
state.pre_shutdown();
assert_eq!(state, State::PreShutdown);
}
#[test]
fn test_proto_flag() {
let mut p = BlockingFlag::default();
assert_eq!(p.connected(), true);
assert_eq!(p.disconnected(), true);
assert_eq!(p.received(), true);
assert_eq!(p.notify(), true);
p.disable_connected();
assert_eq!(p.connected(), false);
p.disable_disconnected();
assert_eq!(p.disconnected(), false);
p.disable_received();
assert_eq!(p.received(), false);
p.disable_notify();
assert_eq!(p.notify(), false);
p.enable_all();
p.disable_all();
assert_eq!(p.connected(), false);
assert_eq!(p.disconnected(), false);
assert_eq!(p.received(), false);
assert_eq!(p.notify(), false);
}
}