2 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
3 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
4 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * a) Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
12 * b) Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the distribution.
16 * c) Neither the name of Cisco Systems, Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGE.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #ifndef _NETINET_SCTP_UIO_H_
37 #define _NETINET_SCTP_UIO_H_
40 #if ! defined(_KERNEL)
43 #include <sys/types.h>
44 #include <sys/socket.h>
45 #include <netinet/in.h>
47 typedef uint32_t sctp_assoc_t;
49 #define SCTP_FUTURE_ASSOC 0
50 #define SCTP_CURRENT_ASSOC 1
51 #define SCTP_ALL_ASSOC 2
54 sctp_assoc_t se_assoc_id;
59 /* Compatibility to previous define's */
60 #define sctp_stream_reset_events sctp_stream_reset_event
62 /* On/Off setup for subscription to events */
63 struct sctp_event_subscribe {
64 uint8_t sctp_data_io_event;
65 uint8_t sctp_association_event;
66 uint8_t sctp_address_event;
67 uint8_t sctp_send_failure_event;
68 uint8_t sctp_peer_error_event;
69 uint8_t sctp_shutdown_event;
70 uint8_t sctp_partial_delivery_event;
71 uint8_t sctp_adaptation_layer_event;
72 uint8_t sctp_authentication_event;
73 uint8_t sctp_sender_dry_event;
74 uint8_t sctp_stream_reset_event;
77 /* ancillary data types */
78 #define SCTP_INIT 0x0001
79 #define SCTP_SNDRCV 0x0002
80 #define SCTP_EXTRCV 0x0003
81 #define SCTP_SNDINFO 0x0004
82 #define SCTP_RCVINFO 0x0005
83 #define SCTP_NXTINFO 0x0006
84 #define SCTP_PRINFO 0x0007
85 #define SCTP_AUTHINFO 0x0008
86 #define SCTP_DSTADDRV4 0x0009
87 #define SCTP_DSTADDRV6 0x000a
90 * ancillary data structures
93 uint16_t sinit_num_ostreams;
94 uint16_t sinit_max_instreams;
95 uint16_t sinit_max_attempts;
96 uint16_t sinit_max_init_timeo;
99 /* We add 96 bytes to the size of sctp_sndrcvinfo.
100 * This makes the current structure 128 bytes long
101 * which is nicely 64 bit aligned but also has room
102 * for us to add more and keep ABI compatibility.
103 * For example, already we have the sctp_extrcvinfo
104 * when enabled which is 48 bytes.
108 * The assoc up needs a verfid
109 * all sendrcvinfo's need a verfid for SENDING only.
113 #define SCTP_ALIGN_RESV_PAD 92
114 #define SCTP_ALIGN_RESV_PAD_SHORT 76
116 struct sctp_sndrcvinfo {
117 uint16_t sinfo_stream;
119 uint16_t sinfo_flags;
121 uint32_t sinfo_context;
122 uint32_t sinfo_timetolive;
124 uint32_t sinfo_cumtsn;
125 sctp_assoc_t sinfo_assoc_id;
126 uint16_t sinfo_keynumber;
127 uint16_t sinfo_keynumber_valid;
128 uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD];
131 struct sctp_extrcvinfo {
132 uint16_t sinfo_stream;
134 uint16_t sinfo_flags;
136 uint32_t sinfo_context;
137 uint32_t sinfo_timetolive;
139 uint32_t sinfo_cumtsn;
140 sctp_assoc_t sinfo_assoc_id;
141 uint16_t sreinfo_next_flags;
142 uint16_t sreinfo_next_stream;
143 uint32_t sreinfo_next_aid;
144 uint32_t sreinfo_next_length;
145 uint32_t sreinfo_next_ppid;
146 uint16_t sinfo_keynumber;
147 uint16_t sinfo_keynumber_valid;
148 uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD_SHORT];
151 struct sctp_sndinfo {
155 uint32_t snd_context;
156 sctp_assoc_t snd_assoc_id;
164 struct sctp_default_prinfo {
167 sctp_assoc_t pr_assoc_id;
170 struct sctp_authinfo {
171 uint16_t auth_keynumber;
174 struct sctp_rcvinfo {
181 uint32_t rcv_context;
182 sctp_assoc_t rcv_assoc_id;
185 struct sctp_nxtinfo {
190 sctp_assoc_t nxt_assoc_id;
193 #define SCTP_NO_NEXT_MSG 0x0000
194 #define SCTP_NEXT_MSG_AVAIL 0x0001
195 #define SCTP_NEXT_MSG_ISCOMPLETE 0x0002
196 #define SCTP_NEXT_MSG_IS_UNORDERED 0x0004
197 #define SCTP_NEXT_MSG_IS_NOTIFICATION 0x0008
199 struct sctp_recvv_rn {
200 struct sctp_rcvinfo recvv_rcvinfo;
201 struct sctp_nxtinfo recvv_nxtinfo;
204 #define SCTP_RECVV_NOINFO 0
205 #define SCTP_RECVV_RCVINFO 1
206 #define SCTP_RECVV_NXTINFO 2
207 #define SCTP_RECVV_RN 3
209 #define SCTP_SENDV_NOINFO 0
210 #define SCTP_SENDV_SNDINFO 1
211 #define SCTP_SENDV_PRINFO 2
212 #define SCTP_SENDV_AUTHINFO 3
213 #define SCTP_SENDV_SPA 4
215 struct sctp_sendv_spa {
216 uint32_t sendv_flags;
217 struct sctp_sndinfo sendv_sndinfo;
218 struct sctp_prinfo sendv_prinfo;
219 struct sctp_authinfo sendv_authinfo;
222 #define SCTP_SEND_SNDINFO_VALID 0x00000001
223 #define SCTP_SEND_PRINFO_VALID 0x00000002
224 #define SCTP_SEND_AUTHINFO_VALID 0x00000004
226 struct sctp_snd_all_completes {
227 uint16_t sall_stream;
230 uint32_t sall_context;
231 uint32_t sall_num_sent;
232 uint32_t sall_num_failed;
235 /* Flags that go into the sinfo->sinfo_flags field */
236 #define SCTP_NOTIFICATION 0x0010 /* next message is a notification */
237 #define SCTP_COMPLETE 0x0020 /* next message is complete */
238 #define SCTP_EOF 0x0100 /* Start shutdown procedures */
239 #define SCTP_ABORT 0x0200 /* Send an ABORT to peer */
240 #define SCTP_UNORDERED 0x0400 /* Message is un-ordered */
241 #define SCTP_ADDR_OVER 0x0800 /* Override the primary-address */
242 #define SCTP_SENDALL 0x1000 /* Send this on all associations */
243 #define SCTP_EOR 0x2000 /* end of message signal */
244 #define SCTP_SACK_IMMEDIATELY 0x4000 /* Set I-Bit */
246 #define INVALID_SINFO_FLAG(x) (((x) & 0xfffffff0 \
247 & ~(SCTP_EOF | SCTP_ABORT | SCTP_UNORDERED |\
248 SCTP_ADDR_OVER | SCTP_SENDALL | SCTP_EOR |\
249 SCTP_SACK_IMMEDIATELY)) != 0)
250 /* for the endpoint */
252 /* The lower byte is an enumeration of PR-SCTP policies */
253 #define SCTP_PR_SCTP_NONE 0x0000/* Reliable transfer */
254 #define SCTP_PR_SCTP_TTL 0x0001/* Time based PR-SCTP */
255 #define SCTP_PR_SCTP_BUF 0x0002/* Buffer based PR-SCTP */
256 #define SCTP_PR_SCTP_RTX 0x0003/* Number of retransmissions based PR-SCTP */
258 #define PR_SCTP_POLICY(x) ((x) & 0x0f)
259 #define PR_SCTP_ENABLED(x) (PR_SCTP_POLICY(x) != SCTP_PR_SCTP_NONE)
260 #define PR_SCTP_TTL_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_TTL)
261 #define PR_SCTP_BUF_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_BUF)
262 #define PR_SCTP_RTX_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_RTX)
263 #define PR_SCTP_INVALID_POLICY(x) (PR_SCTP_POLICY(x) > SCTP_PR_SCTP_RTX)
265 struct sctp_pcbinfo {
268 uint32_t laddr_count;
269 uint32_t raddr_count;
271 uint32_t readq_count;
272 uint32_t free_chunks;
273 uint32_t stream_oque;
276 struct sctp_sockstat {
277 sctp_assoc_t ss_assoc_id;
278 uint32_t ss_total_sndbuf;
279 uint32_t ss_total_recv_buf;
283 * notification event structures
287 * association change event
289 struct sctp_assoc_change {
295 uint16_t sac_outbound_streams;
296 uint16_t sac_inbound_streams;
297 sctp_assoc_t sac_assoc_id;
301 /* sac_state values */
302 #define SCTP_COMM_UP 0x0001
303 #define SCTP_COMM_LOST 0x0002
304 #define SCTP_RESTART 0x0003
305 #define SCTP_SHUTDOWN_COMP 0x0004
306 #define SCTP_CANT_STR_ASSOC 0x0005
308 /* sac_info values */
309 #define SCTP_ASSOC_SUPPORTS_PR 0x01
310 #define SCTP_ASSOC_SUPPORTS_AUTH 0x02
311 #define SCTP_ASSOC_SUPPORTS_ASCONF 0x03
312 #define SCTP_ASSOC_SUPPORTS_MULTIBUF 0x04
313 #define SCTP_ASSOC_SUPPORTS_RE_CONFIG 0x05
314 #define SCTP_ASSOC_SUPPORTS_MAX 0x05
318 struct sctp_paddr_change {
322 struct sockaddr_storage spc_aaddr;
325 sctp_assoc_t spc_assoc_id;
328 /* paddr state values */
329 #define SCTP_ADDR_AVAILABLE 0x0001
330 #define SCTP_ADDR_UNREACHABLE 0x0002
331 #define SCTP_ADDR_REMOVED 0x0003
332 #define SCTP_ADDR_ADDED 0x0004
333 #define SCTP_ADDR_MADE_PRIM 0x0005
334 #define SCTP_ADDR_CONFIRMED 0x0006
336 #define SCTP_ACTIVE 0x0001 /* SCTP_ADDR_REACHABLE */
337 #define SCTP_INACTIVE 0x0002 /* neither SCTP_ADDR_REACHABLE nor
338 * SCTP_ADDR_UNCONFIRMED */
339 #define SCTP_UNCONFIRMED 0x0200 /* SCTP_ADDR_UNCONFIRMED */
341 /* remote error events */
342 struct sctp_remote_error {
347 sctp_assoc_t sre_assoc_id;
351 /* data send failure event (deprecated) */
352 struct sctp_send_failed {
357 struct sctp_sndrcvinfo ssf_info;
358 sctp_assoc_t ssf_assoc_id;
362 /* data send failure event (not deprecated) */
363 struct sctp_send_failed_event {
366 uint32_t ssfe_length;
368 struct sctp_sndinfo ssfe_info;
369 sctp_assoc_t ssfe_assoc_id;
373 /* flag that indicates state of data */
374 #define SCTP_DATA_UNSENT 0x0001 /* inqueue never on wire */
375 #define SCTP_DATA_SENT 0x0002 /* on wire at failure */
378 struct sctp_shutdown_event {
382 sctp_assoc_t sse_assoc_id;
385 /* Adaptation layer indication stuff */
386 struct sctp_adaptation_event {
390 uint32_t sai_adaptation_ind;
391 sctp_assoc_t sai_assoc_id;
394 struct sctp_setadaptation {
395 uint32_t ssb_adaptation_ind;
398 /* compatible old spelling */
399 struct sctp_adaption_event {
403 uint32_t sai_adaption_ind;
404 sctp_assoc_t sai_assoc_id;
407 struct sctp_setadaption {
408 uint32_t ssb_adaption_ind;
413 * Partial Delivery API event
415 struct sctp_pdapi_event {
417 uint16_t pdapi_flags;
418 uint32_t pdapi_length;
419 uint32_t pdapi_indication;
420 uint16_t pdapi_stream;
422 sctp_assoc_t pdapi_assoc_id;
425 /* indication values */
426 #define SCTP_PARTIAL_DELIVERY_ABORTED 0x0001
430 * authentication key event
432 struct sctp_authkey_event {
435 uint32_t auth_length;
436 uint16_t auth_keynumber;
437 uint16_t auth_altkeynumber;
438 uint32_t auth_indication;
439 sctp_assoc_t auth_assoc_id;
442 /* indication values */
443 #define SCTP_AUTH_NEW_KEY 0x0001
444 #define SCTP_AUTH_NEWKEY SCTP_AUTH_NEW_KEY
445 #define SCTP_AUTH_NO_AUTH 0x0002
446 #define SCTP_AUTH_FREE_KEY 0x0003
449 struct sctp_sender_dry_event {
450 uint16_t sender_dry_type;
451 uint16_t sender_dry_flags;
452 uint32_t sender_dry_length;
453 sctp_assoc_t sender_dry_assoc_id;
458 * Stream reset event - subscribe to SCTP_STREAM_RESET_EVENT
460 struct sctp_stream_reset_event {
461 uint16_t strreset_type;
462 uint16_t strreset_flags;
463 uint32_t strreset_length;
464 sctp_assoc_t strreset_assoc_id;
465 uint16_t strreset_stream_list[];
468 /* flags in stream_reset_event (strreset_flags) */
469 #define SCTP_STREAM_RESET_INCOMING_SSN 0x0001
470 #define SCTP_STREAM_RESET_OUTGOING_SSN 0x0002
471 #define SCTP_STREAM_RESET_DENIED 0x0004
472 #define SCTP_STREAM_RESET_FAILED 0x0008
475 * Assoc reset event - subscribe to SCTP_ASSOC_RESET_EVENT
477 struct sctp_assoc_reset_event {
478 uint16_t assocreset_type;
479 uint16_t assocreset_flags;
480 uint32_t assocreset_length;
481 sctp_assoc_t assocreset_assoc_id;
482 uint32_t assocreset_local_tsn;
483 uint32_t assocreset_remote_tsn;
486 #define SCTP_ASSOC_RESET_DENIED 0x0004
487 #define SCTP_ASSOC_RESET_FAILED 0x0008
490 * Stream change event - subscribe to SCTP_STREAM_CHANGE_EVENT
492 struct sctp_stream_change_event {
493 uint16_t strchange_type;
494 uint16_t strchange_flags;
495 uint32_t strchange_length;
496 sctp_assoc_t strchange_assoc_id;
497 uint16_t strchange_instrms;
498 uint16_t strchange_outstrms;
501 #define SCTP_STREAM_CHANGE_DENIED 0x0004
502 #define SCTP_STREAM_CHANGE_FAILED 0x0008
505 /* SCTP notification event */
512 union sctp_notification {
513 struct sctp_tlv sn_header;
514 struct sctp_assoc_change sn_assoc_change;
515 struct sctp_paddr_change sn_paddr_change;
516 struct sctp_remote_error sn_remote_error;
517 struct sctp_send_failed sn_send_failed;
518 struct sctp_shutdown_event sn_shutdown_event;
519 struct sctp_adaptation_event sn_adaptation_event;
520 /* compatibility same as above */
521 struct sctp_adaption_event sn_adaption_event;
522 struct sctp_pdapi_event sn_pdapi_event;
523 struct sctp_authkey_event sn_auth_event;
524 struct sctp_sender_dry_event sn_sender_dry_event;
525 struct sctp_send_failed_event sn_send_failed_event;
526 struct sctp_stream_reset_event sn_strreset_event;
527 struct sctp_assoc_reset_event sn_assocreset_event;
528 struct sctp_stream_change_event sn_strchange_event;
531 /* notification types */
532 #define SCTP_ASSOC_CHANGE 0x0001
533 #define SCTP_PEER_ADDR_CHANGE 0x0002
534 #define SCTP_REMOTE_ERROR 0x0003
535 #define SCTP_SEND_FAILED 0x0004
536 #define SCTP_SHUTDOWN_EVENT 0x0005
537 #define SCTP_ADAPTATION_INDICATION 0x0006
539 #define SCTP_ADAPTION_INDICATION 0x0006
540 #define SCTP_PARTIAL_DELIVERY_EVENT 0x0007
541 #define SCTP_AUTHENTICATION_EVENT 0x0008
542 #define SCTP_STREAM_RESET_EVENT 0x0009
543 #define SCTP_SENDER_DRY_EVENT 0x000a
544 #define SCTP_NOTIFICATIONS_STOPPED_EVENT 0x000b /* we don't send this */
545 #define SCTP_ASSOC_RESET_EVENT 0x000c
546 #define SCTP_STREAM_CHANGE_EVENT 0x000d
547 #define SCTP_SEND_FAILED_EVENT 0x000e
549 * socket option structs
552 struct sctp_paddrparams {
553 struct sockaddr_storage spp_address;
554 sctp_assoc_t spp_assoc_id;
555 uint32_t spp_hbinterval;
556 uint32_t spp_pathmtu;
558 uint32_t spp_ipv6_flowlabel;
559 uint16_t spp_pathmaxrxt;
563 #define spp_ipv4_tos spp_dscp
565 #define SPP_HB_ENABLE 0x00000001
566 #define SPP_HB_DISABLE 0x00000002
567 #define SPP_HB_DEMAND 0x00000004
568 #define SPP_PMTUD_ENABLE 0x00000008
569 #define SPP_PMTUD_DISABLE 0x00000010
570 #define SPP_HB_TIME_IS_ZERO 0x00000080
571 #define SPP_IPV6_FLOWLABEL 0x00000100
572 #define SPP_DSCP 0x00000200
573 #define SPP_IPV4_TOS SPP_DSCP
575 struct sctp_paddrthlds {
576 struct sockaddr_storage spt_address;
577 sctp_assoc_t spt_assoc_id;
578 uint16_t spt_pathmaxrxt;
579 uint16_t spt_pathpfthld;
582 struct sctp_paddrinfo {
583 struct sockaddr_storage spinfo_address;
584 sctp_assoc_t spinfo_assoc_id;
585 int32_t spinfo_state;
586 uint32_t spinfo_cwnd;
587 uint32_t spinfo_srtt;
592 struct sctp_rtoinfo {
593 sctp_assoc_t srto_assoc_id;
594 uint32_t srto_initial;
599 struct sctp_assocparams {
600 sctp_assoc_t sasoc_assoc_id;
601 uint32_t sasoc_peer_rwnd;
602 uint32_t sasoc_local_rwnd;
603 uint32_t sasoc_cookie_life;
604 uint16_t sasoc_asocmaxrxt;
605 uint16_t sasoc_number_peer_destinations;
608 struct sctp_setprim {
609 struct sockaddr_storage ssp_addr;
610 sctp_assoc_t ssp_assoc_id;
611 uint8_t ssp_padding[4];
614 struct sctp_setpeerprim {
615 struct sockaddr_storage sspp_addr;
616 sctp_assoc_t sspp_assoc_id;
617 uint8_t sspp_padding[4];
620 struct sctp_getaddresses {
621 sctp_assoc_t sget_assoc_id;
622 /* addr is filled in for N * sockaddr_storage */
623 struct sockaddr addr[1];
627 sctp_assoc_t sstat_assoc_id;
630 uint16_t sstat_unackdata;
631 uint16_t sstat_penddata;
632 uint16_t sstat_instrms;
633 uint16_t sstat_outstrms;
634 uint32_t sstat_fragmentation_point;
635 struct sctp_paddrinfo sstat_primary;
639 * AUTHENTICATION support
641 /* SCTP_AUTH_CHUNK */
642 struct sctp_authchunk {
647 struct sctp_authkey {
648 sctp_assoc_t sca_assoc_id;
649 uint16_t sca_keynumber;
650 uint16_t sca_keylength;
654 /* SCTP_HMAC_IDENT */
655 struct sctp_hmacalgo {
656 uint32_t shmac_number_of_idents;
657 uint16_t shmac_idents[];
661 #define SCTP_AUTH_HMAC_ID_RSVD 0x0000
662 #define SCTP_AUTH_HMAC_ID_SHA1 0x0001 /* default, mandatory */
663 #define SCTP_AUTH_HMAC_ID_SHA256 0x0003
665 /* SCTP_AUTH_ACTIVE_KEY / SCTP_AUTH_DELETE_KEY */
666 struct sctp_authkeyid {
667 sctp_assoc_t scact_assoc_id;
668 uint16_t scact_keynumber;
671 /* SCTP_PEER_AUTH_CHUNKS / SCTP_LOCAL_AUTH_CHUNKS */
672 struct sctp_authchunks {
673 sctp_assoc_t gauth_assoc_id;
674 uint32_t gauth_number_of_chunks;
675 uint8_t gauth_chunks[];
678 struct sctp_assoc_value {
679 sctp_assoc_t assoc_id;
680 uint32_t assoc_value;
683 struct sctp_cc_option {
685 struct sctp_assoc_value aid_value;
688 struct sctp_stream_value {
689 sctp_assoc_t assoc_id;
691 uint16_t stream_value;
694 struct sctp_assoc_ids {
695 uint32_t gaids_number_of_ids;
696 sctp_assoc_t gaids_assoc_id[];
699 struct sctp_sack_info {
700 sctp_assoc_t sack_assoc_id;
705 struct sctp_timeouts {
706 sctp_assoc_t stimo_assoc_id;
710 uint32_t stimo_shutdown;
711 uint32_t stimo_heartbeat;
712 uint32_t stimo_cookie;
713 uint32_t stimo_shutdownack;
716 struct sctp_udpencaps {
717 struct sockaddr_storage sue_address;
718 sctp_assoc_t sue_assoc_id;
722 struct sctp_cwnd_args {
723 struct sctp_nets *net; /* network to *//* FIXME: LP64 issue */
724 uint32_t cwnd_new_value;/* cwnd in k */
725 uint32_t pseudo_cumack;
726 uint16_t inflight; /* flightsize in k */
727 uint16_t cwnd_augment; /* increment to it */
728 uint8_t meets_pseudo_cumack;
729 uint8_t need_new_pseudo_cumack;
734 struct sctp_blk_args {
735 uint32_t onsb; /* in 1k bytes */
736 uint32_t sndlen; /* len of send being attempted */
737 uint32_t peer_rwnd; /* rwnd of peer */
738 uint16_t send_sent_qcnt;/* chnk cnt */
739 uint16_t stream_qcnt; /* chnk cnt */
740 uint16_t chunks_on_oque;/* chunks out */
741 uint16_t flight_size; /* flight size in k */
745 * Max we can reset in one setting, note this is dictated not by the define
746 * but the size of a mbuf cluster so don't change this define and think you
747 * can specify more. You must do multiple resets if you want to reset more
748 * than SCTP_MAX_EXPLICIT_STR_RESET.
750 #define SCTP_MAX_EXPLICT_STR_RESET 1000
752 struct sctp_reset_streams {
753 sctp_assoc_t srs_assoc_id;
755 uint16_t srs_number_streams; /* 0 == ALL */
756 uint16_t srs_stream_list[]; /* list if strrst_num_streams is not 0 */
759 struct sctp_add_streams {
760 sctp_assoc_t sas_assoc_id;
761 uint16_t sas_instrms;
762 uint16_t sas_outstrms;
765 struct sctp_get_nonce_values {
766 sctp_assoc_t gn_assoc_id;
767 uint32_t gn_peers_tag;
768 uint32_t gn_local_tag;
772 struct sctp_str_log {
773 void *stcb; /* FIXME: LP64 issue */
782 void *stcb; /* FIXME: LP64 issue */
789 uint32_t largest_tsn;
790 uint32_t largest_new_tsn;
800 struct sctp_rwnd_log {
807 struct sctp_mbcnt_log {
808 uint32_t total_queue_size;
809 uint32_t size_change;
810 uint32_t total_queue_mb_size;
811 uint32_t mbcnt_change;
814 struct sctp_sack_log {
822 struct sctp_lock_log {
823 void *sock; /* FIXME: LP64 issue */
824 void *inp; /* FIXME: LP64 issue */
829 uint8_t sockrcvbuf_lock;
830 uint8_t socksndbuf_lock;
835 struct sctp_rto_log {
836 void *net; /* FIXME: LP64 issue */
840 struct sctp_nagle_log {
841 void *stcb; /* FIXME: LP64 issue */
842 uint32_t total_flight;
843 uint32_t total_in_queue;
844 uint16_t count_in_queue;
845 uint16_t count_in_flight;
848 struct sctp_sbwake_log {
849 void *stcb; /* FIXME: LP64 issue */
854 uint8_t stream_qcnt; /* chnk cnt */
855 uint8_t chunks_on_oque; /* chunks out */
860 struct sctp_misc_info {
867 struct sctp_log_closing {
868 void *inp; /* FIXME: LP64 issue */
869 void *stcb; /* FIXME: LP64 issue */
875 struct sctp_mbuf_log {
876 struct mbuf *mp; /* FIXME: LP64 issue */
884 struct sctp_cwnd_log {
890 struct sctp_log_closing close;
891 struct sctp_blk_args blk;
892 struct sctp_cwnd_args cwnd;
893 struct sctp_str_log strlog;
894 struct sctp_fr_log fr;
895 struct sctp_fr_map map;
896 struct sctp_rwnd_log rwnd;
897 struct sctp_mbcnt_log mbcnt;
898 struct sctp_sack_log sack;
899 struct sctp_lock_log lock;
900 struct sctp_rto_log rto;
901 struct sctp_sb_log sb;
902 struct sctp_nagle_log nagle;
903 struct sctp_sbwake_log wake;
904 struct sctp_mbuf_log mb;
905 struct sctp_misc_info misc;
909 struct sctp_cwnd_log_req {
910 int32_t num_in_log; /* Number in log */
911 int32_t num_ret; /* Number returned */
912 int32_t start_at; /* start at this one */
913 int32_t end_at; /* end at this one */
914 struct sctp_cwnd_log log[];
917 struct sctp_timeval {
923 struct sctp_timeval sctps_discontinuitytime; /* sctpStats 18
925 /* MIB according to RFC 3873 */
926 uint32_t sctps_currestab; /* sctpStats 1 (Gauge32) */
927 uint32_t sctps_activeestab; /* sctpStats 2 (Counter32) */
928 uint32_t sctps_restartestab;
929 uint32_t sctps_collisionestab;
930 uint32_t sctps_passiveestab; /* sctpStats 3 (Counter32) */
931 uint32_t sctps_aborted; /* sctpStats 4 (Counter32) */
932 uint32_t sctps_shutdown;/* sctpStats 5 (Counter32) */
933 uint32_t sctps_outoftheblue; /* sctpStats 6 (Counter32) */
934 uint32_t sctps_checksumerrors; /* sctpStats 7 (Counter32) */
935 uint32_t sctps_outcontrolchunks; /* sctpStats 8 (Counter64) */
936 uint32_t sctps_outorderchunks; /* sctpStats 9 (Counter64) */
937 uint32_t sctps_outunorderchunks; /* sctpStats 10 (Counter64) */
938 uint32_t sctps_incontrolchunks; /* sctpStats 11 (Counter64) */
939 uint32_t sctps_inorderchunks; /* sctpStats 12 (Counter64) */
940 uint32_t sctps_inunorderchunks; /* sctpStats 13 (Counter64) */
941 uint32_t sctps_fragusrmsgs; /* sctpStats 14 (Counter64) */
942 uint32_t sctps_reasmusrmsgs; /* sctpStats 15 (Counter64) */
943 uint32_t sctps_outpackets; /* sctpStats 16 (Counter64) */
944 uint32_t sctps_inpackets; /* sctpStats 17 (Counter64) */
946 /* input statistics: */
947 uint32_t sctps_recvpackets; /* total input packets */
948 uint32_t sctps_recvdatagrams; /* total input datagrams */
949 uint32_t sctps_recvpktwithdata; /* total packets that had data */
950 uint32_t sctps_recvsacks; /* total input SACK chunks */
951 uint32_t sctps_recvdata;/* total input DATA chunks */
952 uint32_t sctps_recvdupdata; /* total input duplicate DATA chunks */
953 uint32_t sctps_recvheartbeat; /* total input HB chunks */
954 uint32_t sctps_recvheartbeatack; /* total input HB-ACK chunks */
955 uint32_t sctps_recvecne;/* total input ECNE chunks */
956 uint32_t sctps_recvauth;/* total input AUTH chunks */
957 uint32_t sctps_recvauthmissing; /* total input chunks missing AUTH */
958 uint32_t sctps_recvivalhmacid; /* total number of invalid HMAC ids
960 uint32_t sctps_recvivalkeyid; /* total number of invalid secret ids
962 uint32_t sctps_recvauthfailed; /* total number of auth failed */
963 uint32_t sctps_recvexpress; /* total fast path receives all one
965 uint32_t sctps_recvexpressm; /* total fast path multi-part data */
966 uint32_t sctps_recvnocrc;
967 uint32_t sctps_recvswcrc;
968 uint32_t sctps_recvhwcrc;
970 /* output statistics: */
971 uint32_t sctps_sendpackets; /* total output packets */
972 uint32_t sctps_sendsacks; /* total output SACKs */
973 uint32_t sctps_senddata;/* total output DATA chunks */
974 uint32_t sctps_sendretransdata; /* total output retransmitted DATA
976 uint32_t sctps_sendfastretrans; /* total output fast retransmitted
978 uint32_t sctps_sendmultfastretrans; /* total FR's that happened
979 * more than once to same
980 * chunk (u-del multi-fr
982 uint32_t sctps_sendheartbeat; /* total output HB chunks */
983 uint32_t sctps_sendecne;/* total output ECNE chunks */
984 uint32_t sctps_sendauth;/* total output AUTH chunks FIXME */
985 uint32_t sctps_senderrors; /* ip_output error counter */
986 uint32_t sctps_sendnocrc;
987 uint32_t sctps_sendswcrc;
988 uint32_t sctps_sendhwcrc;
989 /* PCKDROPREP statistics: */
990 uint32_t sctps_pdrpfmbox; /* Packet drop from middle box */
991 uint32_t sctps_pdrpfehos; /* P-drop from end host */
992 uint32_t sctps_pdrpmbda;/* P-drops with data */
993 uint32_t sctps_pdrpmbct;/* P-drops, non-data, non-endhost */
994 uint32_t sctps_pdrpbwrpt; /* P-drop, non-endhost, bandwidth rep
996 uint32_t sctps_pdrpcrupt; /* P-drop, not enough for chunk header */
997 uint32_t sctps_pdrpnedat; /* P-drop, not enough data to confirm */
998 uint32_t sctps_pdrppdbrk; /* P-drop, where process_chunk_drop
1000 uint32_t sctps_pdrptsnnf; /* P-drop, could not find TSN */
1001 uint32_t sctps_pdrpdnfnd; /* P-drop, attempt reverse TSN lookup */
1002 uint32_t sctps_pdrpdiwnp; /* P-drop, e-host confirms zero-rwnd */
1003 uint32_t sctps_pdrpdizrw; /* P-drop, midbox confirms no space */
1004 uint32_t sctps_pdrpbadd;/* P-drop, data did not match TSN */
1005 uint32_t sctps_pdrpmark;/* P-drop, TSN's marked for Fast Retran */
1007 uint32_t sctps_timoiterator; /* Number of iterator timers that
1009 uint32_t sctps_timodata;/* Number of T3 data time outs */
1010 uint32_t sctps_timowindowprobe; /* Number of window probe (T3) timers
1012 uint32_t sctps_timoinit;/* Number of INIT timers that fired */
1013 uint32_t sctps_timosack;/* Number of sack timers that fired */
1014 uint32_t sctps_timoshutdown; /* Number of shutdown timers that
1016 uint32_t sctps_timoheartbeat; /* Number of heartbeat timers that
1018 uint32_t sctps_timocookie; /* Number of times a cookie timeout
1020 uint32_t sctps_timosecret; /* Number of times an endpoint changed
1021 * its cookie secret */
1022 uint32_t sctps_timopathmtu; /* Number of PMTU timers that fired */
1023 uint32_t sctps_timoshutdownack; /* Number of shutdown ack timers that
1025 uint32_t sctps_timoshutdownguard; /* Number of shutdown guard
1026 * timers that fired */
1027 uint32_t sctps_timostrmrst; /* Number of stream reset timers that
1029 uint32_t sctps_timoearlyfr; /* Number of early FR timers that
1031 uint32_t sctps_timoasconf; /* Number of times an asconf timer
1033 uint32_t sctps_timodelprim; /* Number of times a prim_deleted
1035 uint32_t sctps_timoautoclose; /* Number of times auto close timer
1037 uint32_t sctps_timoassockill; /* Number of asoc free timers expired */
1038 uint32_t sctps_timoinpkill; /* Number of inp free timers expired */
1039 /* former early FR counters */
1040 uint32_t sctps_spare[11];
1042 uint32_t sctps_hdrops; /* packet shorter than header */
1043 uint32_t sctps_badsum; /* checksum error */
1044 uint32_t sctps_noport; /* no endpoint for port */
1045 uint32_t sctps_badvtag; /* bad v-tag */
1046 uint32_t sctps_badsid; /* bad SID */
1047 uint32_t sctps_nomem; /* no memory */
1048 uint32_t sctps_fastretransinrtt; /* number of multiple FR in a
1050 uint32_t sctps_markedretrans;
1051 uint32_t sctps_naglesent; /* nagle allowed sending */
1052 uint32_t sctps_naglequeued; /* nagle doesn't allow sending */
1053 uint32_t sctps_maxburstqueued; /* max burst doesn't allow sending */
1054 uint32_t sctps_ifnomemqueued; /* look ahead tells us no memory in
1055 * interface ring buffer OR we had a
1056 * send error and are queuing one
1058 uint32_t sctps_windowprobed; /* total number of window probes sent */
1059 uint32_t sctps_lowlevelerr; /* total times an output error causes
1060 * us to clamp down on next user send. */
1061 uint32_t sctps_lowlevelerrusr; /* total times sctp_senderrors were
1062 * caused from a user send from a user
1063 * invoked send not a sack response */
1064 uint32_t sctps_datadropchklmt; /* Number of in data drops due to
1065 * chunk limit reached */
1066 uint32_t sctps_datadroprwnd; /* Number of in data drops due to rwnd
1068 uint32_t sctps_ecnereducedcwnd; /* Number of times a ECN reduced the
1070 uint32_t sctps_vtagexpress; /* Used express lookup via vtag */
1071 uint32_t sctps_vtagbogus; /* Collision in express lookup. */
1072 uint32_t sctps_primary_randry; /* Number of times the sender ran dry
1073 * of user data on primary */
1074 uint32_t sctps_cmt_randry; /* Same for above */
1075 uint32_t sctps_slowpath_sack; /* Sacks the slow way */
1076 uint32_t sctps_wu_sacks_sent; /* Window Update only sacks sent */
1077 uint32_t sctps_sends_with_flags; /* number of sends with
1078 * sinfo_flags !=0 */
1079 uint32_t sctps_sends_with_unord; /* number of unordered sends */
1080 uint32_t sctps_sends_with_eof; /* number of sends with EOF flag set */
1081 uint32_t sctps_sends_with_abort; /* number of sends with ABORT
1083 uint32_t sctps_protocol_drain_calls; /* number of times protocol
1085 uint32_t sctps_protocol_drains_done; /* number of times we did a
1087 uint32_t sctps_read_peeks; /* Number of times recv was called
1089 uint32_t sctps_cached_chk; /* Number of cached chunks used */
1090 uint32_t sctps_cached_strmoq; /* Number of cached stream oq's used */
1091 uint32_t sctps_left_abandon; /* Number of unread messages abandoned
1093 uint32_t sctps_send_burst_avoid; /* Unused */
1094 uint32_t sctps_send_cwnd_avoid; /* Send cwnd full avoidance, already
1095 * max burst inflight to net */
1096 uint32_t sctps_fwdtsn_map_over; /* number of map array over-runs via
1098 uint32_t sctps_queue_upd_ecne; /* Number of times we queued or
1099 * updated an ECN chunk on send queue */
1100 uint32_t sctps_reserved[31]; /* Future ABI compat - remove int's
1101 * from here when adding new */
1104 #define SCTP_STAT_INCR(_x) SCTP_STAT_INCR_BY(_x,1)
1105 #define SCTP_STAT_DECR(_x) SCTP_STAT_DECR_BY(_x,1)
1106 #if defined(__FreeBSD__) && defined(SMP) && defined(SCTP_USE_PERCPU_STAT)
1107 #define SCTP_STAT_INCR_BY(_x,_d) (SCTP_BASE_STATS[PCPU_GET(cpuid)]._x += _d)
1108 #define SCTP_STAT_DECR_BY(_x,_d) (SCTP_BASE_STATS[PCPU_GET(cpuid)]._x -= _d)
1110 #define SCTP_STAT_INCR_BY(_x,_d) atomic_add_int(&SCTP_BASE_STAT(_x), _d)
1111 #define SCTP_STAT_DECR_BY(_x,_d) atomic_subtract_int(&SCTP_BASE_STAT(_x), _d)
1113 /* The following macros are for handling MIB values, */
1114 #define SCTP_STAT_INCR_COUNTER32(_x) SCTP_STAT_INCR(_x)
1115 #define SCTP_STAT_INCR_COUNTER64(_x) SCTP_STAT_INCR(_x)
1116 #define SCTP_STAT_INCR_GAUGE32(_x) SCTP_STAT_INCR(_x)
1117 #define SCTP_STAT_DECR_COUNTER32(_x) SCTP_STAT_DECR(_x)
1118 #define SCTP_STAT_DECR_COUNTER64(_x) SCTP_STAT_DECR(_x)
1119 #define SCTP_STAT_DECR_GAUGE32(_x) SCTP_STAT_DECR(_x)
1121 union sctp_sockstore {
1122 struct sockaddr_in sin;
1123 struct sockaddr_in6 sin6;
1128 /***********************************/
1129 /* And something for us old timers */
1130 /***********************************/
1133 #include <sys/endian.h>
1134 #define ntohll(x) be64toh(x)
1138 #include <sys/endian.h>
1139 #define htonll(x) htobe64(x)
1141 /***********************************/
1144 struct xsctp_inpcb {
1148 uint32_t total_sends;
1149 uint32_t total_recvs;
1150 uint32_t total_nospaces;
1151 uint32_t fragmentation_point;
1152 uint16_t local_port;
1155 uint32_t extra_padding[31]; /* future */
1159 union sctp_sockstore primary_addr; /* sctpAssocEntry 5/6 */
1161 uint32_t heartbeat_interval; /* sctpAssocEntry 7 */
1162 uint32_t state; /* sctpAssocEntry 8 */
1163 uint32_t in_streams; /* sctpAssocEntry 9 */
1164 uint32_t out_streams; /* sctpAssocEntry 10 */
1165 uint32_t max_nr_retrans;/* sctpAssocEntry 11 */
1166 uint32_t primary_process; /* sctpAssocEntry 12 */
1167 uint32_t T1_expireries; /* sctpAssocEntry 13 */
1168 uint32_t T2_expireries; /* sctpAssocEntry 14 */
1169 uint32_t retransmitted_tsns; /* sctpAssocEntry 15 */
1170 uint32_t total_sends;
1171 uint32_t total_recvs;
1173 uint32_t remote_tag;
1174 uint32_t initial_tsn;
1175 uint32_t highest_tsn;
1176 uint32_t cumulative_tsn;
1177 uint32_t cumulative_tsn_ack;
1180 uint16_t local_port; /* sctpAssocEntry 3 */
1181 uint16_t remote_port; /* sctpAssocEntry 4 */
1182 struct sctp_timeval start_time; /* sctpAssocEntry 16 */
1183 struct sctp_timeval discontinuity_time; /* sctpAssocEntry 17 */
1184 uint32_t peers_rwnd;
1185 sctp_assoc_t assoc_id; /* sctpAssocEntry 1 */
1186 uint32_t extra_padding[32]; /* future */
1189 struct xsctp_laddr {
1190 union sctp_sockstore address; /* sctpAssocLocalAddrEntry 1/2 */
1192 struct sctp_timeval start_time; /* sctpAssocLocalAddrEntry 3 */
1193 uint32_t extra_padding[32]; /* future */
1196 struct xsctp_raddr {
1197 union sctp_sockstore address; /* sctpAssocLocalRemEntry 1/2 */
1199 uint32_t rto; /* sctpAssocLocalRemEntry 5 */
1200 uint32_t max_path_rtx; /* sctpAssocLocalRemEntry 6 */
1201 uint32_t rtx; /* sctpAssocLocalRemEntry 7 */
1202 uint32_t error_counter; /* */
1203 uint32_t cwnd; /* */
1204 uint32_t flight_size; /* */
1206 uint8_t active; /* sctpAssocLocalRemEntry 3 */
1207 uint8_t confirmed; /* */
1208 uint8_t heartbeat_enabled; /* sctpAssocLocalRemEntry 4 */
1209 uint8_t potentially_failed;
1210 struct sctp_timeval start_time; /* sctpAssocLocalRemEntry 8 */
1212 uint32_t heartbeat_interval;
1213 uint32_t extra_padding[31]; /* future */
1216 #define SCTP_MAX_LOGGING_SIZE 30000
1217 #define SCTP_TRACE_PARAMS 6 /* This number MUST be even */
1219 struct sctp_log_entry {
1223 uint32_t params[SCTP_TRACE_PARAMS];
1227 struct sctp_log_entry entry[SCTP_MAX_LOGGING_SIZE];
1233 * Kernel defined for sctp_send
1235 #if defined(_KERNEL) || defined(__Userspace__)
1237 sctp_lower_sosend(struct socket *so,
1238 struct sockaddr *addr,
1241 struct mbuf *control,
1243 struct sctp_sndrcvinfo *srcv
1248 sctp_sorecvmsg(struct socket *so,
1251 struct sockaddr *from,
1254 struct sctp_sndrcvinfo *sinfo,
1262 #if !(defined(_KERNEL)) && !(defined(__Userspace__))
1265 int sctp_peeloff(int, sctp_assoc_t);
1266 int sctp_bindx(int, struct sockaddr *, int, int);
1267 int sctp_connectx(int, const struct sockaddr *, int, sctp_assoc_t *);
1268 int sctp_getaddrlen(sa_family_t);
1269 int sctp_getpaddrs(int, sctp_assoc_t, struct sockaddr **);
1270 void sctp_freepaddrs(struct sockaddr *);
1271 int sctp_getladdrs(int, sctp_assoc_t, struct sockaddr **);
1272 void sctp_freeladdrs(struct sockaddr *);
1273 int sctp_opt_info(int, sctp_assoc_t, int, void *, socklen_t *);
1277 sctp_sendmsg(int, const void *, size_t, const struct sockaddr *,
1278 socklen_t, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t);
1282 sctp_send(int, const void *, size_t,
1283 const struct sctp_sndrcvinfo *, int);
1287 sctp_sendx(int, const void *, size_t, struct sockaddr *,
1288 int, struct sctp_sndrcvinfo *, int);
1292 sctp_sendmsgx(int sd, const void *, size_t, struct sockaddr *,
1293 int, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t);
1295 sctp_assoc_t sctp_getassocid(int, struct sockaddr *);
1299 sctp_recvmsg(int, void *, size_t, struct sockaddr *, socklen_t *,
1300 struct sctp_sndrcvinfo *, int *);
1303 sctp_sendv(int, const struct iovec *, int, struct sockaddr *,
1304 int, void *, socklen_t, unsigned int, int);
1307 sctp_recvv(int, const struct iovec *, int, struct sockaddr *,
1308 socklen_t *, void *, socklen_t *, unsigned int *, int *);
1312 #endif /* !_KERNEL */
1313 #endif /* !__sctp_uio_h__ */