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)
39 /* Returns the name (e.g. "OpenFlow 1.0") of OpenFlow version 'version'. */
41 ofperr_domain_get_name(enum ofp_version version)
43 const struct ofperr_domain *domain = ofperr_domain_from_version(version);
44 return domain ? domain->name : NULL;
47 /* Returns true if 'error' is a valid OFPERR_* value, false otherwise. */
49 ofperr_is_valid(enum ofperr error)
51 return error >= OFPERR_OFS && error < OFPERR_OFS + OFPERR_N_ERRORS;
54 /* Returns true if 'error' is a valid OFPERR_* value that designates a whole
55 * category of errors instead of a particular error, e.g. if it is an
56 * OFPERR_OFPET_* value, and false otherwise. */
58 ofperr_is_category(enum ofperr error)
60 return (ofperr_is_valid(error)
61 && ofperr_of10.errors[error - OFPERR_OFS].code == -1
62 && ofperr_of11.errors[error - OFPERR_OFS].code == -1);
65 /* Returns true if 'error' is a valid OFPERR_* value that is a Nicira
66 * extension, e.g. if it is an OFPERR_NX* value, and false otherwise. */
68 ofperr_is_nx_extension(enum ofperr error)
70 return (ofperr_is_valid(error)
71 && (ofperr_of10.errors[error - OFPERR_OFS].code >= 0x100 ||
72 ofperr_of11.errors[error - OFPERR_OFS].code >= 0x100));
75 /* Returns true if 'error' can be encoded as an OpenFlow error message in
76 * 'domain', false otherwise.
78 * A given error may not be encodable in some domains because each OpenFlow
79 * version tends to introduce new errors and retire some old ones. */
81 ofperr_is_encodable(enum ofperr error, enum ofp_version version)
83 const struct ofperr_domain *domain = ofperr_domain_from_version(version);
84 return (ofperr_is_valid(error)
85 && domain && domain->errors[error - OFPERR_OFS].code >= 0);
88 /* Returns the OFPERR_* value that corresponds to 'type' and 'code' within
89 * 'version', or 0 if either no such OFPERR_* value exists or 'version' is
92 ofperr_decode(enum ofp_version version, uint16_t type, uint16_t code)
94 const struct ofperr_domain *domain = ofperr_domain_from_version(version);
95 return domain ? domain->decode(type, code) : 0;
98 /* Returns the OFPERR_* value that corresponds to the category 'type' within
99 * 'version', or 0 if either no such OFPERR_* value exists or 'version' is
102 ofperr_decode_type(enum ofp_version version, uint16_t type)
104 const struct ofperr_domain *domain = ofperr_domain_from_version(version);
105 return domain ? domain->decode_type(type) : 0;
108 /* Returns the name of 'error', e.g. "OFPBRC_BAD_TYPE" if 'error' is
109 * OFPBRC_BAD_TYPE, or "<invalid>" if 'error' is not a valid OFPERR_* value.
111 * Consider ofperr_to_string() instead, if the error code might be an errno
114 ofperr_get_name(enum ofperr error)
116 return (ofperr_is_valid(error)
117 ? error_names[error - OFPERR_OFS]
121 /* Returns the OFPERR_* value that corresponds for 'name', 0 if none exists.
122 * For example, returns OFPERR_OFPHFC_INCOMPATIBLE if 'name' is
123 * "OFPHFC_INCOMPATIBLE".
125 * This is probably useful only for debugging and testing. */
127 ofperr_from_name(const char *name)
131 for (i = 0; i < OFPERR_N_ERRORS; i++) {
132 if (!strcmp(name, error_names[i])) {
133 return i + OFPERR_OFS;
139 /* Returns an extended description name of 'error', e.g. "ofp_header.type not
140 * supported." if 'error' is OFPBRC_BAD_TYPE, or "<invalid>" if 'error' is not
141 * a valid OFPERR_* value. */
143 ofperr_get_description(enum ofperr error)
145 return (ofperr_is_valid(error)
146 ? error_comments[error - OFPERR_OFS]
150 static const struct pair *
151 ofperr_get_pair__(enum ofperr error, const struct ofperr_domain *domain)
153 size_t ofs = error - OFPERR_OFS;
155 assert(ofperr_is_valid(error));
156 return &domain->errors[ofs];
159 static struct ofpbuf *
160 ofperr_encode_msg__(enum ofperr error, enum ofp_version ofp_version,
161 ovs_be32 xid, const void *data, size_t data_len)
163 struct ofp_error_msg *oem;
164 const struct pair *pair;
166 const struct ofperr_domain *domain;
168 domain = ofperr_domain_from_version(ofp_version);
173 if (!ofperr_is_encodable(error, ofp_version)) {
174 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
176 if (!ofperr_is_valid(error)) {
177 /* 'error' seems likely to be a system errno value. */
178 VLOG_WARN_RL(&rl, "invalid OpenFlow error code %d (%s)",
179 error, strerror(error));
181 const char *s = ofperr_get_name(error);
182 if (ofperr_is_category(error)) {
183 VLOG_WARN_RL(&rl, "cannot encode error category (%s)", s);
185 VLOG_WARN_RL(&rl, "cannot encode %s for %s", s, domain->name);
192 pair = ofperr_get_pair__(error, domain);
193 if (!ofperr_is_nx_extension(error)) {
194 buf = ofpraw_alloc_xid(OFPRAW_OFPT_ERROR, domain->version, xid,
195 sizeof *oem + data_len);
197 oem = ofpbuf_put_uninit(buf, sizeof *oem);
198 oem->type = htons(pair->type);
199 oem->code = htons(pair->code);
201 struct nx_vendor_error *nve;
203 buf = ofpraw_alloc_xid(OFPRAW_OFPT_ERROR, domain->version, xid,
204 sizeof *oem + sizeof *nve + data_len);
206 oem = ofpbuf_put_uninit(buf, sizeof *oem);
207 oem->type = htons(NXET_VENDOR);
208 oem->code = htons(NXVC_VENDOR_ERROR);
210 nve = ofpbuf_put_uninit(buf, sizeof *nve);
211 nve->vendor = htonl(NX_VENDOR_ID);
212 nve->type = htons(pair->type);
213 nve->code = htons(pair->code);
216 ofpbuf_put(buf, data, data_len);
221 /* Creates and returns an OpenFlow message of type OFPT_ERROR that conveys the
224 * 'oh->version' determines the OpenFlow version of the error reply.
225 * 'oh->xid' determines the xid of the error reply.
226 * The error reply will contain an initial subsequence of 'oh', up to
227 * 'oh->length' or 64 bytes, whichever is shorter.
229 * Returns NULL if 'error' is not an OpenFlow error code or if 'error' cannot
230 * be encoded as OpenFlow version 'oh->version'.
232 * This function isn't appropriate for encoding OFPET_HELLO_FAILED error
233 * messages. Use ofperr_encode_hello() instead. */
235 ofperr_encode_reply(enum ofperr error, const struct ofp_header *oh)
237 uint16_t len = ntohs(oh->length);
239 return ofperr_encode_msg__(error, oh->version, oh->xid, oh, MIN(len, 64));
242 /* Creates and returns an OpenFlow message of type OFPT_ERROR that conveys the
243 * given 'error', in the error domain 'domain'. The error message will include
244 * the additional null-terminated text string 's'.
246 * If 'version' is an unknown version then OFP10_VERSION is used.
247 * OFPET_HELLO_FAILED error messages are supposed to be backward-compatible,
248 * so in theory this should work.
250 * Returns NULL if 'error' is not an OpenFlow error code or if 'error' cannot
251 * be encoded in 'domain'. */
253 ofperr_encode_hello(enum ofperr error, enum ofp_version ofp_version,
256 switch (ofp_version) {
263 ofp_version = OFP10_VERSION;
266 return ofperr_encode_msg__(error, ofp_version, htonl(0), s, strlen(s));
269 /* Returns the value that would go into an OFPT_ERROR message's 'type' for
270 * encoding 'error' in 'domain'. Returns -1 if 'error' is not encodable in
271 * 'version' or 'version' is unknown.
273 * 'error' must be a valid OFPERR_* code, as checked by ofperr_is_valid(). */
275 ofperr_get_type(enum ofperr error, enum ofp_version version)
277 const struct ofperr_domain *domain = ofperr_domain_from_version(version);
278 return domain ? ofperr_get_pair__(error, domain)->type : -1;
281 /* Returns the value that would go into an OFPT_ERROR message's 'code' for
282 * encoding 'error' in 'domain'. Returns -1 if 'error' is not encodable in
283 * 'version', 'version' is unknown or if 'error' represents a category
284 * rather than a specific error.
287 * 'error' must be a valid OFPERR_* code, as checked by ofperr_is_valid(). */
289 ofperr_get_code(enum ofperr error, enum ofp_version version)
291 const struct ofperr_domain *domain = ofperr_domain_from_version(version);
292 return domain ? ofperr_get_pair__(error, domain)->code : -1;
295 /* Tries to decodes 'oh', which should be an OpenFlow OFPT_ERROR message.
296 * Returns an OFPERR_* constant on success, 0 on failure.
298 * If 'payload' is nonnull, on success '*payload' is initialized to the
299 * error's payload, and on failure it is cleared. */
301 ofperr_decode_msg(const struct ofp_header *oh, struct ofpbuf *payload)
303 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
305 const struct ofp_error_msg *oem;
312 memset(payload, 0, sizeof *payload);
315 /* Pull off the error message. */
316 ofpbuf_use_const(&b, oh, ntohs(oh->length));
317 error = ofpraw_pull(&raw, &b);
321 oem = ofpbuf_pull(&b, sizeof *oem);
323 /* Get the error type and code. */
324 type = ntohs(oem->type);
325 code = ntohs(oem->code);
326 if (type == NXET_VENDOR && code == NXVC_VENDOR_ERROR) {
327 const struct nx_vendor_error *nve = ofpbuf_try_pull(&b, sizeof *nve);
332 if (nve->vendor != htonl(NX_VENDOR_ID)) {
333 VLOG_WARN_RL(&rl, "error contains unknown vendor ID %#"PRIx32,
337 type = ntohs(nve->type);
338 code = ntohs(nve->code);
341 /* Translate the error type and code into an ofperr.
342 * If we don't know the error type and code, at least try for the type. */
343 error = ofperr_decode(oh->version, type, code);
345 error = ofperr_decode_type(oh->version, type);
347 if (error && payload) {
348 ofpbuf_use_const(payload, b.data, b.size);
353 /* If 'error' is a valid OFPERR_* value, returns its name
354 * (e.g. "OFPBRC_BAD_TYPE" for OFPBRC_BAD_TYPE). Otherwise, assumes that
355 * 'error' is a positive errno value and returns what strerror() produces for
358 ofperr_to_string(enum ofperr error)
360 return ofperr_is_valid(error) ? ofperr_get_name(error) : strerror(error);