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
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
use std::borrow::Cow;
use std::collections::hash_map::Entry;
use std::collections::HashMap;
use std::ffi::{CStr, CString};
use std::future::Future;
use std::sync::Arc;
use std::time::Duration;
use std::{cmp, i32, ptr};
use crate::{
grpc_sys::{self, gpr_timespec, grpc_arg_pointer_vtable, grpc_channel, grpc_channel_args},
Deadline,
};
use libc::{self, c_char, c_int};
use crate::call::{Call, Method};
use crate::cq::CompletionQueue;
use crate::env::Environment;
use crate::error::Result;
use crate::task::CallTag;
use crate::task::Kicker;
use crate::CallOption;
use crate::ResourceQuota;
pub use crate::grpc_sys::{
grpc_compression_algorithm as CompressionAlgorithms,
grpc_compression_level as CompressionLevel, grpc_connectivity_state as ConnectivityState,
};
fn format_user_agent_string(agent: &str) -> CString {
let version = env!("CARGO_PKG_VERSION");
let trimed_agent = agent.trim();
let val = if trimed_agent.is_empty() {
format!("grpc-rust/{}", version)
} else {
format!("{} grpc-rust/{}", trimed_agent, version)
};
CString::new(val).unwrap()
}
fn dur_to_ms(dur: Duration) -> i32 {
let millis = dur.as_secs() * 1000 + dur.subsec_nanos() as u64 / 1_000_000;
cmp::min(i32::MAX as u64, millis) as i32
}
enum Options {
Integer(i32),
String(CString),
Pointer(ResourceQuota, *const grpc_arg_pointer_vtable),
}
#[derive(Clone, Copy)]
pub enum OptTarget {
Latency,
Blend,
Throughput,
}
#[derive(Clone, Copy)]
pub enum LbPolicy {
PickFirst,
RoundRobin,
}
pub struct ChannelBuilder {
env: Arc<Environment>,
options: HashMap<Cow<'static, [u8]>, Options>,
}
impl ChannelBuilder {
pub fn new(env: Arc<Environment>) -> ChannelBuilder {
ChannelBuilder {
env,
options: HashMap::new(),
}
}
pub fn default_authority<S: Into<Vec<u8>>>(mut self, authority: S) -> ChannelBuilder {
let authority = CString::new(authority).unwrap();
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_DEFAULT_AUTHORITY),
Options::String(authority),
);
self
}
pub fn set_resource_quota(mut self, quota: ResourceQuota) -> ChannelBuilder {
unsafe {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_RESOURCE_QUOTA),
Options::Pointer(quota, grpc_sys::grpc_resource_quota_arg_vtable()),
);
}
self
}
pub fn max_concurrent_stream(mut self, num: i32) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_MAX_CONCURRENT_STREAMS),
Options::Integer(num),
);
self
}
pub fn max_receive_message_len(mut self, len: i32) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH),
Options::Integer(len),
);
self
}
pub fn max_send_message_len(mut self, len: i32) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_MAX_SEND_MESSAGE_LENGTH),
Options::Integer(len),
);
self
}
pub fn max_reconnect_backoff(mut self, backoff: Duration) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_MAX_RECONNECT_BACKOFF_MS),
Options::Integer(dur_to_ms(backoff)),
);
self
}
pub fn initial_reconnect_backoff(mut self, backoff: Duration) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_INITIAL_RECONNECT_BACKOFF_MS),
Options::Integer(dur_to_ms(backoff)),
);
self
}
pub fn https_initial_seq_number(mut self, number: i32) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_HTTP2_INITIAL_SEQUENCE_NUMBER),
Options::Integer(number),
);
self
}
pub fn stream_initial_window_size(mut self, window_size: i32) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_HTTP2_STREAM_LOOKAHEAD_BYTES),
Options::Integer(window_size),
);
self
}
pub fn primary_user_agent(mut self, agent: &str) -> ChannelBuilder {
let agent_string = format_user_agent_string(agent);
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_PRIMARY_USER_AGENT_STRING),
Options::String(agent_string),
);
self
}
pub fn reuse_port(mut self, reuse: bool) -> ChannelBuilder {
let opt = if reuse { 1 } else { 0 };
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_ALLOW_REUSEPORT),
Options::Integer(opt),
);
self
}
pub fn tcp_read_chunk_size(mut self, bytes: i32) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_TCP_READ_CHUNK_SIZE),
Options::Integer(bytes),
);
self
}
pub fn tcp_min_read_chunk_size(mut self, bytes: i32) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_TCP_MIN_READ_CHUNK_SIZE),
Options::Integer(bytes),
);
self
}
pub fn tcp_max_read_chunk_size(mut self, bytes: i32) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_TCP_MAX_READ_CHUNK_SIZE),
Options::Integer(bytes),
);
self
}
pub fn http2_write_buffer_size(mut self, size: i32) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_HTTP2_WRITE_BUFFER_SIZE),
Options::Integer(size),
);
self
}
pub fn http2_max_frame_size(mut self, size: i32) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_HTTP2_MAX_FRAME_SIZE),
Options::Integer(size),
);
self
}
pub fn http2_bdp_probe(mut self, enable: bool) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_HTTP2_BDP_PROBE),
Options::Integer(enable as i32),
);
self
}
pub fn http2_min_sent_ping_interval_without_data(
mut self,
interval: Duration,
) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_HTTP2_MIN_SENT_PING_INTERVAL_WITHOUT_DATA_MS),
Options::Integer(dur_to_ms(interval)),
);
self
}
pub fn http2_min_recv_ping_interval_without_data(
mut self,
interval: Duration,
) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_HTTP2_MIN_RECV_PING_INTERVAL_WITHOUT_DATA_MS),
Options::Integer(dur_to_ms(interval)),
);
self
}
pub fn http2_max_pings_without_data(mut self, num: i32) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_HTTP2_MAX_PINGS_WITHOUT_DATA),
Options::Integer(num),
);
self
}
pub fn http2_max_ping_strikes(mut self, num: i32) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_HTTP2_MAX_PING_STRIKES),
Options::Integer(num),
);
self
}
pub fn default_compression_algorithm(mut self, algo: CompressionAlgorithms) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_COMPRESSION_CHANNEL_DEFAULT_ALGORITHM),
Options::Integer(algo as i32),
);
self
}
pub fn default_compression_level(mut self, level: CompressionLevel) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_COMPRESSION_CHANNEL_DEFAULT_LEVEL),
Options::Integer(level as i32),
);
self
}
pub fn keepalive_time(mut self, timeout: Duration) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_KEEPALIVE_TIME_MS),
Options::Integer(dur_to_ms(timeout)),
);
self
}
pub fn keepalive_timeout(mut self, timeout: Duration) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_KEEPALIVE_TIMEOUT_MS),
Options::Integer(dur_to_ms(timeout)),
);
self
}
pub fn keepalive_permit_without_calls(mut self, allow: bool) -> ChannelBuilder {
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_KEEPALIVE_PERMIT_WITHOUT_CALLS),
Options::Integer(allow as i32),
);
self
}
pub fn optimize_for(mut self, target: OptTarget) -> ChannelBuilder {
let val = match target {
OptTarget::Latency => CString::new("latency"),
OptTarget::Blend => CString::new("blend"),
OptTarget::Throughput => CString::new("throughput"),
};
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_OPTIMIZATION_TARGET),
Options::String(val.unwrap()),
);
self
}
pub fn load_balancing_policy(mut self, lb_policy: LbPolicy) -> ChannelBuilder {
let val = match lb_policy {
LbPolicy::PickFirst => CString::new("pick_first"),
LbPolicy::RoundRobin => CString::new("round_robin"),
};
self.options.insert(
Cow::Borrowed(grpcio_sys::GRPC_ARG_LB_POLICY_NAME),
Options::String(val.unwrap()),
);
self
}
#[doc(hidden)]
pub fn raw_cfg_int(mut self, key: CString, val: i32) -> ChannelBuilder {
self.options
.insert(Cow::Owned(key.into_bytes_with_nul()), Options::Integer(val));
self
}
#[doc(hidden)]
pub fn raw_cfg_string(mut self, key: CString, val: CString) -> ChannelBuilder {
self.options
.insert(Cow::Owned(key.into_bytes_with_nul()), Options::String(val));
self
}
#[allow(clippy::useless_conversion)]
#[allow(clippy::cmp_owned)]
pub fn build_args(&self) -> ChannelArgs {
let args = unsafe { grpc_sys::grpcwrap_channel_args_create(self.options.len()) };
for (i, (k, v)) in self.options.iter().enumerate() {
let key = k.as_ptr() as *const c_char;
match *v {
Options::Integer(val) => unsafe {
assert!(
val <= i32::from(libc::INT_MAX) && val >= i32::from(libc::INT_MIN),
"{} is out of range for {:?}",
val,
CStr::from_bytes_with_nul(k).unwrap()
);
grpc_sys::grpcwrap_channel_args_set_integer(args, i, key, val as c_int)
},
Options::String(ref val) => unsafe {
grpc_sys::grpcwrap_channel_args_set_string(args, i, key, val.as_ptr())
},
Options::Pointer(ref quota, vtable) => unsafe {
grpc_sys::grpcwrap_channel_args_set_pointer_vtable(
args,
i,
key,
quota.get_ptr() as _,
vtable,
)
},
}
}
ChannelArgs { args }
}
fn prepare_connect_args(&mut self) -> ChannelArgs {
if let Entry::Vacant(e) = self.options.entry(Cow::Borrowed(
grpcio_sys::GRPC_ARG_PRIMARY_USER_AGENT_STRING,
)) {
e.insert(Options::String(format_user_agent_string("")));
}
self.build_args()
}
pub fn connect(mut self, addr: &str) -> Channel {
let args = self.prepare_connect_args();
let addr = CString::new(addr).unwrap();
let addr_ptr = addr.as_ptr();
let channel =
unsafe { grpc_sys::grpc_insecure_channel_create(addr_ptr, args.args, ptr::null_mut()) };
unsafe { Channel::new(self.env.pick_cq(), self.env, channel) }
}
#[cfg(unix)]
pub unsafe fn connect_from_fd(mut self, target: &str, fd: ::std::os::raw::c_int) -> Channel {
let args = self.prepare_connect_args();
let target = CString::new(target).unwrap();
let target_ptr = target.as_ptr();
let channel = grpc_sys::grpc_insecure_channel_create_from_fd(target_ptr, fd, args.args);
Channel::new(self.env.pick_cq(), self.env, channel)
}
}
#[cfg(feature = "_secure")]
mod secure_channel {
use std::borrow::Cow;
use std::ffi::CString;
use std::ptr;
use crate::grpc_sys;
use crate::ChannelCredentials;
use super::{Channel, ChannelBuilder, Options};
const OPT_SSL_TARGET_NAME_OVERRIDE: &[u8] = b"grpc.ssl_target_name_override\0";
impl ChannelBuilder {
#[doc(hidden)]
pub fn override_ssl_target<S: Into<Vec<u8>>>(mut self, target: S) -> ChannelBuilder {
let target = CString::new(target).unwrap();
self.options.insert(
Cow::Borrowed(OPT_SSL_TARGET_NAME_OVERRIDE),
Options::String(target),
);
self
}
pub fn secure_connect(mut self, addr: &str, mut creds: ChannelCredentials) -> Channel {
let args = self.prepare_connect_args();
let addr = CString::new(addr).unwrap();
let addr_ptr = addr.as_ptr();
let channel = unsafe {
grpc_sys::grpc_secure_channel_create(
creds.as_mut_ptr(),
addr_ptr,
args.args,
ptr::null_mut(),
)
};
unsafe { Channel::new(self.env.pick_cq(), self.env, channel) }
}
}
}
pub struct ChannelArgs {
args: *mut grpc_channel_args,
}
impl ChannelArgs {
pub fn as_ptr(&self) -> *const grpc_channel_args {
self.args
}
}
impl Drop for ChannelArgs {
fn drop(&mut self) {
unsafe { grpc_sys::grpcwrap_channel_args_destroy(self.args) }
}
}
struct ChannelInner {
_env: Arc<Environment>,
channel: *mut grpc_channel,
}
impl ChannelInner {
fn check_connectivity_state(&self, try_to_connect: bool) -> ConnectivityState {
let should_try = if try_to_connect { 1 } else { 0 };
unsafe { grpc_sys::grpc_channel_check_connectivity_state(self.channel, should_try) }
}
}
impl Drop for ChannelInner {
fn drop(&mut self) {
unsafe {
grpc_sys::grpc_channel_destroy(self.channel);
}
}
}
#[derive(Clone)]
pub struct Channel {
inner: Arc<ChannelInner>,
cq: CompletionQueue,
}
#[allow(clippy::non_send_fields_in_send_ty)]
unsafe impl Send for Channel {}
unsafe impl Sync for Channel {}
impl Channel {
pub unsafe fn new(
cq: CompletionQueue,
env: Arc<Environment>,
channel: *mut grpc_channel,
) -> Channel {
Channel {
inner: Arc::new(ChannelInner { _env: env, channel }),
cq,
}
}
pub fn check_connectivity_state(&self, try_to_connect: bool) -> ConnectivityState {
self.inner.check_connectivity_state(try_to_connect)
}
pub fn wait_for_state_change(
&self,
last_observed: ConnectivityState,
deadline: impl Into<Deadline>,
) -> impl Future<Output = bool> {
let (cq_f, prom) = CallTag::action_pair();
let prom_box = Box::new(prom);
let tag = Box::into_raw(prom_box);
let should_wait = if let Ok(cq_ref) = self.cq.borrow() {
unsafe {
grpcio_sys::grpc_channel_watch_connectivity_state(
self.inner.channel,
last_observed,
deadline.into().spec(),
cq_ref.as_ptr(),
tag as *mut _,
)
}
true
} else {
false
};
async move { should_wait && cq_f.await.unwrap() }
}
pub async fn wait_for_connected(&self, deadline: impl Into<Deadline>) -> bool {
let mut state = self.check_connectivity_state(true);
if ConnectivityState::GRPC_CHANNEL_READY == state {
return true;
}
let deadline = deadline.into();
loop {
if self.wait_for_state_change(state, deadline).await {
state = self.check_connectivity_state(true);
match state {
ConnectivityState::GRPC_CHANNEL_READY => return true,
ConnectivityState::GRPC_CHANNEL_SHUTDOWN => return false,
_ => (),
}
continue;
}
return false;
}
}
pub(crate) fn create_kicker(&self) -> Result<Kicker> {
let cq_ref = self.cq.borrow()?;
let raw_call = unsafe {
let ch = self.inner.channel;
let cq = cq_ref.as_ptr();
let timeout = gpr_timespec::inf_future();
grpc_sys::grpcwrap_channel_create_call(
ch,
ptr::null_mut(),
0,
cq,
ptr::null(),
0,
ptr::null(),
0,
timeout,
)
};
let call = unsafe { Call::from_raw(raw_call, self.cq.clone()) };
Ok(Kicker::from_call(call))
}
pub(crate) fn create_call<Req, Resp>(
&self,
method: &Method<Req, Resp>,
opt: &CallOption,
) -> Result<Call> {
let cq_ref = self.cq.borrow()?;
let raw_call = unsafe {
let ch = self.inner.channel;
let cq = cq_ref.as_ptr();
let method_ptr = method.name.as_ptr();
let method_len = method.name.len();
let timeout = opt
.get_timeout()
.map_or_else(gpr_timespec::inf_future, gpr_timespec::from);
grpc_sys::grpcwrap_channel_create_call(
ch,
ptr::null_mut(),
0,
cq,
method_ptr as *const _,
method_len,
ptr::null(),
0,
timeout,
)
};
unsafe { Ok(Call::from_raw(raw_call, self.cq.clone())) }
}
pub(crate) fn cq(&self) -> &CompletionQueue {
&self.cq
}
}