xref: /freebsd/sys/netinet/sctp_structs.h (revision ea60845d09e6bcb73038858af28bd191219b610b)
1 /*-
2  * Copyright (c) 2001-2007, Cisco Systems, Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * a) Redistributions of source code must retain the above copyright notice,
8  *   this list of conditions and the following disclaimer.
9  *
10  * b) Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *   the documentation and/or other materials provided with the distribution.
13  *
14  * c) Neither the name of Cisco Systems, Inc. nor the names of its
15  *    contributors may be used to endorse or promote products derived
16  *    from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
28  * THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 /* $KAME: sctp_structs.h,v 1.13 2005/03/06 16:04:18 itojun Exp $	 */
32 
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
35 
36 #ifndef __sctp_structs_h__
37 #define __sctp_structs_h__
38 
39 #include <netinet/sctp_os.h>
40 #include <netinet/sctp_header.h>
41 #include <netinet/sctp_uio.h>
42 #include <netinet/sctp_auth.h>
43 
44 struct sctp_timer {
45 	sctp_os_timer_t timer;
46 
47 	int type;
48 	/*
49 	 * Depending on the timer type these will be setup and cast with the
50 	 * appropriate entity.
51 	 */
52 	void *ep;
53 	void *tcb;
54 	void *net;
55 
56 	/* for sanity checking */
57 	void *self;
58 	uint32_t ticks;
59 	uint32_t stopped_from;
60 };
61 
62 struct sctp_nonpad_sndrcvinfo {
63 	uint16_t sinfo_stream;
64 	uint16_t sinfo_ssn;
65 	uint16_t sinfo_flags;
66 	uint32_t sinfo_ppid;
67 	uint32_t sinfo_context;
68 	uint32_t sinfo_timetolive;
69 	uint32_t sinfo_tsn;
70 	uint32_t sinfo_cumtsn;
71 	sctp_assoc_t sinfo_assoc_id;
72 };
73 
74 struct sctp_foo_stuff {
75 	struct sctp_inpcb *inp;
76 	uint32_t lineno;
77 	uint32_t ticks;
78 	int updown;
79 };
80 
81 
82 /*
83  * This is the information we track on each interface that we know about from
84  * the distant end.
85  */
86 TAILQ_HEAD(sctpnetlisthead, sctp_nets);
87 
88 struct sctp_stream_reset_list {
89 	TAILQ_ENTRY(sctp_stream_reset_list) next_resp;
90 	uint32_t tsn;
91 	int number_entries;
92 	struct sctp_stream_reset_out_request req;
93 };
94 
95 TAILQ_HEAD(sctp_resethead, sctp_stream_reset_list);
96 
97 /*
98  * Users of the iterator need to malloc a iterator with a call to
99  * sctp_initiate_iterator(inp_func, assoc_func, inp_func,  pcb_flags, pcb_features,
100  *     asoc_state, void-ptr-arg, uint32-arg, end_func, inp);
101  *
102  * Use the following two defines if you don't care what pcb flags are on the EP
103  * and/or you don't care what state the association is in.
104  *
105  * Note that if you specify an INP as the last argument then ONLY each
106  * association of that single INP will be executed upon. Note that the pcb
107  * flags STILL apply so if the inp you specify has different pcb_flags then
108  * what you put in pcb_flags nothing will happen. use SCTP_PCB_ANY_FLAGS to
109  * assure the inp you specify gets treated.
110  */
111 #define SCTP_PCB_ANY_FLAGS	0x00000000
112 #define SCTP_PCB_ANY_FEATURES	0x00000000
113 #define SCTP_ASOC_ANY_STATE	0x00000000
114 
115 typedef void (*asoc_func) (struct sctp_inpcb *, struct sctp_tcb *, void *ptr,
116          uint32_t val);
117 typedef int (*inp_func) (struct sctp_inpcb *, void *ptr, uint32_t val);
118 typedef void (*end_func) (void *ptr, uint32_t val);
119 
120 struct sctp_iterator {
121 	TAILQ_ENTRY(sctp_iterator) sctp_nxt_itr;
122 	struct sctp_timer tmr;
123 	struct sctp_inpcb *inp;	/* current endpoint */
124 	struct sctp_tcb *stcb;	/* current* assoc */
125 	asoc_func function_assoc;	/* per assoc function */
126 	inp_func function_inp;	/* per endpoint function */
127 	inp_func function_inp_end;	/* end INP function */
128 	end_func function_atend;/* iterator completion function */
129 	void *pointer;		/* pointer for apply func to use */
130 	uint32_t val;		/* value for apply func to use */
131 	uint32_t pcb_flags;	/* endpoint flags being checked */
132 	uint32_t pcb_features;	/* endpoint features being checked */
133 	uint32_t asoc_state;	/* assoc state being checked */
134 	uint32_t iterator_flags;
135 	uint8_t no_chunk_output;
136 	uint8_t done_current_ep;
137 };
138 
139 /* iterator_flags values */
140 #define SCTP_ITERATOR_DO_ALL_INP	0x00000001
141 #define SCTP_ITERATOR_DO_SINGLE_INP	0x00000002
142 
143 TAILQ_HEAD(sctpiterators, sctp_iterator);
144 
145 struct sctp_copy_all {
146 	struct sctp_inpcb *inp;	/* ep */
147 	struct mbuf *m;
148 	struct sctp_sndrcvinfo sndrcv;
149 	int sndlen;
150 	int cnt_sent;
151 	int cnt_failed;
152 };
153 
154 struct sctp_asconf_iterator {
155 	struct sctpladdr list_of_work;
156 	int cnt;
157 };
158 
159 
160 struct sctp_nets {
161 	TAILQ_ENTRY(sctp_nets) sctp_next;	/* next link */
162 
163 	/*
164 	 * Things on the top half may be able to be split into a common
165 	 * structure shared by all.
166 	 */
167 	struct sctp_timer pmtu_timer;
168 
169 	/*
170 	 * The following two in combination equate to a route entry for v6
171 	 * or v4.
172 	 */
173 	struct sctp_route {
174 		struct rtentry *ro_rt;
175 		union sctp_sockstore _l_addr;	/* remote peer addr */
176 		struct sctp_ifa *_s_addr;	/* our selected src addr */
177 	}          ro;
178 	/* mtu discovered so far */
179 	uint32_t mtu;
180 	uint32_t ssthresh;	/* not sure about this one for split */
181 
182 	/* smoothed average things for RTT and RTO itself */
183 	int lastsa;
184 	int lastsv;
185 	unsigned int RTO;
186 
187 	/* This is used for SHUTDOWN/SHUTDOWN-ACK/SEND or INIT timers */
188 	struct sctp_timer rxt_timer;
189 	struct sctp_timer fr_timer;	/* for early fr */
190 
191 	/* last time in seconds I sent to it */
192 	struct timeval last_sent_time;
193 	int ref_count;
194 
195 	/* Congestion stats per destination */
196 	/*
197 	 * flight size variables and such, sorry Vern, I could not avoid
198 	 * this if I wanted performance :>
199 	 */
200 	uint32_t flight_size;
201 	uint32_t cwnd;		/* actual cwnd */
202 	uint32_t prev_cwnd;	/* cwnd before any processing */
203 	uint32_t partial_bytes_acked;	/* in CA tracks when to incr a MTU */
204 	uint32_t prev_rtt;
205 	/* tracking variables to avoid the aloc/free in sack processing */
206 	unsigned int net_ack;
207 	unsigned int net_ack2;
208 
209 	/*
210 	 * CMT variables (iyengar@cis.udel.edu)
211 	 */
212 	uint32_t this_sack_highest_newack;	/* tracks highest TSN newly
213 						 * acked for a given dest in
214 						 * the current SACK. Used in
215 						 * SFR and HTNA algos */
216 	uint32_t pseudo_cumack;	/* CMT CUC algorithm. Maintains next expected
217 				 * pseudo-cumack for this destination */
218 	uint32_t rtx_pseudo_cumack;	/* CMT CUC algorithm. Maintains next
219 					 * expected pseudo-cumack for this
220 					 * destination */
221 
222 	/* CMT fast recovery variables */
223 	uint32_t fast_recovery_tsn;
224 	uint32_t heartbeat_random1;
225 	uint32_t heartbeat_random2;
226 	uint32_t tos_flowlabel;
227 
228 	struct timeval start_time;	/* time when this net was created */
229 
230 	uint32_t marked_retrans;/* number or DATA chunks marked for timer
231 				 * based retransmissions */
232 	uint32_t marked_fastretrans;
233 
234 	/* if this guy is ok or not ... status */
235 	uint16_t dest_state;
236 	/* number of transmit failures to down this guy */
237 	uint16_t failure_threshold;
238 	/* error stats on destination */
239 	uint16_t error_count;
240 
241 	uint8_t fast_retran_loss_recovery;
242 	uint8_t will_exit_fast_recovery;
243 	/* Flags that probably can be combined into dest_state */
244 	uint8_t fast_retran_ip;	/* fast retransmit in progress */
245 	uint8_t hb_responded;
246 	uint8_t saw_newack;	/* CMT's SFR algorithm flag */
247 	uint8_t src_addr_selected;	/* if we split we move */
248 	uint8_t indx_of_eligible_next_to_use;
249 	uint8_t addr_is_local;	/* its a local address (if known) could move
250 				 * in split */
251 
252 	/*
253 	 * CMT variables (iyengar@cis.udel.edu)
254 	 */
255 	uint8_t find_pseudo_cumack;	/* CMT CUC algorithm. Flag used to
256 					 * find a new pseudocumack. This flag
257 					 * is set after a new pseudo-cumack
258 					 * has been received and indicates
259 					 * that the sender should find the
260 					 * next pseudo-cumack expected for
261 					 * this destination */
262 	uint8_t find_rtx_pseudo_cumack;	/* CMT CUCv2 algorithm. Flag used to
263 					 * find a new rtx-pseudocumack. This
264 					 * flag is set after a new
265 					 * rtx-pseudo-cumack has been received
266 					 * and indicates that the sender
267 					 * should find the next
268 					 * rtx-pseudo-cumack expected for this
269 					 * destination */
270 	uint8_t new_pseudo_cumack;	/* CMT CUC algorithm. Flag used to
271 					 * indicate if a new pseudo-cumack or
272 					 * rtx-pseudo-cumack has been received */
273 	uint8_t window_probe;	/* Doing a window probe? */
274 #ifdef SCTP_HIGH_SPEED
275 	uint8_t last_hs_used;	/* index into the last HS table entry we used */
276 #endif
277 };
278 
279 
280 struct sctp_data_chunkrec {
281 	uint32_t TSN_seq;	/* the TSN of this transmit */
282 	uint16_t stream_seq;	/* the stream sequence number of this transmit */
283 	uint16_t stream_number;	/* the stream number of this guy */
284 	uint32_t payloadtype;
285 	uint32_t context;	/* from send */
286 
287 	/* ECN Nonce: Nonce Value for this chunk */
288 	uint8_t ect_nonce;
289 
290 	/*
291 	 * part of the Highest sacked algorithm to be able to stroke counts
292 	 * on ones that are FR'd.
293 	 */
294 	uint32_t fast_retran_tsn;	/* sending_seq at the time of FR */
295 	struct timeval timetodrop;	/* time we drop it from queue */
296 	uint8_t doing_fast_retransmit;
297 	uint8_t rcv_flags;	/* flags pulled from data chunk on inbound for
298 				 * outbound holds sending flags for PR-SCTP. */
299 	uint8_t state_flags;
300 	uint8_t chunk_was_revoked;
301 };
302 
303 TAILQ_HEAD(sctpchunk_listhead, sctp_tmit_chunk);
304 
305 /* The lower byte is used to enumerate PR_SCTP policies */
306 #define CHUNK_FLAGS_PR_SCTP_TTL	        SCTP_PR_SCTP_TTL
307 #define CHUNK_FLAGS_PR_SCTP_BUF	        SCTP_PR_SCTP_BUF
308 #define CHUNK_FLAGS_PR_SCTP_RTX         SCTP_PR_SCTP_RTX
309 
310 /* The upper byte is used a a bit mask */
311 #define CHUNK_FLAGS_FRAGMENT_OK	        0x0100
312 
313 struct chk_id {
314 	uint16_t id;
315 	uint16_t can_take_data;
316 };
317 
318 
319 struct sctp_tmit_chunk {
320 	union {
321 		struct sctp_data_chunkrec data;
322 		struct chk_id chunk_id;
323 	}     rec;
324 	struct sctp_association *asoc;	/* bp to asoc this belongs to */
325 	struct timeval sent_rcv_time;	/* filled in if RTT being calculated */
326 	struct mbuf *data;	/* pointer to mbuf chain of data */
327 	struct mbuf *last_mbuf;	/* pointer to last mbuf in chain */
328 	struct sctp_nets *whoTo;
329 	          TAILQ_ENTRY(sctp_tmit_chunk) sctp_next;	/* next link */
330 	int32_t sent;		/* the send status */
331 	uint16_t snd_count;	/* number of times I sent */
332 	uint16_t flags;		/* flags, such as FRAGMENT_OK */
333 	uint16_t send_size;
334 	uint16_t book_size;
335 	uint16_t mbcnt;
336 	uint8_t pad_inplace;
337 	uint8_t do_rtt;
338 	uint8_t book_size_scale;
339 	uint8_t addr_over;	/* flag which is set if the dest address for
340 				 * this chunk is overridden by user. Used for
341 				 * CMT (iyengar@cis.udel.edu, 2005/06/21) */
342 	uint8_t no_fr_allowed;
343 	uint8_t pr_sctp_on;
344 	uint8_t copy_by_ref;
345 	uint8_t window_probe;
346 };
347 
348 /*
349  * The first part of this structure MUST be the entire sinfo structure. Maybe
350  * I should have made it a sub structure... we can circle back later and do
351  * that if we want.
352  */
353 struct sctp_queued_to_read {	/* sinfo structure Pluse more */
354 	uint16_t sinfo_stream;	/* off the wire */
355 	uint16_t sinfo_ssn;	/* off the wire */
356 	uint16_t sinfo_flags;	/* SCTP_UNORDERED from wire use SCTP_EOF for
357 				 * EOR */
358 	uint32_t sinfo_ppid;	/* off the wire */
359 	uint32_t sinfo_context;	/* pick this up from assoc def context? */
360 	uint32_t sinfo_timetolive;	/* not used by kernel */
361 	uint32_t sinfo_tsn;	/* Use this in reassembly as first TSN */
362 	uint32_t sinfo_cumtsn;	/* Use this in reassembly as last TSN */
363 	sctp_assoc_t sinfo_assoc_id;	/* our assoc id */
364 	/* Non sinfo stuff */
365 	uint32_t length;	/* length of data */
366 	uint32_t held_length;	/* length held in sb */
367 	struct sctp_nets *whoFrom;	/* where it came from */
368 	struct mbuf *data;	/* front of the mbuf chain of data with
369 				 * PKT_HDR */
370 	struct mbuf *tail_mbuf;	/* used for multi-part data */
371 	struct sctp_tcb *stcb;	/* assoc, used for window update */
372 	         TAILQ_ENTRY(sctp_queued_to_read) next;
373 	uint16_t port_from;
374 	uint16_t spec_flags;	/* Flags to hold the notification field */
375 	uint8_t do_not_ref_stcb;
376 	uint8_t end_added;
377 	uint8_t pdapi_aborted;
378 	uint8_t some_taken;
379 };
380 
381 /* This data structure will be on the outbound
382  * stream queues. Data will be pulled off from
383  * the front of the mbuf data and chunk-ified
384  * by the output routines. We will custom
385  * fit every chunk we pull to the send/sent
386  * queue to make up the next full packet
387  * if we can. An entry cannot be removed
388  * from the stream_out queue until
389  * the msg_is_complete flag is set. This
390  * means at times data/tail_mbuf MIGHT
391  * be NULL.. If that occurs it happens
392  * for one of two reasons. Either the user
393  * is blocked on a send() call and has not
394  * awoken to copy more data down... OR
395  * the user is in the explict MSG_EOR mode
396  * and wrote some data, but has not completed
397  * sending.
398  */
399 struct sctp_stream_queue_pending {
400 	struct mbuf *data;
401 	struct mbuf *tail_mbuf;
402 	struct timeval ts;
403 	struct sctp_nets *net;
404 	          TAILQ_ENTRY(sctp_stream_queue_pending) next;
405 	uint32_t length;
406 	uint32_t timetolive;
407 	uint32_t ppid;
408 	uint32_t context;
409 	uint16_t sinfo_flags;
410 	uint16_t stream;
411 	uint16_t strseq;
412 	uint16_t act_flags;
413 	uint8_t msg_is_complete;
414 	uint8_t some_taken;
415 	uint8_t addr_over;
416 	uint8_t pr_sctp_on;
417 	uint8_t sender_all_done;
418 	uint8_t put_last_out;
419 };
420 
421 /*
422  * this struct contains info that is used to track inbound stream data and
423  * help with ordering.
424  */
425 TAILQ_HEAD(sctpwheelunrel_listhead, sctp_stream_in);
426 struct sctp_stream_in {
427 	struct sctp_readhead inqueue;
428 	uint16_t stream_no;
429 	uint16_t last_sequence_delivered;	/* used for re-order */
430 	uint8_t delivery_started;
431 };
432 
433 /* This struct is used to track the traffic on outbound streams */
434 TAILQ_HEAD(sctpwheel_listhead, sctp_stream_out);
435 struct sctp_stream_out {
436 	struct sctp_streamhead outqueue;
437 	                TAILQ_ENTRY(sctp_stream_out) next_spoke;	/* next link in wheel */
438 	uint16_t stream_no;
439 	uint16_t next_sequence_sent;	/* next one I expect to send out */
440 	uint8_t last_msg_incomplete;
441 };
442 
443 /* used to keep track of the addresses yet to try to add/delete */
444 TAILQ_HEAD(sctp_asconf_addrhead, sctp_asconf_addr);
445 struct sctp_asconf_addr {
446 	TAILQ_ENTRY(sctp_asconf_addr) next;
447 	struct sctp_asconf_addr_param ap;
448 	struct sctp_ifa *ifa;	/* save the ifa for add/del ip */
449 	uint8_t sent;		/* has this been sent yet? */
450 };
451 
452 struct sctp_scoping {
453 	uint8_t ipv4_addr_legal;
454 	uint8_t ipv6_addr_legal;
455 	uint8_t loopback_scope;
456 	uint8_t ipv4_local_scope;
457 	uint8_t local_scope;
458 	uint8_t site_scope;
459 };
460 
461 #define SCTP_TSN_LOG_SIZE 40
462 
463 struct sctp_tsn_log {
464 	uint32_t tsn;
465 	uint16_t strm;
466 	uint16_t seq;
467 	uint16_t sz;
468 	uint16_t flgs;
469 };
470 
471 /*
472  * Here we have information about each individual association that we track.
473  * We probably in production would be more dynamic. But for ease of
474  * implementation we will have a fixed array that we hunt for in a linear
475  * fashion.
476  */
477 struct sctp_association {
478 	/* association state */
479 	int state;
480 	/* queue of pending addrs to add/delete */
481 	struct sctp_asconf_addrhead asconf_queue;
482 	struct timeval time_entered;	/* time we entered state */
483 	struct timeval time_last_rcvd;
484 	struct timeval time_last_sent;
485 	struct timeval time_last_sat_advance;
486 	struct sctp_sndrcvinfo def_send;	/* default send parameters */
487 
488 	/* timers and such */
489 	struct sctp_timer hb_timer;	/* hb timer */
490 	struct sctp_timer dack_timer;	/* Delayed ack timer */
491 	struct sctp_timer asconf_timer;	/* Asconf */
492 	struct sctp_timer strreset_timer;	/* stream reset */
493 	struct sctp_timer shut_guard_timer;	/* guard */
494 	struct sctp_timer autoclose_timer;	/* automatic close timer */
495 	struct sctp_timer delayed_event_timer;	/* timer for delayed events */
496 
497 	/* list of local addresses when add/del in progress */
498 	struct sctpladdr sctp_restricted_addrs;
499 
500 	struct sctpnetlisthead nets;
501 
502 	/* Free chunk list */
503 	struct sctpchunk_listhead free_chunks;
504 
505 
506 	/* Control chunk queue */
507 	struct sctpchunk_listhead control_send_queue;
508 
509 	/*
510 	 * Once a TSN hits the wire it is moved to the sent_queue. We
511 	 * maintain two counts here (don't know if any but retran_cnt is
512 	 * needed). The idea is that the sent_queue_retran_cnt reflects how
513 	 * many chunks have been marked for retranmission by either T3-rxt
514 	 * or FR.
515 	 */
516 	struct sctpchunk_listhead sent_queue;
517 	struct sctpchunk_listhead send_queue;
518 
519 
520 	/* re-assembly queue for fragmented chunks on the inbound path */
521 	struct sctpchunk_listhead reasmqueue;
522 
523 	/*
524 	 * this queue is used when we reach a condition that we can NOT put
525 	 * data into the socket buffer. We track the size of this queue and
526 	 * set our rwnd to the space in the socket minus also the
527 	 * size_on_delivery_queue.
528 	 */
529 	struct sctpwheel_listhead out_wheel;
530 
531 	/*
532 	 * This pointer will be set to NULL most of the time. But when we
533 	 * have a fragmented message, where we could not get out all of the
534 	 * message at the last send then this will point to the stream to go
535 	 * get data from.
536 	 */
537 	struct sctp_stream_out *locked_on_sending;
538 
539 	/* If an iterator is looking at me, this is it */
540 	struct sctp_iterator *stcb_starting_point_for_iterator;
541 
542 	/* ASCONF destination address last sent to */
543 /*	struct sctp_nets *asconf_last_sent_to;*/
544 /* Peter, greppign for the above shows only on strange set
545  * I don't think we need it so I have commented it out.
546  */
547 
548 	/* ASCONF save the last ASCONF-ACK so we can resend it if necessary */
549 	struct mbuf *last_asconf_ack_sent;
550 
551 	/*
552 	 * pointer to last stream reset queued to control queue by us with
553 	 * requests.
554 	 */
555 	struct sctp_tmit_chunk *str_reset;
556 	/*
557 	 * if Source Address Selection happening, this will rotate through
558 	 * the link list.
559 	 */
560 	struct sctp_laddr *last_used_address;
561 
562 	/* stream arrays */
563 	struct sctp_stream_in *strmin;
564 	struct sctp_stream_out *strmout;
565 	uint8_t *mapping_array;
566 	/* primary destination to use */
567 	struct sctp_nets *primary_destination;
568 	/* For CMT */
569 	struct sctp_nets *last_net_data_came_from;
570 	/* last place I got a data chunk from */
571 	struct sctp_nets *last_data_chunk_from;
572 	/* last place I got a control from */
573 	struct sctp_nets *last_control_chunk_from;
574 
575 	/* circular looking for output selection */
576 	struct sctp_stream_out *last_out_stream;
577 
578 	/*
579 	 * wait to the point the cum-ack passes req->send_reset_at_tsn for
580 	 * any req on the list.
581 	 */
582 	struct sctp_resethead resetHead;
583 
584 	/* queue of chunks waiting to be sent into the local stack */
585 	struct sctp_readhead pending_reply_queue;
586 
587 	uint32_t vrf_id;
588 
589 	uint32_t cookie_preserve_req;
590 	/* ASCONF next seq I am sending out, inits at init-tsn */
591 	uint32_t asconf_seq_out;
592 	/* ASCONF last received ASCONF from peer, starts at peer's TSN-1 */
593 	uint32_t asconf_seq_in;
594 
595 	/* next seq I am sending in str reset messages */
596 	uint32_t str_reset_seq_out;
597 
598 	/* next seq I am expecting in str reset messages */
599 	uint32_t str_reset_seq_in;
600 
601 
602 	/* various verification tag information */
603 	uint32_t my_vtag;	/* The tag to be used. if assoc is re-initited
604 				 * by remote end, and I have unlocked this
605 				 * will be regenerated to a new random value. */
606 	uint32_t peer_vtag;	/* The peers last tag */
607 
608 	uint32_t my_vtag_nonce;
609 	uint32_t peer_vtag_nonce;
610 
611 	uint32_t assoc_id;
612 
613 	/* This is the SCTP fragmentation threshold */
614 	uint32_t smallest_mtu;
615 
616 	/*
617 	 * Special hook for Fast retransmit, allows us to track the highest
618 	 * TSN that is NEW in this SACK if gap ack blocks are present.
619 	 */
620 	uint32_t this_sack_highest_gap;
621 
622 	/*
623 	 * The highest consecutive TSN that has been acked by peer on my
624 	 * sends
625 	 */
626 	uint32_t last_acked_seq;
627 
628 	/* The next TSN that I will use in sending. */
629 	uint32_t sending_seq;
630 
631 	/* Original seq number I used ??questionable to keep?? */
632 	uint32_t init_seq_number;
633 
634 
635 	/* The Advanced Peer Ack Point, as required by the PR-SCTP */
636 	/* (A1 in Section 4.2) */
637 	uint32_t advanced_peer_ack_point;
638 
639 	/*
640 	 * The highest consequetive TSN at the bottom of the mapping array
641 	 * (for his sends).
642 	 */
643 	uint32_t cumulative_tsn;
644 	/*
645 	 * Used to track the mapping array and its offset bits. This MAY be
646 	 * lower then cumulative_tsn.
647 	 */
648 	uint32_t mapping_array_base_tsn;
649 	/*
650 	 * used to track highest TSN we have received and is listed in the
651 	 * mapping array.
652 	 */
653 	uint32_t highest_tsn_inside_map;
654 
655 	uint32_t last_echo_tsn;
656 	uint32_t last_cwr_tsn;
657 	uint32_t fast_recovery_tsn;
658 	uint32_t sat_t3_recovery_tsn;
659 	uint32_t tsn_last_delivered;
660 	/*
661 	 * For the pd-api we should re-write this a bit more efficent. We
662 	 * could have multiple sctp_queued_to_read's that we are building at
663 	 * once. Now we only do this when we get ready to deliver to the
664 	 * socket buffer. Note that we depend on the fact that the struct is
665 	 * "stuck" on the read queue until we finish all the pd-api.
666 	 */
667 	struct sctp_queued_to_read *control_pdapi;
668 
669 	uint32_t tsn_of_pdapi_last_delivered;
670 	uint32_t pdapi_ppid;
671 	uint32_t context;
672 	uint32_t last_reset_action[SCTP_MAX_RESET_PARAMS];
673 	uint32_t last_sending_seq[SCTP_MAX_RESET_PARAMS];
674 	uint32_t last_base_tsnsent[SCTP_MAX_RESET_PARAMS];
675 #ifdef SCTP_ASOCLOG_OF_TSNS
676 	/*
677 	 * special log  - This adds considerable size to the asoc, but
678 	 * provides a log that you can use to detect problems via kgdb.
679 	 */
680 	struct sctp_tsn_log in_tsnlog[SCTP_TSN_LOG_SIZE];
681 	struct sctp_tsn_log out_tsnlog[SCTP_TSN_LOG_SIZE];
682 	uint16_t tsn_in_at;
683 	uint16_t tsn_out_at;
684 	uint16_t tsn_in_wrapped;
685 	uint16_t tsn_out_wrapped;
686 #endif				/* SCTP_ASOCLOG_OF_TSNS */
687 	/*
688 	 * window state information and smallest MTU that I use to bound
689 	 * segmentation
690 	 */
691 	uint32_t peers_rwnd;
692 	uint32_t my_rwnd;
693 	uint32_t my_last_reported_rwnd;
694 	uint32_t my_rwnd_control_len;
695 
696 	uint32_t total_output_queue_size;
697 
698 	uint32_t sb_cc;		/* shadow of sb_cc in one-2-one */
699 	uint32_t sb_mbcnt;	/* shadow of sb_mbcnt in one-2-one */
700 	/* 32 bit nonce stuff */
701 	uint32_t nonce_resync_tsn;
702 	uint32_t nonce_wait_tsn;
703 	uint32_t default_flowlabel;
704 	uint32_t pr_sctp_cnt;
705 	int ctrl_queue_cnt;	/* could be removed  REM */
706 	/*
707 	 * All outbound datagrams queue into this list from the individual
708 	 * stream queue. Here they get assigned a TSN and then await
709 	 * sending. The stream seq comes when it is first put in the
710 	 * individual str queue
711 	 */
712 	unsigned int stream_queue_cnt;
713 	unsigned int send_queue_cnt;
714 	unsigned int sent_queue_cnt;
715 	unsigned int sent_queue_cnt_removeable;
716 	/*
717 	 * Number on sent queue that are marked for retran until this value
718 	 * is 0 we only send one packet of retran'ed data.
719 	 */
720 	unsigned int sent_queue_retran_cnt;
721 
722 	unsigned int size_on_reasm_queue;
723 	unsigned int cnt_on_reasm_queue;
724 	/* amount of data (bytes) currently in flight (on all destinations) */
725 	unsigned int total_flight;
726 	/* Total book size in flight */
727 	unsigned int total_flight_count;	/* count of chunks used with
728 						 * book total */
729 	/* count of destinaton nets and list of destination nets */
730 	unsigned int numnets;
731 
732 	/* Total error count on this association */
733 	unsigned int overall_error_count;
734 
735 	unsigned int cnt_msg_on_sb;
736 
737 	/* All stream count of chunks for delivery */
738 	unsigned int size_on_all_streams;
739 	unsigned int cnt_on_all_streams;
740 
741 	/* Heart Beat delay in ticks */
742 	unsigned int heart_beat_delay;
743 
744 	/* autoclose */
745 	unsigned int sctp_autoclose_ticks;
746 
747 	/* how many preopen streams we have */
748 	unsigned int pre_open_streams;
749 
750 	/* How many streams I support coming into me */
751 	unsigned int max_inbound_streams;
752 
753 	/* the cookie life I award for any cookie, in seconds */
754 	unsigned int cookie_life;
755 	/* time to delay acks for */
756 	unsigned int delayed_ack;
757 	unsigned int old_delayed_ack;
758 	unsigned int sack_freq;
759 	unsigned int data_pkts_seen;
760 
761 	unsigned int numduptsns;
762 	int dup_tsns[SCTP_MAX_DUP_TSNS];
763 	unsigned int initial_init_rto_max;	/* initial RTO for INIT's */
764 	unsigned int initial_rto;	/* initial send RTO */
765 	unsigned int minrto;	/* per assoc RTO-MIN */
766 	unsigned int maxrto;	/* per assoc RTO-MAX */
767 
768 	/* authentication fields */
769 	sctp_auth_chklist_t *local_auth_chunks;
770 	sctp_auth_chklist_t *peer_auth_chunks;
771 	sctp_hmaclist_t *local_hmacs;	/* local HMACs supported */
772 	sctp_hmaclist_t *peer_hmacs;	/* peer HMACs supported */
773 	struct sctp_keyhead shared_keys;	/* assoc's shared keys */
774 	sctp_authinfo_t authinfo;	/* randoms, cached keys */
775 	/*
776 	 * refcnt to block freeing when a sender or receiver is off coping
777 	 * user data in.
778 	 */
779 	uint32_t refcnt;
780 	uint32_t chunks_on_out_queue;	/* total chunks floating around,
781 					 * locked by send socket buffer */
782 
783 	uint16_t peer_hmac_id;	/* peer HMAC id to send */
784 
785 	/*
786 	 * Being that we have no bag to collect stale cookies, and that we
787 	 * really would not want to anyway.. we will count them in this
788 	 * counter. We of course feed them to the pigeons right away (I have
789 	 * always thought of pigeons as flying rats).
790 	 */
791 	uint16_t stale_cookie_count;
792 
793 	/*
794 	 * For the partial delivery API, if up, invoked this is what last
795 	 * TSN I delivered
796 	 */
797 	uint16_t str_of_pdapi;
798 	uint16_t ssn_of_pdapi;
799 
800 	/* counts of actual built streams. Allocation may be more however */
801 	/* could re-arrange to optimize space here. */
802 	uint16_t streamincnt;
803 	uint16_t streamoutcnt;
804 
805 	/* my maximum number of retrans of INIT and SEND */
806 	/* copied from SCTP but should be individually setable */
807 	uint16_t max_init_times;
808 	uint16_t max_send_times;
809 
810 	uint16_t def_net_failure;
811 
812 	/*
813 	 * lock flag: 0 is ok to send, 1+ (duals as a retran count) is
814 	 * awaiting ACK
815 	 */
816 	uint16_t asconf_sent;	/* possibly removable REM */
817 	uint16_t mapping_array_size;
818 
819 	uint16_t last_strm_seq_delivered;
820 	uint16_t last_strm_no_delivered;
821 
822 	uint16_t last_revoke_count;
823 	int16_t num_send_timers_up;
824 
825 	uint16_t stream_locked_on;
826 	uint16_t ecn_echo_cnt_onq;
827 
828 	uint16_t free_chunk_cnt;
829 
830 	uint8_t stream_locked;
831 	uint8_t authenticated;	/* packet authenticated ok */
832 	/*
833 	 * This flag indicates that a SACK need to be sent. Initially this
834 	 * is 1 to send the first sACK immediately.
835 	 */
836 	uint8_t send_sack;
837 
838 	/* max burst after fast retransmit completes */
839 	uint8_t max_burst;
840 
841 	uint8_t sat_network;	/* RTT is in range of sat net or greater */
842 	uint8_t sat_network_lockout;	/* lockout code */
843 	uint8_t burst_limit_applied;	/* Burst limit in effect at last send? */
844 	/* flag goes on when we are doing a partial delivery api */
845 	uint8_t hb_random_values[4];
846 	uint8_t fragmented_delivery_inprogress;
847 	uint8_t fragment_flags;
848 	uint8_t last_flags_delivered;
849 	uint8_t hb_ect_randombit;
850 	uint8_t hb_random_idx;
851 	uint8_t hb_is_disabled;	/* is the hb disabled? */
852 	uint8_t default_tos;
853 
854 	/* ECN Nonce stuff */
855 	uint8_t receiver_nonce_sum;	/* nonce I sum and put in my sack */
856 	uint8_t ecn_nonce_allowed;	/* Tells us if ECN nonce is on */
857 	uint8_t nonce_sum_check;/* On off switch used during re-sync */
858 	uint8_t nonce_wait_for_ecne;	/* flag when we expect a ECN */
859 	uint8_t peer_supports_ecn_nonce;
860 
861 	/*
862 	 * This value, plus all other ack'd but above cum-ack is added
863 	 * together to cross check against the bit that we have yet to
864 	 * define (probably in the SACK). When the cum-ack is updated, this
865 	 * sum is updated as well.
866 	 */
867 	uint8_t nonce_sum_expect_base;
868 	/* Flag to tell if ECN is allowed */
869 	uint8_t ecn_allowed;
870 
871 	/* flag to indicate if peer can do asconf */
872 	uint8_t peer_supports_asconf;
873 	/* pr-sctp support flag */
874 	uint8_t peer_supports_prsctp;
875 	/* peer authentication support flag */
876 	uint8_t peer_supports_auth;
877 	/* stream resets are supported by the peer */
878 	uint8_t peer_supports_strreset;
879 
880 	/*
881 	 * packet drop's are supported by the peer, we don't really care
882 	 * about this but we bookkeep it anyway.
883 	 */
884 	uint8_t peer_supports_pktdrop;
885 
886 	/* Do we allow V6/V4? */
887 	uint8_t ipv4_addr_legal;
888 	uint8_t ipv6_addr_legal;
889 	/* Address scoping flags */
890 	/* scope value for IPv4 */
891 	uint8_t ipv4_local_scope;
892 	/* scope values for IPv6 */
893 	uint8_t local_scope;
894 	uint8_t site_scope;
895 	/* loopback scope */
896 	uint8_t loopback_scope;
897 	/* flags to handle send alternate net tracking */
898 	uint8_t used_alt_onsack;
899 	uint8_t used_alt_asconfack;
900 	uint8_t fast_retran_loss_recovery;
901 	uint8_t sat_t3_loss_recovery;
902 	uint8_t dropped_special_cnt;
903 	uint8_t seen_a_sack_this_pkt;
904 	uint8_t stream_reset_outstanding;
905 	uint8_t stream_reset_out_is_outstanding;
906 	uint8_t delayed_connection;
907 	uint8_t ifp_had_enobuf;
908 	uint8_t saw_sack_with_frags;
909 	uint8_t in_restart_hash;
910 	uint8_t assoc_up_sent;
911 	/* CMT variables */
912 	uint8_t cmt_dac_pkts_rcvd;
913 	uint8_t sctp_cmt_on_off;
914 	uint8_t iam_blocking;
915 	uint8_t cookie_how[8];
916 	/*
917 	 * The mapping array is used to track out of order sequences above
918 	 * last_acked_seq. 0 indicates packet missing 1 indicates packet
919 	 * rec'd. We slide it up every time we raise last_acked_seq and 0
920 	 * trailing locactions out.  If I get a TSN above the array
921 	 * mappingArraySz, I discard the datagram and let retransmit happen.
922 	 */
923 	uint32_t marked_retrans;
924 	uint32_t timoinit;
925 	uint32_t timodata;
926 	uint32_t timosack;
927 	uint32_t timoshutdown;
928 	uint32_t timoheartbeat;
929 	uint32_t timocookie;
930 	uint32_t timoshutdownack;
931 	struct timeval start_time;
932 	struct timeval discontinuity_time;
933 };
934 
935 #endif
936