xref: /freebsd/sys/netinet/sctp_structs.h (revision d9f0ce31900a48d1a2bfc1c8c86f79d1e831451a)
1 /*-
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.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * a) Redistributions of source code must retain the above copyright notice,
10  *    this list of conditions and the following disclaimer.
11  *
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.
15  *
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.
19  *
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.
31  */
32 
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
35 
36 #ifndef _NETINET_SCTP_STRUCTS_H_
37 #define _NETINET_SCTP_STRUCTS_H_
38 
39 #include <netinet/sctp_os.h>
40 #include <netinet/sctp_header.h>
41 #include <netinet/sctp_auth.h>
42 
43 struct sctp_timer {
44 	sctp_os_timer_t timer;
45 
46 	int type;
47 	/*
48 	 * Depending on the timer type these will be setup and cast with the
49 	 * appropriate entity.
50 	 */
51 	void *ep;
52 	void *tcb;
53 	void *net;
54 	void *vnet;
55 
56 	/* for sanity checking */
57 	void *self;
58 	uint32_t ticks;
59 	uint32_t stopped_from;
60 };
61 
62 
63 struct sctp_foo_stuff {
64 	struct sctp_inpcb *inp;
65 	uint32_t lineno;
66 	uint32_t ticks;
67 	int updown;
68 };
69 
70 
71 /*
72  * This is the information we track on each interface that we know about from
73  * the distant end.
74  */
75 TAILQ_HEAD(sctpnetlisthead, sctp_nets);
76 
77 struct sctp_stream_reset_list {
78 	TAILQ_ENTRY(sctp_stream_reset_list) next_resp;
79 	uint32_t seq;
80 	uint32_t tsn;
81 	uint32_t number_entries;
82 	uint16_t list_of_streams[];
83 };
84 
85 TAILQ_HEAD(sctp_resethead, sctp_stream_reset_list);
86 
87 /*
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);
91  *
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.
94  *
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.
100  */
101 #define SCTP_PCB_ANY_FLAGS	0x00000000
102 #define SCTP_PCB_ANY_FEATURES	0x00000000
103 #define SCTP_ASOC_ANY_STATE	0x00000000
104 
105 typedef void (*asoc_func) (struct sctp_inpcb *, struct sctp_tcb *, void *ptr,
106          uint32_t val);
107 typedef int (*inp_func) (struct sctp_inpcb *, void *ptr, uint32_t val);
108 typedef void (*end_func) (void *ptr, uint32_t val);
109 
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;
114 	struct vnet *vn;
115 	struct mbuf *m;
116 	int off;
117 	int v6;
118 };
119 
120 TAILQ_HEAD(sctp_mcore_qhead, sctp_mcore_queue);
121 
122 struct sctp_mcore_ctrl {
123 	SCTP_PROCESS_STRUCT thread_proc;
124 	struct sctp_mcore_qhead que;
125 	struct mtx core_mtx;
126 	struct mtx que_mtx;
127 	int running;
128 	int cpuid;
129 };
130 
131 
132 #endif
133 
134 
135 struct sctp_iterator {
136 	TAILQ_ENTRY(sctp_iterator) sctp_nxt_itr;
137 	struct vnet *vn;
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;
154 };
155 
156 /* iterator_flags values */
157 #define SCTP_ITERATOR_DO_ALL_INP	0x00000001
158 #define SCTP_ITERATOR_DO_SINGLE_INP	0x00000002
159 
160 
161 TAILQ_HEAD(sctpiterators, sctp_iterator);
162 
163 struct sctp_copy_all {
164 	struct sctp_inpcb *inp;	/* ep */
165 	struct mbuf *m;
166 	struct sctp_sndrcvinfo sndrcv;
167 	int sndlen;
168 	int cnt_sent;
169 	int cnt_failed;
170 };
171 
172 struct sctp_asconf_iterator {
173 	struct sctpladdr list_of_work;
174 	int cnt;
175 };
176 
177 struct iterator_control {
178 	struct mtx ipi_iterator_wq_mtx;
179 	struct mtx it_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;
185 };
186 
187 #define SCTP_ITERATOR_STOP_CUR_IT	0x00000004
188 #define SCTP_ITERATOR_STOP_CUR_INP	0x00000008
189 
190 struct sctp_net_route {
191 	sctp_rtentry_t *ro_rt;
192 	char *ro_prepend;
193 	uint16_t ro_plen;
194 	uint16_t ro_flags;
195 	uint16_t ro_mtu;
196 	uint16_t spare;
197 	union sctp_sockstore _l_addr;	/* remote peer addr */
198 	struct sctp_ifa *_s_addr;	/* our selected src addr */
199 };
200 
201 struct htcp {
202 	uint16_t alpha;		/* Fixed point arith, << 7 */
203 	uint8_t beta;		/* Fixed point arith, << 7 */
204 	uint8_t modeswitch;	/* Delay modeswitch until we had at least one
205 				 * congestion event */
206 	uint32_t last_cong;	/* Time since last congestion event end */
207 	uint32_t undo_last_cong;
208 	uint16_t bytes_acked;
209 	uint32_t bytecount;
210 	uint32_t minRTT;
211 	uint32_t maxRTT;
212 
213 	uint32_t undo_maxRTT;
214 	uint32_t undo_old_maxB;
215 
216 	/* Bandwidth estimation */
217 	uint32_t minB;
218 	uint32_t maxB;
219 	uint32_t old_maxB;
220 	uint32_t Bi;
221 	uint32_t lasttime;
222 };
223 
224 struct rtcc_cc {
225 	struct timeval tls;	/* The time we started the sending  */
226 	uint64_t lbw;		/* Our last estimated bw */
227 	uint64_t lbw_rtt;	/* RTT at bw estimate */
228 	uint64_t bw_bytes;	/* The total bytes since this sending began */
229 	uint64_t bw_tot_time;	/* The total time since sending began */
230 	uint64_t new_tot_time;	/* temp holding the new value */
231 	uint64_t bw_bytes_at_last_rttc;	/* What bw_bytes was at last rtt calc */
232 	uint32_t cwnd_at_bw_set;/* Cwnd at last bw saved - lbw */
233 	uint32_t vol_reduce;	/* cnt of voluntary reductions */
234 	uint16_t steady_step;	/* The number required to be in steady state */
235 	uint16_t step_cnt;	/* The current number */
236 	uint8_t ret_from_eq;	/* When all things are equal what do I return
237 				 * 0/1 - 1 no cc advance */
238 	uint8_t use_dccc_ecn;	/* Flag to enable DCCC ECN */
239 	uint8_t tls_needs_set;	/* Flag to indicate we need to set tls 0 or 1
240 				 * means set at send 2 not */
241 	uint8_t last_step_state;/* Last state if steady state stepdown is on */
242 	uint8_t rtt_set_this_sack;	/* Flag saying this sack had RTT calc
243 					 * on it */
244 	uint8_t last_inst_ind;	/* Last saved inst indication */
245 };
246 
247 
248 struct sctp_nets {
249 	TAILQ_ENTRY(sctp_nets) sctp_next;	/* next link */
250 
251 	/*
252 	 * Things on the top half may be able to be split into a common
253 	 * structure shared by all.
254 	 */
255 	struct sctp_timer pmtu_timer;
256 	struct sctp_timer hb_timer;
257 
258 	/*
259 	 * The following two in combination equate to a route entry for v6
260 	 * or v4.
261 	 */
262 	struct sctp_net_route ro;
263 
264 	/* mtu discovered so far */
265 	uint32_t mtu;
266 	uint32_t ssthresh;	/* not sure about this one for split */
267 	uint32_t last_cwr_tsn;
268 	uint32_t cwr_window_tsn;
269 	uint32_t ecn_ce_pkt_cnt;
270 	uint32_t lost_cnt;
271 	/* smoothed average things for RTT and RTO itself */
272 	int lastsa;
273 	int lastsv;
274 	uint64_t rtt;		/* last measured rtt value in us */
275 	unsigned int RTO;
276 
277 	/* This is used for SHUTDOWN/SHUTDOWN-ACK/SEND or INIT timers */
278 	struct sctp_timer rxt_timer;
279 
280 	/* last time in seconds I sent to it */
281 	struct timeval last_sent_time;
282 	union cc_control_data {
283 		struct htcp htcp_ca;	/* JRS - struct used in HTCP algorithm */
284 		struct rtcc_cc rtcc;	/* rtcc module cc stuff  */
285 	}               cc_mod;
286 	int ref_count;
287 
288 	/* Congestion stats per destination */
289 	/*
290 	 * flight size variables and such, sorry Vern, I could not avoid
291 	 * this if I wanted performance :>
292 	 */
293 	uint32_t flight_size;
294 	uint32_t cwnd;		/* actual cwnd */
295 	uint32_t prev_cwnd;	/* cwnd before any processing */
296 	uint32_t ecn_prev_cwnd;	/* ECN prev cwnd at first ecn_echo seen in new
297 				 * window */
298 	uint32_t partial_bytes_acked;	/* in CA tracks when to incr a MTU */
299 	/* tracking variables to avoid the aloc/free in sack processing */
300 	unsigned int net_ack;
301 	unsigned int net_ack2;
302 
303 	/*
304 	 * JRS - 5/8/07 - Variable to track last time a destination was
305 	 * active for CMT PF
306 	 */
307 	uint32_t last_active;
308 
309 	/*
310 	 * CMT variables (iyengar@cis.udel.edu)
311 	 */
312 	uint32_t this_sack_highest_newack;	/* tracks highest TSN newly
313 						 * acked for a given dest in
314 						 * the current SACK. Used in
315 						 * SFR and HTNA algos */
316 	uint32_t pseudo_cumack;	/* CMT CUC algorithm. Maintains next expected
317 				 * pseudo-cumack for this destination */
318 	uint32_t rtx_pseudo_cumack;	/* CMT CUC algorithm. Maintains next
319 					 * expected pseudo-cumack for this
320 					 * destination */
321 
322 	/* CMT fast recovery variables */
323 	uint32_t fast_recovery_tsn;
324 	uint32_t heartbeat_random1;
325 	uint32_t heartbeat_random2;
326 #ifdef INET6
327 	uint32_t flowlabel;
328 #endif
329 	uint8_t dscp;
330 
331 	struct timeval start_time;	/* time when this net was created */
332 	uint32_t marked_retrans;/* number or DATA chunks marked for timer
333 				 * based retransmissions */
334 	uint32_t marked_fastretrans;
335 	uint32_t heart_beat_delay;	/* Heart Beat delay in ms */
336 
337 	/* if this guy is ok or not ... status */
338 	uint16_t dest_state;
339 	/* number of timeouts to consider the destination unreachable */
340 	uint16_t failure_threshold;
341 	/* number of timeouts to consider the destination potentially failed */
342 	uint16_t pf_threshold;
343 	/* error stats on the destination */
344 	uint16_t error_count;
345 	/* UDP port number in case of UDP tunneling */
346 	uint16_t port;
347 
348 	uint8_t fast_retran_loss_recovery;
349 	uint8_t will_exit_fast_recovery;
350 	/* Flags that probably can be combined into dest_state */
351 	uint8_t fast_retran_ip;	/* fast retransmit in progress */
352 	uint8_t hb_responded;
353 	uint8_t saw_newack;	/* CMT's SFR algorithm flag */
354 	uint8_t src_addr_selected;	/* if we split we move */
355 	uint8_t indx_of_eligible_next_to_use;
356 	uint8_t addr_is_local;	/* its a local address (if known) could move
357 				 * in split */
358 
359 	/*
360 	 * CMT variables (iyengar@cis.udel.edu)
361 	 */
362 	uint8_t find_pseudo_cumack;	/* CMT CUC algorithm. Flag used to
363 					 * find a new pseudocumack. This flag
364 					 * is set after a new pseudo-cumack
365 					 * has been received and indicates
366 					 * that the sender should find the
367 					 * next pseudo-cumack expected for
368 					 * this destination */
369 	uint8_t find_rtx_pseudo_cumack;	/* CMT CUCv2 algorithm. Flag used to
370 					 * find a new rtx-pseudocumack. This
371 					 * flag is set after a new
372 					 * rtx-pseudo-cumack has been received
373 					 * and indicates that the sender
374 					 * should find the next
375 					 * rtx-pseudo-cumack expected for this
376 					 * destination */
377 	uint8_t new_pseudo_cumack;	/* CMT CUC algorithm. Flag used to
378 					 * indicate if a new pseudo-cumack or
379 					 * rtx-pseudo-cumack has been received */
380 	uint8_t window_probe;	/* Doing a window probe? */
381 	uint8_t RTO_measured;	/* Have we done the first measure */
382 	uint8_t last_hs_used;	/* index into the last HS table entry we used */
383 	uint8_t lan_type;
384 	uint8_t rto_needed;
385 	uint32_t flowid;
386 	uint8_t flowtype;
387 };
388 
389 
390 struct sctp_data_chunkrec {
391 	uint32_t TSN_seq;	/* the TSN of this transmit */
392 	uint32_t stream_seq;	/* the stream sequence number of this transmit */
393 	uint16_t stream_number;	/* the stream number of this guy */
394 	uint32_t payloadtype;
395 	uint32_t context;	/* from send */
396 	uint32_t cwnd_at_send;
397 	/*
398 	 * part of the Highest sacked algorithm to be able to stroke counts
399 	 * on ones that are FR'd.
400 	 */
401 	uint32_t fast_retran_tsn;	/* sending_seq at the time of FR */
402 	struct timeval timetodrop;	/* time we drop it from queue */
403 	uint32_t fsn_num;	/* Fragment Sequence Number */
404 	uint8_t doing_fast_retransmit;
405 	uint8_t rcv_flags;	/* flags pulled from data chunk on inbound for
406 				 * outbound holds sending flags for PR-SCTP. */
407 	uint8_t state_flags;
408 	uint8_t chunk_was_revoked;
409 	uint8_t fwd_tsn_cnt;
410 };
411 
412 TAILQ_HEAD(sctpchunk_listhead, sctp_tmit_chunk);
413 
414 /* The lower byte is used to enumerate PR_SCTP policies */
415 #define CHUNK_FLAGS_PR_SCTP_TTL	        SCTP_PR_SCTP_TTL
416 #define CHUNK_FLAGS_PR_SCTP_BUF	        SCTP_PR_SCTP_BUF
417 #define CHUNK_FLAGS_PR_SCTP_RTX         SCTP_PR_SCTP_RTX
418 
419 /* The upper byte is used as a bit mask */
420 #define CHUNK_FLAGS_FRAGMENT_OK	        0x0100
421 
422 struct chk_id {
423 	uint8_t id;
424 	uint8_t can_take_data;
425 };
426 
427 
428 struct sctp_tmit_chunk {
429 	union {
430 		struct sctp_data_chunkrec data;
431 		struct chk_id chunk_id;
432 	}     rec;
433 	struct sctp_association *asoc;	/* bp to asoc this belongs to */
434 	struct timeval sent_rcv_time;	/* filled in if RTT being calculated */
435 	struct mbuf *data;	/* pointer to mbuf chain of data */
436 	struct mbuf *last_mbuf;	/* pointer to last mbuf in chain */
437 	struct sctp_nets *whoTo;
438 	          TAILQ_ENTRY(sctp_tmit_chunk) sctp_next;	/* next link */
439 	int32_t sent;		/* the send status */
440 	uint16_t snd_count;	/* number of times I sent */
441 	uint16_t flags;		/* flags, such as FRAGMENT_OK */
442 	uint16_t send_size;
443 	uint16_t book_size;
444 	uint16_t mbcnt;
445 	uint16_t auth_keyid;
446 	uint8_t holds_key_ref;	/* flag if auth keyid refcount is held */
447 	uint8_t pad_inplace;
448 	uint8_t do_rtt;
449 	uint8_t book_size_scale;
450 	uint8_t no_fr_allowed;
451 	uint8_t copy_by_ref;
452 	uint8_t window_probe;
453 };
454 
455 /*
456  * The first part of this structure MUST be the entire sinfo structure. Maybe
457  * I should have made it a sub structure... we can circle back later and do
458  * that if we want.
459  */
460 struct sctp_queued_to_read {	/* sinfo structure Pluse more */
461 	uint16_t sinfo_stream;	/* off the wire */
462 	uint32_t sinfo_ssn;	/* off the wire */
463 	uint16_t sinfo_flags;	/* SCTP_UNORDERED from wire use SCTP_EOF for
464 				 * EOR */
465 	uint32_t sinfo_ppid;	/* off the wire */
466 	uint32_t sinfo_context;	/* pick this up from assoc def context? */
467 	uint32_t sinfo_timetolive;	/* not used by kernel */
468 	uint32_t sinfo_tsn;	/* Use this in reassembly as first TSN */
469 	uint32_t sinfo_cumtsn;	/* Use this in reassembly as last TSN */
470 	sctp_assoc_t sinfo_assoc_id;	/* our assoc id */
471 	/* Non sinfo stuff */
472 	uint32_t msg_id;	/* Fragment Index */
473 	uint32_t length;	/* length of data */
474 	uint32_t held_length;	/* length held in sb */
475 	uint32_t top_fsn;	/* Highest FSN in queue */
476 	uint32_t fsn_included;	/* Highest FSN in *data portion */
477 	struct sctp_nets *whoFrom;	/* where it came from */
478 	struct mbuf *data;	/* front of the mbuf chain of data with
479 				 * PKT_HDR */
480 	struct mbuf *tail_mbuf;	/* used for multi-part data */
481 	struct mbuf *aux_data;	/* used to hold/cache  control if o/s does not
482 				 * take it from us */
483 	struct sctp_tcb *stcb;	/* assoc, used for window update */
484 	         TAILQ_ENTRY(sctp_queued_to_read) next;
485 	         TAILQ_ENTRY(sctp_queued_to_read) next_instrm;
486 	struct sctpchunk_listhead reasm;
487 	uint16_t port_from;
488 	uint16_t spec_flags;	/* Flags to hold the notification field */
489 	uint8_t do_not_ref_stcb;
490 	uint8_t end_added;
491 	uint8_t pdapi_aborted;
492 	uint8_t pdapi_started;
493 	uint8_t some_taken;
494 	uint8_t last_frag_seen;
495 	uint8_t first_frag_seen;
496 	uint8_t on_read_q;
497 	uint8_t on_strm_q;
498 };
499 
500 #define SCTP_ON_ORDERED 1
501 #define SCTP_ON_UNORDERED 2
502 
503 /* This data structure will be on the outbound
504  * stream queues. Data will be pulled off from
505  * the front of the mbuf data and chunk-ified
506  * by the output routines. We will custom
507  * fit every chunk we pull to the send/sent
508  * queue to make up the next full packet
509  * if we can. An entry cannot be removed
510  * from the stream_out queue until
511  * the msg_is_complete flag is set. This
512  * means at times data/tail_mbuf MIGHT
513  * be NULL.. If that occurs it happens
514  * for one of two reasons. Either the user
515  * is blocked on a send() call and has not
516  * awoken to copy more data down... OR
517  * the user is in the explict MSG_EOR mode
518  * and wrote some data, but has not completed
519  * sending.
520  */
521 struct sctp_stream_queue_pending {
522 	struct mbuf *data;
523 	struct mbuf *tail_mbuf;
524 	struct timeval ts;
525 	struct sctp_nets *net;
526 	          TAILQ_ENTRY(sctp_stream_queue_pending) next;
527 	          TAILQ_ENTRY(sctp_stream_queue_pending) ss_next;
528 	uint32_t fsn;
529 	uint32_t msg_id;
530 	uint32_t length;
531 	uint32_t timetolive;
532 	uint32_t ppid;
533 	uint32_t context;
534 	uint16_t sinfo_flags;
535 	uint16_t stream;
536 	uint16_t act_flags;
537 	uint16_t auth_keyid;
538 	uint8_t holds_key_ref;
539 	uint8_t msg_is_complete;
540 	uint8_t some_taken;
541 	uint8_t sender_all_done;
542 	uint8_t put_last_out;
543 	uint8_t discard_rest;
544 };
545 
546 /*
547  * this struct contains info that is used to track inbound stream data and
548  * help with ordering.
549  */
550 TAILQ_HEAD(sctpwheelunrel_listhead, sctp_stream_in);
551 struct sctp_stream_in {
552 	struct sctp_readhead inqueue;
553 	struct sctp_readhead uno_inqueue;
554 	uint32_t last_sequence_delivered;	/* used for re-order */
555 	uint16_t stream_no;
556 	uint8_t delivery_started;
557 	uint8_t pd_api_started;
558 };
559 
560 TAILQ_HEAD(sctpwheel_listhead, sctp_stream_out);
561 TAILQ_HEAD(sctplist_listhead, sctp_stream_queue_pending);
562 
563 /* Round-robin schedulers */
564 struct ss_rr {
565 	/* next link in wheel */
566 	TAILQ_ENTRY(sctp_stream_out) next_spoke;
567 };
568 
569 /* Priority scheduler */
570 struct ss_prio {
571 	/* next link in wheel */
572 	TAILQ_ENTRY(sctp_stream_out) next_spoke;
573 	/* priority id */
574 	uint16_t priority;
575 };
576 
577 /* Fair Bandwidth scheduler */
578 struct ss_fb {
579 	/* next link in wheel */
580 	TAILQ_ENTRY(sctp_stream_out) next_spoke;
581 	/* stores message size */
582 	int32_t rounds;
583 };
584 
585 /*
586  * This union holds all data necessary for
587  * different stream schedulers.
588  */
589 union scheduling_data {
590 	struct sctpwheel_listhead out_wheel;
591 	struct sctplist_listhead out_list;
592 };
593 
594 /*
595  * This union holds all parameters per stream
596  * necessary for different stream schedulers.
597  */
598 union scheduling_parameters {
599 	struct ss_rr rr;
600 	struct ss_prio prio;
601 	struct ss_fb fb;
602 };
603 
604 /* States for outgoing streams */
605 #define SCTP_STREAM_CLOSED           0x00
606 #define SCTP_STREAM_OPENING          0x01
607 #define SCTP_STREAM_OPEN             0x02
608 #define SCTP_STREAM_RESET_PENDING    0x03
609 #define SCTP_STREAM_RESET_IN_FLIGHT  0x04
610 
611 #define SCTP_MAX_STREAMS_AT_ONCE_RESET 200
612 
613 /* This struct is used to track the traffic on outbound streams */
614 struct sctp_stream_out {
615 	struct sctp_streamhead outqueue;
616 	union scheduling_parameters ss_params;
617 	uint32_t chunks_on_queues;	/* send queue and sent queue */
618 #if defined(SCTP_DETAILED_STR_STATS)
619 	uint32_t abandoned_unsent[SCTP_PR_SCTP_MAX + 1];
620 	uint32_t abandoned_sent[SCTP_PR_SCTP_MAX + 1];
621 #else
622 	/* Only the aggregation */
623 	uint32_t abandoned_unsent[1];
624 	uint32_t abandoned_sent[1];
625 #endif
626 	uint32_t next_sequence_send;	/* next one I expect to send out */
627 	uint16_t stream_no;
628 	uint8_t last_msg_incomplete;
629 	uint8_t state;
630 };
631 
632 /* used to keep track of the addresses yet to try to add/delete */
633 TAILQ_HEAD(sctp_asconf_addrhead, sctp_asconf_addr);
634 struct sctp_asconf_addr {
635 	TAILQ_ENTRY(sctp_asconf_addr) next;
636 	struct sctp_asconf_addr_param ap;
637 	struct sctp_ifa *ifa;	/* save the ifa for add/del ip */
638 	uint8_t sent;		/* has this been sent yet? */
639 	uint8_t special_del;	/* not to be used in lookup */
640 };
641 
642 struct sctp_scoping {
643 	uint8_t ipv4_addr_legal;
644 	uint8_t ipv6_addr_legal;
645 	uint8_t loopback_scope;
646 	uint8_t ipv4_local_scope;
647 	uint8_t local_scope;
648 	uint8_t site_scope;
649 };
650 
651 #define SCTP_TSN_LOG_SIZE 40
652 
653 struct sctp_tsn_log {
654 	void *stcb;
655 	uint32_t tsn;
656 	uint32_t seq;
657 	uint16_t strm;
658 	uint16_t sz;
659 	uint16_t flgs;
660 	uint16_t in_pos;
661 	uint16_t in_out;
662 	uint16_t resv;
663 };
664 
665 #define SCTP_FS_SPEC_LOG_SIZE 200
666 struct sctp_fs_spec_log {
667 	uint32_t sent;
668 	uint32_t total_flight;
669 	uint32_t tsn;
670 	uint16_t book;
671 	uint8_t incr;
672 	uint8_t decr;
673 };
674 
675 /* This struct is here to cut out the compatiabilty
676  * pad that bulks up both the inp and stcb. The non
677  * pad portion MUST stay in complete sync with
678  * sctp_sndrcvinfo... i.e. if sinfo_xxxx is added
679  * this must be done here too.
680  */
681 struct sctp_nonpad_sndrcvinfo {
682 	uint16_t sinfo_stream;
683 	uint16_t sinfo_ssn;
684 	uint16_t sinfo_flags;
685 	uint32_t sinfo_ppid;
686 	uint32_t sinfo_context;
687 	uint32_t sinfo_timetolive;
688 	uint32_t sinfo_tsn;
689 	uint32_t sinfo_cumtsn;
690 	sctp_assoc_t sinfo_assoc_id;
691 	uint16_t sinfo_keynumber;
692 	uint16_t sinfo_keynumber_valid;
693 };
694 
695 /*
696  * JRS - Structure to hold function pointers to the functions responsible
697  * for congestion control.
698  */
699 
700 struct sctp_cc_functions {
701 	void (*sctp_set_initial_cc_param) (struct sctp_tcb *stcb, struct sctp_nets *net);
702 	void (*sctp_cwnd_update_after_sack) (struct sctp_tcb *stcb,
703 	         struct sctp_association *asoc,
704 	         int accum_moved, int reneged_all, int will_exit);
705 	void (*sctp_cwnd_update_exit_pf) (struct sctp_tcb *stcb, struct sctp_nets *net);
706 	void (*sctp_cwnd_update_after_fr) (struct sctp_tcb *stcb,
707 	         struct sctp_association *asoc);
708 	void (*sctp_cwnd_update_after_timeout) (struct sctp_tcb *stcb,
709 	         struct sctp_nets *net);
710 	void (*sctp_cwnd_update_after_ecn_echo) (struct sctp_tcb *stcb,
711 	         struct sctp_nets *net, int in_window, int num_pkt_lost);
712 	void (*sctp_cwnd_update_after_packet_dropped) (struct sctp_tcb *stcb,
713 	         struct sctp_nets *net, struct sctp_pktdrop_chunk *cp,
714 	         uint32_t * bottle_bw, uint32_t * on_queue);
715 	void (*sctp_cwnd_update_after_output) (struct sctp_tcb *stcb,
716 	         struct sctp_nets *net, int burst_limit);
717 	void (*sctp_cwnd_update_packet_transmitted) (struct sctp_tcb *stcb,
718 	         struct sctp_nets *net);
719 	void (*sctp_cwnd_update_tsn_acknowledged) (struct sctp_nets *net,
720 	         struct sctp_tmit_chunk *);
721 	void (*sctp_cwnd_new_transmission_begins) (struct sctp_tcb *stcb,
722 	         struct sctp_nets *net);
723 	void (*sctp_cwnd_prepare_net_for_sack) (struct sctp_tcb *stcb,
724 	         struct sctp_nets *net);
725 	int (*sctp_cwnd_socket_option) (struct sctp_tcb *stcb, int set, struct sctp_cc_option *);
726 	void (*sctp_rtt_calculated) (struct sctp_tcb *, struct sctp_nets *, struct timeval *);
727 };
728 
729 /*
730  * RS - Structure to hold function pointers to the functions responsible
731  * for stream scheduling.
732  */
733 struct sctp_ss_functions {
734 	void (*sctp_ss_init) (struct sctp_tcb *stcb, struct sctp_association *asoc,
735 	         int holds_lock);
736 	void (*sctp_ss_clear) (struct sctp_tcb *stcb, struct sctp_association *asoc,
737 	         int clear_values, int holds_lock);
738 	void (*sctp_ss_init_stream) (struct sctp_stream_out *strq, struct sctp_stream_out *with_strq);
739 	void (*sctp_ss_add_to_stream) (struct sctp_tcb *stcb, struct sctp_association *asoc,
740 	         struct sctp_stream_out *strq, struct sctp_stream_queue_pending *sp, int holds_lock);
741 	int (*sctp_ss_is_empty) (struct sctp_tcb *stcb, struct sctp_association *asoc);
742 	void (*sctp_ss_remove_from_stream) (struct sctp_tcb *stcb, struct sctp_association *asoc,
743 	         struct sctp_stream_out *strq, struct sctp_stream_queue_pending *sp, int holds_lock);
744 	struct sctp_stream_out *(*sctp_ss_select_stream) (struct sctp_tcb *stcb,
745 	                    struct sctp_nets *net, struct sctp_association *asoc);
746 	void (*sctp_ss_scheduled) (struct sctp_tcb *stcb, struct sctp_nets *net,
747 	         struct sctp_association *asoc, struct sctp_stream_out *strq, int moved_how_much);
748 	void (*sctp_ss_packet_done) (struct sctp_tcb *stcb, struct sctp_nets *net,
749 	         struct sctp_association *asoc);
750 	int (*sctp_ss_get_value) (struct sctp_tcb *stcb, struct sctp_association *asoc,
751 	        struct sctp_stream_out *strq, uint16_t * value);
752 	int (*sctp_ss_set_value) (struct sctp_tcb *stcb, struct sctp_association *asoc,
753 	        struct sctp_stream_out *strq, uint16_t value);
754 };
755 
756 /* used to save ASCONF chunks for retransmission */
757 TAILQ_HEAD(sctp_asconf_head, sctp_asconf);
758 struct sctp_asconf {
759 	TAILQ_ENTRY(sctp_asconf) next;
760 	uint32_t serial_number;
761 	uint16_t snd_count;
762 	struct mbuf *data;
763 	uint16_t len;
764 };
765 
766 /* used to save ASCONF-ACK chunks for retransmission */
767 TAILQ_HEAD(sctp_asconf_ackhead, sctp_asconf_ack);
768 struct sctp_asconf_ack {
769 	TAILQ_ENTRY(sctp_asconf_ack) next;
770 	uint32_t serial_number;
771 	struct sctp_nets *last_sent_to;
772 	struct mbuf *data;
773 	uint16_t len;
774 };
775 
776 /*
777  * Here we have information about each individual association that we track.
778  * We probably in production would be more dynamic. But for ease of
779  * implementation we will have a fixed array that we hunt for in a linear
780  * fashion.
781  */
782 struct sctp_association {
783 	/* association state */
784 	int state;
785 
786 	/* queue of pending addrs to add/delete */
787 	struct sctp_asconf_addrhead asconf_queue;
788 
789 	struct timeval time_entered;	/* time we entered state */
790 	struct timeval time_last_rcvd;
791 	struct timeval time_last_sent;
792 	struct timeval time_last_sat_advance;
793 	struct sctp_nonpad_sndrcvinfo def_send;
794 
795 	/* timers and such */
796 	struct sctp_timer dack_timer;	/* Delayed ack timer */
797 	struct sctp_timer asconf_timer;	/* asconf */
798 	struct sctp_timer strreset_timer;	/* stream reset */
799 	struct sctp_timer shut_guard_timer;	/* shutdown guard */
800 	struct sctp_timer autoclose_timer;	/* automatic close timer */
801 	struct sctp_timer delayed_event_timer;	/* timer for delayed events */
802 	struct sctp_timer delete_prim_timer;	/* deleting primary dst */
803 
804 	/* list of restricted local addresses */
805 	struct sctpladdr sctp_restricted_addrs;
806 
807 	/* last local address pending deletion (waiting for an address add) */
808 	struct sctp_ifa *asconf_addr_del_pending;
809 	/* Deleted primary destination (used to stop timer) */
810 	struct sctp_nets *deleted_primary;
811 
812 	struct sctpnetlisthead nets;	/* remote address list */
813 
814 	/* Free chunk list */
815 	struct sctpchunk_listhead free_chunks;
816 
817 	/* Control chunk queue */
818 	struct sctpchunk_listhead control_send_queue;
819 
820 	/* ASCONF chunk queue */
821 	struct sctpchunk_listhead asconf_send_queue;
822 
823 	/*
824 	 * Once a TSN hits the wire it is moved to the sent_queue. We
825 	 * maintain two counts here (don't know if any but retran_cnt is
826 	 * needed). The idea is that the sent_queue_retran_cnt reflects how
827 	 * many chunks have been marked for retranmission by either T3-rxt
828 	 * or FR.
829 	 */
830 	struct sctpchunk_listhead sent_queue;
831 	struct sctpchunk_listhead send_queue;
832 
833 	/* Scheduling queues */
834 	union scheduling_data ss_data;
835 
836 	/*
837 	 * This pointer will be set to NULL most of the time. But when we
838 	 * have a fragmented message, where we could not get out all of the
839 	 * message at the last send then this will point to the stream to go
840 	 * get data from.
841 	 */
842 	struct sctp_stream_out *locked_on_sending;
843 
844 	/* If an iterator is looking at me, this is it */
845 	struct sctp_iterator *stcb_starting_point_for_iterator;
846 
847 	/* ASCONF save the last ASCONF-ACK so we can resend it if necessary */
848 	struct sctp_asconf_ackhead asconf_ack_sent;
849 
850 	/*
851 	 * pointer to last stream reset queued to control queue by us with
852 	 * requests.
853 	 */
854 	struct sctp_tmit_chunk *str_reset;
855 	/*
856 	 * if Source Address Selection happening, this will rotate through
857 	 * the link list.
858 	 */
859 	struct sctp_laddr *last_used_address;
860 
861 	/* stream arrays */
862 	struct sctp_stream_in *strmin;
863 	struct sctp_stream_out *strmout;
864 	uint8_t *mapping_array;
865 	/* primary destination to use */
866 	struct sctp_nets *primary_destination;
867 	struct sctp_nets *alternate;	/* If primary is down or PF */
868 	/* For CMT */
869 	struct sctp_nets *last_net_cmt_send_started;
870 	/* last place I got a data chunk from */
871 	struct sctp_nets *last_data_chunk_from;
872 	/* last place I got a control from */
873 	struct sctp_nets *last_control_chunk_from;
874 
875 	/* circular looking for output selection */
876 	struct sctp_stream_out *last_out_stream;
877 
878 	/*
879 	 * wait to the point the cum-ack passes req->send_reset_at_tsn for
880 	 * any req on the list.
881 	 */
882 	struct sctp_resethead resetHead;
883 
884 	/* queue of chunks waiting to be sent into the local stack */
885 	struct sctp_readhead pending_reply_queue;
886 
887 	/* JRS - the congestion control functions are in this struct */
888 	struct sctp_cc_functions cc_functions;
889 	/*
890 	 * JRS - value to store the currently loaded congestion control
891 	 * module
892 	 */
893 	uint32_t congestion_control_module;
894 	/* RS - the stream scheduling functions are in this struct */
895 	struct sctp_ss_functions ss_functions;
896 	/* RS - value to store the currently loaded stream scheduling module */
897 	uint32_t stream_scheduling_module;
898 
899 	uint32_t vrf_id;
900 	uint32_t assoc_msg_id;
901 	uint32_t cookie_preserve_req;
902 	/* ASCONF next seq I am sending out, inits at init-tsn */
903 	uint32_t asconf_seq_out;
904 	uint32_t asconf_seq_out_acked;
905 	/* ASCONF last received ASCONF from peer, starts at peer's TSN-1 */
906 	uint32_t asconf_seq_in;
907 
908 	/* next seq I am sending in str reset messages */
909 	uint32_t str_reset_seq_out;
910 	/* next seq I am expecting in str reset messages */
911 	uint32_t str_reset_seq_in;
912 
913 	/* various verification tag information */
914 	uint32_t my_vtag;	/* The tag to be used. if assoc is re-initited
915 				 * by remote end, and I have unlocked this
916 				 * will be regenerated to a new random value. */
917 	uint32_t peer_vtag;	/* The peers last tag */
918 
919 	uint32_t my_vtag_nonce;
920 	uint32_t peer_vtag_nonce;
921 
922 	uint32_t assoc_id;
923 
924 	/* This is the SCTP fragmentation threshold */
925 	uint32_t smallest_mtu;
926 
927 	/*
928 	 * Special hook for Fast retransmit, allows us to track the highest
929 	 * TSN that is NEW in this SACK if gap ack blocks are present.
930 	 */
931 	uint32_t this_sack_highest_gap;
932 
933 	/*
934 	 * The highest consecutive TSN that has been acked by peer on my
935 	 * sends
936 	 */
937 	uint32_t last_acked_seq;
938 
939 	/* The next TSN that I will use in sending. */
940 	uint32_t sending_seq;
941 
942 	/* Original seq number I used ??questionable to keep?? */
943 	uint32_t init_seq_number;
944 
945 
946 	/* The Advanced Peer Ack Point, as required by the PR-SCTP */
947 	/* (A1 in Section 4.2) */
948 	uint32_t advanced_peer_ack_point;
949 
950 	/*
951 	 * The highest consequetive TSN at the bottom of the mapping array
952 	 * (for his sends).
953 	 */
954 	uint32_t cumulative_tsn;
955 	/*
956 	 * Used to track the mapping array and its offset bits. This MAY be
957 	 * lower then cumulative_tsn.
958 	 */
959 	uint32_t mapping_array_base_tsn;
960 	/*
961 	 * used to track highest TSN we have received and is listed in the
962 	 * mapping array.
963 	 */
964 	uint32_t highest_tsn_inside_map;
965 
966 	/* EY - new NR variables used for nr_sack based on mapping_array */
967 	uint8_t *nr_mapping_array;
968 	uint32_t highest_tsn_inside_nr_map;
969 
970 	uint32_t fast_recovery_tsn;
971 	uint32_t sat_t3_recovery_tsn;
972 	uint32_t tsn_last_delivered;
973 	/*
974 	 * For the pd-api we should re-write this a bit more efficent. We
975 	 * could have multiple sctp_queued_to_read's that we are building at
976 	 * once. Now we only do this when we get ready to deliver to the
977 	 * socket buffer. Note that we depend on the fact that the struct is
978 	 * "stuck" on the read queue until we finish all the pd-api.
979 	 */
980 	struct sctp_queued_to_read *control_pdapi;
981 
982 	uint32_t tsn_of_pdapi_last_delivered;
983 	uint32_t pdapi_ppid;
984 	uint32_t context;
985 	uint32_t last_reset_action[SCTP_MAX_RESET_PARAMS];
986 	uint32_t last_sending_seq[SCTP_MAX_RESET_PARAMS];
987 	uint32_t last_base_tsnsent[SCTP_MAX_RESET_PARAMS];
988 #ifdef SCTP_ASOCLOG_OF_TSNS
989 	/*
990 	 * special log  - This adds considerable size to the asoc, but
991 	 * provides a log that you can use to detect problems via kgdb.
992 	 */
993 	struct sctp_tsn_log in_tsnlog[SCTP_TSN_LOG_SIZE];
994 	struct sctp_tsn_log out_tsnlog[SCTP_TSN_LOG_SIZE];
995 	uint32_t cumack_log[SCTP_TSN_LOG_SIZE];
996 	uint32_t cumack_logsnt[SCTP_TSN_LOG_SIZE];
997 	uint16_t tsn_in_at;
998 	uint16_t tsn_out_at;
999 	uint16_t tsn_in_wrapped;
1000 	uint16_t tsn_out_wrapped;
1001 	uint16_t cumack_log_at;
1002 	uint16_t cumack_log_atsnt;
1003 #endif				/* SCTP_ASOCLOG_OF_TSNS */
1004 #ifdef SCTP_FS_SPEC_LOG
1005 	struct sctp_fs_spec_log fslog[SCTP_FS_SPEC_LOG_SIZE];
1006 	uint16_t fs_index;
1007 #endif
1008 
1009 	/*
1010 	 * window state information and smallest MTU that I use to bound
1011 	 * segmentation
1012 	 */
1013 	uint32_t peers_rwnd;
1014 	uint32_t my_rwnd;
1015 	uint32_t my_last_reported_rwnd;
1016 	uint32_t sctp_frag_point;
1017 
1018 	uint32_t total_output_queue_size;
1019 
1020 	uint32_t sb_cc;		/* shadow of sb_cc */
1021 	uint32_t sb_send_resv;	/* amount reserved on a send */
1022 	uint32_t my_rwnd_control_len;	/* shadow of sb_mbcnt used for rwnd
1023 					 * control */
1024 #ifdef INET6
1025 	uint32_t default_flowlabel;
1026 #endif
1027 	uint32_t pr_sctp_cnt;
1028 	int ctrl_queue_cnt;	/* could be removed  REM - NO IT CAN'T!! RRS */
1029 	/*
1030 	 * All outbound datagrams queue into this list from the individual
1031 	 * stream queue. Here they get assigned a TSN and then await
1032 	 * sending. The stream seq comes when it is first put in the
1033 	 * individual str queue
1034 	 */
1035 	unsigned int stream_queue_cnt;
1036 	unsigned int send_queue_cnt;
1037 	unsigned int sent_queue_cnt;
1038 	unsigned int sent_queue_cnt_removeable;
1039 	/*
1040 	 * Number on sent queue that are marked for retran until this value
1041 	 * is 0 we only send one packet of retran'ed data.
1042 	 */
1043 	unsigned int sent_queue_retran_cnt;
1044 
1045 	unsigned int size_on_reasm_queue;
1046 	unsigned int cnt_on_reasm_queue;
1047 	unsigned int fwd_tsn_cnt;
1048 	/* amount of data (bytes) currently in flight (on all destinations) */
1049 	unsigned int total_flight;
1050 	/* Total book size in flight */
1051 	unsigned int total_flight_count;	/* count of chunks used with
1052 						 * book total */
1053 	/* count of destinaton nets and list of destination nets */
1054 	unsigned int numnets;
1055 
1056 	/* Total error count on this association */
1057 	unsigned int overall_error_count;
1058 
1059 	unsigned int cnt_msg_on_sb;
1060 
1061 	/* All stream count of chunks for delivery */
1062 	unsigned int size_on_all_streams;
1063 	unsigned int cnt_on_all_streams;
1064 
1065 	/* Heart Beat delay in ms */
1066 	uint32_t heart_beat_delay;
1067 
1068 	/* autoclose */
1069 	unsigned int sctp_autoclose_ticks;
1070 
1071 	/* how many preopen streams we have */
1072 	unsigned int pre_open_streams;
1073 
1074 	/* How many streams I support coming into me */
1075 	unsigned int max_inbound_streams;
1076 
1077 	/* the cookie life I award for any cookie, in seconds */
1078 	unsigned int cookie_life;
1079 	/* time to delay acks for */
1080 	unsigned int delayed_ack;
1081 	unsigned int old_delayed_ack;
1082 	unsigned int sack_freq;
1083 	unsigned int data_pkts_seen;
1084 
1085 	unsigned int numduptsns;
1086 	int dup_tsns[SCTP_MAX_DUP_TSNS];
1087 	unsigned int initial_init_rto_max;	/* initial RTO for INIT's */
1088 	unsigned int initial_rto;	/* initial send RTO */
1089 	unsigned int minrto;	/* per assoc RTO-MIN */
1090 	unsigned int maxrto;	/* per assoc RTO-MAX */
1091 
1092 	/* authentication fields */
1093 	sctp_auth_chklist_t *local_auth_chunks;
1094 	sctp_auth_chklist_t *peer_auth_chunks;
1095 	sctp_hmaclist_t *local_hmacs;	/* local HMACs supported */
1096 	sctp_hmaclist_t *peer_hmacs;	/* peer HMACs supported */
1097 	struct sctp_keyhead shared_keys;	/* assoc's shared keys */
1098 	sctp_authinfo_t authinfo;	/* randoms, cached keys */
1099 	/*
1100 	 * refcnt to block freeing when a sender or receiver is off coping
1101 	 * user data in.
1102 	 */
1103 	uint32_t refcnt;
1104 	uint32_t chunks_on_out_queue;	/* total chunks floating around,
1105 					 * locked by send socket buffer */
1106 	uint32_t peers_adaptation;
1107 	uint16_t peer_hmac_id;	/* peer HMAC id to send */
1108 
1109 	/*
1110 	 * Being that we have no bag to collect stale cookies, and that we
1111 	 * really would not want to anyway.. we will count them in this
1112 	 * counter. We of course feed them to the pigeons right away (I have
1113 	 * always thought of pigeons as flying rats).
1114 	 */
1115 	uint16_t stale_cookie_count;
1116 
1117 	/*
1118 	 * For the partial delivery API, if up, invoked this is what last
1119 	 * TSN I delivered
1120 	 */
1121 	uint16_t str_of_pdapi;
1122 	uint16_t ssn_of_pdapi;
1123 
1124 	/* counts of actual built streams. Allocation may be more however */
1125 	/* could re-arrange to optimize space here. */
1126 	uint16_t streamincnt;
1127 	uint16_t streamoutcnt;
1128 	uint16_t strm_realoutsize;
1129 	uint16_t strm_pending_add_size;
1130 	/* my maximum number of retrans of INIT and SEND */
1131 	/* copied from SCTP but should be individually setable */
1132 	uint16_t max_init_times;
1133 	uint16_t max_send_times;
1134 
1135 	uint16_t def_net_failure;
1136 
1137 	uint16_t def_net_pf_threshold;
1138 
1139 	/*
1140 	 * lock flag: 0 is ok to send, 1+ (duals as a retran count) is
1141 	 * awaiting ACK
1142 	 */
1143 	uint16_t mapping_array_size;
1144 
1145 	uint16_t last_strm_seq_delivered;
1146 	uint16_t last_strm_no_delivered;
1147 
1148 	uint16_t last_revoke_count;
1149 	int16_t num_send_timers_up;
1150 
1151 	uint16_t stream_locked_on;
1152 	uint16_t ecn_echo_cnt_onq;
1153 
1154 	uint16_t free_chunk_cnt;
1155 	uint8_t stream_locked;
1156 	uint8_t authenticated;	/* packet authenticated ok */
1157 	/*
1158 	 * This flag indicates that a SACK need to be sent. Initially this
1159 	 * is 1 to send the first sACK immediately.
1160 	 */
1161 	uint8_t send_sack;
1162 
1163 	/* max burst of new packets into the network */
1164 	uint32_t max_burst;
1165 	/* max burst of fast retransmit packets */
1166 	uint32_t fr_max_burst;
1167 
1168 	uint8_t sat_network;	/* RTT is in range of sat net or greater */
1169 	uint8_t sat_network_lockout;	/* lockout code */
1170 	uint8_t burst_limit_applied;	/* Burst limit in effect at last send? */
1171 	/* flag goes on when we are doing a partial delivery api */
1172 	uint8_t hb_random_values[4];
1173 	uint8_t fragmented_delivery_inprogress;
1174 	uint8_t fragment_flags;
1175 	uint8_t last_flags_delivered;
1176 	uint8_t hb_ect_randombit;
1177 	uint8_t hb_random_idx;
1178 	uint8_t default_dscp;
1179 	uint8_t asconf_del_pending;	/* asconf delete last addr pending */
1180 	uint8_t trigger_reset;
1181 	/*
1182 	 * This value, plus all other ack'd but above cum-ack is added
1183 	 * together to cross check against the bit that we have yet to
1184 	 * define (probably in the SACK). When the cum-ack is updated, this
1185 	 * sum is updated as well.
1186 	 */
1187 
1188 	/* Flags whether an extension is supported or not */
1189 	uint8_t ecn_supported;
1190 	uint8_t prsctp_supported;
1191 	uint8_t auth_supported;
1192 	uint8_t asconf_supported;
1193 	uint8_t reconfig_supported;
1194 	uint8_t nrsack_supported;
1195 	uint8_t pktdrop_supported;
1196 	uint8_t idata_supported;
1197 
1198 	/* Did the peer make the stream config (add out) request */
1199 	uint8_t peer_req_out;
1200 
1201 	uint8_t local_strreset_support;
1202 	uint8_t peer_supports_nat;
1203 
1204 	struct sctp_scoping scope;
1205 	/* flags to handle send alternate net tracking */
1206 	uint8_t used_alt_asconfack;
1207 	uint8_t fast_retran_loss_recovery;
1208 	uint8_t sat_t3_loss_recovery;
1209 	uint8_t dropped_special_cnt;
1210 	uint8_t seen_a_sack_this_pkt;
1211 	uint8_t stream_reset_outstanding;
1212 	uint8_t stream_reset_out_is_outstanding;
1213 	uint8_t delayed_connection;
1214 	uint8_t ifp_had_enobuf;
1215 	uint8_t saw_sack_with_frags;
1216 	uint8_t saw_sack_with_nr_frags;
1217 	uint8_t in_asocid_hash;
1218 	uint8_t assoc_up_sent;
1219 	uint8_t adaptation_needed;
1220 	uint8_t adaptation_sent;
1221 	/* CMT variables */
1222 	uint8_t cmt_dac_pkts_rcvd;
1223 	uint8_t sctp_cmt_on_off;
1224 	uint8_t iam_blocking;
1225 	uint8_t cookie_how[8];
1226 	/* JRS 5/21/07 - CMT PF variable */
1227 	uint8_t sctp_cmt_pf;
1228 	uint8_t use_precise_time;
1229 	uint64_t sctp_features;
1230 	uint32_t max_cwnd;
1231 	uint16_t port;		/* remote UDP encapsulation port */
1232 	/*
1233 	 * The mapping array is used to track out of order sequences above
1234 	 * last_acked_seq. 0 indicates packet missing 1 indicates packet
1235 	 * rec'd. We slide it up every time we raise last_acked_seq and 0
1236 	 * trailing locactions out.  If I get a TSN above the array
1237 	 * mappingArraySz, I discard the datagram and let retransmit happen.
1238 	 */
1239 	uint32_t marked_retrans;
1240 	uint32_t timoinit;
1241 	uint32_t timodata;
1242 	uint32_t timosack;
1243 	uint32_t timoshutdown;
1244 	uint32_t timoheartbeat;
1245 	uint32_t timocookie;
1246 	uint32_t timoshutdownack;
1247 	struct timeval start_time;
1248 	struct timeval discontinuity_time;
1249 	uint64_t abandoned_unsent[SCTP_PR_SCTP_MAX + 1];
1250 	uint64_t abandoned_sent[SCTP_PR_SCTP_MAX + 1];
1251 };
1252 
1253 #endif
1254