xref: /freebsd/sys/netinet/sctp_uio.h (revision 282a3889ebf826db9839be296ff1dd903f6d6d6e)
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 <netinet/in.h>
46 
47 typedef uint32_t sctp_assoc_t;
48 
49 /* On/Off setup for subscription to events */
50 struct sctp_event_subscribe {
51 	uint8_t sctp_data_io_event;
52 	uint8_t sctp_association_event;
53 	uint8_t sctp_address_event;
54 	uint8_t sctp_send_failure_event;
55 	uint8_t sctp_peer_error_event;
56 	uint8_t sctp_shutdown_event;
57 	uint8_t sctp_partial_delivery_event;
58 	uint8_t sctp_adaptation_layer_event;
59 	uint8_t sctp_authentication_event;
60 	uint8_t sctp_stream_reset_events;
61 };
62 
63 /* ancillary data types */
64 #define SCTP_INIT	0x0001
65 #define SCTP_SNDRCV	0x0002
66 #define SCTP_EXTRCV	0x0003
67 /*
68  * ancillary data structures
69  */
70 struct sctp_initmsg {
71 	uint32_t sinit_num_ostreams;
72 	uint32_t sinit_max_instreams;
73 	uint16_t sinit_max_attempts;
74 	uint16_t sinit_max_init_timeo;
75 };
76 
77 /* We add 96 bytes to the size of sctp_sndrcvinfo.
78  * This makes the current structure 128 bytes long
79  * which is nicely 64 bit aligned but also has room
80  * for us to add more and keep ABI compatability.
81  * For example, already we have the sctp_extrcvinfo
82  * when enabled which is 48 bytes.
83  */
84 
85 /*
86  * The assoc up needs a verfid
87  * all sendrcvinfo's need a verfid for SENDING only.
88  */
89 
90 
91 #define SCTP_ALIGN_RESV_PAD 96
92 #define SCTP_ALIGN_RESV_PAD_SHORT 80
93 
94 struct sctp_sndrcvinfo {
95 	uint16_t sinfo_stream;
96 	uint16_t sinfo_ssn;
97 	uint16_t sinfo_flags;
98 	uint32_t sinfo_ppid;
99 	uint32_t sinfo_context;
100 	uint32_t sinfo_timetolive;
101 	uint32_t sinfo_tsn;
102 	uint32_t sinfo_cumtsn;
103 	sctp_assoc_t sinfo_assoc_id;
104 	uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD];
105 };
106 
107 struct sctp_extrcvinfo {
108 	struct sctp_sndrcvinfo sreinfo_sinfo;
109 	uint16_t sreinfo_next_flags;
110 	uint16_t sreinfo_next_stream;
111 	uint32_t sreinfo_next_aid;
112 	uint32_t sreinfo_next_length;
113 	uint32_t sreinfo_next_ppid;
114 	uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD_SHORT];
115 };
116 
117 #define SCTP_NO_NEXT_MSG           0x0000
118 #define SCTP_NEXT_MSG_AVAIL        0x0001
119 #define SCTP_NEXT_MSG_ISCOMPLETE   0x0002
120 #define SCTP_NEXT_MSG_IS_UNORDERED 0x0004
121 #define SCTP_NEXT_MSG_IS_NOTIFICATION 0x0008
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 	uint8_t spc_padding[4];
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[0];
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 	struct sockaddr_storage spp_address;
401 	sctp_assoc_t spp_assoc_id;
402 	uint32_t spp_hbinterval;
403 	uint32_t spp_pathmtu;
404 	uint32_t spp_flags;
405 	uint32_t spp_ipv6_flowlabel;
406 	uint16_t spp_pathmaxrxt;
407 	uint8_t spp_ipv4_tos;
408 };
409 
410 #define SPP_HB_ENABLE		0x00000001
411 #define SPP_HB_DISABLE		0x00000002
412 #define SPP_HB_DEMAND		0x00000004
413 #define SPP_PMTUD_ENABLE	0x00000008
414 #define SPP_PMTUD_DISABLE	0x00000010
415 #define SPP_HB_TIME_IS_ZERO     0x00000080
416 #define SPP_IPV6_FLOWLABEL      0x00000100
417 #define SPP_IPV4_TOS            0x00000200
418 
419 struct sctp_paddrinfo {
420 	struct sockaddr_storage spinfo_address;
421 	sctp_assoc_t spinfo_assoc_id;
422 	int32_t spinfo_state;
423 	uint32_t spinfo_cwnd;
424 	uint32_t spinfo_srtt;
425 	uint32_t spinfo_rto;
426 	uint32_t spinfo_mtu;
427 };
428 
429 struct sctp_rtoinfo {
430 	sctp_assoc_t srto_assoc_id;
431 	uint32_t srto_initial;
432 	uint32_t srto_max;
433 	uint32_t srto_min;
434 };
435 
436 struct sctp_assocparams {
437 	sctp_assoc_t sasoc_assoc_id;
438 	uint32_t sasoc_peer_rwnd;
439 	uint32_t sasoc_local_rwnd;
440 	uint32_t sasoc_cookie_life;
441 	uint16_t sasoc_asocmaxrxt;
442 	uint16_t sasoc_number_peer_destinations;
443 };
444 
445 struct sctp_setprim {
446 	struct sockaddr_storage ssp_addr;
447 	sctp_assoc_t ssp_assoc_id;
448 	uint8_t ssp_padding[4];
449 };
450 
451 struct sctp_setpeerprim {
452 	struct sockaddr_storage sspp_addr;
453 	sctp_assoc_t sspp_assoc_id;
454 	uint8_t sspp_padding[4];
455 };
456 
457 struct sctp_getaddresses {
458 	sctp_assoc_t sget_assoc_id;
459 	/* addr is filled in for N * sockaddr_storage */
460 	struct sockaddr addr[1];
461 };
462 
463 struct sctp_setstrm_timeout {
464 	sctp_assoc_t ssto_assoc_id;
465 	uint32_t ssto_timeout;
466 	uint32_t ssto_streamid_start;
467 	uint32_t ssto_streamid_end;
468 };
469 
470 struct sctp_status {
471 	sctp_assoc_t sstat_assoc_id;
472 	int32_t sstat_state;
473 	uint32_t sstat_rwnd;
474 	uint16_t sstat_unackdata;
475 	uint16_t sstat_penddata;
476 	uint16_t sstat_instrms;
477 	uint16_t sstat_outstrms;
478 	uint32_t sstat_fragmentation_point;
479 	struct sctp_paddrinfo sstat_primary;
480 };
481 
482 /*
483  * AUTHENTICATION support
484  */
485 /* SCTP_AUTH_CHUNK */
486 struct sctp_authchunk {
487 	uint8_t sauth_chunk;
488 };
489 
490 /* SCTP_AUTH_KEY */
491 struct sctp_authkey {
492 	sctp_assoc_t sca_assoc_id;
493 	uint16_t sca_keynumber;
494 	uint8_t sca_key[0];
495 };
496 
497 /* SCTP_HMAC_IDENT */
498 struct sctp_hmacalgo {
499 	uint16_t shmac_idents[0];
500 };
501 
502 /* AUTH hmac_id */
503 #define SCTP_AUTH_HMAC_ID_RSVD		0x0000
504 #define SCTP_AUTH_HMAC_ID_SHA1		0x0001	/* default, mandatory */
505 #define SCTP_AUTH_HMAC_ID_MD5		0x0002	/* deprecated */
506 #define SCTP_AUTH_HMAC_ID_SHA256	0x0003
507 #define SCTP_AUTH_HMAC_ID_SHA224	0x8001
508 #define SCTP_AUTH_HMAC_ID_SHA384	0x8002
509 #define SCTP_AUTH_HMAC_ID_SHA512	0x8003
510 
511 
512 /* SCTP_AUTH_ACTIVE_KEY / SCTP_AUTH_DELETE_KEY */
513 struct sctp_authkeyid {
514 	sctp_assoc_t scact_assoc_id;
515 	uint16_t scact_keynumber;
516 };
517 
518 /* SCTP_PEER_AUTH_CHUNKS / SCTP_LOCAL_AUTH_CHUNKS */
519 struct sctp_authchunks {
520 	sctp_assoc_t gauth_assoc_id;
521 	uint8_t gauth_chunks[0];
522 };
523 
524 struct sctp_assoc_value {
525 	sctp_assoc_t assoc_id;
526 	uint32_t assoc_value;
527 };
528 
529 struct sctp_assoc_ids {
530 	sctp_assoc_t gaids_assoc_id[0];
531 };
532 
533 struct sctp_sack_info {
534 	sctp_assoc_t sack_assoc_id;
535 	uint32_t sack_delay;
536 	uint32_t sack_freq;
537 };
538 
539 struct sctp_cwnd_args {
540 	struct sctp_nets *net;	/* network to *//* FIXME: LP64 issue */
541 	uint32_t cwnd_new_value;/* cwnd in k */
542 	uint32_t inflight;	/* flightsize in k */
543 	uint32_t pseudo_cumack;
544 	uint32_t cwnd_augment;	/* increment to it */
545 	uint8_t meets_pseudo_cumack;
546 	uint8_t need_new_pseudo_cumack;
547 	uint8_t cnt_in_send;
548 	uint8_t cnt_in_str;
549 };
550 
551 struct sctp_blk_args {
552 	uint32_t onsb;		/* in 1k bytes */
553 	uint32_t sndlen;	/* len of send being attempted */
554 	uint32_t peer_rwnd;	/* rwnd of peer */
555 	uint16_t send_sent_qcnt;/* chnk cnt */
556 	uint16_t stream_qcnt;	/* chnk cnt */
557 	uint16_t chunks_on_oque;/* chunks out */
558 	uint16_t flight_size;	/* flight size in k */
559 };
560 
561 /*
562  * Max we can reset in one setting, note this is dictated not by the define
563  * but the size of a mbuf cluster so don't change this define and think you
564  * can specify more. You must do multiple resets if you want to reset more
565  * than SCTP_MAX_EXPLICIT_STR_RESET.
566  */
567 #define SCTP_MAX_EXPLICT_STR_RESET   1000
568 
569 #define SCTP_RESET_LOCAL_RECV  0x0001
570 #define SCTP_RESET_LOCAL_SEND  0x0002
571 #define SCTP_RESET_BOTH        0x0003
572 #define SCTP_RESET_TSN         0x0004
573 
574 struct sctp_stream_reset {
575 	sctp_assoc_t strrst_assoc_id;
576 	uint16_t strrst_flags;
577 	uint16_t strrst_num_streams;	/* 0 == ALL */
578 	uint16_t strrst_list[0];/* list if strrst_num_streams is not 0 */
579 };
580 
581 
582 struct sctp_get_nonce_values {
583 	sctp_assoc_t gn_assoc_id;
584 	uint32_t gn_peers_tag;
585 	uint32_t gn_local_tag;
586 };
587 
588 /* Debugging logs */
589 struct sctp_str_log {
590 	void *stcb;		/* FIXME: LP64 issue */
591 	uint32_t n_tsn;
592 	uint32_t e_tsn;
593 	uint16_t n_sseq;
594 	uint16_t e_sseq;
595 	uint16_t strm;
596 };
597 
598 struct sctp_sb_log {
599 	void *stcb;		/* FIXME: LP64 issue */
600 	uint32_t so_sbcc;
601 	uint32_t stcb_sbcc;
602 	uint32_t incr;
603 };
604 
605 struct sctp_fr_log {
606 	uint32_t largest_tsn;
607 	uint32_t largest_new_tsn;
608 	uint32_t tsn;
609 };
610 
611 struct sctp_fr_map {
612 	uint32_t base;
613 	uint32_t cum;
614 	uint32_t high;
615 };
616 
617 struct sctp_rwnd_log {
618 	uint32_t rwnd;
619 	uint32_t send_size;
620 	uint32_t overhead;
621 	uint32_t new_rwnd;
622 };
623 
624 struct sctp_mbcnt_log {
625 	uint32_t total_queue_size;
626 	uint32_t size_change;
627 	uint32_t total_queue_mb_size;
628 	uint32_t mbcnt_change;
629 };
630 
631 struct sctp_sack_log {
632 	uint32_t cumack;
633 	uint32_t oldcumack;
634 	uint32_t tsn;
635 	uint16_t numGaps;
636 	uint16_t numDups;
637 };
638 
639 struct sctp_lock_log {
640 	void *sock;		/* FIXME: LP64 issue */
641 	void *inp;		/* FIXME: LP64 issue */
642 	uint8_t tcb_lock;
643 	uint8_t inp_lock;
644 	uint8_t info_lock;
645 	uint8_t sock_lock;
646 	uint8_t sockrcvbuf_lock;
647 	uint8_t socksndbuf_lock;
648 	uint8_t create_lock;
649 	uint8_t resv;
650 };
651 
652 struct sctp_rto_log {
653 	void *net;		/* FIXME: LP64 issue */
654 	uint32_t rtt;
655 };
656 
657 struct sctp_nagle_log {
658 	void *stcb;		/* FIXME: LP64 issue */
659 	uint32_t total_flight;
660 	uint32_t total_in_queue;
661 	uint16_t count_in_queue;
662 	uint16_t count_in_flight;
663 };
664 
665 struct sctp_sbwake_log {
666 	void *stcb;		/* FIXME: LP64 issue */
667 	uint16_t send_q;
668 	uint16_t sent_q;
669 	uint16_t flight;
670 	uint16_t wake_cnt;
671 	uint8_t stream_qcnt;	/* chnk cnt */
672 	uint8_t chunks_on_oque;	/* chunks out */
673 	uint8_t sbflags;
674 	uint8_t sctpflags;
675 };
676 
677 struct sctp_misc_info {
678 	uint32_t log1;
679 	uint32_t log2;
680 	uint32_t log3;
681 	uint32_t log4;
682 };
683 
684 struct sctp_log_closing {
685 	void *inp;		/* FIXME: LP64 issue */
686 	void *stcb;		/* FIXME: LP64 issue */
687 	uint32_t sctp_flags;
688 	uint16_t state;
689 	int16_t loc;
690 };
691 
692 struct sctp_mbuf_log {
693 	struct mbuf *mp;	/* FIXME: LP64 issue */
694 	caddr_t ext;
695 	caddr_t data;
696 	uint16_t size;
697 	uint8_t refcnt;
698 	uint8_t mbuf_flags;
699 };
700 
701 struct sctp_cwnd_log {
702 	uint64_t time_event;
703 	uint8_t from;
704 	uint8_t event_type;
705 	uint8_t resv[2];
706 	union {
707 		struct sctp_log_closing close;
708 		struct sctp_blk_args blk;
709 		struct sctp_cwnd_args cwnd;
710 		struct sctp_str_log strlog;
711 		struct sctp_fr_log fr;
712 		struct sctp_fr_map map;
713 		struct sctp_rwnd_log rwnd;
714 		struct sctp_mbcnt_log mbcnt;
715 		struct sctp_sack_log sack;
716 		struct sctp_lock_log lock;
717 		struct sctp_rto_log rto;
718 		struct sctp_sb_log sb;
719 		struct sctp_nagle_log nagle;
720 		struct sctp_sbwake_log wake;
721 		struct sctp_mbuf_log mb;
722 		struct sctp_misc_info misc;
723 	}     x;
724 };
725 
726 struct sctp_cwnd_log_req {
727 	int32_t num_in_log;	/* Number in log */
728 	int32_t num_ret;	/* Number returned */
729 	int32_t start_at;	/* start at this one */
730 	int32_t end_at;		/* end at this one */
731 	struct sctp_cwnd_log log[0];
732 };
733 
734 struct sctpstat {
735 	/* MIB according to RFC 3873 */
736 	uint32_t sctps_currestab;	/* sctpStats  1   (Gauge32) */
737 	uint32_t sctps_activeestab;	/* sctpStats  2 (Counter32) */
738 	uint32_t sctps_restartestab;
739 	uint32_t sctps_collisionestab;
740 	uint32_t sctps_passiveestab;	/* sctpStats  3 (Counter32) */
741 	uint32_t sctps_aborted;	/* sctpStats  4 (Counter32) */
742 	uint32_t sctps_shutdown;/* sctpStats  5 (Counter32) */
743 	uint32_t sctps_outoftheblue;	/* sctpStats  6 (Counter32) */
744 	uint32_t sctps_checksumerrors;	/* sctpStats  7 (Counter32) */
745 	uint32_t sctps_outcontrolchunks;	/* sctpStats  8 (Counter64) */
746 	uint32_t sctps_outorderchunks;	/* sctpStats  9 (Counter64) */
747 	uint32_t sctps_outunorderchunks;	/* sctpStats 10 (Counter64) */
748 	uint32_t sctps_incontrolchunks;	/* sctpStats 11 (Counter64) */
749 	uint32_t sctps_inorderchunks;	/* sctpStats 12 (Counter64) */
750 	uint32_t sctps_inunorderchunks;	/* sctpStats 13 (Counter64) */
751 	uint32_t sctps_fragusrmsgs;	/* sctpStats 14 (Counter64) */
752 	uint32_t sctps_reasmusrmsgs;	/* sctpStats 15 (Counter64) */
753 	uint32_t sctps_outpackets;	/* sctpStats 16 (Counter64) */
754 	uint32_t sctps_inpackets;	/* sctpStats 17 (Counter64) */
755 
756 	/* input statistics: */
757 	uint32_t sctps_recvpackets;	/* total input packets        */
758 	uint32_t sctps_recvdatagrams;	/* total input datagrams      */
759 	uint32_t sctps_recvpktwithdata;	/* total packets that had data */
760 	uint32_t sctps_recvsacks;	/* total input SACK chunks    */
761 	uint32_t sctps_recvdata;/* total input DATA chunks    */
762 	uint32_t sctps_recvdupdata;	/* total input duplicate DATA chunks */
763 	uint32_t sctps_recvheartbeat;	/* total input HB chunks      */
764 	uint32_t sctps_recvheartbeatack;	/* total input HB-ACK chunks  */
765 	uint32_t sctps_recvecne;/* total input ECNE chunks    */
766 	uint32_t sctps_recvauth;/* total input AUTH chunks    */
767 	uint32_t sctps_recvauthmissing;	/* total input chunks missing AUTH */
768 	uint32_t sctps_recvivalhmacid;	/* total number of invalid HMAC ids
769 					 * received */
770 	uint32_t sctps_recvivalkeyid;	/* total number of invalid secret ids
771 					 * received */
772 	uint32_t sctps_recvauthfailed;	/* total number of auth failed */
773 	uint32_t sctps_recvexpress;	/* total fast path receives all one
774 					 * chunk */
775 	uint32_t sctps_recvexpressm;	/* total fast path multi-part data */
776 	/* output statistics: */
777 	uint32_t sctps_sendpackets;	/* total output packets       */
778 	uint32_t sctps_sendsacks;	/* total output SACKs         */
779 	uint32_t sctps_senddata;/* total output DATA chunks   */
780 	uint32_t sctps_sendretransdata;	/* total output retransmitted DATA
781 					 * chunks */
782 	uint32_t sctps_sendfastretrans;	/* total output fast retransmitted
783 					 * DATA chunks */
784 	uint32_t sctps_sendmultfastretrans;	/* total FR's that happened
785 						 * more than once to same
786 						 * chunk (u-del multi-fr
787 						 * algo). */
788 	uint32_t sctps_sendheartbeat;	/* total output HB chunks     */
789 	uint32_t sctps_sendecne;/* total output ECNE chunks    */
790 	uint32_t sctps_sendauth;/* total output AUTH chunks FIXME   */
791 	uint32_t sctps_senderrors;	/* ip_output error counter */
792 	/* PCKDROPREP statistics: */
793 	uint32_t sctps_pdrpfmbox;	/* Packet drop from middle box */
794 	uint32_t sctps_pdrpfehos;	/* P-drop from end host */
795 	uint32_t sctps_pdrpmbda;/* P-drops with data */
796 	uint32_t sctps_pdrpmbct;/* P-drops, non-data, non-endhost */
797 	uint32_t sctps_pdrpbwrpt;	/* P-drop, non-endhost, bandwidth rep
798 					 * only */
799 	uint32_t sctps_pdrpcrupt;	/* P-drop, not enough for chunk header */
800 	uint32_t sctps_pdrpnedat;	/* P-drop, not enough data to confirm */
801 	uint32_t sctps_pdrppdbrk;	/* P-drop, where process_chunk_drop
802 					 * said break */
803 	uint32_t sctps_pdrptsnnf;	/* P-drop, could not find TSN */
804 	uint32_t sctps_pdrpdnfnd;	/* P-drop, attempt reverse TSN lookup */
805 	uint32_t sctps_pdrpdiwnp;	/* P-drop, e-host confirms zero-rwnd */
806 	uint32_t sctps_pdrpdizrw;	/* P-drop, midbox confirms no space */
807 	uint32_t sctps_pdrpbadd;/* P-drop, data did not match TSN */
808 	uint32_t sctps_pdrpmark;/* P-drop, TSN's marked for Fast Retran */
809 	/* timeouts */
810 	uint32_t sctps_timoiterator;	/* Number of iterator timers that
811 					 * fired */
812 	uint32_t sctps_timodata;/* Number of T3 data time outs */
813 	uint32_t sctps_timowindowprobe;	/* Number of window probe (T3) timers
814 					 * that fired */
815 	uint32_t sctps_timoinit;/* Number of INIT timers that fired */
816 	uint32_t sctps_timosack;/* Number of sack timers that fired */
817 	uint32_t sctps_timoshutdown;	/* Number of shutdown timers that
818 					 * fired */
819 	uint32_t sctps_timoheartbeat;	/* Number of heartbeat timers that
820 					 * fired */
821 	uint32_t sctps_timocookie;	/* Number of times a cookie timeout
822 					 * fired */
823 	uint32_t sctps_timosecret;	/* Number of times an endpoint changed
824 					 * its cookie secret */
825 	uint32_t sctps_timopathmtu;	/* Number of PMTU timers that fired */
826 	uint32_t sctps_timoshutdownack;	/* Number of shutdown ack timers that
827 					 * fired */
828 	uint32_t sctps_timoshutdownguard;	/* Number of shutdown guard
829 						 * timers that fired */
830 	uint32_t sctps_timostrmrst;	/* Number of stream reset timers that
831 					 * fired */
832 	uint32_t sctps_timoearlyfr;	/* Number of early FR timers that
833 					 * fired */
834 	uint32_t sctps_timoasconf;	/* Number of times an asconf timer
835 					 * fired */
836 	uint32_t sctps_timoautoclose;	/* Number of times auto close timer
837 					 * fired */
838 	uint32_t sctps_timoassockill;	/* Number of asoc free timers expired */
839 	uint32_t sctps_timoinpkill;	/* Number of inp free timers expired */
840 	/* Early fast retransmission counters */
841 	uint32_t sctps_earlyfrstart;
842 	uint32_t sctps_earlyfrstop;
843 	uint32_t sctps_earlyfrmrkretrans;
844 	uint32_t sctps_earlyfrstpout;
845 	uint32_t sctps_earlyfrstpidsck1;
846 	uint32_t sctps_earlyfrstpidsck2;
847 	uint32_t sctps_earlyfrstpidsck3;
848 	uint32_t sctps_earlyfrstpidsck4;
849 	uint32_t sctps_earlyfrstrid;
850 	uint32_t sctps_earlyfrstrout;
851 	uint32_t sctps_earlyfrstrtmr;
852 	/* otheres */
853 	uint32_t sctps_hdrops;	/* packet shorter than header */
854 	uint32_t sctps_badsum;	/* checksum error             */
855 	uint32_t sctps_noport;	/* no endpoint for port       */
856 	uint32_t sctps_badvtag;	/* bad v-tag                  */
857 	uint32_t sctps_badsid;	/* bad SID                    */
858 	uint32_t sctps_nomem;	/* no memory                  */
859 	uint32_t sctps_fastretransinrtt;	/* number of multiple FR in a
860 						 * RTT window */
861 	uint32_t sctps_markedretrans;
862 	uint32_t sctps_naglesent;	/* nagle allowed sending      */
863 	uint32_t sctps_naglequeued;	/* nagle does't allow sending */
864 	uint32_t sctps_maxburstqueued;	/* max burst dosn't allow sending */
865 	uint32_t sctps_ifnomemqueued;	/* look ahead tells us no memory in
866 					 * interface ring buffer OR we had a
867 					 * send error and are queuing one
868 					 * send. */
869 	uint32_t sctps_windowprobed;	/* total number of window probes sent */
870 	uint32_t sctps_lowlevelerr;	/* total times an output error causes
871 					 * us to clamp down on next user send. */
872 	uint32_t sctps_lowlevelerrusr;	/* total times sctp_senderrors were
873 					 * caused from a user send from a user
874 					 * invoked send not a sack response */
875 	uint32_t sctps_datadropchklmt;	/* Number of in data drops due to
876 					 * chunk limit reached */
877 	uint32_t sctps_datadroprwnd;	/* Number of in data drops due to rwnd
878 					 * limit reached */
879 	uint32_t sctps_ecnereducedcwnd;	/* Number of times a ECN reduced the
880 					 * cwnd */
881 	uint32_t sctps_vtagexpress;	/* Used express lookup via vtag */
882 	uint32_t sctps_vtagbogus;	/* Collision in express lookup. */
883 	uint32_t sctps_primary_randry;	/* Number of times the sender ran dry
884 					 * of user data on primary */
885 	uint32_t sctps_cmt_randry;	/* Same for above */
886 	uint32_t sctps_slowpath_sack;	/* Sacks the slow way */
887 	uint32_t sctps_wu_sacks_sent;	/* Window Update only sacks sent */
888 	uint32_t sctps_sends_with_flags;	/* number of sends with
889 						 * sinfo_flags !=0 */
890 	uint32_t sctps_sends_with_unord /* number of undordered sends */ ;
891 	uint32_t sctps_sends_with_eof;	/* number of sends with EOF flag set */
892 	uint32_t sctps_sends_with_abort;	/* number of sends with ABORT
893 						 * flag set */
894 	uint32_t sctps_protocol_drain_calls;	/* number of times protocol
895 						 * drain called */
896 	uint32_t sctps_protocol_drains_done;	/* number of times we did a
897 						 * protocol drain */
898 	uint32_t sctps_read_peeks;	/* Number of times recv was called
899 					 * with peek */
900 	uint32_t sctps_cached_chk;	/* Number of cached chunks used */
901 	uint32_t sctps_cached_strmoq;	/* Number of cached stream oq's used */
902 	uint32_t sctps_left_abandon;	/* Number of unread message abandonded
903 					 * by close */
904 	uint32_t sctps_send_burst_avoid;	/* Send burst avoidance,
905 						 * already max burst inflight
906 						 * to net */
907 	uint32_t sctps_send_cwnd_avoid;	/* Send cwnd full  avoidance, already
908 					 * max burst inflight to net */
909 	uint32_t sctps_fwdtsn_map_over;	/* number of map array over-runs via
910 					 * fwd-tsn's */
911 
912 	struct timeval sctps_discontinuitytime;	/* sctpStats 18 (TimeStamp) */
913 };
914 
915 #define SCTP_STAT_INCR(_x) SCTP_STAT_INCR_BY(_x,1)
916 #define SCTP_STAT_DECR(_x) SCTP_STAT_DECR_BY(_x,1)
917 #define SCTP_STAT_INCR_BY(_x,_d) atomic_add_int(&sctpstat._x, _d)
918 #define SCTP_STAT_DECR_BY(_x,_d) atomic_subtract_int(&sctpstat._x, _d)
919 
920 /* The following macros are for handling MIB values, */
921 #define SCTP_STAT_INCR_COUNTER32(_x) SCTP_STAT_INCR(_x)
922 #define SCTP_STAT_INCR_COUNTER64(_x) SCTP_STAT_INCR(_x)
923 #define SCTP_STAT_INCR_GAUGE32(_x) SCTP_STAT_INCR(_x)
924 #define SCTP_STAT_DECR_COUNTER32(_x) SCTP_STAT_DECR(_x)
925 #define SCTP_STAT_DECR_COUNTER64(_x) SCTP_STAT_DECR(_x)
926 #define SCTP_STAT_DECR_GAUGE32(_x) SCTP_STAT_DECR(_x)
927 
928 union sctp_sockstore {
929 #if defined(INET) || !defined(_KERNEL)
930 	struct sockaddr_in sin;
931 #endif
932 #if defined(INET6) || !defined(_KERNEL)
933 	struct sockaddr_in6 sin6;
934 #endif
935 	struct sockaddr sa;
936 };
937 
938 struct xsctp_inpcb {
939 	uint32_t last;
940 	uint32_t flags;
941 	uint32_t features;
942 	uint32_t total_sends;
943 	uint32_t total_recvs;
944 	uint32_t total_nospaces;
945 	uint32_t fragmentation_point;
946 	uint16_t local_port;
947 	uint16_t qlen;
948 	uint16_t maxqlen;
949 };
950 
951 struct xsctp_tcb {
952 	union sctp_sockstore primary_addr;	/* sctpAssocEntry 5/6 */
953 	uint32_t last;
954 	uint32_t heartbeat_interval;	/* sctpAssocEntry 7   */
955 	uint32_t state;		/* sctpAssocEntry 8   */
956 	uint32_t in_streams;	/* sctpAssocEntry 9   */
957 	uint32_t out_streams;	/* sctpAssocEntry 10  */
958 	uint32_t max_nr_retrans;/* sctpAssocEntry 11  */
959 	uint32_t primary_process;	/* sctpAssocEntry 12  */
960 	uint32_t T1_expireries;	/* sctpAssocEntry 13  */
961 	uint32_t T2_expireries;	/* sctpAssocEntry 14  */
962 	uint32_t retransmitted_tsns;	/* sctpAssocEntry 15  */
963 	uint32_t total_sends;
964 	uint32_t total_recvs;
965 	uint32_t local_tag;
966 	uint32_t remote_tag;
967 	uint32_t initial_tsn;
968 	uint32_t highest_tsn;
969 	uint32_t cumulative_tsn;
970 	uint32_t cumulative_tsn_ack;
971 	uint32_t mtu;
972 	uint32_t refcnt;
973 	uint16_t local_port;	/* sctpAssocEntry 3   */
974 	uint16_t remote_port;	/* sctpAssocEntry 4   */
975 	struct timeval start_time;	/* sctpAssocEntry 16  */
976 	struct timeval discontinuity_time;	/* sctpAssocEntry 17  */
977 };
978 
979 struct xsctp_laddr {
980 	union sctp_sockstore address;	/* sctpAssocLocalAddrEntry 1/2 */
981 	uint32_t last;
982 	struct timeval start_time;	/* sctpAssocLocalAddrEntry 3   */
983 };
984 
985 struct xsctp_raddr {
986 	union sctp_sockstore address;	/* sctpAssocLocalRemEntry 1/2 */
987 	uint32_t last;
988 	uint32_t rto;		/* sctpAssocLocalRemEntry 5   */
989 	uint32_t max_path_rtx;	/* sctpAssocLocalRemEntry 6   */
990 	uint32_t rtx;		/* sctpAssocLocalRemEntry 7   */
991 	uint32_t error_counter;	/* */
992 	uint32_t cwnd;		/* */
993 	uint32_t flight_size;	/* */
994 	uint32_t mtu;		/* */
995 	uint8_t active;		/* sctpAssocLocalRemEntry 3   */
996 	uint8_t confirmed;	/* */
997 	uint8_t heartbeat_enabled;	/* sctpAssocLocalRemEntry 4   */
998 	struct timeval start_time;	/* sctpAssocLocalRemEntry 8   */
999 };
1000 
1001 /*
1002  * Kernel defined for sctp_send
1003  */
1004 #if defined(_KERNEL)
1005 int
1006 sctp_lower_sosend(struct socket *so,
1007     struct sockaddr *addr,
1008     struct uio *uio,
1009     struct mbuf *i_pak,
1010     struct mbuf *control,
1011     int flags,
1012     int use_rcvinfo,
1013     struct sctp_sndrcvinfo *srcv
1014     ,struct thread *p
1015 );
1016 
1017 int
1018 sctp_sorecvmsg(struct socket *so,
1019     struct uio *uio,
1020     struct mbuf **mp,
1021     struct sockaddr *from,
1022     int fromlen,
1023     int *msg_flags,
1024     struct sctp_sndrcvinfo *sinfo,
1025     int filling_sinfo);
1026 
1027 #endif
1028 
1029 /*
1030  * API system calls
1031  */
1032 #if !(defined(_KERNEL))
1033 
1034 __BEGIN_DECLS
1035 int sctp_peeloff __P((int, sctp_assoc_t));
1036 int sctp_bindx __P((int, struct sockaddr *, int, int));
1037 int sctp_connectx __P((int, const struct sockaddr *, int, sctp_assoc_t *));
1038 int sctp_getaddrlen __P((sa_family_t));
1039 int sctp_getpaddrs __P((int, sctp_assoc_t, struct sockaddr **));
1040 void sctp_freepaddrs __P((struct sockaddr *));
1041 int sctp_getladdrs __P((int, sctp_assoc_t, struct sockaddr **));
1042 void sctp_freeladdrs __P((struct sockaddr *));
1043 int sctp_opt_info __P((int, sctp_assoc_t, int, void *, socklen_t *));
1044 
1045 ssize_t sctp_sendmsg
1046 __P((int, const void *, size_t,
1047     const struct sockaddr *,
1048     socklen_t, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t));
1049 
1050 	ssize_t sctp_send __P((int sd, const void *msg, size_t len,
1051               const struct sctp_sndrcvinfo *sinfo, int flags));
1052 
1053 	ssize_t sctp_sendx __P((int sd, const void *msg, size_t len,
1054                struct sockaddr *addrs, int addrcnt,
1055                struct sctp_sndrcvinfo *sinfo, int flags));
1056 
1057 	ssize_t sctp_sendmsgx __P((int sd, const void *, size_t,
1058                   struct sockaddr *, int,
1059                   uint32_t, uint32_t, uint16_t, uint32_t, uint32_t));
1060 
1061 	sctp_assoc_t sctp_getassocid __P((int sd, struct sockaddr *sa));
1062 
1063 	ssize_t sctp_recvmsg __P((int, void *, size_t, struct sockaddr *,
1064                  socklen_t *, struct sctp_sndrcvinfo *, int *));
1065 
1066 __END_DECLS
1067 
1068 #endif				/* !_KERNEL */
1069 #endif				/* !__sctp_uio_h__ */
1070