2 * Copyright (c) 2001-2008, by Cisco Systems, Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * a) Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
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.
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.
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.
31 /* $KAME: sctp_structs.h,v 1.13 2005/03/06 16:04:18 itojun Exp $ */
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #ifndef __sctp_structs_h__
37 #define __sctp_structs_h__
39 #include <netinet/sctp_os.h>
40 #include <netinet/sctp_header.h>
41 #include <netinet/sctp_auth.h>
44 sctp_os_timer_t timer;
48 * Depending on the timer type these will be setup and cast with the
56 /* for sanity checking */
59 uint32_t stopped_from;
63 struct sctp_foo_stuff {
64 struct sctp_inpcb *inp;
72 * This is the information we track on each interface that we know about from
75 TAILQ_HEAD(sctpnetlisthead, sctp_nets);
77 struct sctp_stream_reset_list {
78 TAILQ_ENTRY(sctp_stream_reset_list) next_resp;
81 struct sctp_stream_reset_out_request req;
84 TAILQ_HEAD(sctp_resethead, sctp_stream_reset_list);
87 * Users of the iterator need to malloc a iterator with a call to
88 * sctp_initiate_iterator(inp_func, assoc_func, inp_func, pcb_flags, pcb_features,
89 * asoc_state, void-ptr-arg, uint32-arg, end_func, inp);
91 * Use the following two defines if you don't care what pcb flags are on the EP
92 * and/or you don't care what state the association is in.
94 * Note that if you specify an INP as the last argument then ONLY each
95 * association of that single INP will be executed upon. Note that the pcb
96 * flags STILL apply so if the inp you specify has different pcb_flags then
97 * what you put in pcb_flags nothing will happen. use SCTP_PCB_ANY_FLAGS to
98 * assure the inp you specify gets treated.
100 #define SCTP_PCB_ANY_FLAGS 0x00000000
101 #define SCTP_PCB_ANY_FEATURES 0x00000000
102 #define SCTP_ASOC_ANY_STATE 0x00000000
104 typedef void (*asoc_func) (struct sctp_inpcb *, struct sctp_tcb *, void *ptr,
106 typedef int (*inp_func) (struct sctp_inpcb *, void *ptr, uint32_t val);
107 typedef void (*end_func) (void *ptr, uint32_t val);
109 struct sctp_iterator {
110 TAILQ_ENTRY(sctp_iterator) sctp_nxt_itr;
112 struct sctp_timer tmr;
113 struct sctp_inpcb *inp; /* current endpoint */
114 struct sctp_tcb *stcb; /* current* assoc */
115 struct sctp_inpcb *next_inp; /* special hook to skip to */
116 asoc_func function_assoc; /* per assoc function */
117 inp_func function_inp; /* per endpoint function */
118 inp_func function_inp_end; /* end INP function */
119 end_func function_atend;/* iterator completion function */
120 void *pointer; /* pointer for apply func to use */
121 uint32_t val; /* value for apply func to use */
122 uint32_t pcb_flags; /* endpoint flags being checked */
123 uint32_t pcb_features; /* endpoint features being checked */
124 uint32_t asoc_state; /* assoc state being checked */
125 uint32_t iterator_flags;
126 uint8_t no_chunk_output;
127 uint8_t done_current_ep;
130 /* iterator_flags values */
131 #define SCTP_ITERATOR_DO_ALL_INP 0x00000001
132 #define SCTP_ITERATOR_DO_SINGLE_INP 0x00000002
135 TAILQ_HEAD(sctpiterators, sctp_iterator);
137 struct sctp_copy_all {
138 struct sctp_inpcb *inp; /* ep */
140 struct sctp_sndrcvinfo sndrcv;
146 struct sctp_asconf_iterator {
147 struct sctpladdr list_of_work;
151 struct iterator_control {
152 struct mtx ipi_iterator_wq_mtx;
154 SCTP_PROCESS_STRUCT thread_proc;
155 struct sctpiterators iteratorhead;
156 struct sctp_iterator *cur_it;
157 uint32_t iterator_running;
158 uint32_t iterator_flags;
161 #define SCTP_ITERATOR_MUST_EXIT 0x00000001
162 #define SCTP_ITERATOR_STOP_CUR_IT 0x00000002
163 #define SCTP_ITERATOR_STOP_CUR_INP 0x00000004
165 struct sctp_net_route {
166 sctp_rtentry_t *ro_rt;
168 union sctp_sockstore _l_addr; /* remote peer addr */
169 struct sctp_ifa *_s_addr; /* our selected src addr */
173 uint16_t alpha; /* Fixed point arith, << 7 */
174 uint8_t beta; /* Fixed point arith, << 7 */
175 uint8_t modeswitch; /* Delay modeswitch until we had at least one
176 * congestion event */
177 uint32_t last_cong; /* Time since last congestion event end */
178 uint32_t undo_last_cong;
179 uint16_t bytes_acked;
184 uint32_t undo_maxRTT;
185 uint32_t undo_old_maxB;
187 /* Bandwidth estimation */
197 TAILQ_ENTRY(sctp_nets) sctp_next; /* next link */
200 * Things on the top half may be able to be split into a common
201 * structure shared by all.
203 struct sctp_timer pmtu_timer;
206 * The following two in combination equate to a route entry for v6
209 struct sctp_net_route ro;
211 /* mtu discovered so far */
213 uint32_t ssthresh; /* not sure about this one for split */
215 /* smoothed average things for RTT and RTO itself */
218 int rtt; /* last measured rtt value in ms */
221 /* This is used for SHUTDOWN/SHUTDOWN-ACK/SEND or INIT timers */
222 struct sctp_timer rxt_timer;
223 struct sctp_timer fr_timer; /* for early fr */
225 /* last time in seconds I sent to it */
226 struct timeval last_sent_time;
229 /* Congestion stats per destination */
231 * flight size variables and such, sorry Vern, I could not avoid
232 * this if I wanted performance :>
234 uint32_t flight_size;
235 uint32_t cwnd; /* actual cwnd */
236 uint32_t prev_cwnd; /* cwnd before any processing */
237 uint32_t partial_bytes_acked; /* in CA tracks when to incr a MTU */
239 /* tracking variables to avoid the aloc/free in sack processing */
240 unsigned int net_ack;
241 unsigned int net_ack2;
244 * JRS - 5/8/07 - Variable to track last time a destination was
247 uint32_t last_active;
250 * CMT variables (iyengar@cis.udel.edu)
252 uint32_t this_sack_highest_newack; /* tracks highest TSN newly
253 * acked for a given dest in
254 * the current SACK. Used in
255 * SFR and HTNA algos */
256 uint32_t pseudo_cumack; /* CMT CUC algorithm. Maintains next expected
257 * pseudo-cumack for this destination */
258 uint32_t rtx_pseudo_cumack; /* CMT CUC algorithm. Maintains next
259 * expected pseudo-cumack for this
262 /* CMT fast recovery variables */
263 uint32_t fast_recovery_tsn;
264 uint32_t heartbeat_random1;
265 uint32_t heartbeat_random2;
266 uint32_t tos_flowlabel;
268 struct timeval start_time; /* time when this net was created */
270 uint32_t marked_retrans;/* number or DATA chunks marked for timer
271 * based retransmissions */
272 uint32_t marked_fastretrans;
274 /* if this guy is ok or not ... status */
276 /* number of transmit failures to down this guy */
277 uint16_t failure_threshold;
278 /* error stats on destination */
279 uint16_t error_count;
280 /* UDP port number in case of UDP tunneling */
283 uint8_t fast_retran_loss_recovery;
284 uint8_t will_exit_fast_recovery;
285 /* Flags that probably can be combined into dest_state */
286 uint8_t fast_retran_ip; /* fast retransmit in progress */
287 uint8_t hb_responded;
288 uint8_t saw_newack; /* CMT's SFR algorithm flag */
289 uint8_t src_addr_selected; /* if we split we move */
290 uint8_t indx_of_eligible_next_to_use;
291 uint8_t addr_is_local; /* its a local address (if known) could move
295 * CMT variables (iyengar@cis.udel.edu)
297 uint8_t find_pseudo_cumack; /* CMT CUC algorithm. Flag used to
298 * find a new pseudocumack. This flag
299 * is set after a new pseudo-cumack
300 * has been received and indicates
301 * that the sender should find the
302 * next pseudo-cumack expected for
303 * this destination */
304 uint8_t find_rtx_pseudo_cumack; /* CMT CUCv2 algorithm. Flag used to
305 * find a new rtx-pseudocumack. This
306 * flag is set after a new
307 * rtx-pseudo-cumack has been received
308 * and indicates that the sender
309 * should find the next
310 * rtx-pseudo-cumack expected for this
312 uint8_t new_pseudo_cumack; /* CMT CUC algorithm. Flag used to
313 * indicate if a new pseudo-cumack or
314 * rtx-pseudo-cumack has been received */
315 uint8_t window_probe; /* Doing a window probe? */
316 uint8_t RTO_measured; /* Have we done the first measure */
317 uint8_t last_hs_used; /* index into the last HS table entry we used */
318 /* JRS - struct used in HTCP algorithm */
323 struct sctp_data_chunkrec {
324 uint32_t TSN_seq; /* the TSN of this transmit */
325 uint16_t stream_seq; /* the stream sequence number of this transmit */
326 uint16_t stream_number; /* the stream number of this guy */
327 uint32_t payloadtype;
328 uint32_t context; /* from send */
330 /* ECN Nonce: Nonce Value for this chunk */
334 * part of the Highest sacked algorithm to be able to stroke counts
335 * on ones that are FR'd.
337 uint32_t fast_retran_tsn; /* sending_seq at the time of FR */
338 struct timeval timetodrop; /* time we drop it from queue */
339 uint8_t doing_fast_retransmit;
340 uint8_t rcv_flags; /* flags pulled from data chunk on inbound for
341 * outbound holds sending flags for PR-SCTP. */
343 uint8_t chunk_was_revoked;
346 TAILQ_HEAD(sctpchunk_listhead, sctp_tmit_chunk);
348 /* The lower byte is used to enumerate PR_SCTP policies */
349 #define CHUNK_FLAGS_PR_SCTP_TTL SCTP_PR_SCTP_TTL
350 #define CHUNK_FLAGS_PR_SCTP_BUF SCTP_PR_SCTP_BUF
351 #define CHUNK_FLAGS_PR_SCTP_RTX SCTP_PR_SCTP_RTX
353 /* The upper byte is used as a bit mask */
354 #define CHUNK_FLAGS_FRAGMENT_OK 0x0100
358 uint16_t can_take_data;
362 struct sctp_tmit_chunk {
364 struct sctp_data_chunkrec data;
365 struct chk_id chunk_id;
367 struct sctp_association *asoc; /* bp to asoc this belongs to */
368 struct timeval sent_rcv_time; /* filled in if RTT being calculated */
369 struct mbuf *data; /* pointer to mbuf chain of data */
370 struct mbuf *last_mbuf; /* pointer to last mbuf in chain */
371 struct sctp_nets *whoTo;
372 TAILQ_ENTRY(sctp_tmit_chunk) sctp_next; /* next link */
373 int32_t sent; /* the send status */
374 uint16_t snd_count; /* number of times I sent */
375 uint16_t flags; /* flags, such as FRAGMENT_OK */
380 uint8_t holds_key_ref; /* flag if auth keyid refcount is held */
383 uint8_t book_size_scale;
384 uint8_t no_fr_allowed;
387 uint8_t window_probe;
391 * The first part of this structure MUST be the entire sinfo structure. Maybe
392 * I should have made it a sub structure... we can circle back later and do
395 struct sctp_queued_to_read { /* sinfo structure Pluse more */
396 uint16_t sinfo_stream; /* off the wire */
397 uint16_t sinfo_ssn; /* off the wire */
398 uint16_t sinfo_flags; /* SCTP_UNORDERED from wire use SCTP_EOF for
400 uint32_t sinfo_ppid; /* off the wire */
401 uint32_t sinfo_context; /* pick this up from assoc def context? */
402 uint32_t sinfo_timetolive; /* not used by kernel */
403 uint32_t sinfo_tsn; /* Use this in reassembly as first TSN */
404 uint32_t sinfo_cumtsn; /* Use this in reassembly as last TSN */
405 sctp_assoc_t sinfo_assoc_id; /* our assoc id */
406 /* Non sinfo stuff */
407 uint32_t length; /* length of data */
408 uint32_t held_length; /* length held in sb */
409 struct sctp_nets *whoFrom; /* where it came from */
410 struct mbuf *data; /* front of the mbuf chain of data with
412 struct mbuf *tail_mbuf; /* used for multi-part data */
413 struct mbuf *aux_data; /* used to hold/cache control if o/s does not
415 struct sctp_tcb *stcb; /* assoc, used for window update */
416 TAILQ_ENTRY(sctp_queued_to_read) next;
418 uint16_t spec_flags; /* Flags to hold the notification field */
419 uint8_t do_not_ref_stcb;
421 uint8_t pdapi_aborted;
425 /* This data structure will be on the outbound
426 * stream queues. Data will be pulled off from
427 * the front of the mbuf data and chunk-ified
428 * by the output routines. We will custom
429 * fit every chunk we pull to the send/sent
430 * queue to make up the next full packet
431 * if we can. An entry cannot be removed
432 * from the stream_out queue until
433 * the msg_is_complete flag is set. This
434 * means at times data/tail_mbuf MIGHT
435 * be NULL.. If that occurs it happens
436 * for one of two reasons. Either the user
437 * is blocked on a send() call and has not
438 * awoken to copy more data down... OR
439 * the user is in the explict MSG_EOR mode
440 * and wrote some data, but has not completed
443 struct sctp_stream_queue_pending {
445 struct mbuf *tail_mbuf;
447 struct sctp_nets *net;
448 TAILQ_ENTRY(sctp_stream_queue_pending) next;
453 uint16_t sinfo_flags;
458 uint8_t holds_key_ref;
459 uint8_t msg_is_complete;
462 uint8_t sender_all_done;
463 uint8_t put_last_out;
464 uint8_t discard_rest;
468 * this struct contains info that is used to track inbound stream data and
469 * help with ordering.
471 TAILQ_HEAD(sctpwheelunrel_listhead, sctp_stream_in);
472 struct sctp_stream_in {
473 struct sctp_readhead inqueue;
475 uint16_t last_sequence_delivered; /* used for re-order */
476 uint8_t delivery_started;
479 TAILQ_HEAD(sctpwheel_listhead, sctp_stream_out);
480 TAILQ_HEAD(sctplist_listhead, sctp_stream_queue_pending);
482 /* Round-robin schedulers */
484 /* next link in wheel */
485 TAILQ_ENTRY(sctp_stream_out) next_spoke;
488 /* Priority scheduler */
490 /* next link in wheel */
491 TAILQ_ENTRY(sctp_stream_out) next_spoke;
496 /* Fair Bandwidth scheduler */
498 /* next link in wheel */
499 TAILQ_ENTRY(sctp_stream_out) next_spoke;
500 /* stores message size */
505 * This union holds all data necessary for
506 * different stream schedulers.
508 union scheduling_data {
509 struct sctpwheel_listhead out_wheel;
510 struct sctplist_listhead out_list;
514 * This union holds all parameters per stream
515 * necessary for different stream schedulers.
517 union scheduling_parameters {
523 /* This struct is used to track the traffic on outbound streams */
524 struct sctp_stream_out {
525 struct sctp_streamhead outqueue;
526 union scheduling_parameters ss_params;
528 uint16_t next_sequence_sent; /* next one I expect to send out */
529 uint8_t last_msg_incomplete;
532 /* used to keep track of the addresses yet to try to add/delete */
533 TAILQ_HEAD(sctp_asconf_addrhead, sctp_asconf_addr);
534 struct sctp_asconf_addr {
535 TAILQ_ENTRY(sctp_asconf_addr) next;
536 struct sctp_asconf_addr_param ap;
537 struct sctp_ifa *ifa; /* save the ifa for add/del ip */
538 uint8_t sent; /* has this been sent yet? */
539 uint8_t special_del; /* not to be used in lookup */
542 struct sctp_scoping {
543 uint8_t ipv4_addr_legal;
544 uint8_t ipv6_addr_legal;
545 uint8_t loopback_scope;
546 uint8_t ipv4_local_scope;
551 #define SCTP_TSN_LOG_SIZE 40
553 struct sctp_tsn_log {
564 #define SCTP_FS_SPEC_LOG_SIZE 200
565 struct sctp_fs_spec_log {
567 uint32_t total_flight;
574 /* This struct is here to cut out the compatiabilty
575 * pad that bulks up both the inp and stcb. The non
576 * pad portion MUST stay in complete sync with
577 * sctp_sndrcvinfo... i.e. if sinfo_xxxx is added
578 * this must be done here too.
580 struct sctp_nonpad_sndrcvinfo {
581 uint16_t sinfo_stream;
583 uint16_t sinfo_flags;
585 uint32_t sinfo_context;
586 uint32_t sinfo_timetolive;
588 uint32_t sinfo_cumtsn;
589 sctp_assoc_t sinfo_assoc_id;
593 * JRS - Structure to hold function pointers to the functions responsible
594 * for congestion control.
597 struct sctp_cc_functions {
598 void (*sctp_set_initial_cc_param) (struct sctp_tcb *stcb, struct sctp_nets *net);
599 void (*sctp_cwnd_update_after_sack) (struct sctp_tcb *stcb,
600 struct sctp_association *asoc,
601 int accum_moved, int reneged_all, int will_exit);
602 void (*sctp_cwnd_update_after_fr) (struct sctp_tcb *stcb,
603 struct sctp_association *asoc);
604 void (*sctp_cwnd_update_after_timeout) (struct sctp_tcb *stcb,
605 struct sctp_nets *net);
606 void (*sctp_cwnd_update_after_ecn_echo) (struct sctp_tcb *stcb,
607 struct sctp_nets *net);
608 void (*sctp_cwnd_update_after_packet_dropped) (struct sctp_tcb *stcb,
609 struct sctp_nets *net, struct sctp_pktdrop_chunk *cp,
610 uint32_t * bottle_bw, uint32_t * on_queue);
611 void (*sctp_cwnd_update_after_output) (struct sctp_tcb *stcb,
612 struct sctp_nets *net, int burst_limit);
613 void (*sctp_cwnd_update_after_fr_timer) (struct sctp_inpcb *inp,
614 struct sctp_tcb *stcb, struct sctp_nets *net);
618 * RS - Structure to hold function pointers to the functions responsible
619 * for stream scheduling.
621 struct sctp_ss_functions {
622 void (*sctp_ss_init) (struct sctp_tcb *stcb, struct sctp_association *asoc,
624 void (*sctp_ss_clear) (struct sctp_tcb *stcb, struct sctp_association *asoc,
625 int clear_values, int holds_lock);
626 void (*sctp_ss_init_stream) (struct sctp_stream_out *strq);
627 void (*sctp_ss_add_to_stream) (struct sctp_tcb *stcb, struct sctp_association *asoc,
628 struct sctp_stream_out *strq, struct sctp_stream_queue_pending *sp, int holds_lock);
629 int (*sctp_ss_is_empty) (struct sctp_tcb *stcb, struct sctp_association *asoc);
630 void (*sctp_ss_remove_from_stream) (struct sctp_tcb *stcb, struct sctp_association *asoc,
631 struct sctp_stream_out *strq, struct sctp_stream_queue_pending *sp, int holds_lock);
632 struct sctp_stream_out *(*sctp_ss_select_stream) (struct sctp_tcb *stcb,
633 struct sctp_nets *net, struct sctp_association *asoc);
634 void (*sctp_ss_scheduled) (struct sctp_tcb *stcb, struct sctp_nets *net,
635 struct sctp_association *asoc, struct sctp_stream_out *strq, int moved_how_much);
636 void (*sctp_ss_packet_done) (struct sctp_tcb *stcb, struct sctp_nets *net,
637 struct sctp_association *asoc);
638 int (*sctp_ss_get_value) (struct sctp_tcb *stcb, struct sctp_association *asoc,
639 struct sctp_stream_out *strq, uint16_t * value);
640 int (*sctp_ss_set_value) (struct sctp_tcb *stcb, struct sctp_association *asoc,
641 struct sctp_stream_out *strq, uint16_t value);
644 /* used to save ASCONF chunks for retransmission */
645 TAILQ_HEAD(sctp_asconf_head, sctp_asconf);
647 TAILQ_ENTRY(sctp_asconf) next;
648 uint32_t serial_number;
654 /* used to save ASCONF-ACK chunks for retransmission */
655 TAILQ_HEAD(sctp_asconf_ackhead, sctp_asconf_ack);
656 struct sctp_asconf_ack {
657 TAILQ_ENTRY(sctp_asconf_ack) next;
658 uint32_t serial_number;
659 struct sctp_nets *last_sent_to;
665 * Here we have information about each individual association that we track.
666 * We probably in production would be more dynamic. But for ease of
667 * implementation we will have a fixed array that we hunt for in a linear
670 struct sctp_association {
671 /* association state */
674 /* queue of pending addrs to add/delete */
675 struct sctp_asconf_addrhead asconf_queue;
677 struct timeval time_entered; /* time we entered state */
678 struct timeval time_last_rcvd;
679 struct timeval time_last_sent;
680 struct timeval time_last_sat_advance;
681 struct sctp_nonpad_sndrcvinfo def_send;
683 /* timers and such */
684 struct sctp_timer hb_timer; /* hb timer */
685 struct sctp_timer dack_timer; /* Delayed ack timer */
686 struct sctp_timer asconf_timer; /* asconf */
687 struct sctp_timer strreset_timer; /* stream reset */
688 struct sctp_timer shut_guard_timer; /* shutdown guard */
689 struct sctp_timer autoclose_timer; /* automatic close timer */
690 struct sctp_timer delayed_event_timer; /* timer for delayed events */
691 struct sctp_timer delete_prim_timer; /* deleting primary dst */
693 /* list of restricted local addresses */
694 struct sctpladdr sctp_restricted_addrs;
696 /* last local address pending deletion (waiting for an address add) */
697 struct sctp_ifa *asconf_addr_del_pending;
698 /* Deleted primary destination (used to stop timer) */
699 struct sctp_nets *deleted_primary;
701 struct sctpnetlisthead nets; /* remote address list */
703 /* Free chunk list */
704 struct sctpchunk_listhead free_chunks;
706 /* Control chunk queue */
707 struct sctpchunk_listhead control_send_queue;
709 /* ASCONF chunk queue */
710 struct sctpchunk_listhead asconf_send_queue;
713 * Once a TSN hits the wire it is moved to the sent_queue. We
714 * maintain two counts here (don't know if any but retran_cnt is
715 * needed). The idea is that the sent_queue_retran_cnt reflects how
716 * many chunks have been marked for retranmission by either T3-rxt
719 struct sctpchunk_listhead sent_queue;
720 struct sctpchunk_listhead send_queue;
722 /* re-assembly queue for fragmented chunks on the inbound path */
723 struct sctpchunk_listhead reasmqueue;
726 * this queue is used when we reach a condition that we can NOT put
727 * data into the socket buffer. We track the size of this queue and
728 * set our rwnd to the space in the socket minus also the
729 * size_on_delivery_queue.
731 union scheduling_data ss_data;
734 * This pointer will be set to NULL most of the time. But when we
735 * have a fragmented message, where we could not get out all of the
736 * message at the last send then this will point to the stream to go
739 struct sctp_stream_out *locked_on_sending;
741 /* If an iterator is looking at me, this is it */
742 struct sctp_iterator *stcb_starting_point_for_iterator;
744 /* ASCONF save the last ASCONF-ACK so we can resend it if necessary */
745 struct sctp_asconf_ackhead asconf_ack_sent;
748 * pointer to last stream reset queued to control queue by us with
751 struct sctp_tmit_chunk *str_reset;
753 * if Source Address Selection happening, this will rotate through
756 struct sctp_laddr *last_used_address;
759 struct sctp_stream_in *strmin;
760 struct sctp_stream_out *strmout;
761 uint8_t *mapping_array;
762 /* primary destination to use */
763 struct sctp_nets *primary_destination;
765 struct sctp_nets *last_net_cmt_send_started;
766 /* last place I got a data chunk from */
767 struct sctp_nets *last_data_chunk_from;
768 /* last place I got a control from */
769 struct sctp_nets *last_control_chunk_from;
771 /* circular looking for output selection */
772 struct sctp_stream_out *last_out_stream;
775 * wait to the point the cum-ack passes req->send_reset_at_tsn for
776 * any req on the list.
778 struct sctp_resethead resetHead;
780 /* queue of chunks waiting to be sent into the local stack */
781 struct sctp_readhead pending_reply_queue;
783 /* JRS - the congestion control functions are in this struct */
784 struct sctp_cc_functions cc_functions;
786 * JRS - value to store the currently loaded congestion control
789 uint32_t congestion_control_module;
790 /* RS - the stream scheduling functions are in this struct */
791 struct sctp_ss_functions ss_functions;
792 /* RS - value to store the currently loaded stream scheduling module */
793 uint32_t stream_scheduling_module;
797 uint32_t cookie_preserve_req;
798 /* ASCONF next seq I am sending out, inits at init-tsn */
799 uint32_t asconf_seq_out;
800 uint32_t asconf_seq_out_acked;
801 /* ASCONF last received ASCONF from peer, starts at peer's TSN-1 */
802 uint32_t asconf_seq_in;
804 /* next seq I am sending in str reset messages */
805 uint32_t str_reset_seq_out;
806 /* next seq I am expecting in str reset messages */
807 uint32_t str_reset_seq_in;
809 /* various verification tag information */
810 uint32_t my_vtag; /* The tag to be used. if assoc is re-initited
811 * by remote end, and I have unlocked this
812 * will be regenerated to a new random value. */
813 uint32_t peer_vtag; /* The peers last tag */
815 uint32_t my_vtag_nonce;
816 uint32_t peer_vtag_nonce;
820 /* This is the SCTP fragmentation threshold */
821 uint32_t smallest_mtu;
824 * Special hook for Fast retransmit, allows us to track the highest
825 * TSN that is NEW in this SACK if gap ack blocks are present.
827 uint32_t this_sack_highest_gap;
830 * The highest consecutive TSN that has been acked by peer on my
833 uint32_t last_acked_seq;
835 /* The next TSN that I will use in sending. */
836 uint32_t sending_seq;
838 /* Original seq number I used ??questionable to keep?? */
839 uint32_t init_seq_number;
842 /* The Advanced Peer Ack Point, as required by the PR-SCTP */
843 /* (A1 in Section 4.2) */
844 uint32_t advanced_peer_ack_point;
847 * The highest consequetive TSN at the bottom of the mapping array
850 uint32_t cumulative_tsn;
852 * Used to track the mapping array and its offset bits. This MAY be
853 * lower then cumulative_tsn.
855 uint32_t mapping_array_base_tsn;
857 * used to track highest TSN we have received and is listed in the
860 uint32_t highest_tsn_inside_map;
862 /* EY - new NR variables used for nr_sack based on mapping_array */
863 uint8_t *nr_mapping_array;
864 uint32_t highest_tsn_inside_nr_map;
866 uint32_t last_echo_tsn;
867 uint32_t last_cwr_tsn;
868 uint32_t fast_recovery_tsn;
869 uint32_t sat_t3_recovery_tsn;
870 uint32_t tsn_last_delivered;
872 * For the pd-api we should re-write this a bit more efficent. We
873 * could have multiple sctp_queued_to_read's that we are building at
874 * once. Now we only do this when we get ready to deliver to the
875 * socket buffer. Note that we depend on the fact that the struct is
876 * "stuck" on the read queue until we finish all the pd-api.
878 struct sctp_queued_to_read *control_pdapi;
880 uint32_t tsn_of_pdapi_last_delivered;
883 uint32_t last_reset_action[SCTP_MAX_RESET_PARAMS];
884 uint32_t last_sending_seq[SCTP_MAX_RESET_PARAMS];
885 uint32_t last_base_tsnsent[SCTP_MAX_RESET_PARAMS];
886 #ifdef SCTP_ASOCLOG_OF_TSNS
888 * special log - This adds considerable size to the asoc, but
889 * provides a log that you can use to detect problems via kgdb.
891 struct sctp_tsn_log in_tsnlog[SCTP_TSN_LOG_SIZE];
892 struct sctp_tsn_log out_tsnlog[SCTP_TSN_LOG_SIZE];
893 uint32_t cumack_log[SCTP_TSN_LOG_SIZE];
894 uint32_t cumack_logsnt[SCTP_TSN_LOG_SIZE];
897 uint16_t tsn_in_wrapped;
898 uint16_t tsn_out_wrapped;
899 uint16_t cumack_log_at;
900 uint16_t cumack_log_atsnt;
901 #endif /* SCTP_ASOCLOG_OF_TSNS */
902 #ifdef SCTP_FS_SPEC_LOG
903 struct sctp_fs_spec_log fslog[SCTP_FS_SPEC_LOG_SIZE];
908 * window state information and smallest MTU that I use to bound
913 uint32_t my_last_reported_rwnd;
914 uint32_t sctp_frag_point;
916 uint32_t total_output_queue_size;
918 uint32_t sb_cc; /* shadow of sb_cc */
919 uint32_t sb_send_resv; /* amount reserved on a send */
920 uint32_t my_rwnd_control_len; /* shadow of sb_mbcnt used for rwnd
922 /* 32 bit nonce stuff */
923 uint32_t nonce_resync_tsn;
924 uint32_t nonce_wait_tsn;
925 uint32_t default_flowlabel;
926 uint32_t pr_sctp_cnt;
927 int ctrl_queue_cnt; /* could be removed REM */
929 * All outbound datagrams queue into this list from the individual
930 * stream queue. Here they get assigned a TSN and then await
931 * sending. The stream seq comes when it is first put in the
932 * individual str queue
934 unsigned int stream_queue_cnt;
935 unsigned int send_queue_cnt;
936 unsigned int sent_queue_cnt;
937 unsigned int sent_queue_cnt_removeable;
939 * Number on sent queue that are marked for retran until this value
940 * is 0 we only send one packet of retran'ed data.
942 unsigned int sent_queue_retran_cnt;
944 unsigned int size_on_reasm_queue;
945 unsigned int cnt_on_reasm_queue;
946 unsigned int fwd_tsn_cnt;
947 /* amount of data (bytes) currently in flight (on all destinations) */
948 unsigned int total_flight;
949 /* Total book size in flight */
950 unsigned int total_flight_count; /* count of chunks used with
952 /* count of destinaton nets and list of destination nets */
953 unsigned int numnets;
955 /* Total error count on this association */
956 unsigned int overall_error_count;
958 unsigned int cnt_msg_on_sb;
960 /* All stream count of chunks for delivery */
961 unsigned int size_on_all_streams;
962 unsigned int cnt_on_all_streams;
964 /* Heart Beat delay in ticks */
965 unsigned int heart_beat_delay;
968 unsigned int sctp_autoclose_ticks;
970 /* how many preopen streams we have */
971 unsigned int pre_open_streams;
973 /* How many streams I support coming into me */
974 unsigned int max_inbound_streams;
976 /* the cookie life I award for any cookie, in seconds */
977 unsigned int cookie_life;
978 /* time to delay acks for */
979 unsigned int delayed_ack;
980 unsigned int old_delayed_ack;
981 unsigned int sack_freq;
982 unsigned int data_pkts_seen;
984 unsigned int numduptsns;
985 int dup_tsns[SCTP_MAX_DUP_TSNS];
986 unsigned int initial_init_rto_max; /* initial RTO for INIT's */
987 unsigned int initial_rto; /* initial send RTO */
988 unsigned int minrto; /* per assoc RTO-MIN */
989 unsigned int maxrto; /* per assoc RTO-MAX */
991 /* authentication fields */
992 sctp_auth_chklist_t *local_auth_chunks;
993 sctp_auth_chklist_t *peer_auth_chunks;
994 sctp_hmaclist_t *local_hmacs; /* local HMACs supported */
995 sctp_hmaclist_t *peer_hmacs; /* peer HMACs supported */
996 struct sctp_keyhead shared_keys; /* assoc's shared keys */
997 sctp_authinfo_t authinfo; /* randoms, cached keys */
999 * refcnt to block freeing when a sender or receiver is off coping
1003 uint32_t chunks_on_out_queue; /* total chunks floating around,
1004 * locked by send socket buffer */
1005 uint32_t peers_adaptation;
1006 uint16_t peer_hmac_id; /* peer HMAC id to send */
1009 * Being that we have no bag to collect stale cookies, and that we
1010 * really would not want to anyway.. we will count them in this
1011 * counter. We of course feed them to the pigeons right away (I have
1012 * always thought of pigeons as flying rats).
1014 uint16_t stale_cookie_count;
1017 * For the partial delivery API, if up, invoked this is what last
1020 uint16_t str_of_pdapi;
1021 uint16_t ssn_of_pdapi;
1023 /* counts of actual built streams. Allocation may be more however */
1024 /* could re-arrange to optimize space here. */
1025 uint16_t streamincnt;
1026 uint16_t streamoutcnt;
1027 uint16_t strm_realoutsize;
1028 /* my maximum number of retrans of INIT and SEND */
1029 /* copied from SCTP but should be individually setable */
1030 uint16_t max_init_times;
1031 uint16_t max_send_times;
1033 uint16_t def_net_failure;
1036 * lock flag: 0 is ok to send, 1+ (duals as a retran count) is
1039 uint16_t mapping_array_size;
1041 uint16_t last_strm_seq_delivered;
1042 uint16_t last_strm_no_delivered;
1044 uint16_t last_revoke_count;
1045 int16_t num_send_timers_up;
1047 uint16_t stream_locked_on;
1048 uint16_t ecn_echo_cnt_onq;
1050 uint16_t free_chunk_cnt;
1052 uint8_t stream_locked;
1053 uint8_t authenticated; /* packet authenticated ok */
1055 * This flag indicates that a SACK need to be sent. Initially this
1056 * is 1 to send the first sACK immediately.
1060 /* max burst after fast retransmit completes */
1063 uint8_t sat_network; /* RTT is in range of sat net or greater */
1064 uint8_t sat_network_lockout; /* lockout code */
1065 uint8_t burst_limit_applied; /* Burst limit in effect at last send? */
1066 /* flag goes on when we are doing a partial delivery api */
1067 uint8_t hb_random_values[4];
1068 uint8_t fragmented_delivery_inprogress;
1069 uint8_t fragment_flags;
1070 uint8_t last_flags_delivered;
1071 uint8_t hb_ect_randombit;
1072 uint8_t hb_random_idx;
1073 uint8_t hb_is_disabled; /* is the hb disabled? */
1074 uint8_t default_tos;
1075 uint8_t asconf_del_pending; /* asconf delete last addr pending */
1077 /* ECN Nonce stuff */
1078 uint8_t receiver_nonce_sum; /* nonce I sum and put in my sack */
1079 uint8_t ecn_nonce_allowed; /* Tells us if ECN nonce is on */
1080 uint8_t nonce_sum_check;/* On off switch used during re-sync */
1081 uint8_t nonce_wait_for_ecne; /* flag when we expect a ECN */
1082 uint8_t peer_supports_ecn_nonce;
1085 * This value, plus all other ack'd but above cum-ack is added
1086 * together to cross check against the bit that we have yet to
1087 * define (probably in the SACK). When the cum-ack is updated, this
1088 * sum is updated as well.
1090 uint8_t nonce_sum_expect_base;
1091 /* Flag to tell if ECN is allowed */
1092 uint8_t ecn_allowed;
1094 /* flag to indicate if peer can do asconf */
1095 uint8_t peer_supports_asconf;
1096 /* EY - flag to indicate if peer can do nr_sack */
1097 uint8_t peer_supports_nr_sack;
1098 /* pr-sctp support flag */
1099 uint8_t peer_supports_prsctp;
1100 /* peer authentication support flag */
1101 uint8_t peer_supports_auth;
1102 /* stream resets are supported by the peer */
1103 uint8_t peer_supports_strreset;
1105 uint8_t peer_supports_nat;
1107 * packet drop's are supported by the peer, we don't really care
1108 * about this but we bookkeep it anyway.
1110 uint8_t peer_supports_pktdrop;
1112 /* Do we allow V6/V4? */
1113 uint8_t ipv4_addr_legal;
1114 uint8_t ipv6_addr_legal;
1115 /* Address scoping flags */
1116 /* scope value for IPv4 */
1117 uint8_t ipv4_local_scope;
1118 /* scope values for IPv6 */
1119 uint8_t local_scope;
1121 /* loopback scope */
1122 uint8_t loopback_scope;
1123 /* flags to handle send alternate net tracking */
1124 uint8_t used_alt_onsack;
1125 uint8_t used_alt_asconfack;
1126 uint8_t fast_retran_loss_recovery;
1127 uint8_t sat_t3_loss_recovery;
1128 uint8_t dropped_special_cnt;
1129 uint8_t seen_a_sack_this_pkt;
1130 uint8_t stream_reset_outstanding;
1131 uint8_t stream_reset_out_is_outstanding;
1132 uint8_t delayed_connection;
1133 uint8_t ifp_had_enobuf;
1134 uint8_t saw_sack_with_frags;
1135 uint8_t saw_sack_with_nr_frags;
1136 uint8_t in_asocid_hash;
1137 uint8_t assoc_up_sent;
1138 uint8_t adaptation_needed;
1139 uint8_t adaptation_sent;
1141 uint8_t cmt_dac_pkts_rcvd;
1142 uint8_t sctp_cmt_on_off;
1143 uint8_t iam_blocking;
1144 uint8_t cookie_how[8];
1145 /* EY 05/05/08 - NR_SACK variable */
1146 uint8_t sctp_nr_sack_on_off;
1147 /* JRS 5/21/07 - CMT PF variable */
1148 uint8_t sctp_cmt_pf;
1150 * The mapping array is used to track out of order sequences above
1151 * last_acked_seq. 0 indicates packet missing 1 indicates packet
1152 * rec'd. We slide it up every time we raise last_acked_seq and 0
1153 * trailing locactions out. If I get a TSN above the array
1154 * mappingArraySz, I discard the datagram and let retransmit happen.
1156 uint32_t marked_retrans;
1160 uint32_t timoshutdown;
1161 uint32_t timoheartbeat;
1162 uint32_t timocookie;
1163 uint32_t timoshutdownack;
1164 struct timeval start_time;
1165 struct timeval discontinuity_time;