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_authinfo {
169 struct sctp_rcvinfo {
176 uint32_t rcv_context;
177 sctp_assoc_t rcv_assoc_id;
180 struct sctp_nxtinfo {
185 sctp_assoc_t nxt_assoc_id;
188 #define SCTP_NO_NEXT_MSG 0x0000
189 #define SCTP_NEXT_MSG_AVAIL 0x0001
190 #define SCTP_NEXT_MSG_ISCOMPLETE 0x0002
191 #define SCTP_NEXT_MSG_IS_UNORDERED 0x0004
192 #define SCTP_NEXT_MSG_IS_NOTIFICATION 0x0008
194 struct sctp_recvv_rn {
195 struct sctp_rcvinfo recvv_rcvinfo;
196 struct sctp_nxtinfo recvv_nxtinfo;
199 #define SCTP_RECVV_NOINFO 0
200 #define SCTP_RECVV_RCVINFO 1
201 #define SCTP_RECVV_NXTINFO 2
202 #define SCTP_RECVV_RN 3
204 #define SCTP_SENDV_NOINFO 0
205 #define SCTP_SENDV_SNDINFO 1
206 #define SCTP_SENDV_PRINFO 2
207 #define SCTP_SENDV_AUTHINFO 3
208 #define SCTP_SENDV_SPA 4
210 struct sctp_sendv_spa {
211 uint32_t sendv_flags;
212 struct sctp_sndinfo sendv_sndinfo;
213 struct sctp_prinfo sendv_prinfo;
214 struct sctp_authinfo sendv_authinfo;
217 #define SCTP_SEND_SNDINFO_VALID 0x00000001
218 #define SCTP_SEND_PRINFO_VALID 0x00000002
219 #define SCTP_SEND_AUTHINFO_VALID 0x00000004
221 struct sctp_snd_all_completes {
222 uint16_t sall_stream;
225 uint32_t sall_context;
226 uint32_t sall_num_sent;
227 uint32_t sall_num_failed;
230 /* Flags that go into the sinfo->sinfo_flags field */
231 #define SCTP_NOTIFICATION 0x0010 /* next message is a notification */
232 #define SCTP_COMPLETE 0x0020 /* next message is complete */
233 #define SCTP_EOF 0x0100 /* Start shutdown procedures */
234 #define SCTP_ABORT 0x0200 /* Send an ABORT to peer */
235 #define SCTP_UNORDERED 0x0400 /* Message is un-ordered */
236 #define SCTP_ADDR_OVER 0x0800 /* Override the primary-address */
237 #define SCTP_SENDALL 0x1000 /* Send this on all associations */
238 #define SCTP_EOR 0x2000 /* end of message signal */
239 #define SCTP_SACK_IMMEDIATELY 0x4000 /* Set I-Bit */
241 #define INVALID_SINFO_FLAG(x) (((x) & 0xfffffff0 \
242 & ~(SCTP_EOF | SCTP_ABORT | SCTP_UNORDERED |\
243 SCTP_ADDR_OVER | SCTP_SENDALL | SCTP_EOR |\
244 SCTP_SACK_IMMEDIATELY)) != 0)
245 /* for the endpoint */
247 /* The lower byte is an enumeration of PR-SCTP policies */
248 #define SCTP_PR_SCTP_TTL 0x0001/* Time based PR-SCTP */
249 #define SCTP_PR_SCTP_BUF 0x0002/* Buffer based PR-SCTP */
250 #define SCTP_PR_SCTP_RTX 0x0003/* Number of retransmissions based PR-SCTP */
252 #define PR_SCTP_POLICY(x) ((x) & 0x0f)
253 #define PR_SCTP_ENABLED(x) (PR_SCTP_POLICY(x) != 0)
254 #define PR_SCTP_TTL_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_TTL)
255 #define PR_SCTP_BUF_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_BUF)
256 #define PR_SCTP_RTX_ENABLED(x) (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_RTX)
257 #define PR_SCTP_INVALID_POLICY(x) (PR_SCTP_POLICY(x) > SCTP_PR_SCTP_RTX)
259 struct sctp_pcbinfo {
262 uint32_t laddr_count;
263 uint32_t raddr_count;
265 uint32_t readq_count;
266 uint32_t free_chunks;
267 uint32_t stream_oque;
270 struct sctp_sockstat {
271 sctp_assoc_t ss_assoc_id;
272 uint32_t ss_total_sndbuf;
273 uint32_t ss_total_recv_buf;
277 * notification event structures
281 * association change event
283 struct sctp_assoc_change {
289 uint16_t sac_outbound_streams;
290 uint16_t sac_inbound_streams;
291 sctp_assoc_t sac_assoc_id;
294 /* sac_state values */
295 #define SCTP_COMM_UP 0x0001
296 #define SCTP_COMM_LOST 0x0002
297 #define SCTP_RESTART 0x0003
298 #define SCTP_SHUTDOWN_COMP 0x0004
299 #define SCTP_CANT_STR_ASSOC 0x0005
305 struct sctp_paddr_change {
309 struct sockaddr_storage spc_aaddr;
312 sctp_assoc_t spc_assoc_id;
313 uint8_t spc_padding[4];
316 /* paddr state values */
317 #define SCTP_ADDR_AVAILABLE 0x0001
318 #define SCTP_ADDR_UNREACHABLE 0x0002
319 #define SCTP_ADDR_REMOVED 0x0003
320 #define SCTP_ADDR_ADDED 0x0004
321 #define SCTP_ADDR_MADE_PRIM 0x0005
322 #define SCTP_ADDR_CONFIRMED 0x0006
324 #define SCTP_ACTIVE 0x0001 /* SCTP_ADDR_REACHABLE */
325 #define SCTP_INACTIVE 0x0002 /* SCTP_ADDR_NOT_REACHABLE */
326 #define SCTP_UNCONFIRMED 0x0200 /* SCTP_ADDR_UNCONFIRMED */
328 /* remote error events */
329 struct sctp_remote_error {
334 sctp_assoc_t sre_assoc_id;
338 /* data send failure event */
339 struct sctp_send_failed {
344 struct sctp_sndrcvinfo ssf_info;
345 sctp_assoc_t ssf_assoc_id;
349 /* flag that indicates state of data */
350 #define SCTP_DATA_UNSENT 0x0001 /* inqueue never on wire */
351 #define SCTP_DATA_SENT 0x0002 /* on wire at failure */
354 struct sctp_shutdown_event {
358 sctp_assoc_t sse_assoc_id;
361 /* Adaptation layer indication stuff */
362 struct sctp_adaptation_event {
366 uint32_t sai_adaptation_ind;
367 sctp_assoc_t sai_assoc_id;
370 struct sctp_setadaptation {
371 uint32_t ssb_adaptation_ind;
374 /* compatible old spelling */
375 struct sctp_adaption_event {
379 uint32_t sai_adaption_ind;
380 sctp_assoc_t sai_assoc_id;
383 struct sctp_setadaption {
384 uint32_t ssb_adaption_ind;
389 * Partial Delivery API event
391 struct sctp_pdapi_event {
393 uint16_t pdapi_flags;
394 uint32_t pdapi_length;
395 uint32_t pdapi_indication;
396 uint16_t pdapi_stream;
398 sctp_assoc_t pdapi_assoc_id;
401 /* indication values */
402 #define SCTP_PARTIAL_DELIVERY_ABORTED 0x0001
406 * authentication key event
408 struct sctp_authkey_event {
411 uint32_t auth_length;
412 uint16_t auth_keynumber;
413 uint16_t auth_altkeynumber;
414 uint32_t auth_indication;
415 sctp_assoc_t auth_assoc_id;
418 /* indication values */
419 #define SCTP_AUTH_NEWKEY 0x0001
420 #define SCTP_AUTH_NO_AUTH 0x0002
421 #define SCTP_AUTH_FREE_KEY 0x0003
424 struct sctp_sender_dry_event {
425 uint16_t sender_dry_type;
426 uint16_t sender_dry_flags;
427 uint32_t sender_dry_length;
428 sctp_assoc_t sender_dry_assoc_id;
435 struct sctp_stream_reset_event {
436 uint16_t strreset_type;
437 uint16_t strreset_flags;
438 uint32_t strreset_length;
439 sctp_assoc_t strreset_assoc_id;
440 uint16_t strreset_list[];
443 /* flags in strreset_flags field */
444 #define SCTP_STRRESET_INBOUND_STR 0x0001
445 #define SCTP_STRRESET_OUTBOUND_STR 0x0002
446 #define SCTP_STRRESET_ALL_STREAMS 0x0004
447 #define SCTP_STRRESET_STREAM_LIST 0x0008
448 #define SCTP_STRRESET_FAILED 0x0010
449 #define SCTP_STRRESET_ADD_STREAM 0x0020
451 /* SCTP notification event */
458 union sctp_notification {
459 struct sctp_tlv sn_header;
460 struct sctp_assoc_change sn_assoc_change;
461 struct sctp_paddr_change sn_paddr_change;
462 struct sctp_remote_error sn_remote_error;
463 struct sctp_send_failed sn_send_failed;
464 struct sctp_shutdown_event sn_shutdown_event;
465 struct sctp_adaptation_event sn_adaptation_event;
466 /* compatibility same as above */
467 struct sctp_adaption_event sn_adaption_event;
468 struct sctp_pdapi_event sn_pdapi_event;
469 struct sctp_authkey_event sn_auth_event;
470 struct sctp_sender_dry_event sn_sender_dry_event;
471 struct sctp_stream_reset_event sn_strreset_event;
474 /* notification types */
475 #define SCTP_ASSOC_CHANGE 0x0001
476 #define SCTP_PEER_ADDR_CHANGE 0x0002
477 #define SCTP_REMOTE_ERROR 0x0003
478 #define SCTP_SEND_FAILED 0x0004
479 #define SCTP_SHUTDOWN_EVENT 0x0005
480 #define SCTP_ADAPTATION_INDICATION 0x0006
482 #define SCTP_ADAPTION_INDICATION 0x0006
483 #define SCTP_PARTIAL_DELIVERY_EVENT 0x0007
484 #define SCTP_AUTHENTICATION_EVENT 0x0008
485 #define SCTP_STREAM_RESET_EVENT 0x0009
486 #define SCTP_SENDER_DRY_EVENT 0x000a
487 #define SCTP_NOTIFICATIONS_STOPPED_EVENT 0x000b /* we don't send this */
489 * socket option structs
492 struct sctp_paddrparams {
493 struct sockaddr_storage spp_address;
494 sctp_assoc_t spp_assoc_id;
495 uint32_t spp_hbinterval;
496 uint32_t spp_pathmtu;
498 uint32_t spp_ipv6_flowlabel;
499 uint16_t spp_pathmaxrxt;
500 uint8_t spp_ipv4_tos;
503 #define SPP_HB_ENABLE 0x00000001
504 #define SPP_HB_DISABLE 0x00000002
505 #define SPP_HB_DEMAND 0x00000004
506 #define SPP_PMTUD_ENABLE 0x00000008
507 #define SPP_PMTUD_DISABLE 0x00000010
508 #define SPP_HB_TIME_IS_ZERO 0x00000080
509 #define SPP_IPV6_FLOWLABEL 0x00000100
510 #define SPP_IPV4_TOS 0x00000200
512 struct sctp_paddrinfo {
513 struct sockaddr_storage spinfo_address;
514 sctp_assoc_t spinfo_assoc_id;
515 int32_t spinfo_state;
516 uint32_t spinfo_cwnd;
517 uint32_t spinfo_srtt;
522 struct sctp_rtoinfo {
523 sctp_assoc_t srto_assoc_id;
524 uint32_t srto_initial;
529 struct sctp_assocparams {
530 sctp_assoc_t sasoc_assoc_id;
531 uint32_t sasoc_peer_rwnd;
532 uint32_t sasoc_local_rwnd;
533 uint32_t sasoc_cookie_life;
534 uint16_t sasoc_asocmaxrxt;
535 uint16_t sasoc_number_peer_destinations;
538 struct sctp_setprim {
539 struct sockaddr_storage ssp_addr;
540 sctp_assoc_t ssp_assoc_id;
541 uint8_t ssp_padding[4];
544 struct sctp_setpeerprim {
545 struct sockaddr_storage sspp_addr;
546 sctp_assoc_t sspp_assoc_id;
547 uint8_t sspp_padding[4];
550 struct sctp_getaddresses {
551 sctp_assoc_t sget_assoc_id;
552 /* addr is filled in for N * sockaddr_storage */
553 struct sockaddr addr[1];
556 struct sctp_setstrm_timeout {
557 sctp_assoc_t ssto_assoc_id;
558 uint32_t ssto_timeout;
559 uint32_t ssto_streamid_start;
560 uint32_t ssto_streamid_end;
564 sctp_assoc_t sstat_assoc_id;
567 uint16_t sstat_unackdata;
568 uint16_t sstat_penddata;
569 uint16_t sstat_instrms;
570 uint16_t sstat_outstrms;
571 uint32_t sstat_fragmentation_point;
572 struct sctp_paddrinfo sstat_primary;
576 * AUTHENTICATION support
578 /* SCTP_AUTH_CHUNK */
579 struct sctp_authchunk {
584 struct sctp_authkey {
585 sctp_assoc_t sca_assoc_id;
586 uint16_t sca_keynumber;
590 /* SCTP_HMAC_IDENT */
591 struct sctp_hmacalgo {
592 uint32_t shmac_number_of_idents;
593 uint16_t shmac_idents[];
597 #define SCTP_AUTH_HMAC_ID_RSVD 0x0000
598 #define SCTP_AUTH_HMAC_ID_SHA1 0x0001 /* default, mandatory */
599 #define SCTP_AUTH_HMAC_ID_SHA256 0x0003
600 #define SCTP_AUTH_HMAC_ID_SHA224 0x0004
601 #define SCTP_AUTH_HMAC_ID_SHA384 0x0005
602 #define SCTP_AUTH_HMAC_ID_SHA512 0x0006
605 /* SCTP_AUTH_ACTIVE_KEY / SCTP_AUTH_DELETE_KEY */
606 struct sctp_authkeyid {
607 sctp_assoc_t scact_assoc_id;
608 uint16_t scact_keynumber;
611 /* SCTP_PEER_AUTH_CHUNKS / SCTP_LOCAL_AUTH_CHUNKS */
612 struct sctp_authchunks {
613 sctp_assoc_t gauth_assoc_id;
614 uint8_t gauth_chunks[];
617 struct sctp_assoc_value {
618 sctp_assoc_t assoc_id;
619 uint32_t assoc_value;
622 struct sctp_cc_option {
624 struct sctp_assoc_value aid_value;
627 struct sctp_stream_value {
628 sctp_assoc_t assoc_id;
630 uint16_t stream_value;
633 struct sctp_assoc_ids {
634 uint32_t gaids_number_of_ids;
635 sctp_assoc_t gaids_assoc_id[];
638 struct sctp_sack_info {
639 sctp_assoc_t sack_assoc_id;
644 struct sctp_timeouts {
645 sctp_assoc_t stimo_assoc_id;
649 uint32_t stimo_shutdown;
650 uint32_t stimo_heartbeat;
651 uint32_t stimo_cookie;
652 uint32_t stimo_shutdownack;
655 struct sctp_cwnd_args {
656 struct sctp_nets *net; /* network to *//* FIXME: LP64 issue */
657 uint32_t cwnd_new_value;/* cwnd in k */
658 uint32_t pseudo_cumack;
659 uint16_t inflight; /* flightsize in k */
660 uint16_t cwnd_augment; /* increment to it */
661 uint8_t meets_pseudo_cumack;
662 uint8_t need_new_pseudo_cumack;
667 struct sctp_blk_args {
668 uint32_t onsb; /* in 1k bytes */
669 uint32_t sndlen; /* len of send being attempted */
670 uint32_t peer_rwnd; /* rwnd of peer */
671 uint16_t send_sent_qcnt;/* chnk cnt */
672 uint16_t stream_qcnt; /* chnk cnt */
673 uint16_t chunks_on_oque;/* chunks out */
674 uint16_t flight_size; /* flight size in k */
678 * Max we can reset in one setting, note this is dictated not by the define
679 * but the size of a mbuf cluster so don't change this define and think you
680 * can specify more. You must do multiple resets if you want to reset more
681 * than SCTP_MAX_EXPLICIT_STR_RESET.
683 #define SCTP_MAX_EXPLICT_STR_RESET 1000
685 #define SCTP_RESET_LOCAL_RECV 0x0001
686 #define SCTP_RESET_LOCAL_SEND 0x0002
687 #define SCTP_RESET_BOTH 0x0003
688 #define SCTP_RESET_TSN 0x0004
689 #define SCTP_RESET_ADD_STREAMS 0x0005
691 struct sctp_stream_reset {
692 sctp_assoc_t strrst_assoc_id;
693 uint16_t strrst_flags;
694 uint16_t strrst_num_streams; /* 0 == ALL */
695 uint16_t strrst_list[]; /* list if strrst_num_streams is not 0 */
699 struct sctp_get_nonce_values {
700 sctp_assoc_t gn_assoc_id;
701 uint32_t gn_peers_tag;
702 uint32_t gn_local_tag;
706 struct sctp_str_log {
707 void *stcb; /* FIXME: LP64 issue */
716 void *stcb; /* FIXME: LP64 issue */
723 uint32_t largest_tsn;
724 uint32_t largest_new_tsn;
734 struct sctp_rwnd_log {
741 struct sctp_mbcnt_log {
742 uint32_t total_queue_size;
743 uint32_t size_change;
744 uint32_t total_queue_mb_size;
745 uint32_t mbcnt_change;
748 struct sctp_sack_log {
756 struct sctp_lock_log {
757 void *sock; /* FIXME: LP64 issue */
758 void *inp; /* FIXME: LP64 issue */
763 uint8_t sockrcvbuf_lock;
764 uint8_t socksndbuf_lock;
769 struct sctp_rto_log {
770 void *net; /* FIXME: LP64 issue */
774 struct sctp_nagle_log {
775 void *stcb; /* FIXME: LP64 issue */
776 uint32_t total_flight;
777 uint32_t total_in_queue;
778 uint16_t count_in_queue;
779 uint16_t count_in_flight;
782 struct sctp_sbwake_log {
783 void *stcb; /* FIXME: LP64 issue */
788 uint8_t stream_qcnt; /* chnk cnt */
789 uint8_t chunks_on_oque; /* chunks out */
794 struct sctp_misc_info {
801 struct sctp_log_closing {
802 void *inp; /* FIXME: LP64 issue */
803 void *stcb; /* FIXME: LP64 issue */
809 struct sctp_mbuf_log {
810 struct mbuf *mp; /* FIXME: LP64 issue */
818 struct sctp_cwnd_log {
824 struct sctp_log_closing close;
825 struct sctp_blk_args blk;
826 struct sctp_cwnd_args cwnd;
827 struct sctp_str_log strlog;
828 struct sctp_fr_log fr;
829 struct sctp_fr_map map;
830 struct sctp_rwnd_log rwnd;
831 struct sctp_mbcnt_log mbcnt;
832 struct sctp_sack_log sack;
833 struct sctp_lock_log lock;
834 struct sctp_rto_log rto;
835 struct sctp_sb_log sb;
836 struct sctp_nagle_log nagle;
837 struct sctp_sbwake_log wake;
838 struct sctp_mbuf_log mb;
839 struct sctp_misc_info misc;
843 struct sctp_cwnd_log_req {
844 int32_t num_in_log; /* Number in log */
845 int32_t num_ret; /* Number returned */
846 int32_t start_at; /* start at this one */
847 int32_t end_at; /* end at this one */
848 struct sctp_cwnd_log log[];
851 struct sctp_timeval {
857 struct sctp_timeval sctps_discontinuitytime; /* sctpStats 18
859 /* MIB according to RFC 3873 */
860 uint32_t sctps_currestab; /* sctpStats 1 (Gauge32) */
861 uint32_t sctps_activeestab; /* sctpStats 2 (Counter32) */
862 uint32_t sctps_restartestab;
863 uint32_t sctps_collisionestab;
864 uint32_t sctps_passiveestab; /* sctpStats 3 (Counter32) */
865 uint32_t sctps_aborted; /* sctpStats 4 (Counter32) */
866 uint32_t sctps_shutdown;/* sctpStats 5 (Counter32) */
867 uint32_t sctps_outoftheblue; /* sctpStats 6 (Counter32) */
868 uint32_t sctps_checksumerrors; /* sctpStats 7 (Counter32) */
869 uint32_t sctps_outcontrolchunks; /* sctpStats 8 (Counter64) */
870 uint32_t sctps_outorderchunks; /* sctpStats 9 (Counter64) */
871 uint32_t sctps_outunorderchunks; /* sctpStats 10 (Counter64) */
872 uint32_t sctps_incontrolchunks; /* sctpStats 11 (Counter64) */
873 uint32_t sctps_inorderchunks; /* sctpStats 12 (Counter64) */
874 uint32_t sctps_inunorderchunks; /* sctpStats 13 (Counter64) */
875 uint32_t sctps_fragusrmsgs; /* sctpStats 14 (Counter64) */
876 uint32_t sctps_reasmusrmsgs; /* sctpStats 15 (Counter64) */
877 uint32_t sctps_outpackets; /* sctpStats 16 (Counter64) */
878 uint32_t sctps_inpackets; /* sctpStats 17 (Counter64) */
880 /* input statistics: */
881 uint32_t sctps_recvpackets; /* total input packets */
882 uint32_t sctps_recvdatagrams; /* total input datagrams */
883 uint32_t sctps_recvpktwithdata; /* total packets that had data */
884 uint32_t sctps_recvsacks; /* total input SACK chunks */
885 uint32_t sctps_recvdata;/* total input DATA chunks */
886 uint32_t sctps_recvdupdata; /* total input duplicate DATA chunks */
887 uint32_t sctps_recvheartbeat; /* total input HB chunks */
888 uint32_t sctps_recvheartbeatack; /* total input HB-ACK chunks */
889 uint32_t sctps_recvecne;/* total input ECNE chunks */
890 uint32_t sctps_recvauth;/* total input AUTH chunks */
891 uint32_t sctps_recvauthmissing; /* total input chunks missing AUTH */
892 uint32_t sctps_recvivalhmacid; /* total number of invalid HMAC ids
894 uint32_t sctps_recvivalkeyid; /* total number of invalid secret ids
896 uint32_t sctps_recvauthfailed; /* total number of auth failed */
897 uint32_t sctps_recvexpress; /* total fast path receives all one
899 uint32_t sctps_recvexpressm; /* total fast path multi-part data */
900 uint32_t sctps_recvnocrc;
901 uint32_t sctps_recvswcrc;
902 uint32_t sctps_recvhwcrc;
904 /* output statistics: */
905 uint32_t sctps_sendpackets; /* total output packets */
906 uint32_t sctps_sendsacks; /* total output SACKs */
907 uint32_t sctps_senddata;/* total output DATA chunks */
908 uint32_t sctps_sendretransdata; /* total output retransmitted DATA
910 uint32_t sctps_sendfastretrans; /* total output fast retransmitted
912 uint32_t sctps_sendmultfastretrans; /* total FR's that happened
913 * more than once to same
914 * chunk (u-del multi-fr
916 uint32_t sctps_sendheartbeat; /* total output HB chunks */
917 uint32_t sctps_sendecne;/* total output ECNE chunks */
918 uint32_t sctps_sendauth;/* total output AUTH chunks FIXME */
919 uint32_t sctps_senderrors; /* ip_output error counter */
920 uint32_t sctps_sendnocrc;
921 uint32_t sctps_sendswcrc;
922 uint32_t sctps_sendhwcrc;
923 /* PCKDROPREP statistics: */
924 uint32_t sctps_pdrpfmbox; /* Packet drop from middle box */
925 uint32_t sctps_pdrpfehos; /* P-drop from end host */
926 uint32_t sctps_pdrpmbda;/* P-drops with data */
927 uint32_t sctps_pdrpmbct;/* P-drops, non-data, non-endhost */
928 uint32_t sctps_pdrpbwrpt; /* P-drop, non-endhost, bandwidth rep
930 uint32_t sctps_pdrpcrupt; /* P-drop, not enough for chunk header */
931 uint32_t sctps_pdrpnedat; /* P-drop, not enough data to confirm */
932 uint32_t sctps_pdrppdbrk; /* P-drop, where process_chunk_drop
934 uint32_t sctps_pdrptsnnf; /* P-drop, could not find TSN */
935 uint32_t sctps_pdrpdnfnd; /* P-drop, attempt reverse TSN lookup */
936 uint32_t sctps_pdrpdiwnp; /* P-drop, e-host confirms zero-rwnd */
937 uint32_t sctps_pdrpdizrw; /* P-drop, midbox confirms no space */
938 uint32_t sctps_pdrpbadd;/* P-drop, data did not match TSN */
939 uint32_t sctps_pdrpmark;/* P-drop, TSN's marked for Fast Retran */
941 uint32_t sctps_timoiterator; /* Number of iterator timers that
943 uint32_t sctps_timodata;/* Number of T3 data time outs */
944 uint32_t sctps_timowindowprobe; /* Number of window probe (T3) timers
946 uint32_t sctps_timoinit;/* Number of INIT timers that fired */
947 uint32_t sctps_timosack;/* Number of sack timers that fired */
948 uint32_t sctps_timoshutdown; /* Number of shutdown timers that
950 uint32_t sctps_timoheartbeat; /* Number of heartbeat timers that
952 uint32_t sctps_timocookie; /* Number of times a cookie timeout
954 uint32_t sctps_timosecret; /* Number of times an endpoint changed
955 * its cookie secret */
956 uint32_t sctps_timopathmtu; /* Number of PMTU timers that fired */
957 uint32_t sctps_timoshutdownack; /* Number of shutdown ack timers that
959 uint32_t sctps_timoshutdownguard; /* Number of shutdown guard
960 * timers that fired */
961 uint32_t sctps_timostrmrst; /* Number of stream reset timers that
963 uint32_t sctps_timoearlyfr; /* Number of early FR timers that
965 uint32_t sctps_timoasconf; /* Number of times an asconf timer
967 uint32_t sctps_timodelprim; /* Number of times a prim_deleted
969 uint32_t sctps_timoautoclose; /* Number of times auto close timer
971 uint32_t sctps_timoassockill; /* Number of asoc free timers expired */
972 uint32_t sctps_timoinpkill; /* Number of inp free timers expired */
973 /* Early fast retransmission counters */
974 uint32_t sctps_earlyfrstart;
975 uint32_t sctps_earlyfrstop;
976 uint32_t sctps_earlyfrmrkretrans;
977 uint32_t sctps_earlyfrstpout;
978 uint32_t sctps_earlyfrstpidsck1;
979 uint32_t sctps_earlyfrstpidsck2;
980 uint32_t sctps_earlyfrstpidsck3;
981 uint32_t sctps_earlyfrstpidsck4;
982 uint32_t sctps_earlyfrstrid;
983 uint32_t sctps_earlyfrstrout;
984 uint32_t sctps_earlyfrstrtmr;
986 uint32_t sctps_hdrops; /* packet shorter than header */
987 uint32_t sctps_badsum; /* checksum error */
988 uint32_t sctps_noport; /* no endpoint for port */
989 uint32_t sctps_badvtag; /* bad v-tag */
990 uint32_t sctps_badsid; /* bad SID */
991 uint32_t sctps_nomem; /* no memory */
992 uint32_t sctps_fastretransinrtt; /* number of multiple FR in a
994 uint32_t sctps_markedretrans;
995 uint32_t sctps_naglesent; /* nagle allowed sending */
996 uint32_t sctps_naglequeued; /* nagle doesn't allow sending */
997 uint32_t sctps_maxburstqueued; /* max burst doesn't allow sending */
998 uint32_t sctps_ifnomemqueued; /* look ahead tells us no memory in
999 * interface ring buffer OR we had a
1000 * send error and are queuing one
1002 uint32_t sctps_windowprobed; /* total number of window probes sent */
1003 uint32_t sctps_lowlevelerr; /* total times an output error causes
1004 * us to clamp down on next user send. */
1005 uint32_t sctps_lowlevelerrusr; /* total times sctp_senderrors were
1006 * caused from a user send from a user
1007 * invoked send not a sack response */
1008 uint32_t sctps_datadropchklmt; /* Number of in data drops due to
1009 * chunk limit reached */
1010 uint32_t sctps_datadroprwnd; /* Number of in data drops due to rwnd
1012 uint32_t sctps_ecnereducedcwnd; /* Number of times a ECN reduced the
1014 uint32_t sctps_vtagexpress; /* Used express lookup via vtag */
1015 uint32_t sctps_vtagbogus; /* Collision in express lookup. */
1016 uint32_t sctps_primary_randry; /* Number of times the sender ran dry
1017 * of user data on primary */
1018 uint32_t sctps_cmt_randry; /* Same for above */
1019 uint32_t sctps_slowpath_sack; /* Sacks the slow way */
1020 uint32_t sctps_wu_sacks_sent; /* Window Update only sacks sent */
1021 uint32_t sctps_sends_with_flags; /* number of sends with
1022 * sinfo_flags !=0 */
1023 uint32_t sctps_sends_with_unord; /* number of unordered sends */
1024 uint32_t sctps_sends_with_eof; /* number of sends with EOF flag set */
1025 uint32_t sctps_sends_with_abort; /* number of sends with ABORT
1027 uint32_t sctps_protocol_drain_calls; /* number of times protocol
1029 uint32_t sctps_protocol_drains_done; /* number of times we did a
1031 uint32_t sctps_read_peeks; /* Number of times recv was called
1033 uint32_t sctps_cached_chk; /* Number of cached chunks used */
1034 uint32_t sctps_cached_strmoq; /* Number of cached stream oq's used */
1035 uint32_t sctps_left_abandon; /* Number of unread messages abandoned
1037 uint32_t sctps_send_burst_avoid; /* Unused */
1038 uint32_t sctps_send_cwnd_avoid; /* Send cwnd full avoidance, already
1039 * max burst inflight to net */
1040 uint32_t sctps_fwdtsn_map_over; /* number of map array over-runs via
1042 uint32_t sctps_queue_upd_ecne; /* Number of times we queued or
1043 * updated an ECN chunk on send queue */
1044 uint32_t sctps_reserved[31]; /* Future ABI compat - remove int's
1045 * from here when adding new */
1048 #define SCTP_STAT_INCR(_x) SCTP_STAT_INCR_BY(_x,1)
1049 #define SCTP_STAT_DECR(_x) SCTP_STAT_DECR_BY(_x,1)
1050 #if defined(__FreeBSD__) && defined(SMP) && defined(SCTP_USE_PERCPU_STAT)
1051 #define SCTP_STAT_INCR_BY(_x,_d) (SCTP_BASE_STATS[PCPU_GET(cpuid)]._x += _d)
1052 #define SCTP_STAT_DECR_BY(_x,_d) (SCTP_BASE_STATS[PCPU_GET(cpuid)]._x -= _d)
1054 #define SCTP_STAT_INCR_BY(_x,_d) atomic_add_int(&SCTP_BASE_STAT(_x), _d)
1055 #define SCTP_STAT_DECR_BY(_x,_d) atomic_subtract_int(&SCTP_BASE_STAT(_x), _d)
1057 /* The following macros are for handling MIB values, */
1058 #define SCTP_STAT_INCR_COUNTER32(_x) SCTP_STAT_INCR(_x)
1059 #define SCTP_STAT_INCR_COUNTER64(_x) SCTP_STAT_INCR(_x)
1060 #define SCTP_STAT_INCR_GAUGE32(_x) SCTP_STAT_INCR(_x)
1061 #define SCTP_STAT_DECR_COUNTER32(_x) SCTP_STAT_DECR(_x)
1062 #define SCTP_STAT_DECR_COUNTER64(_x) SCTP_STAT_DECR(_x)
1063 #define SCTP_STAT_DECR_GAUGE32(_x) SCTP_STAT_DECR(_x)
1065 union sctp_sockstore {
1066 #if defined(INET) || !defined(_KERNEL)
1067 struct sockaddr_in sin;
1069 #if defined(INET6) || !defined(_KERNEL)
1070 struct sockaddr_in6 sin6;
1076 /***********************************/
1077 /* And something for us old timers */
1078 /***********************************/
1081 #include <sys/endian.h>
1082 #define ntohll(x) be64toh(x)
1086 #include <sys/endian.h>
1087 #define htonll(x) htobe64(x)
1089 /***********************************/
1092 struct xsctp_inpcb {
1096 uint32_t total_sends;
1097 uint32_t total_recvs;
1098 uint32_t total_nospaces;
1099 uint32_t fragmentation_point;
1100 uint16_t local_port;
1103 uint32_t extra_padding[32]; /* future */
1107 union sctp_sockstore primary_addr; /* sctpAssocEntry 5/6 */
1109 uint32_t heartbeat_interval; /* sctpAssocEntry 7 */
1110 uint32_t state; /* sctpAssocEntry 8 */
1111 uint32_t in_streams; /* sctpAssocEntry 9 */
1112 uint32_t out_streams; /* sctpAssocEntry 10 */
1113 uint32_t max_nr_retrans;/* sctpAssocEntry 11 */
1114 uint32_t primary_process; /* sctpAssocEntry 12 */
1115 uint32_t T1_expireries; /* sctpAssocEntry 13 */
1116 uint32_t T2_expireries; /* sctpAssocEntry 14 */
1117 uint32_t retransmitted_tsns; /* sctpAssocEntry 15 */
1118 uint32_t total_sends;
1119 uint32_t total_recvs;
1121 uint32_t remote_tag;
1122 uint32_t initial_tsn;
1123 uint32_t highest_tsn;
1124 uint32_t cumulative_tsn;
1125 uint32_t cumulative_tsn_ack;
1128 uint16_t local_port; /* sctpAssocEntry 3 */
1129 uint16_t remote_port; /* sctpAssocEntry 4 */
1130 struct sctp_timeval start_time; /* sctpAssocEntry 16 */
1131 struct sctp_timeval discontinuity_time; /* sctpAssocEntry 17 */
1132 uint32_t peers_rwnd;
1133 sctp_assoc_t assoc_id; /* sctpAssocEntry 1 */
1134 uint32_t extra_padding[32]; /* future */
1137 struct xsctp_laddr {
1138 union sctp_sockstore address; /* sctpAssocLocalAddrEntry 1/2 */
1140 struct sctp_timeval start_time; /* sctpAssocLocalAddrEntry 3 */
1141 uint32_t extra_padding[32]; /* future */
1144 struct xsctp_raddr {
1145 union sctp_sockstore address; /* sctpAssocLocalRemEntry 1/2 */
1147 uint32_t rto; /* sctpAssocLocalRemEntry 5 */
1148 uint32_t max_path_rtx; /* sctpAssocLocalRemEntry 6 */
1149 uint32_t rtx; /* sctpAssocLocalRemEntry 7 */
1150 uint32_t error_counter; /* */
1151 uint32_t cwnd; /* */
1152 uint32_t flight_size; /* */
1154 uint8_t active; /* sctpAssocLocalRemEntry 3 */
1155 uint8_t confirmed; /* */
1156 uint8_t heartbeat_enabled; /* sctpAssocLocalRemEntry 4 */
1157 struct sctp_timeval start_time; /* sctpAssocLocalRemEntry 8 */
1159 uint32_t extra_padding[32]; /* future */
1162 #define SCTP_MAX_LOGGING_SIZE 30000
1163 #define SCTP_TRACE_PARAMS 6 /* This number MUST be even */
1165 struct sctp_log_entry {
1169 uint32_t params[SCTP_TRACE_PARAMS];
1173 struct sctp_log_entry entry[SCTP_MAX_LOGGING_SIZE];
1179 * Kernel defined for sctp_send
1181 #if defined(_KERNEL) || defined(__Userspace__)
1183 sctp_lower_sosend(struct socket *so,
1184 struct sockaddr *addr,
1187 struct mbuf *control,
1189 struct sctp_sndrcvinfo *srcv
1194 sctp_sorecvmsg(struct socket *so,
1197 struct sockaddr *from,
1200 struct sctp_sndrcvinfo *sinfo,
1208 #if !(defined(_KERNEL)) && !(defined(__Userspace__))
1211 int sctp_peeloff __P((int, sctp_assoc_t));
1212 int sctp_bindx __P((int, struct sockaddr *, int, int));
1213 int sctp_connectx __P((int, const struct sockaddr *, int, sctp_assoc_t *));
1214 int sctp_getaddrlen __P((sa_family_t));
1215 int sctp_getpaddrs __P((int, sctp_assoc_t, struct sockaddr **));
1216 void sctp_freepaddrs __P((struct sockaddr *));
1217 int sctp_getladdrs __P((int, sctp_assoc_t, struct sockaddr **));
1218 void sctp_freeladdrs __P((struct sockaddr *));
1219 int sctp_opt_info __P((int, sctp_assoc_t, int, void *, socklen_t *));
1222 ssize_t sctp_sendmsg
1223 __P((int, const void *, size_t, const struct sockaddr *,
1224 socklen_t, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t));
1227 ssize_t sctp_send __P((int, const void *, size_t,
1228 const struct sctp_sndrcvinfo *, int));
1231 ssize_t sctp_sendx __P((int, const void *, size_t, struct sockaddr *,
1232 int, struct sctp_sndrcvinfo *, int));
1235 ssize_t sctp_sendmsgx __P((int sd, const void *, size_t, struct sockaddr *,
1236 int, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t));
1238 sctp_assoc_t sctp_getassocid __P((int, struct sockaddr *));
1241 ssize_t sctp_recvmsg __P((int, void *, size_t, struct sockaddr *, socklen_t *,
1242 struct sctp_sndrcvinfo *, int *));
1244 ssize_t sctp_sendv __P((int, const struct iovec *, int, struct sockaddr *,
1245 int, void *, socklen_t, unsigned int, int));
1247 ssize_t sctp_recvv __P((int, const struct iovec *, int, struct sockaddr *,
1248 socklen_t *, void *, socklen_t *, unsigned int *, int *));
1252 #endif /* !_KERNEL */
1253 #endif /* !__sctp_uio_h__ */