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 "unaligned.h"
36 #include "openvswitch/vlog.h"
38 VLOG_DEFINE_THIS_MODULE(nx_match);
46 * The header is 32 bits long. It looks like this:
49 * +----------------------------------+---------------+--+------------------+
50 * | oxm_class | oxm_field |hm| oxm_length |
51 * +----------------------------------+---------------+--+------------------+
53 * where hm stands for oxm_hasmask. It is followed by oxm_length bytes of
54 * payload. When oxm_hasmask is 0, the payload is the value of the field
55 * identified by the header; when oxm_hasmask is 1, the payload is a value for
56 * the field followed by a mask of equal length.
58 * Internally, we represent a standard OXM header as a 64-bit integer with the
59 * above information in the most-significant bits.
65 * The header is 64 bits long. It looks like the diagram above except that a
66 * 32-bit experimenter ID, which we call oxm_vendor and which identifies a
67 * vendor, is inserted just before the payload. Experimenter OXMs are
68 * identified by an all-1-bits oxm_class (OFPXMC12_EXPERIMENTER). The
69 * oxm_length value *includes* the experimenter ID, so that the real payload is
70 * only oxm_length - 4 bytes long.
72 * Internally, we represent an experimenter OXM header as a 64-bit integer with
73 * the standard header in the upper 32 bits and the experimenter ID in the
74 * lower 32 bits. (It would be more convenient to swap the positions of the
75 * two 32-bit words, but this would be more error-prone because experimenter
76 * OXMs are very rarely used, so accidentally passing one through a 32-bit type
77 * somewhere in the OVS code would be hard to find.)
82 * The high order bit differentiate reserved classes from member classes.
83 * Classes 0x0000 to 0x7FFF are member classes, allocated by ONF.
84 * Classes 0x8000 to 0xFFFE are reserved classes, reserved for standardisation.
86 enum ofp12_oxm_class {
87 OFPXMC12_NXM_0 = 0x0000, /* Backward compatibility with NXM */
88 OFPXMC12_NXM_1 = 0x0001, /* Backward compatibility with NXM */
89 OFPXMC12_OPENFLOW_BASIC = 0x8000, /* Basic class for OpenFlow */
90 OFPXMC15_PACKET_REGS = 0x8001, /* Packet registers (pipeline fields). */
91 OFPXMC12_EXPERIMENTER = 0xffff, /* Experimenter class */
94 /* Functions for extracting raw field values from OXM/NXM headers. */
95 static uint32_t nxm_vendor(uint64_t header) { return header; }
96 static int nxm_class(uint64_t header) { return header >> 48; }
97 static int nxm_field(uint64_t header) { return (header >> 41) & 0x7f; }
98 static bool nxm_hasmask(uint64_t header) { return (header >> 40) & 1; }
99 static int nxm_length(uint64_t header) { return (header >> 32) & 0xff; }
100 static uint64_t nxm_no_len(uint64_t header) { return header & 0xffffff80ffffffffULL; }
103 is_experimenter_oxm(uint64_t header)
105 return nxm_class(header) == OFPXMC12_EXPERIMENTER;
108 /* The OXM header "length" field is somewhat tricky:
110 * - For a standard OXM header, the length is the number of bytes of the
111 * payload, and the payload consists of just the value (and mask, if
114 * - For an experimenter OXM header, the length is the number of bytes in
115 * the payload plus 4 (the length of the experimenter ID). That is, the
116 * experimenter ID is included in oxm_length.
118 * This function returns the length of the experimenter ID field in 'header'.
119 * That is, for an experimenter OXM (when an experimenter ID is present), it
120 * returns 4, and for a standard OXM (when no experimenter ID is present), it
123 nxm_experimenter_len(uint64_t header)
125 return is_experimenter_oxm(header) ? 4 : 0;
128 /* Returns the number of bytes that follow the header for an NXM/OXM entry
129 * with the given 'header'. */
131 nxm_payload_len(uint64_t header)
133 return nxm_length(header) - nxm_experimenter_len(header);
136 /* Returns the number of bytes in the header for an NXM/OXM entry with the
139 nxm_header_len(uint64_t header)
141 return 4 + nxm_experimenter_len(header);
144 #define NXM_HEADER(VENDOR, CLASS, FIELD, HASMASK, LENGTH) \
145 (((uint64_t) (CLASS) << 48) | \
146 ((uint64_t) (FIELD) << 41) | \
147 ((uint64_t) (HASMASK) << 40) | \
148 ((uint64_t) (LENGTH) << 32) | \
151 #define NXM_HEADER_FMT "%#"PRIx32":%d:%d:%d:%d"
152 #define NXM_HEADER_ARGS(HEADER) \
153 nxm_vendor(HEADER), nxm_class(HEADER), nxm_field(HEADER), \
154 nxm_hasmask(HEADER), nxm_length(HEADER)
156 /* Functions for turning the "hasmask" bit on or off. (This also requires
157 * adjusting the length.) */
159 nxm_make_exact_header(uint64_t header)
161 int new_len = nxm_payload_len(header) / 2 + nxm_experimenter_len(header);
162 return NXM_HEADER(nxm_vendor(header), nxm_class(header),
163 nxm_field(header), 0, new_len);
166 nxm_make_wild_header(uint64_t header)
168 int new_len = nxm_payload_len(header) * 2 + nxm_experimenter_len(header);
169 return NXM_HEADER(nxm_vendor(header), nxm_class(header),
170 nxm_field(header), 1, new_len);
175 * This may be used to gain the OpenFlow 1.1-like ability to restrict
176 * certain NXM-based Flow Mod and Flow Stats Request messages to flows
177 * with specific cookies. See the "nx_flow_mod" and "nx_flow_stats_request"
178 * structure definitions for more details. This match is otherwise not
180 #define NXM_NX_COOKIE NXM_HEADER (0, 0x0001, 30, 0, 8)
181 #define NXM_NX_COOKIE_W nxm_make_wild_header(NXM_NX_COOKIE)
185 enum ofp_version version;
186 const char *name; /* e.g. "NXM_OF_IN_PORT". */
191 static const struct nxm_field *nxm_field_by_header(uint64_t header);
192 static const struct nxm_field *nxm_field_by_name(const char *name, size_t len);
193 static const struct nxm_field *nxm_field_by_mf_id(enum mf_field_id,
196 static void nx_put_header__(struct ofpbuf *, uint64_t header, bool masked);
198 /* Rate limit for nx_match parse errors. These always indicate a bug in the
199 * peer and so there's not much point in showing a lot of them. */
200 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
202 static const struct nxm_field *
203 mf_parse_subfield_name(const char *name, int name_len, bool *wild);
205 /* Returns the preferred OXM header to use for field 'id' in OpenFlow version
206 * 'version'. Specify 0 for 'version' if an NXM legacy header should be
207 * preferred over any standardized OXM header. Returns 0 if field 'id' cannot
208 * be expressed in NXM or OXM. */
210 mf_oxm_header(enum mf_field_id id, enum ofp_version version)
212 const struct nxm_field *f = nxm_field_by_mf_id(id, version);
213 return f ? f->header : 0;
216 /* Returns the 32-bit OXM or NXM header to use for field 'id', preferring an
217 * NXM legacy header over any standardized OXM header. Returns 0 if field 'id'
218 * cannot be expressed with a 32-bit NXM or OXM header.
220 * Whenever possible, use nx_pull_header() instead of this function, because
221 * this function cannot support 64-bit experimenter OXM headers. */
223 mf_nxm_header(enum mf_field_id id)
225 uint64_t oxm = mf_oxm_header(id, 0);
226 return is_experimenter_oxm(oxm) ? 0 : oxm >> 32;
229 static const struct mf_field *
230 mf_from_oxm_header(uint64_t header)
232 const struct nxm_field *f = nxm_field_by_header(header);
233 return f ? mf_from_id(f->id) : NULL;
236 /* Returns the "struct mf_field" that corresponds to NXM or OXM header
237 * 'header', or NULL if 'header' doesn't correspond to any known field. */
238 const struct mf_field *
239 mf_from_nxm_header(uint32_t header)
241 return mf_from_oxm_header((uint64_t) header << 32);
244 /* Returns the width of the data for a field with the given 'header', in
247 nxm_field_bytes(uint64_t header)
249 unsigned int length = nxm_payload_len(header);
250 return nxm_hasmask(header) ? length / 2 : length;
253 /* nx_pull_match() and helpers. */
255 /* Given NXM/OXM value 'value' and mask 'mask' associated with 'header', checks
256 * for any 1-bit in the value where there is a 0-bit in the mask. Returns 0 if
257 * none, otherwise an error code. */
259 is_mask_consistent(uint64_t header, const uint8_t *value, const uint8_t *mask)
261 unsigned int width = nxm_field_bytes(header);
264 for (i = 0; i < width; i++) {
265 if (value[i] & ~mask[i]) {
266 if (!VLOG_DROP_WARN(&rl)) {
267 VLOG_WARN_RL(&rl, "Rejecting NXM/OXM entry "NXM_HEADER_FMT " "
268 "with 1-bits in value for bits wildcarded by the "
269 "mask.", NXM_HEADER_ARGS(header));
278 is_cookie_pseudoheader(uint64_t header)
280 return header == NXM_NX_COOKIE || header == NXM_NX_COOKIE_W;
284 nx_pull_header__(struct ofpbuf *b, bool allow_cookie, uint64_t *header,
285 const struct mf_field **field)
291 *header = ((uint64_t) ntohl(get_unaligned_be32(b->data))) << 32;
292 if (is_experimenter_oxm(*header)) {
296 *header = ntohll(get_unaligned_be64(b->data));
298 if (nxm_length(*header) <= nxm_experimenter_len(*header)) {
299 VLOG_WARN_RL(&rl, "OXM header "NXM_HEADER_FMT" has invalid length %d "
301 NXM_HEADER_ARGS(*header), nxm_length(*header),
302 nxm_header_len(*header) + 1);
305 ofpbuf_pull(b, nxm_header_len(*header));
308 *field = mf_from_oxm_header(*header);
309 if (!*field && !(allow_cookie && is_cookie_pseudoheader(*header))) {
310 VLOG_DBG_RL(&rl, "OXM header "NXM_HEADER_FMT" is unknown",
311 NXM_HEADER_ARGS(*header));
312 return OFPERR_OFPBMC_BAD_FIELD;
319 VLOG_DBG_RL(&rl, "encountered partial (%"PRIu32"-byte) OXM entry",
326 return OFPERR_OFPBMC_BAD_LEN;
330 nx_pull_entry__(struct ofpbuf *b, bool allow_cookie, uint64_t *header,
331 const struct mf_field **field,
332 union mf_value *value, union mf_value *mask)
334 enum ofperr header_error;
335 unsigned int payload_len;
336 const uint8_t *payload;
339 header_error = nx_pull_header__(b, allow_cookie, header, field);
340 if (header_error && header_error != OFPERR_OFPBMC_BAD_FIELD) {
344 payload_len = nxm_payload_len(*header);
345 payload = ofpbuf_try_pull(b, payload_len);
347 VLOG_DBG_RL(&rl, "OXM header "NXM_HEADER_FMT" calls for %u-byte "
348 "payload but only %"PRIu32" bytes follow OXM header",
349 NXM_HEADER_ARGS(*header), payload_len, b->size);
350 return OFPERR_OFPBMC_BAD_LEN;
353 width = nxm_field_bytes(*header);
354 if (nxm_hasmask(*header)
355 && !is_mask_consistent(*header, payload, payload + width)) {
356 return OFPERR_OFPBMC_BAD_WILDCARDS;
359 memcpy(value, payload, MIN(width, sizeof *value));
361 if (nxm_hasmask(*header)) {
362 memcpy(mask, payload + width, MIN(width, sizeof *mask));
364 memset(mask, 0xff, MIN(width, sizeof *mask));
366 } else if (nxm_hasmask(*header)) {
367 VLOG_DBG_RL(&rl, "OXM header "NXM_HEADER_FMT" includes mask but "
368 "masked OXMs are not allowed here",
369 NXM_HEADER_ARGS(*header));
370 return OFPERR_OFPBMC_BAD_MASK;
376 /* Attempts to pull an NXM or OXM header, value, and mask (if present) from the
377 * beginning of 'b'. If successful, stores a pointer to the "struct mf_field"
378 * corresponding to the pulled header in '*field', the value into '*value',
379 * and the mask into '*mask', and returns 0. On error, returns an OpenFlow
380 * error; in this case, some bytes might have been pulled off 'b' anyhow, and
381 * the output parameters might have been modified.
383 * If a NULL 'mask' is supplied, masked OXM or NXM entries are treated as
384 * errors (with OFPERR_OFPBMC_BAD_MASK).
387 nx_pull_entry(struct ofpbuf *b, const struct mf_field **field,
388 union mf_value *value, union mf_value *mask)
392 return nx_pull_entry__(b, false, &header, field, value, mask);
395 /* Attempts to pull an NXM or OXM header from the beginning of 'b'. If
396 * successful, stores a pointer to the "struct mf_field" corresponding to the
397 * pulled header in '*field', stores the header's hasmask bit in '*masked'
398 * (true if hasmask=1, false if hasmask=0), and returns 0. On error, returns
399 * an OpenFlow error; in this case, some bytes might have been pulled off 'b'
400 * anyhow, and the output parameters might have been modified.
402 * If NULL 'masked' is supplied, masked OXM or NXM headers are treated as
403 * errors (with OFPERR_OFPBMC_BAD_MASK).
406 nx_pull_header(struct ofpbuf *b, const struct mf_field **field, bool *masked)
411 error = nx_pull_header__(b, false, &header, field);
413 *masked = !error && nxm_hasmask(header);
414 } else if (!error && nxm_hasmask(header)) {
415 error = OFPERR_OFPBMC_BAD_MASK;
421 nx_pull_match_entry(struct ofpbuf *b, bool allow_cookie,
422 const struct mf_field **field,
423 union mf_value *value, union mf_value *mask)
428 error = nx_pull_entry__(b, allow_cookie, &header, field, value, mask);
432 if (field && *field) {
433 if (!mf_is_mask_valid(*field, mask)) {
434 VLOG_DBG_RL(&rl, "bad mask for field %s", (*field)->name);
435 return OFPERR_OFPBMC_BAD_MASK;
437 if (!mf_is_value_valid(*field, value)) {
438 VLOG_DBG_RL(&rl, "bad value for field %s", (*field)->name);
439 return OFPERR_OFPBMC_BAD_VALUE;
446 nx_pull_raw(const uint8_t *p, unsigned int match_len, bool strict,
447 struct match *match, ovs_be64 *cookie, ovs_be64 *cookie_mask)
451 ovs_assert((cookie != NULL) == (cookie_mask != NULL));
453 match_init_catchall(match);
455 *cookie = *cookie_mask = htonll(0);
458 ofpbuf_use_const(&b, p, match_len);
460 const uint8_t *pos = b.data;
461 const struct mf_field *field;
462 union mf_value value;
466 error = nx_pull_match_entry(&b, cookie != NULL, &field, &value, &mask);
468 if (error == OFPERR_OFPBMC_BAD_FIELD && !strict) {
473 error = OFPERR_OFPBMC_BAD_FIELD;
474 } else if (*cookie_mask) {
475 error = OFPERR_OFPBMC_DUP_FIELD;
477 *cookie = value.be64;
478 *cookie_mask = mask.be64;
480 } else if (!mf_are_prereqs_ok(field, &match->flow)) {
481 error = OFPERR_OFPBMC_BAD_PREREQ;
482 } else if (!mf_is_all_wild(field, &match->wc)) {
483 error = OFPERR_OFPBMC_DUP_FIELD;
485 mf_set(field, &value, &mask, match);
489 VLOG_DBG_RL(&rl, "error parsing OXM at offset %"PRIdPTR" "
490 "within match (%s)", pos -
491 p, ofperr_to_string(error));
500 nx_pull_match__(struct ofpbuf *b, unsigned int match_len, bool strict,
502 ovs_be64 *cookie, ovs_be64 *cookie_mask)
507 p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
509 VLOG_DBG_RL(&rl, "nx_match length %u, rounded up to a "
510 "multiple of 8, is longer than space in message (max "
511 "length %"PRIu32")", match_len, b->size);
512 return OFPERR_OFPBMC_BAD_LEN;
516 return nx_pull_raw(p, match_len, strict, match, cookie, cookie_mask);
519 /* Parses the nx_match formatted match description in 'b' with length
520 * 'match_len'. Stores the results in 'match'. If 'cookie' and 'cookie_mask'
521 * are valid pointers, then stores the cookie and mask in them if 'b' contains
522 * a "NXM_NX_COOKIE*" match. Otherwise, stores 0 in both.
524 * Fails with an error upon encountering an unknown NXM header.
526 * Returns 0 if successful, otherwise an OpenFlow error code. */
528 nx_pull_match(struct ofpbuf *b, unsigned int match_len, struct match *match,
529 ovs_be64 *cookie, ovs_be64 *cookie_mask)
531 return nx_pull_match__(b, match_len, true, match, cookie, cookie_mask);
534 /* Behaves the same as nx_pull_match(), but skips over unknown NXM headers,
535 * instead of failing with an error. */
537 nx_pull_match_loose(struct ofpbuf *b, unsigned int match_len,
539 ovs_be64 *cookie, ovs_be64 *cookie_mask)
541 return nx_pull_match__(b, match_len, false, match, cookie, cookie_mask);
545 oxm_pull_match__(struct ofpbuf *b, bool strict, struct match *match)
547 struct ofp11_match_header *omh = b->data;
551 if (b->size < sizeof *omh) {
552 return OFPERR_OFPBMC_BAD_LEN;
555 match_len = ntohs(omh->length);
556 if (match_len < sizeof *omh) {
557 return OFPERR_OFPBMC_BAD_LEN;
560 if (omh->type != htons(OFPMT_OXM)) {
561 return OFPERR_OFPBMC_BAD_TYPE;
564 p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
566 VLOG_DBG_RL(&rl, "oxm length %u, rounded up to a "
567 "multiple of 8, is longer than space in message (max "
568 "length %"PRIu32")", match_len, b->size);
569 return OFPERR_OFPBMC_BAD_LEN;
572 return nx_pull_raw(p + sizeof *omh, match_len - sizeof *omh,
573 strict, match, NULL, NULL);
576 /* Parses the oxm formatted match description preceded by a struct
577 * ofp11_match_header in 'b'. Stores the result in 'match'.
579 * Fails with an error when encountering unknown OXM headers.
581 * Returns 0 if successful, otherwise an OpenFlow error code. */
583 oxm_pull_match(struct ofpbuf *b, struct match *match)
585 return oxm_pull_match__(b, true, match);
588 /* Behaves the same as oxm_pull_match() with one exception. Skips over unknown
589 * OXM headers instead of failing with an error when they are encountered. */
591 oxm_pull_match_loose(struct ofpbuf *b, struct match *match)
593 return oxm_pull_match__(b, false, match);
596 /* Verify an array of OXM TLVs treating value of each TLV as a mask,
597 * disallowing masks in each TLV and ignoring pre-requisites. */
599 oxm_pull_field_array(const void *fields_data, size_t fields_len,
600 struct field_array *fa)
604 ofpbuf_use_const(&b, fields_data, fields_len);
606 const uint8_t *pos = b.data;
607 const struct mf_field *field;
608 union mf_value value;
612 error = nx_pull_entry__(&b, false, &header, &field, &value, NULL);
614 VLOG_DBG_RL(&rl, "error pulling field array field");
617 VLOG_DBG_RL(&rl, "unknown field array field");
618 error = OFPERR_OFPBMC_BAD_FIELD;
619 } else if (bitmap_is_set(fa->used.bm, field->id)) {
620 VLOG_DBG_RL(&rl, "duplicate field array field '%s'", field->name);
621 error = OFPERR_OFPBMC_DUP_FIELD;
622 } else if (!mf_is_mask_valid(field, &value)) {
623 VLOG_DBG_RL(&rl, "bad mask in field array field '%s'", field->name);
624 return OFPERR_OFPBMC_BAD_MASK;
626 field_array_set(field->id, &value, fa);
630 const uint8_t *start = fields_data;
632 VLOG_DBG_RL(&rl, "error parsing OXM at offset %"PRIdPTR" "
633 "within field array (%s)", pos - start,
634 ofperr_to_string(error));
642 /* nx_put_match() and helpers.
644 * 'put' functions whose names end in 'w' add a wildcarded field.
645 * 'put' functions whose names end in 'm' add a field that might be wildcarded.
646 * Other 'put' functions add exact-match fields.
650 nxm_put_unmasked(struct ofpbuf *b, enum mf_field_id field,
651 enum ofp_version version, const void *value, size_t n_bytes)
653 nx_put_header(b, field, version, false);
654 ofpbuf_put(b, value, n_bytes);
658 nxm_put(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
659 const void *value, const void *mask, size_t n_bytes)
661 if (!is_all_zeros(mask, n_bytes)) {
662 bool masked = !is_all_ones(mask, n_bytes);
663 nx_put_header(b, field, version, masked);
664 ofpbuf_put(b, value, n_bytes);
666 ofpbuf_put(b, mask, n_bytes);
672 nxm_put_8m(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
673 uint8_t value, uint8_t mask)
675 nxm_put(b, field, version, &value, &mask, sizeof value);
679 nxm_put_8(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
682 nxm_put_unmasked(b, field, version, &value, sizeof value);
686 nxm_put_16m(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
687 ovs_be16 value, ovs_be16 mask)
689 nxm_put(b, field, version, &value, &mask, sizeof value);
693 nxm_put_16(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
696 nxm_put_unmasked(b, field, version, &value, sizeof value);
700 nxm_put_32m(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
701 ovs_be32 value, ovs_be32 mask)
703 nxm_put(b, field, version, &value, &mask, sizeof value);
707 nxm_put_32(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
710 nxm_put_unmasked(b, field, version, &value, sizeof value);
714 nxm_put_64m(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
715 ovs_be64 value, ovs_be64 mask)
717 nxm_put(b, field, version, &value, &mask, sizeof value);
721 nxm_put_eth_masked(struct ofpbuf *b,
722 enum mf_field_id field, enum ofp_version version,
723 const uint8_t value[ETH_ADDR_LEN],
724 const uint8_t mask[ETH_ADDR_LEN])
726 nxm_put(b, field, version, value, mask, ETH_ADDR_LEN);
730 nxm_put_ipv6(struct ofpbuf *b,
731 enum mf_field_id field, enum ofp_version version,
732 const struct in6_addr *value, const struct in6_addr *mask)
734 nxm_put(b, field, version, value->s6_addr, mask->s6_addr,
735 sizeof value->s6_addr);
739 nxm_put_frag(struct ofpbuf *b, const struct match *match,
740 enum ofp_version version)
742 uint8_t nw_frag = match->flow.nw_frag & FLOW_NW_FRAG_MASK;
743 uint8_t nw_frag_mask = match->wc.masks.nw_frag & FLOW_NW_FRAG_MASK;
745 nxm_put_8m(b, MFF_IP_FRAG, version, nw_frag,
746 nw_frag_mask == FLOW_NW_FRAG_MASK ? UINT8_MAX : nw_frag_mask);
749 /* Appends to 'b' a set of OXM or NXM matches for the IPv4 or IPv6 fields in
752 nxm_put_ip(struct ofpbuf *b, const struct match *match, enum ofp_version oxm)
754 const struct flow *flow = &match->flow;
756 if (flow->dl_type == htons(ETH_TYPE_IP)) {
757 nxm_put_32m(b, MFF_IPV4_SRC, oxm,
758 flow->nw_src, match->wc.masks.nw_src);
759 nxm_put_32m(b, MFF_IPV4_DST, oxm,
760 flow->nw_dst, match->wc.masks.nw_dst);
762 nxm_put_ipv6(b, MFF_IPV6_SRC, oxm,
763 &flow->ipv6_src, &match->wc.masks.ipv6_src);
764 nxm_put_ipv6(b, MFF_IPV6_DST, oxm,
765 &flow->ipv6_dst, &match->wc.masks.ipv6_dst);
768 nxm_put_frag(b, match, oxm);
770 if (match->wc.masks.nw_tos & IP_DSCP_MASK) {
772 nxm_put_8(b, MFF_IP_DSCP_SHIFTED, oxm,
775 nxm_put_8(b, MFF_IP_DSCP, oxm,
776 flow->nw_tos & IP_DSCP_MASK);
780 if (match->wc.masks.nw_tos & IP_ECN_MASK) {
781 nxm_put_8(b, MFF_IP_ECN, oxm,
782 flow->nw_tos & IP_ECN_MASK);
785 if (!oxm && match->wc.masks.nw_ttl) {
786 nxm_put_8(b, MFF_IP_TTL, oxm, flow->nw_ttl);
789 nxm_put_32m(b, MFF_IPV6_LABEL, oxm,
790 flow->ipv6_label, match->wc.masks.ipv6_label);
792 if (match->wc.masks.nw_proto) {
793 nxm_put_8(b, MFF_IP_PROTO, oxm, flow->nw_proto);
795 if (flow->nw_proto == IPPROTO_TCP) {
796 nxm_put_16m(b, MFF_TCP_SRC, oxm,
797 flow->tp_src, match->wc.masks.tp_src);
798 nxm_put_16m(b, MFF_TCP_DST, oxm,
799 flow->tp_dst, match->wc.masks.tp_dst);
800 nxm_put_16m(b, MFF_TCP_FLAGS, oxm,
801 flow->tcp_flags, match->wc.masks.tcp_flags);
802 } else if (flow->nw_proto == IPPROTO_UDP) {
803 nxm_put_16m(b, MFF_UDP_SRC, oxm,
804 flow->tp_src, match->wc.masks.tp_src);
805 nxm_put_16m(b, MFF_UDP_DST, oxm,
806 flow->tp_dst, match->wc.masks.tp_dst);
807 } else if (flow->nw_proto == IPPROTO_SCTP) {
808 nxm_put_16m(b, MFF_SCTP_SRC, oxm, flow->tp_src,
809 match->wc.masks.tp_src);
810 nxm_put_16m(b, MFF_SCTP_DST, oxm, flow->tp_dst,
811 match->wc.masks.tp_dst);
812 } else if (is_icmpv4(flow)) {
813 if (match->wc.masks.tp_src) {
814 nxm_put_8(b, MFF_ICMPV4_TYPE, oxm,
815 ntohs(flow->tp_src));
817 if (match->wc.masks.tp_dst) {
818 nxm_put_8(b, MFF_ICMPV4_CODE, oxm,
819 ntohs(flow->tp_dst));
821 } else if (is_icmpv6(flow)) {
822 if (match->wc.masks.tp_src) {
823 nxm_put_8(b, MFF_ICMPV6_TYPE, oxm,
824 ntohs(flow->tp_src));
826 if (match->wc.masks.tp_dst) {
827 nxm_put_8(b, MFF_ICMPV6_CODE, oxm,
828 ntohs(flow->tp_dst));
830 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
831 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
832 nxm_put_ipv6(b, MFF_ND_TARGET, oxm,
833 &flow->nd_target, &match->wc.masks.nd_target);
834 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
835 nxm_put_eth_masked(b, MFF_ND_SLL, oxm,
836 flow->arp_sha, match->wc.masks.arp_sha);
838 if (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
839 nxm_put_eth_masked(b, MFF_ND_TLL, oxm,
840 flow->arp_tha, match->wc.masks.arp_tha);
847 /* Appends to 'b' the nx_match format that expresses 'match'. For Flow Mod and
848 * Flow Stats Requests messages, a 'cookie' and 'cookie_mask' may be supplied.
849 * Otherwise, 'cookie_mask' should be zero.
851 * Specify 'oxm' as 0 to express the match in NXM format; otherwise, specify
852 * 'oxm' as the OpenFlow version number for the OXM format to use.
854 * This function can cause 'b''s data to be reallocated.
856 * Returns the number of bytes appended to 'b', excluding padding.
858 * If 'match' is a catch-all rule that matches every packet, then this function
859 * appends nothing to 'b' and returns 0. */
861 nx_put_raw(struct ofpbuf *b, enum ofp_version oxm, const struct match *match,
862 ovs_be64 cookie, ovs_be64 cookie_mask)
864 const struct flow *flow = &match->flow;
865 const size_t start_len = b->size;
869 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 31);
872 if (match->wc.masks.dp_hash) {
873 nxm_put_32m(b, MFF_DP_HASH, oxm,
874 htonl(flow->dp_hash), htonl(match->wc.masks.dp_hash));
877 if (match->wc.masks.recirc_id) {
878 nxm_put_32(b, MFF_RECIRC_ID, oxm, htonl(flow->recirc_id));
881 if (match->wc.masks.conj_id) {
882 nxm_put_32(b, MFF_CONJ_ID, oxm, htonl(flow->conj_id));
885 if (match->wc.masks.in_port.ofp_port) {
886 ofp_port_t in_port = flow->in_port.ofp_port;
888 nxm_put_32(b, MFF_IN_PORT_OXM, oxm,
889 ofputil_port_to_ofp11(in_port));
891 nxm_put_16(b, MFF_IN_PORT, oxm,
892 htons(ofp_to_u16(in_port)));
895 if (match->wc.masks.actset_output) {
896 nxm_put_32(b, MFF_ACTSET_OUTPUT, oxm,
897 ofputil_port_to_ofp11(flow->actset_output));
901 nxm_put_eth_masked(b, MFF_ETH_SRC, oxm,
902 flow->dl_src, match->wc.masks.dl_src);
903 nxm_put_eth_masked(b, MFF_ETH_DST, oxm,
904 flow->dl_dst, match->wc.masks.dl_dst);
905 nxm_put_16m(b, MFF_ETH_TYPE, oxm,
906 ofputil_dl_type_to_openflow(flow->dl_type),
907 match->wc.masks.dl_type);
911 ovs_be16 VID_CFI_MASK = htons(VLAN_VID_MASK | VLAN_CFI);
912 ovs_be16 vid = flow->vlan_tci & VID_CFI_MASK;
913 ovs_be16 mask = match->wc.masks.vlan_tci & VID_CFI_MASK;
915 if (mask == htons(VLAN_VID_MASK | VLAN_CFI)) {
916 nxm_put_16(b, MFF_VLAN_VID, oxm, vid);
918 nxm_put_16m(b, MFF_VLAN_VID, oxm, vid, mask);
921 if (vid && vlan_tci_to_pcp(match->wc.masks.vlan_tci)) {
922 nxm_put_8(b, MFF_VLAN_PCP, oxm,
923 vlan_tci_to_pcp(flow->vlan_tci));
927 nxm_put_16m(b, MFF_VLAN_TCI, oxm, flow->vlan_tci,
928 match->wc.masks.vlan_tci);
932 if (eth_type_mpls(flow->dl_type)) {
933 if (match->wc.masks.mpls_lse[0] & htonl(MPLS_TC_MASK)) {
934 nxm_put_8(b, MFF_MPLS_TC, oxm,
935 mpls_lse_to_tc(flow->mpls_lse[0]));
938 if (match->wc.masks.mpls_lse[0] & htonl(MPLS_BOS_MASK)) {
939 nxm_put_8(b, MFF_MPLS_BOS, oxm,
940 mpls_lse_to_bos(flow->mpls_lse[0]));
943 if (match->wc.masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK)) {
944 nxm_put_32(b, MFF_MPLS_LABEL, oxm,
945 htonl(mpls_lse_to_label(flow->mpls_lse[0])));
950 if (is_ip_any(flow)) {
951 nxm_put_ip(b, match, oxm);
952 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
953 flow->dl_type == htons(ETH_TYPE_RARP)) {
955 if (match->wc.masks.nw_proto) {
956 nxm_put_16(b, MFF_ARP_OP, oxm,
957 htons(flow->nw_proto));
959 nxm_put_32m(b, MFF_ARP_SPA, oxm,
960 flow->nw_src, match->wc.masks.nw_src);
961 nxm_put_32m(b, MFF_ARP_TPA, oxm,
962 flow->nw_dst, match->wc.masks.nw_dst);
963 nxm_put_eth_masked(b, MFF_ARP_SHA, oxm,
964 flow->arp_sha, match->wc.masks.arp_sha);
965 nxm_put_eth_masked(b, MFF_ARP_THA, oxm,
966 flow->arp_tha, match->wc.masks.arp_tha);
970 nxm_put_64m(b, MFF_TUN_ID, oxm,
971 flow->tunnel.tun_id, match->wc.masks.tunnel.tun_id);
973 /* Other tunnel metadata. */
974 nxm_put_32m(b, MFF_TUN_SRC, oxm,
975 flow->tunnel.ip_src, match->wc.masks.tunnel.ip_src);
976 nxm_put_32m(b, MFF_TUN_DST, oxm,
977 flow->tunnel.ip_dst, match->wc.masks.tunnel.ip_dst);
978 nxm_put_16m(b, MFF_TUN_GBP_ID, oxm,
979 flow->tunnel.gbp_id, match->wc.masks.tunnel.gbp_id);
980 nxm_put_8m(b, MFF_TUN_GBP_FLAGS, oxm,
981 flow->tunnel.gbp_flags, match->wc.masks.tunnel.gbp_flags);
984 if (oxm < OFP15_VERSION) {
985 for (i = 0; i < FLOW_N_REGS; i++) {
986 nxm_put_32m(b, MFF_REG0 + i, oxm,
987 htonl(flow->regs[i]), htonl(match->wc.masks.regs[i]));
990 for (i = 0; i < FLOW_N_XREGS; i++) {
991 nxm_put_64m(b, MFF_XREG0 + i, oxm,
992 htonll(flow_get_xreg(flow, i)),
993 htonll(flow_get_xreg(&match->wc.masks, i)));
998 nxm_put_32m(b, MFF_PKT_MARK, oxm, htonl(flow->pkt_mark),
999 htonl(match->wc.masks.pkt_mark));
1001 /* OpenFlow 1.1+ Metadata. */
1002 nxm_put_64m(b, MFF_METADATA, oxm,
1003 flow->metadata, match->wc.masks.metadata);
1007 bool masked = cookie_mask != OVS_BE64_MAX;
1009 cookie &= cookie_mask;
1010 nx_put_header__(b, NXM_NX_COOKIE, masked);
1011 ofpbuf_put(b, &cookie, sizeof cookie);
1013 ofpbuf_put(b, &cookie_mask, sizeof cookie_mask);
1017 match_len = b->size - start_len;
1021 /* Appends to 'b' the nx_match format that expresses 'match', plus enough zero
1022 * bytes to pad the nx_match out to a multiple of 8. For Flow Mod and Flow
1023 * Stats Requests messages, a 'cookie' and 'cookie_mask' may be supplied.
1024 * Otherwise, 'cookie_mask' should be zero.
1026 * This function can cause 'b''s data to be reallocated.
1028 * Returns the number of bytes appended to 'b', excluding padding. The return
1029 * value can be zero if it appended nothing at all to 'b' (which happens if
1030 * 'cr' is a catch-all rule that matches every packet). */
1032 nx_put_match(struct ofpbuf *b, const struct match *match,
1033 ovs_be64 cookie, ovs_be64 cookie_mask)
1035 int match_len = nx_put_raw(b, 0, match, cookie, cookie_mask);
1037 ofpbuf_put_zeros(b, PAD_SIZE(match_len, 8));
1041 /* Appends to 'b' an struct ofp11_match_header followed by the OXM format that
1042 * expresses 'cr', plus enough zero bytes to pad the data appended out to a
1045 * OXM differs slightly among versions of OpenFlow. Specify the OpenFlow
1046 * version in use as 'version'.
1048 * This function can cause 'b''s data to be reallocated.
1050 * Returns the number of bytes appended to 'b', excluding the padding. Never
1053 oxm_put_match(struct ofpbuf *b, const struct match *match,
1054 enum ofp_version version)
1057 struct ofp11_match_header *omh;
1058 size_t start_len = b->size;
1059 ovs_be64 cookie = htonll(0), cookie_mask = htonll(0);
1061 ofpbuf_put_uninit(b, sizeof *omh);
1062 match_len = (nx_put_raw(b, version, match, cookie, cookie_mask)
1064 ofpbuf_put_zeros(b, PAD_SIZE(match_len, 8));
1066 omh = ofpbuf_at(b, start_len, sizeof *omh);
1067 omh->type = htons(OFPMT_OXM);
1068 omh->length = htons(match_len);
1073 /* Appends to 'b' the nx_match format that expresses the tlv corresponding
1074 * to 'id'. If mask is not all-ones then it is also formated as the value
1077 nx_format_mask_tlv(struct ds *ds, enum mf_field_id id,
1078 const union mf_value *mask)
1080 const struct mf_field *mf = mf_from_id(id);
1082 ds_put_format(ds, "%s", mf->name);
1084 if (!is_all_ones(mask, mf->n_bytes)) {
1085 ds_put_char(ds, '=');
1086 mf_format(mf, mask, NULL, ds);
1089 ds_put_char(ds, ',');
1092 /* Appends a string representation of 'fa_' to 'ds'.
1093 * The TLVS value of 'fa_' is treated as a mask and
1094 * only the name of fields is formated if it is all ones. */
1096 oxm_format_field_array(struct ds *ds, const struct field_array *fa)
1098 size_t start_len = ds->length;
1101 for (i = 0; i < MFF_N_IDS; i++) {
1102 if (bitmap_is_set(fa->used.bm, i)) {
1103 nx_format_mask_tlv(ds, i, &fa->value[i]);
1107 if (ds->length > start_len) {
1112 /* Appends to 'b' a series of OXM TLVs corresponding to the series
1113 * of enum mf_field_id and value tuples in 'fa_'.
1115 * OXM differs slightly among versions of OpenFlow. Specify the OpenFlow
1116 * version in use as 'version'.
1118 * This function can cause 'b''s data to be reallocated.
1120 * Returns the number of bytes appended to 'b'. May return zero. */
1122 oxm_put_field_array(struct ofpbuf *b, const struct field_array *fa,
1123 enum ofp_version version)
1125 size_t start_len = b->size;
1128 /* Field arrays are only used with the group selection method
1129 * property and group properties are only available in OpenFlow 1.5+.
1130 * So the following assertion should never fail.
1132 * If support for older OpenFlow versions is desired then some care
1133 * will need to be taken of different TLVs that handle the same
1134 * flow fields. In particular:
1135 * - VLAN_TCI, VLAN_VID and MFF_VLAN_PCP
1136 * - IP_DSCP_MASK and DSCP_SHIFTED
1139 ovs_assert(version >= OFP15_VERSION);
1141 for (i = 0; i < MFF_N_IDS; i++) {
1142 if (bitmap_is_set(fa->used.bm, i)) {
1143 nxm_put_unmasked(b, i, version, &fa->value[i],
1144 mf_from_id(i)->n_bytes);
1148 return b->size - start_len;
1152 nx_put_header__(struct ofpbuf *b, uint64_t header, bool masked)
1154 uint64_t masked_header = masked ? nxm_make_wild_header(header) : header;
1155 ovs_be64 network_header = htonll(masked_header);
1157 ofpbuf_put(b, &network_header, nxm_header_len(header));
1161 nx_put_header(struct ofpbuf *b, enum mf_field_id field,
1162 enum ofp_version version, bool masked)
1164 nx_put_header__(b, mf_oxm_header(field, version), masked);
1168 nx_put_entry(struct ofpbuf *b,
1169 enum mf_field_id field, enum ofp_version version,
1170 const union mf_value *value, const union mf_value *mask)
1172 int n_bytes = mf_from_id(field)->n_bytes;
1173 bool masked = mask && !is_all_ones(mask, n_bytes);
1175 nx_put_header(b, field, version, masked);
1176 ofpbuf_put(b, value, n_bytes);
1178 ofpbuf_put(b, mask, n_bytes);
1182 /* nx_match_to_string() and helpers. */
1184 static void format_nxm_field_name(struct ds *, uint64_t header);
1187 nx_match_to_string(const uint8_t *p, unsigned int match_len)
1193 return xstrdup("<any>");
1196 ofpbuf_use_const(&b, p, match_len);
1199 union mf_value value;
1200 union mf_value mask;
1205 error = nx_pull_entry__(&b, true, &header, NULL, &value, &mask);
1209 value_len = MIN(sizeof value, nxm_field_bytes(header));
1212 ds_put_cstr(&s, ", ");
1215 format_nxm_field_name(&s, header);
1216 ds_put_char(&s, '(');
1218 for (int i = 0; i < value_len; i++) {
1219 ds_put_format(&s, "%02x", ((const uint8_t *) &value)[i]);
1221 if (nxm_hasmask(header)) {
1222 ds_put_char(&s, '/');
1223 for (int i = 0; i < value_len; i++) {
1224 ds_put_format(&s, "%02x", ((const uint8_t *) &mask)[i]);
1227 ds_put_char(&s, ')');
1232 ds_put_cstr(&s, ", ");
1235 ds_put_format(&s, "<%u invalid bytes>", b.size);
1238 return ds_steal_cstr(&s);
1242 oxm_match_to_string(const struct ofpbuf *p, unsigned int match_len)
1244 const struct ofp11_match_header *omh = p->data;
1245 uint16_t match_len_;
1250 if (match_len < sizeof *omh) {
1251 ds_put_format(&s, "<match too short: %u>", match_len);
1255 if (omh->type != htons(OFPMT_OXM)) {
1256 ds_put_format(&s, "<bad match type field: %u>", ntohs(omh->type));
1260 match_len_ = ntohs(omh->length);
1261 if (match_len_ < sizeof *omh) {
1262 ds_put_format(&s, "<match length field too short: %u>", match_len_);
1266 if (match_len_ != match_len) {
1267 ds_put_format(&s, "<match length field incorrect: %u != %u>",
1268 match_len_, match_len);
1272 return nx_match_to_string(ofpbuf_at(p, sizeof *omh, 0),
1273 match_len - sizeof *omh);
1276 return ds_steal_cstr(&s);
1280 nx_format_field_name(enum mf_field_id id, enum ofp_version version,
1283 format_nxm_field_name(s, mf_oxm_header(id, version));
1287 format_nxm_field_name(struct ds *s, uint64_t header)
1289 const struct nxm_field *f = nxm_field_by_header(header);
1291 ds_put_cstr(s, f->name);
1292 if (nxm_hasmask(header)) {
1293 ds_put_cstr(s, "_W");
1295 } else if (header == NXM_NX_COOKIE) {
1296 ds_put_cstr(s, "NXM_NX_COOKIE");
1297 } else if (header == NXM_NX_COOKIE_W) {
1298 ds_put_cstr(s, "NXM_NX_COOKIE_W");
1300 ds_put_format(s, "%d:%d", nxm_class(header), nxm_field(header));
1305 streq_len(const char *a, size_t a_len, const char *b)
1307 return strlen(b) == a_len && !memcmp(a, b, a_len);
1311 parse_nxm_field_name(const char *name, int name_len)
1313 const struct nxm_field *f;
1316 f = mf_parse_subfield_name(name, name_len, &wild);
1320 } else if (mf_from_id(f->id)->maskable != MFM_NONE) {
1321 return nxm_make_wild_header(f->header);
1325 if (streq_len(name, name_len, "NXM_NX_COOKIE")) {
1326 return NXM_NX_COOKIE;
1327 } else if (streq_len(name, name_len, "NXM_NX_COOKIE_W")) {
1328 return NXM_NX_COOKIE_W;
1331 /* Check whether it's a field header value as hex.
1332 * (This isn't ordinarily useful except for testing error behavior.) */
1333 if (name_len == 8) {
1337 header = hexits_value(name, name_len, &ok) << 32;
1341 } else if (name_len == 16) {
1345 header = hexits_value(name, name_len, &ok);
1346 if (ok && is_experimenter_oxm(header)) {
1354 /* nx_match_from_string(). */
1357 nx_match_from_string_raw(const char *s, struct ofpbuf *b)
1359 const char *full_s = s;
1360 const size_t start_len = b->size;
1362 if (!strcmp(s, "<any>")) {
1363 /* Ensure that 'b->data' isn't actually null. */
1364 ofpbuf_prealloc_tailroom(b, 1);
1368 for (s += strspn(s, ", "); *s; s += strspn(s, ", ")) {
1375 name_len = strcspn(s, "(");
1376 if (s[name_len] != '(') {
1377 ovs_fatal(0, "%s: missing ( at end of nx_match", full_s);
1380 header = parse_nxm_field_name(name, name_len);
1382 ovs_fatal(0, "%s: unknown field `%.*s'", full_s, name_len, s);
1387 nx_put_header__(b, header, false);
1388 s = ofpbuf_put_hex(b, s, &n);
1389 if (n != nxm_field_bytes(header)) {
1390 ovs_fatal(0, "%.2s: hex digits expected", s);
1392 if (nxm_hasmask(header)) {
1393 s += strspn(s, " ");
1395 ovs_fatal(0, "%s: missing / in masked field %.*s",
1396 full_s, name_len, name);
1398 s = ofpbuf_put_hex(b, s + 1, &n);
1399 if (n != nxm_field_bytes(header)) {
1400 ovs_fatal(0, "%.2s: hex digits expected", s);
1404 s += strspn(s, " ");
1406 ovs_fatal(0, "%s: missing ) following field %.*s",
1407 full_s, name_len, name);
1412 return b->size - start_len;
1416 nx_match_from_string(const char *s, struct ofpbuf *b)
1418 int match_len = nx_match_from_string_raw(s, b);
1419 ofpbuf_put_zeros(b, PAD_SIZE(match_len, 8));
1424 oxm_match_from_string(const char *s, struct ofpbuf *b)
1427 struct ofp11_match_header *omh;
1428 size_t start_len = b->size;
1430 ofpbuf_put_uninit(b, sizeof *omh);
1431 match_len = nx_match_from_string_raw(s, b) + sizeof *omh;
1432 ofpbuf_put_zeros(b, PAD_SIZE(match_len, 8));
1434 omh = ofpbuf_at(b, start_len, sizeof *omh);
1435 omh->type = htons(OFPMT_OXM);
1436 omh->length = htons(match_len);
1441 /* Parses 's' as a "move" action, in the form described in ovs-ofctl(8), into
1444 * Returns NULL if successful, otherwise a malloc()'d string describing the
1445 * error. The caller is responsible for freeing the returned string. */
1446 char * OVS_WARN_UNUSED_RESULT
1447 nxm_parse_reg_move(struct ofpact_reg_move *move, const char *s)
1449 const char *full_s = s;
1452 error = mf_parse_subfield__(&move->src, &s);
1456 if (strncmp(s, "->", 2)) {
1457 return xasprintf("%s: missing `->' following source", full_s);
1460 error = mf_parse_subfield(&move->dst, s);
1465 if (move->src.n_bits != move->dst.n_bits) {
1466 return xasprintf("%s: source field is %d bits wide but destination is "
1467 "%d bits wide", full_s,
1468 move->src.n_bits, move->dst.n_bits);
1473 /* nxm_format_reg_move(). */
1476 nxm_format_reg_move(const struct ofpact_reg_move *move, struct ds *s)
1478 ds_put_format(s, "move:");
1479 mf_format_subfield(&move->src, s);
1480 ds_put_cstr(s, "->");
1481 mf_format_subfield(&move->dst, s);
1486 nxm_reg_move_check(const struct ofpact_reg_move *move, const struct flow *flow)
1490 error = mf_check_src(&move->src, flow);
1495 return mf_check_dst(&move->dst, flow);
1498 /* nxm_execute_reg_move(). */
1501 nxm_execute_reg_move(const struct ofpact_reg_move *move,
1502 struct flow *flow, struct flow_wildcards *wc)
1504 union mf_value src_value;
1505 union mf_value dst_value;
1507 mf_mask_field_and_prereqs(move->dst.field, &wc->masks);
1508 mf_mask_field_and_prereqs(move->src.field, &wc->masks);
1510 /* A flow may wildcard nw_frag. Do nothing if setting a transport
1511 * header field on a packet that does not have them. */
1512 if (mf_are_prereqs_ok(move->dst.field, flow)
1513 && mf_are_prereqs_ok(move->src.field, flow)) {
1515 mf_get_value(move->dst.field, flow, &dst_value);
1516 mf_get_value(move->src.field, flow, &src_value);
1517 bitwise_copy(&src_value, move->src.field->n_bytes, move->src.ofs,
1518 &dst_value, move->dst.field->n_bytes, move->dst.ofs,
1520 mf_set_flow_value(move->dst.field, &dst_value, flow);
1525 nxm_reg_load(const struct mf_subfield *dst, uint64_t src_data,
1526 struct flow *flow, struct flow_wildcards *wc)
1528 union mf_subvalue src_subvalue;
1529 union mf_subvalue mask_value;
1530 ovs_be64 src_data_be = htonll(src_data);
1532 memset(&mask_value, 0xff, sizeof mask_value);
1533 mf_write_subfield_flow(dst, &mask_value, &wc->masks);
1535 bitwise_copy(&src_data_be, sizeof src_data_be, 0,
1536 &src_subvalue, sizeof src_subvalue, 0,
1537 sizeof src_data_be * 8);
1538 mf_write_subfield_flow(dst, &src_subvalue, flow);
1541 /* nxm_parse_stack_action, works for both push() and pop(). */
1543 /* Parses 's' as a "push" or "pop" action, in the form described in
1544 * ovs-ofctl(8), into '*stack_action'.
1546 * Returns NULL if successful, otherwise a malloc()'d string describing the
1547 * error. The caller is responsible for freeing the returned string. */
1548 char * OVS_WARN_UNUSED_RESULT
1549 nxm_parse_stack_action(struct ofpact_stack *stack_action, const char *s)
1553 error = mf_parse_subfield__(&stack_action->subfield, &s);
1559 return xasprintf("%s: trailing garbage following push or pop", s);
1566 nxm_format_stack_push(const struct ofpact_stack *push, struct ds *s)
1568 ds_put_cstr(s, "push:");
1569 mf_format_subfield(&push->subfield, s);
1573 nxm_format_stack_pop(const struct ofpact_stack *pop, struct ds *s)
1575 ds_put_cstr(s, "pop:");
1576 mf_format_subfield(&pop->subfield, s);
1580 nxm_stack_push_check(const struct ofpact_stack *push,
1581 const struct flow *flow)
1583 return mf_check_src(&push->subfield, flow);
1587 nxm_stack_pop_check(const struct ofpact_stack *pop,
1588 const struct flow *flow)
1590 return mf_check_dst(&pop->subfield, flow);
1593 /* nxm_execute_stack_push(), nxm_execute_stack_pop(). */
1595 nx_stack_push(struct ofpbuf *stack, union mf_subvalue *v)
1597 ofpbuf_put(stack, v, sizeof *v);
1600 static union mf_subvalue *
1601 nx_stack_pop(struct ofpbuf *stack)
1603 union mf_subvalue *v = NULL;
1607 stack->size -= sizeof *v;
1608 v = (union mf_subvalue *) ofpbuf_tail(stack);
1615 nxm_execute_stack_push(const struct ofpact_stack *push,
1616 const struct flow *flow, struct flow_wildcards *wc,
1617 struct ofpbuf *stack)
1619 union mf_subvalue mask_value;
1620 union mf_subvalue dst_value;
1622 memset(&mask_value, 0xff, sizeof mask_value);
1623 mf_write_subfield_flow(&push->subfield, &mask_value, &wc->masks);
1625 mf_read_subfield(&push->subfield, flow, &dst_value);
1626 nx_stack_push(stack, &dst_value);
1630 nxm_execute_stack_pop(const struct ofpact_stack *pop,
1631 struct flow *flow, struct flow_wildcards *wc,
1632 struct ofpbuf *stack)
1634 union mf_subvalue *src_value;
1636 src_value = nx_stack_pop(stack);
1638 /* Only pop if stack is not empty. Otherwise, give warning. */
1640 union mf_subvalue mask_value;
1642 memset(&mask_value, 0xff, sizeof mask_value);
1643 mf_write_subfield_flow(&pop->subfield, &mask_value, &wc->masks);
1644 mf_write_subfield_flow(&pop->subfield, src_value, flow);
1646 if (!VLOG_DROP_WARN(&rl)) {
1647 char *flow_str = flow_to_string(flow);
1648 VLOG_WARN_RL(&rl, "Failed to pop from an empty stack. On flow\n"
1655 /* Formats 'sf' into 's' in a format normally acceptable to
1656 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
1657 * sf->field has no NXM name.) */
1659 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
1662 ds_put_cstr(s, "<unknown>");
1664 const struct nxm_field *f = nxm_field_by_mf_id(sf->field->id, 0);
1665 ds_put_cstr(s, f ? f->name : sf->field->name);
1668 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
1669 ds_put_cstr(s, "[]");
1670 } else if (sf->n_bits == 1) {
1671 ds_put_format(s, "[%d]", sf->ofs);
1673 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
1677 static const struct nxm_field *
1678 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
1680 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
1685 return nxm_field_by_name(name, name_len);
1688 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
1689 * returns NULL and advances '*sp' to the first byte following the parsed
1690 * string. On failure, returns a malloc()'d error message, does not modify
1691 * '*sp', and does not properly initialize 'sf'.
1693 * The syntax parsed from '*sp' takes the form "header[start..end]" where
1694 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
1695 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
1696 * may both be omitted (the [] are still required) to indicate an entire
1698 char * OVS_WARN_UNUSED_RESULT
1699 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
1701 const struct mf_field *field;
1702 const struct nxm_field *f;
1711 name_len = strcspn(s, "[");
1712 if (s[name_len] != '[') {
1713 return xasprintf("%s: missing [ looking for field name", *sp);
1716 f = mf_parse_subfield_name(name, name_len, &wild);
1718 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
1720 field = mf_from_id(f->id);
1723 if (ovs_scan(s, "[%d..%d]", &start, &end)) {
1724 /* Nothing to do. */
1725 } else if (ovs_scan(s, "[%d]", &start)) {
1727 } else if (!strncmp(s, "[]", 2)) {
1729 end = field->n_bits - 1;
1731 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
1732 "[<start>..<end>]", *sp);
1734 s = strchr(s, ']') + 1;
1737 return xasprintf("%s: starting bit %d is after ending bit %d",
1739 } else if (start >= field->n_bits) {
1740 return xasprintf("%s: starting bit %d is not valid because field is "
1741 "only %d bits wide", *sp, start, field->n_bits);
1742 } else if (end >= field->n_bits){
1743 return xasprintf("%s: ending bit %d is not valid because field is "
1744 "only %d bits wide", *sp, end, field->n_bits);
1749 sf->n_bits = end - start + 1;
1755 /* Parses a subfield from the entirety of 's' into 'sf'. Returns NULL if
1756 * successful, otherwise a malloc()'d string describing the error. The caller
1757 * is responsible for freeing the returned string.
1759 * The syntax parsed from 's' takes the form "header[start..end]" where
1760 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
1761 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
1762 * may both be omitted (the [] are still required) to indicate an entire
1764 char * OVS_WARN_UNUSED_RESULT
1765 mf_parse_subfield(struct mf_subfield *sf, const char *s)
1767 char *error = mf_parse_subfield__(sf, &s);
1768 if (!error && s[0]) {
1769 error = xstrdup("unexpected input following field syntax");
1774 /* Returns an bitmap in which each bit corresponds to the like-numbered field
1775 * in the OFPXMC12_OPENFLOW_BASIC OXM class, in which the bit values are taken
1776 * from the 'fields' bitmap. Only fields defined in OpenFlow 'version' are
1779 * This is useful for encoding OpenFlow 1.2 table stats messages. */
1781 oxm_bitmap_from_mf_bitmap(const struct mf_bitmap *fields,
1782 enum ofp_version version)
1784 uint64_t oxm_bitmap = 0;
1787 BITMAP_FOR_EACH_1 (i, MFF_N_IDS, fields->bm) {
1788 uint64_t oxm = mf_oxm_header(i, version);
1789 uint32_t class = nxm_class(oxm);
1790 int field = nxm_field(oxm);
1792 if (class == OFPXMC12_OPENFLOW_BASIC && field < 64) {
1793 oxm_bitmap |= UINT64_C(1) << field;
1796 return htonll(oxm_bitmap);
1799 /* Opposite conversion from oxm_bitmap_from_mf_bitmap().
1801 * This is useful for decoding OpenFlow 1.2 table stats messages. */
1803 oxm_bitmap_to_mf_bitmap(ovs_be64 oxm_bitmap, enum ofp_version version)
1805 struct mf_bitmap fields = MF_BITMAP_INITIALIZER;
1807 for (enum mf_field_id id = 0; id < MFF_N_IDS; id++) {
1808 uint64_t oxm = mf_oxm_header(id, version);
1809 if (oxm && version >= nxm_field_by_header(oxm)->version) {
1810 uint32_t class = nxm_class(oxm);
1811 int field = nxm_field(oxm);
1813 if (class == OFPXMC12_OPENFLOW_BASIC
1815 && oxm_bitmap & htonll(UINT64_C(1) << field)) {
1816 bitmap_set1(fields.bm, id);
1823 /* Returns a bitmap of fields that can be encoded in OXM and that can be
1824 * modified with a "set_field" action. */
1826 oxm_writable_fields(void)
1828 struct mf_bitmap b = MF_BITMAP_INITIALIZER;
1831 for (i = 0; i < MFF_N_IDS; i++) {
1832 if (mf_oxm_header(i, 0) && mf_from_id(i)->writable) {
1833 bitmap_set1(b.bm, i);
1839 /* Returns a bitmap of fields that can be encoded in OXM and that can be
1840 * matched in a flow table. */
1842 oxm_matchable_fields(void)
1844 struct mf_bitmap b = MF_BITMAP_INITIALIZER;
1847 for (i = 0; i < MFF_N_IDS; i++) {
1848 if (mf_oxm_header(i, 0)) {
1849 bitmap_set1(b.bm, i);
1855 /* Returns a bitmap of fields that can be encoded in OXM and that can be
1856 * matched in a flow table with an arbitrary bitmask. */
1858 oxm_maskable_fields(void)
1860 struct mf_bitmap b = MF_BITMAP_INITIALIZER;
1863 for (i = 0; i < MFF_N_IDS; i++) {
1864 if (mf_oxm_header(i, 0) && mf_from_id(i)->maskable == MFM_FULLY) {
1865 bitmap_set1(b.bm, i);
1871 struct nxm_field_index {
1872 struct hmap_node header_node; /* In nxm_header_map. */
1873 struct hmap_node name_node; /* In nxm_name_map. */
1874 struct ovs_list mf_node; /* In mf_mf_map[nf.id]. */
1875 const struct nxm_field nf;
1878 #include "nx-match.inc"
1880 static struct hmap nxm_header_map;
1881 static struct hmap nxm_name_map;
1882 static struct ovs_list nxm_mf_map[MFF_N_IDS];
1887 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
1888 if (ovsthread_once_start(&once)) {
1889 hmap_init(&nxm_header_map);
1890 hmap_init(&nxm_name_map);
1891 for (int i = 0; i < MFF_N_IDS; i++) {
1892 list_init(&nxm_mf_map[i]);
1894 for (struct nxm_field_index *nfi = all_nxm_fields;
1895 nfi < &all_nxm_fields[ARRAY_SIZE(all_nxm_fields)]; nfi++) {
1896 hmap_insert(&nxm_header_map, &nfi->header_node,
1897 hash_uint64(nxm_no_len(nfi->nf.header)));
1898 hmap_insert(&nxm_name_map, &nfi->name_node,
1899 hash_string(nfi->nf.name, 0));
1900 list_push_back(&nxm_mf_map[nfi->nf.id], &nfi->mf_node);
1902 ovsthread_once_done(&once);
1906 static const struct nxm_field *
1907 nxm_field_by_header(uint64_t header)
1909 const struct nxm_field_index *nfi;
1910 uint64_t header_no_len;
1913 if (nxm_hasmask(header)) {
1914 header = nxm_make_exact_header(header);
1917 header_no_len = nxm_no_len(header);
1919 HMAP_FOR_EACH_IN_BUCKET (nfi, header_node, hash_uint64(header_no_len),
1921 if (header_no_len == nxm_no_len(nfi->nf.header)) {
1922 if (nxm_length(header) == nxm_length(nfi->nf.header) ||
1923 mf_from_id(nfi->nf.id)->variable_len) {
1933 static const struct nxm_field *
1934 nxm_field_by_name(const char *name, size_t len)
1936 const struct nxm_field_index *nfi;
1939 HMAP_FOR_EACH_WITH_HASH (nfi, name_node, hash_bytes(name, len, 0),
1941 if (strlen(nfi->nf.name) == len && !memcmp(nfi->nf.name, name, len)) {
1948 static const struct nxm_field *
1949 nxm_field_by_mf_id(enum mf_field_id id, enum ofp_version version)
1951 const struct nxm_field_index *nfi;
1952 const struct nxm_field *f;
1957 LIST_FOR_EACH (nfi, mf_node, &nxm_mf_map[id]) {
1958 if (!f || version >= nfi->nf.version) {