1af70da90a06bcead19f82853e31a10df6a69a55
[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 struct ds;
25 struct ofp_header;
26 struct ofpbuf;
27
28 /* Error codes.
29  *
30  * We embed system errno values and OpenFlow standard and vendor extension
31  * error codes into the positive range of "int":
32  *
33  *   - Errno values are assumed to use the range 1 through 2**30 - 1.
34  *
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.)
38  *
39  *   - OpenFlow standard and vendor extension error codes use the range
40  *     starting at 2**30 (OFPERR_OFS).
41  *
42  * Zero and negative values are not used.
43  */
44
45 #define OFPERR_OFS (1 << 30)
46
47 enum ofperr {
48 /* Expected duplications. */
49
50     /* Expected: 3,5 in OF1.1 means both OFPBIC_BAD_EXPERIMENTER and
51      * OFPBIC_BAD_EXP_TYPE. */
52
53 /* ## ------------------ ## */
54 /* ## OFPET_HELLO_FAILED ## */
55 /* ## ------------------ ## */
56
57     /* OF1.0+(0).  Hello protocol failed. */
58     OFPERR_OFPET_HELLO_FAILED = OFPERR_OFS,
59
60     /* OF1.0+(0,0).  No compatible version. */
61     OFPERR_OFPHFC_INCOMPATIBLE,
62
63     /* OF1.0+(0,1).  Permissions error. */
64     OFPERR_OFPHFC_EPERM,
65
66 /* ## ----------------- ## */
67 /* ## OFPET_BAD_REQUEST ## */
68 /* ## ----------------- ## */
69
70     /* OF1.0+(1).  Request was not understood. */
71     OFPERR_OFPET_BAD_REQUEST,
72
73     /* OF1.0+(1,0).  ofp_header.version not supported. */
74     OFPERR_OFPBRC_BAD_VERSION,
75
76     /* OF1.0+(1,1).  ofp_header.type not supported. */
77     OFPERR_OFPBRC_BAD_TYPE,
78
79     /* OF1.0+(1,2).  ofp_stats_msg.type not supported. */
80     OFPERR_OFPBRC_BAD_STAT,
81
82     /* OF1.0+(1,3).  Vendor not supported (in ofp_vendor_header or
83      * ofp_stats_msg). */
84     OFPERR_OFPBRC_BAD_VENDOR,
85
86     /* OF1.0+(1,4).  Vendor subtype not supported. */
87     OFPERR_OFPBRC_BAD_SUBTYPE,
88
89     /* OF1.0+(1,5).  Permissions error. */
90     OFPERR_OFPBRC_EPERM,
91
92     /* OF1.0+(1,6).  Wrong request length for type. */
93     OFPERR_OFPBRC_BAD_LEN,
94
95     /* OF1.0+(1,7).  Specified buffer has already been used. */
96     OFPERR_OFPBRC_BUFFER_EMPTY,
97
98     /* OF1.0+(1,8).  Specified buffer does not exist. */
99     OFPERR_OFPBRC_BUFFER_UNKNOWN,
100
101     /* OF1.1+(1,9).  Specified table-id invalid or does not exist. */
102     OFPERR_OFPBRC_BAD_TABLE_ID,
103
104     /* OF1.2+(1,10).  Denied because controller is slave. */
105     OFPERR_OFPBRC_IS_SLAVE,
106
107     /* OF1.2+(1,11).  Invalid port. */
108     OFPERR_OFPBRC_BAD_PORT,
109
110     /* OF1.2+(1,12).  Invalid packet in packet-out. */
111     OFPERR_OFPBRC_BAD_PACKET,
112
113     /* NX1.0+(1,256).  Invalid NXM flow match. */
114     OFPERR_NXBRC_NXM_INVALID,
115
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,
119
120     /* NX1.0+(1,512).  A request specified a nonexistent table ID. */
121     OFPERR_NXBRC_BAD_TABLE_ID,
122
123     /* NX1.0+(1,514).  The in_port in an ofp_packet_out request is invalid. */
124     OFPERR_NXBRC_BAD_IN_PORT,
125
126     /* NX1.0+(1,515).  Must-be-zero field had nonzero value. */
127     OFPERR_NXBRC_MUST_BE_ZERO,
128
129     /* NX1.0+(1,516).  The reason in an ofp_port_status message is not
130      * valid. */
131     OFPERR_NXBRC_BAD_REASON,
132
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,
137
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,
142
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,
146
147 /* ## ---------------- ## */
148 /* ## OFPET_BAD_ACTION ## */
149 /* ## ---------------- ## */
150
151     /* OF1.0+(2).  Error in action description. */
152     OFPERR_OFPET_BAD_ACTION,
153
154     /* OF1.0+(2,0).  Unknown action type. */
155     OFPERR_OFPBAC_BAD_TYPE,
156
157     /* OF1.0+(2,1).  Length problem in actions. */
158     OFPERR_OFPBAC_BAD_LEN,
159
160     /* OF1.0+(2,2).  Unknown experimenter id specified. */
161     OFPERR_OFPBAC_BAD_VENDOR,
162
163     /* OF1.0+(2,3).  Unknown action type for experimenter id. */
164     OFPERR_OFPBAC_BAD_VENDOR_TYPE,
165
166     /* OF1.0+(2,4).  Problem validating output port. */
167     OFPERR_OFPBAC_BAD_OUT_PORT,
168
169     /* OF1.0+(2,5).  Bad action argument. */
170     OFPERR_OFPBAC_BAD_ARGUMENT,
171
172     /* OF1.0+(2,6).  Permissions error. */
173     OFPERR_OFPBAC_EPERM,
174
175     /* OF1.0+(2,7).  Can't handle this many actions. */
176     OFPERR_OFPBAC_TOO_MANY,
177
178     /* OF1.0+(2,8).  Problem validating output queue. */
179     OFPERR_OFPBAC_BAD_QUEUE,
180
181     /* OF1.1+(2,9).  Invalid group id in forward action. */
182     OFPERR_OFPBAC_BAD_OUT_GROUP,
183
184     /* OF1.1+(2,10).  Action can't apply for this match. */
185     OFPERR_OFPBAC_MATCH_INCONSISTENT,
186
187     /* OF1.1+(2,11).  Action order is unsupported for the action list in an
188      * Apply-Actions instruction */
189     OFPERR_OFPBAC_UNSUPPORTED_ORDER,
190
191     /* OF1.1+(2,12).  Actions uses an unsupported tag/encap. */
192     OFPERR_OFPBAC_BAD_TAG,
193
194     /* OF1.2+(2,13).  Unsupported type in SET_FIELD action. */
195     OFPERR_OFPBAC_SET_TYPE,
196
197     /* OF1.2+(2,14).  Length problem in SET_FIELD action. */
198     OFPERR_OFPBAC_SET_LEN,
199
200     /* OF1.2+(2,15).  Bad argument in SET_FIELD action. */
201     OFPERR_OFPBAC_ARGUMENT,
202
203     /* NX1.0+(2,256).  Must-be-zero action argument had nonzero value. */
204     OFPERR_NXBAC_MUST_BE_ZERO,
205
206 /* ## --------------------- ## */
207 /* ## OFPET_BAD_INSTRUCTION ## */
208 /* ## --------------------- ## */
209
210     /* OF1.1+(3).  Error in instruction list. */
211     OFPERR_OFPIT_BAD_INSTRUCTION,
212
213     /* OF1.1+(3,0).  Unknown instruction. */
214     OFPERR_OFPBIC_UNKNOWN_INST,
215
216     /* OF1.1+(3,1).  Switch or table does not support the instruction. */
217     OFPERR_OFPBIC_UNSUP_INST,
218
219     /* OF1.1+(3,2).  Invalid Table-ID specified. */
220     OFPERR_OFPBIC_BAD_TABLE_ID,
221
222     /* OF1.1+(3,3).  Metadata value unsupported by datapath. */
223     OFPERR_OFPBIC_UNSUP_METADATA,
224
225     /* OF1.1+(3,4).  Metadata mask value unsupported by datapath. */
226     OFPERR_OFPBIC_UNSUP_METADATA_MASK,
227
228     /* OF1.1+(3,5).  Unknown experimenter id specified. */
229     OFPERR_OFPBIC_BAD_EXPERIMENTER,
230
231     /* OF1.1(3,5), OF1.2+(3,6).  Unknown instruction for experimenter id. */
232     OFPERR_OFPBIC_BAD_EXP_TYPE,
233
234     /* OF1.2+(3,7).  Length problem in instructions. */
235     OFPERR_OFPBIC_BAD_LEN,
236
237     /* OF1.2+(3,8).  Permissions error. */
238     OFPERR_OFPBIC_EPERM,
239
240     /* NX1.1+(3,256).  Duplicate instruction type in set of instructions. */
241     OFPERR_NXBIC_DUP_TYPE,
242
243 /* ## --------------- ## */
244 /* ## OFPET_BAD_MATCH ## */
245 /* ## --------------- ## */
246
247     /* OF1.1+(4).  Error in match. */
248     OFPERR_OFPET_BAD_MATCH,
249
250     /* OF1.1+(4,0).  Unsupported match type specified by the match */
251     OFPERR_OFPBMC_BAD_TYPE,
252
253     /* OF1.1+(4,1).  Length problem in match. */
254     OFPERR_OFPBMC_BAD_LEN,
255
256     /* OF1.1+(4,2).  Match uses an unsupported tag/encap. */
257     OFPERR_OFPBMC_BAD_TAG,
258
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,
262
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,
266
267     /* OF1.1+(4,5).  Unsupported wildcard specified in the match. */
268     OFPERR_OFPBMC_BAD_WILDCARDS,
269
270     /* OF1.1+(4,6).  Unsupported field in the match. */
271     OFPERR_OFPBMC_BAD_FIELD,
272
273     /* NX1.0(1,258), NX1.1(1,258), OF1.2+(4,7).  Unsupported value in a match
274      * field. */
275     OFPERR_OFPBMC_BAD_VALUE,
276
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,
280
281     /* NX1.0(1,260), NX1.1(1,260), OF1.2+(4,9).  A prerequisite was not met. */
282     OFPERR_OFPBMC_BAD_PREREQ,
283
284     /* NX1.0(1,261), NX1.1(1,261), OF1.2+(4,10).  A field type was
285      * duplicated. */
286     OFPERR_OFPBMC_DUP_FIELD,
287
288     /* OF1.2+(4,11).  Permissions error. */
289     OFPERR_OFPBMC_EPERM,
290
291 /* ## --------------------- ## */
292 /* ## OFPET_FLOW_MOD_FAILED ## */
293 /* ## --------------------- ## */
294
295     /* OF1.0(3), OF1.1+(5).  Problem modifying flow entry. */
296     OFPERR_OFPET_FLOW_MOD_FAILED,
297
298     /* OF1.1+(5,0).  Unspecified error. */
299     OFPERR_OFPFMFC_UNKNOWN,
300
301     /* OF1.0(3,0).  Flow not added because of full tables. */
302     OFPERR_OFPFMFC_ALL_TABLES_FULL,
303
304     /* OF1.1+(5,1).  Flow not added because table was full. */
305     OFPERR_OFPFMFC_TABLE_FULL,
306
307     /* OF1.1+(5,2).  Table does not exist */
308     OFPERR_OFPFMFC_BAD_TABLE_ID,
309
310     /* OF1.0(3,1), OF1.1+(5,3).  Attempted to add overlapping flow with
311      * CHECK_OVERLAP flag set. */
312     OFPERR_OFPFMFC_OVERLAP,
313
314     /* OF1.0(3,2), OF1.1+(5,4).  Permissions error. */
315     OFPERR_OFPFMFC_EPERM,
316
317     /* OF1.1+(5,5).  Flow not added because of unsupported idle/hard
318      * timeout. */
319     OFPERR_OFPFMFC_BAD_TIMEOUT,
320
321     /* OF1.0(3,3).  Flow not added because of non-zero idle/hard timeout. */
322     OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT,
323
324     /* OF1.0(3,4), OF1.1+(5,6).  Unsupported or unknown command. */
325     OFPERR_OFPFMFC_BAD_COMMAND,
326
327     /* OF1.2+(5,7).  Unsupported or unknown flags. */
328     OFPERR_OFPFMFC_BAD_FLAGS,
329
330     /* OF1.0(3,5).  Unsupported action list - cannot process in the order
331      * specified. */
332     OFPERR_OFPFMFC_UNSUPPORTED,
333
334     /* NX1.0(3,256), NX1.1(5,256).  Generic hardware error. */
335     OFPERR_NXFMFC_HARDWARE,
336
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,
341
342 /* ## ---------------------- ## */
343 /* ## OFPET_GROUP_MOD_FAILED ## */
344 /* ## ---------------------- ## */
345
346     /* OF1.1+(6).  Problem modifying group entry. */
347     OFPERR_OFPET_GROUP_MOD_FAILED,
348
349     /* OF1.1+(6,0).  Group not added because a group ADD attempted to replace
350      * an already-present group. */
351     OFPERR_OFPGMFC_GROUP_EXISTS,
352
353     /* OF1.1+(6,1).  Group not added because Group specified is invalid. */
354     OFPERR_OFPGMFC_INVALID_GROUP,
355
356     /* OF1.1+(6,2).  Switch does not support unequal load sharing with select
357      * groups. */
358     OFPERR_OFPGMFC_WEIGHT_UNSUPPORTED,
359
360     /* OF1.1+(6,3).  The group table is full. */
361     OFPERR_OFPGMFC_OUT_OF_GROUPS,
362
363     /* OF1.1+(6,4).  The maximum number of action buckets for a group has been
364      * exceeded. */
365     OFPERR_OFPGMFC_OUT_OF_BUCKETS,
366
367     /* OF1.1+(6,5).  Switch does not support groups that forward to groups. */
368     OFPERR_OFPGMFC_CHAINING_UNSUPPORTED,
369
370     /* OF1.1+(6,6).  This group cannot watch the watch_port or watch_group
371      * specified. */
372     OFPERR_OFPGMFC_WATCH_UNSUPPORTED,
373
374     /* OF1.1+(6,7).  Group entry would cause a loop. */
375     OFPERR_OFPGMFC_LOOP,
376
377     /* OF1.1+(6,8).  Group not modified because a group MODIFY attempted to
378      * modify a non-existent group. */
379     OFPERR_OFPGMFC_UNKNOWN_GROUP,
380
381     /* OF1.2+(6,9).  Group not deleted because another
382                     group is forwarding to it. */
383     OFPERR_OFPGMFC_CHAINED_GROUP,
384
385     /* OF1.2+(6,10).  Unsupported or unknown group type. */
386     OFPERR_OFPGMFC_BAD_TYPE,
387
388     /* OF1.2+(6,11).  Unsupported or unknown command. */
389     OFPERR_OFPGMFC_BAD_COMMAND,
390
391     /* OF1.2+(6,12).  Error in bucket. */
392     OFPERR_OFPGMFC_OFPGMFC_BAD_BUCKET,
393
394     /* OF1.2+(6,13).  Error in watch port/group. */
395     OFPERR_OFPGMFC_OFPGMFC_BAD_WATCH,
396
397     /* OF1.2+(6,14).  Permissions error. */
398     OFPERR_OFPGMFC_OFPGMFC_EPERM,
399
400 /* ## --------------------- ## */
401 /* ## OFPET_PORT_MOD_FAILED ## */
402 /* ## --------------------- ## */
403
404     /* OF1.0(4), OF1.1+(7).  OFPT_PORT_MOD failed. */
405     OFPERR_OFPET_PORT_MOD_FAILED,
406
407     /* OF1.0(4,0), OF1.1+(7,0).  Specified port does not exist. */
408     OFPERR_OFPPMFC_BAD_PORT,
409
410     /* OF1.0(4,1), OF1.1+(7,1).  Specified hardware address does not match the
411      * port number. */
412     OFPERR_OFPPMFC_BAD_HW_ADDR,
413
414     /* OF1.1+(7,2).  Specified config is invalid. */
415     OFPERR_OFPPMFC_BAD_CONFIG,
416
417     /* OF1.1+(7,3).  Specified advertise is invalid. */
418     OFPERR_OFPPMFC_BAD_ADVERTISE,
419
420     /* OF1.2+(7,4).  Permissions error. */
421     OFPERR_OFPPMFC_EPERM,
422
423 /* ## ---------------------- ## */
424 /* ## OFPET_TABLE_MOD_FAILED ## */
425 /* ## ---------------------- ## */
426
427     /* OF1.1+(8).  Table mod request failed. */
428     OFPERR_OFPET_TABLE_MOD_FAILED,
429
430     /* OF1.1+(8,0).  Specified table does not exist. */
431     OFPERR_OFPTMFC_BAD_TABLE,
432
433     /* OF1.1+(8,1).  Specified config is invalid. */
434     OFPERR_OFPTMFC_BAD_CONFIG,
435
436     /* OF1.2+(8,2).  Permissions error. */
437     OFPERR_OFPTMFC_EPERM,
438
439 /* ## --------------------- ## */
440 /* ## OFPET_QUEUE_OP_FAILED ## */
441 /* ## --------------------- ## */
442
443     /* OF1.0(5), OF1.1+(9).  Queue operation failed. */
444     OFPERR_OFPET_QUEUE_OP_FAILED,
445
446     /* OF1.0(5,0), OF1.1+(9,0).  Invalid port (or port does not exist). */
447     OFPERR_OFPQOFC_BAD_PORT,
448
449     /* OF1.0(5,1), OF1.1+(9,1).  Queue does not exist. */
450     OFPERR_OFPQOFC_BAD_QUEUE,
451
452     /* OF1.0(5,2), OF1.1+(9,2).  Permissions error. */
453     OFPERR_OFPQOFC_EPERM,
454
455 /* ## -------------------------- ## */
456 /* ## OFPET_SWITCH_CONFIG_FAILED ## */
457 /* ## -------------------------- ## */
458
459     /* OF1.1+(10).  Switch config request failed. */
460     OFPERR_OFPET_SWITCH_CONFIG_FAILED,
461
462     /* OF1.1+(10,0).  Specified flags is invalid. */
463     OFPERR_OFPSCFC_BAD_FLAGS,
464
465     /* OF1.1+(10,1).  Specified len is invalid. */
466     OFPERR_OFPSCFC_BAD_LEN,
467
468     /* OF1.2+(10,2).  Permissions error. */
469     OFPERR_OFPSCFC_EPERM,
470
471 /* ## ------------------------- ## */
472 /* ## OFPET_ROLE_REQUEST_FAILED ## */
473 /* ## ------------------------- ## */
474
475     /* OF1.2+(11).  Controller Role request failed. */
476     OFPERR_OFPET_ROLE_REQUEST_FAILED,
477
478     /* OF1.2+(11,0).  Stale Message: old generation_id. */
479     OFPERR_OFPRRFC_STALE,
480
481     /* OF1.2+(11,1).  Controller role change unsupported. */
482     OFPERR_OFPRRFC_UNSUP,
483
484     /* NX1.0(1,513), NX1.1(1,513), OF1.2+(11,2).  Invalid role. */
485     OFPERR_OFPRRFC_BAD_ROLE,
486
487 /* ## ------------------ ## */
488 /* ## OFPET_EXPERIMENTER ## */
489 /* ## ------------------ ## */
490
491     /* OF1.2+(0xffff).  Experimenter error messages. */
492     OFPERR_OFPET_EXPERIMENTER,
493 };
494
495 extern const struct ofperr_domain ofperr_of10;
496 extern const struct ofperr_domain ofperr_of11;
497 extern const struct ofperr_domain ofperr_of12;
498
499 const struct ofperr_domain *ofperr_domain_from_version(uint8_t version);
500 const char *ofperr_domain_get_name(const struct ofperr_domain *);
501
502 bool ofperr_is_valid(enum ofperr);
503 bool ofperr_is_category(enum ofperr);
504 bool ofperr_is_nx_extension(enum ofperr);
505 bool ofperr_is_encodable(enum ofperr, const struct ofperr_domain *);
506
507 enum ofperr ofperr_decode(const struct ofperr_domain *,
508                           uint16_t type, uint16_t code);
509 enum ofperr ofperr_decode_type(const struct ofperr_domain *, uint16_t type);
510 enum ofperr ofperr_from_name(const char *);
511
512 enum ofperr ofperr_decode_msg(const struct ofp_header *,
513                               struct ofpbuf *payload);
514 struct ofpbuf *ofperr_encode_reply(enum ofperr, const struct ofp_header *);
515 struct ofpbuf *ofperr_encode_hello(enum ofperr, const struct ofperr_domain *,
516                                    const char *);
517 int ofperr_get_type(enum ofperr, const struct ofperr_domain *);
518 int ofperr_get_code(enum ofperr, const struct ofperr_domain *);
519
520 const char *ofperr_get_name(enum ofperr);
521 const char *ofperr_get_description(enum ofperr);
522
523 void ofperr_format(struct ds *, enum ofperr);
524 const char *ofperr_to_string(enum ofperr);
525
526 #endif /* ofp-errors.h */