2 * Copyright (c) 2010, 2011, 2012 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"
25 #include "meta-flow.h"
26 #include "ofp-actions.h"
27 #include "ofp-errors.h"
30 #include "openflow/nicira-ext.h"
32 #include "unaligned.h"
36 VLOG_DEFINE_THIS_MODULE(nx_match);
38 /* Rate limit for nx_match parse errors. These always indicate a bug in the
39 * peer and so there's not much point in showing a lot of them. */
40 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
42 /* Returns the width of the data for a field with the given 'header', in
45 nxm_field_bytes(uint32_t header)
47 unsigned int length = NXM_LENGTH(header);
48 return NXM_HASMASK(header) ? length / 2 : length;
51 /* Returns the width of the data for a field with the given 'header', in
54 nxm_field_bits(uint32_t header)
56 return nxm_field_bytes(header) * 8;
59 /* nx_pull_match() and helpers. */
62 nx_entry_ok(const void *p, unsigned int match_len)
64 unsigned int payload_len;
70 VLOG_DBG_RL(&rl, "nx_match ends with partial (%u-byte) nxm_header",
75 memcpy(&header_be, p, 4);
76 header = ntohl(header_be);
78 payload_len = NXM_LENGTH(header);
80 VLOG_DBG_RL(&rl, "nxm_entry %08"PRIx32" has invalid payload "
84 if (match_len < payload_len + 4) {
85 VLOG_DBG_RL(&rl, "%"PRIu32"-byte nxm_entry but only "
86 "%u bytes left in nx_match", payload_len + 4, match_len);
94 nx_pull_raw(const uint8_t *p, unsigned int match_len, bool strict,
95 struct match *match, ovs_be64 *cookie, ovs_be64 *cookie_mask)
99 assert((cookie != NULL) == (cookie_mask != NULL));
101 match_init_catchall(match);
103 *cookie = *cookie_mask = htonll(0);
110 (header = nx_entry_ok(p, match_len)) != 0;
111 p += 4 + NXM_LENGTH(header), match_len -= 4 + NXM_LENGTH(header)) {
112 const struct mf_field *mf;
115 mf = mf_from_nxm_header(header);
118 error = OFPERR_OFPBMC_BAD_FIELD;
122 } else if (!mf_are_prereqs_ok(mf, &match->flow)) {
123 error = OFPERR_OFPBMC_BAD_PREREQ;
124 } else if (!mf_is_all_wild(mf, &match->wc)) {
125 error = OFPERR_OFPBMC_DUP_FIELD;
126 } else if (header != OXM_OF_IN_PORT) {
127 unsigned int width = mf->n_bytes;
128 union mf_value value;
130 memcpy(&value, p + 4, width);
131 if (!mf_is_value_valid(mf, &value)) {
132 error = OFPERR_OFPBMC_BAD_VALUE;
133 } else if (!NXM_HASMASK(header)) {
135 mf_set_value(mf, &value, match);
139 memcpy(&mask, p + 4 + width, width);
140 if (!mf_is_mask_valid(mf, &mask)) {
141 error = OFPERR_OFPBMC_BAD_MASK;
144 mf_set(mf, &value, &mask, match);
148 /* Special case for 32bit ports when using OXM,
149 * ports are 16 bits wide otherwise. */
153 memcpy(&port_of11, p + 4, sizeof port_of11);
154 error = ofputil_port_from_ofp11(port_of11, &port);
156 match_set_in_port(match, port);
160 /* Check if the match is for a cookie rather than a classifier rule. */
161 if ((header == NXM_NX_COOKIE || header == NXM_NX_COOKIE_W) && cookie) {
163 error = OFPERR_OFPBMC_DUP_FIELD;
165 unsigned int width = sizeof *cookie;
167 memcpy(cookie, p + 4, width);
168 if (NXM_HASMASK(header)) {
169 memcpy(cookie_mask, p + 4 + width, width);
171 *cookie_mask = htonll(UINT64_MAX);
178 VLOG_DBG_RL(&rl, "bad nxm_entry %#08"PRIx32" (vendor=%"PRIu32", "
179 "field=%"PRIu32", hasmask=%"PRIu32", len=%"PRIu32"), "
181 NXM_VENDOR(header), NXM_FIELD(header),
182 NXM_HASMASK(header), NXM_LENGTH(header),
183 ofperr_to_string(error));
188 return match_len ? OFPERR_OFPBMC_BAD_LEN : 0;
192 nx_pull_match__(struct ofpbuf *b, unsigned int match_len, bool strict,
194 ovs_be64 *cookie, ovs_be64 *cookie_mask)
199 p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
201 VLOG_DBG_RL(&rl, "nx_match length %u, rounded up to a "
202 "multiple of 8, is longer than space in message (max "
203 "length %zu)", match_len, b->size);
204 return OFPERR_OFPBMC_BAD_LEN;
208 return nx_pull_raw(p, match_len, strict, match, cookie, cookie_mask);
211 /* Parses the nx_match formatted match description in 'b' with length
212 * 'match_len'. Stores the results in 'match'. If 'cookie' and 'cookie_mask'
213 * are valid pointers, then stores the cookie and mask in them if 'b' contains
214 * a "NXM_NX_COOKIE*" match. Otherwise, stores 0 in both.
216 * Fails with an error upon encountering an unknown NXM header.
218 * Returns 0 if successful, otherwise an OpenFlow error code. */
220 nx_pull_match(struct ofpbuf *b, unsigned int match_len, struct match *match,
221 ovs_be64 *cookie, ovs_be64 *cookie_mask)
223 return nx_pull_match__(b, match_len, true, match, cookie, cookie_mask);
226 /* Behaves the same as nx_pull_match(), but skips over unknown NXM headers,
227 * instead of failing with an error. */
229 nx_pull_match_loose(struct ofpbuf *b, unsigned int match_len,
231 ovs_be64 *cookie, ovs_be64 *cookie_mask)
233 return nx_pull_match__(b, match_len, false, match, cookie, cookie_mask);
237 oxm_pull_match__(struct ofpbuf *b, bool strict, struct match *match)
239 struct ofp11_match_header *omh = b->data;
243 if (b->size < sizeof *omh) {
244 return OFPERR_OFPBMC_BAD_LEN;
247 match_len = ntohs(omh->length);
248 if (match_len < sizeof *omh) {
249 return OFPERR_OFPBMC_BAD_LEN;
252 if (omh->type != htons(OFPMT_OXM)) {
253 return OFPERR_OFPBMC_BAD_TYPE;
256 p = ofpbuf_try_pull(b, ROUND_UP(match_len, 8));
258 VLOG_DBG_RL(&rl, "oxm length %u, rounded up to a "
259 "multiple of 8, is longer than space in message (max "
260 "length %zu)", match_len, b->size);
261 return OFPERR_OFPBMC_BAD_LEN;
264 return nx_pull_raw(p + sizeof *omh, match_len - sizeof *omh,
265 strict, match, NULL, NULL);
268 /* Parses the oxm formatted match description preceeded by a struct ofp11_match
269 * in 'b' with length 'match_len'. Stores the result in 'match'.
271 * Fails with an error when encountering unknown OXM headers.
273 * Returns 0 if successful, otherwise an OpenFlow error code. */
275 oxm_pull_match(struct ofpbuf *b, struct match *match)
277 return oxm_pull_match__(b, true, match);
280 /* Behaves the same as oxm_pull_match() with one exception. Skips over unknown
281 * PXM headers instead of failing with an error when they are encountered. */
283 oxm_pull_match_loose(struct ofpbuf *b, struct match *match)
285 return oxm_pull_match__(b, false, match);
288 /* nx_put_match() and helpers.
290 * 'put' functions whose names end in 'w' add a wildcarded field.
291 * 'put' functions whose names end in 'm' add a field that might be wildcarded.
292 * Other 'put' functions add exact-match fields.
296 nxm_put_header(struct ofpbuf *b, uint32_t header)
298 ovs_be32 n_header = htonl(header);
299 ofpbuf_put(b, &n_header, sizeof n_header);
303 nxm_put_8(struct ofpbuf *b, uint32_t header, uint8_t value)
305 nxm_put_header(b, header);
306 ofpbuf_put(b, &value, sizeof value);
310 nxm_put_8m(struct ofpbuf *b, uint32_t header, uint8_t value, uint8_t mask)
317 nxm_put_8(b, header, value);
321 nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
322 ofpbuf_put(b, &value, sizeof value);
323 ofpbuf_put(b, &mask, sizeof mask);
328 nxm_put_16(struct ofpbuf *b, uint32_t header, ovs_be16 value)
330 nxm_put_header(b, header);
331 ofpbuf_put(b, &value, sizeof value);
335 nxm_put_16w(struct ofpbuf *b, uint32_t header, ovs_be16 value, ovs_be16 mask)
337 nxm_put_header(b, header);
338 ofpbuf_put(b, &value, sizeof value);
339 ofpbuf_put(b, &mask, sizeof mask);
343 nxm_put_16m(struct ofpbuf *b, uint32_t header, ovs_be16 value, ovs_be16 mask)
349 case CONSTANT_HTONS(UINT16_MAX):
350 nxm_put_16(b, header, value);
354 nxm_put_16w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
360 nxm_put_32(struct ofpbuf *b, uint32_t header, ovs_be32 value)
362 nxm_put_header(b, header);
363 ofpbuf_put(b, &value, sizeof value);
367 nxm_put_32w(struct ofpbuf *b, uint32_t header, ovs_be32 value, ovs_be32 mask)
369 nxm_put_header(b, header);
370 ofpbuf_put(b, &value, sizeof value);
371 ofpbuf_put(b, &mask, sizeof mask);
375 nxm_put_32m(struct ofpbuf *b, uint32_t header, ovs_be32 value, ovs_be32 mask)
381 case CONSTANT_HTONL(UINT32_MAX):
382 nxm_put_32(b, header, value);
386 nxm_put_32w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
392 nxm_put_64(struct ofpbuf *b, uint32_t header, ovs_be64 value)
394 nxm_put_header(b, header);
395 ofpbuf_put(b, &value, sizeof value);
399 nxm_put_64w(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
401 nxm_put_header(b, header);
402 ofpbuf_put(b, &value, sizeof value);
403 ofpbuf_put(b, &mask, sizeof mask);
407 nxm_put_64m(struct ofpbuf *b, uint32_t header, ovs_be64 value, ovs_be64 mask)
413 case CONSTANT_HTONLL(UINT64_MAX):
414 nxm_put_64(b, header, value);
418 nxm_put_64w(b, NXM_MAKE_WILD_HEADER(header), value, mask);
424 nxm_put_eth(struct ofpbuf *b, uint32_t header,
425 const uint8_t value[ETH_ADDR_LEN])
427 nxm_put_header(b, header);
428 ofpbuf_put(b, value, ETH_ADDR_LEN);
432 nxm_put_eth_masked(struct ofpbuf *b, uint32_t header,
433 const uint8_t value[ETH_ADDR_LEN],
434 const uint8_t mask[ETH_ADDR_LEN])
436 if (!eth_addr_is_zero(mask)) {
437 if (eth_mask_is_exact(mask)) {
438 nxm_put_eth(b, header, value);
440 nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
441 ofpbuf_put(b, value, ETH_ADDR_LEN);
442 ofpbuf_put(b, mask, ETH_ADDR_LEN);
448 nxm_put_ipv6(struct ofpbuf *b, uint32_t header,
449 const struct in6_addr *value, const struct in6_addr *mask)
451 if (ipv6_mask_is_any(mask)) {
453 } else if (ipv6_mask_is_exact(mask)) {
454 nxm_put_header(b, header);
455 ofpbuf_put(b, value, sizeof *value);
457 nxm_put_header(b, NXM_MAKE_WILD_HEADER(header));
458 ofpbuf_put(b, value, sizeof *value);
459 ofpbuf_put(b, mask, sizeof *mask);
464 nxm_put_frag(struct ofpbuf *b, const struct match *match)
466 uint8_t nw_frag = match->flow.nw_frag;
467 uint8_t nw_frag_mask = match->wc.masks.nw_frag;
469 switch (nw_frag_mask) {
473 case FLOW_NW_FRAG_MASK:
474 nxm_put_8(b, NXM_NX_IP_FRAG, nw_frag);
478 nxm_put_8m(b, NXM_NX_IP_FRAG, nw_frag,
479 nw_frag_mask & FLOW_NW_FRAG_MASK);
485 nxm_put_ip(struct ofpbuf *b, const struct match *match,
486 uint8_t icmp_proto, uint32_t icmp_type, uint32_t icmp_code,
489 const struct flow *flow = &match->flow;
491 nxm_put_frag(b, match);
493 if (match->wc.masks.nw_tos & IP_DSCP_MASK) {
494 nxm_put_8(b, oxm ? OXM_OF_IP_DSCP : NXM_OF_IP_TOS,
495 flow->nw_tos & IP_DSCP_MASK);
498 if (match->wc.masks.nw_tos & IP_ECN_MASK) {
499 nxm_put_8(b, oxm ? OXM_OF_IP_ECN : NXM_NX_IP_ECN,
500 flow->nw_tos & IP_ECN_MASK);
503 if (!oxm && match->wc.masks.nw_ttl) {
504 nxm_put_8(b, NXM_NX_IP_TTL, flow->nw_ttl);
507 if (match->wc.masks.nw_proto) {
508 nxm_put_8(b, oxm ? OXM_OF_IP_PROTO : NXM_OF_IP_PROTO, flow->nw_proto);
510 if (flow->nw_proto == IPPROTO_TCP) {
511 nxm_put_16m(b, oxm ? OXM_OF_TCP_SRC : NXM_OF_TCP_SRC,
512 flow->tp_src, match->wc.masks.tp_src);
513 nxm_put_16m(b, oxm ? OXM_OF_TCP_DST : NXM_OF_TCP_DST,
514 flow->tp_dst, match->wc.masks.tp_dst);
515 } else if (flow->nw_proto == IPPROTO_UDP) {
516 nxm_put_16m(b, oxm ? OXM_OF_UDP_SRC : NXM_OF_UDP_SRC,
517 flow->tp_src, match->wc.masks.tp_src);
518 nxm_put_16m(b, oxm ? OXM_OF_UDP_DST : NXM_OF_UDP_DST,
519 flow->tp_dst, match->wc.masks.tp_dst);
520 } else if (flow->nw_proto == icmp_proto) {
521 if (match->wc.masks.tp_src) {
522 nxm_put_8(b, icmp_type, ntohs(flow->tp_src));
524 if (match->wc.masks.tp_dst) {
525 nxm_put_8(b, icmp_code, ntohs(flow->tp_dst));
531 /* Appends to 'b' the nx_match format that expresses 'match'. For Flow Mod and
532 * Flow Stats Requests messages, a 'cookie' and 'cookie_mask' may be supplied.
533 * Otherwise, 'cookie_mask' should be zero.
535 * This function can cause 'b''s data to be reallocated.
537 * Returns the number of bytes appended to 'b', excluding padding.
539 * If 'match' is a catch-all rule that matches every packet, then this function
540 * appends nothing to 'b' and returns 0. */
542 nx_put_raw(struct ofpbuf *b, bool oxm, const struct match *match,
543 ovs_be64 cookie, ovs_be64 cookie_mask)
545 const struct flow *flow = &match->flow;
546 const size_t start_len = b->size;
550 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 18);
553 if (match->wc.masks.in_port) {
554 uint16_t in_port = flow->in_port;
556 nxm_put_32(b, OXM_OF_IN_PORT, ofputil_port_to_ofp11(in_port));
558 nxm_put_16(b, NXM_OF_IN_PORT, htons(in_port));
563 nxm_put_eth_masked(b, oxm ? OXM_OF_ETH_SRC : NXM_OF_ETH_SRC,
564 flow->dl_src, match->wc.masks.dl_src);
565 nxm_put_eth_masked(b, oxm ? OXM_OF_ETH_DST : NXM_OF_ETH_DST,
566 flow->dl_dst, match->wc.masks.dl_dst);
567 nxm_put_16m(b, oxm ? OXM_OF_ETH_TYPE : NXM_OF_ETH_TYPE,
568 ofputil_dl_type_to_openflow(flow->dl_type),
569 match->wc.masks.dl_type);
573 ovs_be16 VID_CFI_MASK = htons(VLAN_VID_MASK | VLAN_CFI);
574 ovs_be16 vid = flow->vlan_tci & VID_CFI_MASK;
575 ovs_be16 mask = match->wc.masks.vlan_tci & VID_CFI_MASK;
577 if (mask == htons(VLAN_VID_MASK | VLAN_CFI)) {
578 nxm_put_16(b, OXM_OF_VLAN_VID, vid);
580 nxm_put_16m(b, OXM_OF_VLAN_VID, vid, mask);
583 if (vid && vlan_tci_to_pcp(match->wc.masks.vlan_tci)) {
584 nxm_put_8(b, OXM_OF_VLAN_PCP, vlan_tci_to_pcp(flow->vlan_tci));
588 nxm_put_16m(b, NXM_OF_VLAN_TCI, flow->vlan_tci,
589 match->wc.masks.vlan_tci);
593 if (flow->dl_type == htons(ETH_TYPE_IP)) {
595 nxm_put_32m(b, oxm ? OXM_OF_IPV4_SRC : NXM_OF_IP_SRC,
596 flow->nw_src, match->wc.masks.nw_src);
597 nxm_put_32m(b, oxm ? OXM_OF_IPV4_DST : NXM_OF_IP_DST,
598 flow->nw_dst, match->wc.masks.nw_dst);
599 nxm_put_ip(b, match, IPPROTO_ICMP,
600 oxm ? OXM_OF_ICMPV4_TYPE : NXM_OF_ICMP_TYPE,
601 oxm ? OXM_OF_ICMPV4_CODE : NXM_OF_ICMP_CODE, oxm);
602 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
604 nxm_put_ipv6(b, oxm ? OXM_OF_IPV6_SRC : NXM_NX_IPV6_SRC,
605 &flow->ipv6_src, &match->wc.masks.ipv6_src);
606 nxm_put_ipv6(b, oxm ? OXM_OF_IPV6_DST : NXM_NX_IPV6_DST,
607 &flow->ipv6_dst, &match->wc.masks.ipv6_dst);
608 nxm_put_ip(b, match, IPPROTO_ICMPV6,
609 oxm ? OXM_OF_ICMPV6_TYPE : NXM_NX_ICMPV6_TYPE,
610 oxm ? OXM_OF_ICMPV6_CODE : NXM_NX_ICMPV6_CODE, oxm);
612 nxm_put_32m(b, oxm ? OXM_OF_IPV6_FLABEL : NXM_NX_IPV6_LABEL,
613 flow->ipv6_label, match->wc.masks.ipv6_label);
615 if (flow->nw_proto == IPPROTO_ICMPV6
616 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
617 flow->tp_src == htons(ND_NEIGHBOR_ADVERT))) {
618 nxm_put_ipv6(b, oxm ? OXM_OF_IPV6_ND_TARGET : NXM_NX_ND_TARGET,
619 &flow->nd_target, &match->wc.masks.nd_target);
620 if (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
621 nxm_put_eth_masked(b, oxm ? OXM_OF_IPV6_ND_SLL : NXM_NX_ND_SLL,
622 flow->arp_sha, match->wc.masks.arp_sha);
624 if (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)) {
625 nxm_put_eth_masked(b, oxm ? OXM_OF_IPV6_ND_TLL : NXM_NX_ND_TLL,
626 flow->arp_tha, match->wc.masks.arp_tha);
629 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
630 flow->dl_type == htons(ETH_TYPE_RARP)) {
632 if (match->wc.masks.nw_proto) {
633 nxm_put_16(b, oxm ? OXM_OF_ARP_OP : NXM_OF_ARP_OP,
634 htons(flow->nw_proto));
636 nxm_put_32m(b, oxm ? OXM_OF_ARP_SPA : NXM_OF_ARP_SPA,
637 flow->nw_src, match->wc.masks.nw_src);
638 nxm_put_32m(b, oxm ? OXM_OF_ARP_TPA : NXM_OF_ARP_TPA,
639 flow->nw_dst, match->wc.masks.nw_dst);
640 nxm_put_eth_masked(b, oxm ? OXM_OF_ARP_SHA : NXM_NX_ARP_SHA,
641 flow->arp_sha, match->wc.masks.arp_sha);
642 nxm_put_eth_masked(b, oxm ? OXM_OF_ARP_THA : NXM_NX_ARP_THA,
643 flow->arp_tha, match->wc.masks.arp_tha);
647 nxm_put_64m(b, NXM_NX_TUN_ID, flow->tunnel.tun_id,
648 match->wc.masks.tunnel.tun_id);
651 for (i = 0; i < FLOW_N_REGS; i++) {
652 nxm_put_32m(b, NXM_NX_REG(i),
653 htonl(flow->regs[i]), htonl(match->wc.masks.regs[i]));
656 /* OpenFlow 1.1+ Metadata. */
657 nxm_put_64m(b, OXM_OF_METADATA, flow->metadata, match->wc.masks.metadata);
660 nxm_put_64m(b, NXM_NX_COOKIE, cookie, cookie_mask);
662 match_len = b->size - start_len;
666 /* Appends to 'b' the nx_match format that expresses 'match', plus enough zero
667 * bytes to pad the nx_match out to a multiple of 8. For Flow Mod and Flow
668 * Stats Requests messages, a 'cookie' and 'cookie_mask' may be supplied.
669 * Otherwise, 'cookie_mask' should be zero.
671 * This function can cause 'b''s data to be reallocated.
673 * Returns the number of bytes appended to 'b', excluding padding. The return
674 * value can be zero if it appended nothing at all to 'b' (which happens if
675 * 'cr' is a catch-all rule that matches every packet). */
677 nx_put_match(struct ofpbuf *b, const struct match *match,
678 ovs_be64 cookie, ovs_be64 cookie_mask)
680 int match_len = nx_put_raw(b, false, match, cookie, cookie_mask);
682 ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
687 /* Appends to 'b' an struct ofp11_match_header followed by the oxm format that
688 * expresses 'cr', plus enough zero bytes to pad the data appended out to a
691 * This function can cause 'b''s data to be reallocated.
693 * Returns the number of bytes appended to 'b', excluding the padding. Never
696 oxm_put_match(struct ofpbuf *b, const struct match *match)
699 struct ofp11_match_header *omh;
700 size_t start_len = b->size;
701 ovs_be64 cookie = htonll(0), cookie_mask = htonll(0);
703 ofpbuf_put_uninit(b, sizeof *omh);
704 match_len = nx_put_raw(b, true, match, cookie, cookie_mask) + sizeof *omh;
705 ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
707 omh = (struct ofp11_match_header *)((char *)b->data + start_len);
708 omh->type = htons(OFPMT_OXM);
709 omh->length = htons(match_len);
714 /* nx_match_to_string() and helpers. */
716 static void format_nxm_field_name(struct ds *, uint32_t header);
719 nx_match_to_string(const uint8_t *p, unsigned int match_len)
725 return xstrdup("<any>");
729 while ((header = nx_entry_ok(p, match_len)) != 0) {
730 unsigned int length = NXM_LENGTH(header);
731 unsigned int value_len = nxm_field_bytes(header);
732 const uint8_t *value = p + 4;
733 const uint8_t *mask = value + value_len;
737 ds_put_cstr(&s, ", ");
740 format_nxm_field_name(&s, header);
741 ds_put_char(&s, '(');
743 for (i = 0; i < value_len; i++) {
744 ds_put_format(&s, "%02x", value[i]);
746 if (NXM_HASMASK(header)) {
747 ds_put_char(&s, '/');
748 for (i = 0; i < value_len; i++) {
749 ds_put_format(&s, "%02x", mask[i]);
752 ds_put_char(&s, ')');
755 match_len -= 4 + length;
760 ds_put_cstr(&s, ", ");
763 ds_put_format(&s, "<%u invalid bytes>", match_len);
766 return ds_steal_cstr(&s);
770 oxm_match_to_string(const uint8_t *p, unsigned int match_len)
772 const struct ofp11_match_header *omh = (struct ofp11_match_header *)p;
778 if (match_len < sizeof *omh) {
779 ds_put_format(&s, "<match too short: %u>", match_len);
783 if (omh->type != htons(OFPMT_OXM)) {
784 ds_put_format(&s, "<bad match type field: %u>", ntohs(omh->type));
788 match_len_ = ntohs(omh->length);
789 if (match_len_ < sizeof *omh) {
790 ds_put_format(&s, "<match length field too short: %u>", match_len_);
794 if (match_len_ != match_len) {
795 ds_put_format(&s, "<match length field incorrect: %u != %u>",
796 match_len_, match_len);
800 return nx_match_to_string(p + sizeof *omh, match_len - sizeof *omh);
803 return ds_steal_cstr(&s);
807 format_nxm_field_name(struct ds *s, uint32_t header)
809 const struct mf_field *mf = mf_from_nxm_header(header);
811 ds_put_cstr(s, IS_OXM_HEADER(header) ? mf->oxm_name : mf->nxm_name);
812 if (NXM_HASMASK(header)) {
813 ds_put_cstr(s, "_W");
815 } else if (header == NXM_NX_COOKIE) {
816 ds_put_cstr(s, "NXM_NX_COOKIE");
817 } else if (header == NXM_NX_COOKIE_W) {
818 ds_put_cstr(s, "NXM_NX_COOKIE_W");
820 ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
825 parse_nxm_field_name(const char *name, int name_len)
830 /* Check whether it's a field name. */
831 wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
836 for (i = 0; i < MFF_N_IDS; i++) {
837 const struct mf_field *mf = mf_from_id(i);
841 !strncmp(mf->nxm_name, name, name_len) &&
842 mf->nxm_name[name_len] == '\0') {
843 header = mf->nxm_header;
844 } else if (mf->oxm_name &&
845 !strncmp(mf->oxm_name, name, name_len) &&
846 mf->oxm_name[name_len] == '\0') {
847 header = mf->oxm_header;
854 } else if (mf->maskable != MFM_NONE) {
855 return NXM_MAKE_WILD_HEADER(header);
859 if (!strncmp("NXM_NX_COOKIE", name, name_len) &&
860 (name_len == strlen("NXM_NX_COOKIE"))) {
862 return NXM_NX_COOKIE;
864 return NXM_NX_COOKIE_W;
868 /* Check whether it's a 32-bit field header value as hex.
869 * (This isn't ordinarily useful except for testing error behavior.) */
871 uint32_t header = hexits_value(name, name_len, NULL);
872 if (header != UINT_MAX) {
880 /* nx_match_from_string(). */
883 nx_match_from_string_raw(const char *s, struct ofpbuf *b)
885 const char *full_s = s;
886 const size_t start_len = b->size;
888 if (!strcmp(s, "<any>")) {
889 /* Ensure that 'b->data' isn't actually null. */
890 ofpbuf_prealloc_tailroom(b, 1);
894 for (s += strspn(s, ", "); *s; s += strspn(s, ", ")) {
901 name_len = strcspn(s, "(");
902 if (s[name_len] != '(') {
903 ovs_fatal(0, "%s: missing ( at end of nx_match", full_s);
906 header = parse_nxm_field_name(name, name_len);
908 ovs_fatal(0, "%s: unknown field `%.*s'", full_s, name_len, s);
913 nxm_put_header(b, header);
914 s = ofpbuf_put_hex(b, s, &n);
915 if (n != nxm_field_bytes(header)) {
916 ovs_fatal(0, "%.2s: hex digits expected", s);
918 if (NXM_HASMASK(header)) {
921 ovs_fatal(0, "%s: missing / in masked field %.*s",
922 full_s, name_len, name);
924 s = ofpbuf_put_hex(b, s + 1, &n);
925 if (n != nxm_field_bytes(header)) {
926 ovs_fatal(0, "%.2s: hex digits expected", s);
932 ovs_fatal(0, "%s: missing ) following field %.*s",
933 full_s, name_len, name);
938 return b->size - start_len;
942 nx_match_from_string(const char *s, struct ofpbuf *b)
944 int match_len = nx_match_from_string_raw(s, b);
945 ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
950 oxm_match_from_string(const char *s, struct ofpbuf *b)
953 struct ofp11_match_header *omh;
954 size_t start_len = b->size;
956 ofpbuf_put_uninit(b, sizeof *omh);
957 match_len = nx_match_from_string_raw(s, b) + sizeof *omh;
958 ofpbuf_put_zeros(b, ROUND_UP(match_len, 8) - match_len);
960 omh = (struct ofp11_match_header *)((char *)b->data + start_len);
961 omh->type = htons(OFPMT_OXM);
962 omh->length = htons(match_len);
968 nxm_parse_reg_move(struct ofpact_reg_move *move, const char *s)
970 const char *full_s = s;
972 s = mf_parse_subfield(&move->src, s);
973 if (strncmp(s, "->", 2)) {
974 ovs_fatal(0, "%s: missing `->' following source", full_s);
977 s = mf_parse_subfield(&move->dst, s);
979 ovs_fatal(0, "%s: trailing garbage following destination", full_s);
982 if (move->src.n_bits != move->dst.n_bits) {
983 ovs_fatal(0, "%s: source field is %d bits wide but destination is "
984 "%d bits wide", full_s,
985 move->src.n_bits, move->dst.n_bits);
990 nxm_parse_reg_load(struct ofpact_reg_load *load, const char *s)
992 const char *full_s = s;
993 uint64_t value = strtoull(s, (char **) &s, 0);
995 if (strncmp(s, "->", 2)) {
996 ovs_fatal(0, "%s: missing `->' following value", full_s);
999 s = mf_parse_subfield(&load->dst, s);
1001 ovs_fatal(0, "%s: trailing garbage following destination", full_s);
1004 if (load->dst.n_bits < 64 && (value >> load->dst.n_bits) != 0) {
1005 ovs_fatal(0, "%s: value %"PRIu64" does not fit into %d bits",
1006 full_s, value, load->dst.n_bits);
1009 load->subvalue.be64[0] = htonll(0);
1010 load->subvalue.be64[1] = htonll(value);
1013 /* nxm_format_reg_move(), nxm_format_reg_load(). */
1016 nxm_format_reg_move(const struct ofpact_reg_move *move, struct ds *s)
1018 ds_put_format(s, "move:");
1019 mf_format_subfield(&move->src, s);
1020 ds_put_cstr(s, "->");
1021 mf_format_subfield(&move->dst, s);
1025 set_field_format(const struct ofpact_reg_load *load, struct ds *s)
1027 const struct mf_field *mf = load->dst.field;
1028 union mf_value value;
1030 assert(load->ofpact.compat == OFPUTIL_OFPAT12_SET_FIELD);
1031 ds_put_format(s, "set_field:");
1032 memset(&value, 0, sizeof value);
1033 bitwise_copy(&load->subvalue, sizeof load->subvalue, 0,
1034 &value, mf->n_bytes, 0, load->dst.n_bits);
1035 mf_format(mf, &value, NULL, s);
1036 ds_put_format(s, "->%s", mf->name);
1040 load_format(const struct ofpact_reg_load *load, struct ds *s)
1042 ds_put_cstr(s, "load:");
1043 mf_format_subvalue(&load->subvalue, s);
1044 ds_put_cstr(s, "->");
1045 mf_format_subfield(&load->dst, s);
1049 nxm_format_reg_load(const struct ofpact_reg_load *load, struct ds *s)
1051 if (load->ofpact.compat == OFPUTIL_OFPAT12_SET_FIELD) {
1052 set_field_format(load, s);
1054 load_format(load, s);
1059 nxm_reg_move_from_openflow(const struct nx_action_reg_move *narm,
1060 struct ofpbuf *ofpacts)
1062 struct ofpact_reg_move *move;
1064 move = ofpact_put_REG_MOVE(ofpacts);
1065 move->src.field = mf_from_nxm_header(ntohl(narm->src));
1066 move->src.ofs = ntohs(narm->src_ofs);
1067 move->src.n_bits = ntohs(narm->n_bits);
1068 move->dst.field = mf_from_nxm_header(ntohl(narm->dst));
1069 move->dst.ofs = ntohs(narm->dst_ofs);
1070 move->dst.n_bits = ntohs(narm->n_bits);
1072 return nxm_reg_move_check(move, NULL);
1076 nxm_reg_load_from_openflow(const struct nx_action_reg_load *narl,
1077 struct ofpbuf *ofpacts)
1079 struct ofpact_reg_load *load;
1081 load = ofpact_put_REG_LOAD(ofpacts);
1082 load->dst.field = mf_from_nxm_header(ntohl(narl->dst));
1083 load->dst.ofs = nxm_decode_ofs(narl->ofs_nbits);
1084 load->dst.n_bits = nxm_decode_n_bits(narl->ofs_nbits);
1085 load->subvalue.be64[1] = narl->value;
1087 /* Reject 'narl' if a bit numbered 'n_bits' or higher is set to 1 in
1089 if (load->dst.n_bits < 64 &&
1090 ntohll(narl->value) >> load->dst.n_bits) {
1091 return OFPERR_OFPBAC_BAD_ARGUMENT;
1094 return nxm_reg_load_check(load, NULL);
1098 nxm_reg_load_from_openflow12_set_field(
1099 const struct ofp12_action_set_field * oasf, struct ofpbuf *ofpacts)
1101 uint16_t oasf_len = ntohs(oasf->len);
1102 uint32_t oxm_header = ntohl(oasf->dst);
1103 uint8_t oxm_length = NXM_LENGTH(oxm_header);
1104 struct ofpact_reg_load *load;
1105 const struct mf_field *mf;
1107 /* ofp12_action_set_field is padded to 64 bits by zero */
1108 if (oasf_len != ROUND_UP(sizeof(*oasf) + oxm_length, 8)) {
1109 return OFPERR_OFPBAC_BAD_ARGUMENT;
1111 if (!is_all_zeros((const uint8_t *)(oasf) + sizeof *oasf + oxm_length,
1112 oasf_len - oxm_length - sizeof *oasf)) {
1113 return OFPERR_OFPBAC_BAD_ARGUMENT;
1116 if (NXM_HASMASK(oxm_header)) {
1117 return OFPERR_OFPBAC_BAD_ARGUMENT;
1119 mf = mf_from_nxm_header(oxm_header);
1121 return OFPERR_OFPBAC_BAD_ARGUMENT;
1123 load = ofpact_put_REG_LOAD(ofpacts);
1124 ofpact_set_field_init(load, mf, oasf + 1);
1126 return nxm_reg_load_check(load, NULL);
1130 nxm_reg_move_check(const struct ofpact_reg_move *move, const struct flow *flow)
1134 error = mf_check_src(&move->src, flow);
1139 return mf_check_dst(&move->dst, NULL);
1143 nxm_reg_load_check(const struct ofpact_reg_load *load, const struct flow *flow)
1145 return mf_check_dst(&load->dst, flow);
1149 nxm_reg_move_to_nxast(const struct ofpact_reg_move *move,
1150 struct ofpbuf *openflow)
1152 struct nx_action_reg_move *narm;
1154 narm = ofputil_put_NXAST_REG_MOVE(openflow);
1155 narm->n_bits = htons(move->dst.n_bits);
1156 narm->src_ofs = htons(move->src.ofs);
1157 narm->dst_ofs = htons(move->dst.ofs);
1158 narm->src = htonl(move->src.field->nxm_header);
1159 narm->dst = htonl(move->dst.field->nxm_header);
1163 reg_load_to_nxast(const struct ofpact_reg_load *load, struct ofpbuf *openflow)
1165 struct nx_action_reg_load *narl;
1167 narl = ofputil_put_NXAST_REG_LOAD(openflow);
1168 narl->ofs_nbits = nxm_encode_ofs_nbits(load->dst.ofs, load->dst.n_bits);
1169 narl->dst = htonl(load->dst.field->nxm_header);
1170 narl->value = load->subvalue.be64[1];
1174 set_field_to_ofast(const struct ofpact_reg_load *load,
1175 struct ofpbuf *openflow)
1177 const struct mf_field *mf = load->dst.field;
1178 struct ofp12_action_set_field *oasf;
1179 uint16_t padded_value_len;
1181 oasf = ofputil_put_OFPAT12_SET_FIELD(openflow);
1182 oasf->dst = htonl(mf->oxm_header);
1184 /* Set field is the only action of variable length (so far),
1185 * so handling the variable length portion is open-coded here */
1186 padded_value_len = ROUND_UP(mf->n_bytes, 8);
1187 ofpbuf_put_uninit(openflow, padded_value_len);
1188 oasf->len = htons(ntohs(oasf->len) + padded_value_len);
1189 memset(oasf + 1, 0, padded_value_len);
1191 bitwise_copy(&load->subvalue, sizeof load->subvalue, load->dst.ofs,
1192 oasf + 1, mf->n_bytes, load->dst.ofs, load->dst.n_bits);
1197 nxm_reg_load_to_nxast(const struct ofpact_reg_load *load,
1198 struct ofpbuf *openflow)
1201 if (load->ofpact.compat == OFPUTIL_OFPAT12_SET_FIELD) {
1202 struct ofp_header *oh = (struct ofp_header *)openflow->l2;
1204 switch(oh->version) {
1206 set_field_to_ofast(load, openflow);
1211 if (load->dst.n_bits < 64) {
1212 reg_load_to_nxast(load, openflow);
1214 /* Split into 64bit chunks */
1216 for (ofs = 0; ofs < load->dst.n_bits; ofs += chunk) {
1217 struct ofpact_reg_load subload = *load;
1219 chunk = MIN(load->dst.n_bits - ofs, 64);
1221 subload.dst.field = load->dst.field;
1222 subload.dst.ofs = load->dst.ofs + ofs;
1223 subload.dst.n_bits = chunk;
1224 bitwise_copy(&load->subvalue, sizeof load->subvalue, ofs,
1225 &subload.subvalue, sizeof subload.subvalue, 0,
1227 reg_load_to_nxast(&subload, openflow);
1236 reg_load_to_nxast(load, openflow);
1240 /* nxm_execute_reg_move(), nxm_execute_reg_load(). */
1243 nxm_execute_reg_move(const struct ofpact_reg_move *move,
1246 union mf_value src_value;
1247 union mf_value dst_value;
1249 mf_get_value(move->dst.field, flow, &dst_value);
1250 mf_get_value(move->src.field, flow, &src_value);
1251 bitwise_copy(&src_value, move->src.field->n_bytes, move->src.ofs,
1252 &dst_value, move->dst.field->n_bytes, move->dst.ofs,
1254 mf_set_flow_value(move->dst.field, &dst_value, flow);
1258 nxm_execute_reg_load(const struct ofpact_reg_load *load, struct flow *flow)
1260 mf_write_subfield_flow(&load->dst, &load->subvalue, flow);
1264 nxm_reg_load(const struct mf_subfield *dst, uint64_t src_data,
1267 union mf_subvalue src_subvalue;
1268 ovs_be64 src_data_be = htonll(src_data);
1270 bitwise_copy(&src_data_be, sizeof src_data_be, 0,
1271 &src_subvalue, sizeof src_subvalue, 0,
1272 sizeof src_data_be * 8);
1273 mf_write_subfield_flow(dst, &src_subvalue, flow);