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
29 * We embed system errno values and OpenFlow standard and vendor extension
30 * error codes into the positive range of "int":
32 * - Errno values are assumed to use the range 1 through 2**30 - 1.
34 * (C and POSIX say that errno values are positive. We assume that they
35 * are less than 2**29. They are actually less than 65536 on at least
36 * Linux, FreeBSD, OpenBSD, and Windows.)
38 * - OpenFlow standard and vendor extension error codes use the range
39 * starting at 2**30 (OFPERR_OFS).
41 * Zero and negative values are not used.
44 #define OFPERR_OFS (1 << 30)
47 /* Expected duplications. */
49 /* Expected: 3,5 in OF1.1 means both OFPBIC_BAD_EXPERIMENTER and
50 * OFPBIC_BAD_EXP_TYPE. */
52 /* ## ------------------ ## */
53 /* ## OFPET_HELLO_FAILED ## */
54 /* ## ------------------ ## */
56 /* OF1.0+(0). Hello protocol failed. */
57 OFPERR_OFPET_HELLO_FAILED = OFPERR_OFS,
59 /* OF1.0+(0,0). No compatible version. */
60 OFPERR_OFPHFC_INCOMPATIBLE,
62 /* OF1.0+(0,1). Permissions error. */
65 /* ## ----------------- ## */
66 /* ## OFPET_BAD_REQUEST ## */
67 /* ## ----------------- ## */
69 /* OF1.0+(1). Request was not understood. */
70 OFPERR_OFPET_BAD_REQUEST,
72 /* OF1.0+(1,0). ofp_header.version not supported. */
73 OFPERR_OFPBRC_BAD_VERSION,
75 /* OF1.0+(1,1). ofp_header.type not supported. */
76 OFPERR_OFPBRC_BAD_TYPE,
78 /* OF1.0+(1,2). ofp_stats_msg.type not supported. */
79 OFPERR_OFPBRC_BAD_STAT,
81 /* OF1.0+(1,3). Vendor not supported (in ofp_vendor_header or
83 OFPERR_OFPBRC_BAD_VENDOR,
85 /* OF1.0+(1,4). Vendor subtype not supported. */
86 OFPERR_OFPBRC_BAD_SUBTYPE,
88 /* OF1.0+(1,5). Permissions error. */
91 /* OF1.0+(1,6). Wrong request length for type. */
92 OFPERR_OFPBRC_BAD_LEN,
94 /* OF1.0+(1,7). Specified buffer has already been used. */
95 OFPERR_OFPBRC_BUFFER_EMPTY,
97 /* OF1.0+(1,8). Specified buffer does not exist. */
98 OFPERR_OFPBRC_BUFFER_UNKNOWN,
100 /* OF1.1+(1,9). Specified table-id invalid or does not exist. */
101 OFPERR_OFPBRC_BAD_TABLE_ID,
103 /* OF1.2+(1,10). Denied because controller is slave. */
104 OFPERR_OFPBRC_IS_SLAVE,
106 /* OF1.2+(1,11). Invalid port. */
107 OFPERR_OFPBRC_BAD_PORT,
109 /* OF1.2+(1,12). Invalid packet in packet-out. */
110 OFPERR_OFPBRC_BAD_PACKET,
112 /* NX1.0+(1,256). Invalid NXM flow match. */
113 OFPERR_NXBRC_NXM_INVALID,
115 /* NX1.0+(1,257). The nxm_type, or nxm_type taken in combination with
116 * nxm_hasmask or nxm_length or both, is invalid or not implemented. */
117 OFPERR_NXBRC_NXM_BAD_TYPE,
119 /* NX1.0+(1,512). A request specified a nonexistent table ID. */
120 OFPERR_NXBRC_BAD_TABLE_ID,
122 /* NX1.0+(1,514). The in_port in an ofp_packet_out request is invalid. */
123 OFPERR_NXBRC_BAD_IN_PORT,
125 /* NX1.0+(1,515). Must-be-zero field had nonzero value. */
126 OFPERR_NXBRC_MUST_BE_ZERO,
128 /* NX1.0+(1,516). The reason in an ofp_port_status message is not
130 OFPERR_NXBRC_BAD_REASON,
132 /* NX1.0+(1,517). The 'id' in an NXST_FLOW_MONITOR request is the same as
133 * an existing monitor id (or two monitors in the same NXST_FLOW_MONITOR
134 * request have the same 'id'). */
135 OFPERR_NXBRC_FM_DUPLICATE_ID,
137 /* NX1.0+(1,518). The 'flags' in an NXST_FLOW_MONITOR request either does
138 * not specify at least one of the NXFMF_ADD, NXFMF_DELETE, or NXFMF_MODIFY
139 * flags, or specifies a flag bit that is not defined. */
140 OFPERR_NXBRC_FM_BAD_FLAGS,
142 /* NX1.0+(1,519). The 'id' in an NXT_FLOW_MONITOR_CANCEL request is not
143 * the id of any existing monitor. */
144 OFPERR_NXBRC_FM_BAD_ID,
146 /* ## ---------------- ## */
147 /* ## OFPET_BAD_ACTION ## */
148 /* ## ---------------- ## */
150 /* OF1.0+(2). Error in action description. */
151 OFPERR_OFPET_BAD_ACTION,
153 /* OF1.0+(2,0). Unknown action type. */
154 OFPERR_OFPBAC_BAD_TYPE,
156 /* OF1.0+(2,1). Length problem in actions. */
157 OFPERR_OFPBAC_BAD_LEN,
159 /* OF1.0+(2,2). Unknown experimenter id specified. */
160 OFPERR_OFPBAC_BAD_VENDOR,
162 /* OF1.0+(2,3). Unknown action type for experimenter id. */
163 OFPERR_OFPBAC_BAD_VENDOR_TYPE,
165 /* OF1.0+(2,4). Problem validating output port. */
166 OFPERR_OFPBAC_BAD_OUT_PORT,
168 /* OF1.0+(2,5). Bad action argument. */
169 OFPERR_OFPBAC_BAD_ARGUMENT,
171 /* OF1.0+(2,6). Permissions error. */
174 /* OF1.0+(2,7). Can't handle this many actions. */
175 OFPERR_OFPBAC_TOO_MANY,
177 /* OF1.0+(2,8). Problem validating output queue. */
178 OFPERR_OFPBAC_BAD_QUEUE,
180 /* OF1.1+(2,9). Invalid group id in forward action. */
181 OFPERR_OFPBAC_BAD_OUT_GROUP,
183 /* OF1.1+(2,10). Action can't apply for this match. */
184 OFPERR_OFPBAC_MATCH_INCONSISTENT,
186 /* OF1.1+(2,11). Action order is unsupported for the action list in an
187 * Apply-Actions instruction */
188 OFPERR_OFPBAC_UNSUPPORTED_ORDER,
190 /* OF1.1+(2,12). Actions uses an unsupported tag/encap. */
191 OFPERR_OFPBAC_BAD_TAG,
193 /* OF1.2+(2,13). Unsupported type in SET_FIELD action. */
194 OFPERR_OFPBAC_SET_TYPE,
196 /* OF1.2+(2,14). Length problem in SET_FIELD action. */
197 OFPERR_OFPBAC_SET_LEN,
199 /* OF1.2+(2,15). Bad argument in SET_FIELD action. */
200 OFPERR_OFPBAC_ARGUMENT,
202 /* NX1.0+(2,256). Must-be-zero action argument had nonzero value. */
203 OFPERR_NXBAC_MUST_BE_ZERO,
205 /* ## --------------------- ## */
206 /* ## OFPET_BAD_INSTRUCTION ## */
207 /* ## --------------------- ## */
209 /* OF1.1+(3). Error in instruction list. */
210 OFPERR_OFPIT_BAD_INSTRUCTION,
212 /* OF1.1+(3,0). Unknown instruction. */
213 OFPERR_OFPBIC_UNKNOWN_INST,
215 /* OF1.1+(3,1). Switch or table does not support the instruction. */
216 OFPERR_OFPBIC_UNSUP_INST,
218 /* OF1.1+(3,2). Invalid Table-ID specified. */
219 OFPERR_OFPBIC_BAD_TABLE_ID,
221 /* OF1.1+(3,3). Metadata value unsupported by datapath. */
222 OFPERR_OFPBIC_UNSUP_METADATA,
224 /* OF1.1+(3,4). Metadata mask value unsupported by datapath. */
225 OFPERR_OFPBIC_UNSUP_METADATA_MASK,
227 /* OF1.1+(3,5). Unknown experimenter id specified. */
228 OFPERR_OFPBIC_BAD_EXPERIMENTER,
230 /* OF1.1(3,5), OF1.2+(3,6). Unknown instruction for experimenter id. */
231 OFPERR_OFPBIC_BAD_EXP_TYPE,
233 /* OF1.2+(3,7). Length problem in instructions. */
234 OFPERR_OFPBIC_BAD_LEN,
236 /* OF1.2+(3,8). Permissions error. */
239 /* NX1.1+(3,256). Duplicate instruction type in set of instructions. */
240 OFPERR_NXBIC_DUP_TYPE,
242 /* ## --------------- ## */
243 /* ## OFPET_BAD_MATCH ## */
244 /* ## --------------- ## */
246 /* OF1.1+(4). Error in match. */
247 OFPERR_OFPET_BAD_MATCH,
249 /* OF1.1+(4,0). Unsupported match type specified by the match */
250 OFPERR_OFPBMC_BAD_TYPE,
252 /* OF1.1+(4,1). Length problem in match. */
253 OFPERR_OFPBMC_BAD_LEN,
255 /* OF1.1+(4,2). Match uses an unsupported tag/encap. */
256 OFPERR_OFPBMC_BAD_TAG,
258 /* OF1.1+(4,3). Unsupported datalink addr mask - switch does not support
259 * arbitrary datalink address mask. */
260 OFPERR_OFPBMC_BAD_DL_ADDR_MASK,
262 /* OF1.1+(4,4). Unsupported network addr mask - switch does not support
263 * arbitrary network address mask. */
264 OFPERR_OFPBMC_BAD_NW_ADDR_MASK,
266 /* OF1.1+(4,5). Unsupported wildcard specified in the match. */
267 OFPERR_OFPBMC_BAD_WILDCARDS,
269 /* OF1.1+(4,6). Unsupported field in the match. */
270 OFPERR_OFPBMC_BAD_FIELD,
272 /* NX1.0(1,258), NX1.1(1,258), OF1.2+(4,7). Unsupported value in a match
274 OFPERR_OFPBMC_BAD_VALUE,
276 /* NX1.0(1,259), NX1.1(1,259), OF1.2+(4,8). Unsupported mask specified in
277 * the match, field is not dl-address or nw-address. */
278 OFPERR_OFPBMC_BAD_MASK,
280 /* NX1.0(1,260), NX1.1(1,260), OF1.2+(4,9). A prerequisite was not met. */
281 OFPERR_OFPBMC_BAD_PREREQ,
283 /* NX1.0(1,261), NX1.1(1,261), OF1.2+(4,10). A field type was
285 OFPERR_OFPBMC_DUP_FIELD,
287 /* OF1.2+(4,11). Permissions error. */
290 /* ## --------------------- ## */
291 /* ## OFPET_FLOW_MOD_FAILED ## */
292 /* ## --------------------- ## */
294 /* OF1.0(3), OF1.1+(5). Problem modifying flow entry. */
295 OFPERR_OFPET_FLOW_MOD_FAILED,
297 /* OF1.1+(5,0). Unspecified error. */
298 OFPERR_OFPFMFC_UNKNOWN,
300 /* OF1.0(3,0). Flow not added because of full tables. */
301 OFPERR_OFPFMFC_ALL_TABLES_FULL,
303 /* OF1.1+(5,1). Flow not added because table was full. */
304 OFPERR_OFPFMFC_TABLE_FULL,
306 /* OF1.1+(5,2). Table does not exist */
307 OFPERR_OFPFMFC_BAD_TABLE_ID,
309 /* OF1.0(3,1), OF1.1+(5,3). Attempted to add overlapping flow with
310 * CHECK_OVERLAP flag set. */
311 OFPERR_OFPFMFC_OVERLAP,
313 /* OF1.0(3,2), OF1.1+(5,4). Permissions error. */
314 OFPERR_OFPFMFC_EPERM,
316 /* OF1.1+(5,5). Flow not added because of unsupported idle/hard
318 OFPERR_OFPFMFC_BAD_TIMEOUT,
320 /* OF1.0(3,3). Flow not added because of non-zero idle/hard timeout. */
321 OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT,
323 /* OF1.0(3,4), OF1.1+(5,6). Unsupported or unknown command. */
324 OFPERR_OFPFMFC_BAD_COMMAND,
326 /* OF1.2+(5,7). Unsupported or unknown flags. */
327 OFPERR_OFPFMFC_BAD_FLAGS,
329 /* OF1.0(3,5). Unsupported action list - cannot process in the order
331 OFPERR_OFPFMFC_UNSUPPORTED,
333 /* NX1.0(3,256), NX1.1(5,256). Generic hardware error. */
334 OFPERR_NXFMFC_HARDWARE,
336 /* NX1.0(3,257), NX1.1(5,257). A nonexistent table ID was specified in the
337 * "command" field of struct ofp_flow_mod, when the nxt_flow_mod_table_id
338 * extension is enabled. */
339 OFPERR_NXFMFC_BAD_TABLE_ID,
341 /* ## ---------------------- ## */
342 /* ## OFPET_GROUP_MOD_FAILED ## */
343 /* ## ---------------------- ## */
345 /* OF1.1+(6). Problem modifying group entry. */
346 OFPERR_OFPET_GROUP_MOD_FAILED,
348 /* OF1.1+(6,0). Group not added because a group ADD attempted to replace
349 * an already-present group. */
350 OFPERR_OFPGMFC_GROUP_EXISTS,
352 /* OF1.1+(6,1). Group not added because Group specified is invalid. */
353 OFPERR_OFPGMFC_INVALID_GROUP,
355 /* OF1.1+(6,2). Switch does not support unequal load sharing with select
357 OFPERR_OFPGMFC_WEIGHT_UNSUPPORTED,
359 /* OF1.1+(6,3). The group table is full. */
360 OFPERR_OFPGMFC_OUT_OF_GROUPS,
362 /* OF1.1+(6,4). The maximum number of action buckets for a group has been
364 OFPERR_OFPGMFC_OUT_OF_BUCKETS,
366 /* OF1.1+(6,5). Switch does not support groups that forward to groups. */
367 OFPERR_OFPGMFC_CHAINING_UNSUPPORTED,
369 /* OF1.1+(6,6). This group cannot watch the watch_port or watch_group
371 OFPERR_OFPGMFC_WATCH_UNSUPPORTED,
373 /* OF1.1+(6,7). Group entry would cause a loop. */
376 /* OF1.1+(6,8). Group not modified because a group MODIFY attempted to
377 * modify a non-existent group. */
378 OFPERR_OFPGMFC_UNKNOWN_GROUP,
380 /* OF1.2+(6,9). Group not deleted because another
381 group is forwarding to it. */
382 OFPERR_OFPGMFC_CHAINED_GROUP,
384 /* OF1.2+(6,10). Unsupported or unknown group type. */
385 OFPERR_OFPGMFC_BAD_TYPE,
387 /* OF1.2+(6,11). Unsupported or unknown command. */
388 OFPERR_OFPGMFC_BAD_COMMAND,
390 /* OF1.2+(6,12). Error in bucket. */
391 OFPERR_OFPGMFC_OFPGMFC_BAD_BUCKET,
393 /* OF1.2+(6,13). Error in watch port/group. */
394 OFPERR_OFPGMFC_OFPGMFC_BAD_WATCH,
396 /* OF1.2+(6,14). Permissions error. */
397 OFPERR_OFPGMFC_OFPGMFC_EPERM,
399 /* ## --------------------- ## */
400 /* ## OFPET_PORT_MOD_FAILED ## */
401 /* ## --------------------- ## */
403 /* OF1.0(4), OF1.1+(7). OFPT_PORT_MOD failed. */
404 OFPERR_OFPET_PORT_MOD_FAILED,
406 /* OF1.0(4,0), OF1.1+(7,0). Specified port does not exist. */
407 OFPERR_OFPPMFC_BAD_PORT,
409 /* OF1.0(4,1), OF1.1+(7,1). Specified hardware address does not match the
411 OFPERR_OFPPMFC_BAD_HW_ADDR,
413 /* OF1.1+(7,2). Specified config is invalid. */
414 OFPERR_OFPPMFC_BAD_CONFIG,
416 /* OF1.1+(7,3). Specified advertise is invalid. */
417 OFPERR_OFPPMFC_BAD_ADVERTISE,
419 /* OF1.2+(7,4). Permissions error. */
420 OFPERR_OFPPMFC_EPERM,
422 /* ## ---------------------- ## */
423 /* ## OFPET_TABLE_MOD_FAILED ## */
424 /* ## ---------------------- ## */
426 /* OF1.1+(8). Table mod request failed. */
427 OFPERR_OFPET_TABLE_MOD_FAILED,
429 /* OF1.1+(8,0). Specified table does not exist. */
430 OFPERR_OFPTMFC_BAD_TABLE,
432 /* OF1.1+(8,1). Specified config is invalid. */
433 OFPERR_OFPTMFC_BAD_CONFIG,
435 /* OF1.2+(8,2). Permissions error. */
436 OFPERR_OFPTMFC_EPERM,
438 /* ## --------------------- ## */
439 /* ## OFPET_QUEUE_OP_FAILED ## */
440 /* ## --------------------- ## */
442 /* OF1.0(5), OF1.1+(9). Queue operation failed. */
443 OFPERR_OFPET_QUEUE_OP_FAILED,
445 /* OF1.0(5,0), OF1.1+(9,0). Invalid port (or port does not exist). */
446 OFPERR_OFPQOFC_BAD_PORT,
448 /* OF1.0(5,1), OF1.1+(9,1). Queue does not exist. */
449 OFPERR_OFPQOFC_BAD_QUEUE,
451 /* OF1.0(5,2), OF1.1+(9,2). Permissions error. */
452 OFPERR_OFPQOFC_EPERM,
454 /* ## -------------------------- ## */
455 /* ## OFPET_SWITCH_CONFIG_FAILED ## */
456 /* ## -------------------------- ## */
458 /* OF1.1+(10). Switch config request failed. */
459 OFPERR_OFPET_SWITCH_CONFIG_FAILED,
461 /* OF1.1+(10,0). Specified flags is invalid. */
462 OFPERR_OFPSCFC_BAD_FLAGS,
464 /* OF1.1+(10,1). Specified len is invalid. */
465 OFPERR_OFPSCFC_BAD_LEN,
467 /* OF1.2+(10,2). Permissions error. */
468 OFPERR_OFPSCFC_EPERM,
470 /* ## ------------------------- ## */
471 /* ## OFPET_ROLE_REQUEST_FAILED ## */
472 /* ## ------------------------- ## */
474 /* OF1.2+(11). Controller Role request failed. */
475 OFPERR_OFPET_ROLE_REQUEST_FAILED,
477 /* OF1.2+(11,0). Stale Message: old generation_id. */
478 OFPERR_OFPRRFC_STALE,
480 /* OF1.2+(11,1). Controller role change unsupported. */
481 OFPERR_OFPRRFC_UNSUP,
483 /* NX1.0(1,513), NX1.1(1,513), OF1.2+(11,2). Invalid role. */
484 OFPERR_OFPRRFC_BAD_ROLE,
486 /* ## ------------------ ## */
487 /* ## OFPET_EXPERIMENTER ## */
488 /* ## ------------------ ## */
490 /* OF1.2+(0xffff). Experimenter error messages. */
491 OFPERR_OFPET_EXPERIMENTER,
494 extern const struct ofperr_domain ofperr_of10;
495 extern const struct ofperr_domain ofperr_of11;
496 extern const struct ofperr_domain ofperr_of12;
498 const struct ofperr_domain *ofperr_domain_from_version(uint8_t version);
499 const char *ofperr_domain_get_name(const struct ofperr_domain *);
501 bool ofperr_is_valid(enum ofperr);
502 bool ofperr_is_category(enum ofperr);
503 bool ofperr_is_nx_extension(enum ofperr);
504 bool ofperr_is_encodable(enum ofperr, const struct ofperr_domain *);
506 enum ofperr ofperr_decode(const struct ofperr_domain *,
507 uint16_t type, uint16_t code);
508 enum ofperr ofperr_decode_type(const struct ofperr_domain *, uint16_t type);
509 enum ofperr ofperr_from_name(const char *);
511 enum ofperr ofperr_decode_msg(const struct ofp_header *, size_t *payload_ofs);
512 struct ofpbuf *ofperr_encode_reply(enum ofperr, const struct ofp_header *);
513 struct ofpbuf *ofperr_encode_hello(enum ofperr, const struct ofperr_domain *,
515 int ofperr_get_type(enum ofperr, const struct ofperr_domain *);
516 int ofperr_get_code(enum ofperr, const struct ofperr_domain *);
518 const char *ofperr_get_name(enum ofperr);
519 const char *ofperr_get_description(enum ofperr);
521 void ofperr_format(struct ds *, enum ofperr);
522 const char *ofperr_to_string(enum ofperr);
524 #endif /* ofp-errors.h */