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),
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_DL_VLAN, "dl_vlan", NULL,
161 sizeof(ovs_be16), 12,
169 MFF_VLAN_VID, "vlan_vid", NULL,
170 sizeof(ovs_be16), 12,
175 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
176 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
178 MFF_DL_VLAN_PCP, "dl_vlan_pcp", NULL,
187 MFF_VLAN_PCP, "vlan_pcp", NULL,
193 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
194 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
202 MFF_IPV4_SRC, "ip_src", "nw_src",
203 MF_FIELD_SIZES(be32),
208 NXM_OF_IP_SRC, "NXM_OF_IP_SRC",
209 OXM_OF_IPV4_SRC, "OXM_OF_IPV4_SRC",
211 MFF_IPV4_DST, "ip_dst", "nw_dst",
212 MF_FIELD_SIZES(be32),
217 NXM_OF_IP_DST, "NXM_OF_IP_DST",
218 OXM_OF_IPV4_DST, "OXM_OF_IPV4_DST",
222 MFF_IPV6_SRC, "ipv6_src", NULL,
223 MF_FIELD_SIZES(ipv6),
228 NXM_NX_IPV6_SRC, "NXM_NX_IPV6_SRC",
229 OXM_OF_IPV6_SRC, "OXM_OF_IPV6_SRC",
231 MFF_IPV6_DST, "ipv6_dst", NULL,
232 MF_FIELD_SIZES(ipv6),
237 NXM_NX_IPV6_DST, "NXM_NX_IPV6_DST",
238 OXM_OF_IPV6_DST, "OXM_OF_IPV6_DST",
241 MFF_IPV6_LABEL, "ipv6_label", NULL,
247 NXM_NX_IPV6_LABEL, "NXM_NX_IPV6_LABEL",
248 OXM_OF_IPV6_FLABEL, "OXM_OF_IPV6_FLABEL",
252 MFF_IP_PROTO, "nw_proto", NULL,
258 NXM_OF_IP_PROTO, "NXM_OF_IP_PROTO",
259 OXM_OF_IP_PROTO, "OXM_OF_IP_PROTO",
261 MFF_IP_DSCP, "nw_tos", NULL,
267 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
268 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
270 MFF_IP_ECN, "nw_ecn", NULL,
276 NXM_NX_IP_ECN, "NXM_NX_IP_ECN",
277 OXM_OF_IP_ECN, "OXM_OF_IP_ECN",
279 MFF_IP_TTL, "nw_ttl", NULL,
285 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
286 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
288 MFF_IP_FRAG, "ip_frag", NULL,
294 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
295 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
299 MFF_ARP_OP, "arp_op", NULL,
300 MF_FIELD_SIZES(be16),
305 NXM_OF_ARP_OP, "NXM_OF_ARP_OP",
306 OXM_OF_ARP_OP, "OXM_OF_ARP_OP",
308 MFF_ARP_SPA, "arp_spa", NULL,
309 MF_FIELD_SIZES(be32),
314 NXM_OF_ARP_SPA, "NXM_OF_ARP_SPA",
315 OXM_OF_ARP_SPA, "OXM_OF_ARP_SPA",
317 MFF_ARP_TPA, "arp_tpa", NULL,
318 MF_FIELD_SIZES(be32),
323 NXM_OF_ARP_TPA, "NXM_OF_ARP_TPA",
324 OXM_OF_ARP_TPA, "OXM_OF_ARP_TPA",
326 MFF_ARP_SHA, "arp_sha", NULL,
332 NXM_NX_ARP_SHA, "NXM_NX_ARP_SHA",
333 OXM_OF_ARP_SHA, "OXM_OF_ARP_SHA",
335 MFF_ARP_THA, "arp_tha", NULL,
341 NXM_NX_ARP_THA, "NXM_NX_ARP_THA",
342 OXM_OF_ARP_THA, "OXM_OF_ARP_THA",
350 MFF_TCP_SRC, "tcp_src", "tp_src",
351 MF_FIELD_SIZES(be16),
356 NXM_OF_TCP_SRC, "NXM_OF_TCP_SRC",
357 OXM_OF_TCP_SRC, "OXM_OF_TCP_SRC",
359 MFF_TCP_DST, "tcp_dst", "tp_dst",
360 MF_FIELD_SIZES(be16),
365 NXM_OF_TCP_DST, "NXM_OF_TCP_DST",
366 OXM_OF_TCP_DST, "OXM_OF_TCP_DST",
370 MFF_UDP_SRC, "udp_src", NULL,
371 MF_FIELD_SIZES(be16),
376 NXM_OF_UDP_SRC, "NXM_OF_UDP_SRC",
377 OXM_OF_UDP_SRC, "OXM_OF_UDP_SRC",
379 MFF_UDP_DST, "udp_dst", NULL,
380 MF_FIELD_SIZES(be16),
385 NXM_OF_UDP_DST, "NXM_OF_UDP_DST",
386 OXM_OF_UDP_DST, "OXM_OF_UDP_DST",
390 MFF_ICMPV4_TYPE, "icmp_type", NULL,
396 NXM_OF_ICMP_TYPE, "NXM_OF_ICMP_TYPE",
397 OXM_OF_ICMPV4_TYPE, "OXM_OF_ICMPV4_TYPE",
399 MFF_ICMPV4_CODE, "icmp_code", NULL,
405 NXM_OF_ICMP_CODE, "NXM_OF_ICMP_CODE",
406 OXM_OF_ICMPV4_CODE, "OXM_OF_ICMPV4_CODE",
410 MFF_ICMPV6_TYPE, "icmpv6_type", NULL,
416 NXM_NX_ICMPV6_TYPE, "NXM_NX_ICMPV6_TYPE",
417 OXM_OF_ICMPV6_TYPE, "OXM_OF_ICMPV6_TYPE",
419 MFF_ICMPV6_CODE, "icmpv6_code", NULL,
425 NXM_NX_ICMPV6_CODE, "NXM_NX_ICMPV6_CODE",
426 OXM_OF_ICMPV6_CODE, "OXM_OF_ICMPV6_CODE",
434 MFF_ND_TARGET, "nd_target", NULL,
435 MF_FIELD_SIZES(ipv6),
440 NXM_NX_ND_TARGET, "NXM_NX_ND_TARGET",
441 OXM_OF_IPV6_ND_TARGET, "OXM_OF_IPV6_ND_TARGET",
443 MFF_ND_SLL, "nd_sll", NULL,
449 NXM_NX_ND_SLL, "NXM_NX_ND_SLL",
450 OXM_OF_IPV6_ND_SLL, "OXM_OF_IPV6_ND_SLL",
452 MFF_ND_TLL, "nd_tll", NULL,
458 NXM_NX_ND_TLL, "NXM_NX_ND_TLL",
459 OXM_OF_IPV6_ND_TLL, "OXM_OF_IPV6_ND_TLL",
463 /* Maps an NXM or OXM header value to an mf_field. */
465 struct hmap_node hmap_node; /* In 'all_fields' hmap. */
466 uint32_t header; /* NXM or OXM header value. */
467 const struct mf_field *mf;
470 /* Contains 'struct nxm_field's. */
471 static struct hmap all_fields = HMAP_INITIALIZER(&all_fields);
473 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
474 * controller and so there's not much point in showing a lot of them. */
475 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
477 const struct mf_field *mf_from_nxm_header__(uint32_t header);
479 /* Returns the field with the given 'id'. */
480 const struct mf_field *
481 mf_from_id(enum mf_field_id id)
483 assert((unsigned int) id < MFF_N_IDS);
484 return &mf_fields[id];
487 /* Returns the field with the given 'name', or a null pointer if no field has
489 const struct mf_field *
490 mf_from_name(const char *name)
492 static struct shash mf_by_name = SHASH_INITIALIZER(&mf_by_name);
494 if (shash_is_empty(&mf_by_name)) {
495 const struct mf_field *mf;
497 for (mf = mf_fields; mf < &mf_fields[MFF_N_IDS]; mf++) {
498 shash_add_once(&mf_by_name, mf->name, mf);
499 if (mf->extra_name) {
500 shash_add_once(&mf_by_name, mf->extra_name, mf);
505 return shash_find_data(&mf_by_name, name);
509 add_nxm_field(uint32_t header, const struct mf_field *mf)
513 f = xmalloc(sizeof *f);
514 hmap_insert(&all_fields, &f->hmap_node, hash_int(header, 0));
520 nxm_init_add_field(const struct mf_field *mf, uint32_t header)
523 assert(!mf_from_nxm_header__(header));
524 add_nxm_field(header, mf);
525 if (mf->maskable != MFM_NONE) {
526 add_nxm_field(NXM_MAKE_WILD_HEADER(header), mf);
534 const struct mf_field *mf;
536 for (mf = mf_fields; mf < &mf_fields[MFF_N_IDS]; mf++) {
537 nxm_init_add_field(mf, mf->nxm_header);
538 if (mf->oxm_header != mf->nxm_header) {
539 nxm_init_add_field(mf, mf->oxm_header);
544 const struct mf_field *
545 mf_from_nxm_header(uint32_t header)
547 if (hmap_is_empty(&all_fields)) {
550 return mf_from_nxm_header__(header);
553 const struct mf_field *
554 mf_from_nxm_header__(uint32_t header)
556 const struct nxm_field *f;
558 HMAP_FOR_EACH_IN_BUCKET (f, hmap_node, hash_int(header, 0), &all_fields) {
559 if (f->header == header) {
567 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
568 * specifies at least one bit in the field.
570 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
571 * meets 'mf''s prerequisites. */
573 mf_is_all_wild(const struct mf_field *mf, const struct flow_wildcards *wc)
577 assert(mf->fww_bit != 0);
578 return (wc->wildcards & mf->fww_bit) != 0;
581 return !wc->tun_id_mask;
583 return !wc->metadata_mask;
586 return !wc->reg_masks[mf->id - MFF_REG0];
589 return eth_addr_is_zero(wc->dl_src_mask);
591 return eth_addr_is_zero(wc->dl_dst_mask);
593 return !wc->dl_type_mask;
597 return eth_addr_is_zero(wc->arp_sha_mask);
601 return eth_addr_is_zero(wc->arp_tha_mask);
604 return !wc->vlan_tci_mask;
606 return !(wc->vlan_tci_mask & htons(VLAN_VID_MASK));
608 return !(wc->vlan_tci_mask & htons(VLAN_VID_MASK | VLAN_CFI));
609 case MFF_DL_VLAN_PCP:
611 return !(wc->vlan_tci_mask & htons(VLAN_PCP_MASK));
614 return !wc->nw_src_mask;
616 return !wc->nw_dst_mask;
619 return ipv6_mask_is_any(&wc->ipv6_src_mask);
621 return ipv6_mask_is_any(&wc->ipv6_dst_mask);
624 return !wc->ipv6_label_mask;
627 return !wc->nw_proto_mask;
629 return !(wc->nw_tos_mask & IP_DSCP_MASK);
631 return !(wc->nw_tos_mask & IP_ECN_MASK);
633 return !wc->nw_ttl_mask;
636 return ipv6_mask_is_any(&wc->nd_target_mask);
639 return !(wc->nw_frag_mask & FLOW_NW_FRAG_MASK);
642 return !wc->nw_proto_mask;
644 return !wc->nw_src_mask;
646 return !wc->nw_dst_mask;
650 case MFF_ICMPV4_TYPE:
651 case MFF_ICMPV6_TYPE:
652 return !wc->tp_src_mask;
655 case MFF_ICMPV4_CODE:
656 case MFF_ICMPV6_CODE:
657 return !wc->tp_dst_mask;
665 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
666 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
667 * purposes, or to 0 if it is wildcarded.
669 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
670 * meets 'mf''s prerequisites. */
672 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
673 union mf_value *mask)
677 assert(mf->fww_bit != 0);
678 memset(mask, wc->wildcards & mf->fww_bit ? 0x00 : 0xff, mf->n_bytes);
682 mask->be64 = wc->tun_id_mask;
685 mask->be64 = wc->metadata_mask;
689 mask->be32 = htonl(wc->reg_masks[mf->id - MFF_REG0]);
693 memcpy(mask->mac, wc->dl_dst_mask, ETH_ADDR_LEN);
696 memcpy(mask->mac, wc->dl_src_mask, ETH_ADDR_LEN);
699 mask->be16 = wc->dl_type_mask;
703 mask->be16 = wc->vlan_tci_mask;
706 mask->be16 = wc->vlan_tci_mask & htons(VLAN_VID_MASK);
709 mask->be16 = wc->vlan_tci_mask & htons(VLAN_VID_MASK | VLAN_CFI);
711 case MFF_DL_VLAN_PCP:
713 mask->u8 = vlan_tci_to_pcp(wc->vlan_tci_mask);
717 mask->be32 = wc->nw_src_mask;
720 mask->be32 = wc->nw_dst_mask;
724 mask->ipv6 = wc->ipv6_src_mask;
727 mask->ipv6 = wc->ipv6_dst_mask;
730 mask->be32 = wc->ipv6_label_mask;
734 mask->u8 = wc->nw_proto_mask;
737 mask->u8 = wc->nw_tos_mask & IP_DSCP_MASK;
740 mask->u8 = wc->nw_tos_mask & IP_ECN_MASK;
744 mask->ipv6 = wc->nd_target_mask;
748 mask->u8 = wc->nw_ttl_mask;
751 mask->u8 = wc->nw_frag_mask & FLOW_NW_FRAG_MASK;
755 mask->u8 = wc->nw_proto_mask;
758 mask->be32 = wc->nw_src_mask;
761 mask->be32 = wc->nw_dst_mask;
765 memcpy(mask->mac, wc->arp_sha_mask, ETH_ADDR_LEN);
769 memcpy(mask->mac, wc->arp_tha_mask, ETH_ADDR_LEN);
774 mask->be16 = wc->tp_src_mask;
778 mask->be16 = wc->tp_dst_mask;
781 case MFF_ICMPV4_TYPE:
782 case MFF_ICMPV6_TYPE:
783 mask->u8 = ntohs(wc->tp_src_mask);
785 case MFF_ICMPV4_CODE:
786 case MFF_ICMPV6_CODE:
787 mask->u8 = ntohs(wc->tp_dst_mask);
796 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
797 * if the mask is valid, false otherwise. */
799 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
801 switch (mf->maskable) {
803 return (is_all_zeros((const uint8_t *) mask, mf->n_bytes) ||
804 is_all_ones((const uint8_t *) mask, mf->n_bytes));
814 is_ip_any(const struct flow *flow)
816 return (flow->dl_type == htons(ETH_TYPE_IP) ||
817 flow->dl_type == htons(ETH_TYPE_IPV6));
821 is_icmpv4(const struct flow *flow)
823 return (flow->dl_type == htons(ETH_TYPE_IP)
824 && flow->nw_proto == IPPROTO_ICMP);
828 is_icmpv6(const struct flow *flow)
830 return (flow->dl_type == htons(ETH_TYPE_IPV6)
831 && flow->nw_proto == IPPROTO_ICMPV6);
834 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
836 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
838 switch (mf->prereqs) {
843 return flow->dl_type == htons(ETH_TYPE_ARP);
845 return flow->dl_type == htons(ETH_TYPE_IP);
847 return flow->dl_type == htons(ETH_TYPE_IPV6);
849 return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
851 return is_ip_any(flow);
854 return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP;
856 return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP;
858 return is_icmpv4(flow);
860 return is_icmpv6(flow);
863 return (is_icmpv6(flow)
864 && flow->tp_dst == htons(0)
865 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
866 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
868 return (is_icmpv6(flow)
869 && flow->tp_dst == htons(0)
870 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
872 return (is_icmpv6(flow)
873 && flow->tp_dst == htons(0)
874 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
880 /* Returns true if 'value' may be a valid value *as part of a masked match*,
883 * A value is not rejected just because it is not valid for the field in
884 * question, but only if it doesn't make sense to test the bits in question at
885 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
886 * without the VLAN_CFI bit being set, but we can't reject those values because
887 * it is still legitimate to test just for those bits (see the documentation
888 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
889 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
891 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
916 case MFF_ICMPV4_TYPE:
917 case MFF_ICMPV4_CODE:
918 case MFF_ICMPV6_TYPE:
919 case MFF_ICMPV6_CODE:
926 return !(value->u8 & ~IP_DSCP_MASK);
928 return !(value->u8 & ~IP_ECN_MASK);
930 return !(value->u8 & ~FLOW_NW_FRAG_MASK);
933 return !(value->be16 & htons(0xff00));
936 return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
938 return !(value->be16 & htons(VLAN_PCP_MASK));
940 case MFF_DL_VLAN_PCP:
942 return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
945 return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
953 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
954 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
956 mf_get_value(const struct mf_field *mf, const struct flow *flow,
957 union mf_value *value)
961 value->be64 = flow->tun_id;
964 value->be64 = flow->metadata;
968 value->be16 = htons(flow->in_port);
972 value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
976 memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
980 memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
984 value->be16 = flow->dl_type;
988 value->be16 = flow->vlan_tci;
992 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
995 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
998 case MFF_DL_VLAN_PCP:
1000 value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
1004 value->be32 = flow->nw_src;
1008 value->be32 = flow->nw_dst;
1012 value->ipv6 = flow->ipv6_src;
1016 value->ipv6 = flow->ipv6_dst;
1019 case MFF_IPV6_LABEL:
1020 value->be32 = flow->ipv6_label;
1024 value->u8 = flow->nw_proto;
1028 value->u8 = flow->nw_tos & IP_DSCP_MASK;
1032 value->u8 = flow->nw_tos & IP_ECN_MASK;
1036 value->u8 = flow->nw_ttl;
1040 value->u8 = flow->nw_frag;
1044 value->be16 = htons(flow->nw_proto);
1048 value->be32 = flow->nw_src;
1052 value->be32 = flow->nw_dst;
1057 memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
1062 memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
1067 value->be16 = flow->tp_src;
1072 value->be16 = flow->tp_dst;
1075 case MFF_ICMPV4_TYPE:
1076 case MFF_ICMPV6_TYPE:
1077 value->u8 = ntohs(flow->tp_src);
1080 case MFF_ICMPV4_CODE:
1081 case MFF_ICMPV6_CODE:
1082 value->u8 = ntohs(flow->tp_dst);
1086 value->ipv6 = flow->nd_target;
1095 /* Makes 'rule' match field 'mf' exactly, with the value matched taken from
1096 * 'value'. The caller is responsible for ensuring that 'rule' meets 'mf''s
1099 mf_set_value(const struct mf_field *mf,
1100 const union mf_value *value, struct cls_rule *rule)
1104 cls_rule_set_tun_id(rule, value->be64);
1107 cls_rule_set_metadata(rule, value->be64);
1111 cls_rule_set_in_port(rule, ntohs(value->be16));
1115 cls_rule_set_reg(rule, mf->id - MFF_REG0, ntohl(value->be32));
1119 cls_rule_set_dl_src(rule, value->mac);
1123 cls_rule_set_dl_dst(rule, value->mac);
1127 cls_rule_set_dl_type(rule, value->be16);
1131 cls_rule_set_dl_tci(rule, value->be16);
1135 cls_rule_set_dl_vlan(rule, value->be16);
1138 cls_rule_set_vlan_vid(rule, value->be16);
1141 case MFF_DL_VLAN_PCP:
1143 cls_rule_set_dl_vlan_pcp(rule, value->u8);
1147 cls_rule_set_nw_src(rule, value->be32);
1151 cls_rule_set_nw_dst(rule, value->be32);
1155 cls_rule_set_ipv6_src(rule, &value->ipv6);
1159 cls_rule_set_ipv6_dst(rule, &value->ipv6);
1162 case MFF_IPV6_LABEL:
1163 cls_rule_set_ipv6_label(rule, value->be32);
1167 cls_rule_set_nw_proto(rule, value->u8);
1171 cls_rule_set_nw_dscp(rule, value->u8);
1175 cls_rule_set_nw_ecn(rule, value->u8);
1179 cls_rule_set_nw_ttl(rule, value->u8);
1183 cls_rule_set_nw_frag(rule, value->u8);
1187 cls_rule_set_nw_proto(rule, ntohs(value->be16));
1191 cls_rule_set_nw_src(rule, value->be32);
1195 cls_rule_set_nw_dst(rule, value->be32);
1200 cls_rule_set_arp_sha(rule, value->mac);
1205 cls_rule_set_arp_tha(rule, value->mac);
1210 cls_rule_set_tp_src(rule, value->be16);
1215 cls_rule_set_tp_dst(rule, value->be16);
1218 case MFF_ICMPV4_TYPE:
1219 case MFF_ICMPV6_TYPE:
1220 cls_rule_set_icmp_type(rule, value->u8);
1223 case MFF_ICMPV4_CODE:
1224 case MFF_ICMPV6_CODE:
1225 cls_rule_set_icmp_code(rule, value->u8);
1229 cls_rule_set_nd_target(rule, &value->ipv6);
1238 /* Makes 'rule' match field 'mf' exactly, with the value matched taken from
1239 * 'value'. The caller is responsible for ensuring that 'rule' meets 'mf''s
1242 mf_set_flow_value(const struct mf_field *mf,
1243 const union mf_value *value, struct flow *flow)
1247 flow->tun_id = value->be64;
1250 flow->metadata = value->be64;
1254 flow->in_port = ntohs(value->be16);
1258 flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1262 memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
1266 memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
1270 flow->dl_type = value->be16;
1274 flow->vlan_tci = value->be16;
1278 flow_set_dl_vlan(flow, value->be16);
1281 flow_set_vlan_vid(flow, value->be16);
1284 case MFF_DL_VLAN_PCP:
1286 flow_set_vlan_pcp(flow, value->u8);
1290 flow->nw_src = value->be32;
1294 flow->nw_dst = value->be32;
1298 flow->ipv6_src = value->ipv6;
1302 flow->ipv6_dst = value->ipv6;
1305 case MFF_IPV6_LABEL:
1306 flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1310 flow->nw_proto = value->u8;
1314 flow->nw_tos &= ~IP_DSCP_MASK;
1315 flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1319 flow->nw_tos &= ~IP_ECN_MASK;
1320 flow->nw_tos |= value->u8 & IP_ECN_MASK;
1324 flow->nw_ttl = value->u8;
1328 flow->nw_frag &= value->u8;
1332 flow->nw_proto = ntohs(value->be16);
1336 flow->nw_src = value->be32;
1340 flow->nw_dst = value->be32;
1345 memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1350 memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1355 flow->tp_src = value->be16;
1360 flow->tp_dst = value->be16;
1363 case MFF_ICMPV4_TYPE:
1364 case MFF_ICMPV6_TYPE:
1365 flow->tp_src = htons(value->u8);
1368 case MFF_ICMPV4_CODE:
1369 case MFF_ICMPV6_CODE:
1370 flow->tp_dst = htons(value->u8);
1374 flow->nd_target = value->ipv6;
1383 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1385 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1388 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1390 union mf_value value;
1392 mf_get_value(mf, flow, &value);
1393 return is_all_zeros((const uint8_t *) &value, mf->n_bytes);
1396 /* Makes 'rule' wildcard field 'mf'.
1398 * The caller is responsible for ensuring that 'rule' meets 'mf''s
1401 mf_set_wild(const struct mf_field *mf, struct cls_rule *rule)
1405 cls_rule_set_tun_id_masked(rule, htonll(0), htonll(0));
1408 cls_rule_set_metadata_masked(rule, htonll(0), htonll(0));
1411 rule->wc.wildcards |= FWW_IN_PORT;
1412 rule->flow.in_port = 0;
1416 cls_rule_set_reg_masked(rule, mf->id - MFF_REG0, 0, 0);
1420 memset(rule->flow.dl_src, 0, ETH_ADDR_LEN);
1421 memset(rule->wc.dl_src_mask, 0, ETH_ADDR_LEN);
1425 memset(rule->flow.dl_dst, 0, ETH_ADDR_LEN);
1426 memset(rule->wc.dl_dst_mask, 0, ETH_ADDR_LEN);
1430 rule->flow.dl_type = htons(0);
1431 rule->wc.dl_type_mask = htons(0);
1435 cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
1440 cls_rule_set_any_vid(rule);
1443 case MFF_DL_VLAN_PCP:
1445 cls_rule_set_any_pcp(rule);
1450 cls_rule_set_nw_src_masked(rule, htonl(0), htonl(0));
1455 cls_rule_set_nw_dst_masked(rule, htonl(0), htonl(0));
1459 memset(&rule->wc.ipv6_src_mask, 0, sizeof rule->wc.ipv6_src_mask);
1460 memset(&rule->flow.ipv6_src, 0, sizeof rule->flow.ipv6_src);
1464 memset(&rule->wc.ipv6_dst_mask, 0, sizeof rule->wc.ipv6_dst_mask);
1465 memset(&rule->flow.ipv6_dst, 0, sizeof rule->flow.ipv6_dst);
1468 case MFF_IPV6_LABEL:
1469 rule->wc.ipv6_label_mask = 0;
1470 rule->flow.ipv6_label = 0;
1474 rule->wc.nw_proto_mask = 0;
1475 rule->flow.nw_proto = 0;
1479 rule->wc.nw_tos_mask &= ~IP_DSCP_MASK;
1480 rule->flow.nw_tos &= ~IP_DSCP_MASK;
1484 rule->wc.nw_tos_mask &= ~IP_ECN_MASK;
1485 rule->flow.nw_tos &= ~IP_ECN_MASK;
1489 rule->wc.nw_ttl_mask = 0;
1490 rule->flow.nw_ttl = 0;
1494 rule->wc.nw_frag_mask |= FLOW_NW_FRAG_MASK;
1495 rule->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
1499 rule->wc.nw_proto_mask = 0;
1500 rule->flow.nw_proto = 0;
1505 memset(rule->flow.arp_sha, 0, ETH_ADDR_LEN);
1506 memset(rule->wc.arp_sha_mask, 0, ETH_ADDR_LEN);
1511 memset(rule->flow.arp_tha, 0, ETH_ADDR_LEN);
1512 memset(rule->wc.arp_tha_mask, 0, ETH_ADDR_LEN);
1517 case MFF_ICMPV4_TYPE:
1518 case MFF_ICMPV6_TYPE:
1519 rule->wc.tp_src_mask = htons(0);
1520 rule->flow.tp_src = htons(0);
1525 case MFF_ICMPV4_CODE:
1526 case MFF_ICMPV6_CODE:
1527 rule->wc.tp_dst_mask = htons(0);
1528 rule->flow.tp_dst = htons(0);
1532 memset(&rule->wc.nd_target_mask, 0, sizeof rule->wc.nd_target_mask);
1533 memset(&rule->flow.nd_target, 0, sizeof rule->flow.nd_target);
1542 /* Makes 'rule' match field 'mf' with the specified 'value' and 'mask'.
1543 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1544 * with a 1-bit indicating that the corresponding value bit must match and a
1545 * 0-bit indicating a don't-care.
1547 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1548 * mf_set_value(mf, value, rule). If 'mask' points to all-0-bits, then this
1549 * call is equivalent to mf_set_wild(mf, rule).
1551 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
1552 * is responsible for ensuring that 'rule' meets 'mf''s prerequisites. */
1554 mf_set(const struct mf_field *mf,
1555 const union mf_value *value, const union mf_value *mask,
1556 struct cls_rule *rule)
1558 if (!mask || is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
1559 mf_set_value(mf, value, rule);
1561 } else if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
1562 mf_set_wild(mf, rule);
1570 case MFF_DL_VLAN_PCP:
1577 case MFF_ICMPV4_TYPE:
1578 case MFF_ICMPV4_CODE:
1579 case MFF_ICMPV6_TYPE:
1580 case MFF_ICMPV6_CODE:
1584 cls_rule_set_tun_id_masked(rule, value->be64, mask->be64);
1587 cls_rule_set_metadata_masked(rule, value->be64, mask->be64);
1591 cls_rule_set_reg_masked(rule, mf->id - MFF_REG0,
1592 ntohl(value->be32), ntohl(mask->be32));
1596 cls_rule_set_dl_dst_masked(rule, value->mac, mask->mac);
1600 cls_rule_set_dl_src_masked(rule, value->mac, mask->mac);
1605 cls_rule_set_arp_sha_masked(rule, value->mac, mask->mac);
1610 cls_rule_set_arp_tha_masked(rule, value->mac, mask->mac);
1614 cls_rule_set_dl_tci_masked(rule, value->be16, mask->be16);
1618 cls_rule_set_vlan_vid_masked(rule, value->be16, mask->be16);
1622 cls_rule_set_nw_src_masked(rule, value->be32, mask->be32);
1626 cls_rule_set_nw_dst_masked(rule, value->be32, mask->be32);
1630 cls_rule_set_ipv6_src_masked(rule, &value->ipv6, &mask->ipv6);
1634 cls_rule_set_ipv6_dst_masked(rule, &value->ipv6, &mask->ipv6);
1637 case MFF_IPV6_LABEL:
1638 if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
1639 mf_set_value(mf, value, rule);
1641 cls_rule_set_ipv6_label_masked(rule, value->be32, mask->be32);
1646 cls_rule_set_nd_target_masked(rule, &value->ipv6, &mask->ipv6);
1650 cls_rule_set_nw_frag_masked(rule, value->u8, mask->u8);
1654 cls_rule_set_nw_src_masked(rule, value->be32, mask->be32);
1658 cls_rule_set_nw_dst_masked(rule, value->be32, mask->be32);
1663 cls_rule_set_tp_src_masked(rule, value->be16, mask->be16);
1668 cls_rule_set_tp_dst_masked(rule, value->be16, mask->be16);
1678 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
1682 VLOG_WARN_RL(&rl, "unknown %s field", type);
1683 } else if (!sf->n_bits) {
1684 VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
1685 } else if (sf->ofs >= sf->field->n_bits) {
1686 VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
1687 sf->ofs, sf->field->n_bits, type, sf->field->name);
1688 } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
1689 VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
1690 "of %s field %s", sf->ofs, sf->n_bits,
1691 sf->field->n_bits, type, sf->field->name);
1692 } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
1693 VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
1694 type, sf->field->name);
1699 return OFPERR_OFPBAC_BAD_ARGUMENT;
1702 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
1703 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
1706 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
1708 return mf_check__(sf, flow, "source");
1711 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
1712 * if so, otherwise an OpenFlow error code (e.g. as returned by
1715 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
1717 int error = mf_check__(sf, flow, "destination");
1718 if (!error && !sf->field->writable) {
1719 VLOG_WARN_RL(&rl, "destination field %s is not writable",
1721 return OFPERR_OFPBAC_BAD_ARGUMENT;
1726 /* Copies the value and wildcard bit pattern for 'mf' from 'rule' into the
1727 * 'value' and 'mask', respectively. */
1729 mf_get(const struct mf_field *mf, const struct cls_rule *rule,
1730 union mf_value *value, union mf_value *mask)
1732 mf_get_value(mf, &rule->flow, value);
1733 mf_get_mask(mf, &rule->wc, mask);
1736 /* Assigns a random value for field 'mf' to 'value'. */
1738 mf_random_value(const struct mf_field *mf, union mf_value *value)
1740 random_bytes(value, mf->n_bytes);
1765 case MFF_ICMPV4_TYPE:
1766 case MFF_ICMPV4_CODE:
1767 case MFF_ICMPV6_TYPE:
1768 case MFF_ICMPV6_CODE:
1774 case MFF_IPV6_LABEL:
1775 value->be32 &= ~htonl(IPV6_LABEL_MASK);
1779 value->u8 &= IP_DSCP_MASK;
1783 value->u8 &= IP_ECN_MASK;
1787 value->u8 &= FLOW_NW_FRAG_MASK;
1791 value->be16 &= htons(0xff);
1795 value->be16 &= htons(VLAN_VID_MASK);
1798 value->be16 &= htons(VLAN_VID_MASK | VLAN_CFI);
1801 case MFF_DL_VLAN_PCP:
1813 mf_from_integer_string(const struct mf_field *mf, const char *s,
1814 uint8_t *valuep, uint8_t *maskp)
1816 unsigned long long int integer, mask;
1821 integer = strtoull(s, &tail, 0);
1822 if (errno || (*tail != '\0' && *tail != '/')) {
1827 mask = strtoull(tail + 1, &tail, 0);
1828 if (errno || *tail != '\0') {
1835 for (i = mf->n_bytes - 1; i >= 0; i--) {
1836 valuep[i] = integer;
1842 return xasprintf("%s: value too large for %u-byte field %s",
1843 s, mf->n_bytes, mf->name);
1848 return xasprintf("%s: bad syntax for %s", s, mf->name);
1852 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
1853 uint8_t mac[ETH_ADDR_LEN],
1854 uint8_t mask[ETH_ADDR_LEN])
1856 assert(mf->n_bytes == ETH_ADDR_LEN);
1858 switch (sscanf(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT,
1859 ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask))){
1860 case ETH_ADDR_SCAN_COUNT * 2:
1863 case ETH_ADDR_SCAN_COUNT:
1864 memset(mask, 0xff, ETH_ADDR_LEN);
1868 return xasprintf("%s: invalid Ethernet address", s);
1873 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
1874 ovs_be32 *ip, ovs_be32 *mask)
1878 assert(mf->n_bytes == sizeof *ip);
1880 if (sscanf(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
1881 IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask)) == IP_SCAN_COUNT * 2) {
1883 } else if (sscanf(s, IP_SCAN_FMT"/%d",
1884 IP_SCAN_ARGS(ip), &prefix) == IP_SCAN_COUNT + 1) {
1885 if (prefix <= 0 || prefix > 32) {
1886 return xasprintf("%s: network prefix bits not between 1 and "
1888 } else if (prefix == 32) {
1889 *mask = htonl(UINT32_MAX);
1891 *mask = htonl(((1u << prefix) - 1) << (32 - prefix));
1893 } else if (sscanf(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip)) == IP_SCAN_COUNT) {
1894 *mask = htonl(UINT32_MAX);
1896 return xasprintf("%s: invalid IP address", s);
1902 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
1903 struct in6_addr *value, struct in6_addr *mask)
1905 char *str = xstrdup(s);
1906 char *save_ptr = NULL;
1907 const char *name, *netmask;
1910 assert(mf->n_bytes == sizeof *value);
1912 name = strtok_r(str, "/", &save_ptr);
1913 retval = name ? lookup_ipv6(name, value) : EINVAL;
1917 err = xasprintf("%s: could not convert to IPv6 address", str);
1923 netmask = strtok_r(NULL, "/", &save_ptr);
1925 if (inet_pton(AF_INET6, netmask, mask) != 1) {
1926 int prefix = atoi(netmask);
1927 if (prefix <= 0 || prefix > 128) {
1929 return xasprintf("%s: prefix bits not between 1 and 128", s);
1931 *mask = ipv6_create_mask(prefix);
1935 *mask = in6addr_exact;
1943 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
1944 ovs_be16 *valuep, ovs_be16 *maskp)
1948 assert(mf->n_bytes == sizeof(ovs_be16));
1949 if (ofputil_port_from_string(s, &port)) {
1950 *valuep = htons(port);
1951 *maskp = htons(UINT16_MAX);
1954 return mf_from_integer_string(mf, s,
1955 (uint8_t *) valuep, (uint8_t *) maskp);
1959 struct frag_handling {
1965 static const struct frag_handling all_frags[] = {
1966 #define A FLOW_NW_FRAG_ANY
1967 #define L FLOW_NW_FRAG_LATER
1968 /* name mask value */
1971 { "first", A|L, A },
1972 { "later", A|L, A|L },
1977 { "not_later", L, 0 },
1984 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
1986 const struct frag_handling *h;
1988 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
1989 if (!strcasecmp(s, h->name)) {
1990 /* We force the upper bits of the mask on to make mf_parse_value()
1991 * happy (otherwise it will never think it's an exact match.) */
1992 *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
1998 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
1999 "\"yes\", \"first\", \"later\", \"not_first\"", s);
2002 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2003 * NULL if successful, otherwise a malloc()'d string describing the error. */
2005 mf_parse(const struct mf_field *mf, const char *s,
2006 union mf_value *value, union mf_value *mask)
2008 if (!strcasecmp(s, "any") || !strcmp(s, "*")) {
2009 memset(value, 0, mf->n_bytes);
2010 memset(mask, 0, mf->n_bytes);
2014 switch (mf->string) {
2016 case MFS_HEXADECIMAL:
2017 return mf_from_integer_string(mf, s,
2018 (uint8_t *) value, (uint8_t *) mask);
2021 return mf_from_ethernet_string(mf, s, value->mac, mask->mac);
2024 return mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
2027 return mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
2030 return mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
2033 return mf_from_frag_string(s, &value->u8, &mask->u8);
2038 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2039 * successful, otherwise a malloc()'d string describing the error. */
2041 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2043 union mf_value mask;
2046 error = mf_parse(mf, s, value, &mask);
2051 if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2052 return xasprintf("%s: wildcards not allowed here", s);
2058 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2059 const uint8_t *maskp, struct ds *s)
2061 unsigned long long int integer;
2064 assert(mf->n_bytes <= 8);
2067 for (i = 0; i < mf->n_bytes; i++) {
2068 integer = (integer << 8) | valuep[i];
2070 if (mf->string == MFS_HEXADECIMAL) {
2071 ds_put_format(s, "%#llx", integer);
2073 ds_put_format(s, "%lld", integer);
2077 unsigned long long int mask;
2080 for (i = 0; i < mf->n_bytes; i++) {
2081 mask = (mask << 8) | maskp[i];
2084 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2085 * not sure that that a bit-mask written in decimal is ever easier to
2086 * understand than the same bit-mask written in hexadecimal. */
2087 ds_put_format(s, "/%#llx", mask);
2092 mf_format_frag_string(const uint8_t *valuep, const uint8_t *maskp,
2095 const struct frag_handling *h;
2096 uint8_t value = *valuep;
2097 uint8_t mask = *maskp;
2100 mask &= FLOW_NW_FRAG_MASK;
2102 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2103 if (value == h->value && mask == h->mask) {
2104 ds_put_cstr(s, h->name);
2108 ds_put_cstr(s, "<error>");
2111 /* Appends to 's' a string representation of field 'mf' whose value is in
2112 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2114 mf_format(const struct mf_field *mf,
2115 const union mf_value *value, const union mf_value *mask,
2119 if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2120 ds_put_cstr(s, "ANY");
2122 } else if (is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2127 switch (mf->string) {
2130 ofputil_format_port(ntohs(value->be16), s);
2135 case MFS_HEXADECIMAL:
2136 mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2140 eth_format_masked(value->mac, mask->mac, s);
2144 ip_format_masked(value->be32, mask ? mask->be32 : htonl(UINT32_MAX),
2149 print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2153 mf_format_frag_string(&value->u8, &mask->u8, s);
2161 /* Makes subfield 'sf' within 'rule' exactly match the 'sf->n_bits'
2162 * least-significant bits in 'x'.
2165 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2166 struct cls_rule *rule)
2168 const struct mf_field *field = sf->field;
2169 union mf_value value, mask;
2171 mf_get(field, rule, &value, &mask);
2172 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2173 bitwise_one ( &mask, field->n_bytes, sf->ofs, sf->n_bits);
2174 mf_set(field, &value, &mask, rule);
2177 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2178 * reading 'flow', e.g. as checked by mf_check_src(). */
2180 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2181 union mf_subvalue *x)
2183 union mf_value value;
2185 mf_get_value(sf->field, flow, &value);
2187 memset(x, 0, sizeof *x);
2188 bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2193 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2194 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2197 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2199 union mf_value value;
2201 mf_get_value(sf->field, flow, &value);
2202 return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2205 /* Formats 'sf' into 's' in a format normally acceptable to
2206 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2207 * sf->field has no NXM name.) */
2209 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
2212 ds_put_cstr(s, "<unknown>");
2213 } else if (sf->field->nxm_name) {
2214 ds_put_cstr(s, sf->field->nxm_name);
2215 } else if (sf->field->nxm_header) {
2216 uint32_t header = sf->field->nxm_header;
2217 ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
2219 ds_put_cstr(s, sf->field->name);
2222 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
2223 ds_put_cstr(s, "[]");
2224 } else if (sf->n_bits == 1) {
2225 ds_put_format(s, "[%d]", sf->ofs);
2227 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
2231 static const struct mf_field *
2232 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
2236 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
2241 for (i = 0; i < MFF_N_IDS; i++) {
2242 const struct mf_field *mf = mf_from_id(i);
2245 && !strncmp(mf->nxm_name, name, name_len)
2246 && mf->nxm_name[name_len] == '\0') {
2250 && !strncmp(mf->oxm_name, name, name_len)
2251 && mf->oxm_name[name_len] == '\0') {
2259 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2260 * returns NULL and advances '*sp' to the first byte following the parsed
2261 * string. On failure, returns a malloc()'d error message, does not modify
2262 * '*sp', and does not properly initialize 'sf'.
2264 * The syntax parsed from '*sp' takes the form "header[start..end]" where
2265 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2266 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2267 * may both be omitted (the [] are still required) to indicate an entire
2270 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
2272 const struct mf_field *field;
2281 name_len = strcspn(s, "[");
2282 if (s[name_len] != '[') {
2283 return xasprintf("%s: missing [ looking for field name", *sp);
2286 field = mf_parse_subfield_name(name, name_len, &wild);
2288 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
2292 if (sscanf(s, "[%d..%d]", &start, &end) == 2) {
2293 /* Nothing to do. */
2294 } else if (sscanf(s, "[%d]", &start) == 1) {
2296 } else if (!strncmp(s, "[]", 2)) {
2298 end = field->n_bits - 1;
2300 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2301 "[<start>..<end>]", *sp);
2303 s = strchr(s, ']') + 1;
2306 return xasprintf("%s: starting bit %d is after ending bit %d",
2308 } else if (start >= field->n_bits) {
2309 return xasprintf("%s: starting bit %d is not valid because field is "
2310 "only %d bits wide", *sp, start, field->n_bits);
2311 } else if (end >= field->n_bits){
2312 return xasprintf("%s: ending bit %d is not valid because field is "
2313 "only %d bits wide", *sp, end, field->n_bits);
2318 sf->n_bits = end - start + 1;
2324 /* Parses a subfield from the beginning of 's' into 'sf'. Returns the first
2325 * byte in 's' following the parsed string.
2327 * Exits with an error message if 's' has incorrect syntax.
2329 * The syntax parsed from 's' takes the form "header[start..end]" where
2330 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2331 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2332 * may both be omitted (the [] are still required) to indicate an entire
2335 mf_parse_subfield(struct mf_subfield *sf, const char *s)
2337 char *msg = mf_parse_subfield__(sf, &s);
2339 ovs_fatal(0, "%s", msg);