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 FLOW_U32OFS(FIELD) \
41 offsetof(struct flow, FIELD) % 4 ? -1 : offsetof(struct flow, FIELD) / 4
43 #define MF_FIELD_SIZES(MEMBER) \
44 sizeof ((union mf_value *)0)->MEMBER, \
45 8 * sizeof ((union mf_value *)0)->MEMBER
47 extern const struct mf_field mf_fields[MFF_N_IDS]; /* Silence a warning. */
49 const struct mf_field mf_fields[MFF_N_IDS] = {
55 MFF_DP_HASH, "dp_hash", NULL,
61 NXM_NX_DP_HASH, "NXM_NX_DP_HASH",
62 NXM_NX_DP_HASH, "NXM_NX_DP_HASH",
63 OFPUTIL_P_NXM_OXM_ANY,
64 OFPUTIL_P_NXM_OXM_ANY,
67 MFF_RECIRC_ID, "recirc_id", NULL,
73 NXM_NX_RECIRC_ID, "NXM_NX_RECIRC_ID",
74 NXM_NX_RECIRC_ID, "NXM_NX_RECIRC_ID",
75 OFPUTIL_P_NXM_OXM_ANY,
76 OFPUTIL_P_NXM_OXM_ANY,
79 MFF_TUN_ID, "tun_id", "tunnel_id",
85 NXM_NX_TUN_ID, "NXM_NX_TUN_ID",
86 OXM_OF_TUNNEL_ID, "OXM_OF_TUNNEL_ID",
87 OFPUTIL_P_NXM_OXM_ANY,
88 OFPUTIL_P_NXM_OXM_ANY,
89 FLOW_U32OFS(tunnel.tun_id),
91 MFF_TUN_SRC, "tun_src", NULL,
97 NXM_NX_TUN_IPV4_SRC, "NXM_NX_TUN_IPV4_SRC",
98 NXM_NX_TUN_IPV4_SRC, "NXM_NX_TUN_IPV4_SRC",
99 OFPUTIL_P_NXM_OXM_ANY,
100 OFPUTIL_P_NXM_OXM_ANY,
101 FLOW_U32OFS(tunnel.ip_src),
103 MFF_TUN_DST, "tun_dst", NULL,
104 MF_FIELD_SIZES(be32),
109 NXM_NX_TUN_IPV4_DST, "NXM_NX_TUN_IPV4_DST",
110 NXM_NX_TUN_IPV4_DST, "NXM_NX_TUN_IPV4_DST",
111 OFPUTIL_P_NXM_OXM_ANY,
112 OFPUTIL_P_NXM_OXM_ANY,
113 FLOW_U32OFS(tunnel.ip_dst),
115 MFF_TUN_FLAGS, "tun_flags", NULL,
116 MF_FIELD_SIZES(be16),
127 MFF_TUN_TTL, "tun_ttl", NULL,
139 MFF_TUN_TOS, "tun_tos", NULL,
151 MFF_METADATA, "metadata", NULL,
152 MF_FIELD_SIZES(be64),
157 OXM_OF_METADATA, "OXM_OF_METADATA",
158 OXM_OF_METADATA, "OXM_OF_METADATA",
159 OFPUTIL_P_NXM_OF11_UP,
160 OFPUTIL_P_NXM_OF11_UP,
163 MFF_IN_PORT, "in_port", NULL,
164 MF_FIELD_SIZES(be16),
169 NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
170 NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
171 OFPUTIL_P_ANY, /* OF11+ via mapping to 32 bits. */
175 MFF_IN_PORT_OXM, "in_port_oxm", NULL,
176 MF_FIELD_SIZES(be32),
181 OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
182 OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
187 MFF_SKB_PRIORITY, "skb_priority", NULL,
188 MF_FIELD_SIZES(be32),
199 MFF_PKT_MARK, "pkt_mark", NULL,
200 MF_FIELD_SIZES(be32),
205 NXM_NX_PKT_MARK, "NXM_NX_PKT_MARK",
206 NXM_NX_PKT_MARK, "NXM_NX_PKT_MARK",
207 OFPUTIL_P_NXM_OXM_ANY,
208 OFPUTIL_P_NXM_OXM_ANY,
212 #define REGISTER(IDX) \
214 MFF_REG##IDX, "reg" #IDX, NULL, \
215 MF_FIELD_SIZES(be32), \
220 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
221 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
222 OFPUTIL_P_NXM_OXM_ANY, \
223 OFPUTIL_P_NXM_OXM_ANY, \
259 MFF_ETH_SRC, "eth_src", "dl_src",
265 NXM_OF_ETH_SRC, "NXM_OF_ETH_SRC",
266 OXM_OF_ETH_SRC, "OXM_OF_ETH_SRC",
268 OFPUTIL_P_NXM_OF11_UP, /* Bitwise masking only with NXM and OF11+! */
271 MFF_ETH_DST, "eth_dst", "dl_dst",
277 NXM_OF_ETH_DST, "NXM_OF_ETH_DST",
278 OXM_OF_ETH_DST, "OXM_OF_ETH_DST",
280 OFPUTIL_P_NXM_OF11_UP, /* Bitwise masking only with NXM and OF11+! */
283 MFF_ETH_TYPE, "eth_type", "dl_type",
284 MF_FIELD_SIZES(be16),
289 NXM_OF_ETH_TYPE, "NXM_OF_ETH_TYPE",
290 OXM_OF_ETH_TYPE, "OXM_OF_ETH_TYPE",
297 MFF_VLAN_TCI, "vlan_tci", NULL,
298 MF_FIELD_SIZES(be16),
303 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
304 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
306 OFPUTIL_P_NXM_OXM_ANY,
309 MFF_DL_VLAN, "dl_vlan", NULL,
310 sizeof(ovs_be16), 12,
318 OFPUTIL_P_NXM_OXM_ANY,
321 MFF_VLAN_VID, "vlan_vid", NULL,
322 sizeof(ovs_be16), 12,
327 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
328 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
330 OFPUTIL_P_NXM_OXM_ANY,
333 MFF_DL_VLAN_PCP, "dl_vlan_pcp", NULL,
341 OFPUTIL_P_ANY, /* Will be mapped to NXM and OXM. */
345 MFF_VLAN_PCP, "vlan_pcp", NULL,
351 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
352 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
353 OFPUTIL_P_ANY, /* Will be mapped to OF10 and NXM. */
362 MFF_MPLS_LABEL, "mpls_label", NULL,
368 OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
369 OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
370 OFPUTIL_P_NXM_OF11_UP,
374 MFF_MPLS_TC, "mpls_tc", NULL,
380 OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
381 OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
382 OFPUTIL_P_NXM_OF11_UP,
386 MFF_MPLS_BOS, "mpls_bos", NULL,
392 OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
393 OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
394 OFPUTIL_P_NXM_OXM_ANY,
404 MFF_IPV4_SRC, "ip_src", "nw_src",
405 MF_FIELD_SIZES(be32),
410 NXM_OF_IP_SRC, "NXM_OF_IP_SRC",
411 OXM_OF_IPV4_SRC, "OXM_OF_IPV4_SRC",
413 OFPUTIL_P_NXM_OF11_UP,
416 MFF_IPV4_DST, "ip_dst", "nw_dst",
417 MF_FIELD_SIZES(be32),
422 NXM_OF_IP_DST, "NXM_OF_IP_DST",
423 OXM_OF_IPV4_DST, "OXM_OF_IPV4_DST",
425 OFPUTIL_P_NXM_OF11_UP,
430 MFF_IPV6_SRC, "ipv6_src", NULL,
431 MF_FIELD_SIZES(ipv6),
436 NXM_NX_IPV6_SRC, "NXM_NX_IPV6_SRC",
437 OXM_OF_IPV6_SRC, "OXM_OF_IPV6_SRC",
438 OFPUTIL_P_NXM_OXM_ANY,
439 OFPUTIL_P_NXM_OXM_ANY,
440 FLOW_U32OFS(ipv6_src),
442 MFF_IPV6_DST, "ipv6_dst", NULL,
443 MF_FIELD_SIZES(ipv6),
448 NXM_NX_IPV6_DST, "NXM_NX_IPV6_DST",
449 OXM_OF_IPV6_DST, "OXM_OF_IPV6_DST",
450 OFPUTIL_P_NXM_OXM_ANY,
451 OFPUTIL_P_NXM_OXM_ANY,
452 FLOW_U32OFS(ipv6_dst),
455 MFF_IPV6_LABEL, "ipv6_label", NULL,
461 NXM_NX_IPV6_LABEL, "NXM_NX_IPV6_LABEL",
462 OXM_OF_IPV6_FLABEL, "OXM_OF_IPV6_FLABEL",
463 OFPUTIL_P_NXM_OXM_ANY,
464 OFPUTIL_P_NXM_OXM_ANY,
469 MFF_IP_PROTO, "nw_proto", "ip_proto",
475 NXM_OF_IP_PROTO, "NXM_OF_IP_PROTO",
476 OXM_OF_IP_PROTO, "OXM_OF_IP_PROTO",
481 MFF_IP_DSCP, "nw_tos", NULL,
487 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
488 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
489 OFPUTIL_P_ANY, /* Will be shifted for OXM. */
493 MFF_IP_DSCP_SHIFTED, "ip_dscp", NULL,
499 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
500 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
501 OFPUTIL_P_ANY, /* Will be shifted for non-OXM. */
505 MFF_IP_ECN, "nw_ecn", "ip_ecn",
511 NXM_NX_IP_ECN, "NXM_NX_IP_ECN",
512 OXM_OF_IP_ECN, "OXM_OF_IP_ECN",
513 OFPUTIL_P_NXM_OXM_ANY,
517 MFF_IP_TTL, "nw_ttl", NULL,
523 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
524 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
525 OFPUTIL_P_NXM_OXM_ANY,
529 MFF_IP_FRAG, "ip_frag", NULL,
535 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
536 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
537 OFPUTIL_P_NXM_OXM_ANY,
538 OFPUTIL_P_NXM_OXM_ANY,
543 MFF_ARP_OP, "arp_op", NULL,
544 MF_FIELD_SIZES(be16),
549 NXM_OF_ARP_OP, "NXM_OF_ARP_OP",
550 OXM_OF_ARP_OP, "OXM_OF_ARP_OP",
555 MFF_ARP_SPA, "arp_spa", NULL,
556 MF_FIELD_SIZES(be32),
561 NXM_OF_ARP_SPA, "NXM_OF_ARP_SPA",
562 OXM_OF_ARP_SPA, "OXM_OF_ARP_SPA",
564 OFPUTIL_P_NXM_OF11_UP,
567 MFF_ARP_TPA, "arp_tpa", NULL,
568 MF_FIELD_SIZES(be32),
573 NXM_OF_ARP_TPA, "NXM_OF_ARP_TPA",
574 OXM_OF_ARP_TPA, "OXM_OF_ARP_TPA",
576 OFPUTIL_P_NXM_OF11_UP,
579 MFF_ARP_SHA, "arp_sha", NULL,
585 NXM_NX_ARP_SHA, "NXM_NX_ARP_SHA",
586 OXM_OF_ARP_SHA, "OXM_OF_ARP_SHA",
587 OFPUTIL_P_NXM_OXM_ANY,
588 OFPUTIL_P_NXM_OXM_ANY,
591 MFF_ARP_THA, "arp_tha", NULL,
597 NXM_NX_ARP_THA, "NXM_NX_ARP_THA",
598 OXM_OF_ARP_THA, "OXM_OF_ARP_THA",
599 OFPUTIL_P_NXM_OXM_ANY,
600 OFPUTIL_P_NXM_OXM_ANY,
609 MFF_TCP_SRC, "tcp_src", "tp_src",
610 MF_FIELD_SIZES(be16),
615 NXM_OF_TCP_SRC, "NXM_OF_TCP_SRC",
616 OXM_OF_TCP_SRC, "OXM_OF_TCP_SRC",
618 OFPUTIL_P_NXM_OXM_ANY,
621 MFF_TCP_DST, "tcp_dst", "tp_dst",
622 MF_FIELD_SIZES(be16),
627 NXM_OF_TCP_DST, "NXM_OF_TCP_DST",
628 OXM_OF_TCP_DST, "OXM_OF_TCP_DST",
630 OFPUTIL_P_NXM_OXM_ANY,
633 MFF_TCP_FLAGS, "tcp_flags", NULL,
639 NXM_NX_TCP_FLAGS, "NXM_NX_TCP_FLAGS",
640 NXM_NX_TCP_FLAGS, "NXM_NX_TCP_FLAGS",
641 OFPUTIL_P_NXM_OXM_ANY,
642 OFPUTIL_P_NXM_OXM_ANY,
647 MFF_UDP_SRC, "udp_src", NULL,
648 MF_FIELD_SIZES(be16),
653 NXM_OF_UDP_SRC, "NXM_OF_UDP_SRC",
654 OXM_OF_UDP_SRC, "OXM_OF_UDP_SRC",
656 OFPUTIL_P_NXM_OXM_ANY,
659 MFF_UDP_DST, "udp_dst", NULL,
660 MF_FIELD_SIZES(be16),
665 NXM_OF_UDP_DST, "NXM_OF_UDP_DST",
666 OXM_OF_UDP_DST, "OXM_OF_UDP_DST",
668 OFPUTIL_P_NXM_OXM_ANY,
673 MFF_SCTP_SRC, "sctp_src", NULL,
674 MF_FIELD_SIZES(be16),
679 OXM_OF_SCTP_SRC, "OXM_OF_SCTP_SRC",
680 OXM_OF_SCTP_SRC, "OXM_OF_SCTP_SRC",
681 OFPUTIL_P_NXM_OF11_UP,
682 OFPUTIL_P_NXM_OXM_ANY,
685 MFF_SCTP_DST, "sctp_dst", NULL,
686 MF_FIELD_SIZES(be16),
691 OXM_OF_SCTP_DST, "OXM_OF_SCTP_DST",
692 OXM_OF_SCTP_DST, "OXM_OF_SCTP_DST",
693 OFPUTIL_P_NXM_OF11_UP,
694 OFPUTIL_P_NXM_OXM_ANY,
699 MFF_ICMPV4_TYPE, "icmp_type", NULL,
705 NXM_OF_ICMP_TYPE, "NXM_OF_ICMP_TYPE",
706 OXM_OF_ICMPV4_TYPE, "OXM_OF_ICMPV4_TYPE",
711 MFF_ICMPV4_CODE, "icmp_code", NULL,
717 NXM_OF_ICMP_CODE, "NXM_OF_ICMP_CODE",
718 OXM_OF_ICMPV4_CODE, "OXM_OF_ICMPV4_CODE",
725 MFF_ICMPV6_TYPE, "icmpv6_type", NULL,
731 NXM_NX_ICMPV6_TYPE, "NXM_NX_ICMPV6_TYPE",
732 OXM_OF_ICMPV6_TYPE, "OXM_OF_ICMPV6_TYPE",
733 OFPUTIL_P_NXM_OXM_ANY,
737 MFF_ICMPV6_CODE, "icmpv6_code", NULL,
743 NXM_NX_ICMPV6_CODE, "NXM_NX_ICMPV6_CODE",
744 OXM_OF_ICMPV6_CODE, "OXM_OF_ICMPV6_CODE",
745 OFPUTIL_P_NXM_OXM_ANY,
755 MFF_ND_TARGET, "nd_target", NULL,
756 MF_FIELD_SIZES(ipv6),
761 NXM_NX_ND_TARGET, "NXM_NX_ND_TARGET",
762 OXM_OF_IPV6_ND_TARGET, "OXM_OF_IPV6_ND_TARGET",
763 OFPUTIL_P_NXM_OXM_ANY,
764 OFPUTIL_P_NXM_OXM_ANY,
767 MFF_ND_SLL, "nd_sll", NULL,
773 NXM_NX_ND_SLL, "NXM_NX_ND_SLL",
774 OXM_OF_IPV6_ND_SLL, "OXM_OF_IPV6_ND_SLL",
775 OFPUTIL_P_NXM_OXM_ANY,
776 OFPUTIL_P_NXM_OXM_ANY,
779 MFF_ND_TLL, "nd_tll", NULL,
785 NXM_NX_ND_TLL, "NXM_NX_ND_TLL",
786 OXM_OF_IPV6_ND_TLL, "OXM_OF_IPV6_ND_TLL",
787 OFPUTIL_P_NXM_OXM_ANY,
788 OFPUTIL_P_NXM_OXM_ANY,
793 /* Maps an NXM or OXM header value to an mf_field. */
795 struct hmap_node hmap_node; /* In 'all_fields' hmap. */
796 uint32_t header; /* NXM or OXM header value. */
797 const struct mf_field *mf;
800 /* Contains 'struct nxm_field's. */
801 static struct hmap all_fields;
803 /* Maps from an mf_field's 'name' or 'extra_name' to the mf_field. */
804 static struct shash mf_by_name;
806 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
807 * controller and so there's not much point in showing a lot of them. */
808 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
810 const struct mf_field *mf_from_nxm_header__(uint32_t header);
811 static void nxm_init(void);
813 /* Returns the field with the given 'name', or a null pointer if no field has
815 const struct mf_field *
816 mf_from_name(const char *name)
819 return shash_find_data(&mf_by_name, name);
823 add_nxm_field(uint32_t header, const struct mf_field *mf)
827 f = xmalloc(sizeof *f);
828 hmap_insert(&all_fields, &f->hmap_node, hash_int(header, 0));
834 nxm_init_add_field(const struct mf_field *mf, uint32_t header)
837 ovs_assert(!mf_from_nxm_header__(header));
838 add_nxm_field(header, mf);
839 if (mf->maskable != MFM_NONE) {
840 add_nxm_field(NXM_MAKE_WILD_HEADER(header), mf);
850 hmap_init(&all_fields);
851 shash_init(&mf_by_name);
852 for (i = 0; i < MFF_N_IDS; i++) {
853 const struct mf_field *mf = &mf_fields[i];
855 ovs_assert(mf->id == i); /* Fields must be in the enum order. */
857 nxm_init_add_field(mf, mf->nxm_header);
858 if (mf->oxm_header != mf->nxm_header) {
859 nxm_init_add_field(mf, mf->oxm_header);
862 shash_add_once(&mf_by_name, mf->name, mf);
863 if (mf->extra_name) {
864 shash_add_once(&mf_by_name, mf->extra_name, mf);
872 static pthread_once_t once = PTHREAD_ONCE_INIT;
873 pthread_once(&once, nxm_do_init);
876 const struct mf_field *
877 mf_from_nxm_header(uint32_t header)
880 return mf_from_nxm_header__(header);
883 const struct mf_field *
884 mf_from_nxm_header__(uint32_t header)
886 const struct nxm_field *f;
888 HMAP_FOR_EACH_IN_BUCKET (f, hmap_node, hash_int(header, 0), &all_fields) {
889 if (f->header == header) {
897 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
898 * specifies at least one bit in the field.
900 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
901 * meets 'mf''s prerequisites. */
903 mf_is_all_wild(const struct mf_field *mf, const struct flow_wildcards *wc)
907 return !wc->masks.dp_hash;
909 return !wc->masks.recirc_id;
911 return !wc->masks.tunnel.ip_src;
913 return !wc->masks.tunnel.ip_dst;
918 return !wc->masks.tunnel.tun_id;
920 return !wc->masks.metadata;
922 case MFF_IN_PORT_OXM:
923 return !wc->masks.in_port.ofp_port;
924 case MFF_SKB_PRIORITY:
925 return !wc->masks.skb_priority;
927 return !wc->masks.pkt_mark;
929 return !wc->masks.regs[mf->id - MFF_REG0];
932 return eth_addr_is_zero(wc->masks.dl_src);
934 return eth_addr_is_zero(wc->masks.dl_dst);
936 return !wc->masks.dl_type;
940 return eth_addr_is_zero(wc->masks.arp_sha);
944 return eth_addr_is_zero(wc->masks.arp_tha);
947 return !wc->masks.vlan_tci;
949 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK));
951 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI));
952 case MFF_DL_VLAN_PCP:
954 return !(wc->masks.vlan_tci & htons(VLAN_PCP_MASK));
957 return !(wc->masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK));
959 return !(wc->masks.mpls_lse[1] & htonl(MPLS_TC_MASK));
961 return !(wc->masks.mpls_lse[2] & htonl(MPLS_BOS_MASK));
964 return !wc->masks.nw_src;
966 return !wc->masks.nw_dst;
969 return ipv6_mask_is_any(&wc->masks.ipv6_src);
971 return ipv6_mask_is_any(&wc->masks.ipv6_dst);
974 return !wc->masks.ipv6_label;
977 return !wc->masks.nw_proto;
979 case MFF_IP_DSCP_SHIFTED:
980 return !(wc->masks.nw_tos & IP_DSCP_MASK);
982 return !(wc->masks.nw_tos & IP_ECN_MASK);
984 return !wc->masks.nw_ttl;
987 return ipv6_mask_is_any(&wc->masks.nd_target);
990 return !(wc->masks.nw_frag & FLOW_NW_FRAG_MASK);
993 return !wc->masks.nw_proto;
995 return !wc->masks.nw_src;
997 return !wc->masks.nw_dst;
1002 case MFF_ICMPV4_TYPE:
1003 case MFF_ICMPV6_TYPE:
1004 return !wc->masks.tp_src;
1008 case MFF_ICMPV4_CODE:
1009 case MFF_ICMPV6_CODE:
1010 return !wc->masks.tp_dst;
1012 return !wc->masks.tcp_flags;
1020 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
1021 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
1022 * purposes, or to 0 if it is wildcarded.
1024 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
1025 * meets 'mf''s prerequisites. */
1027 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
1028 union mf_value *mask)
1030 mf_get_value(mf, &wc->masks, mask);
1033 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
1034 * if the mask is valid, false otherwise. */
1036 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
1038 switch (mf->maskable) {
1040 return (is_all_zeros((const uint8_t *) mask, mf->n_bytes) ||
1041 is_all_ones((const uint8_t *) mask, mf->n_bytes));
1050 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
1052 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
1054 switch (mf->prereqs) {
1059 return (flow->dl_type == htons(ETH_TYPE_ARP) ||
1060 flow->dl_type == htons(ETH_TYPE_RARP));
1062 return flow->dl_type == htons(ETH_TYPE_IP);
1064 return flow->dl_type == htons(ETH_TYPE_IPV6);
1066 return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
1068 return eth_type_mpls(flow->dl_type);
1070 return is_ip_any(flow);
1073 return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP;
1075 return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP;
1077 return is_ip_any(flow) && flow->nw_proto == IPPROTO_SCTP;
1079 return is_icmpv4(flow);
1081 return is_icmpv6(flow);
1084 return (is_icmpv6(flow)
1085 && flow->tp_dst == htons(0)
1086 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
1087 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
1088 case MFP_ND_SOLICIT:
1089 return (is_icmpv6(flow)
1090 && flow->tp_dst == htons(0)
1091 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
1093 return (is_icmpv6(flow)
1094 && flow->tp_dst == htons(0)
1095 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
1101 /* Set field and it's prerequisities in the mask.
1102 * This is only ever called for writeable 'mf's, but we do not make the
1103 * distinction here. */
1105 mf_mask_field_and_prereqs(const struct mf_field *mf, struct flow *mask)
1107 static const union mf_value exact_match_mask = MF_EXACT_MASK_INITIALIZER;
1109 mf_set_flow_value(mf, &exact_match_mask, mask);
1111 switch (mf->prereqs) {
1113 case MFP_ND_SOLICIT:
1115 mask->tp_src = OVS_BE16_MAX;
1116 mask->tp_dst = OVS_BE16_MAX;
1123 mask->nw_proto = 0xff;
1130 mask->dl_type = OVS_BE16_MAX;
1133 mask->vlan_tci |= htons(VLAN_CFI);
1141 /* Returns true if 'value' may be a valid value *as part of a masked match*,
1144 * A value is not rejected just because it is not valid for the field in
1145 * question, but only if it doesn't make sense to test the bits in question at
1146 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
1147 * without the VLAN_CFI bit being set, but we can't reject those values because
1148 * it is still legitimate to test just for those bits (see the documentation
1149 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
1150 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
1152 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
1165 case MFF_SKB_PRIORITY:
1188 case MFF_ICMPV4_TYPE:
1189 case MFF_ICMPV4_CODE:
1190 case MFF_ICMPV6_TYPE:
1191 case MFF_ICMPV6_CODE:
1197 case MFF_IN_PORT_OXM: {
1199 return !ofputil_port_from_ofp11(value->be32, &port);
1203 return !(value->u8 & ~IP_DSCP_MASK);
1204 case MFF_IP_DSCP_SHIFTED:
1205 return !(value->u8 & (~IP_DSCP_MASK >> 2));
1207 return !(value->u8 & ~IP_ECN_MASK);
1209 return !(value->u8 & ~FLOW_NW_FRAG_MASK);
1211 return !(value->be16 & ~htons(0x0fff));
1214 return !(value->be16 & htons(0xff00));
1217 return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
1219 return !(value->be16 & htons(VLAN_PCP_MASK));
1221 case MFF_DL_VLAN_PCP:
1223 return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
1225 case MFF_IPV6_LABEL:
1226 return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
1228 case MFF_MPLS_LABEL:
1229 return !(value->be32 & ~htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT));
1232 return !(value->u8 & ~(MPLS_TC_MASK >> MPLS_TC_SHIFT));
1235 return !(value->u8 & ~(MPLS_BOS_MASK >> MPLS_BOS_SHIFT));
1243 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
1244 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
1246 mf_get_value(const struct mf_field *mf, const struct flow *flow,
1247 union mf_value *value)
1251 value->be32 = htonl(flow->dp_hash);
1254 value->be32 = htonl(flow->recirc_id);
1257 value->be64 = flow->tunnel.tun_id;
1260 value->be32 = flow->tunnel.ip_src;
1263 value->be32 = flow->tunnel.ip_dst;
1266 value->be16 = htons(flow->tunnel.flags);
1269 value->u8 = flow->tunnel.ip_ttl;
1272 value->u8 = flow->tunnel.ip_tos;
1276 value->be64 = flow->metadata;
1280 value->be16 = htons(ofp_to_u16(flow->in_port.ofp_port));
1282 case MFF_IN_PORT_OXM:
1283 value->be32 = ofputil_port_to_ofp11(flow->in_port.ofp_port);
1286 case MFF_SKB_PRIORITY:
1287 value->be32 = htonl(flow->skb_priority);
1291 value->be32 = htonl(flow->pkt_mark);
1295 value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
1299 memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
1303 memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
1307 value->be16 = flow->dl_type;
1311 value->be16 = flow->vlan_tci;
1315 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
1318 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
1321 case MFF_DL_VLAN_PCP:
1323 value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
1326 case MFF_MPLS_LABEL:
1327 value->be32 = htonl(mpls_lse_to_label(flow->mpls_lse[0]));
1331 value->u8 = mpls_lse_to_tc(flow->mpls_lse[0]);
1335 value->u8 = mpls_lse_to_bos(flow->mpls_lse[0]);
1339 value->be32 = flow->nw_src;
1343 value->be32 = flow->nw_dst;
1347 value->ipv6 = flow->ipv6_src;
1351 value->ipv6 = flow->ipv6_dst;
1354 case MFF_IPV6_LABEL:
1355 value->be32 = flow->ipv6_label;
1359 value->u8 = flow->nw_proto;
1363 value->u8 = flow->nw_tos & IP_DSCP_MASK;
1366 case MFF_IP_DSCP_SHIFTED:
1367 value->u8 = flow->nw_tos >> 2;
1371 value->u8 = flow->nw_tos & IP_ECN_MASK;
1375 value->u8 = flow->nw_ttl;
1379 value->u8 = flow->nw_frag;
1383 value->be16 = htons(flow->nw_proto);
1387 value->be32 = flow->nw_src;
1391 value->be32 = flow->nw_dst;
1396 memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
1401 memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
1407 value->be16 = flow->tp_src;
1413 value->be16 = flow->tp_dst;
1417 value->be16 = flow->tcp_flags;
1420 case MFF_ICMPV4_TYPE:
1421 case MFF_ICMPV6_TYPE:
1422 value->u8 = ntohs(flow->tp_src);
1425 case MFF_ICMPV4_CODE:
1426 case MFF_ICMPV6_CODE:
1427 value->u8 = ntohs(flow->tp_dst);
1431 value->ipv6 = flow->nd_target;
1440 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1441 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1444 mf_set_value(const struct mf_field *mf,
1445 const union mf_value *value, struct match *match)
1449 match_set_dp_hash(match, ntohl(value->be32));
1452 match_set_recirc_id(match, ntohl(value->be32));
1455 match_set_tun_id(match, value->be64);
1458 match_set_tun_src(match, value->be32);
1461 match_set_tun_dst(match, value->be32);
1464 match_set_tun_flags(match, ntohs(value->be16));
1467 match_set_tun_tos(match, value->u8);
1470 match_set_tun_ttl(match, value->u8);
1474 match_set_metadata(match, value->be64);
1478 match_set_in_port(match, u16_to_ofp(ntohs(value->be16)));
1481 case MFF_IN_PORT_OXM: {
1483 ofputil_port_from_ofp11(value->be32, &port);
1484 match_set_in_port(match, port);
1488 case MFF_SKB_PRIORITY:
1489 match_set_skb_priority(match, ntohl(value->be32));
1493 match_set_pkt_mark(match, ntohl(value->be32));
1497 match_set_reg(match, mf->id - MFF_REG0, ntohl(value->be32));
1501 match_set_dl_src(match, value->mac);
1505 match_set_dl_dst(match, value->mac);
1509 match_set_dl_type(match, value->be16);
1513 match_set_dl_tci(match, value->be16);
1517 match_set_dl_vlan(match, value->be16);
1520 match_set_vlan_vid(match, value->be16);
1523 case MFF_DL_VLAN_PCP:
1525 match_set_dl_vlan_pcp(match, value->u8);
1528 case MFF_MPLS_LABEL:
1529 match_set_mpls_label(match, 0, value->be32);
1533 match_set_mpls_tc(match, 0, value->u8);
1537 match_set_mpls_bos(match, 0, value->u8);
1541 match_set_nw_src(match, value->be32);
1545 match_set_nw_dst(match, value->be32);
1549 match_set_ipv6_src(match, &value->ipv6);
1553 match_set_ipv6_dst(match, &value->ipv6);
1556 case MFF_IPV6_LABEL:
1557 match_set_ipv6_label(match, value->be32);
1561 match_set_nw_proto(match, value->u8);
1565 match_set_nw_dscp(match, value->u8);
1568 case MFF_IP_DSCP_SHIFTED:
1569 match_set_nw_dscp(match, value->u8 << 2);
1573 match_set_nw_ecn(match, value->u8);
1577 match_set_nw_ttl(match, value->u8);
1581 match_set_nw_frag(match, value->u8);
1585 match_set_nw_proto(match, ntohs(value->be16));
1589 match_set_nw_src(match, value->be32);
1593 match_set_nw_dst(match, value->be32);
1598 match_set_arp_sha(match, value->mac);
1603 match_set_arp_tha(match, value->mac);
1609 match_set_tp_src(match, value->be16);
1615 match_set_tp_dst(match, value->be16);
1619 match_set_tcp_flags(match, value->be16);
1622 case MFF_ICMPV4_TYPE:
1623 case MFF_ICMPV6_TYPE:
1624 match_set_icmp_type(match, value->u8);
1627 case MFF_ICMPV4_CODE:
1628 case MFF_ICMPV6_CODE:
1629 match_set_icmp_code(match, value->u8);
1633 match_set_nd_target(match, &value->ipv6);
1642 /* Unwildcard 'mask' member field described by 'mf'. The caller is
1643 * responsible for ensuring that 'mask' meets 'mf''s prerequisites. */
1645 mf_mask_field(const struct mf_field *mf, struct flow *mask)
1647 static const union mf_value exact_match_mask = MF_EXACT_MASK_INITIALIZER;
1649 /* For MFF_DL_VLAN, we cannot send a all 1's to flow_set_dl_vlan()
1650 * as that will be considered as OFP10_VLAN_NONE. So consider it as a
1651 * special case. For the rest, calling mf_set_flow_value() is good
1653 if (mf->id == MFF_DL_VLAN) {
1654 flow_set_dl_vlan(mask, htons(VLAN_VID_MASK));
1656 mf_set_flow_value(mf, &exact_match_mask, mask);
1660 /* Sets 'flow' member field described by 'mf' to 'value'. The caller is
1661 * responsible for ensuring that 'flow' meets 'mf''s prerequisites.*/
1663 mf_set_flow_value(const struct mf_field *mf,
1664 const union mf_value *value, struct flow *flow)
1668 flow->dp_hash = ntohl(value->be32);
1671 flow->recirc_id = ntohl(value->be32);
1674 flow->tunnel.tun_id = value->be64;
1677 flow->tunnel.ip_src = value->be32;
1680 flow->tunnel.ip_dst = value->be32;
1683 flow->tunnel.flags = ntohs(value->be16);
1686 flow->tunnel.ip_tos = value->u8;
1689 flow->tunnel.ip_ttl = value->u8;
1693 flow->metadata = value->be64;
1697 flow->in_port.ofp_port = u16_to_ofp(ntohs(value->be16));
1700 case MFF_IN_PORT_OXM: {
1702 ofputil_port_from_ofp11(value->be32, &port);
1703 flow->in_port.ofp_port = port;
1707 case MFF_SKB_PRIORITY:
1708 flow->skb_priority = ntohl(value->be32);
1712 flow->pkt_mark = ntohl(value->be32);
1716 flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1720 memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
1724 memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
1728 flow->dl_type = value->be16;
1732 flow->vlan_tci = value->be16;
1736 flow_set_dl_vlan(flow, value->be16);
1739 flow_set_vlan_vid(flow, value->be16);
1742 case MFF_DL_VLAN_PCP:
1744 flow_set_vlan_pcp(flow, value->u8);
1747 case MFF_MPLS_LABEL:
1748 flow_set_mpls_label(flow, 0, value->be32);
1752 flow_set_mpls_tc(flow, 0, value->u8);
1756 flow_set_mpls_bos(flow, 0, value->u8);
1760 flow->nw_src = value->be32;
1764 flow->nw_dst = value->be32;
1768 flow->ipv6_src = value->ipv6;
1772 flow->ipv6_dst = value->ipv6;
1775 case MFF_IPV6_LABEL:
1776 flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1780 flow->nw_proto = value->u8;
1784 flow->nw_tos &= ~IP_DSCP_MASK;
1785 flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1788 case MFF_IP_DSCP_SHIFTED:
1789 flow->nw_tos &= ~IP_DSCP_MASK;
1790 flow->nw_tos |= value->u8 << 2;
1794 flow->nw_tos &= ~IP_ECN_MASK;
1795 flow->nw_tos |= value->u8 & IP_ECN_MASK;
1799 flow->nw_ttl = value->u8;
1803 flow->nw_frag = value->u8 & FLOW_NW_FRAG_MASK;
1807 flow->nw_proto = ntohs(value->be16);
1811 flow->nw_src = value->be32;
1815 flow->nw_dst = value->be32;
1820 memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1825 memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1831 flow->tp_src = value->be16;
1837 flow->tp_dst = value->be16;
1841 flow->tcp_flags = value->be16;
1844 case MFF_ICMPV4_TYPE:
1845 case MFF_ICMPV6_TYPE:
1846 flow->tp_src = htons(value->u8);
1849 case MFF_ICMPV4_CODE:
1850 case MFF_ICMPV6_CODE:
1851 flow->tp_dst = htons(value->u8);
1855 flow->nd_target = value->ipv6;
1864 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1866 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1869 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1871 union mf_value value;
1873 mf_get_value(mf, flow, &value);
1874 return is_all_zeros((const uint8_t *) &value, mf->n_bytes);
1877 /* Makes 'match' wildcard field 'mf'.
1879 * The caller is responsible for ensuring that 'match' meets 'mf''s
1882 mf_set_wild(const struct mf_field *mf, struct match *match)
1886 match->flow.dp_hash = 0;
1887 match->wc.masks.dp_hash = 0;
1890 match->flow.recirc_id = 0;
1891 match->wc.masks.recirc_id = 0;
1894 match_set_tun_id_masked(match, htonll(0), htonll(0));
1897 match_set_tun_src_masked(match, htonl(0), htonl(0));
1900 match_set_tun_dst_masked(match, htonl(0), htonl(0));
1903 match_set_tun_flags_masked(match, 0, 0);
1906 match_set_tun_tos_masked(match, 0, 0);
1909 match_set_tun_ttl_masked(match, 0, 0);
1913 match_set_metadata_masked(match, htonll(0), htonll(0));
1917 case MFF_IN_PORT_OXM:
1918 match->flow.in_port.ofp_port = 0;
1919 match->wc.masks.in_port.ofp_port = 0;
1922 case MFF_SKB_PRIORITY:
1923 match->flow.skb_priority = 0;
1924 match->wc.masks.skb_priority = 0;
1928 match->flow.pkt_mark = 0;
1929 match->wc.masks.pkt_mark = 0;
1933 match_set_reg_masked(match, mf->id - MFF_REG0, 0, 0);
1937 memset(match->flow.dl_src, 0, ETH_ADDR_LEN);
1938 memset(match->wc.masks.dl_src, 0, ETH_ADDR_LEN);
1942 memset(match->flow.dl_dst, 0, ETH_ADDR_LEN);
1943 memset(match->wc.masks.dl_dst, 0, ETH_ADDR_LEN);
1947 match->flow.dl_type = htons(0);
1948 match->wc.masks.dl_type = htons(0);
1952 match_set_dl_tci_masked(match, htons(0), htons(0));
1957 match_set_any_vid(match);
1960 case MFF_DL_VLAN_PCP:
1962 match_set_any_pcp(match);
1965 case MFF_MPLS_LABEL:
1966 match_set_any_mpls_label(match, 0);
1970 match_set_any_mpls_tc(match, 0);
1974 match_set_any_mpls_bos(match, 0);
1979 match_set_nw_src_masked(match, htonl(0), htonl(0));
1984 match_set_nw_dst_masked(match, htonl(0), htonl(0));
1988 memset(&match->wc.masks.ipv6_src, 0, sizeof match->wc.masks.ipv6_src);
1989 memset(&match->flow.ipv6_src, 0, sizeof match->flow.ipv6_src);
1993 memset(&match->wc.masks.ipv6_dst, 0, sizeof match->wc.masks.ipv6_dst);
1994 memset(&match->flow.ipv6_dst, 0, sizeof match->flow.ipv6_dst);
1997 case MFF_IPV6_LABEL:
1998 match->wc.masks.ipv6_label = htonl(0);
1999 match->flow.ipv6_label = htonl(0);
2003 match->wc.masks.nw_proto = 0;
2004 match->flow.nw_proto = 0;
2008 case MFF_IP_DSCP_SHIFTED:
2009 match->wc.masks.nw_tos &= ~IP_DSCP_MASK;
2010 match->flow.nw_tos &= ~IP_DSCP_MASK;
2014 match->wc.masks.nw_tos &= ~IP_ECN_MASK;
2015 match->flow.nw_tos &= ~IP_ECN_MASK;
2019 match->wc.masks.nw_ttl = 0;
2020 match->flow.nw_ttl = 0;
2024 match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
2025 match->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
2029 match->wc.masks.nw_proto = 0;
2030 match->flow.nw_proto = 0;
2035 memset(match->flow.arp_sha, 0, ETH_ADDR_LEN);
2036 memset(match->wc.masks.arp_sha, 0, ETH_ADDR_LEN);
2041 memset(match->flow.arp_tha, 0, ETH_ADDR_LEN);
2042 memset(match->wc.masks.arp_tha, 0, ETH_ADDR_LEN);
2048 case MFF_ICMPV4_TYPE:
2049 case MFF_ICMPV6_TYPE:
2050 match->wc.masks.tp_src = htons(0);
2051 match->flow.tp_src = htons(0);
2057 case MFF_ICMPV4_CODE:
2058 case MFF_ICMPV6_CODE:
2059 match->wc.masks.tp_dst = htons(0);
2060 match->flow.tp_dst = htons(0);
2064 match->wc.masks.tcp_flags = htons(0);
2065 match->flow.tcp_flags = htons(0);
2069 memset(&match->wc.masks.nd_target, 0,
2070 sizeof match->wc.masks.nd_target);
2071 memset(&match->flow.nd_target, 0, sizeof match->flow.nd_target);
2080 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
2081 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
2082 * with a 1-bit indicating that the corresponding value bit must match and a
2083 * 0-bit indicating a don't-care.
2085 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
2086 * mf_set_value(mf, value, match). If 'mask' points to all-0-bits, then this
2087 * call is equivalent to mf_set_wild(mf, match).
2089 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
2090 * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
2091 enum ofputil_protocol
2092 mf_set(const struct mf_field *mf,
2093 const union mf_value *value, const union mf_value *mask,
2094 struct match *match)
2096 if (!mask || is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2097 mf_set_value(mf, value, match);
2098 return mf->usable_protocols;
2099 } else if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2100 mf_set_wild(mf, match);
2101 return OFPUTIL_P_ANY;
2107 case MFF_IN_PORT_OXM:
2108 case MFF_SKB_PRIORITY:
2111 case MFF_DL_VLAN_PCP:
2113 case MFF_MPLS_LABEL:
2119 case MFF_IP_DSCP_SHIFTED:
2122 case MFF_ICMPV4_TYPE:
2123 case MFF_ICMPV4_CODE:
2124 case MFF_ICMPV6_TYPE:
2125 case MFF_ICMPV6_CODE:
2126 return OFPUTIL_P_NONE;
2129 match_set_dp_hash_masked(match, ntohl(value->be32), ntohl(mask->be32));
2132 match_set_tun_id_masked(match, value->be64, mask->be64);
2135 match_set_tun_src_masked(match, value->be32, mask->be32);
2138 match_set_tun_dst_masked(match, value->be32, mask->be32);
2141 match_set_tun_flags_masked(match, ntohs(value->be16), ntohs(mask->be16));
2144 match_set_tun_ttl_masked(match, value->u8, mask->u8);
2147 match_set_tun_tos_masked(match, value->u8, mask->u8);
2151 match_set_metadata_masked(match, value->be64, mask->be64);
2155 match_set_reg_masked(match, mf->id - MFF_REG0,
2156 ntohl(value->be32), ntohl(mask->be32));
2160 match_set_pkt_mark_masked(match, ntohl(value->be32),
2165 match_set_dl_dst_masked(match, value->mac, mask->mac);
2169 match_set_dl_src_masked(match, value->mac, mask->mac);
2174 match_set_arp_sha_masked(match, value->mac, mask->mac);
2179 match_set_arp_tha_masked(match, value->mac, mask->mac);
2183 match_set_dl_tci_masked(match, value->be16, mask->be16);
2187 match_set_vlan_vid_masked(match, value->be16, mask->be16);
2191 match_set_nw_src_masked(match, value->be32, mask->be32);
2195 match_set_nw_dst_masked(match, value->be32, mask->be32);
2199 match_set_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
2203 match_set_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
2206 case MFF_IPV6_LABEL:
2207 if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
2208 mf_set_value(mf, value, match);
2210 match_set_ipv6_label_masked(match, value->be32, mask->be32);
2215 match_set_nd_target_masked(match, &value->ipv6, &mask->ipv6);
2219 match_set_nw_frag_masked(match, value->u8, mask->u8);
2223 match_set_nw_src_masked(match, value->be32, mask->be32);
2227 match_set_nw_dst_masked(match, value->be32, mask->be32);
2233 match_set_tp_src_masked(match, value->be16, mask->be16);
2239 match_set_tp_dst_masked(match, value->be16, mask->be16);
2243 match_set_tcp_flags_masked(match, value->be16, mask->be16);
2251 return mf->usable_protocols_bitwise;
2254 return ip_is_cidr(mask->be32) ? mf->usable_protocols :
2255 mf->usable_protocols_bitwise;
2259 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
2263 VLOG_WARN_RL(&rl, "unknown %s field", type);
2264 return OFPERR_OFPBAC_BAD_SET_TYPE;
2265 } else if (!sf->n_bits) {
2266 VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
2267 return OFPERR_OFPBAC_BAD_SET_LEN;
2268 } else if (sf->ofs >= sf->field->n_bits) {
2269 VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
2270 sf->ofs, sf->field->n_bits, type, sf->field->name);
2271 return OFPERR_OFPBAC_BAD_SET_LEN;
2272 } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
2273 VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
2274 "of %s field %s", sf->ofs, sf->n_bits,
2275 sf->field->n_bits, type, sf->field->name);
2276 return OFPERR_OFPBAC_BAD_SET_LEN;
2277 } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
2278 VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
2279 type, sf->field->name);
2280 return OFPERR_OFPBAC_MATCH_INCONSISTENT;
2286 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
2287 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
2290 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
2292 return mf_check__(sf, flow, "source");
2295 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
2296 * if so, otherwise an OpenFlow error code (e.g. as returned by
2299 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
2301 int error = mf_check__(sf, flow, "destination");
2302 if (!error && !sf->field->writable) {
2303 VLOG_WARN_RL(&rl, "destination field %s is not writable",
2305 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
2310 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
2311 * 'value' and 'mask', respectively. */
2313 mf_get(const struct mf_field *mf, const struct match *match,
2314 union mf_value *value, union mf_value *mask)
2316 mf_get_value(mf, &match->flow, value);
2317 mf_get_mask(mf, &match->wc, mask);
2321 mf_from_integer_string(const struct mf_field *mf, const char *s,
2322 uint8_t *valuep, uint8_t *maskp)
2324 unsigned long long int integer, mask;
2329 integer = strtoull(s, &tail, 0);
2330 if (errno || (*tail != '\0' && *tail != '/')) {
2335 mask = strtoull(tail + 1, &tail, 0);
2336 if (errno || *tail != '\0') {
2343 for (i = mf->n_bytes - 1; i >= 0; i--) {
2344 valuep[i] = integer;
2350 return xasprintf("%s: value too large for %u-byte field %s",
2351 s, mf->n_bytes, mf->name);
2356 return xasprintf("%s: bad syntax for %s", s, mf->name);
2360 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
2361 uint8_t mac[ETH_ADDR_LEN],
2362 uint8_t mask[ETH_ADDR_LEN])
2366 ovs_assert(mf->n_bytes == ETH_ADDR_LEN);
2369 if (ovs_scan(s, ETH_ADDR_SCAN_FMT"%n", ETH_ADDR_SCAN_ARGS(mac), &n)
2370 && n == strlen(s)) {
2371 memset(mask, 0xff, ETH_ADDR_LEN);
2376 if (ovs_scan(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT"%n",
2377 ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask), &n)
2378 && n == strlen(s)) {
2382 return xasprintf("%s: invalid Ethernet address", s);
2386 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
2387 ovs_be32 *ip, ovs_be32 *mask)
2391 ovs_assert(mf->n_bytes == sizeof *ip);
2393 if (ovs_scan(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
2394 IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask))) {
2396 } else if (ovs_scan(s, IP_SCAN_FMT"/%d", IP_SCAN_ARGS(ip), &prefix)) {
2397 if (prefix <= 0 || prefix > 32) {
2398 return xasprintf("%s: network prefix bits not between 1 and "
2400 } else if (prefix == 32) {
2401 *mask = OVS_BE32_MAX;
2403 *mask = htonl(((1u << prefix) - 1) << (32 - prefix));
2405 } else if (ovs_scan(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip))) {
2406 *mask = OVS_BE32_MAX;
2408 return xasprintf("%s: invalid IP address", s);
2414 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
2415 struct in6_addr *value, struct in6_addr *mask)
2417 char *str = xstrdup(s);
2418 char *save_ptr = NULL;
2419 const char *name, *netmask;
2422 ovs_assert(mf->n_bytes == sizeof *value);
2424 name = strtok_r(str, "/", &save_ptr);
2425 retval = name ? lookup_ipv6(name, value) : EINVAL;
2429 err = xasprintf("%s: could not convert to IPv6 address", str);
2435 netmask = strtok_r(NULL, "/", &save_ptr);
2437 if (inet_pton(AF_INET6, netmask, mask) != 1) {
2438 int prefix = atoi(netmask);
2439 if (prefix <= 0 || prefix > 128) {
2441 return xasprintf("%s: prefix bits not between 1 and 128", s);
2443 *mask = ipv6_create_mask(prefix);
2447 *mask = in6addr_exact;
2455 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
2456 ovs_be16 *valuep, ovs_be16 *maskp)
2460 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2462 if (ofputil_port_from_string(s, &port)) {
2463 *valuep = htons(ofp_to_u16(port));
2464 *maskp = OVS_BE16_MAX;
2467 return xasprintf("%s: port value out of range for %s", s, mf->name);
2471 mf_from_ofp_port_string32(const struct mf_field *mf, const char *s,
2472 ovs_be32 *valuep, ovs_be32 *maskp)
2476 ovs_assert(mf->n_bytes == sizeof(ovs_be32));
2477 if (ofputil_port_from_string(s, &port)) {
2478 *valuep = ofputil_port_to_ofp11(port);
2479 *maskp = OVS_BE32_MAX;
2482 return xasprintf("%s: port value out of range for %s", s, mf->name);
2485 struct frag_handling {
2491 static const struct frag_handling all_frags[] = {
2492 #define A FLOW_NW_FRAG_ANY
2493 #define L FLOW_NW_FRAG_LATER
2494 /* name mask value */
2497 { "first", A|L, A },
2498 { "later", A|L, A|L },
2503 { "not_later", L, 0 },
2510 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
2512 const struct frag_handling *h;
2514 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2515 if (!strcasecmp(s, h->name)) {
2516 /* We force the upper bits of the mask on to make mf_parse_value()
2517 * happy (otherwise it will never think it's an exact match.) */
2518 *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
2524 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2525 "\"yes\", \"first\", \"later\", \"not_first\"", s);
2529 parse_flow_tun_flags(const char *s_, const char *(*bit_to_string)(uint32_t),
2532 uint32_t result = 0;
2533 char *save_ptr = NULL;
2536 char *s = xstrdup(s_);
2538 for (name = strtok_r((char *)s, " |", &save_ptr); name;
2539 name = strtok_r(NULL, " |", &save_ptr)) {
2541 unsigned long long int flags;
2544 if (ovs_scan(name, "%lli", &flags)) {
2548 name_len = strlen(name);
2549 for (bit = 1; bit; bit <<= 1) {
2550 const char *fname = bit_to_string(bit);
2557 len = strlen(fname);
2558 if (len != name_len) {
2561 if (!strncmp(name, fname, len)) {
2573 *res = htons(result);
2580 mf_from_tun_flags_string(const char *s, ovs_be16 *valuep, ovs_be16 *maskp)
2582 if (!parse_flow_tun_flags(s, flow_tun_flag_to_string, valuep)) {
2583 *maskp = OVS_BE16_MAX;
2587 return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
2588 "\"csum\", \"key\")", s);
2592 mf_from_tcp_flags_string(const char *s, ovs_be16 *flagsp, ovs_be16 *maskp)
2599 if (ovs_scan(s, "%"SCNi16"/%"SCNi16"%n", &flags, &mask, &n) && !s[n]) {
2600 *flagsp = htons(flags);
2601 *maskp = htons(mask);
2604 if (ovs_scan(s, "%"SCNi16"%n", &flags, &n) && !s[n]) {
2605 *flagsp = htons(flags);
2606 *maskp = OVS_BE16_MAX;
2610 while (*s != '\0') {
2622 return xasprintf("%s: TCP flag must be preceded by '+' (for SET) "
2623 "or '-' (NOT SET)", s);
2627 name_len = strcspn(s,"+-");
2629 for (bit = 1; bit; bit <<= 1) {
2630 const char *fname = packet_tcp_flag_to_string(bit);
2637 len = strlen(fname);
2638 if (len != name_len) {
2641 if (!strncmp(s, fname, len)) {
2643 return xasprintf("%s: Each TCP flag can be specified only "
2655 return xasprintf("%s: unknown TCP flag(s)", s);
2660 *flagsp = htons(flags);
2661 *maskp = htons(mask);
2666 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2667 * NULL if successful, otherwise a malloc()'d string describing the error. */
2669 mf_parse(const struct mf_field *mf, const char *s,
2670 union mf_value *value, union mf_value *mask)
2674 if (!strcmp(s, "*")) {
2675 memset(value, 0, mf->n_bytes);
2676 memset(mask, 0, mf->n_bytes);
2680 switch (mf->string) {
2682 case MFS_HEXADECIMAL:
2683 error = mf_from_integer_string(mf, s,
2684 (uint8_t *) value, (uint8_t *) mask);
2688 error = mf_from_ethernet_string(mf, s, value->mac, mask->mac);
2692 error = mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
2696 error = mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
2700 error = mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
2703 case MFS_OFP_PORT_OXM:
2704 error = mf_from_ofp_port_string32(mf, s, &value->be32, &mask->be32);
2708 error = mf_from_frag_string(s, &value->u8, &mask->u8);
2712 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2713 error = mf_from_tun_flags_string(s, &value->be16, &mask->be16);
2717 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2718 error = mf_from_tcp_flags_string(s, &value->be16, &mask->be16);
2725 if (!error && !mf_is_mask_valid(mf, mask)) {
2726 error = xasprintf("%s: invalid mask for field %s", s, mf->name);
2731 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2732 * successful, otherwise a malloc()'d string describing the error. */
2734 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2736 union mf_value mask;
2739 error = mf_parse(mf, s, value, &mask);
2744 if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2745 return xasprintf("%s: wildcards not allowed here", s);
2751 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2752 const uint8_t *maskp, struct ds *s)
2754 unsigned long long int integer;
2757 ovs_assert(mf->n_bytes <= 8);
2760 for (i = 0; i < mf->n_bytes; i++) {
2761 integer = (integer << 8) | valuep[i];
2763 if (mf->string == MFS_HEXADECIMAL) {
2764 ds_put_format(s, "%#llx", integer);
2766 ds_put_format(s, "%lld", integer);
2770 unsigned long long int mask;
2773 for (i = 0; i < mf->n_bytes; i++) {
2774 mask = (mask << 8) | maskp[i];
2777 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2778 * not sure that that a bit-mask written in decimal is ever easier to
2779 * understand than the same bit-mask written in hexadecimal. */
2780 ds_put_format(s, "/%#llx", mask);
2785 mf_format_frag_string(uint8_t value, uint8_t mask, struct ds *s)
2787 const struct frag_handling *h;
2789 mask &= FLOW_NW_FRAG_MASK;
2792 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2793 if (value == h->value && mask == h->mask) {
2794 ds_put_cstr(s, h->name);
2798 ds_put_cstr(s, "<error>");
2802 mf_format_tnl_flags_string(const ovs_be16 *valuep, struct ds *s)
2804 format_flags(s, flow_tun_flag_to_string, ntohs(*valuep), '|');
2808 mf_format_tcp_flags_string(ovs_be16 value, ovs_be16 mask, struct ds *s)
2810 format_flags_masked(s, NULL, packet_tcp_flag_to_string, ntohs(value),
2814 /* Appends to 's' a string representation of field 'mf' whose value is in
2815 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2817 mf_format(const struct mf_field *mf,
2818 const union mf_value *value, const union mf_value *mask,
2822 if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2823 ds_put_cstr(s, "ANY");
2825 } else if (is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2830 switch (mf->string) {
2831 case MFS_OFP_PORT_OXM:
2834 ofputil_port_from_ofp11(value->be32, &port);
2835 ofputil_format_port(port, s);
2841 ofputil_format_port(u16_to_ofp(ntohs(value->be16)), s);
2846 case MFS_HEXADECIMAL:
2847 mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2851 eth_format_masked(value->mac, mask->mac, s);
2855 ip_format_masked(value->be32, mask ? mask->be32 : OVS_BE32_MAX, s);
2859 print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2863 mf_format_frag_string(value->u8, mask ? mask->u8 : UINT8_MAX, s);
2867 mf_format_tnl_flags_string(&value->be16, s);
2871 mf_format_tcp_flags_string(value->be16,
2872 mask ? mask->be16 : OVS_BE16_MAX, s);
2880 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2881 * least-significant bits in 'x'.
2884 mf_write_subfield_flow(const struct mf_subfield *sf,
2885 const union mf_subvalue *x, struct flow *flow)
2887 const struct mf_field *field = sf->field;
2888 union mf_value value;
2890 mf_get_value(field, flow, &value);
2891 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes,
2892 sf->ofs, sf->n_bits);
2893 mf_set_flow_value(field, &value, flow);
2896 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2897 * least-significant bits in 'x'.
2900 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2901 struct match *match)
2903 const struct mf_field *field = sf->field;
2904 union mf_value value, mask;
2906 mf_get(field, match, &value, &mask);
2907 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2908 bitwise_one ( &mask, field->n_bytes, sf->ofs, sf->n_bits);
2909 mf_set(field, &value, &mask, match);
2912 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2913 * reading 'flow', e.g. as checked by mf_check_src(). */
2915 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2916 union mf_subvalue *x)
2918 union mf_value value;
2920 mf_get_value(sf->field, flow, &value);
2922 memset(x, 0, sizeof *x);
2923 bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2928 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2929 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2932 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2934 union mf_value value;
2936 mf_get_value(sf->field, flow, &value);
2937 return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2940 /* Formats 'sf' into 's' in a format normally acceptable to
2941 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2942 * sf->field has no NXM name.) */
2944 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
2947 ds_put_cstr(s, "<unknown>");
2948 } else if (sf->field->nxm_name) {
2949 ds_put_cstr(s, sf->field->nxm_name);
2950 } else if (sf->field->nxm_header) {
2951 uint32_t header = sf->field->nxm_header;
2952 ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
2954 ds_put_cstr(s, sf->field->name);
2957 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
2958 ds_put_cstr(s, "[]");
2959 } else if (sf->n_bits == 1) {
2960 ds_put_format(s, "[%d]", sf->ofs);
2962 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
2966 static const struct mf_field *
2967 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
2971 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
2976 for (i = 0; i < MFF_N_IDS; i++) {
2977 const struct mf_field *mf = mf_from_id(i);
2980 && !strncmp(mf->nxm_name, name, name_len)
2981 && mf->nxm_name[name_len] == '\0') {
2985 && !strncmp(mf->oxm_name, name, name_len)
2986 && mf->oxm_name[name_len] == '\0') {
2994 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2995 * returns NULL and advances '*sp' to the first byte following the parsed
2996 * string. On failure, returns a malloc()'d error message, does not modify
2997 * '*sp', and does not properly initialize 'sf'.
2999 * The syntax parsed from '*sp' takes the form "header[start..end]" where
3000 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
3001 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
3002 * may both be omitted (the [] are still required) to indicate an entire
3004 char * WARN_UNUSED_RESULT
3005 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
3007 const struct mf_field *field;
3016 name_len = strcspn(s, "[");
3017 if (s[name_len] != '[') {
3018 return xasprintf("%s: missing [ looking for field name", *sp);
3021 field = mf_parse_subfield_name(name, name_len, &wild);
3023 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
3027 if (ovs_scan(s, "[%d..%d]", &start, &end)) {
3028 /* Nothing to do. */
3029 } else if (ovs_scan(s, "[%d]", &start)) {
3031 } else if (!strncmp(s, "[]", 2)) {
3033 end = field->n_bits - 1;
3035 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
3036 "[<start>..<end>]", *sp);
3038 s = strchr(s, ']') + 1;
3041 return xasprintf("%s: starting bit %d is after ending bit %d",
3043 } else if (start >= field->n_bits) {
3044 return xasprintf("%s: starting bit %d is not valid because field is "
3045 "only %d bits wide", *sp, start, field->n_bits);
3046 } else if (end >= field->n_bits){
3047 return xasprintf("%s: ending bit %d is not valid because field is "
3048 "only %d bits wide", *sp, end, field->n_bits);
3053 sf->n_bits = end - start + 1;
3059 /* Parses a subfield from the entirety of 's' into 'sf'. Returns NULL if
3060 * successful, otherwise a malloc()'d string describing the error. The caller
3061 * is responsible for freeing the returned string.
3063 * The syntax parsed from 's' takes the form "header[start..end]" where
3064 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
3065 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
3066 * may both be omitted (the [] are still required) to indicate an entire
3068 char * WARN_UNUSED_RESULT
3069 mf_parse_subfield(struct mf_subfield *sf, const char *s)
3071 char *error = mf_parse_subfield__(sf, &s);
3072 if (!error && s[0]) {
3073 error = xstrdup("unexpected input following field syntax");
3079 mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s)
3083 for (i = 0; i < ARRAY_SIZE(subvalue->u8); i++) {
3084 if (subvalue->u8[i]) {
3085 ds_put_format(s, "0x%"PRIx8, subvalue->u8[i]);
3086 for (i++; i < ARRAY_SIZE(subvalue->u8); i++) {
3087 ds_put_format(s, "%02"PRIx8, subvalue->u8[i]);
3092 ds_put_char(s, '0');