xref: /freebsd/sys/netinet/sctp_uio.h (revision 94942af266ac119ede0ca836f9aa5a5ac0582938)
1 /*-
2  * Copyright (c) 2001-2007, by 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 #if ! defined(_KERNEL)
40 #include <stdint.h>
41 #endif
42 #include <sys/types.h>
43 #include <sys/socket.h>
44 #include <sys/time.h>
45 #include <sys/socketvar.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 /*
87  * The assoc up needs a verfid
88  * all sendrcvinfo's need a verfid for SENDING only.
89  */
90 
91 
92 #define SCTP_ALIGN_RESV_PAD 96
93 #define SCTP_ALIGN_RESV_PAD_SHORT 80
94 
95 struct sctp_sndrcvinfo {
96 	uint16_t sinfo_stream;
97 	uint16_t sinfo_ssn;
98 	uint16_t sinfo_flags;
99 	uint32_t sinfo_ppid;
100 	uint32_t sinfo_context;
101 	uint32_t sinfo_timetolive;
102 	uint32_t sinfo_tsn;
103 	uint32_t sinfo_cumtsn;
104 	sctp_assoc_t sinfo_assoc_id;
105 	uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD];
106 };
107 
108 struct sctp_extrcvinfo {
109 	struct sctp_sndrcvinfo sreinfo_sinfo;
110 	uint16_t sreinfo_next_flags;
111 	uint16_t sreinfo_next_stream;
112 	uint32_t sreinfo_next_aid;
113 	uint32_t sreinfo_next_length;
114 	uint32_t sreinfo_next_ppid;
115 	uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD_SHORT];
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 #define SCTP_NEXT_MSG_IS_NOTIFICATION 0x0008
123 
124 struct sctp_snd_all_completes {
125 	uint16_t sall_stream;
126 	uint16_t sall_flags;
127 	uint32_t sall_ppid;
128 	uint32_t sall_context;
129 	uint32_t sall_num_sent;
130 	uint32_t sall_num_failed;
131 };
132 
133 /* Flags that go into the sinfo->sinfo_flags field */
134 #define SCTP_EOF 	  0x0100/* Start shutdown procedures */
135 #define SCTP_ABORT	  0x0200/* Send an ABORT to peer */
136 #define SCTP_UNORDERED 	  0x0400/* Message is un-ordered */
137 #define SCTP_ADDR_OVER	  0x0800/* Override the primary-address */
138 #define SCTP_SENDALL      0x1000/* Send this on all associations */
139 #define SCTP_EOR          0x2000/* end of message signal */
140 #define INVALID_SINFO_FLAG(x) (((x) & 0xffffff00 \
141                                     & ~(SCTP_EOF | SCTP_ABORT | SCTP_UNORDERED |\
142 				        SCTP_ADDR_OVER | SCTP_SENDALL | SCTP_EOR)) != 0)
143 /* for the endpoint */
144 
145 /* The lower byte is an enumeration of PR-SCTP policies */
146 #define SCTP_PR_SCTP_TTL  0x0001/* Time based PR-SCTP */
147 #define SCTP_PR_SCTP_BUF  0x0002/* Buffer based PR-SCTP */
148 #define SCTP_PR_SCTP_RTX  0x0003/* Number of retransmissions based PR-SCTP */
149 
150 #define PR_SCTP_POLICY(x)         ((x) & 0xff)
151 #define PR_SCTP_ENABLED(x)        (PR_SCTP_POLICY(x) != 0)
152 #define PR_SCTP_TTL_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_TTL)
153 #define PR_SCTP_BUF_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_BUF)
154 #define PR_SCTP_RTX_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_RTX)
155 #define PR_SCTP_INVALID_POLICY(x) (PR_SCTP_POLICY(x) > SCTP_PR_SCTP_RTX)
156 /* Stat's */
157 struct sctp_pcbinfo {
158 	uint32_t ep_count;
159 	uint32_t asoc_count;
160 	uint32_t laddr_count;
161 	uint32_t raddr_count;
162 	uint32_t chk_count;
163 	uint32_t readq_count;
164 	uint32_t free_chunks;
165 	uint32_t stream_oque;
166 };
167 
168 struct sctp_sockstat {
169 	sctp_assoc_t ss_assoc_id;
170 	uint32_t ss_total_sndbuf;
171 	uint32_t ss_total_recv_buf;
172 };
173 
174 /*
175  * notification event structures
176  */
177 
178 /*
179  * association change event
180  */
181 struct sctp_assoc_change {
182 	uint16_t sac_type;
183 	uint16_t sac_flags;
184 	uint32_t sac_length;
185 	uint16_t sac_state;
186 	uint16_t sac_error;
187 	uint16_t sac_outbound_streams;
188 	uint16_t sac_inbound_streams;
189 	sctp_assoc_t sac_assoc_id;
190 };
191 
192 /* sac_state values */
193 #define SCTP_COMM_UP		0x0001
194 #define SCTP_COMM_LOST		0x0002
195 #define SCTP_RESTART		0x0003
196 #define SCTP_SHUTDOWN_COMP	0x0004
197 #define SCTP_CANT_STR_ASSOC	0x0005
198 
199 
200 /*
201  * Address event
202  */
203 struct sctp_paddr_change {
204 	uint16_t spc_type;
205 	uint16_t spc_flags;
206 	uint32_t spc_length;
207 	struct sockaddr_storage spc_aaddr;
208 	uint32_t spc_state;
209 	uint32_t spc_error;
210 	sctp_assoc_t spc_assoc_id;
211 };
212 
213 /* paddr state values */
214 #define SCTP_ADDR_AVAILABLE	0x0001
215 #define SCTP_ADDR_UNREACHABLE	0x0002
216 #define SCTP_ADDR_REMOVED	0x0003
217 #define SCTP_ADDR_ADDED		0x0004
218 #define SCTP_ADDR_MADE_PRIM	0x0005
219 #define SCTP_ADDR_CONFIRMED	0x0006
220 
221 /*
222  * CAUTION: these are user exposed SCTP addr reachability states must be
223  * compatible with SCTP_ADDR states in sctp_constants.h
224  */
225 #ifdef SCTP_ACTIVE
226 #undef SCTP_ACTIVE
227 #endif
228 #define SCTP_ACTIVE		0x0001	/* SCTP_ADDR_REACHABLE */
229 
230 #ifdef SCTP_INACTIVE
231 #undef SCTP_INACTIVE
232 #endif
233 #define SCTP_INACTIVE		0x0002	/* SCTP_ADDR_NOT_REACHABLE */
234 
235 #ifdef SCTP_UNCONFIRMED
236 #undef SCTP_UNCONFIRMED
237 #endif
238 #define SCTP_UNCONFIRMED	0x0200	/* SCTP_ADDR_UNCONFIRMED */
239 
240 #ifdef SCTP_NOHEARTBEAT
241 #undef SCTP_NOHEARTBEAT
242 #endif
243 #define SCTP_NOHEARTBEAT	0x0040	/* SCTP_ADDR_NOHB */
244 
245 
246 /* remote error events */
247 struct sctp_remote_error {
248 	uint16_t sre_type;
249 	uint16_t sre_flags;
250 	uint32_t sre_length;
251 	uint16_t sre_error;
252 	sctp_assoc_t sre_assoc_id;
253 	uint8_t sre_data[4];
254 };
255 
256 /* data send failure event */
257 struct sctp_send_failed {
258 	uint16_t ssf_type;
259 	uint16_t ssf_flags;
260 	uint32_t ssf_length;
261 	uint32_t ssf_error;
262 	struct sctp_sndrcvinfo ssf_info;
263 	sctp_assoc_t ssf_assoc_id;
264 	uint8_t ssf_data[4];
265 };
266 
267 /* flag that indicates state of data */
268 #define SCTP_DATA_UNSENT	0x0001	/* inqueue never on wire */
269 #define SCTP_DATA_SENT		0x0002	/* on wire at failure */
270 
271 /* shutdown event */
272 struct sctp_shutdown_event {
273 	uint16_t sse_type;
274 	uint16_t sse_flags;
275 	uint32_t sse_length;
276 	sctp_assoc_t sse_assoc_id;
277 };
278 
279 /* Adaptation layer indication stuff */
280 struct sctp_adaptation_event {
281 	uint16_t sai_type;
282 	uint16_t sai_flags;
283 	uint32_t sai_length;
284 	uint32_t sai_adaptation_ind;
285 	sctp_assoc_t sai_assoc_id;
286 };
287 
288 struct sctp_setadaptation {
289 	uint32_t ssb_adaptation_ind;
290 };
291 
292 /* compatable old spelling */
293 struct sctp_adaption_event {
294 	uint16_t sai_type;
295 	uint16_t sai_flags;
296 	uint32_t sai_length;
297 	uint32_t sai_adaption_ind;
298 	sctp_assoc_t sai_assoc_id;
299 };
300 
301 struct sctp_setadaption {
302 	uint32_t ssb_adaption_ind;
303 };
304 
305 
306 /*
307  * Partial Delivery API event
308  */
309 struct sctp_pdapi_event {
310 	uint16_t pdapi_type;
311 	uint16_t pdapi_flags;
312 	uint32_t pdapi_length;
313 	uint32_t pdapi_indication;
314 	uint16_t pdapi_stream;
315 	uint16_t pdapi_seq;
316 	sctp_assoc_t pdapi_assoc_id;
317 };
318 
319 /* indication values */
320 #define SCTP_PARTIAL_DELIVERY_ABORTED	0x0001
321 
322 
323 /*
324  * authentication key event
325  */
326 struct sctp_authkey_event {
327 	uint16_t auth_type;
328 	uint16_t auth_flags;
329 	uint32_t auth_length;
330 	uint16_t auth_keynumber;
331 	uint16_t auth_altkeynumber;
332 	uint32_t auth_indication;
333 	sctp_assoc_t auth_assoc_id;
334 };
335 
336 /* indication values */
337 #define SCTP_AUTH_NEWKEY	0x0001
338 
339 
340 /*
341  * stream reset event
342  */
343 struct sctp_stream_reset_event {
344 	uint16_t strreset_type;
345 	uint16_t strreset_flags;
346 	uint32_t strreset_length;
347 	sctp_assoc_t strreset_assoc_id;
348 	uint16_t strreset_list[0];
349 };
350 
351 /* flags in strreset_flags field */
352 #define SCTP_STRRESET_INBOUND_STR  0x0001
353 #define SCTP_STRRESET_OUTBOUND_STR 0x0002
354 #define SCTP_STRRESET_ALL_STREAMS  0x0004
355 #define SCTP_STRRESET_STREAM_LIST  0x0008
356 #define SCTP_STRRESET_FAILED       0x0010
357 
358 
359 /* SCTP notification event */
360 struct sctp_tlv {
361 	uint16_t sn_type;
362 	uint16_t sn_flags;
363 	uint32_t sn_length;
364 };
365 
366 union sctp_notification {
367 	struct sctp_tlv sn_header;
368 	struct sctp_assoc_change sn_assoc_change;
369 	struct sctp_paddr_change sn_paddr_change;
370 	struct sctp_remote_error sn_remote_error;
371 	struct sctp_send_failed sn_send_failed;
372 	struct sctp_shutdown_event sn_shutdown_event;
373 	struct sctp_adaptation_event sn_adaptation_event;
374 	/* compatability same as above */
375 	struct sctp_adaption_event sn_adaption_event;
376 	struct sctp_pdapi_event sn_pdapi_event;
377 	struct sctp_authkey_event sn_auth_event;
378 	struct sctp_stream_reset_event sn_strreset_event;
379 };
380 
381 /* notification types */
382 #define SCTP_ASSOC_CHANGE		0x0001
383 #define SCTP_PEER_ADDR_CHANGE		0x0002
384 #define SCTP_REMOTE_ERROR		0x0003
385 #define SCTP_SEND_FAILED		0x0004
386 #define SCTP_SHUTDOWN_EVENT		0x0005
387 #define SCTP_ADAPTATION_INDICATION	0x0006
388 /* same as above */
389 #define SCTP_ADAPTION_INDICATION	0x0006
390 #define SCTP_PARTIAL_DELIVERY_EVENT	0x0007
391 #define SCTP_AUTHENTICATION_EVENT	0x0008
392 #define SCTP_STREAM_RESET_EVENT		0x0009
393 
394 
395 /*
396  * socket option structs
397  */
398 
399 struct sctp_paddrparams {
400 	sctp_assoc_t spp_assoc_id;
401 	struct sockaddr_storage spp_address;
402 	uint32_t spp_hbinterval;
403 	uint16_t spp_pathmaxrxt;
404 	uint32_t spp_pathmtu;
405 	uint32_t spp_flags;
406 	uint32_t spp_ipv6_flowlabel;
407 	uint8_t spp_ipv4_tos;
408 
409 };
410 
411 #define SPP_HB_ENABLE		0x00000001
412 #define SPP_HB_DISABLE		0x00000002
413 #define SPP_HB_DEMAND		0x00000004
414 #define SPP_PMTUD_ENABLE	0x00000008
415 #define SPP_PMTUD_DISABLE	0x00000010
416 #define SPP_SACKDELAY_ENABLE	0x00000020
417 #define SPP_SACKDELAY_DISABLE	0x00000040
418 #define SPP_HB_TIME_IS_ZERO     0x00000080
419 #define SPP_IPV6_FLOWLABEL      0x00000100
420 #define SPP_IPV4_TOS            0x00000200
421 
422 struct sctp_paddrinfo {
423 	sctp_assoc_t spinfo_assoc_id;
424 	struct sockaddr_storage spinfo_address;
425 	int32_t spinfo_state;
426 	uint32_t spinfo_cwnd;
427 	uint32_t spinfo_srtt;
428 	uint32_t spinfo_rto;
429 	uint32_t spinfo_mtu;
430 };
431 
432 struct sctp_rtoinfo {
433 	sctp_assoc_t srto_assoc_id;
434 	uint32_t srto_initial;
435 	uint32_t srto_max;
436 	uint32_t srto_min;
437 };
438 
439 struct sctp_assocparams {
440 	sctp_assoc_t sasoc_assoc_id;
441 	uint16_t sasoc_asocmaxrxt;
442 	uint16_t sasoc_number_peer_destinations;
443 	uint32_t sasoc_peer_rwnd;
444 	uint32_t sasoc_local_rwnd;
445 	uint32_t sasoc_cookie_life;
446 	uint32_t sasoc_sack_delay;
447 	uint32_t sasoc_sack_freq;
448 };
449 
450 struct sctp_setprim {
451 	sctp_assoc_t ssp_assoc_id;
452 	struct sockaddr_storage ssp_addr;
453 };
454 
455 struct sctp_setpeerprim {
456 	sctp_assoc_t sspp_assoc_id;
457 	struct sockaddr_storage sspp_addr;
458 };
459 
460 struct sctp_getaddresses {
461 	sctp_assoc_t sget_assoc_id;
462 	/* addr is filled in for N * sockaddr_storage */
463 	struct sockaddr addr[1];
464 };
465 
466 struct sctp_setstrm_timeout {
467 	sctp_assoc_t ssto_assoc_id;
468 	uint32_t ssto_timeout;
469 	uint32_t ssto_streamid_start;
470 	uint32_t ssto_streamid_end;
471 };
472 
473 struct sctp_status {
474 	sctp_assoc_t sstat_assoc_id;
475 	int32_t sstat_state;
476 	uint32_t sstat_rwnd;
477 	uint16_t sstat_unackdata;
478 	uint16_t sstat_penddata;
479 	uint16_t sstat_instrms;
480 	uint16_t sstat_outstrms;
481 	uint32_t sstat_fragmentation_point;
482 	struct sctp_paddrinfo sstat_primary;
483 };
484 
485 /*
486  * AUTHENTICATION support
487  */
488 /* SCTP_AUTH_CHUNK */
489 struct sctp_authchunk {
490 	uint8_t sauth_chunk;
491 };
492 
493 /* SCTP_AUTH_KEY */
494 struct sctp_authkey {
495 	sctp_assoc_t sca_assoc_id;
496 	uint16_t sca_keynumber;
497 	uint8_t sca_key[0];
498 };
499 
500 /* SCTP_HMAC_IDENT */
501 struct sctp_hmacalgo {
502 	uint16_t shmac_idents[0];
503 };
504 
505 /* AUTH hmac_id */
506 #define SCTP_AUTH_HMAC_ID_RSVD		0x0000
507 #define SCTP_AUTH_HMAC_ID_SHA1		0x0001	/* default, mandatory */
508 #define SCTP_AUTH_HMAC_ID_MD5		0x0002	/* deprecated */
509 #define SCTP_AUTH_HMAC_ID_SHA256	0x0003
510 #define SCTP_AUTH_HMAC_ID_SHA224	0x8001
511 #define SCTP_AUTH_HMAC_ID_SHA384	0x8002
512 #define SCTP_AUTH_HMAC_ID_SHA512	0x8003
513 
514 
515 /* SCTP_AUTH_ACTIVE_KEY / SCTP_AUTH_DELETE_KEY */
516 struct sctp_authkeyid {
517 	sctp_assoc_t scact_assoc_id;
518 	uint16_t scact_keynumber;
519 };
520 
521 /* SCTP_PEER_AUTH_CHUNKS / SCTP_LOCAL_AUTH_CHUNKS */
522 struct sctp_authchunks {
523 	sctp_assoc_t gauth_assoc_id;
524 	uint8_t gauth_chunks[0];
525 };
526 
527 struct sctp_assoc_value {
528 	sctp_assoc_t assoc_id;
529 	uint32_t assoc_value;
530 };
531 
532 struct sctp_assoc_ids {
533 	sctp_assoc_t gaids_assoc_id[0];
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 };
653 
654 struct sctp_nagle_log {
655 	void *stcb;
656 	uint32_t total_flight;
657 	uint32_t total_in_queue;
658 	uint16_t count_in_queue;
659 	uint16_t count_in_flight;
660 };
661 
662 struct sctp_sbwake_log {
663 	void *stcb;
664 	uint16_t send_q;
665 	uint16_t sent_q;
666 	uint16_t flight;
667 	uint16_t wake_cnt;
668 	uint8_t stream_qcnt;	/* chnk cnt */
669 	uint8_t chunks_on_oque;	/* chunks out */
670 	uint8_t sbflags;
671 	uint8_t sctpflags;
672 };
673 
674 struct sctp_misc_info {
675 	uint32_t log1;
676 	uint32_t log2;
677 	uint32_t log3;
678 	uint32_t log4;
679 };
680 
681 struct sctp_log_closing {
682 	void *inp;
683 	void *stcb;
684 	uint32_t sctp_flags;
685 	uint16_t state;
686 	int16_t loc;
687 };
688 
689 struct sctp_mbuf_log {
690 	struct mbuf *mp;
691 	caddr_t ext;
692 	caddr_t data;
693 	uint16_t size;
694 	uint8_t refcnt;
695 	uint8_t mbuf_flags;
696 };
697 
698 struct sctp_cwnd_log {
699 	uint32_t time_event;
700 	uint8_t from;
701 	uint8_t event_type;
702 	uint8_t resv[2];
703 	union {
704 		struct sctp_log_closing close;
705 		struct sctp_blk_args blk;
706 		struct sctp_cwnd_args cwnd;
707 		struct sctp_str_log strlog;
708 		struct sctp_fr_log fr;
709 		struct sctp_fr_map map;
710 		struct sctp_rwnd_log rwnd;
711 		struct sctp_mbcnt_log mbcnt;
712 		struct sctp_sack_log sack;
713 		struct sctp_lock_log lock;
714 		struct sctp_rto_log rto;
715 		struct sctp_sb_log sb;
716 		struct sctp_nagle_log nagle;
717 		struct sctp_sbwake_log wake;
718 		struct sctp_mbuf_log mb;
719 		struct sctp_misc_info misc;
720 	}     x;
721 };
722 
723 struct sctp_cwnd_log_req {
724 	int num_in_log;		/* Number in log */
725 	int num_ret;		/* Number returned */
726 	int start_at;		/* start at this one */
727 	int end_at;		/* end at this one */
728 	struct sctp_cwnd_log log[0];
729 };
730 
731 struct sctpstat {
732 	/* MIB according to RFC 3873 */
733 	u_long sctps_currestab;	/* sctpStats  1   (Gauge32) */
734 	u_long sctps_activeestab;	/* sctpStats  2 (Counter32) */
735 	u_long sctps_restartestab;
736 	u_long sctps_collisionestab;
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 	struct timeval 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;	/* total packets that had data */
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;	/* total FR's that happened
782 						 * more than once to same
783 						 * chunk (u-del multi-fr
784 						 * algo). */
785 	u_long sctps_sendheartbeat;	/* total output HB chunks     */
786 	u_long sctps_sendecne;	/* total output ECNE chunks    */
787 	u_long sctps_sendauth;	/* total output AUTH chunks FIXME   */
788 	u_long sctps_senderrors;/* ip_output error counter */
789 	/* PCKDROPREP statistics: */
790 	u_long sctps_pdrpfmbox;	/* Packet drop from middle box */
791 	u_long sctps_pdrpfehos;	/* P-drop from end host */
792 	u_long sctps_pdrpmbda;	/* P-drops with data */
793 	u_long sctps_pdrpmbct;	/* P-drops, non-data, non-endhost */
794 	u_long sctps_pdrpbwrpt;	/* P-drop, non-endhost, bandwidth rep only */
795 	u_long sctps_pdrpcrupt;	/* P-drop, not enough for chunk header */
796 	u_long sctps_pdrpnedat;	/* P-drop, not enough data to confirm */
797 	u_long sctps_pdrppdbrk;	/* P-drop, where process_chunk_drop said break */
798 	u_long sctps_pdrptsnnf;	/* P-drop, could not find TSN */
799 	u_long sctps_pdrpdnfnd;	/* P-drop, attempt reverse TSN lookup */
800 	u_long sctps_pdrpdiwnp;	/* P-drop, e-host confirms zero-rwnd */
801 	u_long sctps_pdrpdizrw;	/* P-drop, midbox confirms no space */
802 	u_long sctps_pdrpbadd;	/* P-drop, data did not match TSN */
803 	u_long sctps_pdrpmark;	/* P-drop, TSN's marked for Fast Retran */
804 	/* timeouts */
805 	u_long sctps_timoiterator;	/* Number of iterator timers that
806 					 * fired */
807 	u_long sctps_timodata;	/* Number of T3 data time outs */
808 	u_long sctps_timowindowprobe;	/* Number of window probe (T3) timers
809 					 * that fired */
810 	u_long sctps_timoinit;	/* Number of INIT timers that fired */
811 	u_long sctps_timosack;	/* Number of sack timers that fired */
812 	u_long sctps_timoshutdown;	/* Number of shutdown timers that
813 					 * fired */
814 	u_long sctps_timoheartbeat;	/* Number of heartbeat timers that
815 					 * fired */
816 	u_long sctps_timocookie;/* Number of times a cookie timeout fired */
817 	u_long sctps_timosecret;/* Number of times an endpoint changed its
818 				 * cookie secret */
819 	u_long sctps_timopathmtu;	/* Number of PMTU timers that fired */
820 	u_long sctps_timoshutdownack;	/* Number of shutdown ack timers that
821 					 * fired */
822 	u_long sctps_timoshutdownguard;	/* Number of shutdown guard timers
823 					 * that fired */
824 	u_long sctps_timostrmrst;	/* Number of stream reset timers that
825 					 * fired */
826 	u_long sctps_timoearlyfr;	/* Number of early FR timers that
827 					 * fired */
828 	u_long sctps_timoasconf;/* Number of times an asconf timer fired */
829 	u_long sctps_timoautoclose;	/* Number of times auto close timer
830 					 * fired */
831 	u_long sctps_timoassockill;	/* Number of asoc free timers expired */
832 	u_long sctps_timoinpkill;	/* Number of inp free timers expired */
833 	/* Early fast retransmission counters */
834 	u_long sctps_earlyfrstart;
835 	u_long sctps_earlyfrstop;
836 	u_long sctps_earlyfrmrkretrans;
837 	u_long sctps_earlyfrstpout;
838 	u_long sctps_earlyfrstpidsck1;
839 	u_long sctps_earlyfrstpidsck2;
840 	u_long sctps_earlyfrstpidsck3;
841 	u_long sctps_earlyfrstpidsck4;
842 	u_long sctps_earlyfrstrid;
843 	u_long sctps_earlyfrstrout;
844 	u_long sctps_earlyfrstrtmr;
845 	/* otheres */
846 	u_long sctps_hdrops;	/* packet shorter than header */
847 	u_long sctps_badsum;	/* checksum error             */
848 	u_long sctps_noport;	/* no endpoint for port       */
849 	u_long sctps_badvtag;	/* bad v-tag                  */
850 	u_long sctps_badsid;	/* bad SID                    */
851 	u_long sctps_nomem;	/* no memory                  */
852 	u_long sctps_fastretransinrtt;	/* number of multiple FR in a RTT
853 					 * window */
854 	u_long sctps_markedretrans;
855 	u_long sctps_naglesent;	/* nagle allowed sending      */
856 	u_long sctps_naglequeued;	/* nagle does't allow sending */
857 	u_long sctps_maxburstqueued;	/* max burst dosn't allow sending */
858 	u_long sctps_ifnomemqueued;	/* look ahead tells us no memory in
859 					 * interface ring buffer OR we had a
860 					 * send error and are queuing one
861 					 * send. */
862 	u_long sctps_windowprobed;	/* total number of window probes sent */
863 	u_long sctps_lowlevelerr;	/* total times an output error causes
864 					 * us to clamp down on next user send. */
865 	u_long sctps_lowlevelerrusr;	/* total times sctp_senderrors were
866 					 * caused from a user send from a user
867 					 * invoked send not a sack response */
868 	u_long sctps_datadropchklmt;	/* Number of in data drops due to
869 					 * chunk limit reached */
870 	u_long sctps_datadroprwnd;	/* Number of in data drops due to rwnd
871 					 * limit reached */
872 	u_long sctps_ecnereducedcwnd;	/* Number of times a ECN reduced the
873 					 * cwnd */
874 	u_long sctps_vtagexpress;	/* Used express lookup via vtag */
875 	u_long sctps_vtagbogus;	/* Collision in express lookup. */
876 	u_long sctps_primary_randry;	/* Number of times the sender ran dry
877 					 * of user data on primary */
878 	u_long sctps_cmt_randry;/* Same for above */
879 	u_long sctps_slowpath_sack;	/* Sacks the slow way */
880 	u_long sctps_wu_sacks_sent;	/* Window Update only sacks sent */
881 	u_long sctps_sends_with_flags;	/* number of sends with sinfo_flags
882 					 * !=0 */
883 	u_long sctps_sends_with_unord /* number of undordered sends */ ;
884 	u_long sctps_sends_with_eof;	/* number of sends with EOF flag set */
885 	u_long sctps_sends_with_abort;	/* number of sends with ABORT flag set */
886 	u_long sctps_protocol_drain_calls;	/* number of times protocol
887 						 * drain called */
888 	u_long sctps_protocol_drains_done;	/* number of times we did a
889 						 * protocol drain */
890 	u_long sctps_read_peeks;/* Number of times recv was called with peek */
891 	u_long sctps_cached_chk;/* Number of cached chunks used */
892 	u_long sctps_cached_strmoq;	/* Number of cached stream oq's used */
893 	u_long sctps_left_abandon;	/* Number of unread message abandonded
894 					 * by close */
895 	u_long sctps_send_burst_avoid;	/* Send burst avoidance, already max
896 					 * burst inflight to net */
897 	u_long sctps_send_cwnd_avoid;	/* Send cwnd full  avoidance, already
898 					 * max burst inflight to net */
899 };
900 
901 #define SCTP_STAT_INCR(_x) SCTP_STAT_INCR_BY(_x,1)
902 #define SCTP_STAT_DECR(_x) SCTP_STAT_DECR_BY(_x,1)
903 #define SCTP_STAT_INCR_BY(_x,_d) atomic_add_long(&sctpstat._x, _d)
904 #define SCTP_STAT_DECR_BY(_x,_d) atomic_subtract_long(&sctpstat._x, _d)
905 /* The following macros are for handling MIB values, */
906 #define SCTP_STAT_INCR_COUNTER32(_x) SCTP_STAT_INCR(_x)
907 #define SCTP_STAT_INCR_COUNTER64(_x) SCTP_STAT_INCR(_x)
908 #define SCTP_STAT_INCR_GAUGE32(_x) SCTP_STAT_INCR(_x)
909 #define SCTP_STAT_DECR_COUNTER32(_x) SCTP_STAT_DECR(_x)
910 #define SCTP_STAT_DECR_COUNTER64(_x) SCTP_STAT_DECR(_x)
911 #define SCTP_STAT_DECR_GAUGE32(_x) SCTP_STAT_DECR(_x)
912 
913 union sctp_sockstore {
914 #if defined(INET) || !defined(_KERNEL)
915 	struct sockaddr_in sin;
916 #endif
917 #if defined(INET6) || !defined(_KERNEL)
918 	struct sockaddr_in6 sin6;
919 #endif
920 	struct sockaddr sa;
921 };
922 
923 struct xsctp_inpcb {
924 	uint32_t last;
925 	uint16_t local_port;
926 	uint16_t number_local_addresses;
927 	uint32_t number_associations;
928 	uint32_t flags;
929 	uint32_t features;
930 	uint32_t total_sends;
931 	uint32_t total_recvs;
932 	uint32_t total_nospaces;
933 	uint32_t fragmentation_point;
934 	struct xsocket xsocket;
935 	/* add more endpoint specific data here */
936 };
937 
938 struct xsctp_tcb {
939 	uint16_t LocalPort;	/* sctpAssocEntry 3   */
940 	uint16_t RemPort;	/* sctpAssocEntry 4   */
941 	union sctp_sockstore RemPrimAddr;	/* sctpAssocEntry 5/6 */
942 	uint32_t HeartBeatInterval;	/* sctpAssocEntry 7   */
943 	uint32_t State;		/* sctpAssocEntry 8   */
944 	uint32_t InStreams;	/* sctpAssocEntry 9   */
945 	uint32_t OutStreams;	/* sctpAssocEntry 10  */
946 	uint32_t MaxRetr;	/* sctpAssocEntry 11  */
947 	uint32_t PrimProcess;	/* sctpAssocEntry 12  */
948 	uint32_t T1expireds;	/* sctpAssocEntry 13  */
949 	uint32_t T2expireds;	/* sctpAssocEntry 14  */
950 	uint32_t RtxChunks;	/* sctpAssocEntry 15  */
951 	struct timeval StartTime;	/* sctpAssocEntry 16  */
952 	struct timeval DiscontinuityTime;	/* sctpAssocEntry 17  */
953 	uint32_t total_sends;
954 	uint32_t total_recvs;
955 	uint32_t local_tag;
956 	uint32_t remote_tag;
957 	uint32_t initial_tsn;
958 	uint32_t highest_tsn;
959 	uint32_t cumulative_tsn;
960 	uint32_t cumulative_tsn_ack;
961 	uint32_t mtu;
962 	/* add more association specific data here */
963 	uint16_t number_local_addresses;
964 	uint16_t number_remote_addresses;
965 };
966 
967 struct xsctp_laddr {
968 	union sctp_sockstore LocalAddr;	/* sctpAssocLocalAddrEntry 1/2 */
969 	struct timeval LocalStartTime;	/* sctpAssocLocalAddrEntry 3   */
970 	/* add more local address specific data */
971 };
972 
973 struct xsctp_raddr {
974 	union sctp_sockstore RemAddr;	/* sctpAssocLocalRemEntry 1/2 */
975 	uint8_t RemAddrActive;	/* sctpAssocLocalRemEntry 3   */
976 	uint8_t RemAddrConfirmed;	/* */
977 	uint8_t RemAddrHBActive;/* sctpAssocLocalRemEntry 4   */
978 	uint32_t RemAddrRTO;	/* sctpAssocLocalRemEntry 5   */
979 	uint32_t RemAddrMaxPathRtx;	/* sctpAssocLocalRemEntry 6   */
980 	uint32_t RemAddrRtx;	/* sctpAssocLocalRemEntry 7   */
981 	uint32_t RemAddrErrorCounter;	/* */
982 	uint32_t RemAddrCwnd;	/* */
983 	uint32_t RemAddrFlightSize;	/* */
984 	uint32_t RemAddrMTU;	/* */
985 	struct timeval RemAddrStartTime;	/* sctpAssocLocalRemEntry 8   */
986 	/* add more remote address specific data */
987 };
988 
989 /*
990  * Kernel defined for sctp_send
991  */
992 #if defined(_KERNEL)
993 int
994 sctp_lower_sosend(struct socket *so,
995     struct sockaddr *addr,
996     struct uio *uio,
997     struct mbuf *i_pak,
998     struct mbuf *control,
999     int flags,
1000     int use_rcvinfo,
1001     struct sctp_sndrcvinfo *srcv
1002     ,struct thread *p
1003 );
1004 
1005 int
1006 sctp_sorecvmsg(struct socket *so,
1007     struct uio *uio,
1008     struct mbuf **mp,
1009     struct sockaddr *from,
1010     int fromlen,
1011     int *msg_flags,
1012     struct sctp_sndrcvinfo *sinfo,
1013     int filling_sinfo);
1014 
1015 #endif
1016 
1017 /*
1018  * API system calls
1019  */
1020 #if !(defined(_KERNEL))
1021 
1022 __BEGIN_DECLS
1023 int sctp_peeloff __P((int, sctp_assoc_t));
1024 int sctp_bindx __P((int, struct sockaddr *, int, int));
1025 int sctp_connectx __P((int, const struct sockaddr *, int, sctp_assoc_t *));
1026 int sctp_getaddrlen __P((sa_family_t));
1027 int sctp_getpaddrs __P((int, sctp_assoc_t, struct sockaddr **));
1028 void sctp_freepaddrs __P((struct sockaddr *));
1029 int sctp_getladdrs __P((int, sctp_assoc_t, struct sockaddr **));
1030 void sctp_freeladdrs __P((struct sockaddr *));
1031 int sctp_opt_info __P((int, sctp_assoc_t, int, void *, socklen_t *));
1032 
1033 ssize_t sctp_sendmsg
1034 __P((int, const void *, size_t,
1035     const struct sockaddr *,
1036     socklen_t, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t));
1037 
1038 	ssize_t sctp_send __P((int sd, const void *msg, size_t len,
1039               const struct sctp_sndrcvinfo *sinfo, int flags));
1040 
1041 	ssize_t sctp_sendx __P((int sd, const void *msg, size_t len,
1042                struct sockaddr *addrs, int addrcnt,
1043                struct sctp_sndrcvinfo *sinfo, int flags));
1044 
1045 	ssize_t sctp_sendmsgx __P((int sd, const void *, size_t,
1046                   struct sockaddr *, int,
1047                   uint32_t, uint32_t, uint16_t, uint32_t, uint32_t));
1048 
1049 	sctp_assoc_t sctp_getassocid __P((int sd, struct sockaddr *sa));
1050 
1051 	ssize_t sctp_recvmsg __P((int, void *, size_t, struct sockaddr *,
1052                  socklen_t *, struct sctp_sndrcvinfo *, int *));
1053 
1054 __END_DECLS
1055 
1056 #endif				/* !_KERNEL */
1057 #endif				/* !__sctp_uio_h__ */
1058