2 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
3 * Copyright (c) 2008-2011, by Randall Stewart. All rights reserved.
4 * Copyright (c) 2008-2011, 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 /* $KAME: sctp_uio.h,v 1.11 2005/03/06 16:04:18 itojun Exp $ */
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #ifndef __sctp_uio_h__
38 #define __sctp_uio_h__
41 #if ! defined(_KERNEL)
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.
114 #define SCTP_ALIGN_RESV_PAD 92
115 #define SCTP_ALIGN_RESV_PAD_SHORT 76
117 struct sctp_sndrcvinfo {
118 uint16_t sinfo_stream;
120 uint16_t sinfo_flags;
122 uint32_t sinfo_context;
123 uint32_t sinfo_timetolive;
125 uint32_t sinfo_cumtsn;
126 sctp_assoc_t sinfo_assoc_id;
127 uint16_t sinfo_keynumber;
128 uint16_t sinfo_keynumber_valid;
129 uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD];
132 struct sctp_extrcvinfo {
133 uint16_t sinfo_stream;
135 uint16_t sinfo_flags;
137 uint32_t sinfo_context;
138 uint32_t sinfo_timetolive;
140 uint32_t sinfo_cumtsn;
141 sctp_assoc_t sinfo_assoc_id;
142 uint16_t sreinfo_next_flags;
143 uint16_t sreinfo_next_stream;
144 uint32_t sreinfo_next_aid;
145 uint32_t sreinfo_next_length;
146 uint32_t sreinfo_next_ppid;
147 uint16_t sinfo_keynumber;
148 uint16_t sinfo_keynumber_valid;
149 uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD_SHORT];
152 struct sctp_sndinfo {
156 uint32_t snd_context;
157 sctp_assoc_t snd_assoc_id;
165 struct sctp_default_prinfo {
168 sctp_assoc_t pr_assoc_id;
171 struct sctp_authinfo {
175 struct sctp_rcvinfo {
182 uint32_t rcv_context;
183 sctp_assoc_t rcv_assoc_id;
186 struct sctp_nxtinfo {
191 sctp_assoc_t nxt_assoc_id;
194 #define SCTP_NO_NEXT_MSG 0x0000
195 #define SCTP_NEXT_MSG_AVAIL 0x0001
196 #define SCTP_NEXT_MSG_ISCOMPLETE 0x0002
197 #define SCTP_NEXT_MSG_IS_UNORDERED 0x0004
198 #define SCTP_NEXT_MSG_IS_NOTIFICATION 0x0008
200 struct sctp_recvv_rn {
201 struct sctp_rcvinfo recvv_rcvinfo;
202 struct sctp_nxtinfo recvv_nxtinfo;
205 #define SCTP_RECVV_NOINFO 0
206 #define SCTP_RECVV_RCVINFO 1
207 #define SCTP_RECVV_NXTINFO 2
208 #define SCTP_RECVV_RN 3
210 #define SCTP_SENDV_NOINFO 0
211 #define SCTP_SENDV_SNDINFO 1
212 #define SCTP_SENDV_PRINFO 2
213 #define SCTP_SENDV_AUTHINFO 3
214 #define SCTP_SENDV_SPA 4
216 struct sctp_sendv_spa {
217 uint32_t sendv_flags;
218 struct sctp_sndinfo sendv_sndinfo;
219 struct sctp_prinfo sendv_prinfo;
220 struct sctp_authinfo sendv_authinfo;
223 #define SCTP_SEND_SNDINFO_VALID 0x00000001
224 #define SCTP_SEND_PRINFO_VALID 0x00000002
225 #define SCTP_SEND_AUTHINFO_VALID 0x00000004
227 struct sctp_snd_all_completes {
228 uint16_t sall_stream;
231 uint32_t sall_context;
232 uint32_t sall_num_sent;
233 uint32_t sall_num_failed;
236 /* Flags that go into the sinfo->sinfo_flags field */
237 #define SCTP_NOTIFICATION 0x0010 /* next message is a notification */
238 #define SCTP_COMPLETE 0x0020 /* next message is complete */
239 #define SCTP_EOF 0x0100 /* Start shutdown procedures */
240 #define SCTP_ABORT 0x0200 /* Send an ABORT to peer */
241 #define SCTP_UNORDERED 0x0400 /* Message is un-ordered */
242 #define SCTP_ADDR_OVER 0x0800 /* Override the primary-address */
243 #define SCTP_SENDALL 0x1000 /* Send this on all associations */
244 #define SCTP_EOR 0x2000 /* end of message signal */
245 #define SCTP_SACK_IMMEDIATELY 0x4000 /* Set I-Bit */
247 #define INVALID_SINFO_FLAG(x) (((x) & 0xfffffff0 \
248 & ~(SCTP_EOF | SCTP_ABORT | SCTP_UNORDERED |\
249 SCTP_ADDR_OVER | SCTP_SENDALL | SCTP_EOR |\
250 SCTP_SACK_IMMEDIATELY)) != 0)
251 /* for the endpoint */
253 /* The lower byte is an enumeration of PR-SCTP policies */
254 #define SCTP_PR_SCTP_NONE 0x0000/* Reliable transfer */
255 #define SCTP_PR_SCTP_TTL 0x0001/* Time based PR-SCTP */
256 #define SCTP_PR_SCTP_BUF 0x0002/* Buffer based PR-SCTP */
257 #define SCTP_PR_SCTP_RTX 0x0003/* Number of retransmissions based PR-SCTP */
259 #define PR_SCTP_POLICY(x) ((x) & 0x0f)
260 #define PR_SCTP_ENABLED(x) (PR_SCTP_POLICY(x) != SCTP_PR_SCTP_NONE)
261 #define PR_SCTP_TTL_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_TTL)
262 #define PR_SCTP_BUF_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_BUF)
263 #define PR_SCTP_RTX_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_RTX)
264 #define PR_SCTP_INVALID_POLICY(x) (PR_SCTP_POLICY(x) > SCTP_PR_SCTP_RTX)
266 struct sctp_pcbinfo {
269 uint32_t laddr_count;
270 uint32_t raddr_count;
272 uint32_t readq_count;
273 uint32_t free_chunks;
274 uint32_t stream_oque;
277 struct sctp_sockstat {
278 sctp_assoc_t ss_assoc_id;
279 uint32_t ss_total_sndbuf;
280 uint32_t ss_total_recv_buf;
284 * notification event structures
288 * association change event
290 struct sctp_assoc_change {
296 uint16_t sac_outbound_streams;
297 uint16_t sac_inbound_streams;
298 sctp_assoc_t sac_assoc_id;
301 /* sac_state values */
302 #define SCTP_COMM_UP 0x0001
303 #define SCTP_COMM_LOST 0x0002
304 #define SCTP_RESTART 0x0003
305 #define SCTP_SHUTDOWN_COMP 0x0004
306 #define SCTP_CANT_STR_ASSOC 0x0005
312 struct sctp_paddr_change {
316 struct sockaddr_storage spc_aaddr;
319 sctp_assoc_t spc_assoc_id;
320 uint8_t spc_padding[4];
323 /* paddr state values */
324 #define SCTP_ADDR_AVAILABLE 0x0001
325 #define SCTP_ADDR_UNREACHABLE 0x0002
326 #define SCTP_ADDR_REMOVED 0x0003
327 #define SCTP_ADDR_ADDED 0x0004
328 #define SCTP_ADDR_MADE_PRIM 0x0005
329 #define SCTP_ADDR_CONFIRMED 0x0006
331 #define SCTP_ACTIVE 0x0001 /* SCTP_ADDR_REACHABLE */
332 #define SCTP_INACTIVE 0x0002 /* neither SCTP_ADDR_REACHABLE nor
333 * SCTP_ADDR_UNCONFIRMED */
334 #define SCTP_UNCONFIRMED 0x0200 /* SCTP_ADDR_UNCONFIRMED */
336 /* remote error events */
337 struct sctp_remote_error {
342 sctp_assoc_t sre_assoc_id;
346 /* data send failure event */
347 struct sctp_send_failed {
352 struct sctp_sndrcvinfo ssf_info;
353 sctp_assoc_t ssf_assoc_id;
357 /* flag that indicates state of data */
358 #define SCTP_DATA_UNSENT 0x0001 /* inqueue never on wire */
359 #define SCTP_DATA_SENT 0x0002 /* on wire at failure */
362 struct sctp_shutdown_event {
366 sctp_assoc_t sse_assoc_id;
369 /* Adaptation layer indication stuff */
370 struct sctp_adaptation_event {
374 uint32_t sai_adaptation_ind;
375 sctp_assoc_t sai_assoc_id;
378 struct sctp_setadaptation {
379 uint32_t ssb_adaptation_ind;
382 /* compatible old spelling */
383 struct sctp_adaption_event {
387 uint32_t sai_adaption_ind;
388 sctp_assoc_t sai_assoc_id;
391 struct sctp_setadaption {
392 uint32_t ssb_adaption_ind;
397 * Partial Delivery API event
399 struct sctp_pdapi_event {
401 uint16_t pdapi_flags;
402 uint32_t pdapi_length;
403 uint32_t pdapi_indication;
404 uint16_t pdapi_stream;
406 sctp_assoc_t pdapi_assoc_id;
409 /* indication values */
410 #define SCTP_PARTIAL_DELIVERY_ABORTED 0x0001
414 * authentication key event
416 struct sctp_authkey_event {
419 uint32_t auth_length;
420 uint16_t auth_keynumber;
421 uint16_t auth_altkeynumber;
422 uint32_t auth_indication;
423 sctp_assoc_t auth_assoc_id;
426 /* indication values */
427 #define SCTP_AUTH_NEWKEY 0x0001
428 #define SCTP_AUTH_NO_AUTH 0x0002
429 #define SCTP_AUTH_FREE_KEY 0x0003
432 struct sctp_sender_dry_event {
433 uint16_t sender_dry_type;
434 uint16_t sender_dry_flags;
435 uint32_t sender_dry_length;
436 sctp_assoc_t sender_dry_assoc_id;
443 struct sctp_stream_reset_event {
444 uint16_t strreset_type;
445 uint16_t strreset_flags;
446 uint32_t strreset_length;
447 sctp_assoc_t strreset_assoc_id;
448 uint16_t strreset_list[];
451 /* flags in strreset_flags field */
452 #define SCTP_STRRESET_INBOUND_STR 0x0001
453 #define SCTP_STRRESET_OUTBOUND_STR 0x0002
454 #define SCTP_STRRESET_ALL_STREAMS 0x0004
455 #define SCTP_STRRESET_STREAM_LIST 0x0008
456 #define SCTP_STRRESET_FAILED 0x0010
457 #define SCTP_STRRESET_ADD_STREAM 0x0020
459 /* SCTP notification event */
466 union sctp_notification {
467 struct sctp_tlv sn_header;
468 struct sctp_assoc_change sn_assoc_change;
469 struct sctp_paddr_change sn_paddr_change;
470 struct sctp_remote_error sn_remote_error;
471 struct sctp_send_failed sn_send_failed;
472 struct sctp_shutdown_event sn_shutdown_event;
473 struct sctp_adaptation_event sn_adaptation_event;
474 /* compatibility same as above */
475 struct sctp_adaption_event sn_adaption_event;
476 struct sctp_pdapi_event sn_pdapi_event;
477 struct sctp_authkey_event sn_auth_event;
478 struct sctp_sender_dry_event sn_sender_dry_event;
479 struct sctp_stream_reset_event sn_strreset_event;
482 /* notification types */
483 #define SCTP_ASSOC_CHANGE 0x0001
484 #define SCTP_PEER_ADDR_CHANGE 0x0002
485 #define SCTP_REMOTE_ERROR 0x0003
486 #define SCTP_SEND_FAILED 0x0004
487 #define SCTP_SHUTDOWN_EVENT 0x0005
488 #define SCTP_ADAPTATION_INDICATION 0x0006
490 #define SCTP_ADAPTION_INDICATION 0x0006
491 #define SCTP_PARTIAL_DELIVERY_EVENT 0x0007
492 #define SCTP_AUTHENTICATION_EVENT 0x0008
493 #define SCTP_STREAM_RESET_EVENT 0x0009
494 #define SCTP_SENDER_DRY_EVENT 0x000a
495 #define SCTP_NOTIFICATIONS_STOPPED_EVENT 0x000b /* we don't send this */
497 * socket option structs
500 struct sctp_paddrparams {
501 struct sockaddr_storage spp_address;
502 sctp_assoc_t spp_assoc_id;
503 uint32_t spp_hbinterval;
504 uint32_t spp_pathmtu;
506 uint32_t spp_ipv6_flowlabel;
507 uint16_t spp_pathmaxrxt;
511 #define spp_ipv4_tos spp_dscp
513 #define SPP_HB_ENABLE 0x00000001
514 #define SPP_HB_DISABLE 0x00000002
515 #define SPP_HB_DEMAND 0x00000004
516 #define SPP_PMTUD_ENABLE 0x00000008
517 #define SPP_PMTUD_DISABLE 0x00000010
518 #define SPP_HB_TIME_IS_ZERO 0x00000080
519 #define SPP_IPV6_FLOWLABEL 0x00000100
520 #define SPP_DSCP 0x00000200
521 #define SPP_IPV4_TOS SPP_DSCP
523 struct sctp_paddrthlds {
524 sctp_assoc_t spt_assoc_id;
525 struct sockaddr_storage spt_address;
526 uint16_t spt_pathmaxrxt;
527 uint16_t spt_pathpfthld;
530 struct sctp_paddrinfo {
531 struct sockaddr_storage spinfo_address;
532 sctp_assoc_t spinfo_assoc_id;
533 int32_t spinfo_state;
534 uint32_t spinfo_cwnd;
535 uint32_t spinfo_srtt;
540 struct sctp_rtoinfo {
541 sctp_assoc_t srto_assoc_id;
542 uint32_t srto_initial;
547 struct sctp_assocparams {
548 sctp_assoc_t sasoc_assoc_id;
549 uint32_t sasoc_peer_rwnd;
550 uint32_t sasoc_local_rwnd;
551 uint32_t sasoc_cookie_life;
552 uint16_t sasoc_asocmaxrxt;
553 uint16_t sasoc_number_peer_destinations;
556 struct sctp_setprim {
557 struct sockaddr_storage ssp_addr;
558 sctp_assoc_t ssp_assoc_id;
559 uint8_t ssp_padding[4];
562 struct sctp_setpeerprim {
563 struct sockaddr_storage sspp_addr;
564 sctp_assoc_t sspp_assoc_id;
565 uint8_t sspp_padding[4];
568 struct sctp_getaddresses {
569 sctp_assoc_t sget_assoc_id;
570 /* addr is filled in for N * sockaddr_storage */
571 struct sockaddr addr[1];
574 struct sctp_setstrm_timeout {
575 sctp_assoc_t ssto_assoc_id;
576 uint32_t ssto_timeout;
577 uint32_t ssto_streamid_start;
578 uint32_t ssto_streamid_end;
582 sctp_assoc_t sstat_assoc_id;
585 uint16_t sstat_unackdata;
586 uint16_t sstat_penddata;
587 uint16_t sstat_instrms;
588 uint16_t sstat_outstrms;
589 uint32_t sstat_fragmentation_point;
590 struct sctp_paddrinfo sstat_primary;
594 * AUTHENTICATION support
596 /* SCTP_AUTH_CHUNK */
597 struct sctp_authchunk {
602 struct sctp_authkey {
603 sctp_assoc_t sca_assoc_id;
604 uint16_t sca_keynumber;
605 uint16_t sca_keylength;
609 /* SCTP_HMAC_IDENT */
610 struct sctp_hmacalgo {
611 uint32_t shmac_number_of_idents;
612 uint16_t shmac_idents[];
616 #define SCTP_AUTH_HMAC_ID_RSVD 0x0000
617 #define SCTP_AUTH_HMAC_ID_SHA1 0x0001 /* default, mandatory */
618 #define SCTP_AUTH_HMAC_ID_SHA256 0x0003
619 #define SCTP_AUTH_HMAC_ID_SHA224 0x0004
620 #define SCTP_AUTH_HMAC_ID_SHA384 0x0005
621 #define SCTP_AUTH_HMAC_ID_SHA512 0x0006
624 /* SCTP_AUTH_ACTIVE_KEY / SCTP_AUTH_DELETE_KEY */
625 struct sctp_authkeyid {
626 sctp_assoc_t scact_assoc_id;
627 uint16_t scact_keynumber;
630 /* SCTP_PEER_AUTH_CHUNKS / SCTP_LOCAL_AUTH_CHUNKS */
631 struct sctp_authchunks {
632 sctp_assoc_t gauth_assoc_id;
633 uint8_t gauth_chunks[];
636 struct sctp_assoc_value {
637 sctp_assoc_t assoc_id;
638 uint32_t assoc_value;
641 struct sctp_cc_option {
643 struct sctp_assoc_value aid_value;
646 struct sctp_stream_value {
647 sctp_assoc_t assoc_id;
649 uint16_t stream_value;
652 struct sctp_assoc_ids {
653 uint32_t gaids_number_of_ids;
654 sctp_assoc_t gaids_assoc_id[];
657 struct sctp_sack_info {
658 sctp_assoc_t sack_assoc_id;
663 struct sctp_timeouts {
664 sctp_assoc_t stimo_assoc_id;
668 uint32_t stimo_shutdown;
669 uint32_t stimo_heartbeat;
670 uint32_t stimo_cookie;
671 uint32_t stimo_shutdownack;
674 struct sctp_cwnd_args {
675 struct sctp_nets *net; /* network to *//* FIXME: LP64 issue */
676 uint32_t cwnd_new_value;/* cwnd in k */
677 uint32_t pseudo_cumack;
678 uint16_t inflight; /* flightsize in k */
679 uint16_t cwnd_augment; /* increment to it */
680 uint8_t meets_pseudo_cumack;
681 uint8_t need_new_pseudo_cumack;
686 struct sctp_blk_args {
687 uint32_t onsb; /* in 1k bytes */
688 uint32_t sndlen; /* len of send being attempted */
689 uint32_t peer_rwnd; /* rwnd of peer */
690 uint16_t send_sent_qcnt;/* chnk cnt */
691 uint16_t stream_qcnt; /* chnk cnt */
692 uint16_t chunks_on_oque;/* chunks out */
693 uint16_t flight_size; /* flight size in k */
697 * Max we can reset in one setting, note this is dictated not by the define
698 * but the size of a mbuf cluster so don't change this define and think you
699 * can specify more. You must do multiple resets if you want to reset more
700 * than SCTP_MAX_EXPLICIT_STR_RESET.
702 #define SCTP_MAX_EXPLICT_STR_RESET 1000
704 #define SCTP_RESET_LOCAL_RECV 0x0001
705 #define SCTP_RESET_LOCAL_SEND 0x0002
706 #define SCTP_RESET_BOTH 0x0003
707 #define SCTP_RESET_TSN 0x0004
708 #define SCTP_RESET_ADD_STREAMS 0x0005
710 struct sctp_stream_reset {
711 sctp_assoc_t strrst_assoc_id;
712 uint16_t strrst_flags;
713 uint16_t strrst_num_streams; /* 0 == ALL */
714 uint16_t strrst_list[]; /* list if strrst_num_streams is not 0 */
718 struct sctp_get_nonce_values {
719 sctp_assoc_t gn_assoc_id;
720 uint32_t gn_peers_tag;
721 uint32_t gn_local_tag;
725 struct sctp_str_log {
726 void *stcb; /* FIXME: LP64 issue */
735 void *stcb; /* FIXME: LP64 issue */
742 uint32_t largest_tsn;
743 uint32_t largest_new_tsn;
753 struct sctp_rwnd_log {
760 struct sctp_mbcnt_log {
761 uint32_t total_queue_size;
762 uint32_t size_change;
763 uint32_t total_queue_mb_size;
764 uint32_t mbcnt_change;
767 struct sctp_sack_log {
775 struct sctp_lock_log {
776 void *sock; /* FIXME: LP64 issue */
777 void *inp; /* FIXME: LP64 issue */
782 uint8_t sockrcvbuf_lock;
783 uint8_t socksndbuf_lock;
788 struct sctp_rto_log {
789 void *net; /* FIXME: LP64 issue */
793 struct sctp_nagle_log {
794 void *stcb; /* FIXME: LP64 issue */
795 uint32_t total_flight;
796 uint32_t total_in_queue;
797 uint16_t count_in_queue;
798 uint16_t count_in_flight;
801 struct sctp_sbwake_log {
802 void *stcb; /* FIXME: LP64 issue */
807 uint8_t stream_qcnt; /* chnk cnt */
808 uint8_t chunks_on_oque; /* chunks out */
813 struct sctp_misc_info {
820 struct sctp_log_closing {
821 void *inp; /* FIXME: LP64 issue */
822 void *stcb; /* FIXME: LP64 issue */
828 struct sctp_mbuf_log {
829 struct mbuf *mp; /* FIXME: LP64 issue */
837 struct sctp_cwnd_log {
843 struct sctp_log_closing close;
844 struct sctp_blk_args blk;
845 struct sctp_cwnd_args cwnd;
846 struct sctp_str_log strlog;
847 struct sctp_fr_log fr;
848 struct sctp_fr_map map;
849 struct sctp_rwnd_log rwnd;
850 struct sctp_mbcnt_log mbcnt;
851 struct sctp_sack_log sack;
852 struct sctp_lock_log lock;
853 struct sctp_rto_log rto;
854 struct sctp_sb_log sb;
855 struct sctp_nagle_log nagle;
856 struct sctp_sbwake_log wake;
857 struct sctp_mbuf_log mb;
858 struct sctp_misc_info misc;
862 struct sctp_cwnd_log_req {
863 int32_t num_in_log; /* Number in log */
864 int32_t num_ret; /* Number returned */
865 int32_t start_at; /* start at this one */
866 int32_t end_at; /* end at this one */
867 struct sctp_cwnd_log log[];
870 struct sctp_timeval {
876 struct sctp_timeval sctps_discontinuitytime; /* sctpStats 18
878 /* MIB according to RFC 3873 */
879 uint32_t sctps_currestab; /* sctpStats 1 (Gauge32) */
880 uint32_t sctps_activeestab; /* sctpStats 2 (Counter32) */
881 uint32_t sctps_restartestab;
882 uint32_t sctps_collisionestab;
883 uint32_t sctps_passiveestab; /* sctpStats 3 (Counter32) */
884 uint32_t sctps_aborted; /* sctpStats 4 (Counter32) */
885 uint32_t sctps_shutdown;/* sctpStats 5 (Counter32) */
886 uint32_t sctps_outoftheblue; /* sctpStats 6 (Counter32) */
887 uint32_t sctps_checksumerrors; /* sctpStats 7 (Counter32) */
888 uint32_t sctps_outcontrolchunks; /* sctpStats 8 (Counter64) */
889 uint32_t sctps_outorderchunks; /* sctpStats 9 (Counter64) */
890 uint32_t sctps_outunorderchunks; /* sctpStats 10 (Counter64) */
891 uint32_t sctps_incontrolchunks; /* sctpStats 11 (Counter64) */
892 uint32_t sctps_inorderchunks; /* sctpStats 12 (Counter64) */
893 uint32_t sctps_inunorderchunks; /* sctpStats 13 (Counter64) */
894 uint32_t sctps_fragusrmsgs; /* sctpStats 14 (Counter64) */
895 uint32_t sctps_reasmusrmsgs; /* sctpStats 15 (Counter64) */
896 uint32_t sctps_outpackets; /* sctpStats 16 (Counter64) */
897 uint32_t sctps_inpackets; /* sctpStats 17 (Counter64) */
899 /* input statistics: */
900 uint32_t sctps_recvpackets; /* total input packets */
901 uint32_t sctps_recvdatagrams; /* total input datagrams */
902 uint32_t sctps_recvpktwithdata; /* total packets that had data */
903 uint32_t sctps_recvsacks; /* total input SACK chunks */
904 uint32_t sctps_recvdata;/* total input DATA chunks */
905 uint32_t sctps_recvdupdata; /* total input duplicate DATA chunks */
906 uint32_t sctps_recvheartbeat; /* total input HB chunks */
907 uint32_t sctps_recvheartbeatack; /* total input HB-ACK chunks */
908 uint32_t sctps_recvecne;/* total input ECNE chunks */
909 uint32_t sctps_recvauth;/* total input AUTH chunks */
910 uint32_t sctps_recvauthmissing; /* total input chunks missing AUTH */
911 uint32_t sctps_recvivalhmacid; /* total number of invalid HMAC ids
913 uint32_t sctps_recvivalkeyid; /* total number of invalid secret ids
915 uint32_t sctps_recvauthfailed; /* total number of auth failed */
916 uint32_t sctps_recvexpress; /* total fast path receives all one
918 uint32_t sctps_recvexpressm; /* total fast path multi-part data */
919 uint32_t sctps_recvnocrc;
920 uint32_t sctps_recvswcrc;
921 uint32_t sctps_recvhwcrc;
923 /* output statistics: */
924 uint32_t sctps_sendpackets; /* total output packets */
925 uint32_t sctps_sendsacks; /* total output SACKs */
926 uint32_t sctps_senddata;/* total output DATA chunks */
927 uint32_t sctps_sendretransdata; /* total output retransmitted DATA
929 uint32_t sctps_sendfastretrans; /* total output fast retransmitted
931 uint32_t sctps_sendmultfastretrans; /* total FR's that happened
932 * more than once to same
933 * chunk (u-del multi-fr
935 uint32_t sctps_sendheartbeat; /* total output HB chunks */
936 uint32_t sctps_sendecne;/* total output ECNE chunks */
937 uint32_t sctps_sendauth;/* total output AUTH chunks FIXME */
938 uint32_t sctps_senderrors; /* ip_output error counter */
939 uint32_t sctps_sendnocrc;
940 uint32_t sctps_sendswcrc;
941 uint32_t sctps_sendhwcrc;
942 /* PCKDROPREP statistics: */
943 uint32_t sctps_pdrpfmbox; /* Packet drop from middle box */
944 uint32_t sctps_pdrpfehos; /* P-drop from end host */
945 uint32_t sctps_pdrpmbda;/* P-drops with data */
946 uint32_t sctps_pdrpmbct;/* P-drops, non-data, non-endhost */
947 uint32_t sctps_pdrpbwrpt; /* P-drop, non-endhost, bandwidth rep
949 uint32_t sctps_pdrpcrupt; /* P-drop, not enough for chunk header */
950 uint32_t sctps_pdrpnedat; /* P-drop, not enough data to confirm */
951 uint32_t sctps_pdrppdbrk; /* P-drop, where process_chunk_drop
953 uint32_t sctps_pdrptsnnf; /* P-drop, could not find TSN */
954 uint32_t sctps_pdrpdnfnd; /* P-drop, attempt reverse TSN lookup */
955 uint32_t sctps_pdrpdiwnp; /* P-drop, e-host confirms zero-rwnd */
956 uint32_t sctps_pdrpdizrw; /* P-drop, midbox confirms no space */
957 uint32_t sctps_pdrpbadd;/* P-drop, data did not match TSN */
958 uint32_t sctps_pdrpmark;/* P-drop, TSN's marked for Fast Retran */
960 uint32_t sctps_timoiterator; /* Number of iterator timers that
962 uint32_t sctps_timodata;/* Number of T3 data time outs */
963 uint32_t sctps_timowindowprobe; /* Number of window probe (T3) timers
965 uint32_t sctps_timoinit;/* Number of INIT timers that fired */
966 uint32_t sctps_timosack;/* Number of sack timers that fired */
967 uint32_t sctps_timoshutdown; /* Number of shutdown timers that
969 uint32_t sctps_timoheartbeat; /* Number of heartbeat timers that
971 uint32_t sctps_timocookie; /* Number of times a cookie timeout
973 uint32_t sctps_timosecret; /* Number of times an endpoint changed
974 * its cookie secret */
975 uint32_t sctps_timopathmtu; /* Number of PMTU timers that fired */
976 uint32_t sctps_timoshutdownack; /* Number of shutdown ack timers that
978 uint32_t sctps_timoshutdownguard; /* Number of shutdown guard
979 * timers that fired */
980 uint32_t sctps_timostrmrst; /* Number of stream reset timers that
982 uint32_t sctps_timoearlyfr; /* Number of early FR timers that
984 uint32_t sctps_timoasconf; /* Number of times an asconf timer
986 uint32_t sctps_timodelprim; /* Number of times a prim_deleted
988 uint32_t sctps_timoautoclose; /* Number of times auto close timer
990 uint32_t sctps_timoassockill; /* Number of asoc free timers expired */
991 uint32_t sctps_timoinpkill; /* Number of inp free timers expired */
992 /* former early FR counters */
993 uint32_t sctps_spare[11];
995 uint32_t sctps_hdrops; /* packet shorter than header */
996 uint32_t sctps_badsum; /* checksum error */
997 uint32_t sctps_noport; /* no endpoint for port */
998 uint32_t sctps_badvtag; /* bad v-tag */
999 uint32_t sctps_badsid; /* bad SID */
1000 uint32_t sctps_nomem; /* no memory */
1001 uint32_t sctps_fastretransinrtt; /* number of multiple FR in a
1003 uint32_t sctps_markedretrans;
1004 uint32_t sctps_naglesent; /* nagle allowed sending */
1005 uint32_t sctps_naglequeued; /* nagle doesn't allow sending */
1006 uint32_t sctps_maxburstqueued; /* max burst doesn't allow sending */
1007 uint32_t sctps_ifnomemqueued; /* look ahead tells us no memory in
1008 * interface ring buffer OR we had a
1009 * send error and are queuing one
1011 uint32_t sctps_windowprobed; /* total number of window probes sent */
1012 uint32_t sctps_lowlevelerr; /* total times an output error causes
1013 * us to clamp down on next user send. */
1014 uint32_t sctps_lowlevelerrusr; /* total times sctp_senderrors were
1015 * caused from a user send from a user
1016 * invoked send not a sack response */
1017 uint32_t sctps_datadropchklmt; /* Number of in data drops due to
1018 * chunk limit reached */
1019 uint32_t sctps_datadroprwnd; /* Number of in data drops due to rwnd
1021 uint32_t sctps_ecnereducedcwnd; /* Number of times a ECN reduced the
1023 uint32_t sctps_vtagexpress; /* Used express lookup via vtag */
1024 uint32_t sctps_vtagbogus; /* Collision in express lookup. */
1025 uint32_t sctps_primary_randry; /* Number of times the sender ran dry
1026 * of user data on primary */
1027 uint32_t sctps_cmt_randry; /* Same for above */
1028 uint32_t sctps_slowpath_sack; /* Sacks the slow way */
1029 uint32_t sctps_wu_sacks_sent; /* Window Update only sacks sent */
1030 uint32_t sctps_sends_with_flags; /* number of sends with
1031 * sinfo_flags !=0 */
1032 uint32_t sctps_sends_with_unord; /* number of unordered sends */
1033 uint32_t sctps_sends_with_eof; /* number of sends with EOF flag set */
1034 uint32_t sctps_sends_with_abort; /* number of sends with ABORT
1036 uint32_t sctps_protocol_drain_calls; /* number of times protocol
1038 uint32_t sctps_protocol_drains_done; /* number of times we did a
1040 uint32_t sctps_read_peeks; /* Number of times recv was called
1042 uint32_t sctps_cached_chk; /* Number of cached chunks used */
1043 uint32_t sctps_cached_strmoq; /* Number of cached stream oq's used */
1044 uint32_t sctps_left_abandon; /* Number of unread messages abandoned
1046 uint32_t sctps_send_burst_avoid; /* Unused */
1047 uint32_t sctps_send_cwnd_avoid; /* Send cwnd full avoidance, already
1048 * max burst inflight to net */
1049 uint32_t sctps_fwdtsn_map_over; /* number of map array over-runs via
1051 uint32_t sctps_queue_upd_ecne; /* Number of times we queued or
1052 * updated an ECN chunk on send queue */
1053 uint32_t sctps_reserved[31]; /* Future ABI compat - remove int's
1054 * from here when adding new */
1057 #define SCTP_STAT_INCR(_x) SCTP_STAT_INCR_BY(_x,1)
1058 #define SCTP_STAT_DECR(_x) SCTP_STAT_DECR_BY(_x,1)
1059 #if defined(__FreeBSD__) && defined(SMP) && defined(SCTP_USE_PERCPU_STAT)
1060 #define SCTP_STAT_INCR_BY(_x,_d) (SCTP_BASE_STATS[PCPU_GET(cpuid)]._x += _d)
1061 #define SCTP_STAT_DECR_BY(_x,_d) (SCTP_BASE_STATS[PCPU_GET(cpuid)]._x -= _d)
1063 #define SCTP_STAT_INCR_BY(_x,_d) atomic_add_int(&SCTP_BASE_STAT(_x), _d)
1064 #define SCTP_STAT_DECR_BY(_x,_d) atomic_subtract_int(&SCTP_BASE_STAT(_x), _d)
1066 /* The following macros are for handling MIB values, */
1067 #define SCTP_STAT_INCR_COUNTER32(_x) SCTP_STAT_INCR(_x)
1068 #define SCTP_STAT_INCR_COUNTER64(_x) SCTP_STAT_INCR(_x)
1069 #define SCTP_STAT_INCR_GAUGE32(_x) SCTP_STAT_INCR(_x)
1070 #define SCTP_STAT_DECR_COUNTER32(_x) SCTP_STAT_DECR(_x)
1071 #define SCTP_STAT_DECR_COUNTER64(_x) SCTP_STAT_DECR(_x)
1072 #define SCTP_STAT_DECR_GAUGE32(_x) SCTP_STAT_DECR(_x)
1074 union sctp_sockstore {
1075 #if defined(INET) || !defined(_KERNEL)
1076 struct sockaddr_in sin;
1078 #if defined(INET6) || !defined(_KERNEL)
1079 struct sockaddr_in6 sin6;
1085 /***********************************/
1086 /* And something for us old timers */
1087 /***********************************/
1090 #include <sys/endian.h>
1091 #define ntohll(x) be64toh(x)
1095 #include <sys/endian.h>
1096 #define htonll(x) htobe64(x)
1098 /***********************************/
1101 struct xsctp_inpcb {
1105 uint32_t total_sends;
1106 uint32_t total_recvs;
1107 uint32_t total_nospaces;
1108 uint32_t fragmentation_point;
1109 uint16_t local_port;
1112 uint32_t extra_padding[32]; /* future */
1116 union sctp_sockstore primary_addr; /* sctpAssocEntry 5/6 */
1118 uint32_t heartbeat_interval; /* sctpAssocEntry 7 */
1119 uint32_t state; /* sctpAssocEntry 8 */
1120 uint32_t in_streams; /* sctpAssocEntry 9 */
1121 uint32_t out_streams; /* sctpAssocEntry 10 */
1122 uint32_t max_nr_retrans;/* sctpAssocEntry 11 */
1123 uint32_t primary_process; /* sctpAssocEntry 12 */
1124 uint32_t T1_expireries; /* sctpAssocEntry 13 */
1125 uint32_t T2_expireries; /* sctpAssocEntry 14 */
1126 uint32_t retransmitted_tsns; /* sctpAssocEntry 15 */
1127 uint32_t total_sends;
1128 uint32_t total_recvs;
1130 uint32_t remote_tag;
1131 uint32_t initial_tsn;
1132 uint32_t highest_tsn;
1133 uint32_t cumulative_tsn;
1134 uint32_t cumulative_tsn_ack;
1137 uint16_t local_port; /* sctpAssocEntry 3 */
1138 uint16_t remote_port; /* sctpAssocEntry 4 */
1139 struct sctp_timeval start_time; /* sctpAssocEntry 16 */
1140 struct sctp_timeval discontinuity_time; /* sctpAssocEntry 17 */
1141 uint32_t peers_rwnd;
1142 sctp_assoc_t assoc_id; /* sctpAssocEntry 1 */
1143 uint32_t extra_padding[32]; /* future */
1146 struct xsctp_laddr {
1147 union sctp_sockstore address; /* sctpAssocLocalAddrEntry 1/2 */
1149 struct sctp_timeval start_time; /* sctpAssocLocalAddrEntry 3 */
1150 uint32_t extra_padding[32]; /* future */
1153 struct xsctp_raddr {
1154 union sctp_sockstore address; /* sctpAssocLocalRemEntry 1/2 */
1156 uint32_t rto; /* sctpAssocLocalRemEntry 5 */
1157 uint32_t max_path_rtx; /* sctpAssocLocalRemEntry 6 */
1158 uint32_t rtx; /* sctpAssocLocalRemEntry 7 */
1159 uint32_t error_counter; /* */
1160 uint32_t cwnd; /* */
1161 uint32_t flight_size; /* */
1163 uint8_t active; /* sctpAssocLocalRemEntry 3 */
1164 uint8_t confirmed; /* */
1165 uint8_t heartbeat_enabled; /* sctpAssocLocalRemEntry 4 */
1166 uint8_t potentially_failed;
1167 struct sctp_timeval start_time; /* sctpAssocLocalRemEntry 8 */
1169 uint32_t heartbeat_interval;
1170 uint32_t extra_padding[31]; /* future */
1173 #define SCTP_MAX_LOGGING_SIZE 30000
1174 #define SCTP_TRACE_PARAMS 6 /* This number MUST be even */
1176 struct sctp_log_entry {
1180 uint32_t params[SCTP_TRACE_PARAMS];
1184 struct sctp_log_entry entry[SCTP_MAX_LOGGING_SIZE];
1190 * Kernel defined for sctp_send
1192 #if defined(_KERNEL) || defined(__Userspace__)
1194 sctp_lower_sosend(struct socket *so,
1195 struct sockaddr *addr,
1198 struct mbuf *control,
1200 struct sctp_sndrcvinfo *srcv
1205 sctp_sorecvmsg(struct socket *so,
1208 struct sockaddr *from,
1211 struct sctp_sndrcvinfo *sinfo,
1219 #if !(defined(_KERNEL)) && !(defined(__Userspace__))
1222 int sctp_peeloff __P((int, sctp_assoc_t));
1223 int sctp_bindx __P((int, struct sockaddr *, int, int));
1224 int sctp_connectx __P((int, const struct sockaddr *, int, sctp_assoc_t *));
1225 int sctp_getaddrlen __P((sa_family_t));
1226 int sctp_getpaddrs __P((int, sctp_assoc_t, struct sockaddr **));
1227 void sctp_freepaddrs __P((struct sockaddr *));
1228 int sctp_getladdrs __P((int, sctp_assoc_t, struct sockaddr **));
1229 void sctp_freeladdrs __P((struct sockaddr *));
1230 int sctp_opt_info __P((int, sctp_assoc_t, int, void *, socklen_t *));
1233 ssize_t sctp_sendmsg
1234 __P((int, const void *, size_t, const struct sockaddr *,
1235 socklen_t, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t));
1238 ssize_t sctp_send __P((int, const void *, size_t,
1239 const struct sctp_sndrcvinfo *, int));
1242 ssize_t sctp_sendx __P((int, const void *, size_t, struct sockaddr *,
1243 int, struct sctp_sndrcvinfo *, int));
1246 ssize_t sctp_sendmsgx __P((int sd, const void *, size_t, struct sockaddr *,
1247 int, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t));
1249 sctp_assoc_t sctp_getassocid __P((int, struct sockaddr *));
1252 ssize_t sctp_recvmsg __P((int, void *, size_t, struct sockaddr *, socklen_t *,
1253 struct sctp_sndrcvinfo *, int *));
1255 ssize_t sctp_sendv __P((int, const struct iovec *, int, struct sockaddr *,
1256 int, void *, socklen_t, unsigned int, int));
1258 ssize_t sctp_recvv __P((int, const struct iovec *, int, struct sockaddr *,
1259 socklen_t *, void *, socklen_t *, unsigned int *, int *));
1263 #endif /* !_KERNEL */
1264 #endif /* !__sctp_uio_h__ */