Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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. */ |
Frank Filz | 3f7a87d | 2005-06-20 13:14:57 -0700 | [diff] [blame] | 68 | SCTP_CMD_INIT_CHOOSE_TRANSPORT, /* Choose transport for an INIT. */ |
| 69 | SCTP_CMD_INIT_COUNTER_RESET, /* Reset init counter. */ |
| 70 | SCTP_CMD_INIT_COUNTER_INC, /* Increment init counter. */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 71 | SCTP_CMD_INIT_RESTART, /* High level, do init timer work. */ |
Frank Filz | 3f7a87d | 2005-06-20 13:14:57 -0700 | [diff] [blame] | 72 | SCTP_CMD_COOKIEECHO_RESTART, /* High level, do cookie-echo timer work. */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | SCTP_CMD_INIT_FAILED, /* High level, do init failure work. */ |
| 74 | SCTP_CMD_REPORT_DUP, /* Report a duplicate TSN. */ |
| 75 | SCTP_CMD_STRIKE, /* Mark a strike against a transport. */ |
| 76 | SCTP_CMD_TRANSMIT, /* Transmit the outqueue. */ |
| 77 | SCTP_CMD_HB_TIMERS_START, /* Start the heartbeat timers. */ |
| 78 | SCTP_CMD_HB_TIMER_UPDATE, /* Update a heartbeat timers. */ |
| 79 | SCTP_CMD_HB_TIMERS_STOP, /* Stop the heartbeat timers. */ |
| 80 | SCTP_CMD_TRANSPORT_RESET, /* Reset the status of a transport. */ |
| 81 | SCTP_CMD_TRANSPORT_ON, /* Mark the transport as active. */ |
| 82 | SCTP_CMD_REPORT_ERROR, /* Pass this error back out of the sm. */ |
| 83 | SCTP_CMD_REPORT_BAD_TAG, /* Verification tags didn't match. */ |
| 84 | SCTP_CMD_PROCESS_CTSN, /* Sideeffect from shutdown. */ |
| 85 | SCTP_CMD_ASSOC_FAILED, /* Handle association failure. */ |
| 86 | SCTP_CMD_DISCARD_PACKET, /* Discard the whole packet. */ |
| 87 | SCTP_CMD_GEN_SHUTDOWN, /* Generate a SHUTDOWN chunk. */ |
| 88 | SCTP_CMD_UPDATE_ASSOC, /* Update association information. */ |
| 89 | SCTP_CMD_PURGE_OUTQUEUE, /* Purge all data waiting to be sent. */ |
| 90 | SCTP_CMD_SETUP_T2, /* Hi-level, setup T2-shutdown parms. */ |
| 91 | SCTP_CMD_RTO_PENDING, /* Set transport's rto_pending. */ |
| 92 | SCTP_CMD_PART_DELIVER, /* Partial data delivery considerations. */ |
| 93 | SCTP_CMD_RENEGE, /* Renege data on an association. */ |
| 94 | SCTP_CMD_SETUP_T4, /* ADDIP, setup T4 RTO timer parms. */ |
| 95 | SCTP_CMD_PROCESS_OPERR, /* Process an ERROR chunk. */ |
| 96 | SCTP_CMD_REPORT_FWDTSN, /* Report new cumulative TSN Ack. */ |
| 97 | SCTP_CMD_PROCESS_FWDTSN, /* Skips were reported, so process further. */ |
| 98 | SCTP_CMD_CLEAR_INIT_TAG, /* Clears association peer's inittag. */ |
| 99 | SCTP_CMD_DEL_NON_PRIMARY, /* Removes non-primary peer transports. */ |
| 100 | SCTP_CMD_T3_RTX_TIMERS_STOP, /* Stops T3-rtx pending timers */ |
| 101 | SCTP_CMD_FORCE_PRIM_RETRAN, /* Forces retrans. over primary path. */ |
Sridhar Samudrala | 8de8c87 | 2006-05-19 10:58:12 -0700 | [diff] [blame] | 102 | SCTP_CMD_SET_SK_ERR, /* Set sk_err */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 103 | SCTP_CMD_LAST |
| 104 | } sctp_verb_t; |
| 105 | |
| 106 | #define SCTP_CMD_MAX (SCTP_CMD_LAST - 1) |
| 107 | #define SCTP_CMD_NUM_VERBS (SCTP_CMD_MAX + 1) |
| 108 | |
| 109 | /* How many commands can you put in an sctp_cmd_seq_t? |
| 110 | * This is a rather arbitrary number, ideally derived from a careful |
| 111 | * analysis of the state functions, but in reality just taken from |
| 112 | * thin air in the hopes othat we don't trigger a kernel panic. |
| 113 | */ |
| 114 | #define SCTP_MAX_NUM_COMMANDS 14 |
| 115 | |
| 116 | typedef union { |
| 117 | __s32 i32; |
| 118 | __u32 u32; |
| 119 | __u16 u16; |
| 120 | __u8 u8; |
| 121 | int error; |
Al Viro | dc251b2 | 2006-11-20 17:00:44 -0800 | [diff] [blame] | 122 | __be16 err; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 123 | sctp_state_t state; |
| 124 | sctp_event_timeout_t to; |
Vladislav Yasevich | 19c7e9e | 2005-11-11 16:07:40 -0800 | [diff] [blame] | 125 | unsigned long zero; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 126 | void *ptr; |
| 127 | struct sctp_chunk *chunk; |
| 128 | struct sctp_association *asoc; |
| 129 | struct sctp_transport *transport; |
| 130 | struct sctp_bind_addr *bp; |
| 131 | sctp_init_chunk_t *init; |
| 132 | struct sctp_ulpevent *ulpevent; |
| 133 | struct sctp_packet *packet; |
| 134 | sctp_sackhdr_t *sackh; |
| 135 | } sctp_arg_t; |
| 136 | |
| 137 | /* We are simulating ML type constructors here. |
| 138 | * |
| 139 | * SCTP_ARG_CONSTRUCTOR(NAME, TYPE, ELT) builds a function called |
| 140 | * SCTP_NAME() which takes an argument of type TYPE and returns an |
| 141 | * sctp_arg_t. It does this by inserting the sole argument into the |
| 142 | * ELT union element of a local sctp_arg_t. |
| 143 | * |
| 144 | * E.g., SCTP_ARG_CONSTRUCTOR(I32, __s32, i32) builds SCTP_I32(arg), |
| 145 | * which takes an __s32 and returns a sctp_arg_t containing the |
| 146 | * __s32. So, after foo = SCTP_I32(arg), foo.i32 == arg. |
| 147 | */ |
| 148 | static inline sctp_arg_t SCTP_NULL(void) |
| 149 | { |
| 150 | sctp_arg_t retval; retval.ptr = NULL; return retval; |
| 151 | } |
| 152 | static inline sctp_arg_t SCTP_NOFORCE(void) |
| 153 | { |
Vladislav Yasevich | 19c7e9e | 2005-11-11 16:07:40 -0800 | [diff] [blame] | 154 | sctp_arg_t retval = {.zero = 0UL}; retval.i32 = 0; return retval; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 155 | } |
| 156 | static inline sctp_arg_t SCTP_FORCE(void) |
| 157 | { |
Vladislav Yasevich | 19c7e9e | 2005-11-11 16:07:40 -0800 | [diff] [blame] | 158 | sctp_arg_t retval = {.zero = 0UL}; retval.i32 = 1; return retval; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 159 | } |
| 160 | |
| 161 | #define SCTP_ARG_CONSTRUCTOR(name, type, elt) \ |
| 162 | static inline sctp_arg_t \ |
| 163 | SCTP_## name (type arg) \ |
Vladislav Yasevich | 19c7e9e | 2005-11-11 16:07:40 -0800 | [diff] [blame] | 164 | { sctp_arg_t retval = {.zero = 0UL}; retval.elt = arg; return retval; } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 165 | |
| 166 | SCTP_ARG_CONSTRUCTOR(I32, __s32, i32) |
| 167 | SCTP_ARG_CONSTRUCTOR(U32, __u32, u32) |
| 168 | SCTP_ARG_CONSTRUCTOR(U16, __u16, u16) |
| 169 | SCTP_ARG_CONSTRUCTOR(U8, __u8, u8) |
| 170 | SCTP_ARG_CONSTRUCTOR(ERROR, int, error) |
Al Viro | dc251b2 | 2006-11-20 17:00:44 -0800 | [diff] [blame] | 171 | SCTP_ARG_CONSTRUCTOR(PERR, __be16, err) /* protocol error */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 172 | SCTP_ARG_CONSTRUCTOR(STATE, sctp_state_t, state) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 173 | SCTP_ARG_CONSTRUCTOR(TO, sctp_event_timeout_t, to) |
| 174 | SCTP_ARG_CONSTRUCTOR(PTR, void *, ptr) |
| 175 | SCTP_ARG_CONSTRUCTOR(CHUNK, struct sctp_chunk *, chunk) |
| 176 | SCTP_ARG_CONSTRUCTOR(ASOC, struct sctp_association *, asoc) |
| 177 | SCTP_ARG_CONSTRUCTOR(TRANSPORT, struct sctp_transport *, transport) |
| 178 | SCTP_ARG_CONSTRUCTOR(BA, struct sctp_bind_addr *, bp) |
| 179 | SCTP_ARG_CONSTRUCTOR(PEER_INIT, sctp_init_chunk_t *, init) |
| 180 | SCTP_ARG_CONSTRUCTOR(ULPEVENT, struct sctp_ulpevent *, ulpevent) |
| 181 | SCTP_ARG_CONSTRUCTOR(PACKET, struct sctp_packet *, packet) |
| 182 | SCTP_ARG_CONSTRUCTOR(SACKH, sctp_sackhdr_t *, sackh) |
| 183 | |
| 184 | typedef struct { |
| 185 | sctp_arg_t obj; |
| 186 | sctp_verb_t verb; |
| 187 | } sctp_cmd_t; |
| 188 | |
| 189 | typedef struct { |
| 190 | sctp_cmd_t cmds[SCTP_MAX_NUM_COMMANDS]; |
| 191 | __u8 next_free_slot; |
| 192 | __u8 next_cmd; |
| 193 | } sctp_cmd_seq_t; |
| 194 | |
| 195 | |
| 196 | /* Initialize a block of memory as a command sequence. |
| 197 | * Return 0 if the initialization fails. |
| 198 | */ |
| 199 | int sctp_init_cmd_seq(sctp_cmd_seq_t *seq); |
| 200 | |
| 201 | /* Add a command to an sctp_cmd_seq_t. |
| 202 | * Return 0 if the command sequence is full. |
| 203 | * |
| 204 | * Use the SCTP_* constructors defined by SCTP_ARG_CONSTRUCTOR() above |
| 205 | * to wrap data which goes in the obj argument. |
| 206 | */ |
| 207 | int sctp_add_cmd(sctp_cmd_seq_t *seq, sctp_verb_t verb, sctp_arg_t obj); |
| 208 | |
| 209 | /* Return the next command structure in an sctp_cmd_seq. |
| 210 | * Return NULL at the end of the sequence. |
| 211 | */ |
| 212 | sctp_cmd_t *sctp_next_cmd(sctp_cmd_seq_t *seq); |
| 213 | |
| 214 | #endif /* __net_sctp_command_h__ */ |
| 215 | |