2 * Copyright (c) 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 #include <netinet/icmp6.h>
23 #include "classifier.h"
24 #include "dynamic-string.h"
26 #include "meta-flow.h"
27 #include "ofp-actions.h"
28 #include "ofp-errors.h"
31 #include "openflow/nicira-ext.h"
34 #include "tun-metadata.h"
35 #include "unaligned.h"
37 #include "openvswitch/vlog.h"
39 VLOG_DEFINE_THIS_MODULE(nx_match);
47 * The header is 32 bits long. It looks like this:
50 * +----------------------------------+---------------+--+------------------+
51 * | oxm_class | oxm_field |hm| oxm_length |
52 * +----------------------------------+---------------+--+------------------+
54 * where hm stands for oxm_hasmask. It is followed by oxm_length bytes of
55 * payload. When oxm_hasmask is 0, the payload is the value of the field
56 * identified by the header; when oxm_hasmask is 1, the payload is a value for
57 * the field followed by a mask of equal length.
59 * Internally, we represent a standard OXM header as a 64-bit integer with the
60 * above information in the most-significant bits.
66 * The header is 64 bits long. It looks like the diagram above except that a
67 * 32-bit experimenter ID, which we call oxm_vendor and which identifies a
68 * vendor, is inserted just before the payload. Experimenter OXMs are
69 * identified by an all-1-bits oxm_class (OFPXMC12_EXPERIMENTER). The
70 * oxm_length value *includes* the experimenter ID, so that the real payload is
71 * only oxm_length - 4 bytes long.
73 * Internally, we represent an experimenter OXM header as a 64-bit integer with
74 * the standard header in the upper 32 bits and the experimenter ID in the
75 * lower 32 bits. (It would be more convenient to swap the positions of the
76 * two 32-bit words, but this would be more error-prone because experimenter
77 * OXMs are very rarely used, so accidentally passing one through a 32-bit type
78 * somewhere in the OVS code would be hard to find.)
83 * The high order bit differentiate reserved classes from member classes.
84 * Classes 0x0000 to 0x7FFF are member classes, allocated by ONF.
85 * Classes 0x8000 to 0xFFFE are reserved classes, reserved for standardisation.
87 enum ofp12_oxm_class {
88 OFPXMC12_NXM_0 = 0x0000, /* Backward compatibility with NXM */
89 OFPXMC12_NXM_1 = 0x0001, /* Backward compatibility with NXM */
90 OFPXMC12_OPENFLOW_BASIC = 0x8000, /* Basic class for OpenFlow */
91 OFPXMC15_PACKET_REGS = 0x8001, /* Packet registers (pipeline fields). */
92 OFPXMC12_EXPERIMENTER = 0xffff, /* Experimenter class */
95 /* Functions for extracting raw field values from OXM/NXM headers. */
96 static uint32_t nxm_vendor(uint64_t header) { return header; }
97 static int nxm_class(uint64_t header) { return header >> 48; }
98 static int nxm_field(uint64_t header) { return (header >> 41) & 0x7f; }
99 static bool nxm_hasmask(uint64_t header) { return (header >> 40) & 1; }
100 static int nxm_length(uint64_t header) { return (header >> 32) & 0xff; }
101 static uint64_t nxm_no_len(uint64_t header) { return header & 0xffffff80ffffffffULL; }
104 is_experimenter_oxm(uint64_t header)
106 return nxm_class(header) == OFPXMC12_EXPERIMENTER;
109 /* The OXM header "length" field is somewhat tricky:
111 * - For a standard OXM header, the length is the number of bytes of the
112 * payload, and the payload consists of just the value (and mask, if
115 * - For an experimenter OXM header, the length is the number of bytes in
116 * the payload plus 4 (the length of the experimenter ID). That is, the
117 * experimenter ID is included in oxm_length.
119 * This function returns the length of the experimenter ID field in 'header'.
120 * That is, for an experimenter OXM (when an experimenter ID is present), it
121 * returns 4, and for a standard OXM (when no experimenter ID is present), it
124 nxm_experimenter_len(uint64_t header)
126 return is_experimenter_oxm(header) ? 4 : 0;
129 /* Returns the number of bytes that follow the header for an NXM/OXM entry
130 * with the given 'header'. */
132 nxm_payload_len(uint64_t header)
134 return nxm_length(header) - nxm_experimenter_len(header);
137 /* Returns the number of bytes in the header for an NXM/OXM entry with the
140 nxm_header_len(uint64_t header)
142 return 4 + nxm_experimenter_len(header);
145 #define NXM_HEADER(VENDOR, CLASS, FIELD, HASMASK, LENGTH) \
146 (((uint64_t) (CLASS) << 48) | \
147 ((uint64_t) (FIELD) << 41) | \
148 ((uint64_t) (HASMASK) << 40) | \
149 ((uint64_t) (LENGTH) << 32) | \
152 #define NXM_HEADER_FMT "%#"PRIx32":%d:%d:%d:%d"
153 #define NXM_HEADER_ARGS(HEADER) \
154 nxm_vendor(HEADER), nxm_class(HEADER), nxm_field(HEADER), \
155 nxm_hasmask(HEADER), nxm_length(HEADER)
157 /* Functions for turning the "hasmask" bit on or off. (This also requires
158 * adjusting the length.) */
160 nxm_make_exact_header(uint64_t header)
162 int new_len = nxm_payload_len(header) / 2 + nxm_experimenter_len(header);
163 return NXM_HEADER(nxm_vendor(header), nxm_class(header),
164 nxm_field(header), 0, new_len);
167 nxm_make_wild_header(uint64_t header)
169 int new_len = nxm_payload_len(header) * 2 + nxm_experimenter_len(header);
170 return NXM_HEADER(nxm_vendor(header), nxm_class(header),
171 nxm_field(header), 1, new_len);
176 * This may be used to gain the OpenFlow 1.1-like ability to restrict
177 * certain NXM-based Flow Mod and Flow Stats Request messages to flows
178 * with specific cookies. See the "nx_flow_mod" and "nx_flow_stats_request"
179 * structure definitions for more details. This match is otherwise not
181 #define NXM_NX_COOKIE NXM_HEADER (0, 0x0001, 30, 0, 8)
182 #define NXM_NX_COOKIE_W nxm_make_wild_header(NXM_NX_COOKIE)
186 enum ofp_version version;
187 const char *name; /* e.g. "NXM_OF_IN_PORT". */
192 static const struct nxm_field *nxm_field_by_header(uint64_t header);
193 static const struct nxm_field *nxm_field_by_name(const char *name, size_t len);
194 static const struct nxm_field *nxm_field_by_mf_id(enum mf_field_id,
197 static void nx_put_header__(struct ofpbuf *, uint64_t header, bool masked);
198 static void nx_put_header_len(struct ofpbuf *, enum mf_field_id field,
199 enum ofp_version version, bool masked,
202 /* Rate limit for nx_match parse errors. These always indicate a bug in the
203 * peer and so there's not much point in showing a lot of them. */
204 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
206 static const struct nxm_field *
207 mf_parse_subfield_name(const char *name, int name_len, bool *wild);
209 /* Returns the preferred OXM header to use for field 'id' in OpenFlow version
210 * 'version'. Specify 0 for 'version' if an NXM legacy header should be
211 * preferred over any standardized OXM header. Returns 0 if field 'id' cannot
212 * be expressed in NXM or OXM. */
214 mf_oxm_header(enum mf_field_id id, enum ofp_version version)
216 const struct nxm_field *f = nxm_field_by_mf_id(id, version);
217 return f ? f->header : 0;
220 /* Returns the 32-bit OXM or NXM header to use for field 'id', preferring an
221 * NXM legacy header over any standardized OXM header. Returns 0 if field 'id'
222 * cannot be expressed with a 32-bit NXM or OXM header.
224 * Whenever possible, use nx_pull_header() instead of this function, because
225 * this function cannot support 64-bit experimenter OXM headers. */
227 mf_nxm_header(enum mf_field_id id)
229 uint64_t oxm = mf_oxm_header(id, 0);
230 return is_experimenter_oxm(oxm) ? 0 : oxm >> 32;
233 static const struct mf_field *
234 mf_from_oxm_header(uint64_t header)
236 const struct nxm_field *f = nxm_field_by_header(header);
237 return f ? mf_from_id(f->id) : NULL;
240 /* Returns the "struct mf_field" that corresponds to NXM or OXM header
241 * 'header', or NULL if 'header' doesn't correspond to any known field. */
242 const struct mf_field *
243 mf_from_nxm_header(uint32_t header)
245 return mf_from_oxm_header((uint64_t) header << 32);
248 /* Returns the width of the data for a field with the given 'header', in
251 nxm_field_bytes(uint64_t header)
253 unsigned int length = nxm_payload_len(header);
254 return nxm_hasmask(header) ? length / 2 : length;
257 /* nx_pull_match() and helpers. */
259 /* Given NXM/OXM value 'value' and mask 'mask' associated with 'header', checks
260 * for any 1-bit in the value where there is a 0-bit in the mask. Returns 0 if
261 * none, otherwise an error code. */
263 is_mask_consistent(uint64_t header, const uint8_t *value, const uint8_t *mask)
265 unsigned int width = nxm_field_bytes(header);
268 for (i = 0; i < width; i++) {
269 if (value[i] & ~mask[i]) {
270 if (!VLOG_DROP_WARN(&rl)) {
271 VLOG_WARN_RL(&rl, "Rejecting NXM/OXM entry "NXM_HEADER_FMT " "
272 "with 1-bits in value for bits wildcarded by the "
273 "mask.", NXM_HEADER_ARGS(header));
282 is_cookie_pseudoheader(uint64_t header)
284 return header == NXM_NX_COOKIE || header == NXM_NX_COOKIE_W;
288 nx_pull_header__(struct ofpbuf *b, bool allow_cookie, uint64_t *header,
289 const struct mf_field **field)
295 *header = ((uint64_t) ntohl(get_unaligned_be32(b->data))) << 32;
296 if (is_experimenter_oxm(*header)) {
300 *header = ntohll(get_unaligned_be64(b->data));
302 if (nxm_length(*header) <= nxm_experimenter_len(*header)) {
303 VLOG_WARN_RL(&rl, "OXM header "NXM_HEADER_FMT" has invalid length %d "
305 NXM_HEADER_ARGS(*header), nxm_length(*header),
306 nxm_header_len(*header) + 1);
309 ofpbuf_pull(b, nxm_header_len(*header));
312 *field = mf_from_oxm_header(*header);
313 if (!*field && !(allow_cookie && is_cookie_pseudoheader(*header))) {
314 VLOG_DBG_RL(&rl, "OXM header "NXM_HEADER_FMT" is unknown",
315 NXM_HEADER_ARGS(*header));
316 return OFPERR_OFPBMC_BAD_FIELD;
323 VLOG_DBG_RL(&rl, "encountered partial (%"PRIu32"-byte) OXM entry",
330 return OFPERR_OFPBMC_BAD_LEN;
334 copy_entry_value(const struct mf_field *field, union mf_value *value,
335 const uint8_t *payload, int width)
341 copy_len = MIN(width, field ? field->n_bytes : sizeof *value);
343 if (field && field->variable_len) {
344 memset(value, 0, field->n_bytes);
345 copy_dst = &value->u8 + field->n_bytes - copy_len;
348 memcpy(copy_dst, payload, copy_len);
352 nx_pull_entry__(struct ofpbuf *b, bool allow_cookie, uint64_t *header,
353 const struct mf_field **field_,
354 union mf_value *value, union mf_value *mask)
356 const struct mf_field *field;
357 enum ofperr header_error;
358 unsigned int payload_len;
359 const uint8_t *payload;
362 header_error = nx_pull_header__(b, allow_cookie, header, &field);
363 if (header_error && header_error != OFPERR_OFPBMC_BAD_FIELD) {
367 payload_len = nxm_payload_len(*header);
368 payload = ofpbuf_try_pull(b, payload_len);
370 VLOG_DBG_RL(&rl, "OXM header "NXM_HEADER_FMT" calls for %u-byte "
371 "payload but only %"PRIu32" bytes follow OXM header",
372 NXM_HEADER_ARGS(*header), payload_len, b->size);
373 return OFPERR_OFPBMC_BAD_LEN;
376 width = nxm_field_bytes(*header);
377 if (nxm_hasmask(*header)
378 && !is_mask_consistent(*header, payload, payload + width)) {
379 return OFPERR_OFPBMC_BAD_WILDCARDS;
382 copy_entry_value(field, value, payload, width);
385 if (nxm_hasmask(*header)) {
386 copy_entry_value(field, mask, payload + width, width);
388 memset(mask, 0xff, sizeof *mask);
390 } else if (nxm_hasmask(*header)) {
391 VLOG_DBG_RL(&rl, "OXM header "NXM_HEADER_FMT" includes mask but "
392 "masked OXMs are not allowed here",
393 NXM_HEADER_ARGS(*header));
394 return OFPERR_OFPBMC_BAD_MASK;
405 /* Attempts to pull an NXM or OXM header, value, and mask (if present) from the
406 * beginning of 'b'. If successful, stores a pointer to the "struct mf_field"
407 * corresponding to the pulled header in '*field', the value into '*value',
408 * and the mask into '*mask', and returns 0. On error, returns an OpenFlow
409 * error; in this case, some bytes might have been pulled off 'b' anyhow, and
410 * the output parameters might have been modified.
412 * If a NULL 'mask' is supplied, masked OXM or NXM entries are treated as
413 * errors (with OFPERR_OFPBMC_BAD_MASK).
416 nx_pull_entry(struct ofpbuf *b, const struct mf_field **field,
417 union mf_value *value, union mf_value *mask)
421 return nx_pull_entry__(b, false, &header, field, value, mask);
424 /* Attempts to pull an NXM or OXM header from the beginning of 'b'. If
425 * successful, stores a pointer to the "struct mf_field" corresponding to the
426 * pulled header in '*field', stores the header's hasmask bit in '*masked'
427 * (true if hasmask=1, false if hasmask=0), and returns 0. On error, returns
428 * an OpenFlow error; in this case, some bytes might have been pulled off 'b'
429 * anyhow, and the output parameters might have been modified.
431 * If NULL 'masked' is supplied, masked OXM or NXM headers are treated as
432 * errors (with OFPERR_OFPBMC_BAD_MASK).
435 nx_pull_header(struct ofpbuf *b, const struct mf_field **field, bool *masked)
440 error = nx_pull_header__(b, false, &header, field);
442 *masked = !error && nxm_hasmask(header);
443 } else if (!error && nxm_hasmask(header)) {
444 error = OFPERR_OFPBMC_BAD_MASK;
450 nx_pull_match_entry(struct ofpbuf *b, bool allow_cookie,
451 const struct mf_field **field,
452 union mf_value *value, union mf_value *mask)
457 error = nx_pull_entry__(b, allow_cookie, &header, field, value, mask);
461 if (field && *field) {
462 if (!mf_is_mask_valid(*field, mask)) {
463 VLOG_DBG_RL(&rl, "bad mask for field %s", (*field)->name);
464 return OFPERR_OFPBMC_BAD_MASK;
466 if (!mf_is_value_valid(*field, value)) {
467 VLOG_DBG_RL(&rl, "bad value for field %s", (*field)->name);
468 return OFPERR_OFPBMC_BAD_VALUE;
475 nx_pull_raw(const uint8_t *p, unsigned int match_len, bool strict,
476 struct match *match, ovs_be64 *cookie, ovs_be64 *cookie_mask)
480 ovs_assert((cookie != NULL) == (cookie_mask != NULL));
482 match_init_catchall(match);
484 *cookie = *cookie_mask = htonll(0);
487 ofpbuf_use_const(&b, p, match_len);
489 const uint8_t *pos = b.data;
490 const struct mf_field *field;
491 union mf_value value;
495 error = nx_pull_match_entry(&b, cookie != NULL, &field, &value, &mask);
497 if (error == OFPERR_OFPBMC_BAD_FIELD && !strict) {
502 error = OFPERR_OFPBMC_BAD_FIELD;
503 } else if (*cookie_mask) {
504 error = OFPERR_OFPBMC_DUP_FIELD;
506 *cookie = value.be64;
507 *cookie_mask = mask.be64;
509 } else if (!mf_are_prereqs_ok(field, &match->flow)) {
510 error = OFPERR_OFPBMC_BAD_PREREQ;
511 } else if (!mf_is_all_wild(field, &match->wc)) {
512 error = OFPERR_OFPBMC_DUP_FIELD;
514 mf_set(field, &value, &mask, match);
518 VLOG_DBG_RL(&rl, "error parsing OXM at offset %"PRIdPTR" "
519 "within match (%s)", pos -
520 p, ofperr_to_string(error));
529 nx_pull_match__(struct ofpbuf *b, unsigned int match_len, bool strict,
531 ovs_be64 *cookie, ovs_be64 *cookie_mask)
536 p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
538 VLOG_DBG_RL(&rl, "nx_match length %u, rounded up to a "
539 "multiple of 8, is longer than space in message (max "
540 "length %"PRIu32")", match_len, b->size);
541 return OFPERR_OFPBMC_BAD_LEN;
545 return nx_pull_raw(p, match_len, strict, match, cookie, cookie_mask);
548 /* Parses the nx_match formatted match description in 'b' with length
549 * 'match_len'. Stores the results in 'match'. If 'cookie' and 'cookie_mask'
550 * are valid pointers, then stores the cookie and mask in them if 'b' contains
551 * a "NXM_NX_COOKIE*" match. Otherwise, stores 0 in both.
553 * Fails with an error upon encountering an unknown NXM header.
555 * Returns 0 if successful, otherwise an OpenFlow error code. */
557 nx_pull_match(struct ofpbuf *b, unsigned int match_len, struct match *match,
558 ovs_be64 *cookie, ovs_be64 *cookie_mask)
560 return nx_pull_match__(b, match_len, true, match, cookie, cookie_mask);
563 /* Behaves the same as nx_pull_match(), but skips over unknown NXM headers,
564 * instead of failing with an error. */
566 nx_pull_match_loose(struct ofpbuf *b, unsigned int match_len,
568 ovs_be64 *cookie, ovs_be64 *cookie_mask)
570 return nx_pull_match__(b, match_len, false, match, cookie, cookie_mask);
574 oxm_pull_match__(struct ofpbuf *b, bool strict, struct match *match)
576 struct ofp11_match_header *omh = b->data;
580 if (b->size < sizeof *omh) {
581 return OFPERR_OFPBMC_BAD_LEN;
584 match_len = ntohs(omh->length);
585 if (match_len < sizeof *omh) {
586 return OFPERR_OFPBMC_BAD_LEN;
589 if (omh->type != htons(OFPMT_OXM)) {
590 return OFPERR_OFPBMC_BAD_TYPE;
593 p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
595 VLOG_DBG_RL(&rl, "oxm length %u, rounded up to a "
596 "multiple of 8, is longer than space in message (max "
597 "length %"PRIu32")", match_len, b->size);
598 return OFPERR_OFPBMC_BAD_LEN;
601 return nx_pull_raw(p + sizeof *omh, match_len - sizeof *omh,
602 strict, match, NULL, NULL);
605 /* Parses the oxm formatted match description preceded by a struct
606 * ofp11_match_header in 'b'. Stores the result in 'match'.
608 * Fails with an error when encountering unknown OXM headers.
610 * Returns 0 if successful, otherwise an OpenFlow error code. */
612 oxm_pull_match(struct ofpbuf *b, struct match *match)
614 return oxm_pull_match__(b, true, match);
617 /* Behaves the same as oxm_pull_match() with one exception. Skips over unknown
618 * OXM headers instead of failing with an error when they are encountered. */
620 oxm_pull_match_loose(struct ofpbuf *b, struct match *match)
622 return oxm_pull_match__(b, false, match);
625 /* Verify an array of OXM TLVs treating value of each TLV as a mask,
626 * disallowing masks in each TLV and ignoring pre-requisites. */
628 oxm_pull_field_array(const void *fields_data, size_t fields_len,
629 struct field_array *fa)
633 ofpbuf_use_const(&b, fields_data, fields_len);
635 const uint8_t *pos = b.data;
636 const struct mf_field *field;
637 union mf_value value;
641 error = nx_pull_entry__(&b, false, &header, &field, &value, NULL);
643 VLOG_DBG_RL(&rl, "error pulling field array field");
646 VLOG_DBG_RL(&rl, "unknown field array field");
647 error = OFPERR_OFPBMC_BAD_FIELD;
648 } else if (bitmap_is_set(fa->used.bm, field->id)) {
649 VLOG_DBG_RL(&rl, "duplicate field array field '%s'", field->name);
650 error = OFPERR_OFPBMC_DUP_FIELD;
651 } else if (!mf_is_mask_valid(field, &value)) {
652 VLOG_DBG_RL(&rl, "bad mask in field array field '%s'", field->name);
653 return OFPERR_OFPBMC_BAD_MASK;
655 field_array_set(field->id, &value, fa);
659 const uint8_t *start = fields_data;
661 VLOG_DBG_RL(&rl, "error parsing OXM at offset %"PRIdPTR" "
662 "within field array (%s)", pos - start,
663 ofperr_to_string(error));
671 /* nx_put_match() and helpers.
673 * 'put' functions whose names end in 'w' add a wildcarded field.
674 * 'put' functions whose names end in 'm' add a field that might be wildcarded.
675 * Other 'put' functions add exact-match fields.
679 nxm_put_unmasked(struct ofpbuf *b, enum mf_field_id field,
680 enum ofp_version version, const void *value, size_t n_bytes)
682 nx_put_header_len(b, field, version, false, n_bytes);
683 ofpbuf_put(b, value, n_bytes);
687 nxm_put(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
688 const void *value, const void *mask, size_t n_bytes)
690 if (!is_all_zeros(mask, n_bytes)) {
691 bool masked = !is_all_ones(mask, n_bytes);
692 nx_put_header_len(b, field, version, masked, n_bytes);
693 ofpbuf_put(b, value, n_bytes);
695 ofpbuf_put(b, mask, n_bytes);
701 nxm_put_8m(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
702 uint8_t value, uint8_t mask)
704 nxm_put(b, field, version, &value, &mask, sizeof value);
708 nxm_put_8(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
711 nxm_put_unmasked(b, field, version, &value, sizeof value);
715 nxm_put_16m(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
716 ovs_be16 value, ovs_be16 mask)
718 nxm_put(b, field, version, &value, &mask, sizeof value);
722 nxm_put_16(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
725 nxm_put_unmasked(b, field, version, &value, sizeof value);
729 nxm_put_32m(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
730 ovs_be32 value, ovs_be32 mask)
732 nxm_put(b, field, version, &value, &mask, sizeof value);
736 nxm_put_32(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
739 nxm_put_unmasked(b, field, version, &value, sizeof value);
743 nxm_put_64m(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
744 ovs_be64 value, ovs_be64 mask)
746 nxm_put(b, field, version, &value, &mask, sizeof value);
750 nxm_put_eth_masked(struct ofpbuf *b,
751 enum mf_field_id field, enum ofp_version version,
752 const uint8_t value[ETH_ADDR_LEN],
753 const uint8_t mask[ETH_ADDR_LEN])
755 nxm_put(b, field, version, value, mask, ETH_ADDR_LEN);
759 nxm_put_ipv6(struct ofpbuf *b,
760 enum mf_field_id field, enum ofp_version version,
761 const struct in6_addr *value, const struct in6_addr *mask)
763 nxm_put(b, field, version, value->s6_addr, mask->s6_addr,
764 sizeof value->s6_addr);
768 nxm_put_frag(struct ofpbuf *b, const struct match *match,
769 enum ofp_version version)
771 uint8_t nw_frag = match->flow.nw_frag & FLOW_NW_FRAG_MASK;
772 uint8_t nw_frag_mask = match->wc.masks.nw_frag & FLOW_NW_FRAG_MASK;
774 nxm_put_8m(b, MFF_IP_FRAG, version, nw_frag,
775 nw_frag_mask == FLOW_NW_FRAG_MASK ? UINT8_MAX : nw_frag_mask);
778 /* Appends to 'b' a set of OXM or NXM matches for the IPv4 or IPv6 fields in
781 nxm_put_ip(struct ofpbuf *b, const struct match *match, enum ofp_version oxm)
783 const struct flow *flow = &match->flow;
785 if (flow->dl_type == htons(ETH_TYPE_IP)) {
786 nxm_put_32m(b, MFF_IPV4_SRC, oxm,
787 flow->nw_src, match->wc.masks.nw_src);
788 nxm_put_32m(b, MFF_IPV4_DST, oxm,
789 flow->nw_dst, match->wc.masks.nw_dst);
791 nxm_put_ipv6(b, MFF_IPV6_SRC, oxm,
792 &flow->ipv6_src, &match->wc.masks.ipv6_src);
793 nxm_put_ipv6(b, MFF_IPV6_DST, oxm,
794 &flow->ipv6_dst, &match->wc.masks.ipv6_dst);
797 nxm_put_frag(b, match, oxm);
799 if (match->wc.masks.nw_tos & IP_DSCP_MASK) {
801 nxm_put_8(b, MFF_IP_DSCP_SHIFTED, oxm,
804 nxm_put_8(b, MFF_IP_DSCP, oxm,
805 flow->nw_tos & IP_DSCP_MASK);
809 if (match->wc.masks.nw_tos & IP_ECN_MASK) {
810 nxm_put_8(b, MFF_IP_ECN, oxm,
811 flow->nw_tos & IP_ECN_MASK);
814 if (!oxm && match->wc.masks.nw_ttl) {
815 nxm_put_8(b, MFF_IP_TTL, oxm, flow->nw_ttl);
818 nxm_put_32m(b, MFF_IPV6_LABEL, oxm,
819 flow->ipv6_label, match->wc.masks.ipv6_label);
821 if (match->wc.masks.nw_proto) {
822 nxm_put_8(b, MFF_IP_PROTO, oxm, flow->nw_proto);
824 if (flow->nw_proto == IPPROTO_TCP) {
825 nxm_put_16m(b, MFF_TCP_SRC, oxm,
826 flow->tp_src, match->wc.masks.tp_src);
827 nxm_put_16m(b, MFF_TCP_DST, oxm,
828 flow->tp_dst, match->wc.masks.tp_dst);
829 nxm_put_16m(b, MFF_TCP_FLAGS, oxm,
830 flow->tcp_flags, match->wc.masks.tcp_flags);
831 } else if (flow->nw_proto == IPPROTO_UDP) {
832 nxm_put_16m(b, MFF_UDP_SRC, oxm,
833 flow->tp_src, match->wc.masks.tp_src);
834 nxm_put_16m(b, MFF_UDP_DST, oxm,
835 flow->tp_dst, match->wc.masks.tp_dst);
836 } else if (flow->nw_proto == IPPROTO_SCTP) {
837 nxm_put_16m(b, MFF_SCTP_SRC, oxm, flow->tp_src,
838 match->wc.masks.tp_src);
839 nxm_put_16m(b, MFF_SCTP_DST, oxm, flow->tp_dst,
840 match->wc.masks.tp_dst);
841 } else if (is_icmpv4(flow)) {
842 if (match->wc.masks.tp_src) {
843 nxm_put_8(b, MFF_ICMPV4_TYPE, oxm,
844 ntohs(flow->tp_src));
846 if (match->wc.masks.tp_dst) {
847 nxm_put_8(b, MFF_ICMPV4_CODE, oxm,
848 ntohs(flow->tp_dst));
850 } else if (is_icmpv6(flow)) {
851 if (match->wc.masks.tp_src) {
852 nxm_put_8(b, MFF_ICMPV6_TYPE, oxm,
853 ntohs(flow->tp_src));
855 if (match->wc.masks.tp_dst) {
856 nxm_put_8(b, MFF_ICMPV6_CODE, oxm,
857 ntohs(flow->tp_dst));
859 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
860 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
861 nxm_put_ipv6(b, MFF_ND_TARGET, oxm,
862 &flow->nd_target, &match->wc.masks.nd_target);
863 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
864 nxm_put_eth_masked(b, MFF_ND_SLL, oxm,
865 flow->arp_sha, match->wc.masks.arp_sha);
867 if (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
868 nxm_put_eth_masked(b, MFF_ND_TLL, oxm,
869 flow->arp_tha, match->wc.masks.arp_tha);
876 /* Appends to 'b' the nx_match format that expresses 'match'. For Flow Mod and
877 * Flow Stats Requests messages, a 'cookie' and 'cookie_mask' may be supplied.
878 * Otherwise, 'cookie_mask' should be zero.
880 * Specify 'oxm' as 0 to express the match in NXM format; otherwise, specify
881 * 'oxm' as the OpenFlow version number for the OXM format to use.
883 * This function can cause 'b''s data to be reallocated.
885 * Returns the number of bytes appended to 'b', excluding padding.
887 * If 'match' is a catch-all rule that matches every packet, then this function
888 * appends nothing to 'b' and returns 0. */
890 nx_put_raw(struct ofpbuf *b, enum ofp_version oxm, const struct match *match,
891 ovs_be64 cookie, ovs_be64 cookie_mask)
893 const struct flow *flow = &match->flow;
894 const size_t start_len = b->size;
898 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 32);
901 if (match->wc.masks.dp_hash) {
902 nxm_put_32m(b, MFF_DP_HASH, oxm,
903 htonl(flow->dp_hash), htonl(match->wc.masks.dp_hash));
906 if (match->wc.masks.recirc_id) {
907 nxm_put_32(b, MFF_RECIRC_ID, oxm, htonl(flow->recirc_id));
910 if (match->wc.masks.conj_id) {
911 nxm_put_32(b, MFF_CONJ_ID, oxm, htonl(flow->conj_id));
914 if (match->wc.masks.in_port.ofp_port) {
915 ofp_port_t in_port = flow->in_port.ofp_port;
917 nxm_put_32(b, MFF_IN_PORT_OXM, oxm,
918 ofputil_port_to_ofp11(in_port));
920 nxm_put_16(b, MFF_IN_PORT, oxm,
921 htons(ofp_to_u16(in_port)));
924 if (match->wc.masks.actset_output) {
925 nxm_put_32(b, MFF_ACTSET_OUTPUT, oxm,
926 ofputil_port_to_ofp11(flow->actset_output));
930 nxm_put_eth_masked(b, MFF_ETH_SRC, oxm,
931 flow->dl_src, match->wc.masks.dl_src);
932 nxm_put_eth_masked(b, MFF_ETH_DST, oxm,
933 flow->dl_dst, match->wc.masks.dl_dst);
934 nxm_put_16m(b, MFF_ETH_TYPE, oxm,
935 ofputil_dl_type_to_openflow(flow->dl_type),
936 match->wc.masks.dl_type);
940 ovs_be16 VID_CFI_MASK = htons(VLAN_VID_MASK | VLAN_CFI);
941 ovs_be16 vid = flow->vlan_tci & VID_CFI_MASK;
942 ovs_be16 mask = match->wc.masks.vlan_tci & VID_CFI_MASK;
944 if (mask == htons(VLAN_VID_MASK | VLAN_CFI)) {
945 nxm_put_16(b, MFF_VLAN_VID, oxm, vid);
947 nxm_put_16m(b, MFF_VLAN_VID, oxm, vid, mask);
950 if (vid && vlan_tci_to_pcp(match->wc.masks.vlan_tci)) {
951 nxm_put_8(b, MFF_VLAN_PCP, oxm,
952 vlan_tci_to_pcp(flow->vlan_tci));
956 nxm_put_16m(b, MFF_VLAN_TCI, oxm, flow->vlan_tci,
957 match->wc.masks.vlan_tci);
961 if (eth_type_mpls(flow->dl_type)) {
962 if (match->wc.masks.mpls_lse[0] & htonl(MPLS_TC_MASK)) {
963 nxm_put_8(b, MFF_MPLS_TC, oxm,
964 mpls_lse_to_tc(flow->mpls_lse[0]));
967 if (match->wc.masks.mpls_lse[0] & htonl(MPLS_BOS_MASK)) {
968 nxm_put_8(b, MFF_MPLS_BOS, oxm,
969 mpls_lse_to_bos(flow->mpls_lse[0]));
972 if (match->wc.masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK)) {
973 nxm_put_32(b, MFF_MPLS_LABEL, oxm,
974 htonl(mpls_lse_to_label(flow->mpls_lse[0])));
979 if (is_ip_any(flow)) {
980 nxm_put_ip(b, match, oxm);
981 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
982 flow->dl_type == htons(ETH_TYPE_RARP)) {
984 if (match->wc.masks.nw_proto) {
985 nxm_put_16(b, MFF_ARP_OP, oxm,
986 htons(flow->nw_proto));
988 nxm_put_32m(b, MFF_ARP_SPA, oxm,
989 flow->nw_src, match->wc.masks.nw_src);
990 nxm_put_32m(b, MFF_ARP_TPA, oxm,
991 flow->nw_dst, match->wc.masks.nw_dst);
992 nxm_put_eth_masked(b, MFF_ARP_SHA, oxm,
993 flow->arp_sha, match->wc.masks.arp_sha);
994 nxm_put_eth_masked(b, MFF_ARP_THA, oxm,
995 flow->arp_tha, match->wc.masks.arp_tha);
999 nxm_put_64m(b, MFF_TUN_ID, oxm,
1000 flow->tunnel.tun_id, match->wc.masks.tunnel.tun_id);
1002 /* Other tunnel metadata. */
1003 nxm_put_32m(b, MFF_TUN_SRC, oxm,
1004 flow->tunnel.ip_src, match->wc.masks.tunnel.ip_src);
1005 nxm_put_32m(b, MFF_TUN_DST, oxm,
1006 flow->tunnel.ip_dst, match->wc.masks.tunnel.ip_dst);
1007 nxm_put_16m(b, MFF_TUN_GBP_ID, oxm,
1008 flow->tunnel.gbp_id, match->wc.masks.tunnel.gbp_id);
1009 nxm_put_8m(b, MFF_TUN_GBP_FLAGS, oxm,
1010 flow->tunnel.gbp_flags, match->wc.masks.tunnel.gbp_flags);
1011 tun_metadata_to_nx_match(b, oxm, match);
1014 if (oxm < OFP15_VERSION) {
1015 for (i = 0; i < FLOW_N_REGS; i++) {
1016 nxm_put_32m(b, MFF_REG0 + i, oxm,
1017 htonl(flow->regs[i]), htonl(match->wc.masks.regs[i]));
1020 for (i = 0; i < FLOW_N_XREGS; i++) {
1021 nxm_put_64m(b, MFF_XREG0 + i, oxm,
1022 htonll(flow_get_xreg(flow, i)),
1023 htonll(flow_get_xreg(&match->wc.masks, i)));
1028 nxm_put_32m(b, MFF_PKT_MARK, oxm, htonl(flow->pkt_mark),
1029 htonl(match->wc.masks.pkt_mark));
1031 /* OpenFlow 1.1+ Metadata. */
1032 nxm_put_64m(b, MFF_METADATA, oxm,
1033 flow->metadata, match->wc.masks.metadata);
1037 bool masked = cookie_mask != OVS_BE64_MAX;
1039 cookie &= cookie_mask;
1040 nx_put_header__(b, NXM_NX_COOKIE, masked);
1041 ofpbuf_put(b, &cookie, sizeof cookie);
1043 ofpbuf_put(b, &cookie_mask, sizeof cookie_mask);
1047 match_len = b->size - start_len;
1051 /* Appends to 'b' the nx_match format that expresses 'match', plus enough zero
1052 * bytes to pad the nx_match out to a multiple of 8. For Flow Mod and Flow
1053 * Stats Requests messages, a 'cookie' and 'cookie_mask' may be supplied.
1054 * Otherwise, 'cookie_mask' should be zero.
1056 * This function can cause 'b''s data to be reallocated.
1058 * Returns the number of bytes appended to 'b', excluding padding. The return
1059 * value can be zero if it appended nothing at all to 'b' (which happens if
1060 * 'cr' is a catch-all rule that matches every packet). */
1062 nx_put_match(struct ofpbuf *b, const struct match *match,
1063 ovs_be64 cookie, ovs_be64 cookie_mask)
1065 int match_len = nx_put_raw(b, 0, match, cookie, cookie_mask);
1067 ofpbuf_put_zeros(b, PAD_SIZE(match_len, 8));
1071 /* Appends to 'b' an struct ofp11_match_header followed by the OXM format that
1072 * expresses 'cr', plus enough zero bytes to pad the data appended out to a
1075 * OXM differs slightly among versions of OpenFlow. Specify the OpenFlow
1076 * version in use as 'version'.
1078 * This function can cause 'b''s data to be reallocated.
1080 * Returns the number of bytes appended to 'b', excluding the padding. Never
1083 oxm_put_match(struct ofpbuf *b, const struct match *match,
1084 enum ofp_version version)
1087 struct ofp11_match_header *omh;
1088 size_t start_len = b->size;
1089 ovs_be64 cookie = htonll(0), cookie_mask = htonll(0);
1091 ofpbuf_put_uninit(b, sizeof *omh);
1092 match_len = (nx_put_raw(b, version, match, cookie, cookie_mask)
1094 ofpbuf_put_zeros(b, PAD_SIZE(match_len, 8));
1096 omh = ofpbuf_at(b, start_len, sizeof *omh);
1097 omh->type = htons(OFPMT_OXM);
1098 omh->length = htons(match_len);
1103 /* Appends to 'b' the nx_match format that expresses the tlv corresponding
1104 * to 'id'. If mask is not all-ones then it is also formated as the value
1107 nx_format_mask_tlv(struct ds *ds, enum mf_field_id id,
1108 const union mf_value *mask)
1110 const struct mf_field *mf = mf_from_id(id);
1112 ds_put_format(ds, "%s", mf->name);
1114 if (!is_all_ones(mask, mf->n_bytes)) {
1115 ds_put_char(ds, '=');
1116 mf_format(mf, mask, NULL, ds);
1119 ds_put_char(ds, ',');
1122 /* Appends a string representation of 'fa_' to 'ds'.
1123 * The TLVS value of 'fa_' is treated as a mask and
1124 * only the name of fields is formated if it is all ones. */
1126 oxm_format_field_array(struct ds *ds, const struct field_array *fa)
1128 size_t start_len = ds->length;
1131 for (i = 0; i < MFF_N_IDS; i++) {
1132 if (bitmap_is_set(fa->used.bm, i)) {
1133 nx_format_mask_tlv(ds, i, &fa->value[i]);
1137 if (ds->length > start_len) {
1142 /* Appends to 'b' a series of OXM TLVs corresponding to the series
1143 * of enum mf_field_id and value tuples in 'fa_'.
1145 * OXM differs slightly among versions of OpenFlow. Specify the OpenFlow
1146 * version in use as 'version'.
1148 * This function can cause 'b''s data to be reallocated.
1150 * Returns the number of bytes appended to 'b'. May return zero. */
1152 oxm_put_field_array(struct ofpbuf *b, const struct field_array *fa,
1153 enum ofp_version version)
1155 size_t start_len = b->size;
1158 /* Field arrays are only used with the group selection method
1159 * property and group properties are only available in OpenFlow 1.5+.
1160 * So the following assertion should never fail.
1162 * If support for older OpenFlow versions is desired then some care
1163 * will need to be taken of different TLVs that handle the same
1164 * flow fields. In particular:
1165 * - VLAN_TCI, VLAN_VID and MFF_VLAN_PCP
1166 * - IP_DSCP_MASK and DSCP_SHIFTED
1169 ovs_assert(version >= OFP15_VERSION);
1171 for (i = 0; i < MFF_N_IDS; i++) {
1172 if (bitmap_is_set(fa->used.bm, i)) {
1173 int len = mf_field_len(mf_from_id(i), &fa->value[i], NULL);
1174 nxm_put_unmasked(b, i, version,
1175 &fa->value[i].u8 + mf_from_id(i)->n_bytes - len,
1180 return b->size - start_len;
1184 nx_put_header__(struct ofpbuf *b, uint64_t header, bool masked)
1186 uint64_t masked_header = masked ? nxm_make_wild_header(header) : header;
1187 ovs_be64 network_header = htonll(masked_header);
1189 ofpbuf_put(b, &network_header, nxm_header_len(header));
1193 nx_put_header(struct ofpbuf *b, enum mf_field_id field,
1194 enum ofp_version version, bool masked)
1196 nx_put_header__(b, mf_oxm_header(field, version), masked);
1200 nx_put_header_len(struct ofpbuf *b, enum mf_field_id field,
1201 enum ofp_version version, bool masked, size_t n_bytes)
1203 uint64_t header = mf_oxm_header(field, version);
1205 header = NXM_HEADER(nxm_vendor(header), nxm_class(header),
1206 nxm_field(header), false,
1207 nxm_experimenter_len(header) + n_bytes);
1209 nx_put_header__(b, header, masked);
1213 nx_put_entry(struct ofpbuf *b,
1214 enum mf_field_id field, enum ofp_version version,
1215 const union mf_value *value, const union mf_value *mask)
1217 const struct mf_field *mf = mf_from_id(field);
1218 bool masked = mask && !is_all_ones(mask, mf->n_bytes);
1221 len = mf_field_len(mf, value, mask);
1222 offset = mf->n_bytes - len;
1224 nx_put_header_len(b, field, version, masked, len);
1225 ofpbuf_put(b, &value->u8 + offset, len);
1227 ofpbuf_put(b, &mask->u8 + offset, len);
1231 /* nx_match_to_string() and helpers. */
1233 static void format_nxm_field_name(struct ds *, uint64_t header);
1236 nx_match_to_string(const uint8_t *p, unsigned int match_len)
1242 return xstrdup("<any>");
1245 ofpbuf_use_const(&b, p, match_len);
1248 union mf_value value;
1249 union mf_value mask;
1254 error = nx_pull_entry__(&b, true, &header, NULL, &value, &mask);
1258 value_len = MIN(sizeof value, nxm_field_bytes(header));
1261 ds_put_cstr(&s, ", ");
1264 format_nxm_field_name(&s, header);
1265 ds_put_char(&s, '(');
1267 for (int i = 0; i < value_len; i++) {
1268 ds_put_format(&s, "%02x", ((const uint8_t *) &value)[i]);
1270 if (nxm_hasmask(header)) {
1271 ds_put_char(&s, '/');
1272 for (int i = 0; i < value_len; i++) {
1273 ds_put_format(&s, "%02x", ((const uint8_t *) &mask)[i]);
1276 ds_put_char(&s, ')');
1281 ds_put_cstr(&s, ", ");
1284 ds_put_format(&s, "<%u invalid bytes>", b.size);
1287 return ds_steal_cstr(&s);
1291 oxm_match_to_string(const struct ofpbuf *p, unsigned int match_len)
1293 const struct ofp11_match_header *omh = p->data;
1294 uint16_t match_len_;
1299 if (match_len < sizeof *omh) {
1300 ds_put_format(&s, "<match too short: %u>", match_len);
1304 if (omh->type != htons(OFPMT_OXM)) {
1305 ds_put_format(&s, "<bad match type field: %u>", ntohs(omh->type));
1309 match_len_ = ntohs(omh->length);
1310 if (match_len_ < sizeof *omh) {
1311 ds_put_format(&s, "<match length field too short: %u>", match_len_);
1315 if (match_len_ != match_len) {
1316 ds_put_format(&s, "<match length field incorrect: %u != %u>",
1317 match_len_, match_len);
1321 return nx_match_to_string(ofpbuf_at(p, sizeof *omh, 0),
1322 match_len - sizeof *omh);
1325 return ds_steal_cstr(&s);
1329 nx_format_field_name(enum mf_field_id id, enum ofp_version version,
1332 format_nxm_field_name(s, mf_oxm_header(id, version));
1336 format_nxm_field_name(struct ds *s, uint64_t header)
1338 const struct nxm_field *f = nxm_field_by_header(header);
1340 ds_put_cstr(s, f->name);
1341 if (nxm_hasmask(header)) {
1342 ds_put_cstr(s, "_W");
1344 } else if (header == NXM_NX_COOKIE) {
1345 ds_put_cstr(s, "NXM_NX_COOKIE");
1346 } else if (header == NXM_NX_COOKIE_W) {
1347 ds_put_cstr(s, "NXM_NX_COOKIE_W");
1349 ds_put_format(s, "%d:%d", nxm_class(header), nxm_field(header));
1354 streq_len(const char *a, size_t a_len, const char *b)
1356 return strlen(b) == a_len && !memcmp(a, b, a_len);
1360 parse_nxm_field_name(const char *name, int name_len)
1362 const struct nxm_field *f;
1365 f = mf_parse_subfield_name(name, name_len, &wild);
1369 } else if (mf_from_id(f->id)->maskable != MFM_NONE) {
1370 return nxm_make_wild_header(f->header);
1374 if (streq_len(name, name_len, "NXM_NX_COOKIE")) {
1375 return NXM_NX_COOKIE;
1376 } else if (streq_len(name, name_len, "NXM_NX_COOKIE_W")) {
1377 return NXM_NX_COOKIE_W;
1380 /* Check whether it's a field header value as hex.
1381 * (This isn't ordinarily useful except for testing error behavior.) */
1382 if (name_len == 8) {
1386 header = hexits_value(name, name_len, &ok) << 32;
1390 } else if (name_len == 16) {
1394 header = hexits_value(name, name_len, &ok);
1395 if (ok && is_experimenter_oxm(header)) {
1403 /* nx_match_from_string(). */
1406 nx_match_from_string_raw(const char *s, struct ofpbuf *b)
1408 const char *full_s = s;
1409 const size_t start_len = b->size;
1411 if (!strcmp(s, "<any>")) {
1412 /* Ensure that 'b->data' isn't actually null. */
1413 ofpbuf_prealloc_tailroom(b, 1);
1417 for (s += strspn(s, ", "); *s; s += strspn(s, ", ")) {
1421 ovs_be64 *header_ptr;
1426 name_len = strcspn(s, "(");
1427 if (s[name_len] != '(') {
1428 ovs_fatal(0, "%s: missing ( at end of nx_match", full_s);
1431 header = parse_nxm_field_name(name, name_len);
1433 ovs_fatal(0, "%s: unknown field `%.*s'", full_s, name_len, s);
1438 header_ptr = ofpbuf_put_uninit(b, nxm_header_len(header));
1439 s = ofpbuf_put_hex(b, s, &n);
1440 if (n != nxm_field_bytes(header)) {
1441 const struct mf_field *field = mf_from_oxm_header(header);
1443 if (field && field->variable_len) {
1444 if (n <= field->n_bytes) {
1445 int len = (nxm_hasmask(header) ? n * 2 : n) +
1446 nxm_experimenter_len(header);
1448 header = NXM_HEADER(nxm_vendor(header), nxm_class(header),
1450 nxm_hasmask(header) ? 1 : 0, len);
1452 ovs_fatal(0, "expected to read at most %d bytes but got "
1453 "%"PRIuSIZE, field->n_bytes, n);
1456 ovs_fatal(0, "expected to read %d bytes but got %"PRIuSIZE,
1457 nxm_field_bytes(header), n);
1460 nw_header = htonll(header);
1461 memcpy(header_ptr, &nw_header, nxm_header_len(header));
1463 if (nxm_hasmask(header)) {
1464 s += strspn(s, " ");
1466 ovs_fatal(0, "%s: missing / in masked field %.*s",
1467 full_s, name_len, name);
1469 s = ofpbuf_put_hex(b, s + 1, &n);
1470 if (n != nxm_field_bytes(header)) {
1471 ovs_fatal(0, "%.2s: hex digits expected", s);
1475 s += strspn(s, " ");
1477 ovs_fatal(0, "%s: missing ) following field %.*s",
1478 full_s, name_len, name);
1483 return b->size - start_len;
1487 nx_match_from_string(const char *s, struct ofpbuf *b)
1489 int match_len = nx_match_from_string_raw(s, b);
1490 ofpbuf_put_zeros(b, PAD_SIZE(match_len, 8));
1495 oxm_match_from_string(const char *s, struct ofpbuf *b)
1498 struct ofp11_match_header *omh;
1499 size_t start_len = b->size;
1501 ofpbuf_put_uninit(b, sizeof *omh);
1502 match_len = nx_match_from_string_raw(s, b) + sizeof *omh;
1503 ofpbuf_put_zeros(b, PAD_SIZE(match_len, 8));
1505 omh = ofpbuf_at(b, start_len, sizeof *omh);
1506 omh->type = htons(OFPMT_OXM);
1507 omh->length = htons(match_len);
1512 /* Parses 's' as a "move" action, in the form described in ovs-ofctl(8), into
1515 * Returns NULL if successful, otherwise a malloc()'d string describing the
1516 * error. The caller is responsible for freeing the returned string. */
1517 char * OVS_WARN_UNUSED_RESULT
1518 nxm_parse_reg_move(struct ofpact_reg_move *move, const char *s)
1520 const char *full_s = s;
1523 error = mf_parse_subfield__(&move->src, &s);
1527 if (strncmp(s, "->", 2)) {
1528 return xasprintf("%s: missing `->' following source", full_s);
1531 error = mf_parse_subfield(&move->dst, s);
1536 if (move->src.n_bits != move->dst.n_bits) {
1537 return xasprintf("%s: source field is %d bits wide but destination is "
1538 "%d bits wide", full_s,
1539 move->src.n_bits, move->dst.n_bits);
1544 /* nxm_format_reg_move(). */
1547 nxm_format_reg_move(const struct ofpact_reg_move *move, struct ds *s)
1549 ds_put_format(s, "move:");
1550 mf_format_subfield(&move->src, s);
1551 ds_put_cstr(s, "->");
1552 mf_format_subfield(&move->dst, s);
1557 nxm_reg_move_check(const struct ofpact_reg_move *move, const struct flow *flow)
1561 error = mf_check_src(&move->src, flow);
1566 return mf_check_dst(&move->dst, flow);
1569 /* nxm_execute_reg_move(). */
1572 nxm_execute_reg_move(const struct ofpact_reg_move *move,
1573 struct flow *flow, struct flow_wildcards *wc)
1575 union mf_value src_value;
1576 union mf_value dst_value;
1578 mf_mask_field_and_prereqs(move->dst.field, &wc->masks);
1579 mf_mask_field_and_prereqs(move->src.field, &wc->masks);
1581 /* A flow may wildcard nw_frag. Do nothing if setting a transport
1582 * header field on a packet that does not have them. */
1583 if (mf_are_prereqs_ok(move->dst.field, flow)
1584 && mf_are_prereqs_ok(move->src.field, flow)) {
1586 mf_get_value(move->dst.field, flow, &dst_value);
1587 mf_get_value(move->src.field, flow, &src_value);
1588 bitwise_copy(&src_value, move->src.field->n_bytes, move->src.ofs,
1589 &dst_value, move->dst.field->n_bytes, move->dst.ofs,
1591 mf_set_flow_value(move->dst.field, &dst_value, flow);
1596 nxm_reg_load(const struct mf_subfield *dst, uint64_t src_data,
1597 struct flow *flow, struct flow_wildcards *wc)
1599 union mf_subvalue src_subvalue;
1600 union mf_subvalue mask_value;
1601 ovs_be64 src_data_be = htonll(src_data);
1603 memset(&mask_value, 0xff, sizeof mask_value);
1604 mf_write_subfield_flow(dst, &mask_value, &wc->masks);
1606 bitwise_copy(&src_data_be, sizeof src_data_be, 0,
1607 &src_subvalue, sizeof src_subvalue, 0,
1608 sizeof src_data_be * 8);
1609 mf_write_subfield_flow(dst, &src_subvalue, flow);
1612 /* nxm_parse_stack_action, works for both push() and pop(). */
1614 /* Parses 's' as a "push" or "pop" action, in the form described in
1615 * ovs-ofctl(8), into '*stack_action'.
1617 * Returns NULL if successful, otherwise a malloc()'d string describing the
1618 * error. The caller is responsible for freeing the returned string. */
1619 char * OVS_WARN_UNUSED_RESULT
1620 nxm_parse_stack_action(struct ofpact_stack *stack_action, const char *s)
1624 error = mf_parse_subfield__(&stack_action->subfield, &s);
1630 return xasprintf("%s: trailing garbage following push or pop", s);
1637 nxm_format_stack_push(const struct ofpact_stack *push, struct ds *s)
1639 ds_put_cstr(s, "push:");
1640 mf_format_subfield(&push->subfield, s);
1644 nxm_format_stack_pop(const struct ofpact_stack *pop, struct ds *s)
1646 ds_put_cstr(s, "pop:");
1647 mf_format_subfield(&pop->subfield, s);
1651 nxm_stack_push_check(const struct ofpact_stack *push,
1652 const struct flow *flow)
1654 return mf_check_src(&push->subfield, flow);
1658 nxm_stack_pop_check(const struct ofpact_stack *pop,
1659 const struct flow *flow)
1661 return mf_check_dst(&pop->subfield, flow);
1664 /* nxm_execute_stack_push(), nxm_execute_stack_pop(). */
1666 nx_stack_push(struct ofpbuf *stack, union mf_subvalue *v)
1668 ofpbuf_put(stack, v, sizeof *v);
1671 static union mf_subvalue *
1672 nx_stack_pop(struct ofpbuf *stack)
1674 union mf_subvalue *v = NULL;
1678 stack->size -= sizeof *v;
1679 v = (union mf_subvalue *) ofpbuf_tail(stack);
1686 nxm_execute_stack_push(const struct ofpact_stack *push,
1687 const struct flow *flow, struct flow_wildcards *wc,
1688 struct ofpbuf *stack)
1690 union mf_subvalue mask_value;
1691 union mf_subvalue dst_value;
1693 memset(&mask_value, 0xff, sizeof mask_value);
1694 mf_write_subfield_flow(&push->subfield, &mask_value, &wc->masks);
1696 mf_read_subfield(&push->subfield, flow, &dst_value);
1697 nx_stack_push(stack, &dst_value);
1701 nxm_execute_stack_pop(const struct ofpact_stack *pop,
1702 struct flow *flow, struct flow_wildcards *wc,
1703 struct ofpbuf *stack)
1705 union mf_subvalue *src_value;
1707 src_value = nx_stack_pop(stack);
1709 /* Only pop if stack is not empty. Otherwise, give warning. */
1711 union mf_subvalue mask_value;
1713 memset(&mask_value, 0xff, sizeof mask_value);
1714 mf_write_subfield_flow(&pop->subfield, &mask_value, &wc->masks);
1715 mf_write_subfield_flow(&pop->subfield, src_value, flow);
1717 if (!VLOG_DROP_WARN(&rl)) {
1718 char *flow_str = flow_to_string(flow);
1719 VLOG_WARN_RL(&rl, "Failed to pop from an empty stack. On flow\n"
1726 /* Formats 'sf' into 's' in a format normally acceptable to
1727 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
1728 * sf->field has no NXM name.) */
1730 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
1733 ds_put_cstr(s, "<unknown>");
1735 const struct nxm_field *f = nxm_field_by_mf_id(sf->field->id, 0);
1736 ds_put_cstr(s, f ? f->name : sf->field->name);
1739 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
1740 ds_put_cstr(s, "[]");
1741 } else if (sf->n_bits == 1) {
1742 ds_put_format(s, "[%d]", sf->ofs);
1744 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
1748 static const struct nxm_field *
1749 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
1751 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
1756 return nxm_field_by_name(name, name_len);
1759 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
1760 * returns NULL and advances '*sp' to the first byte following the parsed
1761 * string. On failure, returns a malloc()'d error message, does not modify
1762 * '*sp', and does not properly initialize 'sf'.
1764 * The syntax parsed from '*sp' takes the form "header[start..end]" where
1765 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
1766 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
1767 * may both be omitted (the [] are still required) to indicate an entire
1769 char * OVS_WARN_UNUSED_RESULT
1770 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
1772 const struct mf_field *field;
1773 const struct nxm_field *f;
1782 name_len = strcspn(s, "[");
1783 if (s[name_len] != '[') {
1784 return xasprintf("%s: missing [ looking for field name", *sp);
1787 f = mf_parse_subfield_name(name, name_len, &wild);
1789 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
1791 field = mf_from_id(f->id);
1794 if (ovs_scan(s, "[%d..%d]", &start, &end)) {
1795 /* Nothing to do. */
1796 } else if (ovs_scan(s, "[%d]", &start)) {
1798 } else if (!strncmp(s, "[]", 2)) {
1800 end = field->n_bits - 1;
1802 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
1803 "[<start>..<end>]", *sp);
1805 s = strchr(s, ']') + 1;
1808 return xasprintf("%s: starting bit %d is after ending bit %d",
1810 } else if (start >= field->n_bits) {
1811 return xasprintf("%s: starting bit %d is not valid because field is "
1812 "only %d bits wide", *sp, start, field->n_bits);
1813 } else if (end >= field->n_bits){
1814 return xasprintf("%s: ending bit %d is not valid because field is "
1815 "only %d bits wide", *sp, end, field->n_bits);
1820 sf->n_bits = end - start + 1;
1826 /* Parses a subfield from the entirety of 's' into 'sf'. Returns NULL if
1827 * successful, otherwise a malloc()'d string describing the error. The caller
1828 * is responsible for freeing the returned string.
1830 * The syntax parsed from 's' takes the form "header[start..end]" where
1831 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
1832 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
1833 * may both be omitted (the [] are still required) to indicate an entire
1835 char * OVS_WARN_UNUSED_RESULT
1836 mf_parse_subfield(struct mf_subfield *sf, const char *s)
1838 char *error = mf_parse_subfield__(sf, &s);
1839 if (!error && s[0]) {
1840 error = xstrdup("unexpected input following field syntax");
1845 /* Returns an bitmap in which each bit corresponds to the like-numbered field
1846 * in the OFPXMC12_OPENFLOW_BASIC OXM class, in which the bit values are taken
1847 * from the 'fields' bitmap. Only fields defined in OpenFlow 'version' are
1850 * This is useful for encoding OpenFlow 1.2 table stats messages. */
1852 oxm_bitmap_from_mf_bitmap(const struct mf_bitmap *fields,
1853 enum ofp_version version)
1855 uint64_t oxm_bitmap = 0;
1858 BITMAP_FOR_EACH_1 (i, MFF_N_IDS, fields->bm) {
1859 uint64_t oxm = mf_oxm_header(i, version);
1860 uint32_t class = nxm_class(oxm);
1861 int field = nxm_field(oxm);
1863 if (class == OFPXMC12_OPENFLOW_BASIC && field < 64) {
1864 oxm_bitmap |= UINT64_C(1) << field;
1867 return htonll(oxm_bitmap);
1870 /* Opposite conversion from oxm_bitmap_from_mf_bitmap().
1872 * This is useful for decoding OpenFlow 1.2 table stats messages. */
1874 oxm_bitmap_to_mf_bitmap(ovs_be64 oxm_bitmap, enum ofp_version version)
1876 struct mf_bitmap fields = MF_BITMAP_INITIALIZER;
1878 for (enum mf_field_id id = 0; id < MFF_N_IDS; id++) {
1879 uint64_t oxm = mf_oxm_header(id, version);
1880 if (oxm && version >= nxm_field_by_header(oxm)->version) {
1881 uint32_t class = nxm_class(oxm);
1882 int field = nxm_field(oxm);
1884 if (class == OFPXMC12_OPENFLOW_BASIC
1886 && oxm_bitmap & htonll(UINT64_C(1) << field)) {
1887 bitmap_set1(fields.bm, id);
1894 /* Returns a bitmap of fields that can be encoded in OXM and that can be
1895 * modified with a "set_field" action. */
1897 oxm_writable_fields(void)
1899 struct mf_bitmap b = MF_BITMAP_INITIALIZER;
1902 for (i = 0; i < MFF_N_IDS; i++) {
1903 if (mf_oxm_header(i, 0) && mf_from_id(i)->writable) {
1904 bitmap_set1(b.bm, i);
1910 /* Returns a bitmap of fields that can be encoded in OXM and that can be
1911 * matched in a flow table. */
1913 oxm_matchable_fields(void)
1915 struct mf_bitmap b = MF_BITMAP_INITIALIZER;
1918 for (i = 0; i < MFF_N_IDS; i++) {
1919 if (mf_oxm_header(i, 0)) {
1920 bitmap_set1(b.bm, i);
1926 /* Returns a bitmap of fields that can be encoded in OXM and that can be
1927 * matched in a flow table with an arbitrary bitmask. */
1929 oxm_maskable_fields(void)
1931 struct mf_bitmap b = MF_BITMAP_INITIALIZER;
1934 for (i = 0; i < MFF_N_IDS; i++) {
1935 if (mf_oxm_header(i, 0) && mf_from_id(i)->maskable == MFM_FULLY) {
1936 bitmap_set1(b.bm, i);
1942 struct nxm_field_index {
1943 struct hmap_node header_node; /* In nxm_header_map. */
1944 struct hmap_node name_node; /* In nxm_name_map. */
1945 struct ovs_list mf_node; /* In mf_mf_map[nf.id]. */
1946 const struct nxm_field nf;
1949 #include "nx-match.inc"
1951 static struct hmap nxm_header_map;
1952 static struct hmap nxm_name_map;
1953 static struct ovs_list nxm_mf_map[MFF_N_IDS];
1958 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
1959 if (ovsthread_once_start(&once)) {
1960 hmap_init(&nxm_header_map);
1961 hmap_init(&nxm_name_map);
1962 for (int i = 0; i < MFF_N_IDS; i++) {
1963 list_init(&nxm_mf_map[i]);
1965 for (struct nxm_field_index *nfi = all_nxm_fields;
1966 nfi < &all_nxm_fields[ARRAY_SIZE(all_nxm_fields)]; nfi++) {
1967 hmap_insert(&nxm_header_map, &nfi->header_node,
1968 hash_uint64(nxm_no_len(nfi->nf.header)));
1969 hmap_insert(&nxm_name_map, &nfi->name_node,
1970 hash_string(nfi->nf.name, 0));
1971 list_push_back(&nxm_mf_map[nfi->nf.id], &nfi->mf_node);
1973 ovsthread_once_done(&once);
1977 static const struct nxm_field *
1978 nxm_field_by_header(uint64_t header)
1980 const struct nxm_field_index *nfi;
1981 uint64_t header_no_len;
1984 if (nxm_hasmask(header)) {
1985 header = nxm_make_exact_header(header);
1988 header_no_len = nxm_no_len(header);
1990 HMAP_FOR_EACH_IN_BUCKET (nfi, header_node, hash_uint64(header_no_len),
1992 if (header_no_len == nxm_no_len(nfi->nf.header)) {
1993 if (nxm_length(header) == nxm_length(nfi->nf.header) ||
1994 mf_from_id(nfi->nf.id)->variable_len) {
2004 static const struct nxm_field *
2005 nxm_field_by_name(const char *name, size_t len)
2007 const struct nxm_field_index *nfi;
2010 HMAP_FOR_EACH_WITH_HASH (nfi, name_node, hash_bytes(name, len, 0),
2012 if (strlen(nfi->nf.name) == len && !memcmp(nfi->nf.name, name, len)) {
2019 static const struct nxm_field *
2020 nxm_field_by_mf_id(enum mf_field_id id, enum ofp_version version)
2022 const struct nxm_field_index *nfi;
2023 const struct nxm_field *f;
2028 LIST_FOR_EACH (nfi, mf_node, &nxm_mf_map[id]) {
2029 if (!f || version >= nfi->nf.version) {