ffac8aa4a69fa5edde5ab3af779ac2f4831053f8
[openvswitch] / 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     /* NX1.0+(1,256).  Invalid NXM flow match. */
134     OFPERR_NXBRC_NXM_INVALID,
135
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,
139
140     /* NX1.0+(1,515).  Must-be-zero field had nonzero value. */
141     OFPERR_NXBRC_MUST_BE_ZERO,
142
143     /* NX1.0+(1,516).  The reason in an ofp_port_status message is not
144      * valid. */
145     OFPERR_NXBRC_BAD_REASON,
146
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,
151
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,
156
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,
160
161 /* ## ---------------- ## */
162 /* ## OFPET_BAD_ACTION ## */
163 /* ## ---------------- ## */
164
165     /* OF1.0+(2).  Error in action description. */
166     OFPERR_OFPET_BAD_ACTION,
167
168     /* OF1.0+(2,0).  Unknown action type. */
169     OFPERR_OFPBAC_BAD_TYPE,
170
171     /* OF1.0+(2,1).  Length problem in actions. */
172     OFPERR_OFPBAC_BAD_LEN,
173
174     /* OF1.0+(2,2).  Unknown experimenter id specified. */
175     OFPERR_OFPBAC_BAD_VENDOR,
176
177     /* OF1.0+(2,3).  Unknown action type for experimenter id. */
178     OFPERR_OFPBAC_BAD_VENDOR_TYPE,
179
180     /* OF1.0+(2,4).  Problem validating output port. */
181     OFPERR_OFPBAC_BAD_OUT_PORT,
182
183     /* OF1.0+(2,5).  Bad action argument. */
184     OFPERR_OFPBAC_BAD_ARGUMENT,
185
186     /* OF1.0+(2,6).  Permissions error. */
187     OFPERR_OFPBAC_EPERM,
188
189     /* OF1.0+(2,7).  Can't handle this many actions. */
190     OFPERR_OFPBAC_TOO_MANY,
191
192     /* OF1.0+(2,8).  Problem validating output queue. */
193     OFPERR_OFPBAC_BAD_QUEUE,
194
195     /* OF1.1+(2,9).  Invalid group id in forward action. */
196     OFPERR_OFPBAC_BAD_OUT_GROUP,
197
198     /* OF1.1+(2,10).  Action can't apply for this match. */
199     OFPERR_OFPBAC_MATCH_INCONSISTENT,
200
201     /* OF1.1+(2,11).  Action order is unsupported for the action list in an
202      * Apply-Actions instruction */
203     OFPERR_OFPBAC_UNSUPPORTED_ORDER,
204
205     /* OF1.1+(2,12).  Actions uses an unsupported tag/encap. */
206     OFPERR_OFPBAC_BAD_TAG,
207
208     /* OF1.2+(2,13).  Unsupported type in SET_FIELD action. */
209     OFPERR_OFPBAC_SET_TYPE,
210
211     /* OF1.2+(2,14).  Length problem in SET_FIELD action. */
212     OFPERR_OFPBAC_SET_LEN,
213
214     /* OF1.2+(2,15).  Bad argument in SET_FIELD action. */
215     OFPERR_OFPBAC_ARGUMENT,
216
217     /* NX1.0+(2,256).  Must-be-zero action argument had nonzero value. */
218     OFPERR_NXBAC_MUST_BE_ZERO,
219
220 /* ## --------------------- ## */
221 /* ## OFPET_BAD_INSTRUCTION ## */
222 /* ## --------------------- ## */
223
224     /* OF1.1+(3).  Error in instruction list. */
225     OFPERR_OFPIT_BAD_INSTRUCTION,
226
227     /* OF1.1+(3,0).  Unknown instruction. */
228     OFPERR_OFPBIC_UNKNOWN_INST,
229
230     /* OF1.1+(3,1).  Switch or table does not support the instruction. */
231     OFPERR_OFPBIC_UNSUP_INST,
232
233     /* OF1.1+(3,2).  Invalid Table-ID specified. */
234     OFPERR_OFPBIC_BAD_TABLE_ID,
235
236     /* OF1.1+(3,3).  Metadata value unsupported by datapath. */
237     OFPERR_OFPBIC_UNSUP_METADATA,
238
239     /* OF1.1+(3,4).  Metadata mask value unsupported by datapath. */
240     OFPERR_OFPBIC_UNSUP_METADATA_MASK,
241
242     /* OF1.1+(3,5).  Unknown experimenter id specified. */
243     OFPERR_OFPBIC_BAD_EXPERIMENTER,
244
245     /* OF1.1(3,5), OF1.2+(3,6).  Unknown instruction for experimenter id. */
246     OFPERR_OFPBIC_BAD_EXP_TYPE,
247
248     /* OF1.2+(3,7).  Length problem in instructions. */
249     OFPERR_OFPBIC_BAD_LEN,
250
251     /* OF1.2+(3,8).  Permissions error. */
252     OFPERR_OFPBIC_EPERM,
253
254 /* ## --------------- ## */
255 /* ## OFPET_BAD_MATCH ## */
256 /* ## --------------- ## */
257
258     /* OF1.1+(4).  Error in match. */
259     OFPERR_OFPET_BAD_MATCH,
260
261     /* OF1.1+(4,0).  Unsupported match type specified by the match */
262     OFPERR_OFPBMC_BAD_TYPE,
263
264     /* OF1.1+(4,1).  Length problem in match. */
265     OFPERR_OFPBMC_BAD_LEN,
266
267     /* OF1.1+(4,2).  Match uses an unsupported tag/encap. */
268     OFPERR_OFPBMC_BAD_TAG,
269
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,
273
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,
277
278     /* OF1.1+(4,5).  Unsupported wildcard specified in the match. */
279     OFPERR_OFPBMC_BAD_WILDCARDS,
280
281     /* OF1.1+(4,6).  Unsupported field in the match. */
282     OFPERR_OFPBMC_BAD_FIELD,
283
284     /* NX1.0(1,258), OF1.1+(4,7).  Unsupported value in a match
285      * field. */
286     OFPERR_OFPBMC_BAD_VALUE,
287
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,
291
292     /* NX1.0(1,260), NX1.1(1,260), OF1.2+(4,9).  A prerequisite was not met. */
293     OFPERR_OFPBMC_BAD_PREREQ,
294
295     /* NX1.0(1,261), NX1.1(1,261), OF1.2+(4,10).  A field type was
296      * duplicated. */
297     OFPERR_OFPBMC_DUP_FIELD,
298
299     /* OF1.2+(4,11).  Permissions error. */
300     OFPERR_OFPBMC_EPERM,
301
302 /* ## --------------------- ## */
303 /* ## OFPET_FLOW_MOD_FAILED ## */
304 /* ## --------------------- ## */
305
306     /* OF1.0(3), OF1.1+(5).  Problem modifying flow entry. */
307     OFPERR_OFPET_FLOW_MOD_FAILED,
308
309     /* OF1.1+(5,0).  Unspecified error. */
310     OFPERR_OFPFMFC_UNKNOWN,
311
312     /* OF1.0(3,0), OF1.1+(5,1).  Flow not added because of full table(s). */
313     OFPERR_OFPFMFC_TABLE_FULL,
314
315     /* OF1.1+(5,2).  Table does not exist */
316     OFPERR_OFPFMFC_BAD_TABLE_ID,
317
318     /* OF1.0(3,1), OF1.1+(5,3).  Attempted to add overlapping flow with
319      * CHECK_OVERLAP flag set. */
320     OFPERR_OFPFMFC_OVERLAP,
321
322     /* OF1.0(3,2), OF1.1+(5,4).  Permissions error. */
323     OFPERR_OFPFMFC_EPERM,
324
325     /* OF1.1+(5,5).  Flow not added because of unsupported idle/hard
326      * timeout. */
327     OFPERR_OFPFMFC_BAD_TIMEOUT,
328
329     /* OF1.0(3,3).  Flow not added because of non-zero idle/hard timeout. */
330     OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT,
331
332     /* OF1.0(3,4), OF1.1+(5,6).  Unsupported or unknown command. */
333     OFPERR_OFPFMFC_BAD_COMMAND,
334
335     /* OF1.2+(5,7).  Unsupported or unknown flags. */
336     OFPERR_OFPFMFC_BAD_FLAGS,
337
338     /* OF1.0(3,5).  Unsupported action list - cannot process in the order
339      * specified. */
340     OFPERR_OFPFMFC_UNSUPPORTED,
341
342     /* NX1.0(3,256), NX1.1(5,256).  Generic hardware error. */
343     OFPERR_NXFMFC_HARDWARE,
344
345     /* NX1.0(3,257), NX1.1(5,257).  A nonexistent table ID was specified in the
346      * "command" field of struct ofp_flow_mod, when the nxt_flow_mod_table_id
347      * extension is enabled. */
348     OFPERR_NXFMFC_BAD_TABLE_ID,
349
350 /* ## ---------------------- ## */
351 /* ## OFPET_GROUP_MOD_FAILED ## */
352 /* ## ---------------------- ## */
353
354     /* OF1.1+(6).  Problem modifying group entry. */
355     OFPERR_OFPET_GROUP_MOD_FAILED,
356
357     /* OF1.1+(6,0).  Group not added because a group ADD attempted to replace
358      * an already-present group. */
359     OFPERR_OFPGMFC_GROUP_EXISTS,
360
361     /* OF1.1+(6,1).  Group not added because Group specified is invalid. */
362     OFPERR_OFPGMFC_INVALID_GROUP,
363
364     /* OF1.1+(6,2).  Switch does not support unequal load sharing with select
365      * groups. */
366     OFPERR_OFPGMFC_WEIGHT_UNSUPPORTED,
367
368     /* OF1.1+(6,3).  The group table is full. */
369     OFPERR_OFPGMFC_OUT_OF_GROUPS,
370
371     /* OF1.1+(6,4).  The maximum number of action buckets for a group has been
372      * exceeded. */
373     OFPERR_OFPGMFC_OUT_OF_BUCKETS,
374
375     /* OF1.1+(6,5).  Switch does not support groups that forward to groups. */
376     OFPERR_OFPGMFC_CHAINING_UNSUPPORTED,
377
378     /* OF1.1+(6,6).  This group cannot watch the watch_port or watch_group
379      * specified. */
380     OFPERR_OFPGMFC_WATCH_UNSUPPORTED,
381
382     /* OF1.1+(6,7).  Group entry would cause a loop. */
383     OFPERR_OFPGMFC_LOOP,
384
385     /* OF1.1+(6,8).  Group not modified because a group MODIFY attempted to
386      * modify a non-existent group. */
387     OFPERR_OFPGMFC_UNKNOWN_GROUP,
388
389     /* OF1.2+(6,9).  Group not deleted because another
390                     group is forwarding to it. */
391     OFPERR_OFPGMFC_CHAINED_GROUP,
392
393     /* OF1.2+(6,10).  Unsupported or unknown group type. */
394     OFPERR_OFPGMFC_BAD_TYPE,
395
396     /* OF1.2+(6,11).  Unsupported or unknown command. */
397     OFPERR_OFPGMFC_BAD_COMMAND,
398
399     /* OF1.2+(6,12).  Error in bucket. */
400     OFPERR_OFPGMFC_OFPGMFC_BAD_BUCKET,
401
402     /* OF1.2+(6,13).  Error in watch port/group. */
403     OFPERR_OFPGMFC_OFPGMFC_BAD_WATCH,
404
405     /* OF1.2+(6,14).  Permissions error. */
406     OFPERR_OFPGMFC_OFPGMFC_EPERM,
407
408 /* ## --------------------- ## */
409 /* ## OFPET_PORT_MOD_FAILED ## */
410 /* ## --------------------- ## */
411
412     /* OF1.0(4), OF1.1+(7).  OFPT_PORT_MOD failed. */
413     OFPERR_OFPET_PORT_MOD_FAILED,
414
415     /* OF1.0(4,0), OF1.1+(7,0).  Specified port does not exist. */
416     OFPERR_OFPPMFC_BAD_PORT,
417
418     /* OF1.0(4,1), OF1.1+(7,1).  Specified hardware address does not match the
419      * port number. */
420     OFPERR_OFPPMFC_BAD_HW_ADDR,
421
422     /* OF1.1+(7,2).  Specified config is invalid. */
423     OFPERR_OFPPMFC_BAD_CONFIG,
424
425     /* OF1.1+(7,3).  Specified advertise is invalid. */
426     OFPERR_OFPPMFC_BAD_ADVERTISE,
427
428     /* OF1.2+(7,4).  Permissions error. */
429     OFPERR_OFPPMFC_EPERM,
430
431 /* ## ---------------------- ## */
432 /* ## OFPET_TABLE_MOD_FAILED ## */
433 /* ## ---------------------- ## */
434
435     /* OF1.1+(8).  Table mod request failed. */
436     OFPERR_OFPET_TABLE_MOD_FAILED,
437
438     /* OF1.1+(8,0).  Specified table does not exist. */
439     OFPERR_OFPTMFC_BAD_TABLE,
440
441     /* OF1.1+(8,1).  Specified config is invalid. */
442     OFPERR_OFPTMFC_BAD_CONFIG,
443
444     /* OF1.2+(8,2).  Permissions error. */
445     OFPERR_OFPTMFC_EPERM,
446
447 /* ## --------------------- ## */
448 /* ## OFPET_QUEUE_OP_FAILED ## */
449 /* ## --------------------- ## */
450
451     /* OF1.0(5), OF1.1+(9).  Queue operation failed. */
452     OFPERR_OFPET_QUEUE_OP_FAILED,
453
454     /* OF1.0(5,0), OF1.1+(9,0).  Invalid port (or port does not exist). */
455     OFPERR_OFPQOFC_BAD_PORT,
456
457     /* OF1.0(5,1), OF1.1+(9,1).  Queue does not exist. */
458     OFPERR_OFPQOFC_BAD_QUEUE,
459
460     /* OF1.0(5,2), OF1.1+(9,2).  Permissions error. */
461     OFPERR_OFPQOFC_EPERM,
462
463 /* ## -------------------------- ## */
464 /* ## OFPET_SWITCH_CONFIG_FAILED ## */
465 /* ## -------------------------- ## */
466
467     /* OF1.1+(10).  Switch config request failed. */
468     OFPERR_OFPET_SWITCH_CONFIG_FAILED,
469
470     /* OF1.1+(10,0).  Specified flags is invalid. */
471     OFPERR_OFPSCFC_BAD_FLAGS,
472
473     /* OF1.1+(10,1).  Specified len is invalid. */
474     OFPERR_OFPSCFC_BAD_LEN,
475
476     /* OF1.2+(10,2).  Permissions error. */
477     OFPERR_OFPSCFC_EPERM,
478
479 /* ## ------------------------- ## */
480 /* ## OFPET_ROLE_REQUEST_FAILED ## */
481 /* ## ------------------------- ## */
482
483     /* OF1.2+(11).  Controller Role request failed. */
484     OFPERR_OFPET_ROLE_REQUEST_FAILED,
485
486     /* OF1.2+(11,0).  Stale Message: old generation_id. */
487     OFPERR_OFPRRFC_STALE,
488
489     /* OF1.2+(11,1).  Controller role change unsupported. */
490     OFPERR_OFPRRFC_UNSUP,
491
492     /* NX1.0(1,513), NX1.1(1,513), OF1.2+(11,2).  Invalid role. */
493     OFPERR_OFPRRFC_BAD_ROLE,
494
495 /* ## ------------------ ## */
496 /* ## OFPET_EXPERIMENTER ## */
497 /* ## ------------------ ## */
498
499     /* OF1.2+(0xffff).  Experimenter error messages. */
500     OFPERR_OFPET_EXPERIMENTER,
501 };
502
503 const char *ofperr_domain_get_name(enum ofp_version);
504
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, enum ofp_version);
509
510 enum ofperr ofperr_decode(enum ofp_version, uint16_t type, uint16_t code);
511 enum ofperr ofperr_decode_type(enum ofp_version, uint16_t type);
512 enum ofperr ofperr_from_name(const char *);
513
514 enum ofperr ofperr_decode_msg(const struct ofp_header *,
515                               struct ofpbuf *payload);
516 struct ofpbuf *ofperr_encode_reply(enum ofperr, const struct ofp_header *);
517 struct ofpbuf *ofperr_encode_hello(enum ofperr, enum ofp_version ofp_version,
518                                    const char *);
519 int ofperr_get_type(enum ofperr, enum ofp_version);
520 int ofperr_get_code(enum ofperr, enum ofp_version);
521
522 const char *ofperr_get_name(enum ofperr);
523 const char *ofperr_get_description(enum ofperr);
524
525 void ofperr_format(struct ds *, enum ofperr);
526 const char *ofperr_to_string(enum ofperr);
527
528 #endif /* ofp-errors.h */