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_TUN_ID, "tun_id", "tunnel_id",
61 NXM_NX_TUN_ID, "NXM_NX_TUN_ID",
62 OXM_OF_TUNNEL_ID, "OXM_OF_TUNNEL_ID",
63 OFPUTIL_P_NXM_OXM_ANY,
64 OFPUTIL_P_NXM_OXM_ANY,
65 FLOW_U32OFS(tunnel.tun_id),
67 MFF_TUN_SRC, "tun_src", NULL,
73 NXM_NX_TUN_IPV4_SRC, "NXM_NX_TUN_IPV4_SRC",
74 NXM_NX_TUN_IPV4_SRC, "NXM_NX_TUN_IPV4_SRC",
75 OFPUTIL_P_NXM_OXM_ANY,
76 OFPUTIL_P_NXM_OXM_ANY,
77 FLOW_U32OFS(tunnel.ip_src),
79 MFF_TUN_DST, "tun_dst", NULL,
85 NXM_NX_TUN_IPV4_DST, "NXM_NX_TUN_IPV4_DST",
86 NXM_NX_TUN_IPV4_DST, "NXM_NX_TUN_IPV4_DST",
87 OFPUTIL_P_NXM_OXM_ANY,
88 OFPUTIL_P_NXM_OXM_ANY,
89 FLOW_U32OFS(tunnel.ip_dst),
91 MFF_TUN_FLAGS, "tun_flags", NULL,
103 MFF_TUN_TTL, "tun_ttl", NULL,
115 MFF_TUN_TOS, "tun_tos", NULL,
127 MFF_METADATA, "metadata", NULL,
128 MF_FIELD_SIZES(be64),
133 OXM_OF_METADATA, "OXM_OF_METADATA",
134 OXM_OF_METADATA, "OXM_OF_METADATA",
135 OFPUTIL_P_NXM_OF11_UP,
136 OFPUTIL_P_NXM_OF11_UP,
139 MFF_IN_PORT, "in_port", NULL,
140 MF_FIELD_SIZES(be16),
145 NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
146 NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
147 OFPUTIL_P_ANY, /* OF11+ via mapping to 32 bits. */
151 MFF_IN_PORT_OXM, "in_port_oxm", NULL,
152 MF_FIELD_SIZES(be32),
157 OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
158 OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
163 MFF_SKB_PRIORITY, "skb_priority", NULL,
164 MF_FIELD_SIZES(be32),
175 MFF_PKT_MARK, "pkt_mark", NULL,
176 MF_FIELD_SIZES(be32),
181 NXM_NX_PKT_MARK, "NXM_NX_PKT_MARK",
182 NXM_NX_PKT_MARK, "NXM_NX_PKT_MARK",
183 OFPUTIL_P_NXM_OXM_ANY,
184 OFPUTIL_P_NXM_OXM_ANY,
188 #define REGISTER(IDX) \
190 MFF_REG##IDX, "reg" #IDX, NULL, \
191 MF_FIELD_SIZES(be32), \
196 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
197 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
198 OFPUTIL_P_NXM_OXM_ANY, \
199 OFPUTIL_P_NXM_OXM_ANY, \
235 MFF_ETH_SRC, "eth_src", "dl_src",
241 NXM_OF_ETH_SRC, "NXM_OF_ETH_SRC",
242 OXM_OF_ETH_SRC, "OXM_OF_ETH_SRC",
244 OFPUTIL_P_NXM_OF11_UP, /* Bitwise masking only with NXM and OF11+! */
247 MFF_ETH_DST, "eth_dst", "dl_dst",
253 NXM_OF_ETH_DST, "NXM_OF_ETH_DST",
254 OXM_OF_ETH_DST, "OXM_OF_ETH_DST",
256 OFPUTIL_P_NXM_OF11_UP, /* Bitwise masking only with NXM and OF11+! */
259 MFF_ETH_TYPE, "eth_type", "dl_type",
260 MF_FIELD_SIZES(be16),
265 NXM_OF_ETH_TYPE, "NXM_OF_ETH_TYPE",
266 OXM_OF_ETH_TYPE, "OXM_OF_ETH_TYPE",
273 MFF_VLAN_TCI, "vlan_tci", NULL,
274 MF_FIELD_SIZES(be16),
279 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
280 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
282 OFPUTIL_P_NXM_OXM_ANY,
285 MFF_DL_VLAN, "dl_vlan", NULL,
286 sizeof(ovs_be16), 12,
294 OFPUTIL_P_NXM_OXM_ANY,
297 MFF_VLAN_VID, "vlan_vid", NULL,
298 sizeof(ovs_be16), 12,
303 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
304 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
306 OFPUTIL_P_NXM_OXM_ANY,
309 MFF_DL_VLAN_PCP, "dl_vlan_pcp", NULL,
317 OFPUTIL_P_ANY, /* Will be mapped to NXM and OXM. */
321 MFF_VLAN_PCP, "vlan_pcp", NULL,
327 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
328 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
329 OFPUTIL_P_ANY, /* Will be mapped to OF10 and NXM. */
338 MFF_MPLS_LABEL, "mpls_label", NULL,
344 OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
345 OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
346 OFPUTIL_P_NXM_OF11_UP,
350 MFF_MPLS_TC, "mpls_tc", NULL,
356 OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
357 OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
358 OFPUTIL_P_NXM_OF11_UP,
362 MFF_MPLS_BOS, "mpls_bos", NULL,
368 OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
369 OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
370 OFPUTIL_P_NXM_OXM_ANY,
380 MFF_IPV4_SRC, "ip_src", "nw_src",
381 MF_FIELD_SIZES(be32),
386 NXM_OF_IP_SRC, "NXM_OF_IP_SRC",
387 OXM_OF_IPV4_SRC, "OXM_OF_IPV4_SRC",
389 OFPUTIL_P_NXM_OF11_UP,
392 MFF_IPV4_DST, "ip_dst", "nw_dst",
393 MF_FIELD_SIZES(be32),
398 NXM_OF_IP_DST, "NXM_OF_IP_DST",
399 OXM_OF_IPV4_DST, "OXM_OF_IPV4_DST",
401 OFPUTIL_P_NXM_OF11_UP,
406 MFF_IPV6_SRC, "ipv6_src", NULL,
407 MF_FIELD_SIZES(ipv6),
412 NXM_NX_IPV6_SRC, "NXM_NX_IPV6_SRC",
413 OXM_OF_IPV6_SRC, "OXM_OF_IPV6_SRC",
414 OFPUTIL_P_NXM_OXM_ANY,
415 OFPUTIL_P_NXM_OXM_ANY,
416 FLOW_U32OFS(ipv6_src),
418 MFF_IPV6_DST, "ipv6_dst", NULL,
419 MF_FIELD_SIZES(ipv6),
424 NXM_NX_IPV6_DST, "NXM_NX_IPV6_DST",
425 OXM_OF_IPV6_DST, "OXM_OF_IPV6_DST",
426 OFPUTIL_P_NXM_OXM_ANY,
427 OFPUTIL_P_NXM_OXM_ANY,
428 FLOW_U32OFS(ipv6_dst),
431 MFF_IPV6_LABEL, "ipv6_label", NULL,
437 NXM_NX_IPV6_LABEL, "NXM_NX_IPV6_LABEL",
438 OXM_OF_IPV6_FLABEL, "OXM_OF_IPV6_FLABEL",
439 OFPUTIL_P_NXM_OXM_ANY,
440 OFPUTIL_P_NXM_OXM_ANY,
445 MFF_IP_PROTO, "nw_proto", "ip_proto",
451 NXM_OF_IP_PROTO, "NXM_OF_IP_PROTO",
452 OXM_OF_IP_PROTO, "OXM_OF_IP_PROTO",
457 MFF_IP_DSCP, "nw_tos", NULL,
463 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
464 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
465 OFPUTIL_P_ANY, /* Will be shifted for OXM. */
469 MFF_IP_DSCP_SHIFTED, "ip_dscp", NULL,
475 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
476 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
477 OFPUTIL_P_ANY, /* Will be shifted for non-OXM. */
481 MFF_IP_ECN, "nw_ecn", "ip_ecn",
487 NXM_NX_IP_ECN, "NXM_NX_IP_ECN",
488 OXM_OF_IP_ECN, "OXM_OF_IP_ECN",
489 OFPUTIL_P_NXM_OXM_ANY,
493 MFF_IP_TTL, "nw_ttl", NULL,
499 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
500 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
501 OFPUTIL_P_NXM_OXM_ANY,
505 MFF_IP_FRAG, "ip_frag", NULL,
511 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
512 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
513 OFPUTIL_P_NXM_OXM_ANY,
514 OFPUTIL_P_NXM_OXM_ANY,
519 MFF_ARP_OP, "arp_op", NULL,
520 MF_FIELD_SIZES(be16),
525 NXM_OF_ARP_OP, "NXM_OF_ARP_OP",
526 OXM_OF_ARP_OP, "OXM_OF_ARP_OP",
531 MFF_ARP_SPA, "arp_spa", NULL,
532 MF_FIELD_SIZES(be32),
537 NXM_OF_ARP_SPA, "NXM_OF_ARP_SPA",
538 OXM_OF_ARP_SPA, "OXM_OF_ARP_SPA",
540 OFPUTIL_P_NXM_OF11_UP,
543 MFF_ARP_TPA, "arp_tpa", NULL,
544 MF_FIELD_SIZES(be32),
549 NXM_OF_ARP_TPA, "NXM_OF_ARP_TPA",
550 OXM_OF_ARP_TPA, "OXM_OF_ARP_TPA",
552 OFPUTIL_P_NXM_OF11_UP,
555 MFF_ARP_SHA, "arp_sha", NULL,
561 NXM_NX_ARP_SHA, "NXM_NX_ARP_SHA",
562 OXM_OF_ARP_SHA, "OXM_OF_ARP_SHA",
563 OFPUTIL_P_NXM_OXM_ANY,
564 OFPUTIL_P_NXM_OXM_ANY,
567 MFF_ARP_THA, "arp_tha", NULL,
573 NXM_NX_ARP_THA, "NXM_NX_ARP_THA",
574 OXM_OF_ARP_THA, "OXM_OF_ARP_THA",
575 OFPUTIL_P_NXM_OXM_ANY,
576 OFPUTIL_P_NXM_OXM_ANY,
585 MFF_TCP_SRC, "tcp_src", "tp_src",
586 MF_FIELD_SIZES(be16),
591 NXM_OF_TCP_SRC, "NXM_OF_TCP_SRC",
592 OXM_OF_TCP_SRC, "OXM_OF_TCP_SRC",
594 OFPUTIL_P_NXM_OXM_ANY,
597 MFF_TCP_DST, "tcp_dst", "tp_dst",
598 MF_FIELD_SIZES(be16),
603 NXM_OF_TCP_DST, "NXM_OF_TCP_DST",
604 OXM_OF_TCP_DST, "OXM_OF_TCP_DST",
606 OFPUTIL_P_NXM_OXM_ANY,
609 MFF_TCP_FLAGS, "tcp_flags", NULL,
615 NXM_NX_TCP_FLAGS, "NXM_NX_TCP_FLAGS",
616 NXM_NX_TCP_FLAGS, "NXM_NX_TCP_FLAGS",
617 OFPUTIL_P_NXM_OXM_ANY,
618 OFPUTIL_P_NXM_OXM_ANY,
623 MFF_UDP_SRC, "udp_src", NULL,
624 MF_FIELD_SIZES(be16),
629 NXM_OF_UDP_SRC, "NXM_OF_UDP_SRC",
630 OXM_OF_UDP_SRC, "OXM_OF_UDP_SRC",
632 OFPUTIL_P_NXM_OXM_ANY,
635 MFF_UDP_DST, "udp_dst", NULL,
636 MF_FIELD_SIZES(be16),
641 NXM_OF_UDP_DST, "NXM_OF_UDP_DST",
642 OXM_OF_UDP_DST, "OXM_OF_UDP_DST",
644 OFPUTIL_P_NXM_OXM_ANY,
649 MFF_SCTP_SRC, "sctp_src", NULL,
650 MF_FIELD_SIZES(be16),
655 OXM_OF_SCTP_SRC, "OXM_OF_SCTP_SRC",
656 OXM_OF_SCTP_SRC, "OXM_OF_SCTP_SRC",
657 OFPUTIL_P_NXM_OF11_UP,
658 OFPUTIL_P_NXM_OXM_ANY,
661 MFF_SCTP_DST, "sctp_dst", NULL,
662 MF_FIELD_SIZES(be16),
667 OXM_OF_SCTP_DST, "OXM_OF_SCTP_DST",
668 OXM_OF_SCTP_DST, "OXM_OF_SCTP_DST",
669 OFPUTIL_P_NXM_OF11_UP,
670 OFPUTIL_P_NXM_OXM_ANY,
675 MFF_ICMPV4_TYPE, "icmp_type", NULL,
681 NXM_OF_ICMP_TYPE, "NXM_OF_ICMP_TYPE",
682 OXM_OF_ICMPV4_TYPE, "OXM_OF_ICMPV4_TYPE",
687 MFF_ICMPV4_CODE, "icmp_code", NULL,
693 NXM_OF_ICMP_CODE, "NXM_OF_ICMP_CODE",
694 OXM_OF_ICMPV4_CODE, "OXM_OF_ICMPV4_CODE",
701 MFF_ICMPV6_TYPE, "icmpv6_type", NULL,
707 NXM_NX_ICMPV6_TYPE, "NXM_NX_ICMPV6_TYPE",
708 OXM_OF_ICMPV6_TYPE, "OXM_OF_ICMPV6_TYPE",
709 OFPUTIL_P_NXM_OXM_ANY,
713 MFF_ICMPV6_CODE, "icmpv6_code", NULL,
719 NXM_NX_ICMPV6_CODE, "NXM_NX_ICMPV6_CODE",
720 OXM_OF_ICMPV6_CODE, "OXM_OF_ICMPV6_CODE",
721 OFPUTIL_P_NXM_OXM_ANY,
731 MFF_ND_TARGET, "nd_target", NULL,
732 MF_FIELD_SIZES(ipv6),
737 NXM_NX_ND_TARGET, "NXM_NX_ND_TARGET",
738 OXM_OF_IPV6_ND_TARGET, "OXM_OF_IPV6_ND_TARGET",
739 OFPUTIL_P_NXM_OXM_ANY,
740 OFPUTIL_P_NXM_OXM_ANY,
743 MFF_ND_SLL, "nd_sll", NULL,
749 NXM_NX_ND_SLL, "NXM_NX_ND_SLL",
750 OXM_OF_IPV6_ND_SLL, "OXM_OF_IPV6_ND_SLL",
751 OFPUTIL_P_NXM_OXM_ANY,
752 OFPUTIL_P_NXM_OXM_ANY,
755 MFF_ND_TLL, "nd_tll", NULL,
761 NXM_NX_ND_TLL, "NXM_NX_ND_TLL",
762 OXM_OF_IPV6_ND_TLL, "OXM_OF_IPV6_ND_TLL",
763 OFPUTIL_P_NXM_OXM_ANY,
764 OFPUTIL_P_NXM_OXM_ANY,
769 /* Maps an NXM or OXM header value to an mf_field. */
771 struct hmap_node hmap_node; /* In 'all_fields' hmap. */
772 uint32_t header; /* NXM or OXM header value. */
773 const struct mf_field *mf;
776 /* Contains 'struct nxm_field's. */
777 static struct hmap all_fields;
779 /* Maps from an mf_field's 'name' or 'extra_name' to the mf_field. */
780 static struct shash mf_by_name;
782 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
783 * controller and so there's not much point in showing a lot of them. */
784 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
786 const struct mf_field *mf_from_nxm_header__(uint32_t header);
787 static void nxm_init(void);
789 /* Returns the field with the given 'name', or a null pointer if no field has
791 const struct mf_field *
792 mf_from_name(const char *name)
795 return shash_find_data(&mf_by_name, name);
799 add_nxm_field(uint32_t header, const struct mf_field *mf)
803 f = xmalloc(sizeof *f);
804 hmap_insert(&all_fields, &f->hmap_node, hash_int(header, 0));
810 nxm_init_add_field(const struct mf_field *mf, uint32_t header)
813 ovs_assert(!mf_from_nxm_header__(header));
814 add_nxm_field(header, mf);
815 if (mf->maskable != MFM_NONE) {
816 add_nxm_field(NXM_MAKE_WILD_HEADER(header), mf);
826 hmap_init(&all_fields);
827 shash_init(&mf_by_name);
828 for (i = 0; i < MFF_N_IDS; i++) {
829 const struct mf_field *mf = &mf_fields[i];
831 ovs_assert(mf->id == i); /* Fields must be in the enum order. */
833 nxm_init_add_field(mf, mf->nxm_header);
834 if (mf->oxm_header != mf->nxm_header) {
835 nxm_init_add_field(mf, mf->oxm_header);
838 shash_add_once(&mf_by_name, mf->name, mf);
839 if (mf->extra_name) {
840 shash_add_once(&mf_by_name, mf->extra_name, mf);
848 static pthread_once_t once = PTHREAD_ONCE_INIT;
849 pthread_once(&once, nxm_do_init);
852 const struct mf_field *
853 mf_from_nxm_header(uint32_t header)
856 return mf_from_nxm_header__(header);
859 const struct mf_field *
860 mf_from_nxm_header__(uint32_t header)
862 const struct nxm_field *f;
864 HMAP_FOR_EACH_IN_BUCKET (f, hmap_node, hash_int(header, 0), &all_fields) {
865 if (f->header == header) {
873 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
874 * specifies at least one bit in the field.
876 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
877 * meets 'mf''s prerequisites. */
879 mf_is_all_wild(const struct mf_field *mf, const struct flow_wildcards *wc)
883 return !wc->masks.tunnel.ip_src;
885 return !wc->masks.tunnel.ip_dst;
890 return !wc->masks.tunnel.tun_id;
892 return !wc->masks.metadata;
894 case MFF_IN_PORT_OXM:
895 return !wc->masks.in_port.ofp_port;
896 case MFF_SKB_PRIORITY:
897 return !wc->masks.skb_priority;
899 return !wc->masks.pkt_mark;
901 return !wc->masks.regs[mf->id - MFF_REG0];
904 return eth_addr_is_zero(wc->masks.dl_src);
906 return eth_addr_is_zero(wc->masks.dl_dst);
908 return !wc->masks.dl_type;
912 return eth_addr_is_zero(wc->masks.arp_sha);
916 return eth_addr_is_zero(wc->masks.arp_tha);
919 return !wc->masks.vlan_tci;
921 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK));
923 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI));
924 case MFF_DL_VLAN_PCP:
926 return !(wc->masks.vlan_tci & htons(VLAN_PCP_MASK));
929 return !(wc->masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK));
931 return !(wc->masks.mpls_lse[1] & htonl(MPLS_TC_MASK));
933 return !(wc->masks.mpls_lse[2] & htonl(MPLS_BOS_MASK));
936 return !wc->masks.nw_src;
938 return !wc->masks.nw_dst;
941 return ipv6_mask_is_any(&wc->masks.ipv6_src);
943 return ipv6_mask_is_any(&wc->masks.ipv6_dst);
946 return !wc->masks.ipv6_label;
949 return !wc->masks.nw_proto;
951 case MFF_IP_DSCP_SHIFTED:
952 return !(wc->masks.nw_tos & IP_DSCP_MASK);
954 return !(wc->masks.nw_tos & IP_ECN_MASK);
956 return !wc->masks.nw_ttl;
959 return ipv6_mask_is_any(&wc->masks.nd_target);
962 return !(wc->masks.nw_frag & FLOW_NW_FRAG_MASK);
965 return !wc->masks.nw_proto;
967 return !wc->masks.nw_src;
969 return !wc->masks.nw_dst;
974 case MFF_ICMPV4_TYPE:
975 case MFF_ICMPV6_TYPE:
976 return !wc->masks.tp_src;
980 case MFF_ICMPV4_CODE:
981 case MFF_ICMPV6_CODE:
982 return !wc->masks.tp_dst;
984 return !wc->masks.tcp_flags;
992 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
993 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
994 * purposes, or to 0 if it is wildcarded.
996 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
997 * meets 'mf''s prerequisites. */
999 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
1000 union mf_value *mask)
1002 mf_get_value(mf, &wc->masks, mask);
1005 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
1006 * if the mask is valid, false otherwise. */
1008 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
1010 switch (mf->maskable) {
1012 return (is_all_zeros((const uint8_t *) mask, mf->n_bytes) ||
1013 is_all_ones((const uint8_t *) mask, mf->n_bytes));
1022 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
1024 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
1026 switch (mf->prereqs) {
1031 return (flow->dl_type == htons(ETH_TYPE_ARP) ||
1032 flow->dl_type == htons(ETH_TYPE_RARP));
1034 return flow->dl_type == htons(ETH_TYPE_IP);
1036 return flow->dl_type == htons(ETH_TYPE_IPV6);
1038 return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
1040 return eth_type_mpls(flow->dl_type);
1042 return is_ip_any(flow);
1045 return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP;
1047 return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP;
1049 return is_ip_any(flow) && flow->nw_proto == IPPROTO_SCTP;
1051 return is_icmpv4(flow);
1053 return is_icmpv6(flow);
1056 return (is_icmpv6(flow)
1057 && flow->tp_dst == htons(0)
1058 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
1059 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
1060 case MFP_ND_SOLICIT:
1061 return (is_icmpv6(flow)
1062 && flow->tp_dst == htons(0)
1063 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
1065 return (is_icmpv6(flow)
1066 && flow->tp_dst == htons(0)
1067 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
1073 /* Set field and it's prerequisities in the mask.
1074 * This is only ever called for writeable 'mf's, but we do not make the
1075 * distinction here. */
1077 mf_mask_field_and_prereqs(const struct mf_field *mf, struct flow *mask)
1079 static const union mf_value exact_match_mask = MF_EXACT_MASK_INITIALIZER;
1081 mf_set_flow_value(mf, &exact_match_mask, mask);
1083 switch (mf->prereqs) {
1085 case MFP_ND_SOLICIT:
1087 mask->tp_src = OVS_BE16_MAX;
1088 mask->tp_dst = OVS_BE16_MAX;
1095 mask->nw_proto = 0xff;
1102 mask->dl_type = OVS_BE16_MAX;
1105 mask->vlan_tci |= htons(VLAN_CFI);
1113 /* Returns true if 'value' may be a valid value *as part of a masked match*,
1116 * A value is not rejected just because it is not valid for the field in
1117 * question, but only if it doesn't make sense to test the bits in question at
1118 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
1119 * without the VLAN_CFI bit being set, but we can't reject those values because
1120 * it is still legitimate to test just for those bits (see the documentation
1121 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
1122 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
1124 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
1135 case MFF_SKB_PRIORITY:
1158 case MFF_ICMPV4_TYPE:
1159 case MFF_ICMPV4_CODE:
1160 case MFF_ICMPV6_TYPE:
1161 case MFF_ICMPV6_CODE:
1167 case MFF_IN_PORT_OXM: {
1169 return !ofputil_port_from_ofp11(value->be32, &port);
1173 return !(value->u8 & ~IP_DSCP_MASK);
1174 case MFF_IP_DSCP_SHIFTED:
1175 return !(value->u8 & (~IP_DSCP_MASK >> 2));
1177 return !(value->u8 & ~IP_ECN_MASK);
1179 return !(value->u8 & ~FLOW_NW_FRAG_MASK);
1181 return !(value->be16 & ~htons(0x0fff));
1184 return !(value->be16 & htons(0xff00));
1187 return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
1189 return !(value->be16 & htons(VLAN_PCP_MASK));
1191 case MFF_DL_VLAN_PCP:
1193 return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
1195 case MFF_IPV6_LABEL:
1196 return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
1198 case MFF_MPLS_LABEL:
1199 return !(value->be32 & ~htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT));
1202 return !(value->u8 & ~(MPLS_TC_MASK >> MPLS_TC_SHIFT));
1205 return !(value->u8 & ~(MPLS_BOS_MASK >> MPLS_BOS_SHIFT));
1213 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
1214 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
1216 mf_get_value(const struct mf_field *mf, const struct flow *flow,
1217 union mf_value *value)
1221 value->be64 = flow->tunnel.tun_id;
1224 value->be32 = flow->tunnel.ip_src;
1227 value->be32 = flow->tunnel.ip_dst;
1230 value->be16 = htons(flow->tunnel.flags);
1233 value->u8 = flow->tunnel.ip_ttl;
1236 value->u8 = flow->tunnel.ip_tos;
1240 value->be64 = flow->metadata;
1244 value->be16 = htons(ofp_to_u16(flow->in_port.ofp_port));
1246 case MFF_IN_PORT_OXM:
1247 value->be32 = ofputil_port_to_ofp11(flow->in_port.ofp_port);
1250 case MFF_SKB_PRIORITY:
1251 value->be32 = htonl(flow->skb_priority);
1255 value->be32 = htonl(flow->pkt_mark);
1259 value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
1263 memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
1267 memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
1271 value->be16 = flow->dl_type;
1275 value->be16 = flow->vlan_tci;
1279 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
1282 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
1285 case MFF_DL_VLAN_PCP:
1287 value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
1290 case MFF_MPLS_LABEL:
1291 value->be32 = htonl(mpls_lse_to_label(flow->mpls_lse[0]));
1295 value->u8 = mpls_lse_to_tc(flow->mpls_lse[0]);
1299 value->u8 = mpls_lse_to_bos(flow->mpls_lse[0]);
1303 value->be32 = flow->nw_src;
1307 value->be32 = flow->nw_dst;
1311 value->ipv6 = flow->ipv6_src;
1315 value->ipv6 = flow->ipv6_dst;
1318 case MFF_IPV6_LABEL:
1319 value->be32 = flow->ipv6_label;
1323 value->u8 = flow->nw_proto;
1327 value->u8 = flow->nw_tos & IP_DSCP_MASK;
1330 case MFF_IP_DSCP_SHIFTED:
1331 value->u8 = flow->nw_tos >> 2;
1335 value->u8 = flow->nw_tos & IP_ECN_MASK;
1339 value->u8 = flow->nw_ttl;
1343 value->u8 = flow->nw_frag;
1347 value->be16 = htons(flow->nw_proto);
1351 value->be32 = flow->nw_src;
1355 value->be32 = flow->nw_dst;
1360 memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
1365 memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
1371 value->be16 = flow->tp_src;
1377 value->be16 = flow->tp_dst;
1381 value->be16 = flow->tcp_flags;
1384 case MFF_ICMPV4_TYPE:
1385 case MFF_ICMPV6_TYPE:
1386 value->u8 = ntohs(flow->tp_src);
1389 case MFF_ICMPV4_CODE:
1390 case MFF_ICMPV6_CODE:
1391 value->u8 = ntohs(flow->tp_dst);
1395 value->ipv6 = flow->nd_target;
1404 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1405 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1408 mf_set_value(const struct mf_field *mf,
1409 const union mf_value *value, struct match *match)
1413 match_set_tun_id(match, value->be64);
1416 match_set_tun_src(match, value->be32);
1419 match_set_tun_dst(match, value->be32);
1422 match_set_tun_flags(match, ntohs(value->be16));
1425 match_set_tun_tos(match, value->u8);
1428 match_set_tun_ttl(match, value->u8);
1432 match_set_metadata(match, value->be64);
1436 match_set_in_port(match, u16_to_ofp(ntohs(value->be16)));
1439 case MFF_IN_PORT_OXM: {
1441 ofputil_port_from_ofp11(value->be32, &port);
1442 match_set_in_port(match, port);
1446 case MFF_SKB_PRIORITY:
1447 match_set_skb_priority(match, ntohl(value->be32));
1451 match_set_pkt_mark(match, ntohl(value->be32));
1455 match_set_reg(match, mf->id - MFF_REG0, ntohl(value->be32));
1459 match_set_dl_src(match, value->mac);
1463 match_set_dl_dst(match, value->mac);
1467 match_set_dl_type(match, value->be16);
1471 match_set_dl_tci(match, value->be16);
1475 match_set_dl_vlan(match, value->be16);
1478 match_set_vlan_vid(match, value->be16);
1481 case MFF_DL_VLAN_PCP:
1483 match_set_dl_vlan_pcp(match, value->u8);
1486 case MFF_MPLS_LABEL:
1487 match_set_mpls_label(match, 0, value->be32);
1491 match_set_mpls_tc(match, 0, value->u8);
1495 match_set_mpls_bos(match, 0, value->u8);
1499 match_set_nw_src(match, value->be32);
1503 match_set_nw_dst(match, value->be32);
1507 match_set_ipv6_src(match, &value->ipv6);
1511 match_set_ipv6_dst(match, &value->ipv6);
1514 case MFF_IPV6_LABEL:
1515 match_set_ipv6_label(match, value->be32);
1519 match_set_nw_proto(match, value->u8);
1523 match_set_nw_dscp(match, value->u8);
1526 case MFF_IP_DSCP_SHIFTED:
1527 match_set_nw_dscp(match, value->u8 << 2);
1531 match_set_nw_ecn(match, value->u8);
1535 match_set_nw_ttl(match, value->u8);
1539 match_set_nw_frag(match, value->u8);
1543 match_set_nw_proto(match, ntohs(value->be16));
1547 match_set_nw_src(match, value->be32);
1551 match_set_nw_dst(match, value->be32);
1556 match_set_arp_sha(match, value->mac);
1561 match_set_arp_tha(match, value->mac);
1567 match_set_tp_src(match, value->be16);
1573 match_set_tp_dst(match, value->be16);
1577 match_set_tcp_flags(match, value->be16);
1580 case MFF_ICMPV4_TYPE:
1581 case MFF_ICMPV6_TYPE:
1582 match_set_icmp_type(match, value->u8);
1585 case MFF_ICMPV4_CODE:
1586 case MFF_ICMPV6_CODE:
1587 match_set_icmp_code(match, value->u8);
1591 match_set_nd_target(match, &value->ipv6);
1600 /* Unwildcard 'mask' member field described by 'mf'. The caller is
1601 * responsible for ensuring that 'mask' meets 'mf''s prerequisites. */
1603 mf_mask_field(const struct mf_field *mf, struct flow *mask)
1605 static const union mf_value exact_match_mask = MF_EXACT_MASK_INITIALIZER;
1607 /* For MFF_DL_VLAN, we cannot send a all 1's to flow_set_dl_vlan()
1608 * as that will be considered as OFP10_VLAN_NONE. So consider it as a
1609 * special case. For the rest, calling mf_set_flow_value() is good
1611 if (mf->id == MFF_DL_VLAN) {
1612 flow_set_dl_vlan(mask, htons(VLAN_VID_MASK));
1614 mf_set_flow_value(mf, &exact_match_mask, mask);
1618 /* Sets 'flow' member field described by 'mf' to 'value'. The caller is
1619 * responsible for ensuring that 'flow' meets 'mf''s prerequisites.*/
1621 mf_set_flow_value(const struct mf_field *mf,
1622 const union mf_value *value, struct flow *flow)
1626 flow->tunnel.tun_id = value->be64;
1629 flow->tunnel.ip_src = value->be32;
1632 flow->tunnel.ip_dst = value->be32;
1635 flow->tunnel.flags = ntohs(value->be16);
1638 flow->tunnel.ip_tos = value->u8;
1641 flow->tunnel.ip_ttl = value->u8;
1645 flow->metadata = value->be64;
1649 flow->in_port.ofp_port = u16_to_ofp(ntohs(value->be16));
1652 case MFF_IN_PORT_OXM: {
1654 ofputil_port_from_ofp11(value->be32, &port);
1655 flow->in_port.ofp_port = port;
1659 case MFF_SKB_PRIORITY:
1660 flow->skb_priority = ntohl(value->be32);
1664 flow->pkt_mark = ntohl(value->be32);
1668 flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1672 memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
1676 memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
1680 flow->dl_type = value->be16;
1684 flow->vlan_tci = value->be16;
1688 flow_set_dl_vlan(flow, value->be16);
1691 flow_set_vlan_vid(flow, value->be16);
1694 case MFF_DL_VLAN_PCP:
1696 flow_set_vlan_pcp(flow, value->u8);
1699 case MFF_MPLS_LABEL:
1700 flow_set_mpls_label(flow, 0, value->be32);
1704 flow_set_mpls_tc(flow, 0, value->u8);
1708 flow_set_mpls_bos(flow, 0, value->u8);
1712 flow->nw_src = value->be32;
1716 flow->nw_dst = value->be32;
1720 flow->ipv6_src = value->ipv6;
1724 flow->ipv6_dst = value->ipv6;
1727 case MFF_IPV6_LABEL:
1728 flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1732 flow->nw_proto = value->u8;
1736 flow->nw_tos &= ~IP_DSCP_MASK;
1737 flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1740 case MFF_IP_DSCP_SHIFTED:
1741 flow->nw_tos &= ~IP_DSCP_MASK;
1742 flow->nw_tos |= value->u8 << 2;
1746 flow->nw_tos &= ~IP_ECN_MASK;
1747 flow->nw_tos |= value->u8 & IP_ECN_MASK;
1751 flow->nw_ttl = value->u8;
1755 flow->nw_frag = value->u8 & FLOW_NW_FRAG_MASK;
1759 flow->nw_proto = ntohs(value->be16);
1763 flow->nw_src = value->be32;
1767 flow->nw_dst = value->be32;
1772 memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1777 memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1783 flow->tp_src = value->be16;
1789 flow->tp_dst = value->be16;
1793 flow->tcp_flags = value->be16;
1796 case MFF_ICMPV4_TYPE:
1797 case MFF_ICMPV6_TYPE:
1798 flow->tp_src = htons(value->u8);
1801 case MFF_ICMPV4_CODE:
1802 case MFF_ICMPV6_CODE:
1803 flow->tp_dst = htons(value->u8);
1807 flow->nd_target = value->ipv6;
1816 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1818 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1821 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1823 union mf_value value;
1825 mf_get_value(mf, flow, &value);
1826 return is_all_zeros((const uint8_t *) &value, mf->n_bytes);
1829 /* Makes 'match' wildcard field 'mf'.
1831 * The caller is responsible for ensuring that 'match' meets 'mf''s
1834 mf_set_wild(const struct mf_field *mf, struct match *match)
1838 match_set_tun_id_masked(match, htonll(0), htonll(0));
1841 match_set_tun_src_masked(match, htonl(0), htonl(0));
1844 match_set_tun_dst_masked(match, htonl(0), htonl(0));
1847 match_set_tun_flags_masked(match, 0, 0);
1850 match_set_tun_tos_masked(match, 0, 0);
1853 match_set_tun_ttl_masked(match, 0, 0);
1857 match_set_metadata_masked(match, htonll(0), htonll(0));
1861 case MFF_IN_PORT_OXM:
1862 match->flow.in_port.ofp_port = 0;
1863 match->wc.masks.in_port.ofp_port = 0;
1866 case MFF_SKB_PRIORITY:
1867 match->flow.skb_priority = 0;
1868 match->wc.masks.skb_priority = 0;
1872 match->flow.pkt_mark = 0;
1873 match->wc.masks.pkt_mark = 0;
1877 match_set_reg_masked(match, mf->id - MFF_REG0, 0, 0);
1881 memset(match->flow.dl_src, 0, ETH_ADDR_LEN);
1882 memset(match->wc.masks.dl_src, 0, ETH_ADDR_LEN);
1886 memset(match->flow.dl_dst, 0, ETH_ADDR_LEN);
1887 memset(match->wc.masks.dl_dst, 0, ETH_ADDR_LEN);
1891 match->flow.dl_type = htons(0);
1892 match->wc.masks.dl_type = htons(0);
1896 match_set_dl_tci_masked(match, htons(0), htons(0));
1901 match_set_any_vid(match);
1904 case MFF_DL_VLAN_PCP:
1906 match_set_any_pcp(match);
1909 case MFF_MPLS_LABEL:
1910 match_set_any_mpls_label(match, 0);
1914 match_set_any_mpls_tc(match, 0);
1918 match_set_any_mpls_bos(match, 0);
1923 match_set_nw_src_masked(match, htonl(0), htonl(0));
1928 match_set_nw_dst_masked(match, htonl(0), htonl(0));
1932 memset(&match->wc.masks.ipv6_src, 0, sizeof match->wc.masks.ipv6_src);
1933 memset(&match->flow.ipv6_src, 0, sizeof match->flow.ipv6_src);
1937 memset(&match->wc.masks.ipv6_dst, 0, sizeof match->wc.masks.ipv6_dst);
1938 memset(&match->flow.ipv6_dst, 0, sizeof match->flow.ipv6_dst);
1941 case MFF_IPV6_LABEL:
1942 match->wc.masks.ipv6_label = htonl(0);
1943 match->flow.ipv6_label = htonl(0);
1947 match->wc.masks.nw_proto = 0;
1948 match->flow.nw_proto = 0;
1952 case MFF_IP_DSCP_SHIFTED:
1953 match->wc.masks.nw_tos &= ~IP_DSCP_MASK;
1954 match->flow.nw_tos &= ~IP_DSCP_MASK;
1958 match->wc.masks.nw_tos &= ~IP_ECN_MASK;
1959 match->flow.nw_tos &= ~IP_ECN_MASK;
1963 match->wc.masks.nw_ttl = 0;
1964 match->flow.nw_ttl = 0;
1968 match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
1969 match->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1973 match->wc.masks.nw_proto = 0;
1974 match->flow.nw_proto = 0;
1979 memset(match->flow.arp_sha, 0, ETH_ADDR_LEN);
1980 memset(match->wc.masks.arp_sha, 0, ETH_ADDR_LEN);
1985 memset(match->flow.arp_tha, 0, ETH_ADDR_LEN);
1986 memset(match->wc.masks.arp_tha, 0, ETH_ADDR_LEN);
1992 case MFF_ICMPV4_TYPE:
1993 case MFF_ICMPV6_TYPE:
1994 match->wc.masks.tp_src = htons(0);
1995 match->flow.tp_src = htons(0);
2001 case MFF_ICMPV4_CODE:
2002 case MFF_ICMPV6_CODE:
2003 match->wc.masks.tp_dst = htons(0);
2004 match->flow.tp_dst = htons(0);
2008 match->wc.masks.tcp_flags = htons(0);
2009 match->flow.tcp_flags = htons(0);
2013 memset(&match->wc.masks.nd_target, 0,
2014 sizeof match->wc.masks.nd_target);
2015 memset(&match->flow.nd_target, 0, sizeof match->flow.nd_target);
2024 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
2025 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
2026 * with a 1-bit indicating that the corresponding value bit must match and a
2027 * 0-bit indicating a don't-care.
2029 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
2030 * mf_set_value(mf, value, match). If 'mask' points to all-0-bits, then this
2031 * call is equivalent to mf_set_wild(mf, match).
2033 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
2034 * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
2035 enum ofputil_protocol
2036 mf_set(const struct mf_field *mf,
2037 const union mf_value *value, const union mf_value *mask,
2038 struct match *match)
2040 if (!mask || is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2041 mf_set_value(mf, value, match);
2042 return mf->usable_protocols;
2043 } else if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2044 mf_set_wild(mf, match);
2045 return OFPUTIL_P_ANY;
2050 case MFF_IN_PORT_OXM:
2051 case MFF_SKB_PRIORITY:
2054 case MFF_DL_VLAN_PCP:
2056 case MFF_MPLS_LABEL:
2062 case MFF_IP_DSCP_SHIFTED:
2065 case MFF_ICMPV4_TYPE:
2066 case MFF_ICMPV4_CODE:
2067 case MFF_ICMPV6_TYPE:
2068 case MFF_ICMPV6_CODE:
2069 return OFPUTIL_P_NONE;
2072 match_set_tun_id_masked(match, value->be64, mask->be64);
2075 match_set_tun_src_masked(match, value->be32, mask->be32);
2078 match_set_tun_dst_masked(match, value->be32, mask->be32);
2081 match_set_tun_flags_masked(match, ntohs(value->be16), ntohs(mask->be16));
2084 match_set_tun_ttl_masked(match, value->u8, mask->u8);
2087 match_set_tun_tos_masked(match, value->u8, mask->u8);
2091 match_set_metadata_masked(match, value->be64, mask->be64);
2095 match_set_reg_masked(match, mf->id - MFF_REG0,
2096 ntohl(value->be32), ntohl(mask->be32));
2100 match_set_pkt_mark_masked(match, ntohl(value->be32),
2105 match_set_dl_dst_masked(match, value->mac, mask->mac);
2109 match_set_dl_src_masked(match, value->mac, mask->mac);
2114 match_set_arp_sha_masked(match, value->mac, mask->mac);
2119 match_set_arp_tha_masked(match, value->mac, mask->mac);
2123 match_set_dl_tci_masked(match, value->be16, mask->be16);
2127 match_set_vlan_vid_masked(match, value->be16, mask->be16);
2131 match_set_nw_src_masked(match, value->be32, mask->be32);
2135 match_set_nw_dst_masked(match, value->be32, mask->be32);
2139 match_set_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
2143 match_set_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
2146 case MFF_IPV6_LABEL:
2147 if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
2148 mf_set_value(mf, value, match);
2150 match_set_ipv6_label_masked(match, value->be32, mask->be32);
2155 match_set_nd_target_masked(match, &value->ipv6, &mask->ipv6);
2159 match_set_nw_frag_masked(match, value->u8, mask->u8);
2163 match_set_nw_src_masked(match, value->be32, mask->be32);
2167 match_set_nw_dst_masked(match, value->be32, mask->be32);
2173 match_set_tp_src_masked(match, value->be16, mask->be16);
2179 match_set_tp_dst_masked(match, value->be16, mask->be16);
2183 match_set_tcp_flags_masked(match, value->be16, mask->be16);
2191 return mf->usable_protocols_bitwise;
2194 return ip_is_cidr(mask->be32) ? mf->usable_protocols :
2195 mf->usable_protocols_bitwise;
2199 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
2203 VLOG_WARN_RL(&rl, "unknown %s field", type);
2204 return OFPERR_OFPBAC_BAD_SET_TYPE;
2205 } else if (!sf->n_bits) {
2206 VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
2207 return OFPERR_OFPBAC_BAD_SET_LEN;
2208 } else if (sf->ofs >= sf->field->n_bits) {
2209 VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
2210 sf->ofs, sf->field->n_bits, type, sf->field->name);
2211 return OFPERR_OFPBAC_BAD_SET_LEN;
2212 } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
2213 VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
2214 "of %s field %s", sf->ofs, sf->n_bits,
2215 sf->field->n_bits, type, sf->field->name);
2216 return OFPERR_OFPBAC_BAD_SET_LEN;
2217 } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
2218 VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
2219 type, sf->field->name);
2220 return OFPERR_OFPBAC_MATCH_INCONSISTENT;
2226 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
2227 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
2230 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
2232 return mf_check__(sf, flow, "source");
2235 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
2236 * if so, otherwise an OpenFlow error code (e.g. as returned by
2239 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
2241 int error = mf_check__(sf, flow, "destination");
2242 if (!error && !sf->field->writable) {
2243 VLOG_WARN_RL(&rl, "destination field %s is not writable",
2245 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
2250 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
2251 * 'value' and 'mask', respectively. */
2253 mf_get(const struct mf_field *mf, const struct match *match,
2254 union mf_value *value, union mf_value *mask)
2256 mf_get_value(mf, &match->flow, value);
2257 mf_get_mask(mf, &match->wc, mask);
2261 mf_from_integer_string(const struct mf_field *mf, const char *s,
2262 uint8_t *valuep, uint8_t *maskp)
2264 unsigned long long int integer, mask;
2269 integer = strtoull(s, &tail, 0);
2270 if (errno || (*tail != '\0' && *tail != '/')) {
2275 mask = strtoull(tail + 1, &tail, 0);
2276 if (errno || *tail != '\0') {
2283 for (i = mf->n_bytes - 1; i >= 0; i--) {
2284 valuep[i] = integer;
2290 return xasprintf("%s: value too large for %u-byte field %s",
2291 s, mf->n_bytes, mf->name);
2296 return xasprintf("%s: bad syntax for %s", s, mf->name);
2300 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
2301 uint8_t mac[ETH_ADDR_LEN],
2302 uint8_t mask[ETH_ADDR_LEN])
2306 ovs_assert(mf->n_bytes == ETH_ADDR_LEN);
2309 if (ovs_scan(s, ETH_ADDR_SCAN_FMT"%n", ETH_ADDR_SCAN_ARGS(mac), &n)
2310 && n == strlen(s)) {
2311 memset(mask, 0xff, ETH_ADDR_LEN);
2316 if (ovs_scan(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT"%n",
2317 ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask), &n)
2318 && n == strlen(s)) {
2322 return xasprintf("%s: invalid Ethernet address", s);
2326 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
2327 ovs_be32 *ip, ovs_be32 *mask)
2331 ovs_assert(mf->n_bytes == sizeof *ip);
2333 if (ovs_scan(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
2334 IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask))) {
2336 } else if (ovs_scan(s, IP_SCAN_FMT"/%d", IP_SCAN_ARGS(ip), &prefix)) {
2337 if (prefix <= 0 || prefix > 32) {
2338 return xasprintf("%s: network prefix bits not between 1 and "
2340 } else if (prefix == 32) {
2341 *mask = OVS_BE32_MAX;
2343 *mask = htonl(((1u << prefix) - 1) << (32 - prefix));
2345 } else if (ovs_scan(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip))) {
2346 *mask = OVS_BE32_MAX;
2348 return xasprintf("%s: invalid IP address", s);
2354 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
2355 struct in6_addr *value, struct in6_addr *mask)
2357 char *str = xstrdup(s);
2358 char *save_ptr = NULL;
2359 const char *name, *netmask;
2362 ovs_assert(mf->n_bytes == sizeof *value);
2364 name = strtok_r(str, "/", &save_ptr);
2365 retval = name ? lookup_ipv6(name, value) : EINVAL;
2369 err = xasprintf("%s: could not convert to IPv6 address", str);
2375 netmask = strtok_r(NULL, "/", &save_ptr);
2377 if (inet_pton(AF_INET6, netmask, mask) != 1) {
2378 int prefix = atoi(netmask);
2379 if (prefix <= 0 || prefix > 128) {
2381 return xasprintf("%s: prefix bits not between 1 and 128", s);
2383 *mask = ipv6_create_mask(prefix);
2387 *mask = in6addr_exact;
2395 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
2396 ovs_be16 *valuep, ovs_be16 *maskp)
2400 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2402 if (ofputil_port_from_string(s, &port)) {
2403 *valuep = htons(ofp_to_u16(port));
2404 *maskp = OVS_BE16_MAX;
2407 return xasprintf("%s: port value out of range for %s", s, mf->name);
2411 mf_from_ofp_port_string32(const struct mf_field *mf, const char *s,
2412 ovs_be32 *valuep, ovs_be32 *maskp)
2416 ovs_assert(mf->n_bytes == sizeof(ovs_be32));
2417 if (ofputil_port_from_string(s, &port)) {
2418 *valuep = ofputil_port_to_ofp11(port);
2419 *maskp = OVS_BE32_MAX;
2422 return xasprintf("%s: port value out of range for %s", s, mf->name);
2425 struct frag_handling {
2431 static const struct frag_handling all_frags[] = {
2432 #define A FLOW_NW_FRAG_ANY
2433 #define L FLOW_NW_FRAG_LATER
2434 /* name mask value */
2437 { "first", A|L, A },
2438 { "later", A|L, A|L },
2443 { "not_later", L, 0 },
2450 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
2452 const struct frag_handling *h;
2454 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2455 if (!strcasecmp(s, h->name)) {
2456 /* We force the upper bits of the mask on to make mf_parse_value()
2457 * happy (otherwise it will never think it's an exact match.) */
2458 *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
2464 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2465 "\"yes\", \"first\", \"later\", \"not_first\"", s);
2469 parse_flow_tun_flags(const char *s_, const char *(*bit_to_string)(uint32_t),
2472 uint32_t result = 0;
2473 char *save_ptr = NULL;
2476 char *s = xstrdup(s_);
2478 for (name = strtok_r((char *)s, " |", &save_ptr); name;
2479 name = strtok_r(NULL, " |", &save_ptr)) {
2481 unsigned long long int flags;
2484 if (ovs_scan(name, "%lli", &flags)) {
2488 name_len = strlen(name);
2489 for (bit = 1; bit; bit <<= 1) {
2490 const char *fname = bit_to_string(bit);
2497 len = strlen(fname);
2498 if (len != name_len) {
2501 if (!strncmp(name, fname, len)) {
2513 *res = htons(result);
2520 mf_from_tun_flags_string(const char *s, ovs_be16 *valuep, ovs_be16 *maskp)
2522 if (!parse_flow_tun_flags(s, flow_tun_flag_to_string, valuep)) {
2523 *maskp = OVS_BE16_MAX;
2527 return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
2528 "\"csum\", \"key\")", s);
2532 mf_from_tcp_flags_string(const char *s, ovs_be16 *flagsp, ovs_be16 *maskp)
2539 if (ovs_scan(s, "%"SCNi16"/%"SCNi16"%n", &flags, &mask, &n) && !s[n]) {
2540 *flagsp = htons(flags);
2541 *maskp = htons(mask);
2544 if (ovs_scan(s, "%"SCNi16"%n", &flags, &n) && !s[n]) {
2545 *flagsp = htons(flags);
2546 *maskp = OVS_BE16_MAX;
2550 while (*s != '\0') {
2562 return xasprintf("%s: TCP flag must be preceded by '+' (for SET) "
2563 "or '-' (NOT SET)", s);
2567 name_len = strcspn(s,"+-");
2569 for (bit = 1; bit; bit <<= 1) {
2570 const char *fname = packet_tcp_flag_to_string(bit);
2577 len = strlen(fname);
2578 if (len != name_len) {
2581 if (!strncmp(s, fname, len)) {
2583 return xasprintf("%s: Each TCP flag can be specified only "
2595 return xasprintf("%s: unknown TCP flag(s)", s);
2600 *flagsp = htons(flags);
2601 *maskp = htons(mask);
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);
2657 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2658 error = mf_from_tcp_flags_string(s, &value->be16, &mask->be16);
2665 if (!error && !mf_is_mask_valid(mf, mask)) {
2666 error = xasprintf("%s: invalid mask for field %s", s, mf->name);
2671 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2672 * successful, otherwise a malloc()'d string describing the error. */
2674 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2676 union mf_value mask;
2679 error = mf_parse(mf, s, value, &mask);
2684 if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2685 return xasprintf("%s: wildcards not allowed here", s);
2691 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2692 const uint8_t *maskp, struct ds *s)
2694 unsigned long long int integer;
2697 ovs_assert(mf->n_bytes <= 8);
2700 for (i = 0; i < mf->n_bytes; i++) {
2701 integer = (integer << 8) | valuep[i];
2703 if (mf->string == MFS_HEXADECIMAL) {
2704 ds_put_format(s, "%#llx", integer);
2706 ds_put_format(s, "%lld", integer);
2710 unsigned long long int mask;
2713 for (i = 0; i < mf->n_bytes; i++) {
2714 mask = (mask << 8) | maskp[i];
2717 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2718 * not sure that that a bit-mask written in decimal is ever easier to
2719 * understand than the same bit-mask written in hexadecimal. */
2720 ds_put_format(s, "/%#llx", mask);
2725 mf_format_frag_string(uint8_t value, uint8_t mask, struct ds *s)
2727 const struct frag_handling *h;
2729 mask &= FLOW_NW_FRAG_MASK;
2732 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2733 if (value == h->value && mask == h->mask) {
2734 ds_put_cstr(s, h->name);
2738 ds_put_cstr(s, "<error>");
2742 mf_format_tnl_flags_string(const ovs_be16 *valuep, struct ds *s)
2744 format_flags(s, flow_tun_flag_to_string, ntohs(*valuep), '|');
2748 mf_format_tcp_flags_string(ovs_be16 value, ovs_be16 mask, struct ds *s)
2750 format_flags_masked(s, NULL, packet_tcp_flag_to_string, ntohs(value),
2754 /* Appends to 's' a string representation of field 'mf' whose value is in
2755 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2757 mf_format(const struct mf_field *mf,
2758 const union mf_value *value, const union mf_value *mask,
2762 if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2763 ds_put_cstr(s, "ANY");
2765 } else if (is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2770 switch (mf->string) {
2771 case MFS_OFP_PORT_OXM:
2774 ofputil_port_from_ofp11(value->be32, &port);
2775 ofputil_format_port(port, s);
2781 ofputil_format_port(u16_to_ofp(ntohs(value->be16)), s);
2786 case MFS_HEXADECIMAL:
2787 mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2791 eth_format_masked(value->mac, mask->mac, s);
2795 ip_format_masked(value->be32, mask ? mask->be32 : OVS_BE32_MAX, s);
2799 print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2803 mf_format_frag_string(value->u8, mask ? mask->u8 : UINT8_MAX, s);
2807 mf_format_tnl_flags_string(&value->be16, s);
2811 mf_format_tcp_flags_string(value->be16,
2812 mask ? mask->be16 : OVS_BE16_MAX, s);
2820 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2821 * least-significant bits in 'x'.
2824 mf_write_subfield_flow(const struct mf_subfield *sf,
2825 const union mf_subvalue *x, struct flow *flow)
2827 const struct mf_field *field = sf->field;
2828 union mf_value value;
2830 mf_get_value(field, flow, &value);
2831 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes,
2832 sf->ofs, sf->n_bits);
2833 mf_set_flow_value(field, &value, flow);
2836 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2837 * least-significant bits in 'x'.
2840 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2841 struct match *match)
2843 const struct mf_field *field = sf->field;
2844 union mf_value value, mask;
2846 mf_get(field, match, &value, &mask);
2847 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2848 bitwise_one ( &mask, field->n_bytes, sf->ofs, sf->n_bits);
2849 mf_set(field, &value, &mask, match);
2852 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2853 * reading 'flow', e.g. as checked by mf_check_src(). */
2855 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2856 union mf_subvalue *x)
2858 union mf_value value;
2860 mf_get_value(sf->field, flow, &value);
2862 memset(x, 0, sizeof *x);
2863 bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2868 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2869 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2872 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2874 union mf_value value;
2876 mf_get_value(sf->field, flow, &value);
2877 return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2880 /* Formats 'sf' into 's' in a format normally acceptable to
2881 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2882 * sf->field has no NXM name.) */
2884 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
2887 ds_put_cstr(s, "<unknown>");
2888 } else if (sf->field->nxm_name) {
2889 ds_put_cstr(s, sf->field->nxm_name);
2890 } else if (sf->field->nxm_header) {
2891 uint32_t header = sf->field->nxm_header;
2892 ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
2894 ds_put_cstr(s, sf->field->name);
2897 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
2898 ds_put_cstr(s, "[]");
2899 } else if (sf->n_bits == 1) {
2900 ds_put_format(s, "[%d]", sf->ofs);
2902 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
2906 static const struct mf_field *
2907 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
2911 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
2916 for (i = 0; i < MFF_N_IDS; i++) {
2917 const struct mf_field *mf = mf_from_id(i);
2920 && !strncmp(mf->nxm_name, name, name_len)
2921 && mf->nxm_name[name_len] == '\0') {
2925 && !strncmp(mf->oxm_name, name, name_len)
2926 && mf->oxm_name[name_len] == '\0') {
2934 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2935 * returns NULL and advances '*sp' to the first byte following the parsed
2936 * string. On failure, returns a malloc()'d error message, does not modify
2937 * '*sp', and does not properly initialize 'sf'.
2939 * The syntax parsed from '*sp' takes the form "header[start..end]" where
2940 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2941 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2942 * may both be omitted (the [] are still required) to indicate an entire
2944 char * WARN_UNUSED_RESULT
2945 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
2947 const struct mf_field *field;
2956 name_len = strcspn(s, "[");
2957 if (s[name_len] != '[') {
2958 return xasprintf("%s: missing [ looking for field name", *sp);
2961 field = mf_parse_subfield_name(name, name_len, &wild);
2963 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
2967 if (ovs_scan(s, "[%d..%d]", &start, &end)) {
2968 /* Nothing to do. */
2969 } else if (ovs_scan(s, "[%d]", &start)) {
2971 } else if (!strncmp(s, "[]", 2)) {
2973 end = field->n_bits - 1;
2975 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2976 "[<start>..<end>]", *sp);
2978 s = strchr(s, ']') + 1;
2981 return xasprintf("%s: starting bit %d is after ending bit %d",
2983 } else if (start >= field->n_bits) {
2984 return xasprintf("%s: starting bit %d is not valid because field is "
2985 "only %d bits wide", *sp, start, field->n_bits);
2986 } else if (end >= field->n_bits){
2987 return xasprintf("%s: ending bit %d is not valid because field is "
2988 "only %d bits wide", *sp, end, field->n_bits);
2993 sf->n_bits = end - start + 1;
2999 /* Parses a subfield from the entirety of 's' into 'sf'. Returns NULL if
3000 * successful, otherwise a malloc()'d string describing the error. The caller
3001 * is responsible for freeing the returned string.
3003 * The syntax parsed from 's' takes the form "header[start..end]" where
3004 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
3005 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
3006 * may both be omitted (the [] are still required) to indicate an entire
3008 char * WARN_UNUSED_RESULT
3009 mf_parse_subfield(struct mf_subfield *sf, const char *s)
3011 char *error = mf_parse_subfield__(sf, &s);
3012 if (!error && s[0]) {
3013 error = xstrdup("unexpected input following field syntax");
3019 mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s)
3023 for (i = 0; i < ARRAY_SIZE(subvalue->u8); i++) {
3024 if (subvalue->u8[i]) {
3025 ds_put_format(s, "0x%"PRIx8, subvalue->u8[i]);
3026 for (i++; i < ARRAY_SIZE(subvalue->u8); i++) {
3027 ds_put_format(s, "%02"PRIx8, subvalue->u8[i]);
3032 ds_put_char(s, '0');