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
30 * We embed system errno values and OpenFlow standard and vendor extension
31 * error codes into the positive range of "int":
33 * - Errno values are assumed to use the range 1 through 2**30 - 1.
35 * (C and POSIX say that errno values are positive. We assume that they
36 * are less than 2**29. They are actually less than 65536 on at least
37 * Linux, FreeBSD, OpenBSD, and Windows.)
39 * - OpenFlow standard and vendor extension error codes use the range
40 * starting at 2**30 (OFPERR_OFS).
42 * Zero and negative values are not used.
45 #define OFPERR_OFS (1 << 30)
48 /* Expected duplications. */
50 /* Expected: 3,5 in OF1.1 means both OFPBIC_BAD_EXPERIMENTER and
51 * OFPBIC_BAD_EXP_TYPE. */
53 /* ## ------------------ ## */
54 /* ## OFPET_HELLO_FAILED ## */
55 /* ## ------------------ ## */
57 /* OF1.0+(0). Hello protocol failed. */
58 OFPERR_OFPET_HELLO_FAILED = OFPERR_OFS,
60 /* OF1.0+(0,0). No compatible version. */
61 OFPERR_OFPHFC_INCOMPATIBLE,
63 /* OF1.0+(0,1). Permissions error. */
66 /* ## ----------------- ## */
67 /* ## OFPET_BAD_REQUEST ## */
68 /* ## ----------------- ## */
70 /* OF1.0+(1). Request was not understood. */
71 OFPERR_OFPET_BAD_REQUEST,
73 /* OF1.0+(1,0). ofp_header.version not supported. */
74 OFPERR_OFPBRC_BAD_VERSION,
76 /* OF1.0+(1,1). ofp_header.type not supported. */
77 OFPERR_OFPBRC_BAD_TYPE,
79 /* OF1.0+(1,2). ofp_stats_msg.type not supported. */
80 OFPERR_OFPBRC_BAD_STAT,
82 /* OF1.0+(1,3). Vendor not supported (in ofp_vendor_header or
84 OFPERR_OFPBRC_BAD_VENDOR,
86 /* OF1.0+(1,4). Vendor subtype not supported. */
87 OFPERR_OFPBRC_BAD_SUBTYPE,
89 /* OF1.0+(1,5). Permissions error. */
92 /* OF1.0+(1,6). Wrong request length for type. */
93 OFPERR_OFPBRC_BAD_LEN,
95 /* OF1.0+(1,7). Specified buffer has already been used. */
96 OFPERR_OFPBRC_BUFFER_EMPTY,
98 /* OF1.0+(1,8). Specified buffer does not exist. */
99 OFPERR_OFPBRC_BUFFER_UNKNOWN,
101 /* OF1.1+(1,9). Specified table-id invalid or does not exist. */
102 OFPERR_OFPBRC_BAD_TABLE_ID,
104 /* OF1.2+(1,10). Denied because controller is slave. */
105 OFPERR_OFPBRC_IS_SLAVE,
107 /* OF1.2+(1,11). Invalid port. */
108 OFPERR_OFPBRC_BAD_PORT,
110 /* OF1.2+(1,12). Invalid packet in packet-out. */
111 OFPERR_OFPBRC_BAD_PACKET,
113 /* NX1.0+(1,256). Invalid NXM flow match. */
114 OFPERR_NXBRC_NXM_INVALID,
116 /* NX1.0+(1,257). The nxm_type, or nxm_type taken in combination with
117 * nxm_hasmask or nxm_length or both, is invalid or not implemented. */
118 OFPERR_NXBRC_NXM_BAD_TYPE,
120 /* NX1.0+(1,512). A request specified a nonexistent table ID. */
121 OFPERR_NXBRC_BAD_TABLE_ID,
123 /* NX1.0+(1,514). The in_port in an ofp_packet_out request is invalid. */
124 OFPERR_NXBRC_BAD_IN_PORT,
126 /* NX1.0+(1,515). Must-be-zero field had nonzero value. */
127 OFPERR_NXBRC_MUST_BE_ZERO,
129 /* NX1.0+(1,516). The reason in an ofp_port_status message is not
131 OFPERR_NXBRC_BAD_REASON,
133 /* NX1.0+(1,517). The 'id' in an NXST_FLOW_MONITOR request is the same as
134 * an existing monitor id (or two monitors in the same NXST_FLOW_MONITOR
135 * request have the same 'id'). */
136 OFPERR_NXBRC_FM_DUPLICATE_ID,
138 /* NX1.0+(1,518). The 'flags' in an NXST_FLOW_MONITOR request either does
139 * not specify at least one of the NXFMF_ADD, NXFMF_DELETE, or NXFMF_MODIFY
140 * flags, or specifies a flag bit that is not defined. */
141 OFPERR_NXBRC_FM_BAD_FLAGS,
143 /* NX1.0+(1,519). The 'id' in an NXT_FLOW_MONITOR_CANCEL request is not
144 * the id of any existing monitor. */
145 OFPERR_NXBRC_FM_BAD_ID,
147 /* ## ---------------- ## */
148 /* ## OFPET_BAD_ACTION ## */
149 /* ## ---------------- ## */
151 /* OF1.0+(2). Error in action description. */
152 OFPERR_OFPET_BAD_ACTION,
154 /* OF1.0+(2,0). Unknown action type. */
155 OFPERR_OFPBAC_BAD_TYPE,
157 /* OF1.0+(2,1). Length problem in actions. */
158 OFPERR_OFPBAC_BAD_LEN,
160 /* OF1.0+(2,2). Unknown experimenter id specified. */
161 OFPERR_OFPBAC_BAD_VENDOR,
163 /* OF1.0+(2,3). Unknown action type for experimenter id. */
164 OFPERR_OFPBAC_BAD_VENDOR_TYPE,
166 /* OF1.0+(2,4). Problem validating output port. */
167 OFPERR_OFPBAC_BAD_OUT_PORT,
169 /* OF1.0+(2,5). Bad action argument. */
170 OFPERR_OFPBAC_BAD_ARGUMENT,
172 /* OF1.0+(2,6). Permissions error. */
175 /* OF1.0+(2,7). Can't handle this many actions. */
176 OFPERR_OFPBAC_TOO_MANY,
178 /* OF1.0+(2,8). Problem validating output queue. */
179 OFPERR_OFPBAC_BAD_QUEUE,
181 /* OF1.1+(2,9). Invalid group id in forward action. */
182 OFPERR_OFPBAC_BAD_OUT_GROUP,
184 /* OF1.1+(2,10). Action can't apply for this match. */
185 OFPERR_OFPBAC_MATCH_INCONSISTENT,
187 /* OF1.1+(2,11). Action order is unsupported for the action list in an
188 * Apply-Actions instruction */
189 OFPERR_OFPBAC_UNSUPPORTED_ORDER,
191 /* OF1.1+(2,12). Actions uses an unsupported tag/encap. */
192 OFPERR_OFPBAC_BAD_TAG,
194 /* OF1.2+(2,13). Unsupported type in SET_FIELD action. */
195 OFPERR_OFPBAC_SET_TYPE,
197 /* OF1.2+(2,14). Length problem in SET_FIELD action. */
198 OFPERR_OFPBAC_SET_LEN,
200 /* OF1.2+(2,15). Bad argument in SET_FIELD action. */
201 OFPERR_OFPBAC_ARGUMENT,
203 /* NX1.0+(2,256). Must-be-zero action argument had nonzero value. */
204 OFPERR_NXBAC_MUST_BE_ZERO,
206 /* ## --------------------- ## */
207 /* ## OFPET_BAD_INSTRUCTION ## */
208 /* ## --------------------- ## */
210 /* OF1.1+(3). Error in instruction list. */
211 OFPERR_OFPIT_BAD_INSTRUCTION,
213 /* OF1.1+(3,0). Unknown instruction. */
214 OFPERR_OFPBIC_UNKNOWN_INST,
216 /* OF1.1+(3,1). Switch or table does not support the instruction. */
217 OFPERR_OFPBIC_UNSUP_INST,
219 /* OF1.1+(3,2). Invalid Table-ID specified. */
220 OFPERR_OFPBIC_BAD_TABLE_ID,
222 /* OF1.1+(3,3). Metadata value unsupported by datapath. */
223 OFPERR_OFPBIC_UNSUP_METADATA,
225 /* OF1.1+(3,4). Metadata mask value unsupported by datapath. */
226 OFPERR_OFPBIC_UNSUP_METADATA_MASK,
228 /* OF1.1+(3,5). Unknown experimenter id specified. */
229 OFPERR_OFPBIC_BAD_EXPERIMENTER,
231 /* OF1.1(3,5), OF1.2+(3,6). Unknown instruction for experimenter id. */
232 OFPERR_OFPBIC_BAD_EXP_TYPE,
234 /* OF1.2+(3,7). Length problem in instructions. */
235 OFPERR_OFPBIC_BAD_LEN,
237 /* OF1.2+(3,8). Permissions error. */
240 /* NX1.1+(3,256). Duplicate instruction type in set of instructions. */
241 OFPERR_NXBIC_DUP_TYPE,
243 /* ## --------------- ## */
244 /* ## OFPET_BAD_MATCH ## */
245 /* ## --------------- ## */
247 /* OF1.1+(4). Error in match. */
248 OFPERR_OFPET_BAD_MATCH,
250 /* OF1.1+(4,0). Unsupported match type specified by the match */
251 OFPERR_OFPBMC_BAD_TYPE,
253 /* OF1.1+(4,1). Length problem in match. */
254 OFPERR_OFPBMC_BAD_LEN,
256 /* OF1.1+(4,2). Match uses an unsupported tag/encap. */
257 OFPERR_OFPBMC_BAD_TAG,
259 /* OF1.1+(4,3). Unsupported datalink addr mask - switch does not support
260 * arbitrary datalink address mask. */
261 OFPERR_OFPBMC_BAD_DL_ADDR_MASK,
263 /* OF1.1+(4,4). Unsupported network addr mask - switch does not support
264 * arbitrary network address mask. */
265 OFPERR_OFPBMC_BAD_NW_ADDR_MASK,
267 /* OF1.1+(4,5). Unsupported wildcard specified in the match. */
268 OFPERR_OFPBMC_BAD_WILDCARDS,
270 /* OF1.1+(4,6). Unsupported field in the match. */
271 OFPERR_OFPBMC_BAD_FIELD,
273 /* NX1.0(1,258), NX1.1(1,258), OF1.2+(4,7). Unsupported value in a match
275 OFPERR_OFPBMC_BAD_VALUE,
277 /* NX1.0(1,259), NX1.1(1,259), OF1.2+(4,8). Unsupported mask specified in
278 * the match, field is not dl-address or nw-address. */
279 OFPERR_OFPBMC_BAD_MASK,
281 /* NX1.0(1,260), NX1.1(1,260), OF1.2+(4,9). A prerequisite was not met. */
282 OFPERR_OFPBMC_BAD_PREREQ,
284 /* NX1.0(1,261), NX1.1(1,261), OF1.2+(4,10). A field type was
286 OFPERR_OFPBMC_DUP_FIELD,
288 /* OF1.2+(4,11). Permissions error. */
291 /* ## --------------------- ## */
292 /* ## OFPET_FLOW_MOD_FAILED ## */
293 /* ## --------------------- ## */
295 /* OF1.0(3), OF1.1+(5). Problem modifying flow entry. */
296 OFPERR_OFPET_FLOW_MOD_FAILED,
298 /* OF1.1+(5,0). Unspecified error. */
299 OFPERR_OFPFMFC_UNKNOWN,
301 /* OF1.0(3,0). Flow not added because of full tables. */
302 OFPERR_OFPFMFC_ALL_TABLES_FULL,
304 /* OF1.1+(5,1). Flow not added because table was full. */
305 OFPERR_OFPFMFC_TABLE_FULL,
307 /* OF1.1+(5,2). Table does not exist */
308 OFPERR_OFPFMFC_BAD_TABLE_ID,
310 /* OF1.0(3,1), OF1.1+(5,3). Attempted to add overlapping flow with
311 * CHECK_OVERLAP flag set. */
312 OFPERR_OFPFMFC_OVERLAP,
314 /* OF1.0(3,2), OF1.1+(5,4). Permissions error. */
315 OFPERR_OFPFMFC_EPERM,
317 /* OF1.1+(5,5). Flow not added because of unsupported idle/hard
319 OFPERR_OFPFMFC_BAD_TIMEOUT,
321 /* OF1.0(3,3). Flow not added because of non-zero idle/hard timeout. */
322 OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT,
324 /* OF1.0(3,4), OF1.1+(5,6). Unsupported or unknown command. */
325 OFPERR_OFPFMFC_BAD_COMMAND,
327 /* OF1.2+(5,7). Unsupported or unknown flags. */
328 OFPERR_OFPFMFC_BAD_FLAGS,
330 /* OF1.0(3,5). Unsupported action list - cannot process in the order
332 OFPERR_OFPFMFC_UNSUPPORTED,
334 /* NX1.0(3,256), NX1.1(5,256). Generic hardware error. */
335 OFPERR_NXFMFC_HARDWARE,
337 /* NX1.0(3,257), NX1.1(5,257). A nonexistent table ID was specified in the
338 * "command" field of struct ofp_flow_mod, when the nxt_flow_mod_table_id
339 * extension is enabled. */
340 OFPERR_NXFMFC_BAD_TABLE_ID,
342 /* NX1.0+(3,258). 'out_group' specified but groups not yet supported. */
343 OFPERR_NXFMFC_GROUPS_NOT_SUPPORTED,
345 /* ## ---------------------- ## */
346 /* ## OFPET_GROUP_MOD_FAILED ## */
347 /* ## ---------------------- ## */
349 /* OF1.1+(6). Problem modifying group entry. */
350 OFPERR_OFPET_GROUP_MOD_FAILED,
352 /* OF1.1+(6,0). Group not added because a group ADD attempted to replace
353 * an already-present group. */
354 OFPERR_OFPGMFC_GROUP_EXISTS,
356 /* OF1.1+(6,1). Group not added because Group specified is invalid. */
357 OFPERR_OFPGMFC_INVALID_GROUP,
359 /* OF1.1+(6,2). Switch does not support unequal load sharing with select
361 OFPERR_OFPGMFC_WEIGHT_UNSUPPORTED,
363 /* OF1.1+(6,3). The group table is full. */
364 OFPERR_OFPGMFC_OUT_OF_GROUPS,
366 /* OF1.1+(6,4). The maximum number of action buckets for a group has been
368 OFPERR_OFPGMFC_OUT_OF_BUCKETS,
370 /* OF1.1+(6,5). Switch does not support groups that forward to groups. */
371 OFPERR_OFPGMFC_CHAINING_UNSUPPORTED,
373 /* OF1.1+(6,6). This group cannot watch the watch_port or watch_group
375 OFPERR_OFPGMFC_WATCH_UNSUPPORTED,
377 /* OF1.1+(6,7). Group entry would cause a loop. */
380 /* OF1.1+(6,8). Group not modified because a group MODIFY attempted to
381 * modify a non-existent group. */
382 OFPERR_OFPGMFC_UNKNOWN_GROUP,
384 /* OF1.2+(6,9). Group not deleted because another
385 group is forwarding to it. */
386 OFPERR_OFPGMFC_CHAINED_GROUP,
388 /* OF1.2+(6,10). Unsupported or unknown group type. */
389 OFPERR_OFPGMFC_BAD_TYPE,
391 /* OF1.2+(6,11). Unsupported or unknown command. */
392 OFPERR_OFPGMFC_BAD_COMMAND,
394 /* OF1.2+(6,12). Error in bucket. */
395 OFPERR_OFPGMFC_OFPGMFC_BAD_BUCKET,
397 /* OF1.2+(6,13). Error in watch port/group. */
398 OFPERR_OFPGMFC_OFPGMFC_BAD_WATCH,
400 /* OF1.2+(6,14). Permissions error. */
401 OFPERR_OFPGMFC_OFPGMFC_EPERM,
403 /* ## --------------------- ## */
404 /* ## OFPET_PORT_MOD_FAILED ## */
405 /* ## --------------------- ## */
407 /* OF1.0(4), OF1.1+(7). OFPT_PORT_MOD failed. */
408 OFPERR_OFPET_PORT_MOD_FAILED,
410 /* OF1.0(4,0), OF1.1+(7,0). Specified port does not exist. */
411 OFPERR_OFPPMFC_BAD_PORT,
413 /* OF1.0(4,1), OF1.1+(7,1). Specified hardware address does not match the
415 OFPERR_OFPPMFC_BAD_HW_ADDR,
417 /* OF1.1+(7,2). Specified config is invalid. */
418 OFPERR_OFPPMFC_BAD_CONFIG,
420 /* OF1.1+(7,3). Specified advertise is invalid. */
421 OFPERR_OFPPMFC_BAD_ADVERTISE,
423 /* OF1.2+(7,4). Permissions error. */
424 OFPERR_OFPPMFC_EPERM,
426 /* ## ---------------------- ## */
427 /* ## OFPET_TABLE_MOD_FAILED ## */
428 /* ## ---------------------- ## */
430 /* OF1.1+(8). Table mod request failed. */
431 OFPERR_OFPET_TABLE_MOD_FAILED,
433 /* OF1.1+(8,0). Specified table does not exist. */
434 OFPERR_OFPTMFC_BAD_TABLE,
436 /* OF1.1+(8,1). Specified config is invalid. */
437 OFPERR_OFPTMFC_BAD_CONFIG,
439 /* OF1.2+(8,2). Permissions error. */
440 OFPERR_OFPTMFC_EPERM,
442 /* ## --------------------- ## */
443 /* ## OFPET_QUEUE_OP_FAILED ## */
444 /* ## --------------------- ## */
446 /* OF1.0(5), OF1.1+(9). Queue operation failed. */
447 OFPERR_OFPET_QUEUE_OP_FAILED,
449 /* OF1.0(5,0), OF1.1+(9,0). Invalid port (or port does not exist). */
450 OFPERR_OFPQOFC_BAD_PORT,
452 /* OF1.0(5,1), OF1.1+(9,1). Queue does not exist. */
453 OFPERR_OFPQOFC_BAD_QUEUE,
455 /* OF1.0(5,2), OF1.1+(9,2). Permissions error. */
456 OFPERR_OFPQOFC_EPERM,
458 /* ## -------------------------- ## */
459 /* ## OFPET_SWITCH_CONFIG_FAILED ## */
460 /* ## -------------------------- ## */
462 /* OF1.1+(10). Switch config request failed. */
463 OFPERR_OFPET_SWITCH_CONFIG_FAILED,
465 /* OF1.1+(10,0). Specified flags is invalid. */
466 OFPERR_OFPSCFC_BAD_FLAGS,
468 /* OF1.1+(10,1). Specified len is invalid. */
469 OFPERR_OFPSCFC_BAD_LEN,
471 /* OF1.2+(10,2). Permissions error. */
472 OFPERR_OFPSCFC_EPERM,
474 /* ## ------------------------- ## */
475 /* ## OFPET_ROLE_REQUEST_FAILED ## */
476 /* ## ------------------------- ## */
478 /* OF1.2+(11). Controller Role request failed. */
479 OFPERR_OFPET_ROLE_REQUEST_FAILED,
481 /* OF1.2+(11,0). Stale Message: old generation_id. */
482 OFPERR_OFPRRFC_STALE,
484 /* OF1.2+(11,1). Controller role change unsupported. */
485 OFPERR_OFPRRFC_UNSUP,
487 /* NX1.0(1,513), NX1.1(1,513), OF1.2+(11,2). Invalid role. */
488 OFPERR_OFPRRFC_BAD_ROLE,
490 /* ## ------------------ ## */
491 /* ## OFPET_EXPERIMENTER ## */
492 /* ## ------------------ ## */
494 /* OF1.2+(0xffff). Experimenter error messages. */
495 OFPERR_OFPET_EXPERIMENTER,
498 extern const struct ofperr_domain ofperr_of10;
499 extern const struct ofperr_domain ofperr_of11;
500 extern const struct ofperr_domain ofperr_of12;
502 const struct ofperr_domain *ofperr_domain_from_version(uint8_t version);
503 const char *ofperr_domain_get_name(const struct ofperr_domain *);
505 bool ofperr_is_valid(enum ofperr);
506 bool ofperr_is_category(enum ofperr);
507 bool ofperr_is_nx_extension(enum ofperr);
508 bool ofperr_is_encodable(enum ofperr, const struct ofperr_domain *);
510 enum ofperr ofperr_decode(const struct ofperr_domain *,
511 uint16_t type, uint16_t code);
512 enum ofperr ofperr_decode_type(const struct ofperr_domain *, uint16_t type);
513 enum ofperr ofperr_from_name(const char *);
515 enum ofperr ofperr_decode_msg(const struct ofp_header *,
516 struct ofpbuf *payload);
517 struct ofpbuf *ofperr_encode_reply(enum ofperr, const struct ofp_header *);
518 struct ofpbuf *ofperr_encode_hello(enum ofperr, const struct ofperr_domain *,
520 int ofperr_get_type(enum ofperr, const struct ofperr_domain *);
521 int ofperr_get_code(enum ofperr, const struct ofperr_domain *);
523 const char *ofperr_get_name(enum ofperr);
524 const char *ofperr_get_description(enum ofperr);
526 void ofperr_format(struct ds *, enum ofperr);
527 const char *ofperr_to_string(enum ofperr);
529 #endif /* ofp-errors.h */