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