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;
64 struct sctp_foo_stuff {
65 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 uint32_t number_entries;
82 uint16_t list_of_streams[];
85 TAILQ_HEAD(sctp_resethead, sctp_stream_reset_list);
88 * Users of the iterator need to malloc a iterator with a call to
89 * sctp_initiate_iterator(inp_func, assoc_func, inp_func, pcb_flags, pcb_features,
90 * asoc_state, void-ptr-arg, uint32-arg, end_func, inp);
92 * Use the following two defines if you don't care what pcb flags are on the EP
93 * and/or you don't care what state the association is in.
95 * Note that if you specify an INP as the last argument then ONLY each
96 * association of that single INP will be executed upon. Note that the pcb
97 * flags STILL apply so if the inp you specify has different pcb_flags then
98 * what you put in pcb_flags nothing will happen. use SCTP_PCB_ANY_FLAGS to
99 * assure the inp you specify gets treated.
101 #define SCTP_PCB_ANY_FLAGS 0x00000000
102 #define SCTP_PCB_ANY_FEATURES 0x00000000
103 #define SCTP_ASOC_ANY_STATE 0x00000000
105 typedef void (*asoc_func) (struct sctp_inpcb *, struct sctp_tcb *, void *ptr,
107 typedef int (*inp_func) (struct sctp_inpcb *, void *ptr, uint32_t val);
108 typedef void (*end_func) (void *ptr, uint32_t val);
110 #if defined(SCTP_MCORE_INPUT) && defined(SMP)
111 /* whats on the mcore control struct */
112 struct sctp_mcore_queue {
113 TAILQ_ENTRY(sctp_mcore_queue) next;
120 TAILQ_HEAD(sctp_mcore_qhead, sctp_mcore_queue);
122 struct sctp_mcore_ctrl {
123 SCTP_PROCESS_STRUCT thread_proc;
124 struct sctp_mcore_qhead que;
132 /* This struct is here to cut out the compatiabilty
133 * pad that bulks up both the inp and stcb. The non
134 * pad portion MUST stay in complete sync with
135 * sctp_sndrcvinfo... i.e. if sinfo_xxxx is added
136 * this must be done here too.
138 struct sctp_nonpad_sndrcvinfo {
139 uint16_t sinfo_stream;
141 uint16_t sinfo_flags;
143 uint32_t sinfo_context;
144 uint32_t sinfo_timetolive;
146 uint32_t sinfo_cumtsn;
147 sctp_assoc_t sinfo_assoc_id;
148 uint16_t sinfo_keynumber;
149 uint16_t sinfo_keynumber_valid;
152 struct sctp_iterator {
153 TAILQ_ENTRY(sctp_iterator) sctp_nxt_itr;
155 struct sctp_timer tmr;
156 struct sctp_inpcb *inp; /* current endpoint */
157 struct sctp_tcb *stcb; /* current* assoc */
158 struct sctp_inpcb *next_inp; /* special hook to skip to */
159 asoc_func function_assoc; /* per assoc function */
160 inp_func function_inp; /* per endpoint function */
161 inp_func function_inp_end; /* end INP function */
162 end_func function_atend; /* iterator completion function */
163 void *pointer; /* pointer for apply func to use */
164 uint32_t val; /* value for apply func to use */
165 uint32_t pcb_flags; /* endpoint flags being checked */
166 uint32_t pcb_features; /* endpoint features being checked */
167 uint32_t asoc_state; /* assoc state being checked */
168 uint32_t iterator_flags;
169 uint8_t no_chunk_output;
170 uint8_t done_current_ep;
173 /* iterator_flags values */
174 #define SCTP_ITERATOR_DO_ALL_INP 0x00000001
175 #define SCTP_ITERATOR_DO_SINGLE_INP 0x00000002
177 TAILQ_HEAD(sctpiterators, sctp_iterator);
179 struct sctp_copy_all {
180 struct sctp_inpcb *inp; /* ep */
182 struct sctp_nonpad_sndrcvinfo sndrcv;
188 struct sctp_asconf_iterator {
189 struct sctpladdr list_of_work;
193 struct iterator_control {
194 struct mtx ipi_iterator_wq_mtx;
196 SCTP_PROCESS_STRUCT thread_proc;
197 struct sctpiterators iteratorhead;
198 struct sctp_iterator *cur_it;
199 uint32_t iterator_running;
200 uint32_t iterator_flags;
202 #define SCTP_ITERATOR_STOP_CUR_IT 0x00000004
203 #define SCTP_ITERATOR_STOP_CUR_INP 0x00000008
205 struct sctp_net_route {
206 struct nhop_object *ro_nh;
207 struct llentry *ro_lle;
213 union sctp_sockstore _l_addr; /* remote peer addr */
214 struct sctp_ifa *_s_addr; /* our selected src addr */
218 uint16_t alpha; /* Fixed point arith, << 7 */
219 uint8_t beta; /* Fixed point arith, << 7 */
220 uint8_t modeswitch; /* Delay modeswitch until we had at least one
221 * congestion event */
222 uint32_t last_cong; /* Time since last congestion event end */
223 uint32_t undo_last_cong;
224 uint16_t bytes_acked;
229 uint32_t undo_maxRTT;
230 uint32_t undo_old_maxB;
232 /* Bandwidth estimation */
241 struct timeval tls; /* The time we started the sending */
242 uint64_t lbw; /* Our last estimated bw */
243 uint64_t lbw_rtt; /* RTT at bw estimate */
244 uint64_t bw_bytes; /* The total bytes since this sending began */
245 uint64_t bw_tot_time; /* The total time since sending began */
246 uint64_t new_tot_time; /* temp holding the new value */
247 uint64_t bw_bytes_at_last_rttc; /* What bw_bytes was at last rtt calc */
248 uint32_t cwnd_at_bw_set; /* Cwnd at last bw saved - lbw */
249 uint32_t vol_reduce; /* cnt of voluntary reductions */
250 uint16_t steady_step; /* The number required to be in steady state */
251 uint16_t step_cnt; /* The current number */
252 uint8_t ret_from_eq; /* When all things are equal what do I return
253 * 0/1 - 1 no cc advance */
254 uint8_t use_dccc_ecn; /* Flag to enable DCCC ECN */
255 uint8_t tls_needs_set; /* Flag to indicate we need to set tls 0 or 1
256 * means set at send 2 not */
257 uint8_t last_step_state; /* Last state if steady state stepdown
259 uint8_t rtt_set_this_sack; /* Flag saying this sack had RTT calc
261 uint8_t last_inst_ind; /* Last saved inst indication */
265 TAILQ_ENTRY(sctp_nets) sctp_next; /* next link */
268 * Things on the top half may be able to be split into a common
269 * structure shared by all.
271 struct sctp_timer pmtu_timer;
272 struct sctp_timer hb_timer;
275 * The following two in combination equate to a route entry for v6
278 struct sctp_net_route ro;
280 /* mtu discovered so far */
282 uint32_t ssthresh; /* not sure about this one for split */
283 uint32_t last_cwr_tsn;
284 uint32_t cwr_window_tsn;
285 uint32_t ecn_ce_pkt_cnt;
287 /* smoothed average things for RTT and RTO itself */
290 uint64_t rtt; /* last measured rtt value in us */
293 /* This is used for SHUTDOWN/SHUTDOWN-ACK/SEND or INIT timers */
294 struct sctp_timer rxt_timer;
296 /* last time in seconds I sent to it */
297 struct timeval last_sent_time;
298 union cc_control_data {
299 struct htcp htcp_ca; /* JRS - struct used in HTCP algorithm */
300 struct rtcc_cc rtcc; /* rtcc module cc stuff */
304 /* Congestion stats per destination */
306 * flight size variables and such, sorry Vern, I could not avoid
307 * this if I wanted performance :>
309 uint32_t flight_size;
310 uint32_t cwnd; /* actual cwnd */
311 uint32_t prev_cwnd; /* cwnd before any processing */
312 uint32_t ecn_prev_cwnd; /* ECN prev cwnd at first ecn_echo seen in new
314 uint32_t partial_bytes_acked; /* in CA tracks when to incr a MTU */
315 /* tracking variables to avoid the aloc/free in sack processing */
316 unsigned int net_ack;
317 unsigned int net_ack2;
320 * JRS - 5/8/07 - Variable to track last time a destination was
323 uint32_t last_active;
326 * CMT variables (iyengar@cis.udel.edu)
328 uint32_t this_sack_highest_newack; /* tracks highest TSN newly
329 * acked for a given dest in
330 * the current SACK. Used in
331 * SFR and HTNA algos */
332 uint32_t pseudo_cumack; /* CMT CUC algorithm. Maintains next expected
333 * pseudo-cumack for this destination */
334 uint32_t rtx_pseudo_cumack; /* CMT CUC algorithm. Maintains next
335 * expected pseudo-cumack for this
338 /* CMT fast recovery variables */
339 uint32_t fast_recovery_tsn;
340 uint32_t heartbeat_random1;
341 uint32_t heartbeat_random2;
347 struct timeval start_time; /* time when this net was created */
348 uint32_t marked_retrans; /* number or DATA chunks marked for
349 * timer based retransmissions */
350 uint32_t marked_fastretrans;
351 uint32_t heart_beat_delay; /* Heart Beat delay in ms */
353 /* if this guy is ok or not ... status */
355 /* number of timeouts to consider the destination unreachable */
356 uint16_t failure_threshold;
357 /* number of timeouts to consider the destination potentially failed */
358 uint16_t pf_threshold;
359 /* error stats on the destination */
360 uint16_t error_count;
361 /* UDP port number in case of UDP tunneling */
364 uint8_t fast_retran_loss_recovery;
365 uint8_t will_exit_fast_recovery;
366 /* Flags that probably can be combined into dest_state */
367 uint8_t fast_retran_ip; /* fast retransmit in progress */
368 uint8_t hb_responded;
369 uint8_t saw_newack; /* CMT's SFR algorithm flag */
370 uint8_t src_addr_selected; /* if we split we move */
371 uint8_t indx_of_eligible_next_to_use;
372 uint8_t addr_is_local; /* its a local address (if known) could move
376 * CMT variables (iyengar@cis.udel.edu)
378 uint8_t find_pseudo_cumack; /* CMT CUC algorithm. Flag used to
379 * find a new pseudocumack. This flag
380 * is set after a new pseudo-cumack
381 * has been received and indicates
382 * that the sender should find the
383 * next pseudo-cumack expected for
384 * this destination */
385 uint8_t find_rtx_pseudo_cumack; /* CMT CUCv2 algorithm. Flag used to
386 * find a new rtx-pseudocumack. This
387 * flag is set after a new
388 * rtx-pseudo-cumack has been received
389 * and indicates that the sender
390 * should find the next
391 * rtx-pseudo-cumack expected for this
393 uint8_t new_pseudo_cumack; /* CMT CUC algorithm. Flag used to
394 * indicate if a new pseudo-cumack or
395 * rtx-pseudo-cumack has been received */
396 uint8_t window_probe; /* Doing a window probe? */
397 uint8_t RTO_measured; /* Have we done the first measure */
398 uint8_t last_hs_used; /* index into the last HS table entry we used */
405 struct sctp_data_chunkrec {
406 uint32_t tsn; /* the TSN of this transmit */
407 uint32_t mid; /* the message identifier of this transmit */
408 uint16_t sid; /* the stream number of this guy */
410 uint32_t context; /* from send */
411 uint32_t cwnd_at_send;
413 * part of the Highest sacked algorithm to be able to stroke counts
414 * on ones that are FR'd.
416 uint32_t fast_retran_tsn; /* sending_seq at the time of FR */
417 struct timeval timetodrop; /* time we drop it from queue */
418 uint32_t fsn; /* Fragment Sequence Number */
419 uint8_t doing_fast_retransmit;
420 uint8_t rcv_flags; /* flags pulled from data chunk on inbound for
421 * outbound holds sending flags for PR-SCTP. */
423 uint8_t chunk_was_revoked;
427 TAILQ_HEAD(sctpchunk_listhead, sctp_tmit_chunk);
429 /* The lower byte is used to enumerate PR_SCTP policies */
430 #define CHUNK_FLAGS_PR_SCTP_TTL SCTP_PR_SCTP_TTL
431 #define CHUNK_FLAGS_PR_SCTP_BUF SCTP_PR_SCTP_BUF
432 #define CHUNK_FLAGS_PR_SCTP_RTX SCTP_PR_SCTP_RTX
434 /* The upper byte is used as a bit mask */
435 #define CHUNK_FLAGS_FRAGMENT_OK 0x0100
439 uint8_t can_take_data;
442 struct sctp_tmit_chunk {
444 struct sctp_data_chunkrec data;
445 struct chk_id chunk_id;
447 struct sctp_association *asoc; /* bp to asoc this belongs to */
448 struct timeval sent_rcv_time; /* filled in if RTT being calculated */
449 struct mbuf *data; /* pointer to mbuf chain of data */
450 struct mbuf *last_mbuf; /* pointer to last mbuf in chain */
451 struct sctp_nets *whoTo;
452 TAILQ_ENTRY(sctp_tmit_chunk) sctp_next; /* next link */
453 int32_t sent; /* the send status */
454 uint16_t snd_count; /* number of times I sent */
455 uint16_t flags; /* flags, such as FRAGMENT_OK */
460 uint8_t holds_key_ref; /* flag if auth keyid refcount is held */
463 uint8_t book_size_scale;
464 uint8_t no_fr_allowed;
466 uint8_t window_probe;
469 struct sctp_queued_to_read { /* sinfo structure Pluse more */
470 uint16_t sinfo_stream; /* off the wire */
471 uint16_t sinfo_flags; /* SCTP_UNORDERED from wire use SCTP_EOF for
473 uint32_t sinfo_ppid; /* off the wire */
474 uint32_t sinfo_context; /* pick this up from assoc def context? */
475 uint32_t sinfo_timetolive; /* not used by kernel */
476 uint32_t sinfo_tsn; /* Use this in reassembly as first TSN */
477 uint32_t sinfo_cumtsn; /* Use this in reassembly as last TSN */
478 sctp_assoc_t sinfo_assoc_id; /* our assoc id */
479 /* Non sinfo stuff */
480 uint32_t mid; /* Fragment Index */
481 uint32_t length; /* length of data */
482 uint32_t held_length; /* length held in sb */
483 uint32_t top_fsn; /* Highest FSN in queue */
484 uint32_t fsn_included; /* Highest FSN in *data portion */
485 struct sctp_nets *whoFrom; /* where it came from */
486 struct mbuf *data; /* front of the mbuf chain of data with
488 struct mbuf *tail_mbuf; /* used for multi-part data */
489 struct mbuf *aux_data; /* used to hold/cache control if o/s does not
491 struct sctp_tcb *stcb; /* assoc, used for window update */
492 TAILQ_ENTRY(sctp_queued_to_read) next;
493 TAILQ_ENTRY(sctp_queued_to_read) next_instrm;
494 struct sctpchunk_listhead reasm;
496 uint16_t spec_flags; /* Flags to hold the notification field */
497 uint8_t do_not_ref_stcb;
499 uint8_t pdapi_aborted;
500 uint8_t pdapi_started;
502 uint8_t last_frag_seen;
503 uint8_t first_frag_seen;
508 #define SCTP_ON_ORDERED 1
509 #define SCTP_ON_UNORDERED 2
511 /* This data structure will be on the outbound
512 * stream queues. Data will be pulled off from
513 * the front of the mbuf data and chunk-ified
514 * by the output routines. We will custom
515 * fit every chunk we pull to the send/sent
516 * queue to make up the next full packet
517 * if we can. An entry cannot be removed
518 * from the stream_out queue until
519 * the msg_is_complete flag is set. This
520 * means at times data/tail_mbuf MIGHT
521 * be NULL.. If that occurs it happens
522 * for one of two reasons. Either the user
523 * is blocked on a send() call and has not
524 * awoken to copy more data down... OR
525 * the user is in the explict MSG_EOR mode
526 * and wrote some data, but has not completed
528 * ss_next and scheduled are only used by the FCFS stream scheduler.
530 struct sctp_stream_queue_pending {
532 struct mbuf *tail_mbuf;
534 struct sctp_nets *net;
535 TAILQ_ENTRY(sctp_stream_queue_pending) next;
536 TAILQ_ENTRY(sctp_stream_queue_pending) ss_next;
542 uint16_t sinfo_flags;
546 uint8_t holds_key_ref;
547 uint8_t msg_is_complete;
549 uint8_t sender_all_done;
550 uint8_t put_last_out;
551 uint8_t discard_rest;
557 * this struct contains info that is used to track inbound stream data and
558 * help with ordering.
560 TAILQ_HEAD(sctpwheelunrel_listhead, sctp_stream_in);
561 struct sctp_stream_in {
562 struct sctp_readhead inqueue;
563 struct sctp_readhead uno_inqueue;
564 uint32_t last_mid_delivered; /* used for re-order */
566 uint8_t delivery_started;
567 uint8_t pd_api_started;
570 TAILQ_HEAD(sctpwheel_listhead, sctp_stream_out);
571 TAILQ_HEAD(sctplist_listhead, sctp_stream_queue_pending);
574 * This union holds all data necessary for
575 * different stream schedulers.
577 struct scheduling_data {
578 struct sctp_stream_out *locked_on_sending;
579 /* circular looking for output selection */
580 struct sctp_stream_out *last_out_stream;
582 struct sctpwheel_listhead wheel;
583 struct sctplist_listhead list;
587 /* Round-robin schedulers */
589 /* next link in wheel */
590 TAILQ_ENTRY(sctp_stream_out) next_spoke;
593 /* Priority scheduler */
595 /* next link in wheel */
596 TAILQ_ENTRY(sctp_stream_out) next_spoke;
601 /* Fair Bandwidth scheduler */
603 /* next link in wheel */
604 TAILQ_ENTRY(sctp_stream_out) next_spoke;
605 /* stores message size */
610 * This union holds all parameters per stream
611 * necessary for different stream schedulers.
613 struct scheduling_parameters {
622 /* States for outgoing streams */
623 #define SCTP_STREAM_CLOSED 0x00
624 #define SCTP_STREAM_OPENING 0x01
625 #define SCTP_STREAM_OPEN 0x02
626 #define SCTP_STREAM_RESET_PENDING 0x03
627 #define SCTP_STREAM_RESET_IN_FLIGHT 0x04
629 /* This struct is used to track the traffic on outbound streams */
630 struct sctp_stream_out {
631 struct sctp_streamhead outqueue;
632 struct scheduling_parameters ss_params;
633 uint32_t chunks_on_queues; /* send queue and sent queue */
634 #if defined(SCTP_DETAILED_STR_STATS)
635 uint32_t abandoned_unsent[SCTP_PR_SCTP_MAX + 1];
636 uint32_t abandoned_sent[SCTP_PR_SCTP_MAX + 1];
638 /* Only the aggregation */
639 uint32_t abandoned_unsent[1];
640 uint32_t abandoned_sent[1];
643 * For associations using DATA chunks, the lower 16-bit of
644 * next_mid_ordered are used as the next SSN.
646 uint32_t next_mid_ordered;
647 uint32_t next_mid_unordered;
649 uint8_t last_msg_incomplete;
653 #define SCTP_MAX_STREAMS_AT_ONCE_RESET 200
655 /* used to keep track of the addresses yet to try to add/delete */
656 TAILQ_HEAD(sctp_asconf_addrhead, sctp_asconf_addr);
657 struct sctp_asconf_addr {
658 TAILQ_ENTRY(sctp_asconf_addr) next;
659 struct sctp_asconf_addr_param ap;
660 struct sctp_ifa *ifa; /* save the ifa for add/del ip */
661 uint8_t sent; /* has this been sent yet? */
662 uint8_t special_del; /* not to be used in lookup */
665 struct sctp_scoping {
666 uint8_t ipv4_addr_legal;
667 uint8_t ipv6_addr_legal;
668 uint8_t loopback_scope;
669 uint8_t ipv4_local_scope;
674 #define SCTP_TSN_LOG_SIZE 40
676 struct sctp_tsn_log {
688 #define SCTP_FS_SPEC_LOG_SIZE 200
689 struct sctp_fs_spec_log {
691 uint32_t total_flight;
699 * JRS - Structure to hold function pointers to the functions responsible
700 * for congestion control.
703 struct sctp_cc_functions {
704 void (*sctp_set_initial_cc_param) (struct sctp_tcb *stcb, struct sctp_nets *net);
705 void (*sctp_cwnd_update_after_sack) (struct sctp_tcb *stcb,
706 struct sctp_association *asoc,
707 int accum_moved, int reneged_all, int will_exit);
708 void (*sctp_cwnd_update_exit_pf) (struct sctp_tcb *stcb, struct sctp_nets *net);
709 void (*sctp_cwnd_update_after_fr) (struct sctp_tcb *stcb,
710 struct sctp_association *asoc);
711 void (*sctp_cwnd_update_after_timeout) (struct sctp_tcb *stcb,
712 struct sctp_nets *net);
713 void (*sctp_cwnd_update_after_ecn_echo) (struct sctp_tcb *stcb,
714 struct sctp_nets *net, int in_window, int num_pkt_lost);
715 void (*sctp_cwnd_update_after_packet_dropped) (struct sctp_tcb *stcb,
716 struct sctp_nets *net, struct sctp_pktdrop_chunk *cp,
717 uint32_t *bottle_bw, uint32_t *on_queue);
718 void (*sctp_cwnd_update_after_output) (struct sctp_tcb *stcb,
719 struct sctp_nets *net, int burst_limit);
720 void (*sctp_cwnd_update_packet_transmitted) (struct sctp_tcb *stcb,
721 struct sctp_nets *net);
722 void (*sctp_cwnd_update_tsn_acknowledged) (struct sctp_nets *net,
723 struct sctp_tmit_chunk *);
724 void (*sctp_cwnd_new_transmission_begins) (struct sctp_tcb *stcb,
725 struct sctp_nets *net);
726 void (*sctp_cwnd_prepare_net_for_sack) (struct sctp_tcb *stcb,
727 struct sctp_nets *net);
728 int (*sctp_cwnd_socket_option) (struct sctp_tcb *stcb, int set, struct sctp_cc_option *);
729 void (*sctp_rtt_calculated) (struct sctp_tcb *, struct sctp_nets *, struct timeval *);
733 * RS - Structure to hold function pointers to the functions responsible
734 * for stream scheduling.
736 struct sctp_ss_functions {
737 void (*sctp_ss_init) (struct sctp_tcb *stcb, struct sctp_association *asoc);
738 void (*sctp_ss_clear) (struct sctp_tcb *stcb, struct sctp_association *asoc,
740 void (*sctp_ss_init_stream) (struct sctp_tcb *stcb, struct sctp_stream_out *strq, struct sctp_stream_out *with_strq);
741 void (*sctp_ss_add_to_stream) (struct sctp_tcb *stcb, struct sctp_association *asoc,
742 struct sctp_stream_out *strq, struct sctp_stream_queue_pending *sp);
743 bool (*sctp_ss_is_empty) (struct sctp_tcb *stcb, struct sctp_association *asoc);
744 void (*sctp_ss_remove_from_stream) (struct sctp_tcb *stcb, struct sctp_association *asoc,
745 struct sctp_stream_out *strq, struct sctp_stream_queue_pending *sp);
746 struct sctp_stream_out *(*sctp_ss_select_stream) (struct sctp_tcb *stcb,
747 struct sctp_nets *net, struct sctp_association *asoc);
748 void (*sctp_ss_scheduled) (struct sctp_tcb *stcb, struct sctp_nets *net,
749 struct sctp_association *asoc, struct sctp_stream_out *strq, int moved_how_much);
750 void (*sctp_ss_packet_done) (struct sctp_tcb *stcb, struct sctp_nets *net,
751 struct sctp_association *asoc);
752 int (*sctp_ss_get_value) (struct sctp_tcb *stcb, struct sctp_association *asoc,
753 struct sctp_stream_out *strq, uint16_t *value);
754 int (*sctp_ss_set_value) (struct sctp_tcb *stcb, struct sctp_association *asoc,
755 struct sctp_stream_out *strq, uint16_t value);
756 bool (*sctp_ss_is_user_msgs_incomplete) (struct sctp_tcb *stcb, struct sctp_association *asoc);
759 /* used to save ASCONF chunks for retransmission */
760 TAILQ_HEAD(sctp_asconf_head, sctp_asconf);
762 TAILQ_ENTRY(sctp_asconf) next;
763 uint32_t serial_number;
769 /* used to save ASCONF-ACK chunks for retransmission */
770 TAILQ_HEAD(sctp_asconf_ackhead, sctp_asconf_ack);
771 struct sctp_asconf_ack {
772 TAILQ_ENTRY(sctp_asconf_ack) next;
773 uint32_t serial_number;
774 struct sctp_nets *last_sent_to;
780 * Here we have information about each individual association that we track.
781 * We probably in production would be more dynamic. But for ease of
782 * implementation we will have a fixed array that we hunt for in a linear
785 struct sctp_association {
786 /* association state */
789 /* queue of pending addrs to add/delete */
790 struct sctp_asconf_addrhead asconf_queue;
792 struct timeval time_entered; /* time we entered state */
793 struct timeval time_last_rcvd;
794 struct timeval time_last_sent;
795 struct timeval time_last_sat_advance;
796 struct sctp_nonpad_sndrcvinfo def_send;
798 /* timers and such */
799 struct sctp_timer dack_timer; /* Delayed ack timer */
800 struct sctp_timer asconf_timer; /* asconf */
801 struct sctp_timer strreset_timer; /* stream reset */
802 struct sctp_timer shut_guard_timer; /* shutdown guard */
803 struct sctp_timer autoclose_timer; /* automatic close timer */
804 struct sctp_timer delete_prim_timer; /* deleting primary dst */
806 /* list of restricted local addresses */
807 struct sctpladdr sctp_restricted_addrs;
809 /* last local address pending deletion (waiting for an address add) */
810 struct sctp_ifa *asconf_addr_del_pending;
811 /* Deleted primary destination (used to stop timer) */
812 struct sctp_nets *deleted_primary;
814 struct sctpnetlisthead nets; /* remote address list */
816 /* Free chunk list */
817 struct sctpchunk_listhead free_chunks;
819 /* Control chunk queue */
820 struct sctpchunk_listhead control_send_queue;
822 /* ASCONF chunk queue */
823 struct sctpchunk_listhead asconf_send_queue;
826 * Once a TSN hits the wire it is moved to the sent_queue. We
827 * maintain two counts here (don't know if any but retran_cnt is
828 * needed). The idea is that the sent_queue_retran_cnt reflects how
829 * many chunks have been marked for retranmission by either T3-rxt
832 struct sctpchunk_listhead sent_queue;
833 struct sctpchunk_listhead send_queue;
835 /* Scheduling queues */
836 struct scheduling_data ss_data;
838 /* If an iterator is looking at me, this is it */
839 struct sctp_iterator *stcb_starting_point_for_iterator;
841 /* ASCONF save the last ASCONF-ACK so we can resend it if necessary */
842 struct sctp_asconf_ackhead asconf_ack_sent;
845 * pointer to last stream reset queued to control queue by us with
848 struct sctp_tmit_chunk *str_reset;
850 * if Source Address Selection happening, this will rotate through
853 struct sctp_laddr *last_used_address;
856 struct sctp_stream_in *strmin;
857 struct sctp_stream_out *strmout;
858 uint8_t *mapping_array;
859 /* primary destination to use */
860 struct sctp_nets *primary_destination;
861 struct sctp_nets *alternate; /* If primary is down or PF */
863 struct sctp_nets *last_net_cmt_send_started;
864 /* last place I got a data chunk from */
865 struct sctp_nets *last_data_chunk_from;
866 /* last place I got a control from */
867 struct sctp_nets *last_control_chunk_from;
870 * wait to the point the cum-ack passes req->send_reset_at_tsn for
871 * any req on the list.
873 struct sctp_resethead resetHead;
875 /* queue of chunks waiting to be sent into the local stack */
876 struct sctp_readhead pending_reply_queue;
878 /* JRS - the congestion control functions are in this struct */
879 struct sctp_cc_functions cc_functions;
881 * JRS - value to store the currently loaded congestion control
884 uint32_t congestion_control_module;
885 /* RS - the stream scheduling functions are in this struct */
886 struct sctp_ss_functions ss_functions;
887 /* RS - value to store the currently loaded stream scheduling module */
888 uint32_t stream_scheduling_module;
891 uint32_t cookie_preserve_req;
892 /* ASCONF next seq I am sending out, inits at init-tsn */
893 uint32_t asconf_seq_out;
894 uint32_t asconf_seq_out_acked;
895 /* ASCONF last received ASCONF from peer, starts at peer's TSN-1 */
896 uint32_t asconf_seq_in;
898 /* next seq I am sending in str reset messages */
899 uint32_t str_reset_seq_out;
900 /* next seq I am expecting in str reset messages */
901 uint32_t str_reset_seq_in;
903 /* various verification tag information */
904 uint32_t my_vtag; /* The tag to be used. if assoc is re-initited
905 * by remote end, and I have unlocked this
906 * will be regenerated to a new random value. */
907 uint32_t peer_vtag; /* The peers last tag */
909 uint32_t my_vtag_nonce;
910 uint32_t peer_vtag_nonce;
914 /* This is the SCTP fragmentation threshold */
915 uint32_t smallest_mtu;
918 * Special hook for Fast retransmit, allows us to track the highest
919 * TSN that is NEW in this SACK if gap ack blocks are present.
921 uint32_t this_sack_highest_gap;
924 * The highest consecutive TSN that has been acked by peer on my
927 uint32_t last_acked_seq;
929 /* The next TSN that I will use in sending. */
930 uint32_t sending_seq;
932 /* Original seq number I used ??questionable to keep?? */
933 uint32_t init_seq_number;
935 /* The Advanced Peer Ack Point, as required by the PR-SCTP */
936 /* (A1 in Section 4.2) */
937 uint32_t advanced_peer_ack_point;
940 * The highest consequetive TSN at the bottom of the mapping array
943 uint32_t cumulative_tsn;
945 * Used to track the mapping array and its offset bits. This MAY be
946 * lower then cumulative_tsn.
948 uint32_t mapping_array_base_tsn;
950 * used to track highest TSN we have received and is listed in the
953 uint32_t highest_tsn_inside_map;
955 /* EY - new NR variables used for nr_sack based on mapping_array */
956 uint8_t *nr_mapping_array;
957 uint32_t highest_tsn_inside_nr_map;
959 uint32_t fast_recovery_tsn;
960 uint32_t sat_t3_recovery_tsn;
961 uint32_t tsn_last_delivered;
963 * For the pd-api we should re-write this a bit more efficient. We
964 * could have multiple sctp_queued_to_read's that we are building at
965 * once. Now we only do this when we get ready to deliver to the
966 * socket buffer. Note that we depend on the fact that the struct is
967 * "stuck" on the read queue until we finish all the pd-api.
969 struct sctp_queued_to_read *control_pdapi;
971 uint32_t tsn_of_pdapi_last_delivered;
974 uint32_t last_reset_action[SCTP_MAX_RESET_PARAMS];
975 uint32_t last_sending_seq[SCTP_MAX_RESET_PARAMS];
976 uint32_t last_base_tsnsent[SCTP_MAX_RESET_PARAMS];
977 #ifdef SCTP_ASOCLOG_OF_TSNS
979 * special log - This adds considerable size to the asoc, but
980 * provides a log that you can use to detect problems via kgdb.
982 struct sctp_tsn_log in_tsnlog[SCTP_TSN_LOG_SIZE];
983 struct sctp_tsn_log out_tsnlog[SCTP_TSN_LOG_SIZE];
984 uint32_t cumack_log[SCTP_TSN_LOG_SIZE];
985 uint32_t cumack_logsnt[SCTP_TSN_LOG_SIZE];
988 uint16_t tsn_in_wrapped;
989 uint16_t tsn_out_wrapped;
990 uint16_t cumack_log_at;
991 uint16_t cumack_log_atsnt;
992 #endif /* SCTP_ASOCLOG_OF_TSNS */
993 #ifdef SCTP_FS_SPEC_LOG
994 struct sctp_fs_spec_log fslog[SCTP_FS_SPEC_LOG_SIZE];
999 * window state information and smallest MTU that I use to bound
1002 uint32_t peers_rwnd;
1004 uint32_t my_last_reported_rwnd;
1005 uint32_t sctp_frag_point;
1007 uint32_t total_output_queue_size;
1009 uint32_t sb_cc; /* shadow of sb_cc */
1010 uint32_t sb_send_resv; /* amount reserved on a send */
1011 uint32_t my_rwnd_control_len; /* shadow of sb_mbcnt used for rwnd
1014 uint32_t default_flowlabel;
1016 uint32_t pr_sctp_cnt;
1017 int ctrl_queue_cnt; /* could be removed REM - NO IT CAN'T!! RRS */
1019 * All outbound datagrams queue into this list from the individual
1020 * stream queue. Here they get assigned a TSN and then await
1021 * sending. The stream seq comes when it is first put in the
1022 * individual str queue
1024 unsigned int stream_queue_cnt;
1025 unsigned int send_queue_cnt;
1026 unsigned int sent_queue_cnt;
1027 unsigned int sent_queue_cnt_removeable;
1029 * Number on sent queue that are marked for retran until this value
1030 * is 0 we only send one packet of retran'ed data.
1032 unsigned int sent_queue_retran_cnt;
1034 unsigned int size_on_reasm_queue;
1035 unsigned int cnt_on_reasm_queue;
1036 unsigned int fwd_tsn_cnt;
1037 /* amount of data (bytes) currently in flight (on all destinations) */
1038 unsigned int total_flight;
1039 /* Total book size in flight */
1040 unsigned int total_flight_count; /* count of chunks used with
1042 /* count of destinaton nets and list of destination nets */
1043 unsigned int numnets;
1045 /* Total error count on this association */
1046 unsigned int overall_error_count;
1048 unsigned int cnt_msg_on_sb;
1050 /* All stream count of chunks for delivery */
1051 unsigned int size_on_all_streams;
1052 unsigned int cnt_on_all_streams;
1054 /* Heart Beat delay in ms */
1055 uint32_t heart_beat_delay;
1058 uint32_t sctp_autoclose_ticks;
1060 /* how many preopen streams we have */
1061 unsigned int pre_open_streams;
1063 /* How many streams I support coming into me */
1064 unsigned int max_inbound_streams;
1066 /* the cookie life I award for any cookie, in seconds */
1067 uint32_t cookie_life;
1068 /* time to delay acks for */
1069 unsigned int delayed_ack;
1070 unsigned int old_delayed_ack;
1071 unsigned int sack_freq;
1072 unsigned int data_pkts_seen;
1074 unsigned int numduptsns;
1075 int dup_tsns[SCTP_MAX_DUP_TSNS];
1076 uint32_t initial_init_rto_max; /* initial RTO for INIT's */
1077 uint32_t initial_rto; /* initial send RTO */
1078 uint32_t minrto; /* per assoc RTO-MIN */
1079 uint32_t maxrto; /* per assoc RTO-MAX */
1081 /* authentication fields */
1082 sctp_auth_chklist_t *local_auth_chunks;
1083 sctp_auth_chklist_t *peer_auth_chunks;
1084 sctp_hmaclist_t *local_hmacs; /* local HMACs supported */
1085 sctp_hmaclist_t *peer_hmacs; /* peer HMACs supported */
1086 struct sctp_keyhead shared_keys; /* assoc's shared keys */
1087 sctp_authinfo_t authinfo; /* randoms, cached keys */
1089 * refcnt to block freeing when a sender or receiver is off coping
1093 uint32_t chunks_on_out_queue; /* total chunks floating around,
1094 * locked by send socket buffer */
1095 uint32_t peers_adaptation;
1096 uint32_t default_mtu;
1097 uint16_t peer_hmac_id; /* peer HMAC id to send */
1100 * Being that we have no bag to collect stale cookies, and that we
1101 * really would not want to anyway.. we will count them in this
1102 * counter. We of course feed them to the pigeons right away (I have
1103 * always thought of pigeons as flying rats).
1105 uint16_t stale_cookie_count;
1108 * For the partial delivery API, if up, invoked this is what last
1111 uint16_t str_of_pdapi;
1112 uint16_t ssn_of_pdapi;
1114 /* counts of actual built streams. Allocation may be more however */
1115 /* could re-arrange to optimize space here. */
1116 uint16_t streamincnt;
1117 uint16_t streamoutcnt;
1118 uint16_t strm_realoutsize;
1119 uint16_t strm_pending_add_size;
1120 /* my maximum number of retrans of INIT and SEND */
1121 /* copied from SCTP but should be individually setable */
1122 uint16_t max_init_times;
1123 uint16_t max_send_times;
1125 uint16_t def_net_failure;
1127 uint16_t def_net_pf_threshold;
1130 * lock flag: 0 is ok to send, 1+ (duals as a retran count) is
1133 uint16_t mapping_array_size;
1135 uint16_t last_strm_seq_delivered;
1136 uint16_t last_strm_no_delivered;
1138 uint16_t last_revoke_count;
1139 int16_t num_send_timers_up;
1141 uint16_t stream_locked_on;
1142 uint16_t ecn_echo_cnt_onq;
1144 uint16_t free_chunk_cnt;
1145 uint8_t stream_locked;
1146 uint8_t authenticated; /* packet authenticated ok */
1148 * This flag indicates that a SACK need to be sent. Initially this
1149 * is 1 to send the first sACK immediately.
1153 /* max burst of new packets into the network */
1155 /* max burst of fast retransmit packets */
1156 uint32_t fr_max_burst;
1158 uint8_t sat_network; /* RTT is in range of sat net or greater */
1159 uint8_t sat_network_lockout; /* lockout code */
1160 uint8_t burst_limit_applied; /* Burst limit in effect at last send? */
1161 /* flag goes on when we are doing a partial delivery api */
1162 uint8_t hb_random_values[4];
1163 uint8_t fragmented_delivery_inprogress;
1164 uint8_t fragment_flags;
1165 uint8_t last_flags_delivered;
1166 uint8_t hb_ect_randombit;
1167 uint8_t hb_random_idx;
1168 uint8_t default_dscp;
1169 uint8_t asconf_del_pending; /* asconf delete last addr pending */
1170 uint8_t trigger_reset;
1172 * This value, plus all other ack'd but above cum-ack is added
1173 * together to cross check against the bit that we have yet to
1174 * define (probably in the SACK). When the cum-ack is updated, this
1175 * sum is updated as well.
1178 /* Flags whether an extension is supported or not */
1179 uint8_t ecn_supported;
1180 uint8_t prsctp_supported;
1181 uint8_t auth_supported;
1182 uint8_t asconf_supported;
1183 uint8_t reconfig_supported;
1184 uint8_t nrsack_supported;
1185 uint8_t pktdrop_supported;
1186 uint8_t idata_supported;
1188 /* Did the peer make the stream config (add out) request */
1189 uint8_t peer_req_out;
1191 uint8_t local_strreset_support;
1192 uint8_t peer_supports_nat;
1194 struct sctp_scoping scope;
1195 /* flags to handle send alternate net tracking */
1196 uint8_t used_alt_asconfack;
1197 uint8_t fast_retran_loss_recovery;
1198 uint8_t sat_t3_loss_recovery;
1199 uint8_t dropped_special_cnt;
1200 uint8_t seen_a_sack_this_pkt;
1201 uint8_t stream_reset_outstanding;
1202 uint8_t stream_reset_out_is_outstanding;
1203 uint8_t delayed_connection;
1204 uint8_t ifp_had_enobuf;
1205 uint8_t saw_sack_with_frags;
1206 uint8_t saw_sack_with_nr_frags;
1207 uint8_t in_asocid_hash;
1208 uint8_t assoc_up_sent;
1209 uint8_t adaptation_needed;
1210 uint8_t adaptation_sent;
1212 uint8_t cmt_dac_pkts_rcvd;
1213 uint8_t sctp_cmt_on_off;
1214 uint8_t iam_blocking;
1215 uint8_t cookie_how[8];
1216 /* JRS 5/21/07 - CMT PF variable */
1217 uint8_t sctp_cmt_pf;
1218 uint8_t use_precise_time;
1219 uint64_t sctp_features;
1221 uint16_t port; /* remote UDP encapsulation port */
1223 * The mapping array is used to track out of order sequences above
1224 * last_acked_seq. 0 indicates packet missing 1 indicates packet
1225 * rec'd. We slide it up every time we raise last_acked_seq and 0
1226 * trailing locactions out. If I get a TSN above the array
1227 * mappingArraySz, I discard the datagram and let retransmit happen.
1229 uint32_t marked_retrans;
1233 uint32_t timoshutdown;
1234 uint32_t timoheartbeat;
1235 uint32_t timocookie;
1236 uint32_t timoshutdownack;
1237 struct timeval start_time;
1238 struct timeval discontinuity_time;
1239 uint64_t abandoned_unsent[SCTP_PR_SCTP_MAX + 1];
1240 uint64_t abandoned_sent[SCTP_PR_SCTP_MAX + 1];