2 * Copyright (c) 2011, 2012, 2013, 2014, 2015 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"
29 #include "ofp-errors.h"
31 #include "ovs-thread.h"
35 #include "socket-util.h"
36 #include "tun-metadata.h"
37 #include "unaligned.h"
39 #include "openvswitch/vlog.h"
41 VLOG_DEFINE_THIS_MODULE(meta_flow);
43 #define FLOW_U32OFS(FIELD) \
44 offsetof(struct flow, FIELD) % 4 ? -1 : offsetof(struct flow, FIELD) / 4
46 #define MF_FIELD_SIZES(MEMBER) \
47 sizeof ((union mf_value *)0)->MEMBER, \
48 8 * sizeof ((union mf_value *)0)->MEMBER
50 extern const struct mf_field mf_fields[MFF_N_IDS]; /* Silence a warning. */
52 const struct mf_field mf_fields[MFF_N_IDS] = {
53 #include "meta-flow.inc"
56 /* Maps from an mf_field's 'name' or 'extra_name' to the mf_field. */
57 static struct shash mf_by_name;
59 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
60 * controller and so there's not much point in showing a lot of them. */
61 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
63 #define MF_VALUE_EXACT_8 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
64 #define MF_VALUE_EXACT_16 MF_VALUE_EXACT_8, MF_VALUE_EXACT_8
65 #define MF_VALUE_EXACT_32 MF_VALUE_EXACT_16, MF_VALUE_EXACT_16
66 #define MF_VALUE_EXACT_64 MF_VALUE_EXACT_32, MF_VALUE_EXACT_32
67 #define MF_VALUE_EXACT_128 MF_VALUE_EXACT_64, MF_VALUE_EXACT_64
68 #define MF_VALUE_EXACT_INITIALIZER { .tun_metadata = { MF_VALUE_EXACT_128 } }
70 const union mf_value exact_match_mask = MF_VALUE_EXACT_INITIALIZER;
72 static void nxm_init(void);
74 /* Returns the field with the given 'name', or a null pointer if no field has
76 const struct mf_field *
77 mf_from_name(const char *name)
80 return shash_find_data(&mf_by_name, name);
88 shash_init(&mf_by_name);
89 for (i = 0; i < MFF_N_IDS; i++) {
90 const struct mf_field *mf = &mf_fields[i];
92 ovs_assert(mf->id == i); /* Fields must be in the enum order. */
94 shash_add_once(&mf_by_name, mf->name, mf);
96 shash_add_once(&mf_by_name, mf->extra_name, mf);
104 static pthread_once_t once = PTHREAD_ONCE_INIT;
105 pthread_once(&once, nxm_do_init);
108 /* Consider the two value/mask pairs 'a_value/a_mask' and 'b_value/b_mask' as
109 * restrictions on a field's value. Then, this function initializes
110 * 'dst_value/dst_mask' such that it combines the restrictions of both pairs.
111 * This is not always possible, i.e. if one pair insists on a value of 0 in
112 * some bit and the other pair insists on a value of 1 in that bit. This
113 * function returns false in a case where the combined restriction is
114 * impossible (in which case 'dst_value/dst_mask' is not fully initialized),
117 * (As usually true for value/mask pairs in OVS, any 1-bit in a value must have
118 * a corresponding 1-bit in its mask.) */
120 mf_subvalue_intersect(const union mf_subvalue *a_value,
121 const union mf_subvalue *a_mask,
122 const union mf_subvalue *b_value,
123 const union mf_subvalue *b_mask,
124 union mf_subvalue *dst_value,
125 union mf_subvalue *dst_mask)
127 for (int i = 0; i < ARRAY_SIZE(a_value->be64); i++) {
128 ovs_be64 av = a_value->be64[i];
129 ovs_be64 am = a_mask->be64[i];
130 ovs_be64 bv = b_value->be64[i];
131 ovs_be64 bm = b_mask->be64[i];
132 ovs_be64 *dv = &dst_value->be64[i];
133 ovs_be64 *dm = &dst_mask->be64[i];
135 if ((av ^ bv) & (am & bm)) {
144 /* Returns the "number of bits" in 'v', e.g. 1 if only the lowest-order bit is
145 * set, 2 if the second-lowest-order bit is set, and so on. */
147 mf_subvalue_width(const union mf_subvalue *v)
149 return 1 + bitwise_rscan(v, sizeof *v, true, sizeof *v * 8 - 1, -1);
152 /* For positive 'n', shifts the bits in 'value' 'n' bits to the left, and for
153 * negative 'n', shifts the bits '-n' bits to the right. */
155 mf_subvalue_shift(union mf_subvalue *value, int n)
158 union mf_subvalue tmp;
159 memset(&tmp, 0, sizeof tmp);
161 if (n > 0 && n < 8 * sizeof tmp) {
162 bitwise_copy(value, sizeof *value, 0,
165 } else if (n < 0 && n > -8 * sizeof tmp) {
166 bitwise_copy(value, sizeof *value, -n,
174 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
175 * specifies at least one bit in the field.
177 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
178 * meets 'mf''s prerequisites. */
180 mf_is_all_wild(const struct mf_field *mf, const struct flow_wildcards *wc)
184 return !wc->masks.dp_hash;
186 return !wc->masks.recirc_id;
188 return !wc->masks.conj_id;
190 return !wc->masks.tunnel.ip_src;
192 return !wc->masks.tunnel.ip_dst;
194 return !wc->masks.tunnel.tun_id;
196 return !wc->masks.tunnel.ip_tos;
198 return !wc->masks.tunnel.ip_ttl;
200 return !(wc->masks.tunnel.flags & FLOW_TNL_PUB_F_MASK);
202 return !wc->masks.tunnel.gbp_id;
203 case MFF_TUN_GBP_FLAGS:
204 return !wc->masks.tunnel.gbp_flags;
205 CASE_MFF_TUN_METADATA:
206 return !ULLONG_GET(wc->masks.tunnel.metadata.present.map,
207 mf->id - MFF_TUN_METADATA0);
209 return !wc->masks.metadata;
211 case MFF_IN_PORT_OXM:
212 return !wc->masks.in_port.ofp_port;
213 case MFF_SKB_PRIORITY:
214 return !wc->masks.skb_priority;
216 return !wc->masks.pkt_mark;
218 return !wc->masks.regs[mf->id - MFF_REG0];
220 return !flow_get_xreg(&wc->masks, mf->id - MFF_XREG0);
221 case MFF_ACTSET_OUTPUT:
222 return !wc->masks.actset_output;
225 return eth_addr_is_zero(wc->masks.dl_src);
227 return eth_addr_is_zero(wc->masks.dl_dst);
229 return !wc->masks.dl_type;
233 return eth_addr_is_zero(wc->masks.arp_sha);
237 return eth_addr_is_zero(wc->masks.arp_tha);
240 return !wc->masks.vlan_tci;
242 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK));
244 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI));
245 case MFF_DL_VLAN_PCP:
247 return !(wc->masks.vlan_tci & htons(VLAN_PCP_MASK));
250 return !(wc->masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK));
252 return !(wc->masks.mpls_lse[0] & htonl(MPLS_TC_MASK));
254 return !(wc->masks.mpls_lse[0] & htonl(MPLS_BOS_MASK));
257 return !wc->masks.nw_src;
259 return !wc->masks.nw_dst;
262 return ipv6_mask_is_any(&wc->masks.ipv6_src);
264 return ipv6_mask_is_any(&wc->masks.ipv6_dst);
267 return !wc->masks.ipv6_label;
270 return !wc->masks.nw_proto;
272 case MFF_IP_DSCP_SHIFTED:
273 return !(wc->masks.nw_tos & IP_DSCP_MASK);
275 return !(wc->masks.nw_tos & IP_ECN_MASK);
277 return !wc->masks.nw_ttl;
280 return ipv6_mask_is_any(&wc->masks.nd_target);
283 return !(wc->masks.nw_frag & FLOW_NW_FRAG_MASK);
286 return !wc->masks.nw_proto;
288 return !wc->masks.nw_src;
290 return !wc->masks.nw_dst;
295 case MFF_ICMPV4_TYPE:
296 case MFF_ICMPV6_TYPE:
297 return !wc->masks.tp_src;
301 case MFF_ICMPV4_CODE:
302 case MFF_ICMPV6_CODE:
303 return !wc->masks.tp_dst;
305 return !wc->masks.tcp_flags;
313 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
314 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
315 * purposes, or to 0 if it is wildcarded.
317 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
318 * meets 'mf''s prerequisites. */
320 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
321 union mf_value *mask)
323 mf_get_value(mf, &wc->masks, mask);
326 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
327 * if the mask is valid, false otherwise. */
329 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
331 switch (mf->maskable) {
333 return (is_all_zeros(mask, mf->n_bytes) ||
334 is_all_ones(mask, mf->n_bytes));
343 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
345 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
347 switch (mf->prereqs) {
352 return (flow->dl_type == htons(ETH_TYPE_ARP) ||
353 flow->dl_type == htons(ETH_TYPE_RARP));
355 return flow->dl_type == htons(ETH_TYPE_IP);
357 return flow->dl_type == htons(ETH_TYPE_IPV6);
359 return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
361 return eth_type_mpls(flow->dl_type);
363 return is_ip_any(flow);
366 return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP
367 && !(flow->nw_frag & FLOW_NW_FRAG_LATER);
369 return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP
370 && !(flow->nw_frag & FLOW_NW_FRAG_LATER);
372 return is_ip_any(flow) && flow->nw_proto == IPPROTO_SCTP
373 && !(flow->nw_frag & FLOW_NW_FRAG_LATER);
375 return is_icmpv4(flow);
377 return is_icmpv6(flow);
380 return (is_icmpv6(flow)
381 && flow->tp_dst == htons(0)
382 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
383 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
385 return (is_icmpv6(flow)
386 && flow->tp_dst == htons(0)
387 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
389 return (is_icmpv6(flow)
390 && flow->tp_dst == htons(0)
391 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
397 /* Set field and it's prerequisities in the mask.
398 * This is only ever called for writeable 'mf's, but we do not make the
399 * distinction here. */
401 mf_mask_field_and_prereqs(const struct mf_field *mf, struct flow_wildcards *wc)
403 mf_set_flow_value(mf, &exact_match_mask, &wc->masks);
405 switch (mf->prereqs) {
409 WC_MASK_FIELD(wc, tp_src);
410 WC_MASK_FIELD(wc, tp_dst);
417 /* nw_frag always unwildcarded. */
418 WC_MASK_FIELD(wc, nw_proto);
425 /* dl_type always unwildcarded. */
428 WC_MASK_FIELD_MASK(wc, vlan_tci, htons(VLAN_CFI));
435 /* Set bits of 'bm' corresponding to the field 'mf' and it's prerequisities. */
437 mf_bitmap_set_field_and_prereqs(const struct mf_field *mf, struct mf_bitmap *bm)
439 bitmap_set1(bm->bm, mf->id);
441 switch (mf->prereqs) {
445 bitmap_set1(bm->bm, MFF_TCP_SRC);
446 bitmap_set1(bm->bm, MFF_TCP_DST);
453 /* nw_frag always unwildcarded. */
454 bitmap_set1(bm->bm, MFF_IP_PROTO);
461 bitmap_set1(bm->bm, MFF_ETH_TYPE);
464 bitmap_set1(bm->bm, MFF_VLAN_TCI);
471 /* Returns true if 'value' may be a valid value *as part of a masked match*,
474 * A value is not rejected just because it is not valid for the field in
475 * question, but only if it doesn't make sense to test the bits in question at
476 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
477 * without the VLAN_CFI bit being set, but we can't reject those values because
478 * it is still legitimate to test just for those bits (see the documentation
479 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
480 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
482 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
494 case MFF_TUN_GBP_FLAGS:
495 CASE_MFF_TUN_METADATA:
498 case MFF_SKB_PRIORITY:
522 case MFF_ICMPV4_TYPE:
523 case MFF_ICMPV4_CODE:
524 case MFF_ICMPV6_TYPE:
525 case MFF_ICMPV6_CODE:
531 case MFF_IN_PORT_OXM:
532 case MFF_ACTSET_OUTPUT: {
534 return !ofputil_port_from_ofp11(value->be32, &port);
538 return !(value->u8 & ~IP_DSCP_MASK);
539 case MFF_IP_DSCP_SHIFTED:
540 return !(value->u8 & (~IP_DSCP_MASK >> 2));
542 return !(value->u8 & ~IP_ECN_MASK);
544 return !(value->u8 & ~FLOW_NW_FRAG_MASK);
546 return !(value->be16 & ~htons(0x0fff));
549 return !(value->be16 & htons(0xff00));
552 return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
554 return !(value->be16 & htons(VLAN_PCP_MASK));
556 case MFF_DL_VLAN_PCP:
558 return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
561 return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
564 return !(value->be32 & ~htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT));
567 return !(value->u8 & ~(MPLS_TC_MASK >> MPLS_TC_SHIFT));
570 return !(value->u8 & ~(MPLS_BOS_MASK >> MPLS_BOS_SHIFT));
573 return !(value->be16 & ~htons(FLOW_TNL_PUB_F_MASK));
581 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
582 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
584 mf_get_value(const struct mf_field *mf, const struct flow *flow,
585 union mf_value *value)
589 value->be32 = htonl(flow->dp_hash);
592 value->be32 = htonl(flow->recirc_id);
595 value->be32 = htonl(flow->conj_id);
598 value->be64 = flow->tunnel.tun_id;
601 value->be32 = flow->tunnel.ip_src;
604 value->be32 = flow->tunnel.ip_dst;
607 value->be16 = htons(flow->tunnel.flags & FLOW_TNL_PUB_F_MASK);
610 value->be16 = flow->tunnel.gbp_id;
612 case MFF_TUN_GBP_FLAGS:
613 value->u8 = flow->tunnel.gbp_flags;
616 value->u8 = flow->tunnel.ip_ttl;
619 value->u8 = flow->tunnel.ip_tos;
621 CASE_MFF_TUN_METADATA:
622 tun_metadata_read(&flow->tunnel, mf, value);
626 value->be64 = flow->metadata;
630 value->be16 = htons(ofp_to_u16(flow->in_port.ofp_port));
632 case MFF_IN_PORT_OXM:
633 value->be32 = ofputil_port_to_ofp11(flow->in_port.ofp_port);
635 case MFF_ACTSET_OUTPUT:
636 value->be32 = ofputil_port_to_ofp11(flow->actset_output);
639 case MFF_SKB_PRIORITY:
640 value->be32 = htonl(flow->skb_priority);
644 value->be32 = htonl(flow->pkt_mark);
648 value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
652 value->be64 = htonll(flow_get_xreg(flow, mf->id - MFF_XREG0));
656 value->mac = flow->dl_src;
660 value->mac = flow->dl_dst;
664 value->be16 = flow->dl_type;
668 value->be16 = flow->vlan_tci;
672 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
675 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
678 case MFF_DL_VLAN_PCP:
680 value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
684 value->be32 = htonl(mpls_lse_to_label(flow->mpls_lse[0]));
688 value->u8 = mpls_lse_to_tc(flow->mpls_lse[0]);
692 value->u8 = mpls_lse_to_bos(flow->mpls_lse[0]);
696 value->be32 = flow->nw_src;
700 value->be32 = flow->nw_dst;
704 value->ipv6 = flow->ipv6_src;
708 value->ipv6 = flow->ipv6_dst;
712 value->be32 = flow->ipv6_label;
716 value->u8 = flow->nw_proto;
720 value->u8 = flow->nw_tos & IP_DSCP_MASK;
723 case MFF_IP_DSCP_SHIFTED:
724 value->u8 = flow->nw_tos >> 2;
728 value->u8 = flow->nw_tos & IP_ECN_MASK;
732 value->u8 = flow->nw_ttl;
736 value->u8 = flow->nw_frag;
740 value->be16 = htons(flow->nw_proto);
744 value->be32 = flow->nw_src;
748 value->be32 = flow->nw_dst;
753 value->mac = flow->arp_sha;
758 value->mac = flow->arp_tha;
764 value->be16 = flow->tp_src;
770 value->be16 = flow->tp_dst;
774 value->be16 = flow->tcp_flags;
777 case MFF_ICMPV4_TYPE:
778 case MFF_ICMPV6_TYPE:
779 value->u8 = ntohs(flow->tp_src);
782 case MFF_ICMPV4_CODE:
783 case MFF_ICMPV6_CODE:
784 value->u8 = ntohs(flow->tp_dst);
788 value->ipv6 = flow->nd_target;
797 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
798 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
801 * If non-NULL, 'err_str' returns a malloc'ed string describing any errors
802 * with the request or NULL if there is no error. The caller is reponsible
803 * for freeing the string. */
805 mf_set_value(const struct mf_field *mf,
806 const union mf_value *value, struct match *match, char **err_str)
814 match_set_dp_hash(match, ntohl(value->be32));
817 match_set_recirc_id(match, ntohl(value->be32));
820 match_set_conj_id(match, ntohl(value->be32));
823 match_set_tun_id(match, value->be64);
826 match_set_tun_src(match, value->be32);
829 match_set_tun_dst(match, value->be32);
832 match_set_tun_flags(match, ntohs(value->be16));
835 match_set_tun_gbp_id(match, value->be16);
837 case MFF_TUN_GBP_FLAGS:
838 match_set_tun_gbp_flags(match, value->u8);
841 match_set_tun_tos(match, value->u8);
844 match_set_tun_ttl(match, value->u8);
846 CASE_MFF_TUN_METADATA:
847 tun_metadata_set_match(mf, value, NULL, match, err_str);
851 match_set_metadata(match, value->be64);
855 match_set_in_port(match, u16_to_ofp(ntohs(value->be16)));
858 case MFF_IN_PORT_OXM: {
860 ofputil_port_from_ofp11(value->be32, &port);
861 match_set_in_port(match, port);
864 case MFF_ACTSET_OUTPUT: {
866 ofputil_port_from_ofp11(value->be32, &port);
867 match_set_actset_output(match, port);
871 case MFF_SKB_PRIORITY:
872 match_set_skb_priority(match, ntohl(value->be32));
876 match_set_pkt_mark(match, ntohl(value->be32));
880 match_set_reg(match, mf->id - MFF_REG0, ntohl(value->be32));
884 match_set_xreg(match, mf->id - MFF_XREG0, ntohll(value->be64));
888 match_set_dl_src(match, value->mac);
892 match_set_dl_dst(match, value->mac);
896 match_set_dl_type(match, value->be16);
900 match_set_dl_tci(match, value->be16);
904 match_set_dl_vlan(match, value->be16);
907 match_set_vlan_vid(match, value->be16);
910 case MFF_DL_VLAN_PCP:
912 match_set_dl_vlan_pcp(match, value->u8);
916 match_set_mpls_label(match, 0, value->be32);
920 match_set_mpls_tc(match, 0, value->u8);
924 match_set_mpls_bos(match, 0, value->u8);
928 match_set_nw_src(match, value->be32);
932 match_set_nw_dst(match, value->be32);
936 match_set_ipv6_src(match, &value->ipv6);
940 match_set_ipv6_dst(match, &value->ipv6);
944 match_set_ipv6_label(match, value->be32);
948 match_set_nw_proto(match, value->u8);
952 match_set_nw_dscp(match, value->u8);
955 case MFF_IP_DSCP_SHIFTED:
956 match_set_nw_dscp(match, value->u8 << 2);
960 match_set_nw_ecn(match, value->u8);
964 match_set_nw_ttl(match, value->u8);
968 match_set_nw_frag(match, value->u8);
972 match_set_nw_proto(match, ntohs(value->be16));
976 match_set_nw_src(match, value->be32);
980 match_set_nw_dst(match, value->be32);
985 match_set_arp_sha(match, value->mac);
990 match_set_arp_tha(match, value->mac);
996 match_set_tp_src(match, value->be16);
1002 match_set_tp_dst(match, value->be16);
1006 match_set_tcp_flags(match, value->be16);
1009 case MFF_ICMPV4_TYPE:
1010 case MFF_ICMPV6_TYPE:
1011 match_set_icmp_type(match, value->u8);
1014 case MFF_ICMPV4_CODE:
1015 case MFF_ICMPV6_CODE:
1016 match_set_icmp_code(match, value->u8);
1020 match_set_nd_target(match, &value->ipv6);
1029 /* Unwildcard 'mask' member field described by 'mf'. The caller is
1030 * responsible for ensuring that 'mask' meets 'mf''s prerequisites. */
1032 mf_mask_field(const struct mf_field *mf, struct flow *mask)
1034 /* For MFF_DL_VLAN, we cannot send a all 1's to flow_set_dl_vlan()
1035 * as that will be considered as OFP10_VLAN_NONE. So consider it as a
1036 * special case. For the rest, calling mf_set_flow_value() is good
1038 if (mf->id == MFF_DL_VLAN) {
1039 flow_set_dl_vlan(mask, htons(VLAN_VID_MASK));
1041 mf_set_flow_value(mf, &exact_match_mask, mask);
1046 field_len(const struct mf_field *mf, const union mf_value *value_)
1048 const uint8_t *value = &value_->u8;
1051 if (!mf->variable_len) {
1059 for (i = 0; i < mf->n_bytes; i++) {
1060 if (value[i] != 0) {
1065 return mf->n_bytes - i;
1068 /* Returns the effective length of the field. For fixed length fields,
1069 * this is just the defined length. For variable length fields, it is
1070 * the minimum size encoding that retains the same meaning (i.e.
1071 * discarding leading zeros).
1073 * 'is_masked' returns (if non-NULL) whether the original contained
1074 * a mask. Otherwise, a mask that is the same length as the value
1075 * might be misinterpreted as an exact match. */
1077 mf_field_len(const struct mf_field *mf, const union mf_value *value,
1078 const union mf_value *mask, bool *is_masked_)
1081 bool is_masked = mask && !is_all_ones(mask, mf->n_bytes);
1083 len = field_len(mf, value);
1085 mask_len = field_len(mf, mask);
1086 len = MAX(len, mask_len);
1090 *is_masked_ = is_masked;
1096 /* Sets 'flow' member field described by 'mf' to 'value'. The caller is
1097 * responsible for ensuring that 'flow' meets 'mf''s prerequisites.*/
1099 mf_set_flow_value(const struct mf_field *mf,
1100 const union mf_value *value, struct flow *flow)
1104 flow->dp_hash = ntohl(value->be32);
1107 flow->recirc_id = ntohl(value->be32);
1110 flow->conj_id = ntohl(value->be32);
1113 flow->tunnel.tun_id = value->be64;
1116 flow->tunnel.ip_src = value->be32;
1119 flow->tunnel.ip_dst = value->be32;
1122 flow->tunnel.flags = (flow->tunnel.flags & ~FLOW_TNL_PUB_F_MASK) |
1125 case MFF_TUN_GBP_ID:
1126 flow->tunnel.gbp_id = value->be16;
1128 case MFF_TUN_GBP_FLAGS:
1129 flow->tunnel.gbp_flags = value->u8;
1132 flow->tunnel.ip_tos = value->u8;
1135 flow->tunnel.ip_ttl = value->u8;
1137 CASE_MFF_TUN_METADATA:
1138 tun_metadata_write(&flow->tunnel, mf, value);
1141 flow->metadata = value->be64;
1145 flow->in_port.ofp_port = u16_to_ofp(ntohs(value->be16));
1148 case MFF_IN_PORT_OXM:
1149 ofputil_port_from_ofp11(value->be32, &flow->in_port.ofp_port);
1151 case MFF_ACTSET_OUTPUT:
1152 ofputil_port_from_ofp11(value->be32, &flow->actset_output);
1155 case MFF_SKB_PRIORITY:
1156 flow->skb_priority = ntohl(value->be32);
1160 flow->pkt_mark = ntohl(value->be32);
1164 flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1168 flow_set_xreg(flow, mf->id - MFF_XREG0, ntohll(value->be64));
1172 flow->dl_src = value->mac;
1176 flow->dl_dst = value->mac;
1180 flow->dl_type = value->be16;
1184 flow->vlan_tci = value->be16;
1188 flow_set_dl_vlan(flow, value->be16);
1191 flow_set_vlan_vid(flow, value->be16);
1194 case MFF_DL_VLAN_PCP:
1196 flow_set_vlan_pcp(flow, value->u8);
1199 case MFF_MPLS_LABEL:
1200 flow_set_mpls_label(flow, 0, value->be32);
1204 flow_set_mpls_tc(flow, 0, value->u8);
1208 flow_set_mpls_bos(flow, 0, value->u8);
1212 flow->nw_src = value->be32;
1216 flow->nw_dst = value->be32;
1220 flow->ipv6_src = value->ipv6;
1224 flow->ipv6_dst = value->ipv6;
1227 case MFF_IPV6_LABEL:
1228 flow->ipv6_label = value->be32 & htonl(IPV6_LABEL_MASK);
1232 flow->nw_proto = value->u8;
1236 flow->nw_tos &= ~IP_DSCP_MASK;
1237 flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1240 case MFF_IP_DSCP_SHIFTED:
1241 flow->nw_tos &= ~IP_DSCP_MASK;
1242 flow->nw_tos |= value->u8 << 2;
1246 flow->nw_tos &= ~IP_ECN_MASK;
1247 flow->nw_tos |= value->u8 & IP_ECN_MASK;
1251 flow->nw_ttl = value->u8;
1255 flow->nw_frag = value->u8 & FLOW_NW_FRAG_MASK;
1259 flow->nw_proto = ntohs(value->be16);
1263 flow->nw_src = value->be32;
1267 flow->nw_dst = value->be32;
1272 flow->arp_sha = value->mac;
1277 flow->arp_tha = value->mac;
1283 flow->tp_src = value->be16;
1289 flow->tp_dst = value->be16;
1293 flow->tcp_flags = value->be16;
1296 case MFF_ICMPV4_TYPE:
1297 case MFF_ICMPV6_TYPE:
1298 flow->tp_src = htons(value->u8);
1301 case MFF_ICMPV4_CODE:
1302 case MFF_ICMPV6_CODE:
1303 flow->tp_dst = htons(value->u8);
1307 flow->nd_target = value->ipv6;
1316 /* Consider each of 'src', 'mask', and 'dst' as if they were arrays of 8*n
1317 * bits. Then, for each 0 <= i < 8 * n such that mask[i] == 1, sets dst[i] =
1320 apply_mask(const uint8_t *src, const uint8_t *mask, uint8_t *dst, size_t n)
1324 for (i = 0; i < n; i++) {
1325 dst[i] = (src[i] & mask[i]) | (dst[i] & ~mask[i]);
1329 /* Sets 'flow' member field described by 'field' to 'value', except that bits
1330 * for which 'mask' has a 0-bit keep their existing values. The caller is
1331 * responsible for ensuring that 'flow' meets 'field''s prerequisites.*/
1333 mf_set_flow_value_masked(const struct mf_field *field,
1334 const union mf_value *value,
1335 const union mf_value *mask,
1340 mf_get_value(field, flow, &tmp);
1341 apply_mask((const uint8_t *) value, (const uint8_t *) mask,
1342 (uint8_t *) &tmp, field->n_bytes);
1343 mf_set_flow_value(field, &tmp, flow);
1347 mf_is_tun_metadata(const struct mf_field *mf)
1349 return mf->id >= MFF_TUN_METADATA0 &&
1350 mf->id < MFF_TUN_METADATA0 + TUN_METADATA_NUM_OPTS;
1353 /* Returns true if 'mf' has previously been set in 'flow', false if
1354 * it contains a non-default value.
1356 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1359 mf_is_set(const struct mf_field *mf, const struct flow *flow)
1361 if (!mf_is_tun_metadata(mf)) {
1362 union mf_value value;
1364 mf_get_value(mf, flow, &value);
1365 return !is_all_zeros(&value, mf->n_bytes);
1367 return ULLONG_GET(flow->tunnel.metadata.present.map,
1368 mf->id - MFF_TUN_METADATA0);
1372 /* Makes 'match' wildcard field 'mf'.
1374 * The caller is responsible for ensuring that 'match' meets 'mf''s
1377 * If non-NULL, 'err_str' returns a malloc'ed string describing any errors
1378 * with the request or NULL if there is no error. The caller is reponsible
1379 * for freeing the string. */
1381 mf_set_wild(const struct mf_field *mf, struct match *match, char **err_str)
1389 match->flow.dp_hash = 0;
1390 match->wc.masks.dp_hash = 0;
1393 match->flow.recirc_id = 0;
1394 match->wc.masks.recirc_id = 0;
1397 match->flow.conj_id = 0;
1398 match->wc.masks.conj_id = 0;
1401 match_set_tun_id_masked(match, htonll(0), htonll(0));
1404 match_set_tun_src_masked(match, htonl(0), htonl(0));
1407 match_set_tun_dst_masked(match, htonl(0), htonl(0));
1410 match_set_tun_flags_masked(match, 0, 0);
1412 case MFF_TUN_GBP_ID:
1413 match_set_tun_gbp_id_masked(match, 0, 0);
1415 case MFF_TUN_GBP_FLAGS:
1416 match_set_tun_gbp_flags_masked(match, 0, 0);
1419 match_set_tun_tos_masked(match, 0, 0);
1422 match_set_tun_ttl_masked(match, 0, 0);
1424 CASE_MFF_TUN_METADATA:
1425 tun_metadata_set_match(mf, NULL, NULL, match, err_str);
1429 match_set_metadata_masked(match, htonll(0), htonll(0));
1433 case MFF_IN_PORT_OXM:
1434 match->flow.in_port.ofp_port = 0;
1435 match->wc.masks.in_port.ofp_port = 0;
1437 case MFF_ACTSET_OUTPUT:
1438 match->flow.actset_output = 0;
1439 match->wc.masks.actset_output = 0;
1442 case MFF_SKB_PRIORITY:
1443 match->flow.skb_priority = 0;
1444 match->wc.masks.skb_priority = 0;
1448 match->flow.pkt_mark = 0;
1449 match->wc.masks.pkt_mark = 0;
1453 match_set_reg_masked(match, mf->id - MFF_REG0, 0, 0);
1457 match_set_xreg_masked(match, mf->id - MFF_XREG0, 0, 0);
1461 match->flow.dl_src = eth_addr_zero;
1462 match->wc.masks.dl_src = eth_addr_zero;
1466 match->flow.dl_dst = eth_addr_zero;
1467 match->wc.masks.dl_dst = eth_addr_zero;
1471 match->flow.dl_type = htons(0);
1472 match->wc.masks.dl_type = htons(0);
1476 match_set_dl_tci_masked(match, htons(0), htons(0));
1481 match_set_any_vid(match);
1484 case MFF_DL_VLAN_PCP:
1486 match_set_any_pcp(match);
1489 case MFF_MPLS_LABEL:
1490 match_set_any_mpls_label(match, 0);
1494 match_set_any_mpls_tc(match, 0);
1498 match_set_any_mpls_bos(match, 0);
1503 match_set_nw_src_masked(match, htonl(0), htonl(0));
1508 match_set_nw_dst_masked(match, htonl(0), htonl(0));
1512 memset(&match->wc.masks.ipv6_src, 0, sizeof match->wc.masks.ipv6_src);
1513 memset(&match->flow.ipv6_src, 0, sizeof match->flow.ipv6_src);
1517 memset(&match->wc.masks.ipv6_dst, 0, sizeof match->wc.masks.ipv6_dst);
1518 memset(&match->flow.ipv6_dst, 0, sizeof match->flow.ipv6_dst);
1521 case MFF_IPV6_LABEL:
1522 match->wc.masks.ipv6_label = htonl(0);
1523 match->flow.ipv6_label = htonl(0);
1527 match->wc.masks.nw_proto = 0;
1528 match->flow.nw_proto = 0;
1532 case MFF_IP_DSCP_SHIFTED:
1533 match->wc.masks.nw_tos &= ~IP_DSCP_MASK;
1534 match->flow.nw_tos &= ~IP_DSCP_MASK;
1538 match->wc.masks.nw_tos &= ~IP_ECN_MASK;
1539 match->flow.nw_tos &= ~IP_ECN_MASK;
1543 match->wc.masks.nw_ttl = 0;
1544 match->flow.nw_ttl = 0;
1548 match->wc.masks.nw_frag &= ~FLOW_NW_FRAG_MASK;
1549 match->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1553 match->wc.masks.nw_proto = 0;
1554 match->flow.nw_proto = 0;
1559 match->flow.arp_sha = eth_addr_zero;
1560 match->wc.masks.arp_sha = eth_addr_zero;
1565 match->flow.arp_tha = eth_addr_zero;
1566 match->wc.masks.arp_tha = eth_addr_zero;
1572 case MFF_ICMPV4_TYPE:
1573 case MFF_ICMPV6_TYPE:
1574 match->wc.masks.tp_src = htons(0);
1575 match->flow.tp_src = htons(0);
1581 case MFF_ICMPV4_CODE:
1582 case MFF_ICMPV6_CODE:
1583 match->wc.masks.tp_dst = htons(0);
1584 match->flow.tp_dst = htons(0);
1588 match->wc.masks.tcp_flags = htons(0);
1589 match->flow.tcp_flags = htons(0);
1593 memset(&match->wc.masks.nd_target, 0,
1594 sizeof match->wc.masks.nd_target);
1595 memset(&match->flow.nd_target, 0, sizeof match->flow.nd_target);
1604 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
1605 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1606 * with a 1-bit indicating that the corresponding value bit must match and a
1607 * 0-bit indicating a don't-care.
1609 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1610 * mf_set_value(mf, value, match). If 'mask' points to all-0-bits, then this
1611 * call is equivalent to mf_set_wild(mf, match).
1613 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
1614 * is responsible for ensuring that 'match' meets 'mf''s prerequisites.
1616 * If non-NULL, 'err_str' returns a malloc'ed string describing any errors
1617 * with the request or NULL if there is no error. The caller is reponsible
1618 * for freeing the string.*/
1619 enum ofputil_protocol
1620 mf_set(const struct mf_field *mf,
1621 const union mf_value *value, const union mf_value *mask,
1622 struct match *match, char **err_str)
1624 if (!mask || is_all_ones(mask, mf->n_bytes)) {
1625 mf_set_value(mf, value, match, err_str);
1626 return mf->usable_protocols_exact;
1627 } else if (is_all_zeros(mask, mf->n_bytes) && !mf_is_tun_metadata(mf)) {
1628 /* Tunnel metadata matches on the existence of the field itself, so
1629 * it still needs to be encoded even if the value is wildcarded. */
1630 mf_set_wild(mf, match, err_str);
1631 return OFPUTIL_P_ANY;
1642 case MFF_IN_PORT_OXM:
1643 case MFF_ACTSET_OUTPUT:
1644 case MFF_SKB_PRIORITY:
1647 case MFF_DL_VLAN_PCP:
1649 case MFF_MPLS_LABEL:
1655 case MFF_IP_DSCP_SHIFTED:
1658 case MFF_ICMPV4_TYPE:
1659 case MFF_ICMPV4_CODE:
1660 case MFF_ICMPV6_TYPE:
1661 case MFF_ICMPV6_CODE:
1662 return OFPUTIL_P_NONE;
1665 match_set_dp_hash_masked(match, ntohl(value->be32), ntohl(mask->be32));
1668 match_set_tun_id_masked(match, value->be64, mask->be64);
1671 match_set_tun_src_masked(match, value->be32, mask->be32);
1674 match_set_tun_dst_masked(match, value->be32, mask->be32);
1677 match_set_tun_flags_masked(match, ntohs(value->be16), ntohs(mask->be16));
1679 case MFF_TUN_GBP_ID:
1680 match_set_tun_gbp_id_masked(match, value->be16, mask->be16);
1682 case MFF_TUN_GBP_FLAGS:
1683 match_set_tun_gbp_flags_masked(match, value->u8, mask->u8);
1686 match_set_tun_ttl_masked(match, value->u8, mask->u8);
1689 match_set_tun_tos_masked(match, value->u8, mask->u8);
1691 CASE_MFF_TUN_METADATA:
1692 tun_metadata_set_match(mf, value, mask, match, err_str);
1696 match_set_metadata_masked(match, value->be64, mask->be64);
1700 match_set_reg_masked(match, mf->id - MFF_REG0,
1701 ntohl(value->be32), ntohl(mask->be32));
1705 match_set_xreg_masked(match, mf->id - MFF_XREG0,
1706 ntohll(value->be64), ntohll(mask->be64));
1710 match_set_pkt_mark_masked(match, ntohl(value->be32),
1715 match_set_dl_dst_masked(match, value->mac, mask->mac);
1719 match_set_dl_src_masked(match, value->mac, mask->mac);
1724 match_set_arp_sha_masked(match, value->mac, mask->mac);
1729 match_set_arp_tha_masked(match, value->mac, mask->mac);
1733 match_set_dl_tci_masked(match, value->be16, mask->be16);
1737 match_set_vlan_vid_masked(match, value->be16, mask->be16);
1741 match_set_nw_src_masked(match, value->be32, mask->be32);
1745 match_set_nw_dst_masked(match, value->be32, mask->be32);
1749 match_set_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
1753 match_set_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
1756 case MFF_IPV6_LABEL:
1757 if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
1758 mf_set_value(mf, value, match, err_str);
1760 match_set_ipv6_label_masked(match, value->be32, mask->be32);
1765 match_set_nd_target_masked(match, &value->ipv6, &mask->ipv6);
1769 match_set_nw_frag_masked(match, value->u8, mask->u8);
1773 match_set_nw_src_masked(match, value->be32, mask->be32);
1777 match_set_nw_dst_masked(match, value->be32, mask->be32);
1783 match_set_tp_src_masked(match, value->be16, mask->be16);
1789 match_set_tp_dst_masked(match, value->be16, mask->be16);
1793 match_set_tcp_flags_masked(match, value->be16, mask->be16);
1801 return ((mf->usable_protocols_bitwise == mf->usable_protocols_cidr
1802 || ip_is_cidr(mask->be32))
1803 ? mf->usable_protocols_cidr
1804 : mf->usable_protocols_bitwise);
1808 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
1812 VLOG_WARN_RL(&rl, "unknown %s field", type);
1813 return OFPERR_OFPBAC_BAD_SET_TYPE;
1814 } else if (!sf->n_bits) {
1815 VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
1816 return OFPERR_OFPBAC_BAD_SET_LEN;
1817 } else if (sf->ofs >= sf->field->n_bits) {
1818 VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
1819 sf->ofs, sf->field->n_bits, type, sf->field->name);
1820 return OFPERR_OFPBAC_BAD_SET_LEN;
1821 } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
1822 VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
1823 "of %s field %s", sf->ofs, sf->n_bits,
1824 sf->field->n_bits, type, sf->field->name);
1825 return OFPERR_OFPBAC_BAD_SET_LEN;
1826 } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
1827 VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
1828 type, sf->field->name);
1829 return OFPERR_OFPBAC_MATCH_INCONSISTENT;
1835 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
1836 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
1839 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
1841 return mf_check__(sf, flow, "source");
1844 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
1845 * if so, otherwise an OpenFlow error code (e.g. as returned by
1848 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
1850 int error = mf_check__(sf, flow, "destination");
1851 if (!error && !sf->field->writable) {
1852 VLOG_WARN_RL(&rl, "destination field %s is not writable",
1854 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
1859 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
1860 * 'value' and 'mask', respectively. */
1862 mf_get(const struct mf_field *mf, const struct match *match,
1863 union mf_value *value, union mf_value *mask)
1865 mf_get_value(mf, &match->flow, value);
1866 mf_get_mask(mf, &match->wc, mask);
1870 mf_from_integer_string(const struct mf_field *mf, const char *s,
1871 uint8_t *valuep, uint8_t *maskp)
1874 const char *err_str = "";
1877 err = parse_int_string(s, valuep, mf->n_bytes, &tail);
1878 if (err || (*tail != '\0' && *tail != '/')) {
1884 err = parse_int_string(tail + 1, maskp, mf->n_bytes, &tail);
1885 if (err || *tail != '\0') {
1890 memset(maskp, 0xff, mf->n_bytes);
1896 if (err == ERANGE) {
1897 return xasprintf("%s: %s too large for %u-byte field %s",
1898 s, err_str, mf->n_bytes, mf->name);
1900 return xasprintf("%s: bad syntax for %s %s", s, mf->name, err_str);
1905 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
1906 struct eth_addr *mac, struct eth_addr *mask)
1910 ovs_assert(mf->n_bytes == ETH_ADDR_LEN);
1913 if (ovs_scan(s, ETH_ADDR_SCAN_FMT"%n", ETH_ADDR_SCAN_ARGS(*mac), &n)
1914 && n == strlen(s)) {
1915 *mask = eth_addr_exact;
1920 if (ovs_scan(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT"%n",
1921 ETH_ADDR_SCAN_ARGS(*mac), ETH_ADDR_SCAN_ARGS(*mask), &n)
1922 && n == strlen(s)) {
1926 return xasprintf("%s: invalid Ethernet address", s);
1930 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
1931 ovs_be32 *ip, ovs_be32 *mask)
1935 ovs_assert(mf->n_bytes == sizeof *ip);
1937 if (ovs_scan(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
1938 IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask))) {
1940 } else if (ovs_scan(s, IP_SCAN_FMT"/%d", IP_SCAN_ARGS(ip), &prefix)) {
1941 if (prefix <= 0 || prefix > 32) {
1942 return xasprintf("%s: network prefix bits not between 0 and "
1945 *mask = be32_prefix_mask(prefix);
1946 } else if (ovs_scan(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip))) {
1947 *mask = OVS_BE32_MAX;
1949 return xasprintf("%s: invalid IP address", s);
1955 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
1956 struct in6_addr *value, struct in6_addr *mask)
1958 char *str = xstrdup(s);
1959 char *save_ptr = NULL;
1960 const char *name, *netmask;
1963 ovs_assert(mf->n_bytes == sizeof *value);
1965 name = strtok_r(str, "/", &save_ptr);
1966 retval = name ? lookup_ipv6(name, value) : EINVAL;
1970 err = xasprintf("%s: could not convert to IPv6 address", str);
1976 netmask = strtok_r(NULL, "/", &save_ptr);
1978 if (inet_pton(AF_INET6, netmask, mask) != 1) {
1979 int prefix = atoi(netmask);
1980 if (prefix <= 0 || prefix > 128) {
1982 return xasprintf("%s: prefix bits not between 1 and 128", s);
1984 *mask = ipv6_create_mask(prefix);
1988 *mask = in6addr_exact;
1996 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
1997 ovs_be16 *valuep, ovs_be16 *maskp)
2001 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2003 if (ofputil_port_from_string(s, &port)) {
2004 *valuep = htons(ofp_to_u16(port));
2005 *maskp = OVS_BE16_MAX;
2008 return xasprintf("%s: port value out of range for %s", s, mf->name);
2012 mf_from_ofp_port_string32(const struct mf_field *mf, const char *s,
2013 ovs_be32 *valuep, ovs_be32 *maskp)
2017 ovs_assert(mf->n_bytes == sizeof(ovs_be32));
2018 if (ofputil_port_from_string(s, &port)) {
2019 *valuep = ofputil_port_to_ofp11(port);
2020 *maskp = OVS_BE32_MAX;
2023 return xasprintf("%s: port value out of range for %s", s, mf->name);
2026 struct frag_handling {
2032 static const struct frag_handling all_frags[] = {
2033 #define A FLOW_NW_FRAG_ANY
2034 #define L FLOW_NW_FRAG_LATER
2035 /* name mask value */
2038 { "first", A|L, A },
2039 { "later", A|L, A|L },
2044 { "not_later", L, 0 },
2051 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
2053 const struct frag_handling *h;
2055 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2056 if (!strcasecmp(s, h->name)) {
2057 /* We force the upper bits of the mask on to make mf_parse_value()
2058 * happy (otherwise it will never think it's an exact match.) */
2059 *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
2065 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2066 "\"yes\", \"first\", \"later\", \"not_first\"", s);
2070 parse_mf_flags(const char *s, const char *(*bit_to_string)(uint32_t),
2071 const char *field_name, ovs_be16 *flagsp, ovs_be16 allowed,
2076 uint32_t flags, mask;
2078 err = parse_flags(s, bit_to_string, '\0', field_name, &err_str,
2079 &flags, ntohs(allowed), maskp ? &mask : NULL);
2084 *flagsp = htons(flags);
2086 *maskp = htons(mask);
2093 mf_from_tcp_flags_string(const char *s, ovs_be16 *flagsp, ovs_be16 *maskp)
2095 return parse_mf_flags(s, packet_tcp_flag_to_string, "TCP", flagsp,
2096 TCP_FLAGS_BE16(OVS_BE16_MAX), maskp);
2100 mf_from_tun_flags_string(const char *s, ovs_be16 *flagsp, ovs_be16 *maskp)
2102 return parse_mf_flags(s, flow_tun_flag_to_string, "tunnel", flagsp,
2103 htons(FLOW_TNL_PUB_F_MASK), maskp);
2106 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2107 * NULL if successful, otherwise a malloc()'d string describing the error. */
2109 mf_parse(const struct mf_field *mf, const char *s,
2110 union mf_value *value, union mf_value *mask)
2114 if (!strcmp(s, "*")) {
2115 memset(value, 0, mf->n_bytes);
2116 memset(mask, 0, mf->n_bytes);
2120 switch (mf->string) {
2122 case MFS_HEXADECIMAL:
2123 error = mf_from_integer_string(mf, s,
2124 (uint8_t *) value, (uint8_t *) mask);
2128 error = mf_from_ethernet_string(mf, s, &value->mac, &mask->mac);
2132 error = mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
2136 error = mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
2140 error = mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
2143 case MFS_OFP_PORT_OXM:
2144 error = mf_from_ofp_port_string32(mf, s, &value->be32, &mask->be32);
2148 error = mf_from_frag_string(s, &value->u8, &mask->u8);
2152 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2153 error = mf_from_tun_flags_string(s, &value->be16, &mask->be16);
2157 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2158 error = mf_from_tcp_flags_string(s, &value->be16, &mask->be16);
2165 if (!error && !mf_is_mask_valid(mf, mask)) {
2166 error = xasprintf("%s: invalid mask for field %s", s, mf->name);
2171 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2172 * successful, otherwise a malloc()'d string describing the error. */
2174 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2176 union mf_value mask;
2179 error = mf_parse(mf, s, value, &mask);
2184 if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2185 return xasprintf("%s: wildcards not allowed here", s);
2191 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2192 const uint8_t *maskp, struct ds *s)
2194 if (mf->string == MFS_HEXADECIMAL) {
2195 ds_put_hex(s, valuep, mf->n_bytes);
2197 unsigned long long int integer = 0;
2200 ovs_assert(mf->n_bytes <= 8);
2201 for (i = 0; i < mf->n_bytes; i++) {
2202 integer = (integer << 8) | valuep[i];
2204 ds_put_format(s, "%lld", integer);
2208 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2209 * not sure that that a bit-mask written in decimal is ever easier to
2210 * understand than the same bit-mask written in hexadecimal. */
2211 ds_put_char(s, '/');
2212 ds_put_hex(s, maskp, mf->n_bytes);
2217 mf_format_frag_string(uint8_t value, uint8_t mask, struct ds *s)
2219 const struct frag_handling *h;
2221 mask &= FLOW_NW_FRAG_MASK;
2224 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2225 if (value == h->value && mask == h->mask) {
2226 ds_put_cstr(s, h->name);
2230 ds_put_cstr(s, "<error>");
2234 mf_format_tnl_flags_string(ovs_be16 value, ovs_be16 mask, struct ds *s)
2236 format_flags_masked(s, NULL, flow_tun_flag_to_string, ntohs(value),
2237 ntohs(mask) & FLOW_TNL_PUB_F_MASK, FLOW_TNL_PUB_F_MASK);
2241 mf_format_tcp_flags_string(ovs_be16 value, ovs_be16 mask, struct ds *s)
2243 format_flags_masked(s, NULL, packet_tcp_flag_to_string, ntohs(value),
2244 TCP_FLAGS(mask), TCP_FLAGS(OVS_BE16_MAX));
2247 /* Appends to 's' a string representation of field 'mf' whose value is in
2248 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2250 mf_format(const struct mf_field *mf,
2251 const union mf_value *value, const union mf_value *mask,
2255 if (is_all_zeros(mask, mf->n_bytes)) {
2256 ds_put_cstr(s, "ANY");
2258 } else if (is_all_ones(mask, mf->n_bytes)) {
2263 switch (mf->string) {
2264 case MFS_OFP_PORT_OXM:
2267 ofputil_port_from_ofp11(value->be32, &port);
2268 ofputil_format_port(port, s);
2274 ofputil_format_port(u16_to_ofp(ntohs(value->be16)), s);
2279 case MFS_HEXADECIMAL:
2280 mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2284 eth_format_masked(value->mac, mask ? &mask->mac : NULL, s);
2288 ip_format_masked(value->be32, mask ? mask->be32 : OVS_BE32_MAX, s);
2292 print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2296 mf_format_frag_string(value->u8, mask ? mask->u8 : UINT8_MAX, s);
2300 mf_format_tnl_flags_string(value->be16,
2301 mask ? mask->be16 : OVS_BE16_MAX, s);
2305 mf_format_tcp_flags_string(value->be16,
2306 mask ? mask->be16 : OVS_BE16_MAX, s);
2314 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2315 * least-significant bits in 'x'.
2318 mf_write_subfield_flow(const struct mf_subfield *sf,
2319 const union mf_subvalue *x, struct flow *flow)
2321 const struct mf_field *field = sf->field;
2322 union mf_value value;
2324 mf_get_value(field, flow, &value);
2325 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes,
2326 sf->ofs, sf->n_bits);
2327 mf_set_flow_value(field, &value, flow);
2330 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2331 * least-significant bits in 'x'.
2334 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2335 struct match *match)
2337 const struct mf_field *field = sf->field;
2338 union mf_value value, mask;
2340 mf_get(field, match, &value, &mask);
2341 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2342 bitwise_one ( &mask, field->n_bytes, sf->ofs, sf->n_bits);
2343 mf_set(field, &value, &mask, match, NULL);
2346 /* 'v' and 'm' correspond to values of 'field'. This function copies them into
2347 * 'match' in the correspond positions. */
2349 mf_mask_subfield(const struct mf_field *field,
2350 const union mf_subvalue *v,
2351 const union mf_subvalue *m,
2352 struct match *match)
2354 union mf_value value, mask;
2356 mf_get(field, match, &value, &mask);
2357 bitwise_copy(v, sizeof *v, 0, &value, field->n_bytes, 0, field->n_bits);
2358 bitwise_copy(m, sizeof *m, 0, &mask, field->n_bytes, 0, field->n_bits);
2359 mf_set(field, &value, &mask, match, NULL);
2362 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2363 * reading 'flow', e.g. as checked by mf_check_src(). */
2365 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2366 union mf_subvalue *x)
2368 union mf_value value;
2370 mf_get_value(sf->field, flow, &value);
2372 memset(x, 0, sizeof *x);
2373 bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2378 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2379 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2382 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2384 union mf_value value;
2386 mf_get_value(sf->field, flow, &value);
2387 return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2391 mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s)
2393 ds_put_hex(s, subvalue->u8, sizeof subvalue->u8);
2397 field_array_set(enum mf_field_id id, const union mf_value *value,
2398 struct field_array *fa)
2400 ovs_assert(id < MFF_N_IDS);
2401 bitmap_set1(fa->used.bm, id);
2402 fa->value[id] = *value;