forked from nanomsg/nng
-
Notifications
You must be signed in to change notification settings - Fork 0
/
socket.c
1719 lines (1472 loc) · 38.9 KB
/
socket.c
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
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//
// Copyright 2019 Staysail Systems, Inc. <[email protected]>
// Copyright 2018 Capitar IT Group BV <[email protected]>
//
// This software is supplied under the terms of the MIT License, a
// copy of which should be located in the distribution where this
// file was obtained (LICENSE.txt). A copy of the license may also be
// found online at https://opensource.org/licenses/MIT.
//
#include "core/nng_impl.h"
#include "sockimpl.h"
#include <stdio.h>
#include <string.h>
// Socket implementation.
static nni_list sock_list;
static nni_idhash *sock_hash;
static nni_mtx sock_lk;
static nni_idhash *ctx_hash;
struct nni_ctx {
nni_list_node c_node;
nni_sock * c_sock;
nni_proto_ctx_ops c_ops;
void * c_data;
bool c_closed;
unsigned c_refcnt; // protected by global lock
uint32_t c_id;
nng_duration c_sndtimeo;
nng_duration c_rcvtimeo;
};
typedef struct nni_sockopt {
nni_list_node node;
char * name;
nni_type typ;
size_t sz;
void * data;
} nni_sockopt;
typedef struct nni_sock_pipe_cb {
nng_pipe_cb cb_fn;
void * cb_arg;
} nni_sock_pipe_cb;
typedef struct sock_stats {
nni_stat_item s_root; // socket scope
nni_stat_item s_id; // socket id
nni_stat_item s_name; // socket name
nni_stat_item s_protocol; // socket protocol
nni_stat_item s_ndialers; // number of dialers
nni_stat_item s_nlisteners; // number of listeners
nni_stat_item s_npipes; // number of pipes
nni_stat_item s_rxbytes; // number of bytes received
nni_stat_item s_txbytes; // number of bytes received
nni_stat_item s_rxmsgs; // number of msgs received
nni_stat_item s_txmsgs; // number of msgs sent
nni_stat_item s_reject; // pipes rejected
} sock_stats;
struct nni_socket {
nni_list_node s_node;
nni_mtx s_mx;
nni_cv s_cv;
nni_cv s_close_cv;
uint32_t s_id;
uint32_t s_flags;
unsigned s_refcnt; // protected by global lock
void * s_data; // Protocol private
nni_msgq *s_uwq; // Upper write queue
nni_msgq *s_urq; // Upper read queue
nni_proto_id s_self_id;
nni_proto_id s_peer_id;
nni_proto_pipe_ops s_pipe_ops;
nni_proto_sock_ops s_sock_ops;
nni_proto_ctx_ops s_ctx_ops;
// options
nni_duration s_sndtimeo; // send timeout
nni_duration s_rcvtimeo; // receive timeout
nni_duration s_reconn; // reconnect time
nni_duration s_reconnmax; // max reconnect time
size_t s_rcvmaxsz; // max receive size
nni_list s_options; // opts not handled by sock/proto
char s_name[64]; // socket name (legacy compat)
char s_scope[24]; // socket scope ("socket%u", 32 bits max)
nni_list s_listeners; // active listeners
nni_list s_dialers; // active dialers
nni_list s_pipes; // active pipes
nni_list s_ctxs; // active contexts (protected by global sock_lk)
bool s_closing; // Socket is closing
bool s_closed; // Socket closed, protected by global lock
bool s_ctxwait; // Waiting for contexts to close.
nni_mtx s_pipe_cbs_mtx;
nni_sock_pipe_cb s_pipe_cbs[NNG_PIPE_EV_NUM];
sock_stats s_stats;
};
static void nni_ctx_destroy(nni_ctx *);
static void dialer_shutdown_locked(nni_dialer *);
static void listener_shutdown_locked(nni_listener *);
#define SOCK(s) ((nni_sock *) (s))
static int
sock_get_fd(void *s, int flag, int *fdp)
{
int rv;
nni_pollable *p;
if ((flag & nni_sock_flags(SOCK(s))) == 0) {
return (NNG_ENOTSUP);
}
switch (flag) {
case NNI_PROTO_FLAG_SND:
rv = nni_msgq_get_sendable(SOCK(s)->s_uwq, &p);
break;
case NNI_PROTO_FLAG_RCV:
rv = nni_msgq_get_recvable(SOCK(s)->s_urq, &p);
break;
default:
rv = NNG_EINVAL;
break;
}
if (rv == 0) {
rv = nni_pollable_getfd(p, fdp);
}
return (rv);
}
static int
sock_get_sendfd(void *s, void *buf, size_t *szp, nni_type t)
{
int fd;
int rv;
if ((rv = sock_get_fd(SOCK(s), NNI_PROTO_FLAG_SND, &fd)) != 0) {
return (rv);
}
return (nni_copyout_int(fd, buf, szp, t));
}
static int
sock_get_recvfd(void *s, void *buf, size_t *szp, nni_type t)
{
int fd;
int rv;
if ((rv = sock_get_fd(SOCK(s), NNI_PROTO_FLAG_RCV, &fd)) != 0) {
return (rv);
}
return (nni_copyout_int(fd, buf, szp, t));
}
static int
sock_get_raw(void *s, void *buf, size_t *szp, nni_type t)
{
bool raw = ((nni_sock_flags(SOCK(s)) & NNI_PROTO_FLAG_RAW) != 0);
return (nni_copyout_bool(raw, buf, szp, t));
}
static int
sock_set_recvtimeo(void *s, const void *buf, size_t sz, nni_type t)
{
return (nni_copyin_ms(&SOCK(s)->s_rcvtimeo, buf, sz, t));
}
static int
sock_get_recvtimeo(void *s, void *buf, size_t *szp, nni_type t)
{
return (nni_copyout_ms(SOCK(s)->s_rcvtimeo, buf, szp, t));
}
static int
sock_set_sendtimeo(void *s, const void *buf, size_t sz, nni_type t)
{
return (nni_copyin_ms(&SOCK(s)->s_sndtimeo, buf, sz, t));
}
static int
sock_get_sendtimeo(void *s, void *buf, size_t *szp, nni_type t)
{
return (nni_copyout_ms(SOCK(s)->s_sndtimeo, buf, szp, t));
}
static int
sock_set_recvbuf(void *s, const void *buf, size_t sz, nni_type t)
{
int len;
int rv;
if ((rv = nni_copyin_int(&len, buf, sz, 0, 8192, t)) != 0) {
return (rv);
}
return (nni_msgq_resize(SOCK(s)->s_urq, len));
}
static int
sock_get_recvbuf(void *s, void *buf, size_t *szp, nni_type t)
{
int len = nni_msgq_cap(SOCK(s)->s_urq);
return (nni_copyout_int(len, buf, szp, t));
}
static int
sock_set_sendbuf(void *s, const void *buf, size_t sz, nni_type t)
{
int len;
int rv;
if ((rv = nni_copyin_int(&len, buf, sz, 0, 8192, t)) != 0) {
return (rv);
}
return (nni_msgq_resize(SOCK(s)->s_uwq, len));
}
static int
sock_get_sendbuf(void *s, void *buf, size_t *szp, nni_type t)
{
int len = nni_msgq_cap(SOCK(s)->s_uwq);
return (nni_copyout_int(len, buf, szp, t));
}
static int
sock_get_sockname(void *s, void *buf, size_t *szp, nni_type t)
{
return (nni_copyout_str(SOCK(s)->s_name, buf, szp, t));
}
static int
sock_set_sockname(void *s, const void *buf, size_t sz, nni_type t)
{
return (nni_copyin_str(
SOCK(s)->s_name, buf, sizeof(SOCK(s)->s_name), sz, t));
}
static int
sock_get_proto(void *s, void *buf, size_t *szp, nni_type t)
{
return (nni_copyout_int(nni_sock_proto_id(SOCK(s)), buf, szp, t));
}
static int
sock_get_peer(void *s, void *buf, size_t *szp, nni_type t)
{
return (nni_copyout_int(nni_sock_peer_id(SOCK(s)), buf, szp, t));
}
static int
sock_get_protoname(void *s, void *buf, size_t *szp, nni_type t)
{
return (nni_copyout_str(nni_sock_proto_name(SOCK(s)), buf, szp, t));
}
static int
sock_get_peername(void *s, void *buf, size_t *szp, nni_type t)
{
return (nni_copyout_str(nni_sock_peer_name(SOCK(s)), buf, szp, t));
}
static const nni_option sock_options[] = {
{
.o_name = NNG_OPT_RECVTIMEO,
.o_get = sock_get_recvtimeo,
.o_set = sock_set_recvtimeo,
},
{
.o_name = NNG_OPT_SENDTIMEO,
.o_get = sock_get_sendtimeo,
.o_set = sock_set_sendtimeo,
},
{
.o_name = NNG_OPT_RECVFD,
.o_get = sock_get_recvfd,
},
{
.o_name = NNG_OPT_SENDFD,
.o_get = sock_get_sendfd,
},
{
.o_name = NNG_OPT_RECVBUF,
.o_get = sock_get_recvbuf,
.o_set = sock_set_recvbuf,
},
{
.o_name = NNG_OPT_SENDBUF,
.o_get = sock_get_sendbuf,
.o_set = sock_set_sendbuf,
},
{
.o_name = NNG_OPT_SOCKNAME,
.o_get = sock_get_sockname,
.o_set = sock_set_sockname,
},
{
.o_name = NNG_OPT_RAW,
.o_get = sock_get_raw,
},
{
.o_name = NNG_OPT_PROTO,
.o_get = sock_get_proto,
},
{
.o_name = NNG_OPT_PEER,
.o_get = sock_get_peer,
},
{
.o_name = NNG_OPT_PROTONAME,
.o_get = sock_get_protoname,
},
{
.o_name = NNG_OPT_PEERNAME,
.o_get = sock_get_peername,
},
// terminate list
{
.o_name = NULL,
},
};
static void
nni_free_opt(nni_sockopt *opt)
{
nni_strfree(opt->name);
nni_free(opt->data, opt->sz);
NNI_FREE_STRUCT(opt);
}
uint32_t
nni_sock_id(nni_sock *s)
{
return (s->s_id);
}
// nni_sock_sendq and nni_sock_recvq are called by the protocol to obtain
// the upper read and write queues.
nni_msgq *
nni_sock_sendq(nni_sock *s)
{
return (s->s_uwq);
}
nni_msgq *
nni_sock_recvq(nni_sock *s)
{
return (s->s_urq);
}
int
nni_sock_find(nni_sock **sockp, uint32_t id)
{
int rv;
nni_sock *s;
if ((rv = nni_init()) != 0) {
return (rv);
}
nni_mtx_lock(&sock_lk);
if ((rv = nni_idhash_find(sock_hash, id, (void **) &s)) == 0) {
if (s->s_closed) {
rv = NNG_ECLOSED;
} else {
s->s_refcnt++;
*sockp = s;
}
}
nni_mtx_unlock(&sock_lk);
if (rv == NNG_ENOENT) {
rv = NNG_ECLOSED;
}
return (rv);
}
void
nni_sock_rele(nni_sock *s)
{
nni_mtx_lock(&sock_lk);
s->s_refcnt--;
if (s->s_closed && (s->s_refcnt < 2)) {
nni_cv_wake(&s->s_close_cv);
}
nni_mtx_unlock(&sock_lk);
}
static void
sock_stats_fini(nni_sock *s)
{
#ifdef NNG_ENABLE_STATS
sock_stats *st = &s->s_stats;
nni_stat_remove(&st->s_root);
#else
NNI_ARG_UNUSED(s);
#endif
}
static void
sock_stats_init(nni_sock *s)
{
#ifdef NNG_ENABLE_STATS
sock_stats * st = &s->s_stats;
nni_stat_item *root = &s->s_stats.s_root;
// To make collection cheap and atomic for the socket,
// we just use a single lock for the entire chain.
nni_stat_init_scope(root, s->s_scope, "socket statistics");
nni_stat_init_id(&st->s_id, "id", "socket id", s->s_id);
nni_stat_append(root, &st->s_id);
nni_stat_init_string(&st->s_name, "name", "socket name", s->s_name);
nni_stat_set_lock(&st->s_name, &s->s_mx);
nni_stat_append(root, &st->s_name);
nni_stat_init_string(&st->s_protocol, "protocol", "socket protocol",
nni_sock_proto_name(s));
nni_stat_append(root, &st->s_protocol);
nni_stat_init_atomic(&st->s_ndialers, "ndialers", "open dialers");
nni_stat_set_type(&st->s_ndialers, NNG_STAT_LEVEL);
nni_stat_append(root, &st->s_ndialers);
nni_stat_init_atomic(
&st->s_nlisteners, "nlisteners", "open listeners");
nni_stat_set_type(&st->s_nlisteners, NNG_STAT_LEVEL);
nni_stat_append(root, &st->s_nlisteners);
nni_stat_init_atomic(&st->s_npipes, "npipes", "open pipes");
nni_stat_set_type(&st->s_npipes, NNG_STAT_LEVEL);
nni_stat_append(root, &st->s_npipes);
nni_stat_init_atomic(&st->s_rxbytes, "rxbytes", "bytes received");
nni_stat_set_unit(&st->s_rxbytes, NNG_UNIT_BYTES);
nni_stat_append(root, &st->s_rxbytes);
nni_stat_init_atomic(&st->s_txbytes, "txbytes", "bytes sent");
nni_stat_set_unit(&st->s_txbytes, NNG_UNIT_BYTES);
nni_stat_append(root, &st->s_txbytes);
nni_stat_init_atomic(&st->s_rxmsgs, "rxmsgs", "messages received");
nni_stat_set_unit(&st->s_rxmsgs, NNG_UNIT_MESSAGES);
nni_stat_append(root, &st->s_rxmsgs);
nni_stat_init_atomic(&st->s_txmsgs, "txmsgs", "messages sent");
nni_stat_set_unit(&st->s_txmsgs, NNG_UNIT_MESSAGES);
nni_stat_append(root, &st->s_txmsgs);
nni_stat_init_atomic(&st->s_reject, "reject", "pipes rejected");
nni_stat_append(root, &st->s_reject);
#else
NNI_ARG_UNUSED(s);
#endif
}
static void
sock_destroy(nni_sock *s)
{
nni_sockopt *sopt;
// The protocol needs to clean up its state.
if (s->s_data != NULL) {
s->s_sock_ops.sock_fini(s->s_data);
}
while ((sopt = nni_list_first(&s->s_options)) != NULL) {
nni_list_remove(&s->s_options, sopt);
nni_free_opt(sopt);
}
// This exists to silence a false positive in helgrind.
nni_mtx_lock(&s->s_mx);
nni_mtx_unlock(&s->s_mx);
sock_stats_fini(s);
nni_msgq_fini(s->s_urq);
nni_msgq_fini(s->s_uwq);
nni_cv_fini(&s->s_close_cv);
nni_cv_fini(&s->s_cv);
nni_mtx_fini(&s->s_mx);
nni_mtx_fini(&s->s_pipe_cbs_mtx);
NNI_FREE_STRUCT(s);
}
static int
nni_sock_create(nni_sock **sp, const nni_proto *proto)
{
int rv;
nni_sock *s;
bool on;
if ((s = NNI_ALLOC_STRUCT(s)) == NULL) {
return (NNG_ENOMEM);
}
s->s_sndtimeo = -1;
s->s_rcvtimeo = -1;
s->s_reconn = NNI_SECOND;
s->s_reconnmax = 0;
s->s_rcvmaxsz = 0; // unlimited by default
s->s_id = 0;
s->s_refcnt = 0;
s->s_self_id = proto->proto_self;
s->s_peer_id = proto->proto_peer;
s->s_flags = proto->proto_flags;
s->s_sock_ops = *proto->proto_sock_ops;
s->s_pipe_ops = *proto->proto_pipe_ops;
s->s_closed = false;
s->s_closing = false;
if (proto->proto_ctx_ops != NULL) {
s->s_ctx_ops = *proto->proto_ctx_ops;
}
NNI_ASSERT(s->s_sock_ops.sock_open != NULL);
NNI_ASSERT(s->s_sock_ops.sock_close != NULL);
NNI_LIST_NODE_INIT(&s->s_node);
NNI_LIST_INIT(&s->s_options, nni_sockopt, node);
NNI_LIST_INIT(&s->s_ctxs, nni_ctx, c_node);
NNI_LIST_INIT(&s->s_pipes, nni_pipe, p_sock_node);
NNI_LIST_INIT(&s->s_listeners, nni_listener, l_node);
NNI_LIST_INIT(&s->s_dialers, nni_dialer, d_node);
nni_mtx_init(&s->s_mx);
nni_mtx_init(&s->s_pipe_cbs_mtx);
nni_cv_init(&s->s_cv, &s->s_mx);
nni_cv_init(&s->s_close_cv, &sock_lk);
sock_stats_init(s);
if (((rv = nni_msgq_init(&s->s_uwq, 0)) != 0) ||
((rv = nni_msgq_init(&s->s_urq, 1)) != 0) ||
((rv = s->s_sock_ops.sock_init(&s->s_data, s)) != 0) ||
((rv = nni_sock_setopt(s, NNG_OPT_SENDTIMEO, &s->s_sndtimeo,
sizeof(nni_duration), NNI_TYPE_DURATION)) != 0) ||
((rv = nni_sock_setopt(s, NNG_OPT_RECVTIMEO, &s->s_rcvtimeo,
sizeof(nni_duration), NNI_TYPE_DURATION)) != 0) ||
((rv = nni_sock_setopt(s, NNG_OPT_RECONNMINT, &s->s_reconn,
sizeof(nni_duration), NNI_TYPE_DURATION)) != 0) ||
((rv = nni_sock_setopt(s, NNG_OPT_RECONNMAXT, &s->s_reconnmax,
sizeof(nni_duration), NNI_TYPE_DURATION)) != 0) ||
((rv = nni_sock_setopt(s, NNG_OPT_RECVMAXSZ, &s->s_rcvmaxsz,
sizeof(size_t), NNI_TYPE_SIZE)) != 0)) {
sock_destroy(s);
return (rv);
}
// These we *attempt* to call so that we are likely to have initial
// values loaded. They should not fail, but if they do we don't
// worry about it.
on = true;
(void) nni_sock_setopt(
s, NNG_OPT_TCP_NODELAY, &on, sizeof(on), NNI_TYPE_BOOL);
on = false;
(void) nni_sock_setopt(
s, NNG_OPT_TCP_KEEPALIVE, &on, sizeof(on), NNI_TYPE_BOOL);
*sp = s;
return (rv);
}
int
nni_sock_sys_init(void)
{
int rv;
NNI_LIST_INIT(&sock_list, nni_sock, s_node);
nni_mtx_init(&sock_lk);
if (((rv = nni_idhash_init(&sock_hash)) != 0) ||
((rv = nni_idhash_init(&ctx_hash)) != 0)) {
nni_sock_sys_fini();
return (rv);
}
nni_idhash_set_limits(sock_hash, 1, 0x7fffffff, 1);
nni_idhash_set_limits(ctx_hash, 1, 0x7fffffff, 1);
return (0);
}
void
nni_sock_sys_fini(void)
{
if (sock_hash != NULL) {
nni_idhash_fini(sock_hash);
sock_hash = NULL;
}
if (ctx_hash != NULL) {
nni_idhash_fini(ctx_hash);
ctx_hash = NULL;
}
nni_mtx_fini(&sock_lk);
}
int
nni_sock_open(nni_sock **sockp, const nni_proto *proto)
{
nni_sock *s = NULL;
int rv;
if (proto->proto_version != NNI_PROTOCOL_VERSION) {
// unsupported protocol version
return (NNG_ENOTSUP);
}
if (((rv = nni_init()) != 0) ||
((rv = nni_sock_create(&s, proto)) != 0)) {
return (rv);
}
nni_mtx_lock(&sock_lk);
if ((rv = nni_idhash_alloc32(sock_hash, &s->s_id, s)) != 0) {
sock_destroy(s);
} else {
nni_list_append(&sock_list, s);
s->s_sock_ops.sock_open(s->s_data);
*sockp = s;
}
nni_mtx_unlock(&sock_lk);
// Set the sockname.
(void) snprintf(s->s_name, sizeof(s->s_name), "%u", s->s_id);
// Set up basic stat values.
(void) snprintf(s->s_scope, sizeof(s->s_scope), "socket%u", s->s_id);
nni_stat_set_value(&s->s_stats.s_id, s->s_id);
// Add our stats chain.
nni_stat_append(NULL, &s->s_stats.s_root);
return (0);
}
// nni_sock_shutdown shuts down the socket; after this point no
// further access to the socket will function, and any threads blocked
// in entry points will be woken (and the functions they are blocked
// in will return NNG_ECLOSED.)
int
nni_sock_shutdown(nni_sock *sock)
{
nni_pipe * pipe;
nni_dialer * d;
nni_listener *l;
nni_ctx * ctx;
nni_ctx * nctx;
nni_mtx_lock(&sock->s_mx);
if (sock->s_closing) {
nni_mtx_unlock(&sock->s_mx);
return (NNG_ECLOSED);
}
// Mark us closing, so no more EPs or changes can occur.
sock->s_closing = true;
// Close the EPs. This prevents new connections from forming
// but but allows existing ones to drain.
NNI_LIST_FOREACH (&sock->s_listeners, l) {
listener_shutdown_locked(l);
}
NNI_LIST_FOREACH (&sock->s_dialers, d) {
dialer_shutdown_locked(d);
}
nni_mtx_unlock(&sock->s_mx);
// We now mark any owned contexts as closing.
// XXX: Add context draining support here!
nni_mtx_lock(&sock_lk);
nctx = nni_list_first(&sock->s_ctxs);
while ((ctx = nctx) != NULL) {
nctx = nni_list_next(&sock->s_ctxs, ctx);
ctx->c_closed = true;
if (ctx->c_refcnt == 0) {
// No open operations. So close it.
nni_idhash_remove(ctx_hash, ctx->c_id);
nni_list_remove(&sock->s_ctxs, ctx);
nni_ctx_destroy(ctx);
}
// If still has a reference count, then wait for last
// reference to close before nuking it.
}
nni_mtx_unlock(&sock_lk);
// Generally, unless the protocol is blocked trying to perform
// writes (e.g. a slow reader on the other side), it should be
// trying to shut things down. We wait to give it
// a chance to do so gracefully.
nni_mtx_lock(&sock_lk);
while (!nni_list_empty(&sock->s_ctxs)) {
sock->s_ctxwait = true;
nni_cv_wait(&sock->s_close_cv);
}
nni_mtx_unlock(&sock_lk);
nni_mtx_lock(&sock->s_mx);
// At this point, we've done everything we politely can to
// give the protocol a chance to flush its write side. Now
// its time to be a little more insistent.
// Close the upper queues immediately. This can happen
// safely while we hold the lock.
nni_msgq_close(sock->s_urq);
nni_msgq_close(sock->s_uwq);
// Go through the dialers and listeners, attempting to close them.
// We might already have a close in progress, in which case
// we skip past it; it will be removed from another thread.
NNI_LIST_FOREACH (&sock->s_listeners, l) {
if (nni_listener_hold(l) == 0) {
nni_listener_close_rele(l);
}
}
NNI_LIST_FOREACH (&sock->s_dialers, d) {
if (nni_dialer_hold(d) == 0) {
nni_dialer_close_rele(d);
}
}
// For each pipe, arrange for it to teardown hard. We would
// expect there not to be any here. However, it is possible for
// a pipe to have been added by an endpoint due to racing conditions
// in the shutdown. Therefore it is important that we shutdown pipes
// *last*.
NNI_LIST_FOREACH (&sock->s_pipes, pipe) {
nni_pipe_close(pipe);
}
// We have to wait for *both* endpoints and pipes to be
// removed.
while ((!nni_list_empty(&sock->s_pipes)) ||
(!nni_list_empty(&sock->s_listeners)) ||
(!nni_list_empty(&sock->s_dialers))) {
nni_cv_wait(&sock->s_cv);
}
sock->s_sock_ops.sock_close(sock->s_data);
nni_cv_wake(&sock->s_cv);
NNI_ASSERT(nni_list_first(&sock->s_pipes) == NULL);
nni_mtx_unlock(&sock->s_mx);
// At this point, there are no threads blocked inside of us
// that are referencing socket state. User code should call
// nng_close to release the last resources.
return (0);
}
// nni_sock_close shuts down the socket, then releases any resources
// associated with it. It is a programmer error to reference the
// socket after this function is called, as the pointer may reference
// invalid memory or other objects.
void
nni_sock_close(nni_sock *s)
{
// Shutdown everything if not already done. This operation
// is idempotent.
nni_sock_shutdown(s);
nni_stat_remove(&s->s_stats.s_root);
nni_mtx_lock(&sock_lk);
if (s->s_closed) {
// Some other thread called close. All we need to do
// is drop our reference count.
nni_mtx_unlock(&sock_lk);
nni_sock_rele(s);
return;
}
s->s_closed = true;
nni_idhash_remove(sock_hash, s->s_id);
// We might have been removed from the list already, e.g. by
// nni_sock_closeall. This is idempotent.
nni_list_node_remove(&s->s_node);
// Wait for all other references to drop. Note that we
// have a reference already (from our caller).
s->s_ctxwait = true;
while ((s->s_refcnt > 1) || (!nni_list_empty(&s->s_ctxs))) {
nni_cv_wait(&s->s_close_cv);
}
nni_mtx_unlock(&sock_lk);
// Because we already shut everything down before, we should not
// have any child objects.
nni_mtx_lock(&s->s_mx);
NNI_ASSERT(nni_list_empty(&s->s_dialers));
NNI_ASSERT(nni_list_empty(&s->s_listeners));
NNI_ASSERT(nni_list_empty(&s->s_pipes));
nni_mtx_unlock(&s->s_mx);
sock_destroy(s);
}
void
nni_sock_closeall(void)
{
nni_sock *s;
if (sock_hash == NULL) {
return;
}
for (;;) {
nni_mtx_lock(&sock_lk);
if ((s = nni_list_first(&sock_list)) == NULL) {
nni_mtx_unlock(&sock_lk);
return;
}
// Bump the reference count. The close call below
// will drop it.
s->s_refcnt++;
nni_list_node_remove(&s->s_node);
nni_mtx_unlock(&sock_lk);
nni_sock_close(s);
}
}
void
nni_sock_send(nni_sock *sock, nni_aio *aio)
{
nni_aio_normalize_timeout(aio, sock->s_sndtimeo);
sock->s_sock_ops.sock_send(sock->s_data, aio);
}
void
nni_sock_recv(nni_sock *sock, nni_aio *aio)
{
nni_aio_normalize_timeout(aio, sock->s_rcvtimeo);
sock->s_sock_ops.sock_recv(sock->s_data, aio);
}
// nni_sock_proto_id returns the socket's 16-bit protocol number.
uint16_t
nni_sock_proto_id(nni_sock *sock)
{
return (sock->s_self_id.p_id);
}
// nni_sock_peer_id returns the socket peer's 16-bit protocol number.
uint16_t
nni_sock_peer_id(nni_sock *sock)
{
return (sock->s_peer_id.p_id);
}
const char *
nni_sock_proto_name(nni_sock *sock)
{
return (sock->s_self_id.p_name);
}
const char *
nni_sock_peer_name(nni_sock *sock)
{
return (sock->s_peer_id.p_name);
}
struct nni_proto_pipe_ops *
nni_sock_proto_pipe_ops(nni_sock *sock)
{
return (&sock->s_pipe_ops);
}
void *
nni_sock_proto_data(nni_sock *sock)
{
return (sock->s_data);
}
int
nni_sock_add_listener(nni_sock *s, nni_listener *l)
{
nni_sockopt *sopt;
nni_mtx_lock(&s->s_mx);
if (s->s_closing) {
nni_mtx_unlock(&s->s_mx);
return (NNG_ECLOSED);
}
NNI_LIST_FOREACH (&s->s_options, sopt) {
int rv;
rv = nni_listener_setopt(
l, sopt->name, sopt->data, sopt->sz, sopt->typ);
if ((rv != 0) && (rv != NNG_ENOTSUP)) {
nni_mtx_unlock(&s->s_mx);
return (rv);
}
}
nni_list_append(&s->s_listeners, l);
nni_stat_inc_atomic(&s->s_stats.s_nlisteners, 1);
nni_mtx_unlock(&s->s_mx);
return (0);
}
int
nni_sock_add_dialer(nni_sock *s, nni_dialer *d)
{
nni_sockopt *sopt;
nni_mtx_lock(&s->s_mx);
if (s->s_closing) {
nni_mtx_unlock(&s->s_mx);
return (NNG_ECLOSED);
}
NNI_LIST_FOREACH (&s->s_options, sopt) {
int rv;
rv = nni_dialer_setopt(
d, sopt->name, sopt->data, sopt->sz, sopt->typ);
if ((rv != 0) && (rv != NNG_ENOTSUP)) {
nni_mtx_unlock(&s->s_mx);
return (rv);
}
}
nni_list_append(&s->s_dialers, d);
nni_stat_inc_atomic(&s->s_stats.s_ndialers, 1);
nni_mtx_unlock(&s->s_mx);
return (0);
}
int
nni_sock_setopt(
nni_sock *s, const char *name, const void *v, size_t sz, nni_type t)
{
int rv;
nni_dialer * d;
nni_listener *l;
nni_sockopt * optv;
nni_sockopt * oldv = NULL;
nni_mtx_lock(&s->s_mx);
if (s->s_closing) {
nni_mtx_unlock(&s->s_mx);
return (NNG_ECLOSED);
}
// Protocol options. The protocol can override options that
// the socket framework would otherwise supply, like buffer
// sizes.
rv = nni_setopt(s->s_sock_ops.sock_options, name, s->s_data, v, sz, t);
if (rv != NNG_ENOTSUP) {
nni_mtx_unlock(&s->s_mx);
return (rv);
}
// Some options do not go down to transports. Handle them directly.
rv = nni_setopt(sock_options, name, s, v, sz, t);
if (rv != NNG_ENOTSUP) {
nni_mtx_unlock(&s->s_mx);
return (rv);
}
nni_mtx_unlock(&s->s_mx);
// If the option was already handled one way or the other,
if (rv != NNG_ENOTSUP) {
return (rv);
}
// Validation of generic and transport options. This is stateless, so
// transports should not fail to set an option later if they
// passed it here.
if ((strcmp(name, NNG_OPT_RECONNMINT) == 0) ||
(strcmp(name, NNG_OPT_RECONNMAXT) == 0)) {
nng_duration ms;
if ((rv = nni_copyin_ms(&ms, v, sz, t)) != 0) {
return (rv);
}
} else if ((rv = nni_tran_chkopt(name, v, sz, t)) != 0) {
return (rv);
}
// Prepare a copy of the sockoption.
if ((optv = NNI_ALLOC_STRUCT(optv)) == NULL) {
return (NNG_ENOMEM);