2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #define OFP_ERRORS_H 1
24 #include "openflow/openflow.h"
31 * We embed system errno values and OpenFlow standard and vendor extension
32 * error codes into the positive range of "int":
34 * - Errno values are assumed to use the range 1 through 2**30 - 1.
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.)
40 * - OpenFlow standard and vendor extension error codes use the range
41 * starting at 2**30 (OFPERR_OFS).
43 * Zero and negative values are not used.
46 #define OFPERR_OFS (1 << 30)
48 /* OpenFlow error codes.
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:
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:
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.
60 * # The version can specify a specific OpenFlow version, a version
61 * range delimited by "-", or an open-ended range with "+".
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.)
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. */
76 /* Expected duplications. */
78 /* Expected: 0x0,3,5 in OF1.1 means both OFPBIC_BAD_EXPERIMENTER and
79 * OFPBIC_BAD_EXP_TYPE. */
81 /* ## ------------------ ## */
82 /* ## OFPET_HELLO_FAILED ## */
83 /* ## ------------------ ## */
85 /* OF1.0+(0,0). No compatible version. */
86 OFPERR_OFPHFC_INCOMPATIBLE = OFPERR_OFS,
88 /* OF1.0+(0,1). Permissions error. */
91 /* ## ----------------- ## */
92 /* ## OFPET_BAD_REQUEST ## */
93 /* ## ----------------- ## */
95 /* OF1.0+(1,0). ofp_header.version not supported. */
96 OFPERR_OFPBRC_BAD_VERSION,
98 /* OF1.0+(1,1). ofp_header.type not supported. */
99 OFPERR_OFPBRC_BAD_TYPE,
101 /* OF1.0+(1,2). ofp_stats_msg.type not supported. */
102 OFPERR_OFPBRC_BAD_STAT,
104 /* OF1.0+(1,3). Vendor not supported (in ofp_vendor_header or
106 OFPERR_OFPBRC_BAD_VENDOR,
108 /* OF1.0+(1,4). Vendor subtype not supported. */
109 OFPERR_OFPBRC_BAD_SUBTYPE,
111 /* OF1.0+(1,5). Permissions error. */
114 /* OF1.0+(1,6). Wrong request length for type. */
115 OFPERR_OFPBRC_BAD_LEN,
117 /* OF1.0+(1,7). Specified buffer has already been used. */
118 OFPERR_OFPBRC_BUFFER_EMPTY,
120 /* OF1.0+(1,8). Specified buffer does not exist. */
121 OFPERR_OFPBRC_BUFFER_UNKNOWN,
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,
129 /* OF1.2+(1,10). Denied because controller is slave. */
130 OFPERR_OFPBRC_IS_SLAVE,
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,
138 /* OF1.2+(1,12). Invalid packet in packet-out. */
139 OFPERR_OFPBRC_BAD_PACKET,
141 /* OF1.3+(1,13). Multipart request overflowed the assigned buffer. */
142 OFPERR_OFPBRC_MULTIPART_BUFFER_OVERFLOW,
144 /* NX1.0-1.1(1,256), NX1.2+(2). Invalid NXM flow match. */
145 OFPERR_NXBRC_NXM_INVALID,
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
150 OFPERR_NXBRC_NXM_BAD_TYPE,
152 /* NX1.0-1.1(1,515), NX1.2+(4). Must-be-zero field had nonzero value. */
153 OFPERR_NXBRC_MUST_BE_ZERO,
155 /* NX1.0-1.1(1,516), NX1.2+(5). The reason in an ofp_port_status message
157 OFPERR_NXBRC_BAD_REASON,
159 /* NX1.0-1.1(1,517), NX1.2+(6). The 'id' in an NXST_FLOW_MONITOR request
160 * is the same as an existing monitor id (or two monitors in the same
161 * NXST_FLOW_MONITOR request have the same 'id'). */
162 OFPERR_NXBRC_FM_DUPLICATE_ID,
164 /* NX1.0-1.1(1,518), NX1.2+(7). The 'flags' in an NXST_FLOW_MONITOR
165 * request either does not specify at least one of the NXFMF_ADD,
166 * NXFMF_DELETE, or NXFMF_MODIFY flags, or specifies a flag bit that is not
168 OFPERR_NXBRC_FM_BAD_FLAGS,
170 /* NX1.0-1.1(1,519), NX1.2+(8). The 'id' in an NXT_FLOW_MONITOR_CANCEL
171 * request is not the id of any existing monitor. */
172 OFPERR_NXBRC_FM_BAD_ID,
174 /* NX1.0-1.1(1,520), NX1.2+(9). The 'event' in an NXST_FLOW_MONITOR reply
175 * does not specify one of the NXFME_ABBREV, NXFME_ADD, NXFME_DELETE, or
177 OFPERR_NXBRC_FM_BAD_EVENT,
179 /* NX1.0-1.1(1,521), NX1.2+(10). The error that occurred cannot be
180 * represented in this OpenFlow version. */
181 OFPERR_NXBRC_UNENCODABLE_ERROR,
183 /* ## ---------------- ## */
184 /* ## OFPET_BAD_ACTION ## */
185 /* ## ---------------- ## */
187 /* OF1.0+(2,0). Unknown action type. */
188 OFPERR_OFPBAC_BAD_TYPE,
190 /* OF1.0+(2,1). Length problem in actions. */
191 OFPERR_OFPBAC_BAD_LEN,
193 /* OF1.0+(2,2). Unknown experimenter id specified. */
194 OFPERR_OFPBAC_BAD_VENDOR,
196 /* OF1.0+(2,3). Unknown action type for experimenter id. */
197 OFPERR_OFPBAC_BAD_VENDOR_TYPE,
199 /* OF1.0+(2,4). Problem validating output port. */
200 OFPERR_OFPBAC_BAD_OUT_PORT,
202 /* OF1.0+(2,5). Bad action argument. */
203 OFPERR_OFPBAC_BAD_ARGUMENT,
205 /* OF1.0+(2,6). Permissions error. */
208 /* OF1.0+(2,7). Can't handle this many actions. */
209 OFPERR_OFPBAC_TOO_MANY,
211 /* OF1.0+(2,8). Problem validating output queue. */
212 OFPERR_OFPBAC_BAD_QUEUE,
214 /* OF1.1+(2,9). Invalid group id in forward action. */
215 OFPERR_OFPBAC_BAD_OUT_GROUP,
217 /* NX1.0(1,522), OF1.1+(2,10). Action can't apply for this match or a
218 * prerequisite for use of this field is unmet. */
219 OFPERR_OFPBAC_MATCH_INCONSISTENT,
221 /* OF1.1+(2,11). Action order is unsupported for the action list in an
222 * Apply-Actions instruction */
223 OFPERR_OFPBAC_UNSUPPORTED_ORDER,
225 /* OF1.1+(2,12). Actions uses an unsupported tag/encap. */
226 OFPERR_OFPBAC_BAD_TAG,
228 /* NX1.0-1.1(1,523), OF1.2+(2,13). Action uses unknown or unsupported OXM
230 OFPERR_OFPBAC_BAD_SET_TYPE,
232 /* NX1.0-1.1(1,524), OF1.2+(2,14). Action references past the end of an
233 * OXM or NXM field, or uses a length of zero. */
234 OFPERR_OFPBAC_BAD_SET_LEN,
236 /* NX1.0-1.1(1,525), OF1.2+(2,15). Action sets a field to an invalid or
237 * unsupported value, or modifies a read-only field. */
238 OFPERR_OFPBAC_BAD_SET_ARGUMENT,
240 /* NX1.0-1.1(2,256), NX1.2+(11). Must-be-zero action argument had nonzero
242 OFPERR_NXBAC_MUST_BE_ZERO,
244 /* ## --------------------- ## */
245 /* ## OFPET_BAD_INSTRUCTION ## */
246 /* ## --------------------- ## */
248 /* OF1.1+(3,0). Unknown instruction. */
249 OFPERR_OFPBIC_UNKNOWN_INST,
251 /* OF1.1+(3,1). Switch or table does not support the instruction. */
252 OFPERR_OFPBIC_UNSUP_INST,
254 /* OF1.1+(3,2). Invalid Table-ID specified. */
255 OFPERR_OFPBIC_BAD_TABLE_ID,
257 /* OF1.1+(3,3). Metadata value unsupported by datapath. */
258 OFPERR_OFPBIC_UNSUP_METADATA,
260 /* OF1.1+(3,4). Metadata mask value unsupported by datapath. */
261 OFPERR_OFPBIC_UNSUP_METADATA_MASK,
263 /* OF1.1+(3,5). Unknown experimenter id specified. */
264 OFPERR_OFPBIC_BAD_EXPERIMENTER,
266 /* OF1.1(3,5), OF1.2+(3,6). Unknown instruction for experimenter id. */
267 OFPERR_OFPBIC_BAD_EXP_TYPE,
269 /* OF1.2+(3,7). Length problem in instructions. */
270 OFPERR_OFPBIC_BAD_LEN,
272 /* OF1.2+(3,8). Permissions error. */
275 /* ONF1.1+(2600). Duplicate instruction. */
276 OFPERR_ONFBIC_DUP_INSTRUCTION,
278 /* ## --------------- ## */
279 /* ## OFPET_BAD_MATCH ## */
280 /* ## --------------- ## */
282 /* OF1.1+(4,0). Unsupported match type specified by the match */
283 OFPERR_OFPBMC_BAD_TYPE,
285 /* OF1.1+(4,1). Length problem in match. */
286 OFPERR_OFPBMC_BAD_LEN,
288 /* OF1.1+(4,2). Match uses an unsupported tag/encap. */
289 OFPERR_OFPBMC_BAD_TAG,
291 /* OF1.1+(4,3). Unsupported datalink addr mask - switch does not support
292 * arbitrary datalink address mask. */
293 OFPERR_OFPBMC_BAD_DL_ADDR_MASK,
295 /* OF1.1+(4,4). Unsupported network addr mask - switch does not support
296 * arbitrary network address mask. */
297 OFPERR_OFPBMC_BAD_NW_ADDR_MASK,
299 /* OF1.1+(4,5). Unsupported wildcard specified in the match. */
300 OFPERR_OFPBMC_BAD_WILDCARDS,
302 /* OF1.1+(4,6). Unsupported field in the match. */
303 OFPERR_OFPBMC_BAD_FIELD,
305 /* NX1.0(1,258), OF1.1+(4,7). Unsupported value in a match
307 OFPERR_OFPBMC_BAD_VALUE,
309 /* NX1.0-1.1(1,259), OF1.2+(4,8). Unsupported mask specified in the match,
310 * field is not dl-address or nw-address. */
311 OFPERR_OFPBMC_BAD_MASK,
313 /* NX1.0-1.1(1,260), OF1.2+(4,9). A prerequisite was not met. */
314 OFPERR_OFPBMC_BAD_PREREQ,
316 /* NX1.0-1.1(1,261), OF1.2+(4,10). A field type was duplicated. */
317 OFPERR_OFPBMC_DUP_FIELD,
319 /* OF1.2+(4,11). Permissions error. */
322 /* ## --------------------- ## */
323 /* ## OFPET_FLOW_MOD_FAILED ## */
324 /* ## --------------------- ## */
326 /* OF1.1+(5,0). Unspecified error. */
327 OFPERR_OFPFMFC_UNKNOWN,
329 /* OF1.0(3,0), OF1.1+(5,1). Flow not added because of full table(s). */
330 OFPERR_OFPFMFC_TABLE_FULL,
332 /* OF1.1+(5,2). Table does not exist */
333 OFPERR_OFPFMFC_BAD_TABLE_ID,
335 /* OF1.0(3,1), OF1.1+(5,3). Attempted to add overlapping flow with
336 * CHECK_OVERLAP flag set. */
337 OFPERR_OFPFMFC_OVERLAP,
339 /* OF1.0(3,2), OF1.1+(5,4). Permissions error. */
340 OFPERR_OFPFMFC_EPERM,
342 /* OF1.1+(5,5). Flow not added because of unsupported idle/hard
344 OFPERR_OFPFMFC_BAD_TIMEOUT,
346 /* OF1.0(3,3). Flow not added because of non-zero idle/hard timeout. */
347 OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT,
349 /* OF1.0(3,4), OF1.1+(5,6). Unsupported or unknown command. */
350 OFPERR_OFPFMFC_BAD_COMMAND,
352 /* NX1.0(3,258), NX1.1(5,258), OF1.2+(5,7). Unsupported or unknown
354 OFPERR_OFPFMFC_BAD_FLAGS,
356 /* OF1.0(3,5). Unsupported action list - cannot process in the order
358 OFPERR_OFPFMFC_UNSUPPORTED,
360 /* NX1.0-1.1(5,256), NX1.2+(12). Generic hardware error. */
361 OFPERR_NXFMFC_HARDWARE,
363 /* NX1.0-1.1(5,257), NX1.2+(13). A nonexistent table ID was specified in
364 * the "command" field of struct ofp_flow_mod, when the
365 * nxt_flow_mod_table_id extension is enabled. */
366 OFPERR_NXFMFC_BAD_TABLE_ID,
368 /* ## ---------------------- ## */
369 /* ## OFPET_GROUP_MOD_FAILED ## */
370 /* ## ---------------------- ## */
372 /* OF1.1+(6,0). Group not added because a group ADD attempted to replace
373 * an already-present group. */
374 OFPERR_OFPGMFC_GROUP_EXISTS,
376 /* OF1.1+(6,1). Group not added because Group specified is invalid. */
377 OFPERR_OFPGMFC_INVALID_GROUP,
379 /* OF1.1+(6,2). Switch does not support unequal load sharing with select
381 OFPERR_OFPGMFC_WEIGHT_UNSUPPORTED,
383 /* OF1.1+(6,3). The group table is full. */
384 OFPERR_OFPGMFC_OUT_OF_GROUPS,
386 /* OF1.1+(6,4). The maximum number of action buckets for a group has been
388 OFPERR_OFPGMFC_OUT_OF_BUCKETS,
390 /* OF1.1+(6,5). Switch does not support groups that forward to groups. */
391 OFPERR_OFPGMFC_CHAINING_UNSUPPORTED,
393 /* OF1.1+(6,6). This group cannot watch the watch_port or watch_group
395 OFPERR_OFPGMFC_WATCH_UNSUPPORTED,
397 /* OF1.1+(6,7). Group entry would cause a loop. */
400 /* OF1.1+(6,8). Group not modified because a group MODIFY attempted to
401 * modify a non-existent group. */
402 OFPERR_OFPGMFC_UNKNOWN_GROUP,
404 /* OF1.2+(6,9). Group not deleted because another
405 group is forwarding to it. */
406 OFPERR_OFPGMFC_CHAINED_GROUP,
408 /* OF1.2+(6,10). Unsupported or unknown group type. */
409 OFPERR_OFPGMFC_BAD_TYPE,
411 /* OF1.2+(6,11). Unsupported or unknown command. */
412 OFPERR_OFPGMFC_BAD_COMMAND,
414 /* OF1.2+(6,12). Error in bucket. */
415 OFPERR_OFPGMFC_BAD_BUCKET,
417 /* OF1.2+(6,13). Error in watch port/group. */
418 OFPERR_OFPGMFC_BAD_WATCH,
420 /* OF1.2+(6,14). Permissions error. */
421 OFPERR_OFPGMFC_EPERM,
423 /* ## --------------------- ## */
424 /* ## OFPET_PORT_MOD_FAILED ## */
425 /* ## --------------------- ## */
427 /* OF1.0(4,0), OF1.1+(7,0). Specified port does not exist. */
428 OFPERR_OFPPMFC_BAD_PORT,
430 /* OF1.0(4,1), OF1.1+(7,1). Specified hardware address does not match the
432 OFPERR_OFPPMFC_BAD_HW_ADDR,
434 /* OF1.1+(7,2). Specified config is invalid. */
435 OFPERR_OFPPMFC_BAD_CONFIG,
437 /* OF1.1+(7,3). Specified advertise is invalid. */
438 OFPERR_OFPPMFC_BAD_ADVERTISE,
440 /* OF1.2+(7,4). Permissions error. */
441 OFPERR_OFPPMFC_EPERM,
443 /* ## ---------------------- ## */
444 /* ## OFPET_TABLE_MOD_FAILED ## */
445 /* ## ---------------------- ## */
447 /* OF1.1+(8,0). Specified table does not exist. */
448 OFPERR_OFPTMFC_BAD_TABLE,
450 /* OF1.1+(8,1). Specified config is invalid. */
451 OFPERR_OFPTMFC_BAD_CONFIG,
453 /* OF1.2+(8,2). Permissions error. */
454 OFPERR_OFPTMFC_EPERM,
456 /* ## --------------------- ## */
457 /* ## OFPET_QUEUE_OP_FAILED ## */
458 /* ## --------------------- ## */
460 /* OF1.0(5,0), OF1.1+(9,0). Invalid port (or port does not exist). */
461 OFPERR_OFPQOFC_BAD_PORT,
463 /* OF1.0(5,1), OF1.1+(9,1). Queue does not exist. */
464 OFPERR_OFPQOFC_BAD_QUEUE,
466 /* OF1.0(5,2), OF1.1+(9,2). Permissions error. */
467 OFPERR_OFPQOFC_EPERM,
469 /* ## -------------------------- ## */
470 /* ## OFPET_SWITCH_CONFIG_FAILED ## */
471 /* ## -------------------------- ## */
473 /* OF1.1+(10,0). Specified flags is invalid. */
474 OFPERR_OFPSCFC_BAD_FLAGS,
476 /* OF1.1+(10,1). Specified len is invalid. */
477 OFPERR_OFPSCFC_BAD_LEN,
479 /* OF1.2+(10,2). Permissions error. */
480 OFPERR_OFPSCFC_EPERM,
482 /* ## ------------------------- ## */
483 /* ## OFPET_ROLE_REQUEST_FAILED ## */
484 /* ## ------------------------- ## */
486 /* OF1.2+(11,0). Stale Message: old generation_id. */
487 OFPERR_OFPRRFC_STALE,
489 /* OF1.2+(11,1). Controller role change unsupported. */
490 OFPERR_OFPRRFC_UNSUP,
492 /* NX1.0-1.1(1,513), OF1.2+(11,2). Invalid role. */
493 OFPERR_OFPRRFC_BAD_ROLE,
495 /* ## ---------------------- ## */
496 /* ## OFPET_METER_MOD_FAILED ## */
497 /* ## ---------------------- ## */
499 /* OF1.3+(12,0). Unspecified error. */
500 OFPERR_OFPMMFC_UNKNOWN,
502 /* OF1.3+(12,1). Meter not added because a Meter ADD attempted to
503 * replace an existing Meter. */
504 OFPERR_OFPMMFC_METER_EXISTS,
506 /* OF1.3+(12,2). Meter not added because Meter specified is invalid. */
507 OFPERR_OFPMMFC_INVALID_METER,
509 /* OF1.3+(12,3). Meter not modified because a Meter MODIFY attempted
510 * to modify a non-existent Meter. */
511 OFPERR_OFPMMFC_UNKNOWN_METER,
513 /* OF1.3+(12,4). Unsupported or unknown command. */
514 OFPERR_OFPMMFC_BAD_COMMAND,
516 /* OF1.3+(12,5). Flag configuration unsupported. */
517 OFPERR_OFPMMFC_BAD_FLAGS,
519 /* OF1.3+(12,6). Rate unsupported. */
520 OFPERR_OFPMMFC_BAD_RATE,
522 /* OF1.3+(12,7). Burst size unsupported. */
523 OFPERR_OFPMMFC_BAD_BURST,
525 /* OF1.3+(12,8). Band unsupported. */
526 OFPERR_OFPMMFC_BAD_BAND,
528 /* OF1.3+(12,9). Band value unsupported. */
529 OFPERR_OFPMMFC_BAD_BAND_VALUE,
531 /* OF1.3+(12,10). No more meters available. */
532 OFPERR_OFPMMFC_OUT_OF_METERS,
534 /* OF1.3+(12,11). The maximum number of properties for a meter has
536 OFPERR_OFPMMFC_OUT_OF_BANDS,
538 /* ## --------------------------- ## */
539 /* ## OFPET_TABLE_FEATURES_FAILED ## */
540 /* ## --------------------------- ## */
542 /* OF1.3+(13,0). Specified table does not exist. */
543 OFPERR_OFPTFFC_BAD_TABLE,
545 /* OF1.3+(13,1). Invalid metadata mask. */
546 OFPERR_OFPTFFC_BAD_METADATA,
548 /* OF1.3+(13,2). Unknown property type. */
549 OFPERR_OFPTFFC_BAD_TYPE,
551 /* OF1.3+(13,3). Length problem in properties. */
552 OFPERR_OFPTFFC_BAD_LEN,
554 /* OF1.3+(13,4). Unsupported property value. */
555 OFPERR_OFPTFFC_BAD_ARGUMENT,
557 /* OF1.3+(13,5). Permissions error. */
558 OFPERR_OFPTFFC_EPERM,
560 /* ## ------------------ ## */
561 /* ## OFPET_EXPERIMENTER ## */
562 /* ## ------------------ ## */
565 const char *ofperr_domain_get_name(enum ofp_version);
567 bool ofperr_is_valid(enum ofperr);
569 enum ofperr ofperr_from_name(const char *);
571 enum ofperr ofperr_decode_msg(const struct ofp_header *,
572 struct ofpbuf *payload);
573 struct ofpbuf *ofperr_encode_reply(enum ofperr, const struct ofp_header *);
574 struct ofpbuf *ofperr_encode_hello(enum ofperr, enum ofp_version ofp_version,
576 int ofperr_get_vendor(enum ofperr, enum ofp_version);
577 int ofperr_get_type(enum ofperr, enum ofp_version);
578 int ofperr_get_code(enum ofperr, enum ofp_version);
580 const char *ofperr_get_name(enum ofperr);
581 const char *ofperr_get_description(enum ofperr);
583 void ofperr_format(struct ds *, enum ofperr);
584 const char *ofperr_to_string(enum ofperr);
586 #endif /* ofp-errors.h */