2 * Copyright (c) 2011, 2012, 2013 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.
19 #include "meta-flow.h"
23 #include <netinet/icmp6.h>
24 #include <netinet/ip6.h>
26 #include "classifier.h"
27 #include "dynamic-string.h"
28 #include "ofp-errors.h"
30 #include "ovs-thread.h"
34 #include "socket-util.h"
35 #include "unaligned.h"
38 VLOG_DEFINE_THIS_MODULE(meta_flow);
40 #define MF_FIELD_SIZES(MEMBER) \
41 sizeof ((union mf_value *)0)->MEMBER, \
42 8 * sizeof ((union mf_value *)0)->MEMBER
44 static const struct mf_field mf_fields[MFF_N_IDS] = {
50 MFF_TUN_ID, "tun_id", NULL,
56 NXM_NX_TUN_ID, "NXM_NX_TUN_ID",
57 OXM_OF_TUNNEL_ID, "OXM_OF_TUNNEL_ID",
58 OFPUTIL_P_NXM_OXM_ANY,
59 OFPUTIL_P_NXM_OXM_ANY,
61 MFF_TUN_SRC, "tun_src", NULL,
67 NXM_NX_TUN_IPV4_SRC, "NXM_NX_TUN_IPV4_SRC",
68 NXM_NX_TUN_IPV4_SRC, "NXM_NX_TUN_IPV4_SRC",
69 OFPUTIL_P_NXM_OXM_ANY,
70 OFPUTIL_P_NXM_OXM_ANY,
72 MFF_TUN_DST, "tun_dst", NULL,
78 NXM_NX_TUN_IPV4_DST, "NXM_NX_TUN_IPV4_DST",
79 NXM_NX_TUN_IPV4_DST, "NXM_NX_TUN_IPV4_DST",
80 OFPUTIL_P_NXM_OXM_ANY,
81 OFPUTIL_P_NXM_OXM_ANY,
83 MFF_TUN_FLAGS, "tun_flags", NULL,
94 MFF_TUN_TTL, "tun_ttl", NULL,
105 MFF_TUN_TOS, "tun_tos", NULL,
116 MFF_METADATA, "metadata", NULL,
117 MF_FIELD_SIZES(be64),
122 OXM_OF_METADATA, "OXM_OF_METADATA",
123 OXM_OF_METADATA, "OXM_OF_METADATA",
124 OFPUTIL_P_NXM_OF11_UP,
125 OFPUTIL_P_NXM_OF11_UP,
127 MFF_IN_PORT, "in_port", NULL,
128 MF_FIELD_SIZES(be16),
133 NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
134 NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
135 OFPUTIL_P_ANY, /* OF11+ via mapping to 32 bits. */
138 MFF_IN_PORT_OXM, "in_port_oxm", NULL,
139 MF_FIELD_SIZES(be32),
144 OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
145 OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
149 MFF_SKB_PRIORITY, "skb_priority", NULL,
150 MF_FIELD_SIZES(be32),
160 MFF_PKT_MARK, "pkt_mark", NULL,
161 MF_FIELD_SIZES(be32),
166 NXM_NX_PKT_MARK, "NXM_NX_PKT_MARK",
167 NXM_NX_PKT_MARK, "NXM_NX_PKT_MARK",
168 OFPUTIL_P_NXM_OXM_ANY,
169 OFPUTIL_P_NXM_OXM_ANY,
172 #define REGISTER(IDX) \
174 MFF_REG##IDX, "reg" #IDX, NULL, \
175 MF_FIELD_SIZES(be32), \
180 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
181 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
182 OFPUTIL_P_NXM_OXM_ANY, \
183 OFPUTIL_P_NXM_OXM_ANY, \
218 MFF_ETH_SRC, "eth_src", "dl_src",
224 NXM_OF_ETH_SRC, "NXM_OF_ETH_SRC",
225 OXM_OF_ETH_SRC, "OXM_OF_ETH_SRC",
227 OFPUTIL_P_NXM_OF11_UP, /* Bitwise masking only with NXM and OF11+! */
229 MFF_ETH_DST, "eth_dst", "dl_dst",
235 NXM_OF_ETH_DST, "NXM_OF_ETH_DST",
236 OXM_OF_ETH_DST, "OXM_OF_ETH_DST",
238 OFPUTIL_P_NXM_OF11_UP, /* Bitwise masking only with NXM and OF11+! */
240 MFF_ETH_TYPE, "eth_type", "dl_type",
241 MF_FIELD_SIZES(be16),
246 NXM_OF_ETH_TYPE, "NXM_OF_ETH_TYPE",
247 OXM_OF_ETH_TYPE, "OXM_OF_ETH_TYPE",
253 MFF_VLAN_TCI, "vlan_tci", NULL,
254 MF_FIELD_SIZES(be16),
259 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
260 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
262 OFPUTIL_P_NXM_OXM_ANY,
264 MFF_DL_VLAN, "dl_vlan", NULL,
265 sizeof(ovs_be16), 12,
273 OFPUTIL_P_NXM_OXM_ANY,
275 MFF_VLAN_VID, "vlan_vid", NULL,
276 sizeof(ovs_be16), 12,
281 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
282 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
284 OFPUTIL_P_NXM_OXM_ANY,
286 MFF_DL_VLAN_PCP, "dl_vlan_pcp", NULL,
294 OFPUTIL_P_ANY, /* Will be mapped to NXM and OXM. */
297 MFF_VLAN_PCP, "vlan_pcp", NULL,
303 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
304 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
305 OFPUTIL_P_ANY, /* Will be mapped to OF10 and NXM. */
313 MFF_MPLS_LABEL, "mpls_label", NULL,
319 OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
320 OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
321 OFPUTIL_P_NXM_OF11_UP,
324 MFF_MPLS_TC, "mpls_tc", NULL,
330 OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
331 OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
332 OFPUTIL_P_NXM_OF11_UP,
335 MFF_MPLS_BOS, "mpls_bos", NULL,
341 OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
342 OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
343 OFPUTIL_P_NXM_OXM_ANY,
352 MFF_IPV4_SRC, "ip_src", "nw_src",
353 MF_FIELD_SIZES(be32),
358 NXM_OF_IP_SRC, "NXM_OF_IP_SRC",
359 OXM_OF_IPV4_SRC, "OXM_OF_IPV4_SRC",
361 OFPUTIL_P_NXM_OF11_UP,
363 MFF_IPV4_DST, "ip_dst", "nw_dst",
364 MF_FIELD_SIZES(be32),
369 NXM_OF_IP_DST, "NXM_OF_IP_DST",
370 OXM_OF_IPV4_DST, "OXM_OF_IPV4_DST",
372 OFPUTIL_P_NXM_OF11_UP,
376 MFF_IPV6_SRC, "ipv6_src", NULL,
377 MF_FIELD_SIZES(ipv6),
382 NXM_NX_IPV6_SRC, "NXM_NX_IPV6_SRC",
383 OXM_OF_IPV6_SRC, "OXM_OF_IPV6_SRC",
384 OFPUTIL_P_NXM_OXM_ANY,
385 OFPUTIL_P_NXM_OXM_ANY,
387 MFF_IPV6_DST, "ipv6_dst", NULL,
388 MF_FIELD_SIZES(ipv6),
393 NXM_NX_IPV6_DST, "NXM_NX_IPV6_DST",
394 OXM_OF_IPV6_DST, "OXM_OF_IPV6_DST",
395 OFPUTIL_P_NXM_OXM_ANY,
396 OFPUTIL_P_NXM_OXM_ANY,
399 MFF_IPV6_LABEL, "ipv6_label", NULL,
405 NXM_NX_IPV6_LABEL, "NXM_NX_IPV6_LABEL",
406 OXM_OF_IPV6_FLABEL, "OXM_OF_IPV6_FLABEL",
407 OFPUTIL_P_NXM_OXM_ANY,
408 OFPUTIL_P_NXM_OXM_ANY,
412 MFF_IP_PROTO, "nw_proto", NULL,
418 NXM_OF_IP_PROTO, "NXM_OF_IP_PROTO",
419 OXM_OF_IP_PROTO, "OXM_OF_IP_PROTO",
423 MFF_IP_DSCP, "nw_tos", NULL,
429 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
430 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
431 OFPUTIL_P_ANY, /* Will be shifted for OXM. */
434 MFF_IP_DSCP_SHIFTED, "nw_tos_shifted", NULL,
440 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
441 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
442 OFPUTIL_P_ANY, /* Will be shifted for non-OXM. */
445 MFF_IP_ECN, "nw_ecn", NULL,
451 NXM_NX_IP_ECN, "NXM_NX_IP_ECN",
452 OXM_OF_IP_ECN, "OXM_OF_IP_ECN",
453 OFPUTIL_P_NXM_OXM_ANY,
456 MFF_IP_TTL, "nw_ttl", NULL,
462 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
463 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
464 OFPUTIL_P_NXM_OXM_ANY,
467 MFF_IP_FRAG, "ip_frag", NULL,
473 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
474 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
475 OFPUTIL_P_NXM_OXM_ANY,
476 OFPUTIL_P_NXM_OXM_ANY,
480 MFF_ARP_OP, "arp_op", NULL,
481 MF_FIELD_SIZES(be16),
486 NXM_OF_ARP_OP, "NXM_OF_ARP_OP",
487 OXM_OF_ARP_OP, "OXM_OF_ARP_OP",
491 MFF_ARP_SPA, "arp_spa", NULL,
492 MF_FIELD_SIZES(be32),
497 NXM_OF_ARP_SPA, "NXM_OF_ARP_SPA",
498 OXM_OF_ARP_SPA, "OXM_OF_ARP_SPA",
500 OFPUTIL_P_NXM_OF11_UP,
502 MFF_ARP_TPA, "arp_tpa", NULL,
503 MF_FIELD_SIZES(be32),
508 NXM_OF_ARP_TPA, "NXM_OF_ARP_TPA",
509 OXM_OF_ARP_TPA, "OXM_OF_ARP_TPA",
511 OFPUTIL_P_NXM_OF11_UP,
513 MFF_ARP_SHA, "arp_sha", NULL,
519 NXM_NX_ARP_SHA, "NXM_NX_ARP_SHA",
520 OXM_OF_ARP_SHA, "OXM_OF_ARP_SHA",
521 OFPUTIL_P_NXM_OXM_ANY,
522 OFPUTIL_P_NXM_OXM_ANY,
524 MFF_ARP_THA, "arp_tha", NULL,
530 NXM_NX_ARP_THA, "NXM_NX_ARP_THA",
531 OXM_OF_ARP_THA, "OXM_OF_ARP_THA",
532 OFPUTIL_P_NXM_OXM_ANY,
533 OFPUTIL_P_NXM_OXM_ANY,
541 MFF_TCP_SRC, "tcp_src", "tp_src",
542 MF_FIELD_SIZES(be16),
547 NXM_OF_TCP_SRC, "NXM_OF_TCP_SRC",
548 OXM_OF_TCP_SRC, "OXM_OF_TCP_SRC",
550 OFPUTIL_P_NXM_OXM_ANY,
552 MFF_TCP_DST, "tcp_dst", "tp_dst",
553 MF_FIELD_SIZES(be16),
558 NXM_OF_TCP_DST, "NXM_OF_TCP_DST",
559 OXM_OF_TCP_DST, "OXM_OF_TCP_DST",
561 OFPUTIL_P_NXM_OXM_ANY,
563 MFF_TCP_FLAGS, "tcp_flags", NULL,
569 NXM_NX_TCP_FLAGS, "NXM_NX_TCP_FLAGS",
570 NXM_NX_TCP_FLAGS, "NXM_NX_TCP_FLAGS",
571 OFPUTIL_P_NXM_OXM_ANY,
572 OFPUTIL_P_NXM_OXM_ANY,
576 MFF_UDP_SRC, "udp_src", NULL,
577 MF_FIELD_SIZES(be16),
582 NXM_OF_UDP_SRC, "NXM_OF_UDP_SRC",
583 OXM_OF_UDP_SRC, "OXM_OF_UDP_SRC",
585 OFPUTIL_P_NXM_OXM_ANY,
587 MFF_UDP_DST, "udp_dst", NULL,
588 MF_FIELD_SIZES(be16),
593 NXM_OF_UDP_DST, "NXM_OF_UDP_DST",
594 OXM_OF_UDP_DST, "OXM_OF_UDP_DST",
596 OFPUTIL_P_NXM_OXM_ANY,
600 MFF_SCTP_SRC, "sctp_src", NULL,
601 MF_FIELD_SIZES(be16),
606 OXM_OF_SCTP_SRC, "OXM_OF_SCTP_SRC",
607 OXM_OF_SCTP_SRC, "OXM_OF_SCTP_SRC",
608 OFPUTIL_P_NXM_OF11_UP,
609 OFPUTIL_P_NXM_OXM_ANY,
611 MFF_SCTP_DST, "sctp_dst", NULL,
612 MF_FIELD_SIZES(be16),
617 OXM_OF_SCTP_DST, "OXM_OF_SCTP_DST",
618 OXM_OF_SCTP_DST, "OXM_OF_SCTP_DST",
619 OFPUTIL_P_NXM_OF11_UP,
620 OFPUTIL_P_NXM_OXM_ANY,
624 MFF_ICMPV4_TYPE, "icmp_type", NULL,
630 NXM_OF_ICMP_TYPE, "NXM_OF_ICMP_TYPE",
631 OXM_OF_ICMPV4_TYPE, "OXM_OF_ICMPV4_TYPE",
635 MFF_ICMPV4_CODE, "icmp_code", NULL,
641 NXM_OF_ICMP_CODE, "NXM_OF_ICMP_CODE",
642 OXM_OF_ICMPV4_CODE, "OXM_OF_ICMPV4_CODE",
648 MFF_ICMPV6_TYPE, "icmpv6_type", NULL,
654 NXM_NX_ICMPV6_TYPE, "NXM_NX_ICMPV6_TYPE",
655 OXM_OF_ICMPV6_TYPE, "OXM_OF_ICMPV6_TYPE",
656 OFPUTIL_P_NXM_OXM_ANY,
659 MFF_ICMPV6_CODE, "icmpv6_code", NULL,
665 NXM_NX_ICMPV6_CODE, "NXM_NX_ICMPV6_CODE",
666 OXM_OF_ICMPV6_CODE, "OXM_OF_ICMPV6_CODE",
667 OFPUTIL_P_NXM_OXM_ANY,
676 MFF_ND_TARGET, "nd_target", NULL,
677 MF_FIELD_SIZES(ipv6),
682 NXM_NX_ND_TARGET, "NXM_NX_ND_TARGET",
683 OXM_OF_IPV6_ND_TARGET, "OXM_OF_IPV6_ND_TARGET",
684 OFPUTIL_P_NXM_OXM_ANY,
685 OFPUTIL_P_NXM_OXM_ANY,
687 MFF_ND_SLL, "nd_sll", NULL,
693 NXM_NX_ND_SLL, "NXM_NX_ND_SLL",
694 OXM_OF_IPV6_ND_SLL, "OXM_OF_IPV6_ND_SLL",
695 OFPUTIL_P_NXM_OXM_ANY,
696 OFPUTIL_P_NXM_OXM_ANY,
698 MFF_ND_TLL, "nd_tll", NULL,
704 NXM_NX_ND_TLL, "NXM_NX_ND_TLL",
705 OXM_OF_IPV6_ND_TLL, "OXM_OF_IPV6_ND_TLL",
706 OFPUTIL_P_NXM_OXM_ANY,
707 OFPUTIL_P_NXM_OXM_ANY,
711 /* Maps an NXM or OXM header value to an mf_field. */
713 struct hmap_node hmap_node; /* In 'all_fields' hmap. */
714 uint32_t header; /* NXM or OXM header value. */
715 const struct mf_field *mf;
718 /* Contains 'struct nxm_field's. */
719 static struct hmap all_fields;
721 /* Maps from an mf_field's 'name' or 'extra_name' to the mf_field. */
722 static struct shash mf_by_name;
724 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
725 * controller and so there's not much point in showing a lot of them. */
726 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
728 const struct mf_field *mf_from_nxm_header__(uint32_t header);
729 static void nxm_init(void);
731 /* Returns the field with the given 'id'. */
732 const struct mf_field *
733 mf_from_id(enum mf_field_id id)
735 ovs_assert((unsigned int) id < MFF_N_IDS);
736 return &mf_fields[id];
739 /* Returns the field with the given 'name', or a null pointer if no field has
741 const struct mf_field *
742 mf_from_name(const char *name)
745 return shash_find_data(&mf_by_name, name);
749 add_nxm_field(uint32_t header, const struct mf_field *mf)
753 f = xmalloc(sizeof *f);
754 hmap_insert(&all_fields, &f->hmap_node, hash_int(header, 0));
760 nxm_init_add_field(const struct mf_field *mf, uint32_t header)
763 ovs_assert(!mf_from_nxm_header__(header));
764 add_nxm_field(header, mf);
765 if (mf->maskable != MFM_NONE) {
766 add_nxm_field(NXM_MAKE_WILD_HEADER(header), mf);
776 hmap_init(&all_fields);
777 shash_init(&mf_by_name);
778 for (i = 0; i < MFF_N_IDS; i++) {
779 const struct mf_field *mf = &mf_fields[i];
781 ovs_assert(mf->id == i); /* Fields must be in the enum order. */
783 nxm_init_add_field(mf, mf->nxm_header);
784 if (mf->oxm_header != mf->nxm_header) {
785 nxm_init_add_field(mf, mf->oxm_header);
788 shash_add_once(&mf_by_name, mf->name, mf);
789 if (mf->extra_name) {
790 shash_add_once(&mf_by_name, mf->extra_name, mf);
798 static pthread_once_t once = PTHREAD_ONCE_INIT;
799 pthread_once(&once, nxm_do_init);
802 const struct mf_field *
803 mf_from_nxm_header(uint32_t header)
806 return mf_from_nxm_header__(header);
809 const struct mf_field *
810 mf_from_nxm_header__(uint32_t header)
812 const struct nxm_field *f;
814 HMAP_FOR_EACH_IN_BUCKET (f, hmap_node, hash_int(header, 0), &all_fields) {
815 if (f->header == header) {
823 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
824 * specifies at least one bit in the field.
826 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
827 * meets 'mf''s prerequisites. */
829 mf_is_all_wild(const struct mf_field *mf, const struct flow_wildcards *wc)
833 return !wc->masks.tunnel.ip_src;
835 return !wc->masks.tunnel.ip_dst;
840 return !wc->masks.tunnel.tun_id;
842 return !wc->masks.metadata;
844 case MFF_IN_PORT_OXM:
845 return !wc->masks.in_port.ofp_port;
846 case MFF_SKB_PRIORITY:
847 return !wc->masks.skb_priority;
849 return !wc->masks.pkt_mark;
851 return !wc->masks.regs[mf->id - MFF_REG0];
854 return eth_addr_is_zero(wc->masks.dl_src);
856 return eth_addr_is_zero(wc->masks.dl_dst);
858 return !wc->masks.dl_type;
862 return eth_addr_is_zero(wc->masks.arp_sha);
866 return eth_addr_is_zero(wc->masks.arp_tha);
869 return !wc->masks.vlan_tci;
871 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK));
873 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI));
874 case MFF_DL_VLAN_PCP:
876 return !(wc->masks.vlan_tci & htons(VLAN_PCP_MASK));
879 return !(wc->masks.mpls_lse & htonl(MPLS_LABEL_MASK));
881 return !(wc->masks.mpls_lse & htonl(MPLS_TC_MASK));
883 return !(wc->masks.mpls_lse & htonl(MPLS_BOS_MASK));
886 return !wc->masks.nw_src;
888 return !wc->masks.nw_dst;
891 return ipv6_mask_is_any(&wc->masks.ipv6_src);
893 return ipv6_mask_is_any(&wc->masks.ipv6_dst);
896 return !wc->masks.ipv6_label;
899 return !wc->masks.nw_proto;
901 case MFF_IP_DSCP_SHIFTED:
902 return !(wc->masks.nw_tos & IP_DSCP_MASK);
904 return !(wc->masks.nw_tos & IP_ECN_MASK);
906 return !wc->masks.nw_ttl;
909 return ipv6_mask_is_any(&wc->masks.nd_target);
912 return !(wc->masks.nw_frag & FLOW_NW_FRAG_MASK);
915 return !wc->masks.nw_proto;
917 return !wc->masks.nw_src;
919 return !wc->masks.nw_dst;
924 case MFF_ICMPV4_TYPE:
925 case MFF_ICMPV6_TYPE:
926 return !wc->masks.tp_src;
930 case MFF_ICMPV4_CODE:
931 case MFF_ICMPV6_CODE:
932 return !wc->masks.tp_dst;
934 return !wc->masks.tcp_flags;
942 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
943 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
944 * purposes, or to 0 if it is wildcarded.
946 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
947 * meets 'mf''s prerequisites. */
949 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
950 union mf_value *mask)
952 mf_get_value(mf, &wc->masks, mask);
955 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
956 * if the mask is valid, false otherwise. */
958 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
960 switch (mf->maskable) {
962 return (is_all_zeros((const uint8_t *) mask, mf->n_bytes) ||
963 is_all_ones((const uint8_t *) mask, mf->n_bytes));
973 is_icmpv4(const struct flow *flow)
975 return (flow->dl_type == htons(ETH_TYPE_IP)
976 && flow->nw_proto == IPPROTO_ICMP);
980 is_icmpv6(const struct flow *flow)
982 return (flow->dl_type == htons(ETH_TYPE_IPV6)
983 && flow->nw_proto == IPPROTO_ICMPV6);
986 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
988 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
990 switch (mf->prereqs) {
995 return (flow->dl_type == htons(ETH_TYPE_ARP) ||
996 flow->dl_type == htons(ETH_TYPE_RARP));
998 return flow->dl_type == htons(ETH_TYPE_IP);
1000 return flow->dl_type == htons(ETH_TYPE_IPV6);
1002 return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
1004 return eth_type_mpls(flow->dl_type);
1006 return is_ip_any(flow);
1009 return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP;
1011 return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP;
1013 return is_ip_any(flow) && flow->nw_proto == IPPROTO_SCTP;
1015 return is_icmpv4(flow);
1017 return is_icmpv6(flow);
1020 return (is_icmpv6(flow)
1021 && flow->tp_dst == htons(0)
1022 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
1023 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
1024 case MFP_ND_SOLICIT:
1025 return (is_icmpv6(flow)
1026 && flow->tp_dst == htons(0)
1027 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
1029 return (is_icmpv6(flow)
1030 && flow->tp_dst == htons(0)
1031 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
1037 /* Set field and it's prerequisities in the mask.
1038 * This is only ever called for writeable 'mf's, but we do not make the
1039 * distinction here. */
1041 mf_mask_field_and_prereqs(const struct mf_field *mf, struct flow *mask)
1043 static const union mf_value exact_match_mask = MF_EXACT_MASK_INITIALIZER;
1045 mf_set_flow_value(mf, &exact_match_mask, mask);
1047 switch (mf->prereqs) {
1049 case MFP_ND_SOLICIT:
1051 mask->tp_src = OVS_BE16_MAX;
1052 mask->tp_dst = OVS_BE16_MAX;
1059 mask->nw_proto = 0xff;
1066 mask->dl_type = OVS_BE16_MAX;
1069 mask->vlan_tci |= htons(VLAN_CFI);
1077 /* Returns true if 'value' may be a valid value *as part of a masked match*,
1080 * A value is not rejected just because it is not valid for the field in
1081 * question, but only if it doesn't make sense to test the bits in question at
1082 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
1083 * without the VLAN_CFI bit being set, but we can't reject those values because
1084 * it is still legitimate to test just for those bits (see the documentation
1085 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
1086 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
1088 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
1099 case MFF_SKB_PRIORITY:
1122 case MFF_ICMPV4_TYPE:
1123 case MFF_ICMPV4_CODE:
1124 case MFF_ICMPV6_TYPE:
1125 case MFF_ICMPV6_CODE:
1131 case MFF_IN_PORT_OXM: {
1133 return !ofputil_port_from_ofp11(value->be32, &port);
1137 return !(value->u8 & ~IP_DSCP_MASK);
1138 case MFF_IP_DSCP_SHIFTED:
1139 return !(value->u8 & (~IP_DSCP_MASK >> 2));
1141 return !(value->u8 & ~IP_ECN_MASK);
1143 return !(value->u8 & ~FLOW_NW_FRAG_MASK);
1145 return !(value->be16 & ~htons(0x0fff));
1148 return !(value->be16 & htons(0xff00));
1151 return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
1153 return !(value->be16 & htons(VLAN_PCP_MASK));
1155 case MFF_DL_VLAN_PCP:
1157 return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
1159 case MFF_IPV6_LABEL:
1160 return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
1162 case MFF_MPLS_LABEL:
1163 return !(value->be32 & ~htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT));
1166 return !(value->u8 & ~(MPLS_TC_MASK >> MPLS_TC_SHIFT));
1169 return !(value->u8 & ~(MPLS_BOS_MASK >> MPLS_BOS_SHIFT));
1177 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
1178 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
1180 mf_get_value(const struct mf_field *mf, const struct flow *flow,
1181 union mf_value *value)
1185 value->be64 = flow->tunnel.tun_id;
1188 value->be32 = flow->tunnel.ip_src;
1191 value->be32 = flow->tunnel.ip_dst;
1194 value->be16 = htons(flow->tunnel.flags);
1197 value->u8 = flow->tunnel.ip_ttl;
1200 value->u8 = flow->tunnel.ip_tos;
1204 value->be64 = flow->metadata;
1208 value->be16 = htons(ofp_to_u16(flow->in_port.ofp_port));
1210 case MFF_IN_PORT_OXM:
1211 value->be32 = ofputil_port_to_ofp11(flow->in_port.ofp_port);
1214 case MFF_SKB_PRIORITY:
1215 value->be32 = htonl(flow->skb_priority);
1219 value->be32 = htonl(flow->pkt_mark);
1223 value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
1227 memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
1231 memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
1235 value->be16 = flow->dl_type;
1239 value->be16 = flow->vlan_tci;
1243 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
1246 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
1249 case MFF_DL_VLAN_PCP:
1251 value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
1254 case MFF_MPLS_LABEL:
1255 value->be32 = htonl(mpls_lse_to_label(flow->mpls_lse));
1259 value->u8 = mpls_lse_to_tc(flow->mpls_lse);
1263 value->u8 = mpls_lse_to_bos(flow->mpls_lse);
1267 value->be32 = flow->nw_src;
1271 value->be32 = flow->nw_dst;
1275 value->ipv6 = flow->ipv6_src;
1279 value->ipv6 = flow->ipv6_dst;
1282 case MFF_IPV6_LABEL:
1283 value->be32 = flow->ipv6_label;
1287 value->u8 = flow->nw_proto;
1291 value->u8 = flow->nw_tos & IP_DSCP_MASK;
1294 case MFF_IP_DSCP_SHIFTED:
1295 value->u8 = flow->nw_tos >> 2;
1299 value->u8 = flow->nw_tos & IP_ECN_MASK;
1303 value->u8 = flow->nw_ttl;
1307 value->u8 = flow->nw_frag;
1311 value->be16 = htons(flow->nw_proto);
1315 value->be32 = flow->nw_src;
1319 value->be32 = flow->nw_dst;
1324 memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
1329 memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
1335 value->be16 = flow->tp_src;
1341 value->be16 = flow->tp_dst;
1345 value->be16 = flow->tcp_flags;
1348 case MFF_ICMPV4_TYPE:
1349 case MFF_ICMPV6_TYPE:
1350 value->u8 = ntohs(flow->tp_src);
1353 case MFF_ICMPV4_CODE:
1354 case MFF_ICMPV6_CODE:
1355 value->u8 = ntohs(flow->tp_dst);
1359 value->ipv6 = flow->nd_target;
1368 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1369 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1372 mf_set_value(const struct mf_field *mf,
1373 const union mf_value *value, struct match *match)
1377 match_set_tun_id(match, value->be64);
1380 match_set_tun_src(match, value->be32);
1383 match_set_tun_dst(match, value->be32);
1386 match_set_tun_flags(match, ntohs(value->be16));
1389 match_set_tun_tos(match, value->u8);
1392 match_set_tun_ttl(match, value->u8);
1396 match_set_metadata(match, value->be64);
1400 match_set_in_port(match, u16_to_ofp(ntohs(value->be16)));
1403 case MFF_IN_PORT_OXM: {
1405 ofputil_port_from_ofp11(value->be32, &port);
1406 match_set_in_port(match, port);
1410 case MFF_SKB_PRIORITY:
1411 match_set_skb_priority(match, ntohl(value->be32));
1415 match_set_pkt_mark(match, ntohl(value->be32));
1419 match_set_reg(match, mf->id - MFF_REG0, ntohl(value->be32));
1423 match_set_dl_src(match, value->mac);
1427 match_set_dl_dst(match, value->mac);
1431 match_set_dl_type(match, value->be16);
1435 match_set_dl_tci(match, value->be16);
1439 match_set_dl_vlan(match, value->be16);
1442 match_set_vlan_vid(match, value->be16);
1445 case MFF_DL_VLAN_PCP:
1447 match_set_dl_vlan_pcp(match, value->u8);
1450 case MFF_MPLS_LABEL:
1451 match_set_mpls_label(match, value->be32);
1455 match_set_mpls_tc(match, value->u8);
1459 match_set_mpls_bos(match, value->u8);
1463 match_set_nw_src(match, value->be32);
1467 match_set_nw_dst(match, value->be32);
1471 match_set_ipv6_src(match, &value->ipv6);
1475 match_set_ipv6_dst(match, &value->ipv6);
1478 case MFF_IPV6_LABEL:
1479 match_set_ipv6_label(match, value->be32);
1483 match_set_nw_proto(match, value->u8);
1487 match_set_nw_dscp(match, value->u8);
1490 case MFF_IP_DSCP_SHIFTED:
1491 match_set_nw_dscp(match, value->u8 << 2);
1495 match_set_nw_ecn(match, value->u8);
1499 match_set_nw_ttl(match, value->u8);
1503 match_set_nw_frag(match, value->u8);
1507 match_set_nw_proto(match, ntohs(value->be16));
1511 match_set_nw_src(match, value->be32);
1515 match_set_nw_dst(match, value->be32);
1520 match_set_arp_sha(match, value->mac);
1525 match_set_arp_tha(match, value->mac);
1531 match_set_tp_src(match, value->be16);
1537 match_set_tp_dst(match, value->be16);
1541 match_set_tcp_flags(match, value->be16);
1544 case MFF_ICMPV4_TYPE:
1545 case MFF_ICMPV6_TYPE:
1546 match_set_icmp_type(match, value->u8);
1549 case MFF_ICMPV4_CODE:
1550 case MFF_ICMPV6_CODE:
1551 match_set_icmp_code(match, value->u8);
1555 match_set_nd_target(match, &value->ipv6);
1564 /* Unwildcard 'mask' member field described by 'mf'. The caller is
1565 * responsible for ensuring that 'mask' meets 'mf''s prerequisites. */
1567 mf_mask_field(const struct mf_field *mf, struct flow *mask)
1569 static const union mf_value exact_match_mask = MF_EXACT_MASK_INITIALIZER;
1571 /* For MFF_DL_VLAN, we cannot send a all 1's to flow_set_dl_vlan()
1572 * as that will be considered as OFP10_VLAN_NONE. So consider it as a
1573 * special case. For the rest, calling mf_set_flow_value() is good
1575 if (mf->id == MFF_DL_VLAN) {
1576 flow_set_dl_vlan(mask, htons(VLAN_VID_MASK));
1578 mf_set_flow_value(mf, &exact_match_mask, mask);
1582 /* Sets 'flow' member field described by 'mf' to 'value'. The caller is
1583 * responsible for ensuring that 'flow' meets 'mf''s prerequisites.*/
1585 mf_set_flow_value(const struct mf_field *mf,
1586 const union mf_value *value, struct flow *flow)
1590 flow->tunnel.tun_id = value->be64;
1593 flow->tunnel.ip_src = value->be32;
1596 flow->tunnel.ip_dst = value->be32;
1599 flow->tunnel.flags = ntohs(value->be16);
1602 flow->tunnel.ip_tos = value->u8;
1605 flow->tunnel.ip_ttl = value->u8;
1609 flow->metadata = value->be64;
1613 flow->in_port.ofp_port = u16_to_ofp(ntohs(value->be16));
1616 case MFF_IN_PORT_OXM: {
1618 ofputil_port_from_ofp11(value->be32, &port);
1619 flow->in_port.ofp_port = port;
1623 case MFF_SKB_PRIORITY:
1624 flow->skb_priority = ntohl(value->be32);
1628 flow->pkt_mark = ntohl(value->be32);
1632 flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1636 memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
1640 memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
1644 flow->dl_type = value->be16;
1648 flow->vlan_tci = value->be16;
1652 flow_set_dl_vlan(flow, value->be16);
1655 flow_set_vlan_vid(flow, value->be16);
1658 case MFF_DL_VLAN_PCP:
1660 flow_set_vlan_pcp(flow, value->u8);
1663 case MFF_MPLS_LABEL:
1664 flow_set_mpls_label(flow, value->be32);
1668 flow_set_mpls_tc(flow, value->u8);
1672 flow_set_mpls_bos(flow, value->u8);
1676 flow->nw_src = value->be32;
1680 flow->nw_dst = value->be32;
1684 flow->ipv6_src = value->ipv6;
1688 flow->ipv6_dst = value->ipv6;
1691 case MFF_IPV6_LABEL:
1692 flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1696 flow->nw_proto = value->u8;
1700 flow->nw_tos &= ~IP_DSCP_MASK;
1701 flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1704 case MFF_IP_DSCP_SHIFTED:
1705 flow->nw_tos &= ~IP_DSCP_MASK;
1706 flow->nw_tos |= value->u8 << 2;
1710 flow->nw_tos &= ~IP_ECN_MASK;
1711 flow->nw_tos |= value->u8 & IP_ECN_MASK;
1715 flow->nw_ttl = value->u8;
1719 flow->nw_frag &= value->u8;
1723 flow->nw_proto = ntohs(value->be16);
1727 flow->nw_src = value->be32;
1731 flow->nw_dst = value->be32;
1736 memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1741 memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1747 flow->tp_src = value->be16;
1753 flow->tp_dst = value->be16;
1757 flow->tcp_flags = value->be16;
1760 case MFF_ICMPV4_TYPE:
1761 case MFF_ICMPV6_TYPE:
1762 flow->tp_src = htons(value->u8);
1765 case MFF_ICMPV4_CODE:
1766 case MFF_ICMPV6_CODE:
1767 flow->tp_dst = htons(value->u8);
1771 flow->nd_target = value->ipv6;
1780 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1782 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1785 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1787 union mf_value value;
1789 mf_get_value(mf, flow, &value);
1790 return is_all_zeros((const uint8_t *) &value, mf->n_bytes);
1793 /* Makes 'match' wildcard field 'mf'.
1795 * The caller is responsible for ensuring that 'match' meets 'mf''s
1798 mf_set_wild(const struct mf_field *mf, struct match *match)
1802 match_set_tun_id_masked(match, htonll(0), htonll(0));
1805 match_set_tun_src_masked(match, htonl(0), htonl(0));
1808 match_set_tun_dst_masked(match, htonl(0), htonl(0));
1811 match_set_tun_flags_masked(match, 0, 0);
1814 match_set_tun_tos_masked(match, 0, 0);
1817 match_set_tun_ttl_masked(match, 0, 0);
1821 match_set_metadata_masked(match, htonll(0), htonll(0));
1825 case MFF_IN_PORT_OXM:
1826 match->flow.in_port.ofp_port = 0;
1827 match->wc.masks.in_port.ofp_port = 0;
1830 case MFF_SKB_PRIORITY:
1831 match->flow.skb_priority = 0;
1832 match->wc.masks.skb_priority = 0;
1836 match->flow.pkt_mark = 0;
1837 match->wc.masks.pkt_mark = 0;
1841 match_set_reg_masked(match, mf->id - MFF_REG0, 0, 0);
1845 memset(match->flow.dl_src, 0, ETH_ADDR_LEN);
1846 memset(match->wc.masks.dl_src, 0, ETH_ADDR_LEN);
1850 memset(match->flow.dl_dst, 0, ETH_ADDR_LEN);
1851 memset(match->wc.masks.dl_dst, 0, ETH_ADDR_LEN);
1855 match->flow.dl_type = htons(0);
1856 match->wc.masks.dl_type = htons(0);
1860 match_set_dl_tci_masked(match, htons(0), htons(0));
1865 match_set_any_vid(match);
1868 case MFF_DL_VLAN_PCP:
1870 match_set_any_pcp(match);
1873 case MFF_MPLS_LABEL:
1874 match_set_any_mpls_label(match);
1878 match_set_any_mpls_tc(match);
1882 match_set_any_mpls_bos(match);
1887 match_set_nw_src_masked(match, htonl(0), htonl(0));
1892 match_set_nw_dst_masked(match, htonl(0), htonl(0));
1896 memset(&match->wc.masks.ipv6_src, 0, sizeof match->wc.masks.ipv6_src);
1897 memset(&match->flow.ipv6_src, 0, sizeof match->flow.ipv6_src);
1901 memset(&match->wc.masks.ipv6_dst, 0, sizeof match->wc.masks.ipv6_dst);
1902 memset(&match->flow.ipv6_dst, 0, sizeof match->flow.ipv6_dst);
1905 case MFF_IPV6_LABEL:
1906 match->wc.masks.ipv6_label = htonl(0);
1907 match->flow.ipv6_label = htonl(0);
1911 match->wc.masks.nw_proto = 0;
1912 match->flow.nw_proto = 0;
1916 case MFF_IP_DSCP_SHIFTED:
1917 match->wc.masks.nw_tos &= ~IP_DSCP_MASK;
1918 match->flow.nw_tos &= ~IP_DSCP_MASK;
1922 match->wc.masks.nw_tos &= ~IP_ECN_MASK;
1923 match->flow.nw_tos &= ~IP_ECN_MASK;
1927 match->wc.masks.nw_ttl = 0;
1928 match->flow.nw_ttl = 0;
1932 match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
1933 match->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1937 match->wc.masks.nw_proto = 0;
1938 match->flow.nw_proto = 0;
1943 memset(match->flow.arp_sha, 0, ETH_ADDR_LEN);
1944 memset(match->wc.masks.arp_sha, 0, ETH_ADDR_LEN);
1949 memset(match->flow.arp_tha, 0, ETH_ADDR_LEN);
1950 memset(match->wc.masks.arp_tha, 0, ETH_ADDR_LEN);
1956 case MFF_ICMPV4_TYPE:
1957 case MFF_ICMPV6_TYPE:
1958 match->wc.masks.tp_src = htons(0);
1959 match->flow.tp_src = htons(0);
1965 case MFF_ICMPV4_CODE:
1966 case MFF_ICMPV6_CODE:
1967 match->wc.masks.tp_dst = htons(0);
1968 match->flow.tp_dst = htons(0);
1972 match->wc.masks.tcp_flags = htons(0);
1973 match->flow.tcp_flags = htons(0);
1977 memset(&match->wc.masks.nd_target, 0,
1978 sizeof match->wc.masks.nd_target);
1979 memset(&match->flow.nd_target, 0, sizeof match->flow.nd_target);
1988 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
1989 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1990 * with a 1-bit indicating that the corresponding value bit must match and a
1991 * 0-bit indicating a don't-care.
1993 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1994 * mf_set_value(mf, value, match). If 'mask' points to all-0-bits, then this
1995 * call is equivalent to mf_set_wild(mf, match).
1997 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
1998 * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
1999 enum ofputil_protocol
2000 mf_set(const struct mf_field *mf,
2001 const union mf_value *value, const union mf_value *mask,
2002 struct match *match)
2004 if (!mask || is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2005 mf_set_value(mf, value, match);
2006 return mf->usable_protocols;
2007 } else if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2008 mf_set_wild(mf, match);
2009 return OFPUTIL_P_ANY;
2014 case MFF_IN_PORT_OXM:
2015 case MFF_SKB_PRIORITY:
2018 case MFF_DL_VLAN_PCP:
2020 case MFF_MPLS_LABEL:
2026 case MFF_IP_DSCP_SHIFTED:
2029 case MFF_ICMPV4_TYPE:
2030 case MFF_ICMPV4_CODE:
2031 case MFF_ICMPV6_TYPE:
2032 case MFF_ICMPV6_CODE:
2033 return OFPUTIL_P_NONE;
2036 match_set_tun_id_masked(match, value->be64, mask->be64);
2039 match_set_tun_src_masked(match, value->be32, mask->be32);
2042 match_set_tun_dst_masked(match, value->be32, mask->be32);
2045 match_set_tun_flags_masked(match, ntohs(value->be16), ntohs(mask->be16));
2048 match_set_tun_ttl_masked(match, value->u8, mask->u8);
2051 match_set_tun_tos_masked(match, value->u8, mask->u8);
2055 match_set_metadata_masked(match, value->be64, mask->be64);
2059 match_set_reg_masked(match, mf->id - MFF_REG0,
2060 ntohl(value->be32), ntohl(mask->be32));
2064 match_set_pkt_mark_masked(match, ntohl(value->be32),
2069 match_set_dl_dst_masked(match, value->mac, mask->mac);
2073 match_set_dl_src_masked(match, value->mac, mask->mac);
2078 match_set_arp_sha_masked(match, value->mac, mask->mac);
2083 match_set_arp_tha_masked(match, value->mac, mask->mac);
2087 match_set_dl_tci_masked(match, value->be16, mask->be16);
2091 match_set_vlan_vid_masked(match, value->be16, mask->be16);
2095 match_set_nw_src_masked(match, value->be32, mask->be32);
2099 match_set_nw_dst_masked(match, value->be32, mask->be32);
2103 match_set_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
2107 match_set_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
2110 case MFF_IPV6_LABEL:
2111 if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
2112 mf_set_value(mf, value, match);
2114 match_set_ipv6_label_masked(match, value->be32, mask->be32);
2119 match_set_nd_target_masked(match, &value->ipv6, &mask->ipv6);
2123 match_set_nw_frag_masked(match, value->u8, mask->u8);
2127 match_set_nw_src_masked(match, value->be32, mask->be32);
2131 match_set_nw_dst_masked(match, value->be32, mask->be32);
2137 match_set_tp_src_masked(match, value->be16, mask->be16);
2143 match_set_tp_dst_masked(match, value->be16, mask->be16);
2147 match_set_tcp_flags_masked(match, value->be16, mask->be16);
2155 return mf->usable_protocols_bitwise;
2158 return ip_is_cidr(mask->be32) ? mf->usable_protocols :
2159 mf->usable_protocols_bitwise;
2163 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
2167 VLOG_WARN_RL(&rl, "unknown %s field", type);
2168 return OFPERR_OFPBAC_BAD_SET_TYPE;
2169 } else if (!sf->n_bits) {
2170 VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
2171 return OFPERR_OFPBAC_BAD_SET_LEN;
2172 } else if (sf->ofs >= sf->field->n_bits) {
2173 VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
2174 sf->ofs, sf->field->n_bits, type, sf->field->name);
2175 return OFPERR_OFPBAC_BAD_SET_LEN;
2176 } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
2177 VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
2178 "of %s field %s", sf->ofs, sf->n_bits,
2179 sf->field->n_bits, type, sf->field->name);
2180 return OFPERR_OFPBAC_BAD_SET_LEN;
2181 } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
2182 VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
2183 type, sf->field->name);
2184 return OFPERR_OFPBAC_MATCH_INCONSISTENT;
2190 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
2191 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
2194 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
2196 return mf_check__(sf, flow, "source");
2199 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
2200 * if so, otherwise an OpenFlow error code (e.g. as returned by
2203 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
2205 int error = mf_check__(sf, flow, "destination");
2206 if (!error && !sf->field->writable) {
2207 VLOG_WARN_RL(&rl, "destination field %s is not writable",
2209 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
2214 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
2215 * 'value' and 'mask', respectively. */
2217 mf_get(const struct mf_field *mf, const struct match *match,
2218 union mf_value *value, union mf_value *mask)
2220 mf_get_value(mf, &match->flow, value);
2221 mf_get_mask(mf, &match->wc, mask);
2224 /* Assigns a random value for field 'mf' to 'value'. */
2226 mf_random_value(const struct mf_field *mf, union mf_value *value)
2228 random_bytes(value, mf->n_bytes);
2240 case MFF_SKB_PRIORITY:
2262 case MFF_ICMPV4_TYPE:
2263 case MFF_ICMPV4_CODE:
2264 case MFF_ICMPV6_TYPE:
2265 case MFF_ICMPV6_CODE:
2272 value->be16 &= htons(0x0fff);
2275 case MFF_IN_PORT_OXM:
2276 value->be32 = ofputil_port_to_ofp11(u16_to_ofp(ntohs(value->be16)));
2279 case MFF_IPV6_LABEL:
2280 value->be32 &= htonl(IPV6_LABEL_MASK);
2284 value->u8 &= IP_DSCP_MASK;
2287 case MFF_IP_DSCP_SHIFTED:
2288 value->u8 &= IP_DSCP_MASK >> 2;
2292 value->u8 &= IP_ECN_MASK;
2296 value->u8 &= FLOW_NW_FRAG_MASK;
2300 value->be16 &= htons(0xff);
2304 value->be16 &= htons(VLAN_VID_MASK);
2307 value->be16 &= htons(VLAN_VID_MASK | VLAN_CFI);
2310 case MFF_DL_VLAN_PCP:
2315 case MFF_MPLS_LABEL:
2316 value->be32 &= htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT);
2320 value->u8 &= MPLS_TC_MASK >> MPLS_TC_SHIFT;
2324 value->u8 &= MPLS_BOS_MASK >> MPLS_BOS_SHIFT;
2334 mf_from_integer_string(const struct mf_field *mf, const char *s,
2335 uint8_t *valuep, uint8_t *maskp)
2337 unsigned long long int integer, mask;
2342 integer = strtoull(s, &tail, 0);
2343 if (errno || (*tail != '\0' && *tail != '/')) {
2348 mask = strtoull(tail + 1, &tail, 0);
2349 if (errno || *tail != '\0') {
2356 for (i = mf->n_bytes - 1; i >= 0; i--) {
2357 valuep[i] = integer;
2363 return xasprintf("%s: value too large for %u-byte field %s",
2364 s, mf->n_bytes, mf->name);
2369 return xasprintf("%s: bad syntax for %s", s, mf->name);
2373 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
2374 uint8_t mac[ETH_ADDR_LEN],
2375 uint8_t mask[ETH_ADDR_LEN])
2379 ovs_assert(mf->n_bytes == ETH_ADDR_LEN);
2382 if (sscanf(s, ETH_ADDR_SCAN_FMT"%n", ETH_ADDR_SCAN_ARGS(mac), &n) > 0
2383 && n == strlen(s)) {
2384 memset(mask, 0xff, ETH_ADDR_LEN);
2389 if (sscanf(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT"%n",
2390 ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask), &n) > 0
2391 && n == strlen(s)) {
2395 return xasprintf("%s: invalid Ethernet address", s);
2399 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
2400 ovs_be32 *ip, ovs_be32 *mask)
2404 ovs_assert(mf->n_bytes == sizeof *ip);
2406 if (sscanf(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
2407 IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask)) == IP_SCAN_COUNT * 2) {
2409 } else if (sscanf(s, IP_SCAN_FMT"/%d",
2410 IP_SCAN_ARGS(ip), &prefix) == IP_SCAN_COUNT + 1) {
2411 if (prefix <= 0 || prefix > 32) {
2412 return xasprintf("%s: network prefix bits not between 1 and "
2414 } else if (prefix == 32) {
2415 *mask = OVS_BE32_MAX;
2417 *mask = htonl(((1u << prefix) - 1) << (32 - prefix));
2419 } else if (sscanf(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip)) == IP_SCAN_COUNT) {
2420 *mask = OVS_BE32_MAX;
2422 return xasprintf("%s: invalid IP address", s);
2428 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
2429 struct in6_addr *value, struct in6_addr *mask)
2431 char *str = xstrdup(s);
2432 char *save_ptr = NULL;
2433 const char *name, *netmask;
2436 ovs_assert(mf->n_bytes == sizeof *value);
2438 name = strtok_r(str, "/", &save_ptr);
2439 retval = name ? lookup_ipv6(name, value) : EINVAL;
2443 err = xasprintf("%s: could not convert to IPv6 address", str);
2449 netmask = strtok_r(NULL, "/", &save_ptr);
2451 if (inet_pton(AF_INET6, netmask, mask) != 1) {
2452 int prefix = atoi(netmask);
2453 if (prefix <= 0 || prefix > 128) {
2455 return xasprintf("%s: prefix bits not between 1 and 128", s);
2457 *mask = ipv6_create_mask(prefix);
2461 *mask = in6addr_exact;
2469 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
2470 ovs_be16 *valuep, ovs_be16 *maskp)
2474 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2476 if (ofputil_port_from_string(s, &port)) {
2477 *valuep = htons(ofp_to_u16(port));
2478 *maskp = OVS_BE16_MAX;
2481 return xasprintf("%s: port value out of range for %s", s, mf->name);
2485 mf_from_ofp_port_string32(const struct mf_field *mf, const char *s,
2486 ovs_be32 *valuep, ovs_be32 *maskp)
2490 ovs_assert(mf->n_bytes == sizeof(ovs_be32));
2491 if (ofputil_port_from_string(s, &port)) {
2492 *valuep = ofputil_port_to_ofp11(port);
2493 *maskp = OVS_BE32_MAX;
2496 return xasprintf("%s: port value out of range for %s", s, mf->name);
2499 struct frag_handling {
2505 static const struct frag_handling all_frags[] = {
2506 #define A FLOW_NW_FRAG_ANY
2507 #define L FLOW_NW_FRAG_LATER
2508 /* name mask value */
2511 { "first", A|L, A },
2512 { "later", A|L, A|L },
2517 { "not_later", L, 0 },
2524 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
2526 const struct frag_handling *h;
2528 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2529 if (!strcasecmp(s, h->name)) {
2530 /* We force the upper bits of the mask on to make mf_parse_value()
2531 * happy (otherwise it will never think it's an exact match.) */
2532 *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
2538 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2539 "\"yes\", \"first\", \"later\", \"not_first\"", s);
2543 parse_flow_tun_flags(const char *s_, const char *(*bit_to_string)(uint32_t),
2546 uint32_t result = 0;
2547 char *save_ptr = NULL;
2550 char *s = xstrdup(s_);
2552 for (name = strtok_r((char *)s, " |", &save_ptr); name;
2553 name = strtok_r(NULL, " |", &save_ptr)) {
2555 unsigned long long int flags;
2559 if (sscanf(name, "%lli%n", &flags, &n0) > 0 && n0 > 0) {
2563 name_len = strlen(name);
2564 for (bit = 1; bit; bit <<= 1) {
2565 const char *fname = bit_to_string(bit);
2572 len = strlen(fname);
2573 if (len != name_len) {
2576 if (!strncmp(name, fname, len)) {
2588 *res = htons(result);
2595 mf_from_tun_flags_string(const char *s, ovs_be16 *valuep, ovs_be16 *maskp)
2597 if (!parse_flow_tun_flags(s, flow_tun_flag_to_string, valuep)) {
2598 *maskp = OVS_BE16_MAX;
2602 return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
2603 "\"csum\", \"key\"", s);
2606 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2607 * NULL if successful, otherwise a malloc()'d string describing the error. */
2609 mf_parse(const struct mf_field *mf, const char *s,
2610 union mf_value *value, union mf_value *mask)
2614 if (!strcmp(s, "*")) {
2615 memset(value, 0, mf->n_bytes);
2616 memset(mask, 0, mf->n_bytes);
2620 switch (mf->string) {
2622 case MFS_HEXADECIMAL:
2623 error = mf_from_integer_string(mf, s,
2624 (uint8_t *) value, (uint8_t *) mask);
2628 error = mf_from_ethernet_string(mf, s, value->mac, mask->mac);
2632 error = mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
2636 error = mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
2640 error = mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
2643 case MFS_OFP_PORT_OXM:
2644 error = mf_from_ofp_port_string32(mf, s, &value->be32, &mask->be32);
2648 error = mf_from_frag_string(s, &value->u8, &mask->u8);
2652 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2653 error = mf_from_tun_flags_string(s, &value->be16, &mask->be16);
2660 if (!error && !mf_is_mask_valid(mf, mask)) {
2661 error = xasprintf("%s: invalid mask for field %s", s, mf->name);
2666 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2667 * successful, otherwise a malloc()'d string describing the error. */
2669 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2671 union mf_value mask;
2674 error = mf_parse(mf, s, value, &mask);
2679 if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2680 return xasprintf("%s: wildcards not allowed here", s);
2686 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2687 const uint8_t *maskp, struct ds *s)
2689 unsigned long long int integer;
2692 ovs_assert(mf->n_bytes <= 8);
2695 for (i = 0; i < mf->n_bytes; i++) {
2696 integer = (integer << 8) | valuep[i];
2698 if (mf->string == MFS_HEXADECIMAL) {
2699 ds_put_format(s, "%#llx", integer);
2701 ds_put_format(s, "%lld", integer);
2705 unsigned long long int mask;
2708 for (i = 0; i < mf->n_bytes; i++) {
2709 mask = (mask << 8) | maskp[i];
2712 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2713 * not sure that that a bit-mask written in decimal is ever easier to
2714 * understand than the same bit-mask written in hexadecimal. */
2715 ds_put_format(s, "/%#llx", mask);
2720 mf_format_frag_string(uint8_t value, uint8_t mask, struct ds *s)
2722 const struct frag_handling *h;
2724 mask &= FLOW_NW_FRAG_MASK;
2727 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2728 if (value == h->value && mask == h->mask) {
2729 ds_put_cstr(s, h->name);
2733 ds_put_cstr(s, "<error>");
2737 mf_format_tnl_flags_string(const ovs_be16 *valuep, struct ds *s)
2739 format_flags(s, flow_tun_flag_to_string, ntohs(*valuep), '|');
2742 /* Appends to 's' a string representation of field 'mf' whose value is in
2743 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2745 mf_format(const struct mf_field *mf,
2746 const union mf_value *value, const union mf_value *mask,
2750 if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2751 ds_put_cstr(s, "ANY");
2753 } else if (is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2758 switch (mf->string) {
2759 case MFS_OFP_PORT_OXM:
2762 ofputil_port_from_ofp11(value->be32, &port);
2763 ofputil_format_port(port, s);
2769 ofputil_format_port(u16_to_ofp(ntohs(value->be16)), s);
2774 case MFS_HEXADECIMAL:
2775 mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2779 eth_format_masked(value->mac, mask->mac, s);
2783 ip_format_masked(value->be32, mask ? mask->be32 : OVS_BE32_MAX, s);
2787 print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2791 mf_format_frag_string(value->u8, mask ? mask->u8 : UINT8_MAX, s);
2795 mf_format_tnl_flags_string(&value->be16, s);
2803 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2804 * least-significant bits in 'x'.
2807 mf_write_subfield_flow(const struct mf_subfield *sf,
2808 const union mf_subvalue *x, struct flow *flow)
2810 const struct mf_field *field = sf->field;
2811 union mf_value value;
2813 mf_get_value(field, flow, &value);
2814 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes,
2815 sf->ofs, sf->n_bits);
2816 mf_set_flow_value(field, &value, flow);
2819 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2820 * least-significant bits in 'x'.
2823 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2824 struct match *match)
2826 const struct mf_field *field = sf->field;
2827 union mf_value value, mask;
2829 mf_get(field, match, &value, &mask);
2830 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2831 bitwise_one ( &mask, field->n_bytes, sf->ofs, sf->n_bits);
2832 mf_set(field, &value, &mask, match);
2835 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2836 * reading 'flow', e.g. as checked by mf_check_src(). */
2838 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2839 union mf_subvalue *x)
2841 union mf_value value;
2843 mf_get_value(sf->field, flow, &value);
2845 memset(x, 0, sizeof *x);
2846 bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2851 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2852 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2855 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2857 union mf_value value;
2859 mf_get_value(sf->field, flow, &value);
2860 return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2863 /* Formats 'sf' into 's' in a format normally acceptable to
2864 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2865 * sf->field has no NXM name.) */
2867 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
2870 ds_put_cstr(s, "<unknown>");
2871 } else if (sf->field->nxm_name) {
2872 ds_put_cstr(s, sf->field->nxm_name);
2873 } else if (sf->field->nxm_header) {
2874 uint32_t header = sf->field->nxm_header;
2875 ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
2877 ds_put_cstr(s, sf->field->name);
2880 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
2881 ds_put_cstr(s, "[]");
2882 } else if (sf->n_bits == 1) {
2883 ds_put_format(s, "[%d]", sf->ofs);
2885 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
2889 static const struct mf_field *
2890 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
2894 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
2899 for (i = 0; i < MFF_N_IDS; i++) {
2900 const struct mf_field *mf = mf_from_id(i);
2903 && !strncmp(mf->nxm_name, name, name_len)
2904 && mf->nxm_name[name_len] == '\0') {
2908 && !strncmp(mf->oxm_name, name, name_len)
2909 && mf->oxm_name[name_len] == '\0') {
2917 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2918 * returns NULL and advances '*sp' to the first byte following the parsed
2919 * string. On failure, returns a malloc()'d error message, does not modify
2920 * '*sp', and does not properly initialize 'sf'.
2922 * The syntax parsed from '*sp' takes the form "header[start..end]" where
2923 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2924 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2925 * may both be omitted (the [] are still required) to indicate an entire
2927 char * WARN_UNUSED_RESULT
2928 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
2930 const struct mf_field *field;
2939 name_len = strcspn(s, "[");
2940 if (s[name_len] != '[') {
2941 return xasprintf("%s: missing [ looking for field name", *sp);
2944 field = mf_parse_subfield_name(name, name_len, &wild);
2946 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
2950 if (sscanf(s, "[%d..%d]", &start, &end) == 2) {
2951 /* Nothing to do. */
2952 } else if (sscanf(s, "[%d]", &start) == 1) {
2954 } else if (!strncmp(s, "[]", 2)) {
2956 end = field->n_bits - 1;
2958 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2959 "[<start>..<end>]", *sp);
2961 s = strchr(s, ']') + 1;
2964 return xasprintf("%s: starting bit %d is after ending bit %d",
2966 } else if (start >= field->n_bits) {
2967 return xasprintf("%s: starting bit %d is not valid because field is "
2968 "only %d bits wide", *sp, start, field->n_bits);
2969 } else if (end >= field->n_bits){
2970 return xasprintf("%s: ending bit %d is not valid because field is "
2971 "only %d bits wide", *sp, end, field->n_bits);
2976 sf->n_bits = end - start + 1;
2982 /* Parses a subfield from the entirety of 's' into 'sf'. Returns NULL if
2983 * successful, otherwise a malloc()'d string describing the error. The caller
2984 * is responsible for freeing the returned string.
2986 * The syntax parsed from 's' takes the form "header[start..end]" where
2987 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2988 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2989 * may both be omitted (the [] are still required) to indicate an entire
2991 char * WARN_UNUSED_RESULT
2992 mf_parse_subfield(struct mf_subfield *sf, const char *s)
2994 char *error = mf_parse_subfield__(sf, &s);
2995 if (!error && s[0]) {
2996 error = xstrdup("unexpected input following field syntax");
3002 mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s)
3006 for (i = 0; i < ARRAY_SIZE(subvalue->u8); i++) {
3007 if (subvalue->u8[i]) {
3008 ds_put_format(s, "0x%"PRIx8, subvalue->u8[i]);
3009 for (i++; i < ARRAY_SIZE(subvalue->u8); i++) {
3010 ds_put_format(s, "%02"PRIx8, subvalue->u8[i]);
3015 ds_put_char(s, '0');