2 * Copyright (c) 2001-2008, by Cisco Systems, Inc. All rights reserved.
3 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
4 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * a) Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
12 * b) Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the distribution.
16 * c) Neither the name of Cisco Systems, Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGE.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #ifndef _NETINET_SCTP_STRUCTS_H_
37 #define _NETINET_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 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(__FreeBSD__) && 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;
135 struct sctp_iterator {
136 TAILQ_ENTRY(sctp_iterator) sctp_nxt_itr;
138 struct sctp_timer tmr;
139 struct sctp_inpcb *inp; /* current endpoint */
140 struct sctp_tcb *stcb; /* current* assoc */
141 struct sctp_inpcb *next_inp; /* special hook to skip to */
142 asoc_func function_assoc; /* per assoc function */
143 inp_func function_inp; /* per endpoint function */
144 inp_func function_inp_end; /* end INP function */
145 end_func function_atend;/* iterator completion function */
146 void *pointer; /* pointer for apply func to use */
147 uint32_t val; /* value for apply func to use */
148 uint32_t pcb_flags; /* endpoint flags being checked */
149 uint32_t pcb_features; /* endpoint features being checked */
150 uint32_t asoc_state; /* assoc state being checked */
151 uint32_t iterator_flags;
152 uint8_t no_chunk_output;
153 uint8_t done_current_ep;
156 /* iterator_flags values */
157 #define SCTP_ITERATOR_DO_ALL_INP 0x00000001
158 #define SCTP_ITERATOR_DO_SINGLE_INP 0x00000002
161 TAILQ_HEAD(sctpiterators, sctp_iterator);
163 struct sctp_copy_all {
164 struct sctp_inpcb *inp; /* ep */
166 struct sctp_sndrcvinfo sndrcv;
172 struct sctp_asconf_iterator {
173 struct sctpladdr list_of_work;
177 struct iterator_control {
178 struct mtx ipi_iterator_wq_mtx;
180 SCTP_PROCESS_STRUCT thread_proc;
181 struct sctpiterators iteratorhead;
182 struct sctp_iterator *cur_it;
183 uint32_t iterator_running;
184 uint32_t iterator_flags;
187 #define SCTP_ITERATOR_STOP_CUR_IT 0x00000004
188 #define SCTP_ITERATOR_STOP_CUR_INP 0x00000008
190 struct sctp_net_route {
191 sctp_rtentry_t *ro_rt;
195 union sctp_sockstore _l_addr; /* remote peer addr */
196 struct sctp_ifa *_s_addr; /* our selected src addr */
200 uint16_t alpha; /* Fixed point arith, << 7 */
201 uint8_t beta; /* Fixed point arith, << 7 */
202 uint8_t modeswitch; /* Delay modeswitch until we had at least one
203 * congestion event */
204 uint32_t last_cong; /* Time since last congestion event end */
205 uint32_t undo_last_cong;
206 uint16_t bytes_acked;
211 uint32_t undo_maxRTT;
212 uint32_t undo_old_maxB;
214 /* Bandwidth estimation */
223 struct timeval tls; /* The time we started the sending */
224 uint64_t lbw; /* Our last estimated bw */
225 uint64_t lbw_rtt; /* RTT at bw estimate */
226 uint64_t bw_bytes; /* The total bytes since this sending began */
227 uint64_t bw_tot_time; /* The total time since sending began */
228 uint64_t new_tot_time; /* temp holding the new value */
229 uint64_t bw_bytes_at_last_rttc; /* What bw_bytes was at last rtt calc */
230 uint32_t cwnd_at_bw_set;/* Cwnd at last bw saved - lbw */
231 uint32_t vol_reduce; /* cnt of voluntary reductions */
232 uint16_t steady_step; /* The number required to be in steady state */
233 uint16_t step_cnt; /* The current number */
234 uint8_t ret_from_eq; /* When all things are equal what do I return
235 * 0/1 - 1 no cc advance */
236 uint8_t use_dccc_ecn; /* Flag to enable DCCC ECN */
237 uint8_t tls_needs_set; /* Flag to indicate we need to set tls 0 or 1
238 * means set at send 2 not */
239 uint8_t last_step_state;/* Last state if steady state stepdown is on */
240 uint8_t rtt_set_this_sack; /* Flag saying this sack had RTT calc
242 uint8_t last_inst_ind; /* Last saved inst indication */
247 TAILQ_ENTRY(sctp_nets) sctp_next; /* next link */
250 * Things on the top half may be able to be split into a common
251 * structure shared by all.
253 struct sctp_timer pmtu_timer;
254 struct sctp_timer hb_timer;
257 * The following two in combination equate to a route entry for v6
260 struct sctp_net_route ro;
262 /* mtu discovered so far */
264 uint32_t ssthresh; /* not sure about this one for split */
265 uint32_t last_cwr_tsn;
266 uint32_t cwr_window_tsn;
267 uint32_t ecn_ce_pkt_cnt;
269 /* smoothed average things for RTT and RTO itself */
272 uint64_t rtt; /* last measured rtt value in us */
275 /* This is used for SHUTDOWN/SHUTDOWN-ACK/SEND or INIT timers */
276 struct sctp_timer rxt_timer;
278 /* last time in seconds I sent to it */
279 struct timeval last_sent_time;
280 union cc_control_data {
281 struct htcp htcp_ca; /* JRS - struct used in HTCP algorithm */
282 struct rtcc_cc rtcc; /* rtcc module cc stuff */
286 /* Congestion stats per destination */
288 * flight size variables and such, sorry Vern, I could not avoid
289 * this if I wanted performance :>
291 uint32_t flight_size;
292 uint32_t cwnd; /* actual cwnd */
293 uint32_t prev_cwnd; /* cwnd before any processing */
294 uint32_t ecn_prev_cwnd; /* ECN prev cwnd at first ecn_echo seen in new
296 uint32_t partial_bytes_acked; /* in CA tracks when to incr a MTU */
297 /* tracking variables to avoid the aloc/free in sack processing */
298 unsigned int net_ack;
299 unsigned int net_ack2;
302 * JRS - 5/8/07 - Variable to track last time a destination was
305 uint32_t last_active;
308 * CMT variables (iyengar@cis.udel.edu)
310 uint32_t this_sack_highest_newack; /* tracks highest TSN newly
311 * acked for a given dest in
312 * the current SACK. Used in
313 * SFR and HTNA algos */
314 uint32_t pseudo_cumack; /* CMT CUC algorithm. Maintains next expected
315 * pseudo-cumack for this destination */
316 uint32_t rtx_pseudo_cumack; /* CMT CUC algorithm. Maintains next
317 * expected pseudo-cumack for this
320 /* CMT fast recovery variables */
321 uint32_t fast_recovery_tsn;
322 uint32_t heartbeat_random1;
323 uint32_t heartbeat_random2;
329 struct timeval start_time; /* time when this net was created */
330 uint32_t marked_retrans;/* number or DATA chunks marked for timer
331 * based retransmissions */
332 uint32_t marked_fastretrans;
333 uint32_t heart_beat_delay; /* Heart Beat delay in ms */
335 /* if this guy is ok or not ... status */
337 /* number of timeouts to consider the destination unreachable */
338 uint16_t failure_threshold;
339 /* number of timeouts to consider the destination potentially failed */
340 uint16_t pf_threshold;
341 /* error stats on the destination */
342 uint16_t error_count;
343 /* UDP port number in case of UDP tunneling */
346 uint8_t fast_retran_loss_recovery;
347 uint8_t will_exit_fast_recovery;
348 /* Flags that probably can be combined into dest_state */
349 uint8_t fast_retran_ip; /* fast retransmit in progress */
350 uint8_t hb_responded;
351 uint8_t saw_newack; /* CMT's SFR algorithm flag */
352 uint8_t src_addr_selected; /* if we split we move */
353 uint8_t indx_of_eligible_next_to_use;
354 uint8_t addr_is_local; /* its a local address (if known) could move
358 * CMT variables (iyengar@cis.udel.edu)
360 uint8_t find_pseudo_cumack; /* CMT CUC algorithm. Flag used to
361 * find a new pseudocumack. This flag
362 * is set after a new pseudo-cumack
363 * has been received and indicates
364 * that the sender should find the
365 * next pseudo-cumack expected for
366 * this destination */
367 uint8_t find_rtx_pseudo_cumack; /* CMT CUCv2 algorithm. Flag used to
368 * find a new rtx-pseudocumack. This
369 * flag is set after a new
370 * rtx-pseudo-cumack has been received
371 * and indicates that the sender
372 * should find the next
373 * rtx-pseudo-cumack expected for this
375 uint8_t new_pseudo_cumack; /* CMT CUC algorithm. Flag used to
376 * indicate if a new pseudo-cumack or
377 * rtx-pseudo-cumack has been received */
378 uint8_t window_probe; /* Doing a window probe? */
379 uint8_t RTO_measured; /* Have we done the first measure */
380 uint8_t last_hs_used; /* index into the last HS table entry we used */
388 struct sctp_data_chunkrec {
389 uint32_t TSN_seq; /* the TSN of this transmit */
390 uint16_t stream_seq; /* the stream sequence number of this transmit */
391 uint16_t stream_number; /* the stream number of this guy */
392 uint32_t payloadtype;
393 uint32_t context; /* from send */
394 uint32_t cwnd_at_send;
396 * part of the Highest sacked algorithm to be able to stroke counts
397 * on ones that are FR'd.
399 uint32_t fast_retran_tsn; /* sending_seq at the time of FR */
400 struct timeval timetodrop; /* time we drop it from queue */
401 uint8_t doing_fast_retransmit;
402 uint8_t rcv_flags; /* flags pulled from data chunk on inbound for
403 * outbound holds sending flags for PR-SCTP. */
405 uint8_t chunk_was_revoked;
409 TAILQ_HEAD(sctpchunk_listhead, sctp_tmit_chunk);
411 /* The lower byte is used to enumerate PR_SCTP policies */
412 #define CHUNK_FLAGS_PR_SCTP_TTL SCTP_PR_SCTP_TTL
413 #define CHUNK_FLAGS_PR_SCTP_BUF SCTP_PR_SCTP_BUF
414 #define CHUNK_FLAGS_PR_SCTP_RTX SCTP_PR_SCTP_RTX
416 /* The upper byte is used as a bit mask */
417 #define CHUNK_FLAGS_FRAGMENT_OK 0x0100
421 uint8_t can_take_data;
425 struct sctp_tmit_chunk {
427 struct sctp_data_chunkrec data;
428 struct chk_id chunk_id;
430 struct sctp_association *asoc; /* bp to asoc this belongs to */
431 struct timeval sent_rcv_time; /* filled in if RTT being calculated */
432 struct mbuf *data; /* pointer to mbuf chain of data */
433 struct mbuf *last_mbuf; /* pointer to last mbuf in chain */
434 struct sctp_nets *whoTo;
435 TAILQ_ENTRY(sctp_tmit_chunk) sctp_next; /* next link */
436 int32_t sent; /* the send status */
437 uint16_t snd_count; /* number of times I sent */
438 uint16_t flags; /* flags, such as FRAGMENT_OK */
443 uint8_t holds_key_ref; /* flag if auth keyid refcount is held */
446 uint8_t book_size_scale;
447 uint8_t no_fr_allowed;
449 uint8_t window_probe;
453 * The first part of this structure MUST be the entire sinfo structure. Maybe
454 * I should have made it a sub structure... we can circle back later and do
457 struct sctp_queued_to_read { /* sinfo structure Pluse more */
458 uint16_t sinfo_stream; /* off the wire */
459 uint16_t sinfo_ssn; /* off the wire */
460 uint16_t sinfo_flags; /* SCTP_UNORDERED from wire use SCTP_EOF for
462 uint32_t sinfo_ppid; /* off the wire */
463 uint32_t sinfo_context; /* pick this up from assoc def context? */
464 uint32_t sinfo_timetolive; /* not used by kernel */
465 uint32_t sinfo_tsn; /* Use this in reassembly as first TSN */
466 uint32_t sinfo_cumtsn; /* Use this in reassembly as last TSN */
467 sctp_assoc_t sinfo_assoc_id; /* our assoc id */
468 /* Non sinfo stuff */
469 uint32_t length; /* length of data */
470 uint32_t held_length; /* length held in sb */
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;
480 uint16_t spec_flags; /* Flags to hold the notification field */
481 uint8_t do_not_ref_stcb;
483 uint8_t pdapi_aborted;
487 /* This data structure will be on the outbound
488 * stream queues. Data will be pulled off from
489 * the front of the mbuf data and chunk-ified
490 * by the output routines. We will custom
491 * fit every chunk we pull to the send/sent
492 * queue to make up the next full packet
493 * if we can. An entry cannot be removed
494 * from the stream_out queue until
495 * the msg_is_complete flag is set. This
496 * means at times data/tail_mbuf MIGHT
497 * be NULL.. If that occurs it happens
498 * for one of two reasons. Either the user
499 * is blocked on a send() call and has not
500 * awoken to copy more data down... OR
501 * the user is in the explict MSG_EOR mode
502 * and wrote some data, but has not completed
505 struct sctp_stream_queue_pending {
507 struct mbuf *tail_mbuf;
509 struct sctp_nets *net;
510 TAILQ_ENTRY(sctp_stream_queue_pending) next;
511 TAILQ_ENTRY(sctp_stream_queue_pending) ss_next;
516 uint16_t sinfo_flags;
520 uint8_t holds_key_ref;
521 uint8_t msg_is_complete;
523 uint8_t sender_all_done;
524 uint8_t put_last_out;
525 uint8_t discard_rest;
529 * this struct contains info that is used to track inbound stream data and
530 * help with ordering.
532 TAILQ_HEAD(sctpwheelunrel_listhead, sctp_stream_in);
533 struct sctp_stream_in {
534 struct sctp_readhead inqueue;
536 uint16_t last_sequence_delivered; /* used for re-order */
537 uint8_t delivery_started;
540 TAILQ_HEAD(sctpwheel_listhead, sctp_stream_out);
541 TAILQ_HEAD(sctplist_listhead, sctp_stream_queue_pending);
543 /* Round-robin schedulers */
545 /* next link in wheel */
546 TAILQ_ENTRY(sctp_stream_out) next_spoke;
549 /* Priority scheduler */
551 /* next link in wheel */
552 TAILQ_ENTRY(sctp_stream_out) next_spoke;
557 /* Fair Bandwidth scheduler */
559 /* next link in wheel */
560 TAILQ_ENTRY(sctp_stream_out) next_spoke;
561 /* stores message size */
566 * This union holds all data necessary for
567 * different stream schedulers.
569 union scheduling_data {
570 struct sctpwheel_listhead out_wheel;
571 struct sctplist_listhead out_list;
575 * This union holds all parameters per stream
576 * necessary for different stream schedulers.
578 union scheduling_parameters {
584 /* States for outgoing streams */
585 #define SCTP_STREAM_CLOSED 0x00
586 #define SCTP_STREAM_OPENING 0x01
587 #define SCTP_STREAM_OPEN 0x02
588 #define SCTP_STREAM_RESET_PENDING 0x03
589 #define SCTP_STREAM_RESET_IN_FLIGHT 0x04
591 #define SCTP_MAX_STREAMS_AT_ONCE_RESET 200
593 /* This struct is used to track the traffic on outbound streams */
594 struct sctp_stream_out {
595 struct sctp_streamhead outqueue;
596 union scheduling_parameters ss_params;
597 uint32_t chunks_on_queues; /* send queue and sent queue */
598 #if defined(SCTP_DETAILED_STR_STATS)
599 uint32_t abandoned_unsent[SCTP_PR_SCTP_MAX + 1];
600 uint32_t abandoned_sent[SCTP_PR_SCTP_MAX + 1];
602 /* Only the aggregation */
603 uint32_t abandoned_unsent[1];
604 uint32_t abandoned_sent[1];
607 uint16_t next_sequence_send; /* next one I expect to send out */
608 uint8_t last_msg_incomplete;
612 /* used to keep track of the addresses yet to try to add/delete */
613 TAILQ_HEAD(sctp_asconf_addrhead, sctp_asconf_addr);
614 struct sctp_asconf_addr {
615 TAILQ_ENTRY(sctp_asconf_addr) next;
616 struct sctp_asconf_addr_param ap;
617 struct sctp_ifa *ifa; /* save the ifa for add/del ip */
618 uint8_t sent; /* has this been sent yet? */
619 uint8_t special_del; /* not to be used in lookup */
622 struct sctp_scoping {
623 uint8_t ipv4_addr_legal;
624 uint8_t ipv6_addr_legal;
625 uint8_t loopback_scope;
626 uint8_t ipv4_local_scope;
631 #define SCTP_TSN_LOG_SIZE 40
633 struct sctp_tsn_log {
644 #define SCTP_FS_SPEC_LOG_SIZE 200
645 struct sctp_fs_spec_log {
647 uint32_t total_flight;
654 /* This struct is here to cut out the compatiabilty
655 * pad that bulks up both the inp and stcb. The non
656 * pad portion MUST stay in complete sync with
657 * sctp_sndrcvinfo... i.e. if sinfo_xxxx is added
658 * this must be done here too.
660 struct sctp_nonpad_sndrcvinfo {
661 uint16_t sinfo_stream;
663 uint16_t sinfo_flags;
665 uint32_t sinfo_context;
666 uint32_t sinfo_timetolive;
668 uint32_t sinfo_cumtsn;
669 sctp_assoc_t sinfo_assoc_id;
670 uint16_t sinfo_keynumber;
671 uint16_t sinfo_keynumber_valid;
675 * JRS - Structure to hold function pointers to the functions responsible
676 * for congestion control.
679 struct sctp_cc_functions {
680 void (*sctp_set_initial_cc_param) (struct sctp_tcb *stcb, struct sctp_nets *net);
681 void (*sctp_cwnd_update_after_sack) (struct sctp_tcb *stcb,
682 struct sctp_association *asoc,
683 int accum_moved, int reneged_all, int will_exit);
684 void (*sctp_cwnd_update_exit_pf) (struct sctp_tcb *stcb, struct sctp_nets *net);
685 void (*sctp_cwnd_update_after_fr) (struct sctp_tcb *stcb,
686 struct sctp_association *asoc);
687 void (*sctp_cwnd_update_after_timeout) (struct sctp_tcb *stcb,
688 struct sctp_nets *net);
689 void (*sctp_cwnd_update_after_ecn_echo) (struct sctp_tcb *stcb,
690 struct sctp_nets *net, int in_window, int num_pkt_lost);
691 void (*sctp_cwnd_update_after_packet_dropped) (struct sctp_tcb *stcb,
692 struct sctp_nets *net, struct sctp_pktdrop_chunk *cp,
693 uint32_t * bottle_bw, uint32_t * on_queue);
694 void (*sctp_cwnd_update_after_output) (struct sctp_tcb *stcb,
695 struct sctp_nets *net, int burst_limit);
696 void (*sctp_cwnd_update_packet_transmitted) (struct sctp_tcb *stcb,
697 struct sctp_nets *net);
698 void (*sctp_cwnd_update_tsn_acknowledged) (struct sctp_nets *net,
699 struct sctp_tmit_chunk *);
700 void (*sctp_cwnd_new_transmission_begins) (struct sctp_tcb *stcb,
701 struct sctp_nets *net);
702 void (*sctp_cwnd_prepare_net_for_sack) (struct sctp_tcb *stcb,
703 struct sctp_nets *net);
704 int (*sctp_cwnd_socket_option) (struct sctp_tcb *stcb, int set, struct sctp_cc_option *);
705 void (*sctp_rtt_calculated) (struct sctp_tcb *, struct sctp_nets *, struct timeval *);
709 * RS - Structure to hold function pointers to the functions responsible
710 * for stream scheduling.
712 struct sctp_ss_functions {
713 void (*sctp_ss_init) (struct sctp_tcb *stcb, struct sctp_association *asoc,
715 void (*sctp_ss_clear) (struct sctp_tcb *stcb, struct sctp_association *asoc,
716 int clear_values, int holds_lock);
717 void (*sctp_ss_init_stream) (struct sctp_stream_out *strq, struct sctp_stream_out *with_strq);
718 void (*sctp_ss_add_to_stream) (struct sctp_tcb *stcb, struct sctp_association *asoc,
719 struct sctp_stream_out *strq, struct sctp_stream_queue_pending *sp, int holds_lock);
720 int (*sctp_ss_is_empty) (struct sctp_tcb *stcb, struct sctp_association *asoc);
721 void (*sctp_ss_remove_from_stream) (struct sctp_tcb *stcb, struct sctp_association *asoc,
722 struct sctp_stream_out *strq, struct sctp_stream_queue_pending *sp, int holds_lock);
723 struct sctp_stream_out *(*sctp_ss_select_stream) (struct sctp_tcb *stcb,
724 struct sctp_nets *net, struct sctp_association *asoc);
725 void (*sctp_ss_scheduled) (struct sctp_tcb *stcb, struct sctp_nets *net,
726 struct sctp_association *asoc, struct sctp_stream_out *strq, int moved_how_much);
727 void (*sctp_ss_packet_done) (struct sctp_tcb *stcb, struct sctp_nets *net,
728 struct sctp_association *asoc);
729 int (*sctp_ss_get_value) (struct sctp_tcb *stcb, struct sctp_association *asoc,
730 struct sctp_stream_out *strq, uint16_t * value);
731 int (*sctp_ss_set_value) (struct sctp_tcb *stcb, struct sctp_association *asoc,
732 struct sctp_stream_out *strq, uint16_t value);
735 /* used to save ASCONF chunks for retransmission */
736 TAILQ_HEAD(sctp_asconf_head, sctp_asconf);
738 TAILQ_ENTRY(sctp_asconf) next;
739 uint32_t serial_number;
745 /* used to save ASCONF-ACK chunks for retransmission */
746 TAILQ_HEAD(sctp_asconf_ackhead, sctp_asconf_ack);
747 struct sctp_asconf_ack {
748 TAILQ_ENTRY(sctp_asconf_ack) next;
749 uint32_t serial_number;
750 struct sctp_nets *last_sent_to;
756 * Here we have information about each individual association that we track.
757 * We probably in production would be more dynamic. But for ease of
758 * implementation we will have a fixed array that we hunt for in a linear
761 struct sctp_association {
762 /* association state */
765 /* queue of pending addrs to add/delete */
766 struct sctp_asconf_addrhead asconf_queue;
768 struct timeval time_entered; /* time we entered state */
769 struct timeval time_last_rcvd;
770 struct timeval time_last_sent;
771 struct timeval time_last_sat_advance;
772 struct sctp_nonpad_sndrcvinfo def_send;
774 /* timers and such */
775 struct sctp_timer dack_timer; /* Delayed ack timer */
776 struct sctp_timer asconf_timer; /* asconf */
777 struct sctp_timer strreset_timer; /* stream reset */
778 struct sctp_timer shut_guard_timer; /* shutdown guard */
779 struct sctp_timer autoclose_timer; /* automatic close timer */
780 struct sctp_timer delayed_event_timer; /* timer for delayed events */
781 struct sctp_timer delete_prim_timer; /* deleting primary dst */
783 /* list of restricted local addresses */
784 struct sctpladdr sctp_restricted_addrs;
786 /* last local address pending deletion (waiting for an address add) */
787 struct sctp_ifa *asconf_addr_del_pending;
788 /* Deleted primary destination (used to stop timer) */
789 struct sctp_nets *deleted_primary;
791 struct sctpnetlisthead nets; /* remote address list */
793 /* Free chunk list */
794 struct sctpchunk_listhead free_chunks;
796 /* Control chunk queue */
797 struct sctpchunk_listhead control_send_queue;
799 /* ASCONF chunk queue */
800 struct sctpchunk_listhead asconf_send_queue;
803 * Once a TSN hits the wire it is moved to the sent_queue. We
804 * maintain two counts here (don't know if any but retran_cnt is
805 * needed). The idea is that the sent_queue_retran_cnt reflects how
806 * many chunks have been marked for retranmission by either T3-rxt
809 struct sctpchunk_listhead sent_queue;
810 struct sctpchunk_listhead send_queue;
812 /* re-assembly queue for fragmented chunks on the inbound path */
813 struct sctpchunk_listhead reasmqueue;
815 /* Scheduling queues */
816 union scheduling_data ss_data;
819 * This pointer will be set to NULL most of the time. But when we
820 * have a fragmented message, where we could not get out all of the
821 * message at the last send then this will point to the stream to go
824 struct sctp_stream_out *locked_on_sending;
826 /* If an iterator is looking at me, this is it */
827 struct sctp_iterator *stcb_starting_point_for_iterator;
829 /* ASCONF save the last ASCONF-ACK so we can resend it if necessary */
830 struct sctp_asconf_ackhead asconf_ack_sent;
833 * pointer to last stream reset queued to control queue by us with
836 struct sctp_tmit_chunk *str_reset;
838 * if Source Address Selection happening, this will rotate through
841 struct sctp_laddr *last_used_address;
844 struct sctp_stream_in *strmin;
845 struct sctp_stream_out *strmout;
846 uint8_t *mapping_array;
847 /* primary destination to use */
848 struct sctp_nets *primary_destination;
849 struct sctp_nets *alternate; /* If primary is down or PF */
851 struct sctp_nets *last_net_cmt_send_started;
852 /* last place I got a data chunk from */
853 struct sctp_nets *last_data_chunk_from;
854 /* last place I got a control from */
855 struct sctp_nets *last_control_chunk_from;
857 /* circular looking for output selection */
858 struct sctp_stream_out *last_out_stream;
861 * wait to the point the cum-ack passes req->send_reset_at_tsn for
862 * any req on the list.
864 struct sctp_resethead resetHead;
866 /* queue of chunks waiting to be sent into the local stack */
867 struct sctp_readhead pending_reply_queue;
869 /* JRS - the congestion control functions are in this struct */
870 struct sctp_cc_functions cc_functions;
872 * JRS - value to store the currently loaded congestion control
875 uint32_t congestion_control_module;
876 /* RS - the stream scheduling functions are in this struct */
877 struct sctp_ss_functions ss_functions;
878 /* RS - value to store the currently loaded stream scheduling module */
879 uint32_t stream_scheduling_module;
883 uint32_t cookie_preserve_req;
884 /* ASCONF next seq I am sending out, inits at init-tsn */
885 uint32_t asconf_seq_out;
886 uint32_t asconf_seq_out_acked;
887 /* ASCONF last received ASCONF from peer, starts at peer's TSN-1 */
888 uint32_t asconf_seq_in;
890 /* next seq I am sending in str reset messages */
891 uint32_t str_reset_seq_out;
892 /* next seq I am expecting in str reset messages */
893 uint32_t str_reset_seq_in;
895 /* various verification tag information */
896 uint32_t my_vtag; /* The tag to be used. if assoc is re-initited
897 * by remote end, and I have unlocked this
898 * will be regenerated to a new random value. */
899 uint32_t peer_vtag; /* The peers last tag */
901 uint32_t my_vtag_nonce;
902 uint32_t peer_vtag_nonce;
906 /* This is the SCTP fragmentation threshold */
907 uint32_t smallest_mtu;
910 * Special hook for Fast retransmit, allows us to track the highest
911 * TSN that is NEW in this SACK if gap ack blocks are present.
913 uint32_t this_sack_highest_gap;
916 * The highest consecutive TSN that has been acked by peer on my
919 uint32_t last_acked_seq;
921 /* The next TSN that I will use in sending. */
922 uint32_t sending_seq;
924 /* Original seq number I used ??questionable to keep?? */
925 uint32_t init_seq_number;
928 /* The Advanced Peer Ack Point, as required by the PR-SCTP */
929 /* (A1 in Section 4.2) */
930 uint32_t advanced_peer_ack_point;
933 * The highest consequetive TSN at the bottom of the mapping array
936 uint32_t cumulative_tsn;
938 * Used to track the mapping array and its offset bits. This MAY be
939 * lower then cumulative_tsn.
941 uint32_t mapping_array_base_tsn;
943 * used to track highest TSN we have received and is listed in the
946 uint32_t highest_tsn_inside_map;
948 /* EY - new NR variables used for nr_sack based on mapping_array */
949 uint8_t *nr_mapping_array;
950 uint32_t highest_tsn_inside_nr_map;
952 uint32_t fast_recovery_tsn;
953 uint32_t sat_t3_recovery_tsn;
954 uint32_t tsn_last_delivered;
956 * For the pd-api we should re-write this a bit more efficent. We
957 * could have multiple sctp_queued_to_read's that we are building at
958 * once. Now we only do this when we get ready to deliver to the
959 * socket buffer. Note that we depend on the fact that the struct is
960 * "stuck" on the read queue until we finish all the pd-api.
962 struct sctp_queued_to_read *control_pdapi;
964 uint32_t tsn_of_pdapi_last_delivered;
967 uint32_t last_reset_action[SCTP_MAX_RESET_PARAMS];
968 uint32_t last_sending_seq[SCTP_MAX_RESET_PARAMS];
969 uint32_t last_base_tsnsent[SCTP_MAX_RESET_PARAMS];
970 #ifdef SCTP_ASOCLOG_OF_TSNS
972 * special log - This adds considerable size to the asoc, but
973 * provides a log that you can use to detect problems via kgdb.
975 struct sctp_tsn_log in_tsnlog[SCTP_TSN_LOG_SIZE];
976 struct sctp_tsn_log out_tsnlog[SCTP_TSN_LOG_SIZE];
977 uint32_t cumack_log[SCTP_TSN_LOG_SIZE];
978 uint32_t cumack_logsnt[SCTP_TSN_LOG_SIZE];
981 uint16_t tsn_in_wrapped;
982 uint16_t tsn_out_wrapped;
983 uint16_t cumack_log_at;
984 uint16_t cumack_log_atsnt;
985 #endif /* SCTP_ASOCLOG_OF_TSNS */
986 #ifdef SCTP_FS_SPEC_LOG
987 struct sctp_fs_spec_log fslog[SCTP_FS_SPEC_LOG_SIZE];
992 * window state information and smallest MTU that I use to bound
997 uint32_t my_last_reported_rwnd;
998 uint32_t sctp_frag_point;
1000 uint32_t total_output_queue_size;
1002 uint32_t sb_cc; /* shadow of sb_cc */
1003 uint32_t sb_send_resv; /* amount reserved on a send */
1004 uint32_t my_rwnd_control_len; /* shadow of sb_mbcnt used for rwnd
1007 uint32_t default_flowlabel;
1009 uint32_t pr_sctp_cnt;
1010 int ctrl_queue_cnt; /* could be removed REM - NO IT CAN'T!! RRS */
1012 * All outbound datagrams queue into this list from the individual
1013 * stream queue. Here they get assigned a TSN and then await
1014 * sending. The stream seq comes when it is first put in the
1015 * individual str queue
1017 unsigned int stream_queue_cnt;
1018 unsigned int send_queue_cnt;
1019 unsigned int sent_queue_cnt;
1020 unsigned int sent_queue_cnt_removeable;
1022 * Number on sent queue that are marked for retran until this value
1023 * is 0 we only send one packet of retran'ed data.
1025 unsigned int sent_queue_retran_cnt;
1027 unsigned int size_on_reasm_queue;
1028 unsigned int cnt_on_reasm_queue;
1029 unsigned int fwd_tsn_cnt;
1030 /* amount of data (bytes) currently in flight (on all destinations) */
1031 unsigned int total_flight;
1032 /* Total book size in flight */
1033 unsigned int total_flight_count; /* count of chunks used with
1035 /* count of destinaton nets and list of destination nets */
1036 unsigned int numnets;
1038 /* Total error count on this association */
1039 unsigned int overall_error_count;
1041 unsigned int cnt_msg_on_sb;
1043 /* All stream count of chunks for delivery */
1044 unsigned int size_on_all_streams;
1045 unsigned int cnt_on_all_streams;
1047 /* Heart Beat delay in ms */
1048 uint32_t heart_beat_delay;
1051 unsigned int sctp_autoclose_ticks;
1053 /* how many preopen streams we have */
1054 unsigned int pre_open_streams;
1056 /* How many streams I support coming into me */
1057 unsigned int max_inbound_streams;
1059 /* the cookie life I award for any cookie, in seconds */
1060 unsigned int cookie_life;
1061 /* time to delay acks for */
1062 unsigned int delayed_ack;
1063 unsigned int old_delayed_ack;
1064 unsigned int sack_freq;
1065 unsigned int data_pkts_seen;
1067 unsigned int numduptsns;
1068 int dup_tsns[SCTP_MAX_DUP_TSNS];
1069 unsigned int initial_init_rto_max; /* initial RTO for INIT's */
1070 unsigned int initial_rto; /* initial send RTO */
1071 unsigned int minrto; /* per assoc RTO-MIN */
1072 unsigned int maxrto; /* per assoc RTO-MAX */
1074 /* authentication fields */
1075 sctp_auth_chklist_t *local_auth_chunks;
1076 sctp_auth_chklist_t *peer_auth_chunks;
1077 sctp_hmaclist_t *local_hmacs; /* local HMACs supported */
1078 sctp_hmaclist_t *peer_hmacs; /* peer HMACs supported */
1079 struct sctp_keyhead shared_keys; /* assoc's shared keys */
1080 sctp_authinfo_t authinfo; /* randoms, cached keys */
1082 * refcnt to block freeing when a sender or receiver is off coping
1086 uint32_t chunks_on_out_queue; /* total chunks floating around,
1087 * locked by send socket buffer */
1088 uint32_t peers_adaptation;
1089 uint16_t peer_hmac_id; /* peer HMAC id to send */
1092 * Being that we have no bag to collect stale cookies, and that we
1093 * really would not want to anyway.. we will count them in this
1094 * counter. We of course feed them to the pigeons right away (I have
1095 * always thought of pigeons as flying rats).
1097 uint16_t stale_cookie_count;
1100 * For the partial delivery API, if up, invoked this is what last
1103 uint16_t str_of_pdapi;
1104 uint16_t ssn_of_pdapi;
1106 /* counts of actual built streams. Allocation may be more however */
1107 /* could re-arrange to optimize space here. */
1108 uint16_t streamincnt;
1109 uint16_t streamoutcnt;
1110 uint16_t strm_realoutsize;
1111 uint16_t strm_pending_add_size;
1112 /* my maximum number of retrans of INIT and SEND */
1113 /* copied from SCTP but should be individually setable */
1114 uint16_t max_init_times;
1115 uint16_t max_send_times;
1117 uint16_t def_net_failure;
1119 uint16_t def_net_pf_threshold;
1122 * lock flag: 0 is ok to send, 1+ (duals as a retran count) is
1125 uint16_t mapping_array_size;
1127 uint16_t last_strm_seq_delivered;
1128 uint16_t last_strm_no_delivered;
1130 uint16_t last_revoke_count;
1131 int16_t num_send_timers_up;
1133 uint16_t stream_locked_on;
1134 uint16_t ecn_echo_cnt_onq;
1136 uint16_t free_chunk_cnt;
1137 uint8_t stream_locked;
1138 uint8_t authenticated; /* packet authenticated ok */
1140 * This flag indicates that a SACK need to be sent. Initially this
1141 * is 1 to send the first sACK immediately.
1145 /* max burst of new packets into the network */
1147 /* max burst of fast retransmit packets */
1148 uint32_t fr_max_burst;
1150 uint8_t sat_network; /* RTT is in range of sat net or greater */
1151 uint8_t sat_network_lockout; /* lockout code */
1152 uint8_t burst_limit_applied; /* Burst limit in effect at last send? */
1153 /* flag goes on when we are doing a partial delivery api */
1154 uint8_t hb_random_values[4];
1155 uint8_t fragmented_delivery_inprogress;
1156 uint8_t fragment_flags;
1157 uint8_t last_flags_delivered;
1158 uint8_t hb_ect_randombit;
1159 uint8_t hb_random_idx;
1160 uint8_t default_dscp;
1161 uint8_t asconf_del_pending; /* asconf delete last addr pending */
1162 uint8_t trigger_reset;
1164 * This value, plus all other ack'd but above cum-ack is added
1165 * together to cross check against the bit that we have yet to
1166 * define (probably in the SACK). When the cum-ack is updated, this
1167 * sum is updated as well.
1170 /* Flags whether an extension is supported or not */
1171 uint8_t ecn_supported;
1172 uint8_t prsctp_supported;
1173 uint8_t auth_supported;
1174 uint8_t asconf_supported;
1175 uint8_t reconfig_supported;
1176 uint8_t nrsack_supported;
1177 uint8_t pktdrop_supported;
1179 /* Did the peer make the stream config (add out) request */
1180 uint8_t peer_req_out;
1182 uint8_t local_strreset_support;
1184 uint8_t peer_supports_nat;
1186 struct sctp_scoping scope;
1187 /* flags to handle send alternate net tracking */
1188 uint8_t used_alt_asconfack;
1189 uint8_t fast_retran_loss_recovery;
1190 uint8_t sat_t3_loss_recovery;
1191 uint8_t dropped_special_cnt;
1192 uint8_t seen_a_sack_this_pkt;
1193 uint8_t stream_reset_outstanding;
1194 uint8_t stream_reset_out_is_outstanding;
1195 uint8_t delayed_connection;
1196 uint8_t ifp_had_enobuf;
1197 uint8_t saw_sack_with_frags;
1198 uint8_t saw_sack_with_nr_frags;
1199 uint8_t in_asocid_hash;
1200 uint8_t assoc_up_sent;
1201 uint8_t adaptation_needed;
1202 uint8_t adaptation_sent;
1204 uint8_t cmt_dac_pkts_rcvd;
1205 uint8_t sctp_cmt_on_off;
1206 uint8_t iam_blocking;
1207 uint8_t cookie_how[8];
1208 /* JRS 5/21/07 - CMT PF variable */
1209 uint8_t sctp_cmt_pf;
1210 uint8_t use_precise_time;
1211 uint64_t sctp_features;
1213 uint16_t port; /* remote UDP encapsulation port */
1215 * The mapping array is used to track out of order sequences above
1216 * last_acked_seq. 0 indicates packet missing 1 indicates packet
1217 * rec'd. We slide it up every time we raise last_acked_seq and 0
1218 * trailing locactions out. If I get a TSN above the array
1219 * mappingArraySz, I discard the datagram and let retransmit happen.
1221 uint32_t marked_retrans;
1225 uint32_t timoshutdown;
1226 uint32_t timoheartbeat;
1227 uint32_t timocookie;
1228 uint32_t timoshutdownack;
1229 struct timeval start_time;
1230 struct timeval discontinuity_time;
1231 uint64_t abandoned_unsent[SCTP_PR_SCTP_MAX + 1];
1232 uint64_t abandoned_sent[SCTP_PR_SCTP_MAX + 1];