2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2001-2008, by Cisco Systems, Inc. All rights reserved.
5 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
6 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * a) Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
14 * b) Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the distribution.
18 * c) Neither the name of Cisco Systems, Inc. nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
24 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32 * THE POSSIBILITY OF SUCH DAMAGE.
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
38 #ifndef _NETINET_SCTP_STRUCTS_H_
39 #define _NETINET_SCTP_STRUCTS_H_
41 #include <netinet/sctp_os.h>
42 #include <netinet/sctp_header.h>
43 #include <netinet/sctp_auth.h>
46 sctp_os_timer_t timer;
50 * Depending on the timer type these will be setup and cast with the
58 /* for sanity checking */
61 uint32_t stopped_from;
65 struct sctp_foo_stuff {
66 struct sctp_inpcb *inp;
74 * This is the information we track on each interface that we know about from
77 TAILQ_HEAD(sctpnetlisthead, sctp_nets);
79 struct sctp_stream_reset_list {
80 TAILQ_ENTRY(sctp_stream_reset_list) next_resp;
83 uint32_t number_entries;
84 uint16_t list_of_streams[];
87 TAILQ_HEAD(sctp_resethead, sctp_stream_reset_list);
90 * Users of the iterator need to malloc a iterator with a call to
91 * sctp_initiate_iterator(inp_func, assoc_func, inp_func, pcb_flags, pcb_features,
92 * asoc_state, void-ptr-arg, uint32-arg, end_func, inp);
94 * Use the following two defines if you don't care what pcb flags are on the EP
95 * and/or you don't care what state the association is in.
97 * Note that if you specify an INP as the last argument then ONLY each
98 * association of that single INP will be executed upon. Note that the pcb
99 * flags STILL apply so if the inp you specify has different pcb_flags then
100 * what you put in pcb_flags nothing will happen. use SCTP_PCB_ANY_FLAGS to
101 * assure the inp you specify gets treated.
103 #define SCTP_PCB_ANY_FLAGS 0x00000000
104 #define SCTP_PCB_ANY_FEATURES 0x00000000
105 #define SCTP_ASOC_ANY_STATE 0x00000000
107 typedef void (*asoc_func) (struct sctp_inpcb *, struct sctp_tcb *, void *ptr,
109 typedef int (*inp_func) (struct sctp_inpcb *, void *ptr, uint32_t val);
110 typedef void (*end_func) (void *ptr, uint32_t val);
112 #if defined(SCTP_MCORE_INPUT) && defined(SMP)
113 /* whats on the mcore control struct */
114 struct sctp_mcore_queue {
115 TAILQ_ENTRY(sctp_mcore_queue) next;
122 TAILQ_HEAD(sctp_mcore_qhead, sctp_mcore_queue);
124 struct sctp_mcore_ctrl {
125 SCTP_PROCESS_STRUCT thread_proc;
126 struct sctp_mcore_qhead que;
134 struct sctp_iterator {
135 TAILQ_ENTRY(sctp_iterator) sctp_nxt_itr;
137 struct sctp_timer tmr;
138 struct sctp_inpcb *inp; /* current endpoint */
139 struct sctp_tcb *stcb; /* current* assoc */
140 struct sctp_inpcb *next_inp; /* special hook to skip to */
141 asoc_func function_assoc; /* per assoc function */
142 inp_func function_inp; /* per endpoint function */
143 inp_func function_inp_end; /* end INP function */
144 end_func function_atend; /* iterator completion function */
145 void *pointer; /* pointer for apply func to use */
146 uint32_t val; /* value for apply func to use */
147 uint32_t pcb_flags; /* endpoint flags being checked */
148 uint32_t pcb_features; /* endpoint features being checked */
149 uint32_t asoc_state; /* assoc state being checked */
150 uint32_t iterator_flags;
151 uint8_t no_chunk_output;
152 uint8_t done_current_ep;
155 /* iterator_flags values */
156 #define SCTP_ITERATOR_DO_ALL_INP 0x00000001
157 #define SCTP_ITERATOR_DO_SINGLE_INP 0x00000002
160 TAILQ_HEAD(sctpiterators, sctp_iterator);
162 struct sctp_copy_all {
163 struct sctp_inpcb *inp; /* ep */
165 struct sctp_sndrcvinfo sndrcv;
171 struct sctp_asconf_iterator {
172 struct sctpladdr list_of_work;
176 struct iterator_control {
177 struct mtx ipi_iterator_wq_mtx;
179 SCTP_PROCESS_STRUCT thread_proc;
180 struct sctpiterators iteratorhead;
181 struct sctp_iterator *cur_it;
182 uint32_t iterator_running;
183 uint32_t iterator_flags;
185 #define SCTP_ITERATOR_STOP_CUR_IT 0x00000004
186 #define SCTP_ITERATOR_STOP_CUR_INP 0x00000008
188 struct sctp_net_route {
189 struct nhop_object *ro_nh;
190 struct llentry *ro_lle;
196 union sctp_sockstore _l_addr; /* remote peer addr */
197 struct sctp_ifa *_s_addr; /* our selected src addr */
201 uint16_t alpha; /* Fixed point arith, << 7 */
202 uint8_t beta; /* Fixed point arith, << 7 */
203 uint8_t modeswitch; /* Delay modeswitch until we had at least one
204 * congestion event */
205 uint32_t last_cong; /* Time since last congestion event end */
206 uint32_t undo_last_cong;
207 uint16_t bytes_acked;
212 uint32_t undo_maxRTT;
213 uint32_t undo_old_maxB;
215 /* Bandwidth estimation */
224 struct timeval tls; /* The time we started the sending */
225 uint64_t lbw; /* Our last estimated bw */
226 uint64_t lbw_rtt; /* RTT at bw estimate */
227 uint64_t bw_bytes; /* The total bytes since this sending began */
228 uint64_t bw_tot_time; /* The total time since sending began */
229 uint64_t new_tot_time; /* temp holding the new value */
230 uint64_t bw_bytes_at_last_rttc; /* What bw_bytes was at last rtt calc */
231 uint32_t cwnd_at_bw_set; /* Cwnd at last bw saved - lbw */
232 uint32_t vol_reduce; /* cnt of voluntary reductions */
233 uint16_t steady_step; /* The number required to be in steady state */
234 uint16_t step_cnt; /* The current number */
235 uint8_t ret_from_eq; /* When all things are equal what do I return
236 * 0/1 - 1 no cc advance */
237 uint8_t use_dccc_ecn; /* Flag to enable DCCC ECN */
238 uint8_t tls_needs_set; /* Flag to indicate we need to set tls 0 or 1
239 * means set at send 2 not */
240 uint8_t last_step_state; /* Last state if steady state stepdown
242 uint8_t rtt_set_this_sack; /* Flag saying this sack had RTT calc
244 uint8_t last_inst_ind; /* Last saved inst indication */
249 TAILQ_ENTRY(sctp_nets) sctp_next; /* next link */
252 * Things on the top half may be able to be split into a common
253 * structure shared by all.
255 struct sctp_timer pmtu_timer;
256 struct sctp_timer hb_timer;
259 * The following two in combination equate to a route entry for v6
262 struct sctp_net_route ro;
264 /* mtu discovered so far */
266 uint32_t ssthresh; /* not sure about this one for split */
267 uint32_t last_cwr_tsn;
268 uint32_t cwr_window_tsn;
269 uint32_t ecn_ce_pkt_cnt;
271 /* smoothed average things for RTT and RTO itself */
274 uint64_t rtt; /* last measured rtt value in us */
277 /* This is used for SHUTDOWN/SHUTDOWN-ACK/SEND or INIT timers */
278 struct sctp_timer rxt_timer;
280 /* last time in seconds I sent to it */
281 struct timeval last_sent_time;
282 union cc_control_data {
283 struct htcp htcp_ca; /* JRS - struct used in HTCP algorithm */
284 struct rtcc_cc rtcc; /* rtcc module cc stuff */
288 /* Congestion stats per destination */
290 * flight size variables and such, sorry Vern, I could not avoid
291 * this if I wanted performance :>
293 uint32_t flight_size;
294 uint32_t cwnd; /* actual cwnd */
295 uint32_t prev_cwnd; /* cwnd before any processing */
296 uint32_t ecn_prev_cwnd; /* ECN prev cwnd at first ecn_echo seen in new
298 uint32_t partial_bytes_acked; /* in CA tracks when to incr a MTU */
299 /* tracking variables to avoid the aloc/free in sack processing */
300 unsigned int net_ack;
301 unsigned int net_ack2;
304 * JRS - 5/8/07 - Variable to track last time a destination was
307 uint32_t last_active;
310 * CMT variables (iyengar@cis.udel.edu)
312 uint32_t this_sack_highest_newack; /* tracks highest TSN newly
313 * acked for a given dest in
314 * the current SACK. Used in
315 * SFR and HTNA algos */
316 uint32_t pseudo_cumack; /* CMT CUC algorithm. Maintains next expected
317 * pseudo-cumack for this destination */
318 uint32_t rtx_pseudo_cumack; /* CMT CUC algorithm. Maintains next
319 * expected pseudo-cumack for this
322 /* CMT fast recovery variables */
323 uint32_t fast_recovery_tsn;
324 uint32_t heartbeat_random1;
325 uint32_t heartbeat_random2;
331 struct timeval start_time; /* time when this net was created */
332 uint32_t marked_retrans; /* number or DATA chunks marked for
333 * timer based retransmissions */
334 uint32_t marked_fastretrans;
335 uint32_t heart_beat_delay; /* Heart Beat delay in ms */
337 /* if this guy is ok or not ... status */
339 /* number of timeouts to consider the destination unreachable */
340 uint16_t failure_threshold;
341 /* number of timeouts to consider the destination potentially failed */
342 uint16_t pf_threshold;
343 /* error stats on the destination */
344 uint16_t error_count;
345 /* UDP port number in case of UDP tunneling */
348 uint8_t fast_retran_loss_recovery;
349 uint8_t will_exit_fast_recovery;
350 /* Flags that probably can be combined into dest_state */
351 uint8_t fast_retran_ip; /* fast retransmit in progress */
352 uint8_t hb_responded;
353 uint8_t saw_newack; /* CMT's SFR algorithm flag */
354 uint8_t src_addr_selected; /* if we split we move */
355 uint8_t indx_of_eligible_next_to_use;
356 uint8_t addr_is_local; /* its a local address (if known) could move
360 * CMT variables (iyengar@cis.udel.edu)
362 uint8_t find_pseudo_cumack; /* CMT CUC algorithm. Flag used to
363 * find a new pseudocumack. This flag
364 * is set after a new pseudo-cumack
365 * has been received and indicates
366 * that the sender should find the
367 * next pseudo-cumack expected for
368 * this destination */
369 uint8_t find_rtx_pseudo_cumack; /* CMT CUCv2 algorithm. Flag used to
370 * find a new rtx-pseudocumack. This
371 * flag is set after a new
372 * rtx-pseudo-cumack has been received
373 * and indicates that the sender
374 * should find the next
375 * rtx-pseudo-cumack expected for this
377 uint8_t new_pseudo_cumack; /* CMT CUC algorithm. Flag used to
378 * indicate if a new pseudo-cumack or
379 * rtx-pseudo-cumack has been received */
380 uint8_t window_probe; /* Doing a window probe? */
381 uint8_t RTO_measured; /* Have we done the first measure */
382 uint8_t last_hs_used; /* index into the last HS table entry we used */
390 struct sctp_data_chunkrec {
391 uint32_t tsn; /* the TSN of this transmit */
392 uint32_t mid; /* the message identifier of this transmit */
393 uint16_t sid; /* the stream number of this guy */
395 uint32_t context; /* from send */
396 uint32_t cwnd_at_send;
398 * part of the Highest sacked algorithm to be able to stroke counts
399 * on ones that are FR'd.
401 uint32_t fast_retran_tsn; /* sending_seq at the time of FR */
402 struct timeval timetodrop; /* time we drop it from queue */
403 uint32_t fsn; /* Fragment Sequence Number */
404 uint8_t doing_fast_retransmit;
405 uint8_t rcv_flags; /* flags pulled from data chunk on inbound for
406 * outbound holds sending flags for PR-SCTP. */
408 uint8_t chunk_was_revoked;
412 TAILQ_HEAD(sctpchunk_listhead, sctp_tmit_chunk);
414 /* The lower byte is used to enumerate PR_SCTP policies */
415 #define CHUNK_FLAGS_PR_SCTP_TTL SCTP_PR_SCTP_TTL
416 #define CHUNK_FLAGS_PR_SCTP_BUF SCTP_PR_SCTP_BUF
417 #define CHUNK_FLAGS_PR_SCTP_RTX SCTP_PR_SCTP_RTX
419 /* The upper byte is used as a bit mask */
420 #define CHUNK_FLAGS_FRAGMENT_OK 0x0100
424 uint8_t can_take_data;
428 struct sctp_tmit_chunk {
430 struct sctp_data_chunkrec data;
431 struct chk_id chunk_id;
433 struct sctp_association *asoc; /* bp to asoc this belongs to */
434 struct timeval sent_rcv_time; /* filled in if RTT being calculated */
435 struct mbuf *data; /* pointer to mbuf chain of data */
436 struct mbuf *last_mbuf; /* pointer to last mbuf in chain */
437 struct sctp_nets *whoTo;
438 TAILQ_ENTRY(sctp_tmit_chunk) sctp_next; /* next link */
439 int32_t sent; /* the send status */
440 uint16_t snd_count; /* number of times I sent */
441 uint16_t flags; /* flags, such as FRAGMENT_OK */
446 uint8_t holds_key_ref; /* flag if auth keyid refcount is held */
449 uint8_t book_size_scale;
450 uint8_t no_fr_allowed;
452 uint8_t window_probe;
455 struct sctp_queued_to_read { /* sinfo structure Pluse more */
456 uint16_t sinfo_stream; /* off the wire */
457 uint16_t sinfo_flags; /* SCTP_UNORDERED from wire use SCTP_EOF for
459 uint32_t sinfo_ppid; /* off the wire */
460 uint32_t sinfo_context; /* pick this up from assoc def context? */
461 uint32_t sinfo_timetolive; /* not used by kernel */
462 uint32_t sinfo_tsn; /* Use this in reassembly as first TSN */
463 uint32_t sinfo_cumtsn; /* Use this in reassembly as last TSN */
464 sctp_assoc_t sinfo_assoc_id; /* our assoc id */
465 /* Non sinfo stuff */
466 uint32_t mid; /* Fragment Index */
467 uint32_t length; /* length of data */
468 uint32_t held_length; /* length held in sb */
469 uint32_t top_fsn; /* Highest FSN in queue */
470 uint32_t fsn_included; /* Highest FSN in *data portion */
471 struct sctp_nets *whoFrom; /* where it came from */
472 struct mbuf *data; /* front of the mbuf chain of data with
474 struct mbuf *tail_mbuf; /* used for multi-part data */
475 struct mbuf *aux_data; /* used to hold/cache control if o/s does not
477 struct sctp_tcb *stcb; /* assoc, used for window update */
478 TAILQ_ENTRY(sctp_queued_to_read) next;
479 TAILQ_ENTRY(sctp_queued_to_read) next_instrm;
480 struct sctpchunk_listhead reasm;
482 uint16_t spec_flags; /* Flags to hold the notification field */
483 uint8_t do_not_ref_stcb;
485 uint8_t pdapi_aborted;
486 uint8_t pdapi_started;
488 uint8_t last_frag_seen;
489 uint8_t first_frag_seen;
494 #define SCTP_ON_ORDERED 1
495 #define SCTP_ON_UNORDERED 2
497 /* This data structure will be on the outbound
498 * stream queues. Data will be pulled off from
499 * the front of the mbuf data and chunk-ified
500 * by the output routines. We will custom
501 * fit every chunk we pull to the send/sent
502 * queue to make up the next full packet
503 * if we can. An entry cannot be removed
504 * from the stream_out queue until
505 * the msg_is_complete flag is set. This
506 * means at times data/tail_mbuf MIGHT
507 * be NULL.. If that occurs it happens
508 * for one of two reasons. Either the user
509 * is blocked on a send() call and has not
510 * awoken to copy more data down... OR
511 * the user is in the explict MSG_EOR mode
512 * and wrote some data, but has not completed
515 struct sctp_stream_queue_pending {
517 struct mbuf *tail_mbuf;
519 struct sctp_nets *net;
520 TAILQ_ENTRY(sctp_stream_queue_pending) next;
521 TAILQ_ENTRY(sctp_stream_queue_pending) ss_next;
527 uint16_t sinfo_flags;
531 uint8_t holds_key_ref;
532 uint8_t msg_is_complete;
534 uint8_t sender_all_done;
535 uint8_t put_last_out;
536 uint8_t discard_rest;
541 * this struct contains info that is used to track inbound stream data and
542 * help with ordering.
544 TAILQ_HEAD(sctpwheelunrel_listhead, sctp_stream_in);
545 struct sctp_stream_in {
546 struct sctp_readhead inqueue;
547 struct sctp_readhead uno_inqueue;
548 uint32_t last_mid_delivered; /* used for re-order */
550 uint8_t delivery_started;
551 uint8_t pd_api_started;
554 TAILQ_HEAD(sctpwheel_listhead, sctp_stream_out);
555 TAILQ_HEAD(sctplist_listhead, sctp_stream_queue_pending);
558 /* Round-robin schedulers */
560 /* next link in wheel */
561 TAILQ_ENTRY(sctp_stream_out) next_spoke;
564 /* Priority scheduler */
566 /* next link in wheel */
567 TAILQ_ENTRY(sctp_stream_out) next_spoke;
572 /* Fair Bandwidth scheduler */
574 /* next link in wheel */
575 TAILQ_ENTRY(sctp_stream_out) next_spoke;
576 /* stores message size */
581 * This union holds all data necessary for
582 * different stream schedulers.
584 struct scheduling_data {
585 struct sctp_stream_out *locked_on_sending;
586 /* circular looking for output selection */
587 struct sctp_stream_out *last_out_stream;
589 struct sctpwheel_listhead wheel;
590 struct sctplist_listhead list;
595 * This union holds all parameters per stream
596 * necessary for different stream schedulers.
598 union scheduling_parameters {
604 /* States for outgoing streams */
605 #define SCTP_STREAM_CLOSED 0x00
606 #define SCTP_STREAM_OPENING 0x01
607 #define SCTP_STREAM_OPEN 0x02
608 #define SCTP_STREAM_RESET_PENDING 0x03
609 #define SCTP_STREAM_RESET_IN_FLIGHT 0x04
611 #define SCTP_MAX_STREAMS_AT_ONCE_RESET 200
613 /* This struct is used to track the traffic on outbound streams */
614 struct sctp_stream_out {
615 struct sctp_streamhead outqueue;
616 union scheduling_parameters ss_params;
617 uint32_t chunks_on_queues; /* send queue and sent queue */
618 #if defined(SCTP_DETAILED_STR_STATS)
619 uint32_t abandoned_unsent[SCTP_PR_SCTP_MAX + 1];
620 uint32_t abandoned_sent[SCTP_PR_SCTP_MAX + 1];
622 /* Only the aggregation */
623 uint32_t abandoned_unsent[1];
624 uint32_t abandoned_sent[1];
627 * For associations using DATA chunks, the lower 16-bit of
628 * next_mid_ordered are used as the next SSN.
630 uint32_t next_mid_ordered;
631 uint32_t next_mid_unordered;
633 uint8_t last_msg_incomplete;
637 /* used to keep track of the addresses yet to try to add/delete */
638 TAILQ_HEAD(sctp_asconf_addrhead, sctp_asconf_addr);
639 struct sctp_asconf_addr {
640 TAILQ_ENTRY(sctp_asconf_addr) next;
641 struct sctp_asconf_addr_param ap;
642 struct sctp_ifa *ifa; /* save the ifa for add/del ip */
643 uint8_t sent; /* has this been sent yet? */
644 uint8_t special_del; /* not to be used in lookup */
647 struct sctp_scoping {
648 uint8_t ipv4_addr_legal;
649 uint8_t ipv6_addr_legal;
650 uint8_t loopback_scope;
651 uint8_t ipv4_local_scope;
656 #define SCTP_TSN_LOG_SIZE 40
658 struct sctp_tsn_log {
670 #define SCTP_FS_SPEC_LOG_SIZE 200
671 struct sctp_fs_spec_log {
673 uint32_t total_flight;
680 /* This struct is here to cut out the compatiabilty
681 * pad that bulks up both the inp and stcb. The non
682 * pad portion MUST stay in complete sync with
683 * sctp_sndrcvinfo... i.e. if sinfo_xxxx is added
684 * this must be done here too.
686 struct sctp_nonpad_sndrcvinfo {
687 uint16_t sinfo_stream;
689 uint16_t sinfo_flags;
691 uint32_t sinfo_context;
692 uint32_t sinfo_timetolive;
694 uint32_t sinfo_cumtsn;
695 sctp_assoc_t sinfo_assoc_id;
696 uint16_t sinfo_keynumber;
697 uint16_t sinfo_keynumber_valid;
701 * JRS - Structure to hold function pointers to the functions responsible
702 * for congestion control.
705 struct sctp_cc_functions {
706 void (*sctp_set_initial_cc_param) (struct sctp_tcb *stcb, struct sctp_nets *net);
707 void (*sctp_cwnd_update_after_sack) (struct sctp_tcb *stcb,
708 struct sctp_association *asoc,
709 int accum_moved, int reneged_all, int will_exit);
710 void (*sctp_cwnd_update_exit_pf) (struct sctp_tcb *stcb, struct sctp_nets *net);
711 void (*sctp_cwnd_update_after_fr) (struct sctp_tcb *stcb,
712 struct sctp_association *asoc);
713 void (*sctp_cwnd_update_after_timeout) (struct sctp_tcb *stcb,
714 struct sctp_nets *net);
715 void (*sctp_cwnd_update_after_ecn_echo) (struct sctp_tcb *stcb,
716 struct sctp_nets *net, int in_window, int num_pkt_lost);
717 void (*sctp_cwnd_update_after_packet_dropped) (struct sctp_tcb *stcb,
718 struct sctp_nets *net, struct sctp_pktdrop_chunk *cp,
719 uint32_t *bottle_bw, uint32_t *on_queue);
720 void (*sctp_cwnd_update_after_output) (struct sctp_tcb *stcb,
721 struct sctp_nets *net, int burst_limit);
722 void (*sctp_cwnd_update_packet_transmitted) (struct sctp_tcb *stcb,
723 struct sctp_nets *net);
724 void (*sctp_cwnd_update_tsn_acknowledged) (struct sctp_nets *net,
725 struct sctp_tmit_chunk *);
726 void (*sctp_cwnd_new_transmission_begins) (struct sctp_tcb *stcb,
727 struct sctp_nets *net);
728 void (*sctp_cwnd_prepare_net_for_sack) (struct sctp_tcb *stcb,
729 struct sctp_nets *net);
730 int (*sctp_cwnd_socket_option) (struct sctp_tcb *stcb, int set, struct sctp_cc_option *);
731 void (*sctp_rtt_calculated) (struct sctp_tcb *, struct sctp_nets *, struct timeval *);
735 * RS - Structure to hold function pointers to the functions responsible
736 * for stream scheduling.
738 struct sctp_ss_functions {
739 void (*sctp_ss_init) (struct sctp_tcb *stcb, struct sctp_association *asoc,
741 void (*sctp_ss_clear) (struct sctp_tcb *stcb, struct sctp_association *asoc,
742 int clear_values, int holds_lock);
743 void (*sctp_ss_init_stream) (struct sctp_tcb *stcb, struct sctp_stream_out *strq, struct sctp_stream_out *with_strq);
744 void (*sctp_ss_add_to_stream) (struct sctp_tcb *stcb, struct sctp_association *asoc,
745 struct sctp_stream_out *strq, struct sctp_stream_queue_pending *sp, int holds_lock);
746 int (*sctp_ss_is_empty) (struct sctp_tcb *stcb, struct sctp_association *asoc);
747 void (*sctp_ss_remove_from_stream) (struct sctp_tcb *stcb, struct sctp_association *asoc,
748 struct sctp_stream_out *strq, struct sctp_stream_queue_pending *sp, int holds_lock);
749 struct sctp_stream_out *(*sctp_ss_select_stream) (struct sctp_tcb *stcb,
750 struct sctp_nets *net, struct sctp_association *asoc);
751 void (*sctp_ss_scheduled) (struct sctp_tcb *stcb, struct sctp_nets *net,
752 struct sctp_association *asoc, struct sctp_stream_out *strq, int moved_how_much);
753 void (*sctp_ss_packet_done) (struct sctp_tcb *stcb, struct sctp_nets *net,
754 struct sctp_association *asoc);
755 int (*sctp_ss_get_value) (struct sctp_tcb *stcb, struct sctp_association *asoc,
756 struct sctp_stream_out *strq, uint16_t *value);
757 int (*sctp_ss_set_value) (struct sctp_tcb *stcb, struct sctp_association *asoc,
758 struct sctp_stream_out *strq, uint16_t value);
759 int (*sctp_ss_is_user_msgs_incomplete) (struct sctp_tcb *stcb, struct sctp_association *asoc);
762 /* used to save ASCONF chunks for retransmission */
763 TAILQ_HEAD(sctp_asconf_head, sctp_asconf);
765 TAILQ_ENTRY(sctp_asconf) next;
766 uint32_t serial_number;
772 /* used to save ASCONF-ACK chunks for retransmission */
773 TAILQ_HEAD(sctp_asconf_ackhead, sctp_asconf_ack);
774 struct sctp_asconf_ack {
775 TAILQ_ENTRY(sctp_asconf_ack) next;
776 uint32_t serial_number;
777 struct sctp_nets *last_sent_to;
783 * Here we have information about each individual association that we track.
784 * We probably in production would be more dynamic. But for ease of
785 * implementation we will have a fixed array that we hunt for in a linear
788 struct sctp_association {
789 /* association state */
792 /* queue of pending addrs to add/delete */
793 struct sctp_asconf_addrhead asconf_queue;
795 struct timeval time_entered; /* time we entered state */
796 struct timeval time_last_rcvd;
797 struct timeval time_last_sent;
798 struct timeval time_last_sat_advance;
799 struct sctp_nonpad_sndrcvinfo def_send;
801 /* timers and such */
802 struct sctp_timer dack_timer; /* Delayed ack timer */
803 struct sctp_timer asconf_timer; /* asconf */
804 struct sctp_timer strreset_timer; /* stream reset */
805 struct sctp_timer shut_guard_timer; /* shutdown guard */
806 struct sctp_timer autoclose_timer; /* automatic close timer */
807 struct sctp_timer delete_prim_timer; /* deleting primary dst */
809 /* list of restricted local addresses */
810 struct sctpladdr sctp_restricted_addrs;
812 /* last local address pending deletion (waiting for an address add) */
813 struct sctp_ifa *asconf_addr_del_pending;
814 /* Deleted primary destination (used to stop timer) */
815 struct sctp_nets *deleted_primary;
817 struct sctpnetlisthead nets; /* remote address list */
819 /* Free chunk list */
820 struct sctpchunk_listhead free_chunks;
822 /* Control chunk queue */
823 struct sctpchunk_listhead control_send_queue;
825 /* ASCONF chunk queue */
826 struct sctpchunk_listhead asconf_send_queue;
829 * Once a TSN hits the wire it is moved to the sent_queue. We
830 * maintain two counts here (don't know if any but retran_cnt is
831 * needed). The idea is that the sent_queue_retran_cnt reflects how
832 * many chunks have been marked for retranmission by either T3-rxt
835 struct sctpchunk_listhead sent_queue;
836 struct sctpchunk_listhead send_queue;
838 /* Scheduling queues */
839 struct scheduling_data ss_data;
841 /* If an iterator is looking at me, this is it */
842 struct sctp_iterator *stcb_starting_point_for_iterator;
844 /* ASCONF save the last ASCONF-ACK so we can resend it if necessary */
845 struct sctp_asconf_ackhead asconf_ack_sent;
848 * pointer to last stream reset queued to control queue by us with
851 struct sctp_tmit_chunk *str_reset;
853 * if Source Address Selection happening, this will rotate through
856 struct sctp_laddr *last_used_address;
859 struct sctp_stream_in *strmin;
860 struct sctp_stream_out *strmout;
861 uint8_t *mapping_array;
862 /* primary destination to use */
863 struct sctp_nets *primary_destination;
864 struct sctp_nets *alternate; /* If primary is down or PF */
866 struct sctp_nets *last_net_cmt_send_started;
867 /* last place I got a data chunk from */
868 struct sctp_nets *last_data_chunk_from;
869 /* last place I got a control from */
870 struct sctp_nets *last_control_chunk_from;
874 * wait to the point the cum-ack passes req->send_reset_at_tsn for
875 * any req on the list.
877 struct sctp_resethead resetHead;
879 /* queue of chunks waiting to be sent into the local stack */
880 struct sctp_readhead pending_reply_queue;
882 /* JRS - the congestion control functions are in this struct */
883 struct sctp_cc_functions cc_functions;
885 * JRS - value to store the currently loaded congestion control
888 uint32_t congestion_control_module;
889 /* RS - the stream scheduling functions are in this struct */
890 struct sctp_ss_functions ss_functions;
891 /* RS - value to store the currently loaded stream scheduling module */
892 uint32_t stream_scheduling_module;
895 uint32_t cookie_preserve_req;
896 /* ASCONF next seq I am sending out, inits at init-tsn */
897 uint32_t asconf_seq_out;
898 uint32_t asconf_seq_out_acked;
899 /* ASCONF last received ASCONF from peer, starts at peer's TSN-1 */
900 uint32_t asconf_seq_in;
902 /* next seq I am sending in str reset messages */
903 uint32_t str_reset_seq_out;
904 /* next seq I am expecting in str reset messages */
905 uint32_t str_reset_seq_in;
907 /* various verification tag information */
908 uint32_t my_vtag; /* The tag to be used. if assoc is re-initited
909 * by remote end, and I have unlocked this
910 * will be regenerated to a new random value. */
911 uint32_t peer_vtag; /* The peers last tag */
913 uint32_t my_vtag_nonce;
914 uint32_t peer_vtag_nonce;
918 /* This is the SCTP fragmentation threshold */
919 uint32_t smallest_mtu;
922 * Special hook for Fast retransmit, allows us to track the highest
923 * TSN that is NEW in this SACK if gap ack blocks are present.
925 uint32_t this_sack_highest_gap;
928 * The highest consecutive TSN that has been acked by peer on my
931 uint32_t last_acked_seq;
933 /* The next TSN that I will use in sending. */
934 uint32_t sending_seq;
936 /* Original seq number I used ??questionable to keep?? */
937 uint32_t init_seq_number;
940 /* The Advanced Peer Ack Point, as required by the PR-SCTP */
941 /* (A1 in Section 4.2) */
942 uint32_t advanced_peer_ack_point;
945 * The highest consequetive TSN at the bottom of the mapping array
948 uint32_t cumulative_tsn;
950 * Used to track the mapping array and its offset bits. This MAY be
951 * lower then cumulative_tsn.
953 uint32_t mapping_array_base_tsn;
955 * used to track highest TSN we have received and is listed in the
958 uint32_t highest_tsn_inside_map;
960 /* EY - new NR variables used for nr_sack based on mapping_array */
961 uint8_t *nr_mapping_array;
962 uint32_t highest_tsn_inside_nr_map;
964 uint32_t fast_recovery_tsn;
965 uint32_t sat_t3_recovery_tsn;
966 uint32_t tsn_last_delivered;
968 * For the pd-api we should re-write this a bit more efficient. We
969 * could have multiple sctp_queued_to_read's that we are building at
970 * once. Now we only do this when we get ready to deliver to the
971 * socket buffer. Note that we depend on the fact that the struct is
972 * "stuck" on the read queue until we finish all the pd-api.
974 struct sctp_queued_to_read *control_pdapi;
976 uint32_t tsn_of_pdapi_last_delivered;
979 uint32_t last_reset_action[SCTP_MAX_RESET_PARAMS];
980 uint32_t last_sending_seq[SCTP_MAX_RESET_PARAMS];
981 uint32_t last_base_tsnsent[SCTP_MAX_RESET_PARAMS];
982 #ifdef SCTP_ASOCLOG_OF_TSNS
984 * special log - This adds considerable size to the asoc, but
985 * provides a log that you can use to detect problems via kgdb.
987 struct sctp_tsn_log in_tsnlog[SCTP_TSN_LOG_SIZE];
988 struct sctp_tsn_log out_tsnlog[SCTP_TSN_LOG_SIZE];
989 uint32_t cumack_log[SCTP_TSN_LOG_SIZE];
990 uint32_t cumack_logsnt[SCTP_TSN_LOG_SIZE];
993 uint16_t tsn_in_wrapped;
994 uint16_t tsn_out_wrapped;
995 uint16_t cumack_log_at;
996 uint16_t cumack_log_atsnt;
997 #endif /* SCTP_ASOCLOG_OF_TSNS */
998 #ifdef SCTP_FS_SPEC_LOG
999 struct sctp_fs_spec_log fslog[SCTP_FS_SPEC_LOG_SIZE];
1004 * window state information and smallest MTU that I use to bound
1007 uint32_t peers_rwnd;
1009 uint32_t my_last_reported_rwnd;
1010 uint32_t sctp_frag_point;
1012 uint32_t total_output_queue_size;
1014 uint32_t sb_cc; /* shadow of sb_cc */
1015 uint32_t sb_send_resv; /* amount reserved on a send */
1016 uint32_t my_rwnd_control_len; /* shadow of sb_mbcnt used for rwnd
1019 uint32_t default_flowlabel;
1021 uint32_t pr_sctp_cnt;
1022 int ctrl_queue_cnt; /* could be removed REM - NO IT CAN'T!! RRS */
1024 * All outbound datagrams queue into this list from the individual
1025 * stream queue. Here they get assigned a TSN and then await
1026 * sending. The stream seq comes when it is first put in the
1027 * individual str queue
1029 unsigned int stream_queue_cnt;
1030 unsigned int send_queue_cnt;
1031 unsigned int sent_queue_cnt;
1032 unsigned int sent_queue_cnt_removeable;
1034 * Number on sent queue that are marked for retran until this value
1035 * is 0 we only send one packet of retran'ed data.
1037 unsigned int sent_queue_retran_cnt;
1039 unsigned int size_on_reasm_queue;
1040 unsigned int cnt_on_reasm_queue;
1041 unsigned int fwd_tsn_cnt;
1042 /* amount of data (bytes) currently in flight (on all destinations) */
1043 unsigned int total_flight;
1044 /* Total book size in flight */
1045 unsigned int total_flight_count; /* count of chunks used with
1047 /* count of destinaton nets and list of destination nets */
1048 unsigned int numnets;
1050 /* Total error count on this association */
1051 unsigned int overall_error_count;
1053 unsigned int cnt_msg_on_sb;
1055 /* All stream count of chunks for delivery */
1056 unsigned int size_on_all_streams;
1057 unsigned int cnt_on_all_streams;
1059 /* Heart Beat delay in ms */
1060 uint32_t heart_beat_delay;
1063 uint32_t sctp_autoclose_ticks;
1065 /* how many preopen streams we have */
1066 unsigned int pre_open_streams;
1068 /* How many streams I support coming into me */
1069 unsigned int max_inbound_streams;
1071 /* the cookie life I award for any cookie, in seconds */
1072 uint32_t cookie_life;
1073 /* time to delay acks for */
1074 unsigned int delayed_ack;
1075 unsigned int old_delayed_ack;
1076 unsigned int sack_freq;
1077 unsigned int data_pkts_seen;
1079 unsigned int numduptsns;
1080 int dup_tsns[SCTP_MAX_DUP_TSNS];
1081 uint32_t initial_init_rto_max; /* initial RTO for INIT's */
1082 uint32_t initial_rto; /* initial send RTO */
1083 uint32_t minrto; /* per assoc RTO-MIN */
1084 uint32_t maxrto; /* per assoc RTO-MAX */
1086 /* authentication fields */
1087 sctp_auth_chklist_t *local_auth_chunks;
1088 sctp_auth_chklist_t *peer_auth_chunks;
1089 sctp_hmaclist_t *local_hmacs; /* local HMACs supported */
1090 sctp_hmaclist_t *peer_hmacs; /* peer HMACs supported */
1091 struct sctp_keyhead shared_keys; /* assoc's shared keys */
1092 sctp_authinfo_t authinfo; /* randoms, cached keys */
1094 * refcnt to block freeing when a sender or receiver is off coping
1098 uint32_t chunks_on_out_queue; /* total chunks floating around,
1099 * locked by send socket buffer */
1100 uint32_t peers_adaptation;
1101 uint32_t default_mtu;
1102 uint16_t peer_hmac_id; /* peer HMAC id to send */
1105 * Being that we have no bag to collect stale cookies, and that we
1106 * really would not want to anyway.. we will count them in this
1107 * counter. We of course feed them to the pigeons right away (I have
1108 * always thought of pigeons as flying rats).
1110 uint16_t stale_cookie_count;
1113 * For the partial delivery API, if up, invoked this is what last
1116 uint16_t str_of_pdapi;
1117 uint16_t ssn_of_pdapi;
1119 /* counts of actual built streams. Allocation may be more however */
1120 /* could re-arrange to optimize space here. */
1121 uint16_t streamincnt;
1122 uint16_t streamoutcnt;
1123 uint16_t strm_realoutsize;
1124 uint16_t strm_pending_add_size;
1125 /* my maximum number of retrans of INIT and SEND */
1126 /* copied from SCTP but should be individually setable */
1127 uint16_t max_init_times;
1128 uint16_t max_send_times;
1130 uint16_t def_net_failure;
1132 uint16_t def_net_pf_threshold;
1135 * lock flag: 0 is ok to send, 1+ (duals as a retran count) is
1138 uint16_t mapping_array_size;
1140 uint16_t last_strm_seq_delivered;
1141 uint16_t last_strm_no_delivered;
1143 uint16_t last_revoke_count;
1144 int16_t num_send_timers_up;
1146 uint16_t stream_locked_on;
1147 uint16_t ecn_echo_cnt_onq;
1149 uint16_t free_chunk_cnt;
1150 uint8_t stream_locked;
1151 uint8_t authenticated; /* packet authenticated ok */
1153 * This flag indicates that a SACK need to be sent. Initially this
1154 * is 1 to send the first sACK immediately.
1158 /* max burst of new packets into the network */
1160 /* max burst of fast retransmit packets */
1161 uint32_t fr_max_burst;
1163 uint8_t sat_network; /* RTT is in range of sat net or greater */
1164 uint8_t sat_network_lockout; /* lockout code */
1165 uint8_t burst_limit_applied; /* Burst limit in effect at last send? */
1166 /* flag goes on when we are doing a partial delivery api */
1167 uint8_t hb_random_values[4];
1168 uint8_t fragmented_delivery_inprogress;
1169 uint8_t fragment_flags;
1170 uint8_t last_flags_delivered;
1171 uint8_t hb_ect_randombit;
1172 uint8_t hb_random_idx;
1173 uint8_t default_dscp;
1174 uint8_t asconf_del_pending; /* asconf delete last addr pending */
1175 uint8_t trigger_reset;
1177 * This value, plus all other ack'd but above cum-ack is added
1178 * together to cross check against the bit that we have yet to
1179 * define (probably in the SACK). When the cum-ack is updated, this
1180 * sum is updated as well.
1183 /* Flags whether an extension is supported or not */
1184 uint8_t ecn_supported;
1185 uint8_t prsctp_supported;
1186 uint8_t auth_supported;
1187 uint8_t asconf_supported;
1188 uint8_t reconfig_supported;
1189 uint8_t nrsack_supported;
1190 uint8_t pktdrop_supported;
1191 uint8_t idata_supported;
1193 /* Did the peer make the stream config (add out) request */
1194 uint8_t peer_req_out;
1196 uint8_t local_strreset_support;
1197 uint8_t peer_supports_nat;
1199 struct sctp_scoping scope;
1200 /* flags to handle send alternate net tracking */
1201 uint8_t used_alt_asconfack;
1202 uint8_t fast_retran_loss_recovery;
1203 uint8_t sat_t3_loss_recovery;
1204 uint8_t dropped_special_cnt;
1205 uint8_t seen_a_sack_this_pkt;
1206 uint8_t stream_reset_outstanding;
1207 uint8_t stream_reset_out_is_outstanding;
1208 uint8_t delayed_connection;
1209 uint8_t ifp_had_enobuf;
1210 uint8_t saw_sack_with_frags;
1211 uint8_t saw_sack_with_nr_frags;
1212 uint8_t in_asocid_hash;
1213 uint8_t assoc_up_sent;
1214 uint8_t adaptation_needed;
1215 uint8_t adaptation_sent;
1217 uint8_t cmt_dac_pkts_rcvd;
1218 uint8_t sctp_cmt_on_off;
1219 uint8_t iam_blocking;
1220 uint8_t cookie_how[8];
1221 /* JRS 5/21/07 - CMT PF variable */
1222 uint8_t sctp_cmt_pf;
1223 uint8_t use_precise_time;
1224 uint64_t sctp_features;
1226 uint16_t port; /* remote UDP encapsulation port */
1228 * The mapping array is used to track out of order sequences above
1229 * last_acked_seq. 0 indicates packet missing 1 indicates packet
1230 * rec'd. We slide it up every time we raise last_acked_seq and 0
1231 * trailing locactions out. If I get a TSN above the array
1232 * mappingArraySz, I discard the datagram and let retransmit happen.
1234 uint32_t marked_retrans;
1238 uint32_t timoshutdown;
1239 uint32_t timoheartbeat;
1240 uint32_t timocookie;
1241 uint32_t timoshutdownack;
1242 struct timeval start_time;
1243 struct timeval discontinuity_time;
1244 uint64_t abandoned_unsent[SCTP_PR_SCTP_MAX + 1];
1245 uint64_t abandoned_sent[SCTP_PR_SCTP_MAX + 1];