patch-2_6_7-vs1_9_1_12
[linux-2.6.git] / include / net / sctp / sm.h
1 /* SCTP kernel reference Implementation
2  * (C) Copyright IBM Corp. 2001, 2004
3  * Copyright (c) 1999-2000 Cisco, Inc.
4  * Copyright (c) 1999-2001 Motorola, Inc.
5  * Copyright (c) 2001 Intel Corp.
6  *
7  * This file is part of the SCTP kernel reference Implementation
8  *
9  * These are definitions needed by the state machine.
10  *
11  * The SCTP reference implementation is free software;
12  * you can redistribute it and/or modify it under the terms of
13  * the GNU General Public License as published by
14  * the Free Software Foundation; either version 2, or (at your option)
15  * any later version.
16  *
17  * The SCTP reference implementation is distributed in the hope that it
18  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
19  *                 ************************
20  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
21  * See the GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with GNU CC; see the file COPYING.  If not, write to
25  * the Free Software Foundation, 59 Temple Place - Suite 330,
26  * Boston, MA 02111-1307, USA.
27  *
28  * Please send any bug reports or fixes you make to the
29  * email addresses:
30  *    lksctp developers <lksctp-developers@lists.sourceforge.net>
31  *
32  * Or submit a bug report through the following website:
33  *    http://www.sf.net/projects/lksctp
34  *
35  * Written or modified by:
36  *    La Monte H.P. Yarroll <piggy@acm.org>
37  *    Karl Knutson <karl@athena.chicago.il.us>
38  *    Xingang Guo <xingang.guo@intel.com>
39  *    Jon Grimm <jgrimm@us.ibm.com>
40  *    Dajiang Zhang <dajiang.zhang@nokia.com>
41  *    Sridhar Samudrala <sri@us.ibm.com>
42  *    Daisy Chang <daisyc@us.ibm.com>
43  *    Ardelle Fan <ardelle.fan@intel.com>
44  *    Kevin Gao <kevin.gao@intel.com>
45  *
46  * Any bugs reported given to us we will try to fix... any fixes shared will
47  * be incorporated into the next SCTP release.
48  */
49
50 #include <linux/types.h>
51 #include <linux/compiler.h>
52 #include <linux/slab.h>
53 #include <linux/in.h>
54 #include <net/sctp/command.h>
55 #include <net/sctp/sctp.h>
56
57 #ifndef __sctp_sm_h__
58 #define __sctp_sm_h__
59
60 /*
61  * Possible values for the disposition are:
62  */
63 typedef enum {
64         SCTP_DISPOSITION_DISCARD,        /* No further processing.  */
65         SCTP_DISPOSITION_CONSUME,        /* Process return values normally.  */
66         SCTP_DISPOSITION_NOMEM,          /* We ran out of memory--recover.  */
67         SCTP_DISPOSITION_DELETE_TCB,     /* Close the association.  */
68         SCTP_DISPOSITION_ABORT,          /* Close the association NOW.  */
69         SCTP_DISPOSITION_VIOLATION,      /* The peer is misbehaving.  */
70         SCTP_DISPOSITION_NOT_IMPL,       /* This entry is not implemented.  */
71         SCTP_DISPOSITION_ERROR,          /* This is plain old user error.  */
72         SCTP_DISPOSITION_BUG,            /* This is a bug.  */
73 } sctp_disposition_t;
74
75 typedef struct {
76         int name;
77         int action;
78 } sctp_sm_command_t;
79
80 typedef sctp_disposition_t (sctp_state_fn_t) (const struct sctp_endpoint *,
81                                               const struct sctp_association *,
82                                               const sctp_subtype_t type,
83                                               void *arg,
84                                               sctp_cmd_seq_t *);
85 typedef void (sctp_timer_event_t) (unsigned long);
86 typedef struct {
87         sctp_state_fn_t *fn;
88         const char *name;
89 } sctp_sm_table_entry_t;
90
91 /* A naming convention of "sctp_sf_xxx" applies to all the state functions
92  * currently in use.
93  */
94
95 /* Prototypes for generic state functions. */
96 sctp_state_fn_t sctp_sf_not_impl;
97 sctp_state_fn_t sctp_sf_bug;
98
99 /* Prototypes for gener timer state functions. */
100 sctp_state_fn_t sctp_sf_timer_ignore;
101
102 /* Prototypes for chunk state functions. */
103 sctp_state_fn_t sctp_sf_do_9_1_abort;
104 sctp_state_fn_t sctp_sf_cookie_wait_abort;
105 sctp_state_fn_t sctp_sf_cookie_echoed_abort;
106 sctp_state_fn_t sctp_sf_shutdown_pending_abort;
107 sctp_state_fn_t sctp_sf_shutdown_sent_abort;
108 sctp_state_fn_t sctp_sf_shutdown_ack_sent_abort;
109 sctp_state_fn_t sctp_sf_do_5_1B_init;
110 sctp_state_fn_t sctp_sf_do_5_1C_ack;
111 sctp_state_fn_t sctp_sf_do_5_1D_ce;
112 sctp_state_fn_t sctp_sf_do_5_1E_ca;
113 sctp_state_fn_t sctp_sf_do_4_C;
114 sctp_state_fn_t sctp_sf_eat_data_6_2;
115 sctp_state_fn_t sctp_sf_eat_data_fast_4_4;
116 sctp_state_fn_t sctp_sf_eat_sack_6_2;
117 sctp_state_fn_t sctp_sf_tabort_8_4_8;
118 sctp_state_fn_t sctp_sf_operr_notify;
119 sctp_state_fn_t sctp_sf_t1_timer_expire;
120 sctp_state_fn_t sctp_sf_t2_timer_expire;
121 sctp_state_fn_t sctp_sf_t4_timer_expire;
122 sctp_state_fn_t sctp_sf_t5_timer_expire;
123 sctp_state_fn_t sctp_sf_sendbeat_8_3;
124 sctp_state_fn_t sctp_sf_beat_8_3;
125 sctp_state_fn_t sctp_sf_backbeat_8_3;
126 sctp_state_fn_t sctp_sf_do_9_2_final;
127 sctp_state_fn_t sctp_sf_do_9_2_shutdown;
128 sctp_state_fn_t sctp_sf_do_ecn_cwr;
129 sctp_state_fn_t sctp_sf_do_ecne;
130 sctp_state_fn_t sctp_sf_ootb;
131 sctp_state_fn_t sctp_sf_shut_8_4_5;
132 sctp_state_fn_t sctp_sf_pdiscard;
133 sctp_state_fn_t sctp_sf_violation;
134 sctp_state_fn_t sctp_sf_discard_chunk;
135 sctp_state_fn_t sctp_sf_do_5_2_1_siminit;
136 sctp_state_fn_t sctp_sf_do_5_2_2_dupinit;
137 sctp_state_fn_t sctp_sf_do_5_2_4_dupcook;
138 sctp_state_fn_t sctp_sf_unk_chunk;
139 sctp_state_fn_t sctp_sf_do_8_5_1_E_sa;
140 sctp_state_fn_t sctp_sf_cookie_echoed_err;
141 sctp_state_fn_t sctp_sf_do_5_2_6_stale;
142 sctp_state_fn_t sctp_sf_do_asconf;
143 sctp_state_fn_t sctp_sf_do_asconf_ack;
144 sctp_state_fn_t sctp_sf_do_9_2_reshutack;
145 sctp_state_fn_t sctp_sf_eat_fwd_tsn;
146 sctp_state_fn_t sctp_sf_eat_fwd_tsn_fast;
147
148 /* Prototypes for primitive event state functions.  */
149 sctp_state_fn_t sctp_sf_do_prm_asoc;
150 sctp_state_fn_t sctp_sf_do_prm_send;
151 sctp_state_fn_t sctp_sf_do_9_2_prm_shutdown;
152 sctp_state_fn_t sctp_sf_cookie_wait_prm_shutdown;
153 sctp_state_fn_t sctp_sf_cookie_echoed_prm_shutdown;
154 sctp_state_fn_t sctp_sf_do_9_1_prm_abort;
155 sctp_state_fn_t sctp_sf_cookie_wait_prm_abort;
156 sctp_state_fn_t sctp_sf_cookie_echoed_prm_abort;
157 sctp_state_fn_t sctp_sf_shutdown_pending_prm_abort;
158 sctp_state_fn_t sctp_sf_shutdown_sent_prm_abort;
159 sctp_state_fn_t sctp_sf_shutdown_ack_sent_prm_abort;
160 sctp_state_fn_t sctp_sf_error_closed;
161 sctp_state_fn_t sctp_sf_error_shutdown;
162 sctp_state_fn_t sctp_sf_ignore_primitive;
163 sctp_state_fn_t sctp_sf_do_prm_requestheartbeat;
164 sctp_state_fn_t sctp_sf_do_prm_asconf;
165
166 /* Prototypes for other event state functions.  */
167 sctp_state_fn_t sctp_sf_do_9_2_start_shutdown;
168 sctp_state_fn_t sctp_sf_do_9_2_shutdown_ack;
169 sctp_state_fn_t sctp_sf_ignore_other;
170
171 /* Prototypes for timeout event state functions.  */
172 sctp_state_fn_t sctp_sf_do_6_3_3_rtx;
173 sctp_state_fn_t sctp_sf_do_6_2_sack;
174 sctp_state_fn_t sctp_sf_autoclose_timer_expire;
175
176 /* Prototypes for utility support functions.  */
177 __u8 sctp_get_chunk_type(struct sctp_chunk *chunk);
178 const sctp_sm_table_entry_t *sctp_sm_lookup_event(sctp_event_t,
179                                             sctp_state_t,
180                                             sctp_subtype_t);
181 int sctp_chunk_iif(const struct sctp_chunk *);
182 struct sctp_association *sctp_make_temp_asoc(const struct sctp_endpoint *,
183                                              struct sctp_chunk *,
184                                              int gfp);
185 __u32 sctp_generate_verification_tag(void);
186 void sctp_populate_tie_tags(__u8 *cookie, __u32 curTag, __u32 hisTag);
187
188 /* Prototypes for chunk-building functions.  */
189 struct sctp_chunk *sctp_make_init(const struct sctp_association *,
190                              const struct sctp_bind_addr *,
191                              int gfp, int vparam_len);
192 struct sctp_chunk *sctp_make_init_ack(const struct sctp_association *,
193                                  const struct sctp_chunk *,
194                                  const int gfp,
195                                  const int unkparam_len);
196 struct sctp_chunk *sctp_make_cookie_echo(const struct sctp_association *,
197                                     const struct sctp_chunk *);
198 struct sctp_chunk *sctp_make_cookie_ack(const struct sctp_association *,
199                                    const struct sctp_chunk *);
200 struct sctp_chunk *sctp_make_cwr(const struct sctp_association *,
201                                  const __u32 lowest_tsn,
202                                  const struct sctp_chunk *);
203 struct sctp_chunk *sctp_make_datafrag(struct sctp_association *,
204                                  const struct sctp_sndrcvinfo *sinfo,
205                                  int len, const __u8 *data,
206                                  __u8 flags, __u16 ssn);
207 struct sctp_chunk * sctp_make_datafrag_empty(struct sctp_association *,
208                                         const struct sctp_sndrcvinfo *sinfo,
209                                         int len, const __u8 flags,
210                                         __u16 ssn);
211 struct sctp_chunk *sctp_make_data(struct sctp_association *,
212                              const struct sctp_sndrcvinfo *sinfo,
213                              int len, const __u8 *data);
214 struct sctp_chunk *sctp_make_data_empty(struct sctp_association *,
215                                    const struct sctp_sndrcvinfo *, int len);
216 struct sctp_chunk *sctp_make_ecne(const struct sctp_association *,
217                                   const __u32);
218 struct sctp_chunk *sctp_make_sack(const struct sctp_association *);
219 struct sctp_chunk *sctp_make_shutdown(const struct sctp_association *asoc,
220                                       const struct sctp_chunk *chunk);
221 struct sctp_chunk *sctp_make_shutdown_ack(const struct sctp_association *asoc,
222                                           const struct sctp_chunk *);
223 struct sctp_chunk *sctp_make_shutdown_complete(const struct sctp_association *,
224                                           const struct sctp_chunk *);
225 void sctp_init_cause(struct sctp_chunk *, __u16 cause, const void *, size_t);
226 struct sctp_chunk *sctp_make_abort(const struct sctp_association *,
227                               const struct sctp_chunk *,
228                               const size_t hint);
229 struct sctp_chunk *sctp_make_abort_no_data(const struct sctp_association *,
230                                       const struct sctp_chunk *,
231                                       __u32 tsn);
232 struct sctp_chunk *sctp_make_abort_user(const struct sctp_association *,
233                                    const struct sctp_chunk *,
234                                    const struct msghdr *);
235 struct sctp_chunk *sctp_make_heartbeat(const struct sctp_association *,
236                                   const struct sctp_transport *,
237                                   const void *payload,
238                                   const size_t paylen);
239 struct sctp_chunk *sctp_make_heartbeat_ack(const struct sctp_association *,
240                                       const struct sctp_chunk *,
241                                       const void *payload,
242                                       const size_t paylen);
243 struct sctp_chunk *sctp_make_op_error(const struct sctp_association *,
244                                  const struct sctp_chunk *chunk,
245                                  __u16 cause_code,
246                                  const void *payload,
247                                  size_t paylen);
248
249 struct sctp_chunk *sctp_make_asconf(struct sctp_association *asoc,
250                                     union sctp_addr *addr,
251                                     int vparam_len);
252 struct sctp_chunk *sctp_make_asconf_update_ip(struct sctp_association *,
253                                               union sctp_addr *,
254                                               struct sockaddr *,
255                                               int, __u16);
256 struct sctp_chunk *sctp_make_asconf_set_prim(struct sctp_association *asoc,
257                                              union sctp_addr *addr);
258 struct sctp_chunk *sctp_make_asconf_ack(const struct sctp_association *asoc,
259                                         __u32 serial, int vparam_len);
260 struct sctp_chunk *sctp_process_asconf(struct sctp_association *asoc,
261                                        struct sctp_chunk *asconf);
262 int sctp_process_asconf_ack(struct sctp_association *asoc,
263                             struct sctp_chunk *asconf_ack);
264 struct sctp_chunk *sctp_make_fwdtsn(const struct sctp_association *asoc,
265                                     __u32 new_cum_tsn, size_t nstreams,
266                                     struct sctp_fwdtsn_skip *skiplist);
267
268 void sctp_chunk_assign_tsn(struct sctp_chunk *);
269 void sctp_chunk_assign_ssn(struct sctp_chunk *);
270
271 /* Prototypes for statetable processing. */
272
273 int sctp_do_sm(sctp_event_t event_type, sctp_subtype_t subtype,
274                sctp_state_t state,
275                struct sctp_endpoint *,
276                struct sctp_association *asoc,
277                void *event_arg,
278                int gfp);
279
280 int sctp_side_effects(sctp_event_t event_type, sctp_subtype_t subtype,
281                       sctp_state_t state,
282                       struct sctp_endpoint *,
283                       struct sctp_association *asoc,
284                       void *event_arg,
285                       sctp_disposition_t status,
286                       sctp_cmd_seq_t *commands,
287                       int gfp);
288
289 /* 2nd level prototypes */
290 int sctp_cmd_interpreter(sctp_event_t, sctp_subtype_t, sctp_state_t,
291                          struct sctp_endpoint *, struct sctp_association *,
292                          void *event_arg, sctp_disposition_t,
293                          sctp_cmd_seq_t *retval, int gfp);
294
295
296 int sctp_gen_sack(struct sctp_association *, int force, sctp_cmd_seq_t *);
297 void sctp_generate_t3_rtx_event(unsigned long peer);
298 void sctp_generate_heartbeat_event(unsigned long peer);
299
300 sctp_sackhdr_t *sctp_sm_pull_sack(struct sctp_chunk *);
301 struct sctp_packet *sctp_abort_pkt_new(const struct sctp_endpoint *,
302                                        const struct sctp_association *,
303                                        struct sctp_chunk *chunk,
304                                        const void *payload,
305                                        size_t paylen);
306 struct sctp_packet *sctp_ootb_pkt_new(const struct sctp_association *,
307                                       const struct sctp_chunk *);
308 void sctp_ootb_pkt_free(struct sctp_packet *);
309
310 struct sctp_cookie_param *
311 sctp_pack_cookie(const struct sctp_endpoint *, const struct sctp_association *,
312                  const struct sctp_chunk *, int *cookie_len,
313                  const __u8 *, int addrs_len);
314 struct sctp_association *sctp_unpack_cookie(const struct sctp_endpoint *,
315                                        const struct sctp_association *,
316                                        struct sctp_chunk *, int gfp, int *err,
317                                        struct sctp_chunk **err_chk_p);
318 int sctp_addip_addr_config(struct sctp_association *, sctp_param_t,
319                            struct sockaddr_storage*, int);
320 void sctp_send_stale_cookie_err(const struct sctp_endpoint *ep,
321                                 const struct sctp_association *asoc,
322                                 const struct sctp_chunk *chunk,
323                                 sctp_cmd_seq_t *commands,
324                                 struct sctp_chunk *err_chunk);
325
326 /* 3rd level prototypes */
327 __u32 sctp_generate_tag(const struct sctp_endpoint *);
328 __u32 sctp_generate_tsn(const struct sctp_endpoint *);
329
330 /* Extern declarations for major data structures.  */
331 const sctp_sm_table_entry_t *sctp_chunk_event_lookup(sctp_cid_t, sctp_state_t);
332 extern const sctp_sm_table_entry_t
333 primitive_event_table[SCTP_NUM_PRIMITIVE_TYPES][SCTP_STATE_NUM_STATES];
334 extern const sctp_sm_table_entry_t
335 other_event_table[SCTP_NUM_OTHER_TYPES][SCTP_STATE_NUM_STATES];
336 extern const sctp_sm_table_entry_t
337 timeout_event_table[SCTP_NUM_TIMEOUT_TYPES][SCTP_STATE_NUM_STATES];
338 extern sctp_timer_event_t *sctp_timer_events[SCTP_NUM_TIMEOUT_TYPES];
339
340 /* These are some handy utility macros... */
341
342
343 /* Get the size of a DATA chunk payload. */
344 static inline __u16 sctp_data_size(struct sctp_chunk *chunk)
345 {
346         __u16 size;
347
348         size = ntohs(chunk->chunk_hdr->length);
349         size -= sizeof(sctp_data_chunk_t);
350
351         return size;
352 }
353
354 /* Compare two TSNs */
355
356 /* RFC 1982 - Serial Number Arithmetic
357  *
358  * 2. Comparison
359  *  Then, s1 is said to be equal to s2 if and only if i1 is equal to i2,
360  *  in all other cases, s1 is not equal to s2.
361  *
362  * s1 is said to be less than s2 if, and only if, s1 is not equal to s2,
363  * and
364  *
365  *      (i1 < i2 and i2 - i1 < 2^(SERIAL_BITS - 1)) or
366  *      (i1 > i2 and i1 - i2 > 2^(SERIAL_BITS - 1))
367  *
368  * s1 is said to be greater than s2 if, and only if, s1 is not equal to
369  * s2, and
370  *
371  *      (i1 < i2 and i2 - i1 > 2^(SERIAL_BITS - 1)) or
372  *      (i1 > i2 and i1 - i2 < 2^(SERIAL_BITS - 1))
373  */
374
375 /*
376  * RFC 2960
377  *  1.6 Serial Number Arithmetic
378  *
379  * Comparisons and arithmetic on TSNs in this document SHOULD use Serial
380  * Number Arithmetic as defined in [RFC1982] where SERIAL_BITS = 32.
381  */
382
383 enum {
384         TSN_SIGN_BIT = (1<<31)
385 };
386
387 static inline int TSN_lt(__u32 s, __u32 t)
388 {
389         return (((s) - (t)) & TSN_SIGN_BIT);
390 }
391
392 static inline int TSN_lte(__u32 s, __u32 t)
393 {
394         return (((s) == (t)) || (((s) - (t)) & TSN_SIGN_BIT));
395 }
396
397 /* Compare two SSNs */
398
399 /*
400  * RFC 2960
401  *  1.6 Serial Number Arithmetic
402  *
403  * Comparisons and arithmetic on Stream Sequence Numbers in this document
404  * SHOULD use Serial Number Arithmetic as defined in [RFC1982] where
405  * SERIAL_BITS = 16.
406  */
407 enum {
408         SSN_SIGN_BIT = (1<<15)
409 };
410
411 static inline int SSN_lt(__u16 s, __u16 t)
412 {
413         return (((s) - (t)) & SSN_SIGN_BIT);
414 }
415
416 static inline int SSN_lte(__u16 s, __u16 t)
417 {
418         return (((s) == (t)) || (((s) - (t)) & SSN_SIGN_BIT));
419 }
420
421 /*
422  * ADDIP 3.1.1
423  * The valid range of Serial Number is from 0 to 4294967295 (2**32 - 1). Serial
424  * Numbers wrap back to 0 after reaching 4294967295.
425  */
426 enum {
427         ADDIP_SERIAL_SIGN_BIT = (1<<31)
428 };
429
430 static inline int ADDIP_SERIAL_gte(__u16 s, __u16 t)
431 {
432         return (((s) == (t)) || (((t) - (s)) & ADDIP_SERIAL_SIGN_BIT));
433 }
434
435
436 /* Run sctp_add_cmd() generating a BUG() if there is a failure.  */
437 static inline void sctp_add_cmd_sf(sctp_cmd_seq_t *seq, sctp_verb_t verb, sctp_arg_t obj)
438 {
439         if (unlikely(!sctp_add_cmd(seq, verb, obj)))
440                 BUG();
441 }
442
443 /* Check VTAG of the packet matches the sender's own tag. */
444 static inline int
445 sctp_vtag_verify(const struct sctp_chunk *chunk,
446                  const struct sctp_association *asoc)
447 {
448         /* RFC 2960 Sec 8.5 When receiving an SCTP packet, the endpoint
449          * MUST ensure that the value in the Verification Tag field of
450          * the received SCTP packet matches its own Tag. If the received
451          * Verification Tag value does not match the receiver's own
452          * tag value, the receiver shall silently discard the packet...
453          */
454         if (ntohl(chunk->sctp_hdr->vtag) == asoc->c.my_vtag)
455                 return 1;
456
457         return 0;
458 }
459
460 /* Check VTAG of the packet matches the sender's own tag OR its peer's
461  * tag and the T bit is set in the Chunk Flags.
462  */
463 static inline int
464 sctp_vtag_verify_either(const struct sctp_chunk *chunk,
465                         const struct sctp_association *asoc)
466 {
467         /* RFC 2960 Section 8.5.1, sctpimpguide-06 Section 2.13.2
468          *
469          * B) The receiver of a ABORT shall accept the packet if the
470          * Verification Tag field of the packet matches its own tag OR it
471          * is set to its peer's tag and the T bit is set in the Chunk
472          * Flags. Otherwise, the receiver MUST silently discard the packet
473          * and take no further action.
474          *
475          * (C) The receiver of a SHUTDOWN COMPLETE shall accept the
476          * packet if the Verification Tag field of the packet
477          * matches its own tag OR it is set to its peer's tag and
478          * the T bit is set in the Chunk Flags.  Otherwise, the
479          * receiver MUST silently discard the packet and take no
480          * further action....
481          *
482          */
483         if ((ntohl(chunk->sctp_hdr->vtag) == asoc->c.my_vtag) ||
484             (sctp_test_T_bit(chunk) && (ntohl(chunk->sctp_hdr->vtag)
485             == asoc->c.peer_vtag))) {
486                 return 1;
487         }
488
489         return 0;
490 }
491
492 #endif /* __sctp_sm_h__ */