sys/netinet/sctp_uio.h

   1 /*-
   2  * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  * a) Redistributions of source code must retain the above copyright notice,
   8  *   this list of conditions and the following disclaimer.
   9  *
  10  * b) Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in
  12  *   the documentation and/or other materials provided with the distribution.
  13  *
  14  * c) Neither the name of Cisco Systems, Inc. nor the names of its
  15  *    contributors may be used to endorse or promote products derived
  16  *    from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  20  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  28  * THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 /* $KAME: sctp_uio.h,v 1.11 2005/03/06 16:04:18 itojun Exp $     */
  32 #include <sys/cdefs.h>
  33 __FBSDID("$FreeBSD$");
  34
  35 #ifndef __sctp_uio_h__
  36 #define __sctp_uio_h__
  37
  38
  39 #if ! defined(_KERNEL)
  40 #include <stdint.h>
  41 #endif
  42 #include <sys/types.h>
  43 #include <sys/socket.h>
  44 #include <sys/time.h>
  45 #include <netinet/in.h>
  46
  47 typedef uint32_t sctp_assoc_t;
  48
  49 /* On/Off setup for subscription to events */
  50 struct sctp_event_subscribe {
  51         uint8_t sctp_data_io_event;
  52         uint8_t sctp_association_event;
  53         uint8_t sctp_address_event;
  54         uint8_t sctp_send_failure_event;
  55         uint8_t sctp_peer_error_event;
  56         uint8_t sctp_shutdown_event;
  57         uint8_t sctp_partial_delivery_event;
  58         uint8_t sctp_adaptation_layer_event;
  59         uint8_t sctp_authentication_event;
  60         uint8_t sctp_stream_reset_events;
  61 };
  62
  63 /* ancillary data types */
  64 #define SCTP_INIT       0x0001
  65 #define SCTP_SNDRCV     0x0002
  66 #define SCTP_EXTRCV     0x0003
  67 /*
  68  * ancillary data structures
  69  */
  70 struct sctp_initmsg {
  71         uint32_t sinit_num_ostreams;
  72         uint32_t sinit_max_instreams;
  73         uint16_t sinit_max_attempts;
  74         uint16_t sinit_max_init_timeo;
  75 };
  76
  77 /* We add 96 bytes to the size of sctp_sndrcvinfo.
  78  * This makes the current structure 128 bytes long
  79  * which is nicely 64 bit aligned but also has room
  80  * for us to add more and keep ABI compatability.
  81  * For example, already we have the sctp_extrcvinfo
  82  * when enabled which is 48 bytes.
  83  */
  84
  85 /*
  86  * The assoc up needs a verfid
  87  * all sendrcvinfo's need a verfid for SENDING only.
  88  */
  89
  90
  91 #define SCTP_ALIGN_RESV_PAD 96
  92 #define SCTP_ALIGN_RESV_PAD_SHORT 80
  93
  94 struct sctp_sndrcvinfo {
  95         uint16_t sinfo_stream;
  96         uint16_t sinfo_ssn;
  97         uint16_t sinfo_flags;
  98         uint16_t sinfo_pr_policy;
  99         uint32_t sinfo_ppid;
 100         uint32_t sinfo_context;
 101         uint32_t sinfo_timetolive;
 102         uint32_t sinfo_tsn;
 103         uint32_t sinfo_cumtsn;
 104         sctp_assoc_t sinfo_assoc_id;
 105         uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD];
 106 };
 107
 108 struct sctp_extrcvinfo {
 109         uint16_t sinfo_stream;
 110         uint16_t sinfo_ssn;
 111         uint16_t sinfo_flags;
 112         uint16_t sinfo_pr_policy;
 113         uint32_t sinfo_ppid;
 114         uint32_t sinfo_context;
 115         uint32_t sinfo_timetolive;
 116         uint32_t sinfo_tsn;
 117         uint32_t sinfo_cumtsn;
 118         sctp_assoc_t sinfo_assoc_id;
 119         uint16_t sreinfo_next_flags;
 120         uint16_t sreinfo_next_stream;
 121         uint32_t sreinfo_next_aid;
 122         uint32_t sreinfo_next_length;
 123         uint32_t sreinfo_next_ppid;
 124         uint8_t __reserve_pad[SCTP_ALIGN_RESV_PAD_SHORT];
 125 };
 126
 127 #define SCTP_NO_NEXT_MSG           0x0000
 128 #define SCTP_NEXT_MSG_AVAIL        0x0001
 129 #define SCTP_NEXT_MSG_ISCOMPLETE   0x0002
 130 #define SCTP_NEXT_MSG_IS_UNORDERED 0x0004
 131 #define SCTP_NEXT_MSG_IS_NOTIFICATION 0x0008
 132
 133 struct sctp_snd_all_completes {
 134         uint16_t sall_stream;
 135         uint16_t sall_flags;
 136         uint32_t sall_ppid;
 137         uint32_t sall_context;
 138         uint32_t sall_num_sent;
 139         uint32_t sall_num_failed;
 140 };
 141
 142 /* Flags that go into the sinfo->sinfo_flags field */
 143 #define SCTP_EOF          0x0100/* Start shutdown procedures */
 144 #define SCTP_ABORT        0x0200/* Send an ABORT to peer */
 145 #define SCTP_UNORDERED    0x0400/* Message is un-ordered */
 146 #define SCTP_ADDR_OVER    0x0800/* Override the primary-address */
 147 #define SCTP_SENDALL      0x1000/* Send this on all associations */
 148 #define SCTP_EOR          0x2000/* end of message signal */
 149 #define SCTP_PR_POLICY_VALID 0x4000     /* pr sctp policy valid */
 150
 151 #define INVALID_SINFO_FLAG(x) (((x) & 0xffffff00 \
 152                                     & ~(SCTP_EOF | SCTP_ABORT | SCTP_UNORDERED |\
 153                                         SCTP_ADDR_OVER | SCTP_SENDALL | SCTP_EOR)) != 0)
 154 /* for the endpoint */
 155
 156 /* The lower byte is an enumeration of PR-SCTP policies */
 157 #define SCTP_PR_SCTP_TTL  0x0001/* Time based PR-SCTP */
 158 #define SCTP_PR_SCTP_BUF  0x0002/* Buffer based PR-SCTP */
 159 #define SCTP_PR_SCTP_RTX  0x0003/* Number of retransmissions based PR-SCTP */
 160
 161 #define PR_SCTP_POLICY(x)         ((x) & 0xff)
 162 #define PR_SCTP_ENABLED(x)        (PR_SCTP_POLICY(x) != 0)
 163 #define PR_SCTP_TTL_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_TTL)
 164 #define PR_SCTP_BUF_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_BUF)
 165 #define PR_SCTP_RTX_ENABLED(x)    (PR_SCTP_POLICY(x) == SCTP_PR_SCTP_RTX)
 166 #define PR_SCTP_INVALID_POLICY(x) (PR_SCTP_POLICY(x) > SCTP_PR_SCTP_RTX)
 167 /* Stat's */
 168 struct sctp_pcbinfo {
 169         uint32_t ep_count;
 170         uint32_t asoc_count;
 171         uint32_t laddr_count;
 172         uint32_t raddr_count;
 173         uint32_t chk_count;
 174         uint32_t readq_count;
 175         uint32_t free_chunks;
 176         uint32_t stream_oque;
 177 };
 178
 179 struct sctp_sockstat {
 180         sctp_assoc_t ss_assoc_id;
 181         uint32_t ss_total_sndbuf;
 182         uint32_t ss_total_recv_buf;
 183 };
 184
 185 /*
 186  * notification event structures
 187  */
 188
 189 /*
 190  * association change event
 191  */
 192 struct sctp_assoc_change {
 193         uint16_t sac_type;
 194         uint16_t sac_flags;
 195         uint32_t sac_length;
 196         uint16_t sac_state;
 197         uint16_t sac_error;
 198         uint16_t sac_outbound_streams;
 199         uint16_t sac_inbound_streams;
 200         sctp_assoc_t sac_assoc_id;
 201 };
 202
 203 /* sac_state values */
 204 #define SCTP_COMM_UP            0x0001
 205 #define SCTP_COMM_LOST          0x0002
 206 #define SCTP_RESTART            0x0003
 207 #define SCTP_SHUTDOWN_COMP      0x0004
 208 #define SCTP_CANT_STR_ASSOC     0x0005
 209
 210
 211 /*
 212  * Address event
 213  */
 214 struct sctp_paddr_change {
 215         uint16_t spc_type;
 216         uint16_t spc_flags;
 217         uint32_t spc_length;
 218         struct sockaddr_storage spc_aaddr;
 219         uint32_t spc_state;
 220         uint32_t spc_error;
 221         sctp_assoc_t spc_assoc_id;
 222         uint8_t spc_padding[4];
 223 };
 224
 225 /* paddr state values */
 226 #define SCTP_ADDR_AVAILABLE     0x0001
 227 #define SCTP_ADDR_UNREACHABLE   0x0002
 228 #define SCTP_ADDR_REMOVED       0x0003
 229 #define SCTP_ADDR_ADDED         0x0004
 230 #define SCTP_ADDR_MADE_PRIM     0x0005
 231 #define SCTP_ADDR_CONFIRMED     0x0006
 232
 233 /*
 234  * CAUTION: these are user exposed SCTP addr reachability states must be
 235  * compatible with SCTP_ADDR states in sctp_constants.h
 236  */
 237 #ifdef SCTP_ACTIVE
 238 #undef SCTP_ACTIVE
 239 #endif
 240 #define SCTP_ACTIVE             0x0001  /* SCTP_ADDR_REACHABLE */
 241
 242 #ifdef SCTP_INACTIVE
 243 #undef SCTP_INACTIVE
 244 #endif
 245 #define SCTP_INACTIVE           0x0002  /* SCTP_ADDR_NOT_REACHABLE */
 246
 247 #ifdef SCTP_UNCONFIRMED
 248 #undef SCTP_UNCONFIRMED
 249 #endif
 250 #define SCTP_UNCONFIRMED        0x0200  /* SCTP_ADDR_UNCONFIRMED */
 251
 252 #ifdef SCTP_NOHEARTBEAT
 253 #undef SCTP_NOHEARTBEAT
 254 #endif
 255 #define SCTP_NOHEARTBEAT        0x0040  /* SCTP_ADDR_NOHB */
 256
 257
 258 /* remote error events */
 259 struct sctp_remote_error {
 260         uint16_t sre_type;
 261         uint16_t sre_flags;
 262         uint32_t sre_length;
 263         uint16_t sre_error;
 264         sctp_assoc_t sre_assoc_id;
 265         uint8_t sre_data[4];
 266 };
 267
 268 /* data send failure event */
 269 struct sctp_send_failed {
 270         uint16_t ssf_type;
 271         uint16_t ssf_flags;
 272         uint32_t ssf_length;
 273         uint32_t ssf_error;
 274         struct sctp_sndrcvinfo ssf_info;
 275         sctp_assoc_t ssf_assoc_id;
 276         uint8_t ssf_data[0];
 277 };
 278
 279 /* flag that indicates state of data */
 280 #define SCTP_DATA_UNSENT        0x0001  /* inqueue never on wire */
 281 #define SCTP_DATA_SENT          0x0002  /* on wire at failure */
 282
 283 /* shutdown event */
 284 struct sctp_shutdown_event {
 285         uint16_t sse_type;
 286         uint16_t sse_flags;
 287         uint32_t sse_length;
 288         sctp_assoc_t sse_assoc_id;
 289 };
 290
 291 /* Adaptation layer indication stuff */
 292 struct sctp_adaptation_event {
 293         uint16_t sai_type;
 294         uint16_t sai_flags;
 295         uint32_t sai_length;
 296         uint32_t sai_adaptation_ind;
 297         sctp_assoc_t sai_assoc_id;
 298 };
 299
 300 struct sctp_setadaptation {
 301         uint32_t ssb_adaptation_ind;
 302 };
 303
 304 /* compatable old spelling */
 305 struct sctp_adaption_event {
 306         uint16_t sai_type;
 307         uint16_t sai_flags;
 308         uint32_t sai_length;
 309         uint32_t sai_adaption_ind;
 310         sctp_assoc_t sai_assoc_id;
 311 };
 312
 313 struct sctp_setadaption {
 314         uint32_t ssb_adaption_ind;
 315 };
 316
 317
 318 /*
 319  * Partial Delivery API event
 320  */
 321 struct sctp_pdapi_event {
 322         uint16_t pdapi_type;
 323         uint16_t pdapi_flags;
 324         uint32_t pdapi_length;
 325         uint32_t pdapi_indication;
 326         uint16_t pdapi_stream;
 327         uint16_t pdapi_seq;
 328         sctp_assoc_t pdapi_assoc_id;
 329 };
 330
 331 /* indication values */
 332 #define SCTP_PARTIAL_DELIVERY_ABORTED   0x0001
 333
 334
 335 /*
 336  * authentication key event
 337  */
 338 struct sctp_authkey_event {
 339         uint16_t auth_type;
 340         uint16_t auth_flags;
 341         uint32_t auth_length;
 342         uint16_t auth_keynumber;
 343         uint16_t auth_altkeynumber;
 344         uint32_t auth_indication;
 345         sctp_assoc_t auth_assoc_id;
 346 };
 347
 348 /* indication values */
 349 #define SCTP_AUTH_NEWKEY        0x0001
 350
 351
 352 /*
 353  * stream reset event
 354  */
 355 struct sctp_stream_reset_event {
 356         uint16_t strreset_type;
 357         uint16_t strreset_flags;
 358         uint32_t strreset_length;
 359         sctp_assoc_t strreset_assoc_id;
 360         uint16_t strreset_list[0];
 361 };
 362
 363 /* flags in strreset_flags field */
 364 #define SCTP_STRRESET_INBOUND_STR  0x0001
 365 #define SCTP_STRRESET_OUTBOUND_STR 0x0002
 366 #define SCTP_STRRESET_ALL_STREAMS  0x0004
 367 #define SCTP_STRRESET_STREAM_LIST  0x0008
 368 #define SCTP_STRRESET_FAILED       0x0010
 369
 370
 371 /* SCTP notification event */
 372 struct sctp_tlv {
 373         uint16_t sn_type;
 374         uint16_t sn_flags;
 375         uint32_t sn_length;
 376 };
 377
 378 union sctp_notification {
 379         struct sctp_tlv sn_header;
 380         struct sctp_assoc_change sn_assoc_change;
 381         struct sctp_paddr_change sn_paddr_change;
 382         struct sctp_remote_error sn_remote_error;
 383         struct sctp_send_failed sn_send_failed;
 384         struct sctp_shutdown_event sn_shutdown_event;
 385         struct sctp_adaptation_event sn_adaptation_event;
 386         /* compatability same as above */
 387         struct sctp_adaption_event sn_adaption_event;
 388         struct sctp_pdapi_event sn_pdapi_event;
 389         struct sctp_authkey_event sn_auth_event;
 390         struct sctp_stream_reset_event sn_strreset_event;
 391 };
 392
 393 /* notification types */
 394 #define SCTP_ASSOC_CHANGE               0x0001
 395 #define SCTP_PEER_ADDR_CHANGE           0x0002
 396 #define SCTP_REMOTE_ERROR               0x0003
 397 #define SCTP_SEND_FAILED                0x0004
 398 #define SCTP_SHUTDOWN_EVENT             0x0005
 399 #define SCTP_ADAPTATION_INDICATION      0x0006
 400 /* same as above */
 401 #define SCTP_ADAPTION_INDICATION        0x0006
 402 #define SCTP_PARTIAL_DELIVERY_EVENT     0x0007
 403 #define SCTP_AUTHENTICATION_EVENT       0x0008
 404 #define SCTP_STREAM_RESET_EVENT         0x0009
 405
 406
 407 /*
 408  * socket option structs
 409  */
 410
 411 struct sctp_paddrparams {
 412         struct sockaddr_storage spp_address;
 413         sctp_assoc_t spp_assoc_id;
 414         uint32_t spp_hbinterval;
 415         uint32_t spp_pathmtu;
 416         uint32_t spp_flags;
 417         uint32_t spp_ipv6_flowlabel;
 418         uint16_t spp_pathmaxrxt;
 419         uint8_t spp_ipv4_tos;
 420 };
 421
 422 #define SPP_HB_ENABLE           0x00000001
 423 #define SPP_HB_DISABLE          0x00000002
 424 #define SPP_HB_DEMAND           0x00000004
 425 #define SPP_PMTUD_ENABLE        0x00000008
 426 #define SPP_PMTUD_DISABLE       0x00000010
 427 #define SPP_HB_TIME_IS_ZERO     0x00000080
 428 #define SPP_IPV6_FLOWLABEL      0x00000100
 429 #define SPP_IPV4_TOS            0x00000200
 430
 431 struct sctp_paddrinfo {
 432         struct sockaddr_storage spinfo_address;
 433         sctp_assoc_t spinfo_assoc_id;
 434         int32_t spinfo_state;
 435         uint32_t spinfo_cwnd;
 436         uint32_t spinfo_srtt;
 437         uint32_t spinfo_rto;
 438         uint32_t spinfo_mtu;
 439 };
 440
 441 struct sctp_rtoinfo {
 442         sctp_assoc_t srto_assoc_id;
 443         uint32_t srto_initial;
 444         uint32_t srto_max;
 445         uint32_t srto_min;
 446 };
 447
 448 struct sctp_assocparams {
 449         sctp_assoc_t sasoc_assoc_id;
 450         uint32_t sasoc_peer_rwnd;
 451         uint32_t sasoc_local_rwnd;
 452         uint32_t sasoc_cookie_life;
 453         uint16_t sasoc_asocmaxrxt;
 454         uint16_t sasoc_number_peer_destinations;
 455 };
 456
 457 struct sctp_setprim {
 458         struct sockaddr_storage ssp_addr;
 459         sctp_assoc_t ssp_assoc_id;
 460         uint8_t ssp_padding[4];
 461 };
 462
 463 struct sctp_setpeerprim {
 464         struct sockaddr_storage sspp_addr;
 465         sctp_assoc_t sspp_assoc_id;
 466         uint8_t sspp_padding[4];
 467 };
 468
 469 struct sctp_getaddresses {
 470         sctp_assoc_t sget_assoc_id;
 471         /* addr is filled in for N * sockaddr_storage */
 472         struct sockaddr addr[1];
 473 };
 474
 475 struct sctp_setstrm_timeout {
 476         sctp_assoc_t ssto_assoc_id;
 477         uint32_t ssto_timeout;
 478         uint32_t ssto_streamid_start;
 479         uint32_t ssto_streamid_end;
 480 };
 481
 482 struct sctp_status {
 483         sctp_assoc_t sstat_assoc_id;
 484         int32_t sstat_state;
 485         uint32_t sstat_rwnd;
 486         uint16_t sstat_unackdata;
 487         uint16_t sstat_penddata;
 488         uint16_t sstat_instrms;
 489         uint16_t sstat_outstrms;
 490         uint32_t sstat_fragmentation_point;
 491         struct sctp_paddrinfo sstat_primary;
 492 };
 493
 494 /*
 495  * AUTHENTICATION support
 496  */
 497 /* SCTP_AUTH_CHUNK */
 498 struct sctp_authchunk {
 499         uint8_t sauth_chunk;
 500 };
 501
 502 /* SCTP_AUTH_KEY */
 503 struct sctp_authkey {
 504         sctp_assoc_t sca_assoc_id;
 505         uint16_t sca_keynumber;
 506         uint8_t sca_key[0];
 507 };
 508
 509 /* SCTP_HMAC_IDENT */
 510 struct sctp_hmacalgo {
 511         uint16_t shmac_idents[0];
 512 };
 513
 514 /* AUTH hmac_id */
 515 #define SCTP_AUTH_HMAC_ID_RSVD          0x0000
 516 #define SCTP_AUTH_HMAC_ID_SHA1          0x0001  /* default, mandatory */
 517 #define SCTP_AUTH_HMAC_ID_MD5           0x0002  /* deprecated */
 518 #define SCTP_AUTH_HMAC_ID_SHA256        0x0003
 519 #define SCTP_AUTH_HMAC_ID_SHA224        0x0004
 520 #define SCTP_AUTH_HMAC_ID_SHA384        0x0005
 521 #define SCTP_AUTH_HMAC_ID_SHA512        0x0006
 522
 523
 524 /* SCTP_AUTH_ACTIVE_KEY / SCTP_AUTH_DELETE_KEY */
 525 struct sctp_authkeyid {
 526         sctp_assoc_t scact_assoc_id;
 527         uint16_t scact_keynumber;
 528 };
 529
 530 /* SCTP_PEER_AUTH_CHUNKS / SCTP_LOCAL_AUTH_CHUNKS */
 531 struct sctp_authchunks {
 532         sctp_assoc_t gauth_assoc_id;
 533         uint8_t gauth_chunks[0];
 534 };
 535
 536 struct sctp_assoc_value {
 537         sctp_assoc_t assoc_id;
 538         uint32_t assoc_value;
 539 };
 540
 541 struct sctp_assoc_ids {
 542         sctp_assoc_t gaids_assoc_id[0];
 543 };
 544
 545 struct sctp_sack_info {
 546         sctp_assoc_t sack_assoc_id;
 547         uint32_t sack_delay;
 548         uint32_t sack_freq;
 549 };
 550
 551 struct sctp_cwnd_args {
 552         struct sctp_nets *net;  /* network to *//* FIXME: LP64 issue */
 553         uint32_t cwnd_new_value;/* cwnd in k */
 554         uint32_t inflight;      /* flightsize in k */
 555         uint32_t pseudo_cumack;
 556         uint32_t cwnd_augment;  /* increment to it */
 557         uint8_t meets_pseudo_cumack;
 558         uint8_t need_new_pseudo_cumack;
 559         uint8_t cnt_in_send;
 560         uint8_t cnt_in_str;
 561 };
 562
 563 struct sctp_blk_args {
 564         uint32_t onsb;          /* in 1k bytes */
 565         uint32_t sndlen;        /* len of send being attempted */
 566         uint32_t peer_rwnd;     /* rwnd of peer */
 567         uint16_t send_sent_qcnt;/* chnk cnt */
 568         uint16_t stream_qcnt;   /* chnk cnt */
 569         uint16_t chunks_on_oque;/* chunks out */
 570         uint16_t flight_size;   /* flight size in k */
 571 };
 572
 573 /*
 574  * Max we can reset in one setting, note this is dictated not by the define
 575  * but the size of a mbuf cluster so don't change this define and think you
 576  * can specify more. You must do multiple resets if you want to reset more
 577  * than SCTP_MAX_EXPLICIT_STR_RESET.
 578  */
 579 #define SCTP_MAX_EXPLICT_STR_RESET   1000
 580
 581 #define SCTP_RESET_LOCAL_RECV  0x0001
 582 #define SCTP_RESET_LOCAL_SEND  0x0002
 583 #define SCTP_RESET_BOTH        0x0003
 584 #define SCTP_RESET_TSN         0x0004
 585
 586 struct sctp_stream_reset {
 587         sctp_assoc_t strrst_assoc_id;
 588         uint16_t strrst_flags;
 589         uint16_t strrst_num_streams;    /* 0 == ALL */
 590         uint16_t strrst_list[0];/* list if strrst_num_streams is not 0 */
 591 };
 592
 593
 594 struct sctp_get_nonce_values {
 595         sctp_assoc_t gn_assoc_id;
 596         uint32_t gn_peers_tag;
 597         uint32_t gn_local_tag;
 598 };
 599
 600 /* Debugging logs */
 601 struct sctp_str_log {
 602         void *stcb;             /* FIXME: LP64 issue */
 603         uint32_t n_tsn;
 604         uint32_t e_tsn;
 605         uint16_t n_sseq;
 606         uint16_t e_sseq;
 607         uint16_t strm;
 608 };
 609
 610 struct sctp_sb_log {
 611         void *stcb;             /* FIXME: LP64 issue */
 612         uint32_t so_sbcc;
 613         uint32_t stcb_sbcc;
 614         uint32_t incr;
 615 };
 616
 617 struct sctp_fr_log {
 618         uint32_t largest_tsn;
 619         uint32_t largest_new_tsn;
 620         uint32_t tsn;
 621 };
 622
 623 struct sctp_fr_map {
 624         uint32_t base;
 625         uint32_t cum;
 626         uint32_t high;
 627 };
 628
 629 struct sctp_rwnd_log {
 630         uint32_t rwnd;
 631         uint32_t send_size;
 632         uint32_t overhead;
 633         uint32_t new_rwnd;
 634 };
 635
 636 struct sctp_mbcnt_log {
 637         uint32_t total_queue_size;
 638         uint32_t size_change;
 639         uint32_t total_queue_mb_size;
 640         uint32_t mbcnt_change;
 641 };
 642
 643 struct sctp_sack_log {
 644         uint32_t cumack;
 645         uint32_t oldcumack;
 646         uint32_t tsn;
 647         uint16_t numGaps;
 648         uint16_t numDups;
 649 };
 650
 651 struct sctp_lock_log {
 652         void *sock;             /* FIXME: LP64 issue */
 653         void *inp;              /* FIXME: LP64 issue */
 654         uint8_t tcb_lock;
 655         uint8_t inp_lock;
 656         uint8_t info_lock;
 657         uint8_t sock_lock;
 658         uint8_t sockrcvbuf_lock;
 659         uint8_t socksndbuf_lock;
 660         uint8_t create_lock;
 661         uint8_t resv;
 662 };
 663
 664 struct sctp_rto_log {
 665         void *net;              /* FIXME: LP64 issue */
 666         uint32_t rtt;
 667 };
 668
 669 struct sctp_nagle_log {
 670         void *stcb;             /* FIXME: LP64 issue */
 671         uint32_t total_flight;
 672         uint32_t total_in_queue;
 673         uint16_t count_in_queue;
 674         uint16_t count_in_flight;
 675 };
 676
 677 struct sctp_sbwake_log {
 678         void *stcb;             /* FIXME: LP64 issue */
 679         uint16_t send_q;
 680         uint16_t sent_q;
 681         uint16_t flight;
 682         uint16_t wake_cnt;
 683         uint8_t stream_qcnt;    /* chnk cnt */
 684         uint8_t chunks_on_oque; /* chunks out */
 685         uint8_t sbflags;
 686         uint8_t sctpflags;
 687 };
 688
 689 struct sctp_misc_info {
 690         uint32_t log1;
 691         uint32_t log2;
 692         uint32_t log3;
 693         uint32_t log4;
 694 };
 695
 696 struct sctp_log_closing {
 697         void *inp;              /* FIXME: LP64 issue */
 698         void *stcb;             /* FIXME: LP64 issue */
 699         uint32_t sctp_flags;
 700         uint16_t state;
 701         int16_t loc;
 702 };
 703
 704 struct sctp_mbuf_log {
 705         struct mbuf *mp;        /* FIXME: LP64 issue */
 706         caddr_t ext;
 707         caddr_t data;
 708         uint16_t size;
 709         uint8_t refcnt;
 710         uint8_t mbuf_flags;
 711 };
 712
 713 struct sctp_cwnd_log {
 714         uint64_t time_event;
 715         uint8_t from;
 716         uint8_t event_type;
 717         uint8_t resv[2];
 718         union {
 719                 struct sctp_log_closing close;
 720                 struct sctp_blk_args blk;
 721                 struct sctp_cwnd_args cwnd;
 722                 struct sctp_str_log strlog;
 723                 struct sctp_fr_log fr;
 724                 struct sctp_fr_map map;
 725                 struct sctp_rwnd_log rwnd;
 726                 struct sctp_mbcnt_log mbcnt;
 727                 struct sctp_sack_log sack;
 728                 struct sctp_lock_log lock;
 729                 struct sctp_rto_log rto;
 730                 struct sctp_sb_log sb;
 731                 struct sctp_nagle_log nagle;
 732                 struct sctp_sbwake_log wake;
 733                 struct sctp_mbuf_log mb;
 734                 struct sctp_misc_info misc;
 735         }     x;
 736 };
 737
 738 struct sctp_cwnd_log_req {
 739         int32_t num_in_log;     /* Number in log */
 740         int32_t num_ret;        /* Number returned */
 741         int32_t start_at;       /* start at this one */
 742         int32_t end_at;         /* end at this one */
 743         struct sctp_cwnd_log log[0];
 744 };
 745
 746 struct sctpstat {
 747         /* MIB according to RFC 3873 */
 748         uint32_t sctps_currestab;       /* sctpStats  1   (Gauge32) */
 749         uint32_t sctps_activeestab;     /* sctpStats  2 (Counter32) */
 750         uint32_t sctps_restartestab;
 751         uint32_t sctps_collisionestab;
 752         uint32_t sctps_passiveestab;    /* sctpStats  3 (Counter32) */
 753         uint32_t sctps_aborted; /* sctpStats  4 (Counter32) */
 754         uint32_t sctps_shutdown;/* sctpStats  5 (Counter32) */
 755         uint32_t sctps_outoftheblue;    /* sctpStats  6 (Counter32) */
 756         uint32_t sctps_checksumerrors;  /* sctpStats  7 (Counter32) */
 757         uint32_t sctps_outcontrolchunks;        /* sctpStats  8 (Counter64) */
 758         uint32_t sctps_outorderchunks;  /* sctpStats  9 (Counter64) */
 759         uint32_t sctps_outunorderchunks;        /* sctpStats 10 (Counter64) */
 760         uint32_t sctps_incontrolchunks; /* sctpStats 11 (Counter64) */
 761         uint32_t sctps_inorderchunks;   /* sctpStats 12 (Counter64) */
 762         uint32_t sctps_inunorderchunks; /* sctpStats 13 (Counter64) */
 763         uint32_t sctps_fragusrmsgs;     /* sctpStats 14 (Counter64) */
 764         uint32_t sctps_reasmusrmsgs;    /* sctpStats 15 (Counter64) */
 765         uint32_t sctps_outpackets;      /* sctpStats 16 (Counter64) */
 766         uint32_t sctps_inpackets;       /* sctpStats 17 (Counter64) */
 767
 768         /* input statistics: */
 769         uint32_t sctps_recvpackets;     /* total input packets        */
 770         uint32_t sctps_recvdatagrams;   /* total input datagrams      */
 771         uint32_t sctps_recvpktwithdata; /* total packets that had data */
 772         uint32_t sctps_recvsacks;       /* total input SACK chunks    */
 773         uint32_t sctps_recvdata;/* total input DATA chunks    */
 774         uint32_t sctps_recvdupdata;     /* total input duplicate DATA chunks */
 775         uint32_t sctps_recvheartbeat;   /* total input HB chunks      */
 776         uint32_t sctps_recvheartbeatack;        /* total input HB-ACK chunks  */
 777         uint32_t sctps_recvecne;/* total input ECNE chunks    */
 778         uint32_t sctps_recvauth;/* total input AUTH chunks    */
 779         uint32_t sctps_recvauthmissing; /* total input chunks missing AUTH */
 780         uint32_t sctps_recvivalhmacid;  /* total number of invalid HMAC ids
 781                                          * received */
 782         uint32_t sctps_recvivalkeyid;   /* total number of invalid secret ids
 783                                          * received */
 784         uint32_t sctps_recvauthfailed;  /* total number of auth failed */
 785         uint32_t sctps_recvexpress;     /* total fast path receives all one
 786                                          * chunk */
 787         uint32_t sctps_recvexpressm;    /* total fast path multi-part data */
 788         /* output statistics: */
 789         uint32_t sctps_sendpackets;     /* total output packets       */
 790         uint32_t sctps_sendsacks;       /* total output SACKs         */
 791         uint32_t sctps_senddata;/* total output DATA chunks   */
 792         uint32_t sctps_sendretransdata; /* total output retransmitted DATA
 793                                          * chunks */
 794         uint32_t sctps_sendfastretrans; /* total output fast retransmitted
 795                                          * DATA chunks */
 796         uint32_t sctps_sendmultfastretrans;     /* total FR's that happened
 797                                                  * more than once to same
 798                                                  * chunk (u-del multi-fr
 799                                                  * algo). */
 800         uint32_t sctps_sendheartbeat;   /* total output HB chunks     */
 801         uint32_t sctps_sendecne;/* total output ECNE chunks    */
 802         uint32_t sctps_sendauth;/* total output AUTH chunks FIXME   */
 803         uint32_t sctps_senderrors;      /* ip_output error counter */
 804         /* PCKDROPREP statistics: */
 805         uint32_t sctps_pdrpfmbox;       /* Packet drop from middle box */
 806         uint32_t sctps_pdrpfehos;       /* P-drop from end host */
 807         uint32_t sctps_pdrpmbda;/* P-drops with data */
 808         uint32_t sctps_pdrpmbct;/* P-drops, non-data, non-endhost */
 809         uint32_t sctps_pdrpbwrpt;       /* P-drop, non-endhost, bandwidth rep
 810                                          * only */
 811         uint32_t sctps_pdrpcrupt;       /* P-drop, not enough for chunk header */
 812         uint32_t sctps_pdrpnedat;       /* P-drop, not enough data to confirm */
 813         uint32_t sctps_pdrppdbrk;       /* P-drop, where process_chunk_drop
 814                                          * said break */
 815         uint32_t sctps_pdrptsnnf;       /* P-drop, could not find TSN */
 816         uint32_t sctps_pdrpdnfnd;       /* P-drop, attempt reverse TSN lookup */
 817         uint32_t sctps_pdrpdiwnp;       /* P-drop, e-host confirms zero-rwnd */
 818         uint32_t sctps_pdrpdizrw;       /* P-drop, midbox confirms no space */
 819         uint32_t sctps_pdrpbadd;/* P-drop, data did not match TSN */
 820         uint32_t sctps_pdrpmark;/* P-drop, TSN's marked for Fast Retran */
 821         /* timeouts */
 822         uint32_t sctps_timoiterator;    /* Number of iterator timers that
 823                                          * fired */
 824         uint32_t sctps_timodata;/* Number of T3 data time outs */
 825         uint32_t sctps_timowindowprobe; /* Number of window probe (T3) timers
 826                                          * that fired */
 827         uint32_t sctps_timoinit;/* Number of INIT timers that fired */
 828         uint32_t sctps_timosack;/* Number of sack timers that fired */
 829         uint32_t sctps_timoshutdown;    /* Number of shutdown timers that
 830                                          * fired */
 831         uint32_t sctps_timoheartbeat;   /* Number of heartbeat timers that
 832                                          * fired */
 833         uint32_t sctps_timocookie;      /* Number of times a cookie timeout
 834                                          * fired */
 835         uint32_t sctps_timosecret;      /* Number of times an endpoint changed
 836                                          * its cookie secret */
 837         uint32_t sctps_timopathmtu;     /* Number of PMTU timers that fired */
 838         uint32_t sctps_timoshutdownack; /* Number of shutdown ack timers that
 839                                          * fired */
 840         uint32_t sctps_timoshutdownguard;       /* Number of shutdown guard
 841                                                  * timers that fired */
 842         uint32_t sctps_timostrmrst;     /* Number of stream reset timers that
 843                                          * fired */
 844         uint32_t sctps_timoearlyfr;     /* Number of early FR timers that
 845                                          * fired */
 846         uint32_t sctps_timoasconf;      /* Number of times an asconf timer
 847                                          * fired */
 848         uint32_t sctps_timoautoclose;   /* Number of times auto close timer
 849                                          * fired */
 850         uint32_t sctps_timoassockill;   /* Number of asoc free timers expired */
 851         uint32_t sctps_timoinpkill;     /* Number of inp free timers expired */
 852         /* Early fast retransmission counters */
 853         uint32_t sctps_earlyfrstart;
 854         uint32_t sctps_earlyfrstop;
 855         uint32_t sctps_earlyfrmrkretrans;
 856         uint32_t sctps_earlyfrstpout;
 857         uint32_t sctps_earlyfrstpidsck1;
 858         uint32_t sctps_earlyfrstpidsck2;
 859         uint32_t sctps_earlyfrstpidsck3;
 860         uint32_t sctps_earlyfrstpidsck4;
 861         uint32_t sctps_earlyfrstrid;
 862         uint32_t sctps_earlyfrstrout;
 863         uint32_t sctps_earlyfrstrtmr;
 864         /* otheres */
 865         uint32_t sctps_hdrops;  /* packet shorter than header */
 866         uint32_t sctps_badsum;  /* checksum error             */
 867         uint32_t sctps_noport;  /* no endpoint for port       */
 868         uint32_t sctps_badvtag; /* bad v-tag                  */
 869         uint32_t sctps_badsid;  /* bad SID                    */
 870         uint32_t sctps_nomem;   /* no memory                  */
 871         uint32_t sctps_fastretransinrtt;        /* number of multiple FR in a
 872                                                  * RTT window */
 873         uint32_t sctps_markedretrans;
 874         uint32_t sctps_naglesent;       /* nagle allowed sending      */
 875         uint32_t sctps_naglequeued;     /* nagle does't allow sending */
 876         uint32_t sctps_maxburstqueued;  /* max burst dosn't allow sending */
 877         uint32_t sctps_ifnomemqueued;   /* look ahead tells us no memory in
 878                                          * interface ring buffer OR we had a
 879                                          * send error and are queuing one
 880                                          * send. */
 881         uint32_t sctps_windowprobed;    /* total number of window probes sent */
 882         uint32_t sctps_lowlevelerr;     /* total times an output error causes
 883                                          * us to clamp down on next user send. */
 884         uint32_t sctps_lowlevelerrusr;  /* total times sctp_senderrors were
 885                                          * caused from a user send from a user
 886                                          * invoked send not a sack response */
 887         uint32_t sctps_datadropchklmt;  /* Number of in data drops due to
 888                                          * chunk limit reached */
 889         uint32_t sctps_datadroprwnd;    /* Number of in data drops due to rwnd
 890                                          * limit reached */
 891         uint32_t sctps_ecnereducedcwnd; /* Number of times a ECN reduced the
 892                                          * cwnd */
 893         uint32_t sctps_vtagexpress;     /* Used express lookup via vtag */
 894         uint32_t sctps_vtagbogus;       /* Collision in express lookup. */
 895         uint32_t sctps_primary_randry;  /* Number of times the sender ran dry
 896                                          * of user data on primary */
 897         uint32_t sctps_cmt_randry;      /* Same for above */
 898         uint32_t sctps_slowpath_sack;   /* Sacks the slow way */
 899         uint32_t sctps_wu_sacks_sent;   /* Window Update only sacks sent */
 900         uint32_t sctps_sends_with_flags;        /* number of sends with
 901                                                  * sinfo_flags !=0 */
 902         uint32_t sctps_sends_with_unord /* number of undordered sends */ ;
 903         uint32_t sctps_sends_with_eof;  /* number of sends with EOF flag set */
 904         uint32_t sctps_sends_with_abort;        /* number of sends with ABORT
 905                                                  * flag set */
 906         uint32_t sctps_protocol_drain_calls;    /* number of times protocol
 907                                                  * drain called */
 908         uint32_t sctps_protocol_drains_done;    /* number of times we did a
 909                                                  * protocol drain */
 910         uint32_t sctps_read_peeks;      /* Number of times recv was called
 911                                          * with peek */
 912         uint32_t sctps_cached_chk;      /* Number of cached chunks used */
 913         uint32_t sctps_cached_strmoq;   /* Number of cached stream oq's used */
 914         uint32_t sctps_left_abandon;    /* Number of unread message abandonded
 915                                          * by close */
 916         uint32_t sctps_send_burst_avoid;        /* Send burst avoidance,
 917                                                  * already max burst inflight
 918                                                  * to net */
 919         uint32_t sctps_send_cwnd_avoid; /* Send cwnd full  avoidance, already
 920                                          * max burst inflight to net */
 921         uint32_t sctps_fwdtsn_map_over; /* number of map array over-runs via
 922                                          * fwd-tsn's */
 923
 924         struct timeval sctps_discontinuitytime; /* sctpStats 18 (TimeStamp) */
 925 };
 926
 927 #define SCTP_STAT_INCR(_x) SCTP_STAT_INCR_BY(_x,1)
 928 #define SCTP_STAT_DECR(_x) SCTP_STAT_DECR_BY(_x,1)
 929 #define SCTP_STAT_INCR_BY(_x,_d) atomic_add_int(&sctpstat._x, _d)
 930 #define SCTP_STAT_DECR_BY(_x,_d) atomic_subtract_int(&sctpstat._x, _d)
 931
 932 /* The following macros are for handling MIB values, */
 933 #define SCTP_STAT_INCR_COUNTER32(_x) SCTP_STAT_INCR(_x)
 934 #define SCTP_STAT_INCR_COUNTER64(_x) SCTP_STAT_INCR(_x)
 935 #define SCTP_STAT_INCR_GAUGE32(_x) SCTP_STAT_INCR(_x)
 936 #define SCTP_STAT_DECR_COUNTER32(_x) SCTP_STAT_DECR(_x)
 937 #define SCTP_STAT_DECR_COUNTER64(_x) SCTP_STAT_DECR(_x)
 938 #define SCTP_STAT_DECR_GAUGE32(_x) SCTP_STAT_DECR(_x)
 939
 940 union sctp_sockstore {
 941 #if defined(INET) || !defined(_KERNEL)
 942         struct sockaddr_in sin;
 943 #endif
 944 #if defined(INET6) || !defined(_KERNEL)
 945         struct sockaddr_in6 sin6;
 946 #endif
 947         struct sockaddr sa;
 948 };
 949
 950 struct xsctp_inpcb {
 951         uint32_t last;
 952         uint32_t flags;
 953         uint32_t features;
 954         uint32_t total_sends;
 955         uint32_t total_recvs;
 956         uint32_t total_nospaces;
 957         uint32_t fragmentation_point;
 958         uint16_t local_port;
 959         uint16_t qlen;
 960         uint16_t maxqlen;
 961 };
 962
 963 struct xsctp_tcb {
 964         union sctp_sockstore primary_addr;      /* sctpAssocEntry 5/6 */
 965         uint32_t last;
 966         uint32_t heartbeat_interval;    /* sctpAssocEntry 7   */
 967         uint32_t state;         /* sctpAssocEntry 8   */
 968         uint32_t in_streams;    /* sctpAssocEntry 9   */
 969         uint32_t out_streams;   /* sctpAssocEntry 10  */
 970         uint32_t max_nr_retrans;/* sctpAssocEntry 11  */
 971         uint32_t primary_process;       /* sctpAssocEntry 12  */
 972         uint32_t T1_expireries; /* sctpAssocEntry 13  */
 973         uint32_t T2_expireries; /* sctpAssocEntry 14  */
 974         uint32_t retransmitted_tsns;    /* sctpAssocEntry 15  */
 975         uint32_t total_sends;
 976         uint32_t total_recvs;
 977         uint32_t local_tag;
 978         uint32_t remote_tag;
 979         uint32_t initial_tsn;
 980         uint32_t highest_tsn;
 981         uint32_t cumulative_tsn;
 982         uint32_t cumulative_tsn_ack;
 983         uint32_t mtu;
 984         uint32_t refcnt;
 985         uint16_t local_port;    /* sctpAssocEntry 3   */
 986         uint16_t remote_port;   /* sctpAssocEntry 4   */
 987         struct timeval start_time;      /* sctpAssocEntry 16  */
 988         struct timeval discontinuity_time;      /* sctpAssocEntry 17  */
 989 };
 990
 991 struct xsctp_laddr {
 992         union sctp_sockstore address;   /* sctpAssocLocalAddrEntry 1/2 */
 993         uint32_t last;
 994         struct timeval start_time;      /* sctpAssocLocalAddrEntry 3   */
 995 };
 996
 997 struct xsctp_raddr {
 998         union sctp_sockstore address;   /* sctpAssocLocalRemEntry 1/2 */
 999         uint32_t last;
1000         uint32_t rto;           /* sctpAssocLocalRemEntry 5   */
1001         uint32_t max_path_rtx;  /* sctpAssocLocalRemEntry 6   */
1002         uint32_t rtx;           /* sctpAssocLocalRemEntry 7   */
1003         uint32_t error_counter; /* */
1004         uint32_t cwnd;          /* */
1005         uint32_t flight_size;   /* */
1006         uint32_t mtu;           /* */
1007         uint8_t active;         /* sctpAssocLocalRemEntry 3   */
1008         uint8_t confirmed;      /* */
1009         uint8_t heartbeat_enabled;      /* sctpAssocLocalRemEntry 4   */
1010         struct timeval start_time;      /* sctpAssocLocalRemEntry 8   */
1011 };
1012
1013 /*
1014  * Kernel defined for sctp_send
1015  */
1016 #if defined(_KERNEL)
1017 int
1018 sctp_lower_sosend(struct socket *so,
1019     struct sockaddr *addr,
1020     struct uio *uio,
1021     struct mbuf *i_pak,
1022     struct mbuf *control,
1023     int flags,
1024     int use_rcvinfo,
1025     struct sctp_sndrcvinfo *srcv
1026     ,struct thread *p
1027 );
1028
1029 int
1030 sctp_sorecvmsg(struct socket *so,
1031     struct uio *uio,
1032     struct mbuf **mp,
1033     struct sockaddr *from,
1034     int fromlen,
1035     int *msg_flags,
1036     struct sctp_sndrcvinfo *sinfo,
1037     int filling_sinfo);
1038
1039 #endif
1040
1041 /*
1042  * API system calls
1043  */
1044 #if !(defined(_KERNEL))
1045
1046 __BEGIN_DECLS
1047 int sctp_peeloff __P((int, sctp_assoc_t));
1048 int sctp_bindx __P((int, struct sockaddr *, int, int));
1049 int sctp_connectx __P((int, const struct sockaddr *, int, sctp_assoc_t *));
1050 int sctp_getaddrlen __P((sa_family_t));
1051 int sctp_getpaddrs __P((int, sctp_assoc_t, struct sockaddr **));
1052 void sctp_freepaddrs __P((struct sockaddr *));
1053 int sctp_getladdrs __P((int, sctp_assoc_t, struct sockaddr **));
1054 void sctp_freeladdrs __P((struct sockaddr *));
1055 int sctp_opt_info __P((int, sctp_assoc_t, int, void *, socklen_t *));
1056
1057 ssize_t sctp_sendmsg
1058 __P((int, const void *, size_t,
1059     const struct sockaddr *,
1060     socklen_t, uint32_t, uint32_t, uint16_t, uint32_t, uint32_t));
1061
1062         ssize_t sctp_send __P((int sd, const void *msg, size_t len,
1063               const struct sctp_sndrcvinfo *sinfo, int flags));
1064
1065         ssize_t sctp_sendx __P((int sd, const void *msg, size_t len,
1066                struct sockaddr *addrs, int addrcnt,
1067                struct sctp_sndrcvinfo *sinfo, int flags));
1068
1069         ssize_t sctp_sendmsgx __P((int sd, const void *, size_t,
1070                   struct sockaddr *, int,
1071                   uint32_t, uint32_t, uint16_t, uint32_t, uint32_t));
1072
1073         sctp_assoc_t sctp_getassocid __P((int sd, struct sockaddr *sa));
1074
1075         ssize_t sctp_recvmsg __P((int, void *, size_t, struct sockaddr *,
1076                  socklen_t *, struct sctp_sndrcvinfo *, int *));
1077
1078 __END_DECLS
1079
1080 #endif                          /* !_KERNEL */
1081 #endif                          /* !__sctp_uio_h__ */