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, \
236 #error "Need to update mf_fields[] to match FLOW_N_REGS"
244 MFF_ETH_SRC
, "eth_src", "dl_src",
250 NXM_OF_ETH_SRC
, "NXM_OF_ETH_SRC",
251 OXM_OF_ETH_SRC
, "OXM_OF_ETH_SRC", OFP12_VERSION
,
253 OFPUTIL_P_NXM_OF11_UP
, /* Bitwise masking only with NXM and OF11+! */
256 MFF_ETH_DST
, "eth_dst", "dl_dst",
262 NXM_OF_ETH_DST
, "NXM_OF_ETH_DST",
263 OXM_OF_ETH_DST
, "OXM_OF_ETH_DST", OFP12_VERSION
,
265 OFPUTIL_P_NXM_OF11_UP
, /* Bitwise masking only with NXM and OF11+! */
268 MFF_ETH_TYPE
, "eth_type", "dl_type",
269 MF_FIELD_SIZES(be16
),
274 NXM_OF_ETH_TYPE
, "NXM_OF_ETH_TYPE",
275 OXM_OF_ETH_TYPE
, "OXM_OF_ETH_TYPE", OFP12_VERSION
,
282 MFF_VLAN_TCI
, "vlan_tci", NULL
,
283 MF_FIELD_SIZES(be16
),
288 NXM_OF_VLAN_TCI
, "NXM_OF_VLAN_TCI",
289 NXM_OF_VLAN_TCI
, "NXM_OF_VLAN_TCI", 0,
291 OFPUTIL_P_NXM_OXM_ANY
,
294 MFF_DL_VLAN
, "dl_vlan", NULL
,
295 sizeof(ovs_be16
), 12,
303 OFPUTIL_P_NXM_OXM_ANY
,
306 MFF_VLAN_VID
, "vlan_vid", NULL
,
307 sizeof(ovs_be16
), 12,
312 OXM_OF_VLAN_VID
, "OXM_OF_VLAN_VID",
313 OXM_OF_VLAN_VID
, "OXM_OF_VLAN_VID", OFP12_VERSION
,
315 OFPUTIL_P_NXM_OXM_ANY
,
318 MFF_DL_VLAN_PCP
, "dl_vlan_pcp", NULL
,
326 OFPUTIL_P_ANY
, /* Will be mapped to NXM and OXM. */
330 MFF_VLAN_PCP
, "vlan_pcp", NULL
,
336 OXM_OF_VLAN_PCP
, "OXM_OF_VLAN_PCP",
337 OXM_OF_VLAN_PCP
, "OXM_OF_VLAN_PCP", OFP12_VERSION
,
338 OFPUTIL_P_ANY
, /* Will be mapped to OF10 and NXM. */
347 MFF_MPLS_LABEL
, "mpls_label", NULL
,
353 OXM_OF_MPLS_LABEL
, "OXM_OF_MPLS_LABEL",
354 OXM_OF_MPLS_LABEL
, "OXM_OF_MPLS_LABEL", OFP12_VERSION
,
355 OFPUTIL_P_NXM_OF11_UP
,
359 MFF_MPLS_TC
, "mpls_tc", NULL
,
365 OXM_OF_MPLS_TC
, "OXM_OF_MPLS_TC",
366 OXM_OF_MPLS_TC
, "OXM_OF_MPLS_TC", OFP12_VERSION
,
367 OFPUTIL_P_NXM_OF11_UP
,
371 MFF_MPLS_BOS
, "mpls_bos", NULL
,
377 OXM_OF_MPLS_BOS
, "OXM_OF_MPLS_BOS",
378 OXM_OF_MPLS_BOS
, "OXM_OF_MPLS_BOS", OFP13_VERSION
,
379 OFPUTIL_P_NXM_OXM_ANY
,
389 MFF_IPV4_SRC
, "ip_src", "nw_src",
390 MF_FIELD_SIZES(be32
),
395 NXM_OF_IP_SRC
, "NXM_OF_IP_SRC",
396 OXM_OF_IPV4_SRC
, "OXM_OF_IPV4_SRC", OFP12_VERSION
,
398 OFPUTIL_P_NXM_OF11_UP
,
401 MFF_IPV4_DST
, "ip_dst", "nw_dst",
402 MF_FIELD_SIZES(be32
),
407 NXM_OF_IP_DST
, "NXM_OF_IP_DST",
408 OXM_OF_IPV4_DST
, "OXM_OF_IPV4_DST", OFP12_VERSION
,
410 OFPUTIL_P_NXM_OF11_UP
,
415 MFF_IPV6_SRC
, "ipv6_src", NULL
,
416 MF_FIELD_SIZES(ipv6
),
421 NXM_NX_IPV6_SRC
, "NXM_NX_IPV6_SRC",
422 OXM_OF_IPV6_SRC
, "OXM_OF_IPV6_SRC", OFP12_VERSION
,
423 OFPUTIL_P_NXM_OXM_ANY
,
424 OFPUTIL_P_NXM_OXM_ANY
,
425 FLOW_U32OFS(ipv6_src
),
427 MFF_IPV6_DST
, "ipv6_dst", NULL
,
428 MF_FIELD_SIZES(ipv6
),
433 NXM_NX_IPV6_DST
, "NXM_NX_IPV6_DST",
434 OXM_OF_IPV6_DST
, "OXM_OF_IPV6_DST", OFP12_VERSION
,
435 OFPUTIL_P_NXM_OXM_ANY
,
436 OFPUTIL_P_NXM_OXM_ANY
,
437 FLOW_U32OFS(ipv6_dst
),
440 MFF_IPV6_LABEL
, "ipv6_label", NULL
,
446 NXM_NX_IPV6_LABEL
, "NXM_NX_IPV6_LABEL",
447 OXM_OF_IPV6_FLABEL
, "OXM_OF_IPV6_FLABEL", OFP12_VERSION
,
448 OFPUTIL_P_NXM_OXM_ANY
,
449 OFPUTIL_P_NXM_OXM_ANY
,
454 MFF_IP_PROTO
, "nw_proto", "ip_proto",
460 NXM_OF_IP_PROTO
, "NXM_OF_IP_PROTO",
461 OXM_OF_IP_PROTO
, "OXM_OF_IP_PROTO", OFP12_VERSION
,
466 MFF_IP_DSCP
, "nw_tos", NULL
,
472 NXM_OF_IP_TOS
, "NXM_OF_IP_TOS",
473 NXM_OF_IP_TOS
, "NXM_OF_IP_TOS", 0,
474 OFPUTIL_P_ANY
, /* Will be shifted for OXM. */
478 MFF_IP_DSCP_SHIFTED
, "ip_dscp", NULL
,
484 OXM_OF_IP_DSCP
, "OXM_OF_IP_DSCP",
485 OXM_OF_IP_DSCP
, "OXM_OF_IP_DSCP", OFP12_VERSION
,
486 OFPUTIL_P_ANY
, /* Will be shifted for non-OXM. */
490 MFF_IP_ECN
, "nw_ecn", "ip_ecn",
496 NXM_NX_IP_ECN
, "NXM_NX_IP_ECN",
497 OXM_OF_IP_ECN
, "OXM_OF_IP_ECN", OFP12_VERSION
,
498 OFPUTIL_P_NXM_OXM_ANY
,
502 MFF_IP_TTL
, "nw_ttl", NULL
,
508 NXM_NX_IP_TTL
, "NXM_NX_IP_TTL",
509 NXM_NX_IP_TTL
, "NXM_NX_IP_TTL", 0,
510 OFPUTIL_P_NXM_OXM_ANY
,
514 MFF_IP_FRAG
, "ip_frag", NULL
,
520 NXM_NX_IP_FRAG
, "NXM_NX_IP_FRAG",
521 NXM_NX_IP_FRAG
, "NXM_NX_IP_FRAG", 0,
522 OFPUTIL_P_NXM_OXM_ANY
,
523 OFPUTIL_P_NXM_OXM_ANY
,
528 MFF_ARP_OP
, "arp_op", NULL
,
529 MF_FIELD_SIZES(be16
),
534 NXM_OF_ARP_OP
, "NXM_OF_ARP_OP",
535 OXM_OF_ARP_OP
, "OXM_OF_ARP_OP", OFP12_VERSION
,
540 MFF_ARP_SPA
, "arp_spa", NULL
,
541 MF_FIELD_SIZES(be32
),
546 NXM_OF_ARP_SPA
, "NXM_OF_ARP_SPA",
547 OXM_OF_ARP_SPA
, "OXM_OF_ARP_SPA", OFP12_VERSION
,
549 OFPUTIL_P_NXM_OF11_UP
,
552 MFF_ARP_TPA
, "arp_tpa", NULL
,
553 MF_FIELD_SIZES(be32
),
558 NXM_OF_ARP_TPA
, "NXM_OF_ARP_TPA",
559 OXM_OF_ARP_TPA
, "OXM_OF_ARP_TPA", OFP12_VERSION
,
561 OFPUTIL_P_NXM_OF11_UP
,
564 MFF_ARP_SHA
, "arp_sha", NULL
,
570 NXM_NX_ARP_SHA
, "NXM_NX_ARP_SHA",
571 OXM_OF_ARP_SHA
, "OXM_OF_ARP_SHA", OFP12_VERSION
,
572 OFPUTIL_P_NXM_OXM_ANY
,
573 OFPUTIL_P_NXM_OXM_ANY
,
576 MFF_ARP_THA
, "arp_tha", NULL
,
582 NXM_NX_ARP_THA
, "NXM_NX_ARP_THA",
583 OXM_OF_ARP_THA
, "OXM_OF_ARP_THA", OFP12_VERSION
,
584 OFPUTIL_P_NXM_OXM_ANY
,
585 OFPUTIL_P_NXM_OXM_ANY
,
594 MFF_TCP_SRC
, "tcp_src", "tp_src",
595 MF_FIELD_SIZES(be16
),
600 NXM_OF_TCP_SRC
, "NXM_OF_TCP_SRC",
601 OXM_OF_TCP_SRC
, "OXM_OF_TCP_SRC", OFP12_VERSION
,
603 OFPUTIL_P_NXM_OXM_ANY
,
606 MFF_TCP_DST
, "tcp_dst", "tp_dst",
607 MF_FIELD_SIZES(be16
),
612 NXM_OF_TCP_DST
, "NXM_OF_TCP_DST",
613 OXM_OF_TCP_DST
, "OXM_OF_TCP_DST", OFP12_VERSION
,
615 OFPUTIL_P_NXM_OXM_ANY
,
618 MFF_TCP_FLAGS
, "tcp_flags", NULL
,
624 NXM_NX_TCP_FLAGS
, "NXM_NX_TCP_FLAGS",
625 OXM_OF_TCP_FLAGS
, "OXM_OF_TCP_FLAGS", OFP15_VERSION
,
626 OFPUTIL_P_NXM_OXM_ANY
,
627 OFPUTIL_P_NXM_OXM_ANY
,
632 MFF_UDP_SRC
, "udp_src", NULL
,
633 MF_FIELD_SIZES(be16
),
638 NXM_OF_UDP_SRC
, "NXM_OF_UDP_SRC",
639 OXM_OF_UDP_SRC
, "OXM_OF_UDP_SRC", OFP12_VERSION
,
641 OFPUTIL_P_NXM_OXM_ANY
,
644 MFF_UDP_DST
, "udp_dst", NULL
,
645 MF_FIELD_SIZES(be16
),
650 NXM_OF_UDP_DST
, "NXM_OF_UDP_DST",
651 OXM_OF_UDP_DST
, "OXM_OF_UDP_DST", OFP12_VERSION
,
653 OFPUTIL_P_NXM_OXM_ANY
,
658 MFF_SCTP_SRC
, "sctp_src", NULL
,
659 MF_FIELD_SIZES(be16
),
664 OXM_OF_SCTP_SRC
, "OXM_OF_SCTP_SRC",
665 OXM_OF_SCTP_SRC
, "OXM_OF_SCTP_SRC", OFP12_VERSION
,
666 OFPUTIL_P_NXM_OF11_UP
,
667 OFPUTIL_P_NXM_OXM_ANY
,
670 MFF_SCTP_DST
, "sctp_dst", NULL
,
671 MF_FIELD_SIZES(be16
),
676 OXM_OF_SCTP_DST
, "OXM_OF_SCTP_DST",
677 OXM_OF_SCTP_DST
, "OXM_OF_SCTP_DST", OFP12_VERSION
,
678 OFPUTIL_P_NXM_OF11_UP
,
679 OFPUTIL_P_NXM_OXM_ANY
,
684 MFF_ICMPV4_TYPE
, "icmp_type", NULL
,
690 NXM_OF_ICMP_TYPE
, "NXM_OF_ICMP_TYPE",
691 OXM_OF_ICMPV4_TYPE
, "OXM_OF_ICMPV4_TYPE", OFP12_VERSION
,
696 MFF_ICMPV4_CODE
, "icmp_code", NULL
,
702 NXM_OF_ICMP_CODE
, "NXM_OF_ICMP_CODE",
703 OXM_OF_ICMPV4_CODE
, "OXM_OF_ICMPV4_CODE", OFP12_VERSION
,
710 MFF_ICMPV6_TYPE
, "icmpv6_type", NULL
,
716 NXM_NX_ICMPV6_TYPE
, "NXM_NX_ICMPV6_TYPE",
717 OXM_OF_ICMPV6_TYPE
, "OXM_OF_ICMPV6_TYPE", OFP12_VERSION
,
718 OFPUTIL_P_NXM_OXM_ANY
,
722 MFF_ICMPV6_CODE
, "icmpv6_code", NULL
,
728 NXM_NX_ICMPV6_CODE
, "NXM_NX_ICMPV6_CODE",
729 OXM_OF_ICMPV6_CODE
, "OXM_OF_ICMPV6_CODE", OFP12_VERSION
,
730 OFPUTIL_P_NXM_OXM_ANY
,
740 MFF_ND_TARGET
, "nd_target", NULL
,
741 MF_FIELD_SIZES(ipv6
),
746 NXM_NX_ND_TARGET
, "NXM_NX_ND_TARGET",
747 OXM_OF_IPV6_ND_TARGET
, "OXM_OF_IPV6_ND_TARGET", OFP12_VERSION
,
748 OFPUTIL_P_NXM_OXM_ANY
,
749 OFPUTIL_P_NXM_OXM_ANY
,
752 MFF_ND_SLL
, "nd_sll", NULL
,
758 NXM_NX_ND_SLL
, "NXM_NX_ND_SLL",
759 OXM_OF_IPV6_ND_SLL
, "OXM_OF_IPV6_ND_SLL", OFP12_VERSION
,
760 OFPUTIL_P_NXM_OXM_ANY
,
761 OFPUTIL_P_NXM_OXM_ANY
,
764 MFF_ND_TLL
, "nd_tll", NULL
,
770 NXM_NX_ND_TLL
, "NXM_NX_ND_TLL",
771 OXM_OF_IPV6_ND_TLL
, "OXM_OF_IPV6_ND_TLL", OFP12_VERSION
,
772 OFPUTIL_P_NXM_OXM_ANY
,
773 OFPUTIL_P_NXM_OXM_ANY
,
778 /* Maps an NXM or OXM header value to an mf_field. */
780 struct hmap_node hmap_node
; /* In 'all_fields' hmap. */
781 uint32_t header
; /* NXM or OXM header value. */
782 const struct mf_field
*mf
;
785 /* Contains 'struct nxm_field's. */
786 static struct hmap all_fields
;
788 /* Maps from an mf_field's 'name' or 'extra_name' to the mf_field. */
789 static struct shash mf_by_name
;
791 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
792 * controller and so there's not much point in showing a lot of them. */
793 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
795 const struct mf_field
*mf_from_nxm_header__(uint32_t header
);
796 static void nxm_init(void);
798 /* Returns the field with the given 'name', or a null pointer if no field has
800 const struct mf_field
*
801 mf_from_name(const char *name
)
804 return shash_find_data(&mf_by_name
, name
);
808 add_nxm_field(uint32_t header
, const struct mf_field
*mf
)
812 f
= xmalloc(sizeof *f
);
813 hmap_insert(&all_fields
, &f
->hmap_node
, hash_int(header
, 0));
819 nxm_init_add_field(const struct mf_field
*mf
, uint32_t header
)
822 ovs_assert(!mf_from_nxm_header__(header
));
823 add_nxm_field(header
, mf
);
824 if (mf
->maskable
!= MFM_NONE
) {
825 add_nxm_field(NXM_MAKE_WILD_HEADER(header
), mf
);
835 hmap_init(&all_fields
);
836 shash_init(&mf_by_name
);
837 for (i
= 0; i
< MFF_N_IDS
; i
++) {
838 const struct mf_field
*mf
= &mf_fields
[i
];
840 ovs_assert(mf
->id
== i
); /* Fields must be in the enum order. */
842 nxm_init_add_field(mf
, mf
->nxm_header
);
843 if (mf
->oxm_header
!= mf
->nxm_header
) {
844 nxm_init_add_field(mf
, mf
->oxm_header
);
847 shash_add_once(&mf_by_name
, mf
->name
, mf
);
848 if (mf
->extra_name
) {
849 shash_add_once(&mf_by_name
, mf
->extra_name
, mf
);
857 static pthread_once_t once
= PTHREAD_ONCE_INIT
;
858 pthread_once(&once
, nxm_do_init
);
861 const struct mf_field
*
862 mf_from_nxm_header(uint32_t header
)
865 return mf_from_nxm_header__(header
);
868 const struct mf_field
*
869 mf_from_nxm_header__(uint32_t header
)
871 const struct nxm_field
*f
;
873 HMAP_FOR_EACH_IN_BUCKET (f
, hmap_node
, hash_int(header
, 0), &all_fields
) {
874 if (f
->header
== header
) {
883 mf_oxm_header(enum mf_field_id id
, enum ofp_version oxm_version
)
885 const struct mf_field
*field
= mf_from_id(id
);
887 return (oxm_version
>= field
->oxm_version
889 : field
->nxm_header
);
892 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
893 * specifies at least one bit in the field.
895 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
896 * meets 'mf''s prerequisites. */
898 mf_is_all_wild(const struct mf_field
*mf
, const struct flow_wildcards
*wc
)
902 return !wc
->masks
.dp_hash
;
904 return !wc
->masks
.recirc_id
;
906 return !wc
->masks
.tunnel
.ip_src
;
908 return !wc
->masks
.tunnel
.ip_dst
;
913 return !wc
->masks
.tunnel
.tun_id
;
915 return !wc
->masks
.metadata
;
917 case MFF_IN_PORT_OXM
:
918 return !wc
->masks
.in_port
.ofp_port
;
919 case MFF_SKB_PRIORITY
:
920 return !wc
->masks
.skb_priority
;
922 return !wc
->masks
.pkt_mark
;
924 return !wc
->masks
.regs
[mf
->id
- MFF_REG0
];
927 return eth_addr_is_zero(wc
->masks
.dl_src
);
929 return eth_addr_is_zero(wc
->masks
.dl_dst
);
931 return !wc
->masks
.dl_type
;
935 return eth_addr_is_zero(wc
->masks
.arp_sha
);
939 return eth_addr_is_zero(wc
->masks
.arp_tha
);
942 return !wc
->masks
.vlan_tci
;
944 return !(wc
->masks
.vlan_tci
& htons(VLAN_VID_MASK
));
946 return !(wc
->masks
.vlan_tci
& htons(VLAN_VID_MASK
| VLAN_CFI
));
947 case MFF_DL_VLAN_PCP
:
949 return !(wc
->masks
.vlan_tci
& htons(VLAN_PCP_MASK
));
952 return !(wc
->masks
.mpls_lse
[0] & htonl(MPLS_LABEL_MASK
));
954 return !(wc
->masks
.mpls_lse
[1] & htonl(MPLS_TC_MASK
));
956 return !(wc
->masks
.mpls_lse
[2] & htonl(MPLS_BOS_MASK
));
959 return !wc
->masks
.nw_src
;
961 return !wc
->masks
.nw_dst
;
964 return ipv6_mask_is_any(&wc
->masks
.ipv6_src
);
966 return ipv6_mask_is_any(&wc
->masks
.ipv6_dst
);
969 return !wc
->masks
.ipv6_label
;
972 return !wc
->masks
.nw_proto
;
974 case MFF_IP_DSCP_SHIFTED
:
975 return !(wc
->masks
.nw_tos
& IP_DSCP_MASK
);
977 return !(wc
->masks
.nw_tos
& IP_ECN_MASK
);
979 return !wc
->masks
.nw_ttl
;
982 return ipv6_mask_is_any(&wc
->masks
.nd_target
);
985 return !(wc
->masks
.nw_frag
& FLOW_NW_FRAG_MASK
);
988 return !wc
->masks
.nw_proto
;
990 return !wc
->masks
.nw_src
;
992 return !wc
->masks
.nw_dst
;
997 case MFF_ICMPV4_TYPE
:
998 case MFF_ICMPV6_TYPE
:
999 return !wc
->masks
.tp_src
;
1003 case MFF_ICMPV4_CODE
:
1004 case MFF_ICMPV6_CODE
:
1005 return !wc
->masks
.tp_dst
;
1007 return !wc
->masks
.tcp_flags
;
1015 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
1016 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
1017 * purposes, or to 0 if it is wildcarded.
1019 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
1020 * meets 'mf''s prerequisites. */
1022 mf_get_mask(const struct mf_field
*mf
, const struct flow_wildcards
*wc
,
1023 union mf_value
*mask
)
1025 mf_get_value(mf
, &wc
->masks
, mask
);
1028 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
1029 * if the mask is valid, false otherwise. */
1031 mf_is_mask_valid(const struct mf_field
*mf
, const union mf_value
*mask
)
1033 switch (mf
->maskable
) {
1035 return (is_all_zeros((const uint8_t *) mask
, mf
->n_bytes
) ||
1036 is_all_ones((const uint8_t *) mask
, mf
->n_bytes
));
1045 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
1047 mf_are_prereqs_ok(const struct mf_field
*mf
, const struct flow
*flow
)
1049 switch (mf
->prereqs
) {
1054 return (flow
->dl_type
== htons(ETH_TYPE_ARP
) ||
1055 flow
->dl_type
== htons(ETH_TYPE_RARP
));
1057 return flow
->dl_type
== htons(ETH_TYPE_IP
);
1059 return flow
->dl_type
== htons(ETH_TYPE_IPV6
);
1061 return (flow
->vlan_tci
& htons(VLAN_CFI
)) != 0;
1063 return eth_type_mpls(flow
->dl_type
);
1065 return is_ip_any(flow
);
1068 return is_ip_any(flow
) && flow
->nw_proto
== IPPROTO_TCP
;
1070 return is_ip_any(flow
) && flow
->nw_proto
== IPPROTO_UDP
;
1072 return is_ip_any(flow
) && flow
->nw_proto
== IPPROTO_SCTP
;
1074 return is_icmpv4(flow
);
1076 return is_icmpv6(flow
);
1079 return (is_icmpv6(flow
)
1080 && flow
->tp_dst
== htons(0)
1081 && (flow
->tp_src
== htons(ND_NEIGHBOR_SOLICIT
) ||
1082 flow
->tp_src
== htons(ND_NEIGHBOR_ADVERT
)));
1083 case MFP_ND_SOLICIT
:
1084 return (is_icmpv6(flow
)
1085 && flow
->tp_dst
== htons(0)
1086 && (flow
->tp_src
== htons(ND_NEIGHBOR_SOLICIT
)));
1088 return (is_icmpv6(flow
)
1089 && flow
->tp_dst
== htons(0)
1090 && (flow
->tp_src
== htons(ND_NEIGHBOR_ADVERT
)));
1096 /* Set field and it's prerequisities in the mask.
1097 * This is only ever called for writeable 'mf's, but we do not make the
1098 * distinction here. */
1100 mf_mask_field_and_prereqs(const struct mf_field
*mf
, struct flow
*mask
)
1102 static const union mf_value exact_match_mask
= MF_EXACT_MASK_INITIALIZER
;
1104 mf_set_flow_value(mf
, &exact_match_mask
, mask
);
1106 switch (mf
->prereqs
) {
1108 case MFP_ND_SOLICIT
:
1110 mask
->tp_src
= OVS_BE16_MAX
;
1111 mask
->tp_dst
= OVS_BE16_MAX
;
1118 mask
->nw_proto
= 0xff;
1125 mask
->dl_type
= OVS_BE16_MAX
;
1128 mask
->vlan_tci
|= htons(VLAN_CFI
);
1136 /* Returns true if 'value' may be a valid value *as part of a masked match*,
1139 * A value is not rejected just because it is not valid for the field in
1140 * question, but only if it doesn't make sense to test the bits in question at
1141 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
1142 * without the VLAN_CFI bit being set, but we can't reject those values because
1143 * it is still legitimate to test just for those bits (see the documentation
1144 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
1145 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
1147 mf_is_value_valid(const struct mf_field
*mf
, const union mf_value
*value
)
1160 case MFF_SKB_PRIORITY
:
1183 case MFF_ICMPV4_TYPE
:
1184 case MFF_ICMPV4_CODE
:
1185 case MFF_ICMPV6_TYPE
:
1186 case MFF_ICMPV6_CODE
:
1192 case MFF_IN_PORT_OXM
: {
1194 return !ofputil_port_from_ofp11(value
->be32
, &port
);
1198 return !(value
->u8
& ~IP_DSCP_MASK
);
1199 case MFF_IP_DSCP_SHIFTED
:
1200 return !(value
->u8
& (~IP_DSCP_MASK
>> 2));
1202 return !(value
->u8
& ~IP_ECN_MASK
);
1204 return !(value
->u8
& ~FLOW_NW_FRAG_MASK
);
1206 return !(value
->be16
& ~htons(0x0fff));
1209 return !(value
->be16
& htons(0xff00));
1212 return !(value
->be16
& htons(VLAN_CFI
| VLAN_PCP_MASK
));
1214 return !(value
->be16
& htons(VLAN_PCP_MASK
));
1216 case MFF_DL_VLAN_PCP
:
1218 return !(value
->u8
& ~(VLAN_PCP_MASK
>> VLAN_PCP_SHIFT
));
1220 case MFF_IPV6_LABEL
:
1221 return !(value
->be32
& ~htonl(IPV6_LABEL_MASK
));
1223 case MFF_MPLS_LABEL
:
1224 return !(value
->be32
& ~htonl(MPLS_LABEL_MASK
>> MPLS_LABEL_SHIFT
));
1227 return !(value
->u8
& ~(MPLS_TC_MASK
>> MPLS_TC_SHIFT
));
1230 return !(value
->u8
& ~(MPLS_BOS_MASK
>> MPLS_BOS_SHIFT
));
1238 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
1239 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
1241 mf_get_value(const struct mf_field
*mf
, const struct flow
*flow
,
1242 union mf_value
*value
)
1246 value
->be32
= htonl(flow
->dp_hash
);
1249 value
->be32
= htonl(flow
->recirc_id
);
1252 value
->be64
= flow
->tunnel
.tun_id
;
1255 value
->be32
= flow
->tunnel
.ip_src
;
1258 value
->be32
= flow
->tunnel
.ip_dst
;
1261 value
->be16
= htons(flow
->tunnel
.flags
);
1264 value
->u8
= flow
->tunnel
.ip_ttl
;
1267 value
->u8
= flow
->tunnel
.ip_tos
;
1271 value
->be64
= flow
->metadata
;
1275 value
->be16
= htons(ofp_to_u16(flow
->in_port
.ofp_port
));
1277 case MFF_IN_PORT_OXM
:
1278 value
->be32
= ofputil_port_to_ofp11(flow
->in_port
.ofp_port
);
1281 case MFF_SKB_PRIORITY
:
1282 value
->be32
= htonl(flow
->skb_priority
);
1286 value
->be32
= htonl(flow
->pkt_mark
);
1290 value
->be32
= htonl(flow
->regs
[mf
->id
- MFF_REG0
]);
1294 memcpy(value
->mac
, flow
->dl_src
, ETH_ADDR_LEN
);
1298 memcpy(value
->mac
, flow
->dl_dst
, ETH_ADDR_LEN
);
1302 value
->be16
= flow
->dl_type
;
1306 value
->be16
= flow
->vlan_tci
;
1310 value
->be16
= flow
->vlan_tci
& htons(VLAN_VID_MASK
);
1313 value
->be16
= flow
->vlan_tci
& htons(VLAN_VID_MASK
| VLAN_CFI
);
1316 case MFF_DL_VLAN_PCP
:
1318 value
->u8
= vlan_tci_to_pcp(flow
->vlan_tci
);
1321 case MFF_MPLS_LABEL
:
1322 value
->be32
= htonl(mpls_lse_to_label(flow
->mpls_lse
[0]));
1326 value
->u8
= mpls_lse_to_tc(flow
->mpls_lse
[0]);
1330 value
->u8
= mpls_lse_to_bos(flow
->mpls_lse
[0]);
1334 value
->be32
= flow
->nw_src
;
1338 value
->be32
= flow
->nw_dst
;
1342 value
->ipv6
= flow
->ipv6_src
;
1346 value
->ipv6
= flow
->ipv6_dst
;
1349 case MFF_IPV6_LABEL
:
1350 value
->be32
= flow
->ipv6_label
;
1354 value
->u8
= flow
->nw_proto
;
1358 value
->u8
= flow
->nw_tos
& IP_DSCP_MASK
;
1361 case MFF_IP_DSCP_SHIFTED
:
1362 value
->u8
= flow
->nw_tos
>> 2;
1366 value
->u8
= flow
->nw_tos
& IP_ECN_MASK
;
1370 value
->u8
= flow
->nw_ttl
;
1374 value
->u8
= flow
->nw_frag
;
1378 value
->be16
= htons(flow
->nw_proto
);
1382 value
->be32
= flow
->nw_src
;
1386 value
->be32
= flow
->nw_dst
;
1391 memcpy(value
->mac
, flow
->arp_sha
, ETH_ADDR_LEN
);
1396 memcpy(value
->mac
, flow
->arp_tha
, ETH_ADDR_LEN
);
1402 value
->be16
= flow
->tp_src
;
1408 value
->be16
= flow
->tp_dst
;
1412 value
->be16
= flow
->tcp_flags
;
1415 case MFF_ICMPV4_TYPE
:
1416 case MFF_ICMPV6_TYPE
:
1417 value
->u8
= ntohs(flow
->tp_src
);
1420 case MFF_ICMPV4_CODE
:
1421 case MFF_ICMPV6_CODE
:
1422 value
->u8
= ntohs(flow
->tp_dst
);
1426 value
->ipv6
= flow
->nd_target
;
1435 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1436 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1439 mf_set_value(const struct mf_field
*mf
,
1440 const union mf_value
*value
, struct match
*match
)
1444 match_set_dp_hash(match
, ntohl(value
->be32
));
1447 match_set_recirc_id(match
, ntohl(value
->be32
));
1450 match_set_tun_id(match
, value
->be64
);
1453 match_set_tun_src(match
, value
->be32
);
1456 match_set_tun_dst(match
, value
->be32
);
1459 match_set_tun_flags(match
, ntohs(value
->be16
));
1462 match_set_tun_tos(match
, value
->u8
);
1465 match_set_tun_ttl(match
, value
->u8
);
1469 match_set_metadata(match
, value
->be64
);
1473 match_set_in_port(match
, u16_to_ofp(ntohs(value
->be16
)));
1476 case MFF_IN_PORT_OXM
: {
1478 ofputil_port_from_ofp11(value
->be32
, &port
);
1479 match_set_in_port(match
, port
);
1483 case MFF_SKB_PRIORITY
:
1484 match_set_skb_priority(match
, ntohl(value
->be32
));
1488 match_set_pkt_mark(match
, ntohl(value
->be32
));
1492 match_set_reg(match
, mf
->id
- MFF_REG0
, ntohl(value
->be32
));
1496 match_set_dl_src(match
, value
->mac
);
1500 match_set_dl_dst(match
, value
->mac
);
1504 match_set_dl_type(match
, value
->be16
);
1508 match_set_dl_tci(match
, value
->be16
);
1512 match_set_dl_vlan(match
, value
->be16
);
1515 match_set_vlan_vid(match
, value
->be16
);
1518 case MFF_DL_VLAN_PCP
:
1520 match_set_dl_vlan_pcp(match
, value
->u8
);
1523 case MFF_MPLS_LABEL
:
1524 match_set_mpls_label(match
, 0, value
->be32
);
1528 match_set_mpls_tc(match
, 0, value
->u8
);
1532 match_set_mpls_bos(match
, 0, value
->u8
);
1536 match_set_nw_src(match
, value
->be32
);
1540 match_set_nw_dst(match
, value
->be32
);
1544 match_set_ipv6_src(match
, &value
->ipv6
);
1548 match_set_ipv6_dst(match
, &value
->ipv6
);
1551 case MFF_IPV6_LABEL
:
1552 match_set_ipv6_label(match
, value
->be32
);
1556 match_set_nw_proto(match
, value
->u8
);
1560 match_set_nw_dscp(match
, value
->u8
);
1563 case MFF_IP_DSCP_SHIFTED
:
1564 match_set_nw_dscp(match
, value
->u8
<< 2);
1568 match_set_nw_ecn(match
, value
->u8
);
1572 match_set_nw_ttl(match
, value
->u8
);
1576 match_set_nw_frag(match
, value
->u8
);
1580 match_set_nw_proto(match
, ntohs(value
->be16
));
1584 match_set_nw_src(match
, value
->be32
);
1588 match_set_nw_dst(match
, value
->be32
);
1593 match_set_arp_sha(match
, value
->mac
);
1598 match_set_arp_tha(match
, value
->mac
);
1604 match_set_tp_src(match
, value
->be16
);
1610 match_set_tp_dst(match
, value
->be16
);
1614 match_set_tcp_flags(match
, value
->be16
);
1617 case MFF_ICMPV4_TYPE
:
1618 case MFF_ICMPV6_TYPE
:
1619 match_set_icmp_type(match
, value
->u8
);
1622 case MFF_ICMPV4_CODE
:
1623 case MFF_ICMPV6_CODE
:
1624 match_set_icmp_code(match
, value
->u8
);
1628 match_set_nd_target(match
, &value
->ipv6
);
1637 /* Unwildcard 'mask' member field described by 'mf'. The caller is
1638 * responsible for ensuring that 'mask' meets 'mf''s prerequisites. */
1640 mf_mask_field(const struct mf_field
*mf
, struct flow
*mask
)
1642 static const union mf_value exact_match_mask
= MF_EXACT_MASK_INITIALIZER
;
1644 /* For MFF_DL_VLAN, we cannot send a all 1's to flow_set_dl_vlan()
1645 * as that will be considered as OFP10_VLAN_NONE. So consider it as a
1646 * special case. For the rest, calling mf_set_flow_value() is good
1648 if (mf
->id
== MFF_DL_VLAN
) {
1649 flow_set_dl_vlan(mask
, htons(VLAN_VID_MASK
));
1651 mf_set_flow_value(mf
, &exact_match_mask
, mask
);
1655 /* Sets 'flow' member field described by 'mf' to 'value'. The caller is
1656 * responsible for ensuring that 'flow' meets 'mf''s prerequisites.*/
1658 mf_set_flow_value(const struct mf_field
*mf
,
1659 const union mf_value
*value
, struct flow
*flow
)
1663 flow
->dp_hash
= ntohl(value
->be32
);
1666 flow
->recirc_id
= ntohl(value
->be32
);
1669 flow
->tunnel
.tun_id
= value
->be64
;
1672 flow
->tunnel
.ip_src
= value
->be32
;
1675 flow
->tunnel
.ip_dst
= value
->be32
;
1678 flow
->tunnel
.flags
= ntohs(value
->be16
);
1681 flow
->tunnel
.ip_tos
= value
->u8
;
1684 flow
->tunnel
.ip_ttl
= value
->u8
;
1688 flow
->metadata
= value
->be64
;
1692 flow
->in_port
.ofp_port
= u16_to_ofp(ntohs(value
->be16
));
1695 case MFF_IN_PORT_OXM
: {
1697 ofputil_port_from_ofp11(value
->be32
, &port
);
1698 flow
->in_port
.ofp_port
= port
;
1702 case MFF_SKB_PRIORITY
:
1703 flow
->skb_priority
= ntohl(value
->be32
);
1707 flow
->pkt_mark
= ntohl(value
->be32
);
1711 flow
->regs
[mf
->id
- MFF_REG0
] = ntohl(value
->be32
);
1715 memcpy(flow
->dl_src
, value
->mac
, ETH_ADDR_LEN
);
1719 memcpy(flow
->dl_dst
, value
->mac
, ETH_ADDR_LEN
);
1723 flow
->dl_type
= value
->be16
;
1727 flow
->vlan_tci
= value
->be16
;
1731 flow_set_dl_vlan(flow
, value
->be16
);
1734 flow_set_vlan_vid(flow
, value
->be16
);
1737 case MFF_DL_VLAN_PCP
:
1739 flow_set_vlan_pcp(flow
, value
->u8
);
1742 case MFF_MPLS_LABEL
:
1743 flow_set_mpls_label(flow
, 0, value
->be32
);
1747 flow_set_mpls_tc(flow
, 0, value
->u8
);
1751 flow_set_mpls_bos(flow
, 0, value
->u8
);
1755 flow
->nw_src
= value
->be32
;
1759 flow
->nw_dst
= value
->be32
;
1763 flow
->ipv6_src
= value
->ipv6
;
1767 flow
->ipv6_dst
= value
->ipv6
;
1770 case MFF_IPV6_LABEL
:
1771 flow
->ipv6_label
= value
->be32
& ~htonl(IPV6_LABEL_MASK
);
1775 flow
->nw_proto
= value
->u8
;
1779 flow
->nw_tos
&= ~IP_DSCP_MASK
;
1780 flow
->nw_tos
|= value
->u8
& IP_DSCP_MASK
;
1783 case MFF_IP_DSCP_SHIFTED
:
1784 flow
->nw_tos
&= ~IP_DSCP_MASK
;
1785 flow
->nw_tos
|= value
->u8
<< 2;
1789 flow
->nw_tos
&= ~IP_ECN_MASK
;
1790 flow
->nw_tos
|= value
->u8
& IP_ECN_MASK
;
1794 flow
->nw_ttl
= value
->u8
;
1798 flow
->nw_frag
= value
->u8
& FLOW_NW_FRAG_MASK
;
1802 flow
->nw_proto
= ntohs(value
->be16
);
1806 flow
->nw_src
= value
->be32
;
1810 flow
->nw_dst
= value
->be32
;
1815 memcpy(flow
->arp_sha
, value
->mac
, ETH_ADDR_LEN
);
1820 memcpy(flow
->arp_tha
, value
->mac
, ETH_ADDR_LEN
);
1826 flow
->tp_src
= value
->be16
;
1832 flow
->tp_dst
= value
->be16
;
1836 flow
->tcp_flags
= value
->be16
;
1839 case MFF_ICMPV4_TYPE
:
1840 case MFF_ICMPV6_TYPE
:
1841 flow
->tp_src
= htons(value
->u8
);
1844 case MFF_ICMPV4_CODE
:
1845 case MFF_ICMPV6_CODE
:
1846 flow
->tp_dst
= htons(value
->u8
);
1850 flow
->nd_target
= value
->ipv6
;
1859 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1861 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1864 mf_is_zero(const struct mf_field
*mf
, const struct flow
*flow
)
1866 union mf_value value
;
1868 mf_get_value(mf
, flow
, &value
);
1869 return is_all_zeros((const uint8_t *) &value
, mf
->n_bytes
);
1872 /* Makes 'match' wildcard field 'mf'.
1874 * The caller is responsible for ensuring that 'match' meets 'mf''s
1877 mf_set_wild(const struct mf_field
*mf
, struct match
*match
)
1881 match
->flow
.dp_hash
= 0;
1882 match
->wc
.masks
.dp_hash
= 0;
1885 match
->flow
.recirc_id
= 0;
1886 match
->wc
.masks
.recirc_id
= 0;
1889 match_set_tun_id_masked(match
, htonll(0), htonll(0));
1892 match_set_tun_src_masked(match
, htonl(0), htonl(0));
1895 match_set_tun_dst_masked(match
, htonl(0), htonl(0));
1898 match_set_tun_flags_masked(match
, 0, 0);
1901 match_set_tun_tos_masked(match
, 0, 0);
1904 match_set_tun_ttl_masked(match
, 0, 0);
1908 match_set_metadata_masked(match
, htonll(0), htonll(0));
1912 case MFF_IN_PORT_OXM
:
1913 match
->flow
.in_port
.ofp_port
= 0;
1914 match
->wc
.masks
.in_port
.ofp_port
= 0;
1917 case MFF_SKB_PRIORITY
:
1918 match
->flow
.skb_priority
= 0;
1919 match
->wc
.masks
.skb_priority
= 0;
1923 match
->flow
.pkt_mark
= 0;
1924 match
->wc
.masks
.pkt_mark
= 0;
1928 match_set_reg_masked(match
, mf
->id
- MFF_REG0
, 0, 0);
1932 memset(match
->flow
.dl_src
, 0, ETH_ADDR_LEN
);
1933 memset(match
->wc
.masks
.dl_src
, 0, ETH_ADDR_LEN
);
1937 memset(match
->flow
.dl_dst
, 0, ETH_ADDR_LEN
);
1938 memset(match
->wc
.masks
.dl_dst
, 0, ETH_ADDR_LEN
);
1942 match
->flow
.dl_type
= htons(0);
1943 match
->wc
.masks
.dl_type
= htons(0);
1947 match_set_dl_tci_masked(match
, htons(0), htons(0));
1952 match_set_any_vid(match
);
1955 case MFF_DL_VLAN_PCP
:
1957 match_set_any_pcp(match
);
1960 case MFF_MPLS_LABEL
:
1961 match_set_any_mpls_label(match
, 0);
1965 match_set_any_mpls_tc(match
, 0);
1969 match_set_any_mpls_bos(match
, 0);
1974 match_set_nw_src_masked(match
, htonl(0), htonl(0));
1979 match_set_nw_dst_masked(match
, htonl(0), htonl(0));
1983 memset(&match
->wc
.masks
.ipv6_src
, 0, sizeof match
->wc
.masks
.ipv6_src
);
1984 memset(&match
->flow
.ipv6_src
, 0, sizeof match
->flow
.ipv6_src
);
1988 memset(&match
->wc
.masks
.ipv6_dst
, 0, sizeof match
->wc
.masks
.ipv6_dst
);
1989 memset(&match
->flow
.ipv6_dst
, 0, sizeof match
->flow
.ipv6_dst
);
1992 case MFF_IPV6_LABEL
:
1993 match
->wc
.masks
.ipv6_label
= htonl(0);
1994 match
->flow
.ipv6_label
= htonl(0);
1998 match
->wc
.masks
.nw_proto
= 0;
1999 match
->flow
.nw_proto
= 0;
2003 case MFF_IP_DSCP_SHIFTED
:
2004 match
->wc
.masks
.nw_tos
&= ~IP_DSCP_MASK
;
2005 match
->flow
.nw_tos
&= ~IP_DSCP_MASK
;
2009 match
->wc
.masks
.nw_tos
&= ~IP_ECN_MASK
;
2010 match
->flow
.nw_tos
&= ~IP_ECN_MASK
;
2014 match
->wc
.masks
.nw_ttl
= 0;
2015 match
->flow
.nw_ttl
= 0;
2019 match
->wc
.masks
.nw_frag
|= FLOW_NW_FRAG_MASK
;
2020 match
->flow
.nw_frag
&= ~FLOW_NW_FRAG_MASK
;
2024 match
->wc
.masks
.nw_proto
= 0;
2025 match
->flow
.nw_proto
= 0;
2030 memset(match
->flow
.arp_sha
, 0, ETH_ADDR_LEN
);
2031 memset(match
->wc
.masks
.arp_sha
, 0, ETH_ADDR_LEN
);
2036 memset(match
->flow
.arp_tha
, 0, ETH_ADDR_LEN
);
2037 memset(match
->wc
.masks
.arp_tha
, 0, ETH_ADDR_LEN
);
2043 case MFF_ICMPV4_TYPE
:
2044 case MFF_ICMPV6_TYPE
:
2045 match
->wc
.masks
.tp_src
= htons(0);
2046 match
->flow
.tp_src
= htons(0);
2052 case MFF_ICMPV4_CODE
:
2053 case MFF_ICMPV6_CODE
:
2054 match
->wc
.masks
.tp_dst
= htons(0);
2055 match
->flow
.tp_dst
= htons(0);
2059 match
->wc
.masks
.tcp_flags
= htons(0);
2060 match
->flow
.tcp_flags
= htons(0);
2064 memset(&match
->wc
.masks
.nd_target
, 0,
2065 sizeof match
->wc
.masks
.nd_target
);
2066 memset(&match
->flow
.nd_target
, 0, sizeof match
->flow
.nd_target
);
2075 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
2076 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
2077 * with a 1-bit indicating that the corresponding value bit must match and a
2078 * 0-bit indicating a don't-care.
2080 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
2081 * mf_set_value(mf, value, match). If 'mask' points to all-0-bits, then this
2082 * call is equivalent to mf_set_wild(mf, match).
2084 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
2085 * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
2086 enum ofputil_protocol
2087 mf_set(const struct mf_field
*mf
,
2088 const union mf_value
*value
, const union mf_value
*mask
,
2089 struct match
*match
)
2091 if (!mask
|| is_all_ones((const uint8_t *) mask
, mf
->n_bytes
)) {
2092 mf_set_value(mf
, value
, match
);
2093 return mf
->usable_protocols
;
2094 } else if (is_all_zeros((const uint8_t *) mask
, mf
->n_bytes
)) {
2095 mf_set_wild(mf
, match
);
2096 return OFPUTIL_P_ANY
;
2102 case MFF_IN_PORT_OXM
:
2103 case MFF_SKB_PRIORITY
:
2106 case MFF_DL_VLAN_PCP
:
2108 case MFF_MPLS_LABEL
:
2114 case MFF_IP_DSCP_SHIFTED
:
2117 case MFF_ICMPV4_TYPE
:
2118 case MFF_ICMPV4_CODE
:
2119 case MFF_ICMPV6_TYPE
:
2120 case MFF_ICMPV6_CODE
:
2121 return OFPUTIL_P_NONE
;
2124 match_set_dp_hash_masked(match
, ntohl(value
->be32
), ntohl(mask
->be32
));
2127 match_set_tun_id_masked(match
, value
->be64
, mask
->be64
);
2130 match_set_tun_src_masked(match
, value
->be32
, mask
->be32
);
2133 match_set_tun_dst_masked(match
, value
->be32
, mask
->be32
);
2136 match_set_tun_flags_masked(match
, ntohs(value
->be16
), ntohs(mask
->be16
));
2139 match_set_tun_ttl_masked(match
, value
->u8
, mask
->u8
);
2142 match_set_tun_tos_masked(match
, value
->u8
, mask
->u8
);
2146 match_set_metadata_masked(match
, value
->be64
, mask
->be64
);
2150 match_set_reg_masked(match
, mf
->id
- MFF_REG0
,
2151 ntohl(value
->be32
), ntohl(mask
->be32
));
2155 match_set_pkt_mark_masked(match
, ntohl(value
->be32
),
2160 match_set_dl_dst_masked(match
, value
->mac
, mask
->mac
);
2164 match_set_dl_src_masked(match
, value
->mac
, mask
->mac
);
2169 match_set_arp_sha_masked(match
, value
->mac
, mask
->mac
);
2174 match_set_arp_tha_masked(match
, value
->mac
, mask
->mac
);
2178 match_set_dl_tci_masked(match
, value
->be16
, mask
->be16
);
2182 match_set_vlan_vid_masked(match
, value
->be16
, mask
->be16
);
2186 match_set_nw_src_masked(match
, value
->be32
, mask
->be32
);
2190 match_set_nw_dst_masked(match
, value
->be32
, mask
->be32
);
2194 match_set_ipv6_src_masked(match
, &value
->ipv6
, &mask
->ipv6
);
2198 match_set_ipv6_dst_masked(match
, &value
->ipv6
, &mask
->ipv6
);
2201 case MFF_IPV6_LABEL
:
2202 if ((mask
->be32
& htonl(IPV6_LABEL_MASK
)) == htonl(IPV6_LABEL_MASK
)) {
2203 mf_set_value(mf
, value
, match
);
2205 match_set_ipv6_label_masked(match
, value
->be32
, mask
->be32
);
2210 match_set_nd_target_masked(match
, &value
->ipv6
, &mask
->ipv6
);
2214 match_set_nw_frag_masked(match
, value
->u8
, mask
->u8
);
2218 match_set_nw_src_masked(match
, value
->be32
, mask
->be32
);
2222 match_set_nw_dst_masked(match
, value
->be32
, mask
->be32
);
2228 match_set_tp_src_masked(match
, value
->be16
, mask
->be16
);
2234 match_set_tp_dst_masked(match
, value
->be16
, mask
->be16
);
2238 match_set_tcp_flags_masked(match
, value
->be16
, mask
->be16
);
2246 return mf
->usable_protocols_bitwise
;
2249 return ip_is_cidr(mask
->be32
) ? mf
->usable_protocols
:
2250 mf
->usable_protocols_bitwise
;
2254 mf_check__(const struct mf_subfield
*sf
, const struct flow
*flow
,
2258 VLOG_WARN_RL(&rl
, "unknown %s field", type
);
2259 return OFPERR_OFPBAC_BAD_SET_TYPE
;
2260 } else if (!sf
->n_bits
) {
2261 VLOG_WARN_RL(&rl
, "zero bit %s field %s", type
, sf
->field
->name
);
2262 return OFPERR_OFPBAC_BAD_SET_LEN
;
2263 } else if (sf
->ofs
>= sf
->field
->n_bits
) {
2264 VLOG_WARN_RL(&rl
, "bit offset %d exceeds %d-bit width of %s field %s",
2265 sf
->ofs
, sf
->field
->n_bits
, type
, sf
->field
->name
);
2266 return OFPERR_OFPBAC_BAD_SET_LEN
;
2267 } else if (sf
->ofs
+ sf
->n_bits
> sf
->field
->n_bits
) {
2268 VLOG_WARN_RL(&rl
, "bit offset %d and width %d exceeds %d-bit width "
2269 "of %s field %s", sf
->ofs
, sf
->n_bits
,
2270 sf
->field
->n_bits
, type
, sf
->field
->name
);
2271 return OFPERR_OFPBAC_BAD_SET_LEN
;
2272 } else if (flow
&& !mf_are_prereqs_ok(sf
->field
, flow
)) {
2273 VLOG_WARN_RL(&rl
, "%s field %s lacks correct prerequisites",
2274 type
, sf
->field
->name
);
2275 return OFPERR_OFPBAC_MATCH_INCONSISTENT
;
2281 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
2282 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
2285 mf_check_src(const struct mf_subfield
*sf
, const struct flow
*flow
)
2287 return mf_check__(sf
, flow
, "source");
2290 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
2291 * if so, otherwise an OpenFlow error code (e.g. as returned by
2294 mf_check_dst(const struct mf_subfield
*sf
, const struct flow
*flow
)
2296 int error
= mf_check__(sf
, flow
, "destination");
2297 if (!error
&& !sf
->field
->writable
) {
2298 VLOG_WARN_RL(&rl
, "destination field %s is not writable",
2300 return OFPERR_OFPBAC_BAD_SET_ARGUMENT
;
2305 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
2306 * 'value' and 'mask', respectively. */
2308 mf_get(const struct mf_field
*mf
, const struct match
*match
,
2309 union mf_value
*value
, union mf_value
*mask
)
2311 mf_get_value(mf
, &match
->flow
, value
);
2312 mf_get_mask(mf
, &match
->wc
, mask
);
2316 mf_from_integer_string(const struct mf_field
*mf
, const char *s
,
2317 uint8_t *valuep
, uint8_t *maskp
)
2319 unsigned long long int integer
, mask
;
2324 integer
= strtoull(s
, &tail
, 0);
2325 if (errno
|| (*tail
!= '\0' && *tail
!= '/')) {
2330 mask
= strtoull(tail
+ 1, &tail
, 0);
2331 if (errno
|| *tail
!= '\0') {
2338 for (i
= mf
->n_bytes
- 1; i
>= 0; i
--) {
2339 valuep
[i
] = integer
;
2345 return xasprintf("%s: value too large for %u-byte field %s",
2346 s
, mf
->n_bytes
, mf
->name
);
2351 return xasprintf("%s: bad syntax for %s", s
, mf
->name
);
2355 mf_from_ethernet_string(const struct mf_field
*mf
, const char *s
,
2356 uint8_t mac
[ETH_ADDR_LEN
],
2357 uint8_t mask
[ETH_ADDR_LEN
])
2361 ovs_assert(mf
->n_bytes
== ETH_ADDR_LEN
);
2364 if (ovs_scan(s
, ETH_ADDR_SCAN_FMT
"%n", ETH_ADDR_SCAN_ARGS(mac
), &n
)
2365 && n
== strlen(s
)) {
2366 memset(mask
, 0xff, ETH_ADDR_LEN
);
2371 if (ovs_scan(s
, ETH_ADDR_SCAN_FMT
"/"ETH_ADDR_SCAN_FMT
"%n",
2372 ETH_ADDR_SCAN_ARGS(mac
), ETH_ADDR_SCAN_ARGS(mask
), &n
)
2373 && n
== strlen(s
)) {
2377 return xasprintf("%s: invalid Ethernet address", s
);
2381 mf_from_ipv4_string(const struct mf_field
*mf
, const char *s
,
2382 ovs_be32
*ip
, ovs_be32
*mask
)
2386 ovs_assert(mf
->n_bytes
== sizeof *ip
);
2388 if (ovs_scan(s
, IP_SCAN_FMT
"/"IP_SCAN_FMT
,
2389 IP_SCAN_ARGS(ip
), IP_SCAN_ARGS(mask
))) {
2391 } else if (ovs_scan(s
, IP_SCAN_FMT
"/%d", IP_SCAN_ARGS(ip
), &prefix
)) {
2392 if (prefix
<= 0 || prefix
> 32) {
2393 return xasprintf("%s: network prefix bits not between 1 and "
2395 } else if (prefix
== 32) {
2396 *mask
= OVS_BE32_MAX
;
2398 *mask
= htonl(((1u << prefix
) - 1) << (32 - prefix
));
2400 } else if (ovs_scan(s
, IP_SCAN_FMT
, IP_SCAN_ARGS(ip
))) {
2401 *mask
= OVS_BE32_MAX
;
2403 return xasprintf("%s: invalid IP address", s
);
2409 mf_from_ipv6_string(const struct mf_field
*mf
, const char *s
,
2410 struct in6_addr
*value
, struct in6_addr
*mask
)
2412 char *str
= xstrdup(s
);
2413 char *save_ptr
= NULL
;
2414 const char *name
, *netmask
;
2417 ovs_assert(mf
->n_bytes
== sizeof *value
);
2419 name
= strtok_r(str
, "/", &save_ptr
);
2420 retval
= name
? lookup_ipv6(name
, value
) : EINVAL
;
2424 err
= xasprintf("%s: could not convert to IPv6 address", str
);
2430 netmask
= strtok_r(NULL
, "/", &save_ptr
);
2432 if (inet_pton(AF_INET6
, netmask
, mask
) != 1) {
2433 int prefix
= atoi(netmask
);
2434 if (prefix
<= 0 || prefix
> 128) {
2436 return xasprintf("%s: prefix bits not between 1 and 128", s
);
2438 *mask
= ipv6_create_mask(prefix
);
2442 *mask
= in6addr_exact
;
2450 mf_from_ofp_port_string(const struct mf_field
*mf
, const char *s
,
2451 ovs_be16
*valuep
, ovs_be16
*maskp
)
2455 ovs_assert(mf
->n_bytes
== sizeof(ovs_be16
));
2457 if (ofputil_port_from_string(s
, &port
)) {
2458 *valuep
= htons(ofp_to_u16(port
));
2459 *maskp
= OVS_BE16_MAX
;
2462 return xasprintf("%s: port value out of range for %s", s
, mf
->name
);
2466 mf_from_ofp_port_string32(const struct mf_field
*mf
, const char *s
,
2467 ovs_be32
*valuep
, ovs_be32
*maskp
)
2471 ovs_assert(mf
->n_bytes
== sizeof(ovs_be32
));
2472 if (ofputil_port_from_string(s
, &port
)) {
2473 *valuep
= ofputil_port_to_ofp11(port
);
2474 *maskp
= OVS_BE32_MAX
;
2477 return xasprintf("%s: port value out of range for %s", s
, mf
->name
);
2480 struct frag_handling
{
2486 static const struct frag_handling all_frags
[] = {
2487 #define A FLOW_NW_FRAG_ANY
2488 #define L FLOW_NW_FRAG_LATER
2489 /* name mask value */
2492 { "first", A
|L
, A
},
2493 { "later", A
|L
, A
|L
},
2498 { "not_later", L
, 0 },
2505 mf_from_frag_string(const char *s
, uint8_t *valuep
, uint8_t *maskp
)
2507 const struct frag_handling
*h
;
2509 for (h
= all_frags
; h
< &all_frags
[ARRAY_SIZE(all_frags
)]; h
++) {
2510 if (!strcasecmp(s
, h
->name
)) {
2511 /* We force the upper bits of the mask on to make mf_parse_value()
2512 * happy (otherwise it will never think it's an exact match.) */
2513 *maskp
= h
->mask
| ~FLOW_NW_FRAG_MASK
;
2519 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2520 "\"yes\", \"first\", \"later\", \"not_first\"", s
);
2524 parse_flow_tun_flags(const char *s_
, const char *(*bit_to_string
)(uint32_t),
2527 uint32_t result
= 0;
2528 char *save_ptr
= NULL
;
2531 char *s
= xstrdup(s_
);
2533 for (name
= strtok_r((char *)s
, " |", &save_ptr
); name
;
2534 name
= strtok_r(NULL
, " |", &save_ptr
)) {
2536 unsigned long long int flags
;
2539 if (ovs_scan(name
, "%lli", &flags
)) {
2543 name_len
= strlen(name
);
2544 for (bit
= 1; bit
; bit
<<= 1) {
2545 const char *fname
= bit_to_string(bit
);
2552 len
= strlen(fname
);
2553 if (len
!= name_len
) {
2556 if (!strncmp(name
, fname
, len
)) {
2568 *res
= htons(result
);
2575 mf_from_tun_flags_string(const char *s
, ovs_be16
*valuep
, ovs_be16
*maskp
)
2577 if (!parse_flow_tun_flags(s
, flow_tun_flag_to_string
, valuep
)) {
2578 *maskp
= OVS_BE16_MAX
;
2582 return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
2583 "\"csum\", \"key\")", s
);
2587 mf_from_tcp_flags_string(const char *s
, ovs_be16
*flagsp
, ovs_be16
*maskp
)
2594 if (ovs_scan(s
, "%"SCNi16
"/%"SCNi16
"%n", &flags
, &mask
, &n
) && !s
[n
]) {
2595 *flagsp
= htons(flags
);
2596 *maskp
= htons(mask
);
2599 if (ovs_scan(s
, "%"SCNi16
"%n", &flags
, &n
) && !s
[n
]) {
2600 *flagsp
= htons(flags
);
2601 *maskp
= OVS_BE16_MAX
;
2605 while (*s
!= '\0') {
2617 return xasprintf("%s: TCP flag must be preceded by '+' (for SET) "
2618 "or '-' (NOT SET)", s
);
2622 name_len
= strcspn(s
,"+-");
2624 for (bit
= 1; bit
; bit
<<= 1) {
2625 const char *fname
= packet_tcp_flag_to_string(bit
);
2632 len
= strlen(fname
);
2633 if (len
!= name_len
) {
2636 if (!strncmp(s
, fname
, len
)) {
2638 return xasprintf("%s: Each TCP flag can be specified only "
2650 return xasprintf("%s: unknown TCP flag(s)", s
);
2655 *flagsp
= htons(flags
);
2656 *maskp
= htons(mask
);
2661 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2662 * NULL if successful, otherwise a malloc()'d string describing the error. */
2664 mf_parse(const struct mf_field
*mf
, const char *s
,
2665 union mf_value
*value
, union mf_value
*mask
)
2669 if (!strcmp(s
, "*")) {
2670 memset(value
, 0, mf
->n_bytes
);
2671 memset(mask
, 0, mf
->n_bytes
);
2675 switch (mf
->string
) {
2677 case MFS_HEXADECIMAL
:
2678 error
= mf_from_integer_string(mf
, s
,
2679 (uint8_t *) value
, (uint8_t *) mask
);
2683 error
= mf_from_ethernet_string(mf
, s
, value
->mac
, mask
->mac
);
2687 error
= mf_from_ipv4_string(mf
, s
, &value
->be32
, &mask
->be32
);
2691 error
= mf_from_ipv6_string(mf
, s
, &value
->ipv6
, &mask
->ipv6
);
2695 error
= mf_from_ofp_port_string(mf
, s
, &value
->be16
, &mask
->be16
);
2698 case MFS_OFP_PORT_OXM
:
2699 error
= mf_from_ofp_port_string32(mf
, s
, &value
->be32
, &mask
->be32
);
2703 error
= mf_from_frag_string(s
, &value
->u8
, &mask
->u8
);
2707 ovs_assert(mf
->n_bytes
== sizeof(ovs_be16
));
2708 error
= mf_from_tun_flags_string(s
, &value
->be16
, &mask
->be16
);
2712 ovs_assert(mf
->n_bytes
== sizeof(ovs_be16
));
2713 error
= mf_from_tcp_flags_string(s
, &value
->be16
, &mask
->be16
);
2720 if (!error
&& !mf_is_mask_valid(mf
, mask
)) {
2721 error
= xasprintf("%s: invalid mask for field %s", s
, mf
->name
);
2726 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2727 * successful, otherwise a malloc()'d string describing the error. */
2729 mf_parse_value(const struct mf_field
*mf
, const char *s
, union mf_value
*value
)
2731 union mf_value mask
;
2734 error
= mf_parse(mf
, s
, value
, &mask
);
2739 if (!is_all_ones((const uint8_t *) &mask
, mf
->n_bytes
)) {
2740 return xasprintf("%s: wildcards not allowed here", s
);
2746 mf_format_integer_string(const struct mf_field
*mf
, const uint8_t *valuep
,
2747 const uint8_t *maskp
, struct ds
*s
)
2749 unsigned long long int integer
;
2752 ovs_assert(mf
->n_bytes
<= 8);
2755 for (i
= 0; i
< mf
->n_bytes
; i
++) {
2756 integer
= (integer
<< 8) | valuep
[i
];
2758 if (mf
->string
== MFS_HEXADECIMAL
) {
2759 ds_put_format(s
, "%#llx", integer
);
2761 ds_put_format(s
, "%lld", integer
);
2765 unsigned long long int mask
;
2768 for (i
= 0; i
< mf
->n_bytes
; i
++) {
2769 mask
= (mask
<< 8) | maskp
[i
];
2772 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2773 * not sure that that a bit-mask written in decimal is ever easier to
2774 * understand than the same bit-mask written in hexadecimal. */
2775 ds_put_format(s
, "/%#llx", mask
);
2780 mf_format_frag_string(uint8_t value
, uint8_t mask
, struct ds
*s
)
2782 const struct frag_handling
*h
;
2784 mask
&= FLOW_NW_FRAG_MASK
;
2787 for (h
= all_frags
; h
< &all_frags
[ARRAY_SIZE(all_frags
)]; h
++) {
2788 if (value
== h
->value
&& mask
== h
->mask
) {
2789 ds_put_cstr(s
, h
->name
);
2793 ds_put_cstr(s
, "<error>");
2797 mf_format_tnl_flags_string(const ovs_be16
*valuep
, struct ds
*s
)
2799 format_flags(s
, flow_tun_flag_to_string
, ntohs(*valuep
), '|');
2803 mf_format_tcp_flags_string(ovs_be16 value
, ovs_be16 mask
, struct ds
*s
)
2805 format_flags_masked(s
, NULL
, packet_tcp_flag_to_string
, ntohs(value
),
2809 /* Appends to 's' a string representation of field 'mf' whose value is in
2810 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2812 mf_format(const struct mf_field
*mf
,
2813 const union mf_value
*value
, const union mf_value
*mask
,
2817 if (is_all_zeros((const uint8_t *) mask
, mf
->n_bytes
)) {
2818 ds_put_cstr(s
, "ANY");
2820 } else if (is_all_ones((const uint8_t *) mask
, mf
->n_bytes
)) {
2825 switch (mf
->string
) {
2826 case MFS_OFP_PORT_OXM
:
2829 ofputil_port_from_ofp11(value
->be32
, &port
);
2830 ofputil_format_port(port
, s
);
2836 ofputil_format_port(u16_to_ofp(ntohs(value
->be16
)), s
);
2841 case MFS_HEXADECIMAL
:
2842 mf_format_integer_string(mf
, (uint8_t *) value
, (uint8_t *) mask
, s
);
2846 eth_format_masked(value
->mac
, mask
->mac
, s
);
2850 ip_format_masked(value
->be32
, mask
? mask
->be32
: OVS_BE32_MAX
, s
);
2854 print_ipv6_masked(s
, &value
->ipv6
, mask
? &mask
->ipv6
: NULL
);
2858 mf_format_frag_string(value
->u8
, mask
? mask
->u8
: UINT8_MAX
, s
);
2862 mf_format_tnl_flags_string(&value
->be16
, s
);
2866 mf_format_tcp_flags_string(value
->be16
,
2867 mask
? mask
->be16
: OVS_BE16_MAX
, s
);
2875 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2876 * least-significant bits in 'x'.
2879 mf_write_subfield_flow(const struct mf_subfield
*sf
,
2880 const union mf_subvalue
*x
, struct flow
*flow
)
2882 const struct mf_field
*field
= sf
->field
;
2883 union mf_value value
;
2885 mf_get_value(field
, flow
, &value
);
2886 bitwise_copy(x
, sizeof *x
, 0, &value
, field
->n_bytes
,
2887 sf
->ofs
, sf
->n_bits
);
2888 mf_set_flow_value(field
, &value
, flow
);
2891 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2892 * least-significant bits in 'x'.
2895 mf_write_subfield(const struct mf_subfield
*sf
, const union mf_subvalue
*x
,
2896 struct match
*match
)
2898 const struct mf_field
*field
= sf
->field
;
2899 union mf_value value
, mask
;
2901 mf_get(field
, match
, &value
, &mask
);
2902 bitwise_copy(x
, sizeof *x
, 0, &value
, field
->n_bytes
, sf
->ofs
, sf
->n_bits
);
2903 bitwise_one ( &mask
, field
->n_bytes
, sf
->ofs
, sf
->n_bits
);
2904 mf_set(field
, &value
, &mask
, match
);
2907 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2908 * reading 'flow', e.g. as checked by mf_check_src(). */
2910 mf_read_subfield(const struct mf_subfield
*sf
, const struct flow
*flow
,
2911 union mf_subvalue
*x
)
2913 union mf_value value
;
2915 mf_get_value(sf
->field
, flow
, &value
);
2917 memset(x
, 0, sizeof *x
);
2918 bitwise_copy(&value
, sf
->field
->n_bytes
, sf
->ofs
,
2923 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2924 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2927 mf_get_subfield(const struct mf_subfield
*sf
, const struct flow
*flow
)
2929 union mf_value value
;
2931 mf_get_value(sf
->field
, flow
, &value
);
2932 return bitwise_get(&value
, sf
->field
->n_bytes
, sf
->ofs
, sf
->n_bits
);
2935 /* Formats 'sf' into 's' in a format normally acceptable to
2936 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2937 * sf->field has no NXM name.) */
2939 mf_format_subfield(const struct mf_subfield
*sf
, struct ds
*s
)
2942 ds_put_cstr(s
, "<unknown>");
2943 } else if (sf
->field
->nxm_name
) {
2944 ds_put_cstr(s
, sf
->field
->nxm_name
);
2945 } else if (sf
->field
->nxm_header
) {
2946 uint32_t header
= sf
->field
->nxm_header
;
2947 ds_put_format(s
, "%d:%d", NXM_VENDOR(header
), NXM_FIELD(header
));
2949 ds_put_cstr(s
, sf
->field
->name
);
2952 if (sf
->field
&& sf
->ofs
== 0 && sf
->n_bits
== sf
->field
->n_bits
) {
2953 ds_put_cstr(s
, "[]");
2954 } else if (sf
->n_bits
== 1) {
2955 ds_put_format(s
, "[%d]", sf
->ofs
);
2957 ds_put_format(s
, "[%d..%d]", sf
->ofs
, sf
->ofs
+ sf
->n_bits
- 1);
2961 static const struct mf_field
*
2962 mf_parse_subfield_name(const char *name
, int name_len
, bool *wild
)
2966 *wild
= name_len
> 2 && !memcmp(&name
[name_len
- 2], "_W", 2);
2971 for (i
= 0; i
< MFF_N_IDS
; i
++) {
2972 const struct mf_field
*mf
= mf_from_id(i
);
2975 && !strncmp(mf
->nxm_name
, name
, name_len
)
2976 && mf
->nxm_name
[name_len
] == '\0') {
2980 && !strncmp(mf
->oxm_name
, name
, name_len
)
2981 && mf
->oxm_name
[name_len
] == '\0') {
2989 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2990 * returns NULL and advances '*sp' to the first byte following the parsed
2991 * string. On failure, returns a malloc()'d error message, does not modify
2992 * '*sp', and does not properly initialize 'sf'.
2994 * The syntax parsed from '*sp' takes the form "header[start..end]" where
2995 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2996 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2997 * may both be omitted (the [] are still required) to indicate an entire
2999 char * WARN_UNUSED_RESULT
3000 mf_parse_subfield__(struct mf_subfield
*sf
, const char **sp
)
3002 const struct mf_field
*field
;
3011 name_len
= strcspn(s
, "[");
3012 if (s
[name_len
] != '[') {
3013 return xasprintf("%s: missing [ looking for field name", *sp
);
3016 field
= mf_parse_subfield_name(name
, name_len
, &wild
);
3018 return xasprintf("%s: unknown field `%.*s'", *sp
, name_len
, s
);
3022 if (ovs_scan(s
, "[%d..%d]", &start
, &end
)) {
3023 /* Nothing to do. */
3024 } else if (ovs_scan(s
, "[%d]", &start
)) {
3026 } else if (!strncmp(s
, "[]", 2)) {
3028 end
= field
->n_bits
- 1;
3030 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
3031 "[<start>..<end>]", *sp
);
3033 s
= strchr(s
, ']') + 1;
3036 return xasprintf("%s: starting bit %d is after ending bit %d",
3038 } else if (start
>= field
->n_bits
) {
3039 return xasprintf("%s: starting bit %d is not valid because field is "
3040 "only %d bits wide", *sp
, start
, field
->n_bits
);
3041 } else if (end
>= field
->n_bits
){
3042 return xasprintf("%s: ending bit %d is not valid because field is "
3043 "only %d bits wide", *sp
, end
, field
->n_bits
);
3048 sf
->n_bits
= end
- start
+ 1;
3054 /* Parses a subfield from the entirety of 's' into 'sf'. Returns NULL if
3055 * successful, otherwise a malloc()'d string describing the error. The caller
3056 * is responsible for freeing the returned string.
3058 * The syntax parsed from 's' takes the form "header[start..end]" where
3059 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
3060 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
3061 * may both be omitted (the [] are still required) to indicate an entire
3063 char * WARN_UNUSED_RESULT
3064 mf_parse_subfield(struct mf_subfield
*sf
, const char *s
)
3066 char *error
= mf_parse_subfield__(sf
, &s
);
3067 if (!error
&& s
[0]) {
3068 error
= xstrdup("unexpected input following field syntax");
3074 mf_format_subvalue(const union mf_subvalue
*subvalue
, struct ds
*s
)
3078 for (i
= 0; i
< ARRAY_SIZE(subvalue
->u8
); i
++) {
3079 if (subvalue
->u8
[i
]) {
3080 ds_put_format(s
, "0x%"PRIx8
, subvalue
->u8
[i
]);
3081 for (i
++; i
< ARRAY_SIZE(subvalue
->u8
); i
++) {
3082 ds_put_format(s
, "%02"PRIx8
, subvalue
->u8
[i
]);
3087 ds_put_char(s
, '0');