2 * Copyright (c) 2011, 2012, 2013, 2014 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "meta-flow.h"
23 #include <netinet/icmp6.h>
24 #include <netinet/ip6.h>
26 #include "classifier.h"
27 #include "dynamic-string.h"
28 #include "ofp-errors.h"
30 #include "ovs-thread.h"
34 #include "socket-util.h"
35 #include "unaligned.h"
38 VLOG_DEFINE_THIS_MODULE(meta_flow);
40 #define FLOW_U32OFS(FIELD) \
41 offsetof(struct flow, FIELD) % 4 ? -1 : offsetof(struct flow, FIELD) / 4
43 #define MF_FIELD_SIZES(MEMBER) \
44 sizeof ((union mf_value *)0)->MEMBER, \
45 8 * sizeof ((union mf_value *)0)->MEMBER
47 extern const struct mf_field mf_fields[MFF_N_IDS]; /* Silence a warning. */
49 const struct mf_field mf_fields[MFF_N_IDS] = {
55 MFF_DP_HASH, "dp_hash", NULL,
61 NXM_NX_DP_HASH, "NXM_NX_DP_HASH",
62 NXM_NX_DP_HASH, "NXM_NX_DP_HASH", 0,
63 OFPUTIL_P_NXM_OXM_ANY,
64 OFPUTIL_P_NXM_OXM_ANY,
67 MFF_RECIRC_ID, "recirc_id", NULL,
73 NXM_NX_RECIRC_ID, "NXM_NX_RECIRC_ID",
74 NXM_NX_RECIRC_ID, "NXM_NX_RECIRC_ID", 0,
75 OFPUTIL_P_NXM_OXM_ANY,
76 OFPUTIL_P_NXM_OXM_ANY,
79 MFF_TUN_ID, "tun_id", "tunnel_id",
85 NXM_NX_TUN_ID, "NXM_NX_TUN_ID",
86 OXM_OF_TUNNEL_ID, "OXM_OF_TUNNEL_ID", OFP13_VERSION,
87 OFPUTIL_P_NXM_OXM_ANY,
88 OFPUTIL_P_NXM_OXM_ANY,
89 FLOW_U32OFS(tunnel.tun_id),
91 MFF_TUN_SRC, "tun_src", NULL,
97 NXM_NX_TUN_IPV4_SRC, "NXM_NX_TUN_IPV4_SRC",
98 NXM_NX_TUN_IPV4_SRC, "NXM_NX_TUN_IPV4_SRC", 0,
99 OFPUTIL_P_NXM_OXM_ANY,
100 OFPUTIL_P_NXM_OXM_ANY,
101 FLOW_U32OFS(tunnel.ip_src),
103 MFF_TUN_DST, "tun_dst", NULL,
104 MF_FIELD_SIZES(be32),
109 NXM_NX_TUN_IPV4_DST, "NXM_NX_TUN_IPV4_DST",
110 NXM_NX_TUN_IPV4_DST, "NXM_NX_TUN_IPV4_DST", 0,
111 OFPUTIL_P_NXM_OXM_ANY,
112 OFPUTIL_P_NXM_OXM_ANY,
113 FLOW_U32OFS(tunnel.ip_dst),
115 MFF_TUN_FLAGS, "tun_flags", NULL,
116 MF_FIELD_SIZES(be16),
127 MFF_TUN_TTL, "tun_ttl", NULL,
139 MFF_TUN_TOS, "tun_tos", NULL,
151 MFF_METADATA, "metadata", NULL,
152 MF_FIELD_SIZES(be64),
157 OXM_OF_METADATA, "OXM_OF_METADATA",
158 OXM_OF_METADATA, "OXM_OF_METADATA", OFP12_VERSION,
159 OFPUTIL_P_NXM_OF11_UP,
160 OFPUTIL_P_NXM_OF11_UP,
163 MFF_IN_PORT, "in_port", NULL,
164 MF_FIELD_SIZES(be16),
169 NXM_OF_IN_PORT, "NXM_OF_IN_PORT",
170 NXM_OF_IN_PORT, "NXM_OF_IN_PORT", 0,
171 OFPUTIL_P_ANY, /* OF11+ via mapping to 32 bits. */
175 MFF_IN_PORT_OXM, "in_port_oxm", NULL,
176 MF_FIELD_SIZES(be32),
181 OXM_OF_IN_PORT, "OXM_OF_IN_PORT",
182 OXM_OF_IN_PORT, "OXM_OF_IN_PORT", OFP12_VERSION,
187 MFF_SKB_PRIORITY, "skb_priority", NULL,
188 MF_FIELD_SIZES(be32),
199 MFF_PKT_MARK, "pkt_mark", NULL,
200 MF_FIELD_SIZES(be32),
205 NXM_NX_PKT_MARK, "NXM_NX_PKT_MARK",
206 NXM_NX_PKT_MARK, "NXM_NX_PKT_MARK", 0,
207 OFPUTIL_P_NXM_OXM_ANY,
208 OFPUTIL_P_NXM_OXM_ANY,
212 #define REGISTER(IDX) \
214 MFF_REG##IDX, "reg" #IDX, NULL, \
215 MF_FIELD_SIZES(be32), \
220 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
221 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, 0, \
222 OFPUTIL_P_NXM_OXM_ANY, \
223 OFPUTIL_P_NXM_OXM_ANY, \
259 MFF_ETH_SRC, "eth_src", "dl_src",
265 NXM_OF_ETH_SRC, "NXM_OF_ETH_SRC",
266 OXM_OF_ETH_SRC, "OXM_OF_ETH_SRC", OFP12_VERSION,
268 OFPUTIL_P_NXM_OF11_UP, /* Bitwise masking only with NXM and OF11+! */
271 MFF_ETH_DST, "eth_dst", "dl_dst",
277 NXM_OF_ETH_DST, "NXM_OF_ETH_DST",
278 OXM_OF_ETH_DST, "OXM_OF_ETH_DST", OFP12_VERSION,
280 OFPUTIL_P_NXM_OF11_UP, /* Bitwise masking only with NXM and OF11+! */
283 MFF_ETH_TYPE, "eth_type", "dl_type",
284 MF_FIELD_SIZES(be16),
289 NXM_OF_ETH_TYPE, "NXM_OF_ETH_TYPE",
290 OXM_OF_ETH_TYPE, "OXM_OF_ETH_TYPE", OFP12_VERSION,
297 MFF_VLAN_TCI, "vlan_tci", NULL,
298 MF_FIELD_SIZES(be16),
303 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI",
304 NXM_OF_VLAN_TCI, "NXM_OF_VLAN_TCI", 0,
306 OFPUTIL_P_NXM_OXM_ANY,
309 MFF_DL_VLAN, "dl_vlan", NULL,
310 sizeof(ovs_be16), 12,
318 OFPUTIL_P_NXM_OXM_ANY,
321 MFF_VLAN_VID, "vlan_vid", NULL,
322 sizeof(ovs_be16), 12,
327 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID",
328 OXM_OF_VLAN_VID, "OXM_OF_VLAN_VID", OFP12_VERSION,
330 OFPUTIL_P_NXM_OXM_ANY,
333 MFF_DL_VLAN_PCP, "dl_vlan_pcp", NULL,
341 OFPUTIL_P_ANY, /* Will be mapped to NXM and OXM. */
345 MFF_VLAN_PCP, "vlan_pcp", NULL,
351 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP",
352 OXM_OF_VLAN_PCP, "OXM_OF_VLAN_PCP", OFP12_VERSION,
353 OFPUTIL_P_ANY, /* Will be mapped to OF10 and NXM. */
362 MFF_MPLS_LABEL, "mpls_label", NULL,
368 OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL",
369 OXM_OF_MPLS_LABEL, "OXM_OF_MPLS_LABEL", OFP12_VERSION,
370 OFPUTIL_P_NXM_OF11_UP,
374 MFF_MPLS_TC, "mpls_tc", NULL,
380 OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC",
381 OXM_OF_MPLS_TC, "OXM_OF_MPLS_TC", OFP12_VERSION,
382 OFPUTIL_P_NXM_OF11_UP,
386 MFF_MPLS_BOS, "mpls_bos", NULL,
392 OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS",
393 OXM_OF_MPLS_BOS, "OXM_OF_MPLS_BOS", OFP13_VERSION,
394 OFPUTIL_P_NXM_OXM_ANY,
404 MFF_IPV4_SRC, "ip_src", "nw_src",
405 MF_FIELD_SIZES(be32),
410 NXM_OF_IP_SRC, "NXM_OF_IP_SRC",
411 OXM_OF_IPV4_SRC, "OXM_OF_IPV4_SRC", OFP12_VERSION,
413 OFPUTIL_P_NXM_OF11_UP,
416 MFF_IPV4_DST, "ip_dst", "nw_dst",
417 MF_FIELD_SIZES(be32),
422 NXM_OF_IP_DST, "NXM_OF_IP_DST",
423 OXM_OF_IPV4_DST, "OXM_OF_IPV4_DST", OFP12_VERSION,
425 OFPUTIL_P_NXM_OF11_UP,
430 MFF_IPV6_SRC, "ipv6_src", NULL,
431 MF_FIELD_SIZES(ipv6),
436 NXM_NX_IPV6_SRC, "NXM_NX_IPV6_SRC",
437 OXM_OF_IPV6_SRC, "OXM_OF_IPV6_SRC", OFP12_VERSION,
438 OFPUTIL_P_NXM_OXM_ANY,
439 OFPUTIL_P_NXM_OXM_ANY,
440 FLOW_U32OFS(ipv6_src),
442 MFF_IPV6_DST, "ipv6_dst", NULL,
443 MF_FIELD_SIZES(ipv6),
448 NXM_NX_IPV6_DST, "NXM_NX_IPV6_DST",
449 OXM_OF_IPV6_DST, "OXM_OF_IPV6_DST", OFP12_VERSION,
450 OFPUTIL_P_NXM_OXM_ANY,
451 OFPUTIL_P_NXM_OXM_ANY,
452 FLOW_U32OFS(ipv6_dst),
455 MFF_IPV6_LABEL, "ipv6_label", NULL,
461 NXM_NX_IPV6_LABEL, "NXM_NX_IPV6_LABEL",
462 OXM_OF_IPV6_FLABEL, "OXM_OF_IPV6_FLABEL", OFP12_VERSION,
463 OFPUTIL_P_NXM_OXM_ANY,
464 OFPUTIL_P_NXM_OXM_ANY,
469 MFF_IP_PROTO, "nw_proto", "ip_proto",
475 NXM_OF_IP_PROTO, "NXM_OF_IP_PROTO",
476 OXM_OF_IP_PROTO, "OXM_OF_IP_PROTO", OFP12_VERSION,
481 MFF_IP_DSCP, "nw_tos", NULL,
487 NXM_OF_IP_TOS, "NXM_OF_IP_TOS",
488 NXM_OF_IP_TOS, "NXM_OF_IP_TOS", 0,
489 OFPUTIL_P_ANY, /* Will be shifted for OXM. */
493 MFF_IP_DSCP_SHIFTED, "ip_dscp", NULL,
499 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP",
500 OXM_OF_IP_DSCP, "OXM_OF_IP_DSCP", OFP12_VERSION,
501 OFPUTIL_P_ANY, /* Will be shifted for non-OXM. */
505 MFF_IP_ECN, "nw_ecn", "ip_ecn",
511 NXM_NX_IP_ECN, "NXM_NX_IP_ECN",
512 OXM_OF_IP_ECN, "OXM_OF_IP_ECN", OFP12_VERSION,
513 OFPUTIL_P_NXM_OXM_ANY,
517 MFF_IP_TTL, "nw_ttl", NULL,
523 NXM_NX_IP_TTL, "NXM_NX_IP_TTL",
524 NXM_NX_IP_TTL, "NXM_NX_IP_TTL", 0,
525 OFPUTIL_P_NXM_OXM_ANY,
529 MFF_IP_FRAG, "ip_frag", NULL,
535 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG",
536 NXM_NX_IP_FRAG, "NXM_NX_IP_FRAG", 0,
537 OFPUTIL_P_NXM_OXM_ANY,
538 OFPUTIL_P_NXM_OXM_ANY,
543 MFF_ARP_OP, "arp_op", NULL,
544 MF_FIELD_SIZES(be16),
549 NXM_OF_ARP_OP, "NXM_OF_ARP_OP",
550 OXM_OF_ARP_OP, "OXM_OF_ARP_OP", OFP12_VERSION,
555 MFF_ARP_SPA, "arp_spa", NULL,
556 MF_FIELD_SIZES(be32),
561 NXM_OF_ARP_SPA, "NXM_OF_ARP_SPA",
562 OXM_OF_ARP_SPA, "OXM_OF_ARP_SPA", OFP12_VERSION,
564 OFPUTIL_P_NXM_OF11_UP,
567 MFF_ARP_TPA, "arp_tpa", NULL,
568 MF_FIELD_SIZES(be32),
573 NXM_OF_ARP_TPA, "NXM_OF_ARP_TPA",
574 OXM_OF_ARP_TPA, "OXM_OF_ARP_TPA", OFP12_VERSION,
576 OFPUTIL_P_NXM_OF11_UP,
579 MFF_ARP_SHA, "arp_sha", NULL,
585 NXM_NX_ARP_SHA, "NXM_NX_ARP_SHA",
586 OXM_OF_ARP_SHA, "OXM_OF_ARP_SHA", OFP12_VERSION,
587 OFPUTIL_P_NXM_OXM_ANY,
588 OFPUTIL_P_NXM_OXM_ANY,
591 MFF_ARP_THA, "arp_tha", NULL,
597 NXM_NX_ARP_THA, "NXM_NX_ARP_THA",
598 OXM_OF_ARP_THA, "OXM_OF_ARP_THA", OFP12_VERSION,
599 OFPUTIL_P_NXM_OXM_ANY,
600 OFPUTIL_P_NXM_OXM_ANY,
609 MFF_TCP_SRC, "tcp_src", "tp_src",
610 MF_FIELD_SIZES(be16),
615 NXM_OF_TCP_SRC, "NXM_OF_TCP_SRC",
616 OXM_OF_TCP_SRC, "OXM_OF_TCP_SRC", OFP12_VERSION,
618 OFPUTIL_P_NXM_OXM_ANY,
621 MFF_TCP_DST, "tcp_dst", "tp_dst",
622 MF_FIELD_SIZES(be16),
627 NXM_OF_TCP_DST, "NXM_OF_TCP_DST",
628 OXM_OF_TCP_DST, "OXM_OF_TCP_DST", OFP12_VERSION,
630 OFPUTIL_P_NXM_OXM_ANY,
633 MFF_TCP_FLAGS, "tcp_flags", NULL,
639 NXM_NX_TCP_FLAGS, "NXM_NX_TCP_FLAGS",
640 OXM_OF_TCP_FLAGS, "OXM_OF_TCP_FLAGS", OFP15_VERSION,
641 OFPUTIL_P_NXM_OXM_ANY,
642 OFPUTIL_P_NXM_OXM_ANY,
647 MFF_UDP_SRC, "udp_src", NULL,
648 MF_FIELD_SIZES(be16),
653 NXM_OF_UDP_SRC, "NXM_OF_UDP_SRC",
654 OXM_OF_UDP_SRC, "OXM_OF_UDP_SRC", OFP12_VERSION,
656 OFPUTIL_P_NXM_OXM_ANY,
659 MFF_UDP_DST, "udp_dst", NULL,
660 MF_FIELD_SIZES(be16),
665 NXM_OF_UDP_DST, "NXM_OF_UDP_DST",
666 OXM_OF_UDP_DST, "OXM_OF_UDP_DST", OFP12_VERSION,
668 OFPUTIL_P_NXM_OXM_ANY,
673 MFF_SCTP_SRC, "sctp_src", NULL,
674 MF_FIELD_SIZES(be16),
679 OXM_OF_SCTP_SRC, "OXM_OF_SCTP_SRC",
680 OXM_OF_SCTP_SRC, "OXM_OF_SCTP_SRC", OFP12_VERSION,
681 OFPUTIL_P_NXM_OF11_UP,
682 OFPUTIL_P_NXM_OXM_ANY,
685 MFF_SCTP_DST, "sctp_dst", NULL,
686 MF_FIELD_SIZES(be16),
691 OXM_OF_SCTP_DST, "OXM_OF_SCTP_DST",
692 OXM_OF_SCTP_DST, "OXM_OF_SCTP_DST", OFP12_VERSION,
693 OFPUTIL_P_NXM_OF11_UP,
694 OFPUTIL_P_NXM_OXM_ANY,
699 MFF_ICMPV4_TYPE, "icmp_type", NULL,
705 NXM_OF_ICMP_TYPE, "NXM_OF_ICMP_TYPE",
706 OXM_OF_ICMPV4_TYPE, "OXM_OF_ICMPV4_TYPE", OFP12_VERSION,
711 MFF_ICMPV4_CODE, "icmp_code", NULL,
717 NXM_OF_ICMP_CODE, "NXM_OF_ICMP_CODE",
718 OXM_OF_ICMPV4_CODE, "OXM_OF_ICMPV4_CODE", OFP12_VERSION,
725 MFF_ICMPV6_TYPE, "icmpv6_type", NULL,
731 NXM_NX_ICMPV6_TYPE, "NXM_NX_ICMPV6_TYPE",
732 OXM_OF_ICMPV6_TYPE, "OXM_OF_ICMPV6_TYPE", OFP12_VERSION,
733 OFPUTIL_P_NXM_OXM_ANY,
737 MFF_ICMPV6_CODE, "icmpv6_code", NULL,
743 NXM_NX_ICMPV6_CODE, "NXM_NX_ICMPV6_CODE",
744 OXM_OF_ICMPV6_CODE, "OXM_OF_ICMPV6_CODE", OFP12_VERSION,
745 OFPUTIL_P_NXM_OXM_ANY,
755 MFF_ND_TARGET, "nd_target", NULL,
756 MF_FIELD_SIZES(ipv6),
761 NXM_NX_ND_TARGET, "NXM_NX_ND_TARGET",
762 OXM_OF_IPV6_ND_TARGET, "OXM_OF_IPV6_ND_TARGET", OFP12_VERSION,
763 OFPUTIL_P_NXM_OXM_ANY,
764 OFPUTIL_P_NXM_OXM_ANY,
767 MFF_ND_SLL, "nd_sll", NULL,
773 NXM_NX_ND_SLL, "NXM_NX_ND_SLL",
774 OXM_OF_IPV6_ND_SLL, "OXM_OF_IPV6_ND_SLL", OFP12_VERSION,
775 OFPUTIL_P_NXM_OXM_ANY,
776 OFPUTIL_P_NXM_OXM_ANY,
779 MFF_ND_TLL, "nd_tll", NULL,
785 NXM_NX_ND_TLL, "NXM_NX_ND_TLL",
786 OXM_OF_IPV6_ND_TLL, "OXM_OF_IPV6_ND_TLL", OFP12_VERSION,
787 OFPUTIL_P_NXM_OXM_ANY,
788 OFPUTIL_P_NXM_OXM_ANY,
793 /* Maps an NXM or OXM header value to an mf_field. */
795 struct hmap_node hmap_node; /* In 'all_fields' hmap. */
796 uint32_t header; /* NXM or OXM header value. */
797 const struct mf_field *mf;
800 /* Contains 'struct nxm_field's. */
801 static struct hmap all_fields;
803 /* Maps from an mf_field's 'name' or 'extra_name' to the mf_field. */
804 static struct shash mf_by_name;
806 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
807 * controller and so there's not much point in showing a lot of them. */
808 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
810 const struct mf_field *mf_from_nxm_header__(uint32_t header);
811 static void nxm_init(void);
813 /* Returns the field with the given 'name', or a null pointer if no field has
815 const struct mf_field *
816 mf_from_name(const char *name)
819 return shash_find_data(&mf_by_name, name);
823 add_nxm_field(uint32_t header, const struct mf_field *mf)
827 f = xmalloc(sizeof *f);
828 hmap_insert(&all_fields, &f->hmap_node, hash_int(header, 0));
834 nxm_init_add_field(const struct mf_field *mf, uint32_t header)
837 ovs_assert(!mf_from_nxm_header__(header));
838 add_nxm_field(header, mf);
839 if (mf->maskable != MFM_NONE) {
840 add_nxm_field(NXM_MAKE_WILD_HEADER(header), mf);
850 hmap_init(&all_fields);
851 shash_init(&mf_by_name);
852 for (i = 0; i < MFF_N_IDS; i++) {
853 const struct mf_field *mf = &mf_fields[i];
855 ovs_assert(mf->id == i); /* Fields must be in the enum order. */
857 nxm_init_add_field(mf, mf->nxm_header);
858 if (mf->oxm_header != mf->nxm_header) {
859 nxm_init_add_field(mf, mf->oxm_header);
862 shash_add_once(&mf_by_name, mf->name, mf);
863 if (mf->extra_name) {
864 shash_add_once(&mf_by_name, mf->extra_name, mf);
872 static pthread_once_t once = PTHREAD_ONCE_INIT;
873 pthread_once(&once, nxm_do_init);
876 const struct mf_field *
877 mf_from_nxm_header(uint32_t header)
880 return mf_from_nxm_header__(header);
883 const struct mf_field *
884 mf_from_nxm_header__(uint32_t header)
886 const struct nxm_field *f;
888 HMAP_FOR_EACH_IN_BUCKET (f, hmap_node, hash_int(header, 0), &all_fields) {
889 if (f->header == header) {
898 mf_oxm_header(enum mf_field_id id, enum ofp_version oxm_version)
900 const struct mf_field *field = mf_from_id(id);
902 return (oxm_version >= field->oxm_version
904 : field->nxm_header);
907 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
908 * specifies at least one bit in the field.
910 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
911 * meets 'mf''s prerequisites. */
913 mf_is_all_wild(const struct mf_field *mf, const struct flow_wildcards *wc)
917 return !wc->masks.dp_hash;
919 return !wc->masks.recirc_id;
921 return !wc->masks.tunnel.ip_src;
923 return !wc->masks.tunnel.ip_dst;
928 return !wc->masks.tunnel.tun_id;
930 return !wc->masks.metadata;
932 case MFF_IN_PORT_OXM:
933 return !wc->masks.in_port.ofp_port;
934 case MFF_SKB_PRIORITY:
935 return !wc->masks.skb_priority;
937 return !wc->masks.pkt_mark;
939 return !wc->masks.regs[mf->id - MFF_REG0];
942 return eth_addr_is_zero(wc->masks.dl_src);
944 return eth_addr_is_zero(wc->masks.dl_dst);
946 return !wc->masks.dl_type;
950 return eth_addr_is_zero(wc->masks.arp_sha);
954 return eth_addr_is_zero(wc->masks.arp_tha);
957 return !wc->masks.vlan_tci;
959 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK));
961 return !(wc->masks.vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI));
962 case MFF_DL_VLAN_PCP:
964 return !(wc->masks.vlan_tci & htons(VLAN_PCP_MASK));
967 return !(wc->masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK));
969 return !(wc->masks.mpls_lse[1] & htonl(MPLS_TC_MASK));
971 return !(wc->masks.mpls_lse[2] & htonl(MPLS_BOS_MASK));
974 return !wc->masks.nw_src;
976 return !wc->masks.nw_dst;
979 return ipv6_mask_is_any(&wc->masks.ipv6_src);
981 return ipv6_mask_is_any(&wc->masks.ipv6_dst);
984 return !wc->masks.ipv6_label;
987 return !wc->masks.nw_proto;
989 case MFF_IP_DSCP_SHIFTED:
990 return !(wc->masks.nw_tos & IP_DSCP_MASK);
992 return !(wc->masks.nw_tos & IP_ECN_MASK);
994 return !wc->masks.nw_ttl;
997 return ipv6_mask_is_any(&wc->masks.nd_target);
1000 return !(wc->masks.nw_frag & FLOW_NW_FRAG_MASK);
1003 return !wc->masks.nw_proto;
1005 return !wc->masks.nw_src;
1007 return !wc->masks.nw_dst;
1012 case MFF_ICMPV4_TYPE:
1013 case MFF_ICMPV6_TYPE:
1014 return !wc->masks.tp_src;
1018 case MFF_ICMPV4_CODE:
1019 case MFF_ICMPV6_CODE:
1020 return !wc->masks.tp_dst;
1022 return !wc->masks.tcp_flags;
1030 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
1031 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
1032 * purposes, or to 0 if it is wildcarded.
1034 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
1035 * meets 'mf''s prerequisites. */
1037 mf_get_mask(const struct mf_field *mf, const struct flow_wildcards *wc,
1038 union mf_value *mask)
1040 mf_get_value(mf, &wc->masks, mask);
1043 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
1044 * if the mask is valid, false otherwise. */
1046 mf_is_mask_valid(const struct mf_field *mf, const union mf_value *mask)
1048 switch (mf->maskable) {
1050 return (is_all_zeros((const uint8_t *) mask, mf->n_bytes) ||
1051 is_all_ones((const uint8_t *) mask, mf->n_bytes));
1060 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
1062 mf_are_prereqs_ok(const struct mf_field *mf, const struct flow *flow)
1064 switch (mf->prereqs) {
1069 return (flow->dl_type == htons(ETH_TYPE_ARP) ||
1070 flow->dl_type == htons(ETH_TYPE_RARP));
1072 return flow->dl_type == htons(ETH_TYPE_IP);
1074 return flow->dl_type == htons(ETH_TYPE_IPV6);
1076 return (flow->vlan_tci & htons(VLAN_CFI)) != 0;
1078 return eth_type_mpls(flow->dl_type);
1080 return is_ip_any(flow);
1083 return is_ip_any(flow) && flow->nw_proto == IPPROTO_TCP;
1085 return is_ip_any(flow) && flow->nw_proto == IPPROTO_UDP;
1087 return is_ip_any(flow) && flow->nw_proto == IPPROTO_SCTP;
1089 return is_icmpv4(flow);
1091 return is_icmpv6(flow);
1094 return (is_icmpv6(flow)
1095 && flow->tp_dst == htons(0)
1096 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
1097 flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
1098 case MFP_ND_SOLICIT:
1099 return (is_icmpv6(flow)
1100 && flow->tp_dst == htons(0)
1101 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)));
1103 return (is_icmpv6(flow)
1104 && flow->tp_dst == htons(0)
1105 && (flow->tp_src == htons(ND_NEIGHBOR_ADVERT)));
1111 /* Set field and it's prerequisities in the mask.
1112 * This is only ever called for writeable 'mf's, but we do not make the
1113 * distinction here. */
1115 mf_mask_field_and_prereqs(const struct mf_field *mf, struct flow *mask)
1117 static const union mf_value exact_match_mask = MF_EXACT_MASK_INITIALIZER;
1119 mf_set_flow_value(mf, &exact_match_mask, mask);
1121 switch (mf->prereqs) {
1123 case MFP_ND_SOLICIT:
1125 mask->tp_src = OVS_BE16_MAX;
1126 mask->tp_dst = OVS_BE16_MAX;
1133 mask->nw_proto = 0xff;
1140 mask->dl_type = OVS_BE16_MAX;
1143 mask->vlan_tci |= htons(VLAN_CFI);
1151 /* Returns true if 'value' may be a valid value *as part of a masked match*,
1154 * A value is not rejected just because it is not valid for the field in
1155 * question, but only if it doesn't make sense to test the bits in question at
1156 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
1157 * without the VLAN_CFI bit being set, but we can't reject those values because
1158 * it is still legitimate to test just for those bits (see the documentation
1159 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
1160 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
1162 mf_is_value_valid(const struct mf_field *mf, const union mf_value *value)
1175 case MFF_SKB_PRIORITY:
1198 case MFF_ICMPV4_TYPE:
1199 case MFF_ICMPV4_CODE:
1200 case MFF_ICMPV6_TYPE:
1201 case MFF_ICMPV6_CODE:
1207 case MFF_IN_PORT_OXM: {
1209 return !ofputil_port_from_ofp11(value->be32, &port);
1213 return !(value->u8 & ~IP_DSCP_MASK);
1214 case MFF_IP_DSCP_SHIFTED:
1215 return !(value->u8 & (~IP_DSCP_MASK >> 2));
1217 return !(value->u8 & ~IP_ECN_MASK);
1219 return !(value->u8 & ~FLOW_NW_FRAG_MASK);
1221 return !(value->be16 & ~htons(0x0fff));
1224 return !(value->be16 & htons(0xff00));
1227 return !(value->be16 & htons(VLAN_CFI | VLAN_PCP_MASK));
1229 return !(value->be16 & htons(VLAN_PCP_MASK));
1231 case MFF_DL_VLAN_PCP:
1233 return !(value->u8 & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT));
1235 case MFF_IPV6_LABEL:
1236 return !(value->be32 & ~htonl(IPV6_LABEL_MASK));
1238 case MFF_MPLS_LABEL:
1239 return !(value->be32 & ~htonl(MPLS_LABEL_MASK >> MPLS_LABEL_SHIFT));
1242 return !(value->u8 & ~(MPLS_TC_MASK >> MPLS_TC_SHIFT));
1245 return !(value->u8 & ~(MPLS_BOS_MASK >> MPLS_BOS_SHIFT));
1253 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
1254 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
1256 mf_get_value(const struct mf_field *mf, const struct flow *flow,
1257 union mf_value *value)
1261 value->be32 = htonl(flow->dp_hash);
1264 value->be32 = htonl(flow->recirc_id);
1267 value->be64 = flow->tunnel.tun_id;
1270 value->be32 = flow->tunnel.ip_src;
1273 value->be32 = flow->tunnel.ip_dst;
1276 value->be16 = htons(flow->tunnel.flags);
1279 value->u8 = flow->tunnel.ip_ttl;
1282 value->u8 = flow->tunnel.ip_tos;
1286 value->be64 = flow->metadata;
1290 value->be16 = htons(ofp_to_u16(flow->in_port.ofp_port));
1292 case MFF_IN_PORT_OXM:
1293 value->be32 = ofputil_port_to_ofp11(flow->in_port.ofp_port);
1296 case MFF_SKB_PRIORITY:
1297 value->be32 = htonl(flow->skb_priority);
1301 value->be32 = htonl(flow->pkt_mark);
1305 value->be32 = htonl(flow->regs[mf->id - MFF_REG0]);
1309 memcpy(value->mac, flow->dl_src, ETH_ADDR_LEN);
1313 memcpy(value->mac, flow->dl_dst, ETH_ADDR_LEN);
1317 value->be16 = flow->dl_type;
1321 value->be16 = flow->vlan_tci;
1325 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK);
1328 value->be16 = flow->vlan_tci & htons(VLAN_VID_MASK | VLAN_CFI);
1331 case MFF_DL_VLAN_PCP:
1333 value->u8 = vlan_tci_to_pcp(flow->vlan_tci);
1336 case MFF_MPLS_LABEL:
1337 value->be32 = htonl(mpls_lse_to_label(flow->mpls_lse[0]));
1341 value->u8 = mpls_lse_to_tc(flow->mpls_lse[0]);
1345 value->u8 = mpls_lse_to_bos(flow->mpls_lse[0]);
1349 value->be32 = flow->nw_src;
1353 value->be32 = flow->nw_dst;
1357 value->ipv6 = flow->ipv6_src;
1361 value->ipv6 = flow->ipv6_dst;
1364 case MFF_IPV6_LABEL:
1365 value->be32 = flow->ipv6_label;
1369 value->u8 = flow->nw_proto;
1373 value->u8 = flow->nw_tos & IP_DSCP_MASK;
1376 case MFF_IP_DSCP_SHIFTED:
1377 value->u8 = flow->nw_tos >> 2;
1381 value->u8 = flow->nw_tos & IP_ECN_MASK;
1385 value->u8 = flow->nw_ttl;
1389 value->u8 = flow->nw_frag;
1393 value->be16 = htons(flow->nw_proto);
1397 value->be32 = flow->nw_src;
1401 value->be32 = flow->nw_dst;
1406 memcpy(value->mac, flow->arp_sha, ETH_ADDR_LEN);
1411 memcpy(value->mac, flow->arp_tha, ETH_ADDR_LEN);
1417 value->be16 = flow->tp_src;
1423 value->be16 = flow->tp_dst;
1427 value->be16 = flow->tcp_flags;
1430 case MFF_ICMPV4_TYPE:
1431 case MFF_ICMPV6_TYPE:
1432 value->u8 = ntohs(flow->tp_src);
1435 case MFF_ICMPV4_CODE:
1436 case MFF_ICMPV6_CODE:
1437 value->u8 = ntohs(flow->tp_dst);
1441 value->ipv6 = flow->nd_target;
1450 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1451 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1454 mf_set_value(const struct mf_field *mf,
1455 const union mf_value *value, struct match *match)
1459 match_set_dp_hash(match, ntohl(value->be32));
1462 match_set_recirc_id(match, ntohl(value->be32));
1465 match_set_tun_id(match, value->be64);
1468 match_set_tun_src(match, value->be32);
1471 match_set_tun_dst(match, value->be32);
1474 match_set_tun_flags(match, ntohs(value->be16));
1477 match_set_tun_tos(match, value->u8);
1480 match_set_tun_ttl(match, value->u8);
1484 match_set_metadata(match, value->be64);
1488 match_set_in_port(match, u16_to_ofp(ntohs(value->be16)));
1491 case MFF_IN_PORT_OXM: {
1493 ofputil_port_from_ofp11(value->be32, &port);
1494 match_set_in_port(match, port);
1498 case MFF_SKB_PRIORITY:
1499 match_set_skb_priority(match, ntohl(value->be32));
1503 match_set_pkt_mark(match, ntohl(value->be32));
1507 match_set_reg(match, mf->id - MFF_REG0, ntohl(value->be32));
1511 match_set_dl_src(match, value->mac);
1515 match_set_dl_dst(match, value->mac);
1519 match_set_dl_type(match, value->be16);
1523 match_set_dl_tci(match, value->be16);
1527 match_set_dl_vlan(match, value->be16);
1530 match_set_vlan_vid(match, value->be16);
1533 case MFF_DL_VLAN_PCP:
1535 match_set_dl_vlan_pcp(match, value->u8);
1538 case MFF_MPLS_LABEL:
1539 match_set_mpls_label(match, 0, value->be32);
1543 match_set_mpls_tc(match, 0, value->u8);
1547 match_set_mpls_bos(match, 0, value->u8);
1551 match_set_nw_src(match, value->be32);
1555 match_set_nw_dst(match, value->be32);
1559 match_set_ipv6_src(match, &value->ipv6);
1563 match_set_ipv6_dst(match, &value->ipv6);
1566 case MFF_IPV6_LABEL:
1567 match_set_ipv6_label(match, value->be32);
1571 match_set_nw_proto(match, value->u8);
1575 match_set_nw_dscp(match, value->u8);
1578 case MFF_IP_DSCP_SHIFTED:
1579 match_set_nw_dscp(match, value->u8 << 2);
1583 match_set_nw_ecn(match, value->u8);
1587 match_set_nw_ttl(match, value->u8);
1591 match_set_nw_frag(match, value->u8);
1595 match_set_nw_proto(match, ntohs(value->be16));
1599 match_set_nw_src(match, value->be32);
1603 match_set_nw_dst(match, value->be32);
1608 match_set_arp_sha(match, value->mac);
1613 match_set_arp_tha(match, value->mac);
1619 match_set_tp_src(match, value->be16);
1625 match_set_tp_dst(match, value->be16);
1629 match_set_tcp_flags(match, value->be16);
1632 case MFF_ICMPV4_TYPE:
1633 case MFF_ICMPV6_TYPE:
1634 match_set_icmp_type(match, value->u8);
1637 case MFF_ICMPV4_CODE:
1638 case MFF_ICMPV6_CODE:
1639 match_set_icmp_code(match, value->u8);
1643 match_set_nd_target(match, &value->ipv6);
1652 /* Unwildcard 'mask' member field described by 'mf'. The caller is
1653 * responsible for ensuring that 'mask' meets 'mf''s prerequisites. */
1655 mf_mask_field(const struct mf_field *mf, struct flow *mask)
1657 static const union mf_value exact_match_mask = MF_EXACT_MASK_INITIALIZER;
1659 /* For MFF_DL_VLAN, we cannot send a all 1's to flow_set_dl_vlan()
1660 * as that will be considered as OFP10_VLAN_NONE. So consider it as a
1661 * special case. For the rest, calling mf_set_flow_value() is good
1663 if (mf->id == MFF_DL_VLAN) {
1664 flow_set_dl_vlan(mask, htons(VLAN_VID_MASK));
1666 mf_set_flow_value(mf, &exact_match_mask, mask);
1670 /* Sets 'flow' member field described by 'mf' to 'value'. The caller is
1671 * responsible for ensuring that 'flow' meets 'mf''s prerequisites.*/
1673 mf_set_flow_value(const struct mf_field *mf,
1674 const union mf_value *value, struct flow *flow)
1678 flow->dp_hash = ntohl(value->be32);
1681 flow->recirc_id = ntohl(value->be32);
1684 flow->tunnel.tun_id = value->be64;
1687 flow->tunnel.ip_src = value->be32;
1690 flow->tunnel.ip_dst = value->be32;
1693 flow->tunnel.flags = ntohs(value->be16);
1696 flow->tunnel.ip_tos = value->u8;
1699 flow->tunnel.ip_ttl = value->u8;
1703 flow->metadata = value->be64;
1707 flow->in_port.ofp_port = u16_to_ofp(ntohs(value->be16));
1710 case MFF_IN_PORT_OXM: {
1712 ofputil_port_from_ofp11(value->be32, &port);
1713 flow->in_port.ofp_port = port;
1717 case MFF_SKB_PRIORITY:
1718 flow->skb_priority = ntohl(value->be32);
1722 flow->pkt_mark = ntohl(value->be32);
1726 flow->regs[mf->id - MFF_REG0] = ntohl(value->be32);
1730 memcpy(flow->dl_src, value->mac, ETH_ADDR_LEN);
1734 memcpy(flow->dl_dst, value->mac, ETH_ADDR_LEN);
1738 flow->dl_type = value->be16;
1742 flow->vlan_tci = value->be16;
1746 flow_set_dl_vlan(flow, value->be16);
1749 flow_set_vlan_vid(flow, value->be16);
1752 case MFF_DL_VLAN_PCP:
1754 flow_set_vlan_pcp(flow, value->u8);
1757 case MFF_MPLS_LABEL:
1758 flow_set_mpls_label(flow, 0, value->be32);
1762 flow_set_mpls_tc(flow, 0, value->u8);
1766 flow_set_mpls_bos(flow, 0, value->u8);
1770 flow->nw_src = value->be32;
1774 flow->nw_dst = value->be32;
1778 flow->ipv6_src = value->ipv6;
1782 flow->ipv6_dst = value->ipv6;
1785 case MFF_IPV6_LABEL:
1786 flow->ipv6_label = value->be32 & ~htonl(IPV6_LABEL_MASK);
1790 flow->nw_proto = value->u8;
1794 flow->nw_tos &= ~IP_DSCP_MASK;
1795 flow->nw_tos |= value->u8 & IP_DSCP_MASK;
1798 case MFF_IP_DSCP_SHIFTED:
1799 flow->nw_tos &= ~IP_DSCP_MASK;
1800 flow->nw_tos |= value->u8 << 2;
1804 flow->nw_tos &= ~IP_ECN_MASK;
1805 flow->nw_tos |= value->u8 & IP_ECN_MASK;
1809 flow->nw_ttl = value->u8;
1813 flow->nw_frag = value->u8 & FLOW_NW_FRAG_MASK;
1817 flow->nw_proto = ntohs(value->be16);
1821 flow->nw_src = value->be32;
1825 flow->nw_dst = value->be32;
1830 memcpy(flow->arp_sha, value->mac, ETH_ADDR_LEN);
1835 memcpy(flow->arp_tha, value->mac, ETH_ADDR_LEN);
1841 flow->tp_src = value->be16;
1847 flow->tp_dst = value->be16;
1851 flow->tcp_flags = value->be16;
1854 case MFF_ICMPV4_TYPE:
1855 case MFF_ICMPV6_TYPE:
1856 flow->tp_src = htons(value->u8);
1859 case MFF_ICMPV4_CODE:
1860 case MFF_ICMPV6_CODE:
1861 flow->tp_dst = htons(value->u8);
1865 flow->nd_target = value->ipv6;
1874 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1876 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1879 mf_is_zero(const struct mf_field *mf, const struct flow *flow)
1881 union mf_value value;
1883 mf_get_value(mf, flow, &value);
1884 return is_all_zeros((const uint8_t *) &value, mf->n_bytes);
1887 /* Makes 'match' wildcard field 'mf'.
1889 * The caller is responsible for ensuring that 'match' meets 'mf''s
1892 mf_set_wild(const struct mf_field *mf, struct match *match)
1896 match->flow.dp_hash = 0;
1897 match->wc.masks.dp_hash = 0;
1900 match->flow.recirc_id = 0;
1901 match->wc.masks.recirc_id = 0;
1904 match_set_tun_id_masked(match, htonll(0), htonll(0));
1907 match_set_tun_src_masked(match, htonl(0), htonl(0));
1910 match_set_tun_dst_masked(match, htonl(0), htonl(0));
1913 match_set_tun_flags_masked(match, 0, 0);
1916 match_set_tun_tos_masked(match, 0, 0);
1919 match_set_tun_ttl_masked(match, 0, 0);
1923 match_set_metadata_masked(match, htonll(0), htonll(0));
1927 case MFF_IN_PORT_OXM:
1928 match->flow.in_port.ofp_port = 0;
1929 match->wc.masks.in_port.ofp_port = 0;
1932 case MFF_SKB_PRIORITY:
1933 match->flow.skb_priority = 0;
1934 match->wc.masks.skb_priority = 0;
1938 match->flow.pkt_mark = 0;
1939 match->wc.masks.pkt_mark = 0;
1943 match_set_reg_masked(match, mf->id - MFF_REG0, 0, 0);
1947 memset(match->flow.dl_src, 0, ETH_ADDR_LEN);
1948 memset(match->wc.masks.dl_src, 0, ETH_ADDR_LEN);
1952 memset(match->flow.dl_dst, 0, ETH_ADDR_LEN);
1953 memset(match->wc.masks.dl_dst, 0, ETH_ADDR_LEN);
1957 match->flow.dl_type = htons(0);
1958 match->wc.masks.dl_type = htons(0);
1962 match_set_dl_tci_masked(match, htons(0), htons(0));
1967 match_set_any_vid(match);
1970 case MFF_DL_VLAN_PCP:
1972 match_set_any_pcp(match);
1975 case MFF_MPLS_LABEL:
1976 match_set_any_mpls_label(match, 0);
1980 match_set_any_mpls_tc(match, 0);
1984 match_set_any_mpls_bos(match, 0);
1989 match_set_nw_src_masked(match, htonl(0), htonl(0));
1994 match_set_nw_dst_masked(match, htonl(0), htonl(0));
1998 memset(&match->wc.masks.ipv6_src, 0, sizeof match->wc.masks.ipv6_src);
1999 memset(&match->flow.ipv6_src, 0, sizeof match->flow.ipv6_src);
2003 memset(&match->wc.masks.ipv6_dst, 0, sizeof match->wc.masks.ipv6_dst);
2004 memset(&match->flow.ipv6_dst, 0, sizeof match->flow.ipv6_dst);
2007 case MFF_IPV6_LABEL:
2008 match->wc.masks.ipv6_label = htonl(0);
2009 match->flow.ipv6_label = htonl(0);
2013 match->wc.masks.nw_proto = 0;
2014 match->flow.nw_proto = 0;
2018 case MFF_IP_DSCP_SHIFTED:
2019 match->wc.masks.nw_tos &= ~IP_DSCP_MASK;
2020 match->flow.nw_tos &= ~IP_DSCP_MASK;
2024 match->wc.masks.nw_tos &= ~IP_ECN_MASK;
2025 match->flow.nw_tos &= ~IP_ECN_MASK;
2029 match->wc.masks.nw_ttl = 0;
2030 match->flow.nw_ttl = 0;
2034 match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
2035 match->flow.nw_frag &= ~FLOW_NW_FRAG_MASK;
2039 match->wc.masks.nw_proto = 0;
2040 match->flow.nw_proto = 0;
2045 memset(match->flow.arp_sha, 0, ETH_ADDR_LEN);
2046 memset(match->wc.masks.arp_sha, 0, ETH_ADDR_LEN);
2051 memset(match->flow.arp_tha, 0, ETH_ADDR_LEN);
2052 memset(match->wc.masks.arp_tha, 0, ETH_ADDR_LEN);
2058 case MFF_ICMPV4_TYPE:
2059 case MFF_ICMPV6_TYPE:
2060 match->wc.masks.tp_src = htons(0);
2061 match->flow.tp_src = htons(0);
2067 case MFF_ICMPV4_CODE:
2068 case MFF_ICMPV6_CODE:
2069 match->wc.masks.tp_dst = htons(0);
2070 match->flow.tp_dst = htons(0);
2074 match->wc.masks.tcp_flags = htons(0);
2075 match->flow.tcp_flags = htons(0);
2079 memset(&match->wc.masks.nd_target, 0,
2080 sizeof match->wc.masks.nd_target);
2081 memset(&match->flow.nd_target, 0, sizeof match->flow.nd_target);
2090 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
2091 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
2092 * with a 1-bit indicating that the corresponding value bit must match and a
2093 * 0-bit indicating a don't-care.
2095 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
2096 * mf_set_value(mf, value, match). If 'mask' points to all-0-bits, then this
2097 * call is equivalent to mf_set_wild(mf, match).
2099 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
2100 * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
2101 enum ofputil_protocol
2102 mf_set(const struct mf_field *mf,
2103 const union mf_value *value, const union mf_value *mask,
2104 struct match *match)
2106 if (!mask || is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2107 mf_set_value(mf, value, match);
2108 return mf->usable_protocols;
2109 } else if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2110 mf_set_wild(mf, match);
2111 return OFPUTIL_P_ANY;
2117 case MFF_IN_PORT_OXM:
2118 case MFF_SKB_PRIORITY:
2121 case MFF_DL_VLAN_PCP:
2123 case MFF_MPLS_LABEL:
2129 case MFF_IP_DSCP_SHIFTED:
2132 case MFF_ICMPV4_TYPE:
2133 case MFF_ICMPV4_CODE:
2134 case MFF_ICMPV6_TYPE:
2135 case MFF_ICMPV6_CODE:
2136 return OFPUTIL_P_NONE;
2139 match_set_dp_hash_masked(match, ntohl(value->be32), ntohl(mask->be32));
2142 match_set_tun_id_masked(match, value->be64, mask->be64);
2145 match_set_tun_src_masked(match, value->be32, mask->be32);
2148 match_set_tun_dst_masked(match, value->be32, mask->be32);
2151 match_set_tun_flags_masked(match, ntohs(value->be16), ntohs(mask->be16));
2154 match_set_tun_ttl_masked(match, value->u8, mask->u8);
2157 match_set_tun_tos_masked(match, value->u8, mask->u8);
2161 match_set_metadata_masked(match, value->be64, mask->be64);
2165 match_set_reg_masked(match, mf->id - MFF_REG0,
2166 ntohl(value->be32), ntohl(mask->be32));
2170 match_set_pkt_mark_masked(match, ntohl(value->be32),
2175 match_set_dl_dst_masked(match, value->mac, mask->mac);
2179 match_set_dl_src_masked(match, value->mac, mask->mac);
2184 match_set_arp_sha_masked(match, value->mac, mask->mac);
2189 match_set_arp_tha_masked(match, value->mac, mask->mac);
2193 match_set_dl_tci_masked(match, value->be16, mask->be16);
2197 match_set_vlan_vid_masked(match, value->be16, mask->be16);
2201 match_set_nw_src_masked(match, value->be32, mask->be32);
2205 match_set_nw_dst_masked(match, value->be32, mask->be32);
2209 match_set_ipv6_src_masked(match, &value->ipv6, &mask->ipv6);
2213 match_set_ipv6_dst_masked(match, &value->ipv6, &mask->ipv6);
2216 case MFF_IPV6_LABEL:
2217 if ((mask->be32 & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK)) {
2218 mf_set_value(mf, value, match);
2220 match_set_ipv6_label_masked(match, value->be32, mask->be32);
2225 match_set_nd_target_masked(match, &value->ipv6, &mask->ipv6);
2229 match_set_nw_frag_masked(match, value->u8, mask->u8);
2233 match_set_nw_src_masked(match, value->be32, mask->be32);
2237 match_set_nw_dst_masked(match, value->be32, mask->be32);
2243 match_set_tp_src_masked(match, value->be16, mask->be16);
2249 match_set_tp_dst_masked(match, value->be16, mask->be16);
2253 match_set_tcp_flags_masked(match, value->be16, mask->be16);
2261 return mf->usable_protocols_bitwise;
2264 return ip_is_cidr(mask->be32) ? mf->usable_protocols :
2265 mf->usable_protocols_bitwise;
2269 mf_check__(const struct mf_subfield *sf, const struct flow *flow,
2273 VLOG_WARN_RL(&rl, "unknown %s field", type);
2274 return OFPERR_OFPBAC_BAD_SET_TYPE;
2275 } else if (!sf->n_bits) {
2276 VLOG_WARN_RL(&rl, "zero bit %s field %s", type, sf->field->name);
2277 return OFPERR_OFPBAC_BAD_SET_LEN;
2278 } else if (sf->ofs >= sf->field->n_bits) {
2279 VLOG_WARN_RL(&rl, "bit offset %d exceeds %d-bit width of %s field %s",
2280 sf->ofs, sf->field->n_bits, type, sf->field->name);
2281 return OFPERR_OFPBAC_BAD_SET_LEN;
2282 } else if (sf->ofs + sf->n_bits > sf->field->n_bits) {
2283 VLOG_WARN_RL(&rl, "bit offset %d and width %d exceeds %d-bit width "
2284 "of %s field %s", sf->ofs, sf->n_bits,
2285 sf->field->n_bits, type, sf->field->name);
2286 return OFPERR_OFPBAC_BAD_SET_LEN;
2287 } else if (flow && !mf_are_prereqs_ok(sf->field, flow)) {
2288 VLOG_WARN_RL(&rl, "%s field %s lacks correct prerequisites",
2289 type, sf->field->name);
2290 return OFPERR_OFPBAC_MATCH_INCONSISTENT;
2296 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
2297 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
2300 mf_check_src(const struct mf_subfield *sf, const struct flow *flow)
2302 return mf_check__(sf, flow, "source");
2305 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
2306 * if so, otherwise an OpenFlow error code (e.g. as returned by
2309 mf_check_dst(const struct mf_subfield *sf, const struct flow *flow)
2311 int error = mf_check__(sf, flow, "destination");
2312 if (!error && !sf->field->writable) {
2313 VLOG_WARN_RL(&rl, "destination field %s is not writable",
2315 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
2320 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
2321 * 'value' and 'mask', respectively. */
2323 mf_get(const struct mf_field *mf, const struct match *match,
2324 union mf_value *value, union mf_value *mask)
2326 mf_get_value(mf, &match->flow, value);
2327 mf_get_mask(mf, &match->wc, mask);
2331 mf_from_integer_string(const struct mf_field *mf, const char *s,
2332 uint8_t *valuep, uint8_t *maskp)
2334 unsigned long long int integer, mask;
2339 integer = strtoull(s, &tail, 0);
2340 if (errno || (*tail != '\0' && *tail != '/')) {
2345 mask = strtoull(tail + 1, &tail, 0);
2346 if (errno || *tail != '\0') {
2353 for (i = mf->n_bytes - 1; i >= 0; i--) {
2354 valuep[i] = integer;
2360 return xasprintf("%s: value too large for %u-byte field %s",
2361 s, mf->n_bytes, mf->name);
2366 return xasprintf("%s: bad syntax for %s", s, mf->name);
2370 mf_from_ethernet_string(const struct mf_field *mf, const char *s,
2371 uint8_t mac[ETH_ADDR_LEN],
2372 uint8_t mask[ETH_ADDR_LEN])
2376 ovs_assert(mf->n_bytes == ETH_ADDR_LEN);
2379 if (ovs_scan(s, ETH_ADDR_SCAN_FMT"%n", ETH_ADDR_SCAN_ARGS(mac), &n)
2380 && n == strlen(s)) {
2381 memset(mask, 0xff, ETH_ADDR_LEN);
2386 if (ovs_scan(s, ETH_ADDR_SCAN_FMT"/"ETH_ADDR_SCAN_FMT"%n",
2387 ETH_ADDR_SCAN_ARGS(mac), ETH_ADDR_SCAN_ARGS(mask), &n)
2388 && n == strlen(s)) {
2392 return xasprintf("%s: invalid Ethernet address", s);
2396 mf_from_ipv4_string(const struct mf_field *mf, const char *s,
2397 ovs_be32 *ip, ovs_be32 *mask)
2401 ovs_assert(mf->n_bytes == sizeof *ip);
2403 if (ovs_scan(s, IP_SCAN_FMT"/"IP_SCAN_FMT,
2404 IP_SCAN_ARGS(ip), IP_SCAN_ARGS(mask))) {
2406 } else if (ovs_scan(s, IP_SCAN_FMT"/%d", IP_SCAN_ARGS(ip), &prefix)) {
2407 if (prefix <= 0 || prefix > 32) {
2408 return xasprintf("%s: network prefix bits not between 1 and "
2410 } else if (prefix == 32) {
2411 *mask = OVS_BE32_MAX;
2413 *mask = htonl(((1u << prefix) - 1) << (32 - prefix));
2415 } else if (ovs_scan(s, IP_SCAN_FMT, IP_SCAN_ARGS(ip))) {
2416 *mask = OVS_BE32_MAX;
2418 return xasprintf("%s: invalid IP address", s);
2424 mf_from_ipv6_string(const struct mf_field *mf, const char *s,
2425 struct in6_addr *value, struct in6_addr *mask)
2427 char *str = xstrdup(s);
2428 char *save_ptr = NULL;
2429 const char *name, *netmask;
2432 ovs_assert(mf->n_bytes == sizeof *value);
2434 name = strtok_r(str, "/", &save_ptr);
2435 retval = name ? lookup_ipv6(name, value) : EINVAL;
2439 err = xasprintf("%s: could not convert to IPv6 address", str);
2445 netmask = strtok_r(NULL, "/", &save_ptr);
2447 if (inet_pton(AF_INET6, netmask, mask) != 1) {
2448 int prefix = atoi(netmask);
2449 if (prefix <= 0 || prefix > 128) {
2451 return xasprintf("%s: prefix bits not between 1 and 128", s);
2453 *mask = ipv6_create_mask(prefix);
2457 *mask = in6addr_exact;
2465 mf_from_ofp_port_string(const struct mf_field *mf, const char *s,
2466 ovs_be16 *valuep, ovs_be16 *maskp)
2470 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2472 if (ofputil_port_from_string(s, &port)) {
2473 *valuep = htons(ofp_to_u16(port));
2474 *maskp = OVS_BE16_MAX;
2477 return xasprintf("%s: port value out of range for %s", s, mf->name);
2481 mf_from_ofp_port_string32(const struct mf_field *mf, const char *s,
2482 ovs_be32 *valuep, ovs_be32 *maskp)
2486 ovs_assert(mf->n_bytes == sizeof(ovs_be32));
2487 if (ofputil_port_from_string(s, &port)) {
2488 *valuep = ofputil_port_to_ofp11(port);
2489 *maskp = OVS_BE32_MAX;
2492 return xasprintf("%s: port value out of range for %s", s, mf->name);
2495 struct frag_handling {
2501 static const struct frag_handling all_frags[] = {
2502 #define A FLOW_NW_FRAG_ANY
2503 #define L FLOW_NW_FRAG_LATER
2504 /* name mask value */
2507 { "first", A|L, A },
2508 { "later", A|L, A|L },
2513 { "not_later", L, 0 },
2520 mf_from_frag_string(const char *s, uint8_t *valuep, uint8_t *maskp)
2522 const struct frag_handling *h;
2524 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2525 if (!strcasecmp(s, h->name)) {
2526 /* We force the upper bits of the mask on to make mf_parse_value()
2527 * happy (otherwise it will never think it's an exact match.) */
2528 *maskp = h->mask | ~FLOW_NW_FRAG_MASK;
2534 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2535 "\"yes\", \"first\", \"later\", \"not_first\"", s);
2539 parse_flow_tun_flags(const char *s_, const char *(*bit_to_string)(uint32_t),
2542 uint32_t result = 0;
2543 char *save_ptr = NULL;
2546 char *s = xstrdup(s_);
2548 for (name = strtok_r((char *)s, " |", &save_ptr); name;
2549 name = strtok_r(NULL, " |", &save_ptr)) {
2551 unsigned long long int flags;
2554 if (ovs_scan(name, "%lli", &flags)) {
2558 name_len = strlen(name);
2559 for (bit = 1; bit; bit <<= 1) {
2560 const char *fname = bit_to_string(bit);
2567 len = strlen(fname);
2568 if (len != name_len) {
2571 if (!strncmp(name, fname, len)) {
2583 *res = htons(result);
2590 mf_from_tun_flags_string(const char *s, ovs_be16 *valuep, ovs_be16 *maskp)
2592 if (!parse_flow_tun_flags(s, flow_tun_flag_to_string, valuep)) {
2593 *maskp = OVS_BE16_MAX;
2597 return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
2598 "\"csum\", \"key\")", s);
2602 mf_from_tcp_flags_string(const char *s, ovs_be16 *flagsp, ovs_be16 *maskp)
2609 if (ovs_scan(s, "%"SCNi16"/%"SCNi16"%n", &flags, &mask, &n) && !s[n]) {
2610 *flagsp = htons(flags);
2611 *maskp = htons(mask);
2614 if (ovs_scan(s, "%"SCNi16"%n", &flags, &n) && !s[n]) {
2615 *flagsp = htons(flags);
2616 *maskp = OVS_BE16_MAX;
2620 while (*s != '\0') {
2632 return xasprintf("%s: TCP flag must be preceded by '+' (for SET) "
2633 "or '-' (NOT SET)", s);
2637 name_len = strcspn(s,"+-");
2639 for (bit = 1; bit; bit <<= 1) {
2640 const char *fname = packet_tcp_flag_to_string(bit);
2647 len = strlen(fname);
2648 if (len != name_len) {
2651 if (!strncmp(s, fname, len)) {
2653 return xasprintf("%s: Each TCP flag can be specified only "
2665 return xasprintf("%s: unknown TCP flag(s)", s);
2670 *flagsp = htons(flags);
2671 *maskp = htons(mask);
2676 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2677 * NULL if successful, otherwise a malloc()'d string describing the error. */
2679 mf_parse(const struct mf_field *mf, const char *s,
2680 union mf_value *value, union mf_value *mask)
2684 if (!strcmp(s, "*")) {
2685 memset(value, 0, mf->n_bytes);
2686 memset(mask, 0, mf->n_bytes);
2690 switch (mf->string) {
2692 case MFS_HEXADECIMAL:
2693 error = mf_from_integer_string(mf, s,
2694 (uint8_t *) value, (uint8_t *) mask);
2698 error = mf_from_ethernet_string(mf, s, value->mac, mask->mac);
2702 error = mf_from_ipv4_string(mf, s, &value->be32, &mask->be32);
2706 error = mf_from_ipv6_string(mf, s, &value->ipv6, &mask->ipv6);
2710 error = mf_from_ofp_port_string(mf, s, &value->be16, &mask->be16);
2713 case MFS_OFP_PORT_OXM:
2714 error = mf_from_ofp_port_string32(mf, s, &value->be32, &mask->be32);
2718 error = mf_from_frag_string(s, &value->u8, &mask->u8);
2722 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2723 error = mf_from_tun_flags_string(s, &value->be16, &mask->be16);
2727 ovs_assert(mf->n_bytes == sizeof(ovs_be16));
2728 error = mf_from_tcp_flags_string(s, &value->be16, &mask->be16);
2735 if (!error && !mf_is_mask_valid(mf, mask)) {
2736 error = xasprintf("%s: invalid mask for field %s", s, mf->name);
2741 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2742 * successful, otherwise a malloc()'d string describing the error. */
2744 mf_parse_value(const struct mf_field *mf, const char *s, union mf_value *value)
2746 union mf_value mask;
2749 error = mf_parse(mf, s, value, &mask);
2754 if (!is_all_ones((const uint8_t *) &mask, mf->n_bytes)) {
2755 return xasprintf("%s: wildcards not allowed here", s);
2761 mf_format_integer_string(const struct mf_field *mf, const uint8_t *valuep,
2762 const uint8_t *maskp, struct ds *s)
2764 unsigned long long int integer;
2767 ovs_assert(mf->n_bytes <= 8);
2770 for (i = 0; i < mf->n_bytes; i++) {
2771 integer = (integer << 8) | valuep[i];
2773 if (mf->string == MFS_HEXADECIMAL) {
2774 ds_put_format(s, "%#llx", integer);
2776 ds_put_format(s, "%lld", integer);
2780 unsigned long long int mask;
2783 for (i = 0; i < mf->n_bytes; i++) {
2784 mask = (mask << 8) | maskp[i];
2787 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2788 * not sure that that a bit-mask written in decimal is ever easier to
2789 * understand than the same bit-mask written in hexadecimal. */
2790 ds_put_format(s, "/%#llx", mask);
2795 mf_format_frag_string(uint8_t value, uint8_t mask, struct ds *s)
2797 const struct frag_handling *h;
2799 mask &= FLOW_NW_FRAG_MASK;
2802 for (h = all_frags; h < &all_frags[ARRAY_SIZE(all_frags)]; h++) {
2803 if (value == h->value && mask == h->mask) {
2804 ds_put_cstr(s, h->name);
2808 ds_put_cstr(s, "<error>");
2812 mf_format_tnl_flags_string(const ovs_be16 *valuep, struct ds *s)
2814 format_flags(s, flow_tun_flag_to_string, ntohs(*valuep), '|');
2818 mf_format_tcp_flags_string(ovs_be16 value, ovs_be16 mask, struct ds *s)
2820 format_flags_masked(s, NULL, packet_tcp_flag_to_string, ntohs(value),
2824 /* Appends to 's' a string representation of field 'mf' whose value is in
2825 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2827 mf_format(const struct mf_field *mf,
2828 const union mf_value *value, const union mf_value *mask,
2832 if (is_all_zeros((const uint8_t *) mask, mf->n_bytes)) {
2833 ds_put_cstr(s, "ANY");
2835 } else if (is_all_ones((const uint8_t *) mask, mf->n_bytes)) {
2840 switch (mf->string) {
2841 case MFS_OFP_PORT_OXM:
2844 ofputil_port_from_ofp11(value->be32, &port);
2845 ofputil_format_port(port, s);
2851 ofputil_format_port(u16_to_ofp(ntohs(value->be16)), s);
2856 case MFS_HEXADECIMAL:
2857 mf_format_integer_string(mf, (uint8_t *) value, (uint8_t *) mask, s);
2861 eth_format_masked(value->mac, mask->mac, s);
2865 ip_format_masked(value->be32, mask ? mask->be32 : OVS_BE32_MAX, s);
2869 print_ipv6_masked(s, &value->ipv6, mask ? &mask->ipv6 : NULL);
2873 mf_format_frag_string(value->u8, mask ? mask->u8 : UINT8_MAX, s);
2877 mf_format_tnl_flags_string(&value->be16, s);
2881 mf_format_tcp_flags_string(value->be16,
2882 mask ? mask->be16 : OVS_BE16_MAX, s);
2890 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2891 * least-significant bits in 'x'.
2894 mf_write_subfield_flow(const struct mf_subfield *sf,
2895 const union mf_subvalue *x, struct flow *flow)
2897 const struct mf_field *field = sf->field;
2898 union mf_value value;
2900 mf_get_value(field, flow, &value);
2901 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes,
2902 sf->ofs, sf->n_bits);
2903 mf_set_flow_value(field, &value, flow);
2906 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2907 * least-significant bits in 'x'.
2910 mf_write_subfield(const struct mf_subfield *sf, const union mf_subvalue *x,
2911 struct match *match)
2913 const struct mf_field *field = sf->field;
2914 union mf_value value, mask;
2916 mf_get(field, match, &value, &mask);
2917 bitwise_copy(x, sizeof *x, 0, &value, field->n_bytes, sf->ofs, sf->n_bits);
2918 bitwise_one ( &mask, field->n_bytes, sf->ofs, sf->n_bits);
2919 mf_set(field, &value, &mask, match);
2922 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2923 * reading 'flow', e.g. as checked by mf_check_src(). */
2925 mf_read_subfield(const struct mf_subfield *sf, const struct flow *flow,
2926 union mf_subvalue *x)
2928 union mf_value value;
2930 mf_get_value(sf->field, flow, &value);
2932 memset(x, 0, sizeof *x);
2933 bitwise_copy(&value, sf->field->n_bytes, sf->ofs,
2938 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2939 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2942 mf_get_subfield(const struct mf_subfield *sf, const struct flow *flow)
2944 union mf_value value;
2946 mf_get_value(sf->field, flow, &value);
2947 return bitwise_get(&value, sf->field->n_bytes, sf->ofs, sf->n_bits);
2950 /* Formats 'sf' into 's' in a format normally acceptable to
2951 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2952 * sf->field has no NXM name.) */
2954 mf_format_subfield(const struct mf_subfield *sf, struct ds *s)
2957 ds_put_cstr(s, "<unknown>");
2958 } else if (sf->field->nxm_name) {
2959 ds_put_cstr(s, sf->field->nxm_name);
2960 } else if (sf->field->nxm_header) {
2961 uint32_t header = sf->field->nxm_header;
2962 ds_put_format(s, "%d:%d", NXM_VENDOR(header), NXM_FIELD(header));
2964 ds_put_cstr(s, sf->field->name);
2967 if (sf->field && sf->ofs == 0 && sf->n_bits == sf->field->n_bits) {
2968 ds_put_cstr(s, "[]");
2969 } else if (sf->n_bits == 1) {
2970 ds_put_format(s, "[%d]", sf->ofs);
2972 ds_put_format(s, "[%d..%d]", sf->ofs, sf->ofs + sf->n_bits - 1);
2976 static const struct mf_field *
2977 mf_parse_subfield_name(const char *name, int name_len, bool *wild)
2981 *wild = name_len > 2 && !memcmp(&name[name_len - 2], "_W", 2);
2986 for (i = 0; i < MFF_N_IDS; i++) {
2987 const struct mf_field *mf = mf_from_id(i);
2990 && !strncmp(mf->nxm_name, name, name_len)
2991 && mf->nxm_name[name_len] == '\0') {
2995 && !strncmp(mf->oxm_name, name, name_len)
2996 && mf->oxm_name[name_len] == '\0') {
3004 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
3005 * returns NULL and advances '*sp' to the first byte following the parsed
3006 * string. On failure, returns a malloc()'d error message, does not modify
3007 * '*sp', and does not properly initialize 'sf'.
3009 * The syntax parsed from '*sp' takes the form "header[start..end]" where
3010 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
3011 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
3012 * may both be omitted (the [] are still required) to indicate an entire
3014 char * WARN_UNUSED_RESULT
3015 mf_parse_subfield__(struct mf_subfield *sf, const char **sp)
3017 const struct mf_field *field;
3026 name_len = strcspn(s, "[");
3027 if (s[name_len] != '[') {
3028 return xasprintf("%s: missing [ looking for field name", *sp);
3031 field = mf_parse_subfield_name(name, name_len, &wild);
3033 return xasprintf("%s: unknown field `%.*s'", *sp, name_len, s);
3037 if (ovs_scan(s, "[%d..%d]", &start, &end)) {
3038 /* Nothing to do. */
3039 } else if (ovs_scan(s, "[%d]", &start)) {
3041 } else if (!strncmp(s, "[]", 2)) {
3043 end = field->n_bits - 1;
3045 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
3046 "[<start>..<end>]", *sp);
3048 s = strchr(s, ']') + 1;
3051 return xasprintf("%s: starting bit %d is after ending bit %d",
3053 } else if (start >= field->n_bits) {
3054 return xasprintf("%s: starting bit %d is not valid because field is "
3055 "only %d bits wide", *sp, start, field->n_bits);
3056 } else if (end >= field->n_bits){
3057 return xasprintf("%s: ending bit %d is not valid because field is "
3058 "only %d bits wide", *sp, end, field->n_bits);
3063 sf->n_bits = end - start + 1;
3069 /* Parses a subfield from the entirety of 's' into 'sf'. Returns NULL if
3070 * successful, otherwise a malloc()'d string describing the error. The caller
3071 * is responsible for freeing the returned string.
3073 * The syntax parsed from 's' takes the form "header[start..end]" where
3074 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
3075 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
3076 * may both be omitted (the [] are still required) to indicate an entire
3078 char * WARN_UNUSED_RESULT
3079 mf_parse_subfield(struct mf_subfield *sf, const char *s)
3081 char *error = mf_parse_subfield__(sf, &s);
3082 if (!error && s[0]) {
3083 error = xstrdup("unexpected input following field syntax");
3089 mf_format_subvalue(const union mf_subvalue *subvalue, struct ds *s)
3093 for (i = 0; i < ARRAY_SIZE(subvalue->u8); i++) {
3094 if (subvalue->u8[i]) {
3095 ds_put_format(s, "0x%"PRIx8, subvalue->u8[i]);
3096 for (i++; i < ARRAY_SIZE(subvalue->u8); i++) {
3097 ds_put_format(s, "%02"PRIx8, subvalue->u8[i]);
3102 ds_put_char(s, '0');