Home | History | Annotate | Download | only in usrsctplib
      1 /*-
      2  * Copyright (c) 2009-2010 Brad Penoff
      3  * Copyright (c) 2009-2010 Humaira Kamal
      4  * Copyright (c) 2011-2012 Irene Ruengeler
      5  * Copyright (c) 2011-2012 Michael Tuexen
      6  *
      7  * All rights reserved.
      8  *
      9  * Redistribution and use in source and binary forms, with or without
     10  * modification, are permitted provided that the following conditions
     11  * are met:
     12  * 1. Redistributions of source code must retain the above copyright
     13  *    notice, this list of conditions and the following disclaimer.
     14  * 2. Redistributions in binary form must reproduce the above copyright
     15  *    notice, this list of conditions and the following disclaimer in the
     16  *    documentation and/or other materials provided with the distribution.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     28  * SUCH DAMAGE.
     29  */
     30 
     31 #ifndef __USRSCTP_H__
     32 #define __USRSCTP_H__
     33 
     34 #ifdef  __cplusplus
     35 extern "C" {
     36 #endif
     37 
     38 #include <errno.h>
     39 #include <sys/types.h>
     40 #ifdef _WIN32
     41 #ifdef _MSC_VER
     42 #pragma warning(disable: 4200)
     43 #endif
     44 #include <winsock2.h>
     45 #include <ws2tcpip.h>
     46 #else
     47 #include <sys/socket.h>
     48 #include <netinet/in.h>
     49 #endif
     50 
     51 #ifndef MSG_NOTIFICATION
     52 /* This definition MUST be in sync with usrsctplib/user_socketvar.h */
     53 #define MSG_NOTIFICATION 0x2000
     54 #endif
     55 
     56 #ifndef IPPROTO_SCTP
     57 /* This is the IANA assigned protocol number of SCTP. */
     58 #define IPPROTO_SCTP 132
     59 #endif
     60 
     61 #ifdef _WIN32
     62 #if defined(_MSC_VER) && _MSC_VER >= 1600
     63 #include <stdint.h>
     64 #elif defined(SCTP_STDINT_INCLUDE)
     65 #include SCTP_STDINT_INCLUDE
     66 #else
     67 #define uint8_t   unsigned __int8
     68 #define uint16_t  unsigned __int16
     69 #define uint32_t  unsigned __int32
     70 #define int16_t   __int16
     71 #define int32_t   __int32
     72 #endif
     73 
     74 #define ssize_t   __int64
     75 #define MSG_EOR   0x8
     76 #ifndef EWOULDBLOCK
     77 #define EWOULDBLOCK  WSAEWOULDBLOCK
     78 #endif
     79 #ifndef EINPROGRESS
     80 #define EINPROGRESS  WSAEINPROGRESS
     81 #endif
     82 #define SHUT_RD    1
     83 #define SHUT_WR    2
     84 #define SHUT_RDWR  3
     85 #endif
     86 
     87 typedef uint32_t sctp_assoc_t;
     88 
     89 #define AF_CONN 123
     90 /* The definition of struct sockaddr_conn MUST be in
     91  * tune with other sockaddr_* structures.
     92  */
     93 #if defined(__APPLE__) || defined(__FreeBSD__) || defined(__OpenBSD__)
     94 struct sockaddr_conn {
     95 	uint8_t sconn_len;
     96 	uint8_t sconn_family;
     97 	uint16_t sconn_port;
     98 	void *sconn_addr;
     99 };
    100 #else
    101 struct sockaddr_conn {
    102 	uint16_t sconn_family;
    103 	uint16_t sconn_port;
    104 	void *sconn_addr;
    105 };
    106 #endif
    107 
    108 union sctp_sockstore {
    109 #if defined(INET)
    110 	struct sockaddr_in sin;
    111 #endif
    112 #if defined(INET6)
    113 	struct sockaddr_in6 sin6;
    114 #endif
    115 	struct sockaddr_conn sconn;
    116 	struct sockaddr sa;
    117 };
    118 
    119 #define SCTP_FUTURE_ASSOC  0
    120 #define SCTP_CURRENT_ASSOC 1
    121 #define SCTP_ALL_ASSOC     2
    122 
    123 /***  Structures and definitions to use the socket API  ***/
    124 
    125 #define SCTP_ALIGN_RESV_PAD 92
    126 #define SCTP_ALIGN_RESV_PAD_SHORT 76
    127 
    128 struct sctp_rcvinfo {
    129 	uint16_t rcv_sid;
    130 	uint16_t rcv_ssn;
    131 	uint16_t rcv_flags;
    132 	uint32_t rcv_ppid;
    133 	uint32_t rcv_tsn;
    134 	uint32_t rcv_cumtsn;
    135 	uint32_t rcv_context;
    136 	sctp_assoc_t rcv_assoc_id;
    137 };
    138 
    139 struct sctp_nxtinfo {
    140 	uint16_t nxt_sid;
    141 	uint16_t nxt_flags;
    142 	uint32_t nxt_ppid;
    143 	uint32_t nxt_length;
    144 	sctp_assoc_t nxt_assoc_id;
    145 };
    146 
    147 #define SCTP_NO_NEXT_MSG           0x0000
    148 #define SCTP_NEXT_MSG_AVAIL        0x0001
    149 #define SCTP_NEXT_MSG_ISCOMPLETE   0x0002
    150 #define SCTP_NEXT_MSG_IS_UNORDERED 0x0004
    151 #define SCTP_NEXT_MSG_IS_NOTIFICATION 0x0008
    152 
    153 struct sctp_recvv_rn {
    154 	struct sctp_rcvinfo recvv_rcvinfo;
    155 	struct sctp_nxtinfo recvv_nxtinfo;
    156 };
    157 
    158 #define SCTP_RECVV_NOINFO  0
    159 #define SCTP_RECVV_RCVINFO 1
    160 #define SCTP_RECVV_NXTINFO 2
    161 #define SCTP_RECVV_RN      3
    162 
    163 #define SCTP_SENDV_NOINFO   0
    164 #define SCTP_SENDV_SNDINFO  1
    165 #define SCTP_SENDV_PRINFO   2
    166 #define SCTP_SENDV_AUTHINFO 3
    167 #define SCTP_SENDV_SPA      4
    168 
    169 #define SCTP_SEND_SNDINFO_VALID  0x00000001
    170 #define SCTP_SEND_PRINFO_VALID   0x00000002
    171 #define SCTP_SEND_AUTHINFO_VALID 0x00000004
    172 
    173 struct sctp_snd_all_completes {
    174 	uint16_t sall_stream;
    175 	uint16_t sall_flags;
    176 	uint32_t sall_ppid;
    177 	uint32_t sall_context;
    178 	uint32_t sall_num_sent;
    179 	uint32_t sall_num_failed;
    180 };
    181 
    182 struct sctp_sndinfo {
    183 	uint16_t snd_sid;
    184 	uint16_t snd_flags;
    185 	uint32_t snd_ppid;
    186 	uint32_t snd_context;
    187 	sctp_assoc_t snd_assoc_id;
    188 };
    189 
    190 struct sctp_prinfo {
    191 	uint16_t pr_policy;
    192 	uint32_t pr_value;
    193 };
    194 
    195 struct sctp_authinfo {
    196 	uint16_t auth_keynumber;
    197 };
    198 
    199 struct sctp_sendv_spa {
    200 	uint32_t sendv_flags;
    201 	struct sctp_sndinfo sendv_sndinfo;
    202 	struct sctp_prinfo sendv_prinfo;
    203 	struct sctp_authinfo sendv_authinfo;
    204 };
    205 
    206 struct sctp_udpencaps {
    207 	struct sockaddr_storage sue_address;
    208 	uint32_t sue_assoc_id;
    209 	uint16_t sue_port;
    210 };
    211 
    212 /********  Notifications  **************/
    213 
    214 /* notification types */
    215 #define SCTP_ASSOC_CHANGE                 0x0001
    216 #define SCTP_PEER_ADDR_CHANGE             0x0002
    217 #define SCTP_REMOTE_ERROR                 0x0003
    218 #define SCTP_SEND_FAILED                  0x0004
    219 #define SCTP_SHUTDOWN_EVENT               0x0005
    220 #define SCTP_ADAPTATION_INDICATION        0x0006
    221 #define SCTP_PARTIAL_DELIVERY_EVENT       0x0007
    222 #define SCTP_AUTHENTICATION_EVENT         0x0008
    223 #define SCTP_STREAM_RESET_EVENT           0x0009
    224 #define SCTP_SENDER_DRY_EVENT             0x000a
    225 #define SCTP_NOTIFICATIONS_STOPPED_EVENT  0x000b
    226 #define SCTP_ASSOC_RESET_EVENT            0x000c
    227 #define SCTP_STREAM_CHANGE_EVENT          0x000d
    228 #define SCTP_SEND_FAILED_EVENT            0x000e
    229 
    230 /* notification event structures */
    231 
    232 
    233 /* association change event */
    234 struct sctp_assoc_change {
    235 	uint16_t sac_type;
    236 	uint16_t sac_flags;
    237 	uint32_t sac_length;
    238 	uint16_t sac_state;
    239 	uint16_t sac_error;
    240 	uint16_t sac_outbound_streams;
    241 	uint16_t sac_inbound_streams;
    242 	sctp_assoc_t sac_assoc_id;
    243 	uint8_t sac_info[]; /* not available yet */
    244 };
    245 
    246 /* sac_state values */
    247 #define SCTP_COMM_UP        0x0001
    248 #define SCTP_COMM_LOST      0x0002
    249 #define SCTP_RESTART        0x0003
    250 #define SCTP_SHUTDOWN_COMP  0x0004
    251 #define SCTP_CANT_STR_ASSOC 0x0005
    252 
    253 /* sac_info values */
    254 #define SCTP_ASSOC_SUPPORTS_PR        0x01
    255 #define SCTP_ASSOC_SUPPORTS_AUTH      0x02
    256 #define SCTP_ASSOC_SUPPORTS_ASCONF    0x03
    257 #define SCTP_ASSOC_SUPPORTS_MULTIBUF  0x04
    258 #define SCTP_ASSOC_SUPPORTS_RE_CONFIG 0x05
    259 #define SCTP_ASSOC_SUPPORTS_MAX       0x05
    260 
    261 /* Address event */
    262 struct sctp_paddr_change {
    263 	uint16_t spc_type;
    264 	uint16_t spc_flags;
    265 	uint32_t spc_length;
    266 	struct sockaddr_storage spc_aaddr;
    267 	uint32_t spc_state;
    268 	uint32_t spc_error;
    269 	sctp_assoc_t spc_assoc_id;
    270 	uint8_t spc_padding[4];
    271 };
    272 
    273 /* paddr state values */
    274 #define SCTP_ADDR_AVAILABLE   0x0001
    275 #define SCTP_ADDR_UNREACHABLE 0x0002
    276 #define SCTP_ADDR_REMOVED     0x0003
    277 #define SCTP_ADDR_ADDED       0x0004
    278 #define SCTP_ADDR_MADE_PRIM   0x0005
    279 #define SCTP_ADDR_CONFIRMED   0x0006
    280 
    281 /* remote error events */
    282 struct sctp_remote_error {
    283 	uint16_t sre_type;
    284 	uint16_t sre_flags;
    285 	uint32_t sre_length;
    286 	uint16_t sre_error;
    287 	sctp_assoc_t sre_assoc_id;
    288 	uint8_t sre_data[4];
    289 };
    290 
    291 /* shutdown event */
    292 struct sctp_shutdown_event {
    293 	uint16_t sse_type;
    294 	uint16_t sse_flags;
    295 	uint32_t sse_length;
    296 	sctp_assoc_t sse_assoc_id;
    297 };
    298 
    299 /* Adaptation layer indication */
    300 struct sctp_adaptation_event {
    301 	uint16_t sai_type;
    302 	uint16_t sai_flags;
    303 	uint32_t sai_length;
    304 	uint32_t sai_adaptation_ind;
    305 	sctp_assoc_t sai_assoc_id;
    306 };
    307 
    308 /* Partial delivery event */
    309 struct sctp_pdapi_event {
    310 	uint16_t pdapi_type;
    311 	uint16_t pdapi_flags;
    312 	uint32_t pdapi_length;
    313 	uint32_t pdapi_indication;
    314 	uint32_t pdapi_stream;
    315 	uint32_t pdapi_seq;
    316 	sctp_assoc_t pdapi_assoc_id;
    317 };
    318 
    319 /* indication values */
    320 #define SCTP_PARTIAL_DELIVERY_ABORTED  0x0001
    321 
    322 /* SCTP authentication event */
    323 struct sctp_authkey_event {
    324 	uint16_t auth_type;
    325 	uint16_t auth_flags;
    326 	uint32_t auth_length;
    327 	uint16_t auth_keynumber;
    328 	uint32_t auth_indication;
    329 	sctp_assoc_t auth_assoc_id;
    330 };
    331 
    332 /* indication values */
    333 #define SCTP_AUTH_NEW_KEY   0x0001
    334 #define SCTP_AUTH_NO_AUTH   0x0002
    335 #define SCTP_AUTH_FREE_KEY  0x0003
    336 
    337 /* SCTP sender dry event */
    338 struct sctp_sender_dry_event {
    339 	uint16_t sender_dry_type;
    340 	uint16_t sender_dry_flags;
    341 	uint32_t sender_dry_length;
    342 	sctp_assoc_t sender_dry_assoc_id;
    343 };
    344 
    345 
    346 /* Stream reset event - subscribe to SCTP_STREAM_RESET_EVENT */
    347 struct sctp_stream_reset_event {
    348 	uint16_t strreset_type;
    349 	uint16_t strreset_flags;
    350 	uint32_t strreset_length;
    351 	sctp_assoc_t strreset_assoc_id;
    352 	uint16_t strreset_stream_list[];
    353 };
    354 
    355 /* flags in stream_reset_event (strreset_flags) */
    356 #define SCTP_STREAM_RESET_INCOMING_SSN  0x0001
    357 #define SCTP_STREAM_RESET_OUTGOING_SSN  0x0002
    358 #define SCTP_STREAM_RESET_DENIED        0x0004 /* SCTP_STRRESET_FAILED */
    359 #define SCTP_STREAM_RESET_FAILED        0x0008 /* SCTP_STRRESET_FAILED */
    360 #define SCTP_STREAM_CHANGED_DENIED      0x0010
    361 
    362 #define SCTP_STREAM_RESET_INCOMING      0x00000001
    363 #define SCTP_STREAM_RESET_OUTGOING      0x00000002
    364 
    365 
    366 /* Assoc reset event - subscribe to SCTP_ASSOC_RESET_EVENT */
    367 struct sctp_assoc_reset_event {
    368 	uint16_t assocreset_type;
    369 	uint16_t assocreset_flags;
    370 	uint32_t assocreset_length;
    371 	sctp_assoc_t assocreset_assoc_id;
    372 	uint32_t assocreset_local_tsn;
    373 	uint32_t assocreset_remote_tsn;
    374 };
    375 
    376 #define SCTP_ASSOC_RESET_DENIED        0x0004
    377 #define SCTP_ASSOC_RESET_FAILED        0x0008
    378 
    379 
    380 /* Stream change event - subscribe to SCTP_STREAM_CHANGE_EVENT */
    381 struct sctp_stream_change_event {
    382 	uint16_t strchange_type;
    383 	uint16_t strchange_flags;
    384 	uint32_t strchange_length;
    385 	sctp_assoc_t strchange_assoc_id;
    386 	uint16_t strchange_instrms;
    387 	uint16_t strchange_outstrms;
    388 };
    389 
    390 #define SCTP_STREAM_CHANGE_DENIED	0x0004
    391 #define SCTP_STREAM_CHANGE_FAILED	0x0008
    392 
    393 
    394 /* SCTP send failed event */
    395 struct sctp_send_failed_event {
    396 	uint16_t ssfe_type;
    397 	uint16_t ssfe_flags;
    398 	uint32_t ssfe_length;
    399 	uint32_t ssfe_error;
    400 	struct sctp_sndinfo ssfe_info;
    401 	sctp_assoc_t ssfe_assoc_id;
    402 	uint8_t  ssfe_data[];
    403 };
    404 
    405 /* flag that indicates state of data */
    406 #define SCTP_DATA_UNSENT  0x0001	/* inqueue never on wire */
    407 #define SCTP_DATA_SENT    0x0002	/* on wire at failure */
    408 
    409 /* SCTP event option */
    410 struct sctp_event {
    411 	sctp_assoc_t   se_assoc_id;
    412 	uint16_t       se_type;
    413 	uint8_t        se_on;
    414 };
    415 
    416 union sctp_notification {
    417 	struct sctp_tlv {
    418 		uint16_t sn_type;
    419 		uint16_t sn_flags;
    420 		uint32_t sn_length;
    421 	} sn_header;
    422 	struct sctp_assoc_change sn_assoc_change;
    423 	struct sctp_paddr_change sn_paddr_change;
    424 	struct sctp_remote_error sn_remote_error;
    425 	struct sctp_shutdown_event sn_shutdown_event;
    426 	struct sctp_adaptation_event sn_adaptation_event;
    427 	struct sctp_pdapi_event sn_pdapi_event;
    428 	struct sctp_authkey_event sn_auth_event;
    429 	struct sctp_sender_dry_event sn_sender_dry_event;
    430 	struct sctp_send_failed_event sn_send_failed_event;
    431 	struct sctp_stream_reset_event sn_strreset_event;
    432 	struct sctp_assoc_reset_event  sn_assocreset_event;
    433 	struct sctp_stream_change_event sn_strchange_event;
    434 };
    435 
    436 struct sctp_event_subscribe {
    437 	uint8_t sctp_data_io_event;
    438 	uint8_t sctp_association_event;
    439 	uint8_t sctp_address_event;
    440 	uint8_t sctp_send_failure_event;
    441 	uint8_t sctp_peer_error_event;
    442 	uint8_t sctp_shutdown_event;
    443 	uint8_t sctp_partial_delivery_event;
    444 	uint8_t sctp_adaptation_layer_event;
    445 	uint8_t sctp_authentication_event;
    446 	uint8_t sctp_sender_dry_event;
    447 	uint8_t sctp_stream_reset_event;
    448 };
    449 
    450 
    451 
    452 /* Flags that go into the sinfo->sinfo_flags field */
    453 #define SCTP_NOTIFICATION     0x0010 /* next message is a notification */
    454 #define SCTP_COMPLETE         0x0020 /* next message is complete */
    455 #define SCTP_EOF              0x0100 /* Start shutdown procedures */
    456 #define SCTP_ABORT            0x0200 /* Send an ABORT to peer */
    457 #define SCTP_UNORDERED        0x0400 /* Message is un-ordered */
    458 #define SCTP_ADDR_OVER        0x0800 /* Override the primary-address */
    459 #define SCTP_SENDALL          0x1000 /* Send this on all associations */
    460 #define SCTP_EOR              0x2000 /* end of message signal */
    461 #define SCTP_SACK_IMMEDIATELY 0x4000 /* Set I-Bit */
    462 
    463 #define INVALID_SINFO_FLAG(x) (((x) & 0xfffffff0 \
    464                                     & ~(SCTP_EOF | SCTP_ABORT | SCTP_UNORDERED |\
    465 				        SCTP_ADDR_OVER | SCTP_SENDALL | SCTP_EOR |\
    466 					SCTP_SACK_IMMEDIATELY)) != 0)
    467 /* for the endpoint */
    468 
    469 /* The lower byte is an enumeration of PR-SCTP policies */
    470 #define SCTP_PR_SCTP_NONE 0x0000 /* Reliable transfer */
    471 #define SCTP_PR_SCTP_TTL  0x0001 /* Time based PR-SCTP */
    472 #define SCTP_PR_SCTP_BUF  0x0002 /* Buffer based PR-SCTP */
    473 #define SCTP_PR_SCTP_RTX  0x0003 /* Number of retransmissions based PR-SCTP */
    474 
    475 #define PR_SCTP_POLICY(x)         ((x) & 0x0f)
    476 #define PR_SCTP_ENABLED(x)        (PR_SCTP_POLICY(x) != SCTP_PR_SCTP_NONE)
    477 #define PR_SCTP_TTL_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_TTL)
    478 #define PR_SCTP_BUF_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_BUF)
    479 #define PR_SCTP_RTX_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_RTX)
    480 #define PR_SCTP_INVALID_POLICY(x) (PR_SCTP_POLICY(x) > SCTP_PR_SCTP_RTX)
    481 
    482 
    483 /*
    484  * user socket options: socket API defined
    485  */
    486 /*
    487  * read-write options
    488  */
    489 #define SCTP_RTOINFO                    0x00000001
    490 #define SCTP_ASSOCINFO                  0x00000002
    491 #define SCTP_INITMSG                    0x00000003
    492 #define SCTP_NODELAY                    0x00000004
    493 #define SCTP_AUTOCLOSE                  0x00000005
    494 #define SCTP_PRIMARY_ADDR               0x00000007
    495 #define SCTP_ADAPTATION_LAYER           0x00000008
    496 #define SCTP_DISABLE_FRAGMENTS          0x00000009
    497 #define SCTP_PEER_ADDR_PARAMS           0x0000000a
    498 /* ancillary data/notification interest options */
    499 /* Without this applied we will give V4 and V6 addresses on a V6 socket */
    500 #define SCTP_I_WANT_MAPPED_V4_ADDR      0x0000000d
    501 #define SCTP_MAXSEG                     0x0000000e
    502 #define SCTP_DELAYED_SACK               0x0000000f
    503 #define SCTP_FRAGMENT_INTERLEAVE        0x00000010
    504 #define SCTP_PARTIAL_DELIVERY_POINT     0x00000011
    505 /* authentication support */
    506 #define SCTP_HMAC_IDENT                 0x00000014
    507 #define SCTP_AUTH_ACTIVE_KEY            0x00000015
    508 #define SCTP_AUTO_ASCONF                0x00000018
    509 #define SCTP_MAX_BURST                  0x00000019
    510 /* assoc level context */
    511 #define SCTP_CONTEXT                    0x0000001a
    512 /* explicit EOR signalling */
    513 #define SCTP_EXPLICIT_EOR               0x0000001b
    514 #define SCTP_REUSE_PORT                 0x0000001c
    515 
    516 #define SCTP_EVENT                      0x0000001e
    517 #define SCTP_RECVRCVINFO                0x0000001f
    518 #define SCTP_RECVNXTINFO                0x00000020
    519 #define SCTP_DEFAULT_SNDINFO            0x00000021
    520 #define SCTP_DEFAULT_PRINFO             0x00000022
    521 #define SCTP_REMOTE_UDP_ENCAPS_PORT     0x00000024
    522 
    523 #define SCTP_ENABLE_STREAM_RESET        0x00000900 /* struct sctp_assoc_value */
    524 
    525 /*
    526  * read-only options
    527  */
    528 #define SCTP_STATUS                     0x00000100
    529 #define SCTP_GET_PEER_ADDR_INFO         0x00000101
    530 /* authentication support */
    531 #define SCTP_PEER_AUTH_CHUNKS           0x00000102
    532 #define SCTP_LOCAL_AUTH_CHUNKS          0x00000103
    533 #define SCTP_GET_ASSOC_NUMBER           0x00000104
    534 #define SCTP_GET_ASSOC_ID_LIST          0x00000105
    535 
    536 /*
    537  * write-only options
    538  */
    539 #define SCTP_SET_PEER_PRIMARY_ADDR      0x00000006
    540 #define SCTP_AUTH_CHUNK                 0x00000012
    541 #define SCTP_AUTH_KEY                   0x00000013
    542 #define SCTP_AUTH_DEACTIVATE_KEY        0x0000001d
    543 #define SCTP_AUTH_DELETE_KEY            0x00000016
    544 #define SCTP_RESET_STREAMS              0x00000901 /* struct sctp_reset_streams */
    545 #define SCTP_RESET_ASSOC                0x00000902 /* sctp_assoc_t */
    546 #define SCTP_ADD_STREAMS                0x00000903 /* struct sctp_add_streams */
    547 
    548 struct sctp_initmsg {
    549 	uint16_t sinit_num_ostreams;
    550 	uint16_t sinit_max_instreams;
    551 	uint16_t sinit_max_attempts;
    552 	uint16_t sinit_max_init_timeo;
    553 };
    554 
    555 struct sctp_rtoinfo {
    556 	sctp_assoc_t srto_assoc_id;
    557 	uint32_t srto_initial;
    558 	uint32_t srto_max;
    559 	uint32_t srto_min;
    560 };
    561 
    562 struct sctp_assocparams {
    563 	sctp_assoc_t sasoc_assoc_id;
    564 	uint32_t sasoc_peer_rwnd;
    565 	uint32_t sasoc_local_rwnd;
    566 	uint32_t sasoc_cookie_life;
    567 	uint16_t sasoc_asocmaxrxt;
    568 	uint16_t sasoc_number_peer_destinations;
    569 };
    570 
    571 struct sctp_setprim {
    572 	struct sockaddr_storage ssp_addr;
    573 	sctp_assoc_t ssp_assoc_id;
    574 	uint8_t ssp_padding[4];
    575 };
    576 
    577 struct sctp_setadaptation {
    578 	uint32_t   ssb_adaptation_ind;
    579 };
    580 
    581 struct sctp_paddrparams {
    582 	struct sockaddr_storage spp_address;
    583 	sctp_assoc_t spp_assoc_id;
    584 	uint32_t spp_hbinterval;
    585 	uint32_t spp_pathmtu;
    586 	uint32_t spp_flags;
    587 	uint32_t spp_ipv6_flowlabel;
    588 	uint16_t spp_pathmaxrxt;
    589 	uint8_t spp_dscp;
    590 };
    591 
    592 #define SPP_HB_ENABLE       0x00000001
    593 #define SPP_HB_DISABLE      0x00000002
    594 #define SPP_HB_DEMAND       0x00000004
    595 #define SPP_PMTUD_ENABLE    0x00000008
    596 #define SPP_PMTUD_DISABLE   0x00000010
    597 #define SPP_HB_TIME_IS_ZERO 0x00000080
    598 #define SPP_IPV6_FLOWLABEL  0x00000100
    599 #define SPP_DSCP            0x00000200
    600 
    601 /* Used for SCTP_MAXSEG, SCTP_MAX_BURST, SCTP_ENABLE_STREAM_RESET, and SCTP_CONTEXT */
    602 struct sctp_assoc_value {
    603 	sctp_assoc_t assoc_id;
    604 	uint32_t assoc_value;
    605 };
    606 
    607 /* To enable stream reset */
    608 #define SCTP_ENABLE_RESET_STREAM_REQ  0x00000001
    609 #define SCTP_ENABLE_RESET_ASSOC_REQ   0x00000002
    610 #define SCTP_ENABLE_CHANGE_ASSOC_REQ  0x00000004
    611 #define SCTP_ENABLE_VALUE_MASK        0x00000007
    612 
    613 struct sctp_reset_streams {
    614 	sctp_assoc_t srs_assoc_id;
    615 	uint16_t srs_flags;
    616 	uint16_t srs_number_streams;  /* 0 == ALL */
    617 	uint16_t srs_stream_list[];   /* list if strrst_num_streams is not 0 */
    618 };
    619 
    620 struct sctp_add_streams {
    621 	sctp_assoc_t	sas_assoc_id;
    622 	uint16_t	sas_instrms;
    623 	uint16_t	sas_outstrms;
    624 };
    625 
    626 struct sctp_hmacalgo {
    627 	uint32_t shmac_number_of_idents;
    628 	uint16_t shmac_idents[];
    629 };
    630 
    631 /* AUTH hmac_id */
    632 #define SCTP_AUTH_HMAC_ID_RSVD    0x0000
    633 #define SCTP_AUTH_HMAC_ID_SHA1    0x0001	/* default, mandatory */
    634 #define SCTP_AUTH_HMAC_ID_SHA256  0x0003
    635 #define SCTP_AUTH_HMAC_ID_SHA224  0x0004
    636 #define SCTP_AUTH_HMAC_ID_SHA384  0x0005
    637 #define SCTP_AUTH_HMAC_ID_SHA512  0x0006
    638 
    639 
    640 struct sctp_sack_info {
    641 	sctp_assoc_t sack_assoc_id;
    642 	uint32_t sack_delay;
    643 	uint32_t sack_freq;
    644 };
    645 
    646 struct sctp_default_prinfo {
    647 	uint16_t pr_policy;
    648 	uint32_t pr_value;
    649 	sctp_assoc_t pr_assoc_id;
    650 };
    651 
    652 struct sctp_paddrinfo {
    653 	struct sockaddr_storage spinfo_address;
    654 	sctp_assoc_t spinfo_assoc_id;
    655 	int32_t spinfo_state;
    656 	uint32_t spinfo_cwnd;
    657 	uint32_t spinfo_srtt;
    658 	uint32_t spinfo_rto;
    659 	uint32_t spinfo_mtu;
    660 };
    661 
    662 struct sctp_status {
    663 	sctp_assoc_t sstat_assoc_id;
    664 	int32_t  sstat_state;
    665 	uint32_t sstat_rwnd;
    666 	uint16_t sstat_unackdata;
    667 	uint16_t sstat_penddata;
    668 	uint16_t sstat_instrms;
    669 	uint16_t sstat_outstrms;
    670 	uint32_t sstat_fragmentation_point;
    671 	struct sctp_paddrinfo sstat_primary;
    672 };
    673 
    674 /*
    675  * user state values
    676  */
    677 #define SCTP_CLOSED             0x0000
    678 #define SCTP_BOUND              0x1000
    679 #define SCTP_LISTEN             0x2000
    680 #define SCTP_COOKIE_WAIT        0x0002
    681 #define SCTP_COOKIE_ECHOED      0x0004
    682 #define SCTP_ESTABLISHED        0x0008
    683 #define SCTP_SHUTDOWN_SENT      0x0010
    684 #define SCTP_SHUTDOWN_RECEIVED  0x0020
    685 #define SCTP_SHUTDOWN_ACK_SENT  0x0040
    686 #define SCTP_SHUTDOWN_PENDING   0x0080
    687 
    688 
    689 #define SCTP_ACTIVE       0x0001  /* SCTP_ADDR_REACHABLE */
    690 #define SCTP_INACTIVE     0x0002  /* neither SCTP_ADDR_REACHABLE
    691                                      nor SCTP_ADDR_UNCONFIRMED */
    692 #define SCTP_UNCONFIRMED  0x0200  /* SCTP_ADDR_UNCONFIRMED */
    693 
    694 struct sctp_authchunks {
    695 	sctp_assoc_t gauth_assoc_id;
    696 /*	uint32_t gauth_number_of_chunks; not available */
    697 	uint8_t  gauth_chunks[];
    698 };
    699 
    700 struct sctp_assoc_ids {
    701 	uint32_t gaids_number_of_ids;
    702 	sctp_assoc_t gaids_assoc_id[];
    703 };
    704 
    705 struct sctp_setpeerprim {
    706 	struct sockaddr_storage sspp_addr;
    707 	sctp_assoc_t sspp_assoc_id;
    708 	uint8_t sspp_padding[4];
    709 };
    710 
    711 struct sctp_authchunk {
    712 	uint8_t sauth_chunk;
    713 };
    714 
    715 
    716 struct sctp_get_nonce_values {
    717 	sctp_assoc_t gn_assoc_id;
    718 	uint32_t gn_peers_tag;
    719 	uint32_t gn_local_tag;
    720 };
    721 
    722 
    723 /*
    724  * Main SCTP chunk types
    725  */
    726 /************0x00 series ***********/
    727 #define SCTP_DATA               0x00
    728 #define SCTP_INITIATION         0x01
    729 #define SCTP_INITIATION_ACK     0x02
    730 #define SCTP_SELECTIVE_ACK      0x03
    731 #define SCTP_HEARTBEAT_REQUEST  0x04
    732 #define SCTP_HEARTBEAT_ACK      0x05
    733 #define SCTP_ABORT_ASSOCIATION  0x06
    734 #define SCTP_SHUTDOWN           0x07
    735 #define SCTP_SHUTDOWN_ACK       0x08
    736 #define SCTP_OPERATION_ERROR    0x09
    737 #define SCTP_COOKIE_ECHO        0x0a
    738 #define SCTP_COOKIE_ACK         0x0b
    739 #define SCTP_ECN_ECHO           0x0c
    740 #define SCTP_ECN_CWR            0x0d
    741 #define SCTP_SHUTDOWN_COMPLETE  0x0e
    742 /* RFC4895 */
    743 #define SCTP_AUTHENTICATION     0x0f
    744 /* EY nr_sack chunk id*/
    745 #define SCTP_NR_SELECTIVE_ACK   0x10
    746 /************0x40 series ***********/
    747 /************0x80 series ***********/
    748 /* RFC5061 */
    749 #define	SCTP_ASCONF_ACK         0x80
    750 /* draft-ietf-stewart-pktdrpsctp */
    751 #define SCTP_PACKET_DROPPED     0x81
    752 /* draft-ietf-stewart-strreset-xxx */
    753 #define SCTP_STREAM_RESET       0x82
    754 
    755 /* RFC4820                         */
    756 #define SCTP_PAD_CHUNK          0x84
    757 /************0xc0 series ***********/
    758 /* RFC3758 */
    759 #define SCTP_FORWARD_CUM_TSN    0xc0
    760 /* RFC5061 */
    761 #define SCTP_ASCONF             0xc1
    762 
    763 struct sctp_authkey {
    764 	sctp_assoc_t sca_assoc_id;
    765 	uint16_t sca_keynumber;
    766 	uint16_t sca_keylength;
    767 	uint8_t  sca_key[];
    768 };
    769 
    770 struct sctp_authkeyid {
    771 	sctp_assoc_t scact_assoc_id;
    772 	uint16_t scact_keynumber;
    773 };
    774 
    775 struct sctp_cc_option {
    776 	int option;
    777 	struct sctp_assoc_value aid_value;
    778 };
    779 
    780 struct sctp_cwnd_args {
    781 	struct sctp_nets *net;   /* network to */ /* FIXME: LP64 issue */
    782 	uint32_t cwnd_new_value; /* cwnd in k */
    783 	uint32_t pseudo_cumack;
    784 	uint16_t inflight;       /* flightsize in k */
    785 	uint16_t cwnd_augment;   /* increment to it */
    786 	uint8_t meets_pseudo_cumack;
    787 	uint8_t need_new_pseudo_cumack;
    788 	uint8_t cnt_in_send;
    789 	uint8_t cnt_in_str;
    790 };
    791 
    792 struct sctp_blk_args {
    793 	uint32_t onsb;            /* in 1k bytes */
    794 	uint32_t sndlen;          /* len of send being attempted */
    795 	uint32_t peer_rwnd;       /* rwnd of peer */
    796 	uint16_t send_sent_qcnt;  /* chnk cnt */
    797 	uint16_t stream_qcnt;     /* chnk cnt */
    798 	uint16_t chunks_on_oque;  /* chunks out */
    799 	uint16_t flight_size;     /* flight size in k */
    800 };
    801 
    802 struct sctp_timeouts {
    803 	sctp_assoc_t stimo_assoc_id;
    804 	uint32_t stimo_init;
    805 	uint32_t stimo_data;
    806 	uint32_t stimo_sack;
    807 	uint32_t stimo_shutdown;
    808 	uint32_t stimo_heartbeat;
    809 	uint32_t stimo_cookie;
    810 	uint32_t stimo_shutdownack;
    811 };
    812 
    813 
    814 /* Standard TCP Congestion Control */
    815 #define SCTP_CC_RFC2581         0x00000000
    816 /* High Speed TCP Congestion Control (Floyd) */
    817 #define SCTP_CC_HSTCP           0x00000001
    818 /* HTCP Congestion Control */
    819 #define SCTP_CC_HTCP            0x00000002
    820 /* RTCC Congestion Control - RFC2581 plus */
    821 #define SCTP_CC_RTCC            0x00000003
    822 
    823 #define SCTP_CC_OPT_RTCC_SETMODE 0x00002000
    824 #define SCTP_CC_OPT_USE_DCCC_EC  0x00002001
    825 #define SCTP_CC_OPT_STEADY_STEP  0x00002002
    826 
    827 #define SCTP_CMT_OFF            0
    828 #define SCTP_CMT_BASE           1
    829 #define SCTP_CMT_RPV1           2
    830 #define SCTP_CMT_RPV2           3
    831 #define SCTP_CMT_MPTCP          4
    832 #define SCTP_CMT_MAX            SCTP_CMT_MPTCP
    833 
    834 /* RS - Supported stream scheduling modules for pluggable
    835  * stream scheduling
    836  */
    837 /* Default simple round-robin */
    838 #define SCTP_SS_DEFAULT             0x00000000
    839 /* Real round-robin */
    840 #define SCTP_SS_ROUND_ROBIN         0x00000001
    841 /* Real round-robin per packet */
    842 #define SCTP_SS_ROUND_ROBIN_PACKET  0x00000002
    843 /* Priority */
    844 #define SCTP_SS_PRIORITY            0x00000003
    845 /* Fair Bandwidth */
    846 #define SCTP_SS_FAIR_BANDWITH       0x00000004
    847 /* First-come, first-serve */
    848 #define SCTP_SS_FIRST_COME          0x00000005
    849 
    850 /******************** System calls *************/
    851 
    852 void
    853 usrsctp_init(uint16_t,
    854              int (*)(void *addr, void *buffer, size_t length, uint8_t tos, uint8_t set_df),
    855              void (*)(const char *format, ...));
    856 
    857 struct socket *
    858 usrsctp_socket(int domain, int type, int protocol,
    859                int (*receive_cb)(struct socket *sock, union sctp_sockstore addr, void *data,
    860                                  size_t datalen, struct sctp_rcvinfo, int flags, void *ulp_info),
    861                int (*send_cb)(struct socket *sock, uint32_t sb_free),
    862                uint32_t sb_threshold,
    863                void *ulp_info);
    864 
    865 int
    866 usrsctp_setsockopt(struct socket *so,
    867                    int level,
    868                    int option_name,
    869                    const void *option_value,
    870                    socklen_t option_len);
    871 
    872 int
    873 usrsctp_getsockopt(struct socket *so,
    874                    int level,
    875                    int option_name,
    876                    void *option_value,
    877                    socklen_t *option_len);
    878 
    879 int
    880 usrsctp_getpaddrs(struct socket *so,
    881                   sctp_assoc_t id,
    882                   struct sockaddr **raddrs);
    883 
    884 void
    885 usrsctp_freepaddrs(struct sockaddr *addrs);
    886 
    887 int
    888 usrsctp_getladdrs(struct socket *so,
    889                   sctp_assoc_t id,
    890                   struct sockaddr **raddrs);
    891 
    892 void
    893 usrsctp_freeladdrs(struct sockaddr *addrs);
    894 
    895 ssize_t
    896 usrsctp_sendv(struct socket *so,
    897               const void *data,
    898               size_t len,
    899               struct sockaddr *to,
    900               int addrcnt,
    901               void *info,
    902               socklen_t infolen,
    903               unsigned int infotype,
    904               int flags);
    905 
    906 ssize_t
    907 usrsctp_recvv(struct socket *so,
    908               void *dbuf,
    909               size_t len,
    910               struct sockaddr *from,
    911               socklen_t * fromlen,
    912               void *info,
    913               socklen_t *infolen,
    914               unsigned int *infotype,
    915               int *msg_flags);
    916 
    917 int
    918 usrsctp_bind(struct socket *so,
    919              struct sockaddr *name,
    920              socklen_t namelen);
    921 
    922 #define SCTP_BINDX_ADD_ADDR 0x00008001
    923 #define SCTP_BINDX_REM_ADDR 0x00008002
    924 
    925 int
    926 usrsctp_bindx(struct socket *so,
    927               struct sockaddr *addrs,
    928               int addrcnt,
    929               int flags);
    930 
    931 int
    932 usrsctp_listen(struct socket *so,
    933                int backlog);
    934 
    935 struct socket *
    936 usrsctp_accept(struct socket *so,
    937                struct sockaddr * aname,
    938                socklen_t * anamelen);
    939 
    940 struct socket *
    941 usrsctp_peeloff(struct socket *, sctp_assoc_t);
    942 
    943 int
    944 usrsctp_connect(struct socket *so,
    945                 struct sockaddr *name,
    946                 socklen_t namelen);
    947 
    948 int
    949 usrsctp_connectx(struct socket *so,
    950                  const struct sockaddr *addrs, int addrcnt,
    951                  sctp_assoc_t *id);
    952 
    953 void
    954 usrsctp_close(struct socket *so);
    955 
    956 int
    957 usrsctp_finish(void);
    958 
    959 int
    960 usrsctp_shutdown(struct socket *so, int how);
    961 
    962 void
    963 usrsctp_conninput(void *, const void *, size_t, uint8_t);
    964 
    965 int
    966 usrsctp_set_non_blocking(struct socket *, int);
    967 
    968 int
    969 usrsctp_get_non_blocking(struct socket *);
    970 
    971 void
    972 usrsctp_register_address(void *);
    973 
    974 void
    975 usrsctp_deregister_address(void *);
    976 
    977 #define SCTP_DUMP_OUTBOUND 1
    978 #define SCTP_DUMP_INBOUND  0
    979 
    980 char *
    981 usrsctp_dumppacket(void *, size_t, int);
    982 
    983 void
    984 usrsctp_freedumpbuffer(char *);
    985 
    986 #define USRSCTP_SYSCTL_DECL(__field)                \
    987 void usrsctp_sysctl_set_ ## __field(uint32_t value);\
    988 uint32_t usrsctp_sysctl_get_ ## __field(void);
    989 
    990 USRSCTP_SYSCTL_DECL(sctp_sendspace)
    991 USRSCTP_SYSCTL_DECL(sctp_recvspace)
    992 USRSCTP_SYSCTL_DECL(sctp_auto_asconf)
    993 USRSCTP_SYSCTL_DECL(sctp_multiple_asconfs)
    994 USRSCTP_SYSCTL_DECL(sctp_ecn_enable)
    995 USRSCTP_SYSCTL_DECL(sctp_pr_enable)
    996 USRSCTP_SYSCTL_DECL(sctp_auth_enable)
    997 USRSCTP_SYSCTL_DECL(sctp_asconf_enable)
    998 USRSCTP_SYSCTL_DECL(sctp_reconfig_enable)
    999 USRSCTP_SYSCTL_DECL(sctp_nrsack_enable)
   1000 USRSCTP_SYSCTL_DECL(sctp_pktdrop_enable)
   1001 USRSCTP_SYSCTL_DECL(sctp_strict_sacks)
   1002 #if !defined(SCTP_WITH_NO_CSUM)
   1003 USRSCTP_SYSCTL_DECL(sctp_no_csum_on_loopback)
   1004 #endif
   1005 USRSCTP_SYSCTL_DECL(sctp_peer_chunk_oh)
   1006 USRSCTP_SYSCTL_DECL(sctp_max_burst_default)
   1007 USRSCTP_SYSCTL_DECL(sctp_max_chunks_on_queue)
   1008 USRSCTP_SYSCTL_DECL(sctp_hashtblsize)
   1009 USRSCTP_SYSCTL_DECL(sctp_pcbtblsize)
   1010 USRSCTP_SYSCTL_DECL(sctp_min_split_point)
   1011 USRSCTP_SYSCTL_DECL(sctp_chunkscale)
   1012 USRSCTP_SYSCTL_DECL(sctp_delayed_sack_time_default)
   1013 USRSCTP_SYSCTL_DECL(sctp_sack_freq_default)
   1014 USRSCTP_SYSCTL_DECL(sctp_system_free_resc_limit)
   1015 USRSCTP_SYSCTL_DECL(sctp_asoc_free_resc_limit)
   1016 USRSCTP_SYSCTL_DECL(sctp_heartbeat_interval_default)
   1017 USRSCTP_SYSCTL_DECL(sctp_pmtu_raise_time_default)
   1018 USRSCTP_SYSCTL_DECL(sctp_shutdown_guard_time_default)
   1019 USRSCTP_SYSCTL_DECL(sctp_secret_lifetime_default)
   1020 USRSCTP_SYSCTL_DECL(sctp_rto_max_default)
   1021 USRSCTP_SYSCTL_DECL(sctp_rto_min_default)
   1022 USRSCTP_SYSCTL_DECL(sctp_rto_initial_default)
   1023 USRSCTP_SYSCTL_DECL(sctp_init_rto_max_default)
   1024 USRSCTP_SYSCTL_DECL(sctp_valid_cookie_life_default)
   1025 USRSCTP_SYSCTL_DECL(sctp_init_rtx_max_default)
   1026 USRSCTP_SYSCTL_DECL(sctp_assoc_rtx_max_default)
   1027 USRSCTP_SYSCTL_DECL(sctp_path_rtx_max_default)
   1028 USRSCTP_SYSCTL_DECL(sctp_add_more_threshold)
   1029 USRSCTP_SYSCTL_DECL(sctp_nr_incoming_streams_default)
   1030 USRSCTP_SYSCTL_DECL(sctp_nr_outgoing_streams_default)
   1031 USRSCTP_SYSCTL_DECL(sctp_cmt_on_off)
   1032 USRSCTP_SYSCTL_DECL(sctp_cmt_use_dac)
   1033 USRSCTP_SYSCTL_DECL(sctp_use_cwnd_based_maxburst)
   1034 USRSCTP_SYSCTL_DECL(sctp_nat_friendly)
   1035 USRSCTP_SYSCTL_DECL(sctp_L2_abc_variable)
   1036 USRSCTP_SYSCTL_DECL(sctp_mbuf_threshold_count)
   1037 USRSCTP_SYSCTL_DECL(sctp_do_drain)
   1038 USRSCTP_SYSCTL_DECL(sctp_hb_maxburst)
   1039 USRSCTP_SYSCTL_DECL(sctp_abort_if_one_2_one_hits_limit)
   1040 USRSCTP_SYSCTL_DECL(sctp_strict_data_order)
   1041 USRSCTP_SYSCTL_DECL(sctp_min_residual)
   1042 USRSCTP_SYSCTL_DECL(sctp_max_retran_chunk)
   1043 USRSCTP_SYSCTL_DECL(sctp_logging_level)
   1044 USRSCTP_SYSCTL_DECL(sctp_default_cc_module)
   1045 USRSCTP_SYSCTL_DECL(sctp_default_frag_interleave)
   1046 USRSCTP_SYSCTL_DECL(sctp_mobility_base)
   1047 USRSCTP_SYSCTL_DECL(sctp_mobility_fasthandoff)
   1048 USRSCTP_SYSCTL_DECL(sctp_inits_include_nat_friendly)
   1049 USRSCTP_SYSCTL_DECL(sctp_udp_tunneling_port)
   1050 USRSCTP_SYSCTL_DECL(sctp_enable_sack_immediately)
   1051 USRSCTP_SYSCTL_DECL(sctp_vtag_time_wait)
   1052 USRSCTP_SYSCTL_DECL(sctp_blackhole)
   1053 USRSCTP_SYSCTL_DECL(sctp_diag_info_code)
   1054 USRSCTP_SYSCTL_DECL(sctp_fr_max_burst_default)
   1055 USRSCTP_SYSCTL_DECL(sctp_path_pf_threshold)
   1056 USRSCTP_SYSCTL_DECL(sctp_default_ss_module)
   1057 USRSCTP_SYSCTL_DECL(sctp_rttvar_bw)
   1058 USRSCTP_SYSCTL_DECL(sctp_rttvar_rtt)
   1059 USRSCTP_SYSCTL_DECL(sctp_rttvar_eqret)
   1060 USRSCTP_SYSCTL_DECL(sctp_steady_step)
   1061 USRSCTP_SYSCTL_DECL(sctp_use_dccc_ecn)
   1062 USRSCTP_SYSCTL_DECL(sctp_buffer_splitting)
   1063 USRSCTP_SYSCTL_DECL(sctp_initial_cwnd)
   1064 #ifdef SCTP_DEBUG
   1065 USRSCTP_SYSCTL_DECL(sctp_debug_on)
   1066 /* More specific values can be found in sctp_constants, but
   1067  * are not considered to be part of the API.
   1068  */
   1069 #define SCTP_DEBUG_NONE 0x00000000
   1070 #define SCTP_DEBUG_ALL  0xffffffff
   1071 #endif
   1072 #undef USRSCTP_SYSCTL_DECL
   1073 struct sctp_timeval {
   1074 	uint32_t tv_sec;
   1075 	uint32_t tv_usec;
   1076 };
   1077 
   1078 struct sctpstat {
   1079 	struct sctp_timeval sctps_discontinuitytime; /* sctpStats 18 (TimeStamp) */
   1080 	/* MIB according to RFC 3873 */
   1081 	uint32_t  sctps_currestab;           /* sctpStats  1   (Gauge32) */
   1082 	uint32_t  sctps_activeestab;         /* sctpStats  2 (Counter32) */
   1083 	uint32_t  sctps_restartestab;
   1084 	uint32_t  sctps_collisionestab;
   1085 	uint32_t  sctps_passiveestab;        /* sctpStats  3 (Counter32) */
   1086 	uint32_t  sctps_aborted;             /* sctpStats  4 (Counter32) */
   1087 	uint32_t  sctps_shutdown;            /* sctpStats  5 (Counter32) */
   1088 	uint32_t  sctps_outoftheblue;        /* sctpStats  6 (Counter32) */
   1089 	uint32_t  sctps_checksumerrors;      /* sctpStats  7 (Counter32) */
   1090 	uint32_t  sctps_outcontrolchunks;    /* sctpStats  8 (Counter64) */
   1091 	uint32_t  sctps_outorderchunks;      /* sctpStats  9 (Counter64) */
   1092 	uint32_t  sctps_outunorderchunks;    /* sctpStats 10 (Counter64) */
   1093 	uint32_t  sctps_incontrolchunks;     /* sctpStats 11 (Counter64) */
   1094 	uint32_t  sctps_inorderchunks;       /* sctpStats 12 (Counter64) */
   1095 	uint32_t  sctps_inunorderchunks;     /* sctpStats 13 (Counter64) */
   1096 	uint32_t  sctps_fragusrmsgs;         /* sctpStats 14 (Counter64) */
   1097 	uint32_t  sctps_reasmusrmsgs;        /* sctpStats 15 (Counter64) */
   1098 	uint32_t  sctps_outpackets;          /* sctpStats 16 (Counter64) */
   1099 	uint32_t  sctps_inpackets;           /* sctpStats 17 (Counter64) */
   1100 
   1101 	/* input statistics: */
   1102 	uint32_t  sctps_recvpackets;         /* total input packets        */
   1103 	uint32_t  sctps_recvdatagrams;       /* total input datagrams      */
   1104 	uint32_t  sctps_recvpktwithdata;     /* total packets that had data */
   1105 	uint32_t  sctps_recvsacks;           /* total input SACK chunks    */
   1106 	uint32_t  sctps_recvdata;            /* total input DATA chunks    */
   1107 	uint32_t  sctps_recvdupdata;         /* total input duplicate DATA chunks */
   1108 	uint32_t  sctps_recvheartbeat;       /* total input HB chunks      */
   1109 	uint32_t  sctps_recvheartbeatack;    /* total input HB-ACK chunks  */
   1110 	uint32_t  sctps_recvecne;            /* total input ECNE chunks    */
   1111 	uint32_t  sctps_recvauth;            /* total input AUTH chunks    */
   1112 	uint32_t  sctps_recvauthmissing;     /* total input chunks missing AUTH */
   1113 	uint32_t  sctps_recvivalhmacid;      /* total number of invalid HMAC ids received */
   1114 	uint32_t  sctps_recvivalkeyid;       /* total number of invalid secret ids received */
   1115 	uint32_t  sctps_recvauthfailed;      /* total number of auth failed */
   1116 	uint32_t  sctps_recvexpress;         /* total fast path receives all one chunk */
   1117 	uint32_t  sctps_recvexpressm;        /* total fast path multi-part data */
   1118 	uint32_t  sctps_recvnocrc;
   1119 	uint32_t  sctps_recvswcrc;
   1120 	uint32_t  sctps_recvhwcrc;
   1121 
   1122 	/* output statistics: */
   1123 	uint32_t  sctps_sendpackets;         /* total output packets       */
   1124 	uint32_t  sctps_sendsacks;           /* total output SACKs         */
   1125 	uint32_t  sctps_senddata;            /* total output DATA chunks   */
   1126 	uint32_t  sctps_sendretransdata;     /* total output retransmitted DATA chunks */
   1127 	uint32_t  sctps_sendfastretrans;     /* total output fast retransmitted DATA chunks */
   1128 	uint32_t  sctps_sendmultfastretrans; /* total FR's that happened more than once
   1129 	                                      * to same chunk (u-del multi-fr algo).
   1130 	                                      */
   1131 	uint32_t  sctps_sendheartbeat;       /* total output HB chunks     */
   1132 	uint32_t  sctps_sendecne;            /* total output ECNE chunks    */
   1133 	uint32_t  sctps_sendauth;            /* total output AUTH chunks FIXME   */
   1134 	uint32_t  sctps_senderrors;          /* ip_output error counter */
   1135 	uint32_t  sctps_sendnocrc;
   1136 	uint32_t  sctps_sendswcrc;
   1137 	uint32_t  sctps_sendhwcrc;
   1138 	/* PCKDROPREP statistics: */
   1139 	uint32_t  sctps_pdrpfmbox;           /* Packet drop from middle box */
   1140 	uint32_t  sctps_pdrpfehos;           /* P-drop from end host */
   1141 	uint32_t  sctps_pdrpmbda;            /* P-drops with data */
   1142 	uint32_t  sctps_pdrpmbct;            /* P-drops, non-data, non-endhost */
   1143 	uint32_t  sctps_pdrpbwrpt;           /* P-drop, non-endhost, bandwidth rep only */
   1144 	uint32_t  sctps_pdrpcrupt;           /* P-drop, not enough for chunk header */
   1145 	uint32_t  sctps_pdrpnedat;           /* P-drop, not enough data to confirm */
   1146 	uint32_t  sctps_pdrppdbrk;           /* P-drop, where process_chunk_drop said break */
   1147 	uint32_t  sctps_pdrptsnnf;           /* P-drop, could not find TSN */
   1148 	uint32_t  sctps_pdrpdnfnd;           /* P-drop, attempt reverse TSN lookup */
   1149 	uint32_t  sctps_pdrpdiwnp;           /* P-drop, e-host confirms zero-rwnd */
   1150 	uint32_t  sctps_pdrpdizrw;           /* P-drop, midbox confirms no space */
   1151 	uint32_t  sctps_pdrpbadd;            /* P-drop, data did not match TSN */
   1152 	uint32_t  sctps_pdrpmark;            /* P-drop, TSN's marked for Fast Retran */
   1153 	/* timeouts */
   1154 	uint32_t  sctps_timoiterator;        /* Number of iterator timers that fired */
   1155 	uint32_t  sctps_timodata;            /* Number of T3 data time outs */
   1156 	uint32_t  sctps_timowindowprobe;     /* Number of window probe (T3) timers that fired */
   1157 	uint32_t  sctps_timoinit;            /* Number of INIT timers that fired */
   1158 	uint32_t  sctps_timosack;            /* Number of sack timers that fired */
   1159 	uint32_t  sctps_timoshutdown;        /* Number of shutdown timers that fired */
   1160 	uint32_t  sctps_timoheartbeat;       /* Number of heartbeat timers that fired */
   1161 	uint32_t  sctps_timocookie;          /* Number of times a cookie timeout fired */
   1162 	uint32_t  sctps_timosecret;          /* Number of times an endpoint changed its cookie secret*/
   1163 	uint32_t  sctps_timopathmtu;         /* Number of PMTU timers that fired */
   1164 	uint32_t  sctps_timoshutdownack;     /* Number of shutdown ack timers that fired */
   1165 	uint32_t  sctps_timoshutdownguard;   /* Number of shutdown guard timers that fired */
   1166 	uint32_t  sctps_timostrmrst;         /* Number of stream reset timers that fired */
   1167 	uint32_t  sctps_timoearlyfr;         /* Number of early FR timers that fired */
   1168 	uint32_t  sctps_timoasconf;          /* Number of times an asconf timer fired */
   1169 	uint32_t  sctps_timodelprim;	     /* Number of times a prim_deleted timer fired */
   1170 	uint32_t  sctps_timoautoclose;       /* Number of times auto close timer fired */
   1171 	uint32_t  sctps_timoassockill;       /* Number of asoc free timers expired */
   1172 	uint32_t  sctps_timoinpkill;         /* Number of inp free timers expired */
   1173 	/* former early FR counters */
   1174 	uint32_t  sctps_spare[11];
   1175 	/* others */
   1176 	uint32_t  sctps_hdrops;              /* packet shorter than header */
   1177 	uint32_t  sctps_badsum;              /* checksum error             */
   1178 	uint32_t  sctps_noport;              /* no endpoint for port       */
   1179 	uint32_t  sctps_badvtag;             /* bad v-tag                  */
   1180 	uint32_t  sctps_badsid;              /* bad SID                    */
   1181 	uint32_t  sctps_nomem;               /* no memory                  */
   1182 	uint32_t  sctps_fastretransinrtt;    /* number of multiple FR in a RTT window */
   1183 	uint32_t  sctps_markedretrans;
   1184 	uint32_t  sctps_naglesent;           /* nagle allowed sending      */
   1185 	uint32_t  sctps_naglequeued;         /* nagle doesn't allow sending */
   1186 	uint32_t  sctps_maxburstqueued;      /* max burst doesn't allow sending */
   1187 	uint32_t  sctps_ifnomemqueued;       /* look ahead tells us no memory in
   1188 	                                      * interface ring buffer OR we had a
   1189 	                                      * send error and are queuing one send.
   1190 	                                      */
   1191 	uint32_t  sctps_windowprobed;        /* total number of window probes sent */
   1192 	uint32_t  sctps_lowlevelerr;         /* total times an output error causes us
   1193 	                                      * to clamp down on next user send.
   1194 	                                      */
   1195 	uint32_t  sctps_lowlevelerrusr;      /* total times sctp_senderrors were caused from
   1196 	                                      * a user send from a user invoked send not
   1197 	                                      * a sack response
   1198 	                                      */
   1199 	uint32_t  sctps_datadropchklmt;      /* Number of in data drops due to chunk limit reached */
   1200 	uint32_t  sctps_datadroprwnd;        /* Number of in data drops due to rwnd limit reached */
   1201 	uint32_t  sctps_ecnereducedcwnd;     /* Number of times a ECN reduced the cwnd */
   1202 	uint32_t  sctps_vtagexpress;         /* Used express lookup via vtag */
   1203 	uint32_t  sctps_vtagbogus;           /* Collision in express lookup. */
   1204 	uint32_t  sctps_primary_randry;      /* Number of times the sender ran dry of user data on primary */
   1205 	uint32_t  sctps_cmt_randry;          /* Same for above */
   1206 	uint32_t  sctps_slowpath_sack;       /* Sacks the slow way */
   1207 	uint32_t  sctps_wu_sacks_sent;       /* Window Update only sacks sent */
   1208 	uint32_t  sctps_sends_with_flags;    /* number of sends with sinfo_flags !=0 */
   1209 	uint32_t  sctps_sends_with_unord;    /* number of unordered sends */
   1210 	uint32_t  sctps_sends_with_eof;      /* number of sends with EOF flag set */
   1211 	uint32_t  sctps_sends_with_abort;    /* number of sends with ABORT flag set */
   1212 	uint32_t  sctps_protocol_drain_calls;/* number of times protocol drain called */
   1213 	uint32_t  sctps_protocol_drains_done;/* number of times we did a protocol drain */
   1214 	uint32_t  sctps_read_peeks;          /* Number of times recv was called with peek */
   1215 	uint32_t  sctps_cached_chk;          /* Number of cached chunks used */
   1216 	uint32_t  sctps_cached_strmoq;       /* Number of cached stream oq's used */
   1217 	uint32_t  sctps_left_abandon;        /* Number of unread messages abandoned by close */
   1218 	uint32_t  sctps_send_burst_avoid;    /* Unused */
   1219 	uint32_t  sctps_send_cwnd_avoid;     /* Send cwnd full  avoidance, already max burst inflight to net */
   1220 	uint32_t  sctps_fwdtsn_map_over;     /* number of map array over-runs via fwd-tsn's */
   1221 	uint32_t  sctps_queue_upd_ecne;      /* Number of times we queued or updated an ECN chunk on send queue */
   1222 	uint32_t  sctps_reserved[31];        /* Future ABI compat - remove int's from here when adding new */
   1223 };
   1224 
   1225 void
   1226 usrsctp_get_stat(struct sctpstat *);
   1227 
   1228 #ifdef _WIN32
   1229 #ifdef _MSC_VER
   1230 #pragma warning(default: 4200)
   1231 #endif
   1232 #endif
   1233 #ifdef  __cplusplus
   1234 }
   1235 #endif
   1236 #endif
   1237