2 * Copyright (c) 2011, 2012 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "meta-flow.h"
24 #include <netinet/icmp6.h>
25 #include <netinet/ip6.h>
27 #include "classifier.h"
28 #include "dynamic-string.h"
29 #include "ofp-errors.h"
34 #include "socket-util.h"
35 #include "unaligned.h"
38 VLOG_DEFINE_THIS_MODULE(meta_flow);
40 #define MF_FIELD_SIZES(MEMBER) \
41 sizeof ((union mf_value *)0)->MEMBER, \
42 8 * sizeof ((union mf_value *)0)->MEMBER
44 static const struct mf_field mf_fields[MFF_N_IDS] = {
50 MFF_TUN_ID, "tun_id", NULL,
56 NXM_NX_TUN_ID, "NXM_NX_TUN_ID",
57 NXM_NX_TUN_ID, "NXM_NX_TUN_ID",
59 MFF_METADATA, "metadata", NULL,
65 OXM_OF_METADATA, "OXM_OF_METADATA",
66 OXM_OF_METADATA, "OXM_OF_METADATA",
68 MFF_IN_PORT, "in_port", NULL,
70 MFM_NONE, FWW_IN_PORT,
74 NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
75 OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
78 #define REGISTER(IDX) \
80 MFF_REG##IDX, "reg" #IDX, NULL, \
81 MF_FIELD_SIZES(be32), \
86 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
87 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
122 MFF_ETH_SRC, "eth_src", "dl_src",
128 NXM_OF_ETH_SRC, "NXM_OF_ETH_SRC",
129 OXM_OF_ETH_SRC, "OXM_OF_ETH_SRC",
131 MFF_ETH_DST, "eth_dst", "dl_dst",
137 NXM_OF_ETH_DST, "NXM_OF_ETH_DST",
138 OXM_OF_ETH_DST, "OXM_OF_ETH_DST",
140 MFF_ETH_TYPE, "eth_type", "dl_type",
141 MF_FIELD_SIZES(be16),
142 MFM_NONE, FWW_DL_TYPE,
146 NXM_OF_ETH_TYPE, "NXM_OF_ETH_TYPE",
147 OXM_OF_ETH_TYPE, "OXM_OF_ETH_TYPE",
151 MFF_VLAN_TCI, "vlan_tci", NULL,
152 MF_FIELD_SIZES(be16),
157 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
158 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
160 MFF_VLAN_VID, "dl_vlan", NULL,
161 sizeof(ovs_be16), 12,
166 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
167 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
169 MFF_VLAN_PCP, "dl_vlan_pcp", NULL,
175 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
176 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
184 MFF_IPV4_SRC, "ip_src", "nw_src",
185 MF_FIELD_SIZES(be32),
190 NXM_OF_IP_SRC, "NXM_OF_IP_SRC",
191 OXM_OF_IPV4_SRC, "OXM_OF_IPV4_SRC",
193 MFF_IPV4_DST, "ip_dst", "nw_dst",
194 MF_FIELD_SIZES(be32),
199 NXM_OF_IP_DST, "NXM_OF_IP_DST",
200 OXM_OF_IPV4_DST, "OXM_OF_IPV4_DST",
204 MFF_IPV6_SRC, "ipv6_src", NULL,
205 MF_FIELD_SIZES(ipv6),
210 NXM_NX_IPV6_SRC, "NXM_NX_IPV6_SRC",
211 OXM_OF_IPV6_SRC, "OXM_OF_IPV6_SRC",
213 MFF_IPV6_DST, "ipv6_dst", NULL,
214 MF_FIELD_SIZES(ipv6),
219 NXM_NX_IPV6_DST, "NXM_NX_IPV6_DST",
220 OXM_OF_IPV6_DST, "OXM_OF_IPV6_DST",
223 MFF_IPV6_LABEL, "ipv6_label", NULL,
225 MFM_NONE, FWW_IPV6_LABEL,
229 NXM_NX_IPV6_LABEL, "NXM_NX_IPV6_LABEL",
230 OXM_OF_IPV6_FLABEL, "OXM_OF_IPV6_FLABEL",
234 MFF_IP_PROTO, "nw_proto", NULL,
236 MFM_NONE, FWW_NW_PROTO,
240 NXM_OF_IP_PROTO, "NXM_OF_IP_PROTO",
241 OXM_OF_IP_PROTO, "OXM_OF_IP_PROTO",
243 MFF_IP_DSCP, "nw_tos", NULL,
245 MFM_NONE, FWW_NW_DSCP,
249 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
250 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
252 MFF_IP_ECN, "nw_ecn", NULL,
254 MFM_NONE, FWW_NW_ECN,
258 NXM_NX_IP_ECN, "NXM_NX_IP_ECN",
259 OXM_OF_IP_ECN, "OXM_OF_IP_ECN",
261 MFF_IP_TTL, "nw_ttl", NULL,
263 MFM_NONE, FWW_NW_TTL,
267 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
268 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
270 MFF_IP_FRAG, "ip_frag", NULL,
276 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
277 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
281 MFF_ARP_OP, "arp_op", NULL,
282 MF_FIELD_SIZES(be16),
283 MFM_NONE, FWW_NW_PROTO,
287 NXM_OF_ARP_OP, "NXM_OF_ARP_OP",
288 OXM_OF_ARP_OP, "OXM_OF_ARP_OP",
290 MFF_ARP_SPA, "arp_spa", NULL,
291 MF_FIELD_SIZES(be32),
296 NXM_OF_ARP_SPA, "NXM_OF_ARP_SPA",
297 OXM_OF_ARP_SPA, "OXM_OF_ARP_SPA",
299 MFF_ARP_TPA, "arp_tpa", NULL,
300 MF_FIELD_SIZES(be32),
305 NXM_OF_ARP_TPA, "NXM_OF_ARP_TPA",
306 OXM_OF_ARP_TPA, "OXM_OF_ARP_TPA",
308 MFF_ARP_SHA, "arp_sha", NULL,
310 MFM_NONE, FWW_ARP_SHA,
314 NXM_NX_ARP_SHA, "NXM_NX_ARP_SHA",
315 OXM_OF_ARP_SHA, "OXM_OF_ARP_SHA",
317 MFF_ARP_THA, "arp_tha", NULL,
319 MFM_NONE, FWW_ARP_THA,
323 NXM_NX_ARP_THA, "NXM_NX_ARP_THA",
324 OXM_OF_ARP_THA, "OXM_OF_ARP_THA",
332 MFF_TCP_SRC, "tcp_src", "tp_src",
333 MF_FIELD_SIZES(be16),
338 NXM_OF_TCP_SRC, "NXM_OF_TCP_SRC",
339 OXM_OF_TCP_SRC, "OXM_OF_TCP_SRC",
341 MFF_TCP_DST, "tcp_dst", "tp_dst",
342 MF_FIELD_SIZES(be16),
347 NXM_OF_TCP_DST, "NXM_OF_TCP_DST",
348 OXM_OF_TCP_DST, "OXM_OF_TCP_DST",
352 MFF_UDP_SRC, "udp_src", NULL,
353 MF_FIELD_SIZES(be16),
358 NXM_OF_UDP_SRC, "NXM_OF_UDP_SRC",
359 OXM_OF_UDP_SRC, "OXM_OF_UDP_SRC",
361 MFF_UDP_DST, "udp_dst", NULL,
362 MF_FIELD_SIZES(be16),
367 NXM_OF_UDP_DST, "NXM_OF_UDP_DST",
368 OXM_OF_UDP_DST, "OXM_OF_UDP_DST",
372 MFF_ICMPV4_TYPE, "icmp_type", NULL,
378 NXM_OF_ICMP_TYPE, "NXM_OF_ICMP_TYPE",
379 OXM_OF_ICMPV4_TYPE, "OXM_OF_ICMPV4_TYPE",
381 MFF_ICMPV4_CODE, "icmp_code", NULL,
387 NXM_OF_ICMP_CODE, "NXM_OF_ICMP_CODE",
388 OXM_OF_ICMPV4_CODE, "OXM_OF_ICMPV4_CODE",
392 MFF_ICMPV6_TYPE, "icmpv6_type", NULL,
398 NXM_NX_ICMPV6_TYPE, "NXM_NX_ICMPV6_TYPE",
399 OXM_OF_ICMPV6_TYPE, "OXM_OF_ICMPV6_TYPE",
401 MFF_ICMPV6_CODE, "icmpv6_code", NULL,
407 NXM_NX_ICMPV6_CODE, "NXM_NX_ICMPV6_CODE",
408 OXM_OF_ICMPV6_CODE, "OXM_OF_ICMPV6_CODE",
416 MFF_ND_TARGET, "nd_target", NULL,
417 MF_FIELD_SIZES(ipv6),
422 NXM_NX_ND_TARGET, "NXM_NX_ND_TARGET",
423 OXM_OF_IPV6_ND_TARGET, "OXM_OF_IPV6_ND_TARGET",
425 MFF_ND_SLL, "nd_sll", NULL,
427 MFM_NONE, FWW_ARP_SHA,
431 NXM_NX_ND_SLL, "NXM_NX_ND_SLL",
432 OXM_OF_IPV6_ND_SLL, "OXM_OF_IPV6_ND_SLL",
434 MFF_ND_TLL, "nd_tll", NULL,
436 MFM_NONE, FWW_ARP_THA,
440 NXM_NX_ND_TLL, "NXM_NX_ND_TLL",
441 OXM_OF_IPV6_ND_TLL, "OXM_OF_IPV6_ND_TLL",
445 /* Maps an NXM or OXM header value to an mf_field. */
447 struct hmap_node hmap_node; /* In 'all_fields' hmap. */
448 uint32_t header; /* NXM or OXM header value. */
449 const struct mf_field *mf;
452 /* Contains 'struct nxm_field's. */
453 static struct hmap all_fields = HMAP_INITIALIZER(&all_fields);
455 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
456 * controller and so there's not much point in showing a lot of them. */
457 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
459 const struct mf_field *mf_from_nxm_header__(uint32_t header);
461 /* Returns the field with the given 'id'. */
462 const struct mf_field *
463 mf_from_id(enum mf_field_id id)
465 assert((unsigned int) id < MFF_N_IDS);
466 return &mf_fields[id];
469 /* Returns the field with the given 'name', or a null pointer if no field has
471 const struct mf_field *
472 mf_from_name(const char *name)
474 static struct shash mf_by_name = SHASH_INITIALIZER(&mf_by_name);
476 if (shash_is_empty(&mf_by_name)) {
477 const struct mf_field *mf;
479 for (mf = mf_fields; mf < &mf_fields[MFF_N_IDS]; mf++) {
480 shash_add_once(&mf_by_name, mf->name, mf);
481 if (mf->extra_name) {
482 shash_add_once(&mf_by_name, mf->extra_name, mf);
487 return shash_find_data(&mf_by_name, name);
491 add_nxm_field(uint32_t header, const struct mf_field *mf)
495 f = xmalloc(sizeof *f);
496 hmap_insert(&all_fields, &f->hmap_node, hash_int(header, 0));
502 nxm_init_add_field(const struct mf_field *mf, uint32_t header)
505 assert(!mf_from_nxm_header__(header));
506 add_nxm_field(header, mf);
507 if (mf->maskable != MFM_NONE) {
508 add_nxm_field(NXM_MAKE_WILD_HEADER(header), mf);
516 const struct mf_field *mf;
518 for (mf = mf_fields; mf < &mf_fields[MFF_N_IDS]; mf++) {
519 nxm_init_add_field(mf, mf->nxm_header);
520 if (mf->oxm_header != mf->nxm_header) {
521 nxm_init_add_field(mf, mf->oxm_header);
526 const struct mf_field *
527 mf_from_nxm_header(uint32_t header)
529 if (hmap_is_empty(&all_fields)) {
532 return mf_from_nxm_header__(header);
535 const struct mf_field *
536 mf_from_nxm_header__(uint32_t header)
538 const struct nxm_field *f;
540 HMAP_FOR_EACH_IN_BUCKET (f, hmap_node, hash_int(header, 0), &all_fields) {
541 if (f->header == header) {
549 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
550 * specifies at least one bit in the field.
552 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
553 * meets 'mf''s prerequisites. */
555 mf_is_all_wild(const struct mf_field *mf, const struct flow_wildcards *wc)
570 assert(mf->fww_bit != 0);
571 return (wc->wildcards & mf->fww_bit) != 0;
574 return !wc->tun_id_mask;
576 return !wc->metadata_mask;
605 return !wc->reg_masks[mf->id - MFF_REG0];
608 return eth_addr_is_zero(wc->dl_src_mask);
610 return eth_addr_is_zero(wc->dl_dst_mask);
613 return !wc->vlan_tci_mask;
615 return !(wc->vlan_tci_mask & htons(VLAN_VID_MASK));
617 return !(wc->vlan_tci_mask & htons(VLAN_PCP_MASK));
620 return !wc->nw_src_mask;
622 return !wc->nw_dst_mask;
625 return ipv6_mask_is_any(&wc->ipv6_src_mask);
627 return ipv6_mask_is_any(&wc->ipv6_dst_mask);
630 return ipv6_mask_is_any(&wc->nd_target_mask);
633 return !(wc->nw_frag_mask & FLOW_NW_FRAG_MASK);
636 return !wc->nw_src_mask;
638 return !wc->nw_dst_mask;
642 case MFF_ICMPV4_TYPE:
643 case MFF_ICMPV6_TYPE:
644 return !wc->tp_src_mask;
647 case MFF_ICMPV4_CODE:
648 case MFF_ICMPV6_CODE:
649 return !wc->tp_dst_mask;
657 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
658 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
659 * purposes, or to 0 if it is wildcarded.
661 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
662 * meets 'mf''s prerequisites. */
664 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
665 union mf_value *mask)
680 assert(mf->fww_bit != 0);
681 memset(mask, wc->wildcards & mf->fww_bit ? 0x00 : 0xff, mf->n_bytes);
685 mask->be64 = wc->tun_id_mask;
688 mask->be64 = wc->metadata_mask;
718 mask->be32 = htonl(wc->reg_masks[mf->id - MFF_REG0]);
722 memcpy(mask->mac, wc->dl_dst_mask, ETH_ADDR_LEN);
726 memcpy(mask->mac, wc->dl_src_mask, ETH_ADDR_LEN);
730 mask->be16 = wc->vlan_tci_mask;
733 mask->be16 = wc->vlan_tci_mask & htons(VLAN_VID_MASK);
736 mask->u8 = vlan_tci_to_pcp(wc->vlan_tci_mask);
740 mask->be32 = wc->nw_src_mask;
743 mask->be32 = wc->nw_dst_mask;
747 mask->ipv6 = wc->ipv6_src_mask;
750 mask->ipv6 = wc->ipv6_dst_mask;
754 mask->ipv6 = wc->nd_target_mask;
758 mask->u8 = wc->nw_frag_mask & FLOW_NW_FRAG_MASK;
762 mask->be32 = wc->nw_src_mask;
765 mask->be32 = wc->nw_dst_mask;
770 mask->be16 = wc->tp_src_mask;
774 mask->be16 = wc->tp_dst_mask;
777 case MFF_ICMPV4_TYPE:
778 case MFF_ICMPV6_TYPE:
779 mask->u8 = ntohs(wc->tp_src_mask);
781 case MFF_ICMPV4_CODE:
782 case MFF_ICMPV6_CODE:
783 mask->u8 = ntohs(wc->tp_dst_mask);
792 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
793 * if the mask is valid, false otherwise. */
795 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
797 switch (mf->maskable) {
799 return (is_all_zeros((const uint8_t *) mask, mf->n_bytes) ||
800 is_all_ones((const uint8_t *) mask, mf->n_bytes));
810 is_ip_any(const struct flow *flow)
812 return (flow->dl_type == htons(ETH_TYPE_IP) ||
813 flow->dl_type == htons(ETH_TYPE_IPV6));
817 is_icmpv4(const struct flow *flow)
819 return (flow->dl_type == htons(ETH_TYPE_IP)
820 && flow->nw_proto == IPPROTO_ICMP);
824 is_icmpv6(const struct flow *flow)
826 return (flow->dl_type == htons(ETH_TYPE_IPV6)
827 && flow->nw_proto == IPPROTO_ICMPV6);
830 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
832 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
834 switch (mf->prereqs) {
839 return flow->dl_type == htons(ETH_TYPE_ARP);
841 return flow->dl_type == htons(ETH_TYPE_IP);
843 return flow->dl_type == htons(ETH_TYPE_IPV6);
845 return is_ip_any(flow);
848 return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP;
850 return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP;
852 return is_icmpv4(flow);
854 return is_icmpv6(flow);
857 return (is_icmpv6(flow)
858 && flow->tp_dst == htons(0)
859 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
860 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
862 return (is_icmpv6(flow)
863 && flow->tp_dst == htons(0)
864 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
866 return (is_icmpv6(flow)
867 && flow->tp_dst == htons(0)
868 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
874 /* Returns true if 'value' may be a valid value *as part of a masked match*,
877 * A value is not rejected just because it is not valid for the field in
878 * question, but only if it doesn't make sense to test the bits in question at
879 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
880 * without the VLAN_CFI bit being set, but we can't reject those values because
881 * it is still legitimate to test just for those bits (see the documentation
882 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
883 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
885 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
936 case MFF_ICMPV4_TYPE:
937 case MFF_ICMPV4_CODE:
938 case MFF_ICMPV6_TYPE:
939 case MFF_ICMPV6_CODE:
946 return !(value->u8 & ~IP_DSCP_MASK);
948 return !(value->u8 & ~IP_ECN_MASK);
950 return !(value->u8 & ~FLOW_NW_FRAG_MASK);
953 return !(value->be16 & htons(0xff00));
956 return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
959 return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
962 return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
970 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
971 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
973 mf_get_value(const struct mf_field *mf, const struct flow *flow,
974 union mf_value *value)
978 value->be64 = flow->tun_id;
981 value->be64 = flow->metadata;
985 value->be16 = htons(flow->in_port);
1015 value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
1019 memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
1023 memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
1027 value->be16 = flow->dl_type;
1031 value->be16 = flow->vlan_tci;
1035 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
1039 value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
1043 value->be32 = flow->nw_src;
1047 value->be32 = flow->nw_dst;
1051 value->ipv6 = flow->ipv6_src;
1055 value->ipv6 = flow->ipv6_dst;
1058 case MFF_IPV6_LABEL:
1059 value->be32 = flow->ipv6_label;
1063 value->u8 = flow->nw_proto;
1067 value->u8 = flow->nw_tos & IP_DSCP_MASK;
1071 value->u8 = flow->nw_tos & IP_ECN_MASK;
1075 value->u8 = flow->nw_ttl;
1079 value->u8 = flow->nw_frag;
1083 value->be16 = htons(flow->nw_proto);
1087 value->be32 = flow->nw_src;
1091 value->be32 = flow->nw_dst;
1096 memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
1101 memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
1105 value->be16 = flow->tp_src;
1109 value->be16 = flow->tp_dst;
1113 value->be16 = flow->tp_src;
1117 value->be16 = flow->tp_dst;
1120 case MFF_ICMPV4_TYPE:
1121 case MFF_ICMPV6_TYPE:
1122 value->u8 = ntohs(flow->tp_src);
1125 case MFF_ICMPV4_CODE:
1126 case MFF_ICMPV6_CODE:
1127 value->u8 = ntohs(flow->tp_dst);
1131 value->ipv6 = flow->nd_target;
1140 /* Makes 'rule' match field 'mf' exactly, with the value matched taken from
1141 * 'value'. The caller is responsible for ensuring that 'rule' meets 'mf''s
1144 mf_set_value(const struct mf_field *mf,
1145 const union mf_value *value, struct cls_rule *rule)
1149 cls_rule_set_tun_id(rule, value->be64);
1152 cls_rule_set_metadata(rule, value->be64);
1156 cls_rule_set_in_port(rule, ntohs(value->be16));
1187 cls_rule_set_reg(rule, mf->id - MFF_REG0, ntohl(value->be32));
1192 cls_rule_set_dl_src(rule, value->mac);
1196 cls_rule_set_dl_dst(rule, value->mac);
1200 cls_rule_set_dl_type(rule, value->be16);
1204 cls_rule_set_dl_tci(rule, value->be16);
1208 cls_rule_set_dl_vlan(rule, value->be16);
1212 cls_rule_set_dl_vlan_pcp(rule, value->u8);
1216 cls_rule_set_nw_src(rule, value->be32);
1220 cls_rule_set_nw_dst(rule, value->be32);
1224 cls_rule_set_ipv6_src(rule, &value->ipv6);
1228 cls_rule_set_ipv6_dst(rule, &value->ipv6);
1231 case MFF_IPV6_LABEL:
1232 cls_rule_set_ipv6_label(rule, value->be32);
1236 cls_rule_set_nw_proto(rule, value->u8);
1240 cls_rule_set_nw_dscp(rule, value->u8);
1244 cls_rule_set_nw_ecn(rule, value->u8);
1248 cls_rule_set_nw_ttl(rule, value->u8);
1252 cls_rule_set_nw_frag(rule, value->u8);
1256 cls_rule_set_nw_proto(rule, ntohs(value->be16));
1260 cls_rule_set_nw_src(rule, value->be32);
1264 cls_rule_set_nw_dst(rule, value->be32);
1269 cls_rule_set_arp_sha(rule, value->mac);
1274 cls_rule_set_arp_tha(rule, value->mac);
1278 cls_rule_set_tp_src(rule, value->be16);
1282 cls_rule_set_tp_dst(rule, value->be16);
1286 cls_rule_set_tp_src(rule, value->be16);
1290 cls_rule_set_tp_dst(rule, value->be16);
1293 case MFF_ICMPV4_TYPE:
1294 case MFF_ICMPV6_TYPE:
1295 cls_rule_set_icmp_type(rule, value->u8);
1298 case MFF_ICMPV4_CODE:
1299 case MFF_ICMPV6_CODE:
1300 cls_rule_set_icmp_code(rule, value->u8);
1304 cls_rule_set_nd_target(rule, &value->ipv6);
1313 /* Makes 'rule' match field 'mf' exactly, with the value matched taken from
1314 * 'value'. The caller is responsible for ensuring that 'rule' meets 'mf''s
1317 mf_set_flow_value(const struct mf_field *mf,
1318 const union mf_value *value, struct flow *flow)
1322 flow->tun_id = value->be64;
1325 flow->metadata = value->be64;
1329 flow->in_port = ntohs(value->be16);
1360 flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1365 memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
1369 memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
1373 flow->dl_type = value->be16;
1377 flow->vlan_tci = value->be16;
1381 flow_set_vlan_vid(flow, value->be16);
1385 flow_set_vlan_pcp(flow, value->u8);
1389 flow->nw_src = value->be32;
1393 flow->nw_dst = value->be32;
1397 flow->ipv6_src = value->ipv6;
1401 flow->ipv6_dst = value->ipv6;
1404 case MFF_IPV6_LABEL:
1405 flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1409 flow->nw_proto = value->u8;
1413 flow->nw_tos &= ~IP_DSCP_MASK;
1414 flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1418 flow->nw_tos &= ~IP_ECN_MASK;
1419 flow->nw_tos |= value->u8 & IP_ECN_MASK;
1423 flow->nw_ttl = value->u8;
1427 flow->nw_frag &= value->u8;
1431 flow->nw_proto = ntohs(value->be16);
1435 flow->nw_src = value->be32;
1439 flow->nw_dst = value->be32;
1444 memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1449 memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1454 flow->tp_src = value->be16;
1459 flow->tp_dst = value->be16;
1462 case MFF_ICMPV4_TYPE:
1463 case MFF_ICMPV6_TYPE:
1464 flow->tp_src = htons(value->u8);
1467 case MFF_ICMPV4_CODE:
1468 case MFF_ICMPV6_CODE:
1469 flow->tp_dst = htons(value->u8);
1473 flow->nd_target = value->ipv6;
1482 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1484 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1487 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1489 union mf_value value;
1491 mf_get_value(mf, flow, &value);
1492 return is_all_zeros((const uint8_t *) &value, mf->n_bytes);
1495 /* Makes 'rule' wildcard field 'mf'.
1497 * The caller is responsible for ensuring that 'rule' meets 'mf''s
1500 mf_set_wild(const struct mf_field *mf, struct cls_rule *rule)
1504 cls_rule_set_tun_id_masked(rule, htonll(0), htonll(0));
1507 cls_rule_set_metadata_masked(rule, htonll(0), htonll(0));
1510 rule->wc.wildcards |= FWW_IN_PORT;
1511 rule->flow.in_port = 0;
1516 cls_rule_set_reg_masked(rule, 0, 0, 0);
1521 cls_rule_set_reg_masked(rule, 1, 0, 0);
1526 cls_rule_set_reg_masked(rule, 2, 0, 0);
1531 cls_rule_set_reg_masked(rule, 3, 0, 0);
1536 cls_rule_set_reg_masked(rule, 4, 0, 0);
1541 cls_rule_set_reg_masked(rule, 5, 0, 0);
1546 cls_rule_set_reg_masked(rule, 6, 0, 0);
1551 cls_rule_set_reg_masked(rule, 7, 0, 0);
1559 memset(rule->flow.dl_src, 0, ETH_ADDR_LEN);
1560 memset(rule->wc.dl_src_mask, 0, ETH_ADDR_LEN);
1564 memset(rule->flow.dl_dst, 0, ETH_ADDR_LEN);
1565 memset(rule->wc.dl_dst_mask, 0, ETH_ADDR_LEN);
1569 rule->wc.wildcards |= FWW_DL_TYPE;
1570 rule->flow.dl_type = htons(0);
1574 cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
1578 cls_rule_set_any_vid(rule);
1582 cls_rule_set_any_pcp(rule);
1587 cls_rule_set_nw_src_masked(rule, htonl(0), htonl(0));
1592 cls_rule_set_nw_dst_masked(rule, htonl(0), htonl(0));
1596 memset(&rule->wc.ipv6_src_mask, 0, sizeof rule->wc.ipv6_src_mask);
1597 memset(&rule->flow.ipv6_src, 0, sizeof rule->flow.ipv6_src);
1601 memset(&rule->wc.ipv6_dst_mask, 0, sizeof rule->wc.ipv6_dst_mask);
1602 memset(&rule->flow.ipv6_dst, 0, sizeof rule->flow.ipv6_dst);
1605 case MFF_IPV6_LABEL:
1606 rule->wc.wildcards |= FWW_IPV6_LABEL;
1607 rule->flow.ipv6_label = 0;
1611 rule->wc.wildcards |= FWW_NW_PROTO;
1612 rule->flow.nw_proto = 0;
1616 rule->wc.wildcards |= FWW_NW_DSCP;
1617 rule->flow.nw_tos &= ~IP_DSCP_MASK;
1621 rule->wc.wildcards |= FWW_NW_ECN;
1622 rule->flow.nw_tos &= ~IP_ECN_MASK;
1626 rule->wc.wildcards |= FWW_NW_TTL;
1627 rule->flow.nw_ttl = 0;
1631 rule->wc.nw_frag_mask |= FLOW_NW_FRAG_MASK;
1632 rule->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1636 rule->wc.wildcards |= FWW_NW_PROTO;
1637 rule->flow.nw_proto = 0;
1642 rule->wc.wildcards |= FWW_ARP_SHA;
1643 memset(rule->flow.arp_sha, 0, sizeof rule->flow.arp_sha);
1648 rule->wc.wildcards |= FWW_ARP_THA;
1649 memset(rule->flow.arp_tha, 0, sizeof rule->flow.arp_tha);
1654 case MFF_ICMPV4_TYPE:
1655 case MFF_ICMPV6_TYPE:
1656 rule->wc.tp_src_mask = htons(0);
1657 rule->flow.tp_src = htons(0);
1662 case MFF_ICMPV4_CODE:
1663 case MFF_ICMPV6_CODE:
1664 rule->wc.tp_dst_mask = htons(0);
1665 rule->flow.tp_dst = htons(0);
1669 memset(&rule->wc.nd_target_mask, 0, sizeof rule->wc.nd_target_mask);
1670 memset(&rule->flow.nd_target, 0, sizeof rule->flow.nd_target);
1679 /* Makes 'rule' match field 'mf' with the specified 'value' and 'mask'.
1680 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1681 * with a 1-bit indicating that the corresponding value bit must match and a
1682 * 0-bit indicating a don't-care.
1684 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1685 * mf_set_value(mf, value, rule). If 'mask' points to all-0-bits, then this
1686 * call is equivalent to mf_set_wild(mf, rule).
1688 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
1689 * is responsible for ensuring that 'rule' meets 'mf''s prerequisites. */
1691 mf_set(const struct mf_field *mf,
1692 const union mf_value *value, const union mf_value *mask,
1693 struct cls_rule *rule)
1695 if (!mask || is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
1696 mf_set_value(mf, value, rule);
1698 } else if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
1699 mf_set_wild(mf, rule);
1708 case MFF_IPV6_LABEL:
1716 case MFF_ICMPV4_TYPE:
1717 case MFF_ICMPV4_CODE:
1718 case MFF_ICMPV6_TYPE:
1719 case MFF_ICMPV6_CODE:
1725 cls_rule_set_tun_id_masked(rule, value->be64, mask->be64);
1728 cls_rule_set_metadata_masked(rule, value->be64, mask->be64);
1758 cls_rule_set_reg_masked(rule, mf->id - MFF_REG0,
1759 ntohl(value->be32), ntohl(mask->be32));
1763 cls_rule_set_dl_dst_masked(rule, value->mac, mask->mac);
1767 cls_rule_set_dl_src_masked(rule, value->mac, mask->mac);
1771 cls_rule_set_dl_tci_masked(rule, value->be16, mask->be16);
1775 cls_rule_set_nw_src_masked(rule, value->be32, mask->be32);
1779 cls_rule_set_nw_dst_masked(rule, value->be32, mask->be32);
1783 cls_rule_set_ipv6_src_masked(rule, &value->ipv6, &mask->ipv6);
1787 cls_rule_set_ipv6_dst_masked(rule, &value->ipv6, &mask->ipv6);
1791 cls_rule_set_nd_target_masked(rule, &value->ipv6, &mask->ipv6);
1795 cls_rule_set_nw_frag_masked(rule, value->u8, mask->u8);
1799 cls_rule_set_nw_src_masked(rule, value->be32, mask->be32);
1803 cls_rule_set_nw_dst_masked(rule, value->be32, mask->be32);
1808 cls_rule_set_tp_src_masked(rule, value->be16, mask->be16);
1813 cls_rule_set_tp_dst_masked(rule, value->be16, mask->be16);
1823 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
1827 VLOG_WARN_RL(&rl, "unknown %s field", type);
1828 } else if (!sf->n_bits) {
1829 VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
1830 } else if (sf->ofs >= sf->field->n_bits) {
1831 VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
1832 sf->ofs, sf->field->n_bits, type, sf->field->name);
1833 } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
1834 VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
1835 "of %s field %s", sf->ofs, sf->n_bits,
1836 sf->field->n_bits, type, sf->field->name);
1837 } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
1838 VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
1839 type, sf->field->name);
1844 return OFPERR_OFPBAC_BAD_ARGUMENT;
1847 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
1848 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
1851 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
1853 return mf_check__(sf, flow, "source");
1856 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
1857 * if so, otherwise an OpenFlow error code (e.g. as returned by
1860 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
1862 int error = mf_check__(sf, flow, "destination");
1863 if (!error && !sf->field->writable) {
1864 VLOG_WARN_RL(&rl, "destination field %s is not writable",
1866 return OFPERR_OFPBAC_BAD_ARGUMENT;
1871 /* Copies the value and wildcard bit pattern for 'mf' from 'rule' into the
1872 * 'value' and 'mask', respectively. */
1874 mf_get(const struct mf_field *mf, const struct cls_rule *rule,
1875 union mf_value *value, union mf_value *mask)
1877 mf_get_value(mf, &rule->flow, value);
1878 mf_get_mask(mf, &rule->wc, mask);
1881 /* Assigns a random value for field 'mf' to 'value'. */
1883 mf_random_value(const struct mf_field *mf, union mf_value *value)
1885 random_bytes(value, mf->n_bytes);
1936 case MFF_ICMPV4_TYPE:
1937 case MFF_ICMPV4_CODE:
1938 case MFF_ICMPV6_TYPE:
1939 case MFF_ICMPV6_CODE:
1945 case MFF_IPV6_LABEL:
1946 value->be32 &= ~htonl(IPV6_LABEL_MASK);
1950 value->u8 &= IP_DSCP_MASK;
1954 value->u8 &= IP_ECN_MASK;
1958 value->u8 &= FLOW_NW_FRAG_MASK;
1962 value->be16 &= htons(0xff);
1966 value->be16 &= htons(VLAN_VID_MASK);
1980 mf_from_integer_string(const struct mf_field *mf, const char *s,
1981 uint8_t *valuep, uint8_t *maskp)
1983 unsigned long long int integer, mask;
1988 integer = strtoull(s, &tail, 0);
1989 if (errno || (*tail != '\0' && *tail != '/')) {
1994 mask = strtoull(tail + 1, &tail, 0);
1995 if (errno || *tail != '\0') {
2002 for (i = mf->n_bytes - 1; i >= 0; i--) {
2003 valuep[i] = integer;
2009 return xasprintf("%s: value too large for %u-byte field %s",
2010 s, mf->n_bytes, mf->name);
2015 return xasprintf("%s: bad syntax for %s", s, mf->name);
2019 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
2020 uint8_t mac[ETH_ADDR_LEN],
2021 uint8_t mask[ETH_ADDR_LEN])
2023 assert(mf->n_bytes == ETH_ADDR_LEN);
2025 switch (sscanf(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT,
2026 ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask))){
2027 case ETH_ADDR_SCAN_COUNT * 2:
2030 case ETH_ADDR_SCAN_COUNT:
2031 memset(mask, 0xff, ETH_ADDR_LEN);
2035 return xasprintf("%s: invalid Ethernet address", s);
2040 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
2041 ovs_be32 *ip, ovs_be32 *mask)
2045 assert(mf->n_bytes == sizeof *ip);
2047 if (sscanf(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
2048 IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask)) == IP_SCAN_COUNT * 2) {
2050 } else if (sscanf(s, IP_SCAN_FMT"/%d",
2051 IP_SCAN_ARGS(ip), &prefix) == IP_SCAN_COUNT + 1) {
2052 if (prefix <= 0 || prefix > 32) {
2053 return xasprintf("%s: network prefix bits not between 1 and "
2055 } else if (prefix == 32) {
2056 *mask = htonl(UINT32_MAX);
2058 *mask = htonl(((1u << prefix) - 1) << (32 - prefix));
2060 } else if (sscanf(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip)) == IP_SCAN_COUNT) {
2061 *mask = htonl(UINT32_MAX);
2063 return xasprintf("%s: invalid IP address", s);
2069 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
2070 struct in6_addr *value, struct in6_addr *mask)
2072 char *str = xstrdup(s);
2073 char *save_ptr = NULL;
2074 const char *name, *netmask;
2077 assert(mf->n_bytes == sizeof *value);
2079 name = strtok_r(str, "/", &save_ptr);
2080 retval = name ? lookup_ipv6(name, value) : EINVAL;
2084 err = xasprintf("%s: could not convert to IPv6 address", str);
2090 netmask = strtok_r(NULL, "/", &save_ptr);
2092 if (inet_pton(AF_INET6, netmask, mask) != 1) {
2093 int prefix = atoi(netmask);
2094 if (prefix <= 0 || prefix > 128) {
2096 return xasprintf("%s: prefix bits not between 1 and 128", s);
2098 *mask = ipv6_create_mask(prefix);
2102 *mask = in6addr_exact;
2110 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
2111 ovs_be16 *valuep, ovs_be16 *maskp)
2115 assert(mf->n_bytes == sizeof(ovs_be16));
2116 if (ofputil_port_from_string(s, &port)) {
2117 *valuep = htons(port);
2118 *maskp = htons(UINT16_MAX);
2121 return mf_from_integer_string(mf, s,
2122 (uint8_t *) valuep, (uint8_t *) maskp);
2126 struct frag_handling {
2132 static const struct frag_handling all_frags[] = {
2133 #define A FLOW_NW_FRAG_ANY
2134 #define L FLOW_NW_FRAG_LATER
2135 /* name mask value */
2138 { "first", A|L, A },
2139 { "later", A|L, A|L },
2144 { "not_later", L, 0 },
2151 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
2153 const struct frag_handling *h;
2155 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2156 if (!strcasecmp(s, h->name)) {
2157 /* We force the upper bits of the mask on to make mf_parse_value()
2158 * happy (otherwise it will never think it's an exact match.) */
2159 *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
2165 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2166 "\"yes\", \"first\", \"later\", \"not_first\"", s);
2169 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2170 * NULL if successful, otherwise a malloc()'d string describing the error. */
2172 mf_parse(const struct mf_field *mf, const char *s,
2173 union mf_value *value, union mf_value *mask)
2175 if (!strcasecmp(s, "any") || !strcmp(s, "*")) {
2176 memset(value, 0, mf->n_bytes);
2177 memset(mask, 0, mf->n_bytes);
2181 switch (mf->string) {
2183 case MFS_HEXADECIMAL:
2184 return mf_from_integer_string(mf, s,
2185 (uint8_t *) value, (uint8_t *) mask);
2188 return mf_from_ethernet_string(mf, s, value->mac, mask->mac);
2191 return mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
2194 return mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
2197 return mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
2200 return mf_from_frag_string(s, &value->u8, &mask->u8);
2205 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2206 * successful, otherwise a malloc()'d string describing the error. */
2208 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2210 union mf_value mask;
2213 error = mf_parse(mf, s, value, &mask);
2218 if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2219 return xasprintf("%s: wildcards not allowed here", s);
2225 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2226 const uint8_t *maskp, struct ds *s)
2228 unsigned long long int integer;
2231 assert(mf->n_bytes <= 8);
2234 for (i = 0; i < mf->n_bytes; i++) {
2235 integer = (integer << 8) | valuep[i];
2237 if (mf->string == MFS_HEXADECIMAL) {
2238 ds_put_format(s, "%#llx", integer);
2240 ds_put_format(s, "%lld", integer);
2244 unsigned long long int mask;
2247 for (i = 0; i < mf->n_bytes; i++) {
2248 mask = (mask << 8) | maskp[i];
2251 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2252 * not sure that that a bit-mask written in decimal is ever easier to
2253 * understand than the same bit-mask written in hexadecimal. */
2254 ds_put_format(s, "/%#llx", mask);
2259 mf_format_frag_string(const uint8_t *valuep, const uint8_t *maskp,
2262 const struct frag_handling *h;
2263 uint8_t value = *valuep;
2264 uint8_t mask = *maskp;
2267 mask &= FLOW_NW_FRAG_MASK;
2269 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2270 if (value == h->value && mask == h->mask) {
2271 ds_put_cstr(s, h->name);
2275 ds_put_cstr(s, "<error>");
2278 /* Appends to 's' a string representation of field 'mf' whose value is in
2279 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2281 mf_format(const struct mf_field *mf,
2282 const union mf_value *value, const union mf_value *mask,
2286 if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2287 ds_put_cstr(s, "ANY");
2289 } else if (is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2294 switch (mf->string) {
2297 ofputil_format_port(ntohs(value->be16), s);
2302 case MFS_HEXADECIMAL:
2303 mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2307 eth_format_masked(value->mac, mask->mac, s);
2311 ip_format_masked(value->be32, mask ? mask->be32 : htonl(UINT32_MAX),
2316 print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2320 mf_format_frag_string(&value->u8, &mask->u8, s);
2328 /* Makes subfield 'sf' within 'rule' exactly match the 'sf->n_bits'
2329 * least-significant bits in 'x'.
2331 * See mf_set_subfield() for an example.
2333 * The difference between this function and mf_set_subfield() is that the
2334 * latter function can only handle subfields up to 64 bits wide, whereas this
2335 * one handles the general case. On the other hand, mf_set_subfield() is
2336 * arguably easier to use. */
2338 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2339 struct cls_rule *rule)
2341 const struct mf_field *field = sf->field;
2342 union mf_value value, mask;
2344 mf_get(field, rule, &value, &mask);
2345 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2346 bitwise_one ( &mask, field->n_bytes, sf->ofs, sf->n_bits);
2347 mf_set(field, &value, &mask, rule);
2350 /* Makes subfield 'sf' within 'rule' exactly match the 'sf->n_bits'
2351 * least-significant bits of 'x'.
2353 * Example: suppose that 'sf->field' is originally the following 2-byte field
2356 * value == 0xe00a == 2#1110000000001010
2357 * mask == 0xfc3f == 2#1111110000111111
2359 * The call mf_set_subfield(sf, 0x55, 8, 7, rule), where sf->ofs == 8 and
2360 * sf->n_bits == 7 would have the following effect (note that 0x55 is
2363 * value == 0xd50a == 2#1101010100001010
2364 * mask == 0xff3f == 2#1111111100111111
2365 * ^^^^^^^ affected bits
2367 * The caller is responsible for ensuring that the result will be a valid
2368 * wildcard pattern for 'sf->field'. The caller is responsible for ensuring
2369 * that 'rule' meets 'sf->field''s prerequisites. */
2371 mf_set_subfield(const struct mf_subfield *sf, uint64_t x,
2372 struct cls_rule *rule)
2374 const struct mf_field *field = sf->field;
2375 unsigned int n_bits = sf->n_bits;
2376 unsigned int ofs = sf->ofs;
2378 if (ofs == 0 && field->n_bytes * 8 == n_bits) {
2379 union mf_value value;
2382 for (i = field->n_bytes - 1; i >= 0; i--) {
2383 ((uint8_t *) &value)[i] = x;
2386 mf_set_value(field, &value, rule);
2388 union mf_value value, mask;
2389 uint8_t *vp = (uint8_t *) &value;
2390 uint8_t *mp = (uint8_t *) &mask;
2392 mf_get(field, rule, &value, &mask);
2393 bitwise_put(x, vp, field->n_bytes, ofs, n_bits);
2394 bitwise_put(UINT64_MAX, mp, field->n_bytes, ofs, n_bits);
2395 mf_set(field, &value, &mask, rule);
2399 /* Similar to mf_set_subfield() but modifies only a flow, not a cls_rule. */
2401 mf_set_subfield_value(const struct mf_subfield *sf, uint64_t x,
2404 const struct mf_field *field = sf->field;
2405 unsigned int n_bits = sf->n_bits;
2406 unsigned int ofs = sf->ofs;
2407 union mf_value value;
2409 if (ofs == 0 && field->n_bytes * 8 == n_bits) {
2412 for (i = field->n_bytes - 1; i >= 0; i--) {
2413 ((uint8_t *) &value)[i] = x;
2416 mf_set_flow_value(field, &value, flow);
2418 mf_get_value(field, flow, &value);
2419 bitwise_put(x, &value, field->n_bytes, ofs, n_bits);
2420 mf_set_flow_value(field, &value, flow);
2424 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2425 * reading 'flow', e.g. as checked by mf_check_src(). */
2427 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2428 union mf_subvalue *x)
2430 union mf_value value;
2432 mf_get_value(sf->field, flow, &value);
2434 memset(x, 0, sizeof *x);
2435 bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2440 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2441 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2444 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2446 union mf_value value;
2448 mf_get_value(sf->field, flow, &value);
2449 return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2452 /* Formats 'sf' into 's' in a format normally acceptable to
2453 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2454 * sf->field has no NXM name.) */
2456 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
2459 ds_put_cstr(s, "<unknown>");
2460 } else if (sf->field->nxm_name) {
2461 ds_put_cstr(s, sf->field->nxm_name);
2462 } else if (sf->field->nxm_header) {
2463 uint32_t header = sf->field->nxm_header;
2464 ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
2466 ds_put_cstr(s, sf->field->name);
2469 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
2470 ds_put_cstr(s, "[]");
2471 } else if (sf->n_bits == 1) {
2472 ds_put_format(s, "[%d]", sf->ofs);
2474 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
2478 static const struct mf_field *
2479 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
2483 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
2488 for (i = 0; i < MFF_N_IDS; i++) {
2489 const struct mf_field *mf = mf_from_id(i);
2492 && !strncmp(mf->nxm_name, name, name_len)
2493 && mf->nxm_name[name_len] == '\0') {
2497 && !strncmp(mf->oxm_name, name, name_len)
2498 && mf->oxm_name[name_len] == '\0') {
2506 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2507 * returns NULL and advances '*sp' to the first byte following the parsed
2508 * string. On failure, returns a malloc()'d error message, does not modify
2509 * '*sp', and does not properly initialize 'sf'.
2511 * The syntax parsed from '*sp' takes the form "header[start..end]" where
2512 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2513 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2514 * may both be omitted (the [] are still required) to indicate an entire
2517 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
2519 const struct mf_field *field;
2528 name_len = strcspn(s, "[");
2529 if (s[name_len] != '[') {
2530 return xasprintf("%s: missing [ looking for field name", *sp);
2533 field = mf_parse_subfield_name(name, name_len, &wild);
2535 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
2539 if (sscanf(s, "[%d..%d]", &start, &end) == 2) {
2540 /* Nothing to do. */
2541 } else if (sscanf(s, "[%d]", &start) == 1) {
2543 } else if (!strncmp(s, "[]", 2)) {
2545 end = field->n_bits - 1;
2547 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2548 "[<start>..<end>]", *sp);
2550 s = strchr(s, ']') + 1;
2553 return xasprintf("%s: starting bit %d is after ending bit %d",
2555 } else if (start >= field->n_bits) {
2556 return xasprintf("%s: starting bit %d is not valid because field is "
2557 "only %d bits wide", *sp, start, field->n_bits);
2558 } else if (end >= field->n_bits){
2559 return xasprintf("%s: ending bit %d is not valid because field is "
2560 "only %d bits wide", *sp, end, field->n_bits);
2565 sf->n_bits = end - start + 1;
2571 /* Parses a subfield from the beginning of 's' into 'sf'. Returns the first
2572 * byte in 's' following the parsed string.
2574 * Exits with an error message if 's' has incorrect syntax.
2576 * The syntax parsed from 's' takes the form "header[start..end]" where
2577 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2578 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2579 * may both be omitted (the [] are still required) to indicate an entire
2582 mf_parse_subfield(struct mf_subfield *sf, const char *s)
2584 char *msg = mf_parse_subfield__(sf, &s);
2586 ovs_fatal(0, "%s", msg);