FreeBSD/Linux Kernel Cross Reference
sys/netinet/sctp_uio.h

     /*      $KAME: sctp_uio.h,v 1.11 2005/03/06 16:04:18 itojun Exp $       */
     /*      $NetBSD: sctp_uio.h,v 1.4 2018/07/31 13:36:31 rjs Exp $ */
     
     #ifndef __SCTP_UIO_H__
     #define __SCTP_UIO_H__
     
     /*
      * Copyright (c) 2001, 2002, 2003, 2004 Cisco Systems, Inc.
      * All rights reserved.
     *
     * Redistribution and use in source and binary forms, with or without
     * modification, are permitted provided that the following conditions
     * are met:
     * 1. Redistributions of source code must retain the above copyright
     *    notice, this list of conditions and the following disclaimer.
     * 2. Redistributions in binary form must reproduce the above copyright
     *    notice, this list of conditions and the following disclaimer in the
     *    documentation and/or other materials provided with the distribution.
     * 3. All advertising materials mentioning features or use of this software
     *    must display the following acknowledgement:
     *      This product includes software developed by Cisco Systems, Inc.
     * 4. Neither the name of the project nor the names of its contributors
     *    may be used to endorse or promote products derived from this software
     *    without specific prior written permission.
     *
     * THIS SOFTWARE IS PROVIDED BY CISCO SYSTEMS AND CONTRIBUTORS ``AS IS'' AND
     * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     * ARE DISCLAIMED.  IN NO EVENT SHALL CISCO SYSTEMS OR CONTRIBUTORS BE LIABLE
     * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     * SUCH DAMAGE.
     */
    
    #include <sys/types.h>
    #include <sys/socket.h>
    
    typedef u_int32_t sctp_assoc_t;
    
    #define SCTP_FUTURE_ASSOC       0
    #define SCTP_CURRENT_ASSOC      1
    #define SCTP_ALL_ASSOC          2
    
    /* On/Off setup for subscription to events */
    struct sctp_event_subscribe {
            u_int8_t sctp_data_io_event;
            u_int8_t sctp_association_event;
            u_int8_t sctp_address_event;
            u_int8_t sctp_send_failure_event;
            u_int8_t sctp_peer_error_event;
            u_int8_t sctp_shutdown_event;
            u_int8_t sctp_partial_delivery_event;
            u_int8_t sctp_adaption_layer_event;
            u_int8_t sctp_stream_reset_events;
    } __packed;
    
    /* ancillary data types */
    #define SCTP_INIT       0x0001
    #define SCTP_SNDRCV     0x0002
    #define SCTP_EXTRCV     0x0003
    #define SCTP_SNDINFO    0x0004
    #define SCTP_RCVINFO    0x0005
    #define SCTP_NXTINFO    0x0006
    #define SCTP_PRINFO     0x0007
    #define SCTP_AUTHINFO   0x0008
    #define SCTP_DSTADDRV4  0x0009
    #define SCTP_DSTADDRV6  0x000a
    
    struct sctp_event {
            sctp_assoc_t se_assoc_id;
            u_int16_t se_type;
            u_int8_t se_on;
    } __packed;
    
    /*
     * ancillary data structures
     */
    struct sctp_initmsg {
            u_int32_t sinit_num_ostreams;
            u_int32_t sinit_max_instreams;
            u_int16_t sinit_max_attempts;
            u_int16_t sinit_max_init_timeo;
    } __packed;
    
    struct sctp_sndrcvinfo {
            u_int16_t sinfo_stream;
            u_int16_t sinfo_ssn;
            u_int16_t sinfo_flags;
            u_int32_t sinfo_ppid;
            u_int32_t sinfo_context;
            u_int32_t sinfo_timetolive;
            u_int32_t sinfo_tsn;
            u_int32_t sinfo_cumtsn;
            sctp_assoc_t sinfo_assoc_id;
    } __packed;
   
   struct sctp_sndinfo {
           u_int16_t snd_sid;
           u_int16_t snd_flags;
           u_int32_t snd_ppid;
           u_int32_t snd_context;
           sctp_assoc_t snd_assoc_id;
   } __packed;
   
   struct sctp_rcvinfo {
           u_int16_t rcv_sid;
           u_int16_t rcv_ssn;
           u_int16_t rcv_flags;
           u_int32_t rcv_ppid;
           u_int32_t rcv_tsn;
           u_int32_t rcv_cumtsn;
           u_int32_t rcv_context;
           sctp_assoc_t rcv_assoc_id;
   };
   
   struct sctp_nxtinfo {
           u_int16_t nxt_sid;
           u_int16_t nxt_flags;
           u_int32_t nxt_ppid;
           u_int32_t nxt_length;
           sctp_assoc_t nxt_assoc_id;
   } __packed;
   
   struct sctp_prinfo {
           u_int16_t pr_policy;
           u_int32_t pr_value;
   };
   
   struct sctp_authinfo {
           u_int16_t auth_keynumber;
   } __packed;
   
   struct sctp_snd_all_completes {
           u_int16_t sall_stream;
           u_int16_t sall_flags;
           u_int32_t sall_ppid;
           u_int32_t sall_context;
           u_int32_t sall_num_sent;
           u_int32_t sall_num_failed;
   } __packed;
   
   /* send/recv flags */
   #define SCTP_SENDALL            0x0200
   #define SCTP_PR_SCTP_TTL        0x0400  /* Partial Reliable on this msg */
   #define SCTP_PR_SCTP_BUF        0x0800  /* Buffer based PR-SCTP */
   #define SCTP_EOF                0x1000  /* Start shutdown procedures */
   #define SCTP_UNORDERED          0x2000  /* Message is un-ordered */
   #define SCTP_ADDR_OVER          0x4000  /* Override the primary-address */
   #define SCTP_ABORT              0x8000  /* Send an ABORT to peer */
   
   /* Stat's */
   struct sctp_pcbinfo {
           u_int32_t ep_count;
           u_int32_t asoc_count;
           u_int32_t laddr_count;
           u_int32_t raddr_count;
           u_int32_t chk_count;
           u_int32_t sockq_count;
           u_int32_t mbuf_track;
   } __packed;
   
   struct sctp_sockstat {
           sctp_assoc_t ss_assoc_id;
           u_int32_t ss_total_sndbuf;
           u_int32_t ss_total_mbuf_sndbuf;
           u_int32_t ss_total_recv_buf;
   } __packed;
   
   /*
    * notification event structures
    */
   
   
   /* association change events */
   
   struct sctp_assoc_change {
           u_int16_t sac_type;
           u_int16_t sac_flags;
           u_int32_t sac_length;
           u_int16_t sac_state;
           u_int16_t sac_error;
           u_int16_t sac_outbound_streams;
           u_int16_t sac_inbound_streams;
           sctp_assoc_t sac_assoc_id;
           u_int8_t sac_info[0];
   } __packed;
   /* sac_state values */
   
   #define SCTP_COMM_UP            0x0001
   #define SCTP_COMM_LOST          0x0002
   #define SCTP_RESTART            0x0003
   #define SCTP_SHUTDOWN_COMP      0x0004
   #define SCTP_CANT_STR_ASSOC     0x0005
   
   /* sac_info values */
   #define SCTP_ASSOC_SUPPORTS_PR          0x0001
   #define SCTP_ASSOC_SUPPORTS_AUTH        0x0002
   #define SCTP_ASSOC_SUPPORTS_ASCONF      0x0003
   #define SCTP_ASSOC_SUPPORTS_MULTIBUF    0x0004
   
   /* Address events */
   struct sctp_paddr_change {
           u_int16_t spc_type;
           u_int16_t spc_flags;
           u_int32_t spc_length;
           struct sockaddr_storage spc_aaddr;
           u_int32_t spc_state;
           u_int32_t spc_error;
           sctp_assoc_t spc_assoc_id;
   } __packed;
   /* paddr state values */
   #define SCTP_ADDR_AVAILABLE     0x0001
   #define SCTP_ADDR_UNREACHABLE   0x0002
   #define SCTP_ADDR_REMOVED       0x0003
   #define SCTP_ADDR_ADDED         0x0004
   #define SCTP_ADDR_MADE_PRIM     0x0005
   #define SCTP_ADDR_CONFIRMED     0x0006 /* XXX */
   
   /*
    * CAUTION: these are user exposed SCTP addr reachability states
    *          must be compatible with SCTP_ADDR states in sctp_constants.h
    */
   #ifdef SCTP_ACTIVE
   #undef SCTP_ACTIVE
   #endif
   #define SCTP_ACTIVE             0x0001  /* SCTP_ADDR_REACHABLE */
   
   #ifdef SCTP_INACTIVE
   #undef SCTP_INACTIVE
   #endif
   #define SCTP_INACTIVE           0x0002  /* SCTP_ADDR_NOT_REACHABLE */
   
   
   #ifdef SCTP_UNCONFIRMED
   #undef SCTP_UNCONFIRMED
   #endif
   #define SCTP_UNCONFIRMED        0x0200  /* SCTP_ADDR_UNCONFIRMED */
   
   #ifdef SCTP_NOHEARTBEAT
   #undef SCTP_NOHEARTBEAT
   #endif
   #define SCTP_NOHEARTBEAT        0x0040 /* SCTP_ADDR_NOHB */
   
   
   /* remote error events */
   struct sctp_remote_error {
           u_int16_t sre_type;
           u_int16_t sre_flags;
           u_int32_t sre_length;
           u_int16_t sre_error;
           sctp_assoc_t sre_assoc_id;
           u_int8_t  sre_data[4];
   } __packed;
   
   /* data send failure event */
   struct sctp_send_failed {
           u_int16_t ssf_type;
           u_int16_t ssf_flags;
           u_int32_t ssf_length;
           u_int32_t ssf_error;
           struct sctp_sndrcvinfo ssf_info;
           sctp_assoc_t ssf_assoc_id;
           u_int8_t ssf_data[4];
   } __packed;
   
   /* flag that indicates state of data */
   #define SCTP_DATA_UNSENT        0x0001  /* inqueue never on wire */
   #define SCTP_DATA_SENT          0x0002  /* on wire at failure */
   
   /* shutdown event */
   struct sctp_shutdown_event {
           u_int16_t       sse_type;
           u_int16_t       sse_flags;
           u_int32_t       sse_length;
           sctp_assoc_t    sse_assoc_id;
   } __packed;
   
   /* Adaption layer indication stuff */
   struct sctp_adaption_event {
           u_int16_t       sai_type;
           u_int16_t       sai_flags;
           u_int32_t       sai_length;
           u_int32_t       sai_adaption_ind;
           sctp_assoc_t    sai_assoc_id;
   } __packed;
   
   struct sctp_setadaption {
           u_int32_t       ssb_adaption_ind;
   } __packed;
   
   /* pdapi indications */
   struct sctp_pdapi_event {
           u_int16_t       pdapi_type;
           u_int16_t       pdapi_flags;
           u_int32_t       pdapi_length;
           u_int32_t       pdapi_indication;
           u_int32_t       pdapi_stream;
           u_int32_t       pdapi_seq;
           sctp_assoc_t    pdapi_assoc_id;
   } __packed;
   
   
   #define SCTP_PARTIAL_DELIVERY_ABORTED   0x0001
   
   /* sender dry indications */
   struct sctp_sender_dry_event {
           u_int16_t sender_dry_type;
           u_int16_t sender_dry_flags;
           u_int32_t sender_dry_length;
           sctp_assoc_t sender_dry_assoc_id;
   } __packed;
   
   /* stream reset stuff */
   
   struct sctp_stream_reset_event {
           u_int16_t       strreset_type;
           u_int16_t       strreset_flags;
           u_int32_t       strreset_length;
           sctp_assoc_t    strreset_assoc_id;
           u_int16_t       strreset_list[0];
   } __packed;
   
   /* flags in strreset_flags filed */
   #define SCTP_STRRESET_INBOUND_STR  0x0001
   #define SCTP_STRRESET_OUTBOUND_STR 0x0002
   #define SCTP_STRRESET_ALL_STREAMS  0x0004
   #define SCTP_STRRESET_STREAM_LIST  0x0008
   
   #define MAX_ASOC_IDS_RET 255
   
   struct sctp_assoc_ids {
           u_int16_t asls_assoc_start;     /* array of index's start at 0 */
           u_int8_t asls_numb_present;
           u_int8_t asls_more_to_get;
           sctp_assoc_t asls_assoc_id[MAX_ASOC_IDS_RET];
   } __packed;
   
   /* notification types */
   #define SCTP_ASSOC_CHANGE               0x0001
   #define SCTP_PEER_ADDR_CHANGE           0x0002
   #define SCTP_REMOTE_ERROR               0x0003
   #define SCTP_SEND_FAILED                0x0004
   #define SCTP_SHUTDOWN_EVENT             0x0005
   #define SCTP_ADAPTION_INDICATION        0x0006
   #define SCTP_PARTIAL_DELIVERY_EVENT     0x0007
   #define SCTP_STREAM_RESET_EVENT         0x0008 /* XXX */
   #define SCTP_AUTHENTICATION_EVENT       0x0009
   #define SCT_SENDER_DRY_EVENT            0x000a
   
   struct sctp_tlv {
           u_int16_t sn_type;
           u_int16_t sn_flags;
           u_int32_t sn_length;
   } __packed;
   
   
   /* notification event */
   union sctp_notification {
           struct sctp_tlv sn_header;
           struct sctp_assoc_change sn_assoc_change;
           struct sctp_paddr_change sn_paddr_change;
           struct sctp_remote_error sn_remote_error;
           struct sctp_send_failed sn_send_failed;
           struct sctp_shutdown_event sn_shutdown_event;
           struct sctp_adaption_event sn_adaption_event;
           struct sctp_pdapi_event sn_pdapi_event;
           struct sctp_stream_reset_event sn_strreset_event;
   } __packed;
   
   /*
    * socket option structs
    */
   #define SCTP_ISSUE_HB 0xffffffff        /* get a on-demand hb */
   #define SCTP_NO_HB    0x0               /* turn off hb's */
   
   struct sctp_paddrparams {
           sctp_assoc_t spp_assoc_id;
           struct sockaddr_storage spp_address;
           u_int32_t spp_hbinterval;
           u_int16_t spp_pathmaxrxt;
           u_int32_t spp_pathmtu;
           u_int32_t spp_flags;
           u_int32_t spp_ipv6_flowlabel;
           u_int8_t spp_dscp;
   } __packed;
   
   #define SPP_HB_ENABLE           0x0001
   #define SPP_HB_DISABLE          0x0002
   #define SPP_HB_DEMAND           0x0004
   #define SPP_HB_TIME_IS_ZERO     0x0008
   #define SPP_PMTUD_ENABLE        0x0010
   #define SPP_PMTUD_DISABLE       0x0020
   #define SPP_IPV6_FLOWLABEL      0x0040
   #define SPP_DSCP                0x0080
   
   struct sctp_paddrinfo {
           sctp_assoc_t spinfo_assoc_id;
           struct sockaddr_storage spinfo_address;
           int32_t spinfo_state;
           u_int32_t spinfo_cwnd;
           u_int32_t spinfo_srtt;
           u_int32_t spinfo_rto;
           u_int32_t spinfo_mtu;
   } __packed;
   
   struct sctp_rtoinfo {
           sctp_assoc_t srto_assoc_id;
           u_int32_t srto_initial;
           u_int32_t srto_max;
           u_int32_t srto_min;
   } __packed;
   
   struct sctp_assocparams {
           sctp_assoc_t sasoc_assoc_id;
           u_int16_t sasoc_asocmaxrxt;
           u_int16_t sasoc_number_peer_destinations;
           u_int32_t sasoc_peer_rwnd;
           u_int32_t sasoc_local_rwnd;
           u_int32_t sasoc_cookie_life;
   } __packed;
   
   struct sctp_setprim {
           sctp_assoc_t ssp_assoc_id;
           struct sockaddr_storage ssp_addr;
   } __packed;
   
   struct sctp_setpeerprim {
           sctp_assoc_t sspp_assoc_id;
           struct sockaddr_storage sspp_addr;
   } __packed;
   
   struct sctp_getaddresses {
           sctp_assoc_t sget_assoc_id;
           /* addr is filled in for N * sockaddr_storage */
           struct sockaddr addr[1];
   } __packed;
   
   struct sctp_setstrm_timeout {
           sctp_assoc_t ssto_assoc_id;
           u_int32_t ssto_timeout;
           u_int32_t ssto_streamid_start;
           u_int32_t ssto_streamid_end;
   } __packed;
   
   struct sctp_status {
           sctp_assoc_t sstat_assoc_id;
           int32_t sstat_state;
           u_int32_t sstat_rwnd;
           u_int16_t sstat_unackdata;
           u_int16_t sstat_penddata;
           u_int16_t sstat_instrms;
           u_int16_t sstat_outstrms;
           u_int32_t sstat_fragmentation_point;
           struct sctp_paddrinfo sstat_primary;
   } __packed;
   
   struct sctp_cwnd_args {
           struct sctp_nets *net;          /* network to */
           u_int32_t cwnd_new_value;       /* cwnd in k */
           u_int32_t inflight;             /* flightsize in k */
           int cwnd_augment;               /* increment to it */
   } __packed;
   
   struct sctp_blk_args {
           u_int32_t onmb;                 /* in 1k bytes */
           u_int32_t onsb;                 /* in 1k bytes */
           u_int16_t maxmb;                /* in 1k bytes */
           u_int16_t maxsb;                /* in 1k bytes */
           u_int16_t send_sent_qcnt;       /* chnk cnt */
           u_int16_t stream_qcnt;          /* chnk cnt */
   } __packed;
   
   /*
    * Max we can reset in one setting, note this is dictated not by the
    * define but the size of a mbuf cluster so don't change this define
    * and think you can specify more. You must do multiple resets if you
    * want to reset more than SCTP_MAX_EXPLICIT_STR_RESET.
    */
   #define SCTP_MAX_EXPLICT_STR_RESET   1000
   
   #define SCTP_RESET_LOCAL_RECV  0x0001
   #define SCTP_RESET_LOCAL_SEND  0x0002
   #define SCTP_RESET_BOTH        0x0003
   
   struct sctp_stream_reset {
           sctp_assoc_t strrst_assoc_id;
           u_int16_t    strrst_flags;
           u_int16_t    strrst_num_streams;        /* 0 == ALL */
           u_int16_t    strrst_list[0];            /* list if strrst_num_streams is not 0*/
   } __packed;
   
   
   struct sctp_get_nonce_values {
           sctp_assoc_t gn_assoc_id;
           u_int32_t    gn_peers_tag;
           u_int32_t    gn_local_tag;
   } __packed;
   
   /* Debugging logs */
   struct sctp_str_log{
           u_int32_t n_tsn;
           u_int32_t e_tsn;
           u_int16_t n_sseq;
           u_int16_t e_sseq;
   } __packed;
   
   struct sctp_fr_log {
           u_int32_t largest_tsn;
           u_int32_t largest_new_tsn;
           u_int32_t tsn;
   } __packed;
   
   struct sctp_fr_map {
           u_int32_t base;
           u_int32_t cum;
           u_int32_t high;
   } __packed;
   
   struct sctp_rwnd_log {
           u_int32_t rwnd;
           u_int32_t send_size;
           u_int32_t overhead;
           u_int32_t new_rwnd;
   } __packed;
   
   struct sctp_mbcnt_log {
           u_int32_t total_queue_size;
           u_int32_t size_change;
           u_int32_t total_queue_mb_size;
           u_int32_t mbcnt_change;
   } __packed;
   
   struct sctp_cwnd_log {
           union {
                   struct sctp_blk_args blk;
                   struct sctp_cwnd_args cwnd;
                   struct sctp_str_log strlog;
                   struct sctp_fr_log fr;
                   struct sctp_fr_map map;
                   struct sctp_rwnd_log rwnd;
                   struct sctp_mbcnt_log mbcnt;
           }x;
           u_int8_t from;
           u_int8_t event_type;
   
   } __packed;
   
   struct sctp_cwnd_log_req {
           int num_in_log;     /* Number in log */
           int num_ret;        /* Number returned */
           int start_at;       /* start at this one */
           int end_at;         /* end at this one */
           struct sctp_cwnd_log log[0];
   } __packed;
   
   struct sctp_sendv_spa {
           u_int32_t sendv_flags;
           struct sctp_sndinfo sendv_sndinfo;
           struct sctp_prinfo sendv_prinfo;
           struct sctp_authinfo sendv_authinfo;
   } __packed;
   
   #define SCTP_SEND_SNDINFO_VALID         0x00000001
   #define SCTP_SEND_PRINFO_VALID          0x00000002
   #define SCTP_SEND_AUTHINFO_VALID        0x00000004
   
   #define SCTP_SENDV_NOINFO       0x0000
   #define SCTP_SENDV_SNDINFO      0x0001
   #define SCTP_SENDV_PRINFO       0x0002
   #define SCTP_SENDV_AUTHINFO     0x0003
   #define SCTP_SENDV_SPA          0x0004
   
   struct sctp_recvv_rn {
           struct sctp_rcvinfo recvv_rcvinfo;
           struct sctp_nxtinfo recvv_nxtinfo;
   } __packed;
   
   #define SCTP_RECVV_NOINFO       0x0000
   #define SCTP_RECVV_RCVINFO      0x0001
   #define SCTP_RECVV_NXTINFO      0x0002
   #define SCTP_RECVV_RN           0x0003
   
   struct sctp_connectx_addrs {
           int cx_num;
           int cx_len;
           void *cx_addrs;
   } __packed;
   
   #define SIOCCONNECTX    _IOWR('s', 11, struct sctp_connectx_addrs)
   #define SIOCCONNECTXDEL _IOWR('s', 12, struct sctp_connectx_addrs)
   
   /*
    * API system calls
    */
   #if !defined(_KERNEL)
   
   __BEGIN_DECLS
   int sctp_peeloff(int, sctp_assoc_t);
   int     sctp_bindx(int, struct sockaddr *, int, int);
   int     sctp_connectx(int, struct sockaddr *, int, sctp_assoc_t *);
   int     sctp_getpaddrs(int, sctp_assoc_t, struct sockaddr **);
   void    sctp_freepaddrs(struct sockaddr *);
   int     sctp_getladdrs(int, sctp_assoc_t, struct sockaddr **);
   void    sctp_freeladdrs(struct sockaddr *);
   int     sctp_opt_info(int, sctp_assoc_t, int, void *, socklen_t *);
   
   ssize_t sctp_sendmsg(int, const void *, size_t,
           const struct sockaddr *,
           socklen_t, u_int32_t, u_int32_t, u_int16_t, u_int32_t, u_int32_t);
   
   ssize_t sctp_send(int, const void *, size_t,
           const struct sctp_sndrcvinfo *, int);
   
   ssize_t
   sctp_sendx(int, const void *, size_t, struct sockaddr *, int,
                   struct sctp_sndrcvinfo *, int);
   ssize_t
   sctp_sendmsgx(int sd, const void *, size_t,
                 struct sockaddr *, int,
                 u_int32_t, u_int32_t, u_int16_t, u_int32_t, u_int32_t);
   ssize_t sctp_sendv(int, const struct iovec *, int, struct sockaddr *, int,
                         void *, socklen_t, unsigned int, int);
   
   sctp_assoc_t
   sctp_getassocid(int sd, struct sockaddr *sa);
   
   ssize_t sctp_recvmsg(int, void *, size_t, struct sockaddr *,
           socklen_t *, struct sctp_sndrcvinfo *, int *);
   ssize_t sctp_recvv(int, const struct iovec *, int, struct sockaddr *,
                         socklen_t *, void *, socklen_t *, unsigned int *,
                         int *);
   
   __END_DECLS
   
   #endif /* !_KERNEL */
   #endif /* !__SCTP_UIO_H__ */

Cache object: fe158c673b5ac600d8b227287b8898be