2 * Copyright (c) 2011, 2012 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"
24 #include <netinet/icmp6.h>
25 #include <netinet/ip6.h>
27 #include "classifier.h"
28 #include "dynamic-string.h"
29 #include "ofp-errors.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,
68 MFF_TUN_DST, "tun_dst", NULL,
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 OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
122 MFF_SKB_PRIORITY, "skb_priority", NULL,
123 MF_FIELD_SIZES(be32),
131 MFF_SKB_MARK, "skb_mark", NULL,
132 MF_FIELD_SIZES(be32),
141 #define REGISTER(IDX) \
143 MFF_REG##IDX, "reg" #IDX, NULL, \
144 MF_FIELD_SIZES(be32), \
149 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
150 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
185 MFF_ETH_SRC, "eth_src", "dl_src",
191 NXM_OF_ETH_SRC, "NXM_OF_ETH_SRC",
192 OXM_OF_ETH_SRC, "OXM_OF_ETH_SRC",
194 MFF_ETH_DST, "eth_dst", "dl_dst",
200 NXM_OF_ETH_DST, "NXM_OF_ETH_DST",
201 OXM_OF_ETH_DST, "OXM_OF_ETH_DST",
203 MFF_ETH_TYPE, "eth_type", "dl_type",
204 MF_FIELD_SIZES(be16),
209 NXM_OF_ETH_TYPE, "NXM_OF_ETH_TYPE",
210 OXM_OF_ETH_TYPE, "OXM_OF_ETH_TYPE",
214 MFF_VLAN_TCI, "vlan_tci", NULL,
215 MF_FIELD_SIZES(be16),
220 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
221 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
223 MFF_DL_VLAN, "dl_vlan", NULL,
224 sizeof(ovs_be16), 12,
232 MFF_VLAN_VID, "vlan_vid", NULL,
233 sizeof(ovs_be16), 12,
238 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
239 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
241 MFF_DL_VLAN_PCP, "dl_vlan_pcp", NULL,
250 MFF_VLAN_PCP, "vlan_pcp", NULL,
256 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
257 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
265 MFF_IPV4_SRC, "ip_src", "nw_src",
266 MF_FIELD_SIZES(be32),
271 NXM_OF_IP_SRC, "NXM_OF_IP_SRC",
272 OXM_OF_IPV4_SRC, "OXM_OF_IPV4_SRC",
274 MFF_IPV4_DST, "ip_dst", "nw_dst",
275 MF_FIELD_SIZES(be32),
280 NXM_OF_IP_DST, "NXM_OF_IP_DST",
281 OXM_OF_IPV4_DST, "OXM_OF_IPV4_DST",
285 MFF_IPV6_SRC, "ipv6_src", NULL,
286 MF_FIELD_SIZES(ipv6),
291 NXM_NX_IPV6_SRC, "NXM_NX_IPV6_SRC",
292 OXM_OF_IPV6_SRC, "OXM_OF_IPV6_SRC",
294 MFF_IPV6_DST, "ipv6_dst", NULL,
295 MF_FIELD_SIZES(ipv6),
300 NXM_NX_IPV6_DST, "NXM_NX_IPV6_DST",
301 OXM_OF_IPV6_DST, "OXM_OF_IPV6_DST",
304 MFF_IPV6_LABEL, "ipv6_label", NULL,
310 NXM_NX_IPV6_LABEL, "NXM_NX_IPV6_LABEL",
311 OXM_OF_IPV6_FLABEL, "OXM_OF_IPV6_FLABEL",
315 MFF_IP_PROTO, "nw_proto", NULL,
321 NXM_OF_IP_PROTO, "NXM_OF_IP_PROTO",
322 OXM_OF_IP_PROTO, "OXM_OF_IP_PROTO",
324 MFF_IP_DSCP, "nw_tos", NULL,
330 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
331 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
333 MFF_IP_ECN, "nw_ecn", NULL,
339 NXM_NX_IP_ECN, "NXM_NX_IP_ECN",
340 OXM_OF_IP_ECN, "OXM_OF_IP_ECN",
342 MFF_IP_TTL, "nw_ttl", NULL,
348 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
349 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
351 MFF_IP_FRAG, "ip_frag", NULL,
357 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
358 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
362 MFF_ARP_OP, "arp_op", NULL,
363 MF_FIELD_SIZES(be16),
368 NXM_OF_ARP_OP, "NXM_OF_ARP_OP",
369 OXM_OF_ARP_OP, "OXM_OF_ARP_OP",
371 MFF_ARP_SPA, "arp_spa", NULL,
372 MF_FIELD_SIZES(be32),
377 NXM_OF_ARP_SPA, "NXM_OF_ARP_SPA",
378 OXM_OF_ARP_SPA, "OXM_OF_ARP_SPA",
380 MFF_ARP_TPA, "arp_tpa", NULL,
381 MF_FIELD_SIZES(be32),
386 NXM_OF_ARP_TPA, "NXM_OF_ARP_TPA",
387 OXM_OF_ARP_TPA, "OXM_OF_ARP_TPA",
389 MFF_ARP_SHA, "arp_sha", NULL,
395 NXM_NX_ARP_SHA, "NXM_NX_ARP_SHA",
396 OXM_OF_ARP_SHA, "OXM_OF_ARP_SHA",
398 MFF_ARP_THA, "arp_tha", NULL,
404 NXM_NX_ARP_THA, "NXM_NX_ARP_THA",
405 OXM_OF_ARP_THA, "OXM_OF_ARP_THA",
413 MFF_TCP_SRC, "tcp_src", "tp_src",
414 MF_FIELD_SIZES(be16),
419 NXM_OF_TCP_SRC, "NXM_OF_TCP_SRC",
420 OXM_OF_TCP_SRC, "OXM_OF_TCP_SRC",
422 MFF_TCP_DST, "tcp_dst", "tp_dst",
423 MF_FIELD_SIZES(be16),
428 NXM_OF_TCP_DST, "NXM_OF_TCP_DST",
429 OXM_OF_TCP_DST, "OXM_OF_TCP_DST",
433 MFF_UDP_SRC, "udp_src", NULL,
434 MF_FIELD_SIZES(be16),
439 NXM_OF_UDP_SRC, "NXM_OF_UDP_SRC",
440 OXM_OF_UDP_SRC, "OXM_OF_UDP_SRC",
442 MFF_UDP_DST, "udp_dst", NULL,
443 MF_FIELD_SIZES(be16),
448 NXM_OF_UDP_DST, "NXM_OF_UDP_DST",
449 OXM_OF_UDP_DST, "OXM_OF_UDP_DST",
453 MFF_ICMPV4_TYPE, "icmp_type", NULL,
459 NXM_OF_ICMP_TYPE, "NXM_OF_ICMP_TYPE",
460 OXM_OF_ICMPV4_TYPE, "OXM_OF_ICMPV4_TYPE",
462 MFF_ICMPV4_CODE, "icmp_code", NULL,
468 NXM_OF_ICMP_CODE, "NXM_OF_ICMP_CODE",
469 OXM_OF_ICMPV4_CODE, "OXM_OF_ICMPV4_CODE",
473 MFF_ICMPV6_TYPE, "icmpv6_type", NULL,
479 NXM_NX_ICMPV6_TYPE, "NXM_NX_ICMPV6_TYPE",
480 OXM_OF_ICMPV6_TYPE, "OXM_OF_ICMPV6_TYPE",
482 MFF_ICMPV6_CODE, "icmpv6_code", NULL,
488 NXM_NX_ICMPV6_CODE, "NXM_NX_ICMPV6_CODE",
489 OXM_OF_ICMPV6_CODE, "OXM_OF_ICMPV6_CODE",
497 MFF_ND_TARGET, "nd_target", NULL,
498 MF_FIELD_SIZES(ipv6),
503 NXM_NX_ND_TARGET, "NXM_NX_ND_TARGET",
504 OXM_OF_IPV6_ND_TARGET, "OXM_OF_IPV6_ND_TARGET",
506 MFF_ND_SLL, "nd_sll", NULL,
512 NXM_NX_ND_SLL, "NXM_NX_ND_SLL",
513 OXM_OF_IPV6_ND_SLL, "OXM_OF_IPV6_ND_SLL",
515 MFF_ND_TLL, "nd_tll", NULL,
521 NXM_NX_ND_TLL, "NXM_NX_ND_TLL",
522 OXM_OF_IPV6_ND_TLL, "OXM_OF_IPV6_ND_TLL",
526 /* Maps an NXM or OXM header value to an mf_field. */
528 struct hmap_node hmap_node; /* In 'all_fields' hmap. */
529 uint32_t header; /* NXM or OXM header value. */
530 const struct mf_field *mf;
533 /* Contains 'struct nxm_field's. */
534 static struct hmap all_fields = HMAP_INITIALIZER(&all_fields);
536 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
537 * controller and so there's not much point in showing a lot of them. */
538 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
540 const struct mf_field *mf_from_nxm_header__(uint32_t header);
542 /* Returns the field with the given 'id'. */
543 const struct mf_field *
544 mf_from_id(enum mf_field_id id)
546 assert((unsigned int) id < MFF_N_IDS);
547 return &mf_fields[id];
550 /* Returns the field with the given 'name', or a null pointer if no field has
552 const struct mf_field *
553 mf_from_name(const char *name)
555 static struct shash mf_by_name = SHASH_INITIALIZER(&mf_by_name);
557 if (shash_is_empty(&mf_by_name)) {
558 const struct mf_field *mf;
560 for (mf = mf_fields; mf < &mf_fields[MFF_N_IDS]; mf++) {
561 shash_add_once(&mf_by_name, mf->name, mf);
562 if (mf->extra_name) {
563 shash_add_once(&mf_by_name, mf->extra_name, mf);
568 return shash_find_data(&mf_by_name, name);
572 add_nxm_field(uint32_t header, const struct mf_field *mf)
576 f = xmalloc(sizeof *f);
577 hmap_insert(&all_fields, &f->hmap_node, hash_int(header, 0));
583 nxm_init_add_field(const struct mf_field *mf, uint32_t header)
586 assert(!mf_from_nxm_header__(header));
587 add_nxm_field(header, mf);
588 if (mf->maskable != MFM_NONE) {
589 add_nxm_field(NXM_MAKE_WILD_HEADER(header), mf);
597 const struct mf_field *mf;
599 for (mf = mf_fields; mf < &mf_fields[MFF_N_IDS]; mf++) {
600 nxm_init_add_field(mf, mf->nxm_header);
601 if (mf->oxm_header != mf->nxm_header) {
602 nxm_init_add_field(mf, mf->oxm_header);
607 const struct mf_field *
608 mf_from_nxm_header(uint32_t header)
610 if (hmap_is_empty(&all_fields)) {
613 return mf_from_nxm_header__(header);
616 const struct mf_field *
617 mf_from_nxm_header__(uint32_t header)
619 const struct nxm_field *f;
621 HMAP_FOR_EACH_IN_BUCKET (f, hmap_node, hash_int(header, 0), &all_fields) {
622 if (f->header == header) {
630 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
631 * specifies at least one bit in the field.
633 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
634 * meets 'mf''s prerequisites. */
636 mf_is_all_wild(const struct mf_field *mf, const struct flow_wildcards *wc)
645 return !wc->masks.tunnel.tun_id;
647 return !wc->masks.metadata;
649 return !wc->masks.in_port;
650 case MFF_SKB_PRIORITY:
651 return !wc->masks.skb_priority;
653 return !wc->masks.skb_mark;
655 return !wc->masks.regs[mf->id - MFF_REG0];
658 return eth_addr_is_zero(wc->masks.dl_src);
660 return eth_addr_is_zero(wc->masks.dl_dst);
662 return !wc->masks.dl_type;
666 return eth_addr_is_zero(wc->masks.arp_sha);
670 return eth_addr_is_zero(wc->masks.arp_tha);
673 return !wc->masks.vlan_tci;
675 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK));
677 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI));
678 case MFF_DL_VLAN_PCP:
680 return !(wc->masks.vlan_tci & htons(VLAN_PCP_MASK));
683 return !wc->masks.nw_src;
685 return !wc->masks.nw_dst;
688 return ipv6_mask_is_any(&wc->masks.ipv6_src);
690 return ipv6_mask_is_any(&wc->masks.ipv6_dst);
693 return !wc->masks.ipv6_label;
696 return !wc->masks.nw_proto;
698 return !(wc->masks.nw_tos & IP_DSCP_MASK);
700 return !(wc->masks.nw_tos & IP_ECN_MASK);
702 return !wc->masks.nw_ttl;
705 return ipv6_mask_is_any(&wc->masks.nd_target);
708 return !(wc->masks.nw_frag & FLOW_NW_FRAG_MASK);
711 return !wc->masks.nw_proto;
713 return !wc->masks.nw_src;
715 return !wc->masks.nw_dst;
719 case MFF_ICMPV4_TYPE:
720 case MFF_ICMPV6_TYPE:
721 return !wc->masks.tp_src;
724 case MFF_ICMPV4_CODE:
725 case MFF_ICMPV6_CODE:
726 return !wc->masks.tp_dst;
734 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
735 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
736 * purposes, or to 0 if it is wildcarded.
738 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
739 * meets 'mf''s prerequisites. */
741 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
742 union mf_value *mask)
744 mf_get_value(mf, &wc->masks, mask);
747 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
748 * if the mask is valid, false otherwise. */
750 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
752 switch (mf->maskable) {
754 return (is_all_zeros((const uint8_t *) mask, mf->n_bytes) ||
755 is_all_ones((const uint8_t *) mask, mf->n_bytes));
765 is_ip_any(const struct flow *flow)
767 return (flow->dl_type == htons(ETH_TYPE_IP) ||
768 flow->dl_type == htons(ETH_TYPE_IPV6));
772 is_icmpv4(const struct flow *flow)
774 return (flow->dl_type == htons(ETH_TYPE_IP)
775 && flow->nw_proto == IPPROTO_ICMP);
779 is_icmpv6(const struct flow *flow)
781 return (flow->dl_type == htons(ETH_TYPE_IPV6)
782 && flow->nw_proto == IPPROTO_ICMPV6);
785 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
787 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
789 switch (mf->prereqs) {
794 return (flow->dl_type == htons(ETH_TYPE_ARP) ||
795 flow->dl_type == htons(ETH_TYPE_RARP));
797 return flow->dl_type == htons(ETH_TYPE_IP);
799 return flow->dl_type == htons(ETH_TYPE_IPV6);
801 return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
803 return is_ip_any(flow);
806 return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP;
808 return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP;
810 return is_icmpv4(flow);
812 return is_icmpv6(flow);
815 return (is_icmpv6(flow)
816 && flow->tp_dst == htons(0)
817 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
818 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
820 return (is_icmpv6(flow)
821 && flow->tp_dst == htons(0)
822 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
824 return (is_icmpv6(flow)
825 && flow->tp_dst == htons(0)
826 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
832 /* Returns true if 'value' may be a valid value *as part of a masked match*,
835 * A value is not rejected just because it is not valid for the field in
836 * question, but only if it doesn't make sense to test the bits in question at
837 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
838 * without the VLAN_CFI bit being set, but we can't reject those values because
839 * it is still legitimate to test just for those bits (see the documentation
840 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
841 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
843 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
854 case MFF_SKB_PRIORITY:
875 case MFF_ICMPV4_TYPE:
876 case MFF_ICMPV4_CODE:
877 case MFF_ICMPV6_TYPE:
878 case MFF_ICMPV6_CODE:
885 return !(value->u8 & ~IP_DSCP_MASK);
887 return !(value->u8 & ~IP_ECN_MASK);
889 return !(value->u8 & ~FLOW_NW_FRAG_MASK);
892 return !(value->be16 & htons(0xff00));
895 return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
897 return !(value->be16 & htons(VLAN_PCP_MASK));
899 case MFF_DL_VLAN_PCP:
901 return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
904 return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
912 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
913 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
915 mf_get_value(const struct mf_field *mf, const struct flow *flow,
916 union mf_value *value)
920 value->be64 = flow->tunnel.tun_id;
923 value->be32 = flow->tunnel.ip_src;
926 value->be32 = flow->tunnel.ip_dst;
929 value->be16 = htons(flow->tunnel.flags);
932 value->u8 = flow->tunnel.ip_ttl;
935 value->u8 = flow->tunnel.ip_tos;
939 value->be64 = flow->metadata;
943 value->be16 = htons(flow->in_port);
946 case MFF_SKB_PRIORITY:
947 value->be32 = htonl(flow->skb_priority);
951 value->be32 = htonl(flow->skb_mark);
955 value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
959 memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
963 memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
967 value->be16 = flow->dl_type;
971 value->be16 = flow->vlan_tci;
975 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
978 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
981 case MFF_DL_VLAN_PCP:
983 value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
987 value->be32 = flow->nw_src;
991 value->be32 = flow->nw_dst;
995 value->ipv6 = flow->ipv6_src;
999 value->ipv6 = flow->ipv6_dst;
1002 case MFF_IPV6_LABEL:
1003 value->be32 = flow->ipv6_label;
1007 value->u8 = flow->nw_proto;
1011 value->u8 = flow->nw_tos & IP_DSCP_MASK;
1015 value->u8 = flow->nw_tos & IP_ECN_MASK;
1019 value->u8 = flow->nw_ttl;
1023 value->u8 = flow->nw_frag;
1027 value->be16 = htons(flow->nw_proto);
1031 value->be32 = flow->nw_src;
1035 value->be32 = flow->nw_dst;
1040 memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
1045 memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
1050 value->be16 = flow->tp_src;
1055 value->be16 = flow->tp_dst;
1058 case MFF_ICMPV4_TYPE:
1059 case MFF_ICMPV6_TYPE:
1060 value->u8 = ntohs(flow->tp_src);
1063 case MFF_ICMPV4_CODE:
1064 case MFF_ICMPV6_CODE:
1065 value->u8 = ntohs(flow->tp_dst);
1069 value->ipv6 = flow->nd_target;
1078 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1079 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1082 mf_set_value(const struct mf_field *mf,
1083 const union mf_value *value, struct match *match)
1087 match_set_tun_id(match, value->be64);
1090 match_set_tun_src(match, value->be32);
1093 match_set_tun_dst(match, value->be32);
1096 match_set_tun_flags(match, ntohs(value->be16));
1099 match_set_tun_tos(match, value->u8);
1102 match_set_tun_ttl(match, value->u8);
1106 match_set_metadata(match, value->be64);
1110 match_set_in_port(match, ntohs(value->be16));
1113 case MFF_SKB_PRIORITY:
1114 match_set_skb_priority(match, ntohl(value->be32));
1118 match_set_skb_mark(match, ntohl(value->be32));
1122 match_set_reg(match, mf->id - MFF_REG0, ntohl(value->be32));
1126 match_set_dl_src(match, value->mac);
1130 match_set_dl_dst(match, value->mac);
1134 match_set_dl_type(match, value->be16);
1138 match_set_dl_tci(match, value->be16);
1142 match_set_dl_vlan(match, value->be16);
1145 match_set_vlan_vid(match, value->be16);
1148 case MFF_DL_VLAN_PCP:
1150 match_set_dl_vlan_pcp(match, value->u8);
1154 match_set_nw_src(match, value->be32);
1158 match_set_nw_dst(match, value->be32);
1162 match_set_ipv6_src(match, &value->ipv6);
1166 match_set_ipv6_dst(match, &value->ipv6);
1169 case MFF_IPV6_LABEL:
1170 match_set_ipv6_label(match, value->be32);
1174 match_set_nw_proto(match, value->u8);
1178 match_set_nw_dscp(match, value->u8);
1182 match_set_nw_ecn(match, value->u8);
1186 match_set_nw_ttl(match, value->u8);
1190 match_set_nw_frag(match, value->u8);
1194 match_set_nw_proto(match, ntohs(value->be16));
1198 match_set_nw_src(match, value->be32);
1202 match_set_nw_dst(match, value->be32);
1207 match_set_arp_sha(match, value->mac);
1212 match_set_arp_tha(match, value->mac);
1217 match_set_tp_src(match, value->be16);
1222 match_set_tp_dst(match, value->be16);
1225 case MFF_ICMPV4_TYPE:
1226 case MFF_ICMPV6_TYPE:
1227 match_set_icmp_type(match, value->u8);
1230 case MFF_ICMPV4_CODE:
1231 case MFF_ICMPV6_CODE:
1232 match_set_icmp_code(match, value->u8);
1236 match_set_nd_target(match, &value->ipv6);
1245 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1246 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1249 mf_set_flow_value(const struct mf_field *mf,
1250 const union mf_value *value, struct flow *flow)
1254 flow->tunnel.tun_id = value->be64;
1257 flow->tunnel.ip_src = value->be32;
1260 flow->tunnel.ip_dst = value->be32;
1263 flow->tunnel.flags = ntohs(value->be16);
1266 flow->tunnel.ip_tos = value->u8;
1269 flow->tunnel.ip_ttl = value->u8;
1273 flow->metadata = value->be64;
1277 flow->in_port = ntohs(value->be16);
1280 case MFF_SKB_PRIORITY:
1281 flow->skb_priority = ntohl(value->be32);
1285 flow->skb_mark = ntohl(value->be32);
1289 flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1293 memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
1297 memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
1301 flow->dl_type = value->be16;
1305 flow->vlan_tci = value->be16;
1309 flow_set_dl_vlan(flow, value->be16);
1312 flow_set_vlan_vid(flow, value->be16);
1315 case MFF_DL_VLAN_PCP:
1317 flow_set_vlan_pcp(flow, value->u8);
1321 flow->nw_src = value->be32;
1325 flow->nw_dst = value->be32;
1329 flow->ipv6_src = value->ipv6;
1333 flow->ipv6_dst = value->ipv6;
1336 case MFF_IPV6_LABEL:
1337 flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1341 flow->nw_proto = value->u8;
1345 flow->nw_tos &= ~IP_DSCP_MASK;
1346 flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1350 flow->nw_tos &= ~IP_ECN_MASK;
1351 flow->nw_tos |= value->u8 & IP_ECN_MASK;
1355 flow->nw_ttl = value->u8;
1359 flow->nw_frag &= value->u8;
1363 flow->nw_proto = ntohs(value->be16);
1367 flow->nw_src = value->be32;
1371 flow->nw_dst = value->be32;
1376 memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1381 memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1386 flow->tp_src = value->be16;
1391 flow->tp_dst = value->be16;
1394 case MFF_ICMPV4_TYPE:
1395 case MFF_ICMPV6_TYPE:
1396 flow->tp_src = htons(value->u8);
1399 case MFF_ICMPV4_CODE:
1400 case MFF_ICMPV6_CODE:
1401 flow->tp_dst = htons(value->u8);
1405 flow->nd_target = value->ipv6;
1414 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1416 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1419 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1421 union mf_value value;
1423 mf_get_value(mf, flow, &value);
1424 return is_all_zeros((const uint8_t *) &value, mf->n_bytes);
1427 /* Makes 'match' wildcard field 'mf'.
1429 * The caller is responsible for ensuring that 'match' meets 'mf''s
1432 mf_set_wild(const struct mf_field *mf, struct match *match)
1436 match_set_tun_id_masked(match, htonll(0), htonll(0));
1439 match_set_tun_src_masked(match, htonl(0), htonl(0));
1442 match_set_tun_dst_masked(match, htonl(0), htonl(0));
1445 match_set_tun_flags_masked(match, 0, 0);
1448 match_set_tun_tos_masked(match, 0, 0);
1451 match_set_tun_ttl_masked(match, 0, 0);
1455 match_set_metadata_masked(match, htonll(0), htonll(0));
1458 match->flow.in_port = 0;
1459 match->wc.masks.in_port = 0;
1462 case MFF_SKB_PRIORITY:
1463 match->flow.skb_priority = 0;
1464 match->wc.masks.skb_priority = 0;
1468 match->flow.skb_mark = 0;
1469 match->wc.masks.skb_mark = 0;
1473 match_set_reg_masked(match, mf->id - MFF_REG0, 0, 0);
1477 memset(match->flow.dl_src, 0, ETH_ADDR_LEN);
1478 memset(match->wc.masks.dl_src, 0, ETH_ADDR_LEN);
1482 memset(match->flow.dl_dst, 0, ETH_ADDR_LEN);
1483 memset(match->wc.masks.dl_dst, 0, ETH_ADDR_LEN);
1487 match->flow.dl_type = htons(0);
1488 match->wc.masks.dl_type = htons(0);
1492 match_set_dl_tci_masked(match, htons(0), htons(0));
1497 match_set_any_vid(match);
1500 case MFF_DL_VLAN_PCP:
1502 match_set_any_pcp(match);
1507 match_set_nw_src_masked(match, htonl(0), htonl(0));
1512 match_set_nw_dst_masked(match, htonl(0), htonl(0));
1516 memset(&match->wc.masks.ipv6_src, 0, sizeof match->wc.masks.ipv6_src);
1517 memset(&match->flow.ipv6_src, 0, sizeof match->flow.ipv6_src);
1521 memset(&match->wc.masks.ipv6_dst, 0, sizeof match->wc.masks.ipv6_dst);
1522 memset(&match->flow.ipv6_dst, 0, sizeof match->flow.ipv6_dst);
1525 case MFF_IPV6_LABEL:
1526 match->wc.masks.ipv6_label = htonl(0);
1527 match->flow.ipv6_label = htonl(0);
1531 match->wc.masks.nw_proto = 0;
1532 match->flow.nw_proto = 0;
1536 match->wc.masks.nw_tos &= ~IP_DSCP_MASK;
1537 match->flow.nw_tos &= ~IP_DSCP_MASK;
1541 match->wc.masks.nw_tos &= ~IP_ECN_MASK;
1542 match->flow.nw_tos &= ~IP_ECN_MASK;
1546 match->wc.masks.nw_ttl = 0;
1547 match->flow.nw_ttl = 0;
1551 match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
1552 match->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1556 match->wc.masks.nw_proto = 0;
1557 match->flow.nw_proto = 0;
1562 memset(match->flow.arp_sha, 0, ETH_ADDR_LEN);
1563 memset(match->wc.masks.arp_sha, 0, ETH_ADDR_LEN);
1568 memset(match->flow.arp_tha, 0, ETH_ADDR_LEN);
1569 memset(match->wc.masks.arp_tha, 0, ETH_ADDR_LEN);
1574 case MFF_ICMPV4_TYPE:
1575 case MFF_ICMPV6_TYPE:
1576 match->wc.masks.tp_src = htons(0);
1577 match->flow.tp_src = htons(0);
1582 case MFF_ICMPV4_CODE:
1583 case MFF_ICMPV6_CODE:
1584 match->wc.masks.tp_dst = htons(0);
1585 match->flow.tp_dst = htons(0);
1589 memset(&match->wc.masks.nd_target, 0,
1590 sizeof match->wc.masks.nd_target);
1591 memset(&match->flow.nd_target, 0, sizeof match->flow.nd_target);
1600 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
1601 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1602 * with a 1-bit indicating that the corresponding value bit must match and a
1603 * 0-bit indicating a don't-care.
1605 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1606 * mf_set_value(mf, value, match). If 'mask' points to all-0-bits, then this
1607 * call is equivalent to mf_set_wild(mf, match).
1609 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
1610 * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
1612 mf_set(const struct mf_field *mf,
1613 const union mf_value *value, const union mf_value *mask,
1614 struct match *match)
1616 if (!mask || is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
1617 mf_set_value(mf, value, match);
1619 } else if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
1620 mf_set_wild(mf, match);
1627 case MFF_SKB_PRIORITY:
1630 case MFF_DL_VLAN_PCP:
1637 case MFF_ICMPV4_TYPE:
1638 case MFF_ICMPV4_CODE:
1639 case MFF_ICMPV6_TYPE:
1640 case MFF_ICMPV6_CODE:
1644 match_set_tun_id_masked(match, value->be64, mask->be64);
1647 match_set_tun_src_masked(match, value->be32, mask->be32);
1650 match_set_tun_dst_masked(match, value->be32, mask->be32);
1653 match_set_tun_flags_masked(match, ntohs(value->be16), ntohs(mask->be16));
1656 match_set_tun_ttl_masked(match, value->u8, mask->u8);
1659 match_set_tun_tos_masked(match, value->u8, mask->u8);
1663 match_set_metadata_masked(match, value->be64, mask->be64);
1667 match_set_reg_masked(match, mf->id - MFF_REG0,
1668 ntohl(value->be32), ntohl(mask->be32));
1672 match_set_dl_dst_masked(match, value->mac, mask->mac);
1676 match_set_dl_src_masked(match, value->mac, mask->mac);
1681 match_set_arp_sha_masked(match, value->mac, mask->mac);
1686 match_set_arp_tha_masked(match, value->mac, mask->mac);
1690 match_set_dl_tci_masked(match, value->be16, mask->be16);
1694 match_set_vlan_vid_masked(match, value->be16, mask->be16);
1698 match_set_nw_src_masked(match, value->be32, mask->be32);
1702 match_set_nw_dst_masked(match, value->be32, mask->be32);
1706 match_set_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
1710 match_set_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
1713 case MFF_IPV6_LABEL:
1714 if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
1715 mf_set_value(mf, value, match);
1717 match_set_ipv6_label_masked(match, value->be32, mask->be32);
1722 match_set_nd_target_masked(match, &value->ipv6, &mask->ipv6);
1726 match_set_nw_frag_masked(match, value->u8, mask->u8);
1730 match_set_nw_src_masked(match, value->be32, mask->be32);
1734 match_set_nw_dst_masked(match, value->be32, mask->be32);
1739 match_set_tp_src_masked(match, value->be16, mask->be16);
1744 match_set_tp_dst_masked(match, value->be16, mask->be16);
1754 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
1758 VLOG_WARN_RL(&rl, "unknown %s field", type);
1759 } else if (!sf->n_bits) {
1760 VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
1761 } else if (sf->ofs >= sf->field->n_bits) {
1762 VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
1763 sf->ofs, sf->field->n_bits, type, sf->field->name);
1764 } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
1765 VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
1766 "of %s field %s", sf->ofs, sf->n_bits,
1767 sf->field->n_bits, type, sf->field->name);
1768 } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
1769 VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
1770 type, sf->field->name);
1775 return OFPERR_OFPBAC_BAD_ARGUMENT;
1778 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
1779 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
1782 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
1784 return mf_check__(sf, flow, "source");
1787 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
1788 * if so, otherwise an OpenFlow error code (e.g. as returned by
1791 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
1793 int error = mf_check__(sf, flow, "destination");
1794 if (!error && !sf->field->writable) {
1795 VLOG_WARN_RL(&rl, "destination field %s is not writable",
1797 return OFPERR_OFPBAC_BAD_ARGUMENT;
1802 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
1803 * 'value' and 'mask', respectively. */
1805 mf_get(const struct mf_field *mf, const struct match *match,
1806 union mf_value *value, union mf_value *mask)
1808 mf_get_value(mf, &match->flow, value);
1809 mf_get_mask(mf, &match->wc, mask);
1812 /* Assigns a random value for field 'mf' to 'value'. */
1814 mf_random_value(const struct mf_field *mf, union mf_value *value)
1816 random_bytes(value, mf->n_bytes);
1828 case MFF_SKB_PRIORITY:
1848 case MFF_ICMPV4_TYPE:
1849 case MFF_ICMPV4_CODE:
1850 case MFF_ICMPV6_TYPE:
1851 case MFF_ICMPV6_CODE:
1857 case MFF_IPV6_LABEL:
1858 value->be32 &= ~htonl(IPV6_LABEL_MASK);
1862 value->u8 &= IP_DSCP_MASK;
1866 value->u8 &= IP_ECN_MASK;
1870 value->u8 &= FLOW_NW_FRAG_MASK;
1874 value->be16 &= htons(0xff);
1878 value->be16 &= htons(VLAN_VID_MASK);
1881 value->be16 &= htons(VLAN_VID_MASK | VLAN_CFI);
1884 case MFF_DL_VLAN_PCP:
1896 mf_from_integer_string(const struct mf_field *mf, const char *s,
1897 uint8_t *valuep, uint8_t *maskp)
1899 unsigned long long int integer, mask;
1904 integer = strtoull(s, &tail, 0);
1905 if (errno || (*tail != '\0' && *tail != '/')) {
1910 mask = strtoull(tail + 1, &tail, 0);
1911 if (errno || *tail != '\0') {
1918 for (i = mf->n_bytes - 1; i >= 0; i--) {
1919 valuep[i] = integer;
1925 return xasprintf("%s: value too large for %u-byte field %s",
1926 s, mf->n_bytes, mf->name);
1931 return xasprintf("%s: bad syntax for %s", s, mf->name);
1935 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
1936 uint8_t mac[ETH_ADDR_LEN],
1937 uint8_t mask[ETH_ADDR_LEN])
1939 assert(mf->n_bytes == ETH_ADDR_LEN);
1941 switch (sscanf(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT,
1942 ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask))){
1943 case ETH_ADDR_SCAN_COUNT * 2:
1946 case ETH_ADDR_SCAN_COUNT:
1947 memset(mask, 0xff, ETH_ADDR_LEN);
1951 return xasprintf("%s: invalid Ethernet address", s);
1956 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
1957 ovs_be32 *ip, ovs_be32 *mask)
1961 assert(mf->n_bytes == sizeof *ip);
1963 if (sscanf(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
1964 IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask)) == IP_SCAN_COUNT * 2) {
1966 } else if (sscanf(s, IP_SCAN_FMT"/%d",
1967 IP_SCAN_ARGS(ip), &prefix) == IP_SCAN_COUNT + 1) {
1968 if (prefix <= 0 || prefix > 32) {
1969 return xasprintf("%s: network prefix bits not between 1 and "
1971 } else if (prefix == 32) {
1972 *mask = htonl(UINT32_MAX);
1974 *mask = htonl(((1u << prefix) - 1) << (32 - prefix));
1976 } else if (sscanf(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip)) == IP_SCAN_COUNT) {
1977 *mask = htonl(UINT32_MAX);
1979 return xasprintf("%s: invalid IP address", s);
1985 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
1986 struct in6_addr *value, struct in6_addr *mask)
1988 char *str = xstrdup(s);
1989 char *save_ptr = NULL;
1990 const char *name, *netmask;
1993 assert(mf->n_bytes == sizeof *value);
1995 name = strtok_r(str, "/", &save_ptr);
1996 retval = name ? lookup_ipv6(name, value) : EINVAL;
2000 err = xasprintf("%s: could not convert to IPv6 address", str);
2006 netmask = strtok_r(NULL, "/", &save_ptr);
2008 if (inet_pton(AF_INET6, netmask, mask) != 1) {
2009 int prefix = atoi(netmask);
2010 if (prefix <= 0 || prefix > 128) {
2012 return xasprintf("%s: prefix bits not between 1 and 128", s);
2014 *mask = ipv6_create_mask(prefix);
2018 *mask = in6addr_exact;
2026 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
2027 ovs_be16 *valuep, ovs_be16 *maskp)
2031 assert(mf->n_bytes == sizeof(ovs_be16));
2033 return xasprintf("%s: negative values not supported for %s",
2035 } else if (ofputil_port_from_string(s, &port)) {
2036 *valuep = htons(port);
2037 *maskp = htons(UINT16_MAX);
2040 return mf_from_integer_string(mf, s,
2041 (uint8_t *) valuep, (uint8_t *) maskp);
2045 struct frag_handling {
2051 static const struct frag_handling all_frags[] = {
2052 #define A FLOW_NW_FRAG_ANY
2053 #define L FLOW_NW_FRAG_LATER
2054 /* name mask value */
2057 { "first", A|L, A },
2058 { "later", A|L, A|L },
2063 { "not_later", L, 0 },
2070 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
2072 const struct frag_handling *h;
2074 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2075 if (!strcasecmp(s, h->name)) {
2076 /* We force the upper bits of the mask on to make mf_parse_value()
2077 * happy (otherwise it will never think it's an exact match.) */
2078 *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
2084 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2085 "\"yes\", \"first\", \"later\", \"not_first\"", s);
2089 parse_flow_tun_flags(const char *s_, const char *(*bit_to_string)(uint32_t),
2092 uint32_t result = 0;
2093 char *save_ptr = NULL;
2096 char *s = xstrdup(s_);
2098 for (name = strtok_r((char *)s, " |", &save_ptr); name;
2099 name = strtok_r(NULL, " |", &save_ptr)) {
2101 unsigned long long int flags;
2105 if (sscanf(name, "%lli%n", &flags, &n0) > 0 && n0 > 0) {
2109 name_len = strlen(name);
2110 for (bit = 1; bit; bit <<= 1) {
2111 const char *fname = bit_to_string(bit);
2118 len = strlen(fname);
2119 if (len != name_len) {
2122 if (!strncmp(name, fname, len)) {
2134 *res = htons(result);
2141 mf_from_tun_flags_string(const char *s, ovs_be16 *valuep)
2143 if (!parse_flow_tun_flags(s, flow_tun_flag_to_string, valuep)) {
2147 return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
2148 "\"csum\", \"key\"", s);
2151 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2152 * NULL if successful, otherwise a malloc()'d string describing the error. */
2154 mf_parse(const struct mf_field *mf, const char *s,
2155 union mf_value *value, union mf_value *mask)
2157 if (!strcasecmp(s, "any") || !strcmp(s, "*")) {
2158 memset(value, 0, mf->n_bytes);
2159 memset(mask, 0, mf->n_bytes);
2163 switch (mf->string) {
2165 case MFS_HEXADECIMAL:
2166 return mf_from_integer_string(mf, s,
2167 (uint8_t *) value, (uint8_t *) mask);
2170 return mf_from_ethernet_string(mf, s, value->mac, mask->mac);
2173 return mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
2176 return mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
2179 return mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
2182 return mf_from_frag_string(s, &value->u8, &mask->u8);
2185 return mf_from_tun_flags_string(s, &value->be16);
2190 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2191 * successful, otherwise a malloc()'d string describing the error. */
2193 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2195 union mf_value mask;
2198 error = mf_parse(mf, s, value, &mask);
2203 if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2204 return xasprintf("%s: wildcards not allowed here", s);
2210 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2211 const uint8_t *maskp, struct ds *s)
2213 unsigned long long int integer;
2216 assert(mf->n_bytes <= 8);
2219 for (i = 0; i < mf->n_bytes; i++) {
2220 integer = (integer << 8) | valuep[i];
2222 if (mf->string == MFS_HEXADECIMAL) {
2223 ds_put_format(s, "%#llx", integer);
2225 ds_put_format(s, "%lld", integer);
2229 unsigned long long int mask;
2232 for (i = 0; i < mf->n_bytes; i++) {
2233 mask = (mask << 8) | maskp[i];
2236 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2237 * not sure that that a bit-mask written in decimal is ever easier to
2238 * understand than the same bit-mask written in hexadecimal. */
2239 ds_put_format(s, "/%#llx", mask);
2244 mf_format_frag_string(const uint8_t *valuep, const uint8_t *maskp,
2247 const struct frag_handling *h;
2248 uint8_t value = *valuep;
2249 uint8_t mask = *maskp;
2252 mask &= FLOW_NW_FRAG_MASK;
2254 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2255 if (value == h->value && mask == h->mask) {
2256 ds_put_cstr(s, h->name);
2260 ds_put_cstr(s, "<error>");
2264 mf_format_tnl_flags_string(const ovs_be16 *valuep, struct ds *s)
2266 format_flags(s, flow_tun_flag_to_string, ntohs(*valuep), '|');
2269 /* Appends to 's' a string representation of field 'mf' whose value is in
2270 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2272 mf_format(const struct mf_field *mf,
2273 const union mf_value *value, const union mf_value *mask,
2277 if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2278 ds_put_cstr(s, "ANY");
2280 } else if (is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2285 switch (mf->string) {
2288 ofputil_format_port(ntohs(value->be16), s);
2293 case MFS_HEXADECIMAL:
2294 mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2298 eth_format_masked(value->mac, mask->mac, s);
2302 ip_format_masked(value->be32, mask ? mask->be32 : htonl(UINT32_MAX),
2307 print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2311 mf_format_frag_string(&value->u8, &mask->u8, s);
2315 mf_format_tnl_flags_string(&value->be16, s);
2323 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2324 * least-significant bits in 'x'.
2327 mf_write_subfield_flow(const struct mf_subfield *sf,
2328 const union mf_subvalue *x, struct flow *flow)
2330 const struct mf_field *field = sf->field;
2331 union mf_value value;
2333 mf_get_value(field, flow, &value);
2334 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes,
2335 sf->ofs, sf->n_bits);
2336 mf_set_flow_value(field, &value, flow);
2339 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2340 * least-significant bits in 'x'.
2343 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2344 struct match *match)
2346 const struct mf_field *field = sf->field;
2347 union mf_value value, mask;
2349 mf_get(field, match, &value, &mask);
2350 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2351 bitwise_one ( &mask, field->n_bytes, sf->ofs, sf->n_bits);
2352 mf_set(field, &value, &mask, match);
2355 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2356 * reading 'flow', e.g. as checked by mf_check_src(). */
2358 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2359 union mf_subvalue *x)
2361 union mf_value value;
2363 mf_get_value(sf->field, flow, &value);
2365 memset(x, 0, sizeof *x);
2366 bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2371 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2372 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2375 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2377 union mf_value value;
2379 mf_get_value(sf->field, flow, &value);
2380 return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2383 /* Formats 'sf' into 's' in a format normally acceptable to
2384 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2385 * sf->field has no NXM name.) */
2387 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
2390 ds_put_cstr(s, "<unknown>");
2391 } else if (sf->field->nxm_name) {
2392 ds_put_cstr(s, sf->field->nxm_name);
2393 } else if (sf->field->nxm_header) {
2394 uint32_t header = sf->field->nxm_header;
2395 ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
2397 ds_put_cstr(s, sf->field->name);
2400 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
2401 ds_put_cstr(s, "[]");
2402 } else if (sf->n_bits == 1) {
2403 ds_put_format(s, "[%d]", sf->ofs);
2405 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
2409 static const struct mf_field *
2410 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
2414 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
2419 for (i = 0; i < MFF_N_IDS; i++) {
2420 const struct mf_field *mf = mf_from_id(i);
2423 && !strncmp(mf->nxm_name, name, name_len)
2424 && mf->nxm_name[name_len] == '\0') {
2428 && !strncmp(mf->oxm_name, name, name_len)
2429 && mf->oxm_name[name_len] == '\0') {
2437 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2438 * returns NULL and advances '*sp' to the first byte following the parsed
2439 * string. On failure, returns a malloc()'d error message, does not modify
2440 * '*sp', and does not properly initialize 'sf'.
2442 * The syntax parsed from '*sp' takes the form "header[start..end]" where
2443 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2444 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2445 * may both be omitted (the [] are still required) to indicate an entire
2448 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
2450 const struct mf_field *field;
2459 name_len = strcspn(s, "[");
2460 if (s[name_len] != '[') {
2461 return xasprintf("%s: missing [ looking for field name", *sp);
2464 field = mf_parse_subfield_name(name, name_len, &wild);
2466 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
2470 if (sscanf(s, "[%d..%d]", &start, &end) == 2) {
2471 /* Nothing to do. */
2472 } else if (sscanf(s, "[%d]", &start) == 1) {
2474 } else if (!strncmp(s, "[]", 2)) {
2476 end = field->n_bits - 1;
2478 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2479 "[<start>..<end>]", *sp);
2481 s = strchr(s, ']') + 1;
2484 return xasprintf("%s: starting bit %d is after ending bit %d",
2486 } else if (start >= field->n_bits) {
2487 return xasprintf("%s: starting bit %d is not valid because field is "
2488 "only %d bits wide", *sp, start, field->n_bits);
2489 } else if (end >= field->n_bits){
2490 return xasprintf("%s: ending bit %d is not valid because field is "
2491 "only %d bits wide", *sp, end, field->n_bits);
2496 sf->n_bits = end - start + 1;
2502 /* Parses a subfield from the beginning of 's' into 'sf'. Returns the first
2503 * byte in 's' following the parsed string.
2505 * Exits with an error message if 's' has incorrect syntax.
2507 * The syntax parsed from 's' takes the form "header[start..end]" where
2508 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2509 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2510 * may both be omitted (the [] are still required) to indicate an entire
2513 mf_parse_subfield(struct mf_subfield *sf, const char *s)
2515 char *msg = mf_parse_subfield__(sf, &s);
2517 ovs_fatal(0, "%s", msg);
2523 mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s)
2527 for (i = 0; i < ARRAY_SIZE(subvalue->u8); i++) {
2528 if (subvalue->u8[i]) {
2529 ds_put_format(s, "0x%"PRIx8, subvalue->u8[i]);
2530 for (i++; i < ARRAY_SIZE(subvalue->u8); i++) {
2531 ds_put_format(s, "%02"PRIx8, subvalue->u8[i]);
2536 ds_put_char(s, '0');