2 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
3 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
4 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * a) Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
12 * b) Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the distribution.
16 * c) Neither the name of Cisco Systems, Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGE.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #ifndef _NETINET_SCTP_UIO_H_
37 #define _NETINET_SCTP_UIO_H_
40 #if ! defined(_KERNEL)
43 #include <sys/types.h>
44 #include <sys/socket.h>
45 #include <netinet/in.h>
47 typedef uint32_t sctp_assoc_t;
49 #define SCTP_FUTURE_ASSOC 0
50 #define SCTP_CURRENT_ASSOC 1
51 #define SCTP_ALL_ASSOC 2
54 sctp_assoc_t se_assoc_id;
59 /* Compatibility to previous define's */
60 #define sctp_stream_reset_events sctp_stream_reset_event
62 /* On/Off setup for subscription to events */
63 struct sctp_event_subscribe {
64 uint8_t sctp_data_io_event;
65 uint8_t sctp_association_event;
66 uint8_t sctp_address_event;
67 uint8_t sctp_send_failure_event;
68 uint8_t sctp_peer_error_event;
69 uint8_t sctp_shutdown_event;
70 uint8_t sctp_partial_delivery_event;
71 uint8_t sctp_adaptation_layer_event;
72 uint8_t sctp_authentication_event;
73 uint8_t sctp_sender_dry_event;
74 uint8_t sctp_stream_reset_event;
77 /* ancillary data types */
78 #define SCTP_INIT 0x0001
79 #define SCTP_SNDRCV 0x0002
80 #define SCTP_EXTRCV 0x0003
81 #define SCTP_SNDINFO 0x0004
82 #define SCTP_RCVINFO 0x0005
83 #define SCTP_NXTINFO 0x0006
84 #define SCTP_PRINFO 0x0007
85 #define SCTP_AUTHINFO 0x0008
86 #define SCTP_DSTADDRV4 0x0009
87 #define SCTP_DSTADDRV6 0x000a
90 * ancillary data structures
93 uint16_t sinit_num_ostreams;
94 uint16_t sinit_max_instreams;
95 uint16_t sinit_max_attempts;
96 uint16_t sinit_max_init_timeo;
99 /* We add 96 bytes to the size of sctp_sndrcvinfo.
100 * This makes the current structure 128 bytes long
101 * which is nicely 64 bit aligned but also has room
102 * for us to add more and keep ABI compatibility.
103 * For example, already we have the sctp_extrcvinfo
104 * when enabled which is 48 bytes.
108 * The assoc up needs a verfid
109 * all sendrcvinfo's need a verfid for SENDING only.
113 #define SCTP_ALIGN_RESV_PAD 92
114 #define SCTP_ALIGN_RESV_PAD_SHORT 76
116 struct sctp_sndrcvinfo {
117 uint16_t sinfo_stream;
119 uint16_t sinfo_flags;
121 uint32_t sinfo_context;
122 uint32_t sinfo_timetolive;
124 uint32_t sinfo_cumtsn;
125 sctp_assoc_t sinfo_assoc_id;
126 uint16_t sinfo_keynumber;
127 uint16_t sinfo_keynumber_valid;
128 uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD];
131 struct sctp_extrcvinfo {
132 uint16_t sinfo_stream;
134 uint16_t sinfo_flags;
136 uint32_t sinfo_context;
137 uint32_t sinfo_timetolive; /* 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];
151 #define sinfo_pr_value sinfo_timetolive
152 #define sreinfo_next_flags serinfo_next_flags
153 #define sreinfo_next_stream serinfo_next_stream
154 #define sreinfo_next_aid serinfo_next_aid
155 #define sreinfo_next_length serinfo_next_length
156 #define sreinfo_next_ppid serinfo_next_ppid
158 struct sctp_sndinfo {
162 uint32_t snd_context;
163 sctp_assoc_t snd_assoc_id;
171 struct sctp_default_prinfo {
174 sctp_assoc_t pr_assoc_id;
177 struct sctp_authinfo {
178 uint16_t auth_keynumber;
181 struct sctp_rcvinfo {
188 uint32_t rcv_context;
189 sctp_assoc_t rcv_assoc_id;
192 struct sctp_nxtinfo {
197 sctp_assoc_t nxt_assoc_id;
200 #define SCTP_NO_NEXT_MSG 0x0000
201 #define SCTP_NEXT_MSG_AVAIL 0x0001
202 #define SCTP_NEXT_MSG_ISCOMPLETE 0x0002
203 #define SCTP_NEXT_MSG_IS_UNORDERED 0x0004
204 #define SCTP_NEXT_MSG_IS_NOTIFICATION 0x0008
206 struct sctp_recvv_rn {
207 struct sctp_rcvinfo recvv_rcvinfo;
208 struct sctp_nxtinfo recvv_nxtinfo;
211 #define SCTP_RECVV_NOINFO 0
212 #define SCTP_RECVV_RCVINFO 1
213 #define SCTP_RECVV_NXTINFO 2
214 #define SCTP_RECVV_RN 3
216 #define SCTP_SENDV_NOINFO 0
217 #define SCTP_SENDV_SNDINFO 1
218 #define SCTP_SENDV_PRINFO 2
219 #define SCTP_SENDV_AUTHINFO 3
220 #define SCTP_SENDV_SPA 4
222 struct sctp_sendv_spa {
223 uint32_t sendv_flags;
224 struct sctp_sndinfo sendv_sndinfo;
225 struct sctp_prinfo sendv_prinfo;
226 struct sctp_authinfo sendv_authinfo;
229 #define SCTP_SEND_SNDINFO_VALID 0x00000001
230 #define SCTP_SEND_PRINFO_VALID 0x00000002
231 #define SCTP_SEND_AUTHINFO_VALID 0x00000004
233 struct sctp_snd_all_completes {
234 uint16_t sall_stream;
237 uint32_t sall_context;
238 uint32_t sall_num_sent;
239 uint32_t sall_num_failed;
242 /* Flags that go into the sinfo->sinfo_flags field */
243 #define SCTP_NOTIFICATION 0x0010 /* next message is a notification */
244 #define SCTP_COMPLETE 0x0020 /* next message is complete */
245 #define SCTP_EOF 0x0100 /* Start shutdown procedures */
246 #define SCTP_ABORT 0x0200 /* Send an ABORT to peer */
247 #define SCTP_UNORDERED 0x0400 /* Message is un-ordered */
248 #define SCTP_ADDR_OVER 0x0800 /* Override the primary-address */
249 #define SCTP_SENDALL 0x1000 /* Send this on all associations */
250 #define SCTP_EOR 0x2000 /* end of message signal */
251 #define SCTP_SACK_IMMEDIATELY 0x4000 /* Set I-Bit */
253 #define INVALID_SINFO_FLAG(x) (((x) & 0xfffffff0 \
254 & ~(SCTP_EOF | SCTP_ABORT | SCTP_UNORDERED |\
255 SCTP_ADDR_OVER | SCTP_SENDALL | SCTP_EOR |\
256 SCTP_SACK_IMMEDIATELY)) != 0)
257 /* for the endpoint */
259 /* The lower four bits is an enumeration of PR-SCTP policies */
260 #define SCTP_PR_SCTP_NONE 0x0000/* Reliable transfer */
261 #define SCTP_PR_SCTP_TTL 0x0001/* Time based PR-SCTP */
262 #define SCTP_PR_SCTP_BUF 0x0002/* Buffer based PR-SCTP */
263 #define SCTP_PR_SCTP_RTX 0x0003/* Number of retransmissions based PR-SCTP */
264 #define SCTP_PR_SCTP_MAX SCTP_PR_SCTP_RTX
265 #define SCTP_PR_SCTP_ALL 0x000f/* Used for aggregated stats */
267 #define PR_SCTP_POLICY(x) ((x) & 0x0f)
268 #define PR_SCTP_ENABLED(x) ((PR_SCTP_POLICY(x) != SCTP_PR_SCTP_NONE) && \
269 (PR_SCTP_POLICY(x) != SCTP_PR_SCTP_ALL))
270 #define PR_SCTP_TTL_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_TTL)
271 #define PR_SCTP_BUF_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_BUF)
272 #define PR_SCTP_RTX_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_RTX)
273 #define PR_SCTP_INVALID_POLICY(x) (PR_SCTP_POLICY(x) > SCTP_PR_SCTP_MAX)
274 #define PR_SCTP_VALID_POLICY(x) (PR_SCTP_POLICY(x) <= SCTP_PR_SCTP_MAX)
277 struct sctp_pcbinfo {
280 uint32_t laddr_count;
281 uint32_t raddr_count;
283 uint32_t readq_count;
284 uint32_t free_chunks;
285 uint32_t stream_oque;
288 struct sctp_sockstat {
289 sctp_assoc_t ss_assoc_id;
290 uint32_t ss_total_sndbuf;
291 uint32_t ss_total_recv_buf;
295 * notification event structures
299 * association change event
301 struct sctp_assoc_change {
307 uint16_t sac_outbound_streams;
308 uint16_t sac_inbound_streams;
309 sctp_assoc_t sac_assoc_id;
313 /* sac_state values */
314 #define SCTP_COMM_UP 0x0001
315 #define SCTP_COMM_LOST 0x0002
316 #define SCTP_RESTART 0x0003
317 #define SCTP_SHUTDOWN_COMP 0x0004
318 #define SCTP_CANT_STR_ASSOC 0x0005
320 /* sac_info values */
321 #define SCTP_ASSOC_SUPPORTS_PR 0x01
322 #define SCTP_ASSOC_SUPPORTS_AUTH 0x02
323 #define SCTP_ASSOC_SUPPORTS_ASCONF 0x03
324 #define SCTP_ASSOC_SUPPORTS_MULTIBUF 0x04
325 #define SCTP_ASSOC_SUPPORTS_RE_CONFIG 0x05
326 #define SCTP_ASSOC_SUPPORTS_INTERLEAVING 0x06
327 #define SCTP_ASSOC_SUPPORTS_MAX 0x06
331 struct sctp_paddr_change {
335 struct sockaddr_storage spc_aaddr;
338 sctp_assoc_t spc_assoc_id;
341 /* paddr state values */
342 #define SCTP_ADDR_AVAILABLE 0x0001
343 #define SCTP_ADDR_UNREACHABLE 0x0002
344 #define SCTP_ADDR_REMOVED 0x0003
345 #define SCTP_ADDR_ADDED 0x0004
346 #define SCTP_ADDR_MADE_PRIM 0x0005
347 #define SCTP_ADDR_CONFIRMED 0x0006
349 #define SCTP_ACTIVE 0x0001 /* SCTP_ADDR_REACHABLE */
350 #define SCTP_INACTIVE 0x0002 /* neither SCTP_ADDR_REACHABLE nor
351 * SCTP_ADDR_UNCONFIRMED */
352 #define SCTP_UNCONFIRMED 0x0200 /* SCTP_ADDR_UNCONFIRMED */
354 /* remote error events */
355 struct sctp_remote_error {
360 sctp_assoc_t sre_assoc_id;
364 /* data send failure event (deprecated) */
365 struct sctp_send_failed {
370 struct sctp_sndrcvinfo ssf_info;
371 sctp_assoc_t ssf_assoc_id;
375 /* data send failure event (not deprecated) */
376 struct sctp_send_failed_event {
379 uint32_t ssfe_length;
381 struct sctp_sndinfo ssfe_info;
382 sctp_assoc_t ssfe_assoc_id;
386 /* flag that indicates state of data */
387 #define SCTP_DATA_UNSENT 0x0001 /* inqueue never on wire */
388 #define SCTP_DATA_SENT 0x0002 /* on wire at failure */
391 struct sctp_shutdown_event {
395 sctp_assoc_t sse_assoc_id;
398 /* Adaptation layer indication stuff */
399 struct sctp_adaptation_event {
403 uint32_t sai_adaptation_ind;
404 sctp_assoc_t sai_assoc_id;
407 struct sctp_setadaptation {
408 uint32_t ssb_adaptation_ind;
411 /* compatible old spelling */
412 struct sctp_adaption_event {
416 uint32_t sai_adaption_ind;
417 sctp_assoc_t sai_assoc_id;
420 struct sctp_setadaption {
421 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
443 * authentication key event
445 struct sctp_authkey_event {
448 uint32_t auth_length;
449 uint16_t auth_keynumber;
450 uint16_t auth_altkeynumber;
451 uint32_t auth_indication;
452 sctp_assoc_t auth_assoc_id;
455 /* indication values */
456 #define SCTP_AUTH_NEW_KEY 0x0001
457 #define SCTP_AUTH_NEWKEY SCTP_AUTH_NEW_KEY
458 #define SCTP_AUTH_NO_AUTH 0x0002
459 #define SCTP_AUTH_FREE_KEY 0x0003
462 struct sctp_sender_dry_event {
463 uint16_t sender_dry_type;
464 uint16_t sender_dry_flags;
465 uint32_t sender_dry_length;
466 sctp_assoc_t sender_dry_assoc_id;
471 * Stream reset event - subscribe to SCTP_STREAM_RESET_EVENT
473 struct sctp_stream_reset_event {
474 uint16_t strreset_type;
475 uint16_t strreset_flags;
476 uint32_t strreset_length;
477 sctp_assoc_t strreset_assoc_id;
478 uint16_t strreset_stream_list[];
481 /* flags in stream_reset_event (strreset_flags) */
482 #define SCTP_STREAM_RESET_INCOMING_SSN 0x0001
483 #define SCTP_STREAM_RESET_OUTGOING_SSN 0x0002
484 #define SCTP_STREAM_RESET_DENIED 0x0004
485 #define SCTP_STREAM_RESET_FAILED 0x0008
488 * Assoc reset event - subscribe to SCTP_ASSOC_RESET_EVENT
490 struct sctp_assoc_reset_event {
491 uint16_t assocreset_type;
492 uint16_t assocreset_flags;
493 uint32_t assocreset_length;
494 sctp_assoc_t assocreset_assoc_id;
495 uint32_t assocreset_local_tsn;
496 uint32_t assocreset_remote_tsn;
499 #define SCTP_ASSOC_RESET_DENIED 0x0004
500 #define SCTP_ASSOC_RESET_FAILED 0x0008
503 * Stream change event - subscribe to SCTP_STREAM_CHANGE_EVENT
505 struct sctp_stream_change_event {
506 uint16_t strchange_type;
507 uint16_t strchange_flags;
508 uint32_t strchange_length;
509 sctp_assoc_t strchange_assoc_id;
510 uint16_t strchange_instrms;
511 uint16_t strchange_outstrms;
514 #define SCTP_STREAM_CHANGE_DENIED 0x0004
515 #define SCTP_STREAM_CHANGE_FAILED 0x0008
518 /* SCTP notification event */
525 union sctp_notification {
526 struct sctp_tlv sn_header;
527 struct sctp_assoc_change sn_assoc_change;
528 struct sctp_paddr_change sn_paddr_change;
529 struct sctp_remote_error sn_remote_error;
530 struct sctp_send_failed sn_send_failed;
531 struct sctp_shutdown_event sn_shutdown_event;
532 struct sctp_adaptation_event sn_adaptation_event;
533 /* compatibility same as above */
534 struct sctp_adaption_event sn_adaption_event;
535 struct sctp_pdapi_event sn_pdapi_event;
536 struct sctp_authkey_event sn_auth_event;
537 struct sctp_sender_dry_event sn_sender_dry_event;
538 struct sctp_send_failed_event sn_send_failed_event;
539 struct sctp_stream_reset_event sn_strreset_event;
540 struct sctp_assoc_reset_event sn_assocreset_event;
541 struct sctp_stream_change_event sn_strchange_event;
544 /* notification types */
545 #define SCTP_ASSOC_CHANGE 0x0001
546 #define SCTP_PEER_ADDR_CHANGE 0x0002
547 #define SCTP_REMOTE_ERROR 0x0003
548 #define SCTP_SEND_FAILED 0x0004
549 #define SCTP_SHUTDOWN_EVENT 0x0005
550 #define SCTP_ADAPTATION_INDICATION 0x0006
552 #define SCTP_ADAPTION_INDICATION 0x0006
553 #define SCTP_PARTIAL_DELIVERY_EVENT 0x0007
554 #define SCTP_AUTHENTICATION_EVENT 0x0008
555 #define SCTP_STREAM_RESET_EVENT 0x0009
556 #define SCTP_SENDER_DRY_EVENT 0x000a
557 #define SCTP_NOTIFICATIONS_STOPPED_EVENT 0x000b /* we don't send this */
558 #define SCTP_ASSOC_RESET_EVENT 0x000c
559 #define SCTP_STREAM_CHANGE_EVENT 0x000d
560 #define SCTP_SEND_FAILED_EVENT 0x000e
562 * socket option structs
565 struct sctp_paddrparams {
566 struct sockaddr_storage spp_address;
567 sctp_assoc_t spp_assoc_id;
568 uint32_t spp_hbinterval;
569 uint32_t spp_pathmtu;
571 uint32_t spp_ipv6_flowlabel;
572 uint16_t spp_pathmaxrxt;
576 #define spp_ipv4_tos spp_dscp
578 #define SPP_HB_ENABLE 0x00000001
579 #define SPP_HB_DISABLE 0x00000002
580 #define SPP_HB_DEMAND 0x00000004
581 #define SPP_PMTUD_ENABLE 0x00000008
582 #define SPP_PMTUD_DISABLE 0x00000010
583 #define SPP_HB_TIME_IS_ZERO 0x00000080
584 #define SPP_IPV6_FLOWLABEL 0x00000100
585 #define SPP_DSCP 0x00000200
586 #define SPP_IPV4_TOS SPP_DSCP
588 struct sctp_paddrthlds {
589 struct sockaddr_storage spt_address;
590 sctp_assoc_t spt_assoc_id;
591 uint16_t spt_pathmaxrxt;
592 uint16_t spt_pathpfthld;
595 struct sctp_paddrinfo {
596 struct sockaddr_storage spinfo_address;
597 sctp_assoc_t spinfo_assoc_id;
598 int32_t spinfo_state;
599 uint32_t spinfo_cwnd;
600 uint32_t spinfo_srtt;
605 struct sctp_rtoinfo {
606 sctp_assoc_t srto_assoc_id;
607 uint32_t srto_initial;
612 struct sctp_assocparams {
613 sctp_assoc_t sasoc_assoc_id;
614 uint32_t sasoc_peer_rwnd;
615 uint32_t sasoc_local_rwnd;
616 uint32_t sasoc_cookie_life;
617 uint16_t sasoc_asocmaxrxt;
618 uint16_t sasoc_number_peer_destinations;
621 struct sctp_setprim {
622 struct sockaddr_storage ssp_addr;
623 sctp_assoc_t ssp_assoc_id;
624 uint8_t ssp_padding[4];
627 struct sctp_setpeerprim {
628 struct sockaddr_storage sspp_addr;
629 sctp_assoc_t sspp_assoc_id;
630 uint8_t sspp_padding[4];
633 struct sctp_getaddresses {
634 sctp_assoc_t sget_assoc_id;
635 /* addr is filled in for N * sockaddr_storage */
636 struct sockaddr addr[1];
640 sctp_assoc_t sstat_assoc_id;
643 uint16_t sstat_unackdata;
644 uint16_t sstat_penddata;
645 uint16_t sstat_instrms;
646 uint16_t sstat_outstrms;
647 uint32_t sstat_fragmentation_point;
648 struct sctp_paddrinfo sstat_primary;
652 * AUTHENTICATION support
654 /* SCTP_AUTH_CHUNK */
655 struct sctp_authchunk {
660 struct sctp_authkey {
661 sctp_assoc_t sca_assoc_id;
662 uint16_t sca_keynumber;
663 uint16_t sca_keylength;
667 /* SCTP_HMAC_IDENT */
668 struct sctp_hmacalgo {
669 uint32_t shmac_number_of_idents;
670 uint16_t shmac_idents[];
674 #define SCTP_AUTH_HMAC_ID_RSVD 0x0000
675 #define SCTP_AUTH_HMAC_ID_SHA1 0x0001 /* default, mandatory */
676 #define SCTP_AUTH_HMAC_ID_SHA256 0x0003
678 /* SCTP_AUTH_ACTIVE_KEY / SCTP_AUTH_DELETE_KEY */
679 struct sctp_authkeyid {
680 sctp_assoc_t scact_assoc_id;
681 uint16_t scact_keynumber;
684 /* SCTP_PEER_AUTH_CHUNKS / SCTP_LOCAL_AUTH_CHUNKS */
685 struct sctp_authchunks {
686 sctp_assoc_t gauth_assoc_id;
687 uint32_t gauth_number_of_chunks;
688 uint8_t gauth_chunks[];
691 struct sctp_assoc_value {
692 sctp_assoc_t assoc_id;
693 uint32_t assoc_value;
696 struct sctp_cc_option {
698 struct sctp_assoc_value aid_value;
701 struct sctp_stream_value {
702 sctp_assoc_t assoc_id;
704 uint16_t stream_value;
707 struct sctp_assoc_ids {
708 uint32_t gaids_number_of_ids;
709 sctp_assoc_t gaids_assoc_id[];
712 struct sctp_sack_info {
713 sctp_assoc_t sack_assoc_id;
718 struct sctp_timeouts {
719 sctp_assoc_t stimo_assoc_id;
723 uint32_t stimo_shutdown;
724 uint32_t stimo_heartbeat;
725 uint32_t stimo_cookie;
726 uint32_t stimo_shutdownack;
729 struct sctp_udpencaps {
730 struct sockaddr_storage sue_address;
731 sctp_assoc_t sue_assoc_id;
735 struct sctp_prstatus {
736 sctp_assoc_t sprstat_assoc_id;
737 uint16_t sprstat_sid;
738 uint16_t sprstat_policy;
739 uint64_t sprstat_abandoned_unsent;
740 uint64_t sprstat_abandoned_sent;
743 struct sctp_cwnd_args {
744 struct sctp_nets *net; /* network to *//* FIXME: LP64 issue */
745 uint32_t cwnd_new_value;/* cwnd in k */
746 uint32_t pseudo_cumack;
747 uint16_t inflight; /* flightsize in k */
748 uint16_t cwnd_augment; /* increment to it */
749 uint8_t meets_pseudo_cumack;
750 uint8_t need_new_pseudo_cumack;
755 struct sctp_blk_args {
756 uint32_t onsb; /* in 1k bytes */
757 uint32_t sndlen; /* len of send being attempted */
758 uint32_t peer_rwnd; /* rwnd of peer */
759 uint16_t send_sent_qcnt;/* chnk cnt */
760 uint16_t stream_qcnt; /* chnk cnt */
761 uint16_t chunks_on_oque;/* chunks out */
762 uint16_t flight_size; /* flight size in k */
766 * Max we can reset in one setting, note this is dictated not by the define
767 * but the size of a mbuf cluster so don't change this define and think you
768 * can specify more. You must do multiple resets if you want to reset more
769 * than SCTP_MAX_EXPLICIT_STR_RESET.
771 #define SCTP_MAX_EXPLICT_STR_RESET 1000
773 struct sctp_reset_streams {
774 sctp_assoc_t srs_assoc_id;
776 uint16_t srs_number_streams; /* 0 == ALL */
777 uint16_t srs_stream_list[]; /* list if strrst_num_streams is not 0 */
780 struct sctp_add_streams {
781 sctp_assoc_t sas_assoc_id;
782 uint16_t sas_instrms;
783 uint16_t sas_outstrms;
786 struct sctp_get_nonce_values {
787 sctp_assoc_t gn_assoc_id;
788 uint32_t gn_peers_tag;
789 uint32_t gn_local_tag;
793 struct sctp_str_log {
794 void *stcb; /* FIXME: LP64 issue */
803 void *stcb; /* FIXME: LP64 issue */
810 uint32_t largest_tsn;
811 uint32_t largest_new_tsn;
821 struct sctp_rwnd_log {
828 struct sctp_mbcnt_log {
829 uint32_t total_queue_size;
830 uint32_t size_change;
831 uint32_t total_queue_mb_size;
832 uint32_t mbcnt_change;
835 struct sctp_sack_log {
843 struct sctp_lock_log {
844 void *sock; /* FIXME: LP64 issue */
845 void *inp; /* FIXME: LP64 issue */
850 uint8_t sockrcvbuf_lock;
851 uint8_t socksndbuf_lock;
856 struct sctp_rto_log {
857 void *net; /* FIXME: LP64 issue */
861 struct sctp_nagle_log {
862 void *stcb; /* FIXME: LP64 issue */
863 uint32_t total_flight;
864 uint32_t total_in_queue;
865 uint16_t count_in_queue;
866 uint16_t count_in_flight;
869 struct sctp_sbwake_log {
870 void *stcb; /* FIXME: LP64 issue */
875 uint8_t stream_qcnt; /* chnk cnt */
876 uint8_t chunks_on_oque; /* chunks out */
881 struct sctp_misc_info {
888 struct sctp_log_closing {
889 void *inp; /* FIXME: LP64 issue */
890 void *stcb; /* FIXME: LP64 issue */
896 struct sctp_mbuf_log {
897 struct mbuf *mp; /* FIXME: LP64 issue */
905 struct sctp_cwnd_log {
911 struct sctp_log_closing close;
912 struct sctp_blk_args blk;
913 struct sctp_cwnd_args cwnd;
914 struct sctp_str_log strlog;
915 struct sctp_fr_log fr;
916 struct sctp_fr_map map;
917 struct sctp_rwnd_log rwnd;
918 struct sctp_mbcnt_log mbcnt;
919 struct sctp_sack_log sack;
920 struct sctp_lock_log lock;
921 struct sctp_rto_log rto;
922 struct sctp_sb_log sb;
923 struct sctp_nagle_log nagle;
924 struct sctp_sbwake_log wake;
925 struct sctp_mbuf_log mb;
926 struct sctp_misc_info misc;
930 struct sctp_cwnd_log_req {
931 int32_t num_in_log; /* Number in log */
932 int32_t num_ret; /* Number returned */
933 int32_t start_at; /* start at this one */
934 int32_t end_at; /* end at this one */
935 struct sctp_cwnd_log log[];
938 struct sctp_timeval {
944 struct sctp_timeval sctps_discontinuitytime; /* sctpStats 18
946 /* MIB according to RFC 3873 */
947 uint32_t sctps_currestab; /* sctpStats 1 (Gauge32) */
948 uint32_t sctps_activeestab; /* sctpStats 2 (Counter32) */
949 uint32_t sctps_restartestab;
950 uint32_t sctps_collisionestab;
951 uint32_t sctps_passiveestab; /* sctpStats 3 (Counter32) */
952 uint32_t sctps_aborted; /* sctpStats 4 (Counter32) */
953 uint32_t sctps_shutdown;/* sctpStats 5 (Counter32) */
954 uint32_t sctps_outoftheblue; /* sctpStats 6 (Counter32) */
955 uint32_t sctps_checksumerrors; /* sctpStats 7 (Counter32) */
956 uint32_t sctps_outcontrolchunks; /* sctpStats 8 (Counter64) */
957 uint32_t sctps_outorderchunks; /* sctpStats 9 (Counter64) */
958 uint32_t sctps_outunorderchunks; /* sctpStats 10 (Counter64) */
959 uint32_t sctps_incontrolchunks; /* sctpStats 11 (Counter64) */
960 uint32_t sctps_inorderchunks; /* sctpStats 12 (Counter64) */
961 uint32_t sctps_inunorderchunks; /* sctpStats 13 (Counter64) */
962 uint32_t sctps_fragusrmsgs; /* sctpStats 14 (Counter64) */
963 uint32_t sctps_reasmusrmsgs; /* sctpStats 15 (Counter64) */
964 uint32_t sctps_outpackets; /* sctpStats 16 (Counter64) */
965 uint32_t sctps_inpackets; /* sctpStats 17 (Counter64) */
967 /* input statistics: */
968 uint32_t sctps_recvpackets; /* total input packets */
969 uint32_t sctps_recvdatagrams; /* total input datagrams */
970 uint32_t sctps_recvpktwithdata; /* total packets that had data */
971 uint32_t sctps_recvsacks; /* total input SACK chunks */
972 uint32_t sctps_recvdata;/* total input DATA chunks */
973 uint32_t sctps_recvdupdata; /* total input duplicate DATA chunks */
974 uint32_t sctps_recvheartbeat; /* total input HB chunks */
975 uint32_t sctps_recvheartbeatack; /* total input HB-ACK chunks */
976 uint32_t sctps_recvecne;/* total input ECNE chunks */
977 uint32_t sctps_recvauth;/* total input AUTH chunks */
978 uint32_t sctps_recvauthmissing; /* total input chunks missing AUTH */
979 uint32_t sctps_recvivalhmacid; /* total number of invalid HMAC ids
981 uint32_t sctps_recvivalkeyid; /* total number of invalid secret ids
983 uint32_t sctps_recvauthfailed; /* total number of auth failed */
984 uint32_t sctps_recvexpress; /* total fast path receives all one
986 uint32_t sctps_recvexpressm; /* total fast path multi-part data */
987 uint32_t sctps_recvnocrc;
988 uint32_t sctps_recvswcrc;
989 uint32_t sctps_recvhwcrc;
991 /* output statistics: */
992 uint32_t sctps_sendpackets; /* total output packets */
993 uint32_t sctps_sendsacks; /* total output SACKs */
994 uint32_t sctps_senddata;/* total output DATA chunks */
995 uint32_t sctps_sendretransdata; /* total output retransmitted DATA
997 uint32_t sctps_sendfastretrans; /* total output fast retransmitted
999 uint32_t sctps_sendmultfastretrans; /* total FR's that happened
1000 * more than once to same
1001 * chunk (u-del multi-fr
1003 uint32_t sctps_sendheartbeat; /* total output HB chunks */
1004 uint32_t sctps_sendecne;/* total output ECNE chunks */
1005 uint32_t sctps_sendauth;/* total output AUTH chunks FIXME */
1006 uint32_t sctps_senderrors; /* ip_output error counter */
1007 uint32_t sctps_sendnocrc;
1008 uint32_t sctps_sendswcrc;
1009 uint32_t sctps_sendhwcrc;
1010 /* PCKDROPREP statistics: */
1011 uint32_t sctps_pdrpfmbox; /* Packet drop from middle box */
1012 uint32_t sctps_pdrpfehos; /* P-drop from end host */
1013 uint32_t sctps_pdrpmbda;/* P-drops with data */
1014 uint32_t sctps_pdrpmbct;/* P-drops, non-data, non-endhost */
1015 uint32_t sctps_pdrpbwrpt; /* P-drop, non-endhost, bandwidth rep
1017 uint32_t sctps_pdrpcrupt; /* P-drop, not enough for chunk header */
1018 uint32_t sctps_pdrpnedat; /* P-drop, not enough data to confirm */
1019 uint32_t sctps_pdrppdbrk; /* P-drop, where process_chunk_drop
1021 uint32_t sctps_pdrptsnnf; /* P-drop, could not find TSN */
1022 uint32_t sctps_pdrpdnfnd; /* P-drop, attempt reverse TSN lookup */
1023 uint32_t sctps_pdrpdiwnp; /* P-drop, e-host confirms zero-rwnd */
1024 uint32_t sctps_pdrpdizrw; /* P-drop, midbox confirms no space */
1025 uint32_t sctps_pdrpbadd;/* P-drop, data did not match TSN */
1026 uint32_t sctps_pdrpmark;/* P-drop, TSN's marked for Fast Retran */
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(__FreeBSD__) && 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 union sctp_sockstore {
1143 struct sockaddr_in sin;
1144 struct sockaddr_in6 sin6;
1149 /***********************************/
1150 /* And something for us old timers */
1151 /***********************************/
1154 #include <sys/endian.h>
1155 #define ntohll(x) be64toh(x)
1159 #include <sys/endian.h>
1160 #define htonll(x) htobe64(x)
1162 /***********************************/
1165 struct xsctp_inpcb {
1169 uint32_t total_sends;
1170 uint32_t total_recvs;
1171 uint32_t total_nospaces;
1172 uint32_t fragmentation_point;
1173 uint16_t local_port;
1175 uint16_t maxqlen_old;
1179 #if defined(__LP64__)
1180 uint32_t extra_padding[27]; /* future */
1182 uint32_t extra_padding[28]; /* future */
1187 union sctp_sockstore primary_addr; /* sctpAssocEntry 5/6 */
1189 uint32_t heartbeat_interval; /* sctpAssocEntry 7 */
1190 uint32_t state; /* sctpAssocEntry 8 */
1191 uint32_t in_streams; /* sctpAssocEntry 9 */
1192 uint32_t out_streams; /* sctpAssocEntry 10 */
1193 uint32_t max_nr_retrans;/* sctpAssocEntry 11 */
1194 uint32_t primary_process; /* sctpAssocEntry 12 */
1195 uint32_t T1_expireries; /* sctpAssocEntry 13 */
1196 uint32_t T2_expireries; /* sctpAssocEntry 14 */
1197 uint32_t retransmitted_tsns; /* sctpAssocEntry 15 */
1198 uint32_t total_sends;
1199 uint32_t total_recvs;
1201 uint32_t remote_tag;
1202 uint32_t initial_tsn;
1203 uint32_t highest_tsn;
1204 uint32_t cumulative_tsn;
1205 uint32_t cumulative_tsn_ack;
1208 uint16_t local_port; /* sctpAssocEntry 3 */
1209 uint16_t remote_port; /* sctpAssocEntry 4 */
1210 struct sctp_timeval start_time; /* sctpAssocEntry 16 */
1211 struct sctp_timeval discontinuity_time; /* sctpAssocEntry 17 */
1212 uint32_t peers_rwnd;
1213 sctp_assoc_t assoc_id; /* sctpAssocEntry 1 */
1214 uint32_t extra_padding[32]; /* future */
1217 struct xsctp_laddr {
1218 union sctp_sockstore address; /* sctpAssocLocalAddrEntry 1/2 */
1220 struct sctp_timeval start_time; /* sctpAssocLocalAddrEntry 3 */
1221 uint32_t extra_padding[32]; /* future */
1224 struct xsctp_raddr {
1225 union sctp_sockstore address; /* sctpAssocLocalRemEntry 1/2 */
1227 uint32_t rto; /* sctpAssocLocalRemEntry 5 */
1228 uint32_t max_path_rtx; /* sctpAssocLocalRemEntry 6 */
1229 uint32_t rtx; /* sctpAssocLocalRemEntry 7 */
1230 uint32_t error_counter; /* */
1231 uint32_t cwnd; /* */
1232 uint32_t flight_size; /* */
1234 uint8_t active; /* sctpAssocLocalRemEntry 3 */
1235 uint8_t confirmed; /* */
1236 uint8_t heartbeat_enabled; /* sctpAssocLocalRemEntry 4 */
1237 uint8_t potentially_failed;
1238 struct sctp_timeval start_time; /* sctpAssocLocalRemEntry 8 */
1240 uint32_t heartbeat_interval;
1242 uint32_t extra_padding[30]; /* future */
1245 #define SCTP_MAX_LOGGING_SIZE 30000
1246 #define SCTP_TRACE_PARAMS 6 /* This number MUST be even */
1248 struct sctp_log_entry {
1252 uint32_t params[SCTP_TRACE_PARAMS];
1256 struct sctp_log_entry entry[SCTP_MAX_LOGGING_SIZE];
1262 * Kernel defined for sctp_send
1264 #if defined(_KERNEL) || defined(__Userspace__)
1266 sctp_lower_sosend(struct socket *so,
1267 struct sockaddr *addr,
1270 struct mbuf *control,
1272 struct sctp_sndrcvinfo *srcv
1277 sctp_sorecvmsg(struct socket *so,
1280 struct sockaddr *from,
1283 struct sctp_sndrcvinfo *sinfo,
1291 #if !(defined(_KERNEL)) && !(defined(__Userspace__))
1294 int sctp_peeloff(int, sctp_assoc_t);
1295 int sctp_bindx(int, struct sockaddr *, int, int);
1296 int sctp_connectx(int, const struct sockaddr *, int, sctp_assoc_t *);
1297 int sctp_getaddrlen(sa_family_t);
1298 int sctp_getpaddrs(int, sctp_assoc_t, struct sockaddr **);
1299 void sctp_freepaddrs(struct sockaddr *);
1300 int sctp_getladdrs(int, sctp_assoc_t, struct sockaddr **);
1301 void sctp_freeladdrs(struct sockaddr *);
1302 int sctp_opt_info(int, sctp_assoc_t, int, void *, socklen_t *);
1306 sctp_sendmsg(int, const void *, size_t, const struct sockaddr *,
1307 socklen_t, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t);
1311 sctp_send(int, const void *, size_t,
1312 const struct sctp_sndrcvinfo *, int);
1316 sctp_sendx(int, const void *, size_t, struct sockaddr *,
1317 int, struct sctp_sndrcvinfo *, int);
1321 sctp_sendmsgx(int sd, const void *, size_t, struct sockaddr *,
1322 int, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t);
1324 sctp_assoc_t sctp_getassocid(int, struct sockaddr *);
1328 sctp_recvmsg(int, void *, size_t, struct sockaddr *, socklen_t *,
1329 struct sctp_sndrcvinfo *, int *);
1332 sctp_sendv(int, const struct iovec *, int, struct sockaddr *,
1333 int, void *, socklen_t, unsigned int, int);
1336 sctp_recvv(int, const struct iovec *, int, struct sockaddr *,
1337 socklen_t *, void *, socklen_t *, unsigned int *, int *);
1341 #endif /* !_KERNEL */
1342 #endif /* !__sctp_uio_h__ */