xref: /freebsd/sys/netinet/sctp_uio.h (revision c96ae1968a6ab7056427a739bce81bf07447c2d4)
1 /*-
2  * Copyright (c) 2001-2006, Cisco Systems, Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * a) Redistributions of source code must retain the above copyright notice,
8  *   this list of conditions and the following disclaimer.
9  *
10  * b) Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *   the documentation and/or other materials provided with the distribution.
13  *
14  * c) Neither the name of Cisco Systems, Inc. nor the names of its
15  *    contributors may be used to endorse or promote products derived
16  *    from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
28  * THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 /* $KAME: sctp_uio.h,v 1.11 2005/03/06 16:04:18 itojun Exp $	 */
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
34 
35 #ifndef __sctp_uio_h__
36 #define __sctp_uio_h__
37 
38 
39 
40 
41 #if ! defined(_KERNEL)
42 #include <stdint.h>
43 #endif
44 #include <sys/types.h>
45 #include <sys/socket.h>
46 #include <netinet/in.h>
47 
48 typedef uint32_t sctp_assoc_t;
49 
50 /* On/Off setup for subscription to events */
51 struct sctp_event_subscribe {
52 	uint8_t sctp_data_io_event;
53 	uint8_t sctp_association_event;
54 	uint8_t sctp_address_event;
55 	uint8_t sctp_send_failure_event;
56 	uint8_t sctp_peer_error_event;
57 	uint8_t sctp_shutdown_event;
58 	uint8_t sctp_partial_delivery_event;
59 	uint8_t sctp_adaptation_layer_event;
60 	uint8_t sctp_authentication_event;
61 	uint8_t sctp_stream_reset_events;
62 };
63 
64 /* ancillary data types */
65 #define SCTP_INIT	0x0001
66 #define SCTP_SNDRCV	0x0002
67 #define SCTP_EXTRCV	0x0003
68 /*
69  * ancillary data structures
70  */
71 struct sctp_initmsg {
72 	uint32_t sinit_num_ostreams;
73 	uint32_t sinit_max_instreams;
74 	uint16_t sinit_max_attempts;
75 	uint16_t sinit_max_init_timeo;
76 };
77 
78 /* We add 96 bytes to the size of sctp_sndrcvinfo.
79  * This makes the current structure 128 bytes long
80  * which is nicely 64 bit aligned but also has room
81  * for us to add more and keep ABI compatability.
82  * For example, already we have the sctp_extrcvinfo
83  * when enabled which is 48 bytes.
84  */
85 
86 #define SCTP_ALIGN_RESV_PAD 96
87 
88 struct sctp_sndrcvinfo {
89 	uint16_t sinfo_stream;
90 	uint16_t sinfo_ssn;
91 	uint16_t sinfo_flags;
92 	uint32_t sinfo_ppid;
93 	uint32_t sinfo_context;
94 	uint32_t sinfo_timetolive;
95 	uint32_t sinfo_tsn;
96 	uint32_t sinfo_cumtsn;
97 	sctp_assoc_t sinfo_assoc_id;
98 	uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD];
99 };
100 
101 struct sctp_extrcvinfo {
102 	uint16_t sinfo_stream;
103 	uint16_t sinfo_ssn;
104 	uint16_t sinfo_flags;
105 	uint32_t sinfo_ppid;
106 	uint32_t sinfo_context;
107 	uint32_t sinfo_timetolive;
108 	uint32_t sinfo_tsn;
109 	uint32_t sinfo_cumtsn;
110 	sctp_assoc_t sinfo_assoc_id;
111 	uint16_t next_flags;
112 	uint16_t next_stream;
113 	uint32_t next_asocid;
114 	uint32_t next_length;
115 	uint32_t next_ppid;
116 };
117 
118 #define SCTP_NO_NEXT_MSG           0x0000
119 #define SCTP_NEXT_MSG_AVAIL        0x0001
120 #define SCTP_NEXT_MSG_ISCOMPLETE   0x0002
121 #define SCTP_NEXT_MSG_IS_UNORDERED 0x0004
122 
123 struct sctp_snd_all_completes {
124 	uint16_t sall_stream;
125 	uint16_t sall_flags;
126 	uint32_t sall_ppid;
127 	uint32_t sall_context;
128 	uint32_t sall_num_sent;
129 	uint32_t sall_num_failed;
130 };
131 
132 /* Flags that go into the sinfo->sinfo_flags field */
133 #define SCTP_EOF 	  0x0100/* Start shutdown procedures */
134 #define SCTP_ABORT	  0x0200/* Send an ABORT to peer */
135 #define SCTP_UNORDERED 	  0x0400/* Message is un-ordered */
136 #define SCTP_ADDR_OVER	  0x0800/* Override the primary-address */
137 #define SCTP_SENDALL      0x1000/* Send this on all associations */
138 #define SCTP_EOR          0x2000/* end of message signal */
139 #define INVALID_SINFO_FLAG(x) (((x) & 0xffffff00 \
140                                     & ~(SCTP_EOF | SCTP_ABORT | SCTP_UNORDERED |\
141 				        SCTP_ADDR_OVER | SCTP_SENDALL | SCTP_EOR)) != 0)
142 /* for the endpoint */
143 
144 /* The lower byte is an enumeration of PR-SCTP policies */
145 #define SCTP_PR_SCTP_TTL  0x0001/* Time based PR-SCTP */
146 #define SCTP_PR_SCTP_BUF  0x0002/* Buffer based PR-SCTP */
147 #define SCTP_PR_SCTP_RTX  0x0003/* Number of retransmissions based PR-SCTP */
148 
149 #define PR_SCTP_POLICY(x)         ((x) & 0xff)
150 #define PR_SCTP_ENABLED(x)        (PR_SCTP_POLICY(x) != 0)
151 #define PR_SCTP_TTL_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_TTL)
152 #define PR_SCTP_BUF_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_BUF)
153 #define PR_SCTP_RTX_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_RTX)
154 #define PR_SCTP_INVALID_POLICY(x) (PR_SCTP_POLICY(x) > SCTP_PR_SCTP_RTX)
155 /* Stat's */
156 struct sctp_pcbinfo {
157 	uint32_t ep_count;
158 	uint32_t asoc_count;
159 	uint32_t laddr_count;
160 	uint32_t raddr_count;
161 	uint32_t chk_count;
162 	uint32_t readq_count;
163 	uint32_t free_chunks;
164 	uint32_t stream_oque;
165 };
166 
167 struct sctp_sockstat {
168 	sctp_assoc_t ss_assoc_id;
169 	uint32_t ss_total_sndbuf;
170 	uint32_t ss_total_recv_buf;
171 };
172 
173 /*
174  * notification event structures
175  */
176 
177 /*
178  * association change event
179  */
180 struct sctp_assoc_change {
181 	uint16_t sac_type;
182 	uint16_t sac_flags;
183 	uint32_t sac_length;
184 	uint16_t sac_state;
185 	uint16_t sac_error;
186 	uint16_t sac_outbound_streams;
187 	uint16_t sac_inbound_streams;
188 	sctp_assoc_t sac_assoc_id;
189 };
190 
191 /* sac_state values */
192 #define SCTP_COMM_UP		0x0001
193 #define SCTP_COMM_LOST		0x0002
194 #define SCTP_RESTART		0x0003
195 #define SCTP_SHUTDOWN_COMP	0x0004
196 #define SCTP_CANT_STR_ASSOC	0x0005
197 
198 
199 /*
200  * Address event
201  */
202 struct sctp_paddr_change {
203 	uint16_t spc_type;
204 	uint16_t spc_flags;
205 	uint32_t spc_length;
206 	struct sockaddr_storage spc_aaddr;
207 	uint32_t spc_state;
208 	uint32_t spc_error;
209 	sctp_assoc_t spc_assoc_id;
210 };
211 
212 /* paddr state values */
213 #define SCTP_ADDR_AVAILABLE	0x0001
214 #define SCTP_ADDR_UNREACHABLE	0x0002
215 #define SCTP_ADDR_REMOVED	0x0003
216 #define SCTP_ADDR_ADDED		0x0004
217 #define SCTP_ADDR_MADE_PRIM	0x0005
218 #define SCTP_ADDR_CONFIRMED	0x0006
219 
220 /*
221  * CAUTION: these are user exposed SCTP addr reachability states must be
222  * compatible with SCTP_ADDR states in sctp_constants.h
223  */
224 #ifdef SCTP_ACTIVE
225 #undef SCTP_ACTIVE
226 #endif
227 #define SCTP_ACTIVE		0x0001	/* SCTP_ADDR_REACHABLE */
228 
229 #ifdef SCTP_INACTIVE
230 #undef SCTP_INACTIVE
231 #endif
232 #define SCTP_INACTIVE		0x0002	/* SCTP_ADDR_NOT_REACHABLE */
233 
234 #ifdef SCTP_UNCONFIRMED
235 #undef SCTP_UNCONFIRMED
236 #endif
237 #define SCTP_UNCONFIRMED	0x0200	/* SCTP_ADDR_UNCONFIRMED */
238 
239 #ifdef SCTP_NOHEARTBEAT
240 #undef SCTP_NOHEARTBEAT
241 #endif
242 #define SCTP_NOHEARTBEAT	0x0040	/* SCTP_ADDR_NOHB */
243 
244 
245 /* remote error events */
246 struct sctp_remote_error {
247 	uint16_t sre_type;
248 	uint16_t sre_flags;
249 	uint32_t sre_length;
250 	uint16_t sre_error;
251 	sctp_assoc_t sre_assoc_id;
252 	uint8_t sre_data[4];
253 };
254 
255 /* data send failure event */
256 struct sctp_send_failed {
257 	uint16_t ssf_type;
258 	uint16_t ssf_flags;
259 	uint32_t ssf_length;
260 	uint32_t ssf_error;
261 	struct sctp_sndrcvinfo ssf_info;
262 	sctp_assoc_t ssf_assoc_id;
263 	uint8_t ssf_data[4];
264 };
265 
266 /* flag that indicates state of data */
267 #define SCTP_DATA_UNSENT	0x0001	/* inqueue never on wire */
268 #define SCTP_DATA_SENT		0x0002	/* on wire at failure */
269 
270 /* shutdown event */
271 struct sctp_shutdown_event {
272 	uint16_t sse_type;
273 	uint16_t sse_flags;
274 	uint32_t sse_length;
275 	sctp_assoc_t sse_assoc_id;
276 };
277 
278 /* Adaptation layer indication stuff */
279 struct sctp_adaptation_event {
280 	uint16_t sai_type;
281 	uint16_t sai_flags;
282 	uint32_t sai_length;
283 	uint32_t sai_adaptation_ind;
284 	sctp_assoc_t sai_assoc_id;
285 };
286 
287 struct sctp_setadaptation {
288 	uint32_t ssb_adaptation_ind;
289 };
290 
291 /* compatable old spelling */
292 struct sctp_adaption_event {
293 	uint16_t sai_type;
294 	uint16_t sai_flags;
295 	uint32_t sai_length;
296 	uint32_t sai_adaption_ind;
297 	sctp_assoc_t sai_assoc_id;
298 };
299 
300 struct sctp_setadaption {
301 	uint32_t ssb_adaption_ind;
302 };
303 
304 
305 /*
306  * Partial Delivery API event
307  */
308 struct sctp_pdapi_event {
309 	uint16_t pdapi_type;
310 	uint16_t pdapi_flags;
311 	uint32_t pdapi_length;
312 	uint32_t pdapi_indication;
313 	sctp_assoc_t pdapi_assoc_id;
314 };
315 
316 /* indication values */
317 #define SCTP_PARTIAL_DELIVERY_ABORTED	0x0001
318 
319 
320 /*
321  * authentication key event
322  */
323 struct sctp_authkey_event {
324 	uint16_t auth_type;
325 	uint16_t auth_flags;
326 	uint32_t auth_length;
327 	uint16_t auth_keynumber;
328 	uint16_t auth_altkeynumber;
329 	uint32_t auth_indication;
330 	sctp_assoc_t auth_assoc_id;
331 };
332 
333 /* indication values */
334 #define SCTP_AUTH_NEWKEY	0x0001
335 
336 
337 /*
338  * stream reset event
339  */
340 struct sctp_stream_reset_event {
341 	uint16_t strreset_type;
342 	uint16_t strreset_flags;
343 	uint32_t strreset_length;
344 	sctp_assoc_t strreset_assoc_id;
345 	uint16_t strreset_list[0];
346 };
347 
348 /* flags in strreset_flags field */
349 #define SCTP_STRRESET_INBOUND_STR  0x0001
350 #define SCTP_STRRESET_OUTBOUND_STR 0x0002
351 #define SCTP_STRRESET_ALL_STREAMS  0x0004
352 #define SCTP_STRRESET_STREAM_LIST  0x0008
353 #define SCTP_STRRESET_FAILED       0x0010
354 
355 
356 /* SCTP notification event */
357 struct sctp_tlv {
358 	uint16_t sn_type;
359 	uint16_t sn_flags;
360 	uint32_t sn_length;
361 };
362 
363 union sctp_notification {
364 	struct sctp_tlv sn_header;
365 	struct sctp_assoc_change sn_assoc_change;
366 	struct sctp_paddr_change sn_paddr_change;
367 	struct sctp_remote_error sn_remote_error;
368 	struct sctp_send_failed sn_send_failed;
369 	struct sctp_shutdown_event sn_shutdown_event;
370 	struct sctp_adaptation_event sn_adaptation_event;
371 	/* compatability same as above */
372 	struct sctp_adaption_event sn_adaption_event;
373 	struct sctp_pdapi_event sn_pdapi_event;
374 	struct sctp_authkey_event sn_auth_event;
375 	struct sctp_stream_reset_event sn_strreset_event;
376 };
377 
378 /* notification types */
379 #define SCTP_ASSOC_CHANGE		0x0001
380 #define SCTP_PEER_ADDR_CHANGE		0x0002
381 #define SCTP_REMOTE_ERROR		0x0003
382 #define SCTP_SEND_FAILED		0x0004
383 #define SCTP_SHUTDOWN_EVENT		0x0005
384 #define SCTP_ADAPTATION_INDICATION	0x0006
385 /* same as above */
386 #define SCTP_ADAPTION_INDICATION	0x0006
387 #define SCTP_PARTIAL_DELIVERY_EVENT	0x0007
388 #define SCTP_AUTHENTICATION_EVENT	0x0008
389 #define SCTP_STREAM_RESET_EVENT		0x0009
390 
391 
392 /*
393  * socket option structs
394  */
395 
396 struct sctp_paddrparams {
397 	sctp_assoc_t spp_assoc_id;
398 	struct sockaddr_storage spp_address;
399 	uint32_t spp_hbinterval;
400 	uint16_t spp_pathmaxrxt;
401 	uint32_t spp_pathmtu;
402 	uint32_t spp_sackdelay;
403 	uint32_t spp_flags;
404 	uint32_t spp_ipv6_flowlabel;
405 	uint8_t spp_ipv4_tos;
406 
407 };
408 
409 #define SPP_HB_ENABLE		0x00000001
410 #define SPP_HB_DISABLE		0x00000002
411 #define SPP_HB_DEMAND		0x00000004
412 #define SPP_PMTUD_ENABLE	0x00000008
413 #define SPP_PMTUD_DISABLE	0x00000010
414 #define SPP_SACKDELAY_ENABLE	0x00000020
415 #define SPP_SACKDELAY_DISABLE	0x00000040
416 #define SPP_HB_TIME_IS_ZERO     0x00000080
417 #define SPP_IPV6_FLOWLABEL      0x00000100
418 #define SPP_IPV4_TOS            0x00000200
419 
420 struct sctp_paddrinfo {
421 	sctp_assoc_t spinfo_assoc_id;
422 	struct sockaddr_storage spinfo_address;
423 	int32_t spinfo_state;
424 	uint32_t spinfo_cwnd;
425 	uint32_t spinfo_srtt;
426 	uint32_t spinfo_rto;
427 	uint32_t spinfo_mtu;
428 };
429 
430 struct sctp_rtoinfo {
431 	sctp_assoc_t srto_assoc_id;
432 	uint32_t srto_initial;
433 	uint32_t srto_max;
434 	uint32_t srto_min;
435 };
436 
437 struct sctp_assocparams {
438 	sctp_assoc_t sasoc_assoc_id;
439 	uint16_t sasoc_asocmaxrxt;
440 	uint16_t sasoc_number_peer_destinations;
441 	uint32_t sasoc_peer_rwnd;
442 	uint32_t sasoc_local_rwnd;
443 	uint32_t sasoc_cookie_life;
444 };
445 
446 struct sctp_setprim {
447 	sctp_assoc_t ssp_assoc_id;
448 	struct sockaddr_storage ssp_addr;
449 };
450 
451 struct sctp_setpeerprim {
452 	sctp_assoc_t sspp_assoc_id;
453 	struct sockaddr_storage sspp_addr;
454 };
455 
456 struct sctp_getaddresses {
457 	sctp_assoc_t sget_assoc_id;
458 	/* addr is filled in for N * sockaddr_storage */
459 	struct sockaddr addr[1];
460 };
461 
462 struct sctp_setstrm_timeout {
463 	sctp_assoc_t ssto_assoc_id;
464 	uint32_t ssto_timeout;
465 	uint32_t ssto_streamid_start;
466 	uint32_t ssto_streamid_end;
467 };
468 
469 struct sctp_status {
470 	sctp_assoc_t sstat_assoc_id;
471 	int32_t sstat_state;
472 	uint32_t sstat_rwnd;
473 	uint16_t sstat_unackdata;
474 	uint16_t sstat_penddata;
475 	uint16_t sstat_instrms;
476 	uint16_t sstat_outstrms;
477 	uint32_t sstat_fragmentation_point;
478 	struct sctp_paddrinfo sstat_primary;
479 };
480 
481 /*
482  * AUTHENTICATION support
483  */
484 /* SCTP_AUTH_CHUNK */
485 struct sctp_authchunk {
486 	uint8_t sauth_chunk;
487 };
488 
489 /* SCTP_AUTH_KEY */
490 struct sctp_authkey {
491 	sctp_assoc_t sca_assoc_id;
492 	uint16_t sca_keynumber;
493 	uint8_t sca_key[0];
494 };
495 
496 /* SCTP_HMAC_IDENT */
497 struct sctp_hmacalgo {
498 	uint16_t shmac_idents[0];
499 };
500 
501 /* AUTH hmac_id */
502 #define SCTP_AUTH_HMAC_ID_RSVD		0x0000
503 #define SCTP_AUTH_HMAC_ID_SHA1		0x0001	/* default, mandatory */
504 #define SCTP_AUTH_HMAC_ID_MD5		0x0002	/* deprecated */
505 #define SCTP_AUTH_HMAC_ID_SHA256	0x0003
506 #define SCTP_AUTH_HMAC_ID_SHA224	0x8001
507 #define SCTP_AUTH_HMAC_ID_SHA384	0x8002
508 #define SCTP_AUTH_HMAC_ID_SHA512	0x8003
509 
510 
511 /* SCTP_AUTH_ACTIVE_KEY / SCTP_AUTH_DELETE_KEY */
512 struct sctp_authkeyid {
513 	sctp_assoc_t scact_assoc_id;
514 	uint16_t scact_keynumber;
515 };
516 
517 /* SCTP_PEER_AUTH_CHUNKS / SCTP_LOCAL_AUTH_CHUNKS */
518 struct sctp_authchunks {
519 	sctp_assoc_t gauth_assoc_id;
520 	uint8_t gauth_chunks[0];
521 };
522 
523 struct sctp_assoc_value {
524 	sctp_assoc_t assoc_id;
525 	uint32_t assoc_value;
526 };
527 
528 #define MAX_ASOC_IDS_RET 255
529 struct sctp_assoc_ids {
530 	uint16_t asls_assoc_start;	/* array of index's start at 0 */
531 	uint8_t asls_numb_present;
532 	uint8_t asls_more_to_get;
533 	sctp_assoc_t asls_assoc_id[MAX_ASOC_IDS_RET];
534 };
535 
536 struct sctp_cwnd_args {
537 	struct sctp_nets *net;	/* network to */
538 	uint32_t cwnd_new_value;/* cwnd in k */
539 	uint32_t inflight;	/* flightsize in k */
540 	uint32_t pseudo_cumack;
541 	int cwnd_augment;	/* increment to it */
542 	uint8_t meets_pseudo_cumack;
543 	uint8_t need_new_pseudo_cumack;
544 	uint8_t cnt_in_send;
545 	uint8_t cnt_in_str;
546 };
547 
548 struct sctp_blk_args {
549 	uint32_t onsb;		/* in 1k bytes */
550 	uint32_t sndlen;	/* len of send being attempted */
551 	uint32_t peer_rwnd;	/* rwnd of peer */
552 	uint16_t send_sent_qcnt;/* chnk cnt */
553 	uint16_t stream_qcnt;	/* chnk cnt */
554 	uint16_t chunks_on_oque;/* chunks out */
555 	uint16_t flight_size;	/* flight size in k */
556 };
557 
558 /*
559  * Max we can reset in one setting, note this is dictated not by the define
560  * but the size of a mbuf cluster so don't change this define and think you
561  * can specify more. You must do multiple resets if you want to reset more
562  * than SCTP_MAX_EXPLICIT_STR_RESET.
563  */
564 #define SCTP_MAX_EXPLICT_STR_RESET   1000
565 
566 #define SCTP_RESET_LOCAL_RECV  0x0001
567 #define SCTP_RESET_LOCAL_SEND  0x0002
568 #define SCTP_RESET_BOTH        0x0003
569 #define SCTP_RESET_TSN         0x0004
570 
571 struct sctp_stream_reset {
572 	sctp_assoc_t strrst_assoc_id;
573 	uint16_t strrst_flags;
574 	uint16_t strrst_num_streams;	/* 0 == ALL */
575 	uint16_t strrst_list[0];/* list if strrst_num_streams is not 0 */
576 };
577 
578 
579 struct sctp_get_nonce_values {
580 	sctp_assoc_t gn_assoc_id;
581 	uint32_t gn_peers_tag;
582 	uint32_t gn_local_tag;
583 };
584 
585 /* Debugging logs */
586 struct sctp_str_log {
587 	void *stcb;
588 	uint32_t n_tsn;
589 	uint32_t e_tsn;
590 	uint16_t n_sseq;
591 	uint16_t e_sseq;
592 	uint16_t strm;
593 };
594 
595 struct sctp_sb_log {
596 	void *stcb;
597 	uint32_t so_sbcc;
598 	uint32_t stcb_sbcc;
599 	uint32_t incr;
600 };
601 
602 struct sctp_fr_log {
603 	uint32_t largest_tsn;
604 	uint32_t largest_new_tsn;
605 	uint32_t tsn;
606 };
607 
608 struct sctp_fr_map {
609 	uint32_t base;
610 	uint32_t cum;
611 	uint32_t high;
612 };
613 
614 struct sctp_rwnd_log {
615 	uint32_t rwnd;
616 	uint32_t send_size;
617 	uint32_t overhead;
618 	uint32_t new_rwnd;
619 };
620 
621 struct sctp_mbcnt_log {
622 	uint32_t total_queue_size;
623 	uint32_t size_change;
624 	uint32_t total_queue_mb_size;
625 	uint32_t mbcnt_change;
626 };
627 
628 struct sctp_sack_log {
629 	uint32_t cumack;
630 	uint32_t oldcumack;
631 	uint32_t tsn;
632 	uint16_t numGaps;
633 	uint16_t numDups;
634 };
635 
636 struct sctp_lock_log {
637 	void *sock;
638 	void *inp;
639 	uint8_t tcb_lock;
640 	uint8_t inp_lock;
641 	uint8_t info_lock;
642 	uint8_t sock_lock;
643 	uint8_t sockrcvbuf_lock;
644 	uint8_t socksndbuf_lock;
645 	uint8_t create_lock;
646 	uint8_t resv;
647 };
648 
649 struct sctp_rto_log {
650 	void *net;
651 	uint32_t rtt;
652 	uint32_t rttvar;
653 	uint8_t direction;
654 };
655 
656 struct sctp_nagle_log {
657 	void *stcb;
658 	uint32_t total_flight;
659 	uint32_t total_in_queue;
660 	uint16_t count_in_queue;
661 	uint16_t count_in_flight;
662 };
663 
664 struct sctp_sbwake_log {
665 	void *stcb;
666 	uint16_t send_q;
667 	uint16_t sent_q;
668 	uint16_t flight;
669 	uint16_t wake_cnt;
670 	uint8_t stream_qcnt;	/* chnk cnt */
671 	uint8_t chunks_on_oque;	/* chunks out */
672 	uint8_t sbflags;
673 	uint8_t sctpflags;
674 };
675 
676 struct sctp_misc_info {
677 	uint32_t log1;
678 	uint32_t log2;
679 	uint32_t log3;
680 	uint32_t log4;
681 };
682 
683 struct sctp_log_closing {
684 	void *inp;
685 	void *stcb;
686 	uint32_t sctp_flags;
687 	uint16_t state;
688 	int16_t loc;
689 };
690 
691 struct sctp_mbuf_log {
692 	struct mbuf *mp;
693 	caddr_t ext;
694 	caddr_t data;
695 	uint16_t size;
696 	uint8_t refcnt;
697 	uint8_t mbuf_flags;
698 };
699 
700 struct sctp_cwnd_log {
701 	uint32_t time_event;
702 	uint8_t from;
703 	uint8_t event_type;
704 	uint8_t resv[2];
705 	union {
706 		struct sctp_log_closing close;
707 		struct sctp_blk_args blk;
708 		struct sctp_cwnd_args cwnd;
709 		struct sctp_str_log strlog;
710 		struct sctp_fr_log fr;
711 		struct sctp_fr_map map;
712 		struct sctp_rwnd_log rwnd;
713 		struct sctp_mbcnt_log mbcnt;
714 		struct sctp_sack_log sack;
715 		struct sctp_lock_log lock;
716 		struct sctp_rto_log rto;
717 		struct sctp_sb_log sb;
718 		struct sctp_nagle_log nagle;
719 		struct sctp_sbwake_log wake;
720 		struct sctp_mbuf_log mb;
721 		struct sctp_misc_info misc;
722 	}     x;
723 };
724 
725 struct sctp_cwnd_log_req {
726 	int num_in_log;		/* Number in log */
727 	int num_ret;		/* Number returned */
728 	int start_at;		/* start at this one */
729 	int end_at;		/* end at this one */
730 	struct sctp_cwnd_log log[0];
731 };
732 
733 struct sctpstat {
734 	/* MIB according to RFC 3873 */
735 	u_long sctps_currestab;	/* sctpStats  1   (Gauge32) */
736 	u_long sctps_activeestab;	/* sctpStats  2 (Counter32) */
737 	u_long sctps_passiveestab;	/* sctpStats  3 (Counter32) */
738 	u_long sctps_aborted;	/* sctpStats  4 (Counter32) */
739 	u_long sctps_shutdown;	/* sctpStats  5 (Counter32) */
740 	u_long sctps_outoftheblue;	/* sctpStats  6 (Counter32) */
741 	u_long sctps_checksumerrors;	/* sctpStats  7 (Counter32) */
742 	u_long sctps_outcontrolchunks;	/* sctpStats  8 (Counter64) */
743 	u_long sctps_outorderchunks;	/* sctpStats  9 (Counter64) */
744 	u_long sctps_outunorderchunks;	/* sctpStats 10 (Counter64) */
745 	u_long sctps_incontrolchunks;	/* sctpStats 11 (Counter64) */
746 	u_long sctps_inorderchunks;	/* sctpStats 12 (Counter64) */
747 	u_long sctps_inunorderchunks;	/* sctpStats 13 (Counter64) */
748 	u_long sctps_fragusrmsgs;	/* sctpStats 14 (Counter64) */
749 	u_long sctps_reasmusrmsgs;	/* sctpStats 15 (Counter64) */
750 	u_long sctps_outpackets;/* sctpStats 16 (Counter64) */
751 	u_long sctps_inpackets;	/* sctpStats 17 (Counter64) */
752 	u_long sctps_discontinuitytime;	/* sctpStats 18 (TimeStamp) */
753 	/* input statistics: */
754 	u_long sctps_recvpackets;	/* total input packets        */
755 	u_long sctps_recvdatagrams;	/* total input datagrams      */
756 	u_long sctps_recvpktwithdata;
757 	u_long sctps_recvsacks;	/* total input SACK chunks    */
758 	u_long sctps_recvdata;	/* total input DATA chunks    */
759 	u_long sctps_recvdupdata;	/* total input duplicate DATA chunks */
760 	u_long sctps_recvheartbeat;	/* total input HB chunks      */
761 	u_long sctps_recvheartbeatack;	/* total input HB-ACK chunks  */
762 	u_long sctps_recvecne;	/* total input ECNE chunks    */
763 	u_long sctps_recvauth;	/* total input AUTH chunks    */
764 	u_long sctps_recvauthmissing;	/* total input chunks missing AUTH */
765 	u_long sctps_recvivalhmacid;	/* total number of invalid HMAC ids
766 					 * received */
767 	u_long sctps_recvivalkeyid;	/* total number of invalid secret ids
768 					 * received */
769 	u_long sctps_recvauthfailed;	/* total number of auth failed */
770 	u_long sctps_recvexpress;	/* total fast path receives all one
771 					 * chunk */
772 	u_long sctps_recvexpressm;	/* total fast path multi-part data */
773 	/* output statistics: */
774 	u_long sctps_sendpackets;	/* total output packets       */
775 	u_long sctps_sendsacks;	/* total output SACKs         */
776 	u_long sctps_senddata;	/* total output DATA chunks   */
777 	u_long sctps_sendretransdata;	/* total output retransmitted DATA
778 					 * chunks */
779 	u_long sctps_sendfastretrans;	/* total output fast retransmitted
780 					 * DATA chunks */
781 	u_long sctps_sendmultfastretrans;	/* U-del */
782 	u_long sctps_sendheartbeat;	/* total output HB chunks     */
783 	u_long sctps_sendecne;	/* total output ECNE chunks    */
784 	u_long sctps_sendauth;	/* total output AUTH chunks FIXME   */
785 	u_long sctps_senderrors;/* ip_output error counter */
786 	/* PCKDROPREP statistics: */
787 	u_long sctps_pdrpfmbox;	/* */
788 	u_long sctps_pdrpfehos;	/* */
789 	u_long sctps_pdrpmbda;	/* */
790 	u_long sctps_pdrpmbct;	/* */
791 	u_long sctps_pdrpbwrpt;	/* */
792 	u_long sctps_pdrpcrupt;	/* */
793 	u_long sctps_pdrpnedat;	/* */
794 	u_long sctps_pdrppdbrk;	/* */
795 	u_long sctps_pdrptsnnf;	/* */
796 	u_long sctps_pdrpdnfnd;	/* */
797 	u_long sctps_pdrpdiwnp;	/* */
798 	u_long sctps_pdrpdizrw;	/* */
799 	u_long sctps_pdrpbadd;	/* */
800 	u_long sctps_pdrpmark;	/* */
801 	/* timeouts */
802 	u_long sctps_timoiterator;	/* */
803 	u_long sctps_timodata;	/* */
804 	u_long sctps_timowindowprobe;	/* */
805 	u_long sctps_timoinit;	/* */
806 	u_long sctps_timosack;	/* */
807 	u_long sctps_timoshutdown;	/* */
808 	u_long sctps_timoheartbeat;	/* */
809 	u_long sctps_timocookie;/* */
810 	u_long sctps_timosecret;/* */
811 	u_long sctps_timopathmtu;	/* */
812 	u_long sctps_timoshutdownack;	/* */
813 	u_long sctps_timoshutdownguard;	/* */
814 	u_long sctps_timostrmrst;	/* */
815 	u_long sctps_timoearlyfr;	/* */
816 	u_long sctps_timoasconf;/* */
817 	u_long sctps_timoautoclose;	/* */
818 	u_long sctps_timoassockill;	/* */
819 	u_long sctps_timoinpkill;	/* */
820 	/* Early fast retransmission counters */
821 	u_long sctps_earlyfrstart;
822 	u_long sctps_earlyfrstop;
823 	u_long sctps_earlyfrmrkretrans;
824 	u_long sctps_earlyfrstpout;
825 	u_long sctps_earlyfrstpidsck1;
826 	u_long sctps_earlyfrstpidsck2;
827 	u_long sctps_earlyfrstpidsck3;
828 	u_long sctps_earlyfrstpidsck4;
829 	u_long sctps_earlyfrstrid;
830 	u_long sctps_earlyfrstrout;
831 	u_long sctps_earlyfrstrtmr;
832 	/* otheres */
833 	u_long sctps_hdrops;	/* packet shorter than header */
834 	u_long sctps_badsum;	/* checksum error             */
835 	u_long sctps_noport;	/* no endpoint for port       */
836 	u_long sctps_badvtag;	/* bad v-tag                  */
837 	u_long sctps_badsid;	/* bad SID                    */
838 	u_long sctps_nomem;	/* no memory                  */
839 	u_long sctps_fastretransinrtt;	/* number of multiple FR in a RTT
840 					 * window */
841 	u_long sctps_markedretrans;
842 	u_long sctps_naglesent;	/* nagle allowed sending      */
843 	u_long sctps_naglequeued;	/* nagle does't allow sending */
844 	u_long sctps_maxburstqueued;	/* max burst dosn't allow sending */
845 	u_long sctps_ifnomemqueued;	/* */
846 	u_long sctps_windowprobed;	/* total number of window probes sent */
847 	u_long sctps_lowlevelerr;
848 	u_long sctps_lowlevelerrusr;
849 	u_long sctps_datadropchklmt;
850 	u_long sctps_datadroprwnd;
851 	u_long sctps_ecnereducedcwnd;
852 	u_long sctps_vtagexpress;	/* Used express lookup via vtag */
853 	u_long sctps_vtagbogus;	/* Collision in express lookup. */
854 	u_long sctps_primary_randry;	/* Number of times the sender ran dry
855 					 * of user data on primary */
856 	u_long sctps_cmt_randry;/* Same for above */
857 	u_long sctps_slowpath_sack;	/* Sacks the slow way */
858 	u_long sctps_wu_sacks_sent;	/* Window Update only sacks sent */
859 	u_long sctps_sends_with_flags;	/* number of sends with sinfo_flags
860 					 * !=0 */
861 	u_long sctps_sends_with_unord;
862 	u_long sctps_sends_with_eof;
863 	u_long sctps_sends_with_abort;
864 	u_long sctps_protocol_drain_calls;
865 	u_long sctps_protocol_drains_done;
866 };
867 
868 #define SCTP_STAT_INCR(_x) SCTP_STAT_INCR_BY(_x,1)
869 #define SCTP_STAT_DECR(_x) SCTP_STAT_DECR_BY(_x,1)
870 #define SCTP_STAT_INCR_BY(_x,_d) atomic_add_long(&sctpstat._x, _d)
871 #define SCTP_STAT_DECR_BY(_x,_d) atomic_add_long(&sctpstat._x, -(_d))
872 /* The following macros are for handling MIB values, */
873 #define SCTP_STAT_INCR_COUNTER32(_x) SCTP_STAT_INCR(_x)
874 #define SCTP_STAT_INCR_COUNTER64(_x) SCTP_STAT_INCR(_x)
875 #define SCTP_STAT_INCR_GAUGE32(_x) SCTP_STAT_INCR(_x)
876 #define SCTP_STAT_DECR_COUNTER32(_x) SCTP_STAT_DECR(_x)
877 #define SCTP_STAT_DECR_COUNTER64(_x) SCTP_STAT_DECR(_x)
878 #define SCTP_STAT_DECR_GAUGE32(_x) SCTP_STAT_DECR(_x)
879 
880 union sctp_sockstore {
881 #ifdef AF_INET
882 	struct sockaddr_in sin;
883 #endif
884 #ifdef AF_INET6
885 	struct sockaddr_in6 sin6;
886 #endif
887 	struct sockaddr sa;
888 };
889 
890 struct xsctp_inpcb {
891 	uint32_t last;
892 	uint16_t local_port;
893 	uint16_t number_local_addresses;
894 	uint32_t number_associations;
895 	uint32_t flags;
896 	uint32_t features;
897 	uint32_t total_sends;
898 	uint32_t total_recvs;
899 	uint32_t total_nospaces;
900 	/* add more endpoint specific data here */
901 };
902 
903 struct xsctp_tcb {
904 	uint16_t remote_port;
905 	uint16_t number_local_addresses;
906 	uint16_t number_remote_addresses;
907 	uint16_t number_incomming_streams;
908 	uint16_t number_outgoing_streams;
909 	uint32_t state;
910 	uint32_t total_sends;
911 	uint32_t total_recvs;
912 	uint32_t local_tag;
913 	uint32_t remote_tag;
914 	uint32_t initial_tsn;
915 	uint32_t highest_tsn;
916 	uint32_t cumulative_tsn;
917 	uint32_t cumulative_tsn_ack;
918 	/* add more association specific data here */
919 };
920 
921 struct xsctp_laddr {
922 	union sctp_sockstore address;
923 	/* add more local address specific data */
924 };
925 
926 struct xsctp_raddr {
927 	union sctp_sockstore address;
928 	uint16_t state;
929 	/* add more remote address specific data */
930 };
931 
932 /*
933  * Kernel defined for sctp_send
934  */
935 #if defined(_KERNEL)
936 int
937 sctp_lower_sosend(struct socket *so,
938     struct sockaddr *addr,
939     struct uio *uio,
940     struct mbuf *top,
941     struct mbuf *control,
942     int flags,
943     int use_rcvinfo,
944     struct sctp_sndrcvinfo *srcv,
945     struct thread *p
946 );
947 
948 int
949 sctp_sorecvmsg(struct socket *so,
950     struct uio *uio,
951     struct mbuf **mp,
952     struct sockaddr *from,
953     int fromlen,
954     int *msg_flags,
955     struct sctp_sndrcvinfo *sinfo,
956     int filling_sinfo);
957 
958 
959 #endif
960 
961 /*
962  * API system calls
963  */
964 
965 #if !(defined(_KERNEL))
966 
967 __BEGIN_DECLS
968 int sctp_peeloff __P((int, sctp_assoc_t));
969 int sctp_bindx __P((int, struct sockaddr *, int, int));
970 int sctp_connectx __P((int, const struct sockaddr *, int));
971 int sctp_getaddrlen __P((sa_family_t));
972 int sctp_getpaddrs __P((int, sctp_assoc_t, struct sockaddr **));
973 void sctp_freepaddrs __P((struct sockaddr *));
974 int sctp_getladdrs __P((int, sctp_assoc_t, struct sockaddr **));
975 void sctp_freeladdrs __P((struct sockaddr *));
976 int sctp_opt_info __P((int, sctp_assoc_t, int, void *, socklen_t *));
977 
978 ssize_t sctp_sendmsg
979 __P((int, const void *, size_t,
980     const struct sockaddr *,
981     socklen_t, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t));
982 
983 	ssize_t sctp_send __P((int sd, const void *msg, size_t len,
984               const struct sctp_sndrcvinfo *sinfo, int flags));
985 
986 	ssize_t
987 	sctp_sendx __P((int sd, const void *msg, size_t len,
988                struct sockaddr *addrs, int addrcnt,
989                struct sctp_sndrcvinfo *sinfo, int flags));
990 	ssize_t
991 	sctp_sendmsgx __P((int sd, const void *, size_t,
992                   struct sockaddr *, int,
993                   uint32_t, uint32_t, uint16_t, uint32_t, uint32_t));
994 
995 sctp_assoc_t
996 sctp_getassocid __P((int sd, struct sockaddr *sa));
997 
998 	ssize_t sctp_recvmsg __P((int, void *, size_t, struct sockaddr *,
999                  socklen_t *, struct sctp_sndrcvinfo *, int *));
1000 
1001 __END_DECLS
1002 
1003 #endif				/* !_KERNEL */
1004 #endif				/* !__sctp_uio_h__ */
1005