Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 1 | :: # Copyright 2013, Big Switch Networks, Inc. |
| 2 | :: # |
| 3 | :: # LoxiGen is licensed under the Eclipse Public License, version 1.0 (EPL), with |
| 4 | :: # the following special exception: |
| 5 | :: # |
| 6 | :: # LOXI Exception |
| 7 | :: # |
| 8 | :: # As a special exception to the terms of the EPL, you may distribute libraries |
| 9 | :: # generated by LoxiGen (LoxiGen Libraries) under the terms of your choice, provided |
| 10 | :: # that copyright and licensing notices generated by LoxiGen are not altered or removed |
| 11 | :: # from the LoxiGen Libraries and the notice provided below is (i) included in |
| 12 | :: # the LoxiGen Libraries, if distributed in source code form and (ii) included in any |
| 13 | :: # documentation for the LoxiGen Libraries, if distributed in binary form. |
| 14 | :: # |
| 15 | :: # Notice: "Copyright 2013, Big Switch Networks, Inc. This library was generated by the LoxiGen Compiler." |
| 16 | :: # |
| 17 | :: # You may not use this file except in compliance with the EPL or LOXI Exception. You may obtain |
| 18 | :: # a copy of the EPL at: |
| 19 | :: # |
| 20 | :: # http://www.eclipse.org/legal/epl-v10.html |
| 21 | :: # |
| 22 | :: # Unless required by applicable law or agreed to in writing, software |
| 23 | :: # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 24 | :: # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 25 | :: # EPL for the specific language governing permissions and limitations |
| 26 | :: # under the EPL. |
| 27 | :: |
Rich Lane | d983aa5 | 2013-06-13 11:48:37 -0700 | [diff] [blame] | 28 | :: include('_copyright.c') |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 29 | |
| 30 | /**************************************************************** |
| 31 | * |
| 32 | * Functions related to mapping wire values to object types |
| 33 | * and lengths |
| 34 | * |
| 35 | ****************************************************************/ |
| 36 | |
| 37 | #include <loci/loci.h> |
| 38 | #include <loci/of_message.h> |
| 39 | |
Rich Lane | ef7b994 | 2013-11-18 16:29:28 -0800 | [diff] [blame] | 40 | #define OF_INSTRUCTION_EXPERIMENTER_ID_OFFSET 4 |
| 41 | #define OF_INSTRUCTION_EXPERIMENTER_SUBTYPE_OFFSET 8 |
| 42 | |
Rich Lane | c0e20ff | 2013-12-15 23:40:31 -0800 | [diff] [blame] | 43 | ${legacy_code} |
| 44 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 45 | /**************************************************************** |
| 46 | * Top level OpenFlow message length functions |
| 47 | ****************************************************************/ |
| 48 | |
| 49 | /** |
| 50 | * Get the length of a message object as reported on the wire |
| 51 | * @param obj The object to check |
| 52 | * @param bytes (out) Where the length is stored |
| 53 | * @returns OF_ERROR_ code |
| 54 | */ |
| 55 | void |
| 56 | of_object_message_wire_length_get(of_object_t *obj, int *bytes) |
| 57 | { |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 58 | LOCI_ASSERT(OF_OBJECT_TO_WBUF(obj) != NULL); |
| 59 | // LOCI_ASSERT(obj is message) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 60 | *bytes = of_message_length_get(OF_OBJECT_TO_MESSAGE(obj)); |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Set the length of a message object as reported on the wire |
| 65 | * @param obj The object to check |
| 66 | * @param bytes The new length of the object |
| 67 | * @returns OF_ERROR_ code |
| 68 | */ |
| 69 | void |
| 70 | of_object_message_wire_length_set(of_object_t *obj, int bytes) |
| 71 | { |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 72 | LOCI_ASSERT(OF_OBJECT_TO_WBUF(obj) != NULL); |
| 73 | // LOCI_ASSERT(obj is message) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 74 | of_message_length_set(OF_OBJECT_TO_MESSAGE(obj), bytes); |
| 75 | } |
| 76 | |
| 77 | /**************************************************************** |
| 78 | * TLV16 type/length functions |
| 79 | ****************************************************************/ |
| 80 | |
| 81 | /** |
| 82 | * Many objects are TLVs and use uint16 for the type and length values |
| 83 | * stored on the wire at the beginning of the buffer. |
| 84 | */ |
| 85 | #define TLV16_WIRE_TYPE_OFFSET 0 |
| 86 | #define TLV16_WIRE_LENGTH_OFFSET 2 |
| 87 | |
| 88 | /** |
| 89 | * Get the length field from the wire for a standard TLV |
| 90 | * object that uses uint16 for both type and length. |
| 91 | * @param obj The object being referenced |
| 92 | * @param bytes (out) Where to store the length |
| 93 | */ |
| 94 | |
| 95 | void |
| 96 | of_tlv16_wire_length_get(of_object_t *obj, int *bytes) |
| 97 | { |
| 98 | uint16_t val16; |
| 99 | of_wire_buffer_t *wbuf = OF_OBJECT_TO_WBUF(obj); |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 100 | LOCI_ASSERT(wbuf != NULL); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 101 | |
| 102 | of_wire_buffer_u16_get(wbuf, |
| 103 | OF_OBJECT_ABSOLUTE_OFFSET(obj, TLV16_WIRE_LENGTH_OFFSET), &val16); |
| 104 | *bytes = val16; |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Set the length field in the wire buffer for a standard TLV |
| 109 | * object that uses uint16 for both type and length. |
| 110 | * @param obj The object being referenced |
| 111 | * @param bytes The length value to use |
| 112 | */ |
| 113 | |
| 114 | void |
| 115 | of_tlv16_wire_length_set(of_object_t *obj, int bytes) |
| 116 | { |
| 117 | of_wire_buffer_t *wbuf = OF_OBJECT_TO_WBUF(obj); |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 118 | LOCI_ASSERT(wbuf != NULL); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 119 | |
| 120 | of_wire_buffer_u16_set(wbuf, |
| 121 | OF_OBJECT_ABSOLUTE_OFFSET(obj, TLV16_WIRE_LENGTH_OFFSET), bytes); |
| 122 | } |
| 123 | |
| 124 | /** |
| 125 | * Get the type field from the wire for a standard TLV object that uses |
| 126 | * uint16 for both type and length. |
| 127 | * @param obj The object being referenced |
| 128 | * @param wire_type (out) Where to store the type |
| 129 | */ |
| 130 | |
| 131 | static void |
| 132 | of_tlv16_wire_type_get(of_object_t *obj, int *wire_type) |
| 133 | { |
| 134 | uint16_t val16; |
| 135 | of_wire_buffer_t *wbuf = OF_OBJECT_TO_WBUF(obj); |
| 136 | |
| 137 | of_wire_buffer_u16_get(wbuf, OF_OBJECT_ABSOLUTE_OFFSET(obj, |
| 138 | TLV16_WIRE_TYPE_OFFSET), &val16); |
| 139 | |
| 140 | *wire_type = val16; |
| 141 | } |
| 142 | |
| 143 | /** |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 144 | * Get the object ID of an extended action |
| 145 | * @param obj The object being referenced |
| 146 | * @param id Where to store the object ID |
| 147 | * @fixme: This should be auto generated |
| 148 | * |
| 149 | * If unable to map to known extension, set id to generic "experimenter" |
| 150 | */ |
| 151 | |
| 152 | #define OF_ACTION_EXPERIMENTER_ID_OFFSET 4 |
| 153 | #define OF_ACTION_EXPERIMENTER_SUBTYPE_OFFSET 8 |
| 154 | |
| 155 | |
| 156 | static void |
| 157 | extension_action_object_id_get(of_object_t *obj, of_object_id_t *id) |
| 158 | { |
| 159 | uint32_t exp_id; |
| 160 | uint8_t *buf; |
| 161 | |
| 162 | *id = OF_ACTION_EXPERIMENTER; |
| 163 | |
| 164 | buf = OF_OBJECT_BUFFER_INDEX(obj, 0); |
| 165 | |
| 166 | buf_u32_get(buf + OF_ACTION_EXPERIMENTER_ID_OFFSET, &exp_id); |
| 167 | |
| 168 | switch (exp_id) { |
| 169 | case OF_EXPERIMENTER_ID_BSN: { |
| 170 | uint32_t subtype; |
| 171 | buf_u32_get(buf + OF_ACTION_EXPERIMENTER_SUBTYPE_OFFSET, &subtype); |
| 172 | switch (subtype) { |
| 173 | case 1: *id = OF_ACTION_BSN_MIRROR; break; |
| 174 | case 2: *id = OF_ACTION_BSN_SET_TUNNEL_DST; break; |
| 175 | } |
| 176 | break; |
| 177 | } |
| 178 | case OF_EXPERIMENTER_ID_NICIRA: { |
| 179 | uint16_t subtype; |
| 180 | buf_u16_get(buf + OF_ACTION_EXPERIMENTER_SUBTYPE_OFFSET, &subtype); |
| 181 | switch (subtype) { |
| 182 | case 18: *id = OF_ACTION_NICIRA_DEC_TTL; break; |
| 183 | } |
| 184 | break; |
| 185 | } |
| 186 | } |
| 187 | } |
| 188 | |
| 189 | /** |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 190 | * Get the object ID of an extended action |
| 191 | * @param obj The object being referenced |
| 192 | * @param id Where to store the object ID |
| 193 | * @fixme: This should be auto generated |
| 194 | * |
| 195 | * If unable to map to known extension, set id to generic "experimenter" |
| 196 | */ |
| 197 | |
| 198 | static void |
| 199 | extension_action_id_object_id_get(of_object_t *obj, of_object_id_t *id) |
| 200 | { |
| 201 | uint32_t exp_id; |
| 202 | uint8_t *buf; |
| 203 | |
| 204 | *id = OF_ACTION_ID_EXPERIMENTER; |
| 205 | |
| 206 | buf = OF_OBJECT_BUFFER_INDEX(obj, 0); |
| 207 | |
| 208 | buf_u32_get(buf + OF_ACTION_EXPERIMENTER_ID_OFFSET, &exp_id); |
| 209 | |
| 210 | switch (exp_id) { |
| 211 | case OF_EXPERIMENTER_ID_BSN: { |
| 212 | uint32_t subtype; |
| 213 | buf_u32_get(buf + OF_ACTION_EXPERIMENTER_SUBTYPE_OFFSET, &subtype); |
| 214 | switch (subtype) { |
| 215 | case 1: *id = OF_ACTION_ID_BSN_MIRROR; break; |
| 216 | case 2: *id = OF_ACTION_ID_BSN_SET_TUNNEL_DST; break; |
| 217 | } |
| 218 | break; |
| 219 | } |
| 220 | case OF_EXPERIMENTER_ID_NICIRA: { |
| 221 | uint16_t subtype; |
| 222 | buf_u16_get(buf + OF_ACTION_EXPERIMENTER_SUBTYPE_OFFSET, &subtype); |
| 223 | switch (subtype) { |
| 224 | case 18: *id = OF_ACTION_ID_NICIRA_DEC_TTL; break; |
| 225 | } |
| 226 | break; |
| 227 | } |
| 228 | } |
| 229 | } |
| 230 | |
| 231 | |
| 232 | /** |
| 233 | * Get the object ID based on the wire buffer for an action object |
| 234 | * @param obj The object being referenced |
| 235 | * @param id Where to store the object ID |
| 236 | */ |
| 237 | |
| 238 | |
| 239 | void |
| 240 | of_action_wire_object_id_get(of_object_t *obj, of_object_id_t *id) |
| 241 | { |
| 242 | int wire_type; |
| 243 | |
| 244 | of_tlv16_wire_type_get(obj, &wire_type); |
| 245 | if (wire_type == OF_EXPERIMENTER_TYPE) { |
| 246 | extension_action_object_id_get(obj, id); |
| 247 | return; |
| 248 | } |
| 249 | |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 250 | LOCI_ASSERT(wire_type >= 0 && wire_type < OF_ACTION_ITEM_COUNT); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 251 | |
| 252 | *id = of_action_type_to_id[obj->version][wire_type]; |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 253 | LOCI_ASSERT(*id != OF_OBJECT_INVALID); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 254 | } |
| 255 | |
| 256 | /** |
| 257 | * Get the object ID based on the wire buffer for an action ID object |
| 258 | * @param obj The object being referenced |
| 259 | * @param id Where to store the object ID |
| 260 | */ |
| 261 | |
| 262 | |
| 263 | void |
| 264 | of_action_id_wire_object_id_get(of_object_t *obj, of_object_id_t *id) |
| 265 | { |
| 266 | int wire_type; |
| 267 | |
| 268 | of_tlv16_wire_type_get(obj, &wire_type); |
| 269 | if (wire_type == OF_EXPERIMENTER_TYPE) { |
| 270 | extension_action_id_object_id_get(obj, id); |
| 271 | return; |
| 272 | } |
| 273 | |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 274 | LOCI_ASSERT(wire_type >= 0 && wire_type < OF_ACTION_ID_ITEM_COUNT); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 275 | |
| 276 | *id = of_action_id_type_to_id[obj->version][wire_type]; |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 277 | LOCI_ASSERT(*id != OF_OBJECT_INVALID); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 278 | } |
| 279 | |
| 280 | /** |
| 281 | * @fixme to do when we have instruction extensions |
| 282 | * See extension_action above |
| 283 | */ |
| 284 | |
| 285 | static int |
| 286 | extension_instruction_object_id_get(of_object_t *obj, of_object_id_t *id) |
| 287 | { |
Rich Lane | ef7b994 | 2013-11-18 16:29:28 -0800 | [diff] [blame] | 288 | uint32_t exp_id; |
| 289 | uint8_t *buf; |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 290 | |
| 291 | *id = OF_INSTRUCTION_EXPERIMENTER; |
| 292 | |
Rich Lane | ef7b994 | 2013-11-18 16:29:28 -0800 | [diff] [blame] | 293 | buf = OF_OBJECT_BUFFER_INDEX(obj, 0); |
| 294 | |
| 295 | buf_u32_get(buf + OF_INSTRUCTION_EXPERIMENTER_ID_OFFSET, &exp_id); |
| 296 | |
| 297 | switch (exp_id) { |
| 298 | case OF_EXPERIMENTER_ID_BSN: { |
| 299 | uint32_t subtype; |
| 300 | buf_u32_get(buf + OF_INSTRUCTION_EXPERIMENTER_SUBTYPE_OFFSET, &subtype); |
| 301 | switch (subtype) { |
| 302 | case 0: *id = OF_INSTRUCTION_BSN_DISABLE_SRC_MAC_CHECK; break; |
Rich Lane | f41bad3 | 2014-01-13 13:08:51 -0800 | [diff] [blame] | 303 | case 1: *id = OF_INSTRUCTION_BSN_ARP_OFFLOAD; break; |
Rich Lane | e411343 | 2014-02-04 18:00:03 -0800 | [diff] [blame] | 304 | case 2: *id = OF_INSTRUCTION_BSN_DHCP_OFFLOAD; break; |
Rich Lane | 74a983b | 2014-02-13 17:04:19 -0800 | [diff] [blame] | 305 | case 3: *id = OF_INSTRUCTION_BSN_DISABLE_SPLIT_HORIZON_CHECK; break; |
Rich Lane | 86511ba | 2014-02-26 10:14:57 -0800 | [diff] [blame] | 306 | case 4: *id = OF_INSTRUCTION_BSN_PERMIT; break; |
| 307 | case 5: *id = OF_INSTRUCTION_BSN_DENY; break; |
Rich Lane | ef7b994 | 2013-11-18 16:29:28 -0800 | [diff] [blame] | 308 | } |
| 309 | break; |
| 310 | } |
| 311 | } |
| 312 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 313 | return OF_ERROR_NONE; |
| 314 | } |
| 315 | |
| 316 | /** |
| 317 | * Get the object ID based on the wire buffer for an instruction object |
| 318 | * @param obj The object being referenced |
| 319 | * @param id Where to store the object ID |
| 320 | */ |
| 321 | |
| 322 | void |
| 323 | of_instruction_wire_object_id_get(of_object_t *obj, of_object_id_t *id) |
| 324 | { |
| 325 | int wire_type; |
| 326 | |
| 327 | of_tlv16_wire_type_get(obj, &wire_type); |
| 328 | if (wire_type == OF_EXPERIMENTER_TYPE) { |
| 329 | extension_instruction_object_id_get(obj, id); |
| 330 | return; |
| 331 | } |
| 332 | |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 333 | LOCI_ASSERT(wire_type >= 0 && wire_type < OF_INSTRUCTION_ITEM_COUNT); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 334 | |
| 335 | *id = of_instruction_type_to_id[obj->version][wire_type]; |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 336 | LOCI_ASSERT(*id != OF_OBJECT_INVALID); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 337 | } |
| 338 | |
| 339 | |
| 340 | /** |
| 341 | * @fixme to do when we have queue_prop extensions |
| 342 | * See extension_action above |
| 343 | */ |
| 344 | |
| 345 | static void |
| 346 | extension_queue_prop_object_id_get(of_object_t *obj, of_object_id_t *id) |
| 347 | { |
| 348 | (void)obj; |
| 349 | |
| 350 | *id = OF_QUEUE_PROP_EXPERIMENTER; |
| 351 | } |
| 352 | |
| 353 | /** |
| 354 | * Get the object ID based on the wire buffer for an queue_prop object |
| 355 | * @param obj The object being referenced |
| 356 | * @param id Where to store the object ID |
| 357 | */ |
| 358 | |
| 359 | void |
| 360 | of_queue_prop_wire_object_id_get(of_object_t *obj, of_object_id_t *id) |
| 361 | { |
| 362 | int wire_type; |
| 363 | |
| 364 | of_tlv16_wire_type_get(obj, &wire_type); |
| 365 | if (wire_type == OF_EXPERIMENTER_TYPE) { |
| 366 | extension_queue_prop_object_id_get(obj, id); |
| 367 | return; |
| 368 | } |
| 369 | |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 370 | LOCI_ASSERT(wire_type >= 0 && wire_type < OF_QUEUE_PROP_ITEM_COUNT); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 371 | |
| 372 | *id = of_queue_prop_type_to_id[obj->version][wire_type]; |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 373 | LOCI_ASSERT(*id != OF_OBJECT_INVALID); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 374 | } |
| 375 | |
| 376 | |
| 377 | /** |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 378 | * Table feature property object ID determination |
| 379 | * |
| 380 | * @param obj The object being referenced |
| 381 | * @param id Where to store the object ID |
| 382 | */ |
| 383 | |
| 384 | void |
| 385 | of_table_feature_prop_wire_object_id_get(of_object_t *obj, of_object_id_t *id) |
| 386 | { |
| 387 | int wire_type; |
| 388 | |
| 389 | of_tlv16_wire_type_get(obj, &wire_type); |
Jonathan Stout | 0131f13 | 2014-02-14 17:06:19 -0500 | [diff] [blame] | 390 | *id = of_table_feature_prop_to_object_id(wire_type, obj->version); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 391 | } |
| 392 | |
| 393 | /** |
| 394 | * Get the object ID based on the wire buffer for meter_band object |
| 395 | * @param obj The object being referenced |
| 396 | * @param id Where to store the object ID |
| 397 | */ |
| 398 | |
| 399 | void |
| 400 | of_meter_band_wire_object_id_get(of_object_t *obj, of_object_id_t *id) |
| 401 | { |
| 402 | int wire_type; |
| 403 | |
| 404 | of_tlv16_wire_type_get(obj, &wire_type); |
| 405 | if (wire_type == OF_EXPERIMENTER_TYPE) { |
| 406 | *id = OF_METER_BAND_EXPERIMENTER; |
| 407 | return; |
| 408 | } |
| 409 | |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 410 | LOCI_ASSERT(wire_type >= 0 && wire_type < OF_METER_BAND_ITEM_COUNT); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 411 | |
| 412 | *id = of_meter_band_type_to_id[obj->version][wire_type]; |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 413 | LOCI_ASSERT(*id != OF_OBJECT_INVALID); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 414 | } |
| 415 | |
| 416 | /** |
| 417 | * Get the object ID based on the wire buffer for a hello_elem object |
| 418 | * @param obj The object being referenced |
| 419 | * @param id Where to store the object ID |
| 420 | */ |
| 421 | |
| 422 | void |
| 423 | of_hello_elem_wire_object_id_get(of_object_t *obj, of_object_id_t *id) |
| 424 | { |
| 425 | int wire_type; |
| 426 | |
| 427 | of_tlv16_wire_type_get(obj, &wire_type); |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 428 | LOCI_ASSERT(wire_type >= 0 && wire_type < OF_HELLO_ELEM_ITEM_COUNT); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 429 | *id = of_hello_elem_type_to_id[obj->version][wire_type]; |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 430 | LOCI_ASSERT(*id != OF_OBJECT_INVALID); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 431 | } |
| 432 | |
Rich Lane | 713d928 | 2013-12-30 15:21:35 -0800 | [diff] [blame] | 433 | /** |
| 434 | * Get the object ID based on the wire buffer for a bsn_tlv object |
| 435 | * @param obj The object being referenced |
| 436 | * @param id Where to store the object ID |
| 437 | */ |
| 438 | |
| 439 | void |
| 440 | of_bsn_tlv_wire_object_id_get(of_object_t *obj, of_object_id_t *id) |
| 441 | { |
| 442 | int wire_type; |
| 443 | |
| 444 | of_tlv16_wire_type_get(obj, &wire_type); |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 445 | LOCI_ASSERT(wire_type >= 0 && wire_type < OF_BSN_TLV_ITEM_COUNT); |
Rich Lane | 713d928 | 2013-12-30 15:21:35 -0800 | [diff] [blame] | 446 | *id = of_bsn_tlv_type_to_id[obj->version][wire_type]; |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 447 | LOCI_ASSERT(*id != OF_OBJECT_INVALID); |
Rich Lane | 713d928 | 2013-12-30 15:21:35 -0800 | [diff] [blame] | 448 | } |
| 449 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 450 | /**************************************************************** |
| 451 | * OXM type/length functions. |
| 452 | ****************************************************************/ |
| 453 | |
| 454 | /* Where does the OXM type-length header lie in the buffer */ |
| 455 | #define OXM_HDR_OFFSET 0 |
| 456 | |
| 457 | /** |
| 458 | * Get the OXM header (type-length fields) from the wire buffer |
| 459 | * associated with an OXM object |
| 460 | * |
| 461 | * Will return if error; set hdr to the OXM header |
| 462 | */ |
| 463 | |
| 464 | #define _GET_OXM_TYPE_LEN(obj, tl_p, wbuf) do { \ |
| 465 | wbuf = OF_OBJECT_TO_WBUF(obj); \ |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 466 | LOCI_ASSERT(wbuf != NULL); \ |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 467 | of_wire_buffer_u32_get(wbuf, \ |
| 468 | OF_OBJECT_ABSOLUTE_OFFSET(obj, OXM_HDR_OFFSET), (tl_p)); \ |
| 469 | } while (0) |
| 470 | |
| 471 | #define _SET_OXM_TYPE_LEN(obj, tl_p, wbuf) do { \ |
| 472 | wbuf = OF_OBJECT_TO_WBUF(obj); \ |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 473 | LOCI_ASSERT(wbuf != NULL); \ |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 474 | of_wire_buffer_u32_set(wbuf, \ |
| 475 | OF_OBJECT_ABSOLUTE_OFFSET(obj, OXM_HDR_OFFSET), (tl_p)); \ |
| 476 | } while (0) |
| 477 | |
| 478 | /** |
| 479 | * Get the length of an OXM object from the wire buffer |
| 480 | * @param obj The object whose wire buffer is an OXM type |
| 481 | * @param bytes (out) Where length is stored |
| 482 | */ |
| 483 | |
| 484 | void |
| 485 | of_oxm_wire_length_get(of_object_t *obj, int *bytes) |
| 486 | { |
| 487 | uint32_t type_len; |
| 488 | of_wire_buffer_t *wbuf; |
| 489 | |
| 490 | _GET_OXM_TYPE_LEN(obj, &type_len, wbuf); |
| 491 | *bytes = OF_OXM_LENGTH_GET(type_len); |
| 492 | } |
| 493 | |
| 494 | /** |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 495 | * Get the object ID of an OXM object based on the wire buffer type |
| 496 | * @param obj The object whose wire buffer is an OXM type |
| 497 | * @param id (out) Where the ID is stored |
| 498 | */ |
| 499 | |
| 500 | void |
| 501 | of_oxm_wire_object_id_get(of_object_t *obj, of_object_id_t *id) |
| 502 | { |
| 503 | uint32_t type_len; |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 504 | of_wire_buffer_t *wbuf; |
| 505 | |
| 506 | _GET_OXM_TYPE_LEN(obj, &type_len, wbuf); |
Rich Lane | d8d29c9 | 2013-09-24 13:46:42 -0700 | [diff] [blame] | 507 | *id = of_oxm_to_object_id(type_len, obj->version); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 508 | } |
| 509 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 510 | #define OF_U16_LEN_LENGTH_OFFSET 0 |
| 511 | |
| 512 | /** |
| 513 | * Get the wire length for an object with a uint16 length as first member |
| 514 | * @param obj The object being referenced |
| 515 | * @param bytes Pointer to location to store length |
| 516 | */ |
| 517 | void |
| 518 | of_u16_len_wire_length_get(of_object_t *obj, int *bytes) |
| 519 | { |
| 520 | of_wire_buffer_t *wbuf = OF_OBJECT_TO_WBUF(obj); |
| 521 | uint16_t u16; |
| 522 | |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 523 | LOCI_ASSERT(wbuf != NULL); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 524 | |
| 525 | of_wire_buffer_u16_get(wbuf, |
| 526 | OF_OBJECT_ABSOLUTE_OFFSET(obj, OF_U16_LEN_LENGTH_OFFSET), |
| 527 | &u16); |
| 528 | |
| 529 | *bytes = u16; |
| 530 | } |
| 531 | |
| 532 | /** |
| 533 | * Set the wire length for an object with a uint16 length as first member |
| 534 | * @param obj The object being referenced |
| 535 | * @param bytes The length of the object |
| 536 | */ |
| 537 | |
| 538 | void |
| 539 | of_u16_len_wire_length_set(of_object_t *obj, int bytes) |
| 540 | { |
| 541 | of_wire_buffer_t *wbuf = OF_OBJECT_TO_WBUF(obj); |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 542 | LOCI_ASSERT(wbuf != NULL); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 543 | |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 544 | /* LOCI_ASSERT(obj is u16-len entry) */ |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 545 | |
| 546 | of_wire_buffer_u16_set(wbuf, |
| 547 | OF_OBJECT_ABSOLUTE_OFFSET(obj, OF_U16_LEN_LENGTH_OFFSET), |
| 548 | bytes); |
| 549 | } |
| 550 | |
| 551 | |
| 552 | #define OF_PACKET_QUEUE_LENGTH_OFFSET(ver) \ |
| 553 | (((ver) >= OF_VERSION_1_2) ? 8 : 4) |
| 554 | |
| 555 | /** |
| 556 | * Get the wire length for a packet queue object |
| 557 | * @param obj The object being referenced |
| 558 | * @param bytes Pointer to location to store length |
| 559 | * |
| 560 | * The length is a uint16 at the offset indicated above |
| 561 | */ |
| 562 | void |
| 563 | of_packet_queue_wire_length_get(of_object_t *obj, int *bytes) |
| 564 | { |
| 565 | of_wire_buffer_t *wbuf = OF_OBJECT_TO_WBUF(obj); |
| 566 | uint16_t u16; |
| 567 | int offset; |
| 568 | |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 569 | LOCI_ASSERT(wbuf != NULL); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 570 | |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 571 | /* LOCI_ASSERT(obj is packet queue obj) */ |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 572 | offset = OF_PACKET_QUEUE_LENGTH_OFFSET(obj->version); |
| 573 | of_wire_buffer_u16_get(wbuf, OF_OBJECT_ABSOLUTE_OFFSET(obj, offset), |
| 574 | &u16); |
| 575 | |
| 576 | *bytes = u16; |
| 577 | } |
| 578 | |
| 579 | /** |
| 580 | * Set the wire length for a 1.2 packet queue object |
| 581 | * @param obj The object being referenced |
| 582 | * @param bytes The length of the object |
| 583 | * |
| 584 | * The length is a uint16 at the offset indicated above |
| 585 | */ |
| 586 | |
| 587 | void |
| 588 | of_packet_queue_wire_length_set(of_object_t *obj, int bytes) |
| 589 | { |
| 590 | of_wire_buffer_t *wbuf = OF_OBJECT_TO_WBUF(obj); |
| 591 | int offset; |
| 592 | |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 593 | LOCI_ASSERT(wbuf != NULL); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 594 | |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 595 | /* LOCI_ASSERT(obj is packet queue obj) */ |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 596 | offset = OF_PACKET_QUEUE_LENGTH_OFFSET(obj->version); |
| 597 | of_wire_buffer_u16_set(wbuf, OF_OBJECT_ABSOLUTE_OFFSET(obj, offset), |
| 598 | bytes); |
| 599 | } |
| 600 | |
| 601 | /** |
| 602 | * Get the wire length for a meter band stats list |
| 603 | * @param obj The object being referenced |
| 604 | * @param bytes Pointer to location to store length |
| 605 | * |
| 606 | * Must a meter_stats object as a parent |
| 607 | */ |
| 608 | |
| 609 | void |
| 610 | of_list_meter_band_stats_wire_length_get(of_object_t *obj, int *bytes) |
| 611 | { |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 612 | LOCI_ASSERT(obj->parent != NULL); |
| 613 | LOCI_ASSERT(obj->parent->object_id == OF_METER_STATS); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 614 | |
| 615 | /* We're counting on the parent being properly initialized already. |
| 616 | * The length is stored in a uint16 at offset 4 of the parent. |
| 617 | */ |
| 618 | *bytes = obj->parent->length - OF_OBJECT_FIXED_LENGTH(obj->parent); |
| 619 | } |
| 620 | |
| 621 | #define OF_METER_STATS_LENGTH_OFFSET 4 |
| 622 | |
| 623 | /** |
| 624 | * Get/set the wire length for a meter stats object |
| 625 | * @param obj The object being referenced |
| 626 | * @param bytes Pointer to location to store length |
| 627 | * |
| 628 | * It's almost a TLV.... |
| 629 | */ |
| 630 | |
| 631 | void |
| 632 | of_meter_stats_wire_length_get(of_object_t *obj, int *bytes) |
| 633 | { |
| 634 | uint16_t val16; |
| 635 | of_wire_buffer_t *wbuf = OF_OBJECT_TO_WBUF(obj); |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 636 | LOCI_ASSERT(wbuf != NULL); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 637 | of_wire_buffer_u16_get(wbuf, |
| 638 | OF_OBJECT_ABSOLUTE_OFFSET(obj, OF_METER_STATS_LENGTH_OFFSET), |
| 639 | &val16); |
| 640 | *bytes = val16; |
| 641 | } |
| 642 | |
| 643 | void |
| 644 | of_meter_stats_wire_length_set(of_object_t *obj, int bytes) |
| 645 | { |
| 646 | of_wire_buffer_t *wbuf = OF_OBJECT_TO_WBUF(obj); |
Rich Lane | e57f043 | 2014-02-19 10:31:53 -0800 | [diff] [blame] | 647 | LOCI_ASSERT(wbuf != NULL); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 648 | |
| 649 | of_wire_buffer_u16_set(wbuf, |
| 650 | OF_OBJECT_ABSOLUTE_OFFSET(obj, OF_METER_STATS_LENGTH_OFFSET), bytes); |
| 651 | } |
| 652 | |
| 653 | /* |
| 654 | * Non-message extension push wire values |
| 655 | */ |
| 656 | |
| 657 | int |
| 658 | of_extension_object_wire_push(of_object_t *obj) |
| 659 | { |
| 660 | of_action_bsn_mirror_t *action_mirror; |
| 661 | of_action_id_bsn_mirror_t *action_id_mirror; |
| 662 | of_action_bsn_set_tunnel_dst_t *action_set_tunnel_dst; |
| 663 | of_action_id_bsn_set_tunnel_dst_t *action_id_set_tunnel_dst; |
| 664 | of_action_nicira_dec_ttl_t *action_nicira_dec_ttl; |
| 665 | of_action_id_nicira_dec_ttl_t *action_id_nicira_dec_ttl; |
| 666 | |
| 667 | /* Push exp type, subtype */ |
| 668 | switch (obj->object_id) { |
| 669 | case OF_ACTION_BSN_MIRROR: |
| 670 | action_mirror = (of_action_bsn_mirror_t *)obj; |
| 671 | of_action_bsn_mirror_experimenter_set(action_mirror, |
| 672 | OF_EXPERIMENTER_ID_BSN); |
| 673 | of_action_bsn_mirror_subtype_set(action_mirror, 1); |
| 674 | break; |
| 675 | case OF_ACTION_ID_BSN_MIRROR: |
| 676 | action_id_mirror = (of_action_id_bsn_mirror_t *)obj; |
| 677 | of_action_id_bsn_mirror_experimenter_set(action_id_mirror, |
| 678 | OF_EXPERIMENTER_ID_BSN); |
| 679 | of_action_id_bsn_mirror_subtype_set(action_id_mirror, 1); |
| 680 | break; |
| 681 | case OF_ACTION_BSN_SET_TUNNEL_DST: |
| 682 | action_set_tunnel_dst = (of_action_bsn_set_tunnel_dst_t *)obj; |
| 683 | of_action_bsn_set_tunnel_dst_experimenter_set(action_set_tunnel_dst, |
| 684 | OF_EXPERIMENTER_ID_BSN); |
| 685 | of_action_bsn_set_tunnel_dst_subtype_set(action_set_tunnel_dst, 2); |
| 686 | break; |
| 687 | case OF_ACTION_ID_BSN_SET_TUNNEL_DST: |
| 688 | action_id_set_tunnel_dst = (of_action_id_bsn_set_tunnel_dst_t *)obj; |
| 689 | of_action_id_bsn_set_tunnel_dst_experimenter_set(action_id_set_tunnel_dst, |
| 690 | OF_EXPERIMENTER_ID_BSN); |
| 691 | of_action_id_bsn_set_tunnel_dst_subtype_set(action_id_set_tunnel_dst, 2); |
| 692 | break; |
| 693 | case OF_ACTION_NICIRA_DEC_TTL: |
| 694 | action_nicira_dec_ttl = (of_action_nicira_dec_ttl_t *)obj; |
| 695 | of_action_nicira_dec_ttl_experimenter_set(action_nicira_dec_ttl, |
| 696 | OF_EXPERIMENTER_ID_NICIRA); |
| 697 | of_action_nicira_dec_ttl_subtype_set(action_nicira_dec_ttl, 18); |
| 698 | break; |
| 699 | case OF_ACTION_ID_NICIRA_DEC_TTL: |
| 700 | action_id_nicira_dec_ttl = (of_action_id_nicira_dec_ttl_t *)obj; |
| 701 | of_action_id_nicira_dec_ttl_experimenter_set(action_id_nicira_dec_ttl, |
| 702 | OF_EXPERIMENTER_ID_NICIRA); |
| 703 | of_action_id_nicira_dec_ttl_subtype_set(action_id_nicira_dec_ttl, 18); |
| 704 | break; |
| 705 | default: |
| 706 | break; |
| 707 | } |
| 708 | |
| 709 | return OF_ERROR_NONE; |
| 710 | } |
Rich Lane | 353a79f | 2013-11-13 10:39:56 -0800 | [diff] [blame] | 711 | |
| 712 | int |
| 713 | of_experimenter_stats_request_to_object_id(uint32_t experimenter, uint32_t subtype, int ver) |
| 714 | { |
| 715 | switch (experimenter) { |
| 716 | case OF_EXPERIMENTER_ID_BSN: |
| 717 | switch (subtype) { |
| 718 | case 1: return OF_BSN_LACP_STATS_REQUEST; |
Rich Lane | 713d928 | 2013-12-30 15:21:35 -0800 | [diff] [blame] | 719 | case 2: return OF_BSN_GENTABLE_ENTRY_DESC_STATS_REQUEST; |
| 720 | case 3: return OF_BSN_GENTABLE_ENTRY_STATS_REQUEST; |
| 721 | case 4: return OF_BSN_GENTABLE_DESC_STATS_REQUEST; |
| 722 | case 5: return OF_BSN_GENTABLE_BUCKET_STATS_REQUEST; |
Wilson Ng | 45386fb | 2013-12-03 13:46:42 -0800 | [diff] [blame] | 723 | case 6: return OF_BSN_SWITCH_PIPELINE_STATS_REQUEST; |
Rich Lane | 713d928 | 2013-12-30 15:21:35 -0800 | [diff] [blame] | 724 | case 7: return OF_BSN_GENTABLE_STATS_REQUEST; |
xinwu | 54ceaca | 2013-12-04 17:02:27 -0800 | [diff] [blame] | 725 | case 8: return OF_BSN_PORT_COUNTER_STATS_REQUEST; |
| 726 | case 9: return OF_BSN_VLAN_COUNTER_STATS_REQUEST; |
Rich Lane | 013dea0 | 2014-02-05 13:44:13 -0800 | [diff] [blame] | 727 | case 10: return OF_BSN_FLOW_CHECKSUM_BUCKET_STATS_REQUEST; |
| 728 | case 11: return OF_BSN_TABLE_CHECKSUM_STATS_REQUEST; |
Rich Lane | 353a79f | 2013-11-13 10:39:56 -0800 | [diff] [blame] | 729 | } |
| 730 | } |
| 731 | return OF_OBJECT_INVALID; |
| 732 | } |
| 733 | |
| 734 | int |
| 735 | of_experimenter_stats_reply_to_object_id(uint32_t experimenter, uint32_t subtype, int ver) |
| 736 | { |
| 737 | switch (experimenter) { |
| 738 | case OF_EXPERIMENTER_ID_BSN: |
| 739 | switch (subtype) { |
| 740 | case 1: return OF_BSN_LACP_STATS_REPLY; |
Rich Lane | 713d928 | 2013-12-30 15:21:35 -0800 | [diff] [blame] | 741 | case 2: return OF_BSN_GENTABLE_ENTRY_DESC_STATS_REPLY; |
| 742 | case 3: return OF_BSN_GENTABLE_ENTRY_STATS_REPLY; |
| 743 | case 4: return OF_BSN_GENTABLE_DESC_STATS_REPLY; |
| 744 | case 5: return OF_BSN_GENTABLE_BUCKET_STATS_REPLY; |
Wilson Ng | 45386fb | 2013-12-03 13:46:42 -0800 | [diff] [blame] | 745 | case 6: return OF_BSN_SWITCH_PIPELINE_STATS_REPLY; |
Rich Lane | 713d928 | 2013-12-30 15:21:35 -0800 | [diff] [blame] | 746 | case 7: return OF_BSN_GENTABLE_STATS_REPLY; |
xinwu | 54ceaca | 2013-12-04 17:02:27 -0800 | [diff] [blame] | 747 | case 8: return OF_BSN_PORT_COUNTER_STATS_REPLY; |
| 748 | case 9: return OF_BSN_VLAN_COUNTER_STATS_REPLY; |
Rich Lane | 013dea0 | 2014-02-05 13:44:13 -0800 | [diff] [blame] | 749 | case 10: return OF_BSN_FLOW_CHECKSUM_BUCKET_STATS_REPLY; |
| 750 | case 11: return OF_BSN_TABLE_CHECKSUM_STATS_REPLY; |
Rich Lane | 353a79f | 2013-11-13 10:39:56 -0800 | [diff] [blame] | 751 | } |
| 752 | } |
| 753 | return OF_OBJECT_INVALID; |
| 754 | } |