NFE - Change default RX ring size from 128 -> 256, Adjust moderation timer.
[dragonfly.git] / contrib / tcpdump / sctpConstants.h
blobac28a151d0e8837caf9a1f069e46be878be6fec7
1 /* @(#) $Header: /tcpdump/master/tcpdump/sctpConstants.h,v 1.4 2003-06-03 23:49:23 guy Exp $ (LBL) */
3 /* SCTP reference Implementation Copyright (C) 1999 Cisco And Motorola
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of Cisco nor of Motorola may be used
17 * to endorse or promote products derived from this software without
18 * specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
32 * This file is part of the SCTP reference Implementation
35 * Please send any bug reports or fixes you make to one of the following email
36 * addresses:
38 * rstewar1@email.mot.com
39 * kmorneau@cisco.com
40 * qxie1@email.mot.com
42 * Any bugs reported given to us we will try to fix... any fixes shared will
43 * be incorperated into the next SCTP release.
47 #ifndef __sctpConstants_h__
48 #define __sctpConstants_h__
51 /* If you wish to use MD5 instead of SLA uncomment the line
52 * below. Why you would like to do this:
53 * a) There may be IPR on SHA-1, or so the FIP-180-1 page says,
54 * b) MD5 is 3 times faster (has coded here).
56 * The disadvantage is, it is thought that MD5 has been
57 * cracked... see RFC2104.
59 /*#define USE_MD5 1*/
61 /* the SCTP protocol signature
62 * this includes the version number
63 * encoded in the last 4 bits of the
64 * signature.
66 #define PROTO_SIGNATURE_A 0x30000000
68 #define SCTP_VERSION_NUMBER 0x3
70 #define MAX_TSN 0xffffffff
71 #define MAX_SEQ 0xffff
73 /* option:
74 * If you comment out the following you will
75 * receive the old behavior of obeying cwnd for
76 * the fast retransmit algorithm. With this defined
77 * a FR happens right away with-out waiting for the
78 * flightsize to drop below the cwnd value (which
79 * is reduced by the FR to 1/2 the inflight packets).
81 #define SCTP_IGNORE_CWND_ON_FR 1
82 /* default max I can burst out after a fast retransmit */
83 #define SCTP_DEF_MAX_BURST 4
85 /* Packet transmit states in the sent
86 * field in the SCTP_transmitOnQueue struct
88 #define SCTP_DATAGRAM_UNSENT 0
89 #define SCTP_DATAGRAM_SENT 1
90 #define SCTP_DATAGRAM_RESEND1 2 /* not used */
91 #define SCTP_DATAGRAM_RESEND2 3 /* not used */
92 #define SCTP_DATAGRAM_RESEND3 4 /* not used */
93 #define SCTP_DATAGRAM_RESEND 5
94 #define SCTP_DATAGRAM_ACKED 10010
95 #define SCTP_DATAGRAM_INBOUND 10011
96 #define SCTP_READY_TO_TRANSMIT 10012
97 #define SCTP_DATAGRAM_MARKED 20010
99 #define MAX_FSID 64 /* debug 5 ints used for cc dynamic tracking */
101 /* The valid defines for all message
102 * types know to SCTP. 0 is reserved
104 #define SCTP_MSGTYPE_MASK 0xff
106 #define SCTP_DATA 0x00
107 #define SCTP_INITIATION 0x01
108 #define SCTP_INITIATION_ACK 0x02
109 #define SCTP_SELECTIVE_ACK 0x03
110 #define SCTP_HEARTBEAT_REQUEST 0x04
111 #define SCTP_HEARTBEAT_ACK 0x05
112 #define SCTP_ABORT_ASSOCIATION 0x06
113 #define SCTP_SHUTDOWN 0x07
114 #define SCTP_SHUTDOWN_ACK 0x08
115 #define SCTP_OPERATION_ERR 0x09
116 #define SCTP_COOKIE_ECHO 0x0a
117 #define SCTP_COOKIE_ACK 0x0b
118 #define SCTP_ECN_ECHO 0x0c
119 #define SCTP_ECN_CWR 0x0d
120 #define SCTP_SHUTDOWN_COMPLETE 0x0e
121 #define SCTP_FORWARD_CUM_TSN 0xc0
122 #define SCTP_RELIABLE_CNTL 0xc1
123 #define SCTP_RELIABLE_CNTL_ACK 0xc2
125 /* ABORT and SHUTDOWN COMPLETE FLAG */
126 #define SCTP_HAD_NO_TCB 0x01
128 /* Data Chuck Specific Flags */
129 #define SCTP_DATA_FRAG_MASK 0x03
130 #define SCTP_DATA_MIDDLE_FRAG 0x00
131 #define SCTP_DATA_LAST_FRAG 0x01
132 #define SCTP_DATA_FIRST_FRAG 0x02
133 #define SCTP_DATA_NOT_FRAG 0x03
134 #define SCTP_DATA_UNORDERED 0x04
136 #define SCTP_CRC_ENABLE_BIT 0x01 /* lower bit of reserved */
138 #define isSCTPControl(a) (a->chunkID != SCTP_DATA)
139 #define isSCTPData(a) (a->chunkID == SCTP_DATA)
141 /* sctp parameter types for init/init-ack */
143 #define SCTP_IPV4_PARAM_TYPE 0x0005
144 #define SCTP_IPV6_PARAM_TYPE 0x0006
145 #define SCTP_RESPONDER_COOKIE 0x0007
146 #define SCTP_UNRECOG_PARAM 0x0008
147 #define SCTP_COOKIE_PRESERVE 0x0009
148 #define SCTP_HOSTNAME_VIA_DNS 0x000b
149 #define SCTP_RESTRICT_ADDR_TO 0x000c
151 #define SCTP_ECN_I_CAN_DO_ECN 0x8000
152 #define SCTP_OPERATION_SUCCEED 0x4001
153 #define SCTP_ERROR_NOT_EXECUTED 0x4002
155 #define SCTP_UNRELIABLE_STRM 0xc000
156 #define SCTP_ADD_IP_ADDRESS 0xc001
157 #define SCTP_DEL_IP_ADDRESS 0xc002
158 #define SCTP_STRM_FLOW_LIMIT 0xc003
159 #define SCTP_PARTIAL_CSUM 0xc004
160 #define SCTP_ERROR_CAUSE_TLV 0xc005
161 #define SCTP_MIT_STACK_NAME 0xc006
162 #define SCTP_SETADDRESS_PRIMARY 0xc007
164 /* bits for TOS field */
165 #define SCTP_ECT_BIT 0x02
166 #define SCTP_CE_BIT 0x01
168 /* error codes */
169 #define SCTP_OP_ERROR_NO_ERROR 0x0000
170 #define SCTP_OP_ERROR_INV_STRM 0x0001
171 #define SCTP_OP_ERROR_MISS_PARAM 0x0002
172 #define SCTP_OP_ERROR_STALE_COOKIE 0x0003
173 #define SCTP_OP_ERROR_NO_RESOURCE 0x0004
174 #define SCTP_OP_ERROR_DNS_FAILED 0x0005
175 #define SCTP_OP_ERROR_UNK_CHUNK 0x0006
176 #define SCTP_OP_ERROR_INV_PARAM 0x0007
177 #define SCTP_OP_ERROR_UNK_PARAM 0x0008
178 #define SCTP_OP_ERROR_NO_USERD 0x0009
179 #define SCTP_OP_ERROR_COOKIE_SHUT 0x000a
180 #define SCTP_OP_ERROR_DELETE_LAST 0x000b
181 #define SCTP_OP_ERROR_RESOURCE_SHORT 0x000c
183 #define SCTP_MAX_ERROR_CAUSE 12
185 /* empty error causes i.e. nothing but the cause
186 * are SCTP_OP_ERROR_NO_RESOURCE, SCTP_OP_ERROR_INV_PARAM,
187 * SCTP_OP_ERROR_COOKIE_SHUT.
190 /* parameter for Heart Beat */
191 #define HEART_BEAT_PARAM 0x0001
195 /* send options for SCTP
197 #define SCTP_ORDERED_DELIVERY 0x01
198 #define SCTP_NON_ORDERED_DELIVERY 0x02
199 #define SCTP_DO_CRC16 0x08
200 #define SCTP_MY_ADDRESS_ONLY 0x10
202 /* below turns off above */
203 #define SCTP_FLEXIBLE_ADDRESS 0x20
204 #define SCTP_NO_HEARTBEAT 0x40
206 /* mask to get sticky */
207 #define SCTP_STICKY_OPTIONS_MASK 0x0c
209 /* MTU discovery flags */
210 #define SCTP_DONT_FRAGMENT 0x0100
211 #define SCTP_FRAGMENT_OK 0x0200
214 /* SCTP state defines for internal state machine */
215 #define SCTP_STATE_EMPTY 0x0000
216 #define SCTP_STATE_INUSE 0x0001
217 #define SCTP_STATE_COOKIE_WAIT 0x0002
218 #define SCTP_STATE_COOKIE_SENT 0x0004
219 #define SCTP_STATE_OPEN 0x0008
220 #define SCTP_STATE_SHUTDOWN 0x0010
221 #define SCTP_STATE_SHUTDOWN_RECV 0x0020
222 #define SCTP_STATE_SHUTDOWN_ACK_SENT 0x0040
223 #define SCTP_STATE_SHUTDOWN_PEND 0x0080
224 #define SCTP_STATE_MASK 0x007f
225 /* SCTP reachability state for each address */
226 #define SCTP_ADDR_NOT_REACHABLE 1
227 #define SCTP_ADDR_REACHABLE 2
228 #define SCTP_ADDR_NOHB 4
229 #define SCTP_ADDR_BEING_DELETED 8
231 /* How long a cookie lives */
232 #define SCTP_DEFAULT_COOKIE_LIFE 60 /* seconds */
234 /* resource limit of streams */
235 #define MAX_SCTP_STREAMS 2048
238 /* guess at how big to make the TSN mapping array */
239 #define SCTP_STARTING_MAPARRAY 10000
241 /* Here we define the timer types used
242 * by the implementation has
243 * arguments in the set/get timer type calls.
245 #define SCTP_TIMER_INIT 0
246 #define SCTP_TIMER_RECV 1
247 #define SCTP_TIMER_SEND 2
248 #define SCTP_TIMER_SHUTDOWN 3
249 #define SCTP_TIMER_HEARTBEAT 4
250 #define SCTP_TIMER_PMTU 5
251 /* number of timer types in the base SCTP
252 * structure used in the set/get and has
253 * the base default.
255 #define SCTP_NUM_TMRS 6
259 #define SCTP_IPV4_ADDRESS 2
260 #define SCTP_IPV6_ADDRESS 4
262 /* timer types */
263 #define SctpTimerTypeNone 0
264 #define SctpTimerTypeSend 1
265 #define SctpTimerTypeInit 2
266 #define SctpTimerTypeRecv 3
267 #define SctpTimerTypeShutdown 4
268 #define SctpTimerTypeHeartbeat 5
269 #define SctpTimerTypeCookie 6
270 #define SctpTimerTypeNewCookie 7
271 #define SctpTimerTypePathMtuRaise 8
272 #define SctpTimerTypeShutdownAck 9
273 #define SctpTimerTypeRelReq 10
275 /* Here are the timer directives given to the
276 * user provided function
278 #define SCTP_TIMER_START 1
279 #define SCTP_TIMER_STOP 2
281 /* running flag states in timer structure */
282 #define SCTP_TIMER_IDLE 0x0
283 #define SCTP_TIMER_EXPIRED 0x1
284 #define SCTP_TIMER_RUNNING 0x2
287 /* number of simultaneous timers running */
288 #define SCTP_MAX_NET_TIMERS 6 /* base of where net timers start */
289 #define SCTP_NUMBER_TIMERS 12 /* allows up to 6 destinations */
292 /* Of course we really don't collect stale cookies, being
293 * folks of decerning taste. However we do count them, if
294 * we get to many before the association comes up.. we
295 * give up. Below is the constant that dictates when
296 * we give it up...this is a implemenation dependant
297 * treatment. In ours we do not ask for a extension of
298 * time, but just retry this many times...
300 #define SCTP_MAX_STALE_COOKIES_I_COLLECT 10
302 /* max number of TSN's dup'd that I will hold */
303 #define SCTP_MAX_DUP_TSNS 20
305 /* Here we define the types used when
306 * setting the retry ammounts.
308 /* constants for type of set */
309 #define SCTP_MAXATTEMPT_INIT 2
310 #define SCTP_MAXATTEMPT_SEND 3
312 /* Here we define the default timers and the
313 * default number of attemts we make for
314 * each respective side (send/init).
317 /* init timer def = 3sec */
318 #define SCTP_INIT_SEC 3
319 #define SCTP_INIT_NSEC 0
321 /* send timer def = 3 seconds */
322 #define SCTP_SEND_SEC 1
323 #define SCTP_SEND_NSEC 0
325 /* recv timer def = 200ms (in nsec) */
326 #define SCTP_RECV_SEC 0
327 #define SCTP_RECV_NSEC 200000000
329 /* 30 seconds + RTO */
330 #define SCTP_HB_SEC 30
331 #define SCTP_HB_NSEC 0
334 /* 300 ms */
335 #define SCTP_SHUTDOWN_SEC 0
336 #define SCTP_SHUTDOWN_NSEC 300000000
338 #define SCTP_RTO_UPPER_BOUND 60000000 /* 60 sec in micro-second's */
339 #define SCTP_RTO_UPPER_BOUND_SEC 60 /* for the init timer */
340 #define SCTP_RTO_LOWER_BOUND 1000000 /* 1 sec in micro-sec's */
342 #define SCTP_DEF_MAX_INIT 8
343 #define SCTP_DEF_MAX_SEND 10
345 #define SCTP_DEF_PMTU_RAISE 600 /* 10 Minutes between raise attempts */
346 #define SCTP_DEF_PMTU_MIN 600
348 #define SCTP_MSEC_IN_A_SEC 1000
349 #define SCTP_USEC_IN_A_SEC 1000000
350 #define SCTP_NSEC_IN_A_SEC 1000000000
353 /* Events that SCTP will look for, these
354 * are or'd together to declare what SCTP
355 * wants. Each select mask/poll list should be
356 * set for the fd, if the bit is on.
358 #define SCTP_EVENT_READ 0x000001
359 #define SCTP_EVENT_WRITE 0x000002
360 #define SCTP_EVENT_EXCEPT 0x000004
362 /* The following constant is a value for this
363 * particular implemenation. It is quite arbitrary and
364 * is used to limit how much data will be queued up to
365 * a sender, waiting for cwnd to be larger than flightSize.
366 * All implementations will need this protection is some
367 * way due to buffer size constraints.
370 #define SCTP_MAX_OUTSTANDING_DG 10000
374 /* This constant (SCTP_MAX_READBUFFER) define
375 * how big the read/write buffer is
376 * when we enter the fd event notification
377 * the buffer is put on the stack, so the bigger
378 * it is the more stack you chew up, however it
379 * has got to be big enough to handle the bigest
380 * message this O/S will send you. In solaris
381 * with sockets (not TLI) we end up at a value
382 * of 64k. In TLI we could do partial reads to
383 * get it all in with less hassel.. but we
384 * write to sockets for generality.
386 #define SCTP_MAX_READBUFFER 65536
387 #define SCTP_ADDRMAX 60
389 /* amount peer is obligated to have in rwnd or
390 * I will abort
392 #define SCTP_MIN_RWND 1500
394 #define SCTP_WINDOW_MIN 1500 /* smallest rwnd can be */
395 #define SCTP_WINDOW_MAX 1048576 /* biggest I can grow rwnd to
396 * My playing around suggests a
397 * value greater than 64k does not
398 * do much, I guess via the kernel
399 * limitations on the stream/socket.
402 #define SCTP_MAX_BUNDLE_UP 256 /* max number of chunks I can bundle */
404 /* I can handle a 1meg re-assembly */
405 #define SCTP_DEFAULT_MAXMSGREASM 1048576
408 #define SCTP_DEFAULT_MAXWINDOW 32768 /* default rwnd size */
409 #define SCTP_DEFAULT_MAXSEGMENT 1500 /* MTU size, this is the default
410 * to which we set the smallestMTU
411 * size to. This governs what is the
412 * largest size we will use, of course
413 * PMTU will raise this up to
414 * the largest interface MTU or the
415 * ceiling below if there is no
416 * SIOCGIFMTU.
418 #ifdef LYNX
419 #define DEFAULT_MTU_CEILING 1500 /* Since Lynx O/S is brain dead
420 * in the way it handles the
421 * raw IP socket, insisting
422 * on makeing its own IP
423 * header, we limit the growth
424 * to that of the e-net size
426 #else
427 #define DEFAULT_MTU_CEILING 2048 /* If no SIOCGIFMTU, highest value
428 * to raise the PMTU to, i.e.
429 * don't try to raise above this
430 * value. Tune this per your
431 * largest MTU interface if your
432 * system does not support the
433 * SIOCGIFMTU ioctl.
435 #endif
436 #define SCTP_DEFAULT_MINSEGMENT 512 /* MTU size ... if no mtu disc */
437 #define SCTP_HOW_MANY_SECRETS 2 /* how many secrets I keep */
438 /* This is how long a secret lives, NOT how long a cookie lives */
439 #define SCTP_HOW_LONG_COOKIE_LIVE 3600 /* how many seconds the current secret will live */
441 #define SCTP_NUMBER_OF_SECRETS 8 /* or 8 * 4 = 32 octets */
442 #define SCTP_SECRET_SIZE 32 /* number of octets in a 256 bits */
444 #ifdef USE_MD5
445 #define SCTP_SIGNATURE_SIZE 16 /* size of a MD5 signature */
446 #else
447 #define SCTP_SIGNATURE_SIZE 20 /* size of a SLA-1 signature */
448 #endif
449 /* Here are the notification constants
450 * that the code and upper layer will get
453 /* association is up */
454 #define SCTP_NOTIFY_ASSOC_UP 1
456 /* association is down */
457 #define SCTP_NOTIFY_ASSOC_DOWN 2
459 /* interface on a association is down
460 * and out of consideration for selection.
462 #define SCTP_NOTIFY_INTF_DOWN 3
464 /* interface on a association is up
465 * and now back in consideration for selection.
467 #define SCTP_NOTIFY_INTF_UP 4
469 /* The given datagram cannot be delivered
470 * to the peer, this will probably be followed
471 * by a SCTP_NOTFIY_ASSOC_DOWN.
473 #define SCTP_NOTIFY_DG_FAIL 5
475 /* Sent dg on non-open stream extreme code error!
477 #define SCTP_NOTIFY_STRDATA_ERR 6
479 #define SCTP_NOTIFY_ASSOC_ABORTED 7
481 /* The stream ones are not used yet, but could
482 * be when a association opens.
484 #define SCTP_NOTIFY_PEER_OPENED_STR 8
485 #define SCTP_NOTIFY_STREAM_OPENED_OK 9
487 /* association sees a restart event */
488 #define SCTP_NOTIFY_ASSOC_RESTART 10
490 /* a user requested HB returned */
491 #define SCTP_NOTIFY_HB_RESP 11
493 /* a result from a REL-REQ */
494 #define SCTP_NOTIFY_RELREQ_RESULT_OK 12
495 #define SCTP_NOTIFY_RELREQ_RESULT_FAILED 13
497 /* clock variance is 10ms or 10,000 us's */
498 #define SCTP_CLOCK_GRAINULARITY 10000
500 #define IP_HDR_SIZE 40 /* we use the size of a IP6 header here
501 * this detracts a small amount for ipv4
502 * but it simplifies the ipv6 addition
505 #define SCTP_NUM_FDS 3
507 /* raw IP filedescriptor */
508 #define SCTP_FD_IP 0
509 /* raw ICMP filedescriptor */
510 #define SCTP_FD_ICMP 1
511 /* processes contact me for requests here */
512 #define SCTP_REQUEST 2
515 #define SCTP_DEAMON_PORT 9899
517 /* Deamon registration message types/responses */
518 #define DEAMON_REGISTER 0x01
519 #define DEAMON_REGISTER_ACK 0x02
520 #define DEAMON_DEREGISTER 0x03
521 #define DEAMON_DEREGISTER_ACK 0x04
522 #define DEAMON_CHECKADDR_LIST 0x05
524 #define DEAMON_MAGIC_VER_LEN 0xff
526 /* max times I will attempt to send a message to deamon */
527 #define SCTP_MAX_ATTEMPTS_AT_DEAMON 5
528 #define SCTP_TIMEOUT_IN_POLL_FOR_DEAMON 1500 /* 1.5 seconds */
530 /* modular comparison */
531 /* True if a > b (mod = M) */
532 #define compare_with_wrap(a, b, M) ((a > b) && ((a - b) < (M >> 1))) || \
533 ((b > a) && ((b - a) > (M >> 1)))
535 #ifndef TIMEVAL_TO_TIMESPEC
536 #define TIMEVAL_TO_TIMESPEC(tv, ts) \
538 (ts)->tv_sec = (tv)->tv_sec; \
539 (ts)->tv_nsec = (tv)->tv_usec * 1000; \
541 #endif
543 /* pegs */
544 #define SCTP_NUMBER_OF_PEGS 21
545 /* peg index's */
546 #define SCTP_PEG_SACKS_SEEN 0
547 #define SCTP_PEG_SACKS_SENT 1
548 #define SCTP_PEG_TSNS_SENT 2
549 #define SCTP_PEG_TSNS_RCVD 3
550 #define SCTP_DATAGRAMS_SENT 4
551 #define SCTP_DATAGRAMS_RCVD 5
552 #define SCTP_RETRANTSN_SENT 6
553 #define SCTP_DUPTSN_RECVD 7
554 #define SCTP_HBR_RECV 8
555 #define SCTP_HBA_RECV 9
556 #define SCTP_HB_SENT 10
557 #define SCTP_DATA_DG_SENT 11
558 #define SCTP_DATA_DG_RECV 12
559 #define SCTP_TMIT_TIMER 13
560 #define SCTP_RECV_TIMER 14
561 #define SCTP_HB_TIMER 15
562 #define SCTP_FAST_RETRAN 16
563 #define SCTP_PEG_TSNS_READ 17
564 #define SCTP_NONE_LFT_TO 18
565 #define SCTP_NONE_LFT_RWND 19
566 #define SCTP_NONE_LFT_CWND 20
570 #endif