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_
42 #if ! defined(_KERNEL)
45 #include <sys/types.h>
46 #include <sys/socket.h>
47 #include <netinet/in.h>
49 typedef uint32_t sctp_assoc_t;
51 #define SCTP_FUTURE_ASSOC 0
52 #define SCTP_CURRENT_ASSOC 1
53 #define SCTP_ALL_ASSOC 2
56 sctp_assoc_t se_assoc_id;
61 /* Compatibility to previous define's */
62 #define sctp_stream_reset_events sctp_stream_reset_event
64 /* On/Off setup for subscription to events */
65 struct sctp_event_subscribe {
66 uint8_t sctp_data_io_event;
67 uint8_t sctp_association_event;
68 uint8_t sctp_address_event;
69 uint8_t sctp_send_failure_event;
70 uint8_t sctp_peer_error_event;
71 uint8_t sctp_shutdown_event;
72 uint8_t sctp_partial_delivery_event;
73 uint8_t sctp_adaptation_layer_event;
74 uint8_t sctp_authentication_event;
75 uint8_t sctp_sender_dry_event;
76 uint8_t sctp_stream_reset_event;
79 /* ancillary data types */
80 #define SCTP_INIT 0x0001
81 #define SCTP_SNDRCV 0x0002
82 #define SCTP_EXTRCV 0x0003
83 #define SCTP_SNDINFO 0x0004
84 #define SCTP_RCVINFO 0x0005
85 #define SCTP_NXTINFO 0x0006
86 #define SCTP_PRINFO 0x0007
87 #define SCTP_AUTHINFO 0x0008
88 #define SCTP_DSTADDRV4 0x0009
89 #define SCTP_DSTADDRV6 0x000a
92 * ancillary data structures
95 uint16_t sinit_num_ostreams;
96 uint16_t sinit_max_instreams;
97 uint16_t sinit_max_attempts;
98 uint16_t sinit_max_init_timeo;
101 /* We add 96 bytes to the size of sctp_sndrcvinfo.
102 * This makes the current structure 128 bytes long
103 * which is nicely 64 bit aligned but also has room
104 * for us to add more and keep ABI compatibility.
105 * For example, already we have the sctp_extrcvinfo
106 * when enabled which is 48 bytes.
110 * The assoc up needs a verfid
111 * all sendrcvinfo's need a verfid for SENDING only.
115 #define SCTP_ALIGN_RESV_PAD 92
116 #define SCTP_ALIGN_RESV_PAD_SHORT 76
118 struct sctp_sndrcvinfo {
119 uint16_t sinfo_stream;
121 uint16_t sinfo_flags;
123 uint32_t sinfo_context;
124 uint32_t sinfo_timetolive;
126 uint32_t sinfo_cumtsn;
127 sctp_assoc_t sinfo_assoc_id;
128 uint16_t sinfo_keynumber;
129 uint16_t sinfo_keynumber_valid;
130 uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD];
133 struct sctp_extrcvinfo {
134 uint16_t sinfo_stream;
136 uint16_t sinfo_flags;
138 uint32_t sinfo_context;
139 uint32_t sinfo_timetolive; /* should have been sinfo_pr_value */
141 uint32_t sinfo_cumtsn;
142 sctp_assoc_t sinfo_assoc_id;
143 uint16_t serinfo_next_flags;
144 uint16_t serinfo_next_stream;
145 uint32_t serinfo_next_aid;
146 uint32_t serinfo_next_length;
147 uint32_t serinfo_next_ppid;
148 uint16_t sinfo_keynumber;
149 uint16_t sinfo_keynumber_valid;
150 uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD_SHORT];
152 #define sinfo_pr_value sinfo_timetolive
153 #define sreinfo_next_flags serinfo_next_flags
154 #define sreinfo_next_stream serinfo_next_stream
155 #define sreinfo_next_aid serinfo_next_aid
156 #define sreinfo_next_length serinfo_next_length
157 #define sreinfo_next_ppid serinfo_next_ppid
159 struct sctp_sndinfo {
163 uint32_t snd_context;
164 sctp_assoc_t snd_assoc_id;
172 struct sctp_default_prinfo {
175 sctp_assoc_t pr_assoc_id;
178 struct sctp_authinfo {
179 uint16_t auth_keynumber;
182 struct sctp_rcvinfo {
189 uint32_t rcv_context;
190 sctp_assoc_t rcv_assoc_id;
193 struct sctp_nxtinfo {
198 sctp_assoc_t nxt_assoc_id;
201 #define SCTP_NO_NEXT_MSG 0x0000
202 #define SCTP_NEXT_MSG_AVAIL 0x0001
203 #define SCTP_NEXT_MSG_ISCOMPLETE 0x0002
204 #define SCTP_NEXT_MSG_IS_UNORDERED 0x0004
205 #define SCTP_NEXT_MSG_IS_NOTIFICATION 0x0008
207 struct sctp_recvv_rn {
208 struct sctp_rcvinfo recvv_rcvinfo;
209 struct sctp_nxtinfo recvv_nxtinfo;
212 #define SCTP_RECVV_NOINFO 0
213 #define SCTP_RECVV_RCVINFO 1
214 #define SCTP_RECVV_NXTINFO 2
215 #define SCTP_RECVV_RN 3
217 #define SCTP_SENDV_NOINFO 0
218 #define SCTP_SENDV_SNDINFO 1
219 #define SCTP_SENDV_PRINFO 2
220 #define SCTP_SENDV_AUTHINFO 3
221 #define SCTP_SENDV_SPA 4
223 struct sctp_sendv_spa {
224 uint32_t sendv_flags;
225 struct sctp_sndinfo sendv_sndinfo;
226 struct sctp_prinfo sendv_prinfo;
227 struct sctp_authinfo sendv_authinfo;
230 #define SCTP_SEND_SNDINFO_VALID 0x00000001
231 #define SCTP_SEND_PRINFO_VALID 0x00000002
232 #define SCTP_SEND_AUTHINFO_VALID 0x00000004
234 struct sctp_snd_all_completes {
235 uint16_t sall_stream;
238 uint32_t sall_context;
239 uint32_t sall_num_sent;
240 uint32_t sall_num_failed;
243 /* Flags that go into the sinfo->sinfo_flags field */
244 #define SCTP_NOTIFICATION 0x0010 /* next message is a notification */
245 #define SCTP_COMPLETE 0x0020 /* next message is complete */
246 #define SCTP_EOF 0x0100 /* Start shutdown procedures */
247 #define SCTP_ABORT 0x0200 /* Send an ABORT to peer */
248 #define SCTP_UNORDERED 0x0400 /* Message is un-ordered */
249 #define SCTP_ADDR_OVER 0x0800 /* Override the primary-address */
250 #define SCTP_SENDALL 0x1000 /* Send this on all associations */
251 #define SCTP_EOR 0x2000 /* end of message signal */
252 #define SCTP_SACK_IMMEDIATELY 0x4000 /* Set I-Bit */
254 #define INVALID_SINFO_FLAG(x) (((x) & 0xfffffff0 \
255 & ~(SCTP_EOF | SCTP_ABORT | SCTP_UNORDERED |\
256 SCTP_ADDR_OVER | SCTP_SENDALL | SCTP_EOR |\
257 SCTP_SACK_IMMEDIATELY)) != 0)
258 /* for the endpoint */
260 /* The lower four bits is an enumeration of PR-SCTP policies */
261 #define SCTP_PR_SCTP_NONE 0x0000/* Reliable transfer */
262 #define SCTP_PR_SCTP_TTL 0x0001/* Time based PR-SCTP */
263 #define SCTP_PR_SCTP_PRIO 0x0002/* Buffer based PR-SCTP */
264 #define SCTP_PR_SCTP_BUF SCTP_PR_SCTP_PRIO /* For backwards compatibility */
265 #define SCTP_PR_SCTP_RTX 0x0003/* Number of retransmissions based PR-SCTP */
266 #define SCTP_PR_SCTP_MAX SCTP_PR_SCTP_RTX
267 #define SCTP_PR_SCTP_ALL 0x000f/* Used for aggregated stats */
269 #define PR_SCTP_POLICY(x) ((x) & 0x0f)
270 #define PR_SCTP_ENABLED(x) ((PR_SCTP_POLICY(x) != SCTP_PR_SCTP_NONE) && \
271 (PR_SCTP_POLICY(x) != SCTP_PR_SCTP_ALL))
272 #define PR_SCTP_TTL_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_TTL)
273 #define PR_SCTP_BUF_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_BUF)
274 #define PR_SCTP_RTX_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_RTX)
275 #define PR_SCTP_INVALID_POLICY(x) (PR_SCTP_POLICY(x) > SCTP_PR_SCTP_MAX)
276 #define PR_SCTP_VALID_POLICY(x) (PR_SCTP_POLICY(x) <= SCTP_PR_SCTP_MAX)
279 struct sctp_pcbinfo {
282 uint32_t laddr_count;
283 uint32_t raddr_count;
285 uint32_t readq_count;
286 uint32_t free_chunks;
287 uint32_t stream_oque;
290 struct sctp_sockstat {
291 sctp_assoc_t ss_assoc_id;
292 uint32_t ss_total_sndbuf;
293 uint32_t ss_total_recv_buf;
297 * notification event structures
301 * association change event
303 struct sctp_assoc_change {
309 uint16_t sac_outbound_streams;
310 uint16_t sac_inbound_streams;
311 sctp_assoc_t sac_assoc_id;
315 /* sac_state values */
316 #define SCTP_COMM_UP 0x0001
317 #define SCTP_COMM_LOST 0x0002
318 #define SCTP_RESTART 0x0003
319 #define SCTP_SHUTDOWN_COMP 0x0004
320 #define SCTP_CANT_STR_ASSOC 0x0005
322 /* sac_info values */
323 #define SCTP_ASSOC_SUPPORTS_PR 0x01
324 #define SCTP_ASSOC_SUPPORTS_AUTH 0x02
325 #define SCTP_ASSOC_SUPPORTS_ASCONF 0x03
326 #define SCTP_ASSOC_SUPPORTS_MULTIBUF 0x04
327 #define SCTP_ASSOC_SUPPORTS_RE_CONFIG 0x05
328 #define SCTP_ASSOC_SUPPORTS_INTERLEAVING 0x06
329 #define SCTP_ASSOC_SUPPORTS_MAX 0x06
333 struct sctp_paddr_change {
337 struct sockaddr_storage spc_aaddr;
340 sctp_assoc_t spc_assoc_id;
343 /* paddr state values */
344 #define SCTP_ADDR_AVAILABLE 0x0001
345 #define SCTP_ADDR_UNREACHABLE 0x0002
346 #define SCTP_ADDR_REMOVED 0x0003
347 #define SCTP_ADDR_ADDED 0x0004
348 #define SCTP_ADDR_MADE_PRIM 0x0005
349 #define SCTP_ADDR_CONFIRMED 0x0006
351 #define SCTP_ACTIVE 0x0001 /* SCTP_ADDR_REACHABLE */
352 #define SCTP_INACTIVE 0x0002 /* neither SCTP_ADDR_REACHABLE nor
353 * SCTP_ADDR_UNCONFIRMED */
354 #define SCTP_UNCONFIRMED 0x0200 /* SCTP_ADDR_UNCONFIRMED */
356 /* remote error events */
357 struct sctp_remote_error {
362 sctp_assoc_t sre_assoc_id;
366 /* data send failure event (deprecated) */
367 struct sctp_send_failed {
372 struct sctp_sndrcvinfo ssf_info;
373 sctp_assoc_t ssf_assoc_id;
377 /* data send failure event (not deprecated) */
378 struct sctp_send_failed_event {
381 uint32_t ssfe_length;
383 struct sctp_sndinfo ssfe_info;
384 sctp_assoc_t ssfe_assoc_id;
388 /* flag that indicates state of data */
389 #define SCTP_DATA_UNSENT 0x0001 /* inqueue never on wire */
390 #define SCTP_DATA_SENT 0x0002 /* on wire at failure */
393 struct sctp_shutdown_event {
397 sctp_assoc_t sse_assoc_id;
400 /* Adaptation layer indication stuff */
401 struct sctp_adaptation_event {
405 uint32_t sai_adaptation_ind;
406 sctp_assoc_t sai_assoc_id;
409 struct sctp_setadaptation {
410 uint32_t ssb_adaptation_ind;
413 /* compatible old spelling */
414 struct sctp_adaption_event {
418 uint32_t sai_adaption_ind;
419 sctp_assoc_t sai_assoc_id;
422 struct sctp_setadaption {
423 uint32_t ssb_adaption_ind;
428 * Partial Delivery API event
430 struct sctp_pdapi_event {
432 uint16_t pdapi_flags;
433 uint32_t pdapi_length;
434 uint32_t pdapi_indication;
435 uint16_t pdapi_stream;
437 sctp_assoc_t pdapi_assoc_id;
440 /* indication values */
441 #define SCTP_PARTIAL_DELIVERY_ABORTED 0x0001
445 * authentication key event
447 struct sctp_authkey_event {
450 uint32_t auth_length;
451 uint16_t auth_keynumber;
452 uint16_t auth_altkeynumber;
453 uint32_t auth_indication;
454 sctp_assoc_t auth_assoc_id;
457 /* indication values */
458 #define SCTP_AUTH_NEW_KEY 0x0001
459 #define SCTP_AUTH_NEWKEY SCTP_AUTH_NEW_KEY
460 #define SCTP_AUTH_NO_AUTH 0x0002
461 #define SCTP_AUTH_FREE_KEY 0x0003
464 struct sctp_sender_dry_event {
465 uint16_t sender_dry_type;
466 uint16_t sender_dry_flags;
467 uint32_t sender_dry_length;
468 sctp_assoc_t sender_dry_assoc_id;
473 * Stream reset event - subscribe to SCTP_STREAM_RESET_EVENT
475 struct sctp_stream_reset_event {
476 uint16_t strreset_type;
477 uint16_t strreset_flags;
478 uint32_t strreset_length;
479 sctp_assoc_t strreset_assoc_id;
480 uint16_t strreset_stream_list[];
483 /* flags in stream_reset_event (strreset_flags) */
484 #define SCTP_STREAM_RESET_INCOMING_SSN 0x0001
485 #define SCTP_STREAM_RESET_OUTGOING_SSN 0x0002
486 #define SCTP_STREAM_RESET_DENIED 0x0004
487 #define SCTP_STREAM_RESET_FAILED 0x0008
490 * Assoc reset event - subscribe to SCTP_ASSOC_RESET_EVENT
492 struct sctp_assoc_reset_event {
493 uint16_t assocreset_type;
494 uint16_t assocreset_flags;
495 uint32_t assocreset_length;
496 sctp_assoc_t assocreset_assoc_id;
497 uint32_t assocreset_local_tsn;
498 uint32_t assocreset_remote_tsn;
501 #define SCTP_ASSOC_RESET_DENIED 0x0004
502 #define SCTP_ASSOC_RESET_FAILED 0x0008
505 * Stream change event - subscribe to SCTP_STREAM_CHANGE_EVENT
507 struct sctp_stream_change_event {
508 uint16_t strchange_type;
509 uint16_t strchange_flags;
510 uint32_t strchange_length;
511 sctp_assoc_t strchange_assoc_id;
512 uint16_t strchange_instrms;
513 uint16_t strchange_outstrms;
516 #define SCTP_STREAM_CHANGE_DENIED 0x0004
517 #define SCTP_STREAM_CHANGE_FAILED 0x0008
520 /* SCTP notification event */
527 union sctp_notification {
528 struct sctp_tlv sn_header;
529 struct sctp_assoc_change sn_assoc_change;
530 struct sctp_paddr_change sn_paddr_change;
531 struct sctp_remote_error sn_remote_error;
532 struct sctp_send_failed sn_send_failed;
533 struct sctp_shutdown_event sn_shutdown_event;
534 struct sctp_adaptation_event sn_adaptation_event;
535 /* compatibility same as above */
536 struct sctp_adaption_event sn_adaption_event;
537 struct sctp_pdapi_event sn_pdapi_event;
538 struct sctp_authkey_event sn_auth_event;
539 struct sctp_sender_dry_event sn_sender_dry_event;
540 struct sctp_send_failed_event sn_send_failed_event;
541 struct sctp_stream_reset_event sn_strreset_event;
542 struct sctp_assoc_reset_event sn_assocreset_event;
543 struct sctp_stream_change_event sn_strchange_event;
546 /* notification types */
547 #define SCTP_ASSOC_CHANGE 0x0001
548 #define SCTP_PEER_ADDR_CHANGE 0x0002
549 #define SCTP_REMOTE_ERROR 0x0003
550 #define SCTP_SEND_FAILED 0x0004
551 #define SCTP_SHUTDOWN_EVENT 0x0005
552 #define SCTP_ADAPTATION_INDICATION 0x0006
554 #define SCTP_ADAPTION_INDICATION 0x0006
555 #define SCTP_PARTIAL_DELIVERY_EVENT 0x0007
556 #define SCTP_AUTHENTICATION_EVENT 0x0008
557 #define SCTP_STREAM_RESET_EVENT 0x0009
558 #define SCTP_SENDER_DRY_EVENT 0x000a
559 #define SCTP_NOTIFICATIONS_STOPPED_EVENT 0x000b /* we don't send this */
560 #define SCTP_ASSOC_RESET_EVENT 0x000c
561 #define SCTP_STREAM_CHANGE_EVENT 0x000d
562 #define SCTP_SEND_FAILED_EVENT 0x000e
564 * socket option structs
567 struct sctp_paddrparams {
568 struct sockaddr_storage spp_address;
569 sctp_assoc_t spp_assoc_id;
570 uint32_t spp_hbinterval;
571 uint32_t spp_pathmtu;
573 uint32_t spp_ipv6_flowlabel;
574 uint16_t spp_pathmaxrxt;
577 #define spp_ipv4_tos spp_dscp
579 #define SPP_HB_ENABLE 0x00000001
580 #define SPP_HB_DISABLE 0x00000002
581 #define SPP_HB_DEMAND 0x00000004
582 #define SPP_PMTUD_ENABLE 0x00000008
583 #define SPP_PMTUD_DISABLE 0x00000010
584 #define SPP_HB_TIME_IS_ZERO 0x00000080
585 #define SPP_IPV6_FLOWLABEL 0x00000100
586 #define SPP_DSCP 0x00000200
587 #define SPP_IPV4_TOS SPP_DSCP
589 struct sctp_paddrthlds {
590 struct sockaddr_storage spt_address;
591 sctp_assoc_t spt_assoc_id;
592 uint16_t spt_pathmaxrxt;
593 uint16_t spt_pathpfthld;
594 uint16_t spt_pathcpthld;
597 struct sctp_paddrinfo {
598 struct sockaddr_storage spinfo_address;
599 sctp_assoc_t spinfo_assoc_id;
600 int32_t spinfo_state;
601 uint32_t spinfo_cwnd;
602 uint32_t spinfo_srtt;
607 struct sctp_rtoinfo {
608 sctp_assoc_t srto_assoc_id;
609 uint32_t srto_initial;
614 struct sctp_assocparams {
615 sctp_assoc_t sasoc_assoc_id;
616 uint32_t sasoc_peer_rwnd;
617 uint32_t sasoc_local_rwnd;
618 uint32_t sasoc_cookie_life;
619 uint16_t sasoc_asocmaxrxt;
620 uint16_t sasoc_number_peer_destinations;
623 struct sctp_setprim {
624 struct sockaddr_storage ssp_addr;
625 sctp_assoc_t ssp_assoc_id;
626 uint8_t ssp_padding[4];
629 struct sctp_setpeerprim {
630 struct sockaddr_storage sspp_addr;
631 sctp_assoc_t sspp_assoc_id;
632 uint8_t sspp_padding[4];
635 struct sctp_getaddresses {
636 sctp_assoc_t sget_assoc_id;
637 /* addr is filled in for N * sockaddr_storage */
638 struct sockaddr addr[1];
642 sctp_assoc_t sstat_assoc_id;
645 uint16_t sstat_unackdata;
646 uint16_t sstat_penddata;
647 uint16_t sstat_instrms;
648 uint16_t sstat_outstrms;
649 uint32_t sstat_fragmentation_point;
650 struct sctp_paddrinfo sstat_primary;
654 * AUTHENTICATION support
656 /* SCTP_AUTH_CHUNK */
657 struct sctp_authchunk {
662 struct sctp_authkey {
663 sctp_assoc_t sca_assoc_id;
664 uint16_t sca_keynumber;
665 uint16_t sca_keylength;
669 /* SCTP_HMAC_IDENT */
670 struct sctp_hmacalgo {
671 uint32_t shmac_number_of_idents;
672 uint16_t shmac_idents[];
676 #define SCTP_AUTH_HMAC_ID_RSVD 0x0000
677 #define SCTP_AUTH_HMAC_ID_SHA1 0x0001 /* default, mandatory */
678 #define SCTP_AUTH_HMAC_ID_SHA256 0x0003
680 /* SCTP_AUTH_ACTIVE_KEY / SCTP_AUTH_DELETE_KEY */
681 struct sctp_authkeyid {
682 sctp_assoc_t scact_assoc_id;
683 uint16_t scact_keynumber;
686 /* SCTP_PEER_AUTH_CHUNKS / SCTP_LOCAL_AUTH_CHUNKS */
687 struct sctp_authchunks {
688 sctp_assoc_t gauth_assoc_id;
689 uint32_t gauth_number_of_chunks;
690 uint8_t gauth_chunks[];
693 struct sctp_assoc_value {
694 sctp_assoc_t assoc_id;
695 uint32_t assoc_value;
698 struct sctp_cc_option {
700 struct sctp_assoc_value aid_value;
703 struct sctp_stream_value {
704 sctp_assoc_t assoc_id;
706 uint16_t stream_value;
709 struct sctp_assoc_ids {
710 uint32_t gaids_number_of_ids;
711 sctp_assoc_t gaids_assoc_id[];
714 struct sctp_sack_info {
715 sctp_assoc_t sack_assoc_id;
720 struct sctp_timeouts {
721 sctp_assoc_t stimo_assoc_id;
725 uint32_t stimo_shutdown;
726 uint32_t stimo_heartbeat;
727 uint32_t stimo_cookie;
728 uint32_t stimo_shutdownack;
731 struct sctp_udpencaps {
732 struct sockaddr_storage sue_address;
733 sctp_assoc_t sue_assoc_id;
737 struct sctp_prstatus {
738 sctp_assoc_t sprstat_assoc_id;
739 uint16_t sprstat_sid;
740 uint16_t sprstat_policy;
741 uint64_t sprstat_abandoned_unsent;
742 uint64_t sprstat_abandoned_sent;
745 struct sctp_cwnd_args {
746 struct sctp_nets *net; /* network to *//* FIXME: LP64 issue */
747 uint32_t cwnd_new_value;/* cwnd in k */
748 uint32_t pseudo_cumack;
749 uint16_t inflight; /* flightsize in k */
750 uint16_t cwnd_augment; /* increment to it */
751 uint8_t meets_pseudo_cumack;
752 uint8_t need_new_pseudo_cumack;
757 struct sctp_blk_args {
758 uint32_t onsb; /* in 1k bytes */
759 uint32_t sndlen; /* len of send being attempted */
760 uint32_t peer_rwnd; /* rwnd of peer */
761 uint16_t send_sent_qcnt;/* chnk cnt */
762 uint16_t stream_qcnt; /* chnk cnt */
763 uint16_t chunks_on_oque;/* chunks out */
764 uint16_t flight_size; /* flight size in k */
768 * Max we can reset in one setting, note this is dictated not by the define
769 * but the size of a mbuf cluster so don't change this define and think you
770 * can specify more. You must do multiple resets if you want to reset more
771 * than SCTP_MAX_EXPLICIT_STR_RESET.
773 #define SCTP_MAX_EXPLICT_STR_RESET 1000
775 struct sctp_reset_streams {
776 sctp_assoc_t srs_assoc_id;
778 uint16_t srs_number_streams; /* 0 == ALL */
779 uint16_t srs_stream_list[]; /* list if strrst_num_streams is not 0 */
782 struct sctp_add_streams {
783 sctp_assoc_t sas_assoc_id;
784 uint16_t sas_instrms;
785 uint16_t sas_outstrms;
788 struct sctp_get_nonce_values {
789 sctp_assoc_t gn_assoc_id;
790 uint32_t gn_peers_tag;
791 uint32_t gn_local_tag;
795 struct sctp_str_log {
796 void *stcb; /* FIXME: LP64 issue */
805 void *stcb; /* FIXME: LP64 issue */
812 uint32_t largest_tsn;
813 uint32_t largest_new_tsn;
823 struct sctp_rwnd_log {
830 struct sctp_mbcnt_log {
831 uint32_t total_queue_size;
832 uint32_t size_change;
833 uint32_t total_queue_mb_size;
834 uint32_t mbcnt_change;
837 struct sctp_sack_log {
845 struct sctp_lock_log {
846 void *sock; /* FIXME: LP64 issue */
847 void *inp; /* FIXME: LP64 issue */
852 uint8_t sockrcvbuf_lock;
853 uint8_t socksndbuf_lock;
858 struct sctp_rto_log {
859 void *net; /* FIXME: LP64 issue */
863 struct sctp_nagle_log {
864 void *stcb; /* FIXME: LP64 issue */
865 uint32_t total_flight;
866 uint32_t total_in_queue;
867 uint16_t count_in_queue;
868 uint16_t count_in_flight;
871 struct sctp_sbwake_log {
872 void *stcb; /* FIXME: LP64 issue */
877 uint8_t stream_qcnt; /* chnk cnt */
878 uint8_t chunks_on_oque; /* chunks out */
883 struct sctp_misc_info {
890 struct sctp_log_closing {
891 void *inp; /* FIXME: LP64 issue */
892 void *stcb; /* FIXME: LP64 issue */
898 struct sctp_mbuf_log {
899 struct mbuf *mp; /* FIXME: LP64 issue */
907 struct sctp_cwnd_log {
913 struct sctp_log_closing close;
914 struct sctp_blk_args blk;
915 struct sctp_cwnd_args cwnd;
916 struct sctp_str_log strlog;
917 struct sctp_fr_log fr;
918 struct sctp_fr_map map;
919 struct sctp_rwnd_log rwnd;
920 struct sctp_mbcnt_log mbcnt;
921 struct sctp_sack_log sack;
922 struct sctp_lock_log lock;
923 struct sctp_rto_log rto;
924 struct sctp_sb_log sb;
925 struct sctp_nagle_log nagle;
926 struct sctp_sbwake_log wake;
927 struct sctp_mbuf_log mb;
928 struct sctp_misc_info misc;
932 struct sctp_cwnd_log_req {
933 int32_t num_in_log; /* Number in log */
934 int32_t num_ret; /* Number returned */
935 int32_t start_at; /* start at this one */
936 int32_t end_at; /* end at this one */
937 struct sctp_cwnd_log log[];
940 struct sctp_timeval {
946 struct sctp_timeval sctps_discontinuitytime; /* sctpStats 18
948 /* MIB according to RFC 3873 */
949 uint32_t sctps_currestab; /* sctpStats 1 (Gauge32) */
950 uint32_t sctps_activeestab; /* sctpStats 2 (Counter32) */
951 uint32_t sctps_restartestab;
952 uint32_t sctps_collisionestab;
953 uint32_t sctps_passiveestab; /* sctpStats 3 (Counter32) */
954 uint32_t sctps_aborted; /* sctpStats 4 (Counter32) */
955 uint32_t sctps_shutdown;/* sctpStats 5 (Counter32) */
956 uint32_t sctps_outoftheblue; /* sctpStats 6 (Counter32) */
957 uint32_t sctps_checksumerrors; /* sctpStats 7 (Counter32) */
958 uint32_t sctps_outcontrolchunks; /* sctpStats 8 (Counter64) */
959 uint32_t sctps_outorderchunks; /* sctpStats 9 (Counter64) */
960 uint32_t sctps_outunorderchunks; /* sctpStats 10 (Counter64) */
961 uint32_t sctps_incontrolchunks; /* sctpStats 11 (Counter64) */
962 uint32_t sctps_inorderchunks; /* sctpStats 12 (Counter64) */
963 uint32_t sctps_inunorderchunks; /* sctpStats 13 (Counter64) */
964 uint32_t sctps_fragusrmsgs; /* sctpStats 14 (Counter64) */
965 uint32_t sctps_reasmusrmsgs; /* sctpStats 15 (Counter64) */
966 uint32_t sctps_outpackets; /* sctpStats 16 (Counter64) */
967 uint32_t sctps_inpackets; /* sctpStats 17 (Counter64) */
969 /* input statistics: */
970 uint32_t sctps_recvpackets; /* total input packets */
971 uint32_t sctps_recvdatagrams; /* total input datagrams */
972 uint32_t sctps_recvpktwithdata; /* total packets that had data */
973 uint32_t sctps_recvsacks; /* total input SACK chunks */
974 uint32_t sctps_recvdata;/* total input DATA chunks */
975 uint32_t sctps_recvdupdata; /* total input duplicate DATA chunks */
976 uint32_t sctps_recvheartbeat; /* total input HB chunks */
977 uint32_t sctps_recvheartbeatack; /* total input HB-ACK chunks */
978 uint32_t sctps_recvecne;/* total input ECNE chunks */
979 uint32_t sctps_recvauth;/* total input AUTH chunks */
980 uint32_t sctps_recvauthmissing; /* total input chunks missing AUTH */
981 uint32_t sctps_recvivalhmacid; /* total number of invalid HMAC ids
983 uint32_t sctps_recvivalkeyid; /* total number of invalid secret ids
985 uint32_t sctps_recvauthfailed; /* total number of auth failed */
986 uint32_t sctps_recvexpress; /* total fast path receives all one
988 uint32_t sctps_recvexpressm; /* total fast path multi-part data */
989 uint32_t sctps_recv_spare; /* formerly sctps_recvnocrc */
990 uint32_t sctps_recvswcrc;
991 uint32_t sctps_recvhwcrc;
993 /* output statistics: */
994 uint32_t sctps_sendpackets; /* total output packets */
995 uint32_t sctps_sendsacks; /* total output SACKs */
996 uint32_t sctps_senddata;/* total output DATA chunks */
997 uint32_t sctps_sendretransdata; /* total output retransmitted DATA
999 uint32_t sctps_sendfastretrans; /* total output fast retransmitted
1001 uint32_t sctps_sendmultfastretrans; /* total FR's that happened
1002 * more than once to same
1003 * chunk (u-del multi-fr
1005 uint32_t sctps_sendheartbeat; /* total output HB chunks */
1006 uint32_t sctps_sendecne;/* total output ECNE chunks */
1007 uint32_t sctps_sendauth;/* total output AUTH chunks FIXME */
1008 uint32_t sctps_senderrors; /* ip_output error counter */
1009 uint32_t sctps_send_spare; /* formerly sctps_sendnocrc */
1010 uint32_t sctps_sendswcrc;
1011 uint32_t sctps_sendhwcrc;
1012 /* PCKDROPREP statistics: */
1013 uint32_t sctps_pdrpfmbox; /* Packet drop from middle box */
1014 uint32_t sctps_pdrpfehos; /* P-drop from end host */
1015 uint32_t sctps_pdrpmbda;/* P-drops with data */
1016 uint32_t sctps_pdrpmbct;/* P-drops, non-data, non-endhost */
1017 uint32_t sctps_pdrpbwrpt; /* P-drop, non-endhost, bandwidth rep
1019 uint32_t sctps_pdrpcrupt; /* P-drop, not enough for chunk header */
1020 uint32_t sctps_pdrpnedat; /* P-drop, not enough data to confirm */
1021 uint32_t sctps_pdrppdbrk; /* P-drop, where process_chunk_drop
1023 uint32_t sctps_pdrptsnnf; /* P-drop, could not find TSN */
1024 uint32_t sctps_pdrpdnfnd; /* P-drop, attempt reverse TSN lookup */
1025 uint32_t sctps_pdrpdiwnp; /* P-drop, e-host confirms zero-rwnd */
1026 uint32_t sctps_pdrpdizrw; /* P-drop, midbox confirms no space */
1027 uint32_t sctps_pdrpbadd;/* P-drop, data did not match TSN */
1028 uint32_t sctps_pdrpmark;/* P-drop, TSN's marked for Fast Retran */
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(__FreeBSD__) && 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 union sctp_sockstore {
1145 struct sockaddr_in sin;
1146 struct sockaddr_in6 sin6;
1151 /***********************************/
1152 /* And something for us old timers */
1153 /***********************************/
1156 #include <sys/endian.h>
1157 #define ntohll(x) be64toh(x)
1161 #include <sys/endian.h>
1162 #define htonll(x) htobe64(x)
1164 /***********************************/
1167 struct xsctp_inpcb {
1171 uint32_t total_sends;
1172 uint32_t total_recvs;
1173 uint32_t total_nospaces;
1174 uint32_t fragmentation_point;
1175 uint16_t local_port;
1177 uint16_t maxqlen_old;
1181 #if defined(__LP64__)
1182 uint32_t extra_padding[27]; /* future */
1184 uint32_t extra_padding[28]; /* future */
1189 union sctp_sockstore primary_addr; /* sctpAssocEntry 5/6 */
1191 uint32_t heartbeat_interval; /* sctpAssocEntry 7 */
1192 uint32_t state; /* sctpAssocEntry 8 */
1193 uint32_t in_streams; /* sctpAssocEntry 9 */
1194 uint32_t out_streams; /* sctpAssocEntry 10 */
1195 uint32_t max_nr_retrans;/* sctpAssocEntry 11 */
1196 uint32_t primary_process; /* sctpAssocEntry 12 */
1197 uint32_t T1_expireries; /* sctpAssocEntry 13 */
1198 uint32_t T2_expireries; /* sctpAssocEntry 14 */
1199 uint32_t retransmitted_tsns; /* sctpAssocEntry 15 */
1200 uint32_t total_sends;
1201 uint32_t total_recvs;
1203 uint32_t remote_tag;
1204 uint32_t initial_tsn;
1205 uint32_t highest_tsn;
1206 uint32_t cumulative_tsn;
1207 uint32_t cumulative_tsn_ack;
1210 uint16_t local_port; /* sctpAssocEntry 3 */
1211 uint16_t remote_port; /* sctpAssocEntry 4 */
1212 struct sctp_timeval start_time; /* sctpAssocEntry 16 */
1213 struct sctp_timeval discontinuity_time; /* sctpAssocEntry 17 */
1214 uint32_t peers_rwnd;
1215 sctp_assoc_t assoc_id; /* sctpAssocEntry 1 */
1216 uint32_t extra_padding[32]; /* future */
1219 struct xsctp_laddr {
1220 union sctp_sockstore address; /* sctpAssocLocalAddrEntry 1/2 */
1222 struct sctp_timeval start_time; /* sctpAssocLocalAddrEntry 3 */
1223 uint32_t extra_padding[32]; /* future */
1226 struct xsctp_raddr {
1227 union sctp_sockstore address; /* sctpAssocLocalRemEntry 1/2 */
1229 uint32_t rto; /* sctpAssocLocalRemEntry 5 */
1230 uint32_t max_path_rtx; /* sctpAssocLocalRemEntry 6 */
1231 uint32_t rtx; /* sctpAssocLocalRemEntry 7 */
1232 uint32_t error_counter; /* */
1233 uint32_t cwnd; /* */
1234 uint32_t flight_size; /* */
1236 uint8_t active; /* sctpAssocLocalRemEntry 3 */
1237 uint8_t confirmed; /* */
1238 uint8_t heartbeat_enabled; /* sctpAssocLocalRemEntry 4 */
1239 uint8_t potentially_failed;
1240 struct sctp_timeval start_time; /* sctpAssocLocalRemEntry 8 */
1242 uint32_t heartbeat_interval;
1244 uint16_t encaps_port;
1246 uint32_t extra_padding[29]; /* future */
1249 #define SCTP_MAX_LOGGING_SIZE 30000
1250 #define SCTP_TRACE_PARAMS 6 /* This number MUST be even */
1252 struct sctp_log_entry {
1256 uint32_t params[SCTP_TRACE_PARAMS];
1260 struct sctp_log_entry entry[SCTP_MAX_LOGGING_SIZE];
1266 * Kernel defined for sctp_send
1268 #if defined(_KERNEL) || defined(__Userspace__)
1270 sctp_lower_sosend(struct socket *so,
1271 struct sockaddr *addr,
1274 struct mbuf *control,
1276 struct sctp_sndrcvinfo *srcv
1281 sctp_sorecvmsg(struct socket *so,
1284 struct sockaddr *from,
1287 struct sctp_sndrcvinfo *sinfo,
1294 #if !(defined(_KERNEL)) && !(defined(__Userspace__))
1297 int sctp_peeloff(int, sctp_assoc_t);
1298 int sctp_bindx(int, struct sockaddr *, int, int);
1299 int sctp_connectx(int, const struct sockaddr *, int, sctp_assoc_t *);
1300 int sctp_getaddrlen(sa_family_t);
1301 int sctp_getpaddrs(int, sctp_assoc_t, struct sockaddr **);
1302 void sctp_freepaddrs(struct sockaddr *);
1303 int sctp_getladdrs(int, sctp_assoc_t, struct sockaddr **);
1304 void sctp_freeladdrs(struct sockaddr *);
1305 int sctp_opt_info(int, sctp_assoc_t, int, void *, socklen_t *);
1309 sctp_sendmsg(int, const void *, size_t, const struct sockaddr *,
1310 socklen_t, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t);
1314 sctp_send(int, const void *, size_t,
1315 const struct sctp_sndrcvinfo *, int);
1319 sctp_sendx(int, const void *, size_t, struct sockaddr *,
1320 int, struct sctp_sndrcvinfo *, int);
1324 sctp_sendmsgx(int sd, const void *, size_t, struct sockaddr *,
1325 int, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t);
1327 sctp_assoc_t sctp_getassocid(int, struct sockaddr *);
1331 sctp_recvmsg(int, void *, size_t, struct sockaddr *, socklen_t *,
1332 struct sctp_sndrcvinfo *, int *);
1335 sctp_sendv(int, const struct iovec *, int, struct sockaddr *,
1336 int, void *, socklen_t, unsigned int, int);
1339 sctp_recvv(int, const struct iovec *, int, struct sockaddr *,
1340 socklen_t *, void *, socklen_t *, unsigned int *, int *);
1344 #endif /* !_KERNEL */
1345 #endif /* !__sctp_uio_h__ */