The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

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

Version: -  FREEBSD  -  FREEBSD11  -  FREEBSD10  -  FREEBSD9  -  FREEBSD92  -  FREEBSD91  -  FREEBSD90  -  FREEBSD8  -  FREEBSD82  -  FREEBSD81  -  FREEBSD80  -  FREEBSD7  -  FREEBSD74  -  FREEBSD73  -  FREEBSD72  -  FREEBSD71  -  FREEBSD70  -  FREEBSD6  -  FREEBSD64  -  FREEBSD63  -  FREEBSD62  -  FREEBSD61  -  FREEBSD60  -  FREEBSD5  -  FREEBSD55  -  FREEBSD54  -  FREEBSD53  -  FREEBSD52  -  FREEBSD51  -  FREEBSD50  -  FREEBSD4  -  FREEBSD3  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Copyright (c) 2001-2008, 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_structs.h,v 1.13 2005/03/06 16:04:18 itojun Exp $         */
   32 
   33 #include <sys/cdefs.h>
   34 __FBSDID("$FreeBSD: stable/7/sys/netinet/sctp_structs.h 233643 2012-03-29 02:47:01Z eadler $");
   35 
   36 #ifndef __sctp_structs_h__
   37 #define __sctp_structs_h__
   38 
   39 #include <netinet/sctp_os.h>
   40 #include <netinet/sctp_header.h>
   41 #include <netinet/sctp_auth.h>
   42 
   43 struct sctp_timer {
   44         sctp_os_timer_t timer;
   45 
   46         int type;
   47         /*
   48          * Depending on the timer type these will be setup and cast with the
   49          * appropriate entity.
   50          */
   51         void *ep;
   52         void *tcb;
   53         void *net;
   54 
   55         /* for sanity checking */
   56         void *self;
   57         uint32_t ticks;
   58         uint32_t stopped_from;
   59 };
   60 
   61 
   62 struct sctp_foo_stuff {
   63         struct sctp_inpcb *inp;
   64         uint32_t lineno;
   65         uint32_t ticks;
   66         int updown;
   67 };
   68 
   69 
   70 /*
   71  * This is the information we track on each interface that we know about from
   72  * the distant end.
   73  */
   74 TAILQ_HEAD(sctpnetlisthead, sctp_nets);
   75 
   76 struct sctp_stream_reset_list {
   77         TAILQ_ENTRY(sctp_stream_reset_list) next_resp;
   78         uint32_t tsn;
   79         int number_entries;
   80         struct sctp_stream_reset_out_request req;
   81 };
   82 
   83 TAILQ_HEAD(sctp_resethead, sctp_stream_reset_list);
   84 
   85 /*
   86  * Users of the iterator need to malloc a iterator with a call to
   87  * sctp_initiate_iterator(inp_func, assoc_func, inp_func,  pcb_flags, pcb_features,
   88  *     asoc_state, void-ptr-arg, uint32-arg, end_func, inp);
   89  *
   90  * Use the following two defines if you don't care what pcb flags are on the EP
   91  * and/or you don't care what state the association is in.
   92  *
   93  * Note that if you specify an INP as the last argument then ONLY each
   94  * association of that single INP will be executed upon. Note that the pcb
   95  * flags STILL apply so if the inp you specify has different pcb_flags then
   96  * what you put in pcb_flags nothing will happen. use SCTP_PCB_ANY_FLAGS to
   97  * assure the inp you specify gets treated.
   98  */
   99 #define SCTP_PCB_ANY_FLAGS      0x00000000
  100 #define SCTP_PCB_ANY_FEATURES   0x00000000
  101 #define SCTP_ASOC_ANY_STATE     0x00000000
  102 
  103 typedef void (*asoc_func) (struct sctp_inpcb *, struct sctp_tcb *, void *ptr,
  104          uint32_t val);
  105 typedef int (*inp_func) (struct sctp_inpcb *, void *ptr, uint32_t val);
  106 typedef void (*end_func) (void *ptr, uint32_t val);
  107 
  108 struct sctp_iterator {
  109         TAILQ_ENTRY(sctp_iterator) sctp_nxt_itr;
  110         struct sctp_timer tmr;
  111         struct sctp_inpcb *inp; /* current endpoint */
  112         struct sctp_tcb *stcb;  /* current* assoc */
  113         asoc_func function_assoc;       /* per assoc function */
  114         inp_func function_inp;  /* per endpoint function */
  115         inp_func function_inp_end;      /* end INP function */
  116         end_func function_atend;/* iterator completion function */
  117         void *pointer;          /* pointer for apply func to use */
  118         uint32_t val;           /* value for apply func to use */
  119         uint32_t pcb_flags;     /* endpoint flags being checked */
  120         uint32_t pcb_features;  /* endpoint features being checked */
  121         uint32_t asoc_state;    /* assoc state being checked */
  122         uint32_t iterator_flags;
  123         uint8_t no_chunk_output;
  124         uint8_t done_current_ep;
  125 };
  126 
  127 /* iterator_flags values */
  128 #define SCTP_ITERATOR_DO_ALL_INP        0x00000001
  129 #define SCTP_ITERATOR_DO_SINGLE_INP     0x00000002
  130 
  131 TAILQ_HEAD(sctpiterators, sctp_iterator);
  132 
  133 struct sctp_copy_all {
  134         struct sctp_inpcb *inp; /* ep */
  135         struct mbuf *m;
  136         struct sctp_sndrcvinfo sndrcv;
  137         int sndlen;
  138         int cnt_sent;
  139         int cnt_failed;
  140 };
  141 
  142 struct sctp_asconf_iterator {
  143         struct sctpladdr list_of_work;
  144         int cnt;
  145 };
  146 
  147 struct sctp_net_route {
  148         sctp_rtentry_t *ro_rt;
  149         union sctp_sockstore _l_addr;   /* remote peer addr */
  150         struct sctp_ifa *_s_addr;       /* our selected src addr */
  151 };
  152 
  153 struct htcp {
  154         uint16_t alpha;         /* Fixed point arith, << 7 */
  155         uint8_t beta;           /* Fixed point arith, << 7 */
  156         uint8_t modeswitch;     /* Delay modeswitch until we had at least one
  157                                  * congestion event */
  158         uint32_t last_cong;     /* Time since last congestion event end */
  159         uint32_t undo_last_cong;
  160         uint16_t bytes_acked;
  161         uint32_t bytecount;
  162         uint32_t minRTT;
  163         uint32_t maxRTT;
  164 
  165         uint32_t undo_maxRTT;
  166         uint32_t undo_old_maxB;
  167 
  168         /* Bandwidth estimation */
  169         uint32_t minB;
  170         uint32_t maxB;
  171         uint32_t old_maxB;
  172         uint32_t Bi;
  173         uint32_t lasttime;
  174 };
  175 
  176 
  177 struct sctp_nets {
  178         TAILQ_ENTRY(sctp_nets) sctp_next;       /* next link */
  179 
  180         /*
  181          * Things on the top half may be able to be split into a common
  182          * structure shared by all.
  183          */
  184         struct sctp_timer pmtu_timer;
  185 
  186         /*
  187          * The following two in combination equate to a route entry for v6
  188          * or v4.
  189          */
  190         struct sctp_net_route ro;
  191 
  192         /* mtu discovered so far */
  193         uint32_t mtu;
  194         uint32_t ssthresh;      /* not sure about this one for split */
  195 
  196         /* smoothed average things for RTT and RTO itself */
  197         int lastsa;
  198         int lastsv;
  199         unsigned int RTO;
  200 
  201         /* This is used for SHUTDOWN/SHUTDOWN-ACK/SEND or INIT timers */
  202         struct sctp_timer rxt_timer;
  203         struct sctp_timer fr_timer;     /* for early fr */
  204 
  205         /* last time in seconds I sent to it */
  206         struct timeval last_sent_time;
  207         int ref_count;
  208 
  209         /* Congestion stats per destination */
  210         /*
  211          * flight size variables and such, sorry Vern, I could not avoid
  212          * this if I wanted performance :>
  213          */
  214         uint32_t flight_size;
  215         uint32_t cwnd;          /* actual cwnd */
  216         uint32_t prev_cwnd;     /* cwnd before any processing */
  217         uint32_t partial_bytes_acked;   /* in CA tracks when to incr a MTU */
  218         uint32_t prev_rtt;
  219         /* tracking variables to avoid the aloc/free in sack processing */
  220         unsigned int net_ack;
  221         unsigned int net_ack2;
  222 
  223         /*
  224          * JRS - 5/8/07 - Variable to track last time a destination was
  225          * active for CMT PF
  226          */
  227         uint32_t last_active;
  228 
  229         /*
  230          * CMT variables (iyengar@cis.udel.edu)
  231          */
  232         uint32_t this_sack_highest_newack;      /* tracks highest TSN newly
  233                                                  * acked for a given dest in
  234                                                  * the current SACK. Used in
  235                                                  * SFR and HTNA algos */
  236         uint32_t pseudo_cumack; /* CMT CUC algorithm. Maintains next expected
  237                                  * pseudo-cumack for this destination */
  238         uint32_t rtx_pseudo_cumack;     /* CMT CUC algorithm. Maintains next
  239                                          * expected pseudo-cumack for this
  240                                          * destination */
  241 
  242         /* CMT fast recovery variables */
  243         uint32_t fast_recovery_tsn;
  244         uint32_t heartbeat_random1;
  245         uint32_t heartbeat_random2;
  246         uint32_t tos_flowlabel;
  247 
  248         struct timeval start_time;      /* time when this net was created */
  249 
  250         uint32_t marked_retrans;/* number or DATA chunks marked for timer
  251                                  * based retransmissions */
  252         uint32_t marked_fastretrans;
  253 
  254         /* if this guy is ok or not ... status */
  255         uint16_t dest_state;
  256         /* number of transmit failures to down this guy */
  257         uint16_t failure_threshold;
  258         /* error stats on destination */
  259         uint16_t error_count;
  260         /* UDP port number in case of UDP tunneling */
  261         uint16_t port;
  262 
  263         uint8_t fast_retran_loss_recovery;
  264         uint8_t will_exit_fast_recovery;
  265         /* Flags that probably can be combined into dest_state */
  266         uint8_t fast_retran_ip; /* fast retransmit in progress */
  267         uint8_t hb_responded;
  268         uint8_t saw_newack;     /* CMT's SFR algorithm flag */
  269         uint8_t src_addr_selected;      /* if we split we move */
  270         uint8_t indx_of_eligible_next_to_use;
  271         uint8_t addr_is_local;  /* its a local address (if known) could move
  272                                  * in split */
  273 
  274         /*
  275          * CMT variables (iyengar@cis.udel.edu)
  276          */
  277         uint8_t find_pseudo_cumack;     /* CMT CUC algorithm. Flag used to
  278                                          * find a new pseudocumack. This flag
  279                                          * is set after a new pseudo-cumack
  280                                          * has been received and indicates
  281                                          * that the sender should find the
  282                                          * next pseudo-cumack expected for
  283                                          * this destination */
  284         uint8_t find_rtx_pseudo_cumack; /* CMT CUCv2 algorithm. Flag used to
  285                                          * find a new rtx-pseudocumack. This
  286                                          * flag is set after a new
  287                                          * rtx-pseudo-cumack has been received
  288                                          * and indicates that the sender
  289                                          * should find the next
  290                                          * rtx-pseudo-cumack expected for this
  291                                          * destination */
  292         uint8_t new_pseudo_cumack;      /* CMT CUC algorithm. Flag used to
  293                                          * indicate if a new pseudo-cumack or
  294                                          * rtx-pseudo-cumack has been received */
  295         uint8_t window_probe;   /* Doing a window probe? */
  296         uint8_t RTO_measured;   /* Have we done the first measure */
  297         uint8_t last_hs_used;   /* index into the last HS table entry we used */
  298         /* JRS - struct used in HTCP algorithm */
  299         struct htcp htcp_ca;
  300 };
  301 
  302 
  303 struct sctp_data_chunkrec {
  304         uint32_t TSN_seq;       /* the TSN of this transmit */
  305         uint16_t stream_seq;    /* the stream sequence number of this transmit */
  306         uint16_t stream_number; /* the stream number of this guy */
  307         uint32_t payloadtype;
  308         uint32_t context;       /* from send */
  309 
  310         /* ECN Nonce: Nonce Value for this chunk */
  311         uint8_t ect_nonce;
  312 
  313         /*
  314          * part of the Highest sacked algorithm to be able to stroke counts
  315          * on ones that are FR'd.
  316          */
  317         uint32_t fast_retran_tsn;       /* sending_seq at the time of FR */
  318         struct timeval timetodrop;      /* time we drop it from queue */
  319         uint8_t doing_fast_retransmit;
  320         uint8_t rcv_flags;      /* flags pulled from data chunk on inbound for
  321                                  * outbound holds sending flags for PR-SCTP. */
  322         uint8_t state_flags;
  323         uint8_t chunk_was_revoked;
  324 };
  325 
  326 TAILQ_HEAD(sctpchunk_listhead, sctp_tmit_chunk);
  327 
  328 /* The lower byte is used to enumerate PR_SCTP policies */
  329 #define CHUNK_FLAGS_PR_SCTP_TTL         SCTP_PR_SCTP_TTL
  330 #define CHUNK_FLAGS_PR_SCTP_BUF         SCTP_PR_SCTP_BUF
  331 #define CHUNK_FLAGS_PR_SCTP_RTX         SCTP_PR_SCTP_RTX
  332 
  333 /* The upper byte is used as a bit mask */
  334 #define CHUNK_FLAGS_FRAGMENT_OK         0x0100
  335 
  336 struct chk_id {
  337         uint16_t id;
  338         uint16_t can_take_data;
  339 };
  340 
  341 
  342 struct sctp_tmit_chunk {
  343         union {
  344                 struct sctp_data_chunkrec data;
  345                 struct chk_id chunk_id;
  346         }     rec;
  347         struct sctp_association *asoc;  /* bp to asoc this belongs to */
  348         struct timeval sent_rcv_time;   /* filled in if RTT being calculated */
  349         struct mbuf *data;      /* pointer to mbuf chain of data */
  350         struct mbuf *last_mbuf; /* pointer to last mbuf in chain */
  351         struct sctp_nets *whoTo;
  352                   TAILQ_ENTRY(sctp_tmit_chunk) sctp_next;       /* next link */
  353         int32_t sent;           /* the send status */
  354         uint16_t snd_count;     /* number of times I sent */
  355         uint16_t flags;         /* flags, such as FRAGMENT_OK */
  356         uint16_t send_size;
  357         uint16_t book_size;
  358         uint16_t mbcnt;
  359         uint16_t auth_keyid;
  360         uint8_t holds_key_ref;  /* flag if auth keyid refcount is held */
  361         uint8_t pad_inplace;
  362         uint8_t do_rtt;
  363         uint8_t book_size_scale;
  364         uint8_t addr_over;      /* flag which is set if the dest address for
  365                                  * this chunk is overridden by user. Used for
  366                                  * CMT (iyengar@cis.udel.edu, 2005/06/21) */
  367         uint8_t no_fr_allowed;
  368         uint8_t pr_sctp_on;
  369         uint8_t copy_by_ref;
  370         uint8_t window_probe;
  371 };
  372 
  373 /*
  374  * The first part of this structure MUST be the entire sinfo structure. Maybe
  375  * I should have made it a sub structure... we can circle back later and do
  376  * that if we want.
  377  */
  378 struct sctp_queued_to_read {    /* sinfo structure Pluse more */
  379         uint16_t sinfo_stream;  /* off the wire */
  380         uint16_t sinfo_ssn;     /* off the wire */
  381         uint16_t sinfo_flags;   /* SCTP_UNORDERED from wire use SCTP_EOF for
  382                                  * EOR */
  383         uint32_t sinfo_ppid;    /* off the wire */
  384         uint32_t sinfo_context; /* pick this up from assoc def context? */
  385         uint32_t sinfo_timetolive;      /* not used by kernel */
  386         uint32_t sinfo_tsn;     /* Use this in reassembly as first TSN */
  387         uint32_t sinfo_cumtsn;  /* Use this in reassembly as last TSN */
  388         sctp_assoc_t sinfo_assoc_id;    /* our assoc id */
  389         /* Non sinfo stuff */
  390         uint32_t length;        /* length of data */
  391         uint32_t held_length;   /* length held in sb */
  392         struct sctp_nets *whoFrom;      /* where it came from */
  393         struct mbuf *data;      /* front of the mbuf chain of data with
  394                                  * PKT_HDR */
  395         struct mbuf *tail_mbuf; /* used for multi-part data */
  396         struct mbuf *aux_data;  /* used to hold/cache  control if o/s does not
  397                                  * take it from us */
  398         struct sctp_tcb *stcb;  /* assoc, used for window update */
  399                  TAILQ_ENTRY(sctp_queued_to_read) next;
  400         uint16_t port_from;
  401         uint16_t spec_flags;    /* Flags to hold the notification field */
  402         uint8_t do_not_ref_stcb;
  403         uint8_t end_added;
  404         uint8_t pdapi_aborted;
  405         uint8_t some_taken;
  406 };
  407 
  408 /* This data structure will be on the outbound
  409  * stream queues. Data will be pulled off from
  410  * the front of the mbuf data and chunk-ified
  411  * by the output routines. We will custom
  412  * fit every chunk we pull to the send/sent
  413  * queue to make up the next full packet
  414  * if we can. An entry cannot be removed
  415  * from the stream_out queue until
  416  * the msg_is_complete flag is set. This
  417  * means at times data/tail_mbuf MIGHT
  418  * be NULL.. If that occurs it happens
  419  * for one of two reasons. Either the user
  420  * is blocked on a send() call and has not
  421  * awoken to copy more data down... OR
  422  * the user is in the explict MSG_EOR mode
  423  * and wrote some data, but has not completed
  424  * sending.
  425  */
  426 struct sctp_stream_queue_pending {
  427         struct mbuf *data;
  428         struct mbuf *tail_mbuf;
  429         struct timeval ts;
  430         struct sctp_nets *net;
  431                   TAILQ_ENTRY(sctp_stream_queue_pending) next;
  432         uint32_t length;
  433         uint32_t timetolive;
  434         uint32_t ppid;
  435         uint32_t context;
  436         uint16_t sinfo_flags;
  437         uint16_t stream;
  438         uint16_t strseq;
  439         uint16_t act_flags;
  440         uint16_t auth_keyid;
  441         uint8_t holds_key_ref;
  442         uint8_t msg_is_complete;
  443         uint8_t some_taken;
  444         uint8_t addr_over;
  445         uint8_t pr_sctp_on;
  446         uint8_t sender_all_done;
  447         uint8_t put_last_out;
  448 };
  449 
  450 /*
  451  * this struct contains info that is used to track inbound stream data and
  452  * help with ordering.
  453  */
  454 TAILQ_HEAD(sctpwheelunrel_listhead, sctp_stream_in);
  455 struct sctp_stream_in {
  456         struct sctp_readhead inqueue;
  457         uint16_t stream_no;
  458         uint16_t last_sequence_delivered;       /* used for re-order */
  459         uint8_t delivery_started;
  460 };
  461 
  462 /* This struct is used to track the traffic on outbound streams */
  463 TAILQ_HEAD(sctpwheel_listhead, sctp_stream_out);
  464 struct sctp_stream_out {
  465         struct sctp_streamhead outqueue;
  466                         TAILQ_ENTRY(sctp_stream_out) next_spoke;        /* next link in wheel */
  467         uint16_t stream_no;
  468         uint16_t next_sequence_sent;    /* next one I expect to send out */
  469         uint8_t last_msg_incomplete;
  470 };
  471 
  472 /* used to keep track of the addresses yet to try to add/delete */
  473 TAILQ_HEAD(sctp_asconf_addrhead, sctp_asconf_addr);
  474 struct sctp_asconf_addr {
  475         TAILQ_ENTRY(sctp_asconf_addr) next;
  476         struct sctp_asconf_addr_param ap;
  477         struct sctp_ifa *ifa;   /* save the ifa for add/del ip */
  478         uint8_t sent;           /* has this been sent yet? */
  479         uint8_t special_del;    /* not to be used in lookup */
  480 
  481 };
  482 
  483 struct sctp_scoping {
  484         uint8_t ipv4_addr_legal;
  485         uint8_t ipv6_addr_legal;
  486         uint8_t loopback_scope;
  487         uint8_t ipv4_local_scope;
  488         uint8_t local_scope;
  489         uint8_t site_scope;
  490 };
  491 
  492 #define SCTP_TSN_LOG_SIZE 40
  493 
  494 struct sctp_tsn_log {
  495         void *stcb;
  496         uint32_t tsn;
  497         uint16_t strm;
  498         uint16_t seq;
  499         uint16_t sz;
  500         uint16_t flgs;
  501         uint16_t in_pos;
  502         uint16_t in_out;
  503 };
  504 
  505 #define SCTP_FS_SPEC_LOG_SIZE 200
  506 struct sctp_fs_spec_log {
  507         uint32_t sent;
  508         uint32_t total_flight;
  509         uint32_t tsn;
  510         uint16_t book;
  511         uint8_t incr;
  512         uint8_t decr;
  513 };
  514 
  515 /* This struct is here to cut out the compatiabilty
  516  * pad that bulks up both the inp and stcb. The non
  517  * pad portion MUST stay in complete sync with
  518  * sctp_sndrcvinfo... i.e. if sinfo_xxxx is added
  519  * this must be done here too.
  520  */
  521 struct sctp_nonpad_sndrcvinfo {
  522         uint16_t sinfo_stream;
  523         uint16_t sinfo_ssn;
  524         uint16_t sinfo_flags;
  525         uint32_t sinfo_ppid;
  526         uint32_t sinfo_context;
  527         uint32_t sinfo_timetolive;
  528         uint32_t sinfo_tsn;
  529         uint32_t sinfo_cumtsn;
  530         sctp_assoc_t sinfo_assoc_id;
  531 };
  532 
  533 /*
  534  * JRS - Structure to hold function pointers to the functions responsible
  535  * for congestion control.
  536  */
  537 
  538 struct sctp_cc_functions {
  539         void (*sctp_set_initial_cc_param) (struct sctp_tcb *stcb, struct sctp_nets *net);
  540         void (*sctp_cwnd_update_after_sack) (struct sctp_tcb *stcb,
  541                  struct sctp_association *asoc,
  542                  int accum_moved, int reneged_all, int will_exit);
  543         void (*sctp_cwnd_update_after_fr) (struct sctp_tcb *stcb,
  544                  struct sctp_association *asoc);
  545         void (*sctp_cwnd_update_after_timeout) (struct sctp_tcb *stcb,
  546                  struct sctp_nets *net);
  547         void (*sctp_cwnd_update_after_ecn_echo) (struct sctp_tcb *stcb,
  548                  struct sctp_nets *net);
  549         void (*sctp_cwnd_update_after_packet_dropped) (struct sctp_tcb *stcb,
  550                  struct sctp_nets *net, struct sctp_pktdrop_chunk *cp,
  551                  uint32_t * bottle_bw, uint32_t * on_queue);
  552         void (*sctp_cwnd_update_after_output) (struct sctp_tcb *stcb,
  553                  struct sctp_nets *net, int burst_limit);
  554         void (*sctp_cwnd_update_after_fr_timer) (struct sctp_inpcb *inp,
  555                  struct sctp_tcb *stcb, struct sctp_nets *net);
  556 };
  557 
  558 /* used to save ASCONF chunks for retransmission */
  559 TAILQ_HEAD(sctp_asconf_head, sctp_asconf);
  560 struct sctp_asconf {
  561         TAILQ_ENTRY(sctp_asconf) next;
  562         uint32_t serial_number;
  563         uint16_t snd_count;
  564         struct mbuf *data;
  565         uint16_t len;
  566 };
  567 
  568 /* used to save ASCONF-ACK chunks for retransmission */
  569 TAILQ_HEAD(sctp_asconf_ackhead, sctp_asconf_ack);
  570 struct sctp_asconf_ack {
  571         TAILQ_ENTRY(sctp_asconf_ack) next;
  572         uint32_t serial_number;
  573         struct sctp_nets *last_sent_to;
  574         struct mbuf *data;
  575         uint16_t len;
  576 };
  577 
  578 /*
  579  * Here we have information about each individual association that we track.
  580  * We probably in production would be more dynamic. But for ease of
  581  * implementation we will have a fixed array that we hunt for in a linear
  582  * fashion.
  583  */
  584 struct sctp_association {
  585         /* association state */
  586         int state;
  587 
  588         /* queue of pending addrs to add/delete */
  589         struct sctp_asconf_addrhead asconf_queue;
  590 
  591         struct timeval time_entered;    /* time we entered state */
  592         struct timeval time_last_rcvd;
  593         struct timeval time_last_sent;
  594         struct timeval time_last_sat_advance;
  595         struct sctp_nonpad_sndrcvinfo def_send;
  596 
  597         /* timers and such */
  598         struct sctp_timer hb_timer;     /* hb timer */
  599         struct sctp_timer dack_timer;   /* Delayed ack timer */
  600         struct sctp_timer asconf_timer; /* asconf */
  601         struct sctp_timer strreset_timer;       /* stream reset */
  602         struct sctp_timer shut_guard_timer;     /* shutdown guard */
  603         struct sctp_timer autoclose_timer;      /* automatic close timer */
  604         struct sctp_timer delayed_event_timer;  /* timer for delayed events */
  605         struct sctp_timer delete_prim_timer;    /* deleting primary dst */
  606 
  607         /* list of restricted local addresses */
  608         struct sctpladdr sctp_restricted_addrs;
  609 
  610         /* last local address pending deletion (waiting for an address add) */
  611         struct sctp_ifa *asconf_addr_del_pending;
  612         /* Deleted primary destination (used to stop timer) */
  613         struct sctp_nets *deleted_primary;
  614 
  615         struct sctpnetlisthead nets;    /* remote address list */
  616 
  617         /* Free chunk list */
  618         struct sctpchunk_listhead free_chunks;
  619 
  620         /* Control chunk queue */
  621         struct sctpchunk_listhead control_send_queue;
  622 
  623         /* ASCONF chunk queue */
  624         struct sctpchunk_listhead asconf_send_queue;
  625 
  626         /*
  627          * Once a TSN hits the wire it is moved to the sent_queue. We
  628          * maintain two counts here (don't know if any but retran_cnt is
  629          * needed). The idea is that the sent_queue_retran_cnt reflects how
  630          * many chunks have been marked for retranmission by either T3-rxt
  631          * or FR.
  632          */
  633         struct sctpchunk_listhead sent_queue;
  634         struct sctpchunk_listhead send_queue;
  635 
  636         /* re-assembly queue for fragmented chunks on the inbound path */
  637         struct sctpchunk_listhead reasmqueue;
  638 
  639         /*
  640          * this queue is used when we reach a condition that we can NOT put
  641          * data into the socket buffer. We track the size of this queue and
  642          * set our rwnd to the space in the socket minus also the
  643          * size_on_delivery_queue.
  644          */
  645         struct sctpwheel_listhead out_wheel;
  646 
  647         /*
  648          * This pointer will be set to NULL most of the time. But when we
  649          * have a fragmented message, where we could not get out all of the
  650          * message at the last send then this will point to the stream to go
  651          * get data from.
  652          */
  653         struct sctp_stream_out *locked_on_sending;
  654 
  655         /* If an iterator is looking at me, this is it */
  656         struct sctp_iterator *stcb_starting_point_for_iterator;
  657 
  658         /* ASCONF save the last ASCONF-ACK so we can resend it if necessary */
  659         struct sctp_asconf_ackhead asconf_ack_sent;
  660 
  661         /*
  662          * pointer to last stream reset queued to control queue by us with
  663          * requests.
  664          */
  665         struct sctp_tmit_chunk *str_reset;
  666         /*
  667          * if Source Address Selection happening, this will rotate through
  668          * the link list.
  669          */
  670         struct sctp_laddr *last_used_address;
  671 
  672         /* stream arrays */
  673         struct sctp_stream_in *strmin;
  674         struct sctp_stream_out *strmout;
  675         uint8_t *mapping_array;
  676         /* primary destination to use */
  677         struct sctp_nets *primary_destination;
  678         /* For CMT */
  679         struct sctp_nets *last_net_data_came_from;
  680         /* last place I got a data chunk from */
  681         struct sctp_nets *last_data_chunk_from;
  682         /* last place I got a control from */
  683         struct sctp_nets *last_control_chunk_from;
  684 
  685         /* circular looking for output selection */
  686         struct sctp_stream_out *last_out_stream;
  687 
  688         /*
  689          * wait to the point the cum-ack passes req->send_reset_at_tsn for
  690          * any req on the list.
  691          */
  692         struct sctp_resethead resetHead;
  693 
  694         /* queue of chunks waiting to be sent into the local stack */
  695         struct sctp_readhead pending_reply_queue;
  696 
  697         /* JRS - the congestion control functions are in this struct */
  698         struct sctp_cc_functions cc_functions;
  699         /*
  700          * JRS - value to store the currently loaded congestion control
  701          * module
  702          */
  703         uint32_t congestion_control_module;
  704 
  705         uint32_t vrf_id;
  706 
  707         uint32_t cookie_preserve_req;
  708         /* ASCONF next seq I am sending out, inits at init-tsn */
  709         uint32_t asconf_seq_out;
  710         uint32_t asconf_seq_out_acked;
  711         /* ASCONF last received ASCONF from peer, starts at peer's TSN-1 */
  712         uint32_t asconf_seq_in;
  713 
  714         /* next seq I am sending in str reset messages */
  715         uint32_t str_reset_seq_out;
  716         /* next seq I am expecting in str reset messages */
  717         uint32_t str_reset_seq_in;
  718 
  719         /* various verification tag information */
  720         uint32_t my_vtag;       /* The tag to be used. if assoc is re-initited
  721                                  * by remote end, and I have unlocked this
  722                                  * will be regenerated to a new random value. */
  723         uint32_t peer_vtag;     /* The peers last tag */
  724 
  725         uint32_t my_vtag_nonce;
  726         uint32_t peer_vtag_nonce;
  727 
  728         uint32_t assoc_id;
  729 
  730         /* This is the SCTP fragmentation threshold */
  731         uint32_t smallest_mtu;
  732 
  733         /*
  734          * Special hook for Fast retransmit, allows us to track the highest
  735          * TSN that is NEW in this SACK if gap ack blocks are present.
  736          */
  737         uint32_t this_sack_highest_gap;
  738 
  739         /*
  740          * The highest consecutive TSN that has been acked by peer on my
  741          * sends
  742          */
  743         uint32_t last_acked_seq;
  744 
  745         /* The next TSN that I will use in sending. */
  746         uint32_t sending_seq;
  747 
  748         /* Original seq number I used ??questionable to keep?? */
  749         uint32_t init_seq_number;
  750 
  751 
  752         /* The Advanced Peer Ack Point, as required by the PR-SCTP */
  753         /* (A1 in Section 4.2) */
  754         uint32_t advanced_peer_ack_point;
  755 
  756         /*
  757          * The highest consequetive TSN at the bottom of the mapping array
  758          * (for his sends).
  759          */
  760         uint32_t cumulative_tsn;
  761         /*
  762          * Used to track the mapping array and its offset bits. This MAY be
  763          * lower then cumulative_tsn.
  764          */
  765         uint32_t mapping_array_base_tsn;
  766         /*
  767          * used to track highest TSN we have received and is listed in the
  768          * mapping array.
  769          */
  770         uint32_t highest_tsn_inside_map;
  771 
  772         /* EY - new NR variables used for nr_sack based on mapping_array */
  773         uint8_t *nr_mapping_array;
  774         uint32_t nr_mapping_array_base_tsn;
  775         uint32_t highest_tsn_inside_nr_map;
  776         uint16_t nr_mapping_array_size;
  777 
  778         uint32_t last_echo_tsn;
  779         uint32_t last_cwr_tsn;
  780         uint32_t fast_recovery_tsn;
  781         uint32_t sat_t3_recovery_tsn;
  782         uint32_t tsn_last_delivered;
  783         /*
  784          * For the pd-api we should re-write this a bit more efficent. We
  785          * could have multiple sctp_queued_to_read's that we are building at
  786          * once. Now we only do this when we get ready to deliver to the
  787          * socket buffer. Note that we depend on the fact that the struct is
  788          * "stuck" on the read queue until we finish all the pd-api.
  789          */
  790         struct sctp_queued_to_read *control_pdapi;
  791 
  792         uint32_t tsn_of_pdapi_last_delivered;
  793         uint32_t pdapi_ppid;
  794         uint32_t context;
  795         uint32_t last_reset_action[SCTP_MAX_RESET_PARAMS];
  796         uint32_t last_sending_seq[SCTP_MAX_RESET_PARAMS];
  797         uint32_t last_base_tsnsent[SCTP_MAX_RESET_PARAMS];
  798 #ifdef SCTP_ASOCLOG_OF_TSNS
  799         /*
  800          * special log  - This adds considerable size to the asoc, but
  801          * provides a log that you can use to detect problems via kgdb.
  802          */
  803         struct sctp_tsn_log in_tsnlog[SCTP_TSN_LOG_SIZE];
  804         struct sctp_tsn_log out_tsnlog[SCTP_TSN_LOG_SIZE];
  805         uint32_t cumack_log[SCTP_TSN_LOG_SIZE];
  806         uint32_t cumack_logsnt[SCTP_TSN_LOG_SIZE];
  807         uint16_t tsn_in_at;
  808         uint16_t tsn_out_at;
  809         uint16_t tsn_in_wrapped;
  810         uint16_t tsn_out_wrapped;
  811         uint16_t cumack_log_at;
  812         uint16_t cumack_log_atsnt;
  813 #endif                          /* SCTP_ASOCLOG_OF_TSNS */
  814 #ifdef SCTP_FS_SPEC_LOG
  815         struct sctp_fs_spec_log fslog[SCTP_FS_SPEC_LOG_SIZE];
  816         uint16_t fs_index;
  817 #endif
  818 
  819         /*
  820          * window state information and smallest MTU that I use to bound
  821          * segmentation
  822          */
  823         uint32_t peers_rwnd;
  824         uint32_t my_rwnd;
  825         uint32_t my_last_reported_rwnd;
  826         uint32_t sctp_frag_point;
  827 
  828         uint32_t total_output_queue_size;
  829 
  830         uint32_t sb_cc;         /* shadow of sb_cc */
  831         uint32_t sb_send_resv;  /* amount reserved on a send */
  832         uint32_t my_rwnd_control_len;   /* shadow of sb_mbcnt used for rwnd
  833                                          * control */
  834         /* 32 bit nonce stuff */
  835         uint32_t nonce_resync_tsn;
  836         uint32_t nonce_wait_tsn;
  837         uint32_t default_flowlabel;
  838         uint32_t pr_sctp_cnt;
  839         int ctrl_queue_cnt;     /* could be removed  REM */
  840         /*
  841          * All outbound datagrams queue into this list from the individual
  842          * stream queue. Here they get assigned a TSN and then await
  843          * sending. The stream seq comes when it is first put in the
  844          * individual str queue
  845          */
  846         unsigned int stream_queue_cnt;
  847         unsigned int send_queue_cnt;
  848         unsigned int sent_queue_cnt;
  849         unsigned int sent_queue_cnt_removeable;
  850         /*
  851          * Number on sent queue that are marked for retran until this value
  852          * is 0 we only send one packet of retran'ed data.
  853          */
  854         unsigned int sent_queue_retran_cnt;
  855 
  856         unsigned int size_on_reasm_queue;
  857         unsigned int cnt_on_reasm_queue;
  858         /* amount of data (bytes) currently in flight (on all destinations) */
  859         unsigned int total_flight;
  860         /* Total book size in flight */
  861         unsigned int total_flight_count;        /* count of chunks used with
  862                                                  * book total */
  863         /* count of destinaton nets and list of destination nets */
  864         unsigned int numnets;
  865 
  866         /* Total error count on this association */
  867         unsigned int overall_error_count;
  868 
  869         unsigned int cnt_msg_on_sb;
  870 
  871         /* All stream count of chunks for delivery */
  872         unsigned int size_on_all_streams;
  873         unsigned int cnt_on_all_streams;
  874 
  875         /* Heart Beat delay in ticks */
  876         unsigned int heart_beat_delay;
  877 
  878         /* autoclose */
  879         unsigned int sctp_autoclose_ticks;
  880 
  881         /* how many preopen streams we have */
  882         unsigned int pre_open_streams;
  883 
  884         /* How many streams I support coming into me */
  885         unsigned int max_inbound_streams;
  886 
  887         /* the cookie life I award for any cookie, in seconds */
  888         unsigned int cookie_life;
  889         /* time to delay acks for */
  890         unsigned int delayed_ack;
  891         unsigned int old_delayed_ack;
  892         unsigned int sack_freq;
  893         unsigned int data_pkts_seen;
  894 
  895         unsigned int numduptsns;
  896         int dup_tsns[SCTP_MAX_DUP_TSNS];
  897         unsigned int initial_init_rto_max;      /* initial RTO for INIT's */
  898         unsigned int initial_rto;       /* initial send RTO */
  899         unsigned int minrto;    /* per assoc RTO-MIN */
  900         unsigned int maxrto;    /* per assoc RTO-MAX */
  901 
  902         /* authentication fields */
  903         sctp_auth_chklist_t *local_auth_chunks;
  904         sctp_auth_chklist_t *peer_auth_chunks;
  905         sctp_hmaclist_t *local_hmacs;   /* local HMACs supported */
  906         sctp_hmaclist_t *peer_hmacs;    /* peer HMACs supported */
  907         struct sctp_keyhead shared_keys;        /* assoc's shared keys */
  908         sctp_authinfo_t authinfo;       /* randoms, cached keys */
  909         /*
  910          * refcnt to block freeing when a sender or receiver is off coping
  911          * user data in.
  912          */
  913         uint32_t refcnt;
  914         uint32_t chunks_on_out_queue;   /* total chunks floating around,
  915                                          * locked by send socket buffer */
  916         uint32_t peers_adaptation;
  917         uint16_t peer_hmac_id;  /* peer HMAC id to send */
  918 
  919         /*
  920          * Being that we have no bag to collect stale cookies, and that we
  921          * really would not want to anyway.. we will count them in this
  922          * counter. We of course feed them to the pigeons right away (I have
  923          * always thought of pigeons as flying rats).
  924          */
  925         uint16_t stale_cookie_count;
  926 
  927         /*
  928          * For the partial delivery API, if up, invoked this is what last
  929          * TSN I delivered
  930          */
  931         uint16_t str_of_pdapi;
  932         uint16_t ssn_of_pdapi;
  933 
  934         /* counts of actual built streams. Allocation may be more however */
  935         /* could re-arrange to optimize space here. */
  936         uint16_t streamincnt;
  937         uint16_t streamoutcnt;
  938 
  939         /* my maximum number of retrans of INIT and SEND */
  940         /* copied from SCTP but should be individually setable */
  941         uint16_t max_init_times;
  942         uint16_t max_send_times;
  943 
  944         uint16_t def_net_failure;
  945 
  946         /*
  947          * lock flag: 0 is ok to send, 1+ (duals as a retran count) is
  948          * awaiting ACK
  949          */
  950         uint16_t mapping_array_size;
  951 
  952         uint16_t last_strm_seq_delivered;
  953         uint16_t last_strm_no_delivered;
  954 
  955         uint16_t last_revoke_count;
  956         int16_t num_send_timers_up;
  957 
  958         uint16_t stream_locked_on;
  959         uint16_t ecn_echo_cnt_onq;
  960 
  961         uint16_t free_chunk_cnt;
  962 
  963         uint8_t stream_locked;
  964         uint8_t authenticated;  /* packet authenticated ok */
  965         /*
  966          * This flag indicates that a SACK need to be sent. Initially this
  967          * is 1 to send the first sACK immediately.
  968          */
  969         uint8_t send_sack;
  970 
  971         /* max burst after fast retransmit completes */
  972         uint8_t max_burst;
  973 
  974         uint8_t sat_network;    /* RTT is in range of sat net or greater */
  975         uint8_t sat_network_lockout;    /* lockout code */
  976         uint8_t burst_limit_applied;    /* Burst limit in effect at last send? */
  977         /* flag goes on when we are doing a partial delivery api */
  978         uint8_t hb_random_values[4];
  979         uint8_t fragmented_delivery_inprogress;
  980         uint8_t fragment_flags;
  981         uint8_t last_flags_delivered;
  982         uint8_t hb_ect_randombit;
  983         uint8_t hb_random_idx;
  984         uint8_t hb_is_disabled; /* is the hb disabled? */
  985         uint8_t default_tos;
  986         uint8_t asconf_del_pending;     /* asconf delete last addr pending */
  987 
  988         /* ECN Nonce stuff */
  989         uint8_t receiver_nonce_sum;     /* nonce I sum and put in my sack */
  990         uint8_t ecn_nonce_allowed;      /* Tells us if ECN nonce is on */
  991         uint8_t nonce_sum_check;/* On off switch used during re-sync */
  992         uint8_t nonce_wait_for_ecne;    /* flag when we expect a ECN */
  993         uint8_t peer_supports_ecn_nonce;
  994 
  995         /*
  996          * This value, plus all other ack'd but above cum-ack is added
  997          * together to cross check against the bit that we have yet to
  998          * define (probably in the SACK). When the cum-ack is updated, this
  999          * sum is updated as well.
 1000          */
 1001         uint8_t nonce_sum_expect_base;
 1002         /* Flag to tell if ECN is allowed */
 1003         uint8_t ecn_allowed;
 1004 
 1005         /* flag to indicate if peer can do asconf */
 1006         uint8_t peer_supports_asconf;
 1007         /* EY - flag to indicate if peer can do nr_sack */
 1008         uint8_t peer_supports_nr_sack;
 1009         /* pr-sctp support flag */
 1010         uint8_t peer_supports_prsctp;
 1011         /* peer authentication support flag */
 1012         uint8_t peer_supports_auth;
 1013         /* stream resets are supported by the peer */
 1014         uint8_t peer_supports_strreset;
 1015 
 1016         uint8_t peer_supports_nat;
 1017         /*
 1018          * packet drop's are supported by the peer, we don't really care
 1019          * about this but we bookkeep it anyway.
 1020          */
 1021         uint8_t peer_supports_pktdrop;
 1022 
 1023         /* Do we allow V6/V4? */
 1024         uint8_t ipv4_addr_legal;
 1025         uint8_t ipv6_addr_legal;
 1026         /* Address scoping flags */
 1027         /* scope value for IPv4 */
 1028         uint8_t ipv4_local_scope;
 1029         /* scope values for IPv6 */
 1030         uint8_t local_scope;
 1031         uint8_t site_scope;
 1032         /* loopback scope */
 1033         uint8_t loopback_scope;
 1034         /* flags to handle send alternate net tracking */
 1035         uint8_t used_alt_onsack;
 1036         uint8_t used_alt_asconfack;
 1037         uint8_t fast_retran_loss_recovery;
 1038         uint8_t sat_t3_loss_recovery;
 1039         uint8_t dropped_special_cnt;
 1040         uint8_t seen_a_sack_this_pkt;
 1041         uint8_t stream_reset_outstanding;
 1042         uint8_t stream_reset_out_is_outstanding;
 1043         uint8_t delayed_connection;
 1044         uint8_t ifp_had_enobuf;
 1045         uint8_t saw_sack_with_frags;
 1046         /* EY */
 1047         uint8_t saw_sack_with_nr_frags;
 1048         uint8_t in_asocid_hash;
 1049         uint8_t assoc_up_sent;
 1050         uint8_t adaptation_needed;
 1051         uint8_t adaptation_sent;
 1052         /* CMT variables */
 1053         uint8_t cmt_dac_pkts_rcvd;
 1054         uint8_t sctp_cmt_on_off;
 1055         uint8_t iam_blocking;
 1056         uint8_t cookie_how[8];
 1057         /* EY 05/05/08 - NR_SACK variable */
 1058         uint8_t sctp_nr_sack_on_off;
 1059         /* JRS 5/21/07 - CMT PF variable */
 1060         uint8_t sctp_cmt_pf;
 1061         /*
 1062          * The mapping array is used to track out of order sequences above
 1063          * last_acked_seq. 0 indicates packet missing 1 indicates packet
 1064          * rec'd. We slide it up every time we raise last_acked_seq and 0
 1065          * trailing locactions out.  If I get a TSN above the array
 1066          * mappingArraySz, I discard the datagram and let retransmit happen.
 1067          */
 1068         uint32_t marked_retrans;
 1069         uint32_t timoinit;
 1070         uint32_t timodata;
 1071         uint32_t timosack;
 1072         uint32_t timoshutdown;
 1073         uint32_t timoheartbeat;
 1074         uint32_t timocookie;
 1075         uint32_t timoshutdownack;
 1076         struct timeval start_time;
 1077         struct timeval discontinuity_time;
 1078 };
 1079 
 1080 #endif

Cache object: a843f41fa408ad4eef45a1094976797d


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.