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; }
102 is_experimenter_oxm(uint64_t header)
104 return nxm_class(header) == OFPXMC12_EXPERIMENTER;
107 /* The OXM header "length" field is somewhat tricky:
109 * - For a standard OXM header, the length is the number of bytes of the
110 * payload, and the payload consists of just the value (and mask, if
113 * - For an experimenter OXM header, the length is the number of bytes in
114 * the payload plus 4 (the length of the experimenter ID). That is, the
115 * experimenter ID is included in oxm_length.
117 * This function returns the length of the experimenter ID field in 'header'.
118 * That is, for an experimenter OXM (when an experimenter ID is present), it
119 * returns 4, and for a standard OXM (when no experimenter ID is present), it
122 nxm_experimenter_len(uint64_t header)
124 return is_experimenter_oxm(header) ? 4 : 0;
127 /* Returns the number of bytes that follow the header for an NXM/OXM entry
128 * with the given 'header'. */
130 nxm_payload_len(uint64_t header)
132 return nxm_length(header) - nxm_experimenter_len(header);
135 /* Returns the number of bytes in the header for an NXM/OXM entry with the
138 nxm_header_len(uint64_t header)
140 return 4 + nxm_experimenter_len(header);
143 #define NXM_HEADER(VENDOR, CLASS, FIELD, HASMASK, LENGTH) \
144 (((uint64_t) (CLASS) << 48) | \
145 ((uint64_t) (FIELD) << 41) | \
146 ((uint64_t) (HASMASK) << 40) | \
147 ((uint64_t) (LENGTH) << 32) | \
150 #define NXM_HEADER_FMT "%#"PRIx32":%d:%d:%d:%d"
151 #define NXM_HEADER_ARGS(HEADER) \
152 nxm_vendor(HEADER), nxm_class(HEADER), nxm_field(HEADER), \
153 nxm_hasmask(HEADER), nxm_length(HEADER)
155 /* Functions for turning the "hasmask" bit on or off. (This also requires
156 * adjusting the length.) */
158 nxm_make_exact_header(uint64_t header)
160 int new_len = nxm_payload_len(header) / 2 + nxm_experimenter_len(header);
161 return NXM_HEADER(nxm_vendor(header), nxm_class(header),
162 nxm_field(header), 0, new_len);
165 nxm_make_wild_header(uint64_t header)
167 int new_len = nxm_payload_len(header) * 2 + nxm_experimenter_len(header);
168 return NXM_HEADER(nxm_vendor(header), nxm_class(header),
169 nxm_field(header), 1, new_len);
174 * This may be used to gain the OpenFlow 1.1-like ability to restrict
175 * certain NXM-based Flow Mod and Flow Stats Request messages to flows
176 * with specific cookies. See the "nx_flow_mod" and "nx_flow_stats_request"
177 * structure definitions for more details. This match is otherwise not
179 #define NXM_NX_COOKIE NXM_HEADER (0, 0x0001, 30, 0, 8)
180 #define NXM_NX_COOKIE_W nxm_make_wild_header(NXM_NX_COOKIE)
184 enum ofp_version version;
185 const char *name; /* e.g. "NXM_OF_IN_PORT". */
190 static const struct nxm_field *nxm_field_by_header(uint64_t header);
191 static const struct nxm_field *nxm_field_by_name(const char *name, size_t len);
192 static const struct nxm_field *nxm_field_by_mf_id(enum mf_field_id,
195 static void nx_put_header__(struct ofpbuf *, uint64_t header, bool masked);
197 /* Rate limit for nx_match parse errors. These always indicate a bug in the
198 * peer and so there's not much point in showing a lot of them. */
199 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
201 static const struct nxm_field *
202 mf_parse_subfield_name(const char *name, int name_len, bool *wild);
204 /* Returns the preferred OXM header to use for field 'id' in OpenFlow version
205 * 'version'. Specify 0 for 'version' if an NXM legacy header should be
206 * preferred over any standardized OXM header. Returns 0 if field 'id' cannot
207 * be expressed in NXM or OXM. */
209 mf_oxm_header(enum mf_field_id id, enum ofp_version version)
211 const struct nxm_field *f = nxm_field_by_mf_id(id, version);
212 return f ? f->header : 0;
215 /* Returns the 32-bit OXM or NXM header to use for field 'id', preferring an
216 * NXM legacy header over any standardized OXM header. Returns 0 if field 'id'
217 * cannot be expressed with a 32-bit NXM or OXM header.
219 * Whenever possible, use nx_pull_header() instead of this function, because
220 * this function cannot support 64-bit experimenter OXM headers. */
222 mf_nxm_header(enum mf_field_id id)
224 uint64_t oxm = mf_oxm_header(id, 0);
225 return is_experimenter_oxm(oxm) ? 0 : oxm >> 32;
228 static const struct mf_field *
229 mf_from_oxm_header(uint64_t header)
231 const struct nxm_field *f = nxm_field_by_header(header);
232 return f ? mf_from_id(f->id) : NULL;
235 /* Returns the "struct mf_field" that corresponds to NXM or OXM header
236 * 'header', or NULL if 'header' doesn't correspond to any known field. */
237 const struct mf_field *
238 mf_from_nxm_header(uint32_t header)
240 return mf_from_oxm_header((uint64_t) header << 32);
243 /* Returns the width of the data for a field with the given 'header', in
246 nxm_field_bytes(uint64_t header)
248 unsigned int length = nxm_payload_len(header);
249 return nxm_hasmask(header) ? length / 2 : length;
252 /* nx_pull_match() and helpers. */
254 /* Given NXM/OXM value 'value' and mask 'mask' associated with 'header', checks
255 * for any 1-bit in the value where there is a 0-bit in the mask. Returns 0 if
256 * none, otherwise an error code. */
258 is_mask_consistent(uint64_t header, const uint8_t *value, const uint8_t *mask)
260 unsigned int width = nxm_field_bytes(header);
263 for (i = 0; i < width; i++) {
264 if (value[i] & ~mask[i]) {
265 if (!VLOG_DROP_WARN(&rl)) {
266 VLOG_WARN_RL(&rl, "Rejecting NXM/OXM entry "NXM_HEADER_FMT " "
267 "with 1-bits in value for bits wildcarded by the "
268 "mask.", NXM_HEADER_ARGS(header));
277 is_cookie_pseudoheader(uint64_t header)
279 return header == NXM_NX_COOKIE || header == NXM_NX_COOKIE_W;
283 nx_pull_header__(struct ofpbuf *b, bool allow_cookie, uint64_t *header,
284 const struct mf_field **field)
290 *header = ((uint64_t) ntohl(get_unaligned_be32(b->data))) << 32;
291 if (is_experimenter_oxm(*header)) {
295 *header = ntohll(get_unaligned_be64(b->data));
297 if (nxm_length(*header) <= nxm_experimenter_len(*header)) {
298 VLOG_WARN_RL(&rl, "OXM header "NXM_HEADER_FMT" has invalid length %d "
300 NXM_HEADER_ARGS(*header), nxm_length(*header),
301 nxm_header_len(*header) + 1);
304 ofpbuf_pull(b, nxm_header_len(*header));
307 *field = mf_from_oxm_header(*header);
308 if (!*field && !(allow_cookie && is_cookie_pseudoheader(*header))) {
309 VLOG_DBG_RL(&rl, "OXM header "NXM_HEADER_FMT" is unknown",
310 NXM_HEADER_ARGS(*header));
311 return OFPERR_OFPBMC_BAD_FIELD;
318 VLOG_DBG_RL(&rl, "encountered partial (%"PRIu32"-byte) OXM entry",
323 return OFPERR_OFPBMC_BAD_LEN;
327 nx_pull_entry__(struct ofpbuf *b, bool allow_cookie, uint64_t *header,
328 const struct mf_field **field,
329 union mf_value *value, union mf_value *mask)
331 enum ofperr header_error;
332 unsigned int payload_len;
333 const uint8_t *payload;
336 header_error = nx_pull_header__(b, allow_cookie, header, field);
337 if (header_error && header_error != OFPERR_OFPBMC_BAD_FIELD) {
341 payload_len = nxm_payload_len(*header);
342 payload = ofpbuf_try_pull(b, payload_len);
344 VLOG_DBG_RL(&rl, "OXM header "NXM_HEADER_FMT" calls for %u-byte "
345 "payload but only %"PRIu32" bytes follow OXM header",
346 NXM_HEADER_ARGS(*header), payload_len, b->size);
347 return OFPERR_OFPBMC_BAD_LEN;
350 width = nxm_field_bytes(*header);
351 if (nxm_hasmask(*header)
352 && !is_mask_consistent(*header, payload, payload + width)) {
353 return OFPERR_OFPBMC_BAD_WILDCARDS;
356 memcpy(value, payload, MIN(width, sizeof *value));
358 if (nxm_hasmask(*header)) {
359 memcpy(mask, payload + width, MIN(width, sizeof *mask));
361 memset(mask, 0xff, MIN(width, sizeof *mask));
363 } else if (nxm_hasmask(*header)) {
364 VLOG_DBG_RL(&rl, "OXM header "NXM_HEADER_FMT" includes mask but "
365 "masked OXMs are not allowed here",
366 NXM_HEADER_ARGS(*header));
367 return OFPERR_OFPBMC_BAD_MASK;
373 /* Attempts to pull an NXM or OXM header, value, and mask (if present) from the
374 * beginning of 'b'. If successful, stores a pointer to the "struct mf_field"
375 * corresponding to the pulled header in '*field', the value into '*value',
376 * and the mask into '*mask', and returns 0. On error, returns an OpenFlow
377 * error; in this case, some bytes might have been pulled off 'b' anyhow, and
378 * the output parameters might have been modified.
380 * If a NULL 'mask' is supplied, masked OXM or NXM entries are treated as
381 * errors (with OFPERR_OFPBMC_BAD_MASK).
384 nx_pull_entry(struct ofpbuf *b, const struct mf_field **field,
385 union mf_value *value, union mf_value *mask)
389 return nx_pull_entry__(b, false, &header, field, value, mask);
392 /* Attempts to pull an NXM or OXM header from the beginning of 'b'. If
393 * successful, stores a pointer to the "struct mf_field" corresponding to the
394 * pulled header in '*field', stores the header's hasmask bit in '*masked'
395 * (true if hasmask=1, false if hasmask=0), and returns 0. On error, returns
396 * an OpenFlow error; in this case, some bytes might have been pulled off 'b'
397 * anyhow, and the output parameters might have been modified.
399 * If NULL 'masked' is supplied, masked OXM or NXM headers are treated as
400 * errors (with OFPERR_OFPBMC_BAD_MASK).
403 nx_pull_header(struct ofpbuf *b, const struct mf_field **field, bool *masked)
408 error = nx_pull_header__(b, false, &header, field);
410 *masked = !error && nxm_hasmask(header);
411 } else if (!error && nxm_hasmask(header)) {
412 error = OFPERR_OFPBMC_BAD_MASK;
418 nx_pull_match_entry(struct ofpbuf *b, bool allow_cookie,
419 const struct mf_field **field,
420 union mf_value *value, union mf_value *mask)
425 error = nx_pull_entry__(b, allow_cookie, &header, field, value, mask);
429 if (field && *field) {
430 if (!mf_is_mask_valid(*field, mask)) {
431 VLOG_DBG_RL(&rl, "bad mask for field %s", (*field)->name);
432 return OFPERR_OFPBMC_BAD_MASK;
434 if (!mf_is_value_valid(*field, value)) {
435 VLOG_DBG_RL(&rl, "bad value for field %s", (*field)->name);
436 return OFPERR_OFPBMC_BAD_VALUE;
443 nx_pull_raw(const uint8_t *p, unsigned int match_len, bool strict,
444 struct match *match, ovs_be64 *cookie, ovs_be64 *cookie_mask)
448 ovs_assert((cookie != NULL) == (cookie_mask != NULL));
450 match_init_catchall(match);
452 *cookie = *cookie_mask = htonll(0);
455 ofpbuf_use_const(&b, p, match_len);
457 const uint8_t *pos = b.data;
458 const struct mf_field *field;
459 union mf_value value;
463 error = nx_pull_match_entry(&b, cookie != NULL, &field, &value, &mask);
465 if (error == OFPERR_OFPBMC_BAD_FIELD && !strict) {
470 error = OFPERR_OFPBMC_BAD_FIELD;
471 } else if (*cookie_mask) {
472 error = OFPERR_OFPBMC_DUP_FIELD;
474 *cookie = value.be64;
475 *cookie_mask = mask.be64;
477 } else if (!mf_are_prereqs_ok(field, &match->flow)) {
478 error = OFPERR_OFPBMC_BAD_PREREQ;
479 } else if (!mf_is_all_wild(field, &match->wc)) {
480 error = OFPERR_OFPBMC_DUP_FIELD;
482 mf_set(field, &value, &mask, match);
486 VLOG_DBG_RL(&rl, "error parsing OXM at offset %"PRIdPTR" "
487 "within match (%s)", pos -
488 p, ofperr_to_string(error));
497 nx_pull_match__(struct ofpbuf *b, unsigned int match_len, bool strict,
499 ovs_be64 *cookie, ovs_be64 *cookie_mask)
504 p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
506 VLOG_DBG_RL(&rl, "nx_match length %u, rounded up to a "
507 "multiple of 8, is longer than space in message (max "
508 "length %"PRIu32")", match_len, b->size);
509 return OFPERR_OFPBMC_BAD_LEN;
513 return nx_pull_raw(p, match_len, strict, match, cookie, cookie_mask);
516 /* Parses the nx_match formatted match description in 'b' with length
517 * 'match_len'. Stores the results in 'match'. If 'cookie' and 'cookie_mask'
518 * are valid pointers, then stores the cookie and mask in them if 'b' contains
519 * a "NXM_NX_COOKIE*" match. Otherwise, stores 0 in both.
521 * Fails with an error upon encountering an unknown NXM header.
523 * Returns 0 if successful, otherwise an OpenFlow error code. */
525 nx_pull_match(struct ofpbuf *b, unsigned int match_len, struct match *match,
526 ovs_be64 *cookie, ovs_be64 *cookie_mask)
528 return nx_pull_match__(b, match_len, true, match, cookie, cookie_mask);
531 /* Behaves the same as nx_pull_match(), but skips over unknown NXM headers,
532 * instead of failing with an error. */
534 nx_pull_match_loose(struct ofpbuf *b, unsigned int match_len,
536 ovs_be64 *cookie, ovs_be64 *cookie_mask)
538 return nx_pull_match__(b, match_len, false, match, cookie, cookie_mask);
542 oxm_pull_match__(struct ofpbuf *b, bool strict, struct match *match)
544 struct ofp11_match_header *omh = b->data;
548 if (b->size < sizeof *omh) {
549 return OFPERR_OFPBMC_BAD_LEN;
552 match_len = ntohs(omh->length);
553 if (match_len < sizeof *omh) {
554 return OFPERR_OFPBMC_BAD_LEN;
557 if (omh->type != htons(OFPMT_OXM)) {
558 return OFPERR_OFPBMC_BAD_TYPE;
561 p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
563 VLOG_DBG_RL(&rl, "oxm length %u, rounded up to a "
564 "multiple of 8, is longer than space in message (max "
565 "length %"PRIu32")", match_len, b->size);
566 return OFPERR_OFPBMC_BAD_LEN;
569 return nx_pull_raw(p + sizeof *omh, match_len - sizeof *omh,
570 strict, match, NULL, NULL);
573 /* Parses the oxm formatted match description preceded by a struct
574 * ofp11_match_header in 'b'. Stores the result in 'match'.
576 * Fails with an error when encountering unknown OXM headers.
578 * Returns 0 if successful, otherwise an OpenFlow error code. */
580 oxm_pull_match(struct ofpbuf *b, struct match *match)
582 return oxm_pull_match__(b, true, match);
585 /* Behaves the same as oxm_pull_match() with one exception. Skips over unknown
586 * OXM headers instead of failing with an error when they are encountered. */
588 oxm_pull_match_loose(struct ofpbuf *b, struct match *match)
590 return oxm_pull_match__(b, false, match);
593 /* Verify an array of OXM TLVs treating value of each TLV as a mask,
594 * disallowing masks in each TLV and ignoring pre-requisites. */
596 oxm_pull_field_array(const void *fields_data, size_t fields_len,
597 struct field_array *fa)
601 ofpbuf_use_const(&b, fields_data, fields_len);
603 const uint8_t *pos = b.data;
604 const struct mf_field *field;
605 union mf_value value;
609 error = nx_pull_entry__(&b, false, &header, &field, &value, NULL);
611 VLOG_DBG_RL(&rl, "error pulling field array field");
614 VLOG_DBG_RL(&rl, "unknown field array field");
615 error = OFPERR_OFPBMC_BAD_FIELD;
616 } else if (bitmap_is_set(fa->used.bm, field->id)) {
617 VLOG_DBG_RL(&rl, "duplicate field array field '%s'", field->name);
618 error = OFPERR_OFPBMC_DUP_FIELD;
619 } else if (!mf_is_mask_valid(field, &value)) {
620 VLOG_DBG_RL(&rl, "bad mask in field array field '%s'", field->name);
621 return OFPERR_OFPBMC_BAD_MASK;
623 field_array_set(field->id, &value, fa);
627 const uint8_t *start = fields_data;
629 VLOG_DBG_RL(&rl, "error parsing OXM at offset %"PRIdPTR" "
630 "within field array (%s)", pos - start,
631 ofperr_to_string(error));
639 /* nx_put_match() and helpers.
641 * 'put' functions whose names end in 'w' add a wildcarded field.
642 * 'put' functions whose names end in 'm' add a field that might be wildcarded.
643 * Other 'put' functions add exact-match fields.
647 nxm_put_unmasked(struct ofpbuf *b, enum mf_field_id field,
648 enum ofp_version version, const void *value, size_t n_bytes)
650 nx_put_header(b, field, version, false);
651 ofpbuf_put(b, value, n_bytes);
655 nxm_put(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
656 const void *value, const void *mask, size_t n_bytes)
658 if (!is_all_zeros(mask, n_bytes)) {
659 bool masked = !is_all_ones(mask, n_bytes);
660 nx_put_header(b, field, version, masked);
661 ofpbuf_put(b, value, n_bytes);
663 ofpbuf_put(b, mask, n_bytes);
669 nxm_put_8m(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
670 uint8_t value, uint8_t mask)
672 nxm_put(b, field, version, &value, &mask, sizeof value);
676 nxm_put_8(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
679 nxm_put_unmasked(b, field, version, &value, sizeof value);
683 nxm_put_16m(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
684 ovs_be16 value, ovs_be16 mask)
686 nxm_put(b, field, version, &value, &mask, sizeof value);
690 nxm_put_16(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
693 nxm_put_unmasked(b, field, version, &value, sizeof value);
697 nxm_put_32m(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
698 ovs_be32 value, ovs_be32 mask)
700 nxm_put(b, field, version, &value, &mask, sizeof value);
704 nxm_put_32(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
707 nxm_put_unmasked(b, field, version, &value, sizeof value);
711 nxm_put_64m(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
712 ovs_be64 value, ovs_be64 mask)
714 nxm_put(b, field, version, &value, &mask, sizeof value);
718 nxm_put_eth_masked(struct ofpbuf *b,
719 enum mf_field_id field, enum ofp_version version,
720 const uint8_t value[ETH_ADDR_LEN],
721 const uint8_t mask[ETH_ADDR_LEN])
723 nxm_put(b, field, version, value, mask, ETH_ADDR_LEN);
727 nxm_put_ipv6(struct ofpbuf *b,
728 enum mf_field_id field, enum ofp_version version,
729 const struct in6_addr *value, const struct in6_addr *mask)
731 nxm_put(b, field, version, value->s6_addr, mask->s6_addr,
732 sizeof value->s6_addr);
736 nxm_put_frag(struct ofpbuf *b, const struct match *match,
737 enum ofp_version version)
739 uint8_t nw_frag = match->flow.nw_frag & FLOW_NW_FRAG_MASK;
740 uint8_t nw_frag_mask = match->wc.masks.nw_frag & FLOW_NW_FRAG_MASK;
742 nxm_put_8m(b, MFF_IP_FRAG, version, nw_frag,
743 nw_frag_mask == FLOW_NW_FRAG_MASK ? UINT8_MAX : nw_frag_mask);
746 /* Appends to 'b' a set of OXM or NXM matches for the IPv4 or IPv6 fields in
749 nxm_put_ip(struct ofpbuf *b, const struct match *match, enum ofp_version oxm)
751 const struct flow *flow = &match->flow;
753 if (flow->dl_type == htons(ETH_TYPE_IP)) {
754 nxm_put_32m(b, MFF_IPV4_SRC, oxm,
755 flow->nw_src, match->wc.masks.nw_src);
756 nxm_put_32m(b, MFF_IPV4_DST, oxm,
757 flow->nw_dst, match->wc.masks.nw_dst);
759 nxm_put_ipv6(b, MFF_IPV6_SRC, oxm,
760 &flow->ipv6_src, &match->wc.masks.ipv6_src);
761 nxm_put_ipv6(b, MFF_IPV6_DST, oxm,
762 &flow->ipv6_dst, &match->wc.masks.ipv6_dst);
765 nxm_put_frag(b, match, oxm);
767 if (match->wc.masks.nw_tos & IP_DSCP_MASK) {
769 nxm_put_8(b, MFF_IP_DSCP_SHIFTED, oxm,
772 nxm_put_8(b, MFF_IP_DSCP, oxm,
773 flow->nw_tos & IP_DSCP_MASK);
777 if (match->wc.masks.nw_tos & IP_ECN_MASK) {
778 nxm_put_8(b, MFF_IP_ECN, oxm,
779 flow->nw_tos & IP_ECN_MASK);
782 if (!oxm && match->wc.masks.nw_ttl) {
783 nxm_put_8(b, MFF_IP_TTL, oxm, flow->nw_ttl);
786 nxm_put_32m(b, MFF_IPV6_LABEL, oxm,
787 flow->ipv6_label, match->wc.masks.ipv6_label);
789 if (match->wc.masks.nw_proto) {
790 nxm_put_8(b, MFF_IP_PROTO, oxm, flow->nw_proto);
792 if (flow->nw_proto == IPPROTO_TCP) {
793 nxm_put_16m(b, MFF_TCP_SRC, oxm,
794 flow->tp_src, match->wc.masks.tp_src);
795 nxm_put_16m(b, MFF_TCP_DST, oxm,
796 flow->tp_dst, match->wc.masks.tp_dst);
797 nxm_put_16m(b, MFF_TCP_FLAGS, oxm,
798 flow->tcp_flags, match->wc.masks.tcp_flags);
799 } else if (flow->nw_proto == IPPROTO_UDP) {
800 nxm_put_16m(b, MFF_UDP_SRC, oxm,
801 flow->tp_src, match->wc.masks.tp_src);
802 nxm_put_16m(b, MFF_UDP_DST, oxm,
803 flow->tp_dst, match->wc.masks.tp_dst);
804 } else if (flow->nw_proto == IPPROTO_SCTP) {
805 nxm_put_16m(b, MFF_SCTP_SRC, oxm, flow->tp_src,
806 match->wc.masks.tp_src);
807 nxm_put_16m(b, MFF_SCTP_DST, oxm, flow->tp_dst,
808 match->wc.masks.tp_dst);
809 } else if (is_icmpv4(flow)) {
810 if (match->wc.masks.tp_src) {
811 nxm_put_8(b, MFF_ICMPV4_TYPE, oxm,
812 ntohs(flow->tp_src));
814 if (match->wc.masks.tp_dst) {
815 nxm_put_8(b, MFF_ICMPV4_CODE, oxm,
816 ntohs(flow->tp_dst));
818 } else if (is_icmpv6(flow)) {
819 if (match->wc.masks.tp_src) {
820 nxm_put_8(b, MFF_ICMPV6_TYPE, oxm,
821 ntohs(flow->tp_src));
823 if (match->wc.masks.tp_dst) {
824 nxm_put_8(b, MFF_ICMPV6_CODE, oxm,
825 ntohs(flow->tp_dst));
827 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
828 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
829 nxm_put_ipv6(b, MFF_ND_TARGET, oxm,
830 &flow->nd_target, &match->wc.masks.nd_target);
831 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
832 nxm_put_eth_masked(b, MFF_ND_SLL, oxm,
833 flow->arp_sha, match->wc.masks.arp_sha);
835 if (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
836 nxm_put_eth_masked(b, MFF_ND_TLL, oxm,
837 flow->arp_tha, match->wc.masks.arp_tha);
844 /* Appends to 'b' the nx_match format that expresses 'match'. For Flow Mod and
845 * Flow Stats Requests messages, a 'cookie' and 'cookie_mask' may be supplied.
846 * Otherwise, 'cookie_mask' should be zero.
848 * Specify 'oxm' as 0 to express the match in NXM format; otherwise, specify
849 * 'oxm' as the OpenFlow version number for the OXM format to use.
851 * This function can cause 'b''s data to be reallocated.
853 * Returns the number of bytes appended to 'b', excluding padding.
855 * If 'match' is a catch-all rule that matches every packet, then this function
856 * appends nothing to 'b' and returns 0. */
858 nx_put_raw(struct ofpbuf *b, enum ofp_version oxm, const struct match *match,
859 ovs_be64 cookie, ovs_be64 cookie_mask)
861 const struct flow *flow = &match->flow;
862 const size_t start_len = b->size;
866 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 31);
869 if (match->wc.masks.dp_hash) {
870 nxm_put_32m(b, MFF_DP_HASH, oxm,
871 htonl(flow->dp_hash), htonl(match->wc.masks.dp_hash));
874 if (match->wc.masks.recirc_id) {
875 nxm_put_32(b, MFF_RECIRC_ID, oxm, htonl(flow->recirc_id));
878 if (match->wc.masks.conj_id) {
879 nxm_put_32(b, MFF_CONJ_ID, oxm, htonl(flow->conj_id));
882 if (match->wc.masks.in_port.ofp_port) {
883 ofp_port_t in_port = flow->in_port.ofp_port;
885 nxm_put_32(b, MFF_IN_PORT_OXM, oxm,
886 ofputil_port_to_ofp11(in_port));
888 nxm_put_16(b, MFF_IN_PORT, oxm,
889 htons(ofp_to_u16(in_port)));
892 if (match->wc.masks.actset_output) {
893 nxm_put_32(b, MFF_ACTSET_OUTPUT, oxm,
894 ofputil_port_to_ofp11(flow->actset_output));
898 nxm_put_eth_masked(b, MFF_ETH_SRC, oxm,
899 flow->dl_src, match->wc.masks.dl_src);
900 nxm_put_eth_masked(b, MFF_ETH_DST, oxm,
901 flow->dl_dst, match->wc.masks.dl_dst);
902 nxm_put_16m(b, MFF_ETH_TYPE, oxm,
903 ofputil_dl_type_to_openflow(flow->dl_type),
904 match->wc.masks.dl_type);
908 ovs_be16 VID_CFI_MASK = htons(VLAN_VID_MASK | VLAN_CFI);
909 ovs_be16 vid = flow->vlan_tci & VID_CFI_MASK;
910 ovs_be16 mask = match->wc.masks.vlan_tci & VID_CFI_MASK;
912 if (mask == htons(VLAN_VID_MASK | VLAN_CFI)) {
913 nxm_put_16(b, MFF_VLAN_VID, oxm, vid);
915 nxm_put_16m(b, MFF_VLAN_VID, oxm, vid, mask);
918 if (vid && vlan_tci_to_pcp(match->wc.masks.vlan_tci)) {
919 nxm_put_8(b, MFF_VLAN_PCP, oxm,
920 vlan_tci_to_pcp(flow->vlan_tci));
924 nxm_put_16m(b, MFF_VLAN_TCI, oxm, flow->vlan_tci,
925 match->wc.masks.vlan_tci);
929 if (eth_type_mpls(flow->dl_type)) {
930 if (match->wc.masks.mpls_lse[0] & htonl(MPLS_TC_MASK)) {
931 nxm_put_8(b, MFF_MPLS_TC, oxm,
932 mpls_lse_to_tc(flow->mpls_lse[0]));
935 if (match->wc.masks.mpls_lse[0] & htonl(MPLS_BOS_MASK)) {
936 nxm_put_8(b, MFF_MPLS_BOS, oxm,
937 mpls_lse_to_bos(flow->mpls_lse[0]));
940 if (match->wc.masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK)) {
941 nxm_put_32(b, MFF_MPLS_LABEL, oxm,
942 htonl(mpls_lse_to_label(flow->mpls_lse[0])));
947 if (is_ip_any(flow)) {
948 nxm_put_ip(b, match, oxm);
949 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
950 flow->dl_type == htons(ETH_TYPE_RARP)) {
952 if (match->wc.masks.nw_proto) {
953 nxm_put_16(b, MFF_ARP_OP, oxm,
954 htons(flow->nw_proto));
956 nxm_put_32m(b, MFF_ARP_SPA, oxm,
957 flow->nw_src, match->wc.masks.nw_src);
958 nxm_put_32m(b, MFF_ARP_TPA, oxm,
959 flow->nw_dst, match->wc.masks.nw_dst);
960 nxm_put_eth_masked(b, MFF_ARP_SHA, oxm,
961 flow->arp_sha, match->wc.masks.arp_sha);
962 nxm_put_eth_masked(b, MFF_ARP_THA, oxm,
963 flow->arp_tha, match->wc.masks.arp_tha);
967 nxm_put_64m(b, MFF_TUN_ID, oxm,
968 flow->tunnel.tun_id, match->wc.masks.tunnel.tun_id);
970 /* Other tunnel metadata. */
971 nxm_put_32m(b, MFF_TUN_SRC, oxm,
972 flow->tunnel.ip_src, match->wc.masks.tunnel.ip_src);
973 nxm_put_32m(b, MFF_TUN_DST, oxm,
974 flow->tunnel.ip_dst, match->wc.masks.tunnel.ip_dst);
975 nxm_put_16m(b, MFF_TUN_GBP_ID, oxm,
976 flow->tunnel.gbp_id, match->wc.masks.tunnel.gbp_id);
977 nxm_put_8m(b, MFF_TUN_GBP_FLAGS, oxm,
978 flow->tunnel.gbp_flags, match->wc.masks.tunnel.gbp_flags);
981 if (oxm < OFP15_VERSION) {
982 for (i = 0; i < FLOW_N_REGS; i++) {
983 nxm_put_32m(b, MFF_REG0 + i, oxm,
984 htonl(flow->regs[i]), htonl(match->wc.masks.regs[i]));
987 for (i = 0; i < FLOW_N_XREGS; i++) {
988 nxm_put_64m(b, MFF_XREG0 + i, oxm,
989 htonll(flow_get_xreg(flow, i)),
990 htonll(flow_get_xreg(&match->wc.masks, i)));
995 nxm_put_32m(b, MFF_PKT_MARK, oxm, htonl(flow->pkt_mark),
996 htonl(match->wc.masks.pkt_mark));
998 /* OpenFlow 1.1+ Metadata. */
999 nxm_put_64m(b, MFF_METADATA, oxm,
1000 flow->metadata, match->wc.masks.metadata);
1004 bool masked = cookie_mask != OVS_BE64_MAX;
1006 cookie &= cookie_mask;
1007 nx_put_header__(b, NXM_NX_COOKIE, masked);
1008 ofpbuf_put(b, &cookie, sizeof cookie);
1010 ofpbuf_put(b, &cookie_mask, sizeof cookie_mask);
1014 match_len = b->size - start_len;
1018 /* Appends to 'b' the nx_match format that expresses 'match', plus enough zero
1019 * bytes to pad the nx_match out to a multiple of 8. For Flow Mod and Flow
1020 * Stats Requests messages, a 'cookie' and 'cookie_mask' may be supplied.
1021 * Otherwise, 'cookie_mask' should be zero.
1023 * This function can cause 'b''s data to be reallocated.
1025 * Returns the number of bytes appended to 'b', excluding padding. The return
1026 * value can be zero if it appended nothing at all to 'b' (which happens if
1027 * 'cr' is a catch-all rule that matches every packet). */
1029 nx_put_match(struct ofpbuf *b, const struct match *match,
1030 ovs_be64 cookie, ovs_be64 cookie_mask)
1032 int match_len = nx_put_raw(b, 0, match, cookie, cookie_mask);
1034 ofpbuf_put_zeros(b, PAD_SIZE(match_len, 8));
1038 /* Appends to 'b' an struct ofp11_match_header followed by the OXM format that
1039 * expresses 'cr', plus enough zero bytes to pad the data appended out to a
1042 * OXM differs slightly among versions of OpenFlow. Specify the OpenFlow
1043 * version in use as 'version'.
1045 * This function can cause 'b''s data to be reallocated.
1047 * Returns the number of bytes appended to 'b', excluding the padding. Never
1050 oxm_put_match(struct ofpbuf *b, const struct match *match,
1051 enum ofp_version version)
1054 struct ofp11_match_header *omh;
1055 size_t start_len = b->size;
1056 ovs_be64 cookie = htonll(0), cookie_mask = htonll(0);
1058 ofpbuf_put_uninit(b, sizeof *omh);
1059 match_len = (nx_put_raw(b, version, match, cookie, cookie_mask)
1061 ofpbuf_put_zeros(b, PAD_SIZE(match_len, 8));
1063 omh = ofpbuf_at(b, start_len, sizeof *omh);
1064 omh->type = htons(OFPMT_OXM);
1065 omh->length = htons(match_len);
1070 /* Appends to 'b' the nx_match format that expresses the tlv corresponding
1071 * to 'id'. If mask is not all-ones then it is also formated as the value
1074 nx_format_mask_tlv(struct ds *ds, enum mf_field_id id,
1075 const union mf_value *mask)
1077 const struct mf_field *mf = mf_from_id(id);
1079 ds_put_format(ds, "%s", mf->name);
1081 if (!is_all_ones(mask, mf->n_bytes)) {
1082 ds_put_char(ds, '=');
1083 mf_format(mf, mask, NULL, ds);
1086 ds_put_char(ds, ',');
1089 /* Appends a string representation of 'fa_' to 'ds'.
1090 * The TLVS value of 'fa_' is treated as a mask and
1091 * only the name of fields is formated if it is all ones. */
1093 oxm_format_field_array(struct ds *ds, const struct field_array *fa)
1095 size_t start_len = ds->length;
1098 for (i = 0; i < MFF_N_IDS; i++) {
1099 if (bitmap_is_set(fa->used.bm, i)) {
1100 nx_format_mask_tlv(ds, i, &fa->value[i]);
1104 if (ds->length > start_len) {
1109 /* Appends to 'b' a series of OXM TLVs corresponding to the series
1110 * of enum mf_field_id and value tuples in 'fa_'.
1112 * OXM differs slightly among versions of OpenFlow. Specify the OpenFlow
1113 * version in use as 'version'.
1115 * This function can cause 'b''s data to be reallocated.
1117 * Returns the number of bytes appended to 'b'. May return zero. */
1119 oxm_put_field_array(struct ofpbuf *b, const struct field_array *fa,
1120 enum ofp_version version)
1122 size_t start_len = b->size;
1125 /* Field arrays are only used with the group selection method
1126 * property and group properties are only available in OpenFlow * 1.5+.
1127 * So the following assertion should never fail.
1129 * If support for older OpenFlow versions is desired then some care
1130 * will need to be taken of different TLVs that handle the same
1131 * flow fields. In particular:
1132 * - VLAN_TCI, VLAN_VID and MFF_VLAN_PCP
1133 * - IP_DSCP_MASK and DSCP_SHIFTED
1136 ovs_assert(version >= OFP15_VERSION);
1138 for (i = 0; i < MFF_N_IDS; i++) {
1139 if (bitmap_is_set(fa->used.bm, i)) {
1140 nxm_put_unmasked(b, i, version, &fa->value[i],
1141 mf_from_id(i)->n_bytes);
1145 return b->size - start_len;
1149 nx_put_header__(struct ofpbuf *b, uint64_t header, bool masked)
1151 uint64_t masked_header = masked ? nxm_make_wild_header(header) : header;
1152 ovs_be64 network_header = htonll(masked_header);
1154 ofpbuf_put(b, &network_header, nxm_header_len(header));
1158 nx_put_header(struct ofpbuf *b, enum mf_field_id field,
1159 enum ofp_version version, bool masked)
1161 nx_put_header__(b, mf_oxm_header(field, version), masked);
1165 nx_put_entry(struct ofpbuf *b,
1166 enum mf_field_id field, enum ofp_version version,
1167 const union mf_value *value, const union mf_value *mask)
1169 int n_bytes = mf_from_id(field)->n_bytes;
1170 bool masked = mask && !is_all_ones(mask, n_bytes);
1172 nx_put_header(b, field, version, masked);
1173 ofpbuf_put(b, value, n_bytes);
1175 ofpbuf_put(b, mask, n_bytes);
1179 /* nx_match_to_string() and helpers. */
1181 static void format_nxm_field_name(struct ds *, uint64_t header);
1184 nx_match_to_string(const uint8_t *p, unsigned int match_len)
1190 return xstrdup("<any>");
1193 ofpbuf_use_const(&b, p, match_len);
1196 union mf_value value;
1197 union mf_value mask;
1202 error = nx_pull_entry__(&b, true, &header, NULL, &value, &mask);
1206 value_len = MIN(sizeof value, nxm_field_bytes(header));
1209 ds_put_cstr(&s, ", ");
1212 format_nxm_field_name(&s, header);
1213 ds_put_char(&s, '(');
1215 for (int i = 0; i < value_len; i++) {
1216 ds_put_format(&s, "%02x", ((const uint8_t *) &value)[i]);
1218 if (nxm_hasmask(header)) {
1219 ds_put_char(&s, '/');
1220 for (int i = 0; i < value_len; i++) {
1221 ds_put_format(&s, "%02x", ((const uint8_t *) &mask)[i]);
1224 ds_put_char(&s, ')');
1229 ds_put_cstr(&s, ", ");
1232 ds_put_format(&s, "<%u invalid bytes>", b.size);
1235 return ds_steal_cstr(&s);
1239 oxm_match_to_string(const struct ofpbuf *p, unsigned int match_len)
1241 const struct ofp11_match_header *omh = p->data;
1242 uint16_t match_len_;
1247 if (match_len < sizeof *omh) {
1248 ds_put_format(&s, "<match too short: %u>", match_len);
1252 if (omh->type != htons(OFPMT_OXM)) {
1253 ds_put_format(&s, "<bad match type field: %u>", ntohs(omh->type));
1257 match_len_ = ntohs(omh->length);
1258 if (match_len_ < sizeof *omh) {
1259 ds_put_format(&s, "<match length field too short: %u>", match_len_);
1263 if (match_len_ != match_len) {
1264 ds_put_format(&s, "<match length field incorrect: %u != %u>",
1265 match_len_, match_len);
1269 return nx_match_to_string(ofpbuf_at(p, sizeof *omh, 0),
1270 match_len - sizeof *omh);
1273 return ds_steal_cstr(&s);
1277 nx_format_field_name(enum mf_field_id id, enum ofp_version version,
1280 format_nxm_field_name(s, mf_oxm_header(id, version));
1284 format_nxm_field_name(struct ds *s, uint64_t header)
1286 const struct nxm_field *f = nxm_field_by_header(header);
1288 ds_put_cstr(s, f->name);
1289 if (nxm_hasmask(header)) {
1290 ds_put_cstr(s, "_W");
1292 } else if (header == NXM_NX_COOKIE) {
1293 ds_put_cstr(s, "NXM_NX_COOKIE");
1294 } else if (header == NXM_NX_COOKIE_W) {
1295 ds_put_cstr(s, "NXM_NX_COOKIE_W");
1297 ds_put_format(s, "%d:%d", nxm_class(header), nxm_field(header));
1302 streq_len(const char *a, size_t a_len, const char *b)
1304 return strlen(b) == a_len && !memcmp(a, b, a_len);
1308 parse_nxm_field_name(const char *name, int name_len)
1310 const struct nxm_field *f;
1313 f = mf_parse_subfield_name(name, name_len, &wild);
1317 } else if (mf_from_id(f->id)->maskable != MFM_NONE) {
1318 return nxm_make_wild_header(f->header);
1322 if (streq_len(name, name_len, "NXM_NX_COOKIE")) {
1323 return NXM_NX_COOKIE;
1324 } else if (streq_len(name, name_len, "NXM_NX_COOKIE_W")) {
1325 return NXM_NX_COOKIE_W;
1328 /* Check whether it's a field header value as hex.
1329 * (This isn't ordinarily useful except for testing error behavior.) */
1330 if (name_len == 8) {
1334 header = hexits_value(name, name_len, &ok) << 32;
1338 } else if (name_len == 16) {
1342 header = hexits_value(name, name_len, &ok);
1343 if (ok && is_experimenter_oxm(header)) {
1351 /* nx_match_from_string(). */
1354 nx_match_from_string_raw(const char *s, struct ofpbuf *b)
1356 const char *full_s = s;
1357 const size_t start_len = b->size;
1359 if (!strcmp(s, "<any>")) {
1360 /* Ensure that 'b->data' isn't actually null. */
1361 ofpbuf_prealloc_tailroom(b, 1);
1365 for (s += strspn(s, ", "); *s; s += strspn(s, ", ")) {
1372 name_len = strcspn(s, "(");
1373 if (s[name_len] != '(') {
1374 ovs_fatal(0, "%s: missing ( at end of nx_match", full_s);
1377 header = parse_nxm_field_name(name, name_len);
1379 ovs_fatal(0, "%s: unknown field `%.*s'", full_s, name_len, s);
1384 nx_put_header__(b, header, false);
1385 s = ofpbuf_put_hex(b, s, &n);
1386 if (n != nxm_field_bytes(header)) {
1387 ovs_fatal(0, "%.2s: hex digits expected", s);
1389 if (nxm_hasmask(header)) {
1390 s += strspn(s, " ");
1392 ovs_fatal(0, "%s: missing / in masked field %.*s",
1393 full_s, name_len, name);
1395 s = ofpbuf_put_hex(b, s + 1, &n);
1396 if (n != nxm_field_bytes(header)) {
1397 ovs_fatal(0, "%.2s: hex digits expected", s);
1401 s += strspn(s, " ");
1403 ovs_fatal(0, "%s: missing ) following field %.*s",
1404 full_s, name_len, name);
1409 return b->size - start_len;
1413 nx_match_from_string(const char *s, struct ofpbuf *b)
1415 int match_len = nx_match_from_string_raw(s, b);
1416 ofpbuf_put_zeros(b, PAD_SIZE(match_len, 8));
1421 oxm_match_from_string(const char *s, struct ofpbuf *b)
1424 struct ofp11_match_header *omh;
1425 size_t start_len = b->size;
1427 ofpbuf_put_uninit(b, sizeof *omh);
1428 match_len = nx_match_from_string_raw(s, b) + sizeof *omh;
1429 ofpbuf_put_zeros(b, PAD_SIZE(match_len, 8));
1431 omh = ofpbuf_at(b, start_len, sizeof *omh);
1432 omh->type = htons(OFPMT_OXM);
1433 omh->length = htons(match_len);
1438 /* Parses 's' as a "move" action, in the form described in ovs-ofctl(8), into
1441 * Returns NULL if successful, otherwise a malloc()'d string describing the
1442 * error. The caller is responsible for freeing the returned string. */
1443 char * OVS_WARN_UNUSED_RESULT
1444 nxm_parse_reg_move(struct ofpact_reg_move *move, const char *s)
1446 const char *full_s = s;
1449 error = mf_parse_subfield__(&move->src, &s);
1453 if (strncmp(s, "->", 2)) {
1454 return xasprintf("%s: missing `->' following source", full_s);
1457 error = mf_parse_subfield(&move->dst, s);
1462 if (move->src.n_bits != move->dst.n_bits) {
1463 return xasprintf("%s: source field is %d bits wide but destination is "
1464 "%d bits wide", full_s,
1465 move->src.n_bits, move->dst.n_bits);
1470 /* nxm_format_reg_move(). */
1473 nxm_format_reg_move(const struct ofpact_reg_move *move, struct ds *s)
1475 ds_put_format(s, "move:");
1476 mf_format_subfield(&move->src, s);
1477 ds_put_cstr(s, "->");
1478 mf_format_subfield(&move->dst, s);
1483 nxm_reg_move_check(const struct ofpact_reg_move *move, const struct flow *flow)
1487 error = mf_check_src(&move->src, flow);
1492 return mf_check_dst(&move->dst, flow);
1495 /* nxm_execute_reg_move(). */
1498 nxm_execute_reg_move(const struct ofpact_reg_move *move,
1499 struct flow *flow, struct flow_wildcards *wc)
1501 union mf_value src_value;
1502 union mf_value dst_value;
1504 mf_mask_field_and_prereqs(move->dst.field, &wc->masks);
1505 mf_mask_field_and_prereqs(move->src.field, &wc->masks);
1507 /* A flow may wildcard nw_frag. Do nothing if setting a transport
1508 * header field on a packet that does not have them. */
1509 if (mf_are_prereqs_ok(move->dst.field, flow)
1510 && mf_are_prereqs_ok(move->src.field, flow)) {
1512 mf_get_value(move->dst.field, flow, &dst_value);
1513 mf_get_value(move->src.field, flow, &src_value);
1514 bitwise_copy(&src_value, move->src.field->n_bytes, move->src.ofs,
1515 &dst_value, move->dst.field->n_bytes, move->dst.ofs,
1517 mf_set_flow_value(move->dst.field, &dst_value, flow);
1522 nxm_reg_load(const struct mf_subfield *dst, uint64_t src_data,
1523 struct flow *flow, struct flow_wildcards *wc)
1525 union mf_subvalue src_subvalue;
1526 union mf_subvalue mask_value;
1527 ovs_be64 src_data_be = htonll(src_data);
1529 memset(&mask_value, 0xff, sizeof mask_value);
1530 mf_write_subfield_flow(dst, &mask_value, &wc->masks);
1532 bitwise_copy(&src_data_be, sizeof src_data_be, 0,
1533 &src_subvalue, sizeof src_subvalue, 0,
1534 sizeof src_data_be * 8);
1535 mf_write_subfield_flow(dst, &src_subvalue, flow);
1538 /* nxm_parse_stack_action, works for both push() and pop(). */
1540 /* Parses 's' as a "push" or "pop" action, in the form described in
1541 * ovs-ofctl(8), into '*stack_action'.
1543 * Returns NULL if successful, otherwise a malloc()'d string describing the
1544 * error. The caller is responsible for freeing the returned string. */
1545 char * OVS_WARN_UNUSED_RESULT
1546 nxm_parse_stack_action(struct ofpact_stack *stack_action, const char *s)
1550 error = mf_parse_subfield__(&stack_action->subfield, &s);
1556 return xasprintf("%s: trailing garbage following push or pop", s);
1563 nxm_format_stack_push(const struct ofpact_stack *push, struct ds *s)
1565 ds_put_cstr(s, "push:");
1566 mf_format_subfield(&push->subfield, s);
1570 nxm_format_stack_pop(const struct ofpact_stack *pop, struct ds *s)
1572 ds_put_cstr(s, "pop:");
1573 mf_format_subfield(&pop->subfield, s);
1577 nxm_stack_push_check(const struct ofpact_stack *push,
1578 const struct flow *flow)
1580 return mf_check_src(&push->subfield, flow);
1584 nxm_stack_pop_check(const struct ofpact_stack *pop,
1585 const struct flow *flow)
1587 return mf_check_dst(&pop->subfield, flow);
1590 /* nxm_execute_stack_push(), nxm_execute_stack_pop(). */
1592 nx_stack_push(struct ofpbuf *stack, union mf_subvalue *v)
1594 ofpbuf_put(stack, v, sizeof *v);
1597 static union mf_subvalue *
1598 nx_stack_pop(struct ofpbuf *stack)
1600 union mf_subvalue *v = NULL;
1604 stack->size -= sizeof *v;
1605 v = (union mf_subvalue *) ofpbuf_tail(stack);
1612 nxm_execute_stack_push(const struct ofpact_stack *push,
1613 const struct flow *flow, struct flow_wildcards *wc,
1614 struct ofpbuf *stack)
1616 union mf_subvalue mask_value;
1617 union mf_subvalue dst_value;
1619 memset(&mask_value, 0xff, sizeof mask_value);
1620 mf_write_subfield_flow(&push->subfield, &mask_value, &wc->masks);
1622 mf_read_subfield(&push->subfield, flow, &dst_value);
1623 nx_stack_push(stack, &dst_value);
1627 nxm_execute_stack_pop(const struct ofpact_stack *pop,
1628 struct flow *flow, struct flow_wildcards *wc,
1629 struct ofpbuf *stack)
1631 union mf_subvalue *src_value;
1633 src_value = nx_stack_pop(stack);
1635 /* Only pop if stack is not empty. Otherwise, give warning. */
1637 union mf_subvalue mask_value;
1639 memset(&mask_value, 0xff, sizeof mask_value);
1640 mf_write_subfield_flow(&pop->subfield, &mask_value, &wc->masks);
1641 mf_write_subfield_flow(&pop->subfield, src_value, flow);
1643 if (!VLOG_DROP_WARN(&rl)) {
1644 char *flow_str = flow_to_string(flow);
1645 VLOG_WARN_RL(&rl, "Failed to pop from an empty stack. On flow\n"
1652 /* Formats 'sf' into 's' in a format normally acceptable to
1653 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
1654 * sf->field has no NXM name.) */
1656 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
1659 ds_put_cstr(s, "<unknown>");
1661 const struct nxm_field *f = nxm_field_by_mf_id(sf->field->id, 0);
1662 ds_put_cstr(s, f ? f->name : sf->field->name);
1665 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
1666 ds_put_cstr(s, "[]");
1667 } else if (sf->n_bits == 1) {
1668 ds_put_format(s, "[%d]", sf->ofs);
1670 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
1674 static const struct nxm_field *
1675 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
1677 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
1682 return nxm_field_by_name(name, name_len);
1685 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
1686 * returns NULL and advances '*sp' to the first byte following the parsed
1687 * string. On failure, returns a malloc()'d error message, does not modify
1688 * '*sp', and does not properly initialize 'sf'.
1690 * The syntax parsed from '*sp' takes the form "header[start..end]" where
1691 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
1692 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
1693 * may both be omitted (the [] are still required) to indicate an entire
1695 char * OVS_WARN_UNUSED_RESULT
1696 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
1698 const struct mf_field *field;
1699 const struct nxm_field *f;
1708 name_len = strcspn(s, "[");
1709 if (s[name_len] != '[') {
1710 return xasprintf("%s: missing [ looking for field name", *sp);
1713 f = mf_parse_subfield_name(name, name_len, &wild);
1715 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
1717 field = mf_from_id(f->id);
1720 if (ovs_scan(s, "[%d..%d]", &start, &end)) {
1721 /* Nothing to do. */
1722 } else if (ovs_scan(s, "[%d]", &start)) {
1724 } else if (!strncmp(s, "[]", 2)) {
1726 end = field->n_bits - 1;
1728 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
1729 "[<start>..<end>]", *sp);
1731 s = strchr(s, ']') + 1;
1734 return xasprintf("%s: starting bit %d is after ending bit %d",
1736 } else if (start >= field->n_bits) {
1737 return xasprintf("%s: starting bit %d is not valid because field is "
1738 "only %d bits wide", *sp, start, field->n_bits);
1739 } else if (end >= field->n_bits){
1740 return xasprintf("%s: ending bit %d is not valid because field is "
1741 "only %d bits wide", *sp, end, field->n_bits);
1746 sf->n_bits = end - start + 1;
1752 /* Parses a subfield from the entirety of 's' into 'sf'. Returns NULL if
1753 * successful, otherwise a malloc()'d string describing the error. The caller
1754 * is responsible for freeing the returned string.
1756 * The syntax parsed from 's' takes the form "header[start..end]" where
1757 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
1758 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
1759 * may both be omitted (the [] are still required) to indicate an entire
1761 char * OVS_WARN_UNUSED_RESULT
1762 mf_parse_subfield(struct mf_subfield *sf, const char *s)
1764 char *error = mf_parse_subfield__(sf, &s);
1765 if (!error && s[0]) {
1766 error = xstrdup("unexpected input following field syntax");
1771 /* Returns an bitmap in which each bit corresponds to the like-numbered field
1772 * in the OFPXMC12_OPENFLOW_BASIC OXM class, in which the bit values are taken
1773 * from the 'fields' bitmap. Only fields defined in OpenFlow 'version' are
1776 * This is useful for encoding OpenFlow 1.2 table stats messages. */
1778 oxm_bitmap_from_mf_bitmap(const struct mf_bitmap *fields,
1779 enum ofp_version version)
1781 uint64_t oxm_bitmap = 0;
1784 BITMAP_FOR_EACH_1 (i, MFF_N_IDS, fields->bm) {
1785 uint64_t oxm = mf_oxm_header(i, version);
1786 uint32_t class = nxm_class(oxm);
1787 int field = nxm_field(oxm);
1789 if (class == OFPXMC12_OPENFLOW_BASIC && field < 64) {
1790 oxm_bitmap |= UINT64_C(1) << field;
1793 return htonll(oxm_bitmap);
1796 /* Opposite conversion from oxm_bitmap_from_mf_bitmap().
1798 * This is useful for decoding OpenFlow 1.2 table stats messages. */
1800 oxm_bitmap_to_mf_bitmap(ovs_be64 oxm_bitmap, enum ofp_version version)
1802 struct mf_bitmap fields = MF_BITMAP_INITIALIZER;
1804 for (enum mf_field_id id = 0; id < MFF_N_IDS; id++) {
1805 uint64_t oxm = mf_oxm_header(id, version);
1806 if (oxm && version >= nxm_field_by_header(oxm)->version) {
1807 uint32_t class = nxm_class(oxm);
1808 int field = nxm_field(oxm);
1810 if (class == OFPXMC12_OPENFLOW_BASIC
1812 && oxm_bitmap & htonll(UINT64_C(1) << field)) {
1813 bitmap_set1(fields.bm, id);
1820 /* Returns a bitmap of fields that can be encoded in OXM and that can be
1821 * modified with a "set_field" action. */
1823 oxm_writable_fields(void)
1825 struct mf_bitmap b = MF_BITMAP_INITIALIZER;
1828 for (i = 0; i < MFF_N_IDS; i++) {
1829 if (mf_oxm_header(i, 0) && mf_from_id(i)->writable) {
1830 bitmap_set1(b.bm, i);
1836 /* Returns a bitmap of fields that can be encoded in OXM and that can be
1837 * matched in a flow table. */
1839 oxm_matchable_fields(void)
1841 struct mf_bitmap b = MF_BITMAP_INITIALIZER;
1844 for (i = 0; i < MFF_N_IDS; i++) {
1845 if (mf_oxm_header(i, 0)) {
1846 bitmap_set1(b.bm, i);
1852 /* Returns a bitmap of fields that can be encoded in OXM and that can be
1853 * matched in a flow table with an arbitrary bitmask. */
1855 oxm_maskable_fields(void)
1857 struct mf_bitmap b = MF_BITMAP_INITIALIZER;
1860 for (i = 0; i < MFF_N_IDS; i++) {
1861 if (mf_oxm_header(i, 0) && mf_from_id(i)->maskable == MFM_FULLY) {
1862 bitmap_set1(b.bm, i);
1868 struct nxm_field_index {
1869 struct hmap_node header_node; /* In nxm_header_map. */
1870 struct hmap_node name_node; /* In nxm_name_map. */
1871 struct ovs_list mf_node; /* In mf_mf_map[nf.id]. */
1872 const struct nxm_field nf;
1875 #include "nx-match.inc"
1877 static struct hmap nxm_header_map;
1878 static struct hmap nxm_name_map;
1879 static struct ovs_list nxm_mf_map[MFF_N_IDS];
1884 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
1885 if (ovsthread_once_start(&once)) {
1886 hmap_init(&nxm_header_map);
1887 hmap_init(&nxm_name_map);
1888 for (int i = 0; i < MFF_N_IDS; i++) {
1889 list_init(&nxm_mf_map[i]);
1891 for (struct nxm_field_index *nfi = all_nxm_fields;
1892 nfi < &all_nxm_fields[ARRAY_SIZE(all_nxm_fields)]; nfi++) {
1893 hmap_insert(&nxm_header_map, &nfi->header_node,
1894 hash_int(nfi->nf.header, 0));
1895 hmap_insert(&nxm_name_map, &nfi->name_node,
1896 hash_string(nfi->nf.name, 0));
1897 list_push_back(&nxm_mf_map[nfi->nf.id], &nfi->mf_node);
1899 ovsthread_once_done(&once);
1903 static const struct nxm_field *
1904 nxm_field_by_header(uint64_t header)
1906 const struct nxm_field_index *nfi;
1909 if (nxm_hasmask(header)) {
1910 header = nxm_make_exact_header(header);
1913 HMAP_FOR_EACH_IN_BUCKET (nfi, header_node, hash_int(header, 0),
1915 if (header == nfi->nf.header) {
1922 static const struct nxm_field *
1923 nxm_field_by_name(const char *name, size_t len)
1925 const struct nxm_field_index *nfi;
1928 HMAP_FOR_EACH_WITH_HASH (nfi, name_node, hash_bytes(name, len, 0),
1930 if (strlen(nfi->nf.name) == len && !memcmp(nfi->nf.name, name, len)) {
1937 static const struct nxm_field *
1938 nxm_field_by_mf_id(enum mf_field_id id, enum ofp_version version)
1940 const struct nxm_field_index *nfi;
1941 const struct nxm_field *f;
1946 LIST_FOR_EACH (nfi, mf_node, &nxm_mf_map[id]) {
1947 if (!f || version >= nfi->nf.version) {