2 #include "ofp-errors.h"
4 #include "byte-order.h"
5 #include "dynamic-string.h"
9 #include "openflow/openflow.h"
12 VLOG_DEFINE_THIS_MODULE(ofp_errors);
18 #include "ofp-errors.inc"
20 /* Returns an ofperr_domain that corresponds to the OpenFlow version number
21 * 'version' (one of the possible values of struct ofp_header's 'version'
22 * member). Returns NULL if the version isn't defined or isn't understood by
24 static const struct ofperr_domain *
25 ofperr_domain_from_version(enum ofp_version version)
41 /* Returns the name (e.g. "OpenFlow 1.0") of OpenFlow version 'version'. */
43 ofperr_domain_get_name(enum ofp_version version)
45 const struct ofperr_domain *domain = ofperr_domain_from_version(version);
46 return domain ? domain->name : NULL;
49 /* Returns true if 'error' is a valid OFPERR_* value, false otherwise. */
51 ofperr_is_valid(enum ofperr error)
53 return error >= OFPERR_OFS && error < OFPERR_OFS + OFPERR_N_ERRORS;
56 /* Returns true if 'error' is a valid OFPERR_* value that designates a whole
57 * category of errors instead of a particular error, e.g. if it is an
58 * OFPERR_OFPET_* value, and false otherwise. */
60 ofperr_is_category(enum ofperr error)
62 return (ofperr_is_valid(error)
63 && ofperr_of10.errors[error - OFPERR_OFS].code == -1
64 && ofperr_of11.errors[error - OFPERR_OFS].code == -1);
66 /* Returns true if 'error' can be encoded as an OpenFlow error message in
67 * 'domain', false otherwise.
69 * A given error may not be encodable in some domains because each OpenFlow
70 * version tends to introduce new errors and retire some old ones. */
72 ofperr_is_encodable(enum ofperr error, enum ofp_version version)
74 const struct ofperr_domain *domain = ofperr_domain_from_version(version);
75 return (ofperr_is_valid(error)
76 && domain && domain->errors[error - OFPERR_OFS].code >= 0);
79 /* Returns the OFPERR_* value that corresponds to 'type' and 'code' within
80 * 'version', or 0 if either no such OFPERR_* value exists or 'version' is
83 ofperr_decode(enum ofp_version version, uint16_t type, uint16_t code)
85 const struct ofperr_domain *domain = ofperr_domain_from_version(version);
86 return domain ? domain->decode(type, code) : 0;
89 /* Returns the OFPERR_* value that corresponds to the category 'type' within
90 * 'version', or 0 if either no such OFPERR_* value exists or 'version' is
93 ofperr_decode_type(enum ofp_version version, uint16_t type)
95 const struct ofperr_domain *domain = ofperr_domain_from_version(version);
96 return domain ? domain->decode_type(type) : 0;
99 /* Returns the name of 'error', e.g. "OFPBRC_BAD_TYPE" if 'error' is
100 * OFPBRC_BAD_TYPE, or "<invalid>" if 'error' is not a valid OFPERR_* value.
102 * Consider ofperr_to_string() instead, if the error code might be an errno
105 ofperr_get_name(enum ofperr error)
107 return (ofperr_is_valid(error)
108 ? error_names[error - OFPERR_OFS]
112 /* Returns the OFPERR_* value that corresponds for 'name', 0 if none exists.
113 * For example, returns OFPERR_OFPHFC_INCOMPATIBLE if 'name' is
114 * "OFPHFC_INCOMPATIBLE".
116 * This is probably useful only for debugging and testing. */
118 ofperr_from_name(const char *name)
122 for (i = 0; i < OFPERR_N_ERRORS; i++) {
123 if (!strcmp(name, error_names[i])) {
124 return i + OFPERR_OFS;
130 /* Returns an extended description name of 'error', e.g. "ofp_header.type not
131 * supported." if 'error' is OFPBRC_BAD_TYPE, or "<invalid>" if 'error' is not
132 * a valid OFPERR_* value. */
134 ofperr_get_description(enum ofperr error)
136 return (ofperr_is_valid(error)
137 ? error_comments[error - OFPERR_OFS]
141 static const struct pair *
142 ofperr_get_pair__(enum ofperr error, const struct ofperr_domain *domain)
144 size_t ofs = error - OFPERR_OFS;
146 assert(ofperr_is_valid(error));
147 return &domain->errors[ofs];
150 static struct ofpbuf *
151 ofperr_encode_msg__(enum ofperr error, enum ofp_version ofp_version,
152 ovs_be32 xid, const void *data, size_t data_len)
154 struct ofp_error_msg *oem;
155 const struct pair *pair;
157 const struct ofperr_domain *domain;
159 domain = ofperr_domain_from_version(ofp_version);
164 if (!ofperr_is_encodable(error, ofp_version)) {
165 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
167 if (!ofperr_is_valid(error)) {
168 /* 'error' seems likely to be a system errno value. */
169 VLOG_WARN_RL(&rl, "invalid OpenFlow error code %d (%s)",
170 error, strerror(error));
172 const char *s = ofperr_get_name(error);
173 if (ofperr_is_category(error)) {
174 VLOG_WARN_RL(&rl, "cannot encode error category (%s)", s);
176 VLOG_WARN_RL(&rl, "cannot encode %s for %s", s, domain->name);
183 pair = ofperr_get_pair__(error, domain);
184 if (pair->code < 0x100) {
185 buf = ofpraw_alloc_xid(OFPRAW_OFPT_ERROR, domain->version, xid,
186 sizeof *oem + data_len);
188 oem = ofpbuf_put_uninit(buf, sizeof *oem);
189 oem->type = htons(pair->type);
190 oem->code = htons(pair->code);
192 struct nx_vendor_error *nve;
194 buf = ofpraw_alloc_xid(OFPRAW_OFPT_ERROR, domain->version, xid,
195 sizeof *oem + sizeof *nve + data_len);
197 oem = ofpbuf_put_uninit(buf, sizeof *oem);
198 oem->type = htons(NXET_VENDOR);
199 oem->code = htons(NXVC_VENDOR_ERROR);
201 nve = ofpbuf_put_uninit(buf, sizeof *nve);
202 nve->vendor = htonl(NX_VENDOR_ID);
203 nve->type = htons(pair->type);
204 nve->code = htons(pair->code);
207 ofpbuf_put(buf, data, data_len);
208 ofpmsg_update_length(buf);
213 /* Creates and returns an OpenFlow message of type OFPT_ERROR that conveys the
216 * 'oh->version' determines the OpenFlow version of the error reply.
217 * 'oh->xid' determines the xid of the error reply.
218 * The error reply will contain an initial subsequence of 'oh', up to
219 * 'oh->length' or 64 bytes, whichever is shorter.
221 * Returns NULL if 'error' is not an OpenFlow error code or if 'error' cannot
222 * be encoded as OpenFlow version 'oh->version'.
224 * This function isn't appropriate for encoding OFPET_HELLO_FAILED error
225 * messages. Use ofperr_encode_hello() instead. */
227 ofperr_encode_reply(enum ofperr error, const struct ofp_header *oh)
229 uint16_t len = ntohs(oh->length);
231 return ofperr_encode_msg__(error, oh->version, oh->xid, oh, MIN(len, 64));
234 /* Creates and returns an OpenFlow message of type OFPT_ERROR that conveys the
235 * given 'error', in the error domain 'domain'. The error message will include
236 * the additional null-terminated text string 's'.
238 * If 'version' is an unknown version then OFP10_VERSION is used.
239 * OFPET_HELLO_FAILED error messages are supposed to be backward-compatible,
240 * so in theory this should work.
242 * Returns NULL if 'error' is not an OpenFlow error code or if 'error' cannot
243 * be encoded in 'domain'. */
245 ofperr_encode_hello(enum ofperr error, enum ofp_version ofp_version,
248 switch (ofp_version) {
256 ofp_version = OFP10_VERSION;
259 return ofperr_encode_msg__(error, ofp_version, htonl(0), s, strlen(s));
262 /* Returns the value that would go into an OFPT_ERROR message's 'type' for
263 * encoding 'error' in 'domain'. Returns -1 if 'error' is not encodable in
264 * 'version' or 'version' is unknown.
266 * 'error' must be a valid OFPERR_* code, as checked by ofperr_is_valid(). */
268 ofperr_get_type(enum ofperr error, enum ofp_version version)
270 const struct ofperr_domain *domain = ofperr_domain_from_version(version);
271 return domain ? ofperr_get_pair__(error, domain)->type : -1;
274 /* Returns the value that would go into an OFPT_ERROR message's 'code' for
275 * encoding 'error' in 'domain'. Returns -1 if 'error' is not encodable in
276 * 'version', 'version' is unknown or if 'error' represents a category
277 * rather than a specific error.
280 * 'error' must be a valid OFPERR_* code, as checked by ofperr_is_valid(). */
282 ofperr_get_code(enum ofperr error, enum ofp_version version)
284 const struct ofperr_domain *domain = ofperr_domain_from_version(version);
285 return domain ? ofperr_get_pair__(error, domain)->code : -1;
288 /* Tries to decode 'oh', which should be an OpenFlow OFPT_ERROR message.
289 * Returns an OFPERR_* constant on success, 0 on failure.
291 * If 'payload' is nonnull, on success '*payload' is initialized to the
292 * error's payload, and on failure it is cleared. */
294 ofperr_decode_msg(const struct ofp_header *oh, struct ofpbuf *payload)
296 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
298 const struct ofp_error_msg *oem;
305 memset(payload, 0, sizeof *payload);
308 /* Pull off the error message. */
309 ofpbuf_use_const(&b, oh, ntohs(oh->length));
310 error = ofpraw_pull(&raw, &b);
314 oem = ofpbuf_pull(&b, sizeof *oem);
316 /* Get the error type and code. */
317 type = ntohs(oem->type);
318 code = ntohs(oem->code);
319 if (type == NXET_VENDOR && code == NXVC_VENDOR_ERROR) {
320 const struct nx_vendor_error *nve = ofpbuf_try_pull(&b, sizeof *nve);
325 if (nve->vendor != htonl(NX_VENDOR_ID)) {
326 VLOG_WARN_RL(&rl, "error contains unknown vendor ID %#"PRIx32,
330 type = ntohs(nve->type);
331 code = ntohs(nve->code);
334 /* Translate the error type and code into an ofperr.
335 * If we don't know the error type and code, at least try for the type. */
336 error = ofperr_decode(oh->version, type, code);
338 error = ofperr_decode_type(oh->version, type);
340 if (error && payload) {
341 ofpbuf_use_const(payload, b.data, b.size);
346 /* If 'error' is a valid OFPERR_* value, returns its name
347 * (e.g. "OFPBRC_BAD_TYPE" for OFPBRC_BAD_TYPE). Otherwise, assumes that
348 * 'error' is a positive errno value and returns what strerror() produces for
351 ofperr_to_string(enum ofperr error)
353 return ofperr_is_valid(error) ? ofperr_get_name(error) : strerror(error);