2 * Copyright (c) 2011, 2012, 2013 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_TUN_ID
, "tun_id", "tunnel_id",
61 NXM_NX_TUN_ID
, "NXM_NX_TUN_ID",
62 OXM_OF_TUNNEL_ID
, "OXM_OF_TUNNEL_ID",
63 OFPUTIL_P_NXM_OXM_ANY
,
64 OFPUTIL_P_NXM_OXM_ANY
,
65 FLOW_U32OFS(tunnel
.tun_id
),
67 MFF_TUN_SRC
, "tun_src", NULL
,
73 NXM_NX_TUN_IPV4_SRC
, "NXM_NX_TUN_IPV4_SRC",
74 NXM_NX_TUN_IPV4_SRC
, "NXM_NX_TUN_IPV4_SRC",
75 OFPUTIL_P_NXM_OXM_ANY
,
76 OFPUTIL_P_NXM_OXM_ANY
,
77 FLOW_U32OFS(tunnel
.ip_src
),
79 MFF_TUN_DST
, "tun_dst", NULL
,
85 NXM_NX_TUN_IPV4_DST
, "NXM_NX_TUN_IPV4_DST",
86 NXM_NX_TUN_IPV4_DST
, "NXM_NX_TUN_IPV4_DST",
87 OFPUTIL_P_NXM_OXM_ANY
,
88 OFPUTIL_P_NXM_OXM_ANY
,
89 FLOW_U32OFS(tunnel
.ip_dst
),
91 MFF_TUN_FLAGS
, "tun_flags", NULL
,
103 MFF_TUN_TTL
, "tun_ttl", NULL
,
115 MFF_TUN_TOS
, "tun_tos", NULL
,
127 MFF_METADATA
, "metadata", NULL
,
128 MF_FIELD_SIZES(be64
),
133 OXM_OF_METADATA
, "OXM_OF_METADATA",
134 OXM_OF_METADATA
, "OXM_OF_METADATA",
135 OFPUTIL_P_NXM_OF11_UP
,
136 OFPUTIL_P_NXM_OF11_UP
,
139 MFF_IN_PORT
, "in_port", NULL
,
140 MF_FIELD_SIZES(be16
),
145 NXM_OF_IN_PORT
, "NXM_OF_IN_PORT",
146 NXM_OF_IN_PORT
, "NXM_OF_IN_PORT",
147 OFPUTIL_P_ANY
, /* OF11+ via mapping to 32 bits. */
151 MFF_IN_PORT_OXM
, "in_port_oxm", NULL
,
152 MF_FIELD_SIZES(be32
),
157 OXM_OF_IN_PORT
, "OXM_OF_IN_PORT",
158 OXM_OF_IN_PORT
, "OXM_OF_IN_PORT",
163 MFF_SKB_PRIORITY
, "skb_priority", NULL
,
164 MF_FIELD_SIZES(be32
),
175 MFF_PKT_MARK
, "pkt_mark", NULL
,
176 MF_FIELD_SIZES(be32
),
181 NXM_NX_PKT_MARK
, "NXM_NX_PKT_MARK",
182 NXM_NX_PKT_MARK
, "NXM_NX_PKT_MARK",
183 OFPUTIL_P_NXM_OXM_ANY
,
184 OFPUTIL_P_NXM_OXM_ANY
,
188 #define REGISTER(IDX) \
190 MFF_REG##IDX, "reg" #IDX, NULL, \
191 MF_FIELD_SIZES(be32), \
196 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
197 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
198 OFPUTIL_P_NXM_OXM_ANY, \
199 OFPUTIL_P_NXM_OXM_ANY, \
235 MFF_ETH_SRC
, "eth_src", "dl_src",
241 NXM_OF_ETH_SRC
, "NXM_OF_ETH_SRC",
242 OXM_OF_ETH_SRC
, "OXM_OF_ETH_SRC",
244 OFPUTIL_P_NXM_OF11_UP
, /* Bitwise masking only with NXM and OF11+! */
247 MFF_ETH_DST
, "eth_dst", "dl_dst",
253 NXM_OF_ETH_DST
, "NXM_OF_ETH_DST",
254 OXM_OF_ETH_DST
, "OXM_OF_ETH_DST",
256 OFPUTIL_P_NXM_OF11_UP
, /* Bitwise masking only with NXM and OF11+! */
259 MFF_ETH_TYPE
, "eth_type", "dl_type",
260 MF_FIELD_SIZES(be16
),
265 NXM_OF_ETH_TYPE
, "NXM_OF_ETH_TYPE",
266 OXM_OF_ETH_TYPE
, "OXM_OF_ETH_TYPE",
273 MFF_VLAN_TCI
, "vlan_tci", NULL
,
274 MF_FIELD_SIZES(be16
),
279 NXM_OF_VLAN_TCI
, "NXM_OF_VLAN_TCI",
280 NXM_OF_VLAN_TCI
, "NXM_OF_VLAN_TCI",
282 OFPUTIL_P_NXM_OXM_ANY
,
285 MFF_DL_VLAN
, "dl_vlan", NULL
,
286 sizeof(ovs_be16
), 12,
294 OFPUTIL_P_NXM_OXM_ANY
,
297 MFF_VLAN_VID
, "vlan_vid", NULL
,
298 sizeof(ovs_be16
), 12,
303 OXM_OF_VLAN_VID
, "OXM_OF_VLAN_VID",
304 OXM_OF_VLAN_VID
, "OXM_OF_VLAN_VID",
306 OFPUTIL_P_NXM_OXM_ANY
,
309 MFF_DL_VLAN_PCP
, "dl_vlan_pcp", NULL
,
317 OFPUTIL_P_ANY
, /* Will be mapped to NXM and OXM. */
321 MFF_VLAN_PCP
, "vlan_pcp", NULL
,
327 OXM_OF_VLAN_PCP
, "OXM_OF_VLAN_PCP",
328 OXM_OF_VLAN_PCP
, "OXM_OF_VLAN_PCP",
329 OFPUTIL_P_ANY
, /* Will be mapped to OF10 and NXM. */
338 MFF_MPLS_LABEL
, "mpls_label", NULL
,
344 OXM_OF_MPLS_LABEL
, "OXM_OF_MPLS_LABEL",
345 OXM_OF_MPLS_LABEL
, "OXM_OF_MPLS_LABEL",
346 OFPUTIL_P_NXM_OF11_UP
,
350 MFF_MPLS_TC
, "mpls_tc", NULL
,
356 OXM_OF_MPLS_TC
, "OXM_OF_MPLS_TC",
357 OXM_OF_MPLS_TC
, "OXM_OF_MPLS_TC",
358 OFPUTIL_P_NXM_OF11_UP
,
362 MFF_MPLS_BOS
, "mpls_bos", NULL
,
368 OXM_OF_MPLS_BOS
, "OXM_OF_MPLS_BOS",
369 OXM_OF_MPLS_BOS
, "OXM_OF_MPLS_BOS",
370 OFPUTIL_P_NXM_OXM_ANY
,
380 MFF_IPV4_SRC
, "ip_src", "nw_src",
381 MF_FIELD_SIZES(be32
),
386 NXM_OF_IP_SRC
, "NXM_OF_IP_SRC",
387 OXM_OF_IPV4_SRC
, "OXM_OF_IPV4_SRC",
389 OFPUTIL_P_NXM_OF11_UP
,
392 MFF_IPV4_DST
, "ip_dst", "nw_dst",
393 MF_FIELD_SIZES(be32
),
398 NXM_OF_IP_DST
, "NXM_OF_IP_DST",
399 OXM_OF_IPV4_DST
, "OXM_OF_IPV4_DST",
401 OFPUTIL_P_NXM_OF11_UP
,
406 MFF_IPV6_SRC
, "ipv6_src", NULL
,
407 MF_FIELD_SIZES(ipv6
),
412 NXM_NX_IPV6_SRC
, "NXM_NX_IPV6_SRC",
413 OXM_OF_IPV6_SRC
, "OXM_OF_IPV6_SRC",
414 OFPUTIL_P_NXM_OXM_ANY
,
415 OFPUTIL_P_NXM_OXM_ANY
,
416 FLOW_U32OFS(ipv6_src
),
418 MFF_IPV6_DST
, "ipv6_dst", NULL
,
419 MF_FIELD_SIZES(ipv6
),
424 NXM_NX_IPV6_DST
, "NXM_NX_IPV6_DST",
425 OXM_OF_IPV6_DST
, "OXM_OF_IPV6_DST",
426 OFPUTIL_P_NXM_OXM_ANY
,
427 OFPUTIL_P_NXM_OXM_ANY
,
428 FLOW_U32OFS(ipv6_dst
),
431 MFF_IPV6_LABEL
, "ipv6_label", NULL
,
437 NXM_NX_IPV6_LABEL
, "NXM_NX_IPV6_LABEL",
438 OXM_OF_IPV6_FLABEL
, "OXM_OF_IPV6_FLABEL",
439 OFPUTIL_P_NXM_OXM_ANY
,
440 OFPUTIL_P_NXM_OXM_ANY
,
445 MFF_IP_PROTO
, "nw_proto", "ip_proto",
451 NXM_OF_IP_PROTO
, "NXM_OF_IP_PROTO",
452 OXM_OF_IP_PROTO
, "OXM_OF_IP_PROTO",
457 MFF_IP_DSCP
, "nw_tos", NULL
,
463 NXM_OF_IP_TOS
, "NXM_OF_IP_TOS",
464 NXM_OF_IP_TOS
, "NXM_OF_IP_TOS",
465 OFPUTIL_P_ANY
, /* Will be shifted for OXM. */
469 MFF_IP_DSCP_SHIFTED
, "ip_dscp", NULL
,
475 OXM_OF_IP_DSCP
, "OXM_OF_IP_DSCP",
476 OXM_OF_IP_DSCP
, "OXM_OF_IP_DSCP",
477 OFPUTIL_P_ANY
, /* Will be shifted for non-OXM. */
481 MFF_IP_ECN
, "nw_ecn", "ip_ecn",
487 NXM_NX_IP_ECN
, "NXM_NX_IP_ECN",
488 OXM_OF_IP_ECN
, "OXM_OF_IP_ECN",
489 OFPUTIL_P_NXM_OXM_ANY
,
493 MFF_IP_TTL
, "nw_ttl", NULL
,
499 NXM_NX_IP_TTL
, "NXM_NX_IP_TTL",
500 NXM_NX_IP_TTL
, "NXM_NX_IP_TTL",
501 OFPUTIL_P_NXM_OXM_ANY
,
505 MFF_IP_FRAG
, "ip_frag", NULL
,
511 NXM_NX_IP_FRAG
, "NXM_NX_IP_FRAG",
512 NXM_NX_IP_FRAG
, "NXM_NX_IP_FRAG",
513 OFPUTIL_P_NXM_OXM_ANY
,
514 OFPUTIL_P_NXM_OXM_ANY
,
519 MFF_ARP_OP
, "arp_op", NULL
,
520 MF_FIELD_SIZES(be16
),
525 NXM_OF_ARP_OP
, "NXM_OF_ARP_OP",
526 OXM_OF_ARP_OP
, "OXM_OF_ARP_OP",
531 MFF_ARP_SPA
, "arp_spa", NULL
,
532 MF_FIELD_SIZES(be32
),
537 NXM_OF_ARP_SPA
, "NXM_OF_ARP_SPA",
538 OXM_OF_ARP_SPA
, "OXM_OF_ARP_SPA",
540 OFPUTIL_P_NXM_OF11_UP
,
543 MFF_ARP_TPA
, "arp_tpa", NULL
,
544 MF_FIELD_SIZES(be32
),
549 NXM_OF_ARP_TPA
, "NXM_OF_ARP_TPA",
550 OXM_OF_ARP_TPA
, "OXM_OF_ARP_TPA",
552 OFPUTIL_P_NXM_OF11_UP
,
555 MFF_ARP_SHA
, "arp_sha", NULL
,
561 NXM_NX_ARP_SHA
, "NXM_NX_ARP_SHA",
562 OXM_OF_ARP_SHA
, "OXM_OF_ARP_SHA",
563 OFPUTIL_P_NXM_OXM_ANY
,
564 OFPUTIL_P_NXM_OXM_ANY
,
567 MFF_ARP_THA
, "arp_tha", NULL
,
573 NXM_NX_ARP_THA
, "NXM_NX_ARP_THA",
574 OXM_OF_ARP_THA
, "OXM_OF_ARP_THA",
575 OFPUTIL_P_NXM_OXM_ANY
,
576 OFPUTIL_P_NXM_OXM_ANY
,
585 MFF_TCP_SRC
, "tcp_src", "tp_src",
586 MF_FIELD_SIZES(be16
),
591 NXM_OF_TCP_SRC
, "NXM_OF_TCP_SRC",
592 OXM_OF_TCP_SRC
, "OXM_OF_TCP_SRC",
594 OFPUTIL_P_NXM_OXM_ANY
,
597 MFF_TCP_DST
, "tcp_dst", "tp_dst",
598 MF_FIELD_SIZES(be16
),
603 NXM_OF_TCP_DST
, "NXM_OF_TCP_DST",
604 OXM_OF_TCP_DST
, "OXM_OF_TCP_DST",
606 OFPUTIL_P_NXM_OXM_ANY
,
609 MFF_TCP_FLAGS
, "tcp_flags", NULL
,
615 NXM_NX_TCP_FLAGS
, "NXM_NX_TCP_FLAGS",
616 NXM_NX_TCP_FLAGS
, "NXM_NX_TCP_FLAGS",
617 OFPUTIL_P_NXM_OXM_ANY
,
618 OFPUTIL_P_NXM_OXM_ANY
,
623 MFF_UDP_SRC
, "udp_src", NULL
,
624 MF_FIELD_SIZES(be16
),
629 NXM_OF_UDP_SRC
, "NXM_OF_UDP_SRC",
630 OXM_OF_UDP_SRC
, "OXM_OF_UDP_SRC",
632 OFPUTIL_P_NXM_OXM_ANY
,
635 MFF_UDP_DST
, "udp_dst", NULL
,
636 MF_FIELD_SIZES(be16
),
641 NXM_OF_UDP_DST
, "NXM_OF_UDP_DST",
642 OXM_OF_UDP_DST
, "OXM_OF_UDP_DST",
644 OFPUTIL_P_NXM_OXM_ANY
,
649 MFF_SCTP_SRC
, "sctp_src", NULL
,
650 MF_FIELD_SIZES(be16
),
655 OXM_OF_SCTP_SRC
, "OXM_OF_SCTP_SRC",
656 OXM_OF_SCTP_SRC
, "OXM_OF_SCTP_SRC",
657 OFPUTIL_P_NXM_OF11_UP
,
658 OFPUTIL_P_NXM_OXM_ANY
,
661 MFF_SCTP_DST
, "sctp_dst", NULL
,
662 MF_FIELD_SIZES(be16
),
667 OXM_OF_SCTP_DST
, "OXM_OF_SCTP_DST",
668 OXM_OF_SCTP_DST
, "OXM_OF_SCTP_DST",
669 OFPUTIL_P_NXM_OF11_UP
,
670 OFPUTIL_P_NXM_OXM_ANY
,
675 MFF_ICMPV4_TYPE
, "icmp_type", NULL
,
681 NXM_OF_ICMP_TYPE
, "NXM_OF_ICMP_TYPE",
682 OXM_OF_ICMPV4_TYPE
, "OXM_OF_ICMPV4_TYPE",
687 MFF_ICMPV4_CODE
, "icmp_code", NULL
,
693 NXM_OF_ICMP_CODE
, "NXM_OF_ICMP_CODE",
694 OXM_OF_ICMPV4_CODE
, "OXM_OF_ICMPV4_CODE",
701 MFF_ICMPV6_TYPE
, "icmpv6_type", NULL
,
707 NXM_NX_ICMPV6_TYPE
, "NXM_NX_ICMPV6_TYPE",
708 OXM_OF_ICMPV6_TYPE
, "OXM_OF_ICMPV6_TYPE",
709 OFPUTIL_P_NXM_OXM_ANY
,
713 MFF_ICMPV6_CODE
, "icmpv6_code", NULL
,
719 NXM_NX_ICMPV6_CODE
, "NXM_NX_ICMPV6_CODE",
720 OXM_OF_ICMPV6_CODE
, "OXM_OF_ICMPV6_CODE",
721 OFPUTIL_P_NXM_OXM_ANY
,
731 MFF_ND_TARGET
, "nd_target", NULL
,
732 MF_FIELD_SIZES(ipv6
),
737 NXM_NX_ND_TARGET
, "NXM_NX_ND_TARGET",
738 OXM_OF_IPV6_ND_TARGET
, "OXM_OF_IPV6_ND_TARGET",
739 OFPUTIL_P_NXM_OXM_ANY
,
740 OFPUTIL_P_NXM_OXM_ANY
,
743 MFF_ND_SLL
, "nd_sll", NULL
,
749 NXM_NX_ND_SLL
, "NXM_NX_ND_SLL",
750 OXM_OF_IPV6_ND_SLL
, "OXM_OF_IPV6_ND_SLL",
751 OFPUTIL_P_NXM_OXM_ANY
,
752 OFPUTIL_P_NXM_OXM_ANY
,
755 MFF_ND_TLL
, "nd_tll", NULL
,
761 NXM_NX_ND_TLL
, "NXM_NX_ND_TLL",
762 OXM_OF_IPV6_ND_TLL
, "OXM_OF_IPV6_ND_TLL",
763 OFPUTIL_P_NXM_OXM_ANY
,
764 OFPUTIL_P_NXM_OXM_ANY
,
769 /* Maps an NXM or OXM header value to an mf_field. */
771 struct hmap_node hmap_node
; /* In 'all_fields' hmap. */
772 uint32_t header
; /* NXM or OXM header value. */
773 const struct mf_field
*mf
;
776 /* Contains 'struct nxm_field's. */
777 static struct hmap all_fields
;
779 /* Maps from an mf_field's 'name' or 'extra_name' to the mf_field. */
780 static struct shash mf_by_name
;
782 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
783 * controller and so there's not much point in showing a lot of them. */
784 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
786 const struct mf_field
*mf_from_nxm_header__(uint32_t header
);
787 static void nxm_init(void);
789 /* Returns the field with the given 'name', or a null pointer if no field has
791 const struct mf_field
*
792 mf_from_name(const char *name
)
795 return shash_find_data(&mf_by_name
, name
);
799 add_nxm_field(uint32_t header
, const struct mf_field
*mf
)
803 f
= xmalloc(sizeof *f
);
804 hmap_insert(&all_fields
, &f
->hmap_node
, hash_int(header
, 0));
810 nxm_init_add_field(const struct mf_field
*mf
, uint32_t header
)
813 ovs_assert(!mf_from_nxm_header__(header
));
814 add_nxm_field(header
, mf
);
815 if (mf
->maskable
!= MFM_NONE
) {
816 add_nxm_field(NXM_MAKE_WILD_HEADER(header
), mf
);
826 hmap_init(&all_fields
);
827 shash_init(&mf_by_name
);
828 for (i
= 0; i
< MFF_N_IDS
; i
++) {
829 const struct mf_field
*mf
= &mf_fields
[i
];
831 ovs_assert(mf
->id
== i
); /* Fields must be in the enum order. */
833 nxm_init_add_field(mf
, mf
->nxm_header
);
834 if (mf
->oxm_header
!= mf
->nxm_header
) {
835 nxm_init_add_field(mf
, mf
->oxm_header
);
838 shash_add_once(&mf_by_name
, mf
->name
, mf
);
839 if (mf
->extra_name
) {
840 shash_add_once(&mf_by_name
, mf
->extra_name
, mf
);
848 static pthread_once_t once
= PTHREAD_ONCE_INIT
;
849 pthread_once(&once
, nxm_do_init
);
852 const struct mf_field
*
853 mf_from_nxm_header(uint32_t header
)
856 return mf_from_nxm_header__(header
);
859 const struct mf_field
*
860 mf_from_nxm_header__(uint32_t header
)
862 const struct nxm_field
*f
;
864 HMAP_FOR_EACH_IN_BUCKET (f
, hmap_node
, hash_int(header
, 0), &all_fields
) {
865 if (f
->header
== header
) {
873 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
874 * specifies at least one bit in the field.
876 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
877 * meets 'mf''s prerequisites. */
879 mf_is_all_wild(const struct mf_field
*mf
, const struct flow_wildcards
*wc
)
883 return !wc
->masks
.tunnel
.ip_src
;
885 return !wc
->masks
.tunnel
.ip_dst
;
890 return !wc
->masks
.tunnel
.tun_id
;
892 return !wc
->masks
.metadata
;
894 case MFF_IN_PORT_OXM
:
895 return !wc
->masks
.in_port
.ofp_port
;
896 case MFF_SKB_PRIORITY
:
897 return !wc
->masks
.skb_priority
;
899 return !wc
->masks
.pkt_mark
;
901 return !wc
->masks
.regs
[mf
->id
- MFF_REG0
];
904 return eth_addr_is_zero(wc
->masks
.dl_src
);
906 return eth_addr_is_zero(wc
->masks
.dl_dst
);
908 return !wc
->masks
.dl_type
;
912 return eth_addr_is_zero(wc
->masks
.arp_sha
);
916 return eth_addr_is_zero(wc
->masks
.arp_tha
);
919 return !wc
->masks
.vlan_tci
;
921 return !(wc
->masks
.vlan_tci
& htons(VLAN_VID_MASK
));
923 return !(wc
->masks
.vlan_tci
& htons(VLAN_VID_MASK
| VLAN_CFI
));
924 case MFF_DL_VLAN_PCP
:
926 return !(wc
->masks
.vlan_tci
& htons(VLAN_PCP_MASK
));
929 return !(wc
->masks
.mpls_lse
& htonl(MPLS_LABEL_MASK
));
931 return !(wc
->masks
.mpls_lse
& htonl(MPLS_TC_MASK
));
933 return !(wc
->masks
.mpls_lse
& htonl(MPLS_BOS_MASK
));
936 return !wc
->masks
.nw_src
;
938 return !wc
->masks
.nw_dst
;
941 return ipv6_mask_is_any(&wc
->masks
.ipv6_src
);
943 return ipv6_mask_is_any(&wc
->masks
.ipv6_dst
);
946 return !wc
->masks
.ipv6_label
;
949 return !wc
->masks
.nw_proto
;
951 case MFF_IP_DSCP_SHIFTED
:
952 return !(wc
->masks
.nw_tos
& IP_DSCP_MASK
);
954 return !(wc
->masks
.nw_tos
& IP_ECN_MASK
);
956 return !wc
->masks
.nw_ttl
;
959 return ipv6_mask_is_any(&wc
->masks
.nd_target
);
962 return !(wc
->masks
.nw_frag
& FLOW_NW_FRAG_MASK
);
965 return !wc
->masks
.nw_proto
;
967 return !wc
->masks
.nw_src
;
969 return !wc
->masks
.nw_dst
;
974 case MFF_ICMPV4_TYPE
:
975 case MFF_ICMPV6_TYPE
:
976 return !wc
->masks
.tp_src
;
980 case MFF_ICMPV4_CODE
:
981 case MFF_ICMPV6_CODE
:
982 return !wc
->masks
.tp_dst
;
984 return !wc
->masks
.tcp_flags
;
992 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
993 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
994 * purposes, or to 0 if it is wildcarded.
996 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
997 * meets 'mf''s prerequisites. */
999 mf_get_mask(const struct mf_field
*mf
, const struct flow_wildcards
*wc
,
1000 union mf_value
*mask
)
1002 mf_get_value(mf
, &wc
->masks
, mask
);
1005 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
1006 * if the mask is valid, false otherwise. */
1008 mf_is_mask_valid(const struct mf_field
*mf
, const union mf_value
*mask
)
1010 switch (mf
->maskable
) {
1012 return (is_all_zeros((const uint8_t *) mask
, mf
->n_bytes
) ||
1013 is_all_ones((const uint8_t *) mask
, mf
->n_bytes
));
1023 is_icmpv4(const struct flow
*flow
)
1025 return (flow
->dl_type
== htons(ETH_TYPE_IP
)
1026 && flow
->nw_proto
== IPPROTO_ICMP
);
1030 is_icmpv6(const struct flow
*flow
)
1032 return (flow
->dl_type
== htons(ETH_TYPE_IPV6
)
1033 && flow
->nw_proto
== IPPROTO_ICMPV6
);
1036 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
1038 mf_are_prereqs_ok(const struct mf_field
*mf
, const struct flow
*flow
)
1040 switch (mf
->prereqs
) {
1045 return (flow
->dl_type
== htons(ETH_TYPE_ARP
) ||
1046 flow
->dl_type
== htons(ETH_TYPE_RARP
));
1048 return flow
->dl_type
== htons(ETH_TYPE_IP
);
1050 return flow
->dl_type
== htons(ETH_TYPE_IPV6
);
1052 return (flow
->vlan_tci
& htons(VLAN_CFI
)) != 0;
1054 return eth_type_mpls(flow
->dl_type
);
1056 return is_ip_any(flow
);
1059 return is_ip_any(flow
) && flow
->nw_proto
== IPPROTO_TCP
;
1061 return is_ip_any(flow
) && flow
->nw_proto
== IPPROTO_UDP
;
1063 return is_ip_any(flow
) && flow
->nw_proto
== IPPROTO_SCTP
;
1065 return is_icmpv4(flow
);
1067 return is_icmpv6(flow
);
1070 return (is_icmpv6(flow
)
1071 && flow
->tp_dst
== htons(0)
1072 && (flow
->tp_src
== htons(ND_NEIGHBOR_SOLICIT
) ||
1073 flow
->tp_src
== htons(ND_NEIGHBOR_ADVERT
)));
1074 case MFP_ND_SOLICIT
:
1075 return (is_icmpv6(flow
)
1076 && flow
->tp_dst
== htons(0)
1077 && (flow
->tp_src
== htons(ND_NEIGHBOR_SOLICIT
)));
1079 return (is_icmpv6(flow
)
1080 && flow
->tp_dst
== htons(0)
1081 && (flow
->tp_src
== htons(ND_NEIGHBOR_ADVERT
)));
1087 /* Set field and it's prerequisities in the mask.
1088 * This is only ever called for writeable 'mf's, but we do not make the
1089 * distinction here. */
1091 mf_mask_field_and_prereqs(const struct mf_field
*mf
, struct flow
*mask
)
1093 static const union mf_value exact_match_mask
= MF_EXACT_MASK_INITIALIZER
;
1095 mf_set_flow_value(mf
, &exact_match_mask
, mask
);
1097 switch (mf
->prereqs
) {
1099 case MFP_ND_SOLICIT
:
1101 mask
->tp_src
= OVS_BE16_MAX
;
1102 mask
->tp_dst
= OVS_BE16_MAX
;
1109 mask
->nw_proto
= 0xff;
1116 mask
->dl_type
= OVS_BE16_MAX
;
1119 mask
->vlan_tci
|= htons(VLAN_CFI
);
1127 /* Returns true if 'value' may be a valid value *as part of a masked match*,
1130 * A value is not rejected just because it is not valid for the field in
1131 * question, but only if it doesn't make sense to test the bits in question at
1132 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
1133 * without the VLAN_CFI bit being set, but we can't reject those values because
1134 * it is still legitimate to test just for those bits (see the documentation
1135 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
1136 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
1138 mf_is_value_valid(const struct mf_field
*mf
, const union mf_value
*value
)
1149 case MFF_SKB_PRIORITY
:
1172 case MFF_ICMPV4_TYPE
:
1173 case MFF_ICMPV4_CODE
:
1174 case MFF_ICMPV6_TYPE
:
1175 case MFF_ICMPV6_CODE
:
1181 case MFF_IN_PORT_OXM
: {
1183 return !ofputil_port_from_ofp11(value
->be32
, &port
);
1187 return !(value
->u8
& ~IP_DSCP_MASK
);
1188 case MFF_IP_DSCP_SHIFTED
:
1189 return !(value
->u8
& (~IP_DSCP_MASK
>> 2));
1191 return !(value
->u8
& ~IP_ECN_MASK
);
1193 return !(value
->u8
& ~FLOW_NW_FRAG_MASK
);
1195 return !(value
->be16
& ~htons(0x0fff));
1198 return !(value
->be16
& htons(0xff00));
1201 return !(value
->be16
& htons(VLAN_CFI
| VLAN_PCP_MASK
));
1203 return !(value
->be16
& htons(VLAN_PCP_MASK
));
1205 case MFF_DL_VLAN_PCP
:
1207 return !(value
->u8
& ~(VLAN_PCP_MASK
>> VLAN_PCP_SHIFT
));
1209 case MFF_IPV6_LABEL
:
1210 return !(value
->be32
& ~htonl(IPV6_LABEL_MASK
));
1212 case MFF_MPLS_LABEL
:
1213 return !(value
->be32
& ~htonl(MPLS_LABEL_MASK
>> MPLS_LABEL_SHIFT
));
1216 return !(value
->u8
& ~(MPLS_TC_MASK
>> MPLS_TC_SHIFT
));
1219 return !(value
->u8
& ~(MPLS_BOS_MASK
>> MPLS_BOS_SHIFT
));
1227 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
1228 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
1230 mf_get_value(const struct mf_field
*mf
, const struct flow
*flow
,
1231 union mf_value
*value
)
1235 value
->be64
= flow
->tunnel
.tun_id
;
1238 value
->be32
= flow
->tunnel
.ip_src
;
1241 value
->be32
= flow
->tunnel
.ip_dst
;
1244 value
->be16
= htons(flow
->tunnel
.flags
);
1247 value
->u8
= flow
->tunnel
.ip_ttl
;
1250 value
->u8
= flow
->tunnel
.ip_tos
;
1254 value
->be64
= flow
->metadata
;
1258 value
->be16
= htons(ofp_to_u16(flow
->in_port
.ofp_port
));
1260 case MFF_IN_PORT_OXM
:
1261 value
->be32
= ofputil_port_to_ofp11(flow
->in_port
.ofp_port
);
1264 case MFF_SKB_PRIORITY
:
1265 value
->be32
= htonl(flow
->skb_priority
);
1269 value
->be32
= htonl(flow
->pkt_mark
);
1273 value
->be32
= htonl(flow
->regs
[mf
->id
- MFF_REG0
]);
1277 memcpy(value
->mac
, flow
->dl_src
, ETH_ADDR_LEN
);
1281 memcpy(value
->mac
, flow
->dl_dst
, ETH_ADDR_LEN
);
1285 value
->be16
= flow
->dl_type
;
1289 value
->be16
= flow
->vlan_tci
;
1293 value
->be16
= flow
->vlan_tci
& htons(VLAN_VID_MASK
);
1296 value
->be16
= flow
->vlan_tci
& htons(VLAN_VID_MASK
| VLAN_CFI
);
1299 case MFF_DL_VLAN_PCP
:
1301 value
->u8
= vlan_tci_to_pcp(flow
->vlan_tci
);
1304 case MFF_MPLS_LABEL
:
1305 value
->be32
= htonl(mpls_lse_to_label(flow
->mpls_lse
));
1309 value
->u8
= mpls_lse_to_tc(flow
->mpls_lse
);
1313 value
->u8
= mpls_lse_to_bos(flow
->mpls_lse
);
1317 value
->be32
= flow
->nw_src
;
1321 value
->be32
= flow
->nw_dst
;
1325 value
->ipv6
= flow
->ipv6_src
;
1329 value
->ipv6
= flow
->ipv6_dst
;
1332 case MFF_IPV6_LABEL
:
1333 value
->be32
= flow
->ipv6_label
;
1337 value
->u8
= flow
->nw_proto
;
1341 value
->u8
= flow
->nw_tos
& IP_DSCP_MASK
;
1344 case MFF_IP_DSCP_SHIFTED
:
1345 value
->u8
= flow
->nw_tos
>> 2;
1349 value
->u8
= flow
->nw_tos
& IP_ECN_MASK
;
1353 value
->u8
= flow
->nw_ttl
;
1357 value
->u8
= flow
->nw_frag
;
1361 value
->be16
= htons(flow
->nw_proto
);
1365 value
->be32
= flow
->nw_src
;
1369 value
->be32
= flow
->nw_dst
;
1374 memcpy(value
->mac
, flow
->arp_sha
, ETH_ADDR_LEN
);
1379 memcpy(value
->mac
, flow
->arp_tha
, ETH_ADDR_LEN
);
1385 value
->be16
= flow
->tp_src
;
1391 value
->be16
= flow
->tp_dst
;
1395 value
->be16
= flow
->tcp_flags
;
1398 case MFF_ICMPV4_TYPE
:
1399 case MFF_ICMPV6_TYPE
:
1400 value
->u8
= ntohs(flow
->tp_src
);
1403 case MFF_ICMPV4_CODE
:
1404 case MFF_ICMPV6_CODE
:
1405 value
->u8
= ntohs(flow
->tp_dst
);
1409 value
->ipv6
= flow
->nd_target
;
1418 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1419 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1422 mf_set_value(const struct mf_field
*mf
,
1423 const union mf_value
*value
, struct match
*match
)
1427 match_set_tun_id(match
, value
->be64
);
1430 match_set_tun_src(match
, value
->be32
);
1433 match_set_tun_dst(match
, value
->be32
);
1436 match_set_tun_flags(match
, ntohs(value
->be16
));
1439 match_set_tun_tos(match
, value
->u8
);
1442 match_set_tun_ttl(match
, value
->u8
);
1446 match_set_metadata(match
, value
->be64
);
1450 match_set_in_port(match
, u16_to_ofp(ntohs(value
->be16
)));
1453 case MFF_IN_PORT_OXM
: {
1455 ofputil_port_from_ofp11(value
->be32
, &port
);
1456 match_set_in_port(match
, port
);
1460 case MFF_SKB_PRIORITY
:
1461 match_set_skb_priority(match
, ntohl(value
->be32
));
1465 match_set_pkt_mark(match
, ntohl(value
->be32
));
1469 match_set_reg(match
, mf
->id
- MFF_REG0
, ntohl(value
->be32
));
1473 match_set_dl_src(match
, value
->mac
);
1477 match_set_dl_dst(match
, value
->mac
);
1481 match_set_dl_type(match
, value
->be16
);
1485 match_set_dl_tci(match
, value
->be16
);
1489 match_set_dl_vlan(match
, value
->be16
);
1492 match_set_vlan_vid(match
, value
->be16
);
1495 case MFF_DL_VLAN_PCP
:
1497 match_set_dl_vlan_pcp(match
, value
->u8
);
1500 case MFF_MPLS_LABEL
:
1501 match_set_mpls_label(match
, value
->be32
);
1505 match_set_mpls_tc(match
, value
->u8
);
1509 match_set_mpls_bos(match
, value
->u8
);
1513 match_set_nw_src(match
, value
->be32
);
1517 match_set_nw_dst(match
, value
->be32
);
1521 match_set_ipv6_src(match
, &value
->ipv6
);
1525 match_set_ipv6_dst(match
, &value
->ipv6
);
1528 case MFF_IPV6_LABEL
:
1529 match_set_ipv6_label(match
, value
->be32
);
1533 match_set_nw_proto(match
, value
->u8
);
1537 match_set_nw_dscp(match
, value
->u8
);
1540 case MFF_IP_DSCP_SHIFTED
:
1541 match_set_nw_dscp(match
, value
->u8
<< 2);
1545 match_set_nw_ecn(match
, value
->u8
);
1549 match_set_nw_ttl(match
, value
->u8
);
1553 match_set_nw_frag(match
, value
->u8
);
1557 match_set_nw_proto(match
, ntohs(value
->be16
));
1561 match_set_nw_src(match
, value
->be32
);
1565 match_set_nw_dst(match
, value
->be32
);
1570 match_set_arp_sha(match
, value
->mac
);
1575 match_set_arp_tha(match
, value
->mac
);
1581 match_set_tp_src(match
, value
->be16
);
1587 match_set_tp_dst(match
, value
->be16
);
1591 match_set_tcp_flags(match
, value
->be16
);
1594 case MFF_ICMPV4_TYPE
:
1595 case MFF_ICMPV6_TYPE
:
1596 match_set_icmp_type(match
, value
->u8
);
1599 case MFF_ICMPV4_CODE
:
1600 case MFF_ICMPV6_CODE
:
1601 match_set_icmp_code(match
, value
->u8
);
1605 match_set_nd_target(match
, &value
->ipv6
);
1614 /* Unwildcard 'mask' member field described by 'mf'. The caller is
1615 * responsible for ensuring that 'mask' meets 'mf''s prerequisites. */
1617 mf_mask_field(const struct mf_field
*mf
, struct flow
*mask
)
1619 static const union mf_value exact_match_mask
= MF_EXACT_MASK_INITIALIZER
;
1621 /* For MFF_DL_VLAN, we cannot send a all 1's to flow_set_dl_vlan()
1622 * as that will be considered as OFP10_VLAN_NONE. So consider it as a
1623 * special case. For the rest, calling mf_set_flow_value() is good
1625 if (mf
->id
== MFF_DL_VLAN
) {
1626 flow_set_dl_vlan(mask
, htons(VLAN_VID_MASK
));
1628 mf_set_flow_value(mf
, &exact_match_mask
, mask
);
1632 /* Sets 'flow' member field described by 'mf' to 'value'. The caller is
1633 * responsible for ensuring that 'flow' meets 'mf''s prerequisites.*/
1635 mf_set_flow_value(const struct mf_field
*mf
,
1636 const union mf_value
*value
, struct flow
*flow
)
1640 flow
->tunnel
.tun_id
= value
->be64
;
1643 flow
->tunnel
.ip_src
= value
->be32
;
1646 flow
->tunnel
.ip_dst
= value
->be32
;
1649 flow
->tunnel
.flags
= ntohs(value
->be16
);
1652 flow
->tunnel
.ip_tos
= value
->u8
;
1655 flow
->tunnel
.ip_ttl
= value
->u8
;
1659 flow
->metadata
= value
->be64
;
1663 flow
->in_port
.ofp_port
= u16_to_ofp(ntohs(value
->be16
));
1666 case MFF_IN_PORT_OXM
: {
1668 ofputil_port_from_ofp11(value
->be32
, &port
);
1669 flow
->in_port
.ofp_port
= port
;
1673 case MFF_SKB_PRIORITY
:
1674 flow
->skb_priority
= ntohl(value
->be32
);
1678 flow
->pkt_mark
= ntohl(value
->be32
);
1682 flow
->regs
[mf
->id
- MFF_REG0
] = ntohl(value
->be32
);
1686 memcpy(flow
->dl_src
, value
->mac
, ETH_ADDR_LEN
);
1690 memcpy(flow
->dl_dst
, value
->mac
, ETH_ADDR_LEN
);
1694 flow
->dl_type
= value
->be16
;
1698 flow
->vlan_tci
= value
->be16
;
1702 flow_set_dl_vlan(flow
, value
->be16
);
1705 flow_set_vlan_vid(flow
, value
->be16
);
1708 case MFF_DL_VLAN_PCP
:
1710 flow_set_vlan_pcp(flow
, value
->u8
);
1713 case MFF_MPLS_LABEL
:
1714 flow_set_mpls_label(flow
, value
->be32
);
1718 flow_set_mpls_tc(flow
, value
->u8
);
1722 flow_set_mpls_bos(flow
, value
->u8
);
1726 flow
->nw_src
= value
->be32
;
1730 flow
->nw_dst
= value
->be32
;
1734 flow
->ipv6_src
= value
->ipv6
;
1738 flow
->ipv6_dst
= value
->ipv6
;
1741 case MFF_IPV6_LABEL
:
1742 flow
->ipv6_label
= value
->be32
& ~htonl(IPV6_LABEL_MASK
);
1746 flow
->nw_proto
= value
->u8
;
1750 flow
->nw_tos
&= ~IP_DSCP_MASK
;
1751 flow
->nw_tos
|= value
->u8
& IP_DSCP_MASK
;
1754 case MFF_IP_DSCP_SHIFTED
:
1755 flow
->nw_tos
&= ~IP_DSCP_MASK
;
1756 flow
->nw_tos
|= value
->u8
<< 2;
1760 flow
->nw_tos
&= ~IP_ECN_MASK
;
1761 flow
->nw_tos
|= value
->u8
& IP_ECN_MASK
;
1765 flow
->nw_ttl
= value
->u8
;
1769 flow
->nw_frag
&= value
->u8
;
1773 flow
->nw_proto
= ntohs(value
->be16
);
1777 flow
->nw_src
= value
->be32
;
1781 flow
->nw_dst
= value
->be32
;
1786 memcpy(flow
->arp_sha
, value
->mac
, ETH_ADDR_LEN
);
1791 memcpy(flow
->arp_tha
, value
->mac
, ETH_ADDR_LEN
);
1797 flow
->tp_src
= value
->be16
;
1803 flow
->tp_dst
= value
->be16
;
1807 flow
->tcp_flags
= value
->be16
;
1810 case MFF_ICMPV4_TYPE
:
1811 case MFF_ICMPV6_TYPE
:
1812 flow
->tp_src
= htons(value
->u8
);
1815 case MFF_ICMPV4_CODE
:
1816 case MFF_ICMPV6_CODE
:
1817 flow
->tp_dst
= htons(value
->u8
);
1821 flow
->nd_target
= value
->ipv6
;
1830 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1832 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1835 mf_is_zero(const struct mf_field
*mf
, const struct flow
*flow
)
1837 union mf_value value
;
1839 mf_get_value(mf
, flow
, &value
);
1840 return is_all_zeros((const uint8_t *) &value
, mf
->n_bytes
);
1843 /* Makes 'match' wildcard field 'mf'.
1845 * The caller is responsible for ensuring that 'match' meets 'mf''s
1848 mf_set_wild(const struct mf_field
*mf
, struct match
*match
)
1852 match_set_tun_id_masked(match
, htonll(0), htonll(0));
1855 match_set_tun_src_masked(match
, htonl(0), htonl(0));
1858 match_set_tun_dst_masked(match
, htonl(0), htonl(0));
1861 match_set_tun_flags_masked(match
, 0, 0);
1864 match_set_tun_tos_masked(match
, 0, 0);
1867 match_set_tun_ttl_masked(match
, 0, 0);
1871 match_set_metadata_masked(match
, htonll(0), htonll(0));
1875 case MFF_IN_PORT_OXM
:
1876 match
->flow
.in_port
.ofp_port
= 0;
1877 match
->wc
.masks
.in_port
.ofp_port
= 0;
1880 case MFF_SKB_PRIORITY
:
1881 match
->flow
.skb_priority
= 0;
1882 match
->wc
.masks
.skb_priority
= 0;
1886 match
->flow
.pkt_mark
= 0;
1887 match
->wc
.masks
.pkt_mark
= 0;
1891 match_set_reg_masked(match
, mf
->id
- MFF_REG0
, 0, 0);
1895 memset(match
->flow
.dl_src
, 0, ETH_ADDR_LEN
);
1896 memset(match
->wc
.masks
.dl_src
, 0, ETH_ADDR_LEN
);
1900 memset(match
->flow
.dl_dst
, 0, ETH_ADDR_LEN
);
1901 memset(match
->wc
.masks
.dl_dst
, 0, ETH_ADDR_LEN
);
1905 match
->flow
.dl_type
= htons(0);
1906 match
->wc
.masks
.dl_type
= htons(0);
1910 match_set_dl_tci_masked(match
, htons(0), htons(0));
1915 match_set_any_vid(match
);
1918 case MFF_DL_VLAN_PCP
:
1920 match_set_any_pcp(match
);
1923 case MFF_MPLS_LABEL
:
1924 match_set_any_mpls_label(match
);
1928 match_set_any_mpls_tc(match
);
1932 match_set_any_mpls_bos(match
);
1937 match_set_nw_src_masked(match
, htonl(0), htonl(0));
1942 match_set_nw_dst_masked(match
, htonl(0), htonl(0));
1946 memset(&match
->wc
.masks
.ipv6_src
, 0, sizeof match
->wc
.masks
.ipv6_src
);
1947 memset(&match
->flow
.ipv6_src
, 0, sizeof match
->flow
.ipv6_src
);
1951 memset(&match
->wc
.masks
.ipv6_dst
, 0, sizeof match
->wc
.masks
.ipv6_dst
);
1952 memset(&match
->flow
.ipv6_dst
, 0, sizeof match
->flow
.ipv6_dst
);
1955 case MFF_IPV6_LABEL
:
1956 match
->wc
.masks
.ipv6_label
= htonl(0);
1957 match
->flow
.ipv6_label
= htonl(0);
1961 match
->wc
.masks
.nw_proto
= 0;
1962 match
->flow
.nw_proto
= 0;
1966 case MFF_IP_DSCP_SHIFTED
:
1967 match
->wc
.masks
.nw_tos
&= ~IP_DSCP_MASK
;
1968 match
->flow
.nw_tos
&= ~IP_DSCP_MASK
;
1972 match
->wc
.masks
.nw_tos
&= ~IP_ECN_MASK
;
1973 match
->flow
.nw_tos
&= ~IP_ECN_MASK
;
1977 match
->wc
.masks
.nw_ttl
= 0;
1978 match
->flow
.nw_ttl
= 0;
1982 match
->wc
.masks
.nw_frag
|= FLOW_NW_FRAG_MASK
;
1983 match
->flow
.nw_frag
&= ~FLOW_NW_FRAG_MASK
;
1987 match
->wc
.masks
.nw_proto
= 0;
1988 match
->flow
.nw_proto
= 0;
1993 memset(match
->flow
.arp_sha
, 0, ETH_ADDR_LEN
);
1994 memset(match
->wc
.masks
.arp_sha
, 0, ETH_ADDR_LEN
);
1999 memset(match
->flow
.arp_tha
, 0, ETH_ADDR_LEN
);
2000 memset(match
->wc
.masks
.arp_tha
, 0, ETH_ADDR_LEN
);
2006 case MFF_ICMPV4_TYPE
:
2007 case MFF_ICMPV6_TYPE
:
2008 match
->wc
.masks
.tp_src
= htons(0);
2009 match
->flow
.tp_src
= htons(0);
2015 case MFF_ICMPV4_CODE
:
2016 case MFF_ICMPV6_CODE
:
2017 match
->wc
.masks
.tp_dst
= htons(0);
2018 match
->flow
.tp_dst
= htons(0);
2022 match
->wc
.masks
.tcp_flags
= htons(0);
2023 match
->flow
.tcp_flags
= htons(0);
2027 memset(&match
->wc
.masks
.nd_target
, 0,
2028 sizeof match
->wc
.masks
.nd_target
);
2029 memset(&match
->flow
.nd_target
, 0, sizeof match
->flow
.nd_target
);
2038 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
2039 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
2040 * with a 1-bit indicating that the corresponding value bit must match and a
2041 * 0-bit indicating a don't-care.
2043 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
2044 * mf_set_value(mf, value, match). If 'mask' points to all-0-bits, then this
2045 * call is equivalent to mf_set_wild(mf, match).
2047 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
2048 * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
2049 enum ofputil_protocol
2050 mf_set(const struct mf_field
*mf
,
2051 const union mf_value
*value
, const union mf_value
*mask
,
2052 struct match
*match
)
2054 if (!mask
|| is_all_ones((const uint8_t *) mask
, mf
->n_bytes
)) {
2055 mf_set_value(mf
, value
, match
);
2056 return mf
->usable_protocols
;
2057 } else if (is_all_zeros((const uint8_t *) mask
, mf
->n_bytes
)) {
2058 mf_set_wild(mf
, match
);
2059 return OFPUTIL_P_ANY
;
2064 case MFF_IN_PORT_OXM
:
2065 case MFF_SKB_PRIORITY
:
2068 case MFF_DL_VLAN_PCP
:
2070 case MFF_MPLS_LABEL
:
2076 case MFF_IP_DSCP_SHIFTED
:
2079 case MFF_ICMPV4_TYPE
:
2080 case MFF_ICMPV4_CODE
:
2081 case MFF_ICMPV6_TYPE
:
2082 case MFF_ICMPV6_CODE
:
2083 return OFPUTIL_P_NONE
;
2086 match_set_tun_id_masked(match
, value
->be64
, mask
->be64
);
2089 match_set_tun_src_masked(match
, value
->be32
, mask
->be32
);
2092 match_set_tun_dst_masked(match
, value
->be32
, mask
->be32
);
2095 match_set_tun_flags_masked(match
, ntohs(value
->be16
), ntohs(mask
->be16
));
2098 match_set_tun_ttl_masked(match
, value
->u8
, mask
->u8
);
2101 match_set_tun_tos_masked(match
, value
->u8
, mask
->u8
);
2105 match_set_metadata_masked(match
, value
->be64
, mask
->be64
);
2109 match_set_reg_masked(match
, mf
->id
- MFF_REG0
,
2110 ntohl(value
->be32
), ntohl(mask
->be32
));
2114 match_set_pkt_mark_masked(match
, ntohl(value
->be32
),
2119 match_set_dl_dst_masked(match
, value
->mac
, mask
->mac
);
2123 match_set_dl_src_masked(match
, value
->mac
, mask
->mac
);
2128 match_set_arp_sha_masked(match
, value
->mac
, mask
->mac
);
2133 match_set_arp_tha_masked(match
, value
->mac
, mask
->mac
);
2137 match_set_dl_tci_masked(match
, value
->be16
, mask
->be16
);
2141 match_set_vlan_vid_masked(match
, value
->be16
, mask
->be16
);
2145 match_set_nw_src_masked(match
, value
->be32
, mask
->be32
);
2149 match_set_nw_dst_masked(match
, value
->be32
, mask
->be32
);
2153 match_set_ipv6_src_masked(match
, &value
->ipv6
, &mask
->ipv6
);
2157 match_set_ipv6_dst_masked(match
, &value
->ipv6
, &mask
->ipv6
);
2160 case MFF_IPV6_LABEL
:
2161 if ((mask
->be32
& htonl(IPV6_LABEL_MASK
)) == htonl(IPV6_LABEL_MASK
)) {
2162 mf_set_value(mf
, value
, match
);
2164 match_set_ipv6_label_masked(match
, value
->be32
, mask
->be32
);
2169 match_set_nd_target_masked(match
, &value
->ipv6
, &mask
->ipv6
);
2173 match_set_nw_frag_masked(match
, value
->u8
, mask
->u8
);
2177 match_set_nw_src_masked(match
, value
->be32
, mask
->be32
);
2181 match_set_nw_dst_masked(match
, value
->be32
, mask
->be32
);
2187 match_set_tp_src_masked(match
, value
->be16
, mask
->be16
);
2193 match_set_tp_dst_masked(match
, value
->be16
, mask
->be16
);
2197 match_set_tcp_flags_masked(match
, value
->be16
, mask
->be16
);
2205 return mf
->usable_protocols_bitwise
;
2208 return ip_is_cidr(mask
->be32
) ? mf
->usable_protocols
:
2209 mf
->usable_protocols_bitwise
;
2213 mf_check__(const struct mf_subfield
*sf
, const struct flow
*flow
,
2217 VLOG_WARN_RL(&rl
, "unknown %s field", type
);
2218 return OFPERR_OFPBAC_BAD_SET_TYPE
;
2219 } else if (!sf
->n_bits
) {
2220 VLOG_WARN_RL(&rl
, "zero bit %s field %s", type
, sf
->field
->name
);
2221 return OFPERR_OFPBAC_BAD_SET_LEN
;
2222 } else if (sf
->ofs
>= sf
->field
->n_bits
) {
2223 VLOG_WARN_RL(&rl
, "bit offset %d exceeds %d-bit width of %s field %s",
2224 sf
->ofs
, sf
->field
->n_bits
, type
, sf
->field
->name
);
2225 return OFPERR_OFPBAC_BAD_SET_LEN
;
2226 } else if (sf
->ofs
+ sf
->n_bits
> sf
->field
->n_bits
) {
2227 VLOG_WARN_RL(&rl
, "bit offset %d and width %d exceeds %d-bit width "
2228 "of %s field %s", sf
->ofs
, sf
->n_bits
,
2229 sf
->field
->n_bits
, type
, sf
->field
->name
);
2230 return OFPERR_OFPBAC_BAD_SET_LEN
;
2231 } else if (flow
&& !mf_are_prereqs_ok(sf
->field
, flow
)) {
2232 VLOG_WARN_RL(&rl
, "%s field %s lacks correct prerequisites",
2233 type
, sf
->field
->name
);
2234 return OFPERR_OFPBAC_MATCH_INCONSISTENT
;
2240 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
2241 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
2244 mf_check_src(const struct mf_subfield
*sf
, const struct flow
*flow
)
2246 return mf_check__(sf
, flow
, "source");
2249 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
2250 * if so, otherwise an OpenFlow error code (e.g. as returned by
2253 mf_check_dst(const struct mf_subfield
*sf
, const struct flow
*flow
)
2255 int error
= mf_check__(sf
, flow
, "destination");
2256 if (!error
&& !sf
->field
->writable
) {
2257 VLOG_WARN_RL(&rl
, "destination field %s is not writable",
2259 return OFPERR_OFPBAC_BAD_SET_ARGUMENT
;
2264 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
2265 * 'value' and 'mask', respectively. */
2267 mf_get(const struct mf_field
*mf
, const struct match
*match
,
2268 union mf_value
*value
, union mf_value
*mask
)
2270 mf_get_value(mf
, &match
->flow
, value
);
2271 mf_get_mask(mf
, &match
->wc
, mask
);
2275 mf_from_integer_string(const struct mf_field
*mf
, const char *s
,
2276 uint8_t *valuep
, uint8_t *maskp
)
2278 unsigned long long int integer
, mask
;
2283 integer
= strtoull(s
, &tail
, 0);
2284 if (errno
|| (*tail
!= '\0' && *tail
!= '/')) {
2289 mask
= strtoull(tail
+ 1, &tail
, 0);
2290 if (errno
|| *tail
!= '\0') {
2297 for (i
= mf
->n_bytes
- 1; i
>= 0; i
--) {
2298 valuep
[i
] = integer
;
2304 return xasprintf("%s: value too large for %u-byte field %s",
2305 s
, mf
->n_bytes
, mf
->name
);
2310 return xasprintf("%s: bad syntax for %s", s
, mf
->name
);
2314 mf_from_ethernet_string(const struct mf_field
*mf
, const char *s
,
2315 uint8_t mac
[ETH_ADDR_LEN
],
2316 uint8_t mask
[ETH_ADDR_LEN
])
2320 ovs_assert(mf
->n_bytes
== ETH_ADDR_LEN
);
2323 if (ovs_scan(s
, ETH_ADDR_SCAN_FMT
"%n", ETH_ADDR_SCAN_ARGS(mac
), &n
)
2324 && n
== strlen(s
)) {
2325 memset(mask
, 0xff, ETH_ADDR_LEN
);
2330 if (ovs_scan(s
, ETH_ADDR_SCAN_FMT
"/"ETH_ADDR_SCAN_FMT
"%n",
2331 ETH_ADDR_SCAN_ARGS(mac
), ETH_ADDR_SCAN_ARGS(mask
), &n
)
2332 && n
== strlen(s
)) {
2336 return xasprintf("%s: invalid Ethernet address", s
);
2340 mf_from_ipv4_string(const struct mf_field
*mf
, const char *s
,
2341 ovs_be32
*ip
, ovs_be32
*mask
)
2345 ovs_assert(mf
->n_bytes
== sizeof *ip
);
2347 if (ovs_scan(s
, IP_SCAN_FMT
"/"IP_SCAN_FMT
,
2348 IP_SCAN_ARGS(ip
), IP_SCAN_ARGS(mask
))) {
2350 } else if (ovs_scan(s
, IP_SCAN_FMT
"/%d", IP_SCAN_ARGS(ip
), &prefix
)) {
2351 if (prefix
<= 0 || prefix
> 32) {
2352 return xasprintf("%s: network prefix bits not between 1 and "
2354 } else if (prefix
== 32) {
2355 *mask
= OVS_BE32_MAX
;
2357 *mask
= htonl(((1u << prefix
) - 1) << (32 - prefix
));
2359 } else if (ovs_scan(s
, IP_SCAN_FMT
, IP_SCAN_ARGS(ip
))) {
2360 *mask
= OVS_BE32_MAX
;
2362 return xasprintf("%s: invalid IP address", s
);
2368 mf_from_ipv6_string(const struct mf_field
*mf
, const char *s
,
2369 struct in6_addr
*value
, struct in6_addr
*mask
)
2371 char *str
= xstrdup(s
);
2372 char *save_ptr
= NULL
;
2373 const char *name
, *netmask
;
2376 ovs_assert(mf
->n_bytes
== sizeof *value
);
2378 name
= strtok_r(str
, "/", &save_ptr
);
2379 retval
= name
? lookup_ipv6(name
, value
) : EINVAL
;
2383 err
= xasprintf("%s: could not convert to IPv6 address", str
);
2389 netmask
= strtok_r(NULL
, "/", &save_ptr
);
2391 if (inet_pton(AF_INET6
, netmask
, mask
) != 1) {
2392 int prefix
= atoi(netmask
);
2393 if (prefix
<= 0 || prefix
> 128) {
2395 return xasprintf("%s: prefix bits not between 1 and 128", s
);
2397 *mask
= ipv6_create_mask(prefix
);
2401 *mask
= in6addr_exact
;
2409 mf_from_ofp_port_string(const struct mf_field
*mf
, const char *s
,
2410 ovs_be16
*valuep
, ovs_be16
*maskp
)
2414 ovs_assert(mf
->n_bytes
== sizeof(ovs_be16
));
2416 if (ofputil_port_from_string(s
, &port
)) {
2417 *valuep
= htons(ofp_to_u16(port
));
2418 *maskp
= OVS_BE16_MAX
;
2421 return xasprintf("%s: port value out of range for %s", s
, mf
->name
);
2425 mf_from_ofp_port_string32(const struct mf_field
*mf
, const char *s
,
2426 ovs_be32
*valuep
, ovs_be32
*maskp
)
2430 ovs_assert(mf
->n_bytes
== sizeof(ovs_be32
));
2431 if (ofputil_port_from_string(s
, &port
)) {
2432 *valuep
= ofputil_port_to_ofp11(port
);
2433 *maskp
= OVS_BE32_MAX
;
2436 return xasprintf("%s: port value out of range for %s", s
, mf
->name
);
2439 struct frag_handling
{
2445 static const struct frag_handling all_frags
[] = {
2446 #define A FLOW_NW_FRAG_ANY
2447 #define L FLOW_NW_FRAG_LATER
2448 /* name mask value */
2451 { "first", A
|L
, A
},
2452 { "later", A
|L
, A
|L
},
2457 { "not_later", L
, 0 },
2464 mf_from_frag_string(const char *s
, uint8_t *valuep
, uint8_t *maskp
)
2466 const struct frag_handling
*h
;
2468 for (h
= all_frags
; h
< &all_frags
[ARRAY_SIZE(all_frags
)]; h
++) {
2469 if (!strcasecmp(s
, h
->name
)) {
2470 /* We force the upper bits of the mask on to make mf_parse_value()
2471 * happy (otherwise it will never think it's an exact match.) */
2472 *maskp
= h
->mask
| ~FLOW_NW_FRAG_MASK
;
2478 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2479 "\"yes\", \"first\", \"later\", \"not_first\"", s
);
2483 parse_flow_tun_flags(const char *s_
, const char *(*bit_to_string
)(uint32_t),
2486 uint32_t result
= 0;
2487 char *save_ptr
= NULL
;
2490 char *s
= xstrdup(s_
);
2492 for (name
= strtok_r((char *)s
, " |", &save_ptr
); name
;
2493 name
= strtok_r(NULL
, " |", &save_ptr
)) {
2495 unsigned long long int flags
;
2498 if (ovs_scan(name
, "%lli", &flags
)) {
2502 name_len
= strlen(name
);
2503 for (bit
= 1; bit
; bit
<<= 1) {
2504 const char *fname
= bit_to_string(bit
);
2511 len
= strlen(fname
);
2512 if (len
!= name_len
) {
2515 if (!strncmp(name
, fname
, len
)) {
2527 *res
= htons(result
);
2534 mf_from_tun_flags_string(const char *s
, ovs_be16
*valuep
, ovs_be16
*maskp
)
2536 if (!parse_flow_tun_flags(s
, flow_tun_flag_to_string
, valuep
)) {
2537 *maskp
= OVS_BE16_MAX
;
2541 return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
2542 "\"csum\", \"key\")", s
);
2546 mf_from_tcp_flags_string(const char *s
, ovs_be16
*flagsp
, ovs_be16
*maskp
)
2553 if (ovs_scan(s
, "%"SCNi16
"/%"SCNi16
"%n", &flags
, &mask
, &n
) && !s
[n
]) {
2554 *flagsp
= htons(flags
);
2555 *maskp
= htons(mask
);
2558 if (ovs_scan(s
, "%"SCNi16
"%n", &flags
, &n
) && !s
[n
]) {
2559 *flagsp
= htons(flags
);
2560 *maskp
= OVS_BE16_MAX
;
2564 while (*s
!= '\0') {
2576 return xasprintf("%s: TCP flag must be preceded by '+' (for SET) "
2577 "or '-' (NOT SET)", s
);
2581 name_len
= strcspn(s
,"+-");
2583 for (bit
= 1; bit
; bit
<<= 1) {
2584 const char *fname
= packet_tcp_flag_to_string(bit
);
2591 len
= strlen(fname
);
2592 if (len
!= name_len
) {
2595 if (!strncmp(s
, fname
, len
)) {
2597 return xasprintf("%s: Each TCP flag can be specified only "
2609 return xasprintf("%s: unknown TCP flag(s)", s
);
2614 *flagsp
= htons(flags
);
2615 *maskp
= htons(mask
);
2620 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2621 * NULL if successful, otherwise a malloc()'d string describing the error. */
2623 mf_parse(const struct mf_field
*mf
, const char *s
,
2624 union mf_value
*value
, union mf_value
*mask
)
2628 if (!strcmp(s
, "*")) {
2629 memset(value
, 0, mf
->n_bytes
);
2630 memset(mask
, 0, mf
->n_bytes
);
2634 switch (mf
->string
) {
2636 case MFS_HEXADECIMAL
:
2637 error
= mf_from_integer_string(mf
, s
,
2638 (uint8_t *) value
, (uint8_t *) mask
);
2642 error
= mf_from_ethernet_string(mf
, s
, value
->mac
, mask
->mac
);
2646 error
= mf_from_ipv4_string(mf
, s
, &value
->be32
, &mask
->be32
);
2650 error
= mf_from_ipv6_string(mf
, s
, &value
->ipv6
, &mask
->ipv6
);
2654 error
= mf_from_ofp_port_string(mf
, s
, &value
->be16
, &mask
->be16
);
2657 case MFS_OFP_PORT_OXM
:
2658 error
= mf_from_ofp_port_string32(mf
, s
, &value
->be32
, &mask
->be32
);
2662 error
= mf_from_frag_string(s
, &value
->u8
, &mask
->u8
);
2666 ovs_assert(mf
->n_bytes
== sizeof(ovs_be16
));
2667 error
= mf_from_tun_flags_string(s
, &value
->be16
, &mask
->be16
);
2671 ovs_assert(mf
->n_bytes
== sizeof(ovs_be16
));
2672 error
= mf_from_tcp_flags_string(s
, &value
->be16
, &mask
->be16
);
2679 if (!error
&& !mf_is_mask_valid(mf
, mask
)) {
2680 error
= xasprintf("%s: invalid mask for field %s", s
, mf
->name
);
2685 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2686 * successful, otherwise a malloc()'d string describing the error. */
2688 mf_parse_value(const struct mf_field
*mf
, const char *s
, union mf_value
*value
)
2690 union mf_value mask
;
2693 error
= mf_parse(mf
, s
, value
, &mask
);
2698 if (!is_all_ones((const uint8_t *) &mask
, mf
->n_bytes
)) {
2699 return xasprintf("%s: wildcards not allowed here", s
);
2705 mf_format_integer_string(const struct mf_field
*mf
, const uint8_t *valuep
,
2706 const uint8_t *maskp
, struct ds
*s
)
2708 unsigned long long int integer
;
2711 ovs_assert(mf
->n_bytes
<= 8);
2714 for (i
= 0; i
< mf
->n_bytes
; i
++) {
2715 integer
= (integer
<< 8) | valuep
[i
];
2717 if (mf
->string
== MFS_HEXADECIMAL
) {
2718 ds_put_format(s
, "%#llx", integer
);
2720 ds_put_format(s
, "%lld", integer
);
2724 unsigned long long int mask
;
2727 for (i
= 0; i
< mf
->n_bytes
; i
++) {
2728 mask
= (mask
<< 8) | maskp
[i
];
2731 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2732 * not sure that that a bit-mask written in decimal is ever easier to
2733 * understand than the same bit-mask written in hexadecimal. */
2734 ds_put_format(s
, "/%#llx", mask
);
2739 mf_format_frag_string(uint8_t value
, uint8_t mask
, struct ds
*s
)
2741 const struct frag_handling
*h
;
2743 mask
&= FLOW_NW_FRAG_MASK
;
2746 for (h
= all_frags
; h
< &all_frags
[ARRAY_SIZE(all_frags
)]; h
++) {
2747 if (value
== h
->value
&& mask
== h
->mask
) {
2748 ds_put_cstr(s
, h
->name
);
2752 ds_put_cstr(s
, "<error>");
2756 mf_format_tnl_flags_string(const ovs_be16
*valuep
, struct ds
*s
)
2758 format_flags(s
, flow_tun_flag_to_string
, ntohs(*valuep
), '|');
2762 mf_format_tcp_flags_string(ovs_be16 value
, ovs_be16 mask
, struct ds
*s
)
2764 format_flags_masked(s
, NULL
, packet_tcp_flag_to_string
, ntohs(value
),
2768 /* Appends to 's' a string representation of field 'mf' whose value is in
2769 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2771 mf_format(const struct mf_field
*mf
,
2772 const union mf_value
*value
, const union mf_value
*mask
,
2776 if (is_all_zeros((const uint8_t *) mask
, mf
->n_bytes
)) {
2777 ds_put_cstr(s
, "ANY");
2779 } else if (is_all_ones((const uint8_t *) mask
, mf
->n_bytes
)) {
2784 switch (mf
->string
) {
2785 case MFS_OFP_PORT_OXM
:
2788 ofputil_port_from_ofp11(value
->be32
, &port
);
2789 ofputil_format_port(port
, s
);
2795 ofputil_format_port(u16_to_ofp(ntohs(value
->be16
)), s
);
2800 case MFS_HEXADECIMAL
:
2801 mf_format_integer_string(mf
, (uint8_t *) value
, (uint8_t *) mask
, s
);
2805 eth_format_masked(value
->mac
, mask
->mac
, s
);
2809 ip_format_masked(value
->be32
, mask
? mask
->be32
: OVS_BE32_MAX
, s
);
2813 print_ipv6_masked(s
, &value
->ipv6
, mask
? &mask
->ipv6
: NULL
);
2817 mf_format_frag_string(value
->u8
, mask
? mask
->u8
: UINT8_MAX
, s
);
2821 mf_format_tnl_flags_string(&value
->be16
, s
);
2825 mf_format_tcp_flags_string(value
->be16
,
2826 mask
? mask
->be16
: OVS_BE16_MAX
, s
);
2834 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2835 * least-significant bits in 'x'.
2838 mf_write_subfield_flow(const struct mf_subfield
*sf
,
2839 const union mf_subvalue
*x
, struct flow
*flow
)
2841 const struct mf_field
*field
= sf
->field
;
2842 union mf_value value
;
2844 mf_get_value(field
, flow
, &value
);
2845 bitwise_copy(x
, sizeof *x
, 0, &value
, field
->n_bytes
,
2846 sf
->ofs
, sf
->n_bits
);
2847 mf_set_flow_value(field
, &value
, flow
);
2850 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2851 * least-significant bits in 'x'.
2854 mf_write_subfield(const struct mf_subfield
*sf
, const union mf_subvalue
*x
,
2855 struct match
*match
)
2857 const struct mf_field
*field
= sf
->field
;
2858 union mf_value value
, mask
;
2860 mf_get(field
, match
, &value
, &mask
);
2861 bitwise_copy(x
, sizeof *x
, 0, &value
, field
->n_bytes
, sf
->ofs
, sf
->n_bits
);
2862 bitwise_one ( &mask
, field
->n_bytes
, sf
->ofs
, sf
->n_bits
);
2863 mf_set(field
, &value
, &mask
, match
);
2866 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2867 * reading 'flow', e.g. as checked by mf_check_src(). */
2869 mf_read_subfield(const struct mf_subfield
*sf
, const struct flow
*flow
,
2870 union mf_subvalue
*x
)
2872 union mf_value value
;
2874 mf_get_value(sf
->field
, flow
, &value
);
2876 memset(x
, 0, sizeof *x
);
2877 bitwise_copy(&value
, sf
->field
->n_bytes
, sf
->ofs
,
2882 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2883 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2886 mf_get_subfield(const struct mf_subfield
*sf
, const struct flow
*flow
)
2888 union mf_value value
;
2890 mf_get_value(sf
->field
, flow
, &value
);
2891 return bitwise_get(&value
, sf
->field
->n_bytes
, sf
->ofs
, sf
->n_bits
);
2894 /* Formats 'sf' into 's' in a format normally acceptable to
2895 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2896 * sf->field has no NXM name.) */
2898 mf_format_subfield(const struct mf_subfield
*sf
, struct ds
*s
)
2901 ds_put_cstr(s
, "<unknown>");
2902 } else if (sf
->field
->nxm_name
) {
2903 ds_put_cstr(s
, sf
->field
->nxm_name
);
2904 } else if (sf
->field
->nxm_header
) {
2905 uint32_t header
= sf
->field
->nxm_header
;
2906 ds_put_format(s
, "%d:%d", NXM_VENDOR(header
), NXM_FIELD(header
));
2908 ds_put_cstr(s
, sf
->field
->name
);
2911 if (sf
->field
&& sf
->ofs
== 0 && sf
->n_bits
== sf
->field
->n_bits
) {
2912 ds_put_cstr(s
, "[]");
2913 } else if (sf
->n_bits
== 1) {
2914 ds_put_format(s
, "[%d]", sf
->ofs
);
2916 ds_put_format(s
, "[%d..%d]", sf
->ofs
, sf
->ofs
+ sf
->n_bits
- 1);
2920 static const struct mf_field
*
2921 mf_parse_subfield_name(const char *name
, int name_len
, bool *wild
)
2925 *wild
= name_len
> 2 && !memcmp(&name
[name_len
- 2], "_W", 2);
2930 for (i
= 0; i
< MFF_N_IDS
; i
++) {
2931 const struct mf_field
*mf
= mf_from_id(i
);
2934 && !strncmp(mf
->nxm_name
, name
, name_len
)
2935 && mf
->nxm_name
[name_len
] == '\0') {
2939 && !strncmp(mf
->oxm_name
, name
, name_len
)
2940 && mf
->oxm_name
[name_len
] == '\0') {
2948 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2949 * returns NULL and advances '*sp' to the first byte following the parsed
2950 * string. On failure, returns a malloc()'d error message, does not modify
2951 * '*sp', and does not properly initialize 'sf'.
2953 * The syntax parsed from '*sp' takes the form "header[start..end]" where
2954 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2955 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2956 * may both be omitted (the [] are still required) to indicate an entire
2958 char * WARN_UNUSED_RESULT
2959 mf_parse_subfield__(struct mf_subfield
*sf
, const char **sp
)
2961 const struct mf_field
*field
;
2970 name_len
= strcspn(s
, "[");
2971 if (s
[name_len
] != '[') {
2972 return xasprintf("%s: missing [ looking for field name", *sp
);
2975 field
= mf_parse_subfield_name(name
, name_len
, &wild
);
2977 return xasprintf("%s: unknown field `%.*s'", *sp
, name_len
, s
);
2981 if (ovs_scan(s
, "[%d..%d]", &start
, &end
)) {
2982 /* Nothing to do. */
2983 } else if (ovs_scan(s
, "[%d]", &start
)) {
2985 } else if (!strncmp(s
, "[]", 2)) {
2987 end
= field
->n_bits
- 1;
2989 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2990 "[<start>..<end>]", *sp
);
2992 s
= strchr(s
, ']') + 1;
2995 return xasprintf("%s: starting bit %d is after ending bit %d",
2997 } else if (start
>= field
->n_bits
) {
2998 return xasprintf("%s: starting bit %d is not valid because field is "
2999 "only %d bits wide", *sp
, start
, field
->n_bits
);
3000 } else if (end
>= field
->n_bits
){
3001 return xasprintf("%s: ending bit %d is not valid because field is "
3002 "only %d bits wide", *sp
, end
, field
->n_bits
);
3007 sf
->n_bits
= end
- start
+ 1;
3013 /* Parses a subfield from the entirety of 's' into 'sf'. Returns NULL if
3014 * successful, otherwise a malloc()'d string describing the error. The caller
3015 * is responsible for freeing the returned string.
3017 * The syntax parsed from 's' takes the form "header[start..end]" where
3018 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
3019 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
3020 * may both be omitted (the [] are still required) to indicate an entire
3022 char * WARN_UNUSED_RESULT
3023 mf_parse_subfield(struct mf_subfield
*sf
, const char *s
)
3025 char *error
= mf_parse_subfield__(sf
, &s
);
3026 if (!error
&& s
[0]) {
3027 error
= xstrdup("unexpected input following field syntax");
3033 mf_format_subvalue(const union mf_subvalue
*subvalue
, struct ds
*s
)
3037 for (i
= 0; i
< ARRAY_SIZE(subvalue
->u8
); i
++) {
3038 if (subvalue
->u8
[i
]) {
3039 ds_put_format(s
, "0x%"PRIx8
, subvalue
->u8
[i
]);
3040 for (i
++; i
< ARRAY_SIZE(subvalue
->u8
); i
++) {
3041 ds_put_format(s
, "%02"PRIx8
, subvalue
->u8
[i
]);
3046 ds_put_char(s
, '0');