2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 OpenFlow type/code for each
55 * protocol that supports the error.
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. */
62 /* Expected duplications. */
64 /* Expected: 3,5 in OF1.1 means both OFPBIC_BAD_EXPERIMENTER and
65 * OFPBIC_BAD_EXP_TYPE. */
67 /* ## ------------------ ## */
68 /* ## OFPET_HELLO_FAILED ## */
69 /* ## ------------------ ## */
71 /* OF1.0+(0). Hello protocol failed. */
72 OFPERR_OFPET_HELLO_FAILED = OFPERR_OFS,
74 /* OF1.0+(0,0). No compatible version. */
75 OFPERR_OFPHFC_INCOMPATIBLE,
77 /* OF1.0+(0,1). Permissions error. */
80 /* ## ----------------- ## */
81 /* ## OFPET_BAD_REQUEST ## */
82 /* ## ----------------- ## */
84 /* OF1.0+(1). Request was not understood. */
85 OFPERR_OFPET_BAD_REQUEST,
87 /* OF1.0+(1,0). ofp_header.version not supported. */
88 OFPERR_OFPBRC_BAD_VERSION,
90 /* OF1.0+(1,1). ofp_header.type not supported. */
91 OFPERR_OFPBRC_BAD_TYPE,
93 /* OF1.0+(1,2). ofp_stats_msg.type not supported. */
94 OFPERR_OFPBRC_BAD_STAT,
96 /* OF1.0+(1,3). Vendor not supported (in ofp_vendor_header or
98 OFPERR_OFPBRC_BAD_VENDOR,
100 /* OF1.0+(1,4). Vendor subtype not supported. */
101 OFPERR_OFPBRC_BAD_SUBTYPE,
103 /* OF1.0+(1,5). Permissions error. */
106 /* OF1.0+(1,6). Wrong request length for type. */
107 OFPERR_OFPBRC_BAD_LEN,
109 /* OF1.0+(1,7). Specified buffer has already been used. */
110 OFPERR_OFPBRC_BUFFER_EMPTY,
112 /* OF1.0+(1,8). Specified buffer does not exist. */
113 OFPERR_OFPBRC_BUFFER_UNKNOWN,
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,
121 /* OF1.2+(1,10). Denied because controller is slave. */
122 OFPERR_OFPBRC_IS_SLAVE,
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,
130 /* OF1.2+(1,12). Invalid packet in packet-out. */
131 OFPERR_OFPBRC_BAD_PACKET,
133 /* NX1.0+(1,256). Invalid NXM flow match. */
134 OFPERR_NXBRC_NXM_INVALID,
136 /* NX1.0+(1,257). The nxm_type, or nxm_type taken in combination with
137 * nxm_hasmask or nxm_length or both, is invalid or not implemented. */
138 OFPERR_NXBRC_NXM_BAD_TYPE,
140 /* NX1.0+(1,515). Must-be-zero field had nonzero value. */
141 OFPERR_NXBRC_MUST_BE_ZERO,
143 /* NX1.0+(1,516). The reason in an ofp_port_status message is not
145 OFPERR_NXBRC_BAD_REASON,
147 /* NX1.0+(1,517). The 'id' in an NXST_FLOW_MONITOR request is the same as
148 * an existing monitor id (or two monitors in the same NXST_FLOW_MONITOR
149 * request have the same 'id'). */
150 OFPERR_NXBRC_FM_DUPLICATE_ID,
152 /* NX1.0+(1,518). The 'flags' in an NXST_FLOW_MONITOR request either does
153 * not specify at least one of the NXFMF_ADD, NXFMF_DELETE, or NXFMF_MODIFY
154 * flags, or specifies a flag bit that is not defined. */
155 OFPERR_NXBRC_FM_BAD_FLAGS,
157 /* NX1.0+(1,519). The 'id' in an NXT_FLOW_MONITOR_CANCEL request is not
158 * the id of any existing monitor. */
159 OFPERR_NXBRC_FM_BAD_ID,
161 /* ## ---------------- ## */
162 /* ## OFPET_BAD_ACTION ## */
163 /* ## ---------------- ## */
165 /* OF1.0+(2). Error in action description. */
166 OFPERR_OFPET_BAD_ACTION,
168 /* OF1.0+(2,0). Unknown action type. */
169 OFPERR_OFPBAC_BAD_TYPE,
171 /* OF1.0+(2,1). Length problem in actions. */
172 OFPERR_OFPBAC_BAD_LEN,
174 /* OF1.0+(2,2). Unknown experimenter id specified. */
175 OFPERR_OFPBAC_BAD_VENDOR,
177 /* OF1.0+(2,3). Unknown action type for experimenter id. */
178 OFPERR_OFPBAC_BAD_VENDOR_TYPE,
180 /* OF1.0+(2,4). Problem validating output port. */
181 OFPERR_OFPBAC_BAD_OUT_PORT,
183 /* OF1.0+(2,5). Bad action argument. */
184 OFPERR_OFPBAC_BAD_ARGUMENT,
186 /* OF1.0+(2,6). Permissions error. */
189 /* OF1.0+(2,7). Can't handle this many actions. */
190 OFPERR_OFPBAC_TOO_MANY,
192 /* OF1.0+(2,8). Problem validating output queue. */
193 OFPERR_OFPBAC_BAD_QUEUE,
195 /* OF1.1+(2,9). Invalid group id in forward action. */
196 OFPERR_OFPBAC_BAD_OUT_GROUP,
198 /* OF1.1+(2,10). Action can't apply for this match. */
199 OFPERR_OFPBAC_MATCH_INCONSISTENT,
201 /* OF1.1+(2,11). Action order is unsupported for the action list in an
202 * Apply-Actions instruction */
203 OFPERR_OFPBAC_UNSUPPORTED_ORDER,
205 /* OF1.1+(2,12). Actions uses an unsupported tag/encap. */
206 OFPERR_OFPBAC_BAD_TAG,
208 /* OF1.2+(2,13). Unsupported type in SET_FIELD action. */
209 OFPERR_OFPBAC_SET_TYPE,
211 /* OF1.2+(2,14). Length problem in SET_FIELD action. */
212 OFPERR_OFPBAC_SET_LEN,
214 /* OF1.2+(2,15). Bad argument in SET_FIELD action. */
215 OFPERR_OFPBAC_ARGUMENT,
217 /* NX1.0+(2,256). Must-be-zero action argument had nonzero value. */
218 OFPERR_NXBAC_MUST_BE_ZERO,
220 /* ## --------------------- ## */
221 /* ## OFPET_BAD_INSTRUCTION ## */
222 /* ## --------------------- ## */
224 /* OF1.1+(3). Error in instruction list. */
225 OFPERR_OFPIT_BAD_INSTRUCTION,
227 /* OF1.1+(3,0). Unknown instruction. */
228 OFPERR_OFPBIC_UNKNOWN_INST,
230 /* OF1.1+(3,1). Switch or table does not support the instruction. */
231 OFPERR_OFPBIC_UNSUP_INST,
233 /* OF1.1+(3,2). Invalid Table-ID specified. */
234 OFPERR_OFPBIC_BAD_TABLE_ID,
236 /* OF1.1+(3,3). Metadata value unsupported by datapath. */
237 OFPERR_OFPBIC_UNSUP_METADATA,
239 /* OF1.1+(3,4). Metadata mask value unsupported by datapath. */
240 OFPERR_OFPBIC_UNSUP_METADATA_MASK,
242 /* OF1.1+(3,5). Unknown experimenter id specified. */
243 OFPERR_OFPBIC_BAD_EXPERIMENTER,
245 /* OF1.1(3,5), OF1.2+(3,6). Unknown instruction for experimenter id. */
246 OFPERR_OFPBIC_BAD_EXP_TYPE,
248 /* OF1.2+(3,7). Length problem in instructions. */
249 OFPERR_OFPBIC_BAD_LEN,
251 /* OF1.2+(3,8). Permissions error. */
254 /* ## --------------- ## */
255 /* ## OFPET_BAD_MATCH ## */
256 /* ## --------------- ## */
258 /* OF1.1+(4). Error in match. */
259 OFPERR_OFPET_BAD_MATCH,
261 /* OF1.1+(4,0). Unsupported match type specified by the match */
262 OFPERR_OFPBMC_BAD_TYPE,
264 /* OF1.1+(4,1). Length problem in match. */
265 OFPERR_OFPBMC_BAD_LEN,
267 /* OF1.1+(4,2). Match uses an unsupported tag/encap. */
268 OFPERR_OFPBMC_BAD_TAG,
270 /* OF1.1+(4,3). Unsupported datalink addr mask - switch does not support
271 * arbitrary datalink address mask. */
272 OFPERR_OFPBMC_BAD_DL_ADDR_MASK,
274 /* OF1.1+(4,4). Unsupported network addr mask - switch does not support
275 * arbitrary network address mask. */
276 OFPERR_OFPBMC_BAD_NW_ADDR_MASK,
278 /* OF1.1+(4,5). Unsupported wildcard specified in the match. */
279 OFPERR_OFPBMC_BAD_WILDCARDS,
281 /* OF1.1+(4,6). Unsupported field in the match. */
282 OFPERR_OFPBMC_BAD_FIELD,
284 /* NX1.0(1,258), OF1.1+(4,7). Unsupported value in a match
286 OFPERR_OFPBMC_BAD_VALUE,
288 /* NX1.0(1,259), NX1.1(1,259), OF1.2+(4,8). Unsupported mask specified in
289 * the match, field is not dl-address or nw-address. */
290 OFPERR_OFPBMC_BAD_MASK,
292 /* NX1.0(1,260), NX1.1(1,260), OF1.2+(4,9). A prerequisite was not met. */
293 OFPERR_OFPBMC_BAD_PREREQ,
295 /* NX1.0(1,261), NX1.1(1,261), OF1.2+(4,10). A field type was
297 OFPERR_OFPBMC_DUP_FIELD,
299 /* OF1.2+(4,11). Permissions error. */
302 /* ## --------------------- ## */
303 /* ## OFPET_FLOW_MOD_FAILED ## */
304 /* ## --------------------- ## */
306 /* OF1.0(3), OF1.1+(5). Problem modifying flow entry. */
307 OFPERR_OFPET_FLOW_MOD_FAILED,
309 /* OF1.1+(5,0). Unspecified error. */
310 OFPERR_OFPFMFC_UNKNOWN,
312 /* OF1.0(3,0). Flow not added because of full tables. */
313 OFPERR_OFPFMFC_ALL_TABLES_FULL,
315 /* OF1.1+(5,1). Flow not added because table was full. */
316 OFPERR_OFPFMFC_TABLE_FULL,
318 /* OF1.1+(5,2). Table does not exist */
319 OFPERR_OFPFMFC_BAD_TABLE_ID,
321 /* OF1.0(3,1), OF1.1+(5,3). Attempted to add overlapping flow with
322 * CHECK_OVERLAP flag set. */
323 OFPERR_OFPFMFC_OVERLAP,
325 /* OF1.0(3,2), OF1.1+(5,4). Permissions error. */
326 OFPERR_OFPFMFC_EPERM,
328 /* OF1.1+(5,5). Flow not added because of unsupported idle/hard
330 OFPERR_OFPFMFC_BAD_TIMEOUT,
332 /* OF1.0(3,3). Flow not added because of non-zero idle/hard timeout. */
333 OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT,
335 /* OF1.0(3,4), OF1.1+(5,6). Unsupported or unknown command. */
336 OFPERR_OFPFMFC_BAD_COMMAND,
338 /* OF1.2+(5,7). Unsupported or unknown flags. */
339 OFPERR_OFPFMFC_BAD_FLAGS,
341 /* OF1.0(3,5). Unsupported action list - cannot process in the order
343 OFPERR_OFPFMFC_UNSUPPORTED,
345 /* NX1.0(3,256), NX1.1(5,256). Generic hardware error. */
346 OFPERR_NXFMFC_HARDWARE,
348 /* NX1.0(3,257), NX1.1(5,257). A nonexistent table ID was specified in the
349 * "command" field of struct ofp_flow_mod, when the nxt_flow_mod_table_id
350 * extension is enabled. */
351 OFPERR_NXFMFC_BAD_TABLE_ID,
353 /* ## ---------------------- ## */
354 /* ## OFPET_GROUP_MOD_FAILED ## */
355 /* ## ---------------------- ## */
357 /* OF1.1+(6). Problem modifying group entry. */
358 OFPERR_OFPET_GROUP_MOD_FAILED,
360 /* OF1.1+(6,0). Group not added because a group ADD attempted to replace
361 * an already-present group. */
362 OFPERR_OFPGMFC_GROUP_EXISTS,
364 /* OF1.1+(6,1). Group not added because Group specified is invalid. */
365 OFPERR_OFPGMFC_INVALID_GROUP,
367 /* OF1.1+(6,2). Switch does not support unequal load sharing with select
369 OFPERR_OFPGMFC_WEIGHT_UNSUPPORTED,
371 /* OF1.1+(6,3). The group table is full. */
372 OFPERR_OFPGMFC_OUT_OF_GROUPS,
374 /* OF1.1+(6,4). The maximum number of action buckets for a group has been
376 OFPERR_OFPGMFC_OUT_OF_BUCKETS,
378 /* OF1.1+(6,5). Switch does not support groups that forward to groups. */
379 OFPERR_OFPGMFC_CHAINING_UNSUPPORTED,
381 /* OF1.1+(6,6). This group cannot watch the watch_port or watch_group
383 OFPERR_OFPGMFC_WATCH_UNSUPPORTED,
385 /* OF1.1+(6,7). Group entry would cause a loop. */
388 /* OF1.1+(6,8). Group not modified because a group MODIFY attempted to
389 * modify a non-existent group. */
390 OFPERR_OFPGMFC_UNKNOWN_GROUP,
392 /* OF1.2+(6,9). Group not deleted because another
393 group is forwarding to it. */
394 OFPERR_OFPGMFC_CHAINED_GROUP,
396 /* OF1.2+(6,10). Unsupported or unknown group type. */
397 OFPERR_OFPGMFC_BAD_TYPE,
399 /* OF1.2+(6,11). Unsupported or unknown command. */
400 OFPERR_OFPGMFC_BAD_COMMAND,
402 /* OF1.2+(6,12). Error in bucket. */
403 OFPERR_OFPGMFC_OFPGMFC_BAD_BUCKET,
405 /* OF1.2+(6,13). Error in watch port/group. */
406 OFPERR_OFPGMFC_OFPGMFC_BAD_WATCH,
408 /* OF1.2+(6,14). Permissions error. */
409 OFPERR_OFPGMFC_OFPGMFC_EPERM,
411 /* ## --------------------- ## */
412 /* ## OFPET_PORT_MOD_FAILED ## */
413 /* ## --------------------- ## */
415 /* OF1.0(4), OF1.1+(7). OFPT_PORT_MOD failed. */
416 OFPERR_OFPET_PORT_MOD_FAILED,
418 /* OF1.0(4,0), OF1.1+(7,0). Specified port does not exist. */
419 OFPERR_OFPPMFC_BAD_PORT,
421 /* OF1.0(4,1), OF1.1+(7,1). Specified hardware address does not match the
423 OFPERR_OFPPMFC_BAD_HW_ADDR,
425 /* OF1.1+(7,2). Specified config is invalid. */
426 OFPERR_OFPPMFC_BAD_CONFIG,
428 /* OF1.1+(7,3). Specified advertise is invalid. */
429 OFPERR_OFPPMFC_BAD_ADVERTISE,
431 /* OF1.2+(7,4). Permissions error. */
432 OFPERR_OFPPMFC_EPERM,
434 /* ## ---------------------- ## */
435 /* ## OFPET_TABLE_MOD_FAILED ## */
436 /* ## ---------------------- ## */
438 /* OF1.1+(8). Table mod request failed. */
439 OFPERR_OFPET_TABLE_MOD_FAILED,
441 /* OF1.1+(8,0). Specified table does not exist. */
442 OFPERR_OFPTMFC_BAD_TABLE,
444 /* OF1.1+(8,1). Specified config is invalid. */
445 OFPERR_OFPTMFC_BAD_CONFIG,
447 /* OF1.2+(8,2). Permissions error. */
448 OFPERR_OFPTMFC_EPERM,
450 /* ## --------------------- ## */
451 /* ## OFPET_QUEUE_OP_FAILED ## */
452 /* ## --------------------- ## */
454 /* OF1.0(5), OF1.1+(9). Queue operation failed. */
455 OFPERR_OFPET_QUEUE_OP_FAILED,
457 /* OF1.0(5,0), OF1.1+(9,0). Invalid port (or port does not exist). */
458 OFPERR_OFPQOFC_BAD_PORT,
460 /* OF1.0(5,1), OF1.1+(9,1). Queue does not exist. */
461 OFPERR_OFPQOFC_BAD_QUEUE,
463 /* OF1.0(5,2), OF1.1+(9,2). Permissions error. */
464 OFPERR_OFPQOFC_EPERM,
466 /* ## -------------------------- ## */
467 /* ## OFPET_SWITCH_CONFIG_FAILED ## */
468 /* ## -------------------------- ## */
470 /* OF1.1+(10). Switch config request failed. */
471 OFPERR_OFPET_SWITCH_CONFIG_FAILED,
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). Controller Role request failed. */
487 OFPERR_OFPET_ROLE_REQUEST_FAILED,
489 /* OF1.2+(11,0). Stale Message: old generation_id. */
490 OFPERR_OFPRRFC_STALE,
492 /* OF1.2+(11,1). Controller role change unsupported. */
493 OFPERR_OFPRRFC_UNSUP,
495 /* NX1.0(1,513), NX1.1(1,513), OF1.2+(11,2). Invalid role. */
496 OFPERR_OFPRRFC_BAD_ROLE,
498 /* ## ------------------ ## */
499 /* ## OFPET_EXPERIMENTER ## */
500 /* ## ------------------ ## */
502 /* OF1.2+(0xffff). Experimenter error messages. */
503 OFPERR_OFPET_EXPERIMENTER,
506 const char *ofperr_domain_get_name(enum ofp_version);
508 bool ofperr_is_valid(enum ofperr);
509 bool ofperr_is_category(enum ofperr);
510 bool ofperr_is_nx_extension(enum ofperr);
511 bool ofperr_is_encodable(enum ofperr, enum ofp_version);
513 enum ofperr ofperr_decode(enum ofp_version, uint16_t type, uint16_t code);
514 enum ofperr ofperr_decode_type(enum ofp_version, uint16_t type);
515 enum ofperr ofperr_from_name(const char *);
517 enum ofperr ofperr_decode_msg(const struct ofp_header *,
518 struct ofpbuf *payload);
519 struct ofpbuf *ofperr_encode_reply(enum ofperr, const struct ofp_header *);
520 struct ofpbuf *ofperr_encode_hello(enum ofperr, enum ofp_version ofp_version,
522 int ofperr_get_type(enum ofperr, enum ofp_version);
523 int ofperr_get_code(enum ofperr, enum ofp_version);
525 const char *ofperr_get_name(enum ofperr);
526 const char *ofperr_get_description(enum ofperr);
528 void ofperr_format(struct ds *, enum ofperr);
529 const char *ofperr_to_string(enum ofperr);
531 #endif /* ofp-errors.h */