[linux-block.git] / include / net / sctp / sm.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
 *
 * These are definitions needed by the state machine.
 *
 * Please send any bug reports or fixes you make to the
 * email addresses:
 *    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>
 *    Xingang Guo <xingang.guo@intel.com>
 *    Jon Grimm <jgrimm@us.ibm.com>
 *    Dajiang Zhang <dajiang.zhang@nokia.com>
 *    Sridhar Samudrala <sri@us.ibm.com>
 *    Daisy Chang <daisyc@us.ibm.com>
 *    Ardelle Fan <ardelle.fan@intel.com>
 *    Kevin Gao <kevin.gao@intel.com>
 */

#include <linux/types.h>
#include <linux/compiler.h>
#include <linux/slab.h>
#include <linux/in.h>
#include <net/sctp/command.h>
#include <net/sctp/sctp.h>

#ifndef __sctp_sm_h__
#define __sctp_sm_h__

/*
 * Possible values for the disposition are:
 */
enum sctp_disposition {
	SCTP_DISPOSITION_DISCARD,	 /* No further processing.  */
	SCTP_DISPOSITION_CONSUME,	 /* Process return values normally.  */
	SCTP_DISPOSITION_NOMEM,		 /* We ran out of memory--recover.  */
	SCTP_DISPOSITION_DELETE_TCB,	 /* Close the association.  */
	SCTP_DISPOSITION_ABORT,		 /* Close the association NOW.  */
	SCTP_DISPOSITION_VIOLATION,	 /* The peer is misbehaving.  */
	SCTP_DISPOSITION_NOT_IMPL,	 /* This entry is not implemented.  */
	SCTP_DISPOSITION_ERROR,		 /* This is plain old user error.  */
	SCTP_DISPOSITION_BUG,		 /* This is a bug.  */
};

typedef enum sctp_disposition (sctp_state_fn_t) (
					struct net *net,
					const struct sctp_endpoint *ep,
					const struct sctp_association *asoc,
					const union sctp_subtype type,
					void *arg,
					struct sctp_cmd_seq *commands);
typedef void (sctp_timer_event_t) (struct timer_list *);
struct sctp_sm_table_entry {
	sctp_state_fn_t *fn;
	const char *name;
};

/* A naming convention of "sctp_sf_xxx" applies to all the state functions
 * currently in use.
 */

/* Prototypes for generic state functions. */
sctp_state_fn_t sctp_sf_not_impl;
sctp_state_fn_t sctp_sf_bug;

/* Prototypes for gener timer state functions. */
sctp_state_fn_t sctp_sf_timer_ignore;

/* Prototypes for chunk state functions. */
sctp_state_fn_t sctp_sf_do_9_1_abort;
sctp_state_fn_t sctp_sf_cookie_wait_abort;
sctp_state_fn_t sctp_sf_cookie_echoed_abort;
sctp_state_fn_t sctp_sf_shutdown_pending_abort;
sctp_state_fn_t sctp_sf_shutdown_sent_abort;
sctp_state_fn_t sctp_sf_shutdown_ack_sent_abort;
sctp_state_fn_t sctp_sf_do_5_1B_init;
sctp_state_fn_t sctp_sf_do_5_1C_ack;
sctp_state_fn_t sctp_sf_do_5_1D_ce;
sctp_state_fn_t sctp_sf_do_5_1E_ca;
sctp_state_fn_t sctp_sf_do_4_C;
sctp_state_fn_t sctp_sf_eat_data_6_2;
sctp_state_fn_t sctp_sf_eat_data_fast_4_4;
sctp_state_fn_t sctp_sf_eat_sack_6_2;
sctp_state_fn_t sctp_sf_operr_notify;
sctp_state_fn_t sctp_sf_t1_init_timer_expire;
sctp_state_fn_t sctp_sf_t1_cookie_timer_expire;
sctp_state_fn_t sctp_sf_t2_timer_expire;
sctp_state_fn_t sctp_sf_t4_timer_expire;
sctp_state_fn_t sctp_sf_t5_timer_expire;
sctp_state_fn_t sctp_sf_sendbeat_8_3;
sctp_state_fn_t sctp_sf_beat_8_3;
sctp_state_fn_t sctp_sf_backbeat_8_3;
sctp_state_fn_t sctp_sf_do_9_2_final;
sctp_state_fn_t sctp_sf_do_9_2_shutdown;
sctp_state_fn_t sctp_sf_do_9_2_shut_ctsn;
sctp_state_fn_t sctp_sf_do_ecn_cwr;
sctp_state_fn_t sctp_sf_do_ecne;
sctp_state_fn_t sctp_sf_ootb;
sctp_state_fn_t sctp_sf_pdiscard;
sctp_state_fn_t sctp_sf_violation;
sctp_state_fn_t sctp_sf_discard_chunk;
sctp_state_fn_t sctp_sf_do_5_2_1_siminit;
sctp_state_fn_t sctp_sf_do_5_2_2_dupinit;
sctp_state_fn_t sctp_sf_do_5_2_3_initack;
sctp_state_fn_t sctp_sf_do_5_2_4_dupcook;
sctp_state_fn_t sctp_sf_unk_chunk;
sctp_state_fn_t sctp_sf_do_8_5_1_E_sa;
sctp_state_fn_t sctp_sf_cookie_echoed_err;
sctp_state_fn_t sctp_sf_do_asconf;
sctp_state_fn_t sctp_sf_do_asconf_ack;
sctp_state_fn_t sctp_sf_do_reconf;
sctp_state_fn_t sctp_sf_do_9_2_reshutack;
sctp_state_fn_t sctp_sf_eat_fwd_tsn;
sctp_state_fn_t sctp_sf_eat_fwd_tsn_fast;
sctp_state_fn_t sctp_sf_eat_auth;

/* Prototypes for primitive event state functions.  */
sctp_state_fn_t sctp_sf_do_prm_asoc;
sctp_state_fn_t sctp_sf_do_prm_send;
sctp_state_fn_t sctp_sf_do_9_2_prm_shutdown;
sctp_state_fn_t sctp_sf_cookie_wait_prm_shutdown;
sctp_state_fn_t sctp_sf_cookie_echoed_prm_shutdown;
sctp_state_fn_t sctp_sf_do_9_1_prm_abort;
sctp_state_fn_t sctp_sf_cookie_wait_prm_abort;
sctp_state_fn_t sctp_sf_cookie_echoed_prm_abort;
sctp_state_fn_t sctp_sf_shutdown_pending_prm_abort;
sctp_state_fn_t sctp_sf_shutdown_sent_prm_abort;
sctp_state_fn_t sctp_sf_shutdown_ack_sent_prm_abort;
sctp_state_fn_t sctp_sf_error_closed;
sctp_state_fn_t sctp_sf_error_shutdown;
sctp_state_fn_t sctp_sf_ignore_primitive;
sctp_state_fn_t sctp_sf_do_prm_requestheartbeat;
sctp_state_fn_t sctp_sf_do_prm_asconf;
sctp_state_fn_t sctp_sf_do_prm_reconf;

/* Prototypes for other event state functions.  */
sctp_state_fn_t sctp_sf_do_no_pending_tsn;
sctp_state_fn_t sctp_sf_do_9_2_start_shutdown;
sctp_state_fn_t sctp_sf_do_9_2_shutdown_ack;
sctp_state_fn_t sctp_sf_ignore_other;
sctp_state_fn_t sctp_sf_cookie_wait_icmp_abort;

/* Prototypes for timeout event state functions.  */
sctp_state_fn_t sctp_sf_do_6_3_3_rtx;
sctp_state_fn_t sctp_sf_send_reconf;
sctp_state_fn_t sctp_sf_send_probe;
sctp_state_fn_t sctp_sf_do_6_2_sack;
sctp_state_fn_t sctp_sf_autoclose_timer_expire;

/* Prototypes for utility support functions.  */
__u8 sctp_get_chunk_type(struct sctp_chunk *chunk);
const struct sctp_sm_table_entry *sctp_sm_lookup_event(
					struct net *net,
					enum sctp_event_type event_type,
					enum sctp_state state,
					union sctp_subtype event_subtype);
int sctp_chunk_iif(const struct sctp_chunk *);
struct sctp_association *sctp_make_temp_asoc(const struct sctp_endpoint *,
					     struct sctp_chunk *,
					     gfp_t gfp);
__u32 sctp_generate_verification_tag(void);
void sctp_populate_tie_tags(__u8 *cookie, __u32 curTag, __u32 hisTag);

/* Prototypes for chunk-building functions.  */
struct sctp_chunk *sctp_make_init(const struct sctp_association *asoc,
				  const struct sctp_bind_addr *bp,
				  gfp_t gfp, int vparam_len);
struct sctp_chunk *sctp_make_init_ack(const struct sctp_association *asoc,
				      const struct sctp_chunk *chunk,
				      const gfp_t gfp, const int unkparam_len);
struct sctp_chunk *sctp_make_cookie_echo(const struct sctp_association *asoc,
					 const struct sctp_chunk *chunk);
struct sctp_chunk *sctp_make_cookie_ack(const struct sctp_association *asoc,
					const struct sctp_chunk *chunk);
struct sctp_chunk *sctp_make_cwr(const struct sctp_association *asoc,
				 const __u32 lowest_tsn,
				 const struct sctp_chunk *chunk);
struct sctp_chunk *sctp_make_idata(const struct sctp_association *asoc,
				   __u8 flags, int paylen, gfp_t gfp);
struct sctp_chunk *sctp_make_ifwdtsn(const struct sctp_association *asoc,
				     __u32 new_cum_tsn, size_t nstreams,
				     struct sctp_ifwdtsn_skip *skiplist);
struct sctp_chunk *sctp_make_datafrag_empty(const struct sctp_association *asoc,
					    const struct sctp_sndrcvinfo *sinfo,
					    int len, __u8 flags, gfp_t gfp);
struct sctp_chunk *sctp_make_ecne(const struct sctp_association *asoc,
				  const __u32 lowest_tsn);
struct sctp_chunk *sctp_make_sack(struct sctp_association *asoc);
struct sctp_chunk *sctp_make_shutdown(const struct sctp_association *asoc,
				      const struct sctp_chunk *chunk);
struct sctp_chunk *sctp_make_shutdown_ack(const struct sctp_association *asoc,
					  const struct sctp_chunk *chunk);
struct sctp_chunk *sctp_make_shutdown_complete(
					const struct sctp_association *asoc,
					const struct sctp_chunk *chunk);
int sctp_init_cause(struct sctp_chunk *chunk, __be16 cause, size_t paylen);
struct sctp_chunk *sctp_make_abort(const struct sctp_association *asoc,
				   const struct sctp_chunk *chunk,
				   const size_t hint);
struct sctp_chunk *sctp_make_abort_no_data(const struct sctp_association *asoc,
					   const struct sctp_chunk *chunk,
					   __u32 tsn);
struct sctp_chunk *sctp_make_abort_user(const struct sctp_association *asoc,
					struct msghdr *msg, size_t msg_len);
struct sctp_chunk *sctp_make_abort_violation(
					const struct sctp_association *asoc,
					const struct sctp_chunk *chunk,
					const __u8 *payload,
					const size_t paylen);
struct sctp_chunk *sctp_make_violation_paramlen(
					const struct sctp_association *asoc,
					const struct sctp_chunk *chunk,
					struct sctp_paramhdr *param);
struct sctp_chunk *sctp_make_violation_max_retrans(
					const struct sctp_association *asoc,
					const struct sctp_chunk *chunk);
struct sctp_chunk *sctp_make_new_encap_port(
					const struct sctp_association *asoc,
					const struct sctp_chunk *chunk);
struct sctp_chunk *sctp_make_heartbeat(const struct sctp_association *asoc,
				       const struct sctp_transport *transport,
				       __u32 probe_size);
struct sctp_chunk *sctp_make_heartbeat_ack(const struct sctp_association *asoc,
					   const struct sctp_chunk *chunk,
					   const void *payload,
					   const size_t paylen);
struct sctp_chunk *sctp_make_pad(const struct sctp_association *asoc, int len);
struct sctp_chunk *sctp_make_op_error(const struct sctp_association *asoc,
				      const struct sctp_chunk *chunk,
				      __be16 cause_code, const void *payload,
				      size_t paylen, size_t reserve_tail);

struct sctp_chunk *sctp_make_asconf_update_ip(struct sctp_association *asoc,
					      union sctp_addr *laddr,
					      struct sockaddr *addrs,
					      int addrcnt, __be16 flags);
struct sctp_chunk *sctp_make_asconf_set_prim(struct sctp_association *asoc,
					     union sctp_addr *addr);
bool sctp_verify_asconf(const struct sctp_association *asoc,
			struct sctp_chunk *chunk, bool addr_param_needed,
			struct sctp_paramhdr **errp);
struct sctp_chunk *sctp_process_asconf(struct sctp_association *asoc,
				       struct sctp_chunk *asconf);
int sctp_process_asconf_ack(struct sctp_association *asoc,
			    struct sctp_chunk *asconf_ack);
struct sctp_chunk *sctp_make_fwdtsn(const struct sctp_association *asoc,
				    __u32 new_cum_tsn, size_t nstreams,
				    struct sctp_fwdtsn_skip *skiplist);
struct sctp_chunk *sctp_make_auth(const struct sctp_association *asoc,
				  __u16 key_id);
struct sctp_chunk *sctp_make_strreset_req(const struct sctp_association *asoc,
					  __u16 stream_num, __be16 *stream_list,
					  bool out, bool in);
struct sctp_chunk *sctp_make_strreset_tsnreq(
					const struct sctp_association *asoc);
struct sctp_chunk *sctp_make_strreset_addstrm(
					const struct sctp_association *asoc,
					__u16 out, __u16 in);
struct sctp_chunk *sctp_make_strreset_resp(const struct sctp_association *asoc,
					   __u32 result, __u32 sn);
struct sctp_chunk *sctp_make_strreset_tsnresp(struct sctp_association *asoc,
					      __u32 result, __u32 sn,
					      __u32 sender_tsn,
					      __u32 receiver_tsn);
bool sctp_verify_reconf(const struct sctp_association *asoc,
			struct sctp_chunk *chunk,
			struct sctp_paramhdr **errp);
void sctp_chunk_assign_tsn(struct sctp_chunk *chunk);
void sctp_chunk_assign_ssn(struct sctp_chunk *chunk);

/* Prototypes for stream-processing functions.  */
struct sctp_chunk *sctp_process_strreset_outreq(
				struct sctp_association *asoc,
				union sctp_params param,
				struct sctp_ulpevent **evp);
struct sctp_chunk *sctp_process_strreset_inreq(
				struct sctp_association *asoc,
				union sctp_params param,
				struct sctp_ulpevent **evp);
struct sctp_chunk *sctp_process_strreset_tsnreq(
				struct sctp_association *asoc,
				union sctp_params param,
				struct sctp_ulpevent **evp);
struct sctp_chunk *sctp_process_strreset_addstrm_out(
				struct sctp_association *asoc,
				union sctp_params param,
				struct sctp_ulpevent **evp);
struct sctp_chunk *sctp_process_strreset_addstrm_in(
				struct sctp_association *asoc,
				union sctp_params param,
				struct sctp_ulpevent **evp);
struct sctp_chunk *sctp_process_strreset_resp(
				struct sctp_association *asoc,
				union sctp_params param,
				struct sctp_ulpevent **evp);

/* Prototypes for statetable processing. */

int sctp_do_sm(struct net *net, enum sctp_event_type event_type,
	       union sctp_subtype subtype, enum sctp_state state,
	       struct sctp_endpoint *ep, struct sctp_association *asoc,
	       void *event_arg, gfp_t gfp);

/* 2nd level prototypes */
void sctp_generate_t3_rtx_event(struct timer_list *t);
void sctp_generate_heartbeat_event(struct timer_list *t);
void sctp_generate_reconf_event(struct timer_list *t);
void sctp_generate_probe_event(struct timer_list *t);
void sctp_generate_proto_unreach_event(struct timer_list *t);

void sctp_ootb_pkt_free(struct sctp_packet *packet);

struct sctp_association *sctp_unpack_cookie(
					const struct sctp_endpoint *ep,
					const struct sctp_association *asoc,
					struct sctp_chunk *chunk,
					gfp_t gfp, int *err,
					struct sctp_chunk **err_chk_p);

/* 3rd level prototypes */
__u32 sctp_generate_tag(const struct sctp_endpoint *ep);
__u32 sctp_generate_tsn(const struct sctp_endpoint *ep);

/* Extern declarations for major data structures.  */
extern sctp_timer_event_t *sctp_timer_events[SCTP_NUM_TIMEOUT_TYPES];


/* Get the size of a DATA chunk payload. */
static inline __u16 sctp_data_size(struct sctp_chunk *chunk)
{
	__u16 size;

	size = ntohs(chunk->chunk_hdr->length);
	size -= sctp_datachk_len(&chunk->asoc->stream);

	return size;
}

/* Compare two TSNs */
#define TSN_lt(a,b)	\
	(typecheck(__u32, a) && \
	 typecheck(__u32, b) && \
	 ((__s32)((a) - (b)) < 0))

#define TSN_lte(a,b)	\
	(typecheck(__u32, a) && \
	 typecheck(__u32, b) && \
	 ((__s32)((a) - (b)) <= 0))

/* Compare two MIDs */
#define MID_lt(a, b)	\
	(typecheck(__u32, a) && \
	 typecheck(__u32, b) && \
	 ((__s32)((a) - (b)) < 0))

/* Compare two SSNs */
#define SSN_lt(a,b)		\
	(typecheck(__u16, a) && \
	 typecheck(__u16, b) && \
	 ((__s16)((a) - (b)) < 0))

/* ADDIP 3.1.1 */
#define ADDIP_SERIAL_gte(a,b)	\
	(typecheck(__u32, a) && \
	 typecheck(__u32, b) && \
	 ((__s32)((b) - (a)) <= 0))

/* Check VTAG of the packet matches the sender's own tag. */
static inline int
sctp_vtag_verify(const struct sctp_chunk *chunk,
		 const struct sctp_association *asoc)
{
	/* RFC 2960 Sec 8.5 When receiving an SCTP packet, the endpoint
	 * MUST ensure that the value in the Verification Tag field of
	 * the received SCTP packet matches its own Tag. If the received
	 * Verification Tag value does not match the receiver's own
	 * tag value, the receiver shall silently discard the packet...
	 */
	if (ntohl(chunk->sctp_hdr->vtag) != asoc->c.my_vtag)
		return 0;

	chunk->transport->encap_port = SCTP_INPUT_CB(chunk->skb)->encap_port;
	return 1;
}

/* Check VTAG of the packet matches the sender's own tag and the T bit is
 * not set, OR its peer's tag and the T bit is set in the Chunk Flags.
 */
static inline int
sctp_vtag_verify_either(const struct sctp_chunk *chunk,
			const struct sctp_association *asoc)
{
        /* RFC 2960 Section 8.5.1, sctpimpguide Section 2.41
	 *
	 * B) The receiver of a ABORT MUST accept the packet
	 *    if the Verification Tag field of the packet matches its own tag
	 *    and the T bit is not set
	 *    OR
	 *    it is set to its peer's tag and the T bit is set in the Chunk
	 *    Flags.
	 *    Otherwise, the receiver MUST silently discard the packet
	 *    and take no further action.
	 *
	 * C) The receiver of a SHUTDOWN COMPLETE shall accept the packet
	 *    if the Verification Tag field of the packet matches its own tag
	 *    and the T bit is not set
	 *    OR
	 *    it is set to its peer's tag and the T bit is set in the Chunk
	 *    Flags.
	 *    Otherwise, the receiver MUST silently discard the packet
	 *    and take no further action.  An endpoint MUST ignore the
	 *    SHUTDOWN COMPLETE if it is not in the SHUTDOWN-ACK-SENT state.
	 */
        if ((!sctp_test_T_bit(chunk) &&
             (ntohl(chunk->sctp_hdr->vtag) == asoc->c.my_vtag)) ||
	    (sctp_test_T_bit(chunk) && asoc->c.peer_vtag &&
	     (ntohl(chunk->sctp_hdr->vtag) == asoc->c.peer_vtag))) {
                return 1;
	}

	return 0;
}

#endif /* __sctp_sm_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 LT	9	*
	10	* These are definitions needed by the state machine.
	11	*
1da177e4 LT	12	* Please send any bug reports or fixes you make to the
1da177e4 LT	13	* email addresses:
91705c61	14	* lksctp developers <linux-sctp@vger.kernel.org>
1da177e4	15	*
1da177e4 LT	16	* Written or modified by:
	17	* La Monte H.P. Yarroll <piggy@acm.org>
	18	* Karl Knutson <karl@athena.chicago.il.us>
	19	* Xingang Guo <xingang.guo@intel.com>
	20	* Jon Grimm <jgrimm@us.ibm.com>
	21	* Dajiang Zhang <dajiang.zhang@nokia.com>
	22	* Sridhar Samudrala <sri@us.ibm.com>
	23	* Daisy Chang <daisyc@us.ibm.com>
	24	* Ardelle Fan <ardelle.fan@intel.com>
	25	* Kevin Gao <kevin.gao@intel.com>
1da177e4 LT	26	*/
	27
	28	#include <linux/types.h>
	29	#include <linux/compiler.h>
	30	#include <linux/slab.h>
	31	#include <linux/in.h>
	32	#include <net/sctp/command.h>
	33	#include <net/sctp/sctp.h>
	34
	35	#ifndef __sctp_sm_h__
	36	#define __sctp_sm_h__
	37
	38	/*
	39	* Possible values for the disposition are:
	40	*/
172a1599	41	enum sctp_disposition {
1da177e4 LT	42	SCTP_DISPOSITION_DISCARD, /* No further processing. */
	43	SCTP_DISPOSITION_CONSUME, /* Process return values normally. */
	44	SCTP_DISPOSITION_NOMEM, /* We ran out of memory--recover. */
	45	SCTP_DISPOSITION_DELETE_TCB, /* Close the association. */
	46	SCTP_DISPOSITION_ABORT, /* Close the association NOW. */
	47	SCTP_DISPOSITION_VIOLATION, /* The peer is misbehaving. */
	48	SCTP_DISPOSITION_NOT_IMPL, /* This entry is not implemented. */
	49	SCTP_DISPOSITION_ERROR, /* This is plain old user error. */
	50	SCTP_DISPOSITION_BUG, /* This is a bug. */
172a1599	51	};
1da177e4	52
172a1599 XL	53	typedef enum sctp_disposition (sctp_state_fn_t) (
	54	struct net *net,
	55	const struct sctp_endpoint *ep,
	56	const struct sctp_association *asoc,
	57	const union sctp_subtype type,
	58	void *arg,
	59	struct sctp_cmd_seq *commands);
9c3b5751	60	typedef void (sctp_timer_event_t) (struct timer_list *);
8ee821ae	61	struct sctp_sm_table_entry {
1da177e4 LT	62	sctp_state_fn_t *fn;
1da177e4 LT	63	const char *name;
8ee821ae	64	};
1da177e4 LT	65
	66	/* A naming convention of "sctp_sf_xxx" applies to all the state functions
	67	* currently in use.
	68	*/
	69
	70	/* Prototypes for generic state functions. */
	71	sctp_state_fn_t sctp_sf_not_impl;
	72	sctp_state_fn_t sctp_sf_bug;
	73
	74	/* Prototypes for gener timer state functions. */
	75	sctp_state_fn_t sctp_sf_timer_ignore;
	76
	77	/* Prototypes for chunk state functions. */
	78	sctp_state_fn_t sctp_sf_do_9_1_abort;
	79	sctp_state_fn_t sctp_sf_cookie_wait_abort;
	80	sctp_state_fn_t sctp_sf_cookie_echoed_abort;
	81	sctp_state_fn_t sctp_sf_shutdown_pending_abort;
	82	sctp_state_fn_t sctp_sf_shutdown_sent_abort;
	83	sctp_state_fn_t sctp_sf_shutdown_ack_sent_abort;
	84	sctp_state_fn_t sctp_sf_do_5_1B_init;
	85	sctp_state_fn_t sctp_sf_do_5_1C_ack;
	86	sctp_state_fn_t sctp_sf_do_5_1D_ce;
	87	sctp_state_fn_t sctp_sf_do_5_1E_ca;
	88	sctp_state_fn_t sctp_sf_do_4_C;
	89	sctp_state_fn_t sctp_sf_eat_data_6_2;
	90	sctp_state_fn_t sctp_sf_eat_data_fast_4_4;
	91	sctp_state_fn_t sctp_sf_eat_sack_6_2;
1da177e4	92	sctp_state_fn_t sctp_sf_operr_notify;
3f7a87d2 FF	93	sctp_state_fn_t sctp_sf_t1_init_timer_expire;
3f7a87d2 FF	94	sctp_state_fn_t sctp_sf_t1_cookie_timer_expire;
1da177e4 LT	95	sctp_state_fn_t sctp_sf_t2_timer_expire;
	96	sctp_state_fn_t sctp_sf_t4_timer_expire;
	97	sctp_state_fn_t sctp_sf_t5_timer_expire;
	98	sctp_state_fn_t sctp_sf_sendbeat_8_3;
	99	sctp_state_fn_t sctp_sf_beat_8_3;
	100	sctp_state_fn_t sctp_sf_backbeat_8_3;
	101	sctp_state_fn_t sctp_sf_do_9_2_final;
	102	sctp_state_fn_t sctp_sf_do_9_2_shutdown;
2e3f92da	103	sctp_state_fn_t sctp_sf_do_9_2_shut_ctsn;
1da177e4 LT	104	sctp_state_fn_t sctp_sf_do_ecn_cwr;
	105	sctp_state_fn_t sctp_sf_do_ecne;
	106	sctp_state_fn_t sctp_sf_ootb;
	107	sctp_state_fn_t sctp_sf_pdiscard;
	108	sctp_state_fn_t sctp_sf_violation;
1da177e4 LT	109	sctp_state_fn_t sctp_sf_discard_chunk;
	110	sctp_state_fn_t sctp_sf_do_5_2_1_siminit;
	111	sctp_state_fn_t sctp_sf_do_5_2_2_dupinit;
610ab73a	112	sctp_state_fn_t sctp_sf_do_5_2_3_initack;
1da177e4 LT	113	sctp_state_fn_t sctp_sf_do_5_2_4_dupcook;
	114	sctp_state_fn_t sctp_sf_unk_chunk;
	115	sctp_state_fn_t sctp_sf_do_8_5_1_E_sa;
	116	sctp_state_fn_t sctp_sf_cookie_echoed_err;
	117	sctp_state_fn_t sctp_sf_do_asconf;
	118	sctp_state_fn_t sctp_sf_do_asconf_ack;
2040d3d7	119	sctp_state_fn_t sctp_sf_do_reconf;
1da177e4 LT	120	sctp_state_fn_t sctp_sf_do_9_2_reshutack;
	121	sctp_state_fn_t sctp_sf_eat_fwd_tsn;
	122	sctp_state_fn_t sctp_sf_eat_fwd_tsn_fast;
bbd0d598	123	sctp_state_fn_t sctp_sf_eat_auth;
1da177e4 LT	124
	125	/* Prototypes for primitive event state functions. */
	126	sctp_state_fn_t sctp_sf_do_prm_asoc;
	127	sctp_state_fn_t sctp_sf_do_prm_send;
	128	sctp_state_fn_t sctp_sf_do_9_2_prm_shutdown;
	129	sctp_state_fn_t sctp_sf_cookie_wait_prm_shutdown;
	130	sctp_state_fn_t sctp_sf_cookie_echoed_prm_shutdown;
	131	sctp_state_fn_t sctp_sf_do_9_1_prm_abort;
	132	sctp_state_fn_t sctp_sf_cookie_wait_prm_abort;
	133	sctp_state_fn_t sctp_sf_cookie_echoed_prm_abort;
	134	sctp_state_fn_t sctp_sf_shutdown_pending_prm_abort;
	135	sctp_state_fn_t sctp_sf_shutdown_sent_prm_abort;
	136	sctp_state_fn_t sctp_sf_shutdown_ack_sent_prm_abort;
	137	sctp_state_fn_t sctp_sf_error_closed;
	138	sctp_state_fn_t sctp_sf_error_shutdown;
	139	sctp_state_fn_t sctp_sf_ignore_primitive;
	140	sctp_state_fn_t sctp_sf_do_prm_requestheartbeat;
	141	sctp_state_fn_t sctp_sf_do_prm_asconf;
7a090b04	142	sctp_state_fn_t sctp_sf_do_prm_reconf;
1da177e4 LT	143
1da177e4 LT	144	/* Prototypes for other event state functions. */
e1cdd553	145	sctp_state_fn_t sctp_sf_do_no_pending_tsn;
1da177e4 LT	146	sctp_state_fn_t sctp_sf_do_9_2_start_shutdown;
	147	sctp_state_fn_t sctp_sf_do_9_2_shutdown_ack;
	148	sctp_state_fn_t sctp_sf_ignore_other;
	149	sctp_state_fn_t sctp_sf_cookie_wait_icmp_abort;
	150
	151	/* Prototypes for timeout event state functions. */
	152	sctp_state_fn_t sctp_sf_do_6_3_3_rtx;
7b9438de	153	sctp_state_fn_t sctp_sf_send_reconf;
92548ec2	154	sctp_state_fn_t sctp_sf_send_probe;
1da177e4 LT	155	sctp_state_fn_t sctp_sf_do_6_2_sack;
	156	sctp_state_fn_t sctp_sf_autoclose_timer_expire;
	157
	158	/* Prototypes for utility support functions. */
	159	__u8 sctp_get_chunk_type(struct sctp_chunk *chunk);
8ee821ae	160	const struct sctp_sm_table_entry *sctp_sm_lookup_event(
bfc6f827	161	struct net *net,
88ee48c1	162	enum sctp_event_type event_type,
bfc6f827 XL	163	enum sctp_state state,
bfc6f827 XL	164	union sctp_subtype event_subtype);
1da177e4 LT	165	int sctp_chunk_iif(const struct sctp_chunk *);
	166	struct sctp_association sctp_make_temp_asoc(const struct sctp_endpoint ,
	167	struct sctp_chunk *,
dd0fc66f	168	gfp_t gfp);
1da177e4 LT	169	__u32 sctp_generate_verification_tag(void);
	170	void sctp_populate_tie_tags(__u8 *cookie, __u32 curTag, __u32 hisTag);
	171
	172	/* Prototypes for chunk-building functions. */
327c0dab XL	173	struct sctp_chunk sctp_make_init(const struct sctp_association asoc,
	174	const struct sctp_bind_addr *bp,
	175	gfp_t gfp, int vparam_len);
	176	struct sctp_chunk sctp_make_init_ack(const struct sctp_association asoc,
	177	const struct sctp_chunk *chunk,
	178	const gfp_t gfp, const int unkparam_len);
	179	struct sctp_chunk sctp_make_cookie_echo(const struct sctp_association asoc,
	180	const struct sctp_chunk *chunk);
	181	struct sctp_chunk sctp_make_cookie_ack(const struct sctp_association asoc,
	182	const struct sctp_chunk *chunk);
	183	struct sctp_chunk sctp_make_cwr(const struct sctp_association asoc,
1da177e4	184	const __u32 lowest_tsn,
327c0dab	185	const struct sctp_chunk *chunk);
ad05a7a0 XL	186	struct sctp_chunk sctp_make_idata(const struct sctp_association asoc,
ad05a7a0 XL	187	__u8 flags, int paylen, gfp_t gfp);
2d07a49a XL	188	struct sctp_chunk sctp_make_ifwdtsn(const struct sctp_association asoc,
	189	__u32 new_cum_tsn, size_t nstreams,
	190	struct sctp_ifwdtsn_skip *skiplist);
0c3f6f65	191	struct sctp_chunk sctp_make_datafrag_empty(const struct sctp_association asoc,
327c0dab	192	const struct sctp_sndrcvinfo *sinfo,
0c3f6f65	193	int len, __u8 flags, gfp_t gfp);
327c0dab XL	194	struct sctp_chunk sctp_make_ecne(const struct sctp_association asoc,
327c0dab XL	195	const __u32 lowest_tsn);
47b3ba51	196	struct sctp_chunk sctp_make_sack(struct sctp_association asoc);
1da177e4 LT	197	struct sctp_chunk sctp_make_shutdown(const struct sctp_association asoc,
	198	const struct sctp_chunk *chunk);
	199	struct sctp_chunk sctp_make_shutdown_ack(const struct sctp_association asoc,
327c0dab XL	200	const struct sctp_chunk *chunk);
	201	struct sctp_chunk *sctp_make_shutdown_complete(
	202	const struct sctp_association *asoc,
	203	const struct sctp_chunk *chunk);
6d3e8aa8	204	int sctp_init_cause(struct sctp_chunk *chunk, __be16 cause, size_t paylen);
327c0dab XL	205	struct sctp_chunk sctp_make_abort(const struct sctp_association asoc,
	206	const struct sctp_chunk *chunk,
	207	const size_t hint);
	208	struct sctp_chunk sctp_make_abort_no_data(const struct sctp_association asoc,
	209	const struct sctp_chunk *chunk,
	210	__u32 tsn);
	211	struct sctp_chunk sctp_make_abort_user(const struct sctp_association asoc,
	212	struct msghdr *msg, size_t msg_len);
	213	struct sctp_chunk *sctp_make_abort_violation(
	214	const struct sctp_association *asoc,
	215	const struct sctp_chunk *chunk,
	216	const __u8 *payload,
	217	const size_t paylen);
	218	struct sctp_chunk *sctp_make_violation_paramlen(
	219	const struct sctp_association *asoc,
	220	const struct sctp_chunk *chunk,
	221	struct sctp_paramhdr *param);
	222	struct sctp_chunk *sctp_make_violation_max_retrans(
	223	const struct sctp_association *asoc,
	224	const struct sctp_chunk *chunk);
e38d86b3 XL	225	struct sctp_chunk *sctp_make_new_encap_port(
	226	const struct sctp_association *asoc,
	227	const struct sctp_chunk *chunk);
327c0dab	228	struct sctp_chunk sctp_make_heartbeat(const struct sctp_association asoc,
fe59379b XL	229	const struct sctp_transport *transport,
fe59379b XL	230	__u32 probe_size);
327c0dab XL	231	struct sctp_chunk sctp_make_heartbeat_ack(const struct sctp_association asoc,
	232	const struct sctp_chunk *chunk,
	233	const void *payload,
	234	const size_t paylen);
745a3211	235	struct sctp_chunk sctp_make_pad(const struct sctp_association asoc, int len);
327c0dab XL	236	struct sctp_chunk sctp_make_op_error(const struct sctp_association asoc,
	237	const struct sctp_chunk *chunk,
	238	__be16 cause_code, const void *payload,
	239	size_t paylen, size_t reserve_tail);
1da177e4	240
327c0dab XL	241	struct sctp_chunk sctp_make_asconf_update_ip(struct sctp_association asoc,
	242	union sctp_addr *laddr,
	243	struct sockaddr *addrs,
	244	int addrcnt, __be16 flags);
1da177e4 LT	245	struct sctp_chunk sctp_make_asconf_set_prim(struct sctp_association asoc,
1da177e4 LT	246	union sctp_addr *addr);
9de7922b DB	247	bool sctp_verify_asconf(const struct sctp_association *asoc,
	248	struct sctp_chunk *chunk, bool addr_param_needed,
	249	struct sctp_paramhdr **errp);
1da177e4 LT	250	struct sctp_chunk sctp_process_asconf(struct sctp_association asoc,
	251	struct sctp_chunk *asconf);
	252	int sctp_process_asconf_ack(struct sctp_association *asoc,
	253	struct sctp_chunk *asconf_ack);
	254	struct sctp_chunk sctp_make_fwdtsn(const struct sctp_association asoc,
	255	__u32 new_cum_tsn, size_t nstreams,
	256	struct sctp_fwdtsn_skip *skiplist);
1b1e0bc9 XL	257	struct sctp_chunk sctp_make_auth(const struct sctp_association asoc,
1b1e0bc9 XL	258	__u16 key_id);
327c0dab	259	struct sctp_chunk sctp_make_strreset_req(const struct sctp_association asoc,
1da4fc97	260	__u16 stream_num, __be16 *stream_list,
327c0dab	261	bool out, bool in);
c56480a1	262	struct sctp_chunk *sctp_make_strreset_tsnreq(
327c0dab	263	const struct sctp_association *asoc);
78098117	264	struct sctp_chunk *sctp_make_strreset_addstrm(
327c0dab XL	265	const struct sctp_association *asoc,
	266	__u16 out, __u16 in);
	267	struct sctp_chunk sctp_make_strreset_resp(const struct sctp_association asoc,
	268	__u32 result, __u32 sn);
	269	struct sctp_chunk sctp_make_strreset_tsnresp(struct sctp_association asoc,
	270	__u32 result, __u32 sn,
	271	__u32 sender_tsn,
	272	__u32 receiver_tsn);
ea625043 XL	273	bool sctp_verify_reconf(const struct sctp_association *asoc,
	274	struct sctp_chunk *chunk,
	275	struct sctp_paramhdr **errp);
327c0dab XL	276	void sctp_chunk_assign_tsn(struct sctp_chunk *chunk);
327c0dab XL	277	void sctp_chunk_assign_ssn(struct sctp_chunk *chunk);
1da177e4	278
81054476 XL	279	/* Prototypes for stream-processing functions. */
	280	struct sctp_chunk *sctp_process_strreset_outreq(
	281	struct sctp_association *asoc,
	282	union sctp_params param,
	283	struct sctp_ulpevent **evp);
16e1a919 XL	284	struct sctp_chunk *sctp_process_strreset_inreq(
	285	struct sctp_association *asoc,
	286	union sctp_params param,
	287	struct sctp_ulpevent **evp);
692787ce XL	288	struct sctp_chunk *sctp_process_strreset_tsnreq(
	289	struct sctp_association *asoc,
	290	union sctp_params param,
	291	struct sctp_ulpevent **evp);
50a41591 XL	292	struct sctp_chunk *sctp_process_strreset_addstrm_out(
	293	struct sctp_association *asoc,
	294	union sctp_params param,
	295	struct sctp_ulpevent **evp);
c5c4ebb3 XL	296	struct sctp_chunk *sctp_process_strreset_addstrm_in(
	297	struct sctp_association *asoc,
	298	union sctp_params param,
	299	struct sctp_ulpevent **evp);
11ae76e6 XL	300	struct sctp_chunk *sctp_process_strreset_resp(
	301	struct sctp_association *asoc,
	302	union sctp_params param,
	303	struct sctp_ulpevent **evp);
81054476	304
1da177e4 LT	305	/* Prototypes for statetable processing. */
1da177e4 LT	306
88ee48c1	307	int sctp_do_sm(struct net *net, enum sctp_event_type event_type,
bfc6f827	308	union sctp_subtype subtype, enum sctp_state state,
61f0eb07 XL	309	struct sctp_endpoint ep, struct sctp_association asoc,
61f0eb07 XL	310	void *event_arg, gfp_t gfp);
1da177e4 LT	311
1da177e4 LT	312	/* 2nd level prototypes */
9c3b5751 KC	313	void sctp_generate_t3_rtx_event(struct timer_list *t);
	314	void sctp_generate_heartbeat_event(struct timer_list *t);
	315	void sctp_generate_reconf_event(struct timer_list *t);
92548ec2	316	void sctp_generate_probe_event(struct timer_list *t);
9c3b5751	317	void sctp_generate_proto_unreach_event(struct timer_list *t);
1da177e4	318
34b4e29b	319	void sctp_ootb_pkt_free(struct sctp_packet *packet);
1da177e4	320
327c0dab XL	321	struct sctp_association *sctp_unpack_cookie(
	322	const struct sctp_endpoint *ep,
	323	const struct sctp_association *asoc,
	324	struct sctp_chunk *chunk,
	325	gfp_t gfp, int *err,
	326	struct sctp_chunk **err_chk_p);
1da177e4 LT	327
1da177e4 LT	328	/* 3rd level prototypes */
34b4e29b XL	329	__u32 sctp_generate_tag(const struct sctp_endpoint *ep);
34b4e29b XL	330	__u32 sctp_generate_tsn(const struct sctp_endpoint *ep);
1da177e4 LT	331
	332	/* Extern declarations for major data structures. */
	333	extern sctp_timer_event_t *sctp_timer_events[SCTP_NUM_TIMEOUT_TYPES];
	334
	335
	336	/* Get the size of a DATA chunk payload. */
	337	static inline __u16 sctp_data_size(struct sctp_chunk *chunk)
	338	{
	339	__u16 size;
	340
	341	size = ntohs(chunk->chunk_hdr->length);
5660b9d9	342	size -= sctp_datachk_len(&chunk->asoc->stream);
1da177e4 LT	343
	344	return size;
	345	}
	346
	347	/* Compare two TSNs */
182691d0 MRL	348	#define TSN_lt(a,b) \
	349	(typecheck(__u32, a) && \
	350	typecheck(__u32, b) && \
	351	((__s32)((a) - (b)) < 0))
1da177e4	352
182691d0 MRL	353	#define TSN_lte(a,b) \
	354	(typecheck(__u32, a) && \
	355	typecheck(__u32, b) && \
	356	((__s32)((a) - (b)) <= 0))
1da177e4	357
9d4ceaf1 XL	358	/* Compare two MIDs */
	359	#define MID_lt(a, b) \
	360	(typecheck(__u32, a) && \
	361	typecheck(__u32, b) && \
	362	((__s32)((a) - (b)) < 0))
	363
1da177e4	364	/* Compare two SSNs */
182691d0 MRL	365	#define SSN_lt(a,b) \
	366	(typecheck(__u16, a) && \
	367	typecheck(__u16, b) && \
	368	((__s16)((a) - (b)) < 0))
	369
	370	/* ADDIP 3.1.1 */
	371	#define ADDIP_SERIAL_gte(a,b) \
	372	(typecheck(__u32, a) && \
	373	typecheck(__u32, b) && \
	374	((__s32)((b) - (a)) <= 0))
1da177e4	375
1da177e4 LT	376	/* Check VTAG of the packet matches the sender's own tag. */
	377	static inline int
	378	sctp_vtag_verify(const struct sctp_chunk *chunk,
	379	const struct sctp_association *asoc)
	380	{
	381	/* RFC 2960 Sec 8.5 When receiving an SCTP packet, the endpoint
	382	* MUST ensure that the value in the Verification Tag field of
	383	* the received SCTP packet matches its own Tag. If the received
	384	* Verification Tag value does not match the receiver's own
	385	* tag value, the receiver shall silently discard the packet...
	386	*/
075718fd XL	387	if (ntohl(chunk->sctp_hdr->vtag) != asoc->c.my_vtag)
075718fd XL	388	return 0;
1da177e4	389
a1dd2cf2	390	chunk->transport->encap_port = SCTP_INPUT_CB(chunk->skb)->encap_port;
075718fd	391	return 1;
1da177e4 LT	392	}
1da177e4 LT	393
047a2428 JF	394	/* Check VTAG of the packet matches the sender's own tag and the T bit is
047a2428 JF	395	* not set, OR its peer's tag and the T bit is set in the Chunk Flags.
1da177e4 LT	396	*/
	397	static inline int
	398	sctp_vtag_verify_either(const struct sctp_chunk *chunk,
	399	const struct sctp_association *asoc)
	400	{
047a2428	401	/* RFC 2960 Section 8.5.1, sctpimpguide Section 2.41
1da177e4	402	*
047a2428 JF	403	* B) The receiver of a ABORT MUST accept the packet
	404	* if the Verification Tag field of the packet matches its own tag
	405	* and the T bit is not set
	406	* OR
	407	* it is set to its peer's tag and the T bit is set in the Chunk
	408	* Flags.
	409	* Otherwise, the receiver MUST silently discard the packet
	410	* and take no further action.
1da177e4	411	*
047a2428 JF	412	* C) The receiver of a SHUTDOWN COMPLETE shall accept the packet
	413	* if the Verification Tag field of the packet matches its own tag
	414	* and the T bit is not set
	415	* OR
	416	* it is set to its peer's tag and the T bit is set in the Chunk
	417	* Flags.
	418	* Otherwise, the receiver MUST silently discard the packet
	419	* and take no further action. An endpoint MUST ignore the
	420	* SHUTDOWN COMPLETE if it is not in the SHUTDOWN-ACK-SENT state.
1da177e4	421	*/
047a2428 JF	422	if ((!sctp_test_T_bit(chunk) &&
047a2428 JF	423	(ntohl(chunk->sctp_hdr->vtag) == asoc->c.my_vtag)) \|\|
52688d6e	424	(sctp_test_T_bit(chunk) && asoc->c.peer_vtag &&
047a2428	425	(ntohl(chunk->sctp_hdr->vtag) == asoc->c.peer_vtag))) {
1da177e4 LT	426	return 1;
	427	}
	428
	429	return 0;
	430	}
	431
	432	#endif /* __sctp_sm_h__ */