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;
193 case MFF_TUN_IPV6_SRC:
194 return ipv6_mask_is_any(&wc->masks.tunnel.ipv6_src);
195 case MFF_TUN_IPV6_DST:
196 return ipv6_mask_is_any(&wc->masks.tunnel.ipv6_dst);
198 return !wc->masks.tunnel.tun_id;
200 return !wc->masks.tunnel.ip_tos;
202 return !wc->masks.tunnel.ip_ttl;
204 return !(wc->masks.tunnel.flags & FLOW_TNL_PUB_F_MASK);
206 return !wc->masks.tunnel.gbp_id;
207 case MFF_TUN_GBP_FLAGS:
208 return !wc->masks.tunnel.gbp_flags;
209 CASE_MFF_TUN_METADATA:
210 return !ULLONG_GET(wc->masks.tunnel.metadata.present.map,
211 mf->id - MFF_TUN_METADATA0);
213 return !wc->masks.metadata;
215 case MFF_IN_PORT_OXM:
216 return !wc->masks.in_port.ofp_port;
217 case MFF_SKB_PRIORITY:
218 return !wc->masks.skb_priority;
220 return !wc->masks.pkt_mark;
222 return !wc->masks.ct_state;
224 return !wc->masks.ct_zone;
226 return !wc->masks.ct_mark;
228 return ovs_u128_is_zero(&wc->masks.ct_label);
230 return !wc->masks.regs[mf->id - MFF_REG0];
232 return !flow_get_xreg(&wc->masks, mf->id - MFF_XREG0);
233 case MFF_ACTSET_OUTPUT:
234 return !wc->masks.actset_output;
237 return eth_addr_is_zero(wc->masks.dl_src);
239 return eth_addr_is_zero(wc->masks.dl_dst);
241 return !wc->masks.dl_type;
245 return eth_addr_is_zero(wc->masks.arp_sha);
249 return eth_addr_is_zero(wc->masks.arp_tha);
252 return !wc->masks.vlan_tci;
254 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK));
256 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI));
257 case MFF_DL_VLAN_PCP:
259 return !(wc->masks.vlan_tci & htons(VLAN_PCP_MASK));
262 return !(wc->masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK));
264 return !(wc->masks.mpls_lse[0] & htonl(MPLS_TC_MASK));
266 return !(wc->masks.mpls_lse[0] & htonl(MPLS_BOS_MASK));
269 return !wc->masks.nw_src;
271 return !wc->masks.nw_dst;
274 return ipv6_mask_is_any(&wc->masks.ipv6_src);
276 return ipv6_mask_is_any(&wc->masks.ipv6_dst);
279 return !wc->masks.ipv6_label;
282 return !wc->masks.nw_proto;
284 case MFF_IP_DSCP_SHIFTED:
285 return !(wc->masks.nw_tos & IP_DSCP_MASK);
287 return !(wc->masks.nw_tos & IP_ECN_MASK);
289 return !wc->masks.nw_ttl;
292 return ipv6_mask_is_any(&wc->masks.nd_target);
295 return !(wc->masks.nw_frag & FLOW_NW_FRAG_MASK);
298 return !wc->masks.nw_proto;
300 return !wc->masks.nw_src;
302 return !wc->masks.nw_dst;
307 case MFF_ICMPV4_TYPE:
308 case MFF_ICMPV6_TYPE:
309 return !wc->masks.tp_src;
313 case MFF_ICMPV4_CODE:
314 case MFF_ICMPV6_CODE:
315 return !wc->masks.tp_dst;
317 return !wc->masks.tcp_flags;
325 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
326 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
327 * purposes, or to 0 if it is wildcarded.
329 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
330 * meets 'mf''s prerequisites. */
332 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
333 union mf_value *mask)
335 mf_get_value(mf, &wc->masks, mask);
338 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
339 * if the mask is valid, false otherwise. */
341 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
343 switch (mf->maskable) {
345 return (is_all_zeros(mask, mf->n_bytes) ||
346 is_all_ones(mask, mf->n_bytes));
355 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
357 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
359 switch (mf->prereqs) {
364 return (flow->dl_type == htons(ETH_TYPE_ARP) ||
365 flow->dl_type == htons(ETH_TYPE_RARP));
367 return flow->dl_type == htons(ETH_TYPE_IP);
369 return flow->dl_type == htons(ETH_TYPE_IPV6);
371 return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
373 return eth_type_mpls(flow->dl_type);
375 return is_ip_any(flow);
378 return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP
379 && !(flow->nw_frag & FLOW_NW_FRAG_LATER);
381 return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP
382 && !(flow->nw_frag & FLOW_NW_FRAG_LATER);
384 return is_ip_any(flow) && flow->nw_proto == IPPROTO_SCTP
385 && !(flow->nw_frag & FLOW_NW_FRAG_LATER);
387 return is_icmpv4(flow);
389 return is_icmpv6(flow);
392 return (is_icmpv6(flow)
393 && flow->tp_dst == htons(0)
394 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
395 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
397 return (is_icmpv6(flow)
398 && flow->tp_dst == htons(0)
399 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
401 return (is_icmpv6(flow)
402 && flow->tp_dst == htons(0)
403 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
409 /* Set field and it's prerequisities in the mask.
410 * This is only ever called for writeable 'mf's, but we do not make the
411 * distinction here. */
413 mf_mask_field_and_prereqs(const struct mf_field *mf, struct flow_wildcards *wc)
415 mf_set_flow_value(mf, &exact_match_mask, &wc->masks);
417 switch (mf->prereqs) {
421 WC_MASK_FIELD(wc, tp_src);
422 WC_MASK_FIELD(wc, tp_dst);
429 /* nw_frag always unwildcarded. */
430 WC_MASK_FIELD(wc, nw_proto);
437 /* dl_type always unwildcarded. */
440 WC_MASK_FIELD_MASK(wc, vlan_tci, htons(VLAN_CFI));
447 /* Set bits of 'bm' corresponding to the field 'mf' and it's prerequisities. */
449 mf_bitmap_set_field_and_prereqs(const struct mf_field *mf, struct mf_bitmap *bm)
451 bitmap_set1(bm->bm, mf->id);
453 switch (mf->prereqs) {
457 bitmap_set1(bm->bm, MFF_TCP_SRC);
458 bitmap_set1(bm->bm, MFF_TCP_DST);
465 /* nw_frag always unwildcarded. */
466 bitmap_set1(bm->bm, MFF_IP_PROTO);
473 bitmap_set1(bm->bm, MFF_ETH_TYPE);
476 bitmap_set1(bm->bm, MFF_VLAN_TCI);
483 /* Returns true if 'value' may be a valid value *as part of a masked match*,
486 * A value is not rejected just because it is not valid for the field in
487 * question, but only if it doesn't make sense to test the bits in question at
488 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
489 * without the VLAN_CFI bit being set, but we can't reject those values because
490 * it is still legitimate to test just for those bits (see the documentation
491 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
492 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
494 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
503 case MFF_TUN_IPV6_SRC:
504 case MFF_TUN_IPV6_DST:
508 case MFF_TUN_GBP_FLAGS:
509 CASE_MFF_TUN_METADATA:
512 case MFF_SKB_PRIORITY:
539 case MFF_ICMPV4_TYPE:
540 case MFF_ICMPV4_CODE:
541 case MFF_ICMPV6_TYPE:
542 case MFF_ICMPV6_CODE:
548 case MFF_IN_PORT_OXM:
549 case MFF_ACTSET_OUTPUT: {
551 return !ofputil_port_from_ofp11(value->be32, &port);
555 return !(value->u8 & ~IP_DSCP_MASK);
556 case MFF_IP_DSCP_SHIFTED:
557 return !(value->u8 & (~IP_DSCP_MASK >> 2));
559 return !(value->u8 & ~IP_ECN_MASK);
561 return !(value->u8 & ~FLOW_NW_FRAG_MASK);
563 return !(value->be16 & ~htons(0x0fff));
566 return !(value->be16 & htons(0xff00));
569 return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
571 return !(value->be16 & htons(VLAN_PCP_MASK));
573 case MFF_DL_VLAN_PCP:
575 return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
578 return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
581 return !(value->be32 & ~htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT));
584 return !(value->u8 & ~(MPLS_TC_MASK >> MPLS_TC_SHIFT));
587 return !(value->u8 & ~(MPLS_BOS_MASK >> MPLS_BOS_SHIFT));
590 return !(value->be16 & ~htons(FLOW_TNL_PUB_F_MASK));
593 return !(value->be32 & ~htonl(CS_SUPPORTED_MASK));
601 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
602 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
604 mf_get_value(const struct mf_field *mf, const struct flow *flow,
605 union mf_value *value)
609 value->be32 = htonl(flow->dp_hash);
612 value->be32 = htonl(flow->recirc_id);
615 value->be32 = htonl(flow->conj_id);
618 value->be64 = flow->tunnel.tun_id;
621 value->be32 = flow->tunnel.ip_src;
624 value->be32 = flow->tunnel.ip_dst;
626 case MFF_TUN_IPV6_SRC:
627 value->ipv6 = flow->tunnel.ipv6_src;
629 case MFF_TUN_IPV6_DST:
630 value->ipv6 = flow->tunnel.ipv6_dst;
633 value->be16 = htons(flow->tunnel.flags & FLOW_TNL_PUB_F_MASK);
636 value->be16 = flow->tunnel.gbp_id;
638 case MFF_TUN_GBP_FLAGS:
639 value->u8 = flow->tunnel.gbp_flags;
642 value->u8 = flow->tunnel.ip_ttl;
645 value->u8 = flow->tunnel.ip_tos;
647 CASE_MFF_TUN_METADATA:
648 tun_metadata_read(&flow->tunnel, mf, value);
652 value->be64 = flow->metadata;
656 value->be16 = htons(ofp_to_u16(flow->in_port.ofp_port));
658 case MFF_IN_PORT_OXM:
659 value->be32 = ofputil_port_to_ofp11(flow->in_port.ofp_port);
661 case MFF_ACTSET_OUTPUT:
662 value->be32 = ofputil_port_to_ofp11(flow->actset_output);
665 case MFF_SKB_PRIORITY:
666 value->be32 = htonl(flow->skb_priority);
670 value->be32 = htonl(flow->pkt_mark);
674 value->be32 = htonl(flow->ct_state);
678 value->be16 = htons(flow->ct_zone);
682 value->be32 = htonl(flow->ct_mark);
686 value->be128 = hton128(flow->ct_label);
690 value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
694 value->be64 = htonll(flow_get_xreg(flow, mf->id - MFF_XREG0));
698 value->mac = flow->dl_src;
702 value->mac = flow->dl_dst;
706 value->be16 = flow->dl_type;
710 value->be16 = flow->vlan_tci;
714 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
717 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
720 case MFF_DL_VLAN_PCP:
722 value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
726 value->be32 = htonl(mpls_lse_to_label(flow->mpls_lse[0]));
730 value->u8 = mpls_lse_to_tc(flow->mpls_lse[0]);
734 value->u8 = mpls_lse_to_bos(flow->mpls_lse[0]);
738 value->be32 = flow->nw_src;
742 value->be32 = flow->nw_dst;
746 value->ipv6 = flow->ipv6_src;
750 value->ipv6 = flow->ipv6_dst;
754 value->be32 = flow->ipv6_label;
758 value->u8 = flow->nw_proto;
762 value->u8 = flow->nw_tos & IP_DSCP_MASK;
765 case MFF_IP_DSCP_SHIFTED:
766 value->u8 = flow->nw_tos >> 2;
770 value->u8 = flow->nw_tos & IP_ECN_MASK;
774 value->u8 = flow->nw_ttl;
778 value->u8 = flow->nw_frag;
782 value->be16 = htons(flow->nw_proto);
786 value->be32 = flow->nw_src;
790 value->be32 = flow->nw_dst;
795 value->mac = flow->arp_sha;
800 value->mac = flow->arp_tha;
806 value->be16 = flow->tp_src;
812 value->be16 = flow->tp_dst;
816 value->be16 = flow->tcp_flags;
819 case MFF_ICMPV4_TYPE:
820 case MFF_ICMPV6_TYPE:
821 value->u8 = ntohs(flow->tp_src);
824 case MFF_ICMPV4_CODE:
825 case MFF_ICMPV6_CODE:
826 value->u8 = ntohs(flow->tp_dst);
830 value->ipv6 = flow->nd_target;
839 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
840 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
843 * If non-NULL, 'err_str' returns a malloc'ed string describing any errors
844 * with the request or NULL if there is no error. The caller is reponsible
845 * for freeing the string. */
847 mf_set_value(const struct mf_field *mf,
848 const union mf_value *value, struct match *match, char **err_str)
856 match_set_dp_hash(match, ntohl(value->be32));
859 match_set_recirc_id(match, ntohl(value->be32));
862 match_set_conj_id(match, ntohl(value->be32));
865 match_set_tun_id(match, value->be64);
868 match_set_tun_src(match, value->be32);
871 match_set_tun_dst(match, value->be32);
873 case MFF_TUN_IPV6_SRC:
874 match_set_tun_ipv6_src(match, &value->ipv6);
876 case MFF_TUN_IPV6_DST:
877 match_set_tun_ipv6_dst(match, &value->ipv6);
880 match_set_tun_flags(match, ntohs(value->be16));
883 match_set_tun_gbp_id(match, value->be16);
885 case MFF_TUN_GBP_FLAGS:
886 match_set_tun_gbp_flags(match, value->u8);
889 match_set_tun_tos(match, value->u8);
892 match_set_tun_ttl(match, value->u8);
894 CASE_MFF_TUN_METADATA:
895 tun_metadata_set_match(mf, value, NULL, match, err_str);
899 match_set_metadata(match, value->be64);
903 match_set_in_port(match, u16_to_ofp(ntohs(value->be16)));
906 case MFF_IN_PORT_OXM: {
908 ofputil_port_from_ofp11(value->be32, &port);
909 match_set_in_port(match, port);
912 case MFF_ACTSET_OUTPUT: {
914 ofputil_port_from_ofp11(value->be32, &port);
915 match_set_actset_output(match, port);
919 case MFF_SKB_PRIORITY:
920 match_set_skb_priority(match, ntohl(value->be32));
924 match_set_pkt_mark(match, ntohl(value->be32));
928 match_set_ct_state(match, ntohl(value->be32));
932 match_set_ct_zone(match, ntohs(value->be16));
936 match_set_ct_mark(match, ntohl(value->be32));
940 match_set_ct_label(match, ntoh128(value->be128));
944 match_set_reg(match, mf->id - MFF_REG0, ntohl(value->be32));
948 match_set_xreg(match, mf->id - MFF_XREG0, ntohll(value->be64));
952 match_set_dl_src(match, value->mac);
956 match_set_dl_dst(match, value->mac);
960 match_set_dl_type(match, value->be16);
964 match_set_dl_tci(match, value->be16);
968 match_set_dl_vlan(match, value->be16);
971 match_set_vlan_vid(match, value->be16);
974 case MFF_DL_VLAN_PCP:
976 match_set_dl_vlan_pcp(match, value->u8);
980 match_set_mpls_label(match, 0, value->be32);
984 match_set_mpls_tc(match, 0, value->u8);
988 match_set_mpls_bos(match, 0, value->u8);
992 match_set_nw_src(match, value->be32);
996 match_set_nw_dst(match, value->be32);
1000 match_set_ipv6_src(match, &value->ipv6);
1004 match_set_ipv6_dst(match, &value->ipv6);
1007 case MFF_IPV6_LABEL:
1008 match_set_ipv6_label(match, value->be32);
1012 match_set_nw_proto(match, value->u8);
1016 match_set_nw_dscp(match, value->u8);
1019 case MFF_IP_DSCP_SHIFTED:
1020 match_set_nw_dscp(match, value->u8 << 2);
1024 match_set_nw_ecn(match, value->u8);
1028 match_set_nw_ttl(match, value->u8);
1032 match_set_nw_frag(match, value->u8);
1036 match_set_nw_proto(match, ntohs(value->be16));
1040 match_set_nw_src(match, value->be32);
1044 match_set_nw_dst(match, value->be32);
1049 match_set_arp_sha(match, value->mac);
1054 match_set_arp_tha(match, value->mac);
1060 match_set_tp_src(match, value->be16);
1066 match_set_tp_dst(match, value->be16);
1070 match_set_tcp_flags(match, value->be16);
1073 case MFF_ICMPV4_TYPE:
1074 case MFF_ICMPV6_TYPE:
1075 match_set_icmp_type(match, value->u8);
1078 case MFF_ICMPV4_CODE:
1079 case MFF_ICMPV6_CODE:
1080 match_set_icmp_code(match, value->u8);
1084 match_set_nd_target(match, &value->ipv6);
1093 /* Unwildcard 'mask' member field described by 'mf'. The caller is
1094 * responsible for ensuring that 'mask' meets 'mf''s prerequisites. */
1096 mf_mask_field(const struct mf_field *mf, struct flow *mask)
1098 /* For MFF_DL_VLAN, we cannot send a all 1's to flow_set_dl_vlan()
1099 * as that will be considered as OFP10_VLAN_NONE. So consider it as a
1100 * special case. For the rest, calling mf_set_flow_value() is good
1102 if (mf->id == MFF_DL_VLAN) {
1103 flow_set_dl_vlan(mask, htons(VLAN_VID_MASK));
1105 mf_set_flow_value(mf, &exact_match_mask, mask);
1110 field_len(const struct mf_field *mf, const union mf_value *value_)
1112 const uint8_t *value = &value_->u8;
1115 if (!mf->variable_len) {
1123 for (i = 0; i < mf->n_bytes; i++) {
1124 if (value[i] != 0) {
1129 return mf->n_bytes - i;
1132 /* Returns the effective length of the field. For fixed length fields,
1133 * this is just the defined length. For variable length fields, it is
1134 * the minimum size encoding that retains the same meaning (i.e.
1135 * discarding leading zeros).
1137 * 'is_masked' returns (if non-NULL) whether the original contained
1138 * a mask. Otherwise, a mask that is the same length as the value
1139 * might be misinterpreted as an exact match. */
1141 mf_field_len(const struct mf_field *mf, const union mf_value *value,
1142 const union mf_value *mask, bool *is_masked_)
1145 bool is_masked = mask && !is_all_ones(mask, mf->n_bytes);
1147 len = field_len(mf, value);
1149 mask_len = field_len(mf, mask);
1150 len = MAX(len, mask_len);
1154 *is_masked_ = is_masked;
1160 /* Sets 'flow' member field described by 'mf' to 'value'. The caller is
1161 * responsible for ensuring that 'flow' meets 'mf''s prerequisites.*/
1163 mf_set_flow_value(const struct mf_field *mf,
1164 const union mf_value *value, struct flow *flow)
1168 flow->dp_hash = ntohl(value->be32);
1171 flow->recirc_id = ntohl(value->be32);
1174 flow->conj_id = ntohl(value->be32);
1177 flow->tunnel.tun_id = value->be64;
1180 flow->tunnel.ip_src = value->be32;
1183 flow->tunnel.ip_dst = value->be32;
1185 case MFF_TUN_IPV6_SRC:
1186 flow->tunnel.ipv6_src = value->ipv6;
1188 case MFF_TUN_IPV6_DST:
1189 flow->tunnel.ipv6_dst = value->ipv6;
1192 flow->tunnel.flags = (flow->tunnel.flags & ~FLOW_TNL_PUB_F_MASK) |
1195 case MFF_TUN_GBP_ID:
1196 flow->tunnel.gbp_id = value->be16;
1198 case MFF_TUN_GBP_FLAGS:
1199 flow->tunnel.gbp_flags = value->u8;
1202 flow->tunnel.ip_tos = value->u8;
1205 flow->tunnel.ip_ttl = value->u8;
1207 CASE_MFF_TUN_METADATA:
1208 tun_metadata_write(&flow->tunnel, mf, value);
1211 flow->metadata = value->be64;
1215 flow->in_port.ofp_port = u16_to_ofp(ntohs(value->be16));
1218 case MFF_IN_PORT_OXM:
1219 ofputil_port_from_ofp11(value->be32, &flow->in_port.ofp_port);
1221 case MFF_ACTSET_OUTPUT:
1222 ofputil_port_from_ofp11(value->be32, &flow->actset_output);
1225 case MFF_SKB_PRIORITY:
1226 flow->skb_priority = ntohl(value->be32);
1230 flow->pkt_mark = ntohl(value->be32);
1234 flow->ct_state = ntohl(value->be32);
1238 flow->ct_zone = ntohs(value->be16);
1242 flow->ct_mark = ntohl(value->be32);
1246 flow->ct_label = ntoh128(value->be128);
1250 flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1254 flow_set_xreg(flow, mf->id - MFF_XREG0, ntohll(value->be64));
1258 flow->dl_src = value->mac;
1262 flow->dl_dst = value->mac;
1266 flow->dl_type = value->be16;
1270 flow->vlan_tci = value->be16;
1274 flow_set_dl_vlan(flow, value->be16);
1277 flow_set_vlan_vid(flow, value->be16);
1280 case MFF_DL_VLAN_PCP:
1282 flow_set_vlan_pcp(flow, value->u8);
1285 case MFF_MPLS_LABEL:
1286 flow_set_mpls_label(flow, 0, value->be32);
1290 flow_set_mpls_tc(flow, 0, value->u8);
1294 flow_set_mpls_bos(flow, 0, value->u8);
1298 flow->nw_src = value->be32;
1302 flow->nw_dst = value->be32;
1306 flow->ipv6_src = value->ipv6;
1310 flow->ipv6_dst = value->ipv6;
1313 case MFF_IPV6_LABEL:
1314 flow->ipv6_label = value->be32 & htonl(IPV6_LABEL_MASK);
1318 flow->nw_proto = value->u8;
1322 flow->nw_tos &= ~IP_DSCP_MASK;
1323 flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1326 case MFF_IP_DSCP_SHIFTED:
1327 flow->nw_tos &= ~IP_DSCP_MASK;
1328 flow->nw_tos |= value->u8 << 2;
1332 flow->nw_tos &= ~IP_ECN_MASK;
1333 flow->nw_tos |= value->u8 & IP_ECN_MASK;
1337 flow->nw_ttl = value->u8;
1341 flow->nw_frag = value->u8 & FLOW_NW_FRAG_MASK;
1345 flow->nw_proto = ntohs(value->be16);
1349 flow->nw_src = value->be32;
1353 flow->nw_dst = value->be32;
1358 flow->arp_sha = value->mac;
1363 flow->arp_tha = value->mac;
1369 flow->tp_src = value->be16;
1375 flow->tp_dst = value->be16;
1379 flow->tcp_flags = value->be16;
1382 case MFF_ICMPV4_TYPE:
1383 case MFF_ICMPV6_TYPE:
1384 flow->tp_src = htons(value->u8);
1387 case MFF_ICMPV4_CODE:
1388 case MFF_ICMPV6_CODE:
1389 flow->tp_dst = htons(value->u8);
1393 flow->nd_target = value->ipv6;
1402 /* Consider each of 'src', 'mask', and 'dst' as if they were arrays of 8*n
1403 * bits. Then, for each 0 <= i < 8 * n such that mask[i] == 1, sets dst[i] =
1406 apply_mask(const uint8_t *src, const uint8_t *mask, uint8_t *dst, size_t n)
1410 for (i = 0; i < n; i++) {
1411 dst[i] = (src[i] & mask[i]) | (dst[i] & ~mask[i]);
1415 /* Sets 'flow' member field described by 'field' to 'value', except that bits
1416 * for which 'mask' has a 0-bit keep their existing values. The caller is
1417 * responsible for ensuring that 'flow' meets 'field''s prerequisites.*/
1419 mf_set_flow_value_masked(const struct mf_field *field,
1420 const union mf_value *value,
1421 const union mf_value *mask,
1426 mf_get_value(field, flow, &tmp);
1427 apply_mask((const uint8_t *) value, (const uint8_t *) mask,
1428 (uint8_t *) &tmp, field->n_bytes);
1429 mf_set_flow_value(field, &tmp, flow);
1433 mf_is_tun_metadata(const struct mf_field *mf)
1435 return mf->id >= MFF_TUN_METADATA0 &&
1436 mf->id < MFF_TUN_METADATA0 + TUN_METADATA_NUM_OPTS;
1439 /* Returns true if 'mf' has previously been set in 'flow', false if
1440 * it contains a non-default value.
1442 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1445 mf_is_set(const struct mf_field *mf, const struct flow *flow)
1447 if (!mf_is_tun_metadata(mf)) {
1448 union mf_value value;
1450 mf_get_value(mf, flow, &value);
1451 return !is_all_zeros(&value, mf->n_bytes);
1453 return ULLONG_GET(flow->tunnel.metadata.present.map,
1454 mf->id - MFF_TUN_METADATA0);
1458 /* Makes 'match' wildcard field 'mf'.
1460 * The caller is responsible for ensuring that 'match' meets 'mf''s
1463 * If non-NULL, 'err_str' returns a malloc'ed string describing any errors
1464 * with the request or NULL if there is no error. The caller is reponsible
1465 * for freeing the string. */
1467 mf_set_wild(const struct mf_field *mf, struct match *match, char **err_str)
1475 match->flow.dp_hash = 0;
1476 match->wc.masks.dp_hash = 0;
1479 match->flow.recirc_id = 0;
1480 match->wc.masks.recirc_id = 0;
1483 match->flow.conj_id = 0;
1484 match->wc.masks.conj_id = 0;
1487 match_set_tun_id_masked(match, htonll(0), htonll(0));
1490 match_set_tun_src_masked(match, htonl(0), htonl(0));
1493 match_set_tun_dst_masked(match, htonl(0), htonl(0));
1495 case MFF_TUN_IPV6_SRC:
1496 memset(&match->wc.masks.tunnel.ipv6_src, 0,
1497 sizeof match->wc.masks.tunnel.ipv6_src);
1498 memset(&match->flow.tunnel.ipv6_src, 0,
1499 sizeof match->flow.tunnel.ipv6_src);
1501 case MFF_TUN_IPV6_DST:
1502 memset(&match->wc.masks.tunnel.ipv6_dst, 0,
1503 sizeof match->wc.masks.tunnel.ipv6_dst);
1504 memset(&match->flow.tunnel.ipv6_dst, 0,
1505 sizeof match->flow.tunnel.ipv6_dst);
1508 match_set_tun_flags_masked(match, 0, 0);
1510 case MFF_TUN_GBP_ID:
1511 match_set_tun_gbp_id_masked(match, 0, 0);
1513 case MFF_TUN_GBP_FLAGS:
1514 match_set_tun_gbp_flags_masked(match, 0, 0);
1517 match_set_tun_tos_masked(match, 0, 0);
1520 match_set_tun_ttl_masked(match, 0, 0);
1522 CASE_MFF_TUN_METADATA:
1523 tun_metadata_set_match(mf, NULL, NULL, match, err_str);
1527 match_set_metadata_masked(match, htonll(0), htonll(0));
1531 case MFF_IN_PORT_OXM:
1532 match->flow.in_port.ofp_port = 0;
1533 match->wc.masks.in_port.ofp_port = 0;
1535 case MFF_ACTSET_OUTPUT:
1536 match->flow.actset_output = 0;
1537 match->wc.masks.actset_output = 0;
1540 case MFF_SKB_PRIORITY:
1541 match->flow.skb_priority = 0;
1542 match->wc.masks.skb_priority = 0;
1546 match->flow.pkt_mark = 0;
1547 match->wc.masks.pkt_mark = 0;
1551 match->flow.ct_state = 0;
1552 match->wc.masks.ct_state = 0;
1556 match->flow.ct_zone = 0;
1557 match->wc.masks.ct_zone = 0;
1561 match->flow.ct_mark = 0;
1562 match->wc.masks.ct_mark = 0;
1566 memset(&match->flow.ct_label, 0, sizeof(match->flow.ct_label));
1567 memset(&match->wc.masks.ct_label, 0, sizeof(match->wc.masks.ct_label));
1571 match_set_reg_masked(match, mf->id - MFF_REG0, 0, 0);
1575 match_set_xreg_masked(match, mf->id - MFF_XREG0, 0, 0);
1579 match->flow.dl_src = eth_addr_zero;
1580 match->wc.masks.dl_src = eth_addr_zero;
1584 match->flow.dl_dst = eth_addr_zero;
1585 match->wc.masks.dl_dst = eth_addr_zero;
1589 match->flow.dl_type = htons(0);
1590 match->wc.masks.dl_type = htons(0);
1594 match_set_dl_tci_masked(match, htons(0), htons(0));
1599 match_set_any_vid(match);
1602 case MFF_DL_VLAN_PCP:
1604 match_set_any_pcp(match);
1607 case MFF_MPLS_LABEL:
1608 match_set_any_mpls_label(match, 0);
1612 match_set_any_mpls_tc(match, 0);
1616 match_set_any_mpls_bos(match, 0);
1621 match_set_nw_src_masked(match, htonl(0), htonl(0));
1626 match_set_nw_dst_masked(match, htonl(0), htonl(0));
1630 memset(&match->wc.masks.ipv6_src, 0, sizeof match->wc.masks.ipv6_src);
1631 memset(&match->flow.ipv6_src, 0, sizeof match->flow.ipv6_src);
1635 memset(&match->wc.masks.ipv6_dst, 0, sizeof match->wc.masks.ipv6_dst);
1636 memset(&match->flow.ipv6_dst, 0, sizeof match->flow.ipv6_dst);
1639 case MFF_IPV6_LABEL:
1640 match->wc.masks.ipv6_label = htonl(0);
1641 match->flow.ipv6_label = htonl(0);
1645 match->wc.masks.nw_proto = 0;
1646 match->flow.nw_proto = 0;
1650 case MFF_IP_DSCP_SHIFTED:
1651 match->wc.masks.nw_tos &= ~IP_DSCP_MASK;
1652 match->flow.nw_tos &= ~IP_DSCP_MASK;
1656 match->wc.masks.nw_tos &= ~IP_ECN_MASK;
1657 match->flow.nw_tos &= ~IP_ECN_MASK;
1661 match->wc.masks.nw_ttl = 0;
1662 match->flow.nw_ttl = 0;
1666 match->wc.masks.nw_frag &= ~FLOW_NW_FRAG_MASK;
1667 match->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1671 match->wc.masks.nw_proto = 0;
1672 match->flow.nw_proto = 0;
1677 match->flow.arp_sha = eth_addr_zero;
1678 match->wc.masks.arp_sha = eth_addr_zero;
1683 match->flow.arp_tha = eth_addr_zero;
1684 match->wc.masks.arp_tha = eth_addr_zero;
1690 case MFF_ICMPV4_TYPE:
1691 case MFF_ICMPV6_TYPE:
1692 match->wc.masks.tp_src = htons(0);
1693 match->flow.tp_src = htons(0);
1699 case MFF_ICMPV4_CODE:
1700 case MFF_ICMPV6_CODE:
1701 match->wc.masks.tp_dst = htons(0);
1702 match->flow.tp_dst = htons(0);
1706 match->wc.masks.tcp_flags = htons(0);
1707 match->flow.tcp_flags = htons(0);
1711 memset(&match->wc.masks.nd_target, 0,
1712 sizeof match->wc.masks.nd_target);
1713 memset(&match->flow.nd_target, 0, sizeof match->flow.nd_target);
1722 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
1723 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1724 * with a 1-bit indicating that the corresponding value bit must match and a
1725 * 0-bit indicating a don't-care.
1727 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1728 * mf_set_value(mf, value, match). If 'mask' points to all-0-bits, then this
1729 * call is equivalent to mf_set_wild(mf, match).
1731 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
1732 * is responsible for ensuring that 'match' meets 'mf''s prerequisites.
1734 * If non-NULL, 'err_str' returns a malloc'ed string describing any errors
1735 * with the request or NULL if there is no error. The caller is reponsible
1736 * for freeing the string.
1738 * Return a set of enum ofputil_protocol bits (as an uint32_t to avoid circular
1739 * dependency on enum ofputil_protocol definition) indicating which OpenFlow
1740 * protocol versions can support this functionality. */
1742 mf_set(const struct mf_field *mf,
1743 const union mf_value *value, const union mf_value *mask,
1744 struct match *match, char **err_str)
1746 if (!mask || is_all_ones(mask, mf->n_bytes)) {
1747 mf_set_value(mf, value, match, err_str);
1748 return mf->usable_protocols_exact;
1749 } else if (is_all_zeros(mask, mf->n_bytes) && !mf_is_tun_metadata(mf)) {
1750 /* Tunnel metadata matches on the existence of the field itself, so
1751 * it still needs to be encoded even if the value is wildcarded. */
1752 mf_set_wild(mf, match, err_str);
1753 return OFPUTIL_P_ANY;
1765 case MFF_IN_PORT_OXM:
1766 case MFF_ACTSET_OUTPUT:
1767 case MFF_SKB_PRIORITY:
1770 case MFF_DL_VLAN_PCP:
1772 case MFF_MPLS_LABEL:
1778 case MFF_IP_DSCP_SHIFTED:
1781 case MFF_ICMPV4_TYPE:
1782 case MFF_ICMPV4_CODE:
1783 case MFF_ICMPV6_TYPE:
1784 case MFF_ICMPV6_CODE:
1785 return OFPUTIL_P_NONE;
1788 match_set_dp_hash_masked(match, ntohl(value->be32), ntohl(mask->be32));
1791 match_set_tun_id_masked(match, value->be64, mask->be64);
1794 match_set_tun_src_masked(match, value->be32, mask->be32);
1797 match_set_tun_dst_masked(match, value->be32, mask->be32);
1799 case MFF_TUN_IPV6_SRC:
1800 match_set_tun_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
1802 case MFF_TUN_IPV6_DST:
1803 match_set_tun_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
1806 match_set_tun_flags_masked(match, ntohs(value->be16), ntohs(mask->be16));
1808 case MFF_TUN_GBP_ID:
1809 match_set_tun_gbp_id_masked(match, value->be16, mask->be16);
1811 case MFF_TUN_GBP_FLAGS:
1812 match_set_tun_gbp_flags_masked(match, value->u8, mask->u8);
1815 match_set_tun_ttl_masked(match, value->u8, mask->u8);
1818 match_set_tun_tos_masked(match, value->u8, mask->u8);
1820 CASE_MFF_TUN_METADATA:
1821 tun_metadata_set_match(mf, value, mask, match, err_str);
1825 match_set_metadata_masked(match, value->be64, mask->be64);
1829 match_set_reg_masked(match, mf->id - MFF_REG0,
1830 ntohl(value->be32), ntohl(mask->be32));
1834 match_set_xreg_masked(match, mf->id - MFF_XREG0,
1835 ntohll(value->be64), ntohll(mask->be64));
1839 match_set_pkt_mark_masked(match, ntohl(value->be32),
1844 match_set_ct_state_masked(match, ntohl(value->be32), ntohl(mask->be32));
1848 match_set_ct_mark_masked(match, ntohl(value->be32), ntohl(mask->be32));
1852 match_set_ct_label_masked(match, ntoh128(value->be128),
1853 mask ? ntoh128(mask->be128) : OVS_U128_MAX);
1857 match_set_dl_dst_masked(match, value->mac, mask->mac);
1861 match_set_dl_src_masked(match, value->mac, mask->mac);
1866 match_set_arp_sha_masked(match, value->mac, mask->mac);
1871 match_set_arp_tha_masked(match, value->mac, mask->mac);
1875 match_set_dl_tci_masked(match, value->be16, mask->be16);
1879 match_set_vlan_vid_masked(match, value->be16, mask->be16);
1883 match_set_nw_src_masked(match, value->be32, mask->be32);
1887 match_set_nw_dst_masked(match, value->be32, mask->be32);
1891 match_set_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
1895 match_set_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
1898 case MFF_IPV6_LABEL:
1899 if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
1900 mf_set_value(mf, value, match, err_str);
1902 match_set_ipv6_label_masked(match, value->be32, mask->be32);
1907 match_set_nd_target_masked(match, &value->ipv6, &mask->ipv6);
1911 match_set_nw_frag_masked(match, value->u8, mask->u8);
1915 match_set_nw_src_masked(match, value->be32, mask->be32);
1919 match_set_nw_dst_masked(match, value->be32, mask->be32);
1925 match_set_tp_src_masked(match, value->be16, mask->be16);
1931 match_set_tp_dst_masked(match, value->be16, mask->be16);
1935 match_set_tcp_flags_masked(match, value->be16, mask->be16);
1943 return ((mf->usable_protocols_bitwise == mf->usable_protocols_cidr
1944 || ip_is_cidr(mask->be32))
1945 ? mf->usable_protocols_cidr
1946 : mf->usable_protocols_bitwise);
1950 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
1954 VLOG_WARN_RL(&rl, "unknown %s field", type);
1955 return OFPERR_OFPBAC_BAD_SET_TYPE;
1956 } else if (!sf->n_bits) {
1957 VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
1958 return OFPERR_OFPBAC_BAD_SET_LEN;
1959 } else if (sf->ofs >= sf->field->n_bits) {
1960 VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
1961 sf->ofs, sf->field->n_bits, type, sf->field->name);
1962 return OFPERR_OFPBAC_BAD_SET_LEN;
1963 } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
1964 VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
1965 "of %s field %s", sf->ofs, sf->n_bits,
1966 sf->field->n_bits, type, sf->field->name);
1967 return OFPERR_OFPBAC_BAD_SET_LEN;
1968 } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
1969 VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
1970 type, sf->field->name);
1971 return OFPERR_OFPBAC_MATCH_INCONSISTENT;
1977 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
1978 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
1981 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
1983 return mf_check__(sf, flow, "source");
1986 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
1987 * if so, otherwise an OpenFlow error code (e.g. as returned by
1990 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
1992 int error = mf_check__(sf, flow, "destination");
1993 if (!error && !sf->field->writable) {
1994 VLOG_WARN_RL(&rl, "destination field %s is not writable",
1996 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
2001 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
2002 * 'value' and 'mask', respectively. */
2004 mf_get(const struct mf_field *mf, const struct match *match,
2005 union mf_value *value, union mf_value *mask)
2007 mf_get_value(mf, &match->flow, value);
2008 mf_get_mask(mf, &match->wc, mask);
2012 mf_from_integer_string(const struct mf_field *mf, const char *s,
2013 uint8_t *valuep, uint8_t *maskp)
2016 const char *err_str = "";
2019 err = parse_int_string(s, valuep, mf->n_bytes, &tail);
2020 if (err || (*tail != '\0' && *tail != '/')) {
2026 err = parse_int_string(tail + 1, maskp, mf->n_bytes, &tail);
2027 if (err || *tail != '\0') {
2032 memset(maskp, 0xff, mf->n_bytes);
2038 if (err == ERANGE) {
2039 return xasprintf("%s: %s too large for %u-byte field %s",
2040 s, err_str, mf->n_bytes, mf->name);
2042 return xasprintf("%s: bad syntax for %s %s", s, mf->name, err_str);
2047 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
2048 struct eth_addr *mac, struct eth_addr *mask)
2052 ovs_assert(mf->n_bytes == ETH_ADDR_LEN);
2055 if (ovs_scan(s, ETH_ADDR_SCAN_FMT"%n", ETH_ADDR_SCAN_ARGS(*mac), &n)
2056 && n == strlen(s)) {
2057 *mask = eth_addr_exact;
2062 if (ovs_scan(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT"%n",
2063 ETH_ADDR_SCAN_ARGS(*mac), ETH_ADDR_SCAN_ARGS(*mask), &n)
2064 && n == strlen(s)) {
2068 return xasprintf("%s: invalid Ethernet address", s);
2072 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
2073 ovs_be32 *ip, ovs_be32 *mask)
2075 ovs_assert(mf->n_bytes == sizeof *ip);
2076 return ip_parse_masked(s, ip, mask);
2080 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
2081 struct in6_addr *ipv6, struct in6_addr *mask)
2083 ovs_assert(mf->n_bytes == sizeof *ipv6);
2084 return ipv6_parse_masked(s, ipv6, mask);
2088 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
2089 ovs_be16 *valuep, ovs_be16 *maskp)
2093 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2095 if (ofputil_port_from_string(s, &port)) {
2096 *valuep = htons(ofp_to_u16(port));
2097 *maskp = OVS_BE16_MAX;
2100 return xasprintf("%s: port value out of range for %s", s, mf->name);
2104 mf_from_ofp_port_string32(const struct mf_field *mf, const char *s,
2105 ovs_be32 *valuep, ovs_be32 *maskp)
2109 ovs_assert(mf->n_bytes == sizeof(ovs_be32));
2110 if (ofputil_port_from_string(s, &port)) {
2111 *valuep = ofputil_port_to_ofp11(port);
2112 *maskp = OVS_BE32_MAX;
2115 return xasprintf("%s: port value out of range for %s", s, mf->name);
2118 struct frag_handling {
2124 static const struct frag_handling all_frags[] = {
2125 #define A FLOW_NW_FRAG_ANY
2126 #define L FLOW_NW_FRAG_LATER
2127 /* name mask value */
2130 { "first", A|L, A },
2131 { "later", A|L, A|L },
2136 { "not_later", L, 0 },
2143 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
2145 const struct frag_handling *h;
2147 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2148 if (!strcasecmp(s, h->name)) {
2149 /* We force the upper bits of the mask on to make mf_parse_value()
2150 * happy (otherwise it will never think it's an exact match.) */
2151 *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
2157 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2158 "\"yes\", \"first\", \"later\", \"not_first\"", s);
2162 parse_mf_flags(const char *s, const char *(*bit_to_string)(uint32_t),
2163 const char *field_name, ovs_be16 *flagsp, ovs_be16 allowed,
2168 uint32_t flags, mask;
2170 err = parse_flags(s, bit_to_string, '\0', field_name, &err_str,
2171 &flags, ntohs(allowed), maskp ? &mask : NULL);
2176 *flagsp = htons(flags);
2178 *maskp = htons(mask);
2185 mf_from_tcp_flags_string(const char *s, ovs_be16 *flagsp, ovs_be16 *maskp)
2187 return parse_mf_flags(s, packet_tcp_flag_to_string, "TCP", flagsp,
2188 TCP_FLAGS_BE16(OVS_BE16_MAX), maskp);
2192 mf_from_tun_flags_string(const char *s, ovs_be16 *flagsp, ovs_be16 *maskp)
2194 return parse_mf_flags(s, flow_tun_flag_to_string, "tunnel", flagsp,
2195 htons(FLOW_TNL_PUB_F_MASK), maskp);
2199 mf_from_ct_state_string(const char *s, ovs_be32 *flagsp, ovs_be32 *maskp)
2203 uint32_t flags, mask;
2205 err = parse_flags(s, ct_state_to_string, '\0', "ct_state", &err_str,
2206 &flags, CS_SUPPORTED_MASK, maskp ? &mask : NULL);
2211 *flagsp = htonl(flags);
2213 *maskp = htonl(mask);
2219 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2220 * NULL if successful, otherwise a malloc()'d string describing the error. */
2222 mf_parse(const struct mf_field *mf, const char *s,
2223 union mf_value *value, union mf_value *mask)
2227 if (!strcmp(s, "*")) {
2228 memset(value, 0, mf->n_bytes);
2229 memset(mask, 0, mf->n_bytes);
2233 switch (mf->string) {
2235 case MFS_HEXADECIMAL:
2236 error = mf_from_integer_string(mf, s,
2237 (uint8_t *) value, (uint8_t *) mask);
2241 ovs_assert(mf->n_bytes == sizeof(ovs_be32));
2242 error = mf_from_ct_state_string(s, &value->be32, &mask->be32);
2246 error = mf_from_ethernet_string(mf, s, &value->mac, &mask->mac);
2250 error = mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
2254 error = mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
2258 error = mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
2261 case MFS_OFP_PORT_OXM:
2262 error = mf_from_ofp_port_string32(mf, s, &value->be32, &mask->be32);
2266 error = mf_from_frag_string(s, &value->u8, &mask->u8);
2270 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2271 error = mf_from_tun_flags_string(s, &value->be16, &mask->be16);
2275 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2276 error = mf_from_tcp_flags_string(s, &value->be16, &mask->be16);
2283 if (!error && !mf_is_mask_valid(mf, mask)) {
2284 error = xasprintf("%s: invalid mask for field %s", s, mf->name);
2289 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2290 * successful, otherwise a malloc()'d string describing the error. */
2292 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2294 union mf_value mask;
2297 error = mf_parse(mf, s, value, &mask);
2302 if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2303 return xasprintf("%s: wildcards not allowed here", s);
2309 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2310 const uint8_t *maskp, struct ds *s)
2312 if (mf->string == MFS_HEXADECIMAL) {
2313 ds_put_hex(s, valuep, mf->n_bytes);
2315 unsigned long long int integer = 0;
2318 ovs_assert(mf->n_bytes <= 8);
2319 for (i = 0; i < mf->n_bytes; i++) {
2320 integer = (integer << 8) | valuep[i];
2322 ds_put_format(s, "%lld", integer);
2326 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2327 * not sure that that a bit-mask written in decimal is ever easier to
2328 * understand than the same bit-mask written in hexadecimal. */
2329 ds_put_char(s, '/');
2330 ds_put_hex(s, maskp, mf->n_bytes);
2335 mf_format_frag_string(uint8_t value, uint8_t mask, struct ds *s)
2337 const struct frag_handling *h;
2339 mask &= FLOW_NW_FRAG_MASK;
2342 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2343 if (value == h->value && mask == h->mask) {
2344 ds_put_cstr(s, h->name);
2348 ds_put_cstr(s, "<error>");
2352 mf_format_tnl_flags_string(ovs_be16 value, ovs_be16 mask, struct ds *s)
2354 format_flags_masked(s, NULL, flow_tun_flag_to_string, ntohs(value),
2355 ntohs(mask) & FLOW_TNL_PUB_F_MASK, FLOW_TNL_PUB_F_MASK);
2359 mf_format_tcp_flags_string(ovs_be16 value, ovs_be16 mask, struct ds *s)
2361 format_flags_masked(s, NULL, packet_tcp_flag_to_string, ntohs(value),
2362 TCP_FLAGS(mask), TCP_FLAGS(OVS_BE16_MAX));
2366 mf_format_ct_state_string(ovs_be32 value, ovs_be32 mask, struct ds *s)
2368 format_flags_masked(s, NULL, ct_state_to_string, ntohl(value),
2369 ntohl(mask), UINT16_MAX);
2372 /* Appends to 's' a string representation of field 'mf' whose value is in
2373 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2375 mf_format(const struct mf_field *mf,
2376 const union mf_value *value, const union mf_value *mask,
2380 if (is_all_zeros(mask, mf->n_bytes)) {
2381 ds_put_cstr(s, "ANY");
2383 } else if (is_all_ones(mask, mf->n_bytes)) {
2388 switch (mf->string) {
2389 case MFS_OFP_PORT_OXM:
2392 ofputil_port_from_ofp11(value->be32, &port);
2393 ofputil_format_port(port, s);
2399 ofputil_format_port(u16_to_ofp(ntohs(value->be16)), s);
2404 case MFS_HEXADECIMAL:
2405 mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2409 mf_format_ct_state_string(value->be32,
2410 mask ? mask->be32 : OVS_BE32_MAX, s);
2414 eth_format_masked(value->mac, mask ? &mask->mac : NULL, s);
2418 ip_format_masked(value->be32, mask ? mask->be32 : OVS_BE32_MAX, s);
2422 ipv6_format_masked(&value->ipv6, mask ? &mask->ipv6 : NULL, s);
2426 mf_format_frag_string(value->u8, mask ? mask->u8 : UINT8_MAX, s);
2430 mf_format_tnl_flags_string(value->be16,
2431 mask ? mask->be16 : OVS_BE16_MAX, s);
2435 mf_format_tcp_flags_string(value->be16,
2436 mask ? mask->be16 : OVS_BE16_MAX, s);
2444 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2445 * least-significant bits in 'x'.
2448 mf_write_subfield_flow(const struct mf_subfield *sf,
2449 const union mf_subvalue *x, struct flow *flow)
2451 const struct mf_field *field = sf->field;
2452 union mf_value value;
2454 mf_get_value(field, flow, &value);
2455 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes,
2456 sf->ofs, sf->n_bits);
2457 mf_set_flow_value(field, &value, flow);
2460 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2461 * least-significant bits in 'x'.
2464 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2465 struct match *match)
2467 const struct mf_field *field = sf->field;
2468 union mf_value value, mask;
2470 mf_get(field, match, &value, &mask);
2471 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2472 bitwise_one ( &mask, field->n_bytes, sf->ofs, sf->n_bits);
2473 mf_set(field, &value, &mask, match, NULL);
2476 /* 'v' and 'm' correspond to values of 'field'. This function copies them into
2477 * 'match' in the correspond positions. */
2479 mf_mask_subfield(const struct mf_field *field,
2480 const union mf_subvalue *v,
2481 const union mf_subvalue *m,
2482 struct match *match)
2484 union mf_value value, mask;
2486 mf_get(field, match, &value, &mask);
2487 bitwise_copy(v, sizeof *v, 0, &value, field->n_bytes, 0, field->n_bits);
2488 bitwise_copy(m, sizeof *m, 0, &mask, field->n_bytes, 0, field->n_bits);
2489 mf_set(field, &value, &mask, match, NULL);
2492 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2493 * reading 'flow', e.g. as checked by mf_check_src(). */
2495 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2496 union mf_subvalue *x)
2498 union mf_value value;
2500 mf_get_value(sf->field, flow, &value);
2502 memset(x, 0, sizeof *x);
2503 bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2508 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2509 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2512 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2514 union mf_value value;
2516 mf_get_value(sf->field, flow, &value);
2517 return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2521 mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s)
2523 ds_put_hex(s, subvalue->u8, sizeof subvalue->u8);
2527 field_array_set(enum mf_field_id id, const union mf_value *value,
2528 struct field_array *fa)
2530 ovs_assert(id < MFF_N_IDS);
2531 bitmap_set1(fa->used.bm, id);
2532 fa->value[id] = *value;