1 /* SCTP kernel reference Implementation
2 * (C) Copyright IBM Corp. 2001, 2004
3 * Copyright (C) 1999-2001 Cisco, Motorola
4 *
5 * This file is part of the SCTP kernel reference Implementation
6 *
7 * These are the definitions needed for the command object.
8 *
9 * The SCTP reference implementation is free software;
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 *
15 * the SCTP reference implementation is distributed in the hope that it
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
22 * along with GNU CC; see the file COPYING. If not, write to
23 * the Free Software Foundation, 59 Temple Place - Suite 330,
24 * Boston, MA 02111-1307, USA.
25 *
26 * Please send any bug reports or fixes you make to one of the
27 * following email addresses:
28 *
29 * La Monte H.P. Yarroll <piggy@acm.org>
30 * Karl Knutson <karl@athena.chicago.il.us>
31 * Ardelle Fan <ardelle.fan@intel.com>
32 * Sridhar Samudrala <sri@us.ibm.com>
33 *
34 * Any bugs reported given to us we will try to fix... any fixes shared will
35 * be incorporated into the next SCTP release.
36 */
37
38
39 #ifndef __net_sctp_command_h__
40 #define __net_sctp_command_h__
41
42 #include <net/sctp/constants.h>
43 #include <net/sctp/structs.h>
44
45
46 typedef enum {
47 SCTP_CMD_NOP = 0, /* Do nothing. */
48 SCTP_CMD_NEW_ASOC, /* Register a new association. */
49 SCTP_CMD_DELETE_TCB, /* Delete the current association. */
50 SCTP_CMD_NEW_STATE, /* Enter a new state. */
51 SCTP_CMD_REPORT_TSN, /* Record the arrival of a TSN. */
52 SCTP_CMD_GEN_SACK, /* Send a Selective ACK (maybe). */
53 SCTP_CMD_PROCESS_SACK, /* Process an inbound SACK. */
54 SCTP_CMD_GEN_INIT_ACK, /* Generate an INIT ACK chunk. */
55 SCTP_CMD_PEER_INIT, /* Process a INIT from the peer. */
56 SCTP_CMD_GEN_COOKIE_ECHO, /* Generate a COOKIE ECHO chunk. */
57 SCTP_CMD_CHUNK_ULP, /* Send a chunk to the sockets layer. */
58 SCTP_CMD_EVENT_ULP, /* Send a notification to the sockets layer. */
59 SCTP_CMD_REPLY, /* Send a chunk to our peer. */
60 SCTP_CMD_SEND_PKT, /* Send a full packet to our peer. */
61 SCTP_CMD_RETRAN, /* Mark a transport for retransmission. */
62 SCTP_CMD_ECN_CE, /* Do delayed CE processing. */
63 SCTP_CMD_ECN_ECNE, /* Do delayed ECNE processing. */
64 SCTP_CMD_ECN_CWR, /* Do delayed CWR processing. */
65 SCTP_CMD_TIMER_START, /* Start a timer. */
66 SCTP_CMD_TIMER_RESTART, /* Restart a timer. */
67 SCTP_CMD_TIMER_STOP, /* Stop a timer. */
68 SCTP_CMD_COUNTER_RESET, /* Reset a counter. */
69 SCTP_CMD_COUNTER_INC, /* Increment a counter. */
70 SCTP_CMD_INIT_RESTART, /* High level, do init timer work. */
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. */
74 SCTP_CMD_TRANSMIT, /* Transmit the outqueue. */
75 SCTP_CMD_HB_TIMERS_START, /* Start the heartbeat timers. */
76 SCTP_CMD_HB_TIMER_UPDATE, /* Update a heartbeat timers. */
77 SCTP_CMD_HB_TIMERS_STOP, /* Stop the heartbeat timers. */
78 SCTP_CMD_TRANSPORT_RESET, /* Reset the status of a transport. */
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. */
100 SCTP_CMD_LAST
101 } sctp_verb_t;
102
103 #define SCTP_CMD_MAX (SCTP_CMD_LAST - 1)
104 #define SCTP_CMD_NUM_VERBS (SCTP_CMD_MAX + 1)
105
106 /* How many commands can you put in an sctp_cmd_seq_t?
107 * This is a rather arbitrary number, ideally derived from a careful
108 * analysis of the state functions, but in reality just taken from
109 * thin air in the hopes othat we don't trigger a kernel panic.
110 */
111 #define SCTP_MAX_NUM_COMMANDS 14
112
113 typedef union {
114 __s32 i32;
115 __u32 u32;
116 __u16 u16;
117 __u8 u8;
118 int error;
119 sctp_state_t state;
120 sctp_event_timeout_t to;
121 sctp_counter_t counter;
122 void *ptr;
123 struct sctp_chunk *chunk;
124 struct sctp_association *asoc;
125 struct sctp_transport *transport;
126 struct sctp_bind_addr *bp;
127 sctp_init_chunk_t *init;
128 struct sctp_ulpevent *ulpevent;
129 struct sctp_packet *packet;
130 sctp_sackhdr_t *sackh;
131 } sctp_arg_t;
132
133 /* We are simulating ML type constructors here.
134 *
135 * SCTP_ARG_CONSTRUCTOR(NAME, TYPE, ELT) builds a function called
136 * SCTP_NAME() which takes an argument of type TYPE and returns an
137 * sctp_arg_t. It does this by inserting the sole argument into the
138 * ELT union element of a local sctp_arg_t.
139 *
140 * E.g., SCTP_ARG_CONSTRUCTOR(I32, __s32, i32) builds SCTP_I32(arg),
141 * which takes an __s32 and returns a sctp_arg_t containing the
142 * __s32. So, after foo = SCTP_I32(arg), foo.i32 == arg.
143 */
SCTP_NULL(void)144 static inline sctp_arg_t SCTP_NULL(void)
145 {
146 sctp_arg_t retval; retval.ptr = NULL; return retval;
147 }
SCTP_NOFORCE(void)148 static inline sctp_arg_t SCTP_NOFORCE(void)
149 {
150 sctp_arg_t retval; retval.i32 = 0; return retval;
151 }
SCTP_FORCE(void)152 static inline sctp_arg_t SCTP_FORCE(void)
153 {
154 sctp_arg_t retval; retval.i32 = 1; return retval;
155 }
156
157 #define SCTP_ARG_CONSTRUCTOR(name, type, elt) \
158 static inline sctp_arg_t \
159 SCTP_## name (type arg) \
160 { sctp_arg_t retval; retval.elt = arg; return retval; }
161
162 SCTP_ARG_CONSTRUCTOR(I32, __s32, i32)
163 SCTP_ARG_CONSTRUCTOR(U32, __u32, u32)
164 SCTP_ARG_CONSTRUCTOR(U16, __u16, u16)
165 SCTP_ARG_CONSTRUCTOR(U8, __u8, u8)
166 SCTP_ARG_CONSTRUCTOR(ERROR, int, error)
167 SCTP_ARG_CONSTRUCTOR(STATE, sctp_state_t, state)
168 SCTP_ARG_CONSTRUCTOR(COUNTER, sctp_counter_t, counter)
169 SCTP_ARG_CONSTRUCTOR(TO, sctp_event_timeout_t, to)
170 SCTP_ARG_CONSTRUCTOR(PTR, void *, ptr)
171 SCTP_ARG_CONSTRUCTOR(CHUNK, struct sctp_chunk *, chunk)
172 SCTP_ARG_CONSTRUCTOR(ASOC, struct sctp_association *, asoc)
173 SCTP_ARG_CONSTRUCTOR(TRANSPORT, struct sctp_transport *, transport)
174 SCTP_ARG_CONSTRUCTOR(BA, struct sctp_bind_addr *, bp)
175 SCTP_ARG_CONSTRUCTOR(PEER_INIT, sctp_init_chunk_t *, init)
176 SCTP_ARG_CONSTRUCTOR(ULPEVENT, struct sctp_ulpevent *, ulpevent)
177 SCTP_ARG_CONSTRUCTOR(PACKET, struct sctp_packet *, packet)
178 SCTP_ARG_CONSTRUCTOR(SACKH, sctp_sackhdr_t *, sackh)
179
180 typedef struct {
181 sctp_arg_t obj;
182 sctp_verb_t verb;
183 } sctp_cmd_t;
184
185 typedef struct {
186 sctp_cmd_t cmds[SCTP_MAX_NUM_COMMANDS];
187 __u8 next_free_slot;
188 __u8 next_cmd;
189 } sctp_cmd_seq_t;
190
191
192 /* Initialize a block of memory as a command sequence.
193 * Return 0 if the initialization fails.
194 */
195 int sctp_init_cmd_seq(sctp_cmd_seq_t *seq);
196
197 /* Add a command to an sctp_cmd_seq_t.
198 * Return 0 if the command sequence is full.
199 *
200 * Use the SCTP_* constructors defined by SCTP_ARG_CONSTRUCTOR() above
201 * to wrap data which goes in the obj argument.
202 */
203 int sctp_add_cmd(sctp_cmd_seq_t *seq, sctp_verb_t verb, sctp_arg_t obj);
204
205 /* Return the next command structure in an sctp_cmd_seq.
206 * Return NULL at the end of the sequence.
207 */
208 sctp_cmd_t *sctp_next_cmd(sctp_cmd_seq_t *seq);
209
210 #endif /* __net_sctp_command_h__ */
211
212