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",
264 MFF_IPV4_SRC, "ip_src", "nw_src",
265 MF_FIELD_SIZES(be32),
270 NXM_OF_IP_SRC, "NXM_OF_IP_SRC",
271 OXM_OF_IPV4_SRC, "OXM_OF_IPV4_SRC",
273 MFF_IPV4_DST, "ip_dst", "nw_dst",
274 MF_FIELD_SIZES(be32),
279 NXM_OF_IP_DST, "NXM_OF_IP_DST",
280 OXM_OF_IPV4_DST, "OXM_OF_IPV4_DST",
284 MFF_IPV6_SRC, "ipv6_src", NULL,
285 MF_FIELD_SIZES(ipv6),
290 NXM_NX_IPV6_SRC, "NXM_NX_IPV6_SRC",
291 OXM_OF_IPV6_SRC, "OXM_OF_IPV6_SRC",
293 MFF_IPV6_DST, "ipv6_dst", NULL,
294 MF_FIELD_SIZES(ipv6),
299 NXM_NX_IPV6_DST, "NXM_NX_IPV6_DST",
300 OXM_OF_IPV6_DST, "OXM_OF_IPV6_DST",
303 MFF_IPV6_LABEL, "ipv6_label", NULL,
309 NXM_NX_IPV6_LABEL, "NXM_NX_IPV6_LABEL",
310 OXM_OF_IPV6_FLABEL, "OXM_OF_IPV6_FLABEL",
314 MFF_IP_PROTO, "nw_proto", NULL,
320 NXM_OF_IP_PROTO, "NXM_OF_IP_PROTO",
321 OXM_OF_IP_PROTO, "OXM_OF_IP_PROTO",
323 MFF_IP_DSCP, "nw_tos", NULL,
329 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
330 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
332 MFF_IP_ECN, "nw_ecn", NULL,
338 NXM_NX_IP_ECN, "NXM_NX_IP_ECN",
339 OXM_OF_IP_ECN, "OXM_OF_IP_ECN",
341 MFF_IP_TTL, "nw_ttl", NULL,
347 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
348 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
350 MFF_IP_FRAG, "ip_frag", NULL,
356 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
357 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
361 MFF_ARP_OP, "arp_op", NULL,
362 MF_FIELD_SIZES(be16),
367 NXM_OF_ARP_OP, "NXM_OF_ARP_OP",
368 OXM_OF_ARP_OP, "OXM_OF_ARP_OP",
370 MFF_ARP_SPA, "arp_spa", NULL,
371 MF_FIELD_SIZES(be32),
376 NXM_OF_ARP_SPA, "NXM_OF_ARP_SPA",
377 OXM_OF_ARP_SPA, "OXM_OF_ARP_SPA",
379 MFF_ARP_TPA, "arp_tpa", NULL,
380 MF_FIELD_SIZES(be32),
385 NXM_OF_ARP_TPA, "NXM_OF_ARP_TPA",
386 OXM_OF_ARP_TPA, "OXM_OF_ARP_TPA",
388 MFF_ARP_SHA, "arp_sha", NULL,
394 NXM_NX_ARP_SHA, "NXM_NX_ARP_SHA",
395 OXM_OF_ARP_SHA, "OXM_OF_ARP_SHA",
397 MFF_ARP_THA, "arp_tha", NULL,
403 NXM_NX_ARP_THA, "NXM_NX_ARP_THA",
404 OXM_OF_ARP_THA, "OXM_OF_ARP_THA",
412 MFF_TCP_SRC, "tcp_src", "tp_src",
413 MF_FIELD_SIZES(be16),
418 NXM_OF_TCP_SRC, "NXM_OF_TCP_SRC",
419 OXM_OF_TCP_SRC, "OXM_OF_TCP_SRC",
421 MFF_TCP_DST, "tcp_dst", "tp_dst",
422 MF_FIELD_SIZES(be16),
427 NXM_OF_TCP_DST, "NXM_OF_TCP_DST",
428 OXM_OF_TCP_DST, "OXM_OF_TCP_DST",
432 MFF_UDP_SRC, "udp_src", NULL,
433 MF_FIELD_SIZES(be16),
438 NXM_OF_UDP_SRC, "NXM_OF_UDP_SRC",
439 OXM_OF_UDP_SRC, "OXM_OF_UDP_SRC",
441 MFF_UDP_DST, "udp_dst", NULL,
442 MF_FIELD_SIZES(be16),
447 NXM_OF_UDP_DST, "NXM_OF_UDP_DST",
448 OXM_OF_UDP_DST, "OXM_OF_UDP_DST",
452 MFF_ICMPV4_TYPE, "icmp_type", NULL,
458 NXM_OF_ICMP_TYPE, "NXM_OF_ICMP_TYPE",
459 OXM_OF_ICMPV4_TYPE, "OXM_OF_ICMPV4_TYPE",
461 MFF_ICMPV4_CODE, "icmp_code", NULL,
467 NXM_OF_ICMP_CODE, "NXM_OF_ICMP_CODE",
468 OXM_OF_ICMPV4_CODE, "OXM_OF_ICMPV4_CODE",
472 MFF_ICMPV6_TYPE, "icmpv6_type", NULL,
478 NXM_NX_ICMPV6_TYPE, "NXM_NX_ICMPV6_TYPE",
479 OXM_OF_ICMPV6_TYPE, "OXM_OF_ICMPV6_TYPE",
481 MFF_ICMPV6_CODE, "icmpv6_code", NULL,
487 NXM_NX_ICMPV6_CODE, "NXM_NX_ICMPV6_CODE",
488 OXM_OF_ICMPV6_CODE, "OXM_OF_ICMPV6_CODE",
496 MFF_ND_TARGET, "nd_target", NULL,
497 MF_FIELD_SIZES(ipv6),
502 NXM_NX_ND_TARGET, "NXM_NX_ND_TARGET",
503 OXM_OF_IPV6_ND_TARGET, "OXM_OF_IPV6_ND_TARGET",
505 MFF_ND_SLL, "nd_sll", NULL,
511 NXM_NX_ND_SLL, "NXM_NX_ND_SLL",
512 OXM_OF_IPV6_ND_SLL, "OXM_OF_IPV6_ND_SLL",
514 MFF_ND_TLL, "nd_tll", NULL,
520 NXM_NX_ND_TLL, "NXM_NX_ND_TLL",
521 OXM_OF_IPV6_ND_TLL, "OXM_OF_IPV6_ND_TLL",
525 /* Maps an NXM or OXM header value to an mf_field. */
527 struct hmap_node hmap_node; /* In 'all_fields' hmap. */
528 uint32_t header; /* NXM or OXM header value. */
529 const struct mf_field *mf;
532 /* Contains 'struct nxm_field's. */
533 static struct hmap all_fields = HMAP_INITIALIZER(&all_fields);
535 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
536 * controller and so there's not much point in showing a lot of them. */
537 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
539 const struct mf_field *mf_from_nxm_header__(uint32_t header);
541 /* Returns the field with the given 'id'. */
542 const struct mf_field *
543 mf_from_id(enum mf_field_id id)
545 ovs_assert((unsigned int) id < MFF_N_IDS);
546 return &mf_fields[id];
549 /* Returns the field with the given 'name', or a null pointer if no field has
551 const struct mf_field *
552 mf_from_name(const char *name)
554 static struct shash mf_by_name = SHASH_INITIALIZER(&mf_by_name);
556 if (shash_is_empty(&mf_by_name)) {
557 const struct mf_field *mf;
559 for (mf = mf_fields; mf < &mf_fields[MFF_N_IDS]; mf++) {
560 shash_add_once(&mf_by_name, mf->name, mf);
561 if (mf->extra_name) {
562 shash_add_once(&mf_by_name, mf->extra_name, mf);
567 return shash_find_data(&mf_by_name, name);
571 add_nxm_field(uint32_t header, const struct mf_field *mf)
575 f = xmalloc(sizeof *f);
576 hmap_insert(&all_fields, &f->hmap_node, hash_int(header, 0));
582 nxm_init_add_field(const struct mf_field *mf, uint32_t header)
585 ovs_assert(!mf_from_nxm_header__(header));
586 add_nxm_field(header, mf);
587 if (mf->maskable != MFM_NONE) {
588 add_nxm_field(NXM_MAKE_WILD_HEADER(header), mf);
596 const struct mf_field *mf;
598 for (mf = mf_fields; mf < &mf_fields[MFF_N_IDS]; mf++) {
599 nxm_init_add_field(mf, mf->nxm_header);
600 if (mf->oxm_header != mf->nxm_header) {
601 nxm_init_add_field(mf, mf->oxm_header);
606 const struct mf_field *
607 mf_from_nxm_header(uint32_t header)
609 if (hmap_is_empty(&all_fields)) {
612 return mf_from_nxm_header__(header);
615 const struct mf_field *
616 mf_from_nxm_header__(uint32_t header)
618 const struct nxm_field *f;
620 HMAP_FOR_EACH_IN_BUCKET (f, hmap_node, hash_int(header, 0), &all_fields) {
621 if (f->header == header) {
629 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
630 * specifies at least one bit in the field.
632 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
633 * meets 'mf''s prerequisites. */
635 mf_is_all_wild(const struct mf_field *mf, const struct flow_wildcards *wc)
644 return !wc->masks.tunnel.tun_id;
646 return !wc->masks.metadata;
648 return !wc->masks.in_port;
649 case MFF_SKB_PRIORITY:
650 return !wc->masks.skb_priority;
652 return !wc->masks.skb_mark;
654 return !wc->masks.regs[mf->id - MFF_REG0];
657 return eth_addr_is_zero(wc->masks.dl_src);
659 return eth_addr_is_zero(wc->masks.dl_dst);
661 return !wc->masks.dl_type;
665 return eth_addr_is_zero(wc->masks.arp_sha);
669 return eth_addr_is_zero(wc->masks.arp_tha);
672 return !wc->masks.vlan_tci;
674 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK));
676 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI));
677 case MFF_DL_VLAN_PCP:
679 return !(wc->masks.vlan_tci & htons(VLAN_PCP_MASK));
682 return !wc->masks.nw_src;
684 return !wc->masks.nw_dst;
687 return ipv6_mask_is_any(&wc->masks.ipv6_src);
689 return ipv6_mask_is_any(&wc->masks.ipv6_dst);
692 return !wc->masks.ipv6_label;
695 return !wc->masks.nw_proto;
697 return !(wc->masks.nw_tos & IP_DSCP_MASK);
699 return !(wc->masks.nw_tos & IP_ECN_MASK);
701 return !wc->masks.nw_ttl;
704 return ipv6_mask_is_any(&wc->masks.nd_target);
707 return !(wc->masks.nw_frag & FLOW_NW_FRAG_MASK);
710 return !wc->masks.nw_proto;
712 return !wc->masks.nw_src;
714 return !wc->masks.nw_dst;
718 case MFF_ICMPV4_TYPE:
719 case MFF_ICMPV6_TYPE:
720 return !wc->masks.tp_src;
723 case MFF_ICMPV4_CODE:
724 case MFF_ICMPV6_CODE:
725 return !wc->masks.tp_dst;
733 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
734 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
735 * purposes, or to 0 if it is wildcarded.
737 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
738 * meets 'mf''s prerequisites. */
740 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
741 union mf_value *mask)
743 mf_get_value(mf, &wc->masks, mask);
746 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
747 * if the mask is valid, false otherwise. */
749 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
751 switch (mf->maskable) {
753 return (is_all_zeros((const uint8_t *) mask, mf->n_bytes) ||
754 is_all_ones((const uint8_t *) mask, mf->n_bytes));
764 is_icmpv4(const struct flow *flow)
766 return (flow->dl_type == htons(ETH_TYPE_IP)
767 && flow->nw_proto == IPPROTO_ICMP);
771 is_icmpv6(const struct flow *flow)
773 return (flow->dl_type == htons(ETH_TYPE_IPV6)
774 && flow->nw_proto == IPPROTO_ICMPV6);
777 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
779 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
781 switch (mf->prereqs) {
786 return (flow->dl_type == htons(ETH_TYPE_ARP) ||
787 flow->dl_type == htons(ETH_TYPE_RARP));
789 return flow->dl_type == htons(ETH_TYPE_IP);
791 return flow->dl_type == htons(ETH_TYPE_IPV6);
793 return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
795 return is_ip_any(flow);
798 return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP;
800 return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP;
802 return is_icmpv4(flow);
804 return is_icmpv6(flow);
807 return (is_icmpv6(flow)
808 && flow->tp_dst == htons(0)
809 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
810 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
812 return (is_icmpv6(flow)
813 && flow->tp_dst == htons(0)
814 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
816 return (is_icmpv6(flow)
817 && flow->tp_dst == htons(0)
818 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
824 /* Returns true if 'value' may be a valid value *as part of a masked match*,
827 * A value is not rejected just because it is not valid for the field in
828 * question, but only if it doesn't make sense to test the bits in question at
829 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
830 * without the VLAN_CFI bit being set, but we can't reject those values because
831 * it is still legitimate to test just for those bits (see the documentation
832 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
833 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
835 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
846 case MFF_SKB_PRIORITY:
867 case MFF_ICMPV4_TYPE:
868 case MFF_ICMPV4_CODE:
869 case MFF_ICMPV6_TYPE:
870 case MFF_ICMPV6_CODE:
877 return !(value->u8 & ~IP_DSCP_MASK);
879 return !(value->u8 & ~IP_ECN_MASK);
881 return !(value->u8 & ~FLOW_NW_FRAG_MASK);
884 return !(value->be16 & htons(0xff00));
887 return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
889 return !(value->be16 & htons(VLAN_PCP_MASK));
891 case MFF_DL_VLAN_PCP:
893 return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
896 return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
904 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
905 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
907 mf_get_value(const struct mf_field *mf, const struct flow *flow,
908 union mf_value *value)
912 value->be64 = flow->tunnel.tun_id;
915 value->be32 = flow->tunnel.ip_src;
918 value->be32 = flow->tunnel.ip_dst;
921 value->be16 = htons(flow->tunnel.flags);
924 value->u8 = flow->tunnel.ip_ttl;
927 value->u8 = flow->tunnel.ip_tos;
931 value->be64 = flow->metadata;
935 value->be16 = htons(flow->in_port);
938 case MFF_SKB_PRIORITY:
939 value->be32 = htonl(flow->skb_priority);
943 value->be32 = htonl(flow->skb_mark);
947 value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
951 memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
955 memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
959 value->be16 = flow->dl_type;
963 value->be16 = flow->vlan_tci;
967 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
970 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
973 case MFF_DL_VLAN_PCP:
975 value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
979 value->be32 = flow->nw_src;
983 value->be32 = flow->nw_dst;
987 value->ipv6 = flow->ipv6_src;
991 value->ipv6 = flow->ipv6_dst;
995 value->be32 = flow->ipv6_label;
999 value->u8 = flow->nw_proto;
1003 value->u8 = flow->nw_tos & IP_DSCP_MASK;
1007 value->u8 = flow->nw_tos & IP_ECN_MASK;
1011 value->u8 = flow->nw_ttl;
1015 value->u8 = flow->nw_frag;
1019 value->be16 = htons(flow->nw_proto);
1023 value->be32 = flow->nw_src;
1027 value->be32 = flow->nw_dst;
1032 memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
1037 memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
1042 value->be16 = flow->tp_src;
1047 value->be16 = flow->tp_dst;
1050 case MFF_ICMPV4_TYPE:
1051 case MFF_ICMPV6_TYPE:
1052 value->u8 = ntohs(flow->tp_src);
1055 case MFF_ICMPV4_CODE:
1056 case MFF_ICMPV6_CODE:
1057 value->u8 = ntohs(flow->tp_dst);
1061 value->ipv6 = flow->nd_target;
1070 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1071 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1074 mf_set_value(const struct mf_field *mf,
1075 const union mf_value *value, struct match *match)
1079 match_set_tun_id(match, value->be64);
1082 match_set_tun_src(match, value->be32);
1085 match_set_tun_dst(match, value->be32);
1088 match_set_tun_flags(match, ntohs(value->be16));
1091 match_set_tun_tos(match, value->u8);
1094 match_set_tun_ttl(match, value->u8);
1098 match_set_metadata(match, value->be64);
1102 match_set_in_port(match, ntohs(value->be16));
1105 case MFF_SKB_PRIORITY:
1106 match_set_skb_priority(match, ntohl(value->be32));
1110 match_set_skb_mark(match, ntohl(value->be32));
1114 match_set_reg(match, mf->id - MFF_REG0, ntohl(value->be32));
1118 match_set_dl_src(match, value->mac);
1122 match_set_dl_dst(match, value->mac);
1126 match_set_dl_type(match, value->be16);
1130 match_set_dl_tci(match, value->be16);
1134 match_set_dl_vlan(match, value->be16);
1137 match_set_vlan_vid(match, value->be16);
1140 case MFF_DL_VLAN_PCP:
1142 match_set_dl_vlan_pcp(match, value->u8);
1146 match_set_nw_src(match, value->be32);
1150 match_set_nw_dst(match, value->be32);
1154 match_set_ipv6_src(match, &value->ipv6);
1158 match_set_ipv6_dst(match, &value->ipv6);
1161 case MFF_IPV6_LABEL:
1162 match_set_ipv6_label(match, value->be32);
1166 match_set_nw_proto(match, value->u8);
1170 match_set_nw_dscp(match, value->u8);
1174 match_set_nw_ecn(match, value->u8);
1178 match_set_nw_ttl(match, value->u8);
1182 match_set_nw_frag(match, value->u8);
1186 match_set_nw_proto(match, ntohs(value->be16));
1190 match_set_nw_src(match, value->be32);
1194 match_set_nw_dst(match, value->be32);
1199 match_set_arp_sha(match, value->mac);
1204 match_set_arp_tha(match, value->mac);
1209 match_set_tp_src(match, value->be16);
1214 match_set_tp_dst(match, value->be16);
1217 case MFF_ICMPV4_TYPE:
1218 case MFF_ICMPV6_TYPE:
1219 match_set_icmp_type(match, value->u8);
1222 case MFF_ICMPV4_CODE:
1223 case MFF_ICMPV6_CODE:
1224 match_set_icmp_code(match, value->u8);
1228 match_set_nd_target(match, &value->ipv6);
1237 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1238 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1241 mf_set_flow_value(const struct mf_field *mf,
1242 const union mf_value *value, struct flow *flow)
1246 flow->tunnel.tun_id = value->be64;
1249 flow->tunnel.ip_src = value->be32;
1252 flow->tunnel.ip_dst = value->be32;
1255 flow->tunnel.flags = ntohs(value->be16);
1258 flow->tunnel.ip_tos = value->u8;
1261 flow->tunnel.ip_ttl = value->u8;
1265 flow->metadata = value->be64;
1269 flow->in_port = ntohs(value->be16);
1272 case MFF_SKB_PRIORITY:
1273 flow->skb_priority = ntohl(value->be32);
1277 flow->skb_mark = ntohl(value->be32);
1281 flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1285 memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
1289 memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
1293 flow->dl_type = value->be16;
1297 flow->vlan_tci = value->be16;
1301 flow_set_dl_vlan(flow, value->be16);
1304 flow_set_vlan_vid(flow, value->be16);
1307 case MFF_DL_VLAN_PCP:
1309 flow_set_vlan_pcp(flow, value->u8);
1313 flow->nw_src = value->be32;
1317 flow->nw_dst = value->be32;
1321 flow->ipv6_src = value->ipv6;
1325 flow->ipv6_dst = value->ipv6;
1328 case MFF_IPV6_LABEL:
1329 flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1333 flow->nw_proto = value->u8;
1337 flow->nw_tos &= ~IP_DSCP_MASK;
1338 flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1342 flow->nw_tos &= ~IP_ECN_MASK;
1343 flow->nw_tos |= value->u8 & IP_ECN_MASK;
1347 flow->nw_ttl = value->u8;
1351 flow->nw_frag &= value->u8;
1355 flow->nw_proto = ntohs(value->be16);
1359 flow->nw_src = value->be32;
1363 flow->nw_dst = value->be32;
1368 memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1373 memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1378 flow->tp_src = value->be16;
1383 flow->tp_dst = value->be16;
1386 case MFF_ICMPV4_TYPE:
1387 case MFF_ICMPV6_TYPE:
1388 flow->tp_src = htons(value->u8);
1391 case MFF_ICMPV4_CODE:
1392 case MFF_ICMPV6_CODE:
1393 flow->tp_dst = htons(value->u8);
1397 flow->nd_target = value->ipv6;
1406 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1408 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1411 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1413 union mf_value value;
1415 mf_get_value(mf, flow, &value);
1416 return is_all_zeros((const uint8_t *) &value, mf->n_bytes);
1419 /* Makes 'match' wildcard field 'mf'.
1421 * The caller is responsible for ensuring that 'match' meets 'mf''s
1424 mf_set_wild(const struct mf_field *mf, struct match *match)
1428 match_set_tun_id_masked(match, htonll(0), htonll(0));
1431 match_set_tun_src_masked(match, htonl(0), htonl(0));
1434 match_set_tun_dst_masked(match, htonl(0), htonl(0));
1437 match_set_tun_flags_masked(match, 0, 0);
1440 match_set_tun_tos_masked(match, 0, 0);
1443 match_set_tun_ttl_masked(match, 0, 0);
1447 match_set_metadata_masked(match, htonll(0), htonll(0));
1451 match->flow.in_port = 0;
1452 match->wc.masks.in_port = 0;
1455 case MFF_SKB_PRIORITY:
1456 match->flow.skb_priority = 0;
1457 match->wc.masks.skb_priority = 0;
1461 match->flow.skb_mark = 0;
1462 match->wc.masks.skb_mark = 0;
1466 match_set_reg_masked(match, mf->id - MFF_REG0, 0, 0);
1470 memset(match->flow.dl_src, 0, ETH_ADDR_LEN);
1471 memset(match->wc.masks.dl_src, 0, ETH_ADDR_LEN);
1475 memset(match->flow.dl_dst, 0, ETH_ADDR_LEN);
1476 memset(match->wc.masks.dl_dst, 0, ETH_ADDR_LEN);
1480 match->flow.dl_type = htons(0);
1481 match->wc.masks.dl_type = htons(0);
1485 match_set_dl_tci_masked(match, htons(0), htons(0));
1490 match_set_any_vid(match);
1493 case MFF_DL_VLAN_PCP:
1495 match_set_any_pcp(match);
1500 match_set_nw_src_masked(match, htonl(0), htonl(0));
1505 match_set_nw_dst_masked(match, htonl(0), htonl(0));
1509 memset(&match->wc.masks.ipv6_src, 0, sizeof match->wc.masks.ipv6_src);
1510 memset(&match->flow.ipv6_src, 0, sizeof match->flow.ipv6_src);
1514 memset(&match->wc.masks.ipv6_dst, 0, sizeof match->wc.masks.ipv6_dst);
1515 memset(&match->flow.ipv6_dst, 0, sizeof match->flow.ipv6_dst);
1518 case MFF_IPV6_LABEL:
1519 match->wc.masks.ipv6_label = htonl(0);
1520 match->flow.ipv6_label = htonl(0);
1524 match->wc.masks.nw_proto = 0;
1525 match->flow.nw_proto = 0;
1529 match->wc.masks.nw_tos &= ~IP_DSCP_MASK;
1530 match->flow.nw_tos &= ~IP_DSCP_MASK;
1534 match->wc.masks.nw_tos &= ~IP_ECN_MASK;
1535 match->flow.nw_tos &= ~IP_ECN_MASK;
1539 match->wc.masks.nw_ttl = 0;
1540 match->flow.nw_ttl = 0;
1544 match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
1545 match->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1549 match->wc.masks.nw_proto = 0;
1550 match->flow.nw_proto = 0;
1555 memset(match->flow.arp_sha, 0, ETH_ADDR_LEN);
1556 memset(match->wc.masks.arp_sha, 0, ETH_ADDR_LEN);
1561 memset(match->flow.arp_tha, 0, ETH_ADDR_LEN);
1562 memset(match->wc.masks.arp_tha, 0, ETH_ADDR_LEN);
1567 case MFF_ICMPV4_TYPE:
1568 case MFF_ICMPV6_TYPE:
1569 match->wc.masks.tp_src = htons(0);
1570 match->flow.tp_src = htons(0);
1575 case MFF_ICMPV4_CODE:
1576 case MFF_ICMPV6_CODE:
1577 match->wc.masks.tp_dst = htons(0);
1578 match->flow.tp_dst = htons(0);
1582 memset(&match->wc.masks.nd_target, 0,
1583 sizeof match->wc.masks.nd_target);
1584 memset(&match->flow.nd_target, 0, sizeof match->flow.nd_target);
1593 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
1594 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1595 * with a 1-bit indicating that the corresponding value bit must match and a
1596 * 0-bit indicating a don't-care.
1598 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1599 * mf_set_value(mf, value, match). If 'mask' points to all-0-bits, then this
1600 * call is equivalent to mf_set_wild(mf, match).
1602 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
1603 * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
1605 mf_set(const struct mf_field *mf,
1606 const union mf_value *value, const union mf_value *mask,
1607 struct match *match)
1609 if (!mask || is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
1610 mf_set_value(mf, value, match);
1612 } else if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
1613 mf_set_wild(mf, match);
1620 case MFF_SKB_PRIORITY:
1623 case MFF_DL_VLAN_PCP:
1630 case MFF_ICMPV4_TYPE:
1631 case MFF_ICMPV4_CODE:
1632 case MFF_ICMPV6_TYPE:
1633 case MFF_ICMPV6_CODE:
1637 match_set_tun_id_masked(match, value->be64, mask->be64);
1640 match_set_tun_src_masked(match, value->be32, mask->be32);
1643 match_set_tun_dst_masked(match, value->be32, mask->be32);
1646 match_set_tun_flags_masked(match, ntohs(value->be16), ntohs(mask->be16));
1649 match_set_tun_ttl_masked(match, value->u8, mask->u8);
1652 match_set_tun_tos_masked(match, value->u8, mask->u8);
1656 match_set_metadata_masked(match, value->be64, mask->be64);
1660 match_set_reg_masked(match, mf->id - MFF_REG0,
1661 ntohl(value->be32), ntohl(mask->be32));
1665 match_set_dl_dst_masked(match, value->mac, mask->mac);
1669 match_set_dl_src_masked(match, value->mac, mask->mac);
1674 match_set_arp_sha_masked(match, value->mac, mask->mac);
1679 match_set_arp_tha_masked(match, value->mac, mask->mac);
1683 match_set_dl_tci_masked(match, value->be16, mask->be16);
1687 match_set_vlan_vid_masked(match, value->be16, mask->be16);
1691 match_set_nw_src_masked(match, value->be32, mask->be32);
1695 match_set_nw_dst_masked(match, value->be32, mask->be32);
1699 match_set_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
1703 match_set_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
1706 case MFF_IPV6_LABEL:
1707 if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
1708 mf_set_value(mf, value, match);
1710 match_set_ipv6_label_masked(match, value->be32, mask->be32);
1715 match_set_nd_target_masked(match, &value->ipv6, &mask->ipv6);
1719 match_set_nw_frag_masked(match, value->u8, mask->u8);
1723 match_set_nw_src_masked(match, value->be32, mask->be32);
1727 match_set_nw_dst_masked(match, value->be32, mask->be32);
1732 match_set_tp_src_masked(match, value->be16, mask->be16);
1737 match_set_tp_dst_masked(match, value->be16, mask->be16);
1747 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
1751 VLOG_WARN_RL(&rl, "unknown %s field", type);
1752 } else if (!sf->n_bits) {
1753 VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
1754 } else if (sf->ofs >= sf->field->n_bits) {
1755 VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
1756 sf->ofs, sf->field->n_bits, type, sf->field->name);
1757 } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
1758 VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
1759 "of %s field %s", sf->ofs, sf->n_bits,
1760 sf->field->n_bits, type, sf->field->name);
1761 } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
1762 VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
1763 type, sf->field->name);
1768 return OFPERR_OFPBAC_BAD_ARGUMENT;
1771 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
1772 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
1775 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
1777 return mf_check__(sf, flow, "source");
1780 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
1781 * if so, otherwise an OpenFlow error code (e.g. as returned by
1784 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
1786 int error = mf_check__(sf, flow, "destination");
1787 if (!error && !sf->field->writable) {
1788 VLOG_WARN_RL(&rl, "destination field %s is not writable",
1790 return OFPERR_OFPBAC_BAD_ARGUMENT;
1795 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
1796 * 'value' and 'mask', respectively. */
1798 mf_get(const struct mf_field *mf, const struct match *match,
1799 union mf_value *value, union mf_value *mask)
1801 mf_get_value(mf, &match->flow, value);
1802 mf_get_mask(mf, &match->wc, mask);
1805 /* Assigns a random value for field 'mf' to 'value'. */
1807 mf_random_value(const struct mf_field *mf, union mf_value *value)
1809 random_bytes(value, mf->n_bytes);
1821 case MFF_SKB_PRIORITY:
1841 case MFF_ICMPV4_TYPE:
1842 case MFF_ICMPV4_CODE:
1843 case MFF_ICMPV6_TYPE:
1844 case MFF_ICMPV6_CODE:
1850 case MFF_IPV6_LABEL:
1851 value->be32 &= ~htonl(IPV6_LABEL_MASK);
1855 value->u8 &= IP_DSCP_MASK;
1859 value->u8 &= IP_ECN_MASK;
1863 value->u8 &= FLOW_NW_FRAG_MASK;
1867 value->be16 &= htons(0xff);
1871 value->be16 &= htons(VLAN_VID_MASK);
1874 value->be16 &= htons(VLAN_VID_MASK | VLAN_CFI);
1877 case MFF_DL_VLAN_PCP:
1889 mf_from_integer_string(const struct mf_field *mf, const char *s,
1890 uint8_t *valuep, uint8_t *maskp)
1892 unsigned long long int integer, mask;
1897 integer = strtoull(s, &tail, 0);
1898 if (errno || (*tail != '\0' && *tail != '/')) {
1903 mask = strtoull(tail + 1, &tail, 0);
1904 if (errno || *tail != '\0') {
1911 for (i = mf->n_bytes - 1; i >= 0; i--) {
1912 valuep[i] = integer;
1918 return xasprintf("%s: value too large for %u-byte field %s",
1919 s, mf->n_bytes, mf->name);
1924 return xasprintf("%s: bad syntax for %s", s, mf->name);
1928 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
1929 uint8_t mac[ETH_ADDR_LEN],
1930 uint8_t mask[ETH_ADDR_LEN])
1932 ovs_assert(mf->n_bytes == ETH_ADDR_LEN);
1934 switch (sscanf(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT,
1935 ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask))){
1936 case ETH_ADDR_SCAN_COUNT * 2:
1939 case ETH_ADDR_SCAN_COUNT:
1940 memset(mask, 0xff, ETH_ADDR_LEN);
1944 return xasprintf("%s: invalid Ethernet address", s);
1949 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
1950 ovs_be32 *ip, ovs_be32 *mask)
1954 ovs_assert(mf->n_bytes == sizeof *ip);
1956 if (sscanf(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
1957 IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask)) == IP_SCAN_COUNT * 2) {
1959 } else if (sscanf(s, IP_SCAN_FMT"/%d",
1960 IP_SCAN_ARGS(ip), &prefix) == IP_SCAN_COUNT + 1) {
1961 if (prefix <= 0 || prefix > 32) {
1962 return xasprintf("%s: network prefix bits not between 1 and "
1964 } else if (prefix == 32) {
1965 *mask = htonl(UINT32_MAX);
1967 *mask = htonl(((1u << prefix) - 1) << (32 - prefix));
1969 } else if (sscanf(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip)) == IP_SCAN_COUNT) {
1970 *mask = htonl(UINT32_MAX);
1972 return xasprintf("%s: invalid IP address", s);
1978 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
1979 struct in6_addr *value, struct in6_addr *mask)
1981 char *str = xstrdup(s);
1982 char *save_ptr = NULL;
1983 const char *name, *netmask;
1986 ovs_assert(mf->n_bytes == sizeof *value);
1988 name = strtok_r(str, "/", &save_ptr);
1989 retval = name ? lookup_ipv6(name, value) : EINVAL;
1993 err = xasprintf("%s: could not convert to IPv6 address", str);
1999 netmask = strtok_r(NULL, "/", &save_ptr);
2001 if (inet_pton(AF_INET6, netmask, mask) != 1) {
2002 int prefix = atoi(netmask);
2003 if (prefix <= 0 || prefix > 128) {
2005 return xasprintf("%s: prefix bits not between 1 and 128", s);
2007 *mask = ipv6_create_mask(prefix);
2011 *mask = in6addr_exact;
2019 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
2020 ovs_be16 *valuep, ovs_be16 *maskp)
2024 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2026 return xasprintf("%s: negative values not supported for %s",
2028 } else if (ofputil_port_from_string(s, &port)) {
2029 *valuep = htons(port);
2030 *maskp = htons(UINT16_MAX);
2033 return mf_from_integer_string(mf, s,
2034 (uint8_t *) valuep, (uint8_t *) maskp);
2038 struct frag_handling {
2044 static const struct frag_handling all_frags[] = {
2045 #define A FLOW_NW_FRAG_ANY
2046 #define L FLOW_NW_FRAG_LATER
2047 /* name mask value */
2050 { "first", A|L, A },
2051 { "later", A|L, A|L },
2056 { "not_later", L, 0 },
2063 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
2065 const struct frag_handling *h;
2067 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2068 if (!strcasecmp(s, h->name)) {
2069 /* We force the upper bits of the mask on to make mf_parse_value()
2070 * happy (otherwise it will never think it's an exact match.) */
2071 *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
2077 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2078 "\"yes\", \"first\", \"later\", \"not_first\"", s);
2082 parse_flow_tun_flags(const char *s_, const char *(*bit_to_string)(uint32_t),
2085 uint32_t result = 0;
2086 char *save_ptr = NULL;
2089 char *s = xstrdup(s_);
2091 for (name = strtok_r((char *)s, " |", &save_ptr); name;
2092 name = strtok_r(NULL, " |", &save_ptr)) {
2094 unsigned long long int flags;
2098 if (sscanf(name, "%lli%n", &flags, &n0) > 0 && n0 > 0) {
2102 name_len = strlen(name);
2103 for (bit = 1; bit; bit <<= 1) {
2104 const char *fname = bit_to_string(bit);
2111 len = strlen(fname);
2112 if (len != name_len) {
2115 if (!strncmp(name, fname, len)) {
2127 *res = htons(result);
2134 mf_from_tun_flags_string(const char *s, ovs_be16 *valuep, ovs_be16 *maskp)
2136 if (!parse_flow_tun_flags(s, flow_tun_flag_to_string, valuep)) {
2137 *maskp = htons(UINT16_MAX);
2141 return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
2142 "\"csum\", \"key\"", s);
2145 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2146 * NULL if successful, otherwise a malloc()'d string describing the error. */
2148 mf_parse(const struct mf_field *mf, const char *s,
2149 union mf_value *value, union mf_value *mask)
2151 if (!strcmp(s, "*")) {
2152 memset(value, 0, mf->n_bytes);
2153 memset(mask, 0, mf->n_bytes);
2157 switch (mf->string) {
2159 case MFS_HEXADECIMAL:
2160 return mf_from_integer_string(mf, s,
2161 (uint8_t *) value, (uint8_t *) mask);
2164 return mf_from_ethernet_string(mf, s, value->mac, mask->mac);
2167 return mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
2170 return mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
2173 return mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
2176 return mf_from_frag_string(s, &value->u8, &mask->u8);
2179 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2180 return mf_from_tun_flags_string(s, &value->be16, &mask->be16);
2185 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2186 * successful, otherwise a malloc()'d string describing the error. */
2188 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2190 union mf_value mask;
2193 error = mf_parse(mf, s, value, &mask);
2198 if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2199 return xasprintf("%s: wildcards not allowed here", s);
2205 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2206 const uint8_t *maskp, struct ds *s)
2208 unsigned long long int integer;
2211 ovs_assert(mf->n_bytes <= 8);
2214 for (i = 0; i < mf->n_bytes; i++) {
2215 integer = (integer << 8) | valuep[i];
2217 if (mf->string == MFS_HEXADECIMAL) {
2218 ds_put_format(s, "%#llx", integer);
2220 ds_put_format(s, "%lld", integer);
2224 unsigned long long int mask;
2227 for (i = 0; i < mf->n_bytes; i++) {
2228 mask = (mask << 8) | maskp[i];
2231 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2232 * not sure that that a bit-mask written in decimal is ever easier to
2233 * understand than the same bit-mask written in hexadecimal. */
2234 ds_put_format(s, "/%#llx", mask);
2239 mf_format_frag_string(uint8_t value, uint8_t mask, struct ds *s)
2241 const struct frag_handling *h;
2243 mask &= FLOW_NW_FRAG_MASK;
2246 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2247 if (value == h->value && mask == h->mask) {
2248 ds_put_cstr(s, h->name);
2252 ds_put_cstr(s, "<error>");
2256 mf_format_tnl_flags_string(const ovs_be16 *valuep, struct ds *s)
2258 format_flags(s, flow_tun_flag_to_string, ntohs(*valuep), '|');
2261 /* Appends to 's' a string representation of field 'mf' whose value is in
2262 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2264 mf_format(const struct mf_field *mf,
2265 const union mf_value *value, const union mf_value *mask,
2269 if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2270 ds_put_cstr(s, "ANY");
2272 } else if (is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2277 switch (mf->string) {
2280 ofputil_format_port(ntohs(value->be16), s);
2285 case MFS_HEXADECIMAL:
2286 mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2290 eth_format_masked(value->mac, mask->mac, s);
2294 ip_format_masked(value->be32, mask ? mask->be32 : htonl(UINT32_MAX),
2299 print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2303 mf_format_frag_string(value->u8, mask ? mask->u8 : UINT8_MAX, s);
2307 mf_format_tnl_flags_string(&value->be16, s);
2315 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2316 * least-significant bits in 'x'.
2319 mf_write_subfield_flow(const struct mf_subfield *sf,
2320 const union mf_subvalue *x, struct flow *flow)
2322 const struct mf_field *field = sf->field;
2323 union mf_value value;
2325 mf_get_value(field, flow, &value);
2326 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes,
2327 sf->ofs, sf->n_bits);
2328 mf_set_flow_value(field, &value, flow);
2331 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2332 * least-significant bits in 'x'.
2335 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2336 struct match *match)
2338 const struct mf_field *field = sf->field;
2339 union mf_value value, mask;
2341 mf_get(field, match, &value, &mask);
2342 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2343 bitwise_one ( &mask, field->n_bytes, sf->ofs, sf->n_bits);
2344 mf_set(field, &value, &mask, match);
2347 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2348 * reading 'flow', e.g. as checked by mf_check_src(). */
2350 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2351 union mf_subvalue *x)
2353 union mf_value value;
2355 mf_get_value(sf->field, flow, &value);
2357 memset(x, 0, sizeof *x);
2358 bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2363 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2364 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2367 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2369 union mf_value value;
2371 mf_get_value(sf->field, flow, &value);
2372 return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2375 /* Formats 'sf' into 's' in a format normally acceptable to
2376 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2377 * sf->field has no NXM name.) */
2379 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
2382 ds_put_cstr(s, "<unknown>");
2383 } else if (sf->field->nxm_name) {
2384 ds_put_cstr(s, sf->field->nxm_name);
2385 } else if (sf->field->nxm_header) {
2386 uint32_t header = sf->field->nxm_header;
2387 ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
2389 ds_put_cstr(s, sf->field->name);
2392 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
2393 ds_put_cstr(s, "[]");
2394 } else if (sf->n_bits == 1) {
2395 ds_put_format(s, "[%d]", sf->ofs);
2397 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
2401 static const struct mf_field *
2402 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
2406 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
2411 for (i = 0; i < MFF_N_IDS; i++) {
2412 const struct mf_field *mf = mf_from_id(i);
2415 && !strncmp(mf->nxm_name, name, name_len)
2416 && mf->nxm_name[name_len] == '\0') {
2420 && !strncmp(mf->oxm_name, name, name_len)
2421 && mf->oxm_name[name_len] == '\0') {
2429 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2430 * returns NULL and advances '*sp' to the first byte following the parsed
2431 * string. On failure, returns a malloc()'d error message, does not modify
2432 * '*sp', and does not properly initialize 'sf'.
2434 * The syntax parsed from '*sp' takes the form "header[start..end]" where
2435 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2436 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2437 * may both be omitted (the [] are still required) to indicate an entire
2440 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
2442 const struct mf_field *field;
2451 name_len = strcspn(s, "[");
2452 if (s[name_len] != '[') {
2453 return xasprintf("%s: missing [ looking for field name", *sp);
2456 field = mf_parse_subfield_name(name, name_len, &wild);
2458 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
2462 if (sscanf(s, "[%d..%d]", &start, &end) == 2) {
2463 /* Nothing to do. */
2464 } else if (sscanf(s, "[%d]", &start) == 1) {
2466 } else if (!strncmp(s, "[]", 2)) {
2468 end = field->n_bits - 1;
2470 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2471 "[<start>..<end>]", *sp);
2473 s = strchr(s, ']') + 1;
2476 return xasprintf("%s: starting bit %d is after ending bit %d",
2478 } else if (start >= field->n_bits) {
2479 return xasprintf("%s: starting bit %d is not valid because field is "
2480 "only %d bits wide", *sp, start, field->n_bits);
2481 } else if (end >= field->n_bits){
2482 return xasprintf("%s: ending bit %d is not valid because field is "
2483 "only %d bits wide", *sp, end, field->n_bits);
2488 sf->n_bits = end - start + 1;
2494 /* Parses a subfield from the beginning of 's' into 'sf'. Returns the first
2495 * byte in 's' following the parsed string.
2497 * Exits with an error message if 's' has incorrect syntax.
2499 * The syntax parsed from 's' takes the form "header[start..end]" where
2500 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2501 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2502 * may both be omitted (the [] are still required) to indicate an entire
2505 mf_parse_subfield(struct mf_subfield *sf, const char *s)
2507 char *msg = mf_parse_subfield__(sf, &s);
2509 ovs_fatal(0, "%s", msg);
2515 mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s)
2519 for (i = 0; i < ARRAY_SIZE(subvalue->u8); i++) {
2520 if (subvalue->u8[i]) {
2521 ds_put_format(s, "0x%"PRIx8, subvalue->u8[i]);
2522 for (i++; i < ARRAY_SIZE(subvalue->u8); i++) {
2523 ds_put_format(s, "%02"PRIx8, subvalue->u8[i]);
2528 ds_put_char(s, '0');