[thirdparty/kernel/stable.git] / include / net / sctp / constants.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/* SCTP kernel implementation
 * (C) Copyright IBM Corp. 2001, 2004
 * Copyright (c) 1999-2000 Cisco, Inc.
 * Copyright (c) 1999-2001 Motorola, Inc.
 * Copyright (c) 2001 Intel Corp.
 *
 * This file is part of the SCTP kernel implementation
 *
 * Please send any bug reports or fixes you make to the
 * email address(es):
 *    lksctp developers <linux-sctp@vger.kernel.org>
 *
 * Written or modified by:
 *   La Monte H.P. Yarroll <piggy@acm.org>
 *   Karl Knutson          <karl@athena.chicago.il.us>
 *   Randall Stewart       <randall@stewart.chicago.il.us>
 *   Ken Morneau           <kmorneau@cisco.com>
 *   Qiaobing Xie          <qxie1@motorola.com>
 *   Xingang Guo           <xingang.guo@intel.com>
 *   Sridhar Samudrala     <samudrala@us.ibm.com>
 *   Daisy Chang           <daisyc@us.ibm.com>
 */

#ifndef __sctp_constants_h__
#define __sctp_constants_h__

#include <linux/sctp.h>
#include <linux/ipv6.h> /* For ipv6hdr. */
#include <net/tcp_states.h>  /* For TCP states used in enum sctp_sock_state */

/* Value used for stream negotiation. */
enum { SCTP_MAX_STREAM = 0xffff };
enum { SCTP_DEFAULT_OUTSTREAMS = 10 };
enum { SCTP_DEFAULT_INSTREAMS = SCTP_MAX_STREAM };

/* Since CIDs are sparse, we need all four of the following
 * symbols.  CIDs are dense through SCTP_CID_BASE_MAX.
 */
#define SCTP_CID_BASE_MAX		SCTP_CID_SHUTDOWN_COMPLETE

#define SCTP_NUM_BASE_CHUNK_TYPES	(SCTP_CID_BASE_MAX + 1)

#define SCTP_NUM_ADDIP_CHUNK_TYPES	2

#define SCTP_NUM_PRSCTP_CHUNK_TYPES	1

#define SCTP_NUM_RECONF_CHUNK_TYPES	1

#define SCTP_NUM_AUTH_CHUNK_TYPES	1

#define SCTP_NUM_CHUNK_TYPES		(SCTP_NUM_BASE_CHUNK_TYPES + \
					 SCTP_NUM_ADDIP_CHUNK_TYPES +\
					 SCTP_NUM_PRSCTP_CHUNK_TYPES +\
					 SCTP_NUM_RECONF_CHUNK_TYPES +\
					 SCTP_NUM_AUTH_CHUNK_TYPES)

/* These are the different flavours of event.  */
enum sctp_event_type {
	SCTP_EVENT_T_CHUNK = 1,
	SCTP_EVENT_T_TIMEOUT,
	SCTP_EVENT_T_OTHER,
	SCTP_EVENT_T_PRIMITIVE
};

/* As a convenience for the state machine, we append SCTP_EVENT_* and
 * SCTP_ULP_* to the list of possible chunks.
 */

enum sctp_event_timeout {
	SCTP_EVENT_TIMEOUT_NONE = 0,
	SCTP_EVENT_TIMEOUT_T1_COOKIE,
	SCTP_EVENT_TIMEOUT_T1_INIT,
	SCTP_EVENT_TIMEOUT_T2_SHUTDOWN,
	SCTP_EVENT_TIMEOUT_T3_RTX,
	SCTP_EVENT_TIMEOUT_T4_RTO,
	SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD,
	SCTP_EVENT_TIMEOUT_HEARTBEAT,
	SCTP_EVENT_TIMEOUT_RECONF,
	SCTP_EVENT_TIMEOUT_SACK,
	SCTP_EVENT_TIMEOUT_AUTOCLOSE,
};

#define SCTP_EVENT_TIMEOUT_MAX		SCTP_EVENT_TIMEOUT_AUTOCLOSE
#define SCTP_NUM_TIMEOUT_TYPES		(SCTP_EVENT_TIMEOUT_MAX + 1)

enum sctp_event_other {
	SCTP_EVENT_NO_PENDING_TSN = 0,
	SCTP_EVENT_ICMP_PROTO_UNREACH,
};

#define SCTP_EVENT_OTHER_MAX		SCTP_EVENT_ICMP_PROTO_UNREACH
#define SCTP_NUM_OTHER_TYPES		(SCTP_EVENT_OTHER_MAX + 1)

/* These are primitive requests from the ULP.  */
enum sctp_event_primitive {
	SCTP_PRIMITIVE_ASSOCIATE = 0,
	SCTP_PRIMITIVE_SHUTDOWN,
	SCTP_PRIMITIVE_ABORT,
	SCTP_PRIMITIVE_SEND,
	SCTP_PRIMITIVE_REQUESTHEARTBEAT,
	SCTP_PRIMITIVE_ASCONF,
	SCTP_PRIMITIVE_RECONF,
};

#define SCTP_EVENT_PRIMITIVE_MAX	SCTP_PRIMITIVE_RECONF
#define SCTP_NUM_PRIMITIVE_TYPES	(SCTP_EVENT_PRIMITIVE_MAX + 1)

/* We define here a utility type for manipulating subtypes.
 * The subtype constructors all work like this:
 *
 *   union sctp_subtype foo = SCTP_ST_CHUNK(SCTP_CID_INIT);
 */

union sctp_subtype {
	enum sctp_cid chunk;
	enum sctp_event_timeout timeout;
	enum sctp_event_other other;
	enum sctp_event_primitive primitive;
};

#define SCTP_SUBTYPE_CONSTRUCTOR(_name, _type, _elt) \
static inline union sctp_subtype	\
SCTP_ST_## _name (_type _arg)		\
{ union sctp_subtype _retval; _retval._elt = _arg; return _retval; }

SCTP_SUBTYPE_CONSTRUCTOR(CHUNK,		enum sctp_cid,		chunk)
SCTP_SUBTYPE_CONSTRUCTOR(TIMEOUT,	enum sctp_event_timeout, timeout)
SCTP_SUBTYPE_CONSTRUCTOR(OTHER,		enum sctp_event_other,	other)
SCTP_SUBTYPE_CONSTRUCTOR(PRIMITIVE,	enum sctp_event_primitive, primitive)


#define sctp_chunk_is_data(a) (a->chunk_hdr->type == SCTP_CID_DATA || \
			       a->chunk_hdr->type == SCTP_CID_I_DATA)

/* Internal error codes */
enum sctp_ierror {
	SCTP_IERROR_NO_ERROR	        = 0,
	SCTP_IERROR_BASE		= 1000,
	SCTP_IERROR_NO_COOKIE,
	SCTP_IERROR_BAD_SIG,
	SCTP_IERROR_STALE_COOKIE,
	SCTP_IERROR_NOMEM,
	SCTP_IERROR_MALFORMED,
	SCTP_IERROR_BAD_TAG,
	SCTP_IERROR_BIG_GAP,
	SCTP_IERROR_DUP_TSN,
	SCTP_IERROR_HIGH_TSN,
	SCTP_IERROR_IGNORE_TSN,
	SCTP_IERROR_NO_DATA,
	SCTP_IERROR_BAD_STREAM,
	SCTP_IERROR_BAD_PORTS,
	SCTP_IERROR_AUTH_BAD_HMAC,
	SCTP_IERROR_AUTH_BAD_KEYID,
	SCTP_IERROR_PROTO_VIOLATION,
	SCTP_IERROR_ERROR,
	SCTP_IERROR_ABORT,
};


/* SCTP state defines for internal state machine */
enum sctp_state {

	SCTP_STATE_CLOSED		= 0,
	SCTP_STATE_COOKIE_WAIT		= 1,
	SCTP_STATE_COOKIE_ECHOED	= 2,
	SCTP_STATE_ESTABLISHED		= 3,
	SCTP_STATE_SHUTDOWN_PENDING	= 4,
	SCTP_STATE_SHUTDOWN_SENT	= 5,
	SCTP_STATE_SHUTDOWN_RECEIVED	= 6,
	SCTP_STATE_SHUTDOWN_ACK_SENT	= 7,

};

#define SCTP_STATE_MAX			SCTP_STATE_SHUTDOWN_ACK_SENT
#define SCTP_STATE_NUM_STATES		(SCTP_STATE_MAX + 1)

/* These are values for sk->state.
 * For a UDP-style SCTP socket, the states are defined as follows
 * - A socket in SCTP_SS_CLOSED state indicates that it is not willing to
 *   accept new associations, but it can initiate the creation of new ones.
 * - A socket in SCTP_SS_LISTENING state indicates that it is willing to
 *   accept new  associations and can initiate the creation of new ones.
 * - A socket in SCTP_SS_ESTABLISHED state indicates that it is a peeled off
 *   socket with one association.
 * For a TCP-style SCTP socket, the states are defined as follows
 * - A socket in SCTP_SS_CLOSED state indicates that it is not willing to
 *   accept new associations, but it can initiate the creation of new ones.
 * - A socket in SCTP_SS_LISTENING state indicates that it is willing to
 *   accept new associations, but cannot initiate the creation of new ones.
 * - A socket in SCTP_SS_ESTABLISHED state indicates that it has a single 
 *   association.
 */
enum sctp_sock_state {
	SCTP_SS_CLOSED         = TCP_CLOSE,
	SCTP_SS_LISTENING      = TCP_LISTEN,
	SCTP_SS_ESTABLISHING   = TCP_SYN_SENT,
	SCTP_SS_ESTABLISHED    = TCP_ESTABLISHED,
	SCTP_SS_CLOSING        = TCP_CLOSE_WAIT,
};

/* These functions map various type to printable names.  */
const char *sctp_cname(const union sctp_subtype id);	/* chunk types */
const char *sctp_oname(const union sctp_subtype id);	/* other events */
const char *sctp_tname(const union sctp_subtype id);	/* timeouts */
const char *sctp_pname(const union sctp_subtype id);	/* primitives */

/* This is a table of printable names of sctp_state_t's.  */
extern const char *const sctp_state_tbl[];
extern const char *const sctp_evttype_tbl[];
extern const char *const sctp_status_tbl[];

/* Maximum chunk length considering padding requirements. */
enum { SCTP_MAX_CHUNK_LEN = ((1<<16) - sizeof(__u32)) };

/* Encourage Cookie-Echo bundling by pre-fragmenting chunks a little
 * harder (until reaching ESTABLISHED state).
 */
enum { SCTP_ARBITRARY_COOKIE_ECHO_LEN = 200 };

/* Guess at how big to make the TSN mapping array.
 * We guarantee that we can handle at least this big a gap between the
 * cumulative ACK and the highest TSN.  In practice, we can often
 * handle up to twice this value.
 *
 * NEVER make this more than 32767 (2^15-1).  The Gap Ack Blocks in a
 * SACK (see  section 3.3.4) are only 16 bits, so 2*SCTP_TSN_MAP_SIZE
 * must be less than 65535 (2^16 - 1), or we will have overflow
 * problems creating SACK's.
 */
#define SCTP_TSN_MAP_INITIAL BITS_PER_LONG
#define SCTP_TSN_MAP_INCREMENT SCTP_TSN_MAP_INITIAL
#define SCTP_TSN_MAP_SIZE 4096

/* We will not record more than this many duplicate TSNs between two
 * SACKs.  The minimum PMTU is 512.  Remove all the headers and there
 * is enough room for 117 duplicate reports.  Round down to the
 * nearest power of 2.
 */
enum { SCTP_MAX_DUP_TSNS = 16 };
enum { SCTP_MAX_GABS = 16 };

/* Heartbeat interval - 30 secs */
#define SCTP_DEFAULT_TIMEOUT_HEARTBEAT	(30*1000)

/* Delayed sack timer - 200ms */
#define SCTP_DEFAULT_TIMEOUT_SACK	(200)

/* RTO.Initial              - 3  seconds
 * RTO.Min                  - 1  second
 * RTO.Max                  - 60 seconds
 * RTO.Alpha                - 1/8
 * RTO.Beta                 - 1/4
 */
#define SCTP_RTO_INITIAL	(3 * 1000)
#define SCTP_RTO_MIN		(1 * 1000)
#define SCTP_RTO_MAX		(60 * 1000)

#define SCTP_RTO_ALPHA          3   /* 1/8 when converted to right shifts. */
#define SCTP_RTO_BETA           2   /* 1/4 when converted to right shifts. */

/* Maximum number of new data packets that can be sent in a burst.  */
#define SCTP_DEFAULT_MAX_BURST		4

#define SCTP_CLOCK_GRANULARITY	1	/* 1 jiffy */

#define SCTP_DEFAULT_COOKIE_LIFE	(60 * 1000) /* 60 seconds */

#define SCTP_DEFAULT_MINWINDOW	1500	/* default minimum rwnd size */
#define SCTP_DEFAULT_MAXWINDOW	65535	/* default rwnd size */
#define SCTP_DEFAULT_RWND_SHIFT  4	/* by default, update on 1/16 of
					 * rcvbuf, which is 1/8 of initial
					 * window
					 */
#define SCTP_DEFAULT_MAXSEGMENT 1500	/* MTU size, this is the limit
                                         * to which we will raise the P-MTU.
					 */
#define SCTP_DEFAULT_MINSEGMENT 512	/* MTU size ... if no mtu disc */

#define SCTP_SECRET_SIZE 32		/* Number of octets in a 256 bits. */

#define SCTP_SIGNATURE_SIZE 20	        /* size of a SLA-1 signature */

#define SCTP_COOKIE_MULTIPLE 32 /* Pad out our cookie to make our hash
				 * functions simpler to write.
				 */

/* These return values describe the success or failure of a number of
 * routines which form the lower interface to SCTP_outqueue.
 */
enum sctp_xmit {
	SCTP_XMIT_OK,
	SCTP_XMIT_PMTU_FULL,
	SCTP_XMIT_RWND_FULL,
	SCTP_XMIT_DELAY,
};

/* These are the commands for manipulating transports.  */
enum sctp_transport_cmd {
	SCTP_TRANSPORT_UP,
	SCTP_TRANSPORT_DOWN,
	SCTP_TRANSPORT_PF,
};

/* These are the address scopes defined mainly for IPv4 addresses
 * based on draft of SCTP IPv4 scoping <draft-stewart-tsvwg-sctp-ipv4-00.txt>.
 * These scopes are hopefully generic enough to be used on scoping both
 * IPv4 and IPv6 addresses in SCTP.
 * At this point, the IPv6 scopes will be mapped to these internal scopes
 * as much as possible.
 */
enum sctp_scope {
	SCTP_SCOPE_GLOBAL,		/* IPv4 global addresses */
	SCTP_SCOPE_PRIVATE,		/* IPv4 private addresses */
	SCTP_SCOPE_LINK,		/* IPv4 link local address */
	SCTP_SCOPE_LOOPBACK,		/* IPv4 loopback address */
	SCTP_SCOPE_UNUSABLE,		/* IPv4 unusable addresses */
};

enum {
	SCTP_SCOPE_POLICY_DISABLE,	/* Disable IPv4 address scoping */
	SCTP_SCOPE_POLICY_ENABLE,	/* Enable IPv4 address scoping */
	SCTP_SCOPE_POLICY_PRIVATE,	/* Follow draft but allow IPv4 private addresses */
	SCTP_SCOPE_POLICY_LINK,		/* Follow draft but allow IPv4 link local addresses */
};

#define SCTP_SCOPE_POLICY_MAX	SCTP_SCOPE_POLICY_LINK

/* Based on IPv4 scoping <draft-stewart-tsvwg-sctp-ipv4-00.txt>,
 * SCTP IPv4 unusable addresses: 0.0.0.0/8, 224.0.0.0/4, 198.18.0.0/24,
 * 192.88.99.0/24.
 * Also, RFC 8.4, non-unicast addresses are not considered valid SCTP
 * addresses.
 */
#define IS_IPV4_UNUSABLE_ADDRESS(a)	    \
	((htonl(INADDR_BROADCAST) == a) ||  \
	 ipv4_is_multicast(a) ||	    \
	 ipv4_is_zeronet(a) ||		    \
	 ipv4_is_test_198(a) ||		    \
	 ipv4_is_anycast_6to4(a))

/* Flags used for the bind address copy functions.  */
#define SCTP_ADDR6_ALLOWED	0x00000001	/* IPv6 address is allowed by
						   local sock family */
#define SCTP_ADDR4_PEERSUPP	0x00000002	/* IPv4 address is supported by
						   peer */
#define SCTP_ADDR6_PEERSUPP	0x00000004	/* IPv6 address is supported by
						   peer */

/* Reasons to retransmit. */
enum sctp_retransmit_reason {
	SCTP_RTXR_T3_RTX,
	SCTP_RTXR_FAST_RTX,
	SCTP_RTXR_PMTUD,
	SCTP_RTXR_T1_RTX,
};

/* Reasons to lower cwnd. */
enum sctp_lower_cwnd {
	SCTP_LOWER_CWND_T3_RTX,
	SCTP_LOWER_CWND_FAST_RTX,
	SCTP_LOWER_CWND_ECNE,
	SCTP_LOWER_CWND_INACTIVE,
};


/* SCTP-AUTH Necessary constants */

/* SCTP-AUTH, Section 3.3
 *
 *  The following Table 2 shows the currently defined values for HMAC
 *  identifiers.
 *
 *  +-----------------+--------------------------+
 *  | HMAC Identifier | Message Digest Algorithm |
 *  +-----------------+--------------------------+
 *  | 0               | Reserved                 |
 *  | 1               | SHA-1 defined in [8]     |
 *  | 2               | Reserved                 |
 *  | 3               | SHA-256 defined in [8]   |
 *  +-----------------+--------------------------+
 */
enum {
	SCTP_AUTH_HMAC_ID_RESERVED_0,
	SCTP_AUTH_HMAC_ID_SHA1,
	SCTP_AUTH_HMAC_ID_RESERVED_2,
#if defined (CONFIG_CRYPTO_SHA256) || defined (CONFIG_CRYPTO_SHA256_MODULE)
	SCTP_AUTH_HMAC_ID_SHA256,
#endif
	__SCTP_AUTH_HMAC_MAX
};

#define SCTP_AUTH_HMAC_ID_MAX	__SCTP_AUTH_HMAC_MAX - 1
#define SCTP_AUTH_NUM_HMACS 	__SCTP_AUTH_HMAC_MAX
#define SCTP_SHA1_SIG_SIZE 20
#define SCTP_SHA256_SIG_SIZE 32

/*  SCTP-AUTH, Section 3.2
 *     The chunk types for INIT, INIT-ACK, SHUTDOWN-COMPLETE and AUTH chunks
 *     MUST NOT be listed in the CHUNKS parameter
 */
#define SCTP_NUM_NOAUTH_CHUNKS	4
#define SCTP_AUTH_MAX_CHUNKS	(SCTP_NUM_CHUNK_TYPES - SCTP_NUM_NOAUTH_CHUNKS)

/* SCTP-AUTH Section 6.1
 * The RANDOM parameter MUST contain a 32 byte random number.
 */
#define SCTP_AUTH_RANDOM_LENGTH 32

#endif /* __sctp_constants_h__ */
Commit	Line	Data
47505b8b	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
60c778b2	2	/* SCTP kernel implementation
1da177e4 LT	3	* (C) Copyright IBM Corp. 2001, 2004
	4	* Copyright (c) 1999-2000 Cisco, Inc.
	5	* Copyright (c) 1999-2001 Motorola, Inc.
	6	* Copyright (c) 2001 Intel Corp.
	7	*
60c778b2	8	* This file is part of the SCTP kernel implementation
1da177e4	9	*
1da177e4 LT	10	* Please send any bug reports or fixes you make to the
1da177e4 LT	11	* email address(es):
91705c61	12	* lksctp developers <linux-sctp@vger.kernel.org>
1da177e4	13	*
1da177e4 LT	14	* Written or modified by:
	15	* La Monte H.P. Yarroll <piggy@acm.org>
	16	* Karl Knutson <karl@athena.chicago.il.us>
	17	* Randall Stewart <randall@stewart.chicago.il.us>
	18	* Ken Morneau <kmorneau@cisco.com>
	19	* Qiaobing Xie <qxie1@motorola.com>
	20	* Xingang Guo <xingang.guo@intel.com>
	21	* Sridhar Samudrala <samudrala@us.ibm.com>
	22	* Daisy Chang <daisyc@us.ibm.com>
1da177e4 LT	23	*/
	24
	25	#ifndef __sctp_constants_h__
	26	#define __sctp_constants_h__
	27
1da177e4 LT	28	#include <linux/sctp.h>
1da177e4 LT	29	#include <linux/ipv6.h> /* For ipv6hdr. */
84965614	30	#include <net/tcp_states.h> /* For TCP states used in enum sctp_sock_state */
1da177e4 LT	31
	32	/* Value used for stream negotiation. */
	33	enum { SCTP_MAX_STREAM = 0xffff };
	34	enum { SCTP_DEFAULT_OUTSTREAMS = 10 };
	35	enum { SCTP_DEFAULT_INSTREAMS = SCTP_MAX_STREAM };
	36
	37	/* Since CIDs are sparse, we need all four of the following
	38	* symbols. CIDs are dense through SCTP_CID_BASE_MAX.
	39	*/
	40	#define SCTP_CID_BASE_MAX SCTP_CID_SHUTDOWN_COMPLETE
1da177e4 LT	41
1da177e4 LT	42	#define SCTP_NUM_BASE_CHUNK_TYPES (SCTP_CID_BASE_MAX + 1)
1da177e4 LT	43
	44	#define SCTP_NUM_ADDIP_CHUNK_TYPES 2
	45
	46	#define SCTP_NUM_PRSCTP_CHUNK_TYPES 1
	47
d884aa63 XL	48	#define SCTP_NUM_RECONF_CHUNK_TYPES 1
d884aa63 XL	49
1f485649 VY	50	#define SCTP_NUM_AUTH_CHUNK_TYPES 1
	51
	52	#define SCTP_NUM_CHUNK_TYPES (SCTP_NUM_BASE_CHUNK_TYPES + \
	53	SCTP_NUM_ADDIP_CHUNK_TYPES +\
	54	SCTP_NUM_PRSCTP_CHUNK_TYPES +\
d884aa63	55	SCTP_NUM_RECONF_CHUNK_TYPES +\
1f485649 VY	56	SCTP_NUM_AUTH_CHUNK_TYPES)
1f485649 VY	57
1da177e4	58	/* These are the different flavours of event. */
88ee48c1	59	enum sctp_event_type {
1da177e4 LT	60	SCTP_EVENT_T_CHUNK = 1,
	61	SCTP_EVENT_T_TIMEOUT,
	62	SCTP_EVENT_T_OTHER,
	63	SCTP_EVENT_T_PRIMITIVE
61f0eb07	64	};
1da177e4	65
1da177e4 LT	66	/* As a convenience for the state machine, we append SCTP_EVENT_* and
	67	* SCTP_ULP_* to the list of possible chunks.
	68	*/
	69
19cd1592	70	enum sctp_event_timeout {
1da177e4 LT	71	SCTP_EVENT_TIMEOUT_NONE = 0,
	72	SCTP_EVENT_TIMEOUT_T1_COOKIE,
	73	SCTP_EVENT_TIMEOUT_T1_INIT,
	74	SCTP_EVENT_TIMEOUT_T2_SHUTDOWN,
	75	SCTP_EVENT_TIMEOUT_T3_RTX,
	76	SCTP_EVENT_TIMEOUT_T4_RTO,
	77	SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD,
	78	SCTP_EVENT_TIMEOUT_HEARTBEAT,
7b9438de	79	SCTP_EVENT_TIMEOUT_RECONF,
1da177e4 LT	80	SCTP_EVENT_TIMEOUT_SACK,
1da177e4 LT	81	SCTP_EVENT_TIMEOUT_AUTOCLOSE,
19cd1592	82	};
1da177e4 LT	83
	84	#define SCTP_EVENT_TIMEOUT_MAX SCTP_EVENT_TIMEOUT_AUTOCLOSE
	85	#define SCTP_NUM_TIMEOUT_TYPES (SCTP_EVENT_TIMEOUT_MAX + 1)
	86
a0f098d0	87	enum sctp_event_other {
1da177e4 LT	88	SCTP_EVENT_NO_PENDING_TSN = 0,
1da177e4 LT	89	SCTP_EVENT_ICMP_PROTO_UNREACH,
a0f098d0	90	};
1da177e4 LT	91
	92	#define SCTP_EVENT_OTHER_MAX SCTP_EVENT_ICMP_PROTO_UNREACH
	93	#define SCTP_NUM_OTHER_TYPES (SCTP_EVENT_OTHER_MAX + 1)
	94
	95	/* These are primitive requests from the ULP. */
dc1e0e6e	96	enum sctp_event_primitive {
1da177e4 LT	97	SCTP_PRIMITIVE_ASSOCIATE = 0,
	98	SCTP_PRIMITIVE_SHUTDOWN,
	99	SCTP_PRIMITIVE_ABORT,
	100	SCTP_PRIMITIVE_SEND,
	101	SCTP_PRIMITIVE_REQUESTHEARTBEAT,
	102	SCTP_PRIMITIVE_ASCONF,
7a090b04	103	SCTP_PRIMITIVE_RECONF,
dc1e0e6e	104	};
1da177e4	105
7a090b04	106	#define SCTP_EVENT_PRIMITIVE_MAX SCTP_PRIMITIVE_RECONF
1da177e4 LT	107	#define SCTP_NUM_PRIMITIVE_TYPES (SCTP_EVENT_PRIMITIVE_MAX + 1)
	108
	109	/* We define here a utility type for manipulating subtypes.
	110	* The subtype constructors all work like this:
	111	*
bfc6f827	112	* union sctp_subtype foo = SCTP_ST_CHUNK(SCTP_CID_INIT);
1da177e4 LT	113	*/
1da177e4 LT	114
bfc6f827	115	union sctp_subtype {
6d85e68f	116	enum sctp_cid chunk;
19cd1592	117	enum sctp_event_timeout timeout;
a0f098d0	118	enum sctp_event_other other;
dc1e0e6e	119	enum sctp_event_primitive primitive;
bfc6f827	120	};
1da177e4 LT	121
1da177e4 LT	122	#define SCTP_SUBTYPE_CONSTRUCTOR(_name, _type, _elt) \
bfc6f827	123	static inline union sctp_subtype \
1da177e4	124	SCTP_ST_## _name (_type _arg) \
bfc6f827	125	{ union sctp_subtype _retval; _retval._elt = _arg; return _retval; }
1da177e4	126
6d85e68f	127	SCTP_SUBTYPE_CONSTRUCTOR(CHUNK, enum sctp_cid, chunk)
19cd1592	128	SCTP_SUBTYPE_CONSTRUCTOR(TIMEOUT, enum sctp_event_timeout, timeout)
a0f098d0	129	SCTP_SUBTYPE_CONSTRUCTOR(OTHER, enum sctp_event_other, other)
dc1e0e6e	130	SCTP_SUBTYPE_CONSTRUCTOR(PRIMITIVE, enum sctp_event_primitive, primitive)
1da177e4 LT	131
1da177e4 LT	132
668c9beb XL	133	#define sctp_chunk_is_data(a) (a->chunk_hdr->type == SCTP_CID_DATA \|\| \
668c9beb XL	134	a->chunk_hdr->type == SCTP_CID_I_DATA)
1da177e4	135
1da177e4	136	/* Internal error codes */
4785c7ae	137	enum sctp_ierror {
1da177e4 LT	138	SCTP_IERROR_NO_ERROR = 0,
	139	SCTP_IERROR_BASE = 1000,
	140	SCTP_IERROR_NO_COOKIE,
	141	SCTP_IERROR_BAD_SIG,
	142	SCTP_IERROR_STALE_COOKIE,
	143	SCTP_IERROR_NOMEM,
	144	SCTP_IERROR_MALFORMED,
	145	SCTP_IERROR_BAD_TAG,
	146	SCTP_IERROR_BIG_GAP,
	147	SCTP_IERROR_DUP_TSN,
	148	SCTP_IERROR_HIGH_TSN,
	149	SCTP_IERROR_IGNORE_TSN,
	150	SCTP_IERROR_NO_DATA,
	151	SCTP_IERROR_BAD_STREAM,
	152	SCTP_IERROR_BAD_PORTS,
bbd0d598 VY	153	SCTP_IERROR_AUTH_BAD_HMAC,
	154	SCTP_IERROR_AUTH_BAD_KEYID,
	155	SCTP_IERROR_PROTO_VIOLATION,
7ab90804 VY	156	SCTP_IERROR_ERROR,
7ab90804 VY	157	SCTP_IERROR_ABORT,
4785c7ae	158	};
1da177e4 LT	159
	160
	161
	162	/* SCTP state defines for internal state machine */
52106019	163	enum sctp_state {
1da177e4	164
0b8f9e25 VY	165	SCTP_STATE_CLOSED = 0,
	166	SCTP_STATE_COOKIE_WAIT = 1,
	167	SCTP_STATE_COOKIE_ECHOED = 2,
	168	SCTP_STATE_ESTABLISHED = 3,
	169	SCTP_STATE_SHUTDOWN_PENDING = 4,
	170	SCTP_STATE_SHUTDOWN_SENT = 5,
	171	SCTP_STATE_SHUTDOWN_RECEIVED = 6,
	172	SCTP_STATE_SHUTDOWN_ACK_SENT = 7,
1da177e4	173
52106019	174	};
1da177e4 LT	175
	176	#define SCTP_STATE_MAX SCTP_STATE_SHUTDOWN_ACK_SENT
	177	#define SCTP_STATE_NUM_STATES (SCTP_STATE_MAX + 1)
	178
	179	/* These are values for sk->state.
	180	* For a UDP-style SCTP socket, the states are defined as follows
	181	* - A socket in SCTP_SS_CLOSED state indicates that it is not willing to
	182	* accept new associations, but it can initiate the creation of new ones.
	183	* - A socket in SCTP_SS_LISTENING state indicates that it is willing to
	184	* accept new associations and can initiate the creation of new ones.
	185	* - A socket in SCTP_SS_ESTABLISHED state indicates that it is a peeled off
	186	* socket with one association.
	187	* For a TCP-style SCTP socket, the states are defined as follows
	188	* - A socket in SCTP_SS_CLOSED state indicates that it is not willing to
	189	* accept new associations, but it can initiate the creation of new ones.
	190	* - A socket in SCTP_SS_LISTENING state indicates that it is willing to
	191	* accept new associations, but cannot initiate the creation of new ones.
	192	* - A socket in SCTP_SS_ESTABLISHED state indicates that it has a single
	193	* association.
	194	*/
84965614	195	enum sctp_sock_state {
1da177e4 LT	196	SCTP_SS_CLOSED = TCP_CLOSE,
	197	SCTP_SS_LISTENING = TCP_LISTEN,
	198	SCTP_SS_ESTABLISHING = TCP_SYN_SENT,
	199	SCTP_SS_ESTABLISHED = TCP_ESTABLISHED,
df7e88f6	200	SCTP_SS_CLOSING = TCP_CLOSE_WAIT,
84965614	201	};
1da177e4 LT	202
1da177e4 LT	203	/* These functions map various type to printable names. */
bfc6f827 XL	204	const char sctp_cname(const union sctp_subtype id); / chunk types */
	205	const char sctp_oname(const union sctp_subtype id); / other events */
	206	const char sctp_tname(const union sctp_subtype id); / timeouts */
	207	const char sctp_pname(const union sctp_subtype id); / primitives */
1da177e4 LT	208
1da177e4 LT	209	/* This is a table of printable names of sctp_state_t's. */
36cbd3dc JE	210	extern const char *const sctp_state_tbl[];
	211	extern const char *const sctp_evttype_tbl[];
	212	extern const char *const sctp_status_tbl[];
1da177e4 LT	213
	214	/* Maximum chunk length considering padding requirements. */
	215	enum { SCTP_MAX_CHUNK_LEN = ((1<<16) - sizeof(__u32)) };
	216
	217	/* Encourage Cookie-Echo bundling by pre-fragmenting chunks a little
	218	* harder (until reaching ESTABLISHED state).
	219	*/
	220	enum { SCTP_ARBITRARY_COOKIE_ECHO_LEN = 200 };
	221
	222	/* Guess at how big to make the TSN mapping array.
	223	* We guarantee that we can handle at least this big a gap between the
	224	* cumulative ACK and the highest TSN. In practice, we can often
	225	* handle up to twice this value.
	226	*
	227	* NEVER make this more than 32767 (2^15-1). The Gap Ack Blocks in a
	228	* SACK (see section 3.3.4) are only 16 bits, so 2*SCTP_TSN_MAP_SIZE
	229	* must be less than 65535 (2^16 - 1), or we will have overflow
	230	* problems creating SACK's.
	231	*/
8e1ee18c VY	232	#define SCTP_TSN_MAP_INITIAL BITS_PER_LONG
	233	#define SCTP_TSN_MAP_INCREMENT SCTP_TSN_MAP_INITIAL
	234	#define SCTP_TSN_MAP_SIZE 4096
1da177e4 LT	235
1da177e4 LT	236	/* We will not record more than this many duplicate TSNs between two
c45698f8 MRL	237	* SACKs. The minimum PMTU is 512. Remove all the headers and there
c45698f8 MRL	238	* is enough room for 117 duplicate reports. Round down to the
1da177e4 LT	239	* nearest power of 2.
1da177e4 LT	240	*/
1da177e4 LT	241	enum { SCTP_MAX_DUP_TSNS = 16 };
	242	enum { SCTP_MAX_GABS = 16 };
	243
2f85a429	244	/* Heartbeat interval - 30 secs */
3fd091e7	245	#define SCTP_DEFAULT_TIMEOUT_HEARTBEAT (30*1000)
1da177e4	246
2f85a429	247	/* Delayed sack timer - 200ms */
3fd091e7	248	#define SCTP_DEFAULT_TIMEOUT_SACK (200)
1da177e4 LT	249
	250	/* RTO.Initial - 3 seconds
	251	* RTO.Min - 1 second
	252	* RTO.Max - 60 seconds
	253	* RTO.Alpha - 1/8
	254	* RTO.Beta - 1/4
	255	*/
3fd091e7 VY	256	#define SCTP_RTO_INITIAL (3 * 1000)
	257	#define SCTP_RTO_MIN (1 * 1000)
	258	#define SCTP_RTO_MAX (60 * 1000)
1da177e4 LT	259
	260	#define SCTP_RTO_ALPHA 3 /* 1/8 when converted to right shifts. */
	261	#define SCTP_RTO_BETA 2 /* 1/4 when converted to right shifts. */
	262
	263	/* Maximum number of new data packets that can be sent in a burst. */
70331571	264	#define SCTP_DEFAULT_MAX_BURST 4
1da177e4 LT	265
	266	#define SCTP_CLOCK_GRANULARITY 1 /* 1 jiffy */
	267
3fd091e7	268	#define SCTP_DEFAULT_COOKIE_LIFE (60 * 1000) /* 60 seconds */
1da177e4 LT	269
	270	#define SCTP_DEFAULT_MINWINDOW 1500 /* default minimum rwnd size */
	271	#define SCTP_DEFAULT_MAXWINDOW 65535 /* default rwnd size */
90f2f531 VY	272	#define SCTP_DEFAULT_RWND_SHIFT 4 /* by default, update on 1/16 of
	273	* rcvbuf, which is 1/8 of initial
	274	* window
	275	*/
1da177e4 LT	276	#define SCTP_DEFAULT_MAXSEGMENT 1500 /* MTU size, this is the limit
	277	* to which we will raise the P-MTU.
	278	*/
	279	#define SCTP_DEFAULT_MINSEGMENT 512 /* MTU size ... if no mtu disc */
570617e7	280
1da177e4 LT	281	#define SCTP_SECRET_SIZE 32 /* Number of octets in a 256 bits. */
	282
	283	#define SCTP_SIGNATURE_SIZE 20 /* size of a SLA-1 signature */
	284
	285	#define SCTP_COOKIE_MULTIPLE 32 /* Pad out our cookie to make our hash
	286	* functions simpler to write.
	287	*/
	288
1da177e4 LT	289	/* These return values describe the success or failure of a number of
	290	* routines which form the lower interface to SCTP_outqueue.
	291	*/
86b36f2a	292	enum sctp_xmit {
1da177e4 LT	293	SCTP_XMIT_OK,
	294	SCTP_XMIT_PMTU_FULL,
	295	SCTP_XMIT_RWND_FULL,
526cbef7	296	SCTP_XMIT_DELAY,
86b36f2a	297	};
1da177e4 LT	298
1da177e4 LT	299	/* These are the commands for manipulating transports. */
0ceaeebe	300	enum sctp_transport_cmd {
1da177e4 LT	301	SCTP_TRANSPORT_UP,
1da177e4 LT	302	SCTP_TRANSPORT_DOWN,
5aa93bcf	303	SCTP_TRANSPORT_PF,
0ceaeebe	304	};
1da177e4 LT	305
	306	/* These are the address scopes defined mainly for IPv4 addresses
	307	* based on draft of SCTP IPv4 scoping <draft-stewart-tsvwg-sctp-ipv4-00.txt>.
	308	* These scopes are hopefully generic enough to be used on scoping both
	309	* IPv4 and IPv6 addresses in SCTP.
	310	* At this point, the IPv6 scopes will be mapped to these internal scopes
	311	* as much as possible.
	312	*/
1c662018	313	enum sctp_scope {
1da177e4 LT	314	SCTP_SCOPE_GLOBAL, /* IPv4 global addresses */
	315	SCTP_SCOPE_PRIVATE, /* IPv4 private addresses */
	316	SCTP_SCOPE_LINK, /* IPv4 link local address */
	317	SCTP_SCOPE_LOOPBACK, /* IPv4 loopback address */
	318	SCTP_SCOPE_UNUSABLE, /* IPv4 unusable addresses */
1c662018	319	};
1da177e4	320
701ef3e6	321	enum {
72388433 BD	322	SCTP_SCOPE_POLICY_DISABLE, /* Disable IPv4 address scoping */
	323	SCTP_SCOPE_POLICY_ENABLE, /* Enable IPv4 address scoping */
	324	SCTP_SCOPE_POLICY_PRIVATE, /* Follow draft but allow IPv4 private addresses */
	325	SCTP_SCOPE_POLICY_LINK, /* Follow draft but allow IPv4 link local addresses */
701ef3e6 XL	326	};
	327
	328	#define SCTP_SCOPE_POLICY_MAX SCTP_SCOPE_POLICY_LINK
72388433	329
1da177e4 LT	330	/* Based on IPv4 scoping <draft-stewart-tsvwg-sctp-ipv4-00.txt>,
	331	* SCTP IPv4 unusable addresses: 0.0.0.0/8, 224.0.0.0/4, 198.18.0.0/24,
	332	* 192.88.99.0/24.
	333	* Also, RFC 8.4, non-unicast addresses are not considered valid SCTP
	334	* addresses.
	335	*/
b5cb2bbc JP	336	#define IS_IPV4_UNUSABLE_ADDRESS(a) \
	337	((htonl(INADDR_BROADCAST) == a) \|\| \
	338	ipv4_is_multicast(a) \|\| \
	339	ipv4_is_zeronet(a) \|\| \
	340	ipv4_is_test_198(a) \|\| \
	341	ipv4_is_anycast_6to4(a))
1da177e4 LT	342
	343	/* Flags used for the bind address copy functions. */
	344	#define SCTP_ADDR6_ALLOWED 0x00000001 /* IPv6 address is allowed by
	345	local sock family */
	346	#define SCTP_ADDR4_PEERSUPP 0x00000002 /* IPv4 address is supported by
	347	peer */
	348	#define SCTP_ADDR6_PEERSUPP 0x00000004 /* IPv6 address is supported by
	349	peer */
	350
	351	/* Reasons to retransmit. */
125c2982	352	enum sctp_retransmit_reason {
1da177e4 LT	353	SCTP_RTXR_T3_RTX,
	354	SCTP_RTXR_FAST_RTX,
	355	SCTP_RTXR_PMTUD,
b6157d8e	356	SCTP_RTXR_T1_RTX,
125c2982	357	};
1da177e4 LT	358
1da177e4 LT	359	/* Reasons to lower cwnd. */
233e7936	360	enum sctp_lower_cwnd {
1da177e4 LT	361	SCTP_LOWER_CWND_T3_RTX,
	362	SCTP_LOWER_CWND_FAST_RTX,
	363	SCTP_LOWER_CWND_ECNE,
	364	SCTP_LOWER_CWND_INACTIVE,
233e7936	365	};
1da177e4	366
1f485649 VY	367
	368	/* SCTP-AUTH Necessary constants */
	369
	370	/* SCTP-AUTH, Section 3.3
	371	*
	372	* The following Table 2 shows the currently defined values for HMAC
	373	* identifiers.
	374	*
	375	* +-----------------+--------------------------+
	376	* \| HMAC Identifier \| Message Digest Algorithm \|
	377	* +-----------------+--------------------------+
	378	* \| 0 \| Reserved \|
	379	* \| 1 \| SHA-1 defined in [8] \|
	380	* \| 2 \| Reserved \|
	381	* \| 3 \| SHA-256 defined in [8] \|
	382	* +-----------------+--------------------------+
	383	*/
	384	enum {
	385	SCTP_AUTH_HMAC_ID_RESERVED_0,
	386	SCTP_AUTH_HMAC_ID_SHA1,
	387	SCTP_AUTH_HMAC_ID_RESERVED_2,
b7e0fe9f VY	388	#if defined (CONFIG_CRYPTO_SHA256) \|\| defined (CONFIG_CRYPTO_SHA256_MODULE)
	389	SCTP_AUTH_HMAC_ID_SHA256,
	390	#endif
	391	__SCTP_AUTH_HMAC_MAX
1f485649 VY	392	};
1f485649 VY	393
b7e0fe9f VY	394	#define SCTP_AUTH_HMAC_ID_MAX __SCTP_AUTH_HMAC_MAX - 1
b7e0fe9f VY	395	#define SCTP_AUTH_NUM_HMACS __SCTP_AUTH_HMAC_MAX
1f485649 VY	396	#define SCTP_SHA1_SIG_SIZE 20
	397	#define SCTP_SHA256_SIG_SIZE 32
	398
	399	/* SCTP-AUTH, Section 3.2
	400	* The chunk types for INIT, INIT-ACK, SHUTDOWN-COMPLETE and AUTH chunks
	401	* MUST NOT be listed in the CHUNKS parameter
	402	*/
	403	#define SCTP_NUM_NOAUTH_CHUNKS 4
	404	#define SCTP_AUTH_MAX_CHUNKS (SCTP_NUM_CHUNK_TYPES - SCTP_NUM_NOAUTH_CHUNKS)
	405
	406	/* SCTP-AUTH Section 6.1
	407	* The RANDOM parameter MUST contain a 32 byte random number.
	408	*/
	409	#define SCTP_AUTH_RANDOM_LENGTH 32
	410
1da177e4	411	#endif /* __sctp_constants_h__ */