2 * Copyright (c) 2011, 2012, 2013 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "meta-flow.h"
23 #include <netinet/icmp6.h>
24 #include <netinet/ip6.h>
26 #include "classifier.h"
27 #include "dynamic-string.h"
28 #include "ofp-errors.h"
30 #include "ovs-thread.h"
34 #include "socket-util.h"
35 #include "unaligned.h"
38 VLOG_DEFINE_THIS_MODULE(meta_flow);
40 #define MF_FIELD_SIZES(MEMBER) \
41 sizeof ((union mf_value *)0)->MEMBER, \
42 8 * sizeof ((union mf_value *)0)->MEMBER
44 static const struct mf_field mf_fields[MFF_N_IDS] = {
50 MFF_TUN_ID, "tun_id", NULL,
56 NXM_NX_TUN_ID, "NXM_NX_TUN_ID",
57 OXM_OF_TUNNEL_ID, "OXM_OF_TUNNEL_ID",
58 OFPUTIL_P_NXM_OXM_ANY,
59 OFPUTIL_P_NXM_OXM_ANY,
61 MFF_TUN_SRC, "tun_src", NULL,
67 NXM_NX_TUN_IPV4_SRC, "NXM_NX_TUN_IPV4_SRC",
68 NXM_NX_TUN_IPV4_SRC, "NXM_NX_TUN_IPV4_SRC",
69 OFPUTIL_P_NXM_OXM_ANY,
70 OFPUTIL_P_NXM_OXM_ANY,
72 MFF_TUN_DST, "tun_dst", NULL,
78 NXM_NX_TUN_IPV4_DST, "NXM_NX_TUN_IPV4_DST",
79 NXM_NX_TUN_IPV4_DST, "NXM_NX_TUN_IPV4_DST",
80 OFPUTIL_P_NXM_OXM_ANY,
81 OFPUTIL_P_NXM_OXM_ANY,
83 MFF_TUN_FLAGS, "tun_flags", NULL,
94 MFF_TUN_TTL, "tun_ttl", NULL,
105 MFF_TUN_TOS, "tun_tos", NULL,
116 MFF_METADATA, "metadata", NULL,
117 MF_FIELD_SIZES(be64),
122 OXM_OF_METADATA, "OXM_OF_METADATA",
123 OXM_OF_METADATA, "OXM_OF_METADATA",
124 OFPUTIL_P_NXM_OF11_UP,
125 OFPUTIL_P_NXM_OF11_UP,
127 MFF_IN_PORT, "in_port", NULL,
128 MF_FIELD_SIZES(be16),
133 NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
134 NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
135 OFPUTIL_P_ANY, /* OF11+ via mapping to 32 bits. */
138 MFF_IN_PORT_OXM, "in_port_oxm", NULL,
139 MF_FIELD_SIZES(be32),
144 OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
145 OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
149 MFF_SKB_PRIORITY, "skb_priority", NULL,
150 MF_FIELD_SIZES(be32),
160 MFF_PKT_MARK, "pkt_mark", NULL,
161 MF_FIELD_SIZES(be32),
166 NXM_NX_PKT_MARK, "NXM_NX_PKT_MARK",
167 NXM_NX_PKT_MARK, "NXM_NX_PKT_MARK",
168 OFPUTIL_P_NXM_OXM_ANY,
169 OFPUTIL_P_NXM_OXM_ANY,
172 #define REGISTER(IDX) \
174 MFF_REG##IDX, "reg" #IDX, NULL, \
175 MF_FIELD_SIZES(be32), \
180 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
181 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
182 OFPUTIL_P_NXM_OXM_ANY, \
183 OFPUTIL_P_NXM_OXM_ANY, \
218 MFF_ETH_SRC, "eth_src", "dl_src",
224 NXM_OF_ETH_SRC, "NXM_OF_ETH_SRC",
225 OXM_OF_ETH_SRC, "OXM_OF_ETH_SRC",
227 OFPUTIL_P_NXM_OF11_UP, /* Bitwise masking only with NXM and OF11+! */
229 MFF_ETH_DST, "eth_dst", "dl_dst",
235 NXM_OF_ETH_DST, "NXM_OF_ETH_DST",
236 OXM_OF_ETH_DST, "OXM_OF_ETH_DST",
238 OFPUTIL_P_NXM_OF11_UP, /* Bitwise masking only with NXM and OF11+! */
240 MFF_ETH_TYPE, "eth_type", "dl_type",
241 MF_FIELD_SIZES(be16),
246 NXM_OF_ETH_TYPE, "NXM_OF_ETH_TYPE",
247 OXM_OF_ETH_TYPE, "OXM_OF_ETH_TYPE",
253 MFF_VLAN_TCI, "vlan_tci", NULL,
254 MF_FIELD_SIZES(be16),
259 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
260 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
262 OFPUTIL_P_NXM_OXM_ANY,
264 MFF_DL_VLAN, "dl_vlan", NULL,
265 sizeof(ovs_be16), 12,
273 OFPUTIL_P_NXM_OXM_ANY,
275 MFF_VLAN_VID, "vlan_vid", NULL,
276 sizeof(ovs_be16), 12,
281 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
282 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
284 OFPUTIL_P_NXM_OXM_ANY,
286 MFF_DL_VLAN_PCP, "dl_vlan_pcp", NULL,
294 OFPUTIL_P_ANY, /* Will be mapped to NXM and OXM. */
297 MFF_VLAN_PCP, "vlan_pcp", NULL,
303 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
304 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
305 OFPUTIL_P_ANY, /* Will be mapped to OF10 and NXM. */
313 MFF_MPLS_LABEL, "mpls_label", NULL,
319 OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
320 OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
321 OFPUTIL_P_NXM_OF11_UP,
324 MFF_MPLS_TC, "mpls_tc", NULL,
330 OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
331 OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
332 OFPUTIL_P_NXM_OF11_UP,
335 MFF_MPLS_BOS, "mpls_bos", NULL,
341 OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
342 OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
343 OFPUTIL_P_NXM_OXM_ANY,
352 MFF_IPV4_SRC, "ip_src", "nw_src",
353 MF_FIELD_SIZES(be32),
358 NXM_OF_IP_SRC, "NXM_OF_IP_SRC",
359 OXM_OF_IPV4_SRC, "OXM_OF_IPV4_SRC",
361 OFPUTIL_P_NXM_OF11_UP,
363 MFF_IPV4_DST, "ip_dst", "nw_dst",
364 MF_FIELD_SIZES(be32),
369 NXM_OF_IP_DST, "NXM_OF_IP_DST",
370 OXM_OF_IPV4_DST, "OXM_OF_IPV4_DST",
372 OFPUTIL_P_NXM_OF11_UP,
376 MFF_IPV6_SRC, "ipv6_src", NULL,
377 MF_FIELD_SIZES(ipv6),
382 NXM_NX_IPV6_SRC, "NXM_NX_IPV6_SRC",
383 OXM_OF_IPV6_SRC, "OXM_OF_IPV6_SRC",
384 OFPUTIL_P_NXM_OXM_ANY,
385 OFPUTIL_P_NXM_OXM_ANY,
387 MFF_IPV6_DST, "ipv6_dst", NULL,
388 MF_FIELD_SIZES(ipv6),
393 NXM_NX_IPV6_DST, "NXM_NX_IPV6_DST",
394 OXM_OF_IPV6_DST, "OXM_OF_IPV6_DST",
395 OFPUTIL_P_NXM_OXM_ANY,
396 OFPUTIL_P_NXM_OXM_ANY,
399 MFF_IPV6_LABEL, "ipv6_label", NULL,
405 NXM_NX_IPV6_LABEL, "NXM_NX_IPV6_LABEL",
406 OXM_OF_IPV6_FLABEL, "OXM_OF_IPV6_FLABEL",
407 OFPUTIL_P_NXM_OXM_ANY,
408 OFPUTIL_P_NXM_OXM_ANY,
412 MFF_IP_PROTO, "nw_proto", NULL,
418 NXM_OF_IP_PROTO, "NXM_OF_IP_PROTO",
419 OXM_OF_IP_PROTO, "OXM_OF_IP_PROTO",
423 MFF_IP_DSCP, "nw_tos", NULL,
429 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
430 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
431 OFPUTIL_P_ANY, /* Will be shifted for OXM. */
434 MFF_IP_DSCP_SHIFTED, "nw_tos_shifted", NULL,
440 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
441 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
442 OFPUTIL_P_ANY, /* Will be shifted for non-OXM. */
445 MFF_IP_ECN, "nw_ecn", NULL,
451 NXM_NX_IP_ECN, "NXM_NX_IP_ECN",
452 OXM_OF_IP_ECN, "OXM_OF_IP_ECN",
453 OFPUTIL_P_NXM_OXM_ANY,
456 MFF_IP_TTL, "nw_ttl", NULL,
462 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
463 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
464 OFPUTIL_P_NXM_OXM_ANY,
467 MFF_IP_FRAG, "ip_frag", NULL,
473 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
474 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
475 OFPUTIL_P_NXM_OXM_ANY,
476 OFPUTIL_P_NXM_OXM_ANY,
480 MFF_ARP_OP, "arp_op", NULL,
481 MF_FIELD_SIZES(be16),
486 NXM_OF_ARP_OP, "NXM_OF_ARP_OP",
487 OXM_OF_ARP_OP, "OXM_OF_ARP_OP",
491 MFF_ARP_SPA, "arp_spa", NULL,
492 MF_FIELD_SIZES(be32),
497 NXM_OF_ARP_SPA, "NXM_OF_ARP_SPA",
498 OXM_OF_ARP_SPA, "OXM_OF_ARP_SPA",
500 OFPUTIL_P_NXM_OF11_UP,
502 MFF_ARP_TPA, "arp_tpa", NULL,
503 MF_FIELD_SIZES(be32),
508 NXM_OF_ARP_TPA, "NXM_OF_ARP_TPA",
509 OXM_OF_ARP_TPA, "OXM_OF_ARP_TPA",
511 OFPUTIL_P_NXM_OF11_UP,
513 MFF_ARP_SHA, "arp_sha", NULL,
519 NXM_NX_ARP_SHA, "NXM_NX_ARP_SHA",
520 OXM_OF_ARP_SHA, "OXM_OF_ARP_SHA",
521 OFPUTIL_P_NXM_OXM_ANY,
522 OFPUTIL_P_NXM_OXM_ANY,
524 MFF_ARP_THA, "arp_tha", NULL,
530 NXM_NX_ARP_THA, "NXM_NX_ARP_THA",
531 OXM_OF_ARP_THA, "OXM_OF_ARP_THA",
532 OFPUTIL_P_NXM_OXM_ANY,
533 OFPUTIL_P_NXM_OXM_ANY,
541 MFF_TCP_SRC, "tcp_src", "tp_src",
542 MF_FIELD_SIZES(be16),
547 NXM_OF_TCP_SRC, "NXM_OF_TCP_SRC",
548 OXM_OF_TCP_SRC, "OXM_OF_TCP_SRC",
550 OFPUTIL_P_NXM_OXM_ANY,
552 MFF_TCP_DST, "tcp_dst", "tp_dst",
553 MF_FIELD_SIZES(be16),
558 NXM_OF_TCP_DST, "NXM_OF_TCP_DST",
559 OXM_OF_TCP_DST, "OXM_OF_TCP_DST",
561 OFPUTIL_P_NXM_OXM_ANY,
565 MFF_UDP_SRC, "udp_src", NULL,
566 MF_FIELD_SIZES(be16),
571 NXM_OF_UDP_SRC, "NXM_OF_UDP_SRC",
572 OXM_OF_UDP_SRC, "OXM_OF_UDP_SRC",
574 OFPUTIL_P_NXM_OXM_ANY,
576 MFF_UDP_DST, "udp_dst", NULL,
577 MF_FIELD_SIZES(be16),
582 NXM_OF_UDP_DST, "NXM_OF_UDP_DST",
583 OXM_OF_UDP_DST, "OXM_OF_UDP_DST",
585 OFPUTIL_P_NXM_OXM_ANY,
589 MFF_SCTP_SRC, "sctp_src", NULL,
590 MF_FIELD_SIZES(be16),
595 OXM_OF_SCTP_SRC, "OXM_OF_SCTP_SRC",
596 OXM_OF_SCTP_SRC, "OXM_OF_SCTP_SRC",
597 OFPUTIL_P_NXM_OF11_UP,
598 OFPUTIL_P_NXM_OXM_ANY,
600 MFF_SCTP_DST, "sctp_dst", NULL,
601 MF_FIELD_SIZES(be16),
606 OXM_OF_SCTP_DST, "OXM_OF_SCTP_DST",
607 OXM_OF_SCTP_DST, "OXM_OF_SCTP_DST",
608 OFPUTIL_P_NXM_OF11_UP,
609 OFPUTIL_P_NXM_OXM_ANY,
613 MFF_ICMPV4_TYPE, "icmp_type", NULL,
619 NXM_OF_ICMP_TYPE, "NXM_OF_ICMP_TYPE",
620 OXM_OF_ICMPV4_TYPE, "OXM_OF_ICMPV4_TYPE",
624 MFF_ICMPV4_CODE, "icmp_code", NULL,
630 NXM_OF_ICMP_CODE, "NXM_OF_ICMP_CODE",
631 OXM_OF_ICMPV4_CODE, "OXM_OF_ICMPV4_CODE",
637 MFF_ICMPV6_TYPE, "icmpv6_type", NULL,
643 NXM_NX_ICMPV6_TYPE, "NXM_NX_ICMPV6_TYPE",
644 OXM_OF_ICMPV6_TYPE, "OXM_OF_ICMPV6_TYPE",
645 OFPUTIL_P_NXM_OXM_ANY,
648 MFF_ICMPV6_CODE, "icmpv6_code", NULL,
654 NXM_NX_ICMPV6_CODE, "NXM_NX_ICMPV6_CODE",
655 OXM_OF_ICMPV6_CODE, "OXM_OF_ICMPV6_CODE",
656 OFPUTIL_P_NXM_OXM_ANY,
665 MFF_ND_TARGET, "nd_target", NULL,
666 MF_FIELD_SIZES(ipv6),
671 NXM_NX_ND_TARGET, "NXM_NX_ND_TARGET",
672 OXM_OF_IPV6_ND_TARGET, "OXM_OF_IPV6_ND_TARGET",
673 OFPUTIL_P_NXM_OXM_ANY,
674 OFPUTIL_P_NXM_OXM_ANY,
676 MFF_ND_SLL, "nd_sll", NULL,
682 NXM_NX_ND_SLL, "NXM_NX_ND_SLL",
683 OXM_OF_IPV6_ND_SLL, "OXM_OF_IPV6_ND_SLL",
684 OFPUTIL_P_NXM_OXM_ANY,
685 OFPUTIL_P_NXM_OXM_ANY,
687 MFF_ND_TLL, "nd_tll", NULL,
693 NXM_NX_ND_TLL, "NXM_NX_ND_TLL",
694 OXM_OF_IPV6_ND_TLL, "OXM_OF_IPV6_ND_TLL",
695 OFPUTIL_P_NXM_OXM_ANY,
696 OFPUTIL_P_NXM_OXM_ANY,
700 /* Maps an NXM or OXM header value to an mf_field. */
702 struct hmap_node hmap_node; /* In 'all_fields' hmap. */
703 uint32_t header; /* NXM or OXM header value. */
704 const struct mf_field *mf;
707 /* Contains 'struct nxm_field's. */
708 static struct hmap all_fields;
710 /* Maps from an mf_field's 'name' or 'extra_name' to the mf_field. */
711 static struct shash mf_by_name;
713 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
714 * controller and so there's not much point in showing a lot of them. */
715 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
717 const struct mf_field *mf_from_nxm_header__(uint32_t header);
718 static void nxm_init(void);
720 /* Returns the field with the given 'id'. */
721 const struct mf_field *
722 mf_from_id(enum mf_field_id id)
724 ovs_assert((unsigned int) id < MFF_N_IDS);
725 return &mf_fields[id];
728 /* Returns the field with the given 'name', or a null pointer if no field has
730 const struct mf_field *
731 mf_from_name(const char *name)
734 return shash_find_data(&mf_by_name, name);
738 add_nxm_field(uint32_t header, const struct mf_field *mf)
742 f = xmalloc(sizeof *f);
743 hmap_insert(&all_fields, &f->hmap_node, hash_int(header, 0));
749 nxm_init_add_field(const struct mf_field *mf, uint32_t header)
752 ovs_assert(!mf_from_nxm_header__(header));
753 add_nxm_field(header, mf);
754 if (mf->maskable != MFM_NONE) {
755 add_nxm_field(NXM_MAKE_WILD_HEADER(header), mf);
765 hmap_init(&all_fields);
766 shash_init(&mf_by_name);
767 for (i = 0; i < MFF_N_IDS; i++) {
768 const struct mf_field *mf = &mf_fields[i];
770 ovs_assert(mf->id == i); /* Fields must be in the enum order. */
772 nxm_init_add_field(mf, mf->nxm_header);
773 if (mf->oxm_header != mf->nxm_header) {
774 nxm_init_add_field(mf, mf->oxm_header);
777 shash_add_once(&mf_by_name, mf->name, mf);
778 if (mf->extra_name) {
779 shash_add_once(&mf_by_name, mf->extra_name, mf);
787 static pthread_once_t once = PTHREAD_ONCE_INIT;
788 pthread_once(&once, nxm_do_init);
791 const struct mf_field *
792 mf_from_nxm_header(uint32_t header)
795 return mf_from_nxm_header__(header);
798 const struct mf_field *
799 mf_from_nxm_header__(uint32_t header)
801 const struct nxm_field *f;
803 HMAP_FOR_EACH_IN_BUCKET (f, hmap_node, hash_int(header, 0), &all_fields) {
804 if (f->header == header) {
812 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
813 * specifies at least one bit in the field.
815 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
816 * meets 'mf''s prerequisites. */
818 mf_is_all_wild(const struct mf_field *mf, const struct flow_wildcards *wc)
822 return !wc->masks.tunnel.ip_src;
824 return !wc->masks.tunnel.ip_dst;
829 return !wc->masks.tunnel.tun_id;
831 return !wc->masks.metadata;
833 case MFF_IN_PORT_OXM:
834 return !wc->masks.in_port.ofp_port;
835 case MFF_SKB_PRIORITY:
836 return !wc->masks.skb_priority;
838 return !wc->masks.pkt_mark;
840 return !wc->masks.regs[mf->id - MFF_REG0];
843 return eth_addr_is_zero(wc->masks.dl_src);
845 return eth_addr_is_zero(wc->masks.dl_dst);
847 return !wc->masks.dl_type;
851 return eth_addr_is_zero(wc->masks.arp_sha);
855 return eth_addr_is_zero(wc->masks.arp_tha);
858 return !wc->masks.vlan_tci;
860 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK));
862 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI));
863 case MFF_DL_VLAN_PCP:
865 return !(wc->masks.vlan_tci & htons(VLAN_PCP_MASK));
868 return !(wc->masks.mpls_lse & htonl(MPLS_LABEL_MASK));
870 return !(wc->masks.mpls_lse & htonl(MPLS_TC_MASK));
872 return !(wc->masks.mpls_lse & htonl(MPLS_BOS_MASK));
875 return !wc->masks.nw_src;
877 return !wc->masks.nw_dst;
880 return ipv6_mask_is_any(&wc->masks.ipv6_src);
882 return ipv6_mask_is_any(&wc->masks.ipv6_dst);
885 return !wc->masks.ipv6_label;
888 return !wc->masks.nw_proto;
890 case MFF_IP_DSCP_SHIFTED:
891 return !(wc->masks.nw_tos & IP_DSCP_MASK);
893 return !(wc->masks.nw_tos & IP_ECN_MASK);
895 return !wc->masks.nw_ttl;
898 return ipv6_mask_is_any(&wc->masks.nd_target);
901 return !(wc->masks.nw_frag & FLOW_NW_FRAG_MASK);
904 return !wc->masks.nw_proto;
906 return !wc->masks.nw_src;
908 return !wc->masks.nw_dst;
913 case MFF_ICMPV4_TYPE:
914 case MFF_ICMPV6_TYPE:
915 return !wc->masks.tp_src;
919 case MFF_ICMPV4_CODE:
920 case MFF_ICMPV6_CODE:
921 return !wc->masks.tp_dst;
929 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
930 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
931 * purposes, or to 0 if it is wildcarded.
933 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
934 * meets 'mf''s prerequisites. */
936 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
937 union mf_value *mask)
939 mf_get_value(mf, &wc->masks, mask);
942 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
943 * if the mask is valid, false otherwise. */
945 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
947 switch (mf->maskable) {
949 return (is_all_zeros((const uint8_t *) mask, mf->n_bytes) ||
950 is_all_ones((const uint8_t *) mask, mf->n_bytes));
960 is_icmpv4(const struct flow *flow)
962 return (flow->dl_type == htons(ETH_TYPE_IP)
963 && flow->nw_proto == IPPROTO_ICMP);
967 is_icmpv6(const struct flow *flow)
969 return (flow->dl_type == htons(ETH_TYPE_IPV6)
970 && flow->nw_proto == IPPROTO_ICMPV6);
973 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
975 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
977 switch (mf->prereqs) {
982 return (flow->dl_type == htons(ETH_TYPE_ARP) ||
983 flow->dl_type == htons(ETH_TYPE_RARP));
985 return flow->dl_type == htons(ETH_TYPE_IP);
987 return flow->dl_type == htons(ETH_TYPE_IPV6);
989 return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
991 return eth_type_mpls(flow->dl_type);
993 return is_ip_any(flow);
996 return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP;
998 return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP;
1000 return is_ip_any(flow) && flow->nw_proto == IPPROTO_SCTP;
1002 return is_icmpv4(flow);
1004 return is_icmpv6(flow);
1007 return (is_icmpv6(flow)
1008 && flow->tp_dst == htons(0)
1009 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
1010 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
1011 case MFP_ND_SOLICIT:
1012 return (is_icmpv6(flow)
1013 && flow->tp_dst == htons(0)
1014 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
1016 return (is_icmpv6(flow)
1017 && flow->tp_dst == htons(0)
1018 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
1024 /* Set field and it's prerequisities in the mask.
1025 * This is only ever called for writeable 'mf's, but we do not make the
1026 * distinction here. */
1028 mf_mask_field_and_prereqs(const struct mf_field *mf, struct flow *mask)
1030 static const union mf_value exact_match_mask = MF_EXACT_MASK_INITIALIZER;
1032 mf_set_flow_value(mf, &exact_match_mask, mask);
1034 switch (mf->prereqs) {
1036 case MFP_ND_SOLICIT:
1038 mask->tp_src = OVS_BE16_MAX;
1039 mask->tp_dst = OVS_BE16_MAX;
1046 mask->nw_proto = 0xff;
1053 mask->dl_type = OVS_BE16_MAX;
1056 mask->vlan_tci |= htons(VLAN_CFI);
1064 /* Returns true if 'value' may be a valid value *as part of a masked match*,
1067 * A value is not rejected just because it is not valid for the field in
1068 * question, but only if it doesn't make sense to test the bits in question at
1069 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
1070 * without the VLAN_CFI bit being set, but we can't reject those values because
1071 * it is still legitimate to test just for those bits (see the documentation
1072 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
1073 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
1075 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
1086 case MFF_SKB_PRIORITY:
1109 case MFF_ICMPV4_TYPE:
1110 case MFF_ICMPV4_CODE:
1111 case MFF_ICMPV6_TYPE:
1112 case MFF_ICMPV6_CODE:
1118 case MFF_IN_PORT_OXM: {
1120 return !ofputil_port_from_ofp11(value->be32, &port);
1124 return !(value->u8 & ~IP_DSCP_MASK);
1125 case MFF_IP_DSCP_SHIFTED:
1126 return !(value->u8 & (~IP_DSCP_MASK >> 2));
1128 return !(value->u8 & ~IP_ECN_MASK);
1130 return !(value->u8 & ~FLOW_NW_FRAG_MASK);
1133 return !(value->be16 & htons(0xff00));
1136 return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
1138 return !(value->be16 & htons(VLAN_PCP_MASK));
1140 case MFF_DL_VLAN_PCP:
1142 return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
1144 case MFF_IPV6_LABEL:
1145 return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
1147 case MFF_MPLS_LABEL:
1148 return !(value->be32 & ~htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT));
1151 return !(value->u8 & ~(MPLS_TC_MASK >> MPLS_TC_SHIFT));
1154 return !(value->u8 & ~(MPLS_BOS_MASK >> MPLS_BOS_SHIFT));
1162 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
1163 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
1165 mf_get_value(const struct mf_field *mf, const struct flow *flow,
1166 union mf_value *value)
1170 value->be64 = flow->tunnel.tun_id;
1173 value->be32 = flow->tunnel.ip_src;
1176 value->be32 = flow->tunnel.ip_dst;
1179 value->be16 = htons(flow->tunnel.flags);
1182 value->u8 = flow->tunnel.ip_ttl;
1185 value->u8 = flow->tunnel.ip_tos;
1189 value->be64 = flow->metadata;
1193 value->be16 = htons(ofp_to_u16(flow->in_port.ofp_port));
1195 case MFF_IN_PORT_OXM:
1196 value->be32 = ofputil_port_to_ofp11(flow->in_port.ofp_port);
1199 case MFF_SKB_PRIORITY:
1200 value->be32 = htonl(flow->skb_priority);
1204 value->be32 = htonl(flow->pkt_mark);
1208 value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
1212 memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
1216 memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
1220 value->be16 = flow->dl_type;
1224 value->be16 = flow->vlan_tci;
1228 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
1231 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
1234 case MFF_DL_VLAN_PCP:
1236 value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
1239 case MFF_MPLS_LABEL:
1240 value->be32 = htonl(mpls_lse_to_label(flow->mpls_lse));
1244 value->u8 = mpls_lse_to_tc(flow->mpls_lse);
1248 value->u8 = mpls_lse_to_bos(flow->mpls_lse);
1252 value->be32 = flow->nw_src;
1256 value->be32 = flow->nw_dst;
1260 value->ipv6 = flow->ipv6_src;
1264 value->ipv6 = flow->ipv6_dst;
1267 case MFF_IPV6_LABEL:
1268 value->be32 = flow->ipv6_label;
1272 value->u8 = flow->nw_proto;
1276 value->u8 = flow->nw_tos & IP_DSCP_MASK;
1279 case MFF_IP_DSCP_SHIFTED:
1280 value->u8 = flow->nw_tos >> 2;
1284 value->u8 = flow->nw_tos & IP_ECN_MASK;
1288 value->u8 = flow->nw_ttl;
1292 value->u8 = flow->nw_frag;
1296 value->be16 = htons(flow->nw_proto);
1300 value->be32 = flow->nw_src;
1304 value->be32 = flow->nw_dst;
1309 memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
1314 memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
1320 value->be16 = flow->tp_src;
1326 value->be16 = flow->tp_dst;
1329 case MFF_ICMPV4_TYPE:
1330 case MFF_ICMPV6_TYPE:
1331 value->u8 = ntohs(flow->tp_src);
1334 case MFF_ICMPV4_CODE:
1335 case MFF_ICMPV6_CODE:
1336 value->u8 = ntohs(flow->tp_dst);
1340 value->ipv6 = flow->nd_target;
1349 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1350 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1353 mf_set_value(const struct mf_field *mf,
1354 const union mf_value *value, struct match *match)
1358 match_set_tun_id(match, value->be64);
1361 match_set_tun_src(match, value->be32);
1364 match_set_tun_dst(match, value->be32);
1367 match_set_tun_flags(match, ntohs(value->be16));
1370 match_set_tun_tos(match, value->u8);
1373 match_set_tun_ttl(match, value->u8);
1377 match_set_metadata(match, value->be64);
1381 match_set_in_port(match, u16_to_ofp(ntohs(value->be16)));
1384 case MFF_IN_PORT_OXM: {
1386 ofputil_port_from_ofp11(value->be32, &port);
1387 match_set_in_port(match, port);
1391 case MFF_SKB_PRIORITY:
1392 match_set_skb_priority(match, ntohl(value->be32));
1396 match_set_pkt_mark(match, ntohl(value->be32));
1400 match_set_reg(match, mf->id - MFF_REG0, ntohl(value->be32));
1404 match_set_dl_src(match, value->mac);
1408 match_set_dl_dst(match, value->mac);
1412 match_set_dl_type(match, value->be16);
1416 match_set_dl_tci(match, value->be16);
1420 match_set_dl_vlan(match, value->be16);
1423 match_set_vlan_vid(match, value->be16);
1426 case MFF_DL_VLAN_PCP:
1428 match_set_dl_vlan_pcp(match, value->u8);
1431 case MFF_MPLS_LABEL:
1432 match_set_mpls_label(match, value->be32);
1436 match_set_mpls_tc(match, value->u8);
1440 match_set_mpls_bos(match, value->u8);
1444 match_set_nw_src(match, value->be32);
1448 match_set_nw_dst(match, value->be32);
1452 match_set_ipv6_src(match, &value->ipv6);
1456 match_set_ipv6_dst(match, &value->ipv6);
1459 case MFF_IPV6_LABEL:
1460 match_set_ipv6_label(match, value->be32);
1464 match_set_nw_proto(match, value->u8);
1468 match_set_nw_dscp(match, value->u8);
1471 case MFF_IP_DSCP_SHIFTED:
1472 match_set_nw_dscp(match, value->u8 << 2);
1476 match_set_nw_ecn(match, value->u8);
1480 match_set_nw_ttl(match, value->u8);
1484 match_set_nw_frag(match, value->u8);
1488 match_set_nw_proto(match, ntohs(value->be16));
1492 match_set_nw_src(match, value->be32);
1496 match_set_nw_dst(match, value->be32);
1501 match_set_arp_sha(match, value->mac);
1506 match_set_arp_tha(match, value->mac);
1512 match_set_tp_src(match, value->be16);
1518 match_set_tp_dst(match, value->be16);
1521 case MFF_ICMPV4_TYPE:
1522 case MFF_ICMPV6_TYPE:
1523 match_set_icmp_type(match, value->u8);
1526 case MFF_ICMPV4_CODE:
1527 case MFF_ICMPV6_CODE:
1528 match_set_icmp_code(match, value->u8);
1532 match_set_nd_target(match, &value->ipv6);
1541 /* Sets 'flow' member field described by 'mf' to 'value'. The caller is
1542 * responsible for ensuring that 'flow' meets 'mf''s prerequisites.*/
1544 mf_set_flow_value(const struct mf_field *mf,
1545 const union mf_value *value, struct flow *flow)
1549 flow->tunnel.tun_id = value->be64;
1552 flow->tunnel.ip_src = value->be32;
1555 flow->tunnel.ip_dst = value->be32;
1558 flow->tunnel.flags = ntohs(value->be16);
1561 flow->tunnel.ip_tos = value->u8;
1564 flow->tunnel.ip_ttl = value->u8;
1568 flow->metadata = value->be64;
1572 flow->in_port.ofp_port = u16_to_ofp(ntohs(value->be16));
1575 case MFF_IN_PORT_OXM: {
1577 ofputil_port_from_ofp11(value->be32, &port);
1578 flow->in_port.ofp_port = port;
1582 case MFF_SKB_PRIORITY:
1583 flow->skb_priority = ntohl(value->be32);
1587 flow->pkt_mark = ntohl(value->be32);
1591 flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1595 memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
1599 memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
1603 flow->dl_type = value->be16;
1607 flow->vlan_tci = value->be16;
1611 flow_set_dl_vlan(flow, value->be16);
1614 flow_set_vlan_vid(flow, value->be16);
1617 case MFF_DL_VLAN_PCP:
1619 flow_set_vlan_pcp(flow, value->u8);
1622 case MFF_MPLS_LABEL:
1623 flow_set_mpls_label(flow, value->be32);
1627 flow_set_mpls_tc(flow, value->u8);
1631 flow_set_mpls_bos(flow, value->u8);
1635 flow->nw_src = value->be32;
1639 flow->nw_dst = value->be32;
1643 flow->ipv6_src = value->ipv6;
1647 flow->ipv6_dst = value->ipv6;
1650 case MFF_IPV6_LABEL:
1651 flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1655 flow->nw_proto = value->u8;
1659 flow->nw_tos &= ~IP_DSCP_MASK;
1660 flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1663 case MFF_IP_DSCP_SHIFTED:
1664 flow->nw_tos &= ~IP_DSCP_MASK;
1665 flow->nw_tos |= value->u8 << 2;
1669 flow->nw_tos &= ~IP_ECN_MASK;
1670 flow->nw_tos |= value->u8 & IP_ECN_MASK;
1674 flow->nw_ttl = value->u8;
1678 flow->nw_frag &= value->u8;
1682 flow->nw_proto = ntohs(value->be16);
1686 flow->nw_src = value->be32;
1690 flow->nw_dst = value->be32;
1695 memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1700 memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1706 flow->tp_src = value->be16;
1712 flow->tp_dst = value->be16;
1715 case MFF_ICMPV4_TYPE:
1716 case MFF_ICMPV6_TYPE:
1717 flow->tp_src = htons(value->u8);
1720 case MFF_ICMPV4_CODE:
1721 case MFF_ICMPV6_CODE:
1722 flow->tp_dst = htons(value->u8);
1726 flow->nd_target = value->ipv6;
1735 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1737 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1740 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1742 union mf_value value;
1744 mf_get_value(mf, flow, &value);
1745 return is_all_zeros((const uint8_t *) &value, mf->n_bytes);
1748 /* Makes 'match' wildcard field 'mf'.
1750 * The caller is responsible for ensuring that 'match' meets 'mf''s
1753 mf_set_wild(const struct mf_field *mf, struct match *match)
1757 match_set_tun_id_masked(match, htonll(0), htonll(0));
1760 match_set_tun_src_masked(match, htonl(0), htonl(0));
1763 match_set_tun_dst_masked(match, htonl(0), htonl(0));
1766 match_set_tun_flags_masked(match, 0, 0);
1769 match_set_tun_tos_masked(match, 0, 0);
1772 match_set_tun_ttl_masked(match, 0, 0);
1776 match_set_metadata_masked(match, htonll(0), htonll(0));
1780 case MFF_IN_PORT_OXM:
1781 match->flow.in_port.ofp_port = 0;
1782 match->wc.masks.in_port.ofp_port = 0;
1785 case MFF_SKB_PRIORITY:
1786 match->flow.skb_priority = 0;
1787 match->wc.masks.skb_priority = 0;
1791 match->flow.pkt_mark = 0;
1792 match->wc.masks.pkt_mark = 0;
1796 match_set_reg_masked(match, mf->id - MFF_REG0, 0, 0);
1800 memset(match->flow.dl_src, 0, ETH_ADDR_LEN);
1801 memset(match->wc.masks.dl_src, 0, ETH_ADDR_LEN);
1805 memset(match->flow.dl_dst, 0, ETH_ADDR_LEN);
1806 memset(match->wc.masks.dl_dst, 0, ETH_ADDR_LEN);
1810 match->flow.dl_type = htons(0);
1811 match->wc.masks.dl_type = htons(0);
1815 match_set_dl_tci_masked(match, htons(0), htons(0));
1820 match_set_any_vid(match);
1823 case MFF_DL_VLAN_PCP:
1825 match_set_any_pcp(match);
1828 case MFF_MPLS_LABEL:
1829 match_set_any_mpls_label(match);
1833 match_set_any_mpls_tc(match);
1837 match_set_any_mpls_bos(match);
1842 match_set_nw_src_masked(match, htonl(0), htonl(0));
1847 match_set_nw_dst_masked(match, htonl(0), htonl(0));
1851 memset(&match->wc.masks.ipv6_src, 0, sizeof match->wc.masks.ipv6_src);
1852 memset(&match->flow.ipv6_src, 0, sizeof match->flow.ipv6_src);
1856 memset(&match->wc.masks.ipv6_dst, 0, sizeof match->wc.masks.ipv6_dst);
1857 memset(&match->flow.ipv6_dst, 0, sizeof match->flow.ipv6_dst);
1860 case MFF_IPV6_LABEL:
1861 match->wc.masks.ipv6_label = htonl(0);
1862 match->flow.ipv6_label = htonl(0);
1866 match->wc.masks.nw_proto = 0;
1867 match->flow.nw_proto = 0;
1871 case MFF_IP_DSCP_SHIFTED:
1872 match->wc.masks.nw_tos &= ~IP_DSCP_MASK;
1873 match->flow.nw_tos &= ~IP_DSCP_MASK;
1877 match->wc.masks.nw_tos &= ~IP_ECN_MASK;
1878 match->flow.nw_tos &= ~IP_ECN_MASK;
1882 match->wc.masks.nw_ttl = 0;
1883 match->flow.nw_ttl = 0;
1887 match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
1888 match->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1892 match->wc.masks.nw_proto = 0;
1893 match->flow.nw_proto = 0;
1898 memset(match->flow.arp_sha, 0, ETH_ADDR_LEN);
1899 memset(match->wc.masks.arp_sha, 0, ETH_ADDR_LEN);
1904 memset(match->flow.arp_tha, 0, ETH_ADDR_LEN);
1905 memset(match->wc.masks.arp_tha, 0, ETH_ADDR_LEN);
1911 case MFF_ICMPV4_TYPE:
1912 case MFF_ICMPV6_TYPE:
1913 match->wc.masks.tp_src = htons(0);
1914 match->flow.tp_src = htons(0);
1920 case MFF_ICMPV4_CODE:
1921 case MFF_ICMPV6_CODE:
1922 match->wc.masks.tp_dst = htons(0);
1923 match->flow.tp_dst = htons(0);
1927 memset(&match->wc.masks.nd_target, 0,
1928 sizeof match->wc.masks.nd_target);
1929 memset(&match->flow.nd_target, 0, sizeof match->flow.nd_target);
1938 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
1939 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1940 * with a 1-bit indicating that the corresponding value bit must match and a
1941 * 0-bit indicating a don't-care.
1943 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1944 * mf_set_value(mf, value, match). If 'mask' points to all-0-bits, then this
1945 * call is equivalent to mf_set_wild(mf, match).
1947 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
1948 * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
1949 enum ofputil_protocol
1950 mf_set(const struct mf_field *mf,
1951 const union mf_value *value, const union mf_value *mask,
1952 struct match *match)
1954 if (!mask || is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
1955 mf_set_value(mf, value, match);
1956 return mf->usable_protocols;
1957 } else if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
1958 mf_set_wild(mf, match);
1959 return OFPUTIL_P_ANY;
1964 case MFF_IN_PORT_OXM:
1965 case MFF_SKB_PRIORITY:
1968 case MFF_DL_VLAN_PCP:
1970 case MFF_MPLS_LABEL:
1976 case MFF_IP_DSCP_SHIFTED:
1979 case MFF_ICMPV4_TYPE:
1980 case MFF_ICMPV4_CODE:
1981 case MFF_ICMPV6_TYPE:
1982 case MFF_ICMPV6_CODE:
1986 match_set_tun_id_masked(match, value->be64, mask->be64);
1989 match_set_tun_src_masked(match, value->be32, mask->be32);
1992 match_set_tun_dst_masked(match, value->be32, mask->be32);
1995 match_set_tun_flags_masked(match, ntohs(value->be16), ntohs(mask->be16));
1998 match_set_tun_ttl_masked(match, value->u8, mask->u8);
2001 match_set_tun_tos_masked(match, value->u8, mask->u8);
2005 match_set_metadata_masked(match, value->be64, mask->be64);
2009 match_set_reg_masked(match, mf->id - MFF_REG0,
2010 ntohl(value->be32), ntohl(mask->be32));
2014 match_set_pkt_mark_masked(match, ntohl(value->be32),
2019 match_set_dl_dst_masked(match, value->mac, mask->mac);
2023 match_set_dl_src_masked(match, value->mac, mask->mac);
2028 match_set_arp_sha_masked(match, value->mac, mask->mac);
2033 match_set_arp_tha_masked(match, value->mac, mask->mac);
2037 match_set_dl_tci_masked(match, value->be16, mask->be16);
2041 match_set_vlan_vid_masked(match, value->be16, mask->be16);
2045 match_set_nw_src_masked(match, value->be32, mask->be32);
2049 match_set_nw_dst_masked(match, value->be32, mask->be32);
2053 match_set_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
2057 match_set_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
2060 case MFF_IPV6_LABEL:
2061 if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
2062 mf_set_value(mf, value, match);
2064 match_set_ipv6_label_masked(match, value->be32, mask->be32);
2069 match_set_nd_target_masked(match, &value->ipv6, &mask->ipv6);
2073 match_set_nw_frag_masked(match, value->u8, mask->u8);
2077 match_set_nw_src_masked(match, value->be32, mask->be32);
2081 match_set_nw_dst_masked(match, value->be32, mask->be32);
2087 match_set_tp_src_masked(match, value->be16, mask->be16);
2093 match_set_tp_dst_masked(match, value->be16, mask->be16);
2101 return mf->usable_protocols_bitwise;
2104 return ip_is_cidr(mask->be32) ? mf->usable_protocols :
2105 mf->usable_protocols_bitwise;
2109 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
2113 VLOG_WARN_RL(&rl, "unknown %s field", type);
2114 return OFPERR_OFPBAC_BAD_SET_TYPE;
2115 } else if (!sf->n_bits) {
2116 VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
2117 return OFPERR_OFPBAC_BAD_SET_LEN;
2118 } else if (sf->ofs >= sf->field->n_bits) {
2119 VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
2120 sf->ofs, sf->field->n_bits, type, sf->field->name);
2121 return OFPERR_OFPBAC_BAD_SET_LEN;
2122 } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
2123 VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
2124 "of %s field %s", sf->ofs, sf->n_bits,
2125 sf->field->n_bits, type, sf->field->name);
2126 return OFPERR_OFPBAC_BAD_SET_LEN;
2127 } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
2128 VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
2129 type, sf->field->name);
2130 return OFPERR_OFPBAC_MATCH_INCONSISTENT;
2136 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
2137 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
2140 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
2142 return mf_check__(sf, flow, "source");
2145 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
2146 * if so, otherwise an OpenFlow error code (e.g. as returned by
2149 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
2151 int error = mf_check__(sf, flow, "destination");
2152 if (!error && !sf->field->writable) {
2153 VLOG_WARN_RL(&rl, "destination field %s is not writable",
2155 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
2160 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
2161 * 'value' and 'mask', respectively. */
2163 mf_get(const struct mf_field *mf, const struct match *match,
2164 union mf_value *value, union mf_value *mask)
2166 mf_get_value(mf, &match->flow, value);
2167 mf_get_mask(mf, &match->wc, mask);
2170 /* Assigns a random value for field 'mf' to 'value'. */
2172 mf_random_value(const struct mf_field *mf, union mf_value *value)
2174 random_bytes(value, mf->n_bytes);
2186 case MFF_SKB_PRIORITY:
2208 case MFF_ICMPV4_TYPE:
2209 case MFF_ICMPV4_CODE:
2210 case MFF_ICMPV6_TYPE:
2211 case MFF_ICMPV6_CODE:
2217 case MFF_IN_PORT_OXM:
2218 value->be32 = ofputil_port_to_ofp11(u16_to_ofp(ntohs(value->be16)));
2221 case MFF_IPV6_LABEL:
2222 value->be32 &= htonl(IPV6_LABEL_MASK);
2226 value->u8 &= IP_DSCP_MASK;
2229 case MFF_IP_DSCP_SHIFTED:
2230 value->u8 &= IP_DSCP_MASK >> 2;
2234 value->u8 &= IP_ECN_MASK;
2238 value->u8 &= FLOW_NW_FRAG_MASK;
2242 value->be16 &= htons(0xff);
2246 value->be16 &= htons(VLAN_VID_MASK);
2249 value->be16 &= htons(VLAN_VID_MASK | VLAN_CFI);
2252 case MFF_DL_VLAN_PCP:
2257 case MFF_MPLS_LABEL:
2258 value->be32 &= htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT);
2262 value->u8 &= MPLS_TC_MASK >> MPLS_TC_SHIFT;
2266 value->u8 &= MPLS_BOS_MASK >> MPLS_BOS_SHIFT;
2276 mf_from_integer_string(const struct mf_field *mf, const char *s,
2277 uint8_t *valuep, uint8_t *maskp)
2279 unsigned long long int integer, mask;
2284 integer = strtoull(s, &tail, 0);
2285 if (errno || (*tail != '\0' && *tail != '/')) {
2290 mask = strtoull(tail + 1, &tail, 0);
2291 if (errno || *tail != '\0') {
2298 for (i = mf->n_bytes - 1; i >= 0; i--) {
2299 valuep[i] = integer;
2305 return xasprintf("%s: value too large for %u-byte field %s",
2306 s, mf->n_bytes, mf->name);
2311 return xasprintf("%s: bad syntax for %s", s, mf->name);
2315 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
2316 uint8_t mac[ETH_ADDR_LEN],
2317 uint8_t mask[ETH_ADDR_LEN])
2321 ovs_assert(mf->n_bytes == ETH_ADDR_LEN);
2324 if (sscanf(s, ETH_ADDR_SCAN_FMT"%n", ETH_ADDR_SCAN_ARGS(mac), &n) > 0
2325 && n == strlen(s)) {
2326 memset(mask, 0xff, ETH_ADDR_LEN);
2331 if (sscanf(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT"%n",
2332 ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask), &n) > 0
2333 && n == strlen(s)) {
2337 return xasprintf("%s: invalid Ethernet address", s);
2341 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
2342 ovs_be32 *ip, ovs_be32 *mask)
2346 ovs_assert(mf->n_bytes == sizeof *ip);
2348 if (sscanf(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
2349 IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask)) == IP_SCAN_COUNT * 2) {
2351 } else if (sscanf(s, IP_SCAN_FMT"/%d",
2352 IP_SCAN_ARGS(ip), &prefix) == IP_SCAN_COUNT + 1) {
2353 if (prefix <= 0 || prefix > 32) {
2354 return xasprintf("%s: network prefix bits not between 1 and "
2356 } else if (prefix == 32) {
2357 *mask = OVS_BE32_MAX;
2359 *mask = htonl(((1u << prefix) - 1) << (32 - prefix));
2361 } else if (sscanf(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip)) == IP_SCAN_COUNT) {
2362 *mask = OVS_BE32_MAX;
2364 return xasprintf("%s: invalid IP address", s);
2370 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
2371 struct in6_addr *value, struct in6_addr *mask)
2373 char *str = xstrdup(s);
2374 char *save_ptr = NULL;
2375 const char *name, *netmask;
2378 ovs_assert(mf->n_bytes == sizeof *value);
2380 name = strtok_r(str, "/", &save_ptr);
2381 retval = name ? lookup_ipv6(name, value) : EINVAL;
2385 err = xasprintf("%s: could not convert to IPv6 address", str);
2391 netmask = strtok_r(NULL, "/", &save_ptr);
2393 if (inet_pton(AF_INET6, netmask, mask) != 1) {
2394 int prefix = atoi(netmask);
2395 if (prefix <= 0 || prefix > 128) {
2397 return xasprintf("%s: prefix bits not between 1 and 128", s);
2399 *mask = ipv6_create_mask(prefix);
2403 *mask = in6addr_exact;
2411 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
2412 ovs_be16 *valuep, ovs_be16 *maskp)
2416 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2418 if (ofputil_port_from_string(s, &port)) {
2419 *valuep = htons(ofp_to_u16(port));
2420 *maskp = OVS_BE16_MAX;
2423 return xasprintf("%s: port value out of range for %s", s, mf->name);
2427 mf_from_ofp_port_string32(const struct mf_field *mf, const char *s,
2428 ovs_be32 *valuep, ovs_be32 *maskp)
2432 ovs_assert(mf->n_bytes == sizeof(ovs_be32));
2433 if (ofputil_port_from_string(s, &port)) {
2434 *valuep = ofputil_port_to_ofp11(port);
2435 *maskp = OVS_BE32_MAX;
2438 return xasprintf("%s: port value out of range for %s", s, mf->name);
2441 struct frag_handling {
2447 static const struct frag_handling all_frags[] = {
2448 #define A FLOW_NW_FRAG_ANY
2449 #define L FLOW_NW_FRAG_LATER
2450 /* name mask value */
2453 { "first", A|L, A },
2454 { "later", A|L, A|L },
2459 { "not_later", L, 0 },
2466 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
2468 const struct frag_handling *h;
2470 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2471 if (!strcasecmp(s, h->name)) {
2472 /* We force the upper bits of the mask on to make mf_parse_value()
2473 * happy (otherwise it will never think it's an exact match.) */
2474 *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
2480 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2481 "\"yes\", \"first\", \"later\", \"not_first\"", s);
2485 parse_flow_tun_flags(const char *s_, const char *(*bit_to_string)(uint32_t),
2488 uint32_t result = 0;
2489 char *save_ptr = NULL;
2492 char *s = xstrdup(s_);
2494 for (name = strtok_r((char *)s, " |", &save_ptr); name;
2495 name = strtok_r(NULL, " |", &save_ptr)) {
2497 unsigned long long int flags;
2501 if (sscanf(name, "%lli%n", &flags, &n0) > 0 && n0 > 0) {
2505 name_len = strlen(name);
2506 for (bit = 1; bit; bit <<= 1) {
2507 const char *fname = bit_to_string(bit);
2514 len = strlen(fname);
2515 if (len != name_len) {
2518 if (!strncmp(name, fname, len)) {
2530 *res = htons(result);
2537 mf_from_tun_flags_string(const char *s, ovs_be16 *valuep, ovs_be16 *maskp)
2539 if (!parse_flow_tun_flags(s, flow_tun_flag_to_string, valuep)) {
2540 *maskp = OVS_BE16_MAX;
2544 return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
2545 "\"csum\", \"key\"", s);
2548 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2549 * NULL if successful, otherwise a malloc()'d string describing the error. */
2551 mf_parse(const struct mf_field *mf, const char *s,
2552 union mf_value *value, union mf_value *mask)
2554 if (!strcmp(s, "*")) {
2555 memset(value, 0, mf->n_bytes);
2556 memset(mask, 0, mf->n_bytes);
2560 switch (mf->string) {
2562 case MFS_HEXADECIMAL:
2563 return mf_from_integer_string(mf, s,
2564 (uint8_t *) value, (uint8_t *) mask);
2567 return mf_from_ethernet_string(mf, s, value->mac, mask->mac);
2570 return mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
2573 return mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
2576 return mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
2578 case MFS_OFP_PORT_OXM:
2579 return mf_from_ofp_port_string32(mf, s, &value->be32, &mask->be32);
2582 return mf_from_frag_string(s, &value->u8, &mask->u8);
2585 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2586 return mf_from_tun_flags_string(s, &value->be16, &mask->be16);
2591 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2592 * successful, otherwise a malloc()'d string describing the error. */
2594 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2596 union mf_value mask;
2599 error = mf_parse(mf, s, value, &mask);
2604 if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2605 return xasprintf("%s: wildcards not allowed here", s);
2611 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2612 const uint8_t *maskp, struct ds *s)
2614 unsigned long long int integer;
2617 ovs_assert(mf->n_bytes <= 8);
2620 for (i = 0; i < mf->n_bytes; i++) {
2621 integer = (integer << 8) | valuep[i];
2623 if (mf->string == MFS_HEXADECIMAL) {
2624 ds_put_format(s, "%#llx", integer);
2626 ds_put_format(s, "%lld", integer);
2630 unsigned long long int mask;
2633 for (i = 0; i < mf->n_bytes; i++) {
2634 mask = (mask << 8) | maskp[i];
2637 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2638 * not sure that that a bit-mask written in decimal is ever easier to
2639 * understand than the same bit-mask written in hexadecimal. */
2640 ds_put_format(s, "/%#llx", mask);
2645 mf_format_frag_string(uint8_t value, uint8_t mask, struct ds *s)
2647 const struct frag_handling *h;
2649 mask &= FLOW_NW_FRAG_MASK;
2652 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2653 if (value == h->value && mask == h->mask) {
2654 ds_put_cstr(s, h->name);
2658 ds_put_cstr(s, "<error>");
2662 mf_format_tnl_flags_string(const ovs_be16 *valuep, struct ds *s)
2664 format_flags(s, flow_tun_flag_to_string, ntohs(*valuep), '|');
2667 /* Appends to 's' a string representation of field 'mf' whose value is in
2668 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2670 mf_format(const struct mf_field *mf,
2671 const union mf_value *value, const union mf_value *mask,
2675 if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2676 ds_put_cstr(s, "ANY");
2678 } else if (is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2683 switch (mf->string) {
2684 case MFS_OFP_PORT_OXM:
2687 ofputil_port_from_ofp11(value->be32, &port);
2688 ofputil_format_port(port, s);
2694 ofputil_format_port(u16_to_ofp(ntohs(value->be16)), s);
2699 case MFS_HEXADECIMAL:
2700 mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2704 eth_format_masked(value->mac, mask->mac, s);
2708 ip_format_masked(value->be32, mask ? mask->be32 : OVS_BE32_MAX, s);
2712 print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2716 mf_format_frag_string(value->u8, mask ? mask->u8 : UINT8_MAX, s);
2720 mf_format_tnl_flags_string(&value->be16, s);
2728 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2729 * least-significant bits in 'x'.
2732 mf_write_subfield_flow(const struct mf_subfield *sf,
2733 const union mf_subvalue *x, struct flow *flow)
2735 const struct mf_field *field = sf->field;
2736 union mf_value value;
2738 mf_get_value(field, flow, &value);
2739 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes,
2740 sf->ofs, sf->n_bits);
2741 mf_set_flow_value(field, &value, flow);
2744 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2745 * least-significant bits in 'x'.
2748 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2749 struct match *match)
2751 const struct mf_field *field = sf->field;
2752 union mf_value value, mask;
2754 mf_get(field, match, &value, &mask);
2755 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2756 bitwise_one ( &mask, field->n_bytes, sf->ofs, sf->n_bits);
2757 mf_set(field, &value, &mask, match);
2760 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2761 * reading 'flow', e.g. as checked by mf_check_src(). */
2763 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2764 union mf_subvalue *x)
2766 union mf_value value;
2768 mf_get_value(sf->field, flow, &value);
2770 memset(x, 0, sizeof *x);
2771 bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2776 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2777 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2780 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2782 union mf_value value;
2784 mf_get_value(sf->field, flow, &value);
2785 return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2788 /* Formats 'sf' into 's' in a format normally acceptable to
2789 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2790 * sf->field has no NXM name.) */
2792 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
2795 ds_put_cstr(s, "<unknown>");
2796 } else if (sf->field->nxm_name) {
2797 ds_put_cstr(s, sf->field->nxm_name);
2798 } else if (sf->field->nxm_header) {
2799 uint32_t header = sf->field->nxm_header;
2800 ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
2802 ds_put_cstr(s, sf->field->name);
2805 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
2806 ds_put_cstr(s, "[]");
2807 } else if (sf->n_bits == 1) {
2808 ds_put_format(s, "[%d]", sf->ofs);
2810 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
2814 static const struct mf_field *
2815 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
2819 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
2824 for (i = 0; i < MFF_N_IDS; i++) {
2825 const struct mf_field *mf = mf_from_id(i);
2828 && !strncmp(mf->nxm_name, name, name_len)
2829 && mf->nxm_name[name_len] == '\0') {
2833 && !strncmp(mf->oxm_name, name, name_len)
2834 && mf->oxm_name[name_len] == '\0') {
2842 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2843 * returns NULL and advances '*sp' to the first byte following the parsed
2844 * string. On failure, returns a malloc()'d error message, does not modify
2845 * '*sp', and does not properly initialize 'sf'.
2847 * The syntax parsed from '*sp' takes the form "header[start..end]" where
2848 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2849 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2850 * may both be omitted (the [] are still required) to indicate an entire
2852 char * WARN_UNUSED_RESULT
2853 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
2855 const struct mf_field *field;
2864 name_len = strcspn(s, "[");
2865 if (s[name_len] != '[') {
2866 return xasprintf("%s: missing [ looking for field name", *sp);
2869 field = mf_parse_subfield_name(name, name_len, &wild);
2871 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
2875 if (sscanf(s, "[%d..%d]", &start, &end) == 2) {
2876 /* Nothing to do. */
2877 } else if (sscanf(s, "[%d]", &start) == 1) {
2879 } else if (!strncmp(s, "[]", 2)) {
2881 end = field->n_bits - 1;
2883 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2884 "[<start>..<end>]", *sp);
2886 s = strchr(s, ']') + 1;
2889 return xasprintf("%s: starting bit %d is after ending bit %d",
2891 } else if (start >= field->n_bits) {
2892 return xasprintf("%s: starting bit %d is not valid because field is "
2893 "only %d bits wide", *sp, start, field->n_bits);
2894 } else if (end >= field->n_bits){
2895 return xasprintf("%s: ending bit %d is not valid because field is "
2896 "only %d bits wide", *sp, end, field->n_bits);
2901 sf->n_bits = end - start + 1;
2907 /* Parses a subfield from the entirety of 's' into 'sf'. Returns NULL if
2908 * successful, otherwise a malloc()'d string describing the error. The caller
2909 * is responsible for freeing the returned string.
2911 * The syntax parsed from 's' takes the form "header[start..end]" where
2912 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2913 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2914 * may both be omitted (the [] are still required) to indicate an entire
2916 char * WARN_UNUSED_RESULT
2917 mf_parse_subfield(struct mf_subfield *sf, const char *s)
2919 char *error = mf_parse_subfield__(sf, &s);
2920 if (!error && s[0]) {
2921 error = xstrdup("unexpected input following field syntax");
2927 mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s)
2931 for (i = 0; i < ARRAY_SIZE(subvalue->u8); i++) {
2932 if (subvalue->u8[i]) {
2933 ds_put_format(s, "0x%"PRIx8, subvalue->u8[i]);
2934 for (i++; i < ARRAY_SIZE(subvalue->u8); i++) {
2935 ds_put_format(s, "%02"PRIx8, subvalue->u8[i]);
2940 ds_put_char(s, '0');