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 four bits 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 */
257 #define SCTP_PR_SCTP_MAX SCTP_PR_SCTP_RTX
258 #define SCTP_PR_SCTP_ALL 0x000f/* Used for aggregated stats */
260 #define PR_SCTP_POLICY(x) ((x) & 0x0f)
261 #define PR_SCTP_ENABLED(x) ((PR_SCTP_POLICY(x) != SCTP_PR_SCTP_NONE) && \
262 (PR_SCTP_POLICY(x) != SCTP_PR_SCTP_ALL))
263 #define PR_SCTP_TTL_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_TTL)
264 #define PR_SCTP_BUF_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_BUF)
265 #define PR_SCTP_RTX_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_RTX)
266 #define PR_SCTP_INVALID_POLICY(x) (PR_SCTP_POLICY(x) > SCTP_PR_SCTP_MAX)
267 #define PR_SCTP_VALID_POLICY(x) (PR_SCTP_POLICY(x) <= SCTP_PR_SCTP_MAX)
270 struct sctp_pcbinfo {
273 uint32_t laddr_count;
274 uint32_t raddr_count;
276 uint32_t readq_count;
277 uint32_t free_chunks;
278 uint32_t stream_oque;
281 struct sctp_sockstat {
282 sctp_assoc_t ss_assoc_id;
283 uint32_t ss_total_sndbuf;
284 uint32_t ss_total_recv_buf;
288 * notification event structures
292 * association change event
294 struct sctp_assoc_change {
300 uint16_t sac_outbound_streams;
301 uint16_t sac_inbound_streams;
302 sctp_assoc_t sac_assoc_id;
306 /* sac_state values */
307 #define SCTP_COMM_UP 0x0001
308 #define SCTP_COMM_LOST 0x0002
309 #define SCTP_RESTART 0x0003
310 #define SCTP_SHUTDOWN_COMP 0x0004
311 #define SCTP_CANT_STR_ASSOC 0x0005
313 /* sac_info values */
314 #define SCTP_ASSOC_SUPPORTS_PR 0x01
315 #define SCTP_ASSOC_SUPPORTS_AUTH 0x02
316 #define SCTP_ASSOC_SUPPORTS_ASCONF 0x03
317 #define SCTP_ASSOC_SUPPORTS_MULTIBUF 0x04
318 #define SCTP_ASSOC_SUPPORTS_RE_CONFIG 0x05
319 #define SCTP_ASSOC_SUPPORTS_MAX 0x05
323 struct sctp_paddr_change {
327 struct sockaddr_storage spc_aaddr;
330 sctp_assoc_t spc_assoc_id;
331 uint8_t spc_padding[4];
334 /* paddr state values */
335 #define SCTP_ADDR_AVAILABLE 0x0001
336 #define SCTP_ADDR_UNREACHABLE 0x0002
337 #define SCTP_ADDR_REMOVED 0x0003
338 #define SCTP_ADDR_ADDED 0x0004
339 #define SCTP_ADDR_MADE_PRIM 0x0005
340 #define SCTP_ADDR_CONFIRMED 0x0006
342 #define SCTP_ACTIVE 0x0001 /* SCTP_ADDR_REACHABLE */
343 #define SCTP_INACTIVE 0x0002 /* neither SCTP_ADDR_REACHABLE nor
344 * SCTP_ADDR_UNCONFIRMED */
345 #define SCTP_UNCONFIRMED 0x0200 /* SCTP_ADDR_UNCONFIRMED */
347 /* remote error events */
348 struct sctp_remote_error {
353 sctp_assoc_t sre_assoc_id;
357 /* data send failure event (deprecated) */
358 struct sctp_send_failed {
363 struct sctp_sndrcvinfo ssf_info;
364 sctp_assoc_t ssf_assoc_id;
368 /* data send failure event (not deprecated) */
369 struct sctp_send_failed_event {
372 uint32_t ssfe_length;
374 struct sctp_sndinfo ssfe_info;
375 sctp_assoc_t ssfe_assoc_id;
379 /* flag that indicates state of data */
380 #define SCTP_DATA_UNSENT 0x0001 /* inqueue never on wire */
381 #define SCTP_DATA_SENT 0x0002 /* on wire at failure */
384 struct sctp_shutdown_event {
388 sctp_assoc_t sse_assoc_id;
391 /* Adaptation layer indication stuff */
392 struct sctp_adaptation_event {
396 uint32_t sai_adaptation_ind;
397 sctp_assoc_t sai_assoc_id;
400 struct sctp_setadaptation {
401 uint32_t ssb_adaptation_ind;
404 /* compatible old spelling */
405 struct sctp_adaption_event {
409 uint32_t sai_adaption_ind;
410 sctp_assoc_t sai_assoc_id;
413 struct sctp_setadaption {
414 uint32_t ssb_adaption_ind;
419 * Partial Delivery API event
421 struct sctp_pdapi_event {
423 uint16_t pdapi_flags;
424 uint32_t pdapi_length;
425 uint32_t pdapi_indication;
426 uint16_t pdapi_stream;
428 sctp_assoc_t pdapi_assoc_id;
431 /* indication values */
432 #define SCTP_PARTIAL_DELIVERY_ABORTED 0x0001
436 * authentication key event
438 struct sctp_authkey_event {
441 uint32_t auth_length;
442 uint16_t auth_keynumber;
443 uint16_t auth_altkeynumber;
444 uint32_t auth_indication;
445 sctp_assoc_t auth_assoc_id;
448 /* indication values */
449 #define SCTP_AUTH_NEW_KEY 0x0001
450 #define SCTP_AUTH_NEWKEY SCTP_AUTH_NEW_KEY
451 #define SCTP_AUTH_NO_AUTH 0x0002
452 #define SCTP_AUTH_FREE_KEY 0x0003
455 struct sctp_sender_dry_event {
456 uint16_t sender_dry_type;
457 uint16_t sender_dry_flags;
458 uint32_t sender_dry_length;
459 sctp_assoc_t sender_dry_assoc_id;
464 * Stream reset event - subscribe to SCTP_STREAM_RESET_EVENT
466 struct sctp_stream_reset_event {
467 uint16_t strreset_type;
468 uint16_t strreset_flags;
469 uint32_t strreset_length;
470 sctp_assoc_t strreset_assoc_id;
471 uint16_t strreset_stream_list[];
474 /* flags in stream_reset_event (strreset_flags) */
475 #define SCTP_STREAM_RESET_INCOMING_SSN 0x0001
476 #define SCTP_STREAM_RESET_OUTGOING_SSN 0x0002
477 #define SCTP_STREAM_RESET_DENIED 0x0004
478 #define SCTP_STREAM_RESET_FAILED 0x0008
481 * Assoc reset event - subscribe to SCTP_ASSOC_RESET_EVENT
483 struct sctp_assoc_reset_event {
484 uint16_t assocreset_type;
485 uint16_t assocreset_flags;
486 uint32_t assocreset_length;
487 sctp_assoc_t assocreset_assoc_id;
488 uint32_t assocreset_local_tsn;
489 uint32_t assocreset_remote_tsn;
492 #define SCTP_ASSOC_RESET_DENIED 0x0004
493 #define SCTP_ASSOC_RESET_FAILED 0x0008
496 * Stream change event - subscribe to SCTP_STREAM_CHANGE_EVENT
498 struct sctp_stream_change_event {
499 uint16_t strchange_type;
500 uint16_t strchange_flags;
501 uint32_t strchange_length;
502 sctp_assoc_t strchange_assoc_id;
503 uint16_t strchange_instrms;
504 uint16_t strchange_outstrms;
507 #define SCTP_STREAM_CHANGE_DENIED 0x0004
508 #define SCTP_STREAM_CHANGE_FAILED 0x0008
511 /* SCTP notification event */
518 union sctp_notification {
519 struct sctp_tlv sn_header;
520 struct sctp_assoc_change sn_assoc_change;
521 struct sctp_paddr_change sn_paddr_change;
522 struct sctp_remote_error sn_remote_error;
523 struct sctp_send_failed sn_send_failed;
524 struct sctp_shutdown_event sn_shutdown_event;
525 struct sctp_adaptation_event sn_adaptation_event;
526 /* compatibility same as above */
527 struct sctp_adaption_event sn_adaption_event;
528 struct sctp_pdapi_event sn_pdapi_event;
529 struct sctp_authkey_event sn_auth_event;
530 struct sctp_sender_dry_event sn_sender_dry_event;
531 struct sctp_send_failed_event sn_send_failed_event;
532 struct sctp_stream_reset_event sn_strreset_event;
533 struct sctp_assoc_reset_event sn_assocreset_event;
534 struct sctp_stream_change_event sn_strchange_event;
537 /* notification types */
538 #define SCTP_ASSOC_CHANGE 0x0001
539 #define SCTP_PEER_ADDR_CHANGE 0x0002
540 #define SCTP_REMOTE_ERROR 0x0003
541 #define SCTP_SEND_FAILED 0x0004
542 #define SCTP_SHUTDOWN_EVENT 0x0005
543 #define SCTP_ADAPTATION_INDICATION 0x0006
545 #define SCTP_ADAPTION_INDICATION 0x0006
546 #define SCTP_PARTIAL_DELIVERY_EVENT 0x0007
547 #define SCTP_AUTHENTICATION_EVENT 0x0008
548 #define SCTP_STREAM_RESET_EVENT 0x0009
549 #define SCTP_SENDER_DRY_EVENT 0x000a
550 #define SCTP_NOTIFICATIONS_STOPPED_EVENT 0x000b /* we don't send this */
551 #define SCTP_ASSOC_RESET_EVENT 0x000c
552 #define SCTP_STREAM_CHANGE_EVENT 0x000d
553 #define SCTP_SEND_FAILED_EVENT 0x000e
555 * socket option structs
558 struct sctp_paddrparams {
559 struct sockaddr_storage spp_address;
560 sctp_assoc_t spp_assoc_id;
561 uint32_t spp_hbinterval;
562 uint32_t spp_pathmtu;
564 uint32_t spp_ipv6_flowlabel;
565 uint16_t spp_pathmaxrxt;
569 #define spp_ipv4_tos spp_dscp
571 #define SPP_HB_ENABLE 0x00000001
572 #define SPP_HB_DISABLE 0x00000002
573 #define SPP_HB_DEMAND 0x00000004
574 #define SPP_PMTUD_ENABLE 0x00000008
575 #define SPP_PMTUD_DISABLE 0x00000010
576 #define SPP_HB_TIME_IS_ZERO 0x00000080
577 #define SPP_IPV6_FLOWLABEL 0x00000100
578 #define SPP_DSCP 0x00000200
579 #define SPP_IPV4_TOS SPP_DSCP
581 struct sctp_paddrthlds {
582 struct sockaddr_storage spt_address;
583 sctp_assoc_t spt_assoc_id;
584 uint16_t spt_pathmaxrxt;
585 uint16_t spt_pathpfthld;
588 struct sctp_paddrinfo {
589 struct sockaddr_storage spinfo_address;
590 sctp_assoc_t spinfo_assoc_id;
591 int32_t spinfo_state;
592 uint32_t spinfo_cwnd;
593 uint32_t spinfo_srtt;
598 struct sctp_rtoinfo {
599 sctp_assoc_t srto_assoc_id;
600 uint32_t srto_initial;
605 struct sctp_assocparams {
606 sctp_assoc_t sasoc_assoc_id;
607 uint32_t sasoc_peer_rwnd;
608 uint32_t sasoc_local_rwnd;
609 uint32_t sasoc_cookie_life;
610 uint16_t sasoc_asocmaxrxt;
611 uint16_t sasoc_number_peer_destinations;
614 struct sctp_setprim {
615 struct sockaddr_storage ssp_addr;
616 sctp_assoc_t ssp_assoc_id;
617 uint8_t ssp_padding[4];
620 struct sctp_setpeerprim {
621 struct sockaddr_storage sspp_addr;
622 sctp_assoc_t sspp_assoc_id;
623 uint8_t sspp_padding[4];
626 struct sctp_getaddresses {
627 sctp_assoc_t sget_assoc_id;
628 /* addr is filled in for N * sockaddr_storage */
629 struct sockaddr addr[1];
633 sctp_assoc_t sstat_assoc_id;
636 uint16_t sstat_unackdata;
637 uint16_t sstat_penddata;
638 uint16_t sstat_instrms;
639 uint16_t sstat_outstrms;
640 uint32_t sstat_fragmentation_point;
641 struct sctp_paddrinfo sstat_primary;
645 * AUTHENTICATION support
647 /* SCTP_AUTH_CHUNK */
648 struct sctp_authchunk {
653 struct sctp_authkey {
654 sctp_assoc_t sca_assoc_id;
655 uint16_t sca_keynumber;
656 uint16_t sca_keylength;
660 /* SCTP_HMAC_IDENT */
661 struct sctp_hmacalgo {
662 uint32_t shmac_number_of_idents;
663 uint16_t shmac_idents[];
667 #define SCTP_AUTH_HMAC_ID_RSVD 0x0000
668 #define SCTP_AUTH_HMAC_ID_SHA1 0x0001 /* default, mandatory */
669 #define SCTP_AUTH_HMAC_ID_SHA256 0x0003
671 /* SCTP_AUTH_ACTIVE_KEY / SCTP_AUTH_DELETE_KEY */
672 struct sctp_authkeyid {
673 sctp_assoc_t scact_assoc_id;
674 uint16_t scact_keynumber;
677 /* SCTP_PEER_AUTH_CHUNKS / SCTP_LOCAL_AUTH_CHUNKS */
678 struct sctp_authchunks {
679 sctp_assoc_t gauth_assoc_id;
680 uint32_t gauth_number_of_chunks;
681 uint8_t gauth_chunks[];
684 struct sctp_assoc_value {
685 sctp_assoc_t assoc_id;
686 uint32_t assoc_value;
689 struct sctp_cc_option {
691 struct sctp_assoc_value aid_value;
694 struct sctp_stream_value {
695 sctp_assoc_t assoc_id;
697 uint16_t stream_value;
700 struct sctp_assoc_ids {
701 uint32_t gaids_number_of_ids;
702 sctp_assoc_t gaids_assoc_id[];
705 struct sctp_sack_info {
706 sctp_assoc_t sack_assoc_id;
711 struct sctp_timeouts {
712 sctp_assoc_t stimo_assoc_id;
716 uint32_t stimo_shutdown;
717 uint32_t stimo_heartbeat;
718 uint32_t stimo_cookie;
719 uint32_t stimo_shutdownack;
722 struct sctp_udpencaps {
723 struct sockaddr_storage sue_address;
724 sctp_assoc_t sue_assoc_id;
728 struct sctp_prstatus {
729 sctp_assoc_t sprstat_assoc_id;
730 uint16_t sprstat_sid;
731 uint16_t sprstat_policy;
732 uint64_t sprstat_abandoned_unsent;
733 uint64_t sprstat_abandoned_sent;
736 struct sctp_cwnd_args {
737 struct sctp_nets *net; /* network to *//* FIXME: LP64 issue */
738 uint32_t cwnd_new_value;/* cwnd in k */
739 uint32_t pseudo_cumack;
740 uint16_t inflight; /* flightsize in k */
741 uint16_t cwnd_augment; /* increment to it */
742 uint8_t meets_pseudo_cumack;
743 uint8_t need_new_pseudo_cumack;
748 struct sctp_blk_args {
749 uint32_t onsb; /* in 1k bytes */
750 uint32_t sndlen; /* len of send being attempted */
751 uint32_t peer_rwnd; /* rwnd of peer */
752 uint16_t send_sent_qcnt;/* chnk cnt */
753 uint16_t stream_qcnt; /* chnk cnt */
754 uint16_t chunks_on_oque;/* chunks out */
755 uint16_t flight_size; /* flight size in k */
759 * Max we can reset in one setting, note this is dictated not by the define
760 * but the size of a mbuf cluster so don't change this define and think you
761 * can specify more. You must do multiple resets if you want to reset more
762 * than SCTP_MAX_EXPLICIT_STR_RESET.
764 #define SCTP_MAX_EXPLICT_STR_RESET 1000
766 struct sctp_reset_streams {
767 sctp_assoc_t srs_assoc_id;
769 uint16_t srs_number_streams; /* 0 == ALL */
770 uint16_t srs_stream_list[]; /* list if strrst_num_streams is not 0 */
773 struct sctp_add_streams {
774 sctp_assoc_t sas_assoc_id;
775 uint16_t sas_instrms;
776 uint16_t sas_outstrms;
779 struct sctp_get_nonce_values {
780 sctp_assoc_t gn_assoc_id;
781 uint32_t gn_peers_tag;
782 uint32_t gn_local_tag;
786 struct sctp_str_log {
787 void *stcb; /* FIXME: LP64 issue */
796 void *stcb; /* FIXME: LP64 issue */
803 uint32_t largest_tsn;
804 uint32_t largest_new_tsn;
814 struct sctp_rwnd_log {
821 struct sctp_mbcnt_log {
822 uint32_t total_queue_size;
823 uint32_t size_change;
824 uint32_t total_queue_mb_size;
825 uint32_t mbcnt_change;
828 struct sctp_sack_log {
836 struct sctp_lock_log {
837 void *sock; /* FIXME: LP64 issue */
838 void *inp; /* FIXME: LP64 issue */
843 uint8_t sockrcvbuf_lock;
844 uint8_t socksndbuf_lock;
849 struct sctp_rto_log {
850 void *net; /* FIXME: LP64 issue */
854 struct sctp_nagle_log {
855 void *stcb; /* FIXME: LP64 issue */
856 uint32_t total_flight;
857 uint32_t total_in_queue;
858 uint16_t count_in_queue;
859 uint16_t count_in_flight;
862 struct sctp_sbwake_log {
863 void *stcb; /* FIXME: LP64 issue */
868 uint8_t stream_qcnt; /* chnk cnt */
869 uint8_t chunks_on_oque; /* chunks out */
874 struct sctp_misc_info {
881 struct sctp_log_closing {
882 void *inp; /* FIXME: LP64 issue */
883 void *stcb; /* FIXME: LP64 issue */
889 struct sctp_mbuf_log {
890 struct mbuf *mp; /* FIXME: LP64 issue */
898 struct sctp_cwnd_log {
904 struct sctp_log_closing close;
905 struct sctp_blk_args blk;
906 struct sctp_cwnd_args cwnd;
907 struct sctp_str_log strlog;
908 struct sctp_fr_log fr;
909 struct sctp_fr_map map;
910 struct sctp_rwnd_log rwnd;
911 struct sctp_mbcnt_log mbcnt;
912 struct sctp_sack_log sack;
913 struct sctp_lock_log lock;
914 struct sctp_rto_log rto;
915 struct sctp_sb_log sb;
916 struct sctp_nagle_log nagle;
917 struct sctp_sbwake_log wake;
918 struct sctp_mbuf_log mb;
919 struct sctp_misc_info misc;
923 struct sctp_cwnd_log_req {
924 int32_t num_in_log; /* Number in log */
925 int32_t num_ret; /* Number returned */
926 int32_t start_at; /* start at this one */
927 int32_t end_at; /* end at this one */
928 struct sctp_cwnd_log log[];
931 struct sctp_timeval {
937 struct sctp_timeval sctps_discontinuitytime; /* sctpStats 18
939 /* MIB according to RFC 3873 */
940 uint32_t sctps_currestab; /* sctpStats 1 (Gauge32) */
941 uint32_t sctps_activeestab; /* sctpStats 2 (Counter32) */
942 uint32_t sctps_restartestab;
943 uint32_t sctps_collisionestab;
944 uint32_t sctps_passiveestab; /* sctpStats 3 (Counter32) */
945 uint32_t sctps_aborted; /* sctpStats 4 (Counter32) */
946 uint32_t sctps_shutdown;/* sctpStats 5 (Counter32) */
947 uint32_t sctps_outoftheblue; /* sctpStats 6 (Counter32) */
948 uint32_t sctps_checksumerrors; /* sctpStats 7 (Counter32) */
949 uint32_t sctps_outcontrolchunks; /* sctpStats 8 (Counter64) */
950 uint32_t sctps_outorderchunks; /* sctpStats 9 (Counter64) */
951 uint32_t sctps_outunorderchunks; /* sctpStats 10 (Counter64) */
952 uint32_t sctps_incontrolchunks; /* sctpStats 11 (Counter64) */
953 uint32_t sctps_inorderchunks; /* sctpStats 12 (Counter64) */
954 uint32_t sctps_inunorderchunks; /* sctpStats 13 (Counter64) */
955 uint32_t sctps_fragusrmsgs; /* sctpStats 14 (Counter64) */
956 uint32_t sctps_reasmusrmsgs; /* sctpStats 15 (Counter64) */
957 uint32_t sctps_outpackets; /* sctpStats 16 (Counter64) */
958 uint32_t sctps_inpackets; /* sctpStats 17 (Counter64) */
960 /* input statistics: */
961 uint32_t sctps_recvpackets; /* total input packets */
962 uint32_t sctps_recvdatagrams; /* total input datagrams */
963 uint32_t sctps_recvpktwithdata; /* total packets that had data */
964 uint32_t sctps_recvsacks; /* total input SACK chunks */
965 uint32_t sctps_recvdata;/* total input DATA chunks */
966 uint32_t sctps_recvdupdata; /* total input duplicate DATA chunks */
967 uint32_t sctps_recvheartbeat; /* total input HB chunks */
968 uint32_t sctps_recvheartbeatack; /* total input HB-ACK chunks */
969 uint32_t sctps_recvecne;/* total input ECNE chunks */
970 uint32_t sctps_recvauth;/* total input AUTH chunks */
971 uint32_t sctps_recvauthmissing; /* total input chunks missing AUTH */
972 uint32_t sctps_recvivalhmacid; /* total number of invalid HMAC ids
974 uint32_t sctps_recvivalkeyid; /* total number of invalid secret ids
976 uint32_t sctps_recvauthfailed; /* total number of auth failed */
977 uint32_t sctps_recvexpress; /* total fast path receives all one
979 uint32_t sctps_recvexpressm; /* total fast path multi-part data */
980 uint32_t sctps_recvnocrc;
981 uint32_t sctps_recvswcrc;
982 uint32_t sctps_recvhwcrc;
984 /* output statistics: */
985 uint32_t sctps_sendpackets; /* total output packets */
986 uint32_t sctps_sendsacks; /* total output SACKs */
987 uint32_t sctps_senddata;/* total output DATA chunks */
988 uint32_t sctps_sendretransdata; /* total output retransmitted DATA
990 uint32_t sctps_sendfastretrans; /* total output fast retransmitted
992 uint32_t sctps_sendmultfastretrans; /* total FR's that happened
993 * more than once to same
994 * chunk (u-del multi-fr
996 uint32_t sctps_sendheartbeat; /* total output HB chunks */
997 uint32_t sctps_sendecne;/* total output ECNE chunks */
998 uint32_t sctps_sendauth;/* total output AUTH chunks FIXME */
999 uint32_t sctps_senderrors; /* ip_output error counter */
1000 uint32_t sctps_sendnocrc;
1001 uint32_t sctps_sendswcrc;
1002 uint32_t sctps_sendhwcrc;
1003 /* PCKDROPREP statistics: */
1004 uint32_t sctps_pdrpfmbox; /* Packet drop from middle box */
1005 uint32_t sctps_pdrpfehos; /* P-drop from end host */
1006 uint32_t sctps_pdrpmbda;/* P-drops with data */
1007 uint32_t sctps_pdrpmbct;/* P-drops, non-data, non-endhost */
1008 uint32_t sctps_pdrpbwrpt; /* P-drop, non-endhost, bandwidth rep
1010 uint32_t sctps_pdrpcrupt; /* P-drop, not enough for chunk header */
1011 uint32_t sctps_pdrpnedat; /* P-drop, not enough data to confirm */
1012 uint32_t sctps_pdrppdbrk; /* P-drop, where process_chunk_drop
1014 uint32_t sctps_pdrptsnnf; /* P-drop, could not find TSN */
1015 uint32_t sctps_pdrpdnfnd; /* P-drop, attempt reverse TSN lookup */
1016 uint32_t sctps_pdrpdiwnp; /* P-drop, e-host confirms zero-rwnd */
1017 uint32_t sctps_pdrpdizrw; /* P-drop, midbox confirms no space */
1018 uint32_t sctps_pdrpbadd;/* P-drop, data did not match TSN */
1019 uint32_t sctps_pdrpmark;/* P-drop, TSN's marked for Fast Retran */
1021 uint32_t sctps_timoiterator; /* Number of iterator timers that
1023 uint32_t sctps_timodata;/* Number of T3 data time outs */
1024 uint32_t sctps_timowindowprobe; /* Number of window probe (T3) timers
1026 uint32_t sctps_timoinit;/* Number of INIT timers that fired */
1027 uint32_t sctps_timosack;/* Number of sack timers that fired */
1028 uint32_t sctps_timoshutdown; /* Number of shutdown timers that
1030 uint32_t sctps_timoheartbeat; /* Number of heartbeat timers that
1032 uint32_t sctps_timocookie; /* Number of times a cookie timeout
1034 uint32_t sctps_timosecret; /* Number of times an endpoint changed
1035 * its cookie secret */
1036 uint32_t sctps_timopathmtu; /* Number of PMTU timers that fired */
1037 uint32_t sctps_timoshutdownack; /* Number of shutdown ack timers that
1039 uint32_t sctps_timoshutdownguard; /* Number of shutdown guard
1040 * timers that fired */
1041 uint32_t sctps_timostrmrst; /* Number of stream reset timers that
1043 uint32_t sctps_timoearlyfr; /* Number of early FR timers that
1045 uint32_t sctps_timoasconf; /* Number of times an asconf timer
1047 uint32_t sctps_timodelprim; /* Number of times a prim_deleted
1049 uint32_t sctps_timoautoclose; /* Number of times auto close timer
1051 uint32_t sctps_timoassockill; /* Number of asoc free timers expired */
1052 uint32_t sctps_timoinpkill; /* Number of inp free timers expired */
1053 /* former early FR counters */
1054 uint32_t sctps_spare[11];
1056 uint32_t sctps_hdrops; /* packet shorter than header */
1057 uint32_t sctps_badsum; /* checksum error */
1058 uint32_t sctps_noport; /* no endpoint for port */
1059 uint32_t sctps_badvtag; /* bad v-tag */
1060 uint32_t sctps_badsid; /* bad SID */
1061 uint32_t sctps_nomem; /* no memory */
1062 uint32_t sctps_fastretransinrtt; /* number of multiple FR in a
1064 uint32_t sctps_markedretrans;
1065 uint32_t sctps_naglesent; /* nagle allowed sending */
1066 uint32_t sctps_naglequeued; /* nagle doesn't allow sending */
1067 uint32_t sctps_maxburstqueued; /* max burst doesn't allow sending */
1068 uint32_t sctps_ifnomemqueued; /* look ahead tells us no memory in
1069 * interface ring buffer OR we had a
1070 * send error and are queuing one
1072 uint32_t sctps_windowprobed; /* total number of window probes sent */
1073 uint32_t sctps_lowlevelerr; /* total times an output error causes
1074 * us to clamp down on next user send. */
1075 uint32_t sctps_lowlevelerrusr; /* total times sctp_senderrors were
1076 * caused from a user send from a user
1077 * invoked send not a sack response */
1078 uint32_t sctps_datadropchklmt; /* Number of in data drops due to
1079 * chunk limit reached */
1080 uint32_t sctps_datadroprwnd; /* Number of in data drops due to rwnd
1082 uint32_t sctps_ecnereducedcwnd; /* Number of times a ECN reduced the
1084 uint32_t sctps_vtagexpress; /* Used express lookup via vtag */
1085 uint32_t sctps_vtagbogus; /* Collision in express lookup. */
1086 uint32_t sctps_primary_randry; /* Number of times the sender ran dry
1087 * of user data on primary */
1088 uint32_t sctps_cmt_randry; /* Same for above */
1089 uint32_t sctps_slowpath_sack; /* Sacks the slow way */
1090 uint32_t sctps_wu_sacks_sent; /* Window Update only sacks sent */
1091 uint32_t sctps_sends_with_flags; /* number of sends with
1092 * sinfo_flags !=0 */
1093 uint32_t sctps_sends_with_unord; /* number of unordered sends */
1094 uint32_t sctps_sends_with_eof; /* number of sends with EOF flag set */
1095 uint32_t sctps_sends_with_abort; /* number of sends with ABORT
1097 uint32_t sctps_protocol_drain_calls; /* number of times protocol
1099 uint32_t sctps_protocol_drains_done; /* number of times we did a
1101 uint32_t sctps_read_peeks; /* Number of times recv was called
1103 uint32_t sctps_cached_chk; /* Number of cached chunks used */
1104 uint32_t sctps_cached_strmoq; /* Number of cached stream oq's used */
1105 uint32_t sctps_left_abandon; /* Number of unread messages abandoned
1107 uint32_t sctps_send_burst_avoid; /* Unused */
1108 uint32_t sctps_send_cwnd_avoid; /* Send cwnd full avoidance, already
1109 * max burst inflight to net */
1110 uint32_t sctps_fwdtsn_map_over; /* number of map array over-runs via
1112 uint32_t sctps_queue_upd_ecne; /* Number of times we queued or
1113 * updated an ECN chunk on send queue */
1114 uint32_t sctps_reserved[31]; /* Future ABI compat - remove int's
1115 * from here when adding new */
1118 #define SCTP_STAT_INCR(_x) SCTP_STAT_INCR_BY(_x,1)
1119 #define SCTP_STAT_DECR(_x) SCTP_STAT_DECR_BY(_x,1)
1120 #if defined(__FreeBSD__) && defined(SMP) && defined(SCTP_USE_PERCPU_STAT)
1121 #define SCTP_STAT_INCR_BY(_x,_d) (SCTP_BASE_STATS[PCPU_GET(cpuid)]._x += _d)
1122 #define SCTP_STAT_DECR_BY(_x,_d) (SCTP_BASE_STATS[PCPU_GET(cpuid)]._x -= _d)
1124 #define SCTP_STAT_INCR_BY(_x,_d) atomic_add_int(&SCTP_BASE_STAT(_x), _d)
1125 #define SCTP_STAT_DECR_BY(_x,_d) atomic_subtract_int(&SCTP_BASE_STAT(_x), _d)
1127 /* The following macros are for handling MIB values, */
1128 #define SCTP_STAT_INCR_COUNTER32(_x) SCTP_STAT_INCR(_x)
1129 #define SCTP_STAT_INCR_COUNTER64(_x) SCTP_STAT_INCR(_x)
1130 #define SCTP_STAT_INCR_GAUGE32(_x) SCTP_STAT_INCR(_x)
1131 #define SCTP_STAT_DECR_COUNTER32(_x) SCTP_STAT_DECR(_x)
1132 #define SCTP_STAT_DECR_COUNTER64(_x) SCTP_STAT_DECR(_x)
1133 #define SCTP_STAT_DECR_GAUGE32(_x) SCTP_STAT_DECR(_x)
1135 union sctp_sockstore {
1136 struct sockaddr_in sin;
1137 struct sockaddr_in6 sin6;
1142 /***********************************/
1143 /* And something for us old timers */
1144 /***********************************/
1147 #include <sys/endian.h>
1148 #define ntohll(x) be64toh(x)
1152 #include <sys/endian.h>
1153 #define htonll(x) htobe64(x)
1155 /***********************************/
1158 struct xsctp_inpcb {
1162 uint32_t total_sends;
1163 uint32_t total_recvs;
1164 uint32_t total_nospaces;
1165 uint32_t fragmentation_point;
1166 uint16_t local_port;
1170 #if defined(__LP64__)
1171 uint32_t extra_padding[29]; /* future */
1173 uint32_t extra_padding[30]; /* future */
1178 union sctp_sockstore primary_addr; /* sctpAssocEntry 5/6 */
1180 uint32_t heartbeat_interval; /* sctpAssocEntry 7 */
1181 uint32_t state; /* sctpAssocEntry 8 */
1182 uint32_t in_streams; /* sctpAssocEntry 9 */
1183 uint32_t out_streams; /* sctpAssocEntry 10 */
1184 uint32_t max_nr_retrans;/* sctpAssocEntry 11 */
1185 uint32_t primary_process; /* sctpAssocEntry 12 */
1186 uint32_t T1_expireries; /* sctpAssocEntry 13 */
1187 uint32_t T2_expireries; /* sctpAssocEntry 14 */
1188 uint32_t retransmitted_tsns; /* sctpAssocEntry 15 */
1189 uint32_t total_sends;
1190 uint32_t total_recvs;
1192 uint32_t remote_tag;
1193 uint32_t initial_tsn;
1194 uint32_t highest_tsn;
1195 uint32_t cumulative_tsn;
1196 uint32_t cumulative_tsn_ack;
1199 uint16_t local_port; /* sctpAssocEntry 3 */
1200 uint16_t remote_port; /* sctpAssocEntry 4 */
1201 struct sctp_timeval start_time; /* sctpAssocEntry 16 */
1202 struct sctp_timeval discontinuity_time; /* sctpAssocEntry 17 */
1203 uint32_t peers_rwnd;
1204 sctp_assoc_t assoc_id; /* sctpAssocEntry 1 */
1205 uint32_t extra_padding[32]; /* future */
1208 struct xsctp_laddr {
1209 union sctp_sockstore address; /* sctpAssocLocalAddrEntry 1/2 */
1211 struct sctp_timeval start_time; /* sctpAssocLocalAddrEntry 3 */
1212 uint32_t extra_padding[32]; /* future */
1215 struct xsctp_raddr {
1216 union sctp_sockstore address; /* sctpAssocLocalRemEntry 1/2 */
1218 uint32_t rto; /* sctpAssocLocalRemEntry 5 */
1219 uint32_t max_path_rtx; /* sctpAssocLocalRemEntry 6 */
1220 uint32_t rtx; /* sctpAssocLocalRemEntry 7 */
1221 uint32_t error_counter; /* */
1222 uint32_t cwnd; /* */
1223 uint32_t flight_size; /* */
1225 uint8_t active; /* sctpAssocLocalRemEntry 3 */
1226 uint8_t confirmed; /* */
1227 uint8_t heartbeat_enabled; /* sctpAssocLocalRemEntry 4 */
1228 uint8_t potentially_failed;
1229 struct sctp_timeval start_time; /* sctpAssocLocalRemEntry 8 */
1231 uint32_t heartbeat_interval;
1232 uint32_t extra_padding[31]; /* future */
1235 #define SCTP_MAX_LOGGING_SIZE 30000
1236 #define SCTP_TRACE_PARAMS 6 /* This number MUST be even */
1238 struct sctp_log_entry {
1242 uint32_t params[SCTP_TRACE_PARAMS];
1246 struct sctp_log_entry entry[SCTP_MAX_LOGGING_SIZE];
1252 * Kernel defined for sctp_send
1254 #if defined(_KERNEL) || defined(__Userspace__)
1256 sctp_lower_sosend(struct socket *so,
1257 struct sockaddr *addr,
1260 struct mbuf *control,
1262 struct sctp_sndrcvinfo *srcv
1267 sctp_sorecvmsg(struct socket *so,
1270 struct sockaddr *from,
1273 struct sctp_sndrcvinfo *sinfo,
1281 #if !(defined(_KERNEL)) && !(defined(__Userspace__))
1284 int sctp_peeloff(int, sctp_assoc_t);
1285 int sctp_bindx(int, struct sockaddr *, int, int);
1286 int sctp_connectx(int, const struct sockaddr *, int, sctp_assoc_t *);
1287 int sctp_getaddrlen(sa_family_t);
1288 int sctp_getpaddrs(int, sctp_assoc_t, struct sockaddr **);
1289 void sctp_freepaddrs(struct sockaddr *);
1290 int sctp_getladdrs(int, sctp_assoc_t, struct sockaddr **);
1291 void sctp_freeladdrs(struct sockaddr *);
1292 int sctp_opt_info(int, sctp_assoc_t, int, void *, socklen_t *);
1296 sctp_sendmsg(int, const void *, size_t, const struct sockaddr *,
1297 socklen_t, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t);
1301 sctp_send(int, const void *, size_t,
1302 const struct sctp_sndrcvinfo *, int);
1306 sctp_sendx(int, const void *, size_t, struct sockaddr *,
1307 int, struct sctp_sndrcvinfo *, int);
1311 sctp_sendmsgx(int sd, const void *, size_t, struct sockaddr *,
1312 int, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t);
1314 sctp_assoc_t sctp_getassocid(int, struct sockaddr *);
1318 sctp_recvmsg(int, void *, size_t, struct sockaddr *, socklen_t *,
1319 struct sctp_sndrcvinfo *, int *);
1322 sctp_sendv(int, const struct iovec *, int, struct sockaddr *,
1323 int, void *, socklen_t, unsigned int, int);
1326 sctp_recvv(int, const struct iovec *, int, struct sockaddr *,
1327 socklen_t *, void *, socklen_t *, unsigned int *, int *);
1331 #endif /* !_KERNEL */
1332 #endif /* !__sctp_uio_h__ */