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,
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)
569 assert(mf->fww_bit != 0);
570 return (wc->wildcards & mf->fww_bit) != 0;
573 return !wc->tun_id_mask;
575 return !wc->metadata_mask;
578 return !wc->reg_masks[mf->id - MFF_REG0];
581 return eth_addr_is_zero(wc->dl_src_mask);
583 return eth_addr_is_zero(wc->dl_dst_mask);
586 return !wc->vlan_tci_mask;
588 return !(wc->vlan_tci_mask & htons(VLAN_VID_MASK));
590 return !(wc->vlan_tci_mask & htons(VLAN_PCP_MASK));
593 return !wc->nw_src_mask;
595 return !wc->nw_dst_mask;
598 return ipv6_mask_is_any(&wc->ipv6_src_mask);
600 return ipv6_mask_is_any(&wc->ipv6_dst_mask);
603 return !wc->ipv6_label_mask;
606 return ipv6_mask_is_any(&wc->nd_target_mask);
609 return !(wc->nw_frag_mask & FLOW_NW_FRAG_MASK);
612 return !wc->nw_src_mask;
614 return !wc->nw_dst_mask;
618 case MFF_ICMPV4_TYPE:
619 case MFF_ICMPV6_TYPE:
620 return !wc->tp_src_mask;
623 case MFF_ICMPV4_CODE:
624 case MFF_ICMPV6_CODE:
625 return !wc->tp_dst_mask;
633 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
634 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
635 * purposes, or to 0 if it is wildcarded.
637 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
638 * meets 'mf''s prerequisites. */
640 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
641 union mf_value *mask)
656 assert(mf->fww_bit != 0);
657 memset(mask, wc->wildcards & mf->fww_bit ? 0x00 : 0xff, mf->n_bytes);
661 mask->be64 = wc->tun_id_mask;
664 mask->be64 = wc->metadata_mask;
668 mask->be32 = htonl(wc->reg_masks[mf->id - MFF_REG0]);
672 memcpy(mask->mac, wc->dl_dst_mask, ETH_ADDR_LEN);
676 memcpy(mask->mac, wc->dl_src_mask, ETH_ADDR_LEN);
680 mask->be16 = wc->vlan_tci_mask;
683 mask->be16 = wc->vlan_tci_mask & htons(VLAN_VID_MASK);
686 mask->u8 = vlan_tci_to_pcp(wc->vlan_tci_mask);
690 mask->be32 = wc->nw_src_mask;
693 mask->be32 = wc->nw_dst_mask;
697 mask->ipv6 = wc->ipv6_src_mask;
700 mask->ipv6 = wc->ipv6_dst_mask;
704 mask->ipv6 = wc->nd_target_mask;
708 mask->u8 = wc->nw_frag_mask & FLOW_NW_FRAG_MASK;
712 mask->be32 = wc->nw_src_mask;
715 mask->be32 = wc->nw_dst_mask;
720 mask->be16 = wc->tp_src_mask;
724 mask->be16 = wc->tp_dst_mask;
727 case MFF_ICMPV4_TYPE:
728 case MFF_ICMPV6_TYPE:
729 mask->u8 = ntohs(wc->tp_src_mask);
731 case MFF_ICMPV4_CODE:
732 case MFF_ICMPV6_CODE:
733 mask->u8 = ntohs(wc->tp_dst_mask);
742 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
743 * if the mask is valid, false otherwise. */
745 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
747 switch (mf->maskable) {
749 return (is_all_zeros((const uint8_t *) mask, mf->n_bytes) ||
750 is_all_ones((const uint8_t *) mask, mf->n_bytes));
760 is_ip_any(const struct flow *flow)
762 return (flow->dl_type == htons(ETH_TYPE_IP) ||
763 flow->dl_type == htons(ETH_TYPE_IPV6));
767 is_icmpv4(const struct flow *flow)
769 return (flow->dl_type == htons(ETH_TYPE_IP)
770 && flow->nw_proto == IPPROTO_ICMP);
774 is_icmpv6(const struct flow *flow)
776 return (flow->dl_type == htons(ETH_TYPE_IPV6)
777 && flow->nw_proto == IPPROTO_ICMPV6);
780 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
782 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
784 switch (mf->prereqs) {
789 return flow->dl_type == htons(ETH_TYPE_ARP);
791 return flow->dl_type == htons(ETH_TYPE_IP);
793 return flow->dl_type == htons(ETH_TYPE_IPV6);
795 return is_ip_any(flow);
798 return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP;
800 return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP;
802 return is_icmpv4(flow);
804 return is_icmpv6(flow);
807 return (is_icmpv6(flow)
808 && flow->tp_dst == htons(0)
809 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
810 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
812 return (is_icmpv6(flow)
813 && flow->tp_dst == htons(0)
814 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
816 return (is_icmpv6(flow)
817 && flow->tp_dst == htons(0)
818 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
824 /* Returns true if 'value' may be a valid value *as part of a masked match*,
827 * A value is not rejected just because it is not valid for the field in
828 * question, but only if it doesn't make sense to test the bits in question at
829 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
830 * without the VLAN_CFI bit being set, but we can't reject those values because
831 * it is still legitimate to test just for those bits (see the documentation
832 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
833 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
835 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
860 case MFF_ICMPV4_TYPE:
861 case MFF_ICMPV4_CODE:
862 case MFF_ICMPV6_TYPE:
863 case MFF_ICMPV6_CODE:
870 return !(value->u8 & ~IP_DSCP_MASK);
872 return !(value->u8 & ~IP_ECN_MASK);
874 return !(value->u8 & ~FLOW_NW_FRAG_MASK);
877 return !(value->be16 & htons(0xff00));
880 return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
883 return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
886 return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
894 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
895 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
897 mf_get_value(const struct mf_field *mf, const struct flow *flow,
898 union mf_value *value)
902 value->be64 = flow->tun_id;
905 value->be64 = flow->metadata;
909 value->be16 = htons(flow->in_port);
913 value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
917 memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
921 memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
925 value->be16 = flow->dl_type;
929 value->be16 = flow->vlan_tci;
933 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
937 value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
941 value->be32 = flow->nw_src;
945 value->be32 = flow->nw_dst;
949 value->ipv6 = flow->ipv6_src;
953 value->ipv6 = flow->ipv6_dst;
957 value->be32 = flow->ipv6_label;
961 value->u8 = flow->nw_proto;
965 value->u8 = flow->nw_tos & IP_DSCP_MASK;
969 value->u8 = flow->nw_tos & IP_ECN_MASK;
973 value->u8 = flow->nw_ttl;
977 value->u8 = flow->nw_frag;
981 value->be16 = htons(flow->nw_proto);
985 value->be32 = flow->nw_src;
989 value->be32 = flow->nw_dst;
994 memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
999 memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
1004 value->be16 = flow->tp_src;
1009 value->be16 = flow->tp_dst;
1012 case MFF_ICMPV4_TYPE:
1013 case MFF_ICMPV6_TYPE:
1014 value->u8 = ntohs(flow->tp_src);
1017 case MFF_ICMPV4_CODE:
1018 case MFF_ICMPV6_CODE:
1019 value->u8 = ntohs(flow->tp_dst);
1023 value->ipv6 = flow->nd_target;
1032 /* Makes 'rule' match field 'mf' exactly, with the value matched taken from
1033 * 'value'. The caller is responsible for ensuring that 'rule' meets 'mf''s
1036 mf_set_value(const struct mf_field *mf,
1037 const union mf_value *value, struct cls_rule *rule)
1041 cls_rule_set_tun_id(rule, value->be64);
1044 cls_rule_set_metadata(rule, value->be64);
1048 cls_rule_set_in_port(rule, ntohs(value->be16));
1052 cls_rule_set_reg(rule, mf->id - MFF_REG0, ntohl(value->be32));
1056 cls_rule_set_dl_src(rule, value->mac);
1060 cls_rule_set_dl_dst(rule, value->mac);
1064 cls_rule_set_dl_type(rule, value->be16);
1068 cls_rule_set_dl_tci(rule, value->be16);
1072 cls_rule_set_dl_vlan(rule, value->be16);
1076 cls_rule_set_dl_vlan_pcp(rule, value->u8);
1080 cls_rule_set_nw_src(rule, value->be32);
1084 cls_rule_set_nw_dst(rule, value->be32);
1088 cls_rule_set_ipv6_src(rule, &value->ipv6);
1092 cls_rule_set_ipv6_dst(rule, &value->ipv6);
1095 case MFF_IPV6_LABEL:
1096 cls_rule_set_ipv6_label(rule, value->be32);
1100 cls_rule_set_nw_proto(rule, value->u8);
1104 cls_rule_set_nw_dscp(rule, value->u8);
1108 cls_rule_set_nw_ecn(rule, value->u8);
1112 cls_rule_set_nw_ttl(rule, value->u8);
1116 cls_rule_set_nw_frag(rule, value->u8);
1120 cls_rule_set_nw_proto(rule, ntohs(value->be16));
1124 cls_rule_set_nw_src(rule, value->be32);
1128 cls_rule_set_nw_dst(rule, value->be32);
1133 cls_rule_set_arp_sha(rule, value->mac);
1138 cls_rule_set_arp_tha(rule, value->mac);
1143 cls_rule_set_tp_src(rule, value->be16);
1148 cls_rule_set_tp_dst(rule, value->be16);
1151 case MFF_ICMPV4_TYPE:
1152 case MFF_ICMPV6_TYPE:
1153 cls_rule_set_icmp_type(rule, value->u8);
1156 case MFF_ICMPV4_CODE:
1157 case MFF_ICMPV6_CODE:
1158 cls_rule_set_icmp_code(rule, value->u8);
1162 cls_rule_set_nd_target(rule, &value->ipv6);
1171 /* Makes 'rule' match field 'mf' exactly, with the value matched taken from
1172 * 'value'. The caller is responsible for ensuring that 'rule' meets 'mf''s
1175 mf_set_flow_value(const struct mf_field *mf,
1176 const union mf_value *value, struct flow *flow)
1180 flow->tun_id = value->be64;
1183 flow->metadata = value->be64;
1187 flow->in_port = ntohs(value->be16);
1191 flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1195 memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
1199 memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
1203 flow->dl_type = value->be16;
1207 flow->vlan_tci = value->be16;
1211 flow_set_vlan_vid(flow, value->be16);
1215 flow_set_vlan_pcp(flow, value->u8);
1219 flow->nw_src = value->be32;
1223 flow->nw_dst = value->be32;
1227 flow->ipv6_src = value->ipv6;
1231 flow->ipv6_dst = value->ipv6;
1234 case MFF_IPV6_LABEL:
1235 flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1239 flow->nw_proto = value->u8;
1243 flow->nw_tos &= ~IP_DSCP_MASK;
1244 flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1248 flow->nw_tos &= ~IP_ECN_MASK;
1249 flow->nw_tos |= value->u8 & IP_ECN_MASK;
1253 flow->nw_ttl = value->u8;
1257 flow->nw_frag &= value->u8;
1261 flow->nw_proto = ntohs(value->be16);
1265 flow->nw_src = value->be32;
1269 flow->nw_dst = value->be32;
1274 memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1279 memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1284 flow->tp_src = value->be16;
1289 flow->tp_dst = value->be16;
1292 case MFF_ICMPV4_TYPE:
1293 case MFF_ICMPV6_TYPE:
1294 flow->tp_src = htons(value->u8);
1297 case MFF_ICMPV4_CODE:
1298 case MFF_ICMPV6_CODE:
1299 flow->tp_dst = htons(value->u8);
1303 flow->nd_target = value->ipv6;
1312 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1314 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1317 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1319 union mf_value value;
1321 mf_get_value(mf, flow, &value);
1322 return is_all_zeros((const uint8_t *) &value, mf->n_bytes);
1325 /* Makes 'rule' wildcard field 'mf'.
1327 * The caller is responsible for ensuring that 'rule' meets 'mf''s
1330 mf_set_wild(const struct mf_field *mf, struct cls_rule *rule)
1334 cls_rule_set_tun_id_masked(rule, htonll(0), htonll(0));
1337 cls_rule_set_metadata_masked(rule, htonll(0), htonll(0));
1340 rule->wc.wildcards |= FWW_IN_PORT;
1341 rule->flow.in_port = 0;
1345 cls_rule_set_reg_masked(rule, mf->id - MFF_REG0, 0, 0);
1349 memset(rule->flow.dl_src, 0, ETH_ADDR_LEN);
1350 memset(rule->wc.dl_src_mask, 0, ETH_ADDR_LEN);
1354 memset(rule->flow.dl_dst, 0, ETH_ADDR_LEN);
1355 memset(rule->wc.dl_dst_mask, 0, ETH_ADDR_LEN);
1359 rule->wc.wildcards |= FWW_DL_TYPE;
1360 rule->flow.dl_type = htons(0);
1364 cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
1368 cls_rule_set_any_vid(rule);
1372 cls_rule_set_any_pcp(rule);
1377 cls_rule_set_nw_src_masked(rule, htonl(0), htonl(0));
1382 cls_rule_set_nw_dst_masked(rule, htonl(0), htonl(0));
1386 memset(&rule->wc.ipv6_src_mask, 0, sizeof rule->wc.ipv6_src_mask);
1387 memset(&rule->flow.ipv6_src, 0, sizeof rule->flow.ipv6_src);
1391 memset(&rule->wc.ipv6_dst_mask, 0, sizeof rule->wc.ipv6_dst_mask);
1392 memset(&rule->flow.ipv6_dst, 0, sizeof rule->flow.ipv6_dst);
1395 case MFF_IPV6_LABEL:
1396 rule->wc.ipv6_label_mask = 0;
1397 rule->flow.ipv6_label = 0;
1401 rule->wc.wildcards |= FWW_NW_PROTO;
1402 rule->flow.nw_proto = 0;
1406 rule->wc.wildcards |= FWW_NW_DSCP;
1407 rule->flow.nw_tos &= ~IP_DSCP_MASK;
1411 rule->wc.wildcards |= FWW_NW_ECN;
1412 rule->flow.nw_tos &= ~IP_ECN_MASK;
1416 rule->wc.wildcards |= FWW_NW_TTL;
1417 rule->flow.nw_ttl = 0;
1421 rule->wc.nw_frag_mask |= FLOW_NW_FRAG_MASK;
1422 rule->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1426 rule->wc.wildcards |= FWW_NW_PROTO;
1427 rule->flow.nw_proto = 0;
1432 rule->wc.wildcards |= FWW_ARP_SHA;
1433 memset(rule->flow.arp_sha, 0, sizeof rule->flow.arp_sha);
1438 rule->wc.wildcards |= FWW_ARP_THA;
1439 memset(rule->flow.arp_tha, 0, sizeof rule->flow.arp_tha);
1444 case MFF_ICMPV4_TYPE:
1445 case MFF_ICMPV6_TYPE:
1446 rule->wc.tp_src_mask = htons(0);
1447 rule->flow.tp_src = htons(0);
1452 case MFF_ICMPV4_CODE:
1453 case MFF_ICMPV6_CODE:
1454 rule->wc.tp_dst_mask = htons(0);
1455 rule->flow.tp_dst = htons(0);
1459 memset(&rule->wc.nd_target_mask, 0, sizeof rule->wc.nd_target_mask);
1460 memset(&rule->flow.nd_target, 0, sizeof rule->flow.nd_target);
1469 /* Makes 'rule' match field 'mf' with the specified 'value' and 'mask'.
1470 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1471 * with a 1-bit indicating that the corresponding value bit must match and a
1472 * 0-bit indicating a don't-care.
1474 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1475 * mf_set_value(mf, value, rule). If 'mask' points to all-0-bits, then this
1476 * call is equivalent to mf_set_wild(mf, rule).
1478 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
1479 * is responsible for ensuring that 'rule' meets 'mf''s prerequisites. */
1481 mf_set(const struct mf_field *mf,
1482 const union mf_value *value, const union mf_value *mask,
1483 struct cls_rule *rule)
1485 if (!mask || is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
1486 mf_set_value(mf, value, rule);
1488 } else if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
1489 mf_set_wild(mf, rule);
1505 case MFF_ICMPV4_TYPE:
1506 case MFF_ICMPV4_CODE:
1507 case MFF_ICMPV6_TYPE:
1508 case MFF_ICMPV6_CODE:
1514 cls_rule_set_tun_id_masked(rule, value->be64, mask->be64);
1517 cls_rule_set_metadata_masked(rule, value->be64, mask->be64);
1521 cls_rule_set_reg_masked(rule, mf->id - MFF_REG0,
1522 ntohl(value->be32), ntohl(mask->be32));
1526 cls_rule_set_dl_dst_masked(rule, value->mac, mask->mac);
1530 cls_rule_set_dl_src_masked(rule, value->mac, mask->mac);
1534 cls_rule_set_dl_tci_masked(rule, value->be16, mask->be16);
1538 cls_rule_set_nw_src_masked(rule, value->be32, mask->be32);
1542 cls_rule_set_nw_dst_masked(rule, value->be32, mask->be32);
1546 cls_rule_set_ipv6_src_masked(rule, &value->ipv6, &mask->ipv6);
1550 cls_rule_set_ipv6_dst_masked(rule, &value->ipv6, &mask->ipv6);
1553 case MFF_IPV6_LABEL:
1554 if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
1555 mf_set_value(mf, value, rule);
1557 cls_rule_set_ipv6_label_masked(rule, value->be32, mask->be32);
1562 cls_rule_set_nd_target_masked(rule, &value->ipv6, &mask->ipv6);
1566 cls_rule_set_nw_frag_masked(rule, value->u8, mask->u8);
1570 cls_rule_set_nw_src_masked(rule, value->be32, mask->be32);
1574 cls_rule_set_nw_dst_masked(rule, value->be32, mask->be32);
1579 cls_rule_set_tp_src_masked(rule, value->be16, mask->be16);
1584 cls_rule_set_tp_dst_masked(rule, value->be16, mask->be16);
1594 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
1598 VLOG_WARN_RL(&rl, "unknown %s field", type);
1599 } else if (!sf->n_bits) {
1600 VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
1601 } else if (sf->ofs >= sf->field->n_bits) {
1602 VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
1603 sf->ofs, sf->field->n_bits, type, sf->field->name);
1604 } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
1605 VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
1606 "of %s field %s", sf->ofs, sf->n_bits,
1607 sf->field->n_bits, type, sf->field->name);
1608 } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
1609 VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
1610 type, sf->field->name);
1615 return OFPERR_OFPBAC_BAD_ARGUMENT;
1618 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
1619 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
1622 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
1624 return mf_check__(sf, flow, "source");
1627 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
1628 * if so, otherwise an OpenFlow error code (e.g. as returned by
1631 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
1633 int error = mf_check__(sf, flow, "destination");
1634 if (!error && !sf->field->writable) {
1635 VLOG_WARN_RL(&rl, "destination field %s is not writable",
1637 return OFPERR_OFPBAC_BAD_ARGUMENT;
1642 /* Copies the value and wildcard bit pattern for 'mf' from 'rule' into the
1643 * 'value' and 'mask', respectively. */
1645 mf_get(const struct mf_field *mf, const struct cls_rule *rule,
1646 union mf_value *value, union mf_value *mask)
1648 mf_get_value(mf, &rule->flow, value);
1649 mf_get_mask(mf, &rule->wc, mask);
1652 /* Assigns a random value for field 'mf' to 'value'. */
1654 mf_random_value(const struct mf_field *mf, union mf_value *value)
1656 random_bytes(value, mf->n_bytes);
1681 case MFF_ICMPV4_TYPE:
1682 case MFF_ICMPV4_CODE:
1683 case MFF_ICMPV6_TYPE:
1684 case MFF_ICMPV6_CODE:
1690 case MFF_IPV6_LABEL:
1691 value->be32 &= ~htonl(IPV6_LABEL_MASK);
1695 value->u8 &= IP_DSCP_MASK;
1699 value->u8 &= IP_ECN_MASK;
1703 value->u8 &= FLOW_NW_FRAG_MASK;
1707 value->be16 &= htons(0xff);
1711 value->be16 &= htons(VLAN_VID_MASK);
1725 mf_from_integer_string(const struct mf_field *mf, const char *s,
1726 uint8_t *valuep, uint8_t *maskp)
1728 unsigned long long int integer, mask;
1733 integer = strtoull(s, &tail, 0);
1734 if (errno || (*tail != '\0' && *tail != '/')) {
1739 mask = strtoull(tail + 1, &tail, 0);
1740 if (errno || *tail != '\0') {
1747 for (i = mf->n_bytes - 1; i >= 0; i--) {
1748 valuep[i] = integer;
1754 return xasprintf("%s: value too large for %u-byte field %s",
1755 s, mf->n_bytes, mf->name);
1760 return xasprintf("%s: bad syntax for %s", s, mf->name);
1764 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
1765 uint8_t mac[ETH_ADDR_LEN],
1766 uint8_t mask[ETH_ADDR_LEN])
1768 assert(mf->n_bytes == ETH_ADDR_LEN);
1770 switch (sscanf(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT,
1771 ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask))){
1772 case ETH_ADDR_SCAN_COUNT * 2:
1775 case ETH_ADDR_SCAN_COUNT:
1776 memset(mask, 0xff, ETH_ADDR_LEN);
1780 return xasprintf("%s: invalid Ethernet address", s);
1785 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
1786 ovs_be32 *ip, ovs_be32 *mask)
1790 assert(mf->n_bytes == sizeof *ip);
1792 if (sscanf(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
1793 IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask)) == IP_SCAN_COUNT * 2) {
1795 } else if (sscanf(s, IP_SCAN_FMT"/%d",
1796 IP_SCAN_ARGS(ip), &prefix) == IP_SCAN_COUNT + 1) {
1797 if (prefix <= 0 || prefix > 32) {
1798 return xasprintf("%s: network prefix bits not between 1 and "
1800 } else if (prefix == 32) {
1801 *mask = htonl(UINT32_MAX);
1803 *mask = htonl(((1u << prefix) - 1) << (32 - prefix));
1805 } else if (sscanf(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip)) == IP_SCAN_COUNT) {
1806 *mask = htonl(UINT32_MAX);
1808 return xasprintf("%s: invalid IP address", s);
1814 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
1815 struct in6_addr *value, struct in6_addr *mask)
1817 char *str = xstrdup(s);
1818 char *save_ptr = NULL;
1819 const char *name, *netmask;
1822 assert(mf->n_bytes == sizeof *value);
1824 name = strtok_r(str, "/", &save_ptr);
1825 retval = name ? lookup_ipv6(name, value) : EINVAL;
1829 err = xasprintf("%s: could not convert to IPv6 address", str);
1835 netmask = strtok_r(NULL, "/", &save_ptr);
1837 if (inet_pton(AF_INET6, netmask, mask) != 1) {
1838 int prefix = atoi(netmask);
1839 if (prefix <= 0 || prefix > 128) {
1841 return xasprintf("%s: prefix bits not between 1 and 128", s);
1843 *mask = ipv6_create_mask(prefix);
1847 *mask = in6addr_exact;
1855 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
1856 ovs_be16 *valuep, ovs_be16 *maskp)
1860 assert(mf->n_bytes == sizeof(ovs_be16));
1861 if (ofputil_port_from_string(s, &port)) {
1862 *valuep = htons(port);
1863 *maskp = htons(UINT16_MAX);
1866 return mf_from_integer_string(mf, s,
1867 (uint8_t *) valuep, (uint8_t *) maskp);
1871 struct frag_handling {
1877 static const struct frag_handling all_frags[] = {
1878 #define A FLOW_NW_FRAG_ANY
1879 #define L FLOW_NW_FRAG_LATER
1880 /* name mask value */
1883 { "first", A|L, A },
1884 { "later", A|L, A|L },
1889 { "not_later", L, 0 },
1896 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
1898 const struct frag_handling *h;
1900 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
1901 if (!strcasecmp(s, h->name)) {
1902 /* We force the upper bits of the mask on to make mf_parse_value()
1903 * happy (otherwise it will never think it's an exact match.) */
1904 *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
1910 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
1911 "\"yes\", \"first\", \"later\", \"not_first\"", s);
1914 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
1915 * NULL if successful, otherwise a malloc()'d string describing the error. */
1917 mf_parse(const struct mf_field *mf, const char *s,
1918 union mf_value *value, union mf_value *mask)
1920 if (!strcasecmp(s, "any") || !strcmp(s, "*")) {
1921 memset(value, 0, mf->n_bytes);
1922 memset(mask, 0, mf->n_bytes);
1926 switch (mf->string) {
1928 case MFS_HEXADECIMAL:
1929 return mf_from_integer_string(mf, s,
1930 (uint8_t *) value, (uint8_t *) mask);
1933 return mf_from_ethernet_string(mf, s, value->mac, mask->mac);
1936 return mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
1939 return mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
1942 return mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
1945 return mf_from_frag_string(s, &value->u8, &mask->u8);
1950 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
1951 * successful, otherwise a malloc()'d string describing the error. */
1953 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
1955 union mf_value mask;
1958 error = mf_parse(mf, s, value, &mask);
1963 if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
1964 return xasprintf("%s: wildcards not allowed here", s);
1970 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
1971 const uint8_t *maskp, struct ds *s)
1973 unsigned long long int integer;
1976 assert(mf->n_bytes <= 8);
1979 for (i = 0; i < mf->n_bytes; i++) {
1980 integer = (integer << 8) | valuep[i];
1982 if (mf->string == MFS_HEXADECIMAL) {
1983 ds_put_format(s, "%#llx", integer);
1985 ds_put_format(s, "%lld", integer);
1989 unsigned long long int mask;
1992 for (i = 0; i < mf->n_bytes; i++) {
1993 mask = (mask << 8) | maskp[i];
1996 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
1997 * not sure that that a bit-mask written in decimal is ever easier to
1998 * understand than the same bit-mask written in hexadecimal. */
1999 ds_put_format(s, "/%#llx", mask);
2004 mf_format_frag_string(const uint8_t *valuep, const uint8_t *maskp,
2007 const struct frag_handling *h;
2008 uint8_t value = *valuep;
2009 uint8_t mask = *maskp;
2012 mask &= FLOW_NW_FRAG_MASK;
2014 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2015 if (value == h->value && mask == h->mask) {
2016 ds_put_cstr(s, h->name);
2020 ds_put_cstr(s, "<error>");
2023 /* Appends to 's' a string representation of field 'mf' whose value is in
2024 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2026 mf_format(const struct mf_field *mf,
2027 const union mf_value *value, const union mf_value *mask,
2031 if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2032 ds_put_cstr(s, "ANY");
2034 } else if (is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2039 switch (mf->string) {
2042 ofputil_format_port(ntohs(value->be16), s);
2047 case MFS_HEXADECIMAL:
2048 mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2052 eth_format_masked(value->mac, mask->mac, s);
2056 ip_format_masked(value->be32, mask ? mask->be32 : htonl(UINT32_MAX),
2061 print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2065 mf_format_frag_string(&value->u8, &mask->u8, s);
2073 /* Makes subfield 'sf' within 'rule' exactly match the 'sf->n_bits'
2074 * least-significant bits in 'x'.
2077 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2078 struct cls_rule *rule)
2080 const struct mf_field *field = sf->field;
2081 union mf_value value, mask;
2083 mf_get(field, rule, &value, &mask);
2084 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2085 bitwise_one ( &mask, field->n_bytes, sf->ofs, sf->n_bits);
2086 mf_set(field, &value, &mask, rule);
2089 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2090 * reading 'flow', e.g. as checked by mf_check_src(). */
2092 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2093 union mf_subvalue *x)
2095 union mf_value value;
2097 mf_get_value(sf->field, flow, &value);
2099 memset(x, 0, sizeof *x);
2100 bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2105 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2106 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2109 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2111 union mf_value value;
2113 mf_get_value(sf->field, flow, &value);
2114 return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2117 /* Formats 'sf' into 's' in a format normally acceptable to
2118 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2119 * sf->field has no NXM name.) */
2121 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
2124 ds_put_cstr(s, "<unknown>");
2125 } else if (sf->field->nxm_name) {
2126 ds_put_cstr(s, sf->field->nxm_name);
2127 } else if (sf->field->nxm_header) {
2128 uint32_t header = sf->field->nxm_header;
2129 ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
2131 ds_put_cstr(s, sf->field->name);
2134 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
2135 ds_put_cstr(s, "[]");
2136 } else if (sf->n_bits == 1) {
2137 ds_put_format(s, "[%d]", sf->ofs);
2139 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
2143 static const struct mf_field *
2144 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
2148 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
2153 for (i = 0; i < MFF_N_IDS; i++) {
2154 const struct mf_field *mf = mf_from_id(i);
2157 && !strncmp(mf->nxm_name, name, name_len)
2158 && mf->nxm_name[name_len] == '\0') {
2162 && !strncmp(mf->oxm_name, name, name_len)
2163 && mf->oxm_name[name_len] == '\0') {
2171 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2172 * returns NULL and advances '*sp' to the first byte following the parsed
2173 * string. On failure, returns a malloc()'d error message, does not modify
2174 * '*sp', and does not properly initialize 'sf'.
2176 * The syntax parsed from '*sp' takes the form "header[start..end]" where
2177 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2178 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2179 * may both be omitted (the [] are still required) to indicate an entire
2182 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
2184 const struct mf_field *field;
2193 name_len = strcspn(s, "[");
2194 if (s[name_len] != '[') {
2195 return xasprintf("%s: missing [ looking for field name", *sp);
2198 field = mf_parse_subfield_name(name, name_len, &wild);
2200 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
2204 if (sscanf(s, "[%d..%d]", &start, &end) == 2) {
2205 /* Nothing to do. */
2206 } else if (sscanf(s, "[%d]", &start) == 1) {
2208 } else if (!strncmp(s, "[]", 2)) {
2210 end = field->n_bits - 1;
2212 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2213 "[<start>..<end>]", *sp);
2215 s = strchr(s, ']') + 1;
2218 return xasprintf("%s: starting bit %d is after ending bit %d",
2220 } else if (start >= field->n_bits) {
2221 return xasprintf("%s: starting bit %d is not valid because field is "
2222 "only %d bits wide", *sp, start, field->n_bits);
2223 } else if (end >= field->n_bits){
2224 return xasprintf("%s: ending bit %d is not valid because field is "
2225 "only %d bits wide", *sp, end, field->n_bits);
2230 sf->n_bits = end - start + 1;
2236 /* Parses a subfield from the beginning of 's' into 'sf'. Returns the first
2237 * byte in 's' following the parsed string.
2239 * Exits with an error message if 's' has incorrect syntax.
2241 * The syntax parsed from 's' takes the form "header[start..end]" where
2242 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2243 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2244 * may both be omitted (the [] are still required) to indicate an entire
2247 mf_parse_subfield(struct mf_subfield *sf, const char *s)
2249 char *msg = mf_parse_subfield__(sf, &s);
2251 ovs_fatal(0, "%s", msg);