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"
33 #include "socket-util.h"
34 #include "unaligned.h"
37 VLOG_DEFINE_THIS_MODULE(meta_flow);
39 #define MF_FIELD_SIZES(MEMBER) \
40 sizeof ((union mf_value *)0)->MEMBER, \
41 8 * sizeof ((union mf_value *)0)->MEMBER
43 static const struct mf_field mf_fields[MFF_N_IDS] = {
49 MFF_TUN_ID, "tun_id", NULL,
55 NXM_NX_TUN_ID, "NXM_NX_TUN_ID",
56 OXM_OF_TUNNEL_ID, "OXM_OF_TUNNEL_ID",
58 MFF_TUN_SRC, "tun_src", NULL,
67 MFF_TUN_DST, "tun_dst", NULL,
76 MFF_TUN_FLAGS, "tun_flags", NULL,
85 MFF_TUN_TOS, "tun_tos", NULL,
94 MFF_TUN_TTL, "tun_ttl", NULL,
103 MFF_METADATA, "metadata", NULL,
104 MF_FIELD_SIZES(be64),
109 OXM_OF_METADATA, "OXM_OF_METADATA",
110 OXM_OF_METADATA, "OXM_OF_METADATA",
112 MFF_IN_PORT, "in_port", NULL,
113 MF_FIELD_SIZES(be16),
118 NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
119 OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
121 MFF_SKB_PRIORITY, "skb_priority", NULL,
122 MF_FIELD_SIZES(be32),
130 MFF_SKB_MARK, "skb_mark", NULL,
131 MF_FIELD_SIZES(be32),
140 #define REGISTER(IDX) \
142 MFF_REG##IDX, "reg" #IDX, NULL, \
143 MF_FIELD_SIZES(be32), \
148 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
149 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
184 MFF_ETH_SRC, "eth_src", "dl_src",
190 NXM_OF_ETH_SRC, "NXM_OF_ETH_SRC",
191 OXM_OF_ETH_SRC, "OXM_OF_ETH_SRC",
193 MFF_ETH_DST, "eth_dst", "dl_dst",
199 NXM_OF_ETH_DST, "NXM_OF_ETH_DST",
200 OXM_OF_ETH_DST, "OXM_OF_ETH_DST",
202 MFF_ETH_TYPE, "eth_type", "dl_type",
203 MF_FIELD_SIZES(be16),
208 NXM_OF_ETH_TYPE, "NXM_OF_ETH_TYPE",
209 OXM_OF_ETH_TYPE, "OXM_OF_ETH_TYPE",
213 MFF_VLAN_TCI, "vlan_tci", NULL,
214 MF_FIELD_SIZES(be16),
219 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
220 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
222 MFF_DL_VLAN, "dl_vlan", NULL,
223 sizeof(ovs_be16), 12,
231 MFF_VLAN_VID, "vlan_vid", NULL,
232 sizeof(ovs_be16), 12,
237 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
238 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
240 MFF_DL_VLAN_PCP, "dl_vlan_pcp", NULL,
249 MFF_VLAN_PCP, "vlan_pcp", NULL,
255 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
256 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
263 MFF_MPLS_LABEL, "mpls_label", NULL,
269 OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
270 OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
272 MFF_MPLS_TC, "mpls_tc", NULL,
278 OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
279 OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
281 MFF_MPLS_BOS, "mpls_bos", NULL,
287 OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
288 OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
296 MFF_IPV4_SRC, "ip_src", "nw_src",
297 MF_FIELD_SIZES(be32),
302 NXM_OF_IP_SRC, "NXM_OF_IP_SRC",
303 OXM_OF_IPV4_SRC, "OXM_OF_IPV4_SRC",
305 MFF_IPV4_DST, "ip_dst", "nw_dst",
306 MF_FIELD_SIZES(be32),
311 NXM_OF_IP_DST, "NXM_OF_IP_DST",
312 OXM_OF_IPV4_DST, "OXM_OF_IPV4_DST",
316 MFF_IPV6_SRC, "ipv6_src", NULL,
317 MF_FIELD_SIZES(ipv6),
322 NXM_NX_IPV6_SRC, "NXM_NX_IPV6_SRC",
323 OXM_OF_IPV6_SRC, "OXM_OF_IPV6_SRC",
325 MFF_IPV6_DST, "ipv6_dst", NULL,
326 MF_FIELD_SIZES(ipv6),
331 NXM_NX_IPV6_DST, "NXM_NX_IPV6_DST",
332 OXM_OF_IPV6_DST, "OXM_OF_IPV6_DST",
335 MFF_IPV6_LABEL, "ipv6_label", NULL,
341 NXM_NX_IPV6_LABEL, "NXM_NX_IPV6_LABEL",
342 OXM_OF_IPV6_FLABEL, "OXM_OF_IPV6_FLABEL",
346 MFF_IP_PROTO, "nw_proto", NULL,
352 NXM_OF_IP_PROTO, "NXM_OF_IP_PROTO",
353 OXM_OF_IP_PROTO, "OXM_OF_IP_PROTO",
355 MFF_IP_DSCP, "nw_tos", NULL,
361 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
362 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
364 MFF_IP_ECN, "nw_ecn", NULL,
370 NXM_NX_IP_ECN, "NXM_NX_IP_ECN",
371 OXM_OF_IP_ECN, "OXM_OF_IP_ECN",
373 MFF_IP_TTL, "nw_ttl", NULL,
379 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
380 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
382 MFF_IP_FRAG, "ip_frag", NULL,
388 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
389 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
393 MFF_ARP_OP, "arp_op", NULL,
394 MF_FIELD_SIZES(be16),
399 NXM_OF_ARP_OP, "NXM_OF_ARP_OP",
400 OXM_OF_ARP_OP, "OXM_OF_ARP_OP",
402 MFF_ARP_SPA, "arp_spa", NULL,
403 MF_FIELD_SIZES(be32),
408 NXM_OF_ARP_SPA, "NXM_OF_ARP_SPA",
409 OXM_OF_ARP_SPA, "OXM_OF_ARP_SPA",
411 MFF_ARP_TPA, "arp_tpa", NULL,
412 MF_FIELD_SIZES(be32),
417 NXM_OF_ARP_TPA, "NXM_OF_ARP_TPA",
418 OXM_OF_ARP_TPA, "OXM_OF_ARP_TPA",
420 MFF_ARP_SHA, "arp_sha", NULL,
426 NXM_NX_ARP_SHA, "NXM_NX_ARP_SHA",
427 OXM_OF_ARP_SHA, "OXM_OF_ARP_SHA",
429 MFF_ARP_THA, "arp_tha", NULL,
435 NXM_NX_ARP_THA, "NXM_NX_ARP_THA",
436 OXM_OF_ARP_THA, "OXM_OF_ARP_THA",
444 MFF_TCP_SRC, "tcp_src", "tp_src",
445 MF_FIELD_SIZES(be16),
450 NXM_OF_TCP_SRC, "NXM_OF_TCP_SRC",
451 OXM_OF_TCP_SRC, "OXM_OF_TCP_SRC",
453 MFF_TCP_DST, "tcp_dst", "tp_dst",
454 MF_FIELD_SIZES(be16),
459 NXM_OF_TCP_DST, "NXM_OF_TCP_DST",
460 OXM_OF_TCP_DST, "OXM_OF_TCP_DST",
464 MFF_UDP_SRC, "udp_src", NULL,
465 MF_FIELD_SIZES(be16),
470 NXM_OF_UDP_SRC, "NXM_OF_UDP_SRC",
471 OXM_OF_UDP_SRC, "OXM_OF_UDP_SRC",
473 MFF_UDP_DST, "udp_dst", NULL,
474 MF_FIELD_SIZES(be16),
479 NXM_OF_UDP_DST, "NXM_OF_UDP_DST",
480 OXM_OF_UDP_DST, "OXM_OF_UDP_DST",
484 MFF_ICMPV4_TYPE, "icmp_type", NULL,
490 NXM_OF_ICMP_TYPE, "NXM_OF_ICMP_TYPE",
491 OXM_OF_ICMPV4_TYPE, "OXM_OF_ICMPV4_TYPE",
493 MFF_ICMPV4_CODE, "icmp_code", NULL,
499 NXM_OF_ICMP_CODE, "NXM_OF_ICMP_CODE",
500 OXM_OF_ICMPV4_CODE, "OXM_OF_ICMPV4_CODE",
504 MFF_ICMPV6_TYPE, "icmpv6_type", NULL,
510 NXM_NX_ICMPV6_TYPE, "NXM_NX_ICMPV6_TYPE",
511 OXM_OF_ICMPV6_TYPE, "OXM_OF_ICMPV6_TYPE",
513 MFF_ICMPV6_CODE, "icmpv6_code", NULL,
519 NXM_NX_ICMPV6_CODE, "NXM_NX_ICMPV6_CODE",
520 OXM_OF_ICMPV6_CODE, "OXM_OF_ICMPV6_CODE",
528 MFF_ND_TARGET, "nd_target", NULL,
529 MF_FIELD_SIZES(ipv6),
534 NXM_NX_ND_TARGET, "NXM_NX_ND_TARGET",
535 OXM_OF_IPV6_ND_TARGET, "OXM_OF_IPV6_ND_TARGET",
537 MFF_ND_SLL, "nd_sll", NULL,
543 NXM_NX_ND_SLL, "NXM_NX_ND_SLL",
544 OXM_OF_IPV6_ND_SLL, "OXM_OF_IPV6_ND_SLL",
546 MFF_ND_TLL, "nd_tll", NULL,
552 NXM_NX_ND_TLL, "NXM_NX_ND_TLL",
553 OXM_OF_IPV6_ND_TLL, "OXM_OF_IPV6_ND_TLL",
557 /* Maps an NXM or OXM header value to an mf_field. */
559 struct hmap_node hmap_node; /* In 'all_fields' hmap. */
560 uint32_t header; /* NXM or OXM header value. */
561 const struct mf_field *mf;
564 /* Contains 'struct nxm_field's. */
565 static struct hmap all_fields = HMAP_INITIALIZER(&all_fields);
567 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
568 * controller and so there's not much point in showing a lot of them. */
569 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
571 const struct mf_field *mf_from_nxm_header__(uint32_t header);
573 /* Returns the field with the given 'id'. */
574 const struct mf_field *
575 mf_from_id(enum mf_field_id id)
577 ovs_assert((unsigned int) id < MFF_N_IDS);
578 return &mf_fields[id];
581 /* Returns the field with the given 'name', or a null pointer if no field has
583 const struct mf_field *
584 mf_from_name(const char *name)
586 static struct shash mf_by_name = SHASH_INITIALIZER(&mf_by_name);
588 if (shash_is_empty(&mf_by_name)) {
589 const struct mf_field *mf;
591 for (mf = mf_fields; mf < &mf_fields[MFF_N_IDS]; mf++) {
592 shash_add_once(&mf_by_name, mf->name, mf);
593 if (mf->extra_name) {
594 shash_add_once(&mf_by_name, mf->extra_name, mf);
599 return shash_find_data(&mf_by_name, name);
603 add_nxm_field(uint32_t header, const struct mf_field *mf)
607 f = xmalloc(sizeof *f);
608 hmap_insert(&all_fields, &f->hmap_node, hash_int(header, 0));
614 nxm_init_add_field(const struct mf_field *mf, uint32_t header)
617 ovs_assert(!mf_from_nxm_header__(header));
618 add_nxm_field(header, mf);
619 if (mf->maskable != MFM_NONE) {
620 add_nxm_field(NXM_MAKE_WILD_HEADER(header), mf);
628 const struct mf_field *mf;
630 for (mf = mf_fields; mf < &mf_fields[MFF_N_IDS]; mf++) {
631 nxm_init_add_field(mf, mf->nxm_header);
632 if (mf->oxm_header != mf->nxm_header) {
633 nxm_init_add_field(mf, mf->oxm_header);
638 const struct mf_field *
639 mf_from_nxm_header(uint32_t header)
641 if (hmap_is_empty(&all_fields)) {
644 return mf_from_nxm_header__(header);
647 const struct mf_field *
648 mf_from_nxm_header__(uint32_t header)
650 const struct nxm_field *f;
652 HMAP_FOR_EACH_IN_BUCKET (f, hmap_node, hash_int(header, 0), &all_fields) {
653 if (f->header == header) {
661 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
662 * specifies at least one bit in the field.
664 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
665 * meets 'mf''s prerequisites. */
667 mf_is_all_wild(const struct mf_field *mf, const struct flow_wildcards *wc)
676 return !wc->masks.tunnel.tun_id;
678 return !wc->masks.metadata;
680 return !wc->masks.in_port;
681 case MFF_SKB_PRIORITY:
682 return !wc->masks.skb_priority;
684 return !wc->masks.skb_mark;
686 return !wc->masks.regs[mf->id - MFF_REG0];
689 return eth_addr_is_zero(wc->masks.dl_src);
691 return eth_addr_is_zero(wc->masks.dl_dst);
693 return !wc->masks.dl_type;
697 return eth_addr_is_zero(wc->masks.arp_sha);
701 return eth_addr_is_zero(wc->masks.arp_tha);
704 return !wc->masks.vlan_tci;
706 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK));
708 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI));
709 case MFF_DL_VLAN_PCP:
711 return !(wc->masks.vlan_tci & htons(VLAN_PCP_MASK));
714 return !(wc->masks.mpls_lse & htonl(MPLS_LABEL_MASK));
716 return !(wc->masks.mpls_lse & htonl(MPLS_TC_MASK));
718 return !(wc->masks.mpls_lse & htonl(MPLS_BOS_MASK));
721 return !wc->masks.nw_src;
723 return !wc->masks.nw_dst;
726 return ipv6_mask_is_any(&wc->masks.ipv6_src);
728 return ipv6_mask_is_any(&wc->masks.ipv6_dst);
731 return !wc->masks.ipv6_label;
734 return !wc->masks.nw_proto;
736 return !(wc->masks.nw_tos & IP_DSCP_MASK);
738 return !(wc->masks.nw_tos & IP_ECN_MASK);
740 return !wc->masks.nw_ttl;
743 return ipv6_mask_is_any(&wc->masks.nd_target);
746 return !(wc->masks.nw_frag & FLOW_NW_FRAG_MASK);
749 return !wc->masks.nw_proto;
751 return !wc->masks.nw_src;
753 return !wc->masks.nw_dst;
757 case MFF_ICMPV4_TYPE:
758 case MFF_ICMPV6_TYPE:
759 return !wc->masks.tp_src;
762 case MFF_ICMPV4_CODE:
763 case MFF_ICMPV6_CODE:
764 return !wc->masks.tp_dst;
772 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
773 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
774 * purposes, or to 0 if it is wildcarded.
776 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
777 * meets 'mf''s prerequisites. */
779 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
780 union mf_value *mask)
782 mf_get_value(mf, &wc->masks, mask);
785 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
786 * if the mask is valid, false otherwise. */
788 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
790 switch (mf->maskable) {
792 return (is_all_zeros((const uint8_t *) mask, mf->n_bytes) ||
793 is_all_ones((const uint8_t *) mask, mf->n_bytes));
803 is_icmpv4(const struct flow *flow)
805 return (flow->dl_type == htons(ETH_TYPE_IP)
806 && flow->nw_proto == IPPROTO_ICMP);
810 is_icmpv6(const struct flow *flow)
812 return (flow->dl_type == htons(ETH_TYPE_IPV6)
813 && flow->nw_proto == IPPROTO_ICMPV6);
816 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
818 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
820 switch (mf->prereqs) {
825 return (flow->dl_type == htons(ETH_TYPE_ARP) ||
826 flow->dl_type == htons(ETH_TYPE_RARP));
828 return flow->dl_type == htons(ETH_TYPE_IP);
830 return flow->dl_type == htons(ETH_TYPE_IPV6);
832 return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
834 return eth_type_mpls(flow->dl_type);
836 return is_ip_any(flow);
839 return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP;
841 return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP;
843 return is_icmpv4(flow);
845 return is_icmpv6(flow);
848 return (is_icmpv6(flow)
849 && flow->tp_dst == htons(0)
850 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
851 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
853 return (is_icmpv6(flow)
854 && flow->tp_dst == htons(0)
855 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
857 return (is_icmpv6(flow)
858 && flow->tp_dst == htons(0)
859 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
865 /* Returns true if 'value' may be a valid value *as part of a masked match*,
868 * A value is not rejected just because it is not valid for the field in
869 * question, but only if it doesn't make sense to test the bits in question at
870 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
871 * without the VLAN_CFI bit being set, but we can't reject those values because
872 * it is still legitimate to test just for those bits (see the documentation
873 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
874 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
876 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
887 case MFF_SKB_PRIORITY:
908 case MFF_ICMPV4_TYPE:
909 case MFF_ICMPV4_CODE:
910 case MFF_ICMPV6_TYPE:
911 case MFF_ICMPV6_CODE:
918 return !(value->u8 & ~IP_DSCP_MASK);
920 return !(value->u8 & ~IP_ECN_MASK);
922 return !(value->u8 & ~FLOW_NW_FRAG_MASK);
925 return !(value->be16 & htons(0xff00));
928 return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
930 return !(value->be16 & htons(VLAN_PCP_MASK));
932 case MFF_DL_VLAN_PCP:
934 return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
937 return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
940 return !(value->be32 & ~htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT));
943 return !(value->u8 & ~(MPLS_TC_MASK >> MPLS_TC_SHIFT));
946 return !(value->u8 & ~(MPLS_BOS_MASK >> MPLS_BOS_SHIFT));
954 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
955 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
957 mf_get_value(const struct mf_field *mf, const struct flow *flow,
958 union mf_value *value)
962 value->be64 = flow->tunnel.tun_id;
965 value->be32 = flow->tunnel.ip_src;
968 value->be32 = flow->tunnel.ip_dst;
971 value->be16 = htons(flow->tunnel.flags);
974 value->u8 = flow->tunnel.ip_ttl;
977 value->u8 = flow->tunnel.ip_tos;
981 value->be64 = flow->metadata;
985 value->be16 = htons(flow->in_port);
988 case MFF_SKB_PRIORITY:
989 value->be32 = htonl(flow->skb_priority);
993 value->be32 = htonl(flow->skb_mark);
997 value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
1001 memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
1005 memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
1009 value->be16 = flow->dl_type;
1013 value->be16 = flow->vlan_tci;
1017 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
1020 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
1023 case MFF_DL_VLAN_PCP:
1025 value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
1028 case MFF_MPLS_LABEL:
1029 value->be32 = htonl(mpls_lse_to_label(flow->mpls_lse));
1033 value->u8 = mpls_lse_to_tc(flow->mpls_lse);
1037 value->u8 = mpls_lse_to_bos(flow->mpls_lse);
1041 value->be32 = flow->nw_src;
1045 value->be32 = flow->nw_dst;
1049 value->ipv6 = flow->ipv6_src;
1053 value->ipv6 = flow->ipv6_dst;
1056 case MFF_IPV6_LABEL:
1057 value->be32 = flow->ipv6_label;
1061 value->u8 = flow->nw_proto;
1065 value->u8 = flow->nw_tos & IP_DSCP_MASK;
1069 value->u8 = flow->nw_tos & IP_ECN_MASK;
1073 value->u8 = flow->nw_ttl;
1077 value->u8 = flow->nw_frag;
1081 value->be16 = htons(flow->nw_proto);
1085 value->be32 = flow->nw_src;
1089 value->be32 = flow->nw_dst;
1094 memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
1099 memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
1104 value->be16 = flow->tp_src;
1109 value->be16 = flow->tp_dst;
1112 case MFF_ICMPV4_TYPE:
1113 case MFF_ICMPV6_TYPE:
1114 value->u8 = ntohs(flow->tp_src);
1117 case MFF_ICMPV4_CODE:
1118 case MFF_ICMPV6_CODE:
1119 value->u8 = ntohs(flow->tp_dst);
1123 value->ipv6 = flow->nd_target;
1132 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1133 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1136 mf_set_value(const struct mf_field *mf,
1137 const union mf_value *value, struct match *match)
1141 match_set_tun_id(match, value->be64);
1144 match_set_tun_src(match, value->be32);
1147 match_set_tun_dst(match, value->be32);
1150 match_set_tun_flags(match, ntohs(value->be16));
1153 match_set_tun_tos(match, value->u8);
1156 match_set_tun_ttl(match, value->u8);
1160 match_set_metadata(match, value->be64);
1164 match_set_in_port(match, ntohs(value->be16));
1167 case MFF_SKB_PRIORITY:
1168 match_set_skb_priority(match, ntohl(value->be32));
1172 match_set_skb_mark(match, ntohl(value->be32));
1176 match_set_reg(match, mf->id - MFF_REG0, ntohl(value->be32));
1180 match_set_dl_src(match, value->mac);
1184 match_set_dl_dst(match, value->mac);
1188 match_set_dl_type(match, value->be16);
1192 match_set_dl_tci(match, value->be16);
1196 match_set_dl_vlan(match, value->be16);
1199 match_set_vlan_vid(match, value->be16);
1202 case MFF_DL_VLAN_PCP:
1204 match_set_dl_vlan_pcp(match, value->u8);
1207 case MFF_MPLS_LABEL:
1208 match_set_mpls_label(match, value->be32);
1212 match_set_mpls_tc(match, value->u8);
1216 match_set_mpls_bos(match, value->u8);
1220 match_set_nw_src(match, value->be32);
1224 match_set_nw_dst(match, value->be32);
1228 match_set_ipv6_src(match, &value->ipv6);
1232 match_set_ipv6_dst(match, &value->ipv6);
1235 case MFF_IPV6_LABEL:
1236 match_set_ipv6_label(match, value->be32);
1240 match_set_nw_proto(match, value->u8);
1244 match_set_nw_dscp(match, value->u8);
1248 match_set_nw_ecn(match, value->u8);
1252 match_set_nw_ttl(match, value->u8);
1256 match_set_nw_frag(match, value->u8);
1260 match_set_nw_proto(match, ntohs(value->be16));
1264 match_set_nw_src(match, value->be32);
1268 match_set_nw_dst(match, value->be32);
1273 match_set_arp_sha(match, value->mac);
1278 match_set_arp_tha(match, value->mac);
1283 match_set_tp_src(match, value->be16);
1288 match_set_tp_dst(match, value->be16);
1291 case MFF_ICMPV4_TYPE:
1292 case MFF_ICMPV6_TYPE:
1293 match_set_icmp_type(match, value->u8);
1296 case MFF_ICMPV4_CODE:
1297 case MFF_ICMPV6_CODE:
1298 match_set_icmp_code(match, value->u8);
1302 match_set_nd_target(match, &value->ipv6);
1311 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1312 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1315 mf_set_flow_value(const struct mf_field *mf,
1316 const union mf_value *value, struct flow *flow)
1320 flow->tunnel.tun_id = value->be64;
1323 flow->tunnel.ip_src = value->be32;
1326 flow->tunnel.ip_dst = value->be32;
1329 flow->tunnel.flags = ntohs(value->be16);
1332 flow->tunnel.ip_tos = value->u8;
1335 flow->tunnel.ip_ttl = value->u8;
1339 flow->metadata = value->be64;
1343 flow->in_port = ntohs(value->be16);
1346 case MFF_SKB_PRIORITY:
1347 flow->skb_priority = ntohl(value->be32);
1351 flow->skb_mark = ntohl(value->be32);
1355 flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1359 memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
1363 memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
1367 flow->dl_type = value->be16;
1371 flow->vlan_tci = value->be16;
1375 flow_set_dl_vlan(flow, value->be16);
1378 flow_set_vlan_vid(flow, value->be16);
1381 case MFF_DL_VLAN_PCP:
1383 flow_set_vlan_pcp(flow, value->u8);
1386 case MFF_MPLS_LABEL:
1387 flow_set_mpls_label(flow, value->be32);
1391 flow_set_mpls_tc(flow, value->u8);
1395 flow_set_mpls_bos(flow, value->u8);
1399 flow->nw_src = value->be32;
1403 flow->nw_dst = value->be32;
1407 flow->ipv6_src = value->ipv6;
1411 flow->ipv6_dst = value->ipv6;
1414 case MFF_IPV6_LABEL:
1415 flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1419 flow->nw_proto = value->u8;
1423 flow->nw_tos &= ~IP_DSCP_MASK;
1424 flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1428 flow->nw_tos &= ~IP_ECN_MASK;
1429 flow->nw_tos |= value->u8 & IP_ECN_MASK;
1433 flow->nw_ttl = value->u8;
1437 flow->nw_frag &= value->u8;
1441 flow->nw_proto = ntohs(value->be16);
1445 flow->nw_src = value->be32;
1449 flow->nw_dst = value->be32;
1454 memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1459 memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1464 flow->tp_src = value->be16;
1469 flow->tp_dst = value->be16;
1472 case MFF_ICMPV4_TYPE:
1473 case MFF_ICMPV6_TYPE:
1474 flow->tp_src = htons(value->u8);
1477 case MFF_ICMPV4_CODE:
1478 case MFF_ICMPV6_CODE:
1479 flow->tp_dst = htons(value->u8);
1483 flow->nd_target = value->ipv6;
1492 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1494 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1497 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1499 union mf_value value;
1501 mf_get_value(mf, flow, &value);
1502 return is_all_zeros((const uint8_t *) &value, mf->n_bytes);
1505 /* Makes 'match' wildcard field 'mf'.
1507 * The caller is responsible for ensuring that 'match' meets 'mf''s
1510 mf_set_wild(const struct mf_field *mf, struct match *match)
1514 match_set_tun_id_masked(match, htonll(0), htonll(0));
1517 match_set_tun_src_masked(match, htonl(0), htonl(0));
1520 match_set_tun_dst_masked(match, htonl(0), htonl(0));
1523 match_set_tun_flags_masked(match, 0, 0);
1526 match_set_tun_tos_masked(match, 0, 0);
1529 match_set_tun_ttl_masked(match, 0, 0);
1533 match_set_metadata_masked(match, htonll(0), htonll(0));
1537 match->flow.in_port = 0;
1538 match->wc.masks.in_port = 0;
1541 case MFF_SKB_PRIORITY:
1542 match->flow.skb_priority = 0;
1543 match->wc.masks.skb_priority = 0;
1547 match->flow.skb_mark = 0;
1548 match->wc.masks.skb_mark = 0;
1552 match_set_reg_masked(match, mf->id - MFF_REG0, 0, 0);
1556 memset(match->flow.dl_src, 0, ETH_ADDR_LEN);
1557 memset(match->wc.masks.dl_src, 0, ETH_ADDR_LEN);
1561 memset(match->flow.dl_dst, 0, ETH_ADDR_LEN);
1562 memset(match->wc.masks.dl_dst, 0, ETH_ADDR_LEN);
1566 match->flow.dl_type = htons(0);
1567 match->wc.masks.dl_type = htons(0);
1571 match_set_dl_tci_masked(match, htons(0), htons(0));
1576 match_set_any_vid(match);
1579 case MFF_DL_VLAN_PCP:
1581 match_set_any_pcp(match);
1584 case MFF_MPLS_LABEL:
1585 match_set_any_mpls_label(match);
1589 match_set_any_mpls_tc(match);
1593 match_set_any_mpls_bos(match);
1598 match_set_nw_src_masked(match, htonl(0), htonl(0));
1603 match_set_nw_dst_masked(match, htonl(0), htonl(0));
1607 memset(&match->wc.masks.ipv6_src, 0, sizeof match->wc.masks.ipv6_src);
1608 memset(&match->flow.ipv6_src, 0, sizeof match->flow.ipv6_src);
1612 memset(&match->wc.masks.ipv6_dst, 0, sizeof match->wc.masks.ipv6_dst);
1613 memset(&match->flow.ipv6_dst, 0, sizeof match->flow.ipv6_dst);
1616 case MFF_IPV6_LABEL:
1617 match->wc.masks.ipv6_label = htonl(0);
1618 match->flow.ipv6_label = htonl(0);
1622 match->wc.masks.nw_proto = 0;
1623 match->flow.nw_proto = 0;
1627 match->wc.masks.nw_tos &= ~IP_DSCP_MASK;
1628 match->flow.nw_tos &= ~IP_DSCP_MASK;
1632 match->wc.masks.nw_tos &= ~IP_ECN_MASK;
1633 match->flow.nw_tos &= ~IP_ECN_MASK;
1637 match->wc.masks.nw_ttl = 0;
1638 match->flow.nw_ttl = 0;
1642 match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
1643 match->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1647 match->wc.masks.nw_proto = 0;
1648 match->flow.nw_proto = 0;
1653 memset(match->flow.arp_sha, 0, ETH_ADDR_LEN);
1654 memset(match->wc.masks.arp_sha, 0, ETH_ADDR_LEN);
1659 memset(match->flow.arp_tha, 0, ETH_ADDR_LEN);
1660 memset(match->wc.masks.arp_tha, 0, ETH_ADDR_LEN);
1665 case MFF_ICMPV4_TYPE:
1666 case MFF_ICMPV6_TYPE:
1667 match->wc.masks.tp_src = htons(0);
1668 match->flow.tp_src = htons(0);
1673 case MFF_ICMPV4_CODE:
1674 case MFF_ICMPV6_CODE:
1675 match->wc.masks.tp_dst = htons(0);
1676 match->flow.tp_dst = htons(0);
1680 memset(&match->wc.masks.nd_target, 0,
1681 sizeof match->wc.masks.nd_target);
1682 memset(&match->flow.nd_target, 0, sizeof match->flow.nd_target);
1691 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
1692 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1693 * with a 1-bit indicating that the corresponding value bit must match and a
1694 * 0-bit indicating a don't-care.
1696 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1697 * mf_set_value(mf, value, match). If 'mask' points to all-0-bits, then this
1698 * call is equivalent to mf_set_wild(mf, match).
1700 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
1701 * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
1703 mf_set(const struct mf_field *mf,
1704 const union mf_value *value, const union mf_value *mask,
1705 struct match *match)
1707 if (!mask || is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
1708 mf_set_value(mf, value, match);
1710 } else if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
1711 mf_set_wild(mf, match);
1718 case MFF_SKB_PRIORITY:
1721 case MFF_DL_VLAN_PCP:
1723 case MFF_MPLS_LABEL:
1731 case MFF_ICMPV4_TYPE:
1732 case MFF_ICMPV4_CODE:
1733 case MFF_ICMPV6_TYPE:
1734 case MFF_ICMPV6_CODE:
1738 match_set_tun_id_masked(match, value->be64, mask->be64);
1741 match_set_tun_src_masked(match, value->be32, mask->be32);
1744 match_set_tun_dst_masked(match, value->be32, mask->be32);
1747 match_set_tun_flags_masked(match, ntohs(value->be16), ntohs(mask->be16));
1750 match_set_tun_ttl_masked(match, value->u8, mask->u8);
1753 match_set_tun_tos_masked(match, value->u8, mask->u8);
1757 match_set_metadata_masked(match, value->be64, mask->be64);
1761 match_set_reg_masked(match, mf->id - MFF_REG0,
1762 ntohl(value->be32), ntohl(mask->be32));
1766 match_set_dl_dst_masked(match, value->mac, mask->mac);
1770 match_set_dl_src_masked(match, value->mac, mask->mac);
1775 match_set_arp_sha_masked(match, value->mac, mask->mac);
1780 match_set_arp_tha_masked(match, value->mac, mask->mac);
1784 match_set_dl_tci_masked(match, value->be16, mask->be16);
1788 match_set_vlan_vid_masked(match, value->be16, mask->be16);
1792 match_set_nw_src_masked(match, value->be32, mask->be32);
1796 match_set_nw_dst_masked(match, value->be32, mask->be32);
1800 match_set_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
1804 match_set_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
1807 case MFF_IPV6_LABEL:
1808 if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
1809 mf_set_value(mf, value, match);
1811 match_set_ipv6_label_masked(match, value->be32, mask->be32);
1816 match_set_nd_target_masked(match, &value->ipv6, &mask->ipv6);
1820 match_set_nw_frag_masked(match, value->u8, mask->u8);
1824 match_set_nw_src_masked(match, value->be32, mask->be32);
1828 match_set_nw_dst_masked(match, value->be32, mask->be32);
1833 match_set_tp_src_masked(match, value->be16, mask->be16);
1838 match_set_tp_dst_masked(match, value->be16, mask->be16);
1848 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
1852 VLOG_WARN_RL(&rl, "unknown %s field", type);
1853 } else if (!sf->n_bits) {
1854 VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
1855 } else if (sf->ofs >= sf->field->n_bits) {
1856 VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
1857 sf->ofs, sf->field->n_bits, type, sf->field->name);
1858 } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
1859 VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
1860 "of %s field %s", sf->ofs, sf->n_bits,
1861 sf->field->n_bits, type, sf->field->name);
1862 } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
1863 VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
1864 type, sf->field->name);
1869 return OFPERR_OFPBAC_BAD_ARGUMENT;
1872 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
1873 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
1876 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
1878 return mf_check__(sf, flow, "source");
1881 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
1882 * if so, otherwise an OpenFlow error code (e.g. as returned by
1885 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
1887 int error = mf_check__(sf, flow, "destination");
1888 if (!error && !sf->field->writable) {
1889 VLOG_WARN_RL(&rl, "destination field %s is not writable",
1891 return OFPERR_OFPBAC_BAD_ARGUMENT;
1896 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
1897 * 'value' and 'mask', respectively. */
1899 mf_get(const struct mf_field *mf, const struct match *match,
1900 union mf_value *value, union mf_value *mask)
1902 mf_get_value(mf, &match->flow, value);
1903 mf_get_mask(mf, &match->wc, mask);
1906 /* Assigns a random value for field 'mf' to 'value'. */
1908 mf_random_value(const struct mf_field *mf, union mf_value *value)
1910 random_bytes(value, mf->n_bytes);
1922 case MFF_SKB_PRIORITY:
1942 case MFF_ICMPV4_TYPE:
1943 case MFF_ICMPV4_CODE:
1944 case MFF_ICMPV6_TYPE:
1945 case MFF_ICMPV6_CODE:
1951 case MFF_IPV6_LABEL:
1952 value->be32 &= ~htonl(IPV6_LABEL_MASK);
1956 value->u8 &= IP_DSCP_MASK;
1960 value->u8 &= IP_ECN_MASK;
1964 value->u8 &= FLOW_NW_FRAG_MASK;
1968 value->be16 &= htons(0xff);
1972 value->be16 &= htons(VLAN_VID_MASK);
1975 value->be16 &= htons(VLAN_VID_MASK | VLAN_CFI);
1978 case MFF_DL_VLAN_PCP:
1983 case MFF_MPLS_LABEL:
1984 value->be32 &= htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT);
1988 value->u8 &= MPLS_TC_MASK >> MPLS_TC_SHIFT;
1992 value->u8 &= MPLS_BOS_MASK >> MPLS_BOS_SHIFT;
2002 mf_from_integer_string(const struct mf_field *mf, const char *s,
2003 uint8_t *valuep, uint8_t *maskp)
2005 unsigned long long int integer, mask;
2010 integer = strtoull(s, &tail, 0);
2011 if (errno || (*tail != '\0' && *tail != '/')) {
2016 mask = strtoull(tail + 1, &tail, 0);
2017 if (errno || *tail != '\0') {
2024 for (i = mf->n_bytes - 1; i >= 0; i--) {
2025 valuep[i] = integer;
2031 return xasprintf("%s: value too large for %u-byte field %s",
2032 s, mf->n_bytes, mf->name);
2037 return xasprintf("%s: bad syntax for %s", s, mf->name);
2041 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
2042 uint8_t mac[ETH_ADDR_LEN],
2043 uint8_t mask[ETH_ADDR_LEN])
2045 ovs_assert(mf->n_bytes == ETH_ADDR_LEN);
2047 switch (sscanf(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT,
2048 ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask))){
2049 case ETH_ADDR_SCAN_COUNT * 2:
2052 case ETH_ADDR_SCAN_COUNT:
2053 memset(mask, 0xff, ETH_ADDR_LEN);
2057 return xasprintf("%s: invalid Ethernet address", s);
2062 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
2063 ovs_be32 *ip, ovs_be32 *mask)
2067 ovs_assert(mf->n_bytes == sizeof *ip);
2069 if (sscanf(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
2070 IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask)) == IP_SCAN_COUNT * 2) {
2072 } else if (sscanf(s, IP_SCAN_FMT"/%d",
2073 IP_SCAN_ARGS(ip), &prefix) == IP_SCAN_COUNT + 1) {
2074 if (prefix <= 0 || prefix > 32) {
2075 return xasprintf("%s: network prefix bits not between 1 and "
2077 } else if (prefix == 32) {
2078 *mask = htonl(UINT32_MAX);
2080 *mask = htonl(((1u << prefix) - 1) << (32 - prefix));
2082 } else if (sscanf(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip)) == IP_SCAN_COUNT) {
2083 *mask = htonl(UINT32_MAX);
2085 return xasprintf("%s: invalid IP address", s);
2091 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
2092 struct in6_addr *value, struct in6_addr *mask)
2094 char *str = xstrdup(s);
2095 char *save_ptr = NULL;
2096 const char *name, *netmask;
2099 ovs_assert(mf->n_bytes == sizeof *value);
2101 name = strtok_r(str, "/", &save_ptr);
2102 retval = name ? lookup_ipv6(name, value) : EINVAL;
2106 err = xasprintf("%s: could not convert to IPv6 address", str);
2112 netmask = strtok_r(NULL, "/", &save_ptr);
2114 if (inet_pton(AF_INET6, netmask, mask) != 1) {
2115 int prefix = atoi(netmask);
2116 if (prefix <= 0 || prefix > 128) {
2118 return xasprintf("%s: prefix bits not between 1 and 128", s);
2120 *mask = ipv6_create_mask(prefix);
2124 *mask = in6addr_exact;
2132 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
2133 ovs_be16 *valuep, ovs_be16 *maskp)
2137 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2139 return xasprintf("%s: negative values not supported for %s",
2141 } else if (ofputil_port_from_string(s, &port)) {
2142 *valuep = htons(port);
2143 *maskp = htons(UINT16_MAX);
2146 return mf_from_integer_string(mf, s,
2147 (uint8_t *) valuep, (uint8_t *) maskp);
2151 struct frag_handling {
2157 static const struct frag_handling all_frags[] = {
2158 #define A FLOW_NW_FRAG_ANY
2159 #define L FLOW_NW_FRAG_LATER
2160 /* name mask value */
2163 { "first", A|L, A },
2164 { "later", A|L, A|L },
2169 { "not_later", L, 0 },
2176 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
2178 const struct frag_handling *h;
2180 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2181 if (!strcasecmp(s, h->name)) {
2182 /* We force the upper bits of the mask on to make mf_parse_value()
2183 * happy (otherwise it will never think it's an exact match.) */
2184 *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
2190 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2191 "\"yes\", \"first\", \"later\", \"not_first\"", s);
2195 parse_flow_tun_flags(const char *s_, const char *(*bit_to_string)(uint32_t),
2198 uint32_t result = 0;
2199 char *save_ptr = NULL;
2202 char *s = xstrdup(s_);
2204 for (name = strtok_r((char *)s, " |", &save_ptr); name;
2205 name = strtok_r(NULL, " |", &save_ptr)) {
2207 unsigned long long int flags;
2211 if (sscanf(name, "%lli%n", &flags, &n0) > 0 && n0 > 0) {
2215 name_len = strlen(name);
2216 for (bit = 1; bit; bit <<= 1) {
2217 const char *fname = bit_to_string(bit);
2224 len = strlen(fname);
2225 if (len != name_len) {
2228 if (!strncmp(name, fname, len)) {
2240 *res = htons(result);
2247 mf_from_tun_flags_string(const char *s, ovs_be16 *valuep, ovs_be16 *maskp)
2249 if (!parse_flow_tun_flags(s, flow_tun_flag_to_string, valuep)) {
2250 *maskp = htons(UINT16_MAX);
2254 return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
2255 "\"csum\", \"key\"", s);
2258 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2259 * NULL if successful, otherwise a malloc()'d string describing the error. */
2261 mf_parse(const struct mf_field *mf, const char *s,
2262 union mf_value *value, union mf_value *mask)
2264 if (!strcmp(s, "*")) {
2265 memset(value, 0, mf->n_bytes);
2266 memset(mask, 0, mf->n_bytes);
2270 switch (mf->string) {
2272 case MFS_HEXADECIMAL:
2273 return mf_from_integer_string(mf, s,
2274 (uint8_t *) value, (uint8_t *) mask);
2277 return mf_from_ethernet_string(mf, s, value->mac, mask->mac);
2280 return mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
2283 return mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
2286 return mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
2289 return mf_from_frag_string(s, &value->u8, &mask->u8);
2292 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2293 return mf_from_tun_flags_string(s, &value->be16, &mask->be16);
2298 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2299 * successful, otherwise a malloc()'d string describing the error. */
2301 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2303 union mf_value mask;
2306 error = mf_parse(mf, s, value, &mask);
2311 if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2312 return xasprintf("%s: wildcards not allowed here", s);
2318 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2319 const uint8_t *maskp, struct ds *s)
2321 unsigned long long int integer;
2324 ovs_assert(mf->n_bytes <= 8);
2327 for (i = 0; i < mf->n_bytes; i++) {
2328 integer = (integer << 8) | valuep[i];
2330 if (mf->string == MFS_HEXADECIMAL) {
2331 ds_put_format(s, "%#llx", integer);
2333 ds_put_format(s, "%lld", integer);
2337 unsigned long long int mask;
2340 for (i = 0; i < mf->n_bytes; i++) {
2341 mask = (mask << 8) | maskp[i];
2344 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2345 * not sure that that a bit-mask written in decimal is ever easier to
2346 * understand than the same bit-mask written in hexadecimal. */
2347 ds_put_format(s, "/%#llx", mask);
2352 mf_format_frag_string(uint8_t value, uint8_t mask, struct ds *s)
2354 const struct frag_handling *h;
2356 mask &= FLOW_NW_FRAG_MASK;
2359 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2360 if (value == h->value && mask == h->mask) {
2361 ds_put_cstr(s, h->name);
2365 ds_put_cstr(s, "<error>");
2369 mf_format_tnl_flags_string(const ovs_be16 *valuep, struct ds *s)
2371 format_flags(s, flow_tun_flag_to_string, ntohs(*valuep), '|');
2374 /* Appends to 's' a string representation of field 'mf' whose value is in
2375 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2377 mf_format(const struct mf_field *mf,
2378 const union mf_value *value, const union mf_value *mask,
2382 if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2383 ds_put_cstr(s, "ANY");
2385 } else if (is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2390 switch (mf->string) {
2393 ofputil_format_port(ntohs(value->be16), s);
2398 case MFS_HEXADECIMAL:
2399 mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2403 eth_format_masked(value->mac, mask->mac, s);
2407 ip_format_masked(value->be32, mask ? mask->be32 : htonl(UINT32_MAX),
2412 print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2416 mf_format_frag_string(value->u8, mask ? mask->u8 : UINT8_MAX, s);
2420 mf_format_tnl_flags_string(&value->be16, s);
2428 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2429 * least-significant bits in 'x'.
2432 mf_write_subfield_flow(const struct mf_subfield *sf,
2433 const union mf_subvalue *x, struct flow *flow)
2435 const struct mf_field *field = sf->field;
2436 union mf_value value;
2438 mf_get_value(field, flow, &value);
2439 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes,
2440 sf->ofs, sf->n_bits);
2441 mf_set_flow_value(field, &value, flow);
2444 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2445 * least-significant bits in 'x'.
2448 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2449 struct match *match)
2451 const struct mf_field *field = sf->field;
2452 union mf_value value, mask;
2454 mf_get(field, match, &value, &mask);
2455 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2456 bitwise_one ( &mask, field->n_bytes, sf->ofs, sf->n_bits);
2457 mf_set(field, &value, &mask, match);
2460 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2461 * reading 'flow', e.g. as checked by mf_check_src(). */
2463 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2464 union mf_subvalue *x)
2466 union mf_value value;
2468 mf_get_value(sf->field, flow, &value);
2470 memset(x, 0, sizeof *x);
2471 bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2476 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2477 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2480 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2482 union mf_value value;
2484 mf_get_value(sf->field, flow, &value);
2485 return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2488 /* Formats 'sf' into 's' in a format normally acceptable to
2489 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2490 * sf->field has no NXM name.) */
2492 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
2495 ds_put_cstr(s, "<unknown>");
2496 } else if (sf->field->nxm_name) {
2497 ds_put_cstr(s, sf->field->nxm_name);
2498 } else if (sf->field->nxm_header) {
2499 uint32_t header = sf->field->nxm_header;
2500 ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
2502 ds_put_cstr(s, sf->field->name);
2505 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
2506 ds_put_cstr(s, "[]");
2507 } else if (sf->n_bits == 1) {
2508 ds_put_format(s, "[%d]", sf->ofs);
2510 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
2514 static const struct mf_field *
2515 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
2519 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
2524 for (i = 0; i < MFF_N_IDS; i++) {
2525 const struct mf_field *mf = mf_from_id(i);
2528 && !strncmp(mf->nxm_name, name, name_len)
2529 && mf->nxm_name[name_len] == '\0') {
2533 && !strncmp(mf->oxm_name, name, name_len)
2534 && mf->oxm_name[name_len] == '\0') {
2542 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2543 * returns NULL and advances '*sp' to the first byte following the parsed
2544 * string. On failure, returns a malloc()'d error message, does not modify
2545 * '*sp', and does not properly initialize 'sf'.
2547 * The syntax parsed from '*sp' takes the form "header[start..end]" where
2548 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2549 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2550 * may both be omitted (the [] are still required) to indicate an entire
2553 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
2555 const struct mf_field *field;
2564 name_len = strcspn(s, "[");
2565 if (s[name_len] != '[') {
2566 return xasprintf("%s: missing [ looking for field name", *sp);
2569 field = mf_parse_subfield_name(name, name_len, &wild);
2571 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
2575 if (sscanf(s, "[%d..%d]", &start, &end) == 2) {
2576 /* Nothing to do. */
2577 } else if (sscanf(s, "[%d]", &start) == 1) {
2579 } else if (!strncmp(s, "[]", 2)) {
2581 end = field->n_bits - 1;
2583 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2584 "[<start>..<end>]", *sp);
2586 s = strchr(s, ']') + 1;
2589 return xasprintf("%s: starting bit %d is after ending bit %d",
2591 } else if (start >= field->n_bits) {
2592 return xasprintf("%s: starting bit %d is not valid because field is "
2593 "only %d bits wide", *sp, start, field->n_bits);
2594 } else if (end >= field->n_bits){
2595 return xasprintf("%s: ending bit %d is not valid because field is "
2596 "only %d bits wide", *sp, end, field->n_bits);
2601 sf->n_bits = end - start + 1;
2607 /* Parses a subfield from the beginning of 's' into 'sf'. Returns the first
2608 * byte in 's' following the parsed string.
2610 * Exits with an error message if 's' has incorrect syntax.
2612 * The syntax parsed from 's' takes the form "header[start..end]" where
2613 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2614 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2615 * may both be omitted (the [] are still required) to indicate an entire
2618 mf_parse_subfield(struct mf_subfield *sf, const char *s)
2620 char *msg = mf_parse_subfield__(sf, &s);
2622 ovs_fatal(0, "%s", msg);
2628 mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s)
2632 for (i = 0; i < ARRAY_SIZE(subvalue->u8); i++) {
2633 if (subvalue->u8[i]) {
2634 ds_put_format(s, "0x%"PRIx8, subvalue->u8[i]);
2635 for (i++; i < ARRAY_SIZE(subvalue->u8); i++) {
2636 ds_put_format(s, "%02"PRIx8, subvalue->u8[i]);
2641 ds_put_char(s, '0');