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 #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 OpenFlow type/code for each
  55  *     protocol that supports the error.
  56  *
  57  *   - Additional text is a human-readable description of the meaning of each
  58  *     error, used to explain the error to the user.  Any text enclosed in
  59  *     square brackets is omitted; this can be used to explain rationale for
  60  *     choice of error codes in the case where this is desirable. */
  61 enum ofperr {
  62 /* Expected duplications. */
  63
  64     /* Expected: 3,5 in OF1.1 means both OFPBIC_BAD_EXPERIMENTER and
  65      * OFPBIC_BAD_EXP_TYPE. */
  66
  67 /* ## ------------------ ## */
  68 /* ## OFPET_HELLO_FAILED ## */
  69 /* ## ------------------ ## */
  70
  71     /* OF1.0+(0).  Hello protocol failed. */
  72     OFPERR_OFPET_HELLO_FAILED = OFPERR_OFS,
  73
  74     /* OF1.0+(0,0).  No compatible version. */
  75     OFPERR_OFPHFC_INCOMPATIBLE,
  76
  77     /* OF1.0+(0,1).  Permissions error. */
  78     OFPERR_OFPHFC_EPERM,
  79
  80 /* ## ----------------- ## */
  81 /* ## OFPET_BAD_REQUEST ## */
  82 /* ## ----------------- ## */
  83
  84     /* OF1.0+(1).  Request was not understood. */
  85     OFPERR_OFPET_BAD_REQUEST,
  86
  87     /* OF1.0+(1,0).  ofp_header.version not supported. */
  88     OFPERR_OFPBRC_BAD_VERSION,
  89
  90     /* OF1.0+(1,1).  ofp_header.type not supported. */
  91     OFPERR_OFPBRC_BAD_TYPE,
  92
  93     /* OF1.0+(1,2).  ofp_stats_msg.type not supported. */
  94     OFPERR_OFPBRC_BAD_STAT,
  95
  96     /* OF1.0+(1,3).  Vendor not supported (in ofp_vendor_header or
  97      * ofp_stats_msg). */
  98     OFPERR_OFPBRC_BAD_VENDOR,
  99
 100     /* OF1.0+(1,4).  Vendor subtype not supported. */
 101     OFPERR_OFPBRC_BAD_SUBTYPE,
 102
 103     /* OF1.0+(1,5).  Permissions error. */
 104     OFPERR_OFPBRC_EPERM,
 105
 106     /* OF1.0+(1,6).  Wrong request length for type. */
 107     OFPERR_OFPBRC_BAD_LEN,
 108
 109     /* OF1.0+(1,7).  Specified buffer has already been used. */
 110     OFPERR_OFPBRC_BUFFER_EMPTY,
 111
 112     /* OF1.0+(1,8).  Specified buffer does not exist. */
 113     OFPERR_OFPBRC_BUFFER_UNKNOWN,
 114
 115     /* NX1.0(1,512), OF1.1+(1,9).  Specified table-id invalid or does not exist.
 116      * [ A non-standard error (1,512), formerly OFPERR_NXBRC_BAD_TABLE_ID,
 117      *   is used for OpenFlow 1.0 as there seems to be no appropriste error
 118      *   code defined the specification. ] */
 119     OFPERR_OFPBRC_BAD_TABLE_ID,
 120
 121     /* OF1.2+(1,10).  Denied because controller is slave. */
 122     OFPERR_OFPBRC_IS_SLAVE,
 123
 124     /* NX1.0(1,514), NX1.1(1,514), OF1.2+(1,11).  Invalid port.
 125      * [ A non-standard error (1,514), formerly
 126      *   OFPERR_NXBRC_BAD_IN_PORT is used for OpenFlow 1.0 and 1.1 as there
 127      *   seems to be no appropriste error code defined the specifications. ] */
 128     OFPERR_OFPBRC_BAD_PORT,
 129
 130     /* OF1.2+(1,12).  Invalid packet in packet-out. */
 131     OFPERR_OFPBRC_BAD_PACKET,
 132
 133     /* OF1.3+(1,13).  Multipart request overflowed the assigned buffer. */
 134     OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW,
 135
 136     /* NX1.0+(1,256).  Invalid NXM flow match. */
 137     OFPERR_NXBRC_NXM_INVALID,
 138
 139     /* NX1.0+(1,257).  The nxm_type, or nxm_type taken in combination with
 140      * nxm_hasmask or nxm_length or both, is invalid or not implemented. */
 141     OFPERR_NXBRC_NXM_BAD_TYPE,
 142
 143     /* NX1.0+(1,515).  Must-be-zero field had nonzero value. */
 144     OFPERR_NXBRC_MUST_BE_ZERO,
 145
 146     /* NX1.0+(1,516).  The reason in an ofp_port_status message is not
 147      * valid. */
 148     OFPERR_NXBRC_BAD_REASON,
 149
 150     /* NX1.0+(1,517).  The 'id' in an NXST_FLOW_MONITOR request is the same as
 151      * an existing monitor id (or two monitors in the same NXST_FLOW_MONITOR
 152      * request have the same 'id').  */
 153     OFPERR_NXBRC_FM_DUPLICATE_ID,
 154
 155     /* NX1.0+(1,518).  The 'flags' in an NXST_FLOW_MONITOR request either does
 156      * not specify at least one of the NXFMF_ADD, NXFMF_DELETE, or NXFMF_MODIFY
 157      * flags, or specifies a flag bit that is not defined. */
 158     OFPERR_NXBRC_FM_BAD_FLAGS,
 159
 160     /* NX1.0+(1,519).  The 'id' in an NXT_FLOW_MONITOR_CANCEL request is not
 161      * the id of any existing monitor. */
 162     OFPERR_NXBRC_FM_BAD_ID,
 163
 164     /* NX1.0+(1,520).  The 'event' in an NXST_FLOW_MONITOR reply does not
 165      * specify one of the NXFME_ABBREV, NXFME_ADD, NXFME_DELETE, or
 166      * NXFME_MODIFY. */
 167     OFPERR_NXBRC_FM_BAD_EVENT,
 168
 169 /* ## ---------------- ## */
 170 /* ## OFPET_BAD_ACTION ## */
 171 /* ## ---------------- ## */
 172
 173     /* OF1.0+(2).  Error in action description. */
 174     OFPERR_OFPET_BAD_ACTION,
 175
 176     /* OF1.0+(2,0).  Unknown action type. */
 177     OFPERR_OFPBAC_BAD_TYPE,
 178
 179     /* OF1.0+(2,1).  Length problem in actions. */
 180     OFPERR_OFPBAC_BAD_LEN,
 181
 182     /* OF1.0+(2,2).  Unknown experimenter id specified. */
 183     OFPERR_OFPBAC_BAD_VENDOR,
 184
 185     /* OF1.0+(2,3).  Unknown action type for experimenter id. */
 186     OFPERR_OFPBAC_BAD_VENDOR_TYPE,
 187
 188     /* OF1.0+(2,4).  Problem validating output port. */
 189     OFPERR_OFPBAC_BAD_OUT_PORT,
 190
 191     /* OF1.0+(2,5).  Bad action argument. */
 192     OFPERR_OFPBAC_BAD_ARGUMENT,
 193
 194     /* OF1.0+(2,6).  Permissions error. */
 195     OFPERR_OFPBAC_EPERM,
 196
 197     /* OF1.0+(2,7).  Can't handle this many actions. */
 198     OFPERR_OFPBAC_TOO_MANY,
 199
 200     /* OF1.0+(2,8).  Problem validating output queue. */
 201     OFPERR_OFPBAC_BAD_QUEUE,
 202
 203     /* OF1.1+(2,9).  Invalid group id in forward action. */
 204     OFPERR_OFPBAC_BAD_OUT_GROUP,
 205
 206     /* OF1.1+(2,10).  Action can't apply for this match. */
 207     OFPERR_OFPBAC_MATCH_INCONSISTENT,
 208
 209     /* OF1.1+(2,11).  Action order is unsupported for the action list in an
 210      * Apply-Actions instruction */
 211     OFPERR_OFPBAC_UNSUPPORTED_ORDER,
 212
 213     /* OF1.1+(2,12).  Actions uses an unsupported tag/encap. */
 214     OFPERR_OFPBAC_BAD_TAG,
 215
 216     /* OF1.2+(2,13).  Unsupported type in SET_FIELD action. */
 217     OFPERR_OFPBAC_SET_TYPE,
 218
 219     /* OF1.2+(2,14).  Length problem in SET_FIELD action. */
 220     OFPERR_OFPBAC_SET_LEN,
 221
 222     /* OF1.2+(2,15).  Bad argument in SET_FIELD action. */
 223     OFPERR_OFPBAC_ARGUMENT,
 224
 225     /* NX1.0+(2,256).  Must-be-zero action argument had nonzero value. */
 226     OFPERR_NXBAC_MUST_BE_ZERO,
 227
 228 /* ## --------------------- ## */
 229 /* ## OFPET_BAD_INSTRUCTION ## */
 230 /* ## --------------------- ## */
 231
 232     /* OF1.1+(3).  Error in instruction list. */
 233     OFPERR_OFPIT_BAD_INSTRUCTION,
 234
 235     /* OF1.1+(3,0).  Unknown instruction. */
 236     OFPERR_OFPBIC_UNKNOWN_INST,
 237
 238     /* OF1.1+(3,1).  Switch or table does not support the instruction. */
 239     OFPERR_OFPBIC_UNSUP_INST,
 240
 241     /* OF1.1+(3,2).  Invalid Table-ID specified. */
 242     OFPERR_OFPBIC_BAD_TABLE_ID,
 243
 244     /* OF1.1+(3,3).  Metadata value unsupported by datapath. */
 245     OFPERR_OFPBIC_UNSUP_METADATA,
 246
 247     /* OF1.1+(3,4).  Metadata mask value unsupported by datapath. */
 248     OFPERR_OFPBIC_UNSUP_METADATA_MASK,
 249
 250     /* OF1.1+(3,5).  Unknown experimenter id specified. */
 251     OFPERR_OFPBIC_BAD_EXPERIMENTER,
 252
 253     /* OF1.1(3,5), OF1.2+(3,6).  Unknown instruction for experimenter id. */
 254     OFPERR_OFPBIC_BAD_EXP_TYPE,
 255
 256     /* OF1.2+(3,7).  Length problem in instructions. */
 257     OFPERR_OFPBIC_BAD_LEN,
 258
 259     /* OF1.2+(3,8).  Permissions error. */
 260     OFPERR_OFPBIC_EPERM,
 261
 262 /* ## --------------- ## */
 263 /* ## OFPET_BAD_MATCH ## */
 264 /* ## --------------- ## */
 265
 266     /* OF1.1+(4).  Error in match. */
 267     OFPERR_OFPET_BAD_MATCH,
 268
 269     /* OF1.1+(4,0).  Unsupported match type specified by the match */
 270     OFPERR_OFPBMC_BAD_TYPE,
 271
 272     /* OF1.1+(4,1).  Length problem in match. */
 273     OFPERR_OFPBMC_BAD_LEN,
 274
 275     /* OF1.1+(4,2).  Match uses an unsupported tag/encap. */
 276     OFPERR_OFPBMC_BAD_TAG,
 277
 278     /* OF1.1+(4,3).  Unsupported datalink addr mask - switch does not support
 279      * arbitrary datalink address mask. */
 280     OFPERR_OFPBMC_BAD_DL_ADDR_MASK,
 281
 282     /* OF1.1+(4,4).  Unsupported network addr mask - switch does not support
 283      * arbitrary network address mask. */
 284     OFPERR_OFPBMC_BAD_NW_ADDR_MASK,
 285
 286     /* OF1.1+(4,5).  Unsupported wildcard specified in the match. */
 287     OFPERR_OFPBMC_BAD_WILDCARDS,
 288
 289     /* OF1.1+(4,6).  Unsupported field in the match. */
 290     OFPERR_OFPBMC_BAD_FIELD,
 291
 292     /* NX1.0(1,258), OF1.1+(4,7).  Unsupported value in a match
 293      * field. */
 294     OFPERR_OFPBMC_BAD_VALUE,
 295
 296     /* NX1.0(1,259), NX1.1(1,259), OF1.2+(4,8).  Unsupported mask specified in
 297      * the match, field is not dl-address or nw-address. */
 298     OFPERR_OFPBMC_BAD_MASK,
 299
 300     /* NX1.0(1,260), NX1.1(1,260), OF1.2+(4,9).  A prerequisite was not met. */
 301     OFPERR_OFPBMC_BAD_PREREQ,
 302
 303     /* NX1.0(1,261), NX1.1(1,261), OF1.2+(4,10).  A field type was
 304      * duplicated. */
 305     OFPERR_OFPBMC_DUP_FIELD,
 306
 307     /* OF1.2+(4,11).  Permissions error. */
 308     OFPERR_OFPBMC_EPERM,
 309
 310 /* ## --------------------- ## */
 311 /* ## OFPET_FLOW_MOD_FAILED ## */
 312 /* ## --------------------- ## */
 313
 314     /* OF1.0(3), OF1.1+(5).  Problem modifying flow entry. */
 315     OFPERR_OFPET_FLOW_MOD_FAILED,
 316
 317     /* OF1.1+(5,0).  Unspecified error. */
 318     OFPERR_OFPFMFC_UNKNOWN,
 319
 320     /* OF1.0(3,0), OF1.1+(5,1).  Flow not added because of full table(s). */
 321     OFPERR_OFPFMFC_TABLE_FULL,
 322
 323     /* OF1.1+(5,2).  Table does not exist */
 324     OFPERR_OFPFMFC_BAD_TABLE_ID,
 325
 326     /* OF1.0(3,1), OF1.1+(5,3).  Attempted to add overlapping flow with
 327      * CHECK_OVERLAP flag set. */
 328     OFPERR_OFPFMFC_OVERLAP,
 329
 330     /* OF1.0(3,2), OF1.1+(5,4).  Permissions error. */
 331     OFPERR_OFPFMFC_EPERM,
 332
 333     /* OF1.1+(5,5).  Flow not added because of unsupported idle/hard
 334      * timeout. */
 335     OFPERR_OFPFMFC_BAD_TIMEOUT,
 336
 337     /* OF1.0(3,3).  Flow not added because of non-zero idle/hard timeout. */
 338     OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT,
 339
 340     /* OF1.0(3,4), OF1.1+(5,6).  Unsupported or unknown command. */
 341     OFPERR_OFPFMFC_BAD_COMMAND,
 342
 343     /* OF1.2+(5,7).  Unsupported or unknown flags. */
 344     OFPERR_OFPFMFC_BAD_FLAGS,
 345
 346     /* OF1.0(3,5).  Unsupported action list - cannot process in the order
 347      * specified. */
 348     OFPERR_OFPFMFC_UNSUPPORTED,
 349
 350     /* NX1.0(3,256), NX1.1(5,256).  Generic hardware error. */
 351     OFPERR_NXFMFC_HARDWARE,
 352
 353     /* NX1.0(3,257), NX1.1(5,257).  A nonexistent table ID was specified in the
 354      * "command" field of struct ofp_flow_mod, when the nxt_flow_mod_table_id
 355      * extension is enabled. */
 356     OFPERR_NXFMFC_BAD_TABLE_ID,
 357
 358 /* ## ---------------------- ## */
 359 /* ## OFPET_GROUP_MOD_FAILED ## */
 360 /* ## ---------------------- ## */
 361
 362     /* OF1.1+(6).  Problem modifying group entry. */
 363     OFPERR_OFPET_GROUP_MOD_FAILED,
 364
 365     /* OF1.1+(6,0).  Group not added because a group ADD attempted to replace
 366      * an already-present group. */
 367     OFPERR_OFPGMFC_GROUP_EXISTS,
 368
 369     /* OF1.1+(6,1).  Group not added because Group specified is invalid. */
 370     OFPERR_OFPGMFC_INVALID_GROUP,
 371
 372     /* OF1.1+(6,2).  Switch does not support unequal load sharing with select
 373      * groups. */
 374     OFPERR_OFPGMFC_WEIGHT_UNSUPPORTED,
 375
 376     /* OF1.1+(6,3).  The group table is full. */
 377     OFPERR_OFPGMFC_OUT_OF_GROUPS,
 378
 379     /* OF1.1+(6,4).  The maximum number of action buckets for a group has been
 380      * exceeded. */
 381     OFPERR_OFPGMFC_OUT_OF_BUCKETS,
 382
 383     /* OF1.1+(6,5).  Switch does not support groups that forward to groups. */
 384     OFPERR_OFPGMFC_CHAINING_UNSUPPORTED,
 385
 386     /* OF1.1+(6,6).  This group cannot watch the watch_port or watch_group
 387      * specified. */
 388     OFPERR_OFPGMFC_WATCH_UNSUPPORTED,
 389
 390     /* OF1.1+(6,7).  Group entry would cause a loop. */
 391     OFPERR_OFPGMFC_LOOP,
 392
 393     /* OF1.1+(6,8).  Group not modified because a group MODIFY attempted to
 394      * modify a non-existent group. */
 395     OFPERR_OFPGMFC_UNKNOWN_GROUP,
 396
 397     /* OF1.2+(6,9).  Group not deleted because another
 398                     group is forwarding to it. */
 399     OFPERR_OFPGMFC_CHAINED_GROUP,
 400
 401     /* OF1.2+(6,10).  Unsupported or unknown group type. */
 402     OFPERR_OFPGMFC_BAD_TYPE,
 403
 404     /* OF1.2+(6,11).  Unsupported or unknown command. */
 405     OFPERR_OFPGMFC_BAD_COMMAND,
 406
 407     /* OF1.2+(6,12).  Error in bucket. */
 408     OFPERR_OFPGMFC_OFPGMFC_BAD_BUCKET,
 409
 410     /* OF1.2+(6,13).  Error in watch port/group. */
 411     OFPERR_OFPGMFC_OFPGMFC_BAD_WATCH,
 412
 413     /* OF1.2+(6,14).  Permissions error. */
 414     OFPERR_OFPGMFC_OFPGMFC_EPERM,
 415
 416 /* ## --------------------- ## */
 417 /* ## OFPET_PORT_MOD_FAILED ## */
 418 /* ## --------------------- ## */
 419
 420     /* OF1.0(4), OF1.1+(7).  OFPT_PORT_MOD failed. */
 421     OFPERR_OFPET_PORT_MOD_FAILED,
 422
 423     /* OF1.0(4,0), OF1.1+(7,0).  Specified port does not exist. */
 424     OFPERR_OFPPMFC_BAD_PORT,
 425
 426     /* OF1.0(4,1), OF1.1+(7,1).  Specified hardware address does not match the
 427      * port number. */
 428     OFPERR_OFPPMFC_BAD_HW_ADDR,
 429
 430     /* OF1.1+(7,2).  Specified config is invalid. */
 431     OFPERR_OFPPMFC_BAD_CONFIG,
 432
 433     /* OF1.1+(7,3).  Specified advertise is invalid. */
 434     OFPERR_OFPPMFC_BAD_ADVERTISE,
 435
 436     /* OF1.2+(7,4).  Permissions error. */
 437     OFPERR_OFPPMFC_EPERM,
 438
 439 /* ## ---------------------- ## */
 440 /* ## OFPET_TABLE_MOD_FAILED ## */
 441 /* ## ---------------------- ## */
 442
 443     /* OF1.1+(8).  Table mod request failed. */
 444     OFPERR_OFPET_TABLE_MOD_FAILED,
 445
 446     /* OF1.1+(8,0).  Specified table does not exist. */
 447     OFPERR_OFPTMFC_BAD_TABLE,
 448
 449     /* OF1.1+(8,1).  Specified config is invalid. */
 450     OFPERR_OFPTMFC_BAD_CONFIG,
 451
 452     /* OF1.2+(8,2).  Permissions error. */
 453     OFPERR_OFPTMFC_EPERM,
 454
 455 /* ## --------------------- ## */
 456 /* ## OFPET_QUEUE_OP_FAILED ## */
 457 /* ## --------------------- ## */
 458
 459     /* OF1.0(5), OF1.1+(9).  Queue operation failed. */
 460     OFPERR_OFPET_QUEUE_OP_FAILED,
 461
 462     /* OF1.0(5,0), OF1.1+(9,0).  Invalid port (or port does not exist). */
 463     OFPERR_OFPQOFC_BAD_PORT,
 464
 465     /* OF1.0(5,1), OF1.1+(9,1).  Queue does not exist. */
 466     OFPERR_OFPQOFC_BAD_QUEUE,
 467
 468     /* OF1.0(5,2), OF1.1+(9,2).  Permissions error. */
 469     OFPERR_OFPQOFC_EPERM,
 470
 471 /* ## -------------------------- ## */
 472 /* ## OFPET_SWITCH_CONFIG_FAILED ## */
 473 /* ## -------------------------- ## */
 474
 475     /* OF1.1+(10).  Switch config request failed. */
 476     OFPERR_OFPET_SWITCH_CONFIG_FAILED,
 477
 478     /* OF1.1+(10,0).  Specified flags is invalid. */
 479     OFPERR_OFPSCFC_BAD_FLAGS,
 480
 481     /* OF1.1+(10,1).  Specified len is invalid. */
 482     OFPERR_OFPSCFC_BAD_LEN,
 483
 484     /* OF1.2+(10,2).  Permissions error. */
 485     OFPERR_OFPSCFC_EPERM,
 486
 487 /* ## ------------------------- ## */
 488 /* ## OFPET_ROLE_REQUEST_FAILED ## */
 489 /* ## ------------------------- ## */
 490
 491     /* OF1.2+(11).  Controller Role request failed. */
 492     OFPERR_OFPET_ROLE_REQUEST_FAILED,
 493
 494     /* OF1.2+(11,0).  Stale Message: old generation_id. */
 495     OFPERR_OFPRRFC_STALE,
 496
 497     /* OF1.2+(11,1).  Controller role change unsupported. */
 498     OFPERR_OFPRRFC_UNSUP,
 499
 500     /* NX1.0(1,513), NX1.1(1,513), OF1.2+(11,2).  Invalid role. */
 501     OFPERR_OFPRRFC_BAD_ROLE,
 502
 503 /* ## ---------------------- ## */
 504 /* ## OFPET_METER_MOD_FAILED ## */
 505 /* ## ---------------------- ## */
 506
 507     /* OF1.3+(12).  Error in meter. */
 508     OFPERR_OFPET_METER_MOD_FAILED,
 509
 510     /* OF1.3+(12,0).  Unspecified error. */
 511     OFPERR_OFPMMFC_UNKNOWN,
 512
 513     /* OF1.3+(12,1).  Meter not added because a Meter ADD attempted to
 514      * replace an existing Meter. */
 515     OFPERR_OFPMMFC_METER_EXISTS,
 516
 517     /* OF1.3+(12,2).  Meter not added because Meter specified is invalid. */
 518     OFPERR_OFPMMFC_INVALID_METER,
 519
 520     /* OF1.3+(12,3).  Meter not modified because a Meter MODIFY attempted
 521      * to modify a non-existent Meter. */
 522     OFPERR_OFPMMFC_UNKNOWN_METER,
 523
 524     /* OF1.3+(12,4).  Unsupported or unknown command. */
 525     OFPERR_OFPMMFC_BAD_COMMAND,
 526
 527     /* OF1.3+(12,5).  Flag configuration unsupported. */
 528     OFPERR_OFPMMFC_BAD_FLAGS,
 529
 530     /* OF1.3+(12,6).  Rate unsupported. */
 531     OFPERR_OFPMMFC_BAD_RATE,
 532
 533     /* OF1.3+(12,7).  Burst size unsupported. */
 534     OFPERR_OFPMMFC_BAD_BURST,
 535
 536     /* OF1.3+(12,8).  Band unsupported. */
 537     OFPERR_OFPMMFC_BAD_BAND,
 538
 539     /* OF1.3+(12,9).  Band value unsupported. */
 540     OFPERR_OFPMMFC_BAD_BAND_VALUE,
 541
 542     /* OF1.3+(12,10).  No more meters available. */
 543     OFPERR_OFPMMFC_OUT_OF_METERS,
 544
 545     /* OF1.3+(12,11).  The maximum number of properties for a meter has
 546      * been exceeded. */
 547     OFPERR_OFPMMFC_OUT_OF_BANDS,
 548
 549 /* ## --------------------------- ## */
 550 /* ## OFPET_TABLE_FEATURES_FAILED ## */
 551 /* ## --------------------------- ## */
 552
 553     /* OF1.3+(13).  Setting table features failed. */
 554     OFPERR_OFPET_TABLE_FEATURES_FAILED,
 555
 556     /* OF1.3+(13,0).  Specified table does not exist. */
 557     OFPERR_OFPTFFC_BAD_TABLE,
 558
 559     /* OF1.3+(13,1).  Invalid metadata mask. */
 560     OFPERR_OFPTFFC_BAD_METADATA,
 561
 562     /* OF1.3+(13,2).  Unknown property type. */
 563     OFPERR_OFPTFFC_BAD_TYPE,
 564
 565     /* OF1.3+(13,3).  Length problem in properties. */
 566     OFPERR_OFPTFFC_BAD_LEN,
 567
 568     /* OF1.3+(13,4).  Unsupported property value. */
 569     OFPERR_OFPTFFC_BAD_ARGUMENT,
 570
 571     /* OF1.3+(13,5).  Permissions error. */
 572     OFPERR_OFPTFFC_EPERM,
 573
 574 /* ## ------------------ ## */
 575 /* ## OFPET_EXPERIMENTER ## */
 576 /* ## ------------------ ## */
 577
 578     /* OF1.2+(0xffff).  Experimenter error messages. */
 579     OFPERR_OFPET_EXPERIMENTER,
 580 };
 581
 582 const char *ofperr_domain_get_name(enum ofp_version);
 583
 584 bool ofperr_is_valid(enum ofperr);
 585 bool ofperr_is_category(enum ofperr);
 586 bool ofperr_is_encodable(enum ofperr, enum ofp_version);
 587
 588 enum ofperr ofperr_decode(enum ofp_version, uint16_t type, uint16_t code);
 589 enum ofperr ofperr_decode_type(enum ofp_version, uint16_t type);
 590 enum ofperr ofperr_from_name(const char *);
 591
 592 enum ofperr ofperr_decode_msg(const struct ofp_header *,
 593                               struct ofpbuf *payload);
 594 struct ofpbuf *ofperr_encode_reply(enum ofperr, const struct ofp_header *);
 595 struct ofpbuf *ofperr_encode_hello(enum ofperr, enum ofp_version ofp_version,
 596                                    const char *);
 597 int ofperr_get_type(enum ofperr, enum ofp_version);
 598 int ofperr_get_code(enum ofperr, enum ofp_version);
 599
 600 const char *ofperr_get_name(enum ofperr);
 601 const char *ofperr_get_description(enum ofperr);
 602
 603 void ofperr_format(struct ds *, enum ofperr);
 604 const char *ofperr_to_string(enum ofperr);
 605
 606 #endif /* ofp-errors.h */