lib/ofp-errors.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef OFP_ERRORS_H
  18 #define OFP_ERRORS_H 1
  19
  20 #include <stdbool.h>
  21 #include <stddef.h>
  22 #include <stdint.h>
  23
  24 struct ds;
  25 struct ofp_header;
  26
  27 /* Error codes.
  28  *
  29  * We embed system errno values and OpenFlow standard and vendor extension
  30  * error codes into the positive range of "int":
  31  *
  32  *   - Errno values are assumed to use the range 1 through 2**30 - 1.
  33  *
  34  *     (C and POSIX say that errno values are positive.  We assume that they
  35  *     are less than 2**29.  They are actually less than 65536 on at least
  36  *     Linux, FreeBSD, OpenBSD, and Windows.)
  37  *
  38  *   - OpenFlow standard and vendor extension error codes use the range
  39  *     starting at 2**30 (OFPERR_OFS).
  40  *
  41  * Zero and negative values are not used.
  42  */
  43
  44 #define OFPERR_OFS (1 << 30)
  45
  46 enum ofperr {
  47 /* Expected duplications. */
  48
  49     /* Expected: 3,5 in OF1.1 means both OFPBIC_BAD_EXPERIMENTER and
  50      * OFPBIC_BAD_EXP_TYPE. */
  51
  52 /* ## ------------------ ## */
  53 /* ## OFPET_HELLO_FAILED ## */
  54 /* ## ------------------ ## */
  55
  56     /* OF1.0+(0).  Hello protocol failed. */
  57     OFPERR_OFPET_HELLO_FAILED = OFPERR_OFS,
  58
  59     /* OF1.0+(0,0).  No compatible version. */
  60     OFPERR_OFPHFC_INCOMPATIBLE,
  61
  62     /* OF1.0+(0,1).  Permissions error. */
  63     OFPERR_OFPHFC_EPERM,
  64
  65 /* ## ----------------- ## */
  66 /* ## OFPET_BAD_REQUEST ## */
  67 /* ## ----------------- ## */
  68
  69     /* OF1.0+(1).  Request was not understood. */
  70     OFPERR_OFPET_BAD_REQUEST,
  71
  72     /* OF1.0+(1,0).  ofp_header.version not supported. */
  73     OFPERR_OFPBRC_BAD_VERSION,
  74
  75     /* OF1.0+(1,1).  ofp_header.type not supported. */
  76     OFPERR_OFPBRC_BAD_TYPE,
  77
  78     /* OF1.0+(1,2).  ofp_stats_msg.type not supported. */
  79     OFPERR_OFPBRC_BAD_STAT,
  80
  81     /* OF1.0+(1,3).  Vendor not supported (in ofp_vendor_header or
  82      * ofp_stats_msg). */
  83     OFPERR_OFPBRC_BAD_VENDOR,
  84
  85     /* OF1.0+(1,4).  Vendor subtype not supported. */
  86     OFPERR_OFPBRC_BAD_SUBTYPE,
  87
  88     /* OF1.0+(1,5).  Permissions error. */
  89     OFPERR_OFPBRC_EPERM,
  90
  91     /* OF1.0+(1,6).  Wrong request length for type. */
  92     OFPERR_OFPBRC_BAD_LEN,
  93
  94     /* OF1.0+(1,7).  Specified buffer has already been used. */
  95     OFPERR_OFPBRC_BUFFER_EMPTY,
  96
  97     /* OF1.0+(1,8).  Specified buffer does not exist. */
  98     OFPERR_OFPBRC_BUFFER_UNKNOWN,
  99
 100     /* OF1.1+(1,9).  Specified table-id invalid or does not exist. */
 101     OFPERR_OFPBRC_BAD_TABLE_ID,
 102
 103     /* OF1.2+(1,10).  Denied because controller is slave. */
 104     OFPERR_OFPBRC_IS_SLAVE,
 105
 106     /* OF1.2+(1,11).  Invalid port. */
 107     OFPERR_OFPBRC_BAD_PORT,
 108
 109     /* OF1.2+(1,12).  Invalid packet in packet-out. */
 110     OFPERR_OFPBRC_BAD_PACKET,
 111
 112     /* NX1.0+(1,256).  Invalid NXM flow match. */
 113     OFPERR_NXBRC_NXM_INVALID,
 114
 115     /* NX1.0+(1,257).  The nxm_type, or nxm_type taken in combination with
 116      * nxm_hasmask or nxm_length or both, is invalid or not implemented. */
 117     OFPERR_NXBRC_NXM_BAD_TYPE,
 118
 119     /* NX1.0+(1,512).  A request specified a nonexistent table ID. */
 120     OFPERR_NXBRC_BAD_TABLE_ID,
 121
 122     /* NX1.0+(1,514).  The in_port in an ofp_packet_out request is invalid. */
 123     OFPERR_NXBRC_BAD_IN_PORT,
 124
 125     /* NX1.0+(1,515).  Must-be-zero field had nonzero value. */
 126     OFPERR_NXBRC_MUST_BE_ZERO,
 127
 128     /* NX1.0+(1,516).  The reason in an ofp_port_status message is not
 129      * valid. */
 130     OFPERR_NXBRC_BAD_REASON,
 131
 132 /* ## ---------------- ## */
 133 /* ## OFPET_BAD_ACTION ## */
 134 /* ## ---------------- ## */
 135
 136     /* OF1.0+(2).  Error in action description. */
 137     OFPERR_OFPET_BAD_ACTION,
 138
 139     /* OF1.0+(2,0).  Unknown action type. */
 140     OFPERR_OFPBAC_BAD_TYPE,
 141
 142     /* OF1.0+(2,1).  Length problem in actions. */
 143     OFPERR_OFPBAC_BAD_LEN,
 144
 145     /* OF1.0+(2,2).  Unknown experimenter id specified. */
 146     OFPERR_OFPBAC_BAD_VENDOR,
 147
 148     /* OF1.0+(2,3).  Unknown action type for experimenter id. */
 149     OFPERR_OFPBAC_BAD_VENDOR_TYPE,
 150
 151     /* OF1.0+(2,4).  Problem validating output port. */
 152     OFPERR_OFPBAC_BAD_OUT_PORT,
 153
 154     /* OF1.0+(2,5).  Bad action argument. */
 155     OFPERR_OFPBAC_BAD_ARGUMENT,
 156
 157     /* OF1.0+(2,6).  Permissions error. */
 158     OFPERR_OFPBAC_EPERM,
 159
 160     /* OF1.0+(2,7).  Can't handle this many actions. */
 161     OFPERR_OFPBAC_TOO_MANY,
 162
 163     /* OF1.0+(2,8).  Problem validating output queue. */
 164     OFPERR_OFPBAC_BAD_QUEUE,
 165
 166     /* OF1.1+(2,9).  Invalid group id in forward action. */
 167     OFPERR_OFPBAC_BAD_OUT_GROUP,
 168
 169     /* OF1.1+(2,10).  Action can't apply for this match. */
 170     OFPERR_OFPBAC_MATCH_INCONSISTENT,
 171
 172     /* OF1.1+(2,11).  Action order is unsupported for the action list in an
 173      * Apply-Actions instruction */
 174     OFPERR_OFPBAC_UNSUPPORTED_ORDER,
 175
 176     /* OF1.1+(2,12).  Actions uses an unsupported tag/encap. */
 177     OFPERR_OFPBAC_BAD_TAG,
 178
 179     /* OF1.2+(2,13).  Unsupported type in SET_FIELD action. */
 180     OFPERR_OFPBAC_SET_TYPE,
 181
 182     /* OF1.2+(2,14).  Length problem in SET_FIELD action. */
 183     OFPERR_OFPBAC_SET_LEN,
 184
 185     /* OF1.2+(2,15).  Bad argument in SET_FIELD action. */
 186     OFPERR_OFPBAC_ARGUMENT,
 187
 188     /* NX1.0+(2,256).  Must-be-zero action argument had nonzero value. */
 189     OFPERR_NXBAC_MUST_BE_ZERO,
 190
 191 /* ## --------------------- ## */
 192 /* ## OFPET_BAD_INSTRUCTION ## */
 193 /* ## --------------------- ## */
 194
 195     /* OF1.1+(3).  Error in instruction list. */
 196     OFPERR_OFPIT_BAD_INSTRUCTION,
 197
 198     /* OF1.1+(3,0).  Unknown instruction. */
 199     OFPERR_OFPBIC_UNKNOWN_INST,
 200
 201     /* OF1.1+(3,1).  Switch or table does not support the instruction. */
 202     OFPERR_OFPBIC_UNSUP_INST,
 203
 204     /* OF1.1+(3,2).  Invalid Table-ID specified. */
 205     OFPERR_OFPBIC_BAD_TABLE_ID,
 206
 207     /* OF1.1+(3,3).  Metadata value unsupported by datapath. */
 208     OFPERR_OFPBIC_UNSUP_METADATA,
 209
 210     /* OF1.1+(3,4).  Metadata mask value unsupported by datapath. */
 211     OFPERR_OFPBIC_UNSUP_METADATA_MASK,
 212
 213     /* OF1.1+(3,5).  Unknown experimenter id specified. */
 214     OFPERR_OFPBIC_BAD_EXPERIMENTER,
 215
 216     /* OF1.1(3,5), OF1.2+(3,6).  Unknown instruction for experimenter id. */
 217     OFPERR_OFPBIC_BAD_EXP_TYPE,
 218
 219     /* OF1.2+(3,7).  Length problem in instructions. */
 220     OFPERR_OFPBIC_BAD_LEN,
 221
 222     /* OF1.2+(3,8).  Permissions error. */
 223     OFPERR_OFPBIC_EPERM,
 224
 225     /* NX1.1+(3,256).  Duplicate instruction type in set of instructions. */
 226     OFPERR_NXBIC_DUP_TYPE,
 227
 228 /* ## --------------- ## */
 229 /* ## OFPET_BAD_MATCH ## */
 230 /* ## --------------- ## */
 231
 232     /* OF1.1+(4).  Error in match. */
 233     OFPERR_OFPET_BAD_MATCH,
 234
 235     /* OF1.1+(4,0).  Unsupported match type specified by the match */
 236     OFPERR_OFPBMC_BAD_TYPE,
 237
 238     /* OF1.1+(4,1).  Length problem in match. */
 239     OFPERR_OFPBMC_BAD_LEN,
 240
 241     /* OF1.1+(4,2).  Match uses an unsupported tag/encap. */
 242     OFPERR_OFPBMC_BAD_TAG,
 243
 244     /* OF1.1+(4,3).  Unsupported datalink addr mask - switch does not support
 245      * arbitrary datalink address mask. */
 246     OFPERR_OFPBMC_BAD_DL_ADDR_MASK,
 247
 248     /* OF1.1+(4,4).  Unsupported network addr mask - switch does not support
 249      * arbitrary network address mask. */
 250     OFPERR_OFPBMC_BAD_NW_ADDR_MASK,
 251
 252     /* OF1.1+(4,5).  Unsupported wildcard specified in the match. */
 253     OFPERR_OFPBMC_BAD_WILDCARDS,
 254
 255     /* OF1.1+(4,6).  Unsupported field in the match. */
 256     OFPERR_OFPBMC_BAD_FIELD,
 257
 258     /* NX1.0(1,258), NX1.1(1,258), OF1.2+(4,7).  Unsupported value in a match
 259      * field. */
 260     OFPERR_OFPBMC_BAD_VALUE,
 261
 262     /* NX1.0(1,259), NX1.1(1,259), OF1.2+(4,8).  Unsupported mask specified in
 263      * the match, field is not dl-address or nw-address. */
 264     OFPERR_OFPBMC_BAD_MASK,
 265
 266     /* NX1.0(1,260), NX1.1(1,260), OF1.2+(4,9).  A prerequisite was not met. */
 267     OFPERR_OFPBMC_BAD_PREREQ,
 268
 269     /* NX1.0(1,261), NX1.1(1,261), OF1.2+(4,10).  A field type was
 270      * duplicated. */
 271     OFPERR_OFPBMC_DUP_FIELD,
 272
 273     /* OF1.2+(4,11).  Permissions error. */
 274     OFPERR_OFPBMC_EPERM,
 275
 276 /* ## --------------------- ## */
 277 /* ## OFPET_FLOW_MOD_FAILED ## */
 278 /* ## --------------------- ## */
 279
 280     /* OF1.0(3), OF1.1+(5).  Problem modifying flow entry. */
 281     OFPERR_OFPET_FLOW_MOD_FAILED,
 282
 283     /* OF1.1+(5,0).  Unspecified error. */
 284     OFPERR_OFPFMFC_UNKNOWN,
 285
 286     /* OF1.0(3,0).  Flow not added because of full tables. */
 287     OFPERR_OFPFMFC_ALL_TABLES_FULL,
 288
 289     /* OF1.1+(5,1).  Flow not added because table was full. */
 290     OFPERR_OFPFMFC_TABLE_FULL,
 291
 292     /* OF1.1+(5,2).  Table does not exist */
 293     OFPERR_OFPFMFC_BAD_TABLE_ID,
 294
 295     /* OF1.0(3,1), OF1.1+(5,3).  Attempted to add overlapping flow with
 296      * CHECK_OVERLAP flag set. */
 297     OFPERR_OFPFMFC_OVERLAP,
 298
 299     /* OF1.0(3,2), OF1.1+(5,4).  Permissions error. */
 300     OFPERR_OFPFMFC_EPERM,
 301
 302     /* OF1.1+(5,5).  Flow not added because of unsupported idle/hard
 303      * timeout. */
 304     OFPERR_OFPFMFC_BAD_TIMEOUT,
 305
 306     /* OF1.0(3,3).  Flow not added because of non-zero idle/hard timeout. */
 307     OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT,
 308
 309     /* OF1.0(3,4), OF1.1+(5,6).  Unsupported or unknown command. */
 310     OFPERR_OFPFMFC_BAD_COMMAND,
 311
 312     /* OF1.2+(5,7).  Unsupported or unknown flags. */
 313     OFPERR_OFPFMFC_BAD_FLAGS,
 314
 315     /* OF1.0(3,5).  Unsupported action list - cannot process in the order
 316      * specified. */
 317     OFPERR_OFPFMFC_UNSUPPORTED,
 318
 319     /* NX1.0(3,256), NX1.1(5,256).  Generic hardware error. */
 320     OFPERR_NXFMFC_HARDWARE,
 321
 322     /* NX1.0(3,257), NX1.1(5,257).  A nonexistent table ID was specified in the
 323      * "command" field of struct ofp_flow_mod, when the nxt_flow_mod_table_id
 324      * extension is enabled. */
 325     OFPERR_NXFMFC_BAD_TABLE_ID,
 326
 327 /* ## ---------------------- ## */
 328 /* ## OFPET_GROUP_MOD_FAILED ## */
 329 /* ## ---------------------- ## */
 330
 331     /* OF1.1+(6).  Problem modifying group entry. */
 332     OFPERR_OFPET_GROUP_MOD_FAILED,
 333
 334     /* OF1.1+(6,0).  Group not added because a group ADD attempted to replace
 335      * an already-present group. */
 336     OFPERR_OFPGMFC_GROUP_EXISTS,
 337
 338     /* OF1.1+(6,1).  Group not added because Group specified is invalid. */
 339     OFPERR_OFPGMFC_INVALID_GROUP,
 340
 341     /* OF1.1+(6,2).  Switch does not support unequal load sharing with select
 342      * groups. */
 343     OFPERR_OFPGMFC_WEIGHT_UNSUPPORTED,
 344
 345     /* OF1.1+(6,3).  The group table is full. */
 346     OFPERR_OFPGMFC_OUT_OF_GROUPS,
 347
 348     /* OF1.1+(6,4).  The maximum number of action buckets for a group has been
 349      * exceeded. */
 350     OFPERR_OFPGMFC_OUT_OF_BUCKETS,
 351
 352     /* OF1.1+(6,5).  Switch does not support groups that forward to groups. */
 353     OFPERR_OFPGMFC_CHAINING_UNSUPPORTED,
 354
 355     /* OF1.1+(6,6).  This group cannot watch the watch_port or watch_group
 356      * specified. */
 357     OFPERR_OFPGMFC_WATCH_UNSUPPORTED,
 358
 359     /* OF1.1+(6,7).  Group entry would cause a loop. */
 360     OFPERR_OFPGMFC_LOOP,
 361
 362     /* OF1.1+(6,8).  Group not modified because a group MODIFY attempted to
 363      * modify a non-existent group. */
 364     OFPERR_OFPGMFC_UNKNOWN_GROUP,
 365
 366     /* OF1.2+(6,9).  Group not deleted because another
 367                     group is forwarding to it. */
 368     OFPERR_OFPGMFC_CHAINED_GROUP,
 369
 370     /* OF1.2+(6,10).  Unsupported or unknown group type. */
 371     OFPERR_OFPGMFC_BAD_TYPE,
 372
 373     /* OF1.2+(6,11).  Unsupported or unknown command. */
 374     OFPERR_OFPGMFC_BAD_COMMAND,
 375
 376     /* OF1.2+(6,12).  Error in bucket. */
 377     OFPERR_OFPGMFC_OFPGMFC_BAD_BUCKET,
 378
 379     /* OF1.2+(6,13).  Error in watch port/group. */
 380     OFPERR_OFPGMFC_OFPGMFC_BAD_WATCH,
 381
 382     /* OF1.2+(6,14).  Permissions error. */
 383     OFPERR_OFPGMFC_OFPGMFC_EPERM,
 384
 385 /* ## --------------------- ## */
 386 /* ## OFPET_PORT_MOD_FAILED ## */
 387 /* ## --------------------- ## */
 388
 389     /* OF1.0(4), OF1.1+(7).  OFPT_PORT_MOD failed. */
 390     OFPERR_OFPET_PORT_MOD_FAILED,
 391
 392     /* OF1.0(4,0), OF1.1+(7,0).  Specified port does not exist. */
 393     OFPERR_OFPPMFC_BAD_PORT,
 394
 395     /* OF1.0(4,1), OF1.1+(7,1).  Specified hardware address does not match the
 396      * port number. */
 397     OFPERR_OFPPMFC_BAD_HW_ADDR,
 398
 399     /* OF1.1+(7,2).  Specified config is invalid. */
 400     OFPERR_OFPPMFC_BAD_CONFIG,
 401
 402     /* OF1.1+(7,3).  Specified advertise is invalid. */
 403     OFPERR_OFPPMFC_BAD_ADVERTISE,
 404
 405     /* OF1.2+(7,4).  Permissions error. */
 406     OFPERR_OFPPMFC_EPERM,
 407
 408 /* ## ---------------------- ## */
 409 /* ## OFPET_TABLE_MOD_FAILED ## */
 410 /* ## ---------------------- ## */
 411
 412     /* OF1.1+(8).  Table mod request failed. */
 413     OFPERR_OFPET_TABLE_MOD_FAILED,
 414
 415     /* OF1.1+(8,0).  Specified table does not exist. */
 416     OFPERR_OFPTMFC_BAD_TABLE,
 417
 418     /* OF1.1+(8,1).  Specified config is invalid. */
 419     OFPERR_OFPTMFC_BAD_CONFIG,
 420
 421     /* OF1.2+(8,2).  Permissions error. */
 422     OFPERR_OFPTMFC_EPERM,
 423
 424 /* ## --------------------- ## */
 425 /* ## OFPET_QUEUE_OP_FAILED ## */
 426 /* ## --------------------- ## */
 427
 428     /* OF1.0(5), OF1.1+(9).  Queue operation failed. */
 429     OFPERR_OFPET_QUEUE_OP_FAILED,
 430
 431     /* OF1.0(5,0), OF1.1+(9,0).  Invalid port (or port does not exist). */
 432     OFPERR_OFPQOFC_BAD_PORT,
 433
 434     /* OF1.0(5,1), OF1.1+(9,1).  Queue does not exist. */
 435     OFPERR_OFPQOFC_BAD_QUEUE,
 436
 437     /* OF1.0(5,2), OF1.1+(9,2).  Permissions error. */
 438     OFPERR_OFPQOFC_EPERM,
 439
 440 /* ## -------------------------- ## */
 441 /* ## OFPET_SWITCH_CONFIG_FAILED ## */
 442 /* ## -------------------------- ## */
 443
 444     /* OF1.1+(10).  Switch config request failed. */
 445     OFPERR_OFPET_SWITCH_CONFIG_FAILED,
 446
 447     /* OF1.1+(10,0).  Specified flags is invalid. */
 448     OFPERR_OFPSCFC_BAD_FLAGS,
 449
 450     /* OF1.1+(10,1).  Specified len is invalid. */
 451     OFPERR_OFPSCFC_BAD_LEN,
 452
 453     /* OF1.2+(10,2).  Permissions error. */
 454     OFPERR_OFPSCFC_EPERM,
 455
 456 /* ## ------------------------- ## */
 457 /* ## OFPET_ROLE_REQUEST_FAILED ## */
 458 /* ## ------------------------- ## */
 459
 460     /* OF1.2+(11).  Controller Role request failed. */
 461     OFPERR_OFPET_ROLE_REQUEST_FAILED,
 462
 463     /* OF1.2+(11,0).  Stale Message: old generation_id. */
 464     OFPERR_OFPRRFC_STALE,
 465
 466     /* OF1.2+(11,1).  Controller role change unsupported. */
 467     OFPERR_OFPRRFC_UNSUP,
 468
 469     /* NX1.0(1,513), NX1.1(1,513), OF1.2+(11,2).  Invalid role. */
 470     OFPERR_OFPRRFC_BAD_ROLE,
 471
 472
 473 /* ## ------------------ ## */
 474 /* ## OFPET_EXPERIMENTER ## */
 475 /* ## ------------------ ## */
 476
 477     /* OF1.2+(0xffff).  Experimenter error messages. */
 478     OFPERR_OFPET_EXPERIMENTER,
 479 };
 480
 481 extern const struct ofperr_domain ofperr_of10;
 482 extern const struct ofperr_domain ofperr_of11;
 483 extern const struct ofperr_domain ofperr_of12;
 484
 485 const struct ofperr_domain *ofperr_domain_from_version(uint8_t version);
 486 const char *ofperr_domain_get_name(const struct ofperr_domain *);
 487
 488 bool ofperr_is_valid(enum ofperr);
 489 bool ofperr_is_category(enum ofperr);
 490 bool ofperr_is_nx_extension(enum ofperr);
 491 bool ofperr_is_encodable(enum ofperr, const struct ofperr_domain *);
 492
 493 enum ofperr ofperr_decode(const struct ofperr_domain *,
 494                           uint16_t type, uint16_t code);
 495 enum ofperr ofperr_decode_type(const struct ofperr_domain *, uint16_t type);
 496 enum ofperr ofperr_from_name(const char *);
 497
 498 enum ofperr ofperr_decode_msg(const struct ofp_header *, size_t *payload_ofs);
 499 struct ofpbuf *ofperr_encode_reply(enum ofperr, const struct ofp_header *);
 500 struct ofpbuf *ofperr_encode_hello(enum ofperr, const struct ofperr_domain *,
 501                                    const char *);
 502 int ofperr_get_type(enum ofperr, const struct ofperr_domain *);
 503 int ofperr_get_code(enum ofperr, const struct ofperr_domain *);
 504
 505 const char *ofperr_get_name(enum ofperr);
 506 const char *ofperr_get_description(enum ofperr);
 507
 508 void ofperr_format(struct ds *, enum ofperr);
 509 const char *ofperr_to_string(enum ofperr);
 510
 511 #endif /* ofp-errors.h */