forked from meetecho/janus-gateway
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sctp.c
1279 lines (1197 loc) · 43.7 KB
/
sctp.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
/*! \file sctp.c
* \author Lorenzo Miniero <lorenzo@meetecho.com>
* \copyright GNU General Public License v3
* \brief SCTP processing for data channels
* \details Implementation (based on libusrsctp) of the SCTP Data Channels.
* The code takes care of the SCTP association between peers and the server,
* and allows for sending and receiving text messages (binary stuff yet to
* be implemented) after that.
*
* \note Right now, the code is heavily based on the rtcweb.c sample code
* provided in the \c usrsctp library code, and as such the copyright notice
* that appears at the beginning of that code is ideally present here as
* well: http://code.google.com/p/sctp-refimpl/source/browse/trunk/KERN/usrsctp/programs/rtcweb.c
*
* \note If you want/need to debug SCTP messages for any reason, you can
* do so by uncommenting the definition of \c DEBUG_SCTP in sctp.h. This
* will force this code to save all the SCTP messages being exchanged to
* a separate file for each session. You must choose what folder to save
* these files in by modifying the \c debug_folder variable. Once a file
* has been saved, you need to process it using the \c text2pcap tool
* that is usually shipped with Wireshark, e.g.:
*
\verbatim
cd /path/to/sctp
/usr/sbin/text2pcap -n -l 248 -D -t '%H:%M:%S.' sctp-debug-XYZ.txt sctp-debug-XYZ.pcapng
/usr/sbin/wireshark sctp-debug-XYZ.pcapng
\endverbatim
*
* \ingroup protocols
* \ref protocols
*/
#ifdef HAVE_SCTP
#include "sctp.h"
#include "dtls.h"
#include "janus.h"
#include "ice.h"
#include "debug.h"
#ifdef DEBUG_SCTP
/* If we're debugging the SCTP messaging, save the files here (edit path) */
const char *debug_folder = "/path/to/sctp";
#endif
static const char *default_label = "JanusDataChannel";
#define SCTP_MAX_PACKET_SIZE (1<<16)
static uint16_t event_types[] = {
SCTP_ASSOC_CHANGE,
SCTP_PEER_ADDR_CHANGE,
SCTP_REMOTE_ERROR,
SCTP_SHUTDOWN_EVENT,
SCTP_ADAPTATION_INDICATION,
SCTP_SEND_FAILED_EVENT,
SCTP_STREAM_RESET_EVENT,
SCTP_STREAM_CHANGE_EVENT
};
int janus_sctp_data_to_dtls(void *instance, void *buffer, size_t length, uint8_t tos, uint8_t set_df);
static int janus_sctp_incoming_data(struct socket *sock, union sctp_sockstore addr, void *data, size_t datalen, struct sctp_rcvinfo rcv, int flags, void *ulp_info);
janus_sctp_channel *janus_sctp_find_channel_by_stream(janus_sctp_association *sctp, uint16_t stream);
janus_sctp_channel *janus_sctp_find_free_channel(janus_sctp_association *sctp);
uint16_t janus_sctp_find_free_stream(janus_sctp_association *sctp);
void janus_sctp_request_more_streams(janus_sctp_association *sctp);
int janus_sctp_send_open_request_message(struct socket *sock, uint16_t stream, char *label, uint8_t unordered, uint16_t pr_policy, uint32_t pr_value);
int janus_sctp_send_open_response_message(struct socket *sock, uint16_t stream);
int janus_sctp_send_open_ack_message(struct socket *sock, uint16_t stream);
void janus_sctp_send_deferred_messages(janus_sctp_association *sctp);
int janus_sctp_open_channel(janus_sctp_association *sctp, char *label, uint8_t unordered, uint16_t pr_policy, uint32_t pr_value);
int janus_sctp_send_text_or_binary(janus_sctp_association *sctp, uint16_t id, gboolean textdata, char *text, size_t length);
void janus_sctp_reset_outgoing_stream(janus_sctp_association *sctp, uint16_t stream);
void janus_sctp_send_outgoing_stream_reset(janus_sctp_association *sctp);
int janus_sctp_close_channel(janus_sctp_association *sctp, uint16_t id);
void janus_sctp_handle_open_request_message(janus_sctp_association *sctp, janus_datachannel_open_request *req, size_t length, uint16_t stream);
void janus_sctp_handle_open_response_message(janus_sctp_association *sctp, janus_datachannel_open_response *rsp, size_t length, uint16_t stream);
void janus_sctp_handle_open_ack_message(janus_sctp_association *sctp, janus_datachannel_ack *ack, size_t length, uint16_t stream);
void janus_sctp_handle_unknown_message(char *msg, size_t length, uint16_t stream);
void janus_sctp_handle_data_message(janus_sctp_association *sctp, gboolean textdata, char *buffer, size_t length, uint16_t stream);
void janus_sctp_handle_message(janus_sctp_association *sctp, char *buffer, size_t length, uint32_t ppid, uint16_t stream, int flags);
void janus_sctp_handle_association_change_event(struct sctp_assoc_change *sac);
void janus_sctp_handle_peer_address_change_event(struct sctp_paddr_change *spc);
void janus_sctp_handle_adaptation_indication(struct sctp_adaptation_event *sai);
void janus_sctp_handle_shutdown_event(struct sctp_shutdown_event *sse);
void janus_sctp_handle_stream_reset_event(janus_sctp_association *sctp, struct sctp_stream_reset_event *strrst);
void janus_sctp_handle_remote_error_event(struct sctp_remote_error *sre);
void janus_sctp_handle_send_failed_event(struct sctp_send_failed_event *ssfe);
void janus_sctp_handle_notification(janus_sctp_association *sctp, union sctp_notification *notif, size_t n);
static gboolean sctp_running;
int janus_sctp_init(void) {
/* Initialize the SCTP stack */
usrsctp_init(0, janus_sctp_data_to_dtls, NULL);
sctp_running = TRUE;
#ifdef DEBUG_SCTP
JANUS_LOG(LOG_WARN, "SCTP debugging to files enabled: going to save them in %s\n", debug_folder);
if(janus_mkdir(debug_folder, 0755) < 0) {
JANUS_LOG(LOG_ERR, "Error creating folder %s, expect problems...\n", debug_folder);
}
#endif
return 0;
}
void janus_sctp_deinit(void) {
usrsctp_finish();
sctp_running = FALSE;
}
static void janus_sctp_association_free(const janus_refcount *sctp_ref) {
janus_sctp_association *sctp = janus_refcount_containerof(sctp_ref, janus_sctp_association, ref);
/* This association can be destroyed, free all the resources */
janus_refcount_decrease(&sctp->handle->ref);
janus_refcount_decrease(&sctp->dtls->ref);
#ifdef DEBUG_SCTP
if(sctp->debug_dump != NULL)
fclose(sctp->debug_dump);
sctp->debug_dump = NULL;
#endif
g_free(sctp->buffer);
g_free(sctp);
sctp = NULL;
}
janus_sctp_association *janus_sctp_association_create(janus_dtls_srtp *dtls, janus_ice_handle *handle, uint16_t udp_port) {
if(dtls == NULL || handle == NULL || udp_port == 0)
return NULL;
/* usrsctp provides UDP encapsulation of SCTP, but we need these messages to
* be encapsulated in DTLS and actually sent/received by libnice, and not by
* usrsctp itself... as such, we make use of the AF_CONN approach */
janus_sctp_association *sctp = g_malloc0(sizeof(janus_sctp_association));
janus_refcount_init(&sctp->ref, janus_sctp_association_free);
g_atomic_int_set(&sctp->destroyed, 0);
sctp->dtls = dtls;
janus_refcount_increase(&dtls->ref);
sctp->handle = handle;
janus_refcount_increase(&handle->ref);
sctp->handle_id = handle->handle_id;
sctp->local_port = 5000; /* FIXME We always use this one */
sctp->remote_port = udp_port;
sctp->buffer = NULL;
sctp->buflen = 0;
sctp->offset = 0;
#ifdef DEBUG_SCTP
sctp->debug_dump = NULL;
#endif
struct socket *sock = NULL;
unsigned int i = 0;
struct sockaddr_conn sconn = { 0 };
/* Now go on with SCTP */
janus_sctp_channel *channel = NULL;
for(i = 0; i < NUMBER_OF_CHANNELS; i++) {
channel = &(sctp->channels[i]);
channel->id = i;
channel->label[0] = '\0';
channel->state = DATA_CHANNEL_CLOSED;
channel->pr_policy = SCTP_PR_SCTP_NONE;
channel->pr_value = 0;
channel->stream = 0;
channel->unordered = 0;
channel->flags = 0;
}
for(i = 0; i < NUMBER_OF_STREAMS; i++) {
sctp->stream_channel[i] = NULL;
sctp->stream_buffer[i] = 0;
}
sctp->stream_buffer_counter = 0;
usrsctp_register_address((void *)sctp);
usrsctp_sysctl_set_sctp_ecn_enable(0);
if((sock = usrsctp_socket(AF_CONN, SOCK_STREAM, IPPROTO_SCTP, janus_sctp_incoming_data, NULL, 0, (void *)sctp)) == NULL) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] Error creating usrsctp socket... (%d)\n", sctp->handle_id, errno);
janus_sctp_association_destroy(sctp);
return NULL;
}
/* Store the socket handle to make sure it is closed in any case if the association creation fails */
sctp->sock = sock;
/* Make the socket non-blocking. Connect, close, shutdown etc will not block
* the thread waiting for the socket operation to complete. */
if (usrsctp_set_non_blocking(sock, 1) < 0) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] Error setting socket to non-blocking... (%d)\n", sctp->handle_id, errno);
janus_sctp_association_destroy(sctp);
return NULL;
}
/* Set SO_LINGER */
struct linger linger_opt;
linger_opt.l_onoff = 1;
linger_opt.l_linger = 0;
if(usrsctp_setsockopt(sock, SOL_SOCKET, SO_LINGER, &linger_opt, sizeof(linger_opt))) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] setsockopt error: SO_LINGER (%d)\n", sctp->handle_id, errno);
janus_sctp_association_destroy(sctp);
return NULL;
}
/* Allow resetting streams */
struct sctp_assoc_value av;
av.assoc_id = SCTP_ALL_ASSOC;
av.assoc_value = SCTP_ENABLE_RESET_STREAM_REQ | SCTP_ENABLE_CHANGE_ASSOC_REQ;
if(usrsctp_setsockopt(sock, IPPROTO_SCTP, SCTP_ENABLE_STREAM_RESET, &av, sizeof(struct sctp_assoc_value)) < 0) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] setsockopt error: SCTP_ENABLE_STREAM_RESET (%d)\n", sctp->handle_id, errno);
janus_sctp_association_destroy(sctp);
return NULL;
}
/* Disable Nagle */
uint32_t nodelay = 1;
if(usrsctp_setsockopt(sock, IPPROTO_SCTP, SCTP_NODELAY, &nodelay, sizeof(nodelay))) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] setsockopt error: SCTP_NODELAY (%d)\n", sctp->handle_id, errno);
janus_sctp_association_destroy(sctp);
return NULL;
}
/* Enable the events of interest */
struct sctp_event event;
memset(&event, 0, sizeof(event));
event.se_assoc_id = SCTP_ALL_ASSOC;
event.se_on = 1;
for(i = 0; i < sizeof(event_types)/sizeof(uint16_t); i++) {
event.se_type = event_types[i];
if(usrsctp_setsockopt(sock, IPPROTO_SCTP, SCTP_EVENT, &event, sizeof(event)) < 0) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] setsockopt error: SCTP_EVENT (%d)\n", sctp->handle_id, errno);
janus_sctp_association_destroy(sctp);
return NULL;
}
}
/* Configure our INIT message */
struct sctp_initmsg initmsg;
memset(&initmsg, 0, sizeof(struct sctp_initmsg));
initmsg.sinit_num_ostreams = NUMBER_OF_STREAMS;
initmsg.sinit_max_instreams = NUMBER_OF_STREAMS;
if(usrsctp_setsockopt(sock, IPPROTO_SCTP, SCTP_INITMSG, &initmsg, sizeof(struct sctp_initmsg)) < 0) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] setsockopt error: SCTP_INITMSG (%d)\n", sctp->handle_id, errno);
janus_sctp_association_destroy(sctp);
return NULL;
}
/* Bind our side of the communication, using AF_CONN as we're doing the actual delivery ourselves */
memset(&sconn, 0, sizeof(struct sockaddr_conn));
sconn.sconn_family = AF_CONN;
sconn.sconn_port = htons(sctp->local_port);
sconn.sconn_addr = (void *)sctp;
if(usrsctp_bind(sock, (struct sockaddr *)&sconn, sizeof(struct sockaddr_conn)) < 0) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] Error binding client on port %"SCNu16" (%d)\n", sctp->handle_id, sctp->local_port, errno);
janus_sctp_association_destroy(sctp);
return NULL;
}
#ifdef DEBUG_SCTP
char debug_file[1024];
g_snprintf(debug_file, 1024, "%s/sctp-debug-%"SCNu64".txt", debug_folder, sctp->handle_id);
sctp->debug_dump = fopen(debug_file, "wt");
#endif
/* Operating as client */
JANUS_LOG(LOG_VERB, "[%"SCNu64"] Connecting the SCTP association\n", sctp->handle_id);
struct sockaddr_conn rconn = { 0 };
memset(&rconn, 0, sizeof(struct sockaddr_conn));
rconn.sconn_family = AF_CONN;
rconn.sconn_port = htons(sctp->remote_port);
rconn.sconn_addr = (void *)sctp;
#ifdef HAVE_SCONN_LEN
rconn.sconn_len = sizeof(struct sockaddr_conn);
#endif
int res = usrsctp_connect(sock, (struct sockaddr *)&rconn, sizeof(struct sockaddr_conn));
if(res < 0 && errno != EINPROGRESS) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] Error connecting to SCTP server at port %"SCNu16" (%d)\n", sctp->handle_id, sctp->remote_port, errno);
janus_sctp_association_destroy(sctp);
return NULL;
}
JANUS_LOG(LOG_VERB, "[%"SCNu64"] Connected to the DataChannel peer\n", sctp->handle_id);
return sctp;
}
void janus_sctp_association_destroy(janus_sctp_association *sctp) {
if(sctp == NULL || !g_atomic_int_compare_and_exchange(&sctp->destroyed, 0, 1))
return;
usrsctp_deregister_address(sctp);
if (sctp->sock != NULL) {
usrsctp_shutdown(sctp->sock, SHUT_RDWR);
usrsctp_close(sctp->sock);
}
janus_refcount_decrease(&sctp->ref);
}
void janus_sctp_data_from_dtls(janus_sctp_association *sctp, char *buf, int len) {
if(sctp == NULL || sctp->handle == NULL || buf == NULL || len <= 0)
return;
JANUS_LOG(LOG_HUGE, "[%"SCNu64"] Data from DTLS to SCTP stack: %d bytes\n", sctp->handle_id, len);
#ifdef DEBUG_SCTP
if(sctp->debug_dump != NULL) {
/* Dump incoming message */
char *dump = usrsctp_dumppacket(buf, len, SCTP_DUMP_INBOUND);
if(dump != NULL) {
fwrite(dump, sizeof(char), strlen(dump), sctp->debug_dump);
fflush(sctp->debug_dump);
usrsctp_freedumpbuffer(dump);
}
}
#endif
usrsctp_conninput((void *)sctp, buf, len, 0);
}
int janus_sctp_data_to_dtls(void *instance, void *buffer, size_t length, uint8_t tos, uint8_t set_df) {
janus_sctp_association *sctp = (janus_sctp_association *)instance;
if(sctp == NULL || sctp->handle == NULL)
return -1;
JANUS_LOG(LOG_HUGE, "[%"SCNu64"] Data from SCTP to DTLS stack: %zu bytes\n", sctp->handle_id, length);
#ifdef DEBUG_SCTP
if(sctp->debug_dump != NULL) {
/* Dump outgoing message */
char *dump = usrsctp_dumppacket(buffer, length, SCTP_DUMP_OUTBOUND);
if(dump != NULL) {
fwrite(dump, sizeof(char), strlen(dump), sctp->debug_dump);
fflush(sctp->debug_dump);
usrsctp_freedumpbuffer(dump);
}
}
#endif
janus_ice_relay_sctp(sctp->handle, buffer, length);
return 0;
}
static int janus_sctp_incoming_data(struct socket *sock, union sctp_sockstore addr, void *data, size_t datalen, struct sctp_rcvinfo rcv, int flags, void *ulp_info) {
janus_sctp_association *sctp = (janus_sctp_association *)ulp_info;
if(sctp == NULL || sctp->dtls == NULL) {
free(data);
return 0;
}
if(data) {
if(flags & MSG_NOTIFICATION) {
janus_sctp_handle_notification(sctp, (union sctp_notification *)data, datalen);
} else {
janus_sctp_handle_message(sctp, data, datalen, ntohl(rcv.rcv_ppid), rcv.rcv_sid, flags);
}
free(data);
}
return 1;
}
void janus_sctp_send_data(janus_sctp_association *sctp, char *label, gboolean textdata, char *buf, int len) {
if(sctp == NULL || buf == NULL || len <= 0)
return;
if(label == NULL)
label = (char *)default_label;
JANUS_LOG(LOG_VERB, "[%"SCNu64"] SCTP data to send (label=%s, %d bytes) coming from a plugin.\n",
sctp->handle_id, label, len);
JANUS_LOG(LOG_HUGE, "[%"SCNu64"] Outgoing SCTP contents: %.*s\n",
sctp->handle_id, len, buf);
/* FIXME Is there any open channel we can use? */
int i = 0, found = 0;
for(i = 0; i < NUMBER_OF_CHANNELS; i++) {
if(sctp->channels[i].state != DATA_CHANNEL_CLOSED && !strcmp(sctp->channels[i].label, label)) {
found = 1;
JANUS_LOG(LOG_VERB, "[%"SCNu64"] -- Using open channel %i\n", sctp->handle_id, i);
break;
}
}
if(!found) {
/* There's no open channel, try opening one now */
JANUS_LOG(LOG_VERB, "[%"SCNu64"] Creating channel '%s'...\n", sctp->handle_id, label);
if(janus_sctp_open_channel(sctp, label, 0, 0, 0) < 0) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] Couldn't open channel...\n", sctp->handle_id);
return;
}
for(i = 0; i < NUMBER_OF_CHANNELS; i++) {
if(sctp->channels[i].state != DATA_CHANNEL_CLOSED && !strcmp(sctp->channels[i].label, label)) {
found = 1;
JANUS_LOG(LOG_VERB, "[%"SCNu64"] -- Using open channel %i\n", sctp->handle_id, i);
break;
}
}
if(!found) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] Channel opened but not found?? giving up...\n", sctp->handle_id);
return;
}
}
/* Send the data, whether it's text or binary */
janus_sctp_send_text_or_binary(sctp, i, textdata, buf, len);
}
/* From now on, it's SCTP stuff */
janus_sctp_channel *janus_sctp_find_channel_by_stream(janus_sctp_association *sctp, uint16_t stream) {
if(sctp == NULL)
return NULL;
if(stream < NUMBER_OF_STREAMS) {
return (sctp->stream_channel[stream]);
} else {
return NULL;
}
}
janus_sctp_channel *janus_sctp_find_free_channel(janus_sctp_association *sctp) {
uint32_t i;
for(i = 0; i < NUMBER_OF_CHANNELS; i++) {
if(sctp->channels[i].state == DATA_CHANNEL_CLOSED) {
break;
}
}
if(i == NUMBER_OF_CHANNELS) {
return NULL;
} else {
return (&(sctp->channels[i]));
}
}
uint16_t janus_sctp_find_free_stream(janus_sctp_association *sctp) {
struct sctp_status status;
uint32_t i, limit;
socklen_t len;
len = (socklen_t)sizeof(struct sctp_status);
if(usrsctp_getsockopt(sctp->sock, IPPROTO_SCTP, SCTP_STATUS, &status, &len) < 0) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] getsockopt error: SCTP_STATUS\n", sctp->handle_id);
return 0;
}
if(status.sstat_outstrms < NUMBER_OF_STREAMS) {
limit = status.sstat_outstrms;
} else {
limit = NUMBER_OF_STREAMS;
}
/* stream id 0 is reserved */
for(i = 1; i < limit; i++) {
if(sctp->stream_channel[i] == NULL) {
break;
}
}
if(i == limit) {
return 0;
} else {
return ((uint16_t)i);
}
}
void janus_sctp_request_more_streams(janus_sctp_association *sctp) {
struct sctp_status status;
struct sctp_add_streams sas;
uint32_t i, streams_needed;
socklen_t len;
streams_needed = 0;
for(i = 0; i < NUMBER_OF_CHANNELS; i++) {
if((sctp->channels[i].state == DATA_CHANNEL_CONNECTING) &&
(sctp->channels[i].stream == 0)) {
streams_needed++;
}
}
len = (socklen_t)sizeof(struct sctp_status);
if(usrsctp_getsockopt(sctp->sock, IPPROTO_SCTP, SCTP_STATUS, &status, &len) < 0) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] getsockopt error: SCTP_STATUS\n", sctp->handle_id);
return;
}
if(status.sstat_outstrms + streams_needed > NUMBER_OF_STREAMS) {
streams_needed = NUMBER_OF_STREAMS - status.sstat_outstrms;
}
if(streams_needed == 0) {
return;
}
memset(&sas, 0, sizeof(struct sctp_add_streams));
sas.sas_instrms = 0;
sas.sas_outstrms = (uint16_t)streams_needed; /* XXX eror handling */
if(usrsctp_setsockopt(sctp->sock, IPPROTO_SCTP, SCTP_ADD_STREAMS, &sas, (socklen_t)sizeof(struct sctp_add_streams)) < 0) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] setsockopt error: SCTP_ADD_STREAMS\n", sctp->handle_id);
}
return;
}
int janus_sctp_send_open_request_message(struct socket *sock, uint16_t stream, char *label, uint8_t unordered, uint16_t pr_policy, uint32_t pr_value) {
/* XXX: This should be encoded in a better way */
janus_datachannel_open_request *req = NULL;
struct sctp_sndinfo sndinfo;
/* Use the default label, if none was provided */
if(label == NULL)
label = (char *)default_label;
guint label_size = (strlen(label)+3) & ~3;
JANUS_LOG(LOG_VERB, "Opening channel with label '%s' (%zu, %u with padding)\n", label, strlen(label), label_size);
req = g_malloc0(sizeof(janus_datachannel_open_request) + label_size);
req->msg_type = DATA_CHANNEL_OPEN_REQUEST;
switch (pr_policy) {
case SCTP_PR_SCTP_NONE:
/* XXX: What about DATA_CHANNEL_RELIABLE_STREAM */
req->channel_type = DATA_CHANNEL_RELIABLE;
break;
case SCTP_PR_SCTP_TTL:
/* XXX: What about DATA_CHANNEL_UNRELIABLE */
req->channel_type = DATA_CHANNEL_PARTIAL_RELIABLE_TIMED;
break;
case SCTP_PR_SCTP_RTX:
req->channel_type = DATA_CHANNEL_PARTIAL_RELIABLE_REXMIT;
break;
default:
return 0;
}
req->priority = htons(0); /* XXX: add support */
req->reliability_params = htonl((uint32_t)pr_value);
req->label_length = htons(label_size);
memcpy(&req->label, label, strlen(label));
memset(&sndinfo, 0, sizeof(struct sctp_sndinfo));
sndinfo.snd_sid = stream;
sndinfo.snd_flags = SCTP_EOR;
sndinfo.snd_ppid = htonl(DATA_CHANNEL_PPID_CONTROL);
if(usrsctp_sendv(sock,
req, sizeof(janus_datachannel_open_request) + label_size,
NULL, 0,
&sndinfo, (socklen_t)sizeof(struct sctp_sndinfo),
SCTP_SENDV_SNDINFO, 0) < 0) {
JANUS_LOG(LOG_ERR, "usrsctp_sendv error (%d)\n", errno);
g_free(req);
req = NULL;
return 0;
} else {
g_free(req);
req = NULL;
return 1;
}
}
int janus_sctp_send_open_response_message(struct socket *sock, uint16_t stream) {
/* XXX: This should be encoded in a better way */
janus_datachannel_open_response rsp;
struct sctp_sndinfo sndinfo;
memset(&rsp, 0, sizeof(janus_datachannel_open_response));
rsp.msg_type = DATA_CHANNEL_OPEN_RESPONSE;
rsp.error = 0;
rsp.flags = htons(0);
rsp.reverse_stream = htons(stream);
memset(&sndinfo, 0, sizeof(struct sctp_sndinfo));
sndinfo.snd_sid = stream;
sndinfo.snd_flags = SCTP_EOR;
sndinfo.snd_ppid = htonl(DATA_CHANNEL_PPID_CONTROL);
if(usrsctp_sendv(sock,
&rsp, sizeof(janus_datachannel_open_response),
NULL, 0,
&sndinfo, (socklen_t)sizeof(struct sctp_sndinfo),
SCTP_SENDV_SNDINFO, 0) < 0) {
JANUS_LOG(LOG_ERR, "usrsctp_sendv error (%d)\n", errno);
return 0;
} else {
return 1;
}
}
int janus_sctp_send_open_ack_message(struct socket *sock, uint16_t stream) {
/* XXX: This should be encoded in a better way */
janus_datachannel_ack ack;
struct sctp_sndinfo sndinfo;
memset(&ack, 0, sizeof(janus_datachannel_ack));
ack.msg_type = DATA_CHANNEL_ACK;
memset(&sndinfo, 0, sizeof(struct sctp_sndinfo));
sndinfo.snd_sid = stream;
sndinfo.snd_flags = SCTP_EOR;
sndinfo.snd_ppid = htonl(DATA_CHANNEL_PPID_CONTROL);
if(usrsctp_sendv(sock,
&ack, sizeof(janus_datachannel_ack),
NULL, 0,
&sndinfo, (socklen_t)sizeof(struct sctp_sndinfo),
SCTP_SENDV_SNDINFO, 0) < 0) {
JANUS_LOG(LOG_ERR, "usrsctp_sendv error (%d)\n", errno);
return 0;
} else {
return 1;
}
}
void janus_sctp_send_deferred_messages(janus_sctp_association *sctp) {
uint32_t i;
janus_sctp_channel *channel;
for(i = 0; i < NUMBER_OF_CHANNELS; i++) {
channel = &(sctp->channels[i]);
if(channel->flags & DATA_CHANNEL_FLAGS_SEND_REQ) {
if(janus_sctp_send_open_request_message(sctp->sock, channel->stream,
channel->label, channel->unordered, channel->pr_policy, channel->pr_value)) {
channel->flags &= ~DATA_CHANNEL_FLAGS_SEND_REQ;
} else {
if(errno != EAGAIN) {
/* XXX: error handling */
}
}
}
if(channel->flags & DATA_CHANNEL_FLAGS_SEND_RSP) {
if(janus_sctp_send_open_response_message(sctp->sock, channel->stream)) {
channel->flags &= ~DATA_CHANNEL_FLAGS_SEND_RSP;
} else {
if(errno != EAGAIN) {
/* XXX: error handling */
}
}
}
if(channel->flags & DATA_CHANNEL_FLAGS_SEND_ACK) {
if(janus_sctp_send_open_ack_message(sctp->sock, channel->stream)) {
channel->flags &= ~DATA_CHANNEL_FLAGS_SEND_ACK;
} else {
if(errno != EAGAIN) {
/* XXX: error handling */
}
}
}
}
return;
}
int janus_sctp_open_channel(janus_sctp_association *sctp, char *label, uint8_t unordered, uint16_t pr_policy, uint32_t pr_value) {
if(sctp == NULL)
return -1;
janus_sctp_channel *channel;
uint16_t stream;
if((pr_policy != SCTP_PR_SCTP_NONE) &&
(pr_policy != SCTP_PR_SCTP_TTL) &&
(pr_policy != SCTP_PR_SCTP_RTX)) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] Invalid pr_policy %"SCNu32"\n", sctp->handle_id, pr_policy);
return -1;
}
if((pr_policy == SCTP_PR_SCTP_NONE) && (pr_value != 0)) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] Invalid pr_value %"SCNu32" for SCTP_PR_SCTP_NONE\n", sctp->handle_id, pr_value);
return -1;
}
if((channel = janus_sctp_find_free_channel(sctp)) == NULL) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] No more free channels available\n", sctp->handle_id);
return -1;
}
stream = janus_sctp_find_free_stream(sctp);
channel->state = DATA_CHANNEL_CONNECTING;
channel->unordered = unordered ? 1 : 0;
channel->pr_policy = pr_policy;
channel->pr_value = pr_value;
channel->stream = stream;
channel->flags = 0;
g_snprintf(channel->label, sizeof(channel->label), "%s", (label ? label : default_label));
if(stream == 0) {
janus_sctp_request_more_streams(sctp);
} else {
if(janus_sctp_send_open_request_message(sctp->sock, stream, channel->label, unordered, pr_policy, pr_value)) {
sctp->stream_channel[stream] = channel;
} else {
if(errno == EAGAIN) {
sctp->stream_channel[stream] = channel;
channel->flags |= DATA_CHANNEL_FLAGS_SEND_REQ;
} else {
channel->label[0] = '\0';
channel->state = DATA_CHANNEL_CLOSED;
channel->unordered = 0;
channel->pr_policy = 0;
channel->pr_value = 0;
channel->stream = 0;
channel->flags = 0;
channel = NULL;
}
}
}
return 0;
}
int janus_sctp_send_text_or_binary(janus_sctp_association *sctp, uint16_t id, gboolean textdata, char *text, size_t length) {
if(id >= NUMBER_OF_CHANNELS || text == NULL)
return -1;
struct sctp_sendv_spa spa;
janus_sctp_channel *channel = &sctp->channels[id];
if(channel == NULL) {
/* No such channel */
JANUS_LOG(LOG_ERR, "[%"SCNu64"] No such channel %"SCNu16"...\n", sctp->handle_id, id);
return -1;
}
if((channel->state != DATA_CHANNEL_OPEN) && (channel->state != DATA_CHANNEL_CONNECTING)) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] Channel %"SCNu16" is neither open nor connecting (state=%d)...\n", sctp->handle_id, id, channel->state);
return -1;
}
memset(&spa, 0, sizeof(struct sctp_sendv_spa));
spa.sendv_sndinfo.snd_sid = channel->stream;
if((channel->state == DATA_CHANNEL_OPEN) && (channel->unordered)) {
spa.sendv_sndinfo.snd_flags = SCTP_EOR | SCTP_UNORDERED;
} else {
spa.sendv_sndinfo.snd_flags = SCTP_EOR;
}
spa.sendv_sndinfo.snd_ppid = htonl(textdata ? DATA_CHANNEL_PPID_DOMSTRING : DATA_CHANNEL_PPID_BINARY);
spa.sendv_flags = SCTP_SEND_SNDINFO_VALID;
if((channel->pr_policy == SCTP_PR_SCTP_TTL) || (channel->pr_policy == SCTP_PR_SCTP_RTX)) {
spa.sendv_prinfo.pr_policy = channel->pr_policy;
spa.sendv_prinfo.pr_value = channel->pr_value;
spa.sendv_flags |= SCTP_SEND_PRINFO_VALID;
}
if(usrsctp_sendv(sctp->sock, text, length, NULL, 0,
&spa, (socklen_t)sizeof(struct sctp_sendv_spa),
SCTP_SENDV_SPA, 0) < 0) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] sctp_sendv error (%d)\n", sctp->handle_id, errno);
return -1;
}
JANUS_LOG(LOG_VERB, "[%"SCNu64"] Message sent on channel %"SCNu16"\n", sctp->handle_id, id);
return 0;
}
void janus_sctp_reset_outgoing_stream(janus_sctp_association *sctp, uint16_t stream) {
uint32_t i;
for(i = 0; i < sctp->stream_buffer_counter; i++) {
if(sctp->stream_buffer[i] == stream) {
return;
}
}
sctp->stream_buffer[sctp->stream_buffer_counter++] = stream;
return;
}
void janus_sctp_send_outgoing_stream_reset(janus_sctp_association *sctp) {
struct sctp_reset_streams *srs;
uint32_t i;
size_t len;
if(sctp->stream_buffer_counter == 0) {
return;
}
len = sizeof(sctp_assoc_t) + (2 + sctp->stream_buffer_counter) * sizeof(uint16_t);
srs = g_malloc0(len);
srs->srs_flags = SCTP_STREAM_RESET_OUTGOING;
srs->srs_number_streams = sctp->stream_buffer_counter;
for(i = 0; i < sctp->stream_buffer_counter; i++) {
srs->srs_stream_list[i] = sctp->stream_buffer[i];
}
if(usrsctp_setsockopt(sctp->sock, IPPROTO_SCTP, SCTP_RESET_STREAMS, srs, (socklen_t)len) < 0) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] setsockopt error: SCTP_RESET_STREAMS (%d)\n", sctp->handle_id, errno);
} else {
for(i = 0; i < sctp->stream_buffer_counter; i++) {
srs->srs_stream_list[i] = 0;
}
sctp->stream_buffer_counter = 0;
}
g_free(srs);
return;
}
int janus_sctp_close_channel(janus_sctp_association *sctp, uint16_t id) {
if(id >= NUMBER_OF_CHANNELS)
return -1;
janus_sctp_channel *channel = &sctp->channels[id];
if(channel == NULL) {
return -1;
}
if(channel->state != DATA_CHANNEL_OPEN) {
return -1;
}
janus_sctp_reset_outgoing_stream(sctp, channel->stream);
janus_sctp_send_outgoing_stream_reset(sctp);
channel->state = DATA_CHANNEL_CLOSING;
return 0;
}
void janus_sctp_handle_open_request_message(janus_sctp_association *sctp, janus_datachannel_open_request *req, size_t length, uint16_t stream) {
janus_sctp_channel *channel;
uint32_t pr_value;
uint16_t pr_policy;
uint8_t unordered;
if(stream >= NUMBER_OF_STREAMS) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] Exceeded number of allowed streams (%u > %u).\n", sctp->handle_id, (stream+1), NUMBER_OF_STREAMS);
/* XXX: some error handling */
return;
}
if((channel = janus_sctp_find_channel_by_stream(sctp, stream))) {
JANUS_LOG(LOG_ERR, "[%"SCNu64"] channel %d is in state %d instead of CLOSED.\n", sctp->handle_id, channel->id, channel->state);
/* XXX: some error handling */
return;
}
if((channel = janus_sctp_find_free_channel(sctp)) == NULL) {
/* XXX: some error handling */
return;
}
switch (req->channel_type) {
case DATA_CHANNEL_RELIABLE:
pr_policy = SCTP_PR_SCTP_NONE;
unordered = 0;
break;
case DATA_CHANNEL_RELIABLE_UNORDERED:
pr_policy = SCTP_PR_SCTP_NONE;
unordered = 1;
break;
case DATA_CHANNEL_PARTIAL_RELIABLE_TIMED:
pr_policy = SCTP_PR_SCTP_TTL;
unordered = 0;
break;
case DATA_CHANNEL_PARTIAL_RELIABLE_TIMED_UNORDERED:
pr_policy = SCTP_PR_SCTP_TTL;
unordered = 1;
break;
case DATA_CHANNEL_PARTIAL_RELIABLE_REXMIT:
pr_policy = SCTP_PR_SCTP_RTX;
unordered = 1;
break;
case DATA_CHANNEL_PARTIAL_RELIABLE_REXMIT_UNORDERED:
pr_policy = SCTP_PR_SCTP_RTX;
unordered = 1;
break;
default:
pr_policy = SCTP_PR_SCTP_NONE;
unordered = 0;
/* FIXME Should we handle some error, here? */
break;
}
pr_value = ntohs(req->reliability_params);
channel->state = DATA_CHANNEL_CONNECTING;
channel->unordered = unordered;
channel->pr_policy = pr_policy;
channel->pr_value = pr_value;
channel->stream = stream;
channel->flags = 0;
sctp->stream_channel[stream] = channel;
if(janus_sctp_send_open_ack_message(sctp->sock, stream)) {
sctp->stream_channel[stream] = channel;
} else {
if(errno == EAGAIN) {
channel->flags |= DATA_CHANNEL_FLAGS_SEND_ACK;
sctp->stream_channel[stream] = channel;
} else {
/* XXX: Signal error to the other end */
sctp->stream_channel[stream] = NULL;
channel->label[0] = '\0';
channel->state = DATA_CHANNEL_CLOSED;
channel->unordered = 0;
channel->pr_policy = 0;
channel->pr_value = 0;
channel->stream = 0;
channel->flags = 0;
}
}
/* Read label, if available */
char *label = NULL;
guint len = ntohs(req->label_length);
if(len > 0 && len < length) {
label = g_malloc(len+1);
memcpy(label, req->label, len);
label[len] = '\0';
g_snprintf(channel->label, sizeof(channel->label), "%s", label);
}
JANUS_LOG(LOG_VERB, "[%"SCNu64"] Opened channel '%s' (id=%"SCNu16") (%d/%d/%d)\n",
sctp->handle_id, label ? label : "??",
channel->stream, channel->unordered, channel->pr_policy, channel->pr_value);
g_free(label);
}
void janus_sctp_handle_open_response_message(janus_sctp_association *sctp, janus_datachannel_open_response *rsp, size_t length, uint16_t stream) {
janus_sctp_channel *channel;
channel = janus_sctp_find_channel_by_stream(sctp, stream);
if(channel == NULL) {
/* XXX: improve error handling */
JANUS_LOG(LOG_ERR, "[%"SCNu64"] Can't find channel for outgoing steam %d.\n", sctp->handle_id, stream);
return;
}
if(channel->state != DATA_CHANNEL_CONNECTING) {
/* XXX: improve error handling */
JANUS_LOG(LOG_ERR, "[%"SCNu64"] Channel with id %d for outgoing steam %d is in state %d.\n", sctp->handle_id, channel->id, stream, channel->state);
return;
}
if(janus_sctp_find_channel_by_stream(sctp, stream)) {
/* XXX: improve error handling */
JANUS_LOG(LOG_ERR, "[%"SCNu64"] Channel collision for channel with id %d and streams (in/out) = (%d/%d).\n", sctp->handle_id, channel->id, stream, stream);
return;
}
channel->stream = stream;
channel->state = DATA_CHANNEL_OPEN;
sctp->stream_channel[stream] = channel;
if(janus_sctp_send_open_ack_message(sctp->sock, stream)) {
channel->flags = 0;
} else {
channel->flags |= DATA_CHANNEL_FLAGS_SEND_ACK;
}
return;
}
void janus_sctp_handle_open_ack_message(janus_sctp_association *sctp, janus_datachannel_ack *ack, size_t length, uint16_t stream) {
janus_sctp_channel *channel;
channel = janus_sctp_find_channel_by_stream(sctp, stream);
if(channel == NULL) {
/* XXX: some error handling */
JANUS_LOG(LOG_ERR, "Ops, no channel with stream %"SCNu16"?\n", stream);
return;
}
if(channel->state == DATA_CHANNEL_OPEN) {
return;
}
if(channel->state != DATA_CHANNEL_CONNECTING) {
/* XXX: error handling */
return;
}
channel->state = DATA_CHANNEL_OPEN;
return;
}
void janus_sctp_handle_unknown_message(char *msg, size_t length, uint16_t stream) {
/* XXX: Send an error message */
return;
}
void janus_sctp_handle_data_message(janus_sctp_association *sctp, gboolean textdata, char *buffer, size_t length, uint16_t stream) {
janus_sctp_channel *channel;
channel = janus_sctp_find_channel_by_stream(sctp, stream);
if(channel == NULL) {
/* XXX: Some error handling */
JANUS_LOG(LOG_WARN, "[%"SCNu64"] Got data from this SCTP association but there is no channel with stream %"SCNu16"...\n", sctp->handle_id, stream);
return;
}
if(channel->state == DATA_CHANNEL_CONNECTING) {
/* Implicit ACK */
channel->state = DATA_CHANNEL_OPEN;
}
if(channel->state != DATA_CHANNEL_OPEN) {
/* XXX: What about other states? */
/* XXX: Some error handling */
JANUS_LOG(LOG_WARN, "[%"SCNu64"] Got data from this SCTP association but channel isn't open yet...\n", sctp->handle_id);
return;
} else {
/* XXX: Protect for non 0 terminated buffer */
JANUS_LOG(LOG_VERB, "[%"SCNu64"] SCTP data received of length %zu on channel with id %d.\n",
sctp->handle_id, length, channel->id);
JANUS_LOG(LOG_HUGE, "[%"SCNu64"] Incoming SCTP contents: %.*s\n",
sctp->handle_id, (int)length, buffer);
/* Pass this to the core */
janus_dtls_notify_data(sctp->dtls, channel->label, textdata, buffer, (int)length);
}
return;
}
void janus_sctp_handle_message(janus_sctp_association *sctp, char *buffer, size_t length, uint32_t ppid, uint16_t stream, int flags) {
janus_datachannel_open_request *req;
janus_datachannel_open_response *rsp;
janus_datachannel_ack *ack, *msg;
switch (ppid) {
case DATA_CHANNEL_PPID_CONTROL:
if(length < sizeof(janus_datachannel_ack)) {
return;
}
msg = (janus_datachannel_ack *)buffer;
switch (msg->msg_type) {
case DATA_CHANNEL_OPEN_REQUEST:
if(length < sizeof(janus_datachannel_open_request)) {
/* XXX: error handling? */
return;
}
req = (janus_datachannel_open_request *)buffer;
janus_sctp_handle_open_request_message(sctp, req, length, stream);
break;
case DATA_CHANNEL_OPEN_RESPONSE:
if(length < sizeof(janus_datachannel_open_response)) {
/* XXX: error handling? */
return;
}
rsp = (janus_datachannel_open_response *)buffer;
janus_sctp_handle_open_response_message(sctp, rsp, length, stream);
break;
case DATA_CHANNEL_ACK:
if(length < sizeof(janus_datachannel_ack)) {
/* XXX: error handling? */
return;
}
ack = (janus_datachannel_ack *)buffer;
janus_sctp_handle_open_ack_message(sctp, ack, length, stream);
break;
default:
janus_sctp_handle_unknown_message(buffer, length, stream);
break;
}
break;
case DATA_CHANNEL_PPID_DOMSTRING:
case DATA_CHANNEL_PPID_BINARY:
case DATA_CHANNEL_PPID_DOMSTRING_PARTIAL:
case DATA_CHANNEL_PPID_BINARY_PARTIAL:
if((flags & MSG_EOR) &&
ppid != DATA_CHANNEL_PPID_DOMSTRING_PARTIAL &&
ppid != DATA_CHANNEL_PPID_BINARY_PARTIAL) {
/* Message is complete, send it */
gboolean textdata = (ppid == DATA_CHANNEL_PPID_DOMSTRING || ppid == DATA_CHANNEL_PPID_DOMSTRING_PARTIAL);
if(sctp->offset > 0) {
/* We buffered multiple partial messages */
janus_sctp_handle_data_message(sctp, textdata, sctp->buffer, sctp->offset, stream);
sctp->offset = 0;
} else {
/* No buffering done, send this message as it is */
janus_sctp_handle_data_message(sctp, textdata, buffer, length, stream);
}
} else {
/* Partial message, buffer only for now */
if(length > (sctp->buflen - sctp->offset)) {
/* (re)Allocate the buffer */