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;
80 uint32_t number_entries;
81 uint16_t list_of_streams[];
84 TAILQ_HEAD(sctp_resethead, sctp_stream_reset_list);
87 * Users of the iterator need to malloc a iterator with a call to
88 * sctp_initiate_iterator(inp_func, assoc_func, inp_func, pcb_flags, pcb_features,
89 * asoc_state, void-ptr-arg, uint32-arg, end_func, inp);
91 * Use the following two defines if you don't care what pcb flags are on the EP
92 * and/or you don't care what state the association is in.
94 * Note that if you specify an INP as the last argument then ONLY each
95 * association of that single INP will be executed upon. Note that the pcb
96 * flags STILL apply so if the inp you specify has different pcb_flags then
97 * what you put in pcb_flags nothing will happen. use SCTP_PCB_ANY_FLAGS to
98 * assure the inp you specify gets treated.
100 #define SCTP_PCB_ANY_FLAGS 0x00000000
101 #define SCTP_PCB_ANY_FEATURES 0x00000000
102 #define SCTP_ASOC_ANY_STATE 0x00000000
104 typedef void (*asoc_func) (struct sctp_inpcb *, struct sctp_tcb *, void *ptr,
106 typedef int (*inp_func) (struct sctp_inpcb *, void *ptr, uint32_t val);
107 typedef void (*end_func) (void *ptr, uint32_t val);
109 #if defined(__FreeBSD__) && defined(SCTP_MCORE_INPUT) && defined(SMP)
110 /* whats on the mcore control struct */
111 struct sctp_mcore_queue {
112 TAILQ_ENTRY(sctp_mcore_queue) next;
119 TAILQ_HEAD(sctp_mcore_qhead, sctp_mcore_queue);
121 struct sctp_mcore_ctrl {
122 SCTP_PROCESS_STRUCT thread_proc;
123 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;
186 #define SCTP_ITERATOR_STOP_CUR_IT 0x00000004
187 #define SCTP_ITERATOR_STOP_CUR_INP 0x00000008
189 struct sctp_net_route {
190 sctp_rtentry_t *ro_rt;
194 union sctp_sockstore _l_addr; /* remote peer addr */
195 struct sctp_ifa *_s_addr; /* our selected src addr */
199 uint16_t alpha; /* Fixed point arith, << 7 */
200 uint8_t beta; /* Fixed point arith, << 7 */
201 uint8_t modeswitch; /* Delay modeswitch until we had at least one
202 * congestion event */
203 uint32_t last_cong; /* Time since last congestion event end */
204 uint32_t undo_last_cong;
205 uint16_t bytes_acked;
210 uint32_t undo_maxRTT;
211 uint32_t undo_old_maxB;
213 /* Bandwidth estimation */
222 struct timeval tls; /* The time we started the sending */
223 uint64_t lbw; /* Our last estimated bw */
224 uint64_t lbw_rtt; /* RTT at bw estimate */
225 uint64_t bw_bytes; /* The total bytes since this sending began */
226 uint64_t bw_tot_time; /* The total time since sending began */
227 uint64_t new_tot_time; /* temp holding the new value */
228 uint64_t bw_bytes_at_last_rttc; /* What bw_bytes was at last rtt calc */
229 uint32_t cwnd_at_bw_set;/* Cwnd at last bw saved - lbw */
230 uint32_t vol_reduce; /* cnt of voluntary reductions */
231 uint16_t steady_step; /* The number required to be in steady state */
232 uint16_t step_cnt; /* The current number */
233 uint8_t ret_from_eq; /* When all things are equal what do I return
234 * 0/1 - 1 no cc advance */
235 uint8_t use_dccc_ecn; /* Flag to enable DCCC ECN */
236 uint8_t tls_needs_set; /* Flag to indicate we need to set tls 0 or 1
237 * means set at send 2 not */
238 uint8_t last_step_state;/* Last state if steady state stepdown is on */
239 uint8_t rtt_set_this_sack; /* Flag saying this sack had RTT calc
241 uint8_t last_inst_ind; /* Last saved inst indication */
246 TAILQ_ENTRY(sctp_nets) sctp_next; /* next link */
249 * Things on the top half may be able to be split into a common
250 * structure shared by all.
252 struct sctp_timer pmtu_timer;
253 struct sctp_timer hb_timer;
256 * The following two in combination equate to a route entry for v6
259 struct sctp_net_route ro;
261 /* mtu discovered so far */
263 uint32_t ssthresh; /* not sure about this one for split */
264 uint32_t last_cwr_tsn;
265 uint32_t cwr_window_tsn;
266 uint32_t ecn_ce_pkt_cnt;
268 /* smoothed average things for RTT and RTO itself */
271 uint64_t rtt; /* last measured rtt value in us */
274 /* This is used for SHUTDOWN/SHUTDOWN-ACK/SEND or INIT timers */
275 struct sctp_timer rxt_timer;
277 /* last time in seconds I sent to it */
278 struct timeval last_sent_time;
279 union cc_control_data {
280 struct htcp htcp_ca; /* JRS - struct used in HTCP algorithm */
281 struct rtcc_cc rtcc; /* rtcc module cc stuff */
285 /* Congestion stats per destination */
287 * flight size variables and such, sorry Vern, I could not avoid
288 * this if I wanted performance :>
290 uint32_t flight_size;
291 uint32_t cwnd; /* actual cwnd */
292 uint32_t prev_cwnd; /* cwnd before any processing */
293 uint32_t ecn_prev_cwnd; /* ECN prev cwnd at first ecn_echo seen in new
295 uint32_t partial_bytes_acked; /* in CA tracks when to incr a MTU */
296 /* tracking variables to avoid the aloc/free in sack processing */
297 unsigned int net_ack;
298 unsigned int net_ack2;
301 * JRS - 5/8/07 - Variable to track last time a destination was
304 uint32_t last_active;
307 * CMT variables (iyengar@cis.udel.edu)
309 uint32_t this_sack_highest_newack; /* tracks highest TSN newly
310 * acked for a given dest in
311 * the current SACK. Used in
312 * SFR and HTNA algos */
313 uint32_t pseudo_cumack; /* CMT CUC algorithm. Maintains next expected
314 * pseudo-cumack for this destination */
315 uint32_t rtx_pseudo_cumack; /* CMT CUC algorithm. Maintains next
316 * expected pseudo-cumack for this
319 /* CMT fast recovery variables */
320 uint32_t fast_recovery_tsn;
321 uint32_t heartbeat_random1;
322 uint32_t heartbeat_random2;
328 struct timeval start_time; /* time when this net was created */
329 uint32_t marked_retrans;/* number or DATA chunks marked for timer
330 * based retransmissions */
331 uint32_t marked_fastretrans;
332 uint32_t heart_beat_delay; /* Heart Beat delay in ms */
334 /* if this guy is ok or not ... status */
336 /* number of timeouts to consider the destination unreachable */
337 uint16_t failure_threshold;
338 /* number of timeouts to consider the destination potentially failed */
339 uint16_t pf_threshold;
340 /* error stats on the destination */
341 uint16_t error_count;
342 /* UDP port number in case of UDP tunneling */
345 uint8_t fast_retran_loss_recovery;
346 uint8_t will_exit_fast_recovery;
347 /* Flags that probably can be combined into dest_state */
348 uint8_t fast_retran_ip; /* fast retransmit in progress */
349 uint8_t hb_responded;
350 uint8_t saw_newack; /* CMT's SFR algorithm flag */
351 uint8_t src_addr_selected; /* if we split we move */
352 uint8_t indx_of_eligible_next_to_use;
353 uint8_t addr_is_local; /* its a local address (if known) could move
357 * CMT variables (iyengar@cis.udel.edu)
359 uint8_t find_pseudo_cumack; /* CMT CUC algorithm. Flag used to
360 * find a new pseudocumack. This flag
361 * is set after a new pseudo-cumack
362 * has been received and indicates
363 * that the sender should find the
364 * next pseudo-cumack expected for
365 * this destination */
366 uint8_t find_rtx_pseudo_cumack; /* CMT CUCv2 algorithm. Flag used to
367 * find a new rtx-pseudocumack. This
368 * flag is set after a new
369 * rtx-pseudo-cumack has been received
370 * and indicates that the sender
371 * should find the next
372 * rtx-pseudo-cumack expected for this
374 uint8_t new_pseudo_cumack; /* CMT CUC algorithm. Flag used to
375 * indicate if a new pseudo-cumack or
376 * rtx-pseudo-cumack has been received */
377 uint8_t window_probe; /* Doing a window probe? */
378 uint8_t RTO_measured; /* Have we done the first measure */
379 uint8_t last_hs_used; /* index into the last HS table entry we used */
387 struct sctp_data_chunkrec {
388 uint32_t TSN_seq; /* the TSN of this transmit */
389 uint16_t stream_seq; /* the stream sequence number of this transmit */
390 uint16_t stream_number; /* the stream number of this guy */
391 uint32_t payloadtype;
392 uint32_t context; /* from send */
393 uint32_t cwnd_at_send;
395 * part of the Highest sacked algorithm to be able to stroke counts
396 * on ones that are FR'd.
398 uint32_t fast_retran_tsn; /* sending_seq at the time of FR */
399 struct timeval timetodrop; /* time we drop it from queue */
400 uint8_t doing_fast_retransmit;
401 uint8_t rcv_flags; /* flags pulled from data chunk on inbound for
402 * outbound holds sending flags for PR-SCTP. */
404 uint8_t chunk_was_revoked;
408 TAILQ_HEAD(sctpchunk_listhead, sctp_tmit_chunk);
410 /* The lower byte is used to enumerate PR_SCTP policies */
411 #define CHUNK_FLAGS_PR_SCTP_TTL SCTP_PR_SCTP_TTL
412 #define CHUNK_FLAGS_PR_SCTP_BUF SCTP_PR_SCTP_BUF
413 #define CHUNK_FLAGS_PR_SCTP_RTX SCTP_PR_SCTP_RTX
415 /* The upper byte is used as a bit mask */
416 #define CHUNK_FLAGS_FRAGMENT_OK 0x0100
420 uint8_t can_take_data;
424 struct sctp_tmit_chunk {
426 struct sctp_data_chunkrec data;
427 struct chk_id chunk_id;
429 struct sctp_association *asoc; /* bp to asoc this belongs to */
430 struct timeval sent_rcv_time; /* filled in if RTT being calculated */
431 struct mbuf *data; /* pointer to mbuf chain of data */
432 struct mbuf *last_mbuf; /* pointer to last mbuf in chain */
433 struct sctp_nets *whoTo;
434 TAILQ_ENTRY(sctp_tmit_chunk) sctp_next; /* next link */
435 int32_t sent; /* the send status */
436 uint16_t snd_count; /* number of times I sent */
437 uint16_t flags; /* flags, such as FRAGMENT_OK */
442 uint8_t holds_key_ref; /* flag if auth keyid refcount is held */
445 uint8_t book_size_scale;
446 uint8_t no_fr_allowed;
448 uint8_t window_probe;
452 * The first part of this structure MUST be the entire sinfo structure. Maybe
453 * I should have made it a sub structure... we can circle back later and do
456 struct sctp_queued_to_read { /* sinfo structure Pluse more */
457 uint16_t sinfo_stream; /* off the wire */
458 uint16_t sinfo_ssn; /* off the wire */
459 uint16_t sinfo_flags; /* SCTP_UNORDERED from wire use SCTP_EOF for
461 uint32_t sinfo_ppid; /* off the wire */
462 uint32_t sinfo_context; /* pick this up from assoc def context? */
463 uint32_t sinfo_timetolive; /* not used by kernel */
464 uint32_t sinfo_tsn; /* Use this in reassembly as first TSN */
465 uint32_t sinfo_cumtsn; /* Use this in reassembly as last TSN */
466 sctp_assoc_t sinfo_assoc_id; /* our assoc id */
467 /* Non sinfo stuff */
468 uint32_t length; /* length of data */
469 uint32_t held_length; /* length held in sb */
470 struct sctp_nets *whoFrom; /* where it came from */
471 struct mbuf *data; /* front of the mbuf chain of data with
473 struct mbuf *tail_mbuf; /* used for multi-part data */
474 struct mbuf *aux_data; /* used to hold/cache control if o/s does not
476 struct sctp_tcb *stcb; /* assoc, used for window update */
477 TAILQ_ENTRY(sctp_queued_to_read) next;
479 uint16_t spec_flags; /* Flags to hold the notification field */
480 uint8_t do_not_ref_stcb;
482 uint8_t pdapi_aborted;
486 /* This data structure will be on the outbound
487 * stream queues. Data will be pulled off from
488 * the front of the mbuf data and chunk-ified
489 * by the output routines. We will custom
490 * fit every chunk we pull to the send/sent
491 * queue to make up the next full packet
492 * if we can. An entry cannot be removed
493 * from the stream_out queue until
494 * the msg_is_complete flag is set. This
495 * means at times data/tail_mbuf MIGHT
496 * be NULL.. If that occurs it happens
497 * for one of two reasons. Either the user
498 * is blocked on a send() call and has not
499 * awoken to copy more data down... OR
500 * the user is in the explict MSG_EOR mode
501 * and wrote some data, but has not completed
504 struct sctp_stream_queue_pending {
506 struct mbuf *tail_mbuf;
508 struct sctp_nets *net;
509 TAILQ_ENTRY(sctp_stream_queue_pending) next;
510 TAILQ_ENTRY(sctp_stream_queue_pending) ss_next;
515 uint16_t sinfo_flags;
519 uint8_t holds_key_ref;
520 uint8_t msg_is_complete;
522 uint8_t sender_all_done;
523 uint8_t put_last_out;
524 uint8_t discard_rest;
528 * this struct contains info that is used to track inbound stream data and
529 * help with ordering.
531 TAILQ_HEAD(sctpwheelunrel_listhead, sctp_stream_in);
532 struct sctp_stream_in {
533 struct sctp_readhead inqueue;
535 uint16_t last_sequence_delivered; /* used for re-order */
536 uint8_t delivery_started;
539 TAILQ_HEAD(sctpwheel_listhead, sctp_stream_out);
540 TAILQ_HEAD(sctplist_listhead, sctp_stream_queue_pending);
542 /* Round-robin schedulers */
544 /* next link in wheel */
545 TAILQ_ENTRY(sctp_stream_out) next_spoke;
548 /* Priority scheduler */
550 /* next link in wheel */
551 TAILQ_ENTRY(sctp_stream_out) next_spoke;
556 /* Fair Bandwidth scheduler */
558 /* next link in wheel */
559 TAILQ_ENTRY(sctp_stream_out) next_spoke;
560 /* stores message size */
565 * This union holds all data necessary for
566 * different stream schedulers.
568 union scheduling_data {
569 struct sctpwheel_listhead out_wheel;
570 struct sctplist_listhead out_list;
574 * This union holds all parameters per stream
575 * necessary for different stream schedulers.
577 union scheduling_parameters {
583 /* This struct is used to track the traffic on outbound streams */
584 struct sctp_stream_out {
585 struct sctp_streamhead outqueue;
586 union scheduling_parameters ss_params;
587 uint32_t chunks_on_queues;
588 #if defined(SCTP_DETAILED_STR_STATS)
589 uint32_t abandoned_unsent[SCTP_PR_SCTP_MAX + 1];
590 uint32_t abandoned_sent[SCTP_PR_SCTP_MAX + 1];
592 /* Only the aggregation */
593 uint32_t abandoned_unsent[1];
594 uint32_t abandoned_sent[1];
597 uint16_t next_sequence_send; /* next one I expect to send out */
598 uint8_t last_msg_incomplete;
601 /* used to keep track of the addresses yet to try to add/delete */
602 TAILQ_HEAD(sctp_asconf_addrhead, sctp_asconf_addr);
603 struct sctp_asconf_addr {
604 TAILQ_ENTRY(sctp_asconf_addr) next;
605 struct sctp_asconf_addr_param ap;
606 struct sctp_ifa *ifa; /* save the ifa for add/del ip */
607 uint8_t sent; /* has this been sent yet? */
608 uint8_t special_del; /* not to be used in lookup */
611 struct sctp_scoping {
612 uint8_t ipv4_addr_legal;
613 uint8_t ipv6_addr_legal;
614 uint8_t loopback_scope;
615 uint8_t ipv4_local_scope;
620 #define SCTP_TSN_LOG_SIZE 40
622 struct sctp_tsn_log {
633 #define SCTP_FS_SPEC_LOG_SIZE 200
634 struct sctp_fs_spec_log {
636 uint32_t total_flight;
643 /* This struct is here to cut out the compatiabilty
644 * pad that bulks up both the inp and stcb. The non
645 * pad portion MUST stay in complete sync with
646 * sctp_sndrcvinfo... i.e. if sinfo_xxxx is added
647 * this must be done here too.
649 struct sctp_nonpad_sndrcvinfo {
650 uint16_t sinfo_stream;
652 uint16_t sinfo_flags;
654 uint32_t sinfo_context;
655 uint32_t sinfo_timetolive;
657 uint32_t sinfo_cumtsn;
658 sctp_assoc_t sinfo_assoc_id;
659 uint16_t sinfo_keynumber;
660 uint16_t sinfo_keynumber_valid;
664 * JRS - Structure to hold function pointers to the functions responsible
665 * for congestion control.
668 struct sctp_cc_functions {
669 void (*sctp_set_initial_cc_param) (struct sctp_tcb *stcb, struct sctp_nets *net);
670 void (*sctp_cwnd_update_after_sack) (struct sctp_tcb *stcb,
671 struct sctp_association *asoc,
672 int accum_moved, int reneged_all, int will_exit);
673 void (*sctp_cwnd_update_exit_pf) (struct sctp_tcb *stcb, struct sctp_nets *net);
674 void (*sctp_cwnd_update_after_fr) (struct sctp_tcb *stcb,
675 struct sctp_association *asoc);
676 void (*sctp_cwnd_update_after_timeout) (struct sctp_tcb *stcb,
677 struct sctp_nets *net);
678 void (*sctp_cwnd_update_after_ecn_echo) (struct sctp_tcb *stcb,
679 struct sctp_nets *net, int in_window, int num_pkt_lost);
680 void (*sctp_cwnd_update_after_packet_dropped) (struct sctp_tcb *stcb,
681 struct sctp_nets *net, struct sctp_pktdrop_chunk *cp,
682 uint32_t * bottle_bw, uint32_t * on_queue);
683 void (*sctp_cwnd_update_after_output) (struct sctp_tcb *stcb,
684 struct sctp_nets *net, int burst_limit);
685 void (*sctp_cwnd_update_packet_transmitted) (struct sctp_tcb *stcb,
686 struct sctp_nets *net);
687 void (*sctp_cwnd_update_tsn_acknowledged) (struct sctp_nets *net,
688 struct sctp_tmit_chunk *);
689 void (*sctp_cwnd_new_transmission_begins) (struct sctp_tcb *stcb,
690 struct sctp_nets *net);
691 void (*sctp_cwnd_prepare_net_for_sack) (struct sctp_tcb *stcb,
692 struct sctp_nets *net);
693 int (*sctp_cwnd_socket_option) (struct sctp_tcb *stcb, int set, struct sctp_cc_option *);
694 void (*sctp_rtt_calculated) (struct sctp_tcb *, struct sctp_nets *, struct timeval *);
698 * RS - Structure to hold function pointers to the functions responsible
699 * for stream scheduling.
701 struct sctp_ss_functions {
702 void (*sctp_ss_init) (struct sctp_tcb *stcb, struct sctp_association *asoc,
704 void (*sctp_ss_clear) (struct sctp_tcb *stcb, struct sctp_association *asoc,
705 int clear_values, int holds_lock);
706 void (*sctp_ss_init_stream) (struct sctp_stream_out *strq, struct sctp_stream_out *with_strq);
707 void (*sctp_ss_add_to_stream) (struct sctp_tcb *stcb, struct sctp_association *asoc,
708 struct sctp_stream_out *strq, struct sctp_stream_queue_pending *sp, int holds_lock);
709 int (*sctp_ss_is_empty) (struct sctp_tcb *stcb, struct sctp_association *asoc);
710 void (*sctp_ss_remove_from_stream) (struct sctp_tcb *stcb, struct sctp_association *asoc,
711 struct sctp_stream_out *strq, struct sctp_stream_queue_pending *sp, int holds_lock);
712 struct sctp_stream_out *(*sctp_ss_select_stream) (struct sctp_tcb *stcb,
713 struct sctp_nets *net, struct sctp_association *asoc);
714 void (*sctp_ss_scheduled) (struct sctp_tcb *stcb, struct sctp_nets *net,
715 struct sctp_association *asoc, struct sctp_stream_out *strq, int moved_how_much);
716 void (*sctp_ss_packet_done) (struct sctp_tcb *stcb, struct sctp_nets *net,
717 struct sctp_association *asoc);
718 int (*sctp_ss_get_value) (struct sctp_tcb *stcb, struct sctp_association *asoc,
719 struct sctp_stream_out *strq, uint16_t * value);
720 int (*sctp_ss_set_value) (struct sctp_tcb *stcb, struct sctp_association *asoc,
721 struct sctp_stream_out *strq, uint16_t value);
724 /* used to save ASCONF chunks for retransmission */
725 TAILQ_HEAD(sctp_asconf_head, sctp_asconf);
727 TAILQ_ENTRY(sctp_asconf) next;
728 uint32_t serial_number;
734 /* used to save ASCONF-ACK chunks for retransmission */
735 TAILQ_HEAD(sctp_asconf_ackhead, sctp_asconf_ack);
736 struct sctp_asconf_ack {
737 TAILQ_ENTRY(sctp_asconf_ack) next;
738 uint32_t serial_number;
739 struct sctp_nets *last_sent_to;
745 * Here we have information about each individual association that we track.
746 * We probably in production would be more dynamic. But for ease of
747 * implementation we will have a fixed array that we hunt for in a linear
750 struct sctp_association {
751 /* association state */
754 /* queue of pending addrs to add/delete */
755 struct sctp_asconf_addrhead asconf_queue;
757 struct timeval time_entered; /* time we entered state */
758 struct timeval time_last_rcvd;
759 struct timeval time_last_sent;
760 struct timeval time_last_sat_advance;
761 struct sctp_nonpad_sndrcvinfo def_send;
763 /* timers and such */
764 struct sctp_timer dack_timer; /* Delayed ack timer */
765 struct sctp_timer asconf_timer; /* asconf */
766 struct sctp_timer strreset_timer; /* stream reset */
767 struct sctp_timer shut_guard_timer; /* shutdown guard */
768 struct sctp_timer autoclose_timer; /* automatic close timer */
769 struct sctp_timer delayed_event_timer; /* timer for delayed events */
770 struct sctp_timer delete_prim_timer; /* deleting primary dst */
772 /* list of restricted local addresses */
773 struct sctpladdr sctp_restricted_addrs;
775 /* last local address pending deletion (waiting for an address add) */
776 struct sctp_ifa *asconf_addr_del_pending;
777 /* Deleted primary destination (used to stop timer) */
778 struct sctp_nets *deleted_primary;
780 struct sctpnetlisthead nets; /* remote address list */
782 /* Free chunk list */
783 struct sctpchunk_listhead free_chunks;
785 /* Control chunk queue */
786 struct sctpchunk_listhead control_send_queue;
788 /* ASCONF chunk queue */
789 struct sctpchunk_listhead asconf_send_queue;
792 * Once a TSN hits the wire it is moved to the sent_queue. We
793 * maintain two counts here (don't know if any but retran_cnt is
794 * needed). The idea is that the sent_queue_retran_cnt reflects how
795 * many chunks have been marked for retranmission by either T3-rxt
798 struct sctpchunk_listhead sent_queue;
799 struct sctpchunk_listhead send_queue;
801 /* re-assembly queue for fragmented chunks on the inbound path */
802 struct sctpchunk_listhead reasmqueue;
804 /* Scheduling queues */
805 union scheduling_data ss_data;
808 * This pointer will be set to NULL most of the time. But when we
809 * have a fragmented message, where we could not get out all of the
810 * message at the last send then this will point to the stream to go
813 struct sctp_stream_out *locked_on_sending;
815 /* If an iterator is looking at me, this is it */
816 struct sctp_iterator *stcb_starting_point_for_iterator;
818 /* ASCONF save the last ASCONF-ACK so we can resend it if necessary */
819 struct sctp_asconf_ackhead asconf_ack_sent;
822 * pointer to last stream reset queued to control queue by us with
825 struct sctp_tmit_chunk *str_reset;
827 * if Source Address Selection happening, this will rotate through
830 struct sctp_laddr *last_used_address;
833 struct sctp_stream_in *strmin;
834 struct sctp_stream_out *strmout;
835 uint8_t *mapping_array;
836 /* primary destination to use */
837 struct sctp_nets *primary_destination;
838 struct sctp_nets *alternate; /* If primary is down or PF */
840 struct sctp_nets *last_net_cmt_send_started;
841 /* last place I got a data chunk from */
842 struct sctp_nets *last_data_chunk_from;
843 /* last place I got a control from */
844 struct sctp_nets *last_control_chunk_from;
846 /* circular looking for output selection */
847 struct sctp_stream_out *last_out_stream;
850 * wait to the point the cum-ack passes req->send_reset_at_tsn for
851 * any req on the list.
853 struct sctp_resethead resetHead;
855 /* queue of chunks waiting to be sent into the local stack */
856 struct sctp_readhead pending_reply_queue;
858 /* JRS - the congestion control functions are in this struct */
859 struct sctp_cc_functions cc_functions;
861 * JRS - value to store the currently loaded congestion control
864 uint32_t congestion_control_module;
865 /* RS - the stream scheduling functions are in this struct */
866 struct sctp_ss_functions ss_functions;
867 /* RS - value to store the currently loaded stream scheduling module */
868 uint32_t stream_scheduling_module;
872 uint32_t cookie_preserve_req;
873 /* ASCONF next seq I am sending out, inits at init-tsn */
874 uint32_t asconf_seq_out;
875 uint32_t asconf_seq_out_acked;
876 /* ASCONF last received ASCONF from peer, starts at peer's TSN-1 */
877 uint32_t asconf_seq_in;
879 /* next seq I am sending in str reset messages */
880 uint32_t str_reset_seq_out;
881 /* next seq I am expecting in str reset messages */
882 uint32_t str_reset_seq_in;
884 /* various verification tag information */
885 uint32_t my_vtag; /* The tag to be used. if assoc is re-initited
886 * by remote end, and I have unlocked this
887 * will be regenerated to a new random value. */
888 uint32_t peer_vtag; /* The peers last tag */
890 uint32_t my_vtag_nonce;
891 uint32_t peer_vtag_nonce;
895 /* This is the SCTP fragmentation threshold */
896 uint32_t smallest_mtu;
899 * Special hook for Fast retransmit, allows us to track the highest
900 * TSN that is NEW in this SACK if gap ack blocks are present.
902 uint32_t this_sack_highest_gap;
905 * The highest consecutive TSN that has been acked by peer on my
908 uint32_t last_acked_seq;
910 /* The next TSN that I will use in sending. */
911 uint32_t sending_seq;
913 /* Original seq number I used ??questionable to keep?? */
914 uint32_t init_seq_number;
917 /* The Advanced Peer Ack Point, as required by the PR-SCTP */
918 /* (A1 in Section 4.2) */
919 uint32_t advanced_peer_ack_point;
922 * The highest consequetive TSN at the bottom of the mapping array
925 uint32_t cumulative_tsn;
927 * Used to track the mapping array and its offset bits. This MAY be
928 * lower then cumulative_tsn.
930 uint32_t mapping_array_base_tsn;
932 * used to track highest TSN we have received and is listed in the
935 uint32_t highest_tsn_inside_map;
937 /* EY - new NR variables used for nr_sack based on mapping_array */
938 uint8_t *nr_mapping_array;
939 uint32_t highest_tsn_inside_nr_map;
941 uint32_t fast_recovery_tsn;
942 uint32_t sat_t3_recovery_tsn;
943 uint32_t tsn_last_delivered;
945 * For the pd-api we should re-write this a bit more efficent. We
946 * could have multiple sctp_queued_to_read's that we are building at
947 * once. Now we only do this when we get ready to deliver to the
948 * socket buffer. Note that we depend on the fact that the struct is
949 * "stuck" on the read queue until we finish all the pd-api.
951 struct sctp_queued_to_read *control_pdapi;
953 uint32_t tsn_of_pdapi_last_delivered;
956 uint32_t last_reset_action[SCTP_MAX_RESET_PARAMS];
957 uint32_t last_sending_seq[SCTP_MAX_RESET_PARAMS];
958 uint32_t last_base_tsnsent[SCTP_MAX_RESET_PARAMS];
959 #ifdef SCTP_ASOCLOG_OF_TSNS
961 * special log - This adds considerable size to the asoc, but
962 * provides a log that you can use to detect problems via kgdb.
964 struct sctp_tsn_log in_tsnlog[SCTP_TSN_LOG_SIZE];
965 struct sctp_tsn_log out_tsnlog[SCTP_TSN_LOG_SIZE];
966 uint32_t cumack_log[SCTP_TSN_LOG_SIZE];
967 uint32_t cumack_logsnt[SCTP_TSN_LOG_SIZE];
970 uint16_t tsn_in_wrapped;
971 uint16_t tsn_out_wrapped;
972 uint16_t cumack_log_at;
973 uint16_t cumack_log_atsnt;
974 #endif /* SCTP_ASOCLOG_OF_TSNS */
975 #ifdef SCTP_FS_SPEC_LOG
976 struct sctp_fs_spec_log fslog[SCTP_FS_SPEC_LOG_SIZE];
981 * window state information and smallest MTU that I use to bound
986 uint32_t my_last_reported_rwnd;
987 uint32_t sctp_frag_point;
989 uint32_t total_output_queue_size;
991 uint32_t sb_cc; /* shadow of sb_cc */
992 uint32_t sb_send_resv; /* amount reserved on a send */
993 uint32_t my_rwnd_control_len; /* shadow of sb_mbcnt used for rwnd
996 uint32_t default_flowlabel;
998 uint32_t pr_sctp_cnt;
999 int ctrl_queue_cnt; /* could be removed REM - NO IT CAN'T!! RRS */
1001 * All outbound datagrams queue into this list from the individual
1002 * stream queue. Here they get assigned a TSN and then await
1003 * sending. The stream seq comes when it is first put in the
1004 * individual str queue
1006 unsigned int stream_queue_cnt;
1007 unsigned int send_queue_cnt;
1008 unsigned int sent_queue_cnt;
1009 unsigned int sent_queue_cnt_removeable;
1011 * Number on sent queue that are marked for retran until this value
1012 * is 0 we only send one packet of retran'ed data.
1014 unsigned int sent_queue_retran_cnt;
1016 unsigned int size_on_reasm_queue;
1017 unsigned int cnt_on_reasm_queue;
1018 unsigned int fwd_tsn_cnt;
1019 /* amount of data (bytes) currently in flight (on all destinations) */
1020 unsigned int total_flight;
1021 /* Total book size in flight */
1022 unsigned int total_flight_count; /* count of chunks used with
1024 /* count of destinaton nets and list of destination nets */
1025 unsigned int numnets;
1027 /* Total error count on this association */
1028 unsigned int overall_error_count;
1030 unsigned int cnt_msg_on_sb;
1032 /* All stream count of chunks for delivery */
1033 unsigned int size_on_all_streams;
1034 unsigned int cnt_on_all_streams;
1036 /* Heart Beat delay in ms */
1037 uint32_t heart_beat_delay;
1040 unsigned int sctp_autoclose_ticks;
1042 /* how many preopen streams we have */
1043 unsigned int pre_open_streams;
1045 /* How many streams I support coming into me */
1046 unsigned int max_inbound_streams;
1048 /* the cookie life I award for any cookie, in seconds */
1049 unsigned int cookie_life;
1050 /* time to delay acks for */
1051 unsigned int delayed_ack;
1052 unsigned int old_delayed_ack;
1053 unsigned int sack_freq;
1054 unsigned int data_pkts_seen;
1056 unsigned int numduptsns;
1057 int dup_tsns[SCTP_MAX_DUP_TSNS];
1058 unsigned int initial_init_rto_max; /* initial RTO for INIT's */
1059 unsigned int initial_rto; /* initial send RTO */
1060 unsigned int minrto; /* per assoc RTO-MIN */
1061 unsigned int maxrto; /* per assoc RTO-MAX */
1063 /* authentication fields */
1064 sctp_auth_chklist_t *local_auth_chunks;
1065 sctp_auth_chklist_t *peer_auth_chunks;
1066 sctp_hmaclist_t *local_hmacs; /* local HMACs supported */
1067 sctp_hmaclist_t *peer_hmacs; /* peer HMACs supported */
1068 struct sctp_keyhead shared_keys; /* assoc's shared keys */
1069 sctp_authinfo_t authinfo; /* randoms, cached keys */
1071 * refcnt to block freeing when a sender or receiver is off coping
1075 uint32_t chunks_on_out_queue; /* total chunks floating around,
1076 * locked by send socket buffer */
1077 uint32_t peers_adaptation;
1078 uint16_t peer_hmac_id; /* peer HMAC id to send */
1081 * Being that we have no bag to collect stale cookies, and that we
1082 * really would not want to anyway.. we will count them in this
1083 * counter. We of course feed them to the pigeons right away (I have
1084 * always thought of pigeons as flying rats).
1086 uint16_t stale_cookie_count;
1089 * For the partial delivery API, if up, invoked this is what last
1092 uint16_t str_of_pdapi;
1093 uint16_t ssn_of_pdapi;
1095 /* counts of actual built streams. Allocation may be more however */
1096 /* could re-arrange to optimize space here. */
1097 uint16_t streamincnt;
1098 uint16_t streamoutcnt;
1099 uint16_t strm_realoutsize;
1100 uint16_t strm_pending_add_size;
1101 /* my maximum number of retrans of INIT and SEND */
1102 /* copied from SCTP but should be individually setable */
1103 uint16_t max_init_times;
1104 uint16_t max_send_times;
1106 uint16_t def_net_failure;
1108 uint16_t def_net_pf_threshold;
1111 * lock flag: 0 is ok to send, 1+ (duals as a retran count) is
1114 uint16_t mapping_array_size;
1116 uint16_t last_strm_seq_delivered;
1117 uint16_t last_strm_no_delivered;
1119 uint16_t last_revoke_count;
1120 int16_t num_send_timers_up;
1122 uint16_t stream_locked_on;
1123 uint16_t ecn_echo_cnt_onq;
1125 uint16_t free_chunk_cnt;
1126 uint8_t stream_locked;
1127 uint8_t authenticated; /* packet authenticated ok */
1129 * This flag indicates that a SACK need to be sent. Initially this
1130 * is 1 to send the first sACK immediately.
1134 /* max burst of new packets into the network */
1136 /* max burst of fast retransmit packets */
1137 uint32_t fr_max_burst;
1139 uint8_t sat_network; /* RTT is in range of sat net or greater */
1140 uint8_t sat_network_lockout; /* lockout code */
1141 uint8_t burst_limit_applied; /* Burst limit in effect at last send? */
1142 /* flag goes on when we are doing a partial delivery api */
1143 uint8_t hb_random_values[4];
1144 uint8_t fragmented_delivery_inprogress;
1145 uint8_t fragment_flags;
1146 uint8_t last_flags_delivered;
1147 uint8_t hb_ect_randombit;
1148 uint8_t hb_random_idx;
1149 uint8_t default_dscp;
1150 uint8_t asconf_del_pending; /* asconf delete last addr pending */
1153 * This value, plus all other ack'd but above cum-ack is added
1154 * together to cross check against the bit that we have yet to
1155 * define (probably in the SACK). When the cum-ack is updated, this
1156 * sum is updated as well.
1159 /* Flags whether an extension is supported or not */
1160 uint8_t ecn_supported;
1161 uint8_t prsctp_supported;
1162 uint8_t auth_supported;
1163 uint8_t asconf_supported;
1164 uint8_t reconfig_supported;
1165 uint8_t nrsack_supported;
1166 uint8_t pktdrop_supported;
1168 /* Did the peer make the stream config (add out) request */
1169 uint8_t peer_req_out;
1171 uint8_t local_strreset_support;
1173 uint8_t peer_supports_nat;
1175 struct sctp_scoping scope;
1176 /* flags to handle send alternate net tracking */
1177 uint8_t used_alt_asconfack;
1178 uint8_t fast_retran_loss_recovery;
1179 uint8_t sat_t3_loss_recovery;
1180 uint8_t dropped_special_cnt;
1181 uint8_t seen_a_sack_this_pkt;
1182 uint8_t stream_reset_outstanding;
1183 uint8_t stream_reset_out_is_outstanding;
1184 uint8_t delayed_connection;
1185 uint8_t ifp_had_enobuf;
1186 uint8_t saw_sack_with_frags;
1187 uint8_t saw_sack_with_nr_frags;
1188 uint8_t in_asocid_hash;
1189 uint8_t assoc_up_sent;
1190 uint8_t adaptation_needed;
1191 uint8_t adaptation_sent;
1193 uint8_t cmt_dac_pkts_rcvd;
1194 uint8_t sctp_cmt_on_off;
1195 uint8_t iam_blocking;
1196 uint8_t cookie_how[8];
1197 /* JRS 5/21/07 - CMT PF variable */
1198 uint8_t sctp_cmt_pf;
1199 uint8_t use_precise_time;
1200 uint64_t sctp_features;
1202 uint16_t port; /* remote UDP encapsulation port */
1204 * The mapping array is used to track out of order sequences above
1205 * last_acked_seq. 0 indicates packet missing 1 indicates packet
1206 * rec'd. We slide it up every time we raise last_acked_seq and 0
1207 * trailing locactions out. If I get a TSN above the array
1208 * mappingArraySz, I discard the datagram and let retransmit happen.
1210 uint32_t marked_retrans;
1214 uint32_t timoshutdown;
1215 uint32_t timoheartbeat;
1216 uint32_t timocookie;
1217 uint32_t timoshutdownack;
1218 struct timeval start_time;
1219 struct timeval discontinuity_time;
1220 uint64_t abandoned_unsent[SCTP_PR_SCTP_MAX + 1];
1221 uint64_t abandoned_sent[SCTP_PR_SCTP_MAX + 1];