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 __FBSDID("$FreeBSD$");
38 #ifndef _NETINET_SCTP_UIO_H_
39 #define _NETINET_SCTP_UIO_H_
44 #include <sys/types.h>
45 #include <sys/socket.h>
46 #include <netinet/in.h>
48 typedef uint32_t sctp_assoc_t;
50 #define SCTP_FUTURE_ASSOC 0
51 #define SCTP_CURRENT_ASSOC 1
52 #define SCTP_ALL_ASSOC 2
55 sctp_assoc_t se_assoc_id;
60 /* Compatibility to previous define's */
61 #define sctp_stream_reset_events sctp_stream_reset_event
63 /* On/Off setup for subscription to events */
64 struct sctp_event_subscribe {
65 uint8_t sctp_data_io_event;
66 uint8_t sctp_association_event;
67 uint8_t sctp_address_event;
68 uint8_t sctp_send_failure_event;
69 uint8_t sctp_peer_error_event;
70 uint8_t sctp_shutdown_event;
71 uint8_t sctp_partial_delivery_event;
72 uint8_t sctp_adaptation_layer_event;
73 uint8_t sctp_authentication_event;
74 uint8_t sctp_sender_dry_event;
75 uint8_t sctp_stream_reset_event;
78 /* ancillary data types */
79 #define SCTP_INIT 0x0001
80 #define SCTP_SNDRCV 0x0002
81 #define SCTP_EXTRCV 0x0003
82 #define SCTP_SNDINFO 0x0004
83 #define SCTP_RCVINFO 0x0005
84 #define SCTP_NXTINFO 0x0006
85 #define SCTP_PRINFO 0x0007
86 #define SCTP_AUTHINFO 0x0008
87 #define SCTP_DSTADDRV4 0x0009
88 #define SCTP_DSTADDRV6 0x000a
91 * ancillary data structures
94 uint16_t sinit_num_ostreams;
95 uint16_t sinit_max_instreams;
96 uint16_t sinit_max_attempts;
97 uint16_t sinit_max_init_timeo;
100 /* We add 96 bytes to the size of sctp_sndrcvinfo.
101 * This makes the current structure 128 bytes long
102 * which is nicely 64 bit aligned but also has room
103 * for us to add more and keep ABI compatibility.
104 * For example, already we have the sctp_extrcvinfo
105 * when enabled which is 48 bytes.
109 * The assoc up needs a verfid
110 * 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; /* should have been sinfo_pr_value */
139 uint32_t sinfo_cumtsn;
140 sctp_assoc_t sinfo_assoc_id;
141 uint16_t serinfo_next_flags;
142 uint16_t serinfo_next_stream;
143 uint32_t serinfo_next_aid;
144 uint32_t serinfo_next_length;
145 uint32_t serinfo_next_ppid;
146 uint16_t sinfo_keynumber;
147 uint16_t sinfo_keynumber_valid;
148 uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD_SHORT];
150 #define sinfo_pr_value sinfo_timetolive
151 #define sreinfo_next_flags serinfo_next_flags
152 #define sreinfo_next_stream serinfo_next_stream
153 #define sreinfo_next_aid serinfo_next_aid
154 #define sreinfo_next_length serinfo_next_length
155 #define sreinfo_next_ppid serinfo_next_ppid
157 struct sctp_sndinfo {
161 uint32_t snd_context;
162 sctp_assoc_t snd_assoc_id;
170 struct sctp_default_prinfo {
173 sctp_assoc_t pr_assoc_id;
176 struct sctp_authinfo {
177 uint16_t auth_keynumber;
180 struct sctp_rcvinfo {
187 uint32_t rcv_context;
188 sctp_assoc_t rcv_assoc_id;
191 struct sctp_nxtinfo {
196 sctp_assoc_t nxt_assoc_id;
199 #define SCTP_NO_NEXT_MSG 0x0000
200 #define SCTP_NEXT_MSG_AVAIL 0x0001
201 #define SCTP_NEXT_MSG_ISCOMPLETE 0x0002
202 #define SCTP_NEXT_MSG_IS_UNORDERED 0x0004
203 #define SCTP_NEXT_MSG_IS_NOTIFICATION 0x0008
205 struct sctp_recvv_rn {
206 struct sctp_rcvinfo recvv_rcvinfo;
207 struct sctp_nxtinfo recvv_nxtinfo;
210 #define SCTP_RECVV_NOINFO 0
211 #define SCTP_RECVV_RCVINFO 1
212 #define SCTP_RECVV_NXTINFO 2
213 #define SCTP_RECVV_RN 3
215 #define SCTP_SENDV_NOINFO 0
216 #define SCTP_SENDV_SNDINFO 1
217 #define SCTP_SENDV_PRINFO 2
218 #define SCTP_SENDV_AUTHINFO 3
219 #define SCTP_SENDV_SPA 4
221 struct sctp_sendv_spa {
222 uint32_t sendv_flags;
223 struct sctp_sndinfo sendv_sndinfo;
224 struct sctp_prinfo sendv_prinfo;
225 struct sctp_authinfo sendv_authinfo;
228 #define SCTP_SEND_SNDINFO_VALID 0x00000001
229 #define SCTP_SEND_PRINFO_VALID 0x00000002
230 #define SCTP_SEND_AUTHINFO_VALID 0x00000004
232 struct sctp_snd_all_completes {
233 uint16_t sall_stream;
236 uint32_t sall_context;
237 uint32_t sall_num_sent;
238 uint32_t sall_num_failed;
241 /* Flags that go into the sinfo->sinfo_flags field */
242 #define SCTP_NOTIFICATION 0x0010 /* next message is a notification */
243 #define SCTP_COMPLETE 0x0020 /* next message is complete */
244 #define SCTP_EOF 0x0100 /* Start shutdown procedures */
245 #define SCTP_ABORT 0x0200 /* Send an ABORT to peer */
246 #define SCTP_UNORDERED 0x0400 /* Message is un-ordered */
247 #define SCTP_ADDR_OVER 0x0800 /* Override the primary-address */
248 #define SCTP_SENDALL 0x1000 /* Send this on all associations */
249 #define SCTP_EOR 0x2000 /* end of message signal */
250 #define SCTP_SACK_IMMEDIATELY 0x4000 /* Set I-Bit */
252 #define INVALID_SINFO_FLAG(x) (((x) & 0xfffffff0 \
253 & ~(SCTP_EOF | SCTP_ABORT | SCTP_UNORDERED |\
254 SCTP_ADDR_OVER | SCTP_SENDALL | SCTP_EOR |\
255 SCTP_SACK_IMMEDIATELY)) != 0)
256 /* for the endpoint */
258 /* The lower four bits is an enumeration of PR-SCTP policies */
259 #define SCTP_PR_SCTP_NONE 0x0000 /* Reliable transfer */
260 #define SCTP_PR_SCTP_TTL 0x0001 /* Time based PR-SCTP */
261 #define SCTP_PR_SCTP_PRIO 0x0002 /* Buffer based PR-SCTP */
262 #define SCTP_PR_SCTP_BUF SCTP_PR_SCTP_PRIO /* For backwards compatibility */
263 #define SCTP_PR_SCTP_RTX 0x0003 /* Number of retransmissions based
265 #define SCTP_PR_SCTP_MAX SCTP_PR_SCTP_RTX
266 #define SCTP_PR_SCTP_ALL 0x000f /* Used for aggregated stats */
268 #define PR_SCTP_POLICY(x) ((x) & 0x0f)
269 #define PR_SCTP_ENABLED(x) ((PR_SCTP_POLICY(x) != SCTP_PR_SCTP_NONE) && \
270 (PR_SCTP_POLICY(x) != SCTP_PR_SCTP_ALL))
271 #define PR_SCTP_TTL_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_TTL)
272 #define PR_SCTP_BUF_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_BUF)
273 #define PR_SCTP_RTX_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_RTX)
274 #define PR_SCTP_INVALID_POLICY(x) (PR_SCTP_POLICY(x) > SCTP_PR_SCTP_MAX)
275 #define PR_SCTP_VALID_POLICY(x) (PR_SCTP_POLICY(x) <= SCTP_PR_SCTP_MAX)
278 struct sctp_pcbinfo {
281 uint32_t laddr_count;
282 uint32_t raddr_count;
284 uint32_t readq_count;
285 uint32_t free_chunks;
286 uint32_t stream_oque;
289 struct sctp_sockstat {
290 sctp_assoc_t ss_assoc_id;
291 uint32_t ss_total_sndbuf;
292 uint32_t ss_total_recv_buf;
296 * notification event structures
300 * association change event
302 struct sctp_assoc_change {
308 uint16_t sac_outbound_streams;
309 uint16_t sac_inbound_streams;
310 sctp_assoc_t sac_assoc_id;
314 /* sac_state values */
315 #define SCTP_COMM_UP 0x0001
316 #define SCTP_COMM_LOST 0x0002
317 #define SCTP_RESTART 0x0003
318 #define SCTP_SHUTDOWN_COMP 0x0004
319 #define SCTP_CANT_STR_ASSOC 0x0005
321 /* sac_info values */
322 #define SCTP_ASSOC_SUPPORTS_PR 0x01
323 #define SCTP_ASSOC_SUPPORTS_AUTH 0x02
324 #define SCTP_ASSOC_SUPPORTS_ASCONF 0x03
325 #define SCTP_ASSOC_SUPPORTS_MULTIBUF 0x04
326 #define SCTP_ASSOC_SUPPORTS_RE_CONFIG 0x05
327 #define SCTP_ASSOC_SUPPORTS_INTERLEAVING 0x06
328 #define SCTP_ASSOC_SUPPORTS_MAX 0x06
332 struct sctp_paddr_change {
336 struct sockaddr_storage spc_aaddr;
339 sctp_assoc_t spc_assoc_id;
342 /* paddr state values */
343 #define SCTP_ADDR_AVAILABLE 0x0001
344 #define SCTP_ADDR_UNREACHABLE 0x0002
345 #define SCTP_ADDR_REMOVED 0x0003
346 #define SCTP_ADDR_ADDED 0x0004
347 #define SCTP_ADDR_MADE_PRIM 0x0005
348 #define SCTP_ADDR_CONFIRMED 0x0006
350 #define SCTP_ACTIVE 0x0001 /* SCTP_ADDR_REACHABLE */
351 #define SCTP_INACTIVE 0x0002 /* neither SCTP_ADDR_REACHABLE nor
352 * SCTP_ADDR_UNCONFIRMED */
353 #define SCTP_UNCONFIRMED 0x0200 /* SCTP_ADDR_UNCONFIRMED */
355 /* remote error events */
356 struct sctp_remote_error {
361 sctp_assoc_t sre_assoc_id;
365 /* data send failure event (deprecated) */
366 struct sctp_send_failed {
371 struct sctp_sndrcvinfo ssf_info;
372 sctp_assoc_t ssf_assoc_id;
376 /* data send failure event (not deprecated) */
377 struct sctp_send_failed_event {
380 uint32_t ssfe_length;
382 struct sctp_sndinfo ssfe_info;
383 sctp_assoc_t ssfe_assoc_id;
387 /* flag that indicates state of data */
388 #define SCTP_DATA_UNSENT 0x0001 /* inqueue never on wire */
389 #define SCTP_DATA_SENT 0x0002 /* on wire at failure */
392 struct sctp_shutdown_event {
396 sctp_assoc_t sse_assoc_id;
399 /* Adaptation layer indication stuff */
400 struct sctp_adaptation_event {
404 uint32_t sai_adaptation_ind;
405 sctp_assoc_t sai_assoc_id;
408 struct sctp_setadaptation {
409 uint32_t ssb_adaptation_ind;
412 /* compatible old spelling */
413 struct sctp_adaption_event {
417 uint32_t sai_adaption_ind;
418 sctp_assoc_t sai_assoc_id;
421 struct sctp_setadaption {
422 uint32_t ssb_adaption_ind;
426 * Partial Delivery API event
428 struct sctp_pdapi_event {
430 uint16_t pdapi_flags;
431 uint32_t pdapi_length;
432 uint32_t pdapi_indication;
433 uint16_t pdapi_stream;
435 sctp_assoc_t pdapi_assoc_id;
438 /* indication values */
439 #define SCTP_PARTIAL_DELIVERY_ABORTED 0x0001
442 * authentication key event
444 struct sctp_authkey_event {
447 uint32_t auth_length;
448 uint16_t auth_keynumber;
449 uint16_t auth_altkeynumber;
450 uint32_t auth_indication;
451 sctp_assoc_t auth_assoc_id;
454 /* indication values */
455 #define SCTP_AUTH_NEW_KEY 0x0001
456 #define SCTP_AUTH_NEWKEY SCTP_AUTH_NEW_KEY
457 #define SCTP_AUTH_NO_AUTH 0x0002
458 #define SCTP_AUTH_FREE_KEY 0x0003
460 struct sctp_sender_dry_event {
461 uint16_t sender_dry_type;
462 uint16_t sender_dry_flags;
463 uint32_t sender_dry_length;
464 sctp_assoc_t sender_dry_assoc_id;
468 * Stream reset event - subscribe to SCTP_STREAM_RESET_EVENT
470 struct sctp_stream_reset_event {
471 uint16_t strreset_type;
472 uint16_t strreset_flags;
473 uint32_t strreset_length;
474 sctp_assoc_t strreset_assoc_id;
475 uint16_t strreset_stream_list[];
478 /* flags in stream_reset_event (strreset_flags) */
479 #define SCTP_STREAM_RESET_INCOMING_SSN 0x0001
480 #define SCTP_STREAM_RESET_OUTGOING_SSN 0x0002
481 #define SCTP_STREAM_RESET_DENIED 0x0004
482 #define SCTP_STREAM_RESET_FAILED 0x0008
485 * Assoc reset event - subscribe to SCTP_ASSOC_RESET_EVENT
487 struct sctp_assoc_reset_event {
488 uint16_t assocreset_type;
489 uint16_t assocreset_flags;
490 uint32_t assocreset_length;
491 sctp_assoc_t assocreset_assoc_id;
492 uint32_t assocreset_local_tsn;
493 uint32_t assocreset_remote_tsn;
496 #define SCTP_ASSOC_RESET_DENIED 0x0004
497 #define SCTP_ASSOC_RESET_FAILED 0x0008
500 * Stream change event - subscribe to SCTP_STREAM_CHANGE_EVENT
502 struct sctp_stream_change_event {
503 uint16_t strchange_type;
504 uint16_t strchange_flags;
505 uint32_t strchange_length;
506 sctp_assoc_t strchange_assoc_id;
507 uint16_t strchange_instrms;
508 uint16_t strchange_outstrms;
511 #define SCTP_STREAM_CHANGE_DENIED 0x0004
512 #define SCTP_STREAM_CHANGE_FAILED 0x0008
514 /* SCTP notification event */
521 union sctp_notification {
522 struct sctp_tlv sn_header;
523 struct sctp_assoc_change sn_assoc_change;
524 struct sctp_paddr_change sn_paddr_change;
525 struct sctp_remote_error sn_remote_error;
526 struct sctp_send_failed sn_send_failed;
527 struct sctp_shutdown_event sn_shutdown_event;
528 struct sctp_adaptation_event sn_adaptation_event;
529 /* compatibility same as above */
530 struct sctp_adaption_event sn_adaption_event;
531 struct sctp_pdapi_event sn_pdapi_event;
532 struct sctp_authkey_event sn_auth_event;
533 struct sctp_sender_dry_event sn_sender_dry_event;
534 struct sctp_send_failed_event sn_send_failed_event;
535 struct sctp_stream_reset_event sn_strreset_event;
536 struct sctp_assoc_reset_event sn_assocreset_event;
537 struct sctp_stream_change_event sn_strchange_event;
540 /* notification types */
541 #define SCTP_ASSOC_CHANGE 0x0001
542 #define SCTP_PEER_ADDR_CHANGE 0x0002
543 #define SCTP_REMOTE_ERROR 0x0003
544 #define SCTP_SEND_FAILED 0x0004
545 #define SCTP_SHUTDOWN_EVENT 0x0005
546 #define SCTP_ADAPTATION_INDICATION 0x0006
548 #define SCTP_ADAPTION_INDICATION 0x0006
549 #define SCTP_PARTIAL_DELIVERY_EVENT 0x0007
550 #define SCTP_AUTHENTICATION_EVENT 0x0008
551 #define SCTP_STREAM_RESET_EVENT 0x0009
552 #define SCTP_SENDER_DRY_EVENT 0x000a
553 #define SCTP_NOTIFICATIONS_STOPPED_EVENT 0x000b /* we don't send this */
554 #define SCTP_ASSOC_RESET_EVENT 0x000c
555 #define SCTP_STREAM_CHANGE_EVENT 0x000d
556 #define SCTP_SEND_FAILED_EVENT 0x000e
558 * socket option structs
561 struct sctp_paddrparams {
562 struct sockaddr_storage spp_address;
563 sctp_assoc_t spp_assoc_id;
564 uint32_t spp_hbinterval;
565 uint32_t spp_pathmtu;
567 uint32_t spp_ipv6_flowlabel;
568 uint16_t spp_pathmaxrxt;
571 #define spp_ipv4_tos spp_dscp
573 #define SPP_HB_ENABLE 0x00000001
574 #define SPP_HB_DISABLE 0x00000002
575 #define SPP_HB_DEMAND 0x00000004
576 #define SPP_PMTUD_ENABLE 0x00000008
577 #define SPP_PMTUD_DISABLE 0x00000010
578 #define SPP_HB_TIME_IS_ZERO 0x00000080
579 #define SPP_IPV6_FLOWLABEL 0x00000100
580 #define SPP_DSCP 0x00000200
581 #define SPP_IPV4_TOS SPP_DSCP
583 struct sctp_paddrthlds {
584 struct sockaddr_storage spt_address;
585 sctp_assoc_t spt_assoc_id;
586 uint16_t spt_pathmaxrxt;
587 uint16_t spt_pathpfthld;
588 uint16_t spt_pathcpthld;
591 struct sctp_paddrinfo {
592 struct sockaddr_storage spinfo_address;
593 sctp_assoc_t spinfo_assoc_id;
594 int32_t spinfo_state;
595 uint32_t spinfo_cwnd;
596 uint32_t spinfo_srtt;
601 struct sctp_rtoinfo {
602 sctp_assoc_t srto_assoc_id;
603 uint32_t srto_initial;
608 struct sctp_assocparams {
609 sctp_assoc_t sasoc_assoc_id;
610 uint32_t sasoc_peer_rwnd;
611 uint32_t sasoc_local_rwnd;
612 uint32_t sasoc_cookie_life;
613 uint16_t sasoc_asocmaxrxt;
614 uint16_t sasoc_number_peer_destinations;
617 struct sctp_setprim {
618 struct sockaddr_storage ssp_addr;
619 sctp_assoc_t ssp_assoc_id;
620 uint8_t ssp_padding[4];
623 struct sctp_setpeerprim {
624 struct sockaddr_storage sspp_addr;
625 sctp_assoc_t sspp_assoc_id;
626 uint8_t sspp_padding[4];
629 union sctp_sockstore {
630 struct sockaddr_in sin;
631 struct sockaddr_in6 sin6;
635 struct sctp_getaddresses {
636 sctp_assoc_t sget_assoc_id;
637 union sctp_sockstore addr[];
641 sctp_assoc_t sstat_assoc_id;
644 uint16_t sstat_unackdata;
645 uint16_t sstat_penddata;
646 uint16_t sstat_instrms;
647 uint16_t sstat_outstrms;
648 uint32_t sstat_fragmentation_point;
649 struct sctp_paddrinfo sstat_primary;
653 * AUTHENTICATION support
655 /* SCTP_AUTH_CHUNK */
656 struct sctp_authchunk {
661 struct sctp_authkey {
662 sctp_assoc_t sca_assoc_id;
663 uint16_t sca_keynumber;
664 uint16_t sca_keylength;
668 /* SCTP_HMAC_IDENT */
669 struct sctp_hmacalgo {
670 uint32_t shmac_number_of_idents;
671 uint16_t shmac_idents[];
675 #define SCTP_AUTH_HMAC_ID_RSVD 0x0000
676 #define SCTP_AUTH_HMAC_ID_SHA1 0x0001 /* default, mandatory */
677 #define SCTP_AUTH_HMAC_ID_SHA256 0x0003
679 /* SCTP_AUTH_ACTIVE_KEY / SCTP_AUTH_DELETE_KEY */
680 struct sctp_authkeyid {
681 sctp_assoc_t scact_assoc_id;
682 uint16_t scact_keynumber;
685 /* SCTP_PEER_AUTH_CHUNKS / SCTP_LOCAL_AUTH_CHUNKS */
686 struct sctp_authchunks {
687 sctp_assoc_t gauth_assoc_id;
688 uint32_t gauth_number_of_chunks;
689 uint8_t gauth_chunks[];
692 struct sctp_assoc_value {
693 sctp_assoc_t assoc_id;
694 uint32_t assoc_value;
697 struct sctp_cc_option {
699 struct sctp_assoc_value aid_value;
702 struct sctp_stream_value {
703 sctp_assoc_t assoc_id;
705 uint16_t stream_value;
708 struct sctp_assoc_ids {
709 uint32_t gaids_number_of_ids;
710 sctp_assoc_t gaids_assoc_id[];
713 struct sctp_sack_info {
714 sctp_assoc_t sack_assoc_id;
719 struct sctp_timeouts {
720 sctp_assoc_t stimo_assoc_id;
724 uint32_t stimo_shutdown;
725 uint32_t stimo_heartbeat;
726 uint32_t stimo_cookie;
727 uint32_t stimo_shutdownack;
730 struct sctp_udpencaps {
731 struct sockaddr_storage sue_address;
732 sctp_assoc_t sue_assoc_id;
736 struct sctp_prstatus {
737 sctp_assoc_t sprstat_assoc_id;
738 uint16_t sprstat_sid;
739 uint16_t sprstat_policy;
740 uint64_t sprstat_abandoned_unsent;
741 uint64_t sprstat_abandoned_sent;
744 struct sctp_cwnd_args {
745 struct sctp_nets *net; /* network to *//* FIXME: LP64 issue */
746 uint32_t cwnd_new_value; /* cwnd in k */
747 uint32_t pseudo_cumack;
748 uint16_t inflight; /* flightsize in k */
749 uint16_t cwnd_augment; /* increment to it */
750 uint8_t meets_pseudo_cumack;
751 uint8_t need_new_pseudo_cumack;
756 struct sctp_blk_args {
757 uint32_t onsb; /* in 1k bytes */
758 uint32_t sndlen; /* len of send being attempted */
759 uint32_t peer_rwnd; /* rwnd of peer */
760 uint16_t send_sent_qcnt; /* chnk cnt */
761 uint16_t stream_qcnt; /* chnk cnt */
762 uint16_t chunks_on_oque; /* chunks out */
763 uint16_t flight_size; /* flight size in k */
767 * Max we can reset in one setting, note this is dictated not by the define
768 * but the size of a mbuf cluster so don't change this define and think you
769 * can specify more. You must do multiple resets if you want to reset more
770 * than SCTP_MAX_EXPLICIT_STR_RESET.
772 #define SCTP_MAX_EXPLICT_STR_RESET 1000
774 struct sctp_reset_streams {
775 sctp_assoc_t srs_assoc_id;
777 uint16_t srs_number_streams; /* 0 == ALL */
778 uint16_t srs_stream_list[]; /* list if strrst_num_streams is not 0 */
781 struct sctp_add_streams {
782 sctp_assoc_t sas_assoc_id;
783 uint16_t sas_instrms;
784 uint16_t sas_outstrms;
787 struct sctp_get_nonce_values {
788 sctp_assoc_t gn_assoc_id;
789 uint32_t gn_peers_tag;
790 uint32_t gn_local_tag;
794 struct sctp_str_log {
795 void *stcb; /* FIXME: LP64 issue */
804 void *stcb; /* FIXME: LP64 issue */
811 uint32_t largest_tsn;
812 uint32_t largest_new_tsn;
822 struct sctp_rwnd_log {
829 struct sctp_mbcnt_log {
830 uint32_t total_queue_size;
831 uint32_t size_change;
832 uint32_t total_queue_mb_size;
833 uint32_t mbcnt_change;
836 struct sctp_sack_log {
844 struct sctp_lock_log {
845 void *sock; /* FIXME: LP64 issue */
846 void *inp; /* FIXME: LP64 issue */
851 uint8_t sockrcvbuf_lock;
852 uint8_t socksndbuf_lock;
857 struct sctp_rto_log {
858 void *net; /* FIXME: LP64 issue */
862 struct sctp_nagle_log {
863 void *stcb; /* FIXME: LP64 issue */
864 uint32_t total_flight;
865 uint32_t total_in_queue;
866 uint16_t count_in_queue;
867 uint16_t count_in_flight;
870 struct sctp_sbwake_log {
871 void *stcb; /* FIXME: LP64 issue */
876 uint8_t stream_qcnt; /* chnk cnt */
877 uint8_t chunks_on_oque; /* chunks out */
882 struct sctp_misc_info {
889 struct sctp_log_closing {
890 void *inp; /* FIXME: LP64 issue */
891 void *stcb; /* FIXME: LP64 issue */
897 struct sctp_mbuf_log {
898 struct mbuf *mp; /* FIXME: LP64 issue */
906 struct sctp_cwnd_log {
912 struct sctp_log_closing close;
913 struct sctp_blk_args blk;
914 struct sctp_cwnd_args cwnd;
915 struct sctp_str_log strlog;
916 struct sctp_fr_log fr;
917 struct sctp_fr_map map;
918 struct sctp_rwnd_log rwnd;
919 struct sctp_mbcnt_log mbcnt;
920 struct sctp_sack_log sack;
921 struct sctp_lock_log lock;
922 struct sctp_rto_log rto;
923 struct sctp_sb_log sb;
924 struct sctp_nagle_log nagle;
925 struct sctp_sbwake_log wake;
926 struct sctp_mbuf_log mb;
927 struct sctp_misc_info misc;
931 struct sctp_cwnd_log_req {
932 int32_t num_in_log; /* Number in log */
933 int32_t num_ret; /* Number returned */
934 int32_t start_at; /* start at this one */
935 int32_t end_at; /* end at this one */
936 struct sctp_cwnd_log log[];
939 struct sctp_timeval {
945 struct sctp_timeval sctps_discontinuitytime; /* sctpStats 18
947 /* MIB according to RFC 3873 */
948 uint32_t sctps_currestab; /* sctpStats 1 (Gauge32) */
949 uint32_t sctps_activeestab; /* sctpStats 2 (Counter32) */
950 uint32_t sctps_restartestab;
951 uint32_t sctps_collisionestab;
952 uint32_t sctps_passiveestab; /* sctpStats 3 (Counter32) */
953 uint32_t sctps_aborted; /* sctpStats 4 (Counter32) */
954 uint32_t sctps_shutdown; /* sctpStats 5 (Counter32) */
955 uint32_t sctps_outoftheblue; /* sctpStats 6 (Counter32) */
956 uint32_t sctps_checksumerrors; /* sctpStats 7 (Counter32) */
957 uint32_t sctps_outcontrolchunks; /* sctpStats 8 (Counter64) */
958 uint32_t sctps_outorderchunks; /* sctpStats 9 (Counter64) */
959 uint32_t sctps_outunorderchunks; /* sctpStats 10 (Counter64) */
960 uint32_t sctps_incontrolchunks; /* sctpStats 11 (Counter64) */
961 uint32_t sctps_inorderchunks; /* sctpStats 12 (Counter64) */
962 uint32_t sctps_inunorderchunks; /* sctpStats 13 (Counter64) */
963 uint32_t sctps_fragusrmsgs; /* sctpStats 14 (Counter64) */
964 uint32_t sctps_reasmusrmsgs; /* sctpStats 15 (Counter64) */
965 uint32_t sctps_outpackets; /* sctpStats 16 (Counter64) */
966 uint32_t sctps_inpackets; /* sctpStats 17 (Counter64) */
968 /* input statistics: */
969 uint32_t sctps_recvpackets; /* total input packets */
970 uint32_t sctps_recvdatagrams; /* total input datagrams */
971 uint32_t sctps_recvpktwithdata; /* total packets that had data */
972 uint32_t sctps_recvsacks; /* total input SACK chunks */
973 uint32_t sctps_recvdata; /* total input DATA chunks */
974 uint32_t sctps_recvdupdata; /* total input duplicate DATA chunks */
975 uint32_t sctps_recvheartbeat; /* total input HB chunks */
976 uint32_t sctps_recvheartbeatack; /* total input HB-ACK chunks */
977 uint32_t sctps_recvecne; /* total input ECNE chunks */
978 uint32_t sctps_recvauth; /* total input AUTH chunks */
979 uint32_t sctps_recvauthmissing; /* total input chunks missing AUTH */
980 uint32_t sctps_recvivalhmacid; /* total number of invalid HMAC ids
982 uint32_t sctps_recvivalkeyid; /* total number of invalid secret ids
984 uint32_t sctps_recvauthfailed; /* total number of auth failed */
985 uint32_t sctps_recvexpress; /* total fast path receives all one
987 uint32_t sctps_recvexpressm; /* total fast path multi-part data */
988 uint32_t sctps_recv_spare; /* formerly sctps_recvnocrc */
989 uint32_t sctps_recvswcrc;
990 uint32_t sctps_recvhwcrc;
992 /* output statistics: */
993 uint32_t sctps_sendpackets; /* total output packets */
994 uint32_t sctps_sendsacks; /* total output SACKs */
995 uint32_t sctps_senddata; /* total output DATA chunks */
996 uint32_t sctps_sendretransdata; /* total output retransmitted DATA
998 uint32_t sctps_sendfastretrans; /* total output fast retransmitted
1000 uint32_t sctps_sendmultfastretrans; /* total FR's that happened
1001 * more than once to same
1002 * chunk (u-del multi-fr
1004 uint32_t sctps_sendheartbeat; /* total output HB chunks */
1005 uint32_t sctps_sendecne; /* total output ECNE chunks */
1006 uint32_t sctps_sendauth; /* total output AUTH chunks FIXME */
1007 uint32_t sctps_senderrors; /* ip_output error counter */
1008 uint32_t sctps_send_spare; /* formerly sctps_sendnocrc */
1009 uint32_t sctps_sendswcrc;
1010 uint32_t sctps_sendhwcrc;
1011 /* PCKDROPREP statistics: */
1012 uint32_t sctps_pdrpfmbox; /* Packet drop from middle box */
1013 uint32_t sctps_pdrpfehos; /* P-drop from end host */
1014 uint32_t sctps_pdrpmbda; /* P-drops with data */
1015 uint32_t sctps_pdrpmbct; /* P-drops, non-data, non-endhost */
1016 uint32_t sctps_pdrpbwrpt; /* P-drop, non-endhost, bandwidth rep
1018 uint32_t sctps_pdrpcrupt; /* P-drop, not enough for chunk header */
1019 uint32_t sctps_pdrpnedat; /* P-drop, not enough data to confirm */
1020 uint32_t sctps_pdrppdbrk; /* P-drop, where process_chunk_drop
1022 uint32_t sctps_pdrptsnnf; /* P-drop, could not find TSN */
1023 uint32_t sctps_pdrpdnfnd; /* P-drop, attempt reverse TSN lookup */
1024 uint32_t sctps_pdrpdiwnp; /* P-drop, e-host confirms zero-rwnd */
1025 uint32_t sctps_pdrpdizrw; /* P-drop, midbox confirms no space */
1026 uint32_t sctps_pdrpbadd; /* P-drop, data did not match TSN */
1027 uint32_t sctps_pdrpmark; /* P-drop, TSN's marked for Fast
1030 uint32_t sctps_timoiterator; /* Number of iterator timers that
1032 uint32_t sctps_timodata; /* Number of T3 data time outs */
1033 uint32_t sctps_timowindowprobe; /* Number of window probe (T3) timers
1035 uint32_t sctps_timoinit; /* Number of INIT timers that fired */
1036 uint32_t sctps_timosack; /* Number of sack timers that fired */
1037 uint32_t sctps_timoshutdown; /* Number of shutdown timers that
1039 uint32_t sctps_timoheartbeat; /* Number of heartbeat timers that
1041 uint32_t sctps_timocookie; /* Number of times a cookie timeout
1043 uint32_t sctps_timosecret; /* Number of times an endpoint changed
1044 * its cookie secret */
1045 uint32_t sctps_timopathmtu; /* Number of PMTU timers that fired */
1046 uint32_t sctps_timoshutdownack; /* Number of shutdown ack timers that
1048 uint32_t sctps_timoshutdownguard; /* Number of shutdown guard
1049 * timers that fired */
1050 uint32_t sctps_timostrmrst; /* Number of stream reset timers that
1052 uint32_t sctps_timoearlyfr; /* Number of early FR timers that
1054 uint32_t sctps_timoasconf; /* Number of times an asconf timer
1056 uint32_t sctps_timodelprim; /* Number of times a prim_deleted
1058 uint32_t sctps_timoautoclose; /* Number of times auto close timer
1060 uint32_t sctps_timoassockill; /* Number of asoc free timers expired */
1061 uint32_t sctps_timoinpkill; /* Number of inp free timers expired */
1062 /* former early FR counters */
1063 uint32_t sctps_spare[11];
1065 uint32_t sctps_hdrops; /* packet shorter than header */
1066 uint32_t sctps_badsum; /* checksum error */
1067 uint32_t sctps_noport; /* no endpoint for port */
1068 uint32_t sctps_badvtag; /* bad v-tag */
1069 uint32_t sctps_badsid; /* bad SID */
1070 uint32_t sctps_nomem; /* no memory */
1071 uint32_t sctps_fastretransinrtt; /* number of multiple FR in a
1073 uint32_t sctps_markedretrans;
1074 uint32_t sctps_naglesent; /* nagle allowed sending */
1075 uint32_t sctps_naglequeued; /* nagle doesn't allow sending */
1076 uint32_t sctps_maxburstqueued; /* max burst doesn't allow sending */
1077 uint32_t sctps_ifnomemqueued; /* look ahead tells us no memory in
1078 * interface ring buffer OR we had a
1079 * send error and are queuing one
1081 uint32_t sctps_windowprobed; /* total number of window probes sent */
1082 uint32_t sctps_lowlevelerr; /* total times an output error causes
1083 * us to clamp down on next user send. */
1084 uint32_t sctps_lowlevelerrusr; /* total times sctp_senderrors were
1085 * caused from a user send from a user
1086 * invoked send not a sack response */
1087 uint32_t sctps_datadropchklmt; /* Number of in data drops due to
1088 * chunk limit reached */
1089 uint32_t sctps_datadroprwnd; /* Number of in data drops due to rwnd
1091 uint32_t sctps_ecnereducedcwnd; /* Number of times a ECN reduced the
1093 uint32_t sctps_vtagexpress; /* Used express lookup via vtag */
1094 uint32_t sctps_vtagbogus; /* Collision in express lookup. */
1095 uint32_t sctps_primary_randry; /* Number of times the sender ran dry
1096 * of user data on primary */
1097 uint32_t sctps_cmt_randry; /* Same for above */
1098 uint32_t sctps_slowpath_sack; /* Sacks the slow way */
1099 uint32_t sctps_wu_sacks_sent; /* Window Update only sacks sent */
1100 uint32_t sctps_sends_with_flags; /* number of sends with
1101 * sinfo_flags !=0 */
1102 uint32_t sctps_sends_with_unord; /* number of unordered sends */
1103 uint32_t sctps_sends_with_eof; /* number of sends with EOF flag set */
1104 uint32_t sctps_sends_with_abort; /* number of sends with ABORT
1106 uint32_t sctps_protocol_drain_calls; /* number of times protocol
1108 uint32_t sctps_protocol_drains_done; /* number of times we did a
1110 uint32_t sctps_read_peeks; /* Number of times recv was called
1112 uint32_t sctps_cached_chk; /* Number of cached chunks used */
1113 uint32_t sctps_cached_strmoq; /* Number of cached stream oq's used */
1114 uint32_t sctps_left_abandon; /* Number of unread messages abandoned
1116 uint32_t sctps_send_burst_avoid; /* Unused */
1117 uint32_t sctps_send_cwnd_avoid; /* Send cwnd full avoidance, already
1118 * max burst inflight to net */
1119 uint32_t sctps_fwdtsn_map_over; /* number of map array over-runs via
1121 uint32_t sctps_queue_upd_ecne; /* Number of times we queued or
1122 * updated an ECN chunk on send queue */
1123 uint32_t sctps_reserved[31]; /* Future ABI compat - remove int's
1124 * from here when adding new */
1127 #define SCTP_STAT_INCR(_x) SCTP_STAT_INCR_BY(_x,1)
1128 #define SCTP_STAT_DECR(_x) SCTP_STAT_DECR_BY(_x,1)
1129 #if defined(SMP) && defined(SCTP_USE_PERCPU_STAT)
1130 #define SCTP_STAT_INCR_BY(_x,_d) (SCTP_BASE_STATS[PCPU_GET(cpuid)]._x += _d)
1131 #define SCTP_STAT_DECR_BY(_x,_d) (SCTP_BASE_STATS[PCPU_GET(cpuid)]._x -= _d)
1133 #define SCTP_STAT_INCR_BY(_x,_d) atomic_add_int(&SCTP_BASE_STAT(_x), _d)
1134 #define SCTP_STAT_DECR_BY(_x,_d) atomic_subtract_int(&SCTP_BASE_STAT(_x), _d)
1136 /* The following macros are for handling MIB values, */
1137 #define SCTP_STAT_INCR_COUNTER32(_x) SCTP_STAT_INCR(_x)
1138 #define SCTP_STAT_INCR_COUNTER64(_x) SCTP_STAT_INCR(_x)
1139 #define SCTP_STAT_INCR_GAUGE32(_x) SCTP_STAT_INCR(_x)
1140 #define SCTP_STAT_DECR_COUNTER32(_x) SCTP_STAT_DECR(_x)
1141 #define SCTP_STAT_DECR_COUNTER64(_x) SCTP_STAT_DECR(_x)
1142 #define SCTP_STAT_DECR_GAUGE32(_x) SCTP_STAT_DECR(_x)
1144 /***********************************/
1145 /* And something for us old timers */
1146 /***********************************/
1149 #include <sys/endian.h>
1150 #define ntohll(x) be64toh(x)
1154 #include <sys/endian.h>
1155 #define htonll(x) htobe64(x)
1157 /***********************************/
1159 struct xsctp_inpcb {
1163 uint32_t total_sends;
1164 uint32_t total_recvs;
1165 uint32_t total_nospaces;
1166 uint32_t fragmentation_point;
1167 uint16_t local_port;
1169 uint16_t maxqlen_old;
1174 uint32_t extra_padding[26]; /* 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;
1233 uint16_t encaps_port;
1235 uint32_t extra_padding[29]; /* future */
1238 #define SCTP_MAX_LOGGING_SIZE 30000
1239 #define SCTP_TRACE_PARAMS 6 /* This number MUST be even */
1241 struct sctp_log_entry {
1245 uint32_t params[SCTP_TRACE_PARAMS];
1249 struct sctp_log_entry entry[SCTP_MAX_LOGGING_SIZE];
1255 * Kernel defined for sctp_send
1257 #if defined(_KERNEL) || defined(__Userspace__)
1259 sctp_lower_sosend(struct socket *so,
1260 struct sockaddr *addr,
1263 struct mbuf *control,
1265 struct sctp_sndrcvinfo *srcv
1270 sctp_sorecvmsg(struct socket *so,
1273 struct sockaddr *from,
1276 struct sctp_sndrcvinfo *sinfo,
1283 #if !(defined(_KERNEL)) && !(defined(__Userspace__))
1286 int sctp_peeloff(int, sctp_assoc_t);
1287 int sctp_bindx(int, struct sockaddr *, int, int);
1288 int sctp_connectx(int, const struct sockaddr *, int, sctp_assoc_t *);
1289 int sctp_getaddrlen(sa_family_t);
1290 int sctp_getpaddrs(int, sctp_assoc_t, struct sockaddr **);
1291 void sctp_freepaddrs(struct sockaddr *);
1292 int sctp_getladdrs(int, sctp_assoc_t, struct sockaddr **);
1293 void sctp_freeladdrs(struct sockaddr *);
1294 int sctp_opt_info(int, sctp_assoc_t, int, void *, socklen_t *);
1298 sctp_sendmsg(int, const void *, size_t, const struct sockaddr *,
1299 socklen_t, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t);
1303 sctp_send(int, const void *, size_t,
1304 const struct sctp_sndrcvinfo *, int);
1308 sctp_sendx(int, const void *, size_t, struct sockaddr *,
1309 int, struct sctp_sndrcvinfo *, int);
1313 sctp_sendmsgx(int sd, const void *, size_t, struct sockaddr *,
1314 int, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t);
1316 sctp_assoc_t sctp_getassocid(int, struct sockaddr *);
1320 sctp_recvmsg(int, void *, size_t, struct sockaddr *, socklen_t *,
1321 struct sctp_sndrcvinfo *, int *);
1324 sctp_sendv(int, const struct iovec *, int, struct sockaddr *,
1325 int, void *, socklen_t, unsigned int, int);
1328 sctp_recvv(int, const struct iovec *, int, struct sockaddr *,
1329 socklen_t *, void *, socklen_t *, unsigned int *, int *);
1333 #endif /* !_KERNEL */
1334 #endif /* !__sctp_uio_h__ */