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",
59 MFF_TUN_SRC, "tun_src", NULL,
65 NXM_NX_TUN_IPV4_SRC, "NXM_NX_TUN_IPV4_SRC",
66 NXM_NX_TUN_IPV4_SRC, "NXM_NX_TUN_IPV4_SRC",
68 MFF_TUN_DST, "tun_dst", NULL,
74 NXM_NX_TUN_IPV4_DST, "NXM_NX_TUN_IPV4_DST",
75 NXM_NX_TUN_IPV4_DST, "NXM_NX_TUN_IPV4_DST",
77 MFF_TUN_FLAGS, "tun_flags", NULL,
86 MFF_TUN_TOS, "tun_tos", NULL,
95 MFF_TUN_TTL, "tun_ttl", NULL,
104 MFF_METADATA, "metadata", NULL,
105 MF_FIELD_SIZES(be64),
110 OXM_OF_METADATA, "OXM_OF_METADATA",
111 OXM_OF_METADATA, "OXM_OF_METADATA",
113 MFF_IN_PORT, "in_port", NULL,
114 MF_FIELD_SIZES(be16),
119 NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
120 NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
122 MFF_IN_PORT_OXM, "in_port_oxm", NULL,
123 MF_FIELD_SIZES(be32),
128 OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
129 OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
131 MFF_SKB_PRIORITY, "skb_priority", NULL,
132 MF_FIELD_SIZES(be32),
140 MFF_PKT_MARK, "pkt_mark", NULL,
141 MF_FIELD_SIZES(be32),
146 NXM_NX_PKT_MARK, "NXM_NX_PKT_MARK",
147 NXM_NX_PKT_MARK, "NXM_NX_PKT_MARK",
150 #define REGISTER(IDX) \
152 MFF_REG##IDX, "reg" #IDX, NULL, \
153 MF_FIELD_SIZES(be32), \
158 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
159 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
194 MFF_ETH_SRC, "eth_src", "dl_src",
200 NXM_OF_ETH_SRC, "NXM_OF_ETH_SRC",
201 OXM_OF_ETH_SRC, "OXM_OF_ETH_SRC",
203 MFF_ETH_DST, "eth_dst", "dl_dst",
209 NXM_OF_ETH_DST, "NXM_OF_ETH_DST",
210 OXM_OF_ETH_DST, "OXM_OF_ETH_DST",
212 MFF_ETH_TYPE, "eth_type", "dl_type",
213 MF_FIELD_SIZES(be16),
218 NXM_OF_ETH_TYPE, "NXM_OF_ETH_TYPE",
219 OXM_OF_ETH_TYPE, "OXM_OF_ETH_TYPE",
223 MFF_VLAN_TCI, "vlan_tci", NULL,
224 MF_FIELD_SIZES(be16),
229 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
230 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
232 MFF_DL_VLAN, "dl_vlan", NULL,
233 sizeof(ovs_be16), 12,
241 MFF_VLAN_VID, "vlan_vid", NULL,
242 sizeof(ovs_be16), 12,
247 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
248 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
250 MFF_DL_VLAN_PCP, "dl_vlan_pcp", NULL,
259 MFF_VLAN_PCP, "vlan_pcp", NULL,
265 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
266 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
273 MFF_MPLS_LABEL, "mpls_label", NULL,
279 OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
280 OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
282 MFF_MPLS_TC, "mpls_tc", NULL,
288 OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
289 OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
291 MFF_MPLS_BOS, "mpls_bos", NULL,
297 OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
298 OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
306 MFF_IPV4_SRC, "ip_src", "nw_src",
307 MF_FIELD_SIZES(be32),
312 NXM_OF_IP_SRC, "NXM_OF_IP_SRC",
313 OXM_OF_IPV4_SRC, "OXM_OF_IPV4_SRC",
315 MFF_IPV4_DST, "ip_dst", "nw_dst",
316 MF_FIELD_SIZES(be32),
321 NXM_OF_IP_DST, "NXM_OF_IP_DST",
322 OXM_OF_IPV4_DST, "OXM_OF_IPV4_DST",
326 MFF_IPV6_SRC, "ipv6_src", NULL,
327 MF_FIELD_SIZES(ipv6),
332 NXM_NX_IPV6_SRC, "NXM_NX_IPV6_SRC",
333 OXM_OF_IPV6_SRC, "OXM_OF_IPV6_SRC",
335 MFF_IPV6_DST, "ipv6_dst", NULL,
336 MF_FIELD_SIZES(ipv6),
341 NXM_NX_IPV6_DST, "NXM_NX_IPV6_DST",
342 OXM_OF_IPV6_DST, "OXM_OF_IPV6_DST",
345 MFF_IPV6_LABEL, "ipv6_label", NULL,
351 NXM_NX_IPV6_LABEL, "NXM_NX_IPV6_LABEL",
352 OXM_OF_IPV6_FLABEL, "OXM_OF_IPV6_FLABEL",
356 MFF_IP_PROTO, "nw_proto", NULL,
362 NXM_OF_IP_PROTO, "NXM_OF_IP_PROTO",
363 OXM_OF_IP_PROTO, "OXM_OF_IP_PROTO",
365 MFF_IP_DSCP, "nw_tos", NULL,
371 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
372 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
374 MFF_IP_DSCP_SHIFTED, "nw_tos_shifted", NULL,
380 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
381 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
383 MFF_IP_ECN, "nw_ecn", NULL,
389 NXM_NX_IP_ECN, "NXM_NX_IP_ECN",
390 OXM_OF_IP_ECN, "OXM_OF_IP_ECN",
392 MFF_IP_TTL, "nw_ttl", NULL,
398 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
399 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
401 MFF_IP_FRAG, "ip_frag", NULL,
407 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
408 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
412 MFF_ARP_OP, "arp_op", NULL,
413 MF_FIELD_SIZES(be16),
418 NXM_OF_ARP_OP, "NXM_OF_ARP_OP",
419 OXM_OF_ARP_OP, "OXM_OF_ARP_OP",
421 MFF_ARP_SPA, "arp_spa", NULL,
422 MF_FIELD_SIZES(be32),
427 NXM_OF_ARP_SPA, "NXM_OF_ARP_SPA",
428 OXM_OF_ARP_SPA, "OXM_OF_ARP_SPA",
430 MFF_ARP_TPA, "arp_tpa", NULL,
431 MF_FIELD_SIZES(be32),
436 NXM_OF_ARP_TPA, "NXM_OF_ARP_TPA",
437 OXM_OF_ARP_TPA, "OXM_OF_ARP_TPA",
439 MFF_ARP_SHA, "arp_sha", NULL,
445 NXM_NX_ARP_SHA, "NXM_NX_ARP_SHA",
446 OXM_OF_ARP_SHA, "OXM_OF_ARP_SHA",
448 MFF_ARP_THA, "arp_tha", NULL,
454 NXM_NX_ARP_THA, "NXM_NX_ARP_THA",
455 OXM_OF_ARP_THA, "OXM_OF_ARP_THA",
463 MFF_TCP_SRC, "tcp_src", "tp_src",
464 MF_FIELD_SIZES(be16),
469 NXM_OF_TCP_SRC, "NXM_OF_TCP_SRC",
470 OXM_OF_TCP_SRC, "OXM_OF_TCP_SRC",
472 MFF_TCP_DST, "tcp_dst", "tp_dst",
473 MF_FIELD_SIZES(be16),
478 NXM_OF_TCP_DST, "NXM_OF_TCP_DST",
479 OXM_OF_TCP_DST, "OXM_OF_TCP_DST",
483 MFF_UDP_SRC, "udp_src", NULL,
484 MF_FIELD_SIZES(be16),
489 NXM_OF_UDP_SRC, "NXM_OF_UDP_SRC",
490 OXM_OF_UDP_SRC, "OXM_OF_UDP_SRC",
492 MFF_UDP_DST, "udp_dst", NULL,
493 MF_FIELD_SIZES(be16),
498 NXM_OF_UDP_DST, "NXM_OF_UDP_DST",
499 OXM_OF_UDP_DST, "OXM_OF_UDP_DST",
503 MFF_SCTP_SRC, "sctp_src", NULL,
504 MF_FIELD_SIZES(be16),
509 OXM_OF_SCTP_SRC, "OXM_OF_SCTP_SRC",
510 OXM_OF_SCTP_SRC, "OXM_OF_SCTP_SRC",
512 MFF_SCTP_DST, "sctp_dst", NULL,
513 MF_FIELD_SIZES(be16),
518 OXM_OF_SCTP_DST, "OXM_OF_SCTP_DST",
519 OXM_OF_SCTP_DST, "OXM_OF_SCTP_DST",
523 MFF_ICMPV4_TYPE, "icmp_type", NULL,
529 NXM_OF_ICMP_TYPE, "NXM_OF_ICMP_TYPE",
530 OXM_OF_ICMPV4_TYPE, "OXM_OF_ICMPV4_TYPE",
532 MFF_ICMPV4_CODE, "icmp_code", NULL,
538 NXM_OF_ICMP_CODE, "NXM_OF_ICMP_CODE",
539 OXM_OF_ICMPV4_CODE, "OXM_OF_ICMPV4_CODE",
543 MFF_ICMPV6_TYPE, "icmpv6_type", NULL,
549 NXM_NX_ICMPV6_TYPE, "NXM_NX_ICMPV6_TYPE",
550 OXM_OF_ICMPV6_TYPE, "OXM_OF_ICMPV6_TYPE",
552 MFF_ICMPV6_CODE, "icmpv6_code", NULL,
558 NXM_NX_ICMPV6_CODE, "NXM_NX_ICMPV6_CODE",
559 OXM_OF_ICMPV6_CODE, "OXM_OF_ICMPV6_CODE",
567 MFF_ND_TARGET, "nd_target", NULL,
568 MF_FIELD_SIZES(ipv6),
573 NXM_NX_ND_TARGET, "NXM_NX_ND_TARGET",
574 OXM_OF_IPV6_ND_TARGET, "OXM_OF_IPV6_ND_TARGET",
576 MFF_ND_SLL, "nd_sll", NULL,
582 NXM_NX_ND_SLL, "NXM_NX_ND_SLL",
583 OXM_OF_IPV6_ND_SLL, "OXM_OF_IPV6_ND_SLL",
585 MFF_ND_TLL, "nd_tll", NULL,
591 NXM_NX_ND_TLL, "NXM_NX_ND_TLL",
592 OXM_OF_IPV6_ND_TLL, "OXM_OF_IPV6_ND_TLL",
596 /* Maps an NXM or OXM header value to an mf_field. */
598 struct hmap_node hmap_node; /* In 'all_fields' hmap. */
599 uint32_t header; /* NXM or OXM header value. */
600 const struct mf_field *mf;
603 /* Contains 'struct nxm_field's. */
604 static struct hmap all_fields;
606 /* Maps from an mf_field's 'name' or 'extra_name' to the mf_field. */
607 static struct shash mf_by_name;
609 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
610 * controller and so there's not much point in showing a lot of them. */
611 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
613 const struct mf_field *mf_from_nxm_header__(uint32_t header);
614 static void nxm_init(void);
616 /* Returns the field with the given 'id'. */
617 const struct mf_field *
618 mf_from_id(enum mf_field_id id)
620 ovs_assert((unsigned int) id < MFF_N_IDS);
621 return &mf_fields[id];
624 /* Returns the field with the given 'name', or a null pointer if no field has
626 const struct mf_field *
627 mf_from_name(const char *name)
630 return shash_find_data(&mf_by_name, name);
634 add_nxm_field(uint32_t header, const struct mf_field *mf)
638 f = xmalloc(sizeof *f);
639 hmap_insert(&all_fields, &f->hmap_node, hash_int(header, 0));
645 nxm_init_add_field(const struct mf_field *mf, uint32_t header)
648 ovs_assert(!mf_from_nxm_header__(header));
649 add_nxm_field(header, mf);
650 if (mf->maskable != MFM_NONE) {
651 add_nxm_field(NXM_MAKE_WILD_HEADER(header), mf);
659 const struct mf_field *mf;
661 hmap_init(&all_fields);
662 shash_init(&mf_by_name);
663 for (mf = mf_fields; mf < &mf_fields[MFF_N_IDS]; mf++) {
664 nxm_init_add_field(mf, mf->nxm_header);
665 if (mf->oxm_header != mf->nxm_header) {
666 nxm_init_add_field(mf, mf->oxm_header);
669 shash_add_once(&mf_by_name, mf->name, mf);
670 if (mf->extra_name) {
671 shash_add_once(&mf_by_name, mf->extra_name, mf);
679 static pthread_once_t once = PTHREAD_ONCE_INIT;
680 pthread_once(&once, nxm_do_init);
683 const struct mf_field *
684 mf_from_nxm_header(uint32_t header)
687 return mf_from_nxm_header__(header);
690 const struct mf_field *
691 mf_from_nxm_header__(uint32_t header)
693 const struct nxm_field *f;
695 HMAP_FOR_EACH_IN_BUCKET (f, hmap_node, hash_int(header, 0), &all_fields) {
696 if (f->header == header) {
704 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
705 * specifies at least one bit in the field.
707 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
708 * meets 'mf''s prerequisites. */
710 mf_is_all_wild(const struct mf_field *mf, const struct flow_wildcards *wc)
714 return !wc->masks.tunnel.ip_src;
716 return !wc->masks.tunnel.ip_dst;
721 return !wc->masks.tunnel.tun_id;
723 return !wc->masks.metadata;
725 case MFF_IN_PORT_OXM:
726 return !wc->masks.in_port.ofp_port;
727 case MFF_SKB_PRIORITY:
728 return !wc->masks.skb_priority;
730 return !wc->masks.pkt_mark;
732 return !wc->masks.regs[mf->id - MFF_REG0];
735 return eth_addr_is_zero(wc->masks.dl_src);
737 return eth_addr_is_zero(wc->masks.dl_dst);
739 return !wc->masks.dl_type;
743 return eth_addr_is_zero(wc->masks.arp_sha);
747 return eth_addr_is_zero(wc->masks.arp_tha);
750 return !wc->masks.vlan_tci;
752 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK));
754 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI));
755 case MFF_DL_VLAN_PCP:
757 return !(wc->masks.vlan_tci & htons(VLAN_PCP_MASK));
760 return !(wc->masks.mpls_lse & htonl(MPLS_LABEL_MASK));
762 return !(wc->masks.mpls_lse & htonl(MPLS_TC_MASK));
764 return !(wc->masks.mpls_lse & htonl(MPLS_BOS_MASK));
767 return !wc->masks.nw_src;
769 return !wc->masks.nw_dst;
772 return ipv6_mask_is_any(&wc->masks.ipv6_src);
774 return ipv6_mask_is_any(&wc->masks.ipv6_dst);
777 return !wc->masks.ipv6_label;
780 return !wc->masks.nw_proto;
782 case MFF_IP_DSCP_SHIFTED:
783 return !(wc->masks.nw_tos & IP_DSCP_MASK);
785 return !(wc->masks.nw_tos & IP_ECN_MASK);
787 return !wc->masks.nw_ttl;
790 return ipv6_mask_is_any(&wc->masks.nd_target);
793 return !(wc->masks.nw_frag & FLOW_NW_FRAG_MASK);
796 return !wc->masks.nw_proto;
798 return !wc->masks.nw_src;
800 return !wc->masks.nw_dst;
805 case MFF_ICMPV4_TYPE:
806 case MFF_ICMPV6_TYPE:
807 return !wc->masks.tp_src;
811 case MFF_ICMPV4_CODE:
812 case MFF_ICMPV6_CODE:
813 return !wc->masks.tp_dst;
821 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
822 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
823 * purposes, or to 0 if it is wildcarded.
825 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
826 * meets 'mf''s prerequisites. */
828 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
829 union mf_value *mask)
831 mf_get_value(mf, &wc->masks, mask);
834 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
835 * if the mask is valid, false otherwise. */
837 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
839 switch (mf->maskable) {
841 return (is_all_zeros((const uint8_t *) mask, mf->n_bytes) ||
842 is_all_ones((const uint8_t *) mask, mf->n_bytes));
852 is_icmpv4(const struct flow *flow)
854 return (flow->dl_type == htons(ETH_TYPE_IP)
855 && flow->nw_proto == IPPROTO_ICMP);
859 is_icmpv6(const struct flow *flow)
861 return (flow->dl_type == htons(ETH_TYPE_IPV6)
862 && flow->nw_proto == IPPROTO_ICMPV6);
865 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
867 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
869 switch (mf->prereqs) {
874 return (flow->dl_type == htons(ETH_TYPE_ARP) ||
875 flow->dl_type == htons(ETH_TYPE_RARP));
877 return flow->dl_type == htons(ETH_TYPE_IP);
879 return flow->dl_type == htons(ETH_TYPE_IPV6);
881 return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
883 return eth_type_mpls(flow->dl_type);
885 return is_ip_any(flow);
888 return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP;
890 return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP;
892 return is_ip_any(flow) && flow->nw_proto == IPPROTO_SCTP;
894 return is_icmpv4(flow);
896 return is_icmpv6(flow);
899 return (is_icmpv6(flow)
900 && flow->tp_dst == htons(0)
901 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
902 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
904 return (is_icmpv6(flow)
905 && flow->tp_dst == htons(0)
906 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
908 return (is_icmpv6(flow)
909 && flow->tp_dst == htons(0)
910 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
916 /* Returns true if 'value' may be a valid value *as part of a masked match*,
919 * A value is not rejected just because it is not valid for the field in
920 * question, but only if it doesn't make sense to test the bits in question at
921 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
922 * without the VLAN_CFI bit being set, but we can't reject those values because
923 * it is still legitimate to test just for those bits (see the documentation
924 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
925 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
927 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
938 case MFF_SKB_PRIORITY:
961 case MFF_ICMPV4_TYPE:
962 case MFF_ICMPV4_CODE:
963 case MFF_ICMPV6_TYPE:
964 case MFF_ICMPV6_CODE:
970 case MFF_IN_PORT_OXM: {
972 return !ofputil_port_from_ofp11(value->be32, &port);
976 return !(value->u8 & ~IP_DSCP_MASK);
977 case MFF_IP_DSCP_SHIFTED:
978 return !(value->u8 & (~IP_DSCP_MASK >> 2));
980 return !(value->u8 & ~IP_ECN_MASK);
982 return !(value->u8 & ~FLOW_NW_FRAG_MASK);
985 return !(value->be16 & htons(0xff00));
988 return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
990 return !(value->be16 & htons(VLAN_PCP_MASK));
992 case MFF_DL_VLAN_PCP:
994 return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
997 return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
1000 return !(value->be32 & ~htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT));
1003 return !(value->u8 & ~(MPLS_TC_MASK >> MPLS_TC_SHIFT));
1006 return !(value->u8 & ~(MPLS_BOS_MASK >> MPLS_BOS_SHIFT));
1014 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
1015 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
1017 mf_get_value(const struct mf_field *mf, const struct flow *flow,
1018 union mf_value *value)
1022 value->be64 = flow->tunnel.tun_id;
1025 value->be32 = flow->tunnel.ip_src;
1028 value->be32 = flow->tunnel.ip_dst;
1031 value->be16 = htons(flow->tunnel.flags);
1034 value->u8 = flow->tunnel.ip_ttl;
1037 value->u8 = flow->tunnel.ip_tos;
1041 value->be64 = flow->metadata;
1045 value->be16 = htons(ofp_to_u16(flow->in_port.ofp_port));
1047 case MFF_IN_PORT_OXM:
1048 value->be32 = ofputil_port_to_ofp11(flow->in_port.ofp_port);
1051 case MFF_SKB_PRIORITY:
1052 value->be32 = htonl(flow->skb_priority);
1056 value->be32 = htonl(flow->pkt_mark);
1060 value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
1064 memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
1068 memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
1072 value->be16 = flow->dl_type;
1076 value->be16 = flow->vlan_tci;
1080 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
1083 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
1086 case MFF_DL_VLAN_PCP:
1088 value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
1091 case MFF_MPLS_LABEL:
1092 value->be32 = htonl(mpls_lse_to_label(flow->mpls_lse));
1096 value->u8 = mpls_lse_to_tc(flow->mpls_lse);
1100 value->u8 = mpls_lse_to_bos(flow->mpls_lse);
1104 value->be32 = flow->nw_src;
1108 value->be32 = flow->nw_dst;
1112 value->ipv6 = flow->ipv6_src;
1116 value->ipv6 = flow->ipv6_dst;
1119 case MFF_IPV6_LABEL:
1120 value->be32 = flow->ipv6_label;
1124 value->u8 = flow->nw_proto;
1128 value->u8 = flow->nw_tos & IP_DSCP_MASK;
1131 case MFF_IP_DSCP_SHIFTED:
1132 value->u8 = flow->nw_tos >> 2;
1136 value->u8 = flow->nw_tos & IP_ECN_MASK;
1140 value->u8 = flow->nw_ttl;
1144 value->u8 = flow->nw_frag;
1148 value->be16 = htons(flow->nw_proto);
1152 value->be32 = flow->nw_src;
1156 value->be32 = flow->nw_dst;
1161 memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
1166 memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
1172 value->be16 = flow->tp_src;
1178 value->be16 = flow->tp_dst;
1181 case MFF_ICMPV4_TYPE:
1182 case MFF_ICMPV6_TYPE:
1183 value->u8 = ntohs(flow->tp_src);
1186 case MFF_ICMPV4_CODE:
1187 case MFF_ICMPV6_CODE:
1188 value->u8 = ntohs(flow->tp_dst);
1192 value->ipv6 = flow->nd_target;
1201 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1202 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1205 mf_set_value(const struct mf_field *mf,
1206 const union mf_value *value, struct match *match)
1210 match_set_tun_id(match, value->be64);
1213 match_set_tun_src(match, value->be32);
1216 match_set_tun_dst(match, value->be32);
1219 match_set_tun_flags(match, ntohs(value->be16));
1222 match_set_tun_tos(match, value->u8);
1225 match_set_tun_ttl(match, value->u8);
1229 match_set_metadata(match, value->be64);
1233 match_set_in_port(match, u16_to_ofp(ntohs(value->be16)));
1236 case MFF_IN_PORT_OXM: {
1238 ofputil_port_from_ofp11(value->be32, &port);
1239 match_set_in_port(match, port);
1243 case MFF_SKB_PRIORITY:
1244 match_set_skb_priority(match, ntohl(value->be32));
1248 match_set_pkt_mark(match, ntohl(value->be32));
1252 match_set_reg(match, mf->id - MFF_REG0, ntohl(value->be32));
1256 match_set_dl_src(match, value->mac);
1260 match_set_dl_dst(match, value->mac);
1264 match_set_dl_type(match, value->be16);
1268 match_set_dl_tci(match, value->be16);
1272 match_set_dl_vlan(match, value->be16);
1275 match_set_vlan_vid(match, value->be16);
1278 case MFF_DL_VLAN_PCP:
1280 match_set_dl_vlan_pcp(match, value->u8);
1283 case MFF_MPLS_LABEL:
1284 match_set_mpls_label(match, value->be32);
1288 match_set_mpls_tc(match, value->u8);
1292 match_set_mpls_bos(match, value->u8);
1296 match_set_nw_src(match, value->be32);
1300 match_set_nw_dst(match, value->be32);
1304 match_set_ipv6_src(match, &value->ipv6);
1308 match_set_ipv6_dst(match, &value->ipv6);
1311 case MFF_IPV6_LABEL:
1312 match_set_ipv6_label(match, value->be32);
1316 match_set_nw_proto(match, value->u8);
1320 match_set_nw_dscp(match, value->u8);
1323 case MFF_IP_DSCP_SHIFTED:
1324 match_set_nw_dscp(match, value->u8 << 2);
1328 match_set_nw_ecn(match, value->u8);
1332 match_set_nw_ttl(match, value->u8);
1336 match_set_nw_frag(match, value->u8);
1340 match_set_nw_proto(match, ntohs(value->be16));
1344 match_set_nw_src(match, value->be32);
1348 match_set_nw_dst(match, value->be32);
1353 match_set_arp_sha(match, value->mac);
1358 match_set_arp_tha(match, value->mac);
1364 match_set_tp_src(match, value->be16);
1370 match_set_tp_dst(match, value->be16);
1373 case MFF_ICMPV4_TYPE:
1374 case MFF_ICMPV6_TYPE:
1375 match_set_icmp_type(match, value->u8);
1378 case MFF_ICMPV4_CODE:
1379 case MFF_ICMPV6_CODE:
1380 match_set_icmp_code(match, value->u8);
1384 match_set_nd_target(match, &value->ipv6);
1393 /* Sets 'flow' member field described by 'mf' to 'value'. The caller is
1394 * responsible for ensuring that 'flow' meets 'mf''s prerequisites.*/
1396 mf_set_flow_value(const struct mf_field *mf,
1397 const union mf_value *value, struct flow *flow)
1401 flow->tunnel.tun_id = value->be64;
1404 flow->tunnel.ip_src = value->be32;
1407 flow->tunnel.ip_dst = value->be32;
1410 flow->tunnel.flags = ntohs(value->be16);
1413 flow->tunnel.ip_tos = value->u8;
1416 flow->tunnel.ip_ttl = value->u8;
1420 flow->metadata = value->be64;
1424 flow->in_port.ofp_port = u16_to_ofp(ntohs(value->be16));
1427 case MFF_IN_PORT_OXM: {
1429 ofputil_port_from_ofp11(value->be32, &port);
1430 flow->in_port.ofp_port = port;
1434 case MFF_SKB_PRIORITY:
1435 flow->skb_priority = ntohl(value->be32);
1439 flow->pkt_mark = ntohl(value->be32);
1443 flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1447 memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
1451 memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
1455 flow->dl_type = value->be16;
1459 flow->vlan_tci = value->be16;
1463 flow_set_dl_vlan(flow, value->be16);
1466 flow_set_vlan_vid(flow, value->be16);
1469 case MFF_DL_VLAN_PCP:
1471 flow_set_vlan_pcp(flow, value->u8);
1474 case MFF_MPLS_LABEL:
1475 flow_set_mpls_label(flow, value->be32);
1479 flow_set_mpls_tc(flow, value->u8);
1483 flow_set_mpls_bos(flow, value->u8);
1487 flow->nw_src = value->be32;
1491 flow->nw_dst = value->be32;
1495 flow->ipv6_src = value->ipv6;
1499 flow->ipv6_dst = value->ipv6;
1502 case MFF_IPV6_LABEL:
1503 flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1507 flow->nw_proto = value->u8;
1511 flow->nw_tos &= ~IP_DSCP_MASK;
1512 flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1515 case MFF_IP_DSCP_SHIFTED:
1516 flow->nw_tos &= ~IP_DSCP_MASK;
1517 flow->nw_tos |= value->u8 << 2;
1521 flow->nw_tos &= ~IP_ECN_MASK;
1522 flow->nw_tos |= value->u8 & IP_ECN_MASK;
1526 flow->nw_ttl = value->u8;
1530 flow->nw_frag &= value->u8;
1534 flow->nw_proto = ntohs(value->be16);
1538 flow->nw_src = value->be32;
1542 flow->nw_dst = value->be32;
1547 memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1552 memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1558 flow->tp_src = value->be16;
1564 flow->tp_dst = value->be16;
1567 case MFF_ICMPV4_TYPE:
1568 case MFF_ICMPV6_TYPE:
1569 flow->tp_src = htons(value->u8);
1572 case MFF_ICMPV4_CODE:
1573 case MFF_ICMPV6_CODE:
1574 flow->tp_dst = htons(value->u8);
1578 flow->nd_target = value->ipv6;
1587 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1589 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1592 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1594 union mf_value value;
1596 mf_get_value(mf, flow, &value);
1597 return is_all_zeros((const uint8_t *) &value, mf->n_bytes);
1600 /* Makes 'match' wildcard field 'mf'.
1602 * The caller is responsible for ensuring that 'match' meets 'mf''s
1605 mf_set_wild(const struct mf_field *mf, struct match *match)
1609 match_set_tun_id_masked(match, htonll(0), htonll(0));
1612 match_set_tun_src_masked(match, htonl(0), htonl(0));
1615 match_set_tun_dst_masked(match, htonl(0), htonl(0));
1618 match_set_tun_flags_masked(match, 0, 0);
1621 match_set_tun_tos_masked(match, 0, 0);
1624 match_set_tun_ttl_masked(match, 0, 0);
1628 match_set_metadata_masked(match, htonll(0), htonll(0));
1632 case MFF_IN_PORT_OXM:
1633 match->flow.in_port.ofp_port = 0;
1634 match->wc.masks.in_port.ofp_port = 0;
1637 case MFF_SKB_PRIORITY:
1638 match->flow.skb_priority = 0;
1639 match->wc.masks.skb_priority = 0;
1643 match->flow.pkt_mark = 0;
1644 match->wc.masks.pkt_mark = 0;
1648 match_set_reg_masked(match, mf->id - MFF_REG0, 0, 0);
1652 memset(match->flow.dl_src, 0, ETH_ADDR_LEN);
1653 memset(match->wc.masks.dl_src, 0, ETH_ADDR_LEN);
1657 memset(match->flow.dl_dst, 0, ETH_ADDR_LEN);
1658 memset(match->wc.masks.dl_dst, 0, ETH_ADDR_LEN);
1662 match->flow.dl_type = htons(0);
1663 match->wc.masks.dl_type = htons(0);
1667 match_set_dl_tci_masked(match, htons(0), htons(0));
1672 match_set_any_vid(match);
1675 case MFF_DL_VLAN_PCP:
1677 match_set_any_pcp(match);
1680 case MFF_MPLS_LABEL:
1681 match_set_any_mpls_label(match);
1685 match_set_any_mpls_tc(match);
1689 match_set_any_mpls_bos(match);
1694 match_set_nw_src_masked(match, htonl(0), htonl(0));
1699 match_set_nw_dst_masked(match, htonl(0), htonl(0));
1703 memset(&match->wc.masks.ipv6_src, 0, sizeof match->wc.masks.ipv6_src);
1704 memset(&match->flow.ipv6_src, 0, sizeof match->flow.ipv6_src);
1708 memset(&match->wc.masks.ipv6_dst, 0, sizeof match->wc.masks.ipv6_dst);
1709 memset(&match->flow.ipv6_dst, 0, sizeof match->flow.ipv6_dst);
1712 case MFF_IPV6_LABEL:
1713 match->wc.masks.ipv6_label = htonl(0);
1714 match->flow.ipv6_label = htonl(0);
1718 match->wc.masks.nw_proto = 0;
1719 match->flow.nw_proto = 0;
1723 case MFF_IP_DSCP_SHIFTED:
1724 match->wc.masks.nw_tos &= ~IP_DSCP_MASK;
1725 match->flow.nw_tos &= ~IP_DSCP_MASK;
1729 match->wc.masks.nw_tos &= ~IP_ECN_MASK;
1730 match->flow.nw_tos &= ~IP_ECN_MASK;
1734 match->wc.masks.nw_ttl = 0;
1735 match->flow.nw_ttl = 0;
1739 match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
1740 match->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1744 match->wc.masks.nw_proto = 0;
1745 match->flow.nw_proto = 0;
1750 memset(match->flow.arp_sha, 0, ETH_ADDR_LEN);
1751 memset(match->wc.masks.arp_sha, 0, ETH_ADDR_LEN);
1756 memset(match->flow.arp_tha, 0, ETH_ADDR_LEN);
1757 memset(match->wc.masks.arp_tha, 0, ETH_ADDR_LEN);
1763 case MFF_ICMPV4_TYPE:
1764 case MFF_ICMPV6_TYPE:
1765 match->wc.masks.tp_src = htons(0);
1766 match->flow.tp_src = htons(0);
1772 case MFF_ICMPV4_CODE:
1773 case MFF_ICMPV6_CODE:
1774 match->wc.masks.tp_dst = htons(0);
1775 match->flow.tp_dst = htons(0);
1779 memset(&match->wc.masks.nd_target, 0,
1780 sizeof match->wc.masks.nd_target);
1781 memset(&match->flow.nd_target, 0, sizeof match->flow.nd_target);
1790 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
1791 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1792 * with a 1-bit indicating that the corresponding value bit must match and a
1793 * 0-bit indicating a don't-care.
1795 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1796 * mf_set_value(mf, value, match). If 'mask' points to all-0-bits, then this
1797 * call is equivalent to mf_set_wild(mf, match).
1799 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
1800 * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
1802 mf_set(const struct mf_field *mf,
1803 const union mf_value *value, const union mf_value *mask,
1804 struct match *match)
1806 if (!mask || is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
1807 mf_set_value(mf, value, match);
1809 } else if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
1810 mf_set_wild(mf, match);
1816 case MFF_IN_PORT_OXM:
1817 case MFF_SKB_PRIORITY:
1820 case MFF_DL_VLAN_PCP:
1822 case MFF_MPLS_LABEL:
1828 case MFF_IP_DSCP_SHIFTED:
1831 case MFF_ICMPV4_TYPE:
1832 case MFF_ICMPV4_CODE:
1833 case MFF_ICMPV6_TYPE:
1834 case MFF_ICMPV6_CODE:
1838 match_set_tun_id_masked(match, value->be64, mask->be64);
1841 match_set_tun_src_masked(match, value->be32, mask->be32);
1844 match_set_tun_dst_masked(match, value->be32, mask->be32);
1847 match_set_tun_flags_masked(match, ntohs(value->be16), ntohs(mask->be16));
1850 match_set_tun_ttl_masked(match, value->u8, mask->u8);
1853 match_set_tun_tos_masked(match, value->u8, mask->u8);
1857 match_set_metadata_masked(match, value->be64, mask->be64);
1861 match_set_reg_masked(match, mf->id - MFF_REG0,
1862 ntohl(value->be32), ntohl(mask->be32));
1866 match_set_pkt_mark_masked(match, ntohl(value->be32),
1871 match_set_dl_dst_masked(match, value->mac, mask->mac);
1875 match_set_dl_src_masked(match, value->mac, mask->mac);
1880 match_set_arp_sha_masked(match, value->mac, mask->mac);
1885 match_set_arp_tha_masked(match, value->mac, mask->mac);
1889 match_set_dl_tci_masked(match, value->be16, mask->be16);
1893 match_set_vlan_vid_masked(match, value->be16, mask->be16);
1897 match_set_nw_src_masked(match, value->be32, mask->be32);
1901 match_set_nw_dst_masked(match, value->be32, mask->be32);
1905 match_set_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
1909 match_set_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
1912 case MFF_IPV6_LABEL:
1913 if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
1914 mf_set_value(mf, value, match);
1916 match_set_ipv6_label_masked(match, value->be32, mask->be32);
1921 match_set_nd_target_masked(match, &value->ipv6, &mask->ipv6);
1925 match_set_nw_frag_masked(match, value->u8, mask->u8);
1929 match_set_nw_src_masked(match, value->be32, mask->be32);
1933 match_set_nw_dst_masked(match, value->be32, mask->be32);
1939 match_set_tp_src_masked(match, value->be16, mask->be16);
1945 match_set_tp_dst_masked(match, value->be16, mask->be16);
1955 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
1959 VLOG_WARN_RL(&rl, "unknown %s field", type);
1960 } else if (!sf->n_bits) {
1961 VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
1962 } else if (sf->ofs >= sf->field->n_bits) {
1963 VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
1964 sf->ofs, sf->field->n_bits, type, sf->field->name);
1965 } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
1966 VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
1967 "of %s field %s", sf->ofs, sf->n_bits,
1968 sf->field->n_bits, type, sf->field->name);
1969 } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
1970 VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
1971 type, sf->field->name);
1976 return OFPERR_OFPBAC_BAD_ARGUMENT;
1979 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
1980 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
1983 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
1985 return mf_check__(sf, flow, "source");
1988 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
1989 * if so, otherwise an OpenFlow error code (e.g. as returned by
1992 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
1994 int error = mf_check__(sf, flow, "destination");
1995 if (!error && !sf->field->writable) {
1996 VLOG_WARN_RL(&rl, "destination field %s is not writable",
1998 return OFPERR_OFPBAC_BAD_ARGUMENT;
2003 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
2004 * 'value' and 'mask', respectively. */
2006 mf_get(const struct mf_field *mf, const struct match *match,
2007 union mf_value *value, union mf_value *mask)
2009 mf_get_value(mf, &match->flow, value);
2010 mf_get_mask(mf, &match->wc, mask);
2013 /* Assigns a random value for field 'mf' to 'value'. */
2015 mf_random_value(const struct mf_field *mf, union mf_value *value)
2017 random_bytes(value, mf->n_bytes);
2029 case MFF_SKB_PRIORITY:
2051 case MFF_ICMPV4_TYPE:
2052 case MFF_ICMPV4_CODE:
2053 case MFF_ICMPV6_TYPE:
2054 case MFF_ICMPV6_CODE:
2060 case MFF_IN_PORT_OXM:
2061 value->be32 = ofputil_port_to_ofp11(u16_to_ofp(ntohs(value->be16)));
2064 case MFF_IPV6_LABEL:
2065 value->be32 &= ~htonl(IPV6_LABEL_MASK);
2069 value->u8 &= IP_DSCP_MASK;
2072 case MFF_IP_DSCP_SHIFTED:
2073 value->u8 &= IP_DSCP_MASK >> 2;
2077 value->u8 &= IP_ECN_MASK;
2081 value->u8 &= FLOW_NW_FRAG_MASK;
2085 value->be16 &= htons(0xff);
2089 value->be16 &= htons(VLAN_VID_MASK);
2092 value->be16 &= htons(VLAN_VID_MASK | VLAN_CFI);
2095 case MFF_DL_VLAN_PCP:
2100 case MFF_MPLS_LABEL:
2101 value->be32 &= htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT);
2105 value->u8 &= MPLS_TC_MASK >> MPLS_TC_SHIFT;
2109 value->u8 &= MPLS_BOS_MASK >> MPLS_BOS_SHIFT;
2119 mf_from_integer_string(const struct mf_field *mf, const char *s,
2120 uint8_t *valuep, uint8_t *maskp)
2122 unsigned long long int integer, mask;
2127 integer = strtoull(s, &tail, 0);
2128 if (errno || (*tail != '\0' && *tail != '/')) {
2133 mask = strtoull(tail + 1, &tail, 0);
2134 if (errno || *tail != '\0') {
2141 for (i = mf->n_bytes - 1; i >= 0; i--) {
2142 valuep[i] = integer;
2148 return xasprintf("%s: value too large for %u-byte field %s",
2149 s, mf->n_bytes, mf->name);
2154 return xasprintf("%s: bad syntax for %s", s, mf->name);
2158 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
2159 uint8_t mac[ETH_ADDR_LEN],
2160 uint8_t mask[ETH_ADDR_LEN])
2164 ovs_assert(mf->n_bytes == ETH_ADDR_LEN);
2167 if (sscanf(s, ETH_ADDR_SCAN_FMT"%n", ETH_ADDR_SCAN_ARGS(mac), &n) > 0
2168 && n == strlen(s)) {
2169 memset(mask, 0xff, ETH_ADDR_LEN);
2174 if (sscanf(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT"%n",
2175 ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask), &n) > 0
2176 && n == strlen(s)) {
2180 return xasprintf("%s: invalid Ethernet address", s);
2184 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
2185 ovs_be32 *ip, ovs_be32 *mask)
2189 ovs_assert(mf->n_bytes == sizeof *ip);
2191 if (sscanf(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
2192 IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask)) == IP_SCAN_COUNT * 2) {
2194 } else if (sscanf(s, IP_SCAN_FMT"/%d",
2195 IP_SCAN_ARGS(ip), &prefix) == IP_SCAN_COUNT + 1) {
2196 if (prefix <= 0 || prefix > 32) {
2197 return xasprintf("%s: network prefix bits not between 1 and "
2199 } else if (prefix == 32) {
2200 *mask = htonl(UINT32_MAX);
2202 *mask = htonl(((1u << prefix) - 1) << (32 - prefix));
2204 } else if (sscanf(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip)) == IP_SCAN_COUNT) {
2205 *mask = htonl(UINT32_MAX);
2207 return xasprintf("%s: invalid IP address", s);
2213 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
2214 struct in6_addr *value, struct in6_addr *mask)
2216 char *str = xstrdup(s);
2217 char *save_ptr = NULL;
2218 const char *name, *netmask;
2221 ovs_assert(mf->n_bytes == sizeof *value);
2223 name = strtok_r(str, "/", &save_ptr);
2224 retval = name ? lookup_ipv6(name, value) : EINVAL;
2228 err = xasprintf("%s: could not convert to IPv6 address", str);
2234 netmask = strtok_r(NULL, "/", &save_ptr);
2236 if (inet_pton(AF_INET6, netmask, mask) != 1) {
2237 int prefix = atoi(netmask);
2238 if (prefix <= 0 || prefix > 128) {
2240 return xasprintf("%s: prefix bits not between 1 and 128", s);
2242 *mask = ipv6_create_mask(prefix);
2246 *mask = in6addr_exact;
2254 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
2255 ovs_be16 *valuep, ovs_be16 *maskp)
2259 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2261 if (ofputil_port_from_string(s, &port)) {
2262 *valuep = htons(ofp_to_u16(port));
2263 *maskp = htons(UINT16_MAX);
2266 return xasprintf("%s: port value out of range for %s", s, mf->name);
2270 mf_from_ofp_port_string32(const struct mf_field *mf, const char *s,
2271 ovs_be32 *valuep, ovs_be32 *maskp)
2275 ovs_assert(mf->n_bytes == sizeof(ovs_be32));
2276 if (ofputil_port_from_string(s, &port)) {
2277 *valuep = ofputil_port_to_ofp11(port);
2278 *maskp = htonl(UINT32_MAX);
2281 return xasprintf("%s: port value out of range for %s", s, mf->name);
2284 struct frag_handling {
2290 static const struct frag_handling all_frags[] = {
2291 #define A FLOW_NW_FRAG_ANY
2292 #define L FLOW_NW_FRAG_LATER
2293 /* name mask value */
2296 { "first", A|L, A },
2297 { "later", A|L, A|L },
2302 { "not_later", L, 0 },
2309 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
2311 const struct frag_handling *h;
2313 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2314 if (!strcasecmp(s, h->name)) {
2315 /* We force the upper bits of the mask on to make mf_parse_value()
2316 * happy (otherwise it will never think it's an exact match.) */
2317 *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
2323 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2324 "\"yes\", \"first\", \"later\", \"not_first\"", s);
2328 parse_flow_tun_flags(const char *s_, const char *(*bit_to_string)(uint32_t),
2331 uint32_t result = 0;
2332 char *save_ptr = NULL;
2335 char *s = xstrdup(s_);
2337 for (name = strtok_r((char *)s, " |", &save_ptr); name;
2338 name = strtok_r(NULL, " |", &save_ptr)) {
2340 unsigned long long int flags;
2344 if (sscanf(name, "%lli%n", &flags, &n0) > 0 && n0 > 0) {
2348 name_len = strlen(name);
2349 for (bit = 1; bit; bit <<= 1) {
2350 const char *fname = bit_to_string(bit);
2357 len = strlen(fname);
2358 if (len != name_len) {
2361 if (!strncmp(name, fname, len)) {
2373 *res = htons(result);
2380 mf_from_tun_flags_string(const char *s, ovs_be16 *valuep, ovs_be16 *maskp)
2382 if (!parse_flow_tun_flags(s, flow_tun_flag_to_string, valuep)) {
2383 *maskp = htons(UINT16_MAX);
2387 return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
2388 "\"csum\", \"key\"", s);
2391 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2392 * NULL if successful, otherwise a malloc()'d string describing the error. */
2394 mf_parse(const struct mf_field *mf, const char *s,
2395 union mf_value *value, union mf_value *mask)
2397 if (!strcmp(s, "*")) {
2398 memset(value, 0, mf->n_bytes);
2399 memset(mask, 0, mf->n_bytes);
2403 switch (mf->string) {
2405 case MFS_HEXADECIMAL:
2406 return mf_from_integer_string(mf, s,
2407 (uint8_t *) value, (uint8_t *) mask);
2410 return mf_from_ethernet_string(mf, s, value->mac, mask->mac);
2413 return mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
2416 return mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
2419 return mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
2421 case MFS_OFP_PORT_OXM:
2422 return mf_from_ofp_port_string32(mf, s, &value->be32, &mask->be32);
2425 return mf_from_frag_string(s, &value->u8, &mask->u8);
2428 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2429 return mf_from_tun_flags_string(s, &value->be16, &mask->be16);
2434 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2435 * successful, otherwise a malloc()'d string describing the error. */
2437 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2439 union mf_value mask;
2442 error = mf_parse(mf, s, value, &mask);
2447 if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2448 return xasprintf("%s: wildcards not allowed here", s);
2454 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2455 const uint8_t *maskp, struct ds *s)
2457 unsigned long long int integer;
2460 ovs_assert(mf->n_bytes <= 8);
2463 for (i = 0; i < mf->n_bytes; i++) {
2464 integer = (integer << 8) | valuep[i];
2466 if (mf->string == MFS_HEXADECIMAL) {
2467 ds_put_format(s, "%#llx", integer);
2469 ds_put_format(s, "%lld", integer);
2473 unsigned long long int mask;
2476 for (i = 0; i < mf->n_bytes; i++) {
2477 mask = (mask << 8) | maskp[i];
2480 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2481 * not sure that that a bit-mask written in decimal is ever easier to
2482 * understand than the same bit-mask written in hexadecimal. */
2483 ds_put_format(s, "/%#llx", mask);
2488 mf_format_frag_string(uint8_t value, uint8_t mask, struct ds *s)
2490 const struct frag_handling *h;
2492 mask &= FLOW_NW_FRAG_MASK;
2495 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2496 if (value == h->value && mask == h->mask) {
2497 ds_put_cstr(s, h->name);
2501 ds_put_cstr(s, "<error>");
2505 mf_format_tnl_flags_string(const ovs_be16 *valuep, struct ds *s)
2507 format_flags(s, flow_tun_flag_to_string, ntohs(*valuep), '|');
2510 /* Appends to 's' a string representation of field 'mf' whose value is in
2511 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2513 mf_format(const struct mf_field *mf,
2514 const union mf_value *value, const union mf_value *mask,
2518 if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2519 ds_put_cstr(s, "ANY");
2521 } else if (is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2526 switch (mf->string) {
2527 case MFS_OFP_PORT_OXM:
2530 ofputil_port_from_ofp11(value->be32, &port);
2531 ofputil_format_port(port, s);
2537 ofputil_format_port(u16_to_ofp(ntohs(value->be16)), s);
2542 case MFS_HEXADECIMAL:
2543 mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2547 eth_format_masked(value->mac, mask->mac, s);
2551 ip_format_masked(value->be32, mask ? mask->be32 : htonl(UINT32_MAX),
2556 print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2560 mf_format_frag_string(value->u8, mask ? mask->u8 : UINT8_MAX, s);
2564 mf_format_tnl_flags_string(&value->be16, s);
2572 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2573 * least-significant bits in 'x'.
2576 mf_write_subfield_flow(const struct mf_subfield *sf,
2577 const union mf_subvalue *x, struct flow *flow)
2579 const struct mf_field *field = sf->field;
2580 union mf_value value;
2582 mf_get_value(field, flow, &value);
2583 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes,
2584 sf->ofs, sf->n_bits);
2585 mf_set_flow_value(field, &value, flow);
2588 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2589 * least-significant bits in 'x'.
2592 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2593 struct match *match)
2595 const struct mf_field *field = sf->field;
2596 union mf_value value, mask;
2598 mf_get(field, match, &value, &mask);
2599 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2600 bitwise_one ( &mask, field->n_bytes, sf->ofs, sf->n_bits);
2601 mf_set(field, &value, &mask, match);
2604 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2605 * reading 'flow', e.g. as checked by mf_check_src(). */
2607 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2608 union mf_subvalue *x)
2610 union mf_value value;
2612 mf_get_value(sf->field, flow, &value);
2614 memset(x, 0, sizeof *x);
2615 bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2620 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2621 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2624 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2626 union mf_value value;
2628 mf_get_value(sf->field, flow, &value);
2629 return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2632 /* Formats 'sf' into 's' in a format normally acceptable to
2633 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2634 * sf->field has no NXM name.) */
2636 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
2639 ds_put_cstr(s, "<unknown>");
2640 } else if (sf->field->nxm_name) {
2641 ds_put_cstr(s, sf->field->nxm_name);
2642 } else if (sf->field->nxm_header) {
2643 uint32_t header = sf->field->nxm_header;
2644 ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
2646 ds_put_cstr(s, sf->field->name);
2649 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
2650 ds_put_cstr(s, "[]");
2651 } else if (sf->n_bits == 1) {
2652 ds_put_format(s, "[%d]", sf->ofs);
2654 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
2658 static const struct mf_field *
2659 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
2663 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
2668 for (i = 0; i < MFF_N_IDS; i++) {
2669 const struct mf_field *mf = mf_from_id(i);
2672 && !strncmp(mf->nxm_name, name, name_len)
2673 && mf->nxm_name[name_len] == '\0') {
2677 && !strncmp(mf->oxm_name, name, name_len)
2678 && mf->oxm_name[name_len] == '\0') {
2686 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2687 * returns NULL and advances '*sp' to the first byte following the parsed
2688 * string. On failure, returns a malloc()'d error message, does not modify
2689 * '*sp', and does not properly initialize 'sf'.
2691 * The syntax parsed from '*sp' takes the form "header[start..end]" where
2692 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2693 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2694 * may both be omitted (the [] are still required) to indicate an entire
2696 char * WARN_UNUSED_RESULT
2697 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
2699 const struct mf_field *field;
2708 name_len = strcspn(s, "[");
2709 if (s[name_len] != '[') {
2710 return xasprintf("%s: missing [ looking for field name", *sp);
2713 field = mf_parse_subfield_name(name, name_len, &wild);
2715 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
2719 if (sscanf(s, "[%d..%d]", &start, &end) == 2) {
2720 /* Nothing to do. */
2721 } else if (sscanf(s, "[%d]", &start) == 1) {
2723 } else if (!strncmp(s, "[]", 2)) {
2725 end = field->n_bits - 1;
2727 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2728 "[<start>..<end>]", *sp);
2730 s = strchr(s, ']') + 1;
2733 return xasprintf("%s: starting bit %d is after ending bit %d",
2735 } else if (start >= field->n_bits) {
2736 return xasprintf("%s: starting bit %d is not valid because field is "
2737 "only %d bits wide", *sp, start, field->n_bits);
2738 } else if (end >= field->n_bits){
2739 return xasprintf("%s: ending bit %d is not valid because field is "
2740 "only %d bits wide", *sp, end, field->n_bits);
2745 sf->n_bits = end - start + 1;
2751 /* Parses a subfield from the entirety of 's' into 'sf'. Returns NULL if
2752 * successful, otherwise a malloc()'d string describing the error. The caller
2753 * is responsible for freeing the returned string.
2755 * The syntax parsed from 's' takes the form "header[start..end]" where
2756 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2757 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2758 * may both be omitted (the [] are still required) to indicate an entire
2760 char * WARN_UNUSED_RESULT
2761 mf_parse_subfield(struct mf_subfield *sf, const char *s)
2763 char *error = mf_parse_subfield__(sf, &s);
2764 if (!error && s[0]) {
2765 error = xstrdup("unexpected input following field syntax");
2771 mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s)
2775 for (i = 0; i < ARRAY_SIZE(subvalue->u8); i++) {
2776 if (subvalue->u8[i]) {
2777 ds_put_format(s, "0x%"PRIx8, subvalue->u8[i]);
2778 for (i++; i < ARRAY_SIZE(subvalue->u8); i++) {
2779 ds_put_format(s, "%02"PRIx8, subvalue->u8[i]);
2784 ds_put_char(s, '0');