2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
5 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
6 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * a) Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
14 * b) Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the distribution.
18 * c) Neither the name of Cisco Systems, Inc. nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
24 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32 * THE POSSIBILITY OF SUCH DAMAGE.
35 #include <sys/cdefs.h>
36 #ifndef _NETINET_SCTP_UIO_H_
37 #define _NETINET_SCTP_UIO_H_
42 #include <sys/types.h>
43 #include <sys/socket.h>
44 #include <netinet/in.h>
46 typedef uint32_t sctp_assoc_t;
48 #define SCTP_FUTURE_ASSOC 0
49 #define SCTP_CURRENT_ASSOC 1
50 #define SCTP_ALL_ASSOC 2
53 sctp_assoc_t se_assoc_id;
58 /* Compatibility to previous define's */
59 #define sctp_stream_reset_events sctp_stream_reset_event
61 /* On/Off setup for subscription to events */
62 struct sctp_event_subscribe {
63 uint8_t sctp_data_io_event;
64 uint8_t sctp_association_event;
65 uint8_t sctp_address_event;
66 uint8_t sctp_send_failure_event;
67 uint8_t sctp_peer_error_event;
68 uint8_t sctp_shutdown_event;
69 uint8_t sctp_partial_delivery_event;
70 uint8_t sctp_adaptation_layer_event;
71 uint8_t sctp_authentication_event;
72 uint8_t sctp_sender_dry_event;
73 uint8_t sctp_stream_reset_event;
76 /* ancillary data types */
77 #define SCTP_INIT 0x0001
78 #define SCTP_SNDRCV 0x0002
79 #define SCTP_EXTRCV 0x0003
80 #define SCTP_SNDINFO 0x0004
81 #define SCTP_RCVINFO 0x0005
82 #define SCTP_NXTINFO 0x0006
83 #define SCTP_PRINFO 0x0007
84 #define SCTP_AUTHINFO 0x0008
85 #define SCTP_DSTADDRV4 0x0009
86 #define SCTP_DSTADDRV6 0x000a
89 * ancillary data structures
92 uint16_t sinit_num_ostreams;
93 uint16_t sinit_max_instreams;
94 uint16_t sinit_max_attempts;
95 uint16_t sinit_max_init_timeo;
98 /* We add 96 bytes to the size of sctp_sndrcvinfo.
99 * This makes the current structure 128 bytes long
100 * which is nicely 64 bit aligned but also has room
101 * for us to add more and keep ABI compatibility.
102 * For example, already we have the sctp_extrcvinfo
103 * when enabled which is 48 bytes.
107 * The assoc up needs a verfid
108 * all sendrcvinfo's need a verfid for SENDING only.
111 #define SCTP_ALIGN_RESV_PAD 92
112 #define SCTP_ALIGN_RESV_PAD_SHORT 76
114 struct sctp_sndrcvinfo {
115 uint16_t sinfo_stream;
117 uint16_t sinfo_flags;
119 uint32_t sinfo_context;
120 uint32_t sinfo_timetolive;
122 uint32_t sinfo_cumtsn;
123 sctp_assoc_t sinfo_assoc_id;
124 uint16_t sinfo_keynumber;
125 uint16_t sinfo_keynumber_valid;
126 uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD];
129 struct sctp_extrcvinfo {
130 uint16_t sinfo_stream;
132 uint16_t sinfo_flags;
134 uint32_t sinfo_context;
135 uint32_t sinfo_timetolive; /* should have been sinfo_pr_value */
137 uint32_t sinfo_cumtsn;
138 sctp_assoc_t sinfo_assoc_id;
139 uint16_t serinfo_next_flags;
140 uint16_t serinfo_next_stream;
141 uint32_t serinfo_next_aid;
142 uint32_t serinfo_next_length;
143 uint32_t serinfo_next_ppid;
144 uint16_t sinfo_keynumber;
145 uint16_t sinfo_keynumber_valid;
146 uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD_SHORT];
148 #define sinfo_pr_value sinfo_timetolive
149 #define sreinfo_next_flags serinfo_next_flags
150 #define sreinfo_next_stream serinfo_next_stream
151 #define sreinfo_next_aid serinfo_next_aid
152 #define sreinfo_next_length serinfo_next_length
153 #define sreinfo_next_ppid serinfo_next_ppid
155 struct sctp_sndinfo {
159 uint32_t snd_context;
160 sctp_assoc_t snd_assoc_id;
168 struct sctp_default_prinfo {
171 sctp_assoc_t pr_assoc_id;
174 struct sctp_authinfo {
175 uint16_t auth_keynumber;
178 struct sctp_rcvinfo {
185 uint32_t rcv_context;
186 sctp_assoc_t rcv_assoc_id;
189 struct sctp_nxtinfo {
194 sctp_assoc_t nxt_assoc_id;
197 #define SCTP_NO_NEXT_MSG 0x0000
198 #define SCTP_NEXT_MSG_AVAIL 0x0001
199 #define SCTP_NEXT_MSG_ISCOMPLETE 0x0002
200 #define SCTP_NEXT_MSG_IS_UNORDERED 0x0004
201 #define SCTP_NEXT_MSG_IS_NOTIFICATION 0x0008
203 struct sctp_recvv_rn {
204 struct sctp_rcvinfo recvv_rcvinfo;
205 struct sctp_nxtinfo recvv_nxtinfo;
208 #define SCTP_RECVV_NOINFO 0
209 #define SCTP_RECVV_RCVINFO 1
210 #define SCTP_RECVV_NXTINFO 2
211 #define SCTP_RECVV_RN 3
213 #define SCTP_SENDV_NOINFO 0
214 #define SCTP_SENDV_SNDINFO 1
215 #define SCTP_SENDV_PRINFO 2
216 #define SCTP_SENDV_AUTHINFO 3
217 #define SCTP_SENDV_SPA 4
219 struct sctp_sendv_spa {
220 uint32_t sendv_flags;
221 struct sctp_sndinfo sendv_sndinfo;
222 struct sctp_prinfo sendv_prinfo;
223 struct sctp_authinfo sendv_authinfo;
226 #define SCTP_SEND_SNDINFO_VALID 0x00000001
227 #define SCTP_SEND_PRINFO_VALID 0x00000002
228 #define SCTP_SEND_AUTHINFO_VALID 0x00000004
230 struct sctp_snd_all_completes {
231 uint16_t sall_stream;
234 uint32_t sall_context;
235 uint32_t sall_num_sent;
236 uint32_t sall_num_failed;
239 /* Flags that go into the sinfo->sinfo_flags field */
240 #define SCTP_NOTIFICATION 0x0010 /* next message is a notification */
241 #define SCTP_COMPLETE 0x0020 /* next message is complete */
242 #define SCTP_EOF 0x0100 /* Start shutdown procedures */
243 #define SCTP_ABORT 0x0200 /* Send an ABORT to peer */
244 #define SCTP_UNORDERED 0x0400 /* Message is un-ordered */
245 #define SCTP_ADDR_OVER 0x0800 /* Override the primary-address */
246 #define SCTP_SENDALL 0x1000 /* Send this on all associations */
247 #define SCTP_EOR 0x2000 /* end of message signal */
248 #define SCTP_SACK_IMMEDIATELY 0x4000 /* Set I-Bit */
250 #define INVALID_SINFO_FLAG(x) (((x) & 0xfffffff0 \
251 & ~(SCTP_EOF | SCTP_ABORT | SCTP_UNORDERED |\
252 SCTP_ADDR_OVER | SCTP_SENDALL | SCTP_EOR |\
253 SCTP_SACK_IMMEDIATELY)) != 0)
254 /* for the endpoint */
256 /* The lower four bits is an enumeration of PR-SCTP policies */
257 #define SCTP_PR_SCTP_NONE 0x0000 /* Reliable transfer */
258 #define SCTP_PR_SCTP_TTL 0x0001 /* Time based PR-SCTP */
259 #define SCTP_PR_SCTP_PRIO 0x0002 /* Buffer based PR-SCTP */
260 #define SCTP_PR_SCTP_BUF SCTP_PR_SCTP_PRIO /* For backwards compatibility */
261 #define SCTP_PR_SCTP_RTX 0x0003 /* Number of retransmissions based
263 #define SCTP_PR_SCTP_MAX SCTP_PR_SCTP_RTX
264 #define SCTP_PR_SCTP_ALL 0x000f /* Used for aggregated stats */
266 #define PR_SCTP_POLICY(x) ((x) & 0x0f)
267 #define PR_SCTP_ENABLED(x) ((PR_SCTP_POLICY(x) != SCTP_PR_SCTP_NONE) && \
268 (PR_SCTP_POLICY(x) != SCTP_PR_SCTP_ALL))
269 #define PR_SCTP_TTL_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_TTL)
270 #define PR_SCTP_BUF_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_BUF)
271 #define PR_SCTP_RTX_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_RTX)
272 #define PR_SCTP_INVALID_POLICY(x) (PR_SCTP_POLICY(x) > SCTP_PR_SCTP_MAX)
273 #define PR_SCTP_VALID_POLICY(x) (PR_SCTP_POLICY(x) <= SCTP_PR_SCTP_MAX)
276 struct sctp_pcbinfo {
279 uint32_t laddr_count;
280 uint32_t raddr_count;
282 uint32_t readq_count;
283 uint32_t free_chunks;
284 uint32_t stream_oque;
287 struct sctp_sockstat {
288 sctp_assoc_t ss_assoc_id;
289 uint32_t ss_total_sndbuf;
290 uint32_t ss_total_recv_buf;
294 * notification event structures
298 * association change event
300 struct sctp_assoc_change {
306 uint16_t sac_outbound_streams;
307 uint16_t sac_inbound_streams;
308 sctp_assoc_t sac_assoc_id;
312 /* sac_state values */
313 #define SCTP_COMM_UP 0x0001
314 #define SCTP_COMM_LOST 0x0002
315 #define SCTP_RESTART 0x0003
316 #define SCTP_SHUTDOWN_COMP 0x0004
317 #define SCTP_CANT_STR_ASSOC 0x0005
319 /* sac_info values */
320 #define SCTP_ASSOC_SUPPORTS_PR 0x01
321 #define SCTP_ASSOC_SUPPORTS_AUTH 0x02
322 #define SCTP_ASSOC_SUPPORTS_ASCONF 0x03
323 #define SCTP_ASSOC_SUPPORTS_MULTIBUF 0x04
324 #define SCTP_ASSOC_SUPPORTS_RE_CONFIG 0x05
325 #define SCTP_ASSOC_SUPPORTS_INTERLEAVING 0x06
326 #define SCTP_ASSOC_SUPPORTS_MAX 0x06
330 struct sctp_paddr_change {
334 struct sockaddr_storage spc_aaddr;
337 sctp_assoc_t spc_assoc_id;
340 /* paddr state values */
341 #define SCTP_ADDR_AVAILABLE 0x0001
342 #define SCTP_ADDR_UNREACHABLE 0x0002
343 #define SCTP_ADDR_REMOVED 0x0003
344 #define SCTP_ADDR_ADDED 0x0004
345 #define SCTP_ADDR_MADE_PRIM 0x0005
346 #define SCTP_ADDR_CONFIRMED 0x0006
348 #define SCTP_ACTIVE 0x0001 /* SCTP_ADDR_REACHABLE */
349 #define SCTP_INACTIVE 0x0002 /* neither SCTP_ADDR_REACHABLE nor
350 * SCTP_ADDR_UNCONFIRMED */
351 #define SCTP_UNCONFIRMED 0x0200 /* SCTP_ADDR_UNCONFIRMED */
353 /* remote error events */
354 struct sctp_remote_error {
359 sctp_assoc_t sre_assoc_id;
363 /* data send failure event (deprecated) */
364 struct sctp_send_failed {
369 struct sctp_sndrcvinfo ssf_info;
370 sctp_assoc_t ssf_assoc_id;
374 /* data send failure event (not deprecated) */
375 struct sctp_send_failed_event {
378 uint32_t ssfe_length;
380 struct sctp_sndinfo ssfe_info;
381 sctp_assoc_t ssfe_assoc_id;
385 /* flag that indicates state of data */
386 #define SCTP_DATA_UNSENT 0x0001 /* inqueue never on wire */
387 #define SCTP_DATA_SENT 0x0002 /* on wire at failure */
390 struct sctp_shutdown_event {
394 sctp_assoc_t sse_assoc_id;
397 /* Adaptation layer indication stuff */
398 struct sctp_adaptation_event {
402 uint32_t sai_adaptation_ind;
403 sctp_assoc_t sai_assoc_id;
406 struct sctp_setadaptation {
407 uint32_t ssb_adaptation_ind;
410 /* compatible old spelling */
411 struct sctp_adaption_event {
415 uint32_t sai_adaption_ind;
416 sctp_assoc_t sai_assoc_id;
419 struct sctp_setadaption {
420 uint32_t ssb_adaption_ind;
424 * Partial Delivery API event
426 struct sctp_pdapi_event {
428 uint16_t pdapi_flags;
429 uint32_t pdapi_length;
430 uint32_t pdapi_indication;
431 uint16_t pdapi_stream;
433 sctp_assoc_t pdapi_assoc_id;
436 /* indication values */
437 #define SCTP_PARTIAL_DELIVERY_ABORTED 0x0001
440 * authentication key event
442 struct sctp_authkey_event {
445 uint32_t auth_length;
446 uint16_t auth_keynumber;
447 uint16_t auth_altkeynumber;
448 uint32_t auth_indication;
449 sctp_assoc_t auth_assoc_id;
452 /* indication values */
453 #define SCTP_AUTH_NEW_KEY 0x0001
454 #define SCTP_AUTH_NEWKEY SCTP_AUTH_NEW_KEY
455 #define SCTP_AUTH_NO_AUTH 0x0002
456 #define SCTP_AUTH_FREE_KEY 0x0003
458 struct sctp_sender_dry_event {
459 uint16_t sender_dry_type;
460 uint16_t sender_dry_flags;
461 uint32_t sender_dry_length;
462 sctp_assoc_t sender_dry_assoc_id;
466 * Stream reset event - subscribe to SCTP_STREAM_RESET_EVENT
468 struct sctp_stream_reset_event {
469 uint16_t strreset_type;
470 uint16_t strreset_flags;
471 uint32_t strreset_length;
472 sctp_assoc_t strreset_assoc_id;
473 uint16_t strreset_stream_list[];
476 /* flags in stream_reset_event (strreset_flags) */
477 #define SCTP_STREAM_RESET_INCOMING_SSN 0x0001
478 #define SCTP_STREAM_RESET_OUTGOING_SSN 0x0002
479 #define SCTP_STREAM_RESET_DENIED 0x0004
480 #define SCTP_STREAM_RESET_FAILED 0x0008
483 * Assoc reset event - subscribe to SCTP_ASSOC_RESET_EVENT
485 struct sctp_assoc_reset_event {
486 uint16_t assocreset_type;
487 uint16_t assocreset_flags;
488 uint32_t assocreset_length;
489 sctp_assoc_t assocreset_assoc_id;
490 uint32_t assocreset_local_tsn;
491 uint32_t assocreset_remote_tsn;
494 #define SCTP_ASSOC_RESET_DENIED 0x0004
495 #define SCTP_ASSOC_RESET_FAILED 0x0008
498 * Stream change event - subscribe to SCTP_STREAM_CHANGE_EVENT
500 struct sctp_stream_change_event {
501 uint16_t strchange_type;
502 uint16_t strchange_flags;
503 uint32_t strchange_length;
504 sctp_assoc_t strchange_assoc_id;
505 uint16_t strchange_instrms;
506 uint16_t strchange_outstrms;
509 #define SCTP_STREAM_CHANGE_DENIED 0x0004
510 #define SCTP_STREAM_CHANGE_FAILED 0x0008
512 /* SCTP notification event */
519 union sctp_notification {
520 struct sctp_tlv sn_header;
521 struct sctp_assoc_change sn_assoc_change;
522 struct sctp_paddr_change sn_paddr_change;
523 struct sctp_remote_error sn_remote_error;
524 struct sctp_send_failed sn_send_failed;
525 struct sctp_shutdown_event sn_shutdown_event;
526 struct sctp_adaptation_event sn_adaptation_event;
527 /* compatibility same as above */
528 struct sctp_adaption_event sn_adaption_event;
529 struct sctp_pdapi_event sn_pdapi_event;
530 struct sctp_authkey_event sn_auth_event;
531 struct sctp_sender_dry_event sn_sender_dry_event;
532 struct sctp_send_failed_event sn_send_failed_event;
533 struct sctp_stream_reset_event sn_strreset_event;
534 struct sctp_assoc_reset_event sn_assocreset_event;
535 struct sctp_stream_change_event sn_strchange_event;
538 /* notification types */
539 #define SCTP_ASSOC_CHANGE 0x0001
540 #define SCTP_PEER_ADDR_CHANGE 0x0002
541 #define SCTP_REMOTE_ERROR 0x0003
542 #define SCTP_SEND_FAILED 0x0004
543 #define SCTP_SHUTDOWN_EVENT 0x0005
544 #define SCTP_ADAPTATION_INDICATION 0x0006
546 #define SCTP_ADAPTION_INDICATION 0x0006
547 #define SCTP_PARTIAL_DELIVERY_EVENT 0x0007
548 #define SCTP_AUTHENTICATION_EVENT 0x0008
549 #define SCTP_STREAM_RESET_EVENT 0x0009
550 #define SCTP_SENDER_DRY_EVENT 0x000a
551 #define SCTP_NOTIFICATIONS_STOPPED_EVENT 0x000b /* we don't send this */
552 #define SCTP_ASSOC_RESET_EVENT 0x000c
553 #define SCTP_STREAM_CHANGE_EVENT 0x000d
554 #define SCTP_SEND_FAILED_EVENT 0x000e
556 * socket option structs
559 struct sctp_paddrparams {
560 struct sockaddr_storage spp_address;
561 sctp_assoc_t spp_assoc_id;
562 uint32_t spp_hbinterval;
563 uint32_t spp_pathmtu;
565 uint32_t spp_ipv6_flowlabel;
566 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;
586 uint16_t spt_pathcpthld;
589 struct sctp_paddrinfo {
590 struct sockaddr_storage spinfo_address;
591 sctp_assoc_t spinfo_assoc_id;
592 int32_t spinfo_state;
593 uint32_t spinfo_cwnd;
594 uint32_t spinfo_srtt;
599 struct sctp_rtoinfo {
600 sctp_assoc_t srto_assoc_id;
601 uint32_t srto_initial;
606 struct sctp_assocparams {
607 sctp_assoc_t sasoc_assoc_id;
608 uint32_t sasoc_peer_rwnd;
609 uint32_t sasoc_local_rwnd;
610 uint32_t sasoc_cookie_life;
611 uint16_t sasoc_asocmaxrxt;
612 uint16_t sasoc_number_peer_destinations;
615 struct sctp_setprim {
616 struct sockaddr_storage ssp_addr;
617 sctp_assoc_t ssp_assoc_id;
618 uint8_t ssp_padding[4];
621 struct sctp_setpeerprim {
622 struct sockaddr_storage sspp_addr;
623 sctp_assoc_t sspp_assoc_id;
624 uint8_t sspp_padding[4];
627 union sctp_sockstore {
628 struct sockaddr_in sin;
629 struct sockaddr_in6 sin6;
633 struct sctp_getaddresses {
634 sctp_assoc_t sget_assoc_id;
635 union sctp_sockstore addr[];
639 sctp_assoc_t sstat_assoc_id;
642 uint16_t sstat_unackdata;
643 uint16_t sstat_penddata;
644 uint16_t sstat_instrms;
645 uint16_t sstat_outstrms;
646 uint32_t sstat_fragmentation_point;
647 struct sctp_paddrinfo sstat_primary;
651 * AUTHENTICATION support
653 /* SCTP_AUTH_CHUNK */
654 struct sctp_authchunk {
659 struct sctp_authkey {
660 sctp_assoc_t sca_assoc_id;
661 uint16_t sca_keynumber;
662 uint16_t sca_keylength;
666 /* SCTP_HMAC_IDENT */
667 struct sctp_hmacalgo {
668 uint32_t shmac_number_of_idents;
669 uint16_t shmac_idents[];
673 #define SCTP_AUTH_HMAC_ID_RSVD 0x0000
674 #define SCTP_AUTH_HMAC_ID_SHA1 0x0001 /* default, mandatory */
675 #define SCTP_AUTH_HMAC_ID_SHA256 0x0003
677 /* SCTP_AUTH_ACTIVE_KEY / SCTP_AUTH_DELETE_KEY */
678 struct sctp_authkeyid {
679 sctp_assoc_t scact_assoc_id;
680 uint16_t scact_keynumber;
683 /* SCTP_PEER_AUTH_CHUNKS / SCTP_LOCAL_AUTH_CHUNKS */
684 struct sctp_authchunks {
685 sctp_assoc_t gauth_assoc_id;
686 uint32_t gauth_number_of_chunks;
687 uint8_t gauth_chunks[];
690 struct sctp_assoc_value {
691 sctp_assoc_t assoc_id;
692 uint32_t assoc_value;
695 struct sctp_cc_option {
697 struct sctp_assoc_value aid_value;
700 struct sctp_stream_value {
701 sctp_assoc_t assoc_id;
703 uint16_t stream_value;
706 struct sctp_assoc_ids {
707 uint32_t gaids_number_of_ids;
708 sctp_assoc_t gaids_assoc_id[];
711 struct sctp_sack_info {
712 sctp_assoc_t sack_assoc_id;
717 struct sctp_timeouts {
718 sctp_assoc_t stimo_assoc_id;
722 uint32_t stimo_shutdown;
723 uint32_t stimo_heartbeat;
724 uint32_t stimo_cookie;
725 uint32_t stimo_shutdownack;
728 struct sctp_udpencaps {
729 struct sockaddr_storage sue_address;
730 sctp_assoc_t sue_assoc_id;
734 struct sctp_prstatus {
735 sctp_assoc_t sprstat_assoc_id;
736 uint16_t sprstat_sid;
737 uint16_t sprstat_policy;
738 uint64_t sprstat_abandoned_unsent;
739 uint64_t sprstat_abandoned_sent;
742 struct sctp_cwnd_args {
743 struct sctp_nets *net; /* network to *//* FIXME: LP64 issue */
744 uint32_t cwnd_new_value; /* cwnd in k */
745 uint32_t pseudo_cumack;
746 uint16_t inflight; /* flightsize in k */
747 uint16_t cwnd_augment; /* increment to it */
748 uint8_t meets_pseudo_cumack;
749 uint8_t need_new_pseudo_cumack;
754 struct sctp_blk_args {
755 uint32_t onsb; /* in 1k bytes */
756 uint32_t sndlen; /* len of send being attempted */
757 uint32_t peer_rwnd; /* rwnd of peer */
758 uint16_t send_sent_qcnt; /* chnk cnt */
759 uint16_t stream_qcnt; /* chnk cnt */
760 uint16_t chunks_on_oque; /* chunks out */
761 uint16_t flight_size; /* flight size in k */
765 * Max we can reset in one setting, note this is dictated not by the define
766 * but the size of a mbuf cluster so don't change this define and think you
767 * can specify more. You must do multiple resets if you want to reset more
768 * than SCTP_MAX_EXPLICIT_STR_RESET.
770 #define SCTP_MAX_EXPLICT_STR_RESET 1000
772 struct sctp_reset_streams {
773 sctp_assoc_t srs_assoc_id;
775 uint16_t srs_number_streams; /* 0 == ALL */
776 uint16_t srs_stream_list[]; /* list if strrst_num_streams is not 0 */
779 struct sctp_add_streams {
780 sctp_assoc_t sas_assoc_id;
781 uint16_t sas_instrms;
782 uint16_t sas_outstrms;
785 struct sctp_get_nonce_values {
786 sctp_assoc_t gn_assoc_id;
787 uint32_t gn_peers_tag;
788 uint32_t gn_local_tag;
792 struct sctp_str_log {
793 void *stcb; /* FIXME: LP64 issue */
802 void *stcb; /* FIXME: LP64 issue */
809 uint32_t largest_tsn;
810 uint32_t largest_new_tsn;
820 struct sctp_rwnd_log {
827 struct sctp_mbcnt_log {
828 uint32_t total_queue_size;
829 uint32_t size_change;
830 uint32_t total_queue_mb_size;
831 uint32_t mbcnt_change;
834 struct sctp_sack_log {
842 struct sctp_lock_log {
843 void *sock; /* FIXME: LP64 issue */
844 void *inp; /* FIXME: LP64 issue */
849 uint8_t sockrcvbuf_lock;
850 uint8_t socksndbuf_lock;
855 struct sctp_rto_log {
856 void *net; /* FIXME: LP64 issue */
860 struct sctp_nagle_log {
861 void *stcb; /* FIXME: LP64 issue */
862 uint32_t total_flight;
863 uint32_t total_in_queue;
864 uint16_t count_in_queue;
865 uint16_t count_in_flight;
868 struct sctp_sbwake_log {
869 void *stcb; /* FIXME: LP64 issue */
874 uint8_t stream_qcnt; /* chnk cnt */
875 uint8_t chunks_on_oque; /* chunks out */
880 struct sctp_misc_info {
887 struct sctp_log_closing {
888 void *inp; /* FIXME: LP64 issue */
889 void *stcb; /* FIXME: LP64 issue */
895 struct sctp_mbuf_log {
896 struct mbuf *mp; /* FIXME: LP64 issue */
904 struct sctp_cwnd_log {
910 struct sctp_log_closing close;
911 struct sctp_blk_args blk;
912 struct sctp_cwnd_args cwnd;
913 struct sctp_str_log strlog;
914 struct sctp_fr_log fr;
915 struct sctp_fr_map map;
916 struct sctp_rwnd_log rwnd;
917 struct sctp_mbcnt_log mbcnt;
918 struct sctp_sack_log sack;
919 struct sctp_lock_log lock;
920 struct sctp_rto_log rto;
921 struct sctp_sb_log sb;
922 struct sctp_nagle_log nagle;
923 struct sctp_sbwake_log wake;
924 struct sctp_mbuf_log mb;
925 struct sctp_misc_info misc;
929 struct sctp_cwnd_log_req {
930 int32_t num_in_log; /* Number in log */
931 int32_t num_ret; /* Number returned */
932 int32_t start_at; /* start at this one */
933 int32_t end_at; /* end at this one */
934 struct sctp_cwnd_log log[];
937 struct sctp_timeval {
943 struct sctp_timeval sctps_discontinuitytime; /* sctpStats 18
945 /* MIB according to RFC 3873 */
946 uint32_t sctps_currestab; /* sctpStats 1 (Gauge32) */
947 uint32_t sctps_activeestab; /* sctpStats 2 (Counter32) */
948 uint32_t sctps_restartestab;
949 uint32_t sctps_collisionestab;
950 uint32_t sctps_passiveestab; /* sctpStats 3 (Counter32) */
951 uint32_t sctps_aborted; /* sctpStats 4 (Counter32) */
952 uint32_t sctps_shutdown; /* sctpStats 5 (Counter32) */
953 uint32_t sctps_outoftheblue; /* sctpStats 6 (Counter32) */
954 uint32_t sctps_checksumerrors; /* sctpStats 7 (Counter32) */
955 uint32_t sctps_outcontrolchunks; /* sctpStats 8 (Counter64) */
956 uint32_t sctps_outorderchunks; /* sctpStats 9 (Counter64) */
957 uint32_t sctps_outunorderchunks; /* sctpStats 10 (Counter64) */
958 uint32_t sctps_incontrolchunks; /* sctpStats 11 (Counter64) */
959 uint32_t sctps_inorderchunks; /* sctpStats 12 (Counter64) */
960 uint32_t sctps_inunorderchunks; /* sctpStats 13 (Counter64) */
961 uint32_t sctps_fragusrmsgs; /* sctpStats 14 (Counter64) */
962 uint32_t sctps_reasmusrmsgs; /* sctpStats 15 (Counter64) */
963 uint32_t sctps_outpackets; /* sctpStats 16 (Counter64) */
964 uint32_t sctps_inpackets; /* sctpStats 17 (Counter64) */
966 /* input statistics: */
967 uint32_t sctps_recvpackets; /* total input packets */
968 uint32_t sctps_recvdatagrams; /* total input datagrams */
969 uint32_t sctps_recvpktwithdata; /* total packets that had data */
970 uint32_t sctps_recvsacks; /* total input SACK chunks */
971 uint32_t sctps_recvdata; /* total input DATA chunks */
972 uint32_t sctps_recvdupdata; /* total input duplicate DATA chunks */
973 uint32_t sctps_recvheartbeat; /* total input HB chunks */
974 uint32_t sctps_recvheartbeatack; /* total input HB-ACK chunks */
975 uint32_t sctps_recvecne; /* total input ECNE chunks */
976 uint32_t sctps_recvauth; /* total input AUTH chunks */
977 uint32_t sctps_recvauthmissing; /* total input chunks missing AUTH */
978 uint32_t sctps_recvivalhmacid; /* total number of invalid HMAC ids
980 uint32_t sctps_recvivalkeyid; /* total number of invalid secret ids
982 uint32_t sctps_recvauthfailed; /* total number of auth failed */
983 uint32_t sctps_recvexpress; /* total fast path receives all one
985 uint32_t sctps_recvexpressm; /* total fast path multi-part data */
986 uint32_t sctps_recv_spare; /* formerly sctps_recvnocrc */
987 uint32_t sctps_recvswcrc;
988 uint32_t sctps_recvhwcrc;
990 /* output statistics: */
991 uint32_t sctps_sendpackets; /* total output packets */
992 uint32_t sctps_sendsacks; /* total output SACKs */
993 uint32_t sctps_senddata; /* total output DATA chunks */
994 uint32_t sctps_sendretransdata; /* total output retransmitted DATA
996 uint32_t sctps_sendfastretrans; /* total output fast retransmitted
998 uint32_t sctps_sendmultfastretrans; /* total FR's that happened
999 * more than once to same
1000 * chunk (u-del multi-fr
1002 uint32_t sctps_sendheartbeat; /* total output HB chunks */
1003 uint32_t sctps_sendecne; /* total output ECNE chunks */
1004 uint32_t sctps_sendauth; /* total output AUTH chunks FIXME */
1005 uint32_t sctps_senderrors; /* ip_output error counter */
1006 uint32_t sctps_send_spare; /* formerly sctps_sendnocrc */
1007 uint32_t sctps_sendswcrc;
1008 uint32_t sctps_sendhwcrc;
1009 /* PCKDROPREP statistics: */
1010 uint32_t sctps_pdrpfmbox; /* Packet drop from middle box */
1011 uint32_t sctps_pdrpfehos; /* P-drop from end host */
1012 uint32_t sctps_pdrpmbda; /* P-drops with data */
1013 uint32_t sctps_pdrpmbct; /* P-drops, non-data, non-endhost */
1014 uint32_t sctps_pdrpbwrpt; /* P-drop, non-endhost, bandwidth rep
1016 uint32_t sctps_pdrpcrupt; /* P-drop, not enough for chunk header */
1017 uint32_t sctps_pdrpnedat; /* P-drop, not enough data to confirm */
1018 uint32_t sctps_pdrppdbrk; /* P-drop, where process_chunk_drop
1020 uint32_t sctps_pdrptsnnf; /* P-drop, could not find TSN */
1021 uint32_t sctps_pdrpdnfnd; /* P-drop, attempt reverse TSN lookup */
1022 uint32_t sctps_pdrpdiwnp; /* P-drop, e-host confirms zero-rwnd */
1023 uint32_t sctps_pdrpdizrw; /* P-drop, midbox confirms no space */
1024 uint32_t sctps_pdrpbadd; /* P-drop, data did not match TSN */
1025 uint32_t sctps_pdrpmark; /* P-drop, TSN's marked for Fast
1028 uint32_t sctps_timoiterator; /* Number of iterator timers that
1030 uint32_t sctps_timodata; /* Number of T3 data time outs */
1031 uint32_t sctps_timowindowprobe; /* Number of window probe (T3) timers
1033 uint32_t sctps_timoinit; /* Number of INIT timers that fired */
1034 uint32_t sctps_timosack; /* Number of sack timers that fired */
1035 uint32_t sctps_timoshutdown; /* Number of shutdown timers that
1037 uint32_t sctps_timoheartbeat; /* Number of heartbeat timers that
1039 uint32_t sctps_timocookie; /* Number of times a cookie timeout
1041 uint32_t sctps_timosecret; /* Number of times an endpoint changed
1042 * its cookie secret */
1043 uint32_t sctps_timopathmtu; /* Number of PMTU timers that fired */
1044 uint32_t sctps_timoshutdownack; /* Number of shutdown ack timers that
1046 uint32_t sctps_timoshutdownguard; /* Number of shutdown guard
1047 * timers that fired */
1048 uint32_t sctps_timostrmrst; /* Number of stream reset timers that
1050 uint32_t sctps_timoearlyfr; /* Number of early FR timers that
1052 uint32_t sctps_timoasconf; /* Number of times an asconf timer
1054 uint32_t sctps_timodelprim; /* Number of times a prim_deleted
1056 uint32_t sctps_timoautoclose; /* Number of times auto close timer
1058 uint32_t sctps_timoassockill; /* Number of asoc free timers expired */
1059 uint32_t sctps_timoinpkill; /* Number of inp free timers expired */
1060 /* former early FR counters */
1061 uint32_t sctps_spare[11];
1063 uint32_t sctps_hdrops; /* packet shorter than header */
1064 uint32_t sctps_badsum; /* checksum error */
1065 uint32_t sctps_noport; /* no endpoint for port */
1066 uint32_t sctps_badvtag; /* bad v-tag */
1067 uint32_t sctps_badsid; /* bad SID */
1068 uint32_t sctps_nomem; /* no memory */
1069 uint32_t sctps_fastretransinrtt; /* number of multiple FR in a
1071 uint32_t sctps_markedretrans;
1072 uint32_t sctps_naglesent; /* nagle allowed sending */
1073 uint32_t sctps_naglequeued; /* nagle doesn't allow sending */
1074 uint32_t sctps_maxburstqueued; /* max burst doesn't allow sending */
1075 uint32_t sctps_ifnomemqueued; /* look ahead tells us no memory in
1076 * interface ring buffer OR we had a
1077 * send error and are queuing one
1079 uint32_t sctps_windowprobed; /* total number of window probes sent */
1080 uint32_t sctps_lowlevelerr; /* total times an output error causes
1081 * us to clamp down on next user send. */
1082 uint32_t sctps_lowlevelerrusr; /* total times sctp_senderrors were
1083 * caused from a user send from a user
1084 * invoked send not a sack response */
1085 uint32_t sctps_datadropchklmt; /* Number of in data drops due to
1086 * chunk limit reached */
1087 uint32_t sctps_datadroprwnd; /* Number of in data drops due to rwnd
1089 uint32_t sctps_ecnereducedcwnd; /* Number of times a ECN reduced the
1091 uint32_t sctps_vtagexpress; /* Used express lookup via vtag */
1092 uint32_t sctps_vtagbogus; /* Collision in express lookup. */
1093 uint32_t sctps_primary_randry; /* Number of times the sender ran dry
1094 * of user data on primary */
1095 uint32_t sctps_cmt_randry; /* Same for above */
1096 uint32_t sctps_slowpath_sack; /* Sacks the slow way */
1097 uint32_t sctps_wu_sacks_sent; /* Window Update only sacks sent */
1098 uint32_t sctps_sends_with_flags; /* number of sends with
1099 * sinfo_flags !=0 */
1100 uint32_t sctps_sends_with_unord; /* number of unordered sends */
1101 uint32_t sctps_sends_with_eof; /* number of sends with EOF flag set */
1102 uint32_t sctps_sends_with_abort; /* number of sends with ABORT
1104 uint32_t sctps_protocol_drain_calls; /* number of times protocol
1106 uint32_t sctps_protocol_drains_done; /* number of times we did a
1108 uint32_t sctps_read_peeks; /* Number of times recv was called
1110 uint32_t sctps_cached_chk; /* Number of cached chunks used */
1111 uint32_t sctps_cached_strmoq; /* Number of cached stream oq's used */
1112 uint32_t sctps_left_abandon; /* Number of unread messages abandoned
1114 uint32_t sctps_send_burst_avoid; /* Unused */
1115 uint32_t sctps_send_cwnd_avoid; /* Send cwnd full avoidance, already
1116 * max burst inflight to net */
1117 uint32_t sctps_fwdtsn_map_over; /* number of map array over-runs via
1119 uint32_t sctps_queue_upd_ecne; /* Number of times we queued or
1120 * updated an ECN chunk on send queue */
1121 uint32_t sctps_reserved[31]; /* Future ABI compat - remove int's
1122 * from here when adding new */
1125 #define SCTP_STAT_INCR(_x) SCTP_STAT_INCR_BY(_x,1)
1126 #define SCTP_STAT_DECR(_x) SCTP_STAT_DECR_BY(_x,1)
1127 #if defined(SMP) && defined(SCTP_USE_PERCPU_STAT)
1128 #define SCTP_STAT_INCR_BY(_x,_d) (SCTP_BASE_STATS[PCPU_GET(cpuid)]._x += _d)
1129 #define SCTP_STAT_DECR_BY(_x,_d) (SCTP_BASE_STATS[PCPU_GET(cpuid)]._x -= _d)
1131 #define SCTP_STAT_INCR_BY(_x,_d) atomic_add_int(&SCTP_BASE_STAT(_x), _d)
1132 #define SCTP_STAT_DECR_BY(_x,_d) atomic_subtract_int(&SCTP_BASE_STAT(_x), _d)
1134 /* The following macros are for handling MIB values, */
1135 #define SCTP_STAT_INCR_COUNTER32(_x) SCTP_STAT_INCR(_x)
1136 #define SCTP_STAT_INCR_COUNTER64(_x) SCTP_STAT_INCR(_x)
1137 #define SCTP_STAT_INCR_GAUGE32(_x) SCTP_STAT_INCR(_x)
1138 #define SCTP_STAT_DECR_COUNTER32(_x) SCTP_STAT_DECR(_x)
1139 #define SCTP_STAT_DECR_COUNTER64(_x) SCTP_STAT_DECR(_x)
1140 #define SCTP_STAT_DECR_GAUGE32(_x) SCTP_STAT_DECR(_x)
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 /***********************************/
1157 struct xsctp_inpcb {
1161 uint32_t total_sends;
1162 uint32_t total_recvs;
1163 uint32_t total_nospaces;
1164 uint32_t fragmentation_point;
1165 uint16_t local_port;
1167 uint16_t maxqlen_old;
1172 uint32_t extra_padding[26]; /* future */
1176 union sctp_sockstore primary_addr; /* sctpAssocEntry 5/6 */
1178 uint32_t heartbeat_interval; /* sctpAssocEntry 7 */
1179 uint32_t state; /* sctpAssocEntry 8 */
1180 uint32_t in_streams; /* sctpAssocEntry 9 */
1181 uint32_t out_streams; /* sctpAssocEntry 10 */
1182 uint32_t max_nr_retrans; /* sctpAssocEntry 11 */
1183 uint32_t primary_process; /* sctpAssocEntry 12 */
1184 uint32_t T1_expireries; /* sctpAssocEntry 13 */
1185 uint32_t T2_expireries; /* sctpAssocEntry 14 */
1186 uint32_t retransmitted_tsns; /* sctpAssocEntry 15 */
1187 uint32_t total_sends;
1188 uint32_t total_recvs;
1190 uint32_t remote_tag;
1191 uint32_t initial_tsn;
1192 uint32_t highest_tsn;
1193 uint32_t cumulative_tsn;
1194 uint32_t cumulative_tsn_ack;
1197 uint16_t local_port; /* sctpAssocEntry 3 */
1198 uint16_t remote_port; /* sctpAssocEntry 4 */
1199 struct sctp_timeval start_time; /* sctpAssocEntry 16 */
1200 struct sctp_timeval discontinuity_time; /* sctpAssocEntry 17 */
1201 uint32_t peers_rwnd;
1202 sctp_assoc_t assoc_id; /* sctpAssocEntry 1 */
1203 uint32_t extra_padding[32]; /* future */
1206 struct xsctp_laddr {
1207 union sctp_sockstore address; /* sctpAssocLocalAddrEntry 1/2 */
1209 struct sctp_timeval start_time; /* sctpAssocLocalAddrEntry 3 */
1210 uint32_t extra_padding[32]; /* future */
1213 struct xsctp_raddr {
1214 union sctp_sockstore address; /* sctpAssocLocalRemEntry 1/2 */
1216 uint32_t rto; /* sctpAssocLocalRemEntry 5 */
1217 uint32_t max_path_rtx; /* sctpAssocLocalRemEntry 6 */
1218 uint32_t rtx; /* sctpAssocLocalRemEntry 7 */
1219 uint32_t error_counter; /* */
1220 uint32_t cwnd; /* */
1221 uint32_t flight_size; /* */
1223 uint8_t active; /* sctpAssocLocalRemEntry 3 */
1224 uint8_t confirmed; /* */
1225 uint8_t heartbeat_enabled; /* sctpAssocLocalRemEntry 4 */
1226 uint8_t potentially_failed;
1227 struct sctp_timeval start_time; /* sctpAssocLocalRemEntry 8 */
1229 uint32_t heartbeat_interval;
1231 uint16_t encaps_port;
1233 uint32_t extra_padding[29]; /* future */
1236 #define SCTP_MAX_LOGGING_SIZE 30000
1237 #define SCTP_TRACE_PARAMS 6 /* This number MUST be even */
1239 struct sctp_log_entry {
1243 uint32_t params[SCTP_TRACE_PARAMS];
1247 struct sctp_log_entry entry[SCTP_MAX_LOGGING_SIZE];
1253 * Kernel defined for sctp_send
1255 #if defined(_KERNEL) || defined(__Userspace__)
1257 sctp_lower_sosend(struct socket *so,
1258 struct sockaddr *addr,
1261 struct mbuf *control,
1263 struct sctp_sndrcvinfo *srcv
1268 sctp_sorecvmsg(struct socket *so,
1271 struct sockaddr *from,
1274 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__ */