lib/ofp-errors.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 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 #include "openflow/openflow.h"
  25
  26 struct ds;
  27 struct ofpbuf;
  28
  29 /* Error codes.
  30  *
  31  * We embed system errno values and OpenFlow standard and vendor extension
  32  * error codes into the positive range of "int":
  33  *
  34  *   - Errno values are assumed to use the range 1 through 2**30 - 1.
  35  *
  36  *     (C and POSIX say that errno values are positive.  We assume that they
  37  *     are less than 2**29.  They are actually less than 65536 on at least
  38  *     Linux, FreeBSD, OpenBSD, and Windows.)
  39  *
  40  *   - OpenFlow standard and vendor extension error codes use the range
  41  *     starting at 2**30 (OFPERR_OFS).
  42  *
  43  * Zero and negative values are not used.
  44  */
  45
  46 #define OFPERR_OFS (1 << 30)
  47
  48 /* OpenFlow error codes.
  49  *
  50  * The comments below are parsed by the extract-ofp-errors program at build
  51  * time and used to determine the mapping between "enum ofperr" constants and
  52  * error type/code values used in the OpenFlow protocol:
  53  *
  54  *   - The first part of each comment specifies the vendor, OpenFlow versions,
  55  *     type, and sometimes a code for each protocol that supports the error:
  56  *
  57  *         # The vendor is OF for standard OpenFlow error codes.  Otherwise it
  58  *           is one of the *_VENDOR_ID codes defined in openflow-common.h.
  59  *
  60  *         # The version can specify a specific OpenFlow version, a version
  61  *           range delimited by "-", or an open-ended range with "+".
  62  *
  63  *         # Standard OpenFlow errors have both a type and a code.  Extension
  64  *           errors generally have only a type, no code.  There is one
  65  *           exception: Nicira extension (NX) errors for OpenFlow 1.0 and 1.1
  66  *           have both a type and a code.  (This means that the version
  67  *           specification for NX errors may not include version 1.0 or 1.1 (or
  68  *           both) along with version 1.2 or later, because the requirements
  69  *           for those versions are different.)
  70  *
  71  *   - Additional text is a human-readable description of the meaning of each
  72  *     error, used to explain the error to the user.  Any text enclosed in
  73  *     square brackets is omitted; this can be used to explain rationale for
  74  *     choice of error codes in the case where this is desirable. */
  75 enum ofperr {
  76 /* Expected duplications. */
  77
  78     /* Expected: 0x0,3,5 in OF1.1 means both OFPBIC_BAD_EXPERIMENTER and
  79      * OFPBIC_BAD_EXP_TYPE. */
  80
  81 /* ## ------------------ ## */
  82 /* ## OFPET_HELLO_FAILED ## */
  83 /* ## ------------------ ## */
  84
  85     /* OF1.0+(0,0).  No compatible version. */
  86     OFPERR_OFPHFC_INCOMPATIBLE = OFPERR_OFS,
  87
  88     /* OF1.0+(0,1).  Permissions error. */
  89     OFPERR_OFPHFC_EPERM,
  90
  91 /* ## ----------------- ## */
  92 /* ## OFPET_BAD_REQUEST ## */
  93 /* ## ----------------- ## */
  94
  95     /* OF1.0+(1,0).  ofp_header.version not supported. */
  96     OFPERR_OFPBRC_BAD_VERSION,
  97
  98     /* OF1.0+(1,1).  ofp_header.type not supported. */
  99     OFPERR_OFPBRC_BAD_TYPE,
 100
 101     /* OF1.0+(1,2).  ofp_stats_msg.type not supported. */
 102     OFPERR_OFPBRC_BAD_STAT,
 103
 104     /* OF1.0+(1,3).  Vendor not supported (in ofp_vendor_header or
 105      * ofp_stats_msg). */
 106     OFPERR_OFPBRC_BAD_VENDOR,
 107
 108     /* OF1.0+(1,4).  Vendor subtype not supported. */
 109     OFPERR_OFPBRC_BAD_SUBTYPE,
 110
 111     /* OF1.0+(1,5).  Permissions error. */
 112     OFPERR_OFPBRC_EPERM,
 113
 114     /* OF1.0+(1,6).  Wrong request length for type. */
 115     OFPERR_OFPBRC_BAD_LEN,
 116
 117     /* OF1.0+(1,7).  Specified buffer has already been used. */
 118     OFPERR_OFPBRC_BUFFER_EMPTY,
 119
 120     /* OF1.0+(1,8).  Specified buffer does not exist. */
 121     OFPERR_OFPBRC_BUFFER_UNKNOWN,
 122
 123     /* NX1.0(1,512), OF1.1+(1,9).  Specified table-id invalid or does not exist.
 124      * [ A non-standard error (1,512), formerly OFPERR_NXBRC_BAD_TABLE_ID,
 125      *   is used for OpenFlow 1.0 as there seems to be no appropriate error
 126      *   code defined the specification. ] */
 127     OFPERR_OFPBRC_BAD_TABLE_ID,
 128
 129     /* OF1.2+(1,10).  Denied because controller is slave. */
 130     OFPERR_OFPBRC_IS_SLAVE,
 131
 132     /* NX1.0-1.1(1,514), OF1.2+(1,11).  Invalid port.  [ A non-standard error
 133      * (1,514), formerly OFPERR_NXBRC_BAD_IN_PORT is used for OpenFlow 1.0 and
 134      * 1.1 as there seems to be no appropriate error code defined the
 135      * specifications. ] */
 136     OFPERR_OFPBRC_BAD_PORT,
 137
 138     /* OF1.2+(1,12).  Invalid packet in packet-out. */
 139     OFPERR_OFPBRC_BAD_PACKET,
 140
 141     /* OF1.3+(1,13).  Multipart request overflowed the assigned buffer. */
 142     OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW,
 143
 144     /* NX1.0-1.1(1,256), NX1.2+(2).  Invalid NXM flow match. */
 145     OFPERR_NXBRC_NXM_INVALID,
 146
 147     /* NX1.0-1.1(1,257), NX1.2+(3).  The nxm_type, or nxm_type taken in
 148      * combination with nxm_hasmask or nxm_length or both, is invalid or not
 149      * implemented. */
 150     OFPERR_NXBRC_NXM_BAD_TYPE,
 151
 152     /* NX1.0-1.1(1,515), NX1.2+(4).  Must-be-zero field had nonzero value. */
 153     OFPERR_NXBRC_MUST_BE_ZERO,
 154
 155     /* NX1.0-1.1(1,516), NX1.2+(5).  The reason in an ofp_port_status message
 156      * is not valid. */
 157     OFPERR_NXBRC_BAD_REASON,
 158
 159     /* NX1.0-1.1(1,520), NX1.2+(9).  The 'event' in an NXST_FLOW_MONITOR reply
 160      * does not specify one of the NXFME_ABBREV, NXFME_ADD, NXFME_DELETE, or
 161      * NXFME_MODIFY. */
 162     OFPERR_NXBRC_FM_BAD_EVENT,
 163
 164     /* NX1.0-1.1(1,521), NX1.2+(10).  The error that occurred cannot be
 165      * represented in this OpenFlow version. */
 166     OFPERR_NXBRC_UNENCODABLE_ERROR,
 167
 168 /* ## ---------------- ## */
 169 /* ## OFPET_BAD_ACTION ## */
 170 /* ## ---------------- ## */
 171
 172     /* OF1.0+(2,0).  Unknown action type. */
 173     OFPERR_OFPBAC_BAD_TYPE,
 174
 175     /* OF1.0+(2,1).  Length problem in actions. */
 176     OFPERR_OFPBAC_BAD_LEN,
 177
 178     /* OF1.0+(2,2).  Unknown experimenter id specified. */
 179     OFPERR_OFPBAC_BAD_VENDOR,
 180
 181     /* OF1.0+(2,3).  Unknown action type for experimenter id. */
 182     OFPERR_OFPBAC_BAD_VENDOR_TYPE,
 183
 184     /* OF1.0+(2,4).  Problem validating output port. */
 185     OFPERR_OFPBAC_BAD_OUT_PORT,
 186
 187     /* OF1.0+(2,5).  Bad action argument. */
 188     OFPERR_OFPBAC_BAD_ARGUMENT,
 189
 190     /* OF1.0+(2,6).  Permissions error. */
 191     OFPERR_OFPBAC_EPERM,
 192
 193     /* OF1.0+(2,7).  Can't handle this many actions. */
 194     OFPERR_OFPBAC_TOO_MANY,
 195
 196     /* OF1.0+(2,8).  Problem validating output queue. */
 197     OFPERR_OFPBAC_BAD_QUEUE,
 198
 199     /* OF1.1+(2,9).  Invalid group id in forward action. */
 200     OFPERR_OFPBAC_BAD_OUT_GROUP,
 201
 202     /* NX1.0(1,522), OF1.1+(2,10).  Action can't apply for this match or a
 203      * prerequisite for use of this field is unmet. */
 204     OFPERR_OFPBAC_MATCH_INCONSISTENT,
 205
 206     /* OF1.1+(2,11).  Action order is unsupported for the action list in an
 207      * Apply-Actions instruction */
 208     OFPERR_OFPBAC_UNSUPPORTED_ORDER,
 209
 210     /* OF1.1+(2,12).  Actions uses an unsupported tag/encap. */
 211     OFPERR_OFPBAC_BAD_TAG,
 212
 213     /* NX1.0-1.1(1,523), OF1.2+(2,13).  Action uses unknown or unsupported OXM
 214      * or NXM field. */
 215     OFPERR_OFPBAC_BAD_SET_TYPE,
 216
 217     /* NX1.0-1.1(1,524), OF1.2+(2,14).  Action references past the end of an
 218      * OXM or NXM field, or uses a length of zero. */
 219     OFPERR_OFPBAC_BAD_SET_LEN,
 220
 221     /* NX1.0-1.1(1,525), OF1.2+(2,15).  Action sets a field to an invalid or
 222      * unsupported value, or modifies a read-only field. */
 223     OFPERR_OFPBAC_BAD_SET_ARGUMENT,
 224
 225     /* ONF1.3-1.4(4250), OF1.5+(2,16).  Field in Set-Field action has Has-Mask
 226      * bit set to 1. */
 227     OFPERR_OFPBAC_BAD_SET_MASK,
 228
 229     /* NX1.0-1.1(2,256), NX1.2+(11).  Must-be-zero action argument had nonzero
 230      * value. */
 231     OFPERR_NXBAC_MUST_BE_ZERO,
 232
 233     /* NX1.0-1.1(2,526), NX1.2+(15).  Conjunction action must be only action
 234      * present.  conjunction(id, k/n) must satisfy 1 <= k <= n and 2 <= n <=
 235      * 64. */
 236     OFPERR_NXBAC_BAD_CONJUNCTION,
 237
 238 /* ## --------------------- ## */
 239 /* ## OFPET_BAD_INSTRUCTION ## */
 240 /* ## --------------------- ## */
 241
 242     /* OF1.1+(3,0).  Unknown instruction. */
 243     OFPERR_OFPBIC_UNKNOWN_INST,
 244
 245     /* NX1.0(2,257), OF1.1+(3,1).  Switch or table does not support the
 246      * instruction. */
 247     OFPERR_OFPBIC_UNSUP_INST,
 248
 249     /* OF1.1+(3,2).  Invalid Table-ID specified. */
 250     OFPERR_OFPBIC_BAD_TABLE_ID,
 251
 252     /* OF1.1+(3,3).  Metadata value unsupported by datapath. */
 253     OFPERR_OFPBIC_UNSUP_METADATA,
 254
 255     /* OF1.1+(3,4).  Metadata mask value unsupported by datapath. */
 256     OFPERR_OFPBIC_UNSUP_METADATA_MASK,
 257
 258     /* OF1.1+(3,5).  Unknown experimenter id specified. */
 259     OFPERR_OFPBIC_BAD_EXPERIMENTER,
 260
 261     /* OF1.1(3,5), OF1.2+(3,6).  Unknown instruction for experimenter id. */
 262     OFPERR_OFPBIC_BAD_EXP_TYPE,
 263
 264     /* OF1.2+(3,7).  Length problem in instructions. */
 265     OFPERR_OFPBIC_BAD_LEN,
 266
 267     /* OF1.2+(3,8).  Permissions error. */
 268     OFPERR_OFPBIC_EPERM,
 269
 270     /* NX1.1(3,256), ONF1.2-1.3(2600), OF1.4+(3,9).  Duplicate instruction. */
 271     OFPERR_OFPBIC_DUP_INST,
 272
 273 /* ## --------------- ## */
 274 /* ## OFPET_BAD_MATCH ## */
 275 /* ## --------------- ## */
 276
 277     /* OF1.1+(4,0).  Unsupported match type specified by the match */
 278     OFPERR_OFPBMC_BAD_TYPE,
 279
 280     /* OF1.1+(4,1).  Length problem in match. */
 281     OFPERR_OFPBMC_BAD_LEN,
 282
 283     /* OF1.1+(4,2).  Match uses an unsupported tag/encap. */
 284     OFPERR_OFPBMC_BAD_TAG,
 285
 286     /* OF1.1+(4,3).  Unsupported datalink addr mask - switch does not support
 287      * arbitrary datalink address mask. */
 288     OFPERR_OFPBMC_BAD_DL_ADDR_MASK,
 289
 290     /* OF1.1+(4,4).  Unsupported network addr mask - switch does not support
 291      * arbitrary network address mask. */
 292     OFPERR_OFPBMC_BAD_NW_ADDR_MASK,
 293
 294     /* NX1.0(1,262), OF1.1+(4,5).  Unsupported wildcard specified in the
 295      * match. */
 296     OFPERR_OFPBMC_BAD_WILDCARDS,
 297
 298     /* OF1.1+(4,6).  Unsupported field in the match. */
 299     OFPERR_OFPBMC_BAD_FIELD,
 300
 301     /* NX1.0(1,258), OF1.1+(4,7).  Unsupported value in a match
 302      * field. */
 303     OFPERR_OFPBMC_BAD_VALUE,
 304
 305     /* NX1.0-1.1(1,259), OF1.2+(4,8).  Unsupported mask specified in the match,
 306      * field is not dl-address or nw-address. */
 307     OFPERR_OFPBMC_BAD_MASK,
 308
 309     /* NX1.0-1.1(1,260), OF1.2+(4,9).  A prerequisite was not met. */
 310     OFPERR_OFPBMC_BAD_PREREQ,
 311
 312     /* NX1.0-1.1(1,261), OF1.2+(4,10).  A field type was duplicated. */
 313     OFPERR_OFPBMC_DUP_FIELD,
 314
 315     /* OF1.2+(4,11).  Permissions error. */
 316     OFPERR_OFPBMC_EPERM,
 317
 318 /* ## --------------------- ## */
 319 /* ## OFPET_FLOW_MOD_FAILED ## */
 320 /* ## --------------------- ## */
 321
 322     /* OF1.1+(5,0).  Unspecified error. */
 323     OFPERR_OFPFMFC_UNKNOWN,
 324
 325     /* OF1.0(3,0), OF1.1+(5,1).  Flow not added because of full table(s). */
 326     OFPERR_OFPFMFC_TABLE_FULL,
 327
 328     /* OF1.1+(5,2).  Table does not exist */
 329     OFPERR_OFPFMFC_BAD_TABLE_ID,
 330
 331     /* OF1.0(3,1), OF1.1+(5,3).  Attempted to add overlapping flow with
 332      * CHECK_OVERLAP flag set. */
 333     OFPERR_OFPFMFC_OVERLAP,
 334
 335     /* OF1.0(3,2), OF1.1+(5,4).  Permissions error. */
 336     OFPERR_OFPFMFC_EPERM,
 337
 338     /* OF1.1+(5,5).  Flow not added because of unsupported idle/hard
 339      * timeout. */
 340     OFPERR_OFPFMFC_BAD_TIMEOUT,
 341
 342     /* OF1.0(3,3).  Flow not added because of non-zero idle/hard timeout. */
 343     OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT,
 344
 345     /* OF1.0(3,4), OF1.1+(5,6).  Unsupported or unknown command. */
 346     OFPERR_OFPFMFC_BAD_COMMAND,
 347
 348     /* NX1.0(3,258), NX1.1(5,258), OF1.2+(5,7).  Unsupported or unknown
 349      * flags. */
 350     OFPERR_OFPFMFC_BAD_FLAGS,
 351
 352     /* OF1.0(3,5).  Unsupported action list - cannot process in the order
 353      * specified. */
 354     OFPERR_OFPFMFC_UNSUPPORTED,
 355
 356     /* NX1.0-1.1(5,256), NX1.2+(12).  Generic hardware error. */
 357     OFPERR_NXFMFC_HARDWARE,
 358
 359     /* NX1.0-1.1(5,257), NX1.2+(13).  A nonexistent table ID was specified in
 360      * the "command" field of struct ofp_flow_mod, when the
 361      * nxt_flow_mod_table_id extension is enabled. */
 362     OFPERR_NXFMFC_BAD_TABLE_ID,
 363
 364 /* ## ---------------------- ## */
 365 /* ## OFPET_GROUP_MOD_FAILED ## */
 366 /* ## ---------------------- ## */
 367
 368     /* OF1.1+(6,0).  Group not added because a group ADD attempted to replace
 369      * an already-present group. */
 370     OFPERR_OFPGMFC_GROUP_EXISTS,
 371
 372     /* OF1.1+(6,1).  Group not added because Group specified is invalid. */
 373     OFPERR_OFPGMFC_INVALID_GROUP,
 374
 375     /* OF1.1+(6,2).  Switch does not support unequal load sharing with select
 376      * groups. */
 377     OFPERR_OFPGMFC_WEIGHT_UNSUPPORTED,
 378
 379     /* OF1.1+(6,3).  The group table is full. */
 380     OFPERR_OFPGMFC_OUT_OF_GROUPS,
 381
 382     /* OF1.1+(6,4).  The maximum number of action buckets for a group has been
 383      * exceeded. */
 384     OFPERR_OFPGMFC_OUT_OF_BUCKETS,
 385
 386     /* OF1.1+(6,5).  Switch does not support groups that forward to groups. */
 387     OFPERR_OFPGMFC_CHAINING_UNSUPPORTED,
 388
 389     /* OF1.1+(6,6).  This group cannot watch the watch_port or watch_group
 390      * specified. */
 391     OFPERR_OFPGMFC_WATCH_UNSUPPORTED,
 392
 393     /* OF1.1+(6,7).  Group entry would cause a loop. */
 394     OFPERR_OFPGMFC_LOOP,
 395
 396     /* OF1.1+(6,8).  Group not modified because a group MODIFY attempted to
 397      * modify a non-existent group. */
 398     OFPERR_OFPGMFC_UNKNOWN_GROUP,
 399
 400     /* OF1.2+(6,9).  Group not deleted because another
 401                     group is forwarding to it. */
 402     OFPERR_OFPGMFC_CHAINED_GROUP,
 403
 404     /* OF1.2+(6,10).  Unsupported or unknown group type. */
 405     OFPERR_OFPGMFC_BAD_TYPE,
 406
 407     /* OF1.2+(6,11).  Unsupported or unknown command. */
 408     OFPERR_OFPGMFC_BAD_COMMAND,
 409
 410     /* OF1.2+(6,12).  Error in bucket. */
 411     OFPERR_OFPGMFC_BAD_BUCKET,
 412
 413     /* OF1.2+(6,13).  Error in watch port/group. */
 414     OFPERR_OFPGMFC_BAD_WATCH,
 415
 416     /* OF1.2+(6,14).  Permissions error. */
 417     OFPERR_OFPGMFC_EPERM,
 418
 419     /* OF1.5+(6,15).  Invalid bucket identifier used in
 420      * INSERT BUCKET or REMOVE BUCKET command. */
 421     OFPERR_OFPGMFC_UNKNOWN_BUCKET,
 422
 423     /* OF1.5+(6,16).  Can't insert bucket because a bucket
 424      * already exist with that bucket-id. */
 425     OFPERR_OFPGMFC_BUCKET_EXISTS,
 426
 427 /* ## --------------------- ## */
 428 /* ## OFPET_PORT_MOD_FAILED ## */
 429 /* ## --------------------- ## */
 430
 431     /* OF1.0(4,0), OF1.1+(7,0).  Specified port does not exist. */
 432     OFPERR_OFPPMFC_BAD_PORT,
 433
 434     /* OF1.0(4,1), OF1.1+(7,1).  Specified hardware address does not match the
 435      * port number. */
 436     OFPERR_OFPPMFC_BAD_HW_ADDR,
 437
 438     /* OF1.1+(7,2).  Specified config is invalid. */
 439     OFPERR_OFPPMFC_BAD_CONFIG,
 440
 441     /* OF1.1+(7,3).  Specified advertise is invalid. */
 442     OFPERR_OFPPMFC_BAD_ADVERTISE,
 443
 444     /* OF1.2+(7,4).  Permissions error. */
 445     OFPERR_OFPPMFC_EPERM,
 446
 447 /* ## ---------------------- ## */
 448 /* ## OFPET_TABLE_MOD_FAILED ## */
 449 /* ## ---------------------- ## */
 450
 451     /* OF1.1+(8,0).  Specified table does not exist. */
 452     OFPERR_OFPTMFC_BAD_TABLE,
 453
 454     /* OF1.1+(8,1).  Specified config is invalid. */
 455     OFPERR_OFPTMFC_BAD_CONFIG,
 456
 457     /* OF1.2+(8,2).  Permissions error. */
 458     OFPERR_OFPTMFC_EPERM,
 459
 460 /* ## --------------------- ## */
 461 /* ## OFPET_QUEUE_OP_FAILED ## */
 462 /* ## --------------------- ## */
 463
 464     /* OF1.0(5,0), OF1.1+(9,0).  Invalid port (or port does not exist). */
 465     OFPERR_OFPQOFC_BAD_PORT,
 466
 467     /* OF1.0(5,1), OF1.1+(9,1).  Queue does not exist. */
 468     OFPERR_OFPQOFC_BAD_QUEUE,
 469
 470     /* OF1.0(5,2), OF1.1+(9,2).  Permissions error. */
 471     OFPERR_OFPQOFC_EPERM,
 472
 473 /* ## -------------------------- ## */
 474 /* ## OFPET_SWITCH_CONFIG_FAILED ## */
 475 /* ## -------------------------- ## */
 476
 477     /* OF1.1+(10,0).  Specified flags is invalid. */
 478     OFPERR_OFPSCFC_BAD_FLAGS,
 479
 480     /* OF1.1+(10,1).  Specified len is invalid. */
 481     OFPERR_OFPSCFC_BAD_LEN,
 482
 483     /* OF1.2+(10,2).  Permissions error. */
 484     OFPERR_OFPSCFC_EPERM,
 485
 486 /* ## ------------------------- ## */
 487 /* ## OFPET_ROLE_REQUEST_FAILED ## */
 488 /* ## ------------------------- ## */
 489
 490     /* OF1.2+(11,0).  Stale Message: old generation_id. */
 491     OFPERR_OFPRRFC_STALE,
 492
 493     /* OF1.2+(11,1).  Controller role change unsupported. */
 494     OFPERR_OFPRRFC_UNSUP,
 495
 496     /* NX1.0-1.1(1,513), OF1.2+(11,2).  Invalid role. */
 497     OFPERR_OFPRRFC_BAD_ROLE,
 498
 499 /* ## ---------------------- ## */
 500 /* ## OFPET_METER_MOD_FAILED ## */
 501 /* ## ---------------------- ## */
 502
 503     /* OF1.3+(12,0).  Unspecified error. */
 504     OFPERR_OFPMMFC_UNKNOWN,
 505
 506     /* OF1.3+(12,1).  Meter not added because a Meter ADD attempted to
 507      * replace an existing Meter. */
 508     OFPERR_OFPMMFC_METER_EXISTS,
 509
 510     /* OF1.3+(12,2).  Meter not added because Meter specified is invalid. */
 511     OFPERR_OFPMMFC_INVALID_METER,
 512
 513     /* OF1.3+(12,3).  Meter not modified because a Meter MODIFY attempted
 514      * to modify a non-existent Meter. */
 515     OFPERR_OFPMMFC_UNKNOWN_METER,
 516
 517     /* OF1.3+(12,4).  Unsupported or unknown command. */
 518     OFPERR_OFPMMFC_BAD_COMMAND,
 519
 520     /* OF1.3+(12,5).  Flag configuration unsupported. */
 521     OFPERR_OFPMMFC_BAD_FLAGS,
 522
 523     /* OF1.3+(12,6).  Rate unsupported. */
 524     OFPERR_OFPMMFC_BAD_RATE,
 525
 526     /* OF1.3+(12,7).  Burst size unsupported. */
 527     OFPERR_OFPMMFC_BAD_BURST,
 528
 529     /* OF1.3+(12,8).  Band unsupported. */
 530     OFPERR_OFPMMFC_BAD_BAND,
 531
 532     /* OF1.3+(12,9).  Band value unsupported. */
 533     OFPERR_OFPMMFC_BAD_BAND_VALUE,
 534
 535     /* OF1.3+(12,10).  No more meters available. */
 536     OFPERR_OFPMMFC_OUT_OF_METERS,
 537
 538     /* OF1.3+(12,11).  The maximum number of properties for a meter has
 539      * been exceeded. */
 540     OFPERR_OFPMMFC_OUT_OF_BANDS,
 541
 542 /* ## --------------------------- ## */
 543 /* ## OFPET_TABLE_FEATURES_FAILED ## */
 544 /* ## --------------------------- ## */
 545
 546     /* OF1.3+(13,0).  Specified table does not exist. */
 547     OFPERR_OFPTFFC_BAD_TABLE,
 548
 549     /* OF1.3+(13,1).  Invalid metadata mask. */
 550     OFPERR_OFPTFFC_BAD_METADATA,
 551
 552     /* OF1.3+(13,5).  Permissions error. */
 553     OFPERR_OFPTFFC_EPERM,
 554
 555 /* ## ------------------ ## */
 556 /* ## OFPET_BAD_PROPERTY ## */
 557 /* ## ------------------ ## */
 558
 559     /* OF1.3(13,2), OF1.4+(14,0).  Unknown property type.
 560      *
 561      * [Known as OFPTFFC_BAD_TYPE in OF1.3.] */
 562     OFPERR_OFPBPC_BAD_TYPE,
 563
 564     /* OF1.3(13,3), OF1.4+(14,1).  Length problem in property.
 565      *
 566      * [Known as OFPTFFC_BAD_LEN in OF1.3.] */
 567     OFPERR_OFPBPC_BAD_LEN,
 568
 569     /* OF1.3(13,4), OF1.4+(14,2).  Unsupported property value.
 570      *
 571      * [Known as OFPTFFC_BAD_ARGUMENT in OF1.3.] */
 572     OFPERR_OFPBPC_BAD_VALUE,
 573
 574     /* ONF1.3(4443), OF1.4+(14,3).  Can't handle this many properties. */
 575     OFPERR_OFPBPC_TOO_MANY,
 576
 577     /* ONF1.3(4444), OF1.4+(14,4).  A property type was duplicated. */
 578     OFPERR_OFPBPC_DUP_TYPE,
 579
 580     /* ONF1.3(4445), OF1.4+(14,5).  Unknown experimenter id specified. */
 581     OFPERR_OFPBPC_BAD_EXPERIMENTER,
 582
 583     /* ONF1.3(4446), OF1.4+(14,6).  Unknown exp_type for experimenter id. */
 584     OFPERR_OFPBPC_BAD_EXP_TYPE,
 585
 586     /* ONF1.3(4447), OF1.4+(14,7).  Unknown value for experimenter id. */
 587     OFPERR_OFPBPC_BAD_EXP_VALUE,
 588
 589     /* ONF1.3(4448), OF1.4+(14,8).  Permissions error. */
 590     OFPERR_OFPBPC_EPERM,
 591
 592 /* ## -------------------- ## */
 593 /* ## OFPET_BUNDLE_FAILED  ## */
 594 /* ## -------------------- ## */
 595
 596     /* OF1.4+(17,0).  Unspecified error. */
 597     OFPERR_OFPBFC_UNKNOWN,
 598
 599     /* OF1.4+(17,1).  Permissions error. */
 600     OFPERR_OFPBFC_EPERM,
 601
 602     /* OF1.4+(17,2).  Bundle ID doesn't exist. */
 603     OFPERR_OFPBFC_BAD_ID,
 604
 605     /* OF1.4+(17,3).  Bundle ID already exists. */
 606     OFPERR_OFPBFC_BUNDLE_EXIST,
 607
 608     /* OF1.4+(17,4).  Bundle ID is closed. */
 609     OFPERR_OFPBFC_BUNDLE_CLOSED,
 610
 611     /* OF1.4+(17,5).  Too many bundle IDs. */
 612     OFPERR_OFPBFC_OUT_OF_BUNDLES,
 613
 614     /* OF1.4+(17,6).  Unsupported of unknown message control type. */
 615     OFPERR_OFPBFC_BAD_TYPE,
 616
 617     /* OF1.4+(17,7).  Unsupported, unknown, or inconsistent flags. */
 618     OFPERR_OFPBFC_BAD_FLAGS,
 619
 620     /* OF1.4+(17,8).  Length problem in included message. */
 621     OFPERR_OFPBFC_MSG_BAD_LEN,
 622
 623     /* OF1.4+(17,9).  Inconsistent or duplicate XID. */
 624     OFPERR_OFPBFC_MSG_BAD_XID,
 625
 626     /* OF1.4+(17,10).  Unsupported message in this bundle. */
 627     OFPERR_OFPBFC_MSG_UNSUP,
 628
 629     /* OF1.4+(17,11).  Unsupported message combination in this bundle. */
 630     OFPERR_OFPBFC_MSG_CONFLICT,
 631
 632     /* OF1.4+(17,12).  Cant handle this many messages in bundle. */
 633     OFPERR_OFPBFC_MSG_TOO_MANY,
 634
 635     /* OF1.4+(17,13).  One message in bundle failed. */
 636     OFPERR_OFPBFC_MSG_FAILED,
 637
 638     /* OF1.4+(17,14).  Bundle is taking too long. */
 639     OFPERR_OFPBFC_TIMEOUT,
 640
 641     /* OF1.4+(17,15).  Bundle is locking the resource. */
 642     OFPERR_OFPBFC_BUNDLE_IN_PROGRESS,
 643
 644 /* ## ------------------------- ## */
 645 /* ## OFPET_FLOW_MONITOR_FAILED ## */
 646 /* ## ------------------------- ## */
 647
 648     /* OF1.4+(16,0).  Unspecified error. */
 649     OFPERR_OFPMOFC_UNKNOWN,
 650
 651     /* NX1.0-1.1(1,517), NX1.2-1.3(6), OF1.4+(16,1).  Monitor not added
 652      * because a Monitor ADD attempted to replace an existing Monitor. */
 653     OFPERR_OFPMOFC_MONITOR_EXISTS,
 654
 655     /* OF1.4+(16,2).  Monitor not added because
 656      * Monitor specified is invalid. */
 657     OFPERR_OFPMOFC_INVALID_MONITOR,
 658
 659     /* NX1.0-1.1(1,519), NX1.2-1.3(8), OF1.4+(16,3).  Monitor not modified
 660      * because a Monitor MODIFY attempted to modify a non-existent Monitor. */
 661     OFPERR_OFPMOFC_UNKNOWN_MONITOR,
 662
 663     /* OF1.4+(16,4).  Unsupported or unknown command. */
 664     OFPERR_OFPMOFC_BAD_COMMAND,
 665
 666     /* NX1.0-1.1(1,518), NX1.2-1.3(7), OF1.4+(16,5).  Flag configuration
 667      * unsupported. */
 668     OFPERR_OFPMOFC_BAD_FLAGS,
 669
 670     /* OF1.4+(16,6).  Specified table does not exist. */
 671     OFPERR_OFPMOFC_BAD_TABLE_ID,
 672
 673     /* OF1.4+(16,7).  Error in output port/group. */
 674     OFPERR_OFPMOFC_BAD_OUT,
 675
 676 /* ## ------------------ ## */
 677 /* ## OFPET_EXPERIMENTER ## */
 678 /* ## ------------------ ## */
 679 };
 680
 681 const char *ofperr_domain_get_name(enum ofp_version);
 682
 683 bool ofperr_is_valid(enum ofperr);
 684
 685 enum ofperr ofperr_from_name(const char *);
 686
 687 enum ofperr ofperr_decode_msg(const struct ofp_header *,
 688                               struct ofpbuf *payload);
 689 struct ofpbuf *ofperr_encode_reply(enum ofperr, const struct ofp_header *);
 690 struct ofpbuf *ofperr_encode_hello(enum ofperr, enum ofp_version ofp_version,
 691                                    const char *);
 692 int ofperr_get_vendor(enum ofperr, enum ofp_version);
 693 int ofperr_get_type(enum ofperr, enum ofp_version);
 694 int ofperr_get_code(enum ofperr, enum ofp_version);
 695
 696 const char *ofperr_get_name(enum ofperr);
 697 const char *ofperr_get_description(enum ofperr);
 698
 699 void ofperr_format(struct ds *, enum ofperr);
 700 const char *ofperr_to_string(enum ofperr);
 701
 702 #endif /* ofp-errors.h */