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