[deliverable/linux.git] / include / net / sctp / command.h

/* SCTP kernel Implementation
 * (C) Copyright IBM Corp. 2001, 2004
 * Copyright (C) 1999-2001 Cisco, Motorola
 *
 * This file is part of the SCTP kernel implementation
 *
 * These are the definitions needed for the command object.
 *
 * This SCTP implementation  is free software;
 * you can redistribute it and/or modify it under the terms of
 * the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This SCTP implementation  is distributed in the hope that it
 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
 *                 ************************
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU CC; see the file COPYING.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * 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>
 *   Ardelle Fan <ardelle.fan@intel.com>
 *   Sridhar Samudrala <sri@us.ibm.com>
 */

#ifndef __net_sctp_command_h__
#define __net_sctp_command_h__

#include <net/sctp/constants.h>
#include <net/sctp/structs.h>


typedef enum {
	SCTP_CMD_NOP = 0,	/* Do nothing. */
	SCTP_CMD_NEW_ASOC,	/* Register a new association.  */
	SCTP_CMD_DELETE_TCB,	/* Delete the current association. */
	SCTP_CMD_NEW_STATE,	/* Enter a new state.  */
	SCTP_CMD_REPORT_TSN,	/* Record the arrival of a TSN.  */
	SCTP_CMD_GEN_SACK,	/* Send a Selective ACK (maybe).  */
	SCTP_CMD_PROCESS_SACK,	/* Process an inbound SACK.  */
	SCTP_CMD_GEN_INIT_ACK,	/* Generate an INIT ACK chunk.  */
	SCTP_CMD_PEER_INIT,	/* Process a INIT from the peer.  */
	SCTP_CMD_GEN_COOKIE_ECHO, /* Generate a COOKIE ECHO chunk. */
	SCTP_CMD_CHUNK_ULP,	/* Send a chunk to the sockets layer.  */
	SCTP_CMD_EVENT_ULP,	/* Send a notification to the sockets layer. */
	SCTP_CMD_REPLY,		/* Send a chunk to our peer.  */
	SCTP_CMD_SEND_PKT,	/* Send a full packet to our peer.  */
	SCTP_CMD_RETRAN,	/* Mark a transport for retransmission.  */
	SCTP_CMD_ECN_CE,        /* Do delayed CE processing.   */
	SCTP_CMD_ECN_ECNE,	/* Do delayed ECNE processing. */
	SCTP_CMD_ECN_CWR,	/* Do delayed CWR processing.  */
	SCTP_CMD_TIMER_START,	/* Start a timer.  */
	SCTP_CMD_TIMER_START_ONCE, /* Start a timer once */
	SCTP_CMD_TIMER_RESTART,	/* Restart a timer. */
	SCTP_CMD_TIMER_STOP,	/* Stop a timer. */
	SCTP_CMD_INIT_CHOOSE_TRANSPORT, /* Choose transport for an INIT. */
	SCTP_CMD_INIT_COUNTER_RESET, /* Reset init counter. */
	SCTP_CMD_INIT_COUNTER_INC,   /* Increment init counter. */
	SCTP_CMD_INIT_RESTART,  /* High level, do init timer work. */
	SCTP_CMD_COOKIEECHO_RESTART,  /* High level, do cookie-echo timer work. */
	SCTP_CMD_INIT_FAILED,   /* High level, do init failure work. */
	SCTP_CMD_REPORT_DUP,	/* Report a duplicate TSN.  */
	SCTP_CMD_STRIKE,	/* Mark a strike against a transport.  */
	SCTP_CMD_HB_TIMERS_START,    /* Start the heartbeat timers. */
	SCTP_CMD_HB_TIMER_UPDATE,    /* Update a heartbeat timers.  */
	SCTP_CMD_HB_TIMERS_STOP,     /* Stop the heartbeat timers.  */
	SCTP_CMD_TRANSPORT_HB_SENT,  /* Reset the status of a transport. */
	SCTP_CMD_TRANSPORT_IDLE,     /* Do manipulations on idle transport */
	SCTP_CMD_TRANSPORT_ON,       /* Mark the transport as active. */
	SCTP_CMD_REPORT_ERROR,   /* Pass this error back out of the sm. */
	SCTP_CMD_REPORT_BAD_TAG, /* Verification tags didn't match. */
	SCTP_CMD_PROCESS_CTSN,   /* Sideeffect from shutdown. */
	SCTP_CMD_ASSOC_FAILED,	 /* Handle association failure. */
	SCTP_CMD_DISCARD_PACKET, /* Discard the whole packet. */
	SCTP_CMD_GEN_SHUTDOWN,   /* Generate a SHUTDOWN chunk. */
	SCTP_CMD_UPDATE_ASSOC,   /* Update association information. */
	SCTP_CMD_PURGE_OUTQUEUE, /* Purge all data waiting to be sent. */
	SCTP_CMD_SETUP_T2,       /* Hi-level, setup T2-shutdown parms.  */
	SCTP_CMD_RTO_PENDING,	 /* Set transport's rto_pending. */
	SCTP_CMD_PART_DELIVER,	 /* Partial data delivery considerations. */
	SCTP_CMD_RENEGE,         /* Renege data on an association. */
	SCTP_CMD_SETUP_T4,	 /* ADDIP, setup T4 RTO timer parms. */
	SCTP_CMD_PROCESS_OPERR,  /* Process an ERROR chunk. */
	SCTP_CMD_REPORT_FWDTSN,	 /* Report new cumulative TSN Ack. */
	SCTP_CMD_PROCESS_FWDTSN, /* Skips were reported, so process further. */
	SCTP_CMD_CLEAR_INIT_TAG, /* Clears association peer's inittag. */
	SCTP_CMD_DEL_NON_PRIMARY, /* Removes non-primary peer transports. */
	SCTP_CMD_T3_RTX_TIMERS_STOP, /* Stops T3-rtx pending timers */
	SCTP_CMD_FORCE_PRIM_RETRAN,  /* Forces retrans. over primary path. */
	SCTP_CMD_SET_SK_ERR,	 /* Set sk_err */
	SCTP_CMD_ASSOC_CHANGE,	 /* generate and send assoc_change event */
	SCTP_CMD_ADAPTATION_IND, /* generate and send adaptation event */
	SCTP_CMD_ASSOC_SHKEY,    /* generate the association shared keys */
	SCTP_CMD_T1_RETRAN,	 /* Mark for retransmission after T1 timeout  */
	SCTP_CMD_UPDATE_INITTAG, /* Update peer inittag */
	SCTP_CMD_SEND_MSG,	 /* Send the whole use message */
	SCTP_CMD_SEND_NEXT_ASCONF, /* Send the next ASCONF after ACK */
	SCTP_CMD_PURGE_ASCONF_QUEUE, /* Purge all asconf queues.*/
	SCTP_CMD_SET_ASOC,	 /* Restore association context */
	SCTP_CMD_LAST
} sctp_verb_t;

/* How many commands can you put in an sctp_cmd_seq_t?
 * This is a rather arbitrary number, ideally derived from a careful
 * analysis of the state functions, but in reality just taken from
 * thin air in the hopes othat we don't trigger a kernel panic.
 */
#define SCTP_MAX_NUM_COMMANDS 20

typedef union {
	void *zero_all;	/* Set to NULL to clear the entire union */
	__s32 i32;
	__u32 u32;
	__be32 be32;
	__u16 u16;
	__u8 u8;
	int error;
	__be16 err;
	sctp_state_t state;
	sctp_event_timeout_t to;
	struct sctp_chunk *chunk;
	struct sctp_association *asoc;
	struct sctp_transport *transport;
	struct sctp_bind_addr *bp;
	sctp_init_chunk_t *init;
	struct sctp_ulpevent *ulpevent;
	struct sctp_packet *packet;
	sctp_sackhdr_t *sackh;
	struct sctp_datamsg *msg;
} sctp_arg_t;

/* We are simulating ML type constructors here.
 *
 * SCTP_ARG_CONSTRUCTOR(NAME, TYPE, ELT) builds a function called
 * SCTP_NAME() which takes an argument of type TYPE and returns an
 * sctp_arg_t.  It does this by inserting the sole argument into the
 * ELT union element of a local sctp_arg_t.
 *
 * E.g., SCTP_ARG_CONSTRUCTOR(I32, __s32, i32) builds SCTP_I32(arg),
 * which takes an __s32 and returns a sctp_arg_t containing the
 * __s32.  So, after foo = SCTP_I32(arg), foo.i32 == arg.
 */

#define SCTP_ARG_CONSTRUCTOR(name, type, elt) \
static inline sctp_arg_t	\
SCTP_## name (type arg)		\
{ sctp_arg_t retval;\
  retval.zero_all = NULL;\
  retval.elt = arg;\
  return retval;\
}

SCTP_ARG_CONSTRUCTOR(I32,	__s32, i32)
SCTP_ARG_CONSTRUCTOR(U32,	__u32, u32)
SCTP_ARG_CONSTRUCTOR(BE32,	__be32, be32)
SCTP_ARG_CONSTRUCTOR(U16,	__u16, u16)
SCTP_ARG_CONSTRUCTOR(U8,	__u8, u8)
SCTP_ARG_CONSTRUCTOR(ERROR,     int, error)
SCTP_ARG_CONSTRUCTOR(PERR,      __be16, err)	/* protocol error */
SCTP_ARG_CONSTRUCTOR(STATE,	sctp_state_t, state)
SCTP_ARG_CONSTRUCTOR(TO,	sctp_event_timeout_t, to)
SCTP_ARG_CONSTRUCTOR(CHUNK,	struct sctp_chunk *, chunk)
SCTP_ARG_CONSTRUCTOR(ASOC,	struct sctp_association *, asoc)
SCTP_ARG_CONSTRUCTOR(TRANSPORT,	struct sctp_transport *, transport)
SCTP_ARG_CONSTRUCTOR(BA,	struct sctp_bind_addr *, bp)
SCTP_ARG_CONSTRUCTOR(PEER_INIT,	sctp_init_chunk_t *, init)
SCTP_ARG_CONSTRUCTOR(ULPEVENT,  struct sctp_ulpevent *, ulpevent)
SCTP_ARG_CONSTRUCTOR(PACKET,	struct sctp_packet *, packet)
SCTP_ARG_CONSTRUCTOR(SACKH,	sctp_sackhdr_t *, sackh)
SCTP_ARG_CONSTRUCTOR(DATAMSG,	struct sctp_datamsg *, msg)

static inline sctp_arg_t SCTP_FORCE(void)
{
	return SCTP_I32(1);
}

static inline sctp_arg_t SCTP_NOFORCE(void)
{
	return SCTP_I32(0);
}

static inline sctp_arg_t SCTP_NULL(void)
{
	sctp_arg_t retval;
	retval.zero_all = NULL;
	return retval;
}

typedef struct {
	sctp_arg_t obj;
	sctp_verb_t verb;
} sctp_cmd_t;

typedef struct {
	sctp_cmd_t cmds[SCTP_MAX_NUM_COMMANDS];
	sctp_cmd_t *last_used_slot;
	sctp_cmd_t *next_cmd;
} sctp_cmd_seq_t;


/* Initialize a block of memory as a command sequence.
 * Return 0 if the initialization fails.
 */
static inline int sctp_init_cmd_seq(sctp_cmd_seq_t *seq)
{
	/* cmds[] is filled backwards to simplify the overflow BUG() check */
	seq->last_used_slot = seq->cmds + SCTP_MAX_NUM_COMMANDS;
	seq->next_cmd = seq->last_used_slot;
	return 1;		/* We always succeed.  */
}


/* Add a command to an sctp_cmd_seq_t.
 *
 * Use the SCTP_* constructors defined by SCTP_ARG_CONSTRUCTOR() above
 * to wrap data which goes in the obj argument.
 */
static inline void sctp_add_cmd_sf(sctp_cmd_seq_t *seq, sctp_verb_t verb,
				   sctp_arg_t obj)
{
	sctp_cmd_t *cmd = seq->last_used_slot - 1;

	BUG_ON(cmd < seq->cmds);

	cmd->verb = verb;
	cmd->obj = obj;
	seq->last_used_slot = cmd;
}

/* Return the next command structure in an sctp_cmd_seq.
 * Return NULL at the end of the sequence.
 */
static inline sctp_cmd_t *sctp_next_cmd(sctp_cmd_seq_t *seq)
{
	if (seq->next_cmd <= seq->last_used_slot)
		return NULL;

	return --seq->next_cmd;
}

#endif /* __net_sctp_command_h__ */
Commit	Line	Data
60c778b2	1	/* SCTP kernel Implementation
1da177e4 LT	2	* (C) Copyright IBM Corp. 2001, 2004
	3	* Copyright (C) 1999-2001 Cisco, Motorola
	4	*
60c778b2	5	* This file is part of the SCTP kernel implementation
1da177e4 LT	6	*
	7	* These are the definitions needed for the command object.
	8	*
60c778b2	9	* This SCTP implementation is free software;
1da177e4 LT	10	* you can redistribute it and/or modify it under the terms of
	11	* the GNU General Public License as published by
	12	* the Free Software Foundation; either version 2, or (at your option)
	13	* any later version.
	14	*
60c778b2	15	* This SCTP implementation is distributed in the hope that it
1da177e4 LT	16	* will be useful, but WITHOUT ANY WARRANTY; without even the implied
	17	* ************************
	18	* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
	19	* See the GNU General Public License for more details.
	20	*
	21	* You should have received a copy of the GNU General Public License
a6227e26 JK	22	* along with GNU CC; see the file COPYING. If not, see
a6227e26 JK	23	* <http://www.gnu.org/licenses/>.
1da177e4	24	*
477143e3 DB	25	* Please send any bug reports or fixes you make to the
	26	* email address(es):
	27	* lksctp developers <linux-sctp@vger.kernel.org>
	28	*
	29	* Written or modified by:
	30	* La Monte H.P. Yarroll <piggy@acm.org>
	31	* Karl Knutson <karl@athena.chicago.il.us>
	32	* Ardelle Fan <ardelle.fan@intel.com>
	33	* Sridhar Samudrala <sri@us.ibm.com>
1da177e4 LT	34	*/
1da177e4 LT	35
1da177e4 LT	36	#ifndef __net_sctp_command_h__
	37	#define __net_sctp_command_h__
	38
	39	#include <net/sctp/constants.h>
	40	#include <net/sctp/structs.h>
	41
	42
	43	typedef enum {
	44	SCTP_CMD_NOP = 0, /* Do nothing. */
	45	SCTP_CMD_NEW_ASOC, /* Register a new association. */
	46	SCTP_CMD_DELETE_TCB, /* Delete the current association. */
	47	SCTP_CMD_NEW_STATE, /* Enter a new state. */
	48	SCTP_CMD_REPORT_TSN, /* Record the arrival of a TSN. */
	49	SCTP_CMD_GEN_SACK, /* Send a Selective ACK (maybe). */
	50	SCTP_CMD_PROCESS_SACK, /* Process an inbound SACK. */
	51	SCTP_CMD_GEN_INIT_ACK, /* Generate an INIT ACK chunk. */
	52	SCTP_CMD_PEER_INIT, /* Process a INIT from the peer. */
	53	SCTP_CMD_GEN_COOKIE_ECHO, /* Generate a COOKIE ECHO chunk. */
	54	SCTP_CMD_CHUNK_ULP, /* Send a chunk to the sockets layer. */
	55	SCTP_CMD_EVENT_ULP, /* Send a notification to the sockets layer. */
	56	SCTP_CMD_REPLY, /* Send a chunk to our peer. */
	57	SCTP_CMD_SEND_PKT, /* Send a full packet to our peer. */
	58	SCTP_CMD_RETRAN, /* Mark a transport for retransmission. */
	59	SCTP_CMD_ECN_CE, /* Do delayed CE processing. */
	60	SCTP_CMD_ECN_ECNE, /* Do delayed ECNE processing. */
	61	SCTP_CMD_ECN_CWR, /* Do delayed CWR processing. */
	62	SCTP_CMD_TIMER_START, /* Start a timer. */
f8d96052	63	SCTP_CMD_TIMER_START_ONCE, /* Start a timer once */
1da177e4 LT	64	SCTP_CMD_TIMER_RESTART, /* Restart a timer. */
1da177e4 LT	65	SCTP_CMD_TIMER_STOP, /* Stop a timer. */
3f7a87d2 FF	66	SCTP_CMD_INIT_CHOOSE_TRANSPORT, /* Choose transport for an INIT. */
	67	SCTP_CMD_INIT_COUNTER_RESET, /* Reset init counter. */
	68	SCTP_CMD_INIT_COUNTER_INC, /* Increment init counter. */
1da177e4	69	SCTP_CMD_INIT_RESTART, /* High level, do init timer work. */
3f7a87d2	70	SCTP_CMD_COOKIEECHO_RESTART, /* High level, do cookie-echo timer work. */
1da177e4 LT	71	SCTP_CMD_INIT_FAILED, /* High level, do init failure work. */
	72	SCTP_CMD_REPORT_DUP, /* Report a duplicate TSN. */
	73	SCTP_CMD_STRIKE, /* Mark a strike against a transport. */
1da177e4 LT	74	SCTP_CMD_HB_TIMERS_START, /* Start the heartbeat timers. */
	75	SCTP_CMD_HB_TIMER_UPDATE, /* Update a heartbeat timers. */
	76	SCTP_CMD_HB_TIMERS_STOP, /* Stop the heartbeat timers. */
7e99013a VY	77	SCTP_CMD_TRANSPORT_HB_SENT, /* Reset the status of a transport. */
7e99013a VY	78	SCTP_CMD_TRANSPORT_IDLE, /* Do manipulations on idle transport */
1da177e4 LT	79	SCTP_CMD_TRANSPORT_ON, /* Mark the transport as active. */
	80	SCTP_CMD_REPORT_ERROR, /* Pass this error back out of the sm. */
	81	SCTP_CMD_REPORT_BAD_TAG, /* Verification tags didn't match. */
	82	SCTP_CMD_PROCESS_CTSN, /* Sideeffect from shutdown. */
	83	SCTP_CMD_ASSOC_FAILED, /* Handle association failure. */
	84	SCTP_CMD_DISCARD_PACKET, /* Discard the whole packet. */
	85	SCTP_CMD_GEN_SHUTDOWN, /* Generate a SHUTDOWN chunk. */
	86	SCTP_CMD_UPDATE_ASSOC, /* Update association information. */
	87	SCTP_CMD_PURGE_OUTQUEUE, /* Purge all data waiting to be sent. */
	88	SCTP_CMD_SETUP_T2, /* Hi-level, setup T2-shutdown parms. */
	89	SCTP_CMD_RTO_PENDING, /* Set transport's rto_pending. */
	90	SCTP_CMD_PART_DELIVER, /* Partial data delivery considerations. */
	91	SCTP_CMD_RENEGE, /* Renege data on an association. */
	92	SCTP_CMD_SETUP_T4, /* ADDIP, setup T4 RTO timer parms. */
	93	SCTP_CMD_PROCESS_OPERR, /* Process an ERROR chunk. */
	94	SCTP_CMD_REPORT_FWDTSN, /* Report new cumulative TSN Ack. */
	95	SCTP_CMD_PROCESS_FWDTSN, /* Skips were reported, so process further. */
	96	SCTP_CMD_CLEAR_INIT_TAG, /* Clears association peer's inittag. */
	97	SCTP_CMD_DEL_NON_PRIMARY, /* Removes non-primary peer transports. */
	98	SCTP_CMD_T3_RTX_TIMERS_STOP, /* Stops T3-rtx pending timers */
	99	SCTP_CMD_FORCE_PRIM_RETRAN, /* Forces retrans. over primary path. */
8de8c873	100	SCTP_CMD_SET_SK_ERR, /* Set sk_err */
07d93967 VY	101	SCTP_CMD_ASSOC_CHANGE, /* generate and send assoc_change event */
07d93967 VY	102	SCTP_CMD_ADAPTATION_IND, /* generate and send adaptation event */
730fc3d0	103	SCTP_CMD_ASSOC_SHKEY, /* generate the association shared keys */
b6157d8e	104	SCTP_CMD_T1_RETRAN, /* Mark for retransmission after T1 timeout */
f4ad85ca	105	SCTP_CMD_UPDATE_INITTAG, /* Update peer inittag */
9c5c62be	106	SCTP_CMD_SEND_MSG, /* Send the whole use message */
c0786693	107	SCTP_CMD_SEND_NEXT_ASCONF, /* Send the next ASCONF after ACK */
a000c01e	108	SCTP_CMD_PURGE_ASCONF_QUEUE, /* Purge all asconf queues.*/
d5ccd496	109	SCTP_CMD_SET_ASOC, /* Restore association context */
1da177e4 LT	110	SCTP_CMD_LAST
	111	} sctp_verb_t;
	112
1da177e4 LT	113	/* How many commands can you put in an sctp_cmd_seq_t?
	114	* This is a rather arbitrary number, ideally derived from a careful
	115	* analysis of the state functions, but in reality just taken from
	116	* thin air in the hopes othat we don't trigger a kernel panic.
	117	*/
bdf6fa52	118	#define SCTP_MAX_NUM_COMMANDS 20
1da177e4 LT	119
1da177e4 LT	120	typedef union {
b9420e1c	121	void zero_all; / Set to NULL to clear the entire union */
1da177e4 LT	122	__s32 i32;
1da177e4 LT	123	__u32 u32;
2178eda8	124	__be32 be32;
1da177e4 LT	125	__u16 u16;
	126	__u8 u8;
	127	int error;
dc251b2b	128	__be16 err;
1da177e4 LT	129	sctp_state_t state;
1da177e4 LT	130	sctp_event_timeout_t to;
1da177e4 LT	131	struct sctp_chunk *chunk;
	132	struct sctp_association *asoc;
	133	struct sctp_transport *transport;
	134	struct sctp_bind_addr *bp;
	135	sctp_init_chunk_t *init;
	136	struct sctp_ulpevent *ulpevent;
	137	struct sctp_packet *packet;
	138	sctp_sackhdr_t *sackh;
9c5c62be	139	struct sctp_datamsg *msg;
1da177e4 LT	140	} sctp_arg_t;
	141
	142	/* We are simulating ML type constructors here.
	143	*
	144	* SCTP_ARG_CONSTRUCTOR(NAME, TYPE, ELT) builds a function called
	145	* SCTP_NAME() which takes an argument of type TYPE and returns an
	146	* sctp_arg_t. It does this by inserting the sole argument into the
	147	* ELT union element of a local sctp_arg_t.
	148	*
	149	* E.g., SCTP_ARG_CONSTRUCTOR(I32, __s32, i32) builds SCTP_I32(arg),
	150	* which takes an __s32 and returns a sctp_arg_t containing the
	151	* __s32. So, after foo = SCTP_I32(arg), foo.i32 == arg.
	152	*/
1da177e4 LT	153
	154	#define SCTP_ARG_CONSTRUCTOR(name, type, elt) \
	155	static inline sctp_arg_t \
	156	SCTP_## name (type arg) \
b26ddd81	157	{ sctp_arg_t retval;\
b9420e1c	158	retval.zero_all = NULL;\
b26ddd81 NH	159	retval.elt = arg;\
	160	return retval;\
	161	}
1da177e4 LT	162
	163	SCTP_ARG_CONSTRUCTOR(I32, __s32, i32)
	164	SCTP_ARG_CONSTRUCTOR(U32, __u32, u32)
2178eda8	165	SCTP_ARG_CONSTRUCTOR(BE32, __be32, be32)
1da177e4 LT	166	SCTP_ARG_CONSTRUCTOR(U16, __u16, u16)
	167	SCTP_ARG_CONSTRUCTOR(U8, __u8, u8)
	168	SCTP_ARG_CONSTRUCTOR(ERROR, int, error)
dc251b2b	169	SCTP_ARG_CONSTRUCTOR(PERR, __be16, err) /* protocol error */
1da177e4	170	SCTP_ARG_CONSTRUCTOR(STATE, sctp_state_t, state)
1da177e4	171	SCTP_ARG_CONSTRUCTOR(TO, sctp_event_timeout_t, to)
1da177e4 LT	172	SCTP_ARG_CONSTRUCTOR(CHUNK, struct sctp_chunk *, chunk)
	173	SCTP_ARG_CONSTRUCTOR(ASOC, struct sctp_association *, asoc)
	174	SCTP_ARG_CONSTRUCTOR(TRANSPORT, struct sctp_transport *, transport)
	175	SCTP_ARG_CONSTRUCTOR(BA, struct sctp_bind_addr *, bp)
	176	SCTP_ARG_CONSTRUCTOR(PEER_INIT, sctp_init_chunk_t *, init)
	177	SCTP_ARG_CONSTRUCTOR(ULPEVENT, struct sctp_ulpevent *, ulpevent)
	178	SCTP_ARG_CONSTRUCTOR(PACKET, struct sctp_packet *, packet)
	179	SCTP_ARG_CONSTRUCTOR(SACKH, sctp_sackhdr_t *, sackh)
9c5c62be	180	SCTP_ARG_CONSTRUCTOR(DATAMSG, struct sctp_datamsg *, msg)
1da177e4	181
b26ddd81 NH	182	static inline sctp_arg_t SCTP_FORCE(void)
	183	{
	184	return SCTP_I32(1);
	185	}
	186
	187	static inline sctp_arg_t SCTP_NOFORCE(void)
	188	{
	189	return SCTP_I32(0);
	190	}
	191
	192	static inline sctp_arg_t SCTP_NULL(void)
	193	{
	194	sctp_arg_t retval;
b9420e1c	195	retval.zero_all = NULL;
b26ddd81 NH	196	return retval;
	197	}
	198
1da177e4 LT	199	typedef struct {
	200	sctp_arg_t obj;
	201	sctp_verb_t verb;
	202	} sctp_cmd_t;
	203
	204	typedef struct {
	205	sctp_cmd_t cmds[SCTP_MAX_NUM_COMMANDS];
d1a3fe26 DL	206	sctp_cmd_t *last_used_slot;
d1a3fe26 DL	207	sctp_cmd_t *next_cmd;
1da177e4 LT	208	} sctp_cmd_seq_t;
	209
	210
	211	/* Initialize a block of memory as a command sequence.
	212	* Return 0 if the initialization fails.
	213	*/
be1f4f48 DL	214	static inline int sctp_init_cmd_seq(sctp_cmd_seq_t *seq)
be1f4f48 DL	215	{
d1a3fe26 DL	216	/* cmds[] is filled backwards to simplify the overflow BUG() check */
	217	seq->last_used_slot = seq->cmds + SCTP_MAX_NUM_COMMANDS;
	218	seq->next_cmd = seq->last_used_slot;
be1f4f48 DL	219	return 1; /* We always succeed. */
	220	}
	221
1da177e4 LT	222
1da177e4 LT	223	/* Add a command to an sctp_cmd_seq_t.
1da177e4 LT	224	*
	225	* Use the SCTP_* constructors defined by SCTP_ARG_CONSTRUCTOR() above
	226	* to wrap data which goes in the obj argument.
	227	*/
be1f4f48 DL	228	static inline void sctp_add_cmd_sf(sctp_cmd_seq_t *seq, sctp_verb_t verb,
	229	sctp_arg_t obj)
	230	{
d1a3fe26	231	sctp_cmd_t *cmd = seq->last_used_slot - 1;
be1f4f48	232
d1a3fe26 DL	233	BUG_ON(cmd < seq->cmds);
	234
	235	cmd->verb = verb;
	236	cmd->obj = obj;
	237	seq->last_used_slot = cmd;
be1f4f48	238	}
1da177e4 LT	239
	240	/* Return the next command structure in an sctp_cmd_seq.
	241	* Return NULL at the end of the sequence.
	242	*/
be1f4f48 DL	243	static inline sctp_cmd_t sctp_next_cmd(sctp_cmd_seq_t seq)
be1f4f48 DL	244	{
d1a3fe26 DL	245	if (seq->next_cmd <= seq->last_used_slot)
d1a3fe26 DL	246	return NULL;
be1f4f48	247
d1a3fe26	248	return --seq->next_cmd;
be1f4f48	249	}
1da177e4	250
be1f4f48	251	#endif /* __net_sctp_command_h__ */