2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017 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.
18 #include "openvswitch/match.h"
21 #include "byte-order.h"
23 #include "openvswitch/dynamic-string.h"
24 #include "openvswitch/meta-flow.h"
25 #include "openvswitch/ofp-port.h"
27 #include "tun-metadata.h"
28 #include "openvswitch/nsh.h"
30 /* Converts the flow in 'flow' into a match in 'match', with the given
33 match_init(struct match
*match
,
34 const struct flow
*flow
, const struct flow_wildcards
*wc
)
38 match_zero_wildcarded_fields(match
);
39 memset(&match
->tun_md
, 0, sizeof match
->tun_md
);
42 /* Converts a flow into a match. It sets the wildcard masks based on
43 * the packet contents. It will not set the mask for fields that do not
44 * make sense for the packet type. */
46 match_wc_init(struct match
*match
, const struct flow
*flow
)
50 flow_wildcards_init_for_packet(&match
->wc
, flow
);
51 WC_MASK_FIELD(&match
->wc
, regs
);
52 WC_MASK_FIELD(&match
->wc
, metadata
);
54 memset(&match
->tun_md
, 0, sizeof match
->tun_md
);
57 /* Initializes 'match' as a "catch-all" match that matches every packet. */
59 match_init_catchall(struct match
*match
)
61 memset(&match
->flow
, 0, sizeof match
->flow
);
62 flow_wildcards_init_catchall(&match
->wc
);
63 memset(&match
->tun_md
, 0, sizeof match
->tun_md
);
66 /* For each bit or field wildcarded in 'match', sets the corresponding bit or
67 * field in 'flow' to all-0-bits. It is important to maintain this invariant
68 * in a match that might be inserted into a classifier.
70 * It is never necessary to call this function directly for a match that is
71 * initialized or modified only by match_*() functions. It is useful to
72 * restore the invariant in a match whose 'wc' member is modified by hand.
75 match_zero_wildcarded_fields(struct match
*match
)
77 flow_zero_wildcards(&match
->flow
, &match
->wc
);
81 match_set_dp_hash(struct match
*match
, uint32_t value
)
83 match_set_dp_hash_masked(match
, value
, UINT32_MAX
);
87 match_set_dp_hash_masked(struct match
*match
, uint32_t value
, uint32_t mask
)
89 match
->wc
.masks
.dp_hash
= mask
;
90 match
->flow
.dp_hash
= value
& mask
;
94 match_set_recirc_id(struct match
*match
, uint32_t value
)
96 match
->flow
.recirc_id
= value
;
97 match
->wc
.masks
.recirc_id
= UINT32_MAX
;
101 match_set_conj_id(struct match
*match
, uint32_t value
)
103 match
->flow
.conj_id
= value
;
104 match
->wc
.masks
.conj_id
= UINT32_MAX
;
108 match_set_reg(struct match
*match
, unsigned int reg_idx
, uint32_t value
)
110 match_set_reg_masked(match
, reg_idx
, value
, UINT32_MAX
);
114 match_set_reg_masked(struct match
*match
, unsigned int reg_idx
,
115 uint32_t value
, uint32_t mask
)
117 ovs_assert(reg_idx
< FLOW_N_REGS
);
118 flow_wildcards_set_reg_mask(&match
->wc
, reg_idx
, mask
);
119 match
->flow
.regs
[reg_idx
] = value
& mask
;
123 match_set_xreg(struct match
*match
, unsigned int xreg_idx
, uint64_t value
)
125 match_set_xreg_masked(match
, xreg_idx
, value
, UINT64_MAX
);
129 match_set_xreg_masked(struct match
*match
, unsigned int xreg_idx
,
130 uint64_t value
, uint64_t mask
)
132 ovs_assert(xreg_idx
< FLOW_N_XREGS
);
133 flow_wildcards_set_xreg_mask(&match
->wc
, xreg_idx
, mask
);
134 flow_set_xreg(&match
->flow
, xreg_idx
, value
& mask
);
138 match_set_xxreg(struct match
*match
, unsigned int xxreg_idx
, ovs_u128 value
)
140 match_set_xxreg_masked(match
, xxreg_idx
, value
, OVS_U128_MAX
);
144 match_set_xxreg_masked(struct match
*match
, unsigned int xxreg_idx
,
145 ovs_u128 value
, ovs_u128 mask
)
147 ovs_assert(xxreg_idx
< FLOW_N_XXREGS
);
148 flow_wildcards_set_xxreg_mask(&match
->wc
, xxreg_idx
, mask
);
149 flow_set_xxreg(&match
->flow
, xxreg_idx
, ovs_u128_and(value
, mask
));
153 match_set_actset_output(struct match
*match
, ofp_port_t actset_output
)
155 match
->wc
.masks
.actset_output
= u16_to_ofp(UINT16_MAX
);
156 match
->flow
.actset_output
= actset_output
;
160 match_set_metadata(struct match
*match
, ovs_be64 metadata
)
162 match_set_metadata_masked(match
, metadata
, OVS_BE64_MAX
);
166 match_set_metadata_masked(struct match
*match
,
167 ovs_be64 metadata
, ovs_be64 mask
)
169 match
->wc
.masks
.metadata
= mask
;
170 match
->flow
.metadata
= metadata
& mask
;
174 match_set_tun_id(struct match
*match
, ovs_be64 tun_id
)
176 match_set_tun_id_masked(match
, tun_id
, OVS_BE64_MAX
);
180 match_set_tun_id_masked(struct match
*match
, ovs_be64 tun_id
, ovs_be64 mask
)
182 match
->wc
.masks
.tunnel
.tun_id
= mask
;
183 match
->flow
.tunnel
.tun_id
= tun_id
& mask
;
187 match_set_tun_src(struct match
*match
, ovs_be32 src
)
189 match_set_tun_src_masked(match
, src
, OVS_BE32_MAX
);
193 match_set_tun_src_masked(struct match
*match
, ovs_be32 src
, ovs_be32 mask
)
195 match
->wc
.masks
.tunnel
.ip_src
= mask
;
196 match
->flow
.tunnel
.ip_src
= src
& mask
;
200 match_set_tun_dst(struct match
*match
, ovs_be32 dst
)
202 match_set_tun_dst_masked(match
, dst
, OVS_BE32_MAX
);
206 match_set_tun_dst_masked(struct match
*match
, ovs_be32 dst
, ovs_be32 mask
)
208 match
->wc
.masks
.tunnel
.ip_dst
= mask
;
209 match
->flow
.tunnel
.ip_dst
= dst
& mask
;
213 match_set_tun_ipv6_src(struct match
*match
, const struct in6_addr
*src
)
215 match
->flow
.tunnel
.ipv6_src
= *src
;
216 match
->wc
.masks
.tunnel
.ipv6_src
= in6addr_exact
;
220 match_set_tun_ipv6_src_masked(struct match
*match
, const struct in6_addr
*src
,
221 const struct in6_addr
*mask
)
223 match
->flow
.tunnel
.ipv6_src
= ipv6_addr_bitand(src
, mask
);
224 match
->wc
.masks
.tunnel
.ipv6_src
= *mask
;
228 match_set_tun_ipv6_dst(struct match
*match
, const struct in6_addr
*dst
)
230 match
->flow
.tunnel
.ipv6_dst
= *dst
;
231 match
->wc
.masks
.tunnel
.ipv6_dst
= in6addr_exact
;
235 match_set_tun_ipv6_dst_masked(struct match
*match
, const struct in6_addr
*dst
,
236 const struct in6_addr
*mask
)
238 match
->flow
.tunnel
.ipv6_dst
= ipv6_addr_bitand(dst
, mask
);
239 match
->wc
.masks
.tunnel
.ipv6_dst
= *mask
;
243 match_set_tun_ttl(struct match
*match
, uint8_t ttl
)
245 match_set_tun_ttl_masked(match
, ttl
, UINT8_MAX
);
249 match_set_tun_ttl_masked(struct match
*match
, uint8_t ttl
, uint8_t mask
)
251 match
->wc
.masks
.tunnel
.ip_ttl
= mask
;
252 match
->flow
.tunnel
.ip_ttl
= ttl
& mask
;
256 match_set_tun_tos(struct match
*match
, uint8_t tos
)
258 match_set_tun_tos_masked(match
, tos
, UINT8_MAX
);
262 match_set_tun_tos_masked(struct match
*match
, uint8_t tos
, uint8_t mask
)
264 match
->wc
.masks
.tunnel
.ip_tos
= mask
;
265 match
->flow
.tunnel
.ip_tos
= tos
& mask
;
269 match_set_tun_flags(struct match
*match
, uint16_t flags
)
271 match_set_tun_flags_masked(match
, flags
, UINT16_MAX
);
275 match_set_tun_flags_masked(struct match
*match
, uint16_t flags
, uint16_t mask
)
277 mask
&= FLOW_TNL_PUB_F_MASK
;
279 match
->wc
.masks
.tunnel
.flags
= mask
;
280 match
->flow
.tunnel
.flags
= flags
& mask
;
284 match_set_tun_tp_dst(struct match
*match
, ovs_be16 tp_dst
)
286 match_set_tun_tp_dst_masked(match
, tp_dst
, OVS_BE16_MAX
);
290 match_set_tun_tp_dst_masked(struct match
*match
, ovs_be16 port
, ovs_be16 mask
)
292 match
->wc
.masks
.tunnel
.tp_dst
= mask
;
293 match
->flow
.tunnel
.tp_dst
= port
& mask
;
297 match_set_tun_gbp_id_masked(struct match
*match
, ovs_be16 gbp_id
, ovs_be16 mask
)
299 match
->wc
.masks
.tunnel
.gbp_id
= mask
;
300 match
->flow
.tunnel
.gbp_id
= gbp_id
& mask
;
304 match_set_tun_gbp_id(struct match
*match
, ovs_be16 gbp_id
)
306 match_set_tun_gbp_id_masked(match
, gbp_id
, OVS_BE16_MAX
);
310 match_set_tun_gbp_flags_masked(struct match
*match
, uint8_t flags
, uint8_t mask
)
312 match
->wc
.masks
.tunnel
.gbp_flags
= mask
;
313 match
->flow
.tunnel
.gbp_flags
= flags
& mask
;
317 match_set_tun_gbp_flags(struct match
*match
, uint8_t flags
)
319 match_set_tun_gbp_flags_masked(match
, flags
, UINT8_MAX
);
323 match_set_in_port(struct match
*match
, ofp_port_t ofp_port
)
325 match
->wc
.masks
.in_port
.ofp_port
= u16_to_ofp(UINT16_MAX
);
326 match
->flow
.in_port
.ofp_port
= ofp_port
;
330 match_set_skb_priority(struct match
*match
, uint32_t skb_priority
)
332 match
->wc
.masks
.skb_priority
= UINT32_MAX
;
333 match
->flow
.skb_priority
= skb_priority
;
337 match_set_pkt_mark(struct match
*match
, uint32_t pkt_mark
)
339 match_set_pkt_mark_masked(match
, pkt_mark
, UINT32_MAX
);
343 match_set_pkt_mark_masked(struct match
*match
, uint32_t pkt_mark
, uint32_t mask
)
345 match
->flow
.pkt_mark
= pkt_mark
& mask
;
346 match
->wc
.masks
.pkt_mark
= mask
;
350 match_set_ct_state(struct match
*match
, uint32_t ct_state
)
352 match_set_ct_state_masked(match
, ct_state
, UINT32_MAX
);
356 match_set_ct_state_masked(struct match
*match
, uint32_t ct_state
, uint32_t mask
)
358 match
->flow
.ct_state
= ct_state
& mask
& UINT8_MAX
;
359 match
->wc
.masks
.ct_state
= mask
& UINT8_MAX
;
363 match_set_ct_zone(struct match
*match
, uint16_t ct_zone
)
365 match
->flow
.ct_zone
= ct_zone
;
366 match
->wc
.masks
.ct_zone
= UINT16_MAX
;
370 match_set_ct_mark(struct match
*match
, uint32_t ct_mark
)
372 match_set_ct_mark_masked(match
, ct_mark
, UINT32_MAX
);
376 match_set_ct_mark_masked(struct match
*match
, uint32_t ct_mark
,
379 match
->flow
.ct_mark
= ct_mark
& mask
;
380 match
->wc
.masks
.ct_mark
= mask
;
384 match_set_ct_label(struct match
*match
, ovs_u128 ct_label
)
388 mask
.u64
.lo
= UINT64_MAX
;
389 mask
.u64
.hi
= UINT64_MAX
;
390 match_set_ct_label_masked(match
, ct_label
, mask
);
394 match_set_ct_label_masked(struct match
*match
, ovs_u128 value
, ovs_u128 mask
)
396 match
->flow
.ct_label
.u64
.lo
= value
.u64
.lo
& mask
.u64
.lo
;
397 match
->flow
.ct_label
.u64
.hi
= value
.u64
.hi
& mask
.u64
.hi
;
398 match
->wc
.masks
.ct_label
= mask
;
402 match_set_ct_nw_src(struct match
*match
, ovs_be32 ct_nw_src
)
404 match
->flow
.ct_nw_src
= ct_nw_src
;
405 match
->wc
.masks
.ct_nw_src
= OVS_BE32_MAX
;
409 match_set_ct_nw_src_masked(struct match
*match
, ovs_be32 ct_nw_src
,
412 match
->flow
.ct_nw_src
= ct_nw_src
& mask
;
413 match
->wc
.masks
.ct_nw_src
= mask
;
417 match_set_ct_nw_dst(struct match
*match
, ovs_be32 ct_nw_dst
)
419 match
->flow
.ct_nw_dst
= ct_nw_dst
;
420 match
->wc
.masks
.ct_nw_dst
= OVS_BE32_MAX
;
424 match_set_ct_nw_dst_masked(struct match
*match
, ovs_be32 ct_nw_dst
,
427 match
->flow
.ct_nw_dst
= ct_nw_dst
& mask
;
428 match
->wc
.masks
.ct_nw_dst
= mask
;
432 match_set_ct_nw_proto(struct match
*match
, uint8_t ct_nw_proto
)
434 match
->flow
.ct_nw_proto
= ct_nw_proto
;
435 match
->wc
.masks
.ct_nw_proto
= UINT8_MAX
;
439 match_set_ct_tp_src(struct match
*match
, ovs_be16 ct_tp_src
)
441 match_set_ct_tp_src_masked(match
, ct_tp_src
, OVS_BE16_MAX
);
445 match_set_ct_tp_src_masked(struct match
*match
, ovs_be16 port
, ovs_be16 mask
)
447 match
->flow
.ct_tp_src
= port
& mask
;
448 match
->wc
.masks
.ct_tp_src
= mask
;
452 match_set_ct_tp_dst(struct match
*match
, ovs_be16 ct_tp_dst
)
454 match_set_ct_tp_dst_masked(match
, ct_tp_dst
, OVS_BE16_MAX
);
458 match_set_ct_tp_dst_masked(struct match
*match
, ovs_be16 port
, ovs_be16 mask
)
460 match
->flow
.ct_tp_dst
= port
& mask
;
461 match
->wc
.masks
.ct_tp_dst
= mask
;
465 match_set_ct_ipv6_src(struct match
*match
, const struct in6_addr
*src
)
467 match
->flow
.ct_ipv6_src
= *src
;
468 match
->wc
.masks
.ct_ipv6_src
= in6addr_exact
;
472 match_set_ct_ipv6_src_masked(struct match
*match
, const struct in6_addr
*src
,
473 const struct in6_addr
*mask
)
475 match
->flow
.ct_ipv6_src
= ipv6_addr_bitand(src
, mask
);
476 match
->wc
.masks
.ct_ipv6_src
= *mask
;
480 match_set_ct_ipv6_dst(struct match
*match
, const struct in6_addr
*dst
)
482 match
->flow
.ct_ipv6_dst
= *dst
;
483 match
->wc
.masks
.ct_ipv6_dst
= in6addr_exact
;
487 match_set_ct_ipv6_dst_masked(struct match
*match
, const struct in6_addr
*dst
,
488 const struct in6_addr
*mask
)
490 match
->flow
.ct_ipv6_dst
= ipv6_addr_bitand(dst
, mask
);
491 match
->wc
.masks
.ct_ipv6_dst
= *mask
;
495 match_set_packet_type(struct match
*match
, ovs_be32 packet_type
)
497 match
->flow
.packet_type
= packet_type
;
498 match
->wc
.masks
.packet_type
= OVS_BE32_MAX
;
501 /* If 'match' does not match on any packet type, make it match on Ethernet
502 * packets (the default packet type, as specified by OpenFlow). */
504 match_set_default_packet_type(struct match
*match
)
506 if (!match
->wc
.masks
.packet_type
) {
507 match_set_packet_type(match
, htonl(PT_ETH
));
511 /* Returns true if 'match' matches only Ethernet packets (the default packet
512 * type, as specified by OpenFlow). */
514 match_has_default_packet_type(const struct match
*match
)
516 return (match
->flow
.packet_type
== htonl(PT_ETH
)
517 && match
->wc
.masks
.packet_type
== OVS_BE32_MAX
);
520 /* A match on 'field' is being added to or has been added to 'match'. If
521 * 'field' is a data field, and 'match' does not already match on packet_type,
522 * this function make it match on the Ethernet packet_type.
524 * This function is useful because OpenFlow implicitly applies to Ethernet
525 * packets when there's no explicit packet_type, but matching on a metadata
526 * field doesn't imply anything about the packet_type and falsely inferring
527 * that it does can cause harm. A flow that matches only on metadata fields,
528 * for example, should be able to match more than just Ethernet flows. There
529 * are also important reasons that a catch-all match (one with no field matches
530 * at all) should not imply a packet_type(0,0) match. For example, a "flow
531 * dump" request that matches on no fields should return every flow in the
532 * switch, not just the flows that match on Ethernet. As a second example,
533 * OpenFlow 1.2+ special-cases "table miss" flows, that is catch-all flows with
534 * priority 0, and inferring a match on packet_type(0,0) causes such a flow not
535 * to be a table miss flow. */
537 match_add_ethernet_prereq(struct match
*match
, const struct mf_field
*field
)
539 if (field
->prereqs
!= MFP_NONE
) {
540 match_set_default_packet_type(match
);
545 match_set_dl_type(struct match
*match
, ovs_be16 dl_type
)
547 match
->wc
.masks
.dl_type
= OVS_BE16_MAX
;
548 match
->flow
.dl_type
= dl_type
;
551 /* Modifies 'value_src' so that the Ethernet address must match 'value_dst'
552 * exactly. 'mask_dst' is set to all 1s. */
554 set_eth(const struct eth_addr value_src
,
555 struct eth_addr
*value_dst
,
556 struct eth_addr
*mask_dst
)
558 *value_dst
= value_src
;
559 *mask_dst
= eth_addr_exact
;
562 /* Modifies 'value_src' so that the Ethernet address must match 'value_src'
563 * after each byte is ANDed with the appropriate byte in 'mask_src'.
564 * 'mask_dst' is set to 'mask_src' */
566 set_eth_masked(const struct eth_addr value_src
,
567 const struct eth_addr mask_src
,
568 struct eth_addr
*value_dst
, struct eth_addr
*mask_dst
)
572 for (i
= 0; i
< ARRAY_SIZE(value_dst
->be16
); i
++) {
573 value_dst
->be16
[i
] = value_src
.be16
[i
] & mask_src
.be16
[i
];
575 *mask_dst
= mask_src
;
578 /* Modifies 'rule' so that the source Ethernet address must match 'dl_src'
581 match_set_dl_src(struct match
*match
, const struct eth_addr dl_src
)
583 set_eth(dl_src
, &match
->flow
.dl_src
, &match
->wc
.masks
.dl_src
);
586 /* Modifies 'rule' so that the source Ethernet address must match 'dl_src'
587 * after each byte is ANDed with the appropriate byte in 'mask'. */
589 match_set_dl_src_masked(struct match
*match
,
590 const struct eth_addr dl_src
,
591 const struct eth_addr mask
)
593 set_eth_masked(dl_src
, mask
, &match
->flow
.dl_src
, &match
->wc
.masks
.dl_src
);
596 /* Modifies 'match' so that the Ethernet address must match 'dl_dst'
599 match_set_dl_dst(struct match
*match
, const struct eth_addr dl_dst
)
601 set_eth(dl_dst
, &match
->flow
.dl_dst
, &match
->wc
.masks
.dl_dst
);
604 /* Modifies 'match' so that the Ethernet address must match 'dl_dst' after each
605 * byte is ANDed with the appropriate byte in 'mask'.
607 * This function will assert-fail if 'mask' is invalid. Only 'mask' values
608 * accepted by flow_wildcards_is_dl_dst_mask_valid() are allowed. */
610 match_set_dl_dst_masked(struct match
*match
,
611 const struct eth_addr dl_dst
,
612 const struct eth_addr mask
)
614 set_eth_masked(dl_dst
, mask
, &match
->flow
.dl_dst
, &match
->wc
.masks
.dl_dst
);
618 match_set_dl_tci(struct match
*match
, ovs_be16 tci
)
620 match_set_dl_tci_masked(match
, tci
, htons(0xffff));
624 match_set_dl_tci_masked(struct match
*match
, ovs_be16 tci
, ovs_be16 mask
)
626 match
->flow
.vlans
[0].tci
= tci
& mask
;
627 match
->wc
.masks
.vlans
[0].tci
= mask
;
630 /* Modifies 'match' so that the VLAN VID is wildcarded. If the PCP is already
631 * wildcarded, then 'match' will match a packet regardless of whether it has an
632 * 802.1Q header or not. */
634 match_set_any_vid(struct match
*match
)
636 if (match
->wc
.masks
.vlans
[0].tci
& htons(VLAN_PCP_MASK
)) {
637 match
->wc
.masks
.vlans
[0].tci
&= ~htons(VLAN_VID_MASK
);
638 match
->flow
.vlans
[0].tci
&= ~htons(VLAN_VID_MASK
);
640 match_set_dl_tci_masked(match
, htons(0), htons(0));
644 /* Modifies 'match' depending on 'dl_vlan':
646 * - If 'dl_vlan' is htons(OFP_VLAN_NONE), makes 'match' match only packets
647 * without an 802.1Q header.
649 * - Otherwise, makes 'match' match only packets with an 802.1Q header whose
650 * VID equals the low 12 bits of 'dl_vlan'.
653 match_set_dl_vlan(struct match
*match
, ovs_be16 dl_vlan
)
655 flow_set_dl_vlan(&match
->flow
, dl_vlan
);
656 if (dl_vlan
== htons(OFP10_VLAN_NONE
)) {
657 match
->wc
.masks
.vlans
[0].tci
= OVS_BE16_MAX
;
659 match
->wc
.masks
.vlans
[0].tci
|= htons(VLAN_VID_MASK
| VLAN_CFI
);
663 /* Sets the VLAN VID that 'match' matches to 'vid', which is interpreted as an
664 * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
667 match_set_vlan_vid(struct match
*match
, ovs_be16 vid
)
669 match_set_vlan_vid_masked(match
, vid
, htons(VLAN_VID_MASK
| VLAN_CFI
));
673 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
674 * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
675 * plus CFI), with the corresponding 'mask'. */
677 match_set_vlan_vid_masked(struct match
*match
, ovs_be16 vid
, ovs_be16 mask
)
679 ovs_be16 pcp_mask
= htons(VLAN_PCP_MASK
);
680 ovs_be16 vid_mask
= htons(VLAN_VID_MASK
| VLAN_CFI
);
683 flow_set_vlan_vid(&match
->flow
, vid
& mask
);
684 match
->wc
.masks
.vlans
[0].tci
=
685 mask
| (match
->wc
.masks
.vlans
[0].tci
& pcp_mask
);
688 /* Modifies 'match' so that the VLAN PCP is wildcarded. If the VID is already
689 * wildcarded, then 'match' will match a packet regardless of whether it has an
690 * 802.1Q header or not. */
692 match_set_any_pcp(struct match
*match
)
694 if (match
->wc
.masks
.vlans
[0].tci
& htons(VLAN_VID_MASK
)) {
695 match
->wc
.masks
.vlans
[0].tci
&= ~htons(VLAN_PCP_MASK
);
696 match
->flow
.vlans
[0].tci
&= ~htons(VLAN_PCP_MASK
);
698 match_set_dl_tci_masked(match
, htons(0), htons(0));
702 /* Modifies 'match' so that it matches only packets with an 802.1Q header whose
703 * PCP equals the low 3 bits of 'dl_vlan_pcp'. */
705 match_set_dl_vlan_pcp(struct match
*match
, uint8_t dl_vlan_pcp
)
707 flow_set_vlan_pcp(&match
->flow
, dl_vlan_pcp
);
708 match
->wc
.masks
.vlans
[0].tci
|= htons(VLAN_CFI
| VLAN_PCP_MASK
);
711 /* Modifies 'match' so that the MPLS label 'idx' matches 'lse' exactly. */
713 match_set_mpls_lse(struct match
*match
, int idx
, ovs_be32 lse
)
715 match
->wc
.masks
.mpls_lse
[idx
] = OVS_BE32_MAX
;
716 match
->flow
.mpls_lse
[idx
] = lse
;
719 /* Modifies 'match' so that the MPLS label is wildcarded. */
721 match_set_any_mpls_label(struct match
*match
, int idx
)
723 match
->wc
.masks
.mpls_lse
[idx
] &= ~htonl(MPLS_LABEL_MASK
);
724 flow_set_mpls_label(&match
->flow
, idx
, htonl(0));
727 /* Modifies 'match' so that it matches only packets with an MPLS header whose
728 * label equals the low 20 bits of 'mpls_label'. */
730 match_set_mpls_label(struct match
*match
, int idx
, ovs_be32 mpls_label
)
732 match
->wc
.masks
.mpls_lse
[idx
] |= htonl(MPLS_LABEL_MASK
);
733 flow_set_mpls_label(&match
->flow
, idx
, mpls_label
);
736 /* Modifies 'match' so that the MPLS TC is wildcarded. */
738 match_set_any_mpls_tc(struct match
*match
, int idx
)
740 match
->wc
.masks
.mpls_lse
[idx
] &= ~htonl(MPLS_TC_MASK
);
741 flow_set_mpls_tc(&match
->flow
, idx
, 0);
744 /* Modifies 'match' so that it matches only packets with an MPLS header whose
745 * Traffic Class equals the low 3 bits of 'mpls_tc'. */
747 match_set_mpls_tc(struct match
*match
, int idx
, uint8_t mpls_tc
)
749 match
->wc
.masks
.mpls_lse
[idx
] |= htonl(MPLS_TC_MASK
);
750 flow_set_mpls_tc(&match
->flow
, idx
, mpls_tc
);
753 /* Modifies 'match' so that the MPLS stack flag is wildcarded. */
755 match_set_any_mpls_bos(struct match
*match
, int idx
)
757 match
->wc
.masks
.mpls_lse
[idx
] &= ~htonl(MPLS_BOS_MASK
);
758 flow_set_mpls_bos(&match
->flow
, idx
, 0);
761 /* Modifies 'match' so that it matches only packets with an MPLS header whose
762 * Stack Flag equals the lower bit of 'mpls_bos' */
764 match_set_mpls_bos(struct match
*match
, int idx
, uint8_t mpls_bos
)
766 match
->wc
.masks
.mpls_lse
[idx
] |= htonl(MPLS_BOS_MASK
);
767 flow_set_mpls_bos(&match
->flow
, idx
, mpls_bos
);
770 /* Modifies 'match' so that the TTL of MPLS label 'idx' is wildcarded. */
772 match_set_any_mpls_ttl(struct match
*match
, int idx
)
774 match
->wc
.masks
.mpls_lse
[idx
] &= ~htonl(MPLS_TTL_MASK
);
775 flow_set_mpls_ttl(&match
->flow
, idx
, 0);
778 /* Modifies 'match' so that it matches only packets in which the TTL of MPLS
779 * label 'idx' equals 'mpls_ttl'. */
781 match_set_mpls_ttl(struct match
*match
, int idx
, uint8_t mpls_ttl
)
783 match
->wc
.masks
.mpls_lse
[idx
] |= htonl(MPLS_TTL_MASK
);
784 flow_set_mpls_ttl(&match
->flow
, idx
, mpls_ttl
);
787 /* Modifies 'match' so that the MPLS LSE is wildcarded. */
789 match_set_any_mpls_lse(struct match
*match
, int idx
)
791 match
->wc
.masks
.mpls_lse
[idx
] = htonl(0);
792 flow_set_mpls_lse(&match
->flow
, idx
, htonl(0));
796 match_set_tp_src(struct match
*match
, ovs_be16 tp_src
)
798 match_set_tp_src_masked(match
, tp_src
, OVS_BE16_MAX
);
802 match_set_tp_src_masked(struct match
*match
, ovs_be16 port
, ovs_be16 mask
)
804 match
->flow
.tp_src
= port
& mask
;
805 match
->wc
.masks
.tp_src
= mask
;
809 match_set_tp_dst(struct match
*match
, ovs_be16 tp_dst
)
811 match_set_tp_dst_masked(match
, tp_dst
, OVS_BE16_MAX
);
815 match_set_tp_dst_masked(struct match
*match
, ovs_be16 port
, ovs_be16 mask
)
817 match
->flow
.tp_dst
= port
& mask
;
818 match
->wc
.masks
.tp_dst
= mask
;
822 match_set_tcp_flags(struct match
*match
, ovs_be16 flags
)
824 match_set_tcp_flags_masked(match
, flags
, OVS_BE16_MAX
);
828 match_set_tcp_flags_masked(struct match
*match
, ovs_be16 flags
, ovs_be16 mask
)
830 match
->flow
.tcp_flags
= flags
& mask
;
831 match
->wc
.masks
.tcp_flags
= mask
;
835 match_set_nw_proto(struct match
*match
, uint8_t nw_proto
)
837 match
->flow
.nw_proto
= nw_proto
;
838 match
->wc
.masks
.nw_proto
= UINT8_MAX
;
842 match_set_nw_src(struct match
*match
, ovs_be32 nw_src
)
844 match
->flow
.nw_src
= nw_src
;
845 match
->wc
.masks
.nw_src
= OVS_BE32_MAX
;
849 match_set_nw_src_masked(struct match
*match
,
850 ovs_be32 nw_src
, ovs_be32 mask
)
852 match
->flow
.nw_src
= nw_src
& mask
;
853 match
->wc
.masks
.nw_src
= mask
;
857 match_set_nw_dst(struct match
*match
, ovs_be32 nw_dst
)
859 match
->flow
.nw_dst
= nw_dst
;
860 match
->wc
.masks
.nw_dst
= OVS_BE32_MAX
;
864 match_set_nw_dst_masked(struct match
*match
, ovs_be32 ip
, ovs_be32 mask
)
866 match
->flow
.nw_dst
= ip
& mask
;
867 match
->wc
.masks
.nw_dst
= mask
;
871 match_set_nw_dscp(struct match
*match
, uint8_t nw_dscp
)
873 match
->wc
.masks
.nw_tos
|= IP_DSCP_MASK
;
874 match
->flow
.nw_tos
&= ~IP_DSCP_MASK
;
875 match
->flow
.nw_tos
|= nw_dscp
& IP_DSCP_MASK
;
879 match_set_nw_ecn(struct match
*match
, uint8_t nw_ecn
)
881 match
->wc
.masks
.nw_tos
|= IP_ECN_MASK
;
882 match
->flow
.nw_tos
&= ~IP_ECN_MASK
;
883 match
->flow
.nw_tos
|= nw_ecn
& IP_ECN_MASK
;
887 match_set_nw_ttl(struct match
*match
, uint8_t nw_ttl
)
889 match
->wc
.masks
.nw_ttl
= UINT8_MAX
;
890 match
->flow
.nw_ttl
= nw_ttl
;
894 match_set_nw_ttl_masked(struct match
*match
, uint8_t nw_ttl
, uint8_t mask
)
896 match
->flow
.nw_ttl
= nw_ttl
& mask
;
897 match
->wc
.masks
.nw_ttl
= mask
;
901 match_set_nw_frag(struct match
*match
, uint8_t nw_frag
)
903 match
->wc
.masks
.nw_frag
|= FLOW_NW_FRAG_MASK
;
904 match
->flow
.nw_frag
= nw_frag
;
908 match_set_nw_frag_masked(struct match
*match
,
909 uint8_t nw_frag
, uint8_t mask
)
911 match
->flow
.nw_frag
= nw_frag
& mask
;
912 match
->wc
.masks
.nw_frag
= mask
;
916 match_set_icmp_type(struct match
*match
, uint8_t icmp_type
)
918 match_set_tp_src(match
, htons(icmp_type
));
922 match_set_icmp_code(struct match
*match
, uint8_t icmp_code
)
924 match_set_tp_dst(match
, htons(icmp_code
));
928 match_set_arp_sha(struct match
*match
, const struct eth_addr sha
)
930 match
->flow
.arp_sha
= sha
;
931 match
->wc
.masks
.arp_sha
= eth_addr_exact
;
935 match_set_arp_sha_masked(struct match
*match
,
936 const struct eth_addr arp_sha
,
937 const struct eth_addr mask
)
939 set_eth_masked(arp_sha
, mask
,
940 &match
->flow
.arp_sha
, &match
->wc
.masks
.arp_sha
);
944 match_set_arp_tha(struct match
*match
, const struct eth_addr tha
)
946 match
->flow
.arp_tha
= tha
;
947 match
->wc
.masks
.arp_tha
= eth_addr_exact
;
951 match_set_arp_tha_masked(struct match
*match
,
952 const struct eth_addr arp_tha
,
953 const struct eth_addr mask
)
955 set_eth_masked(arp_tha
, mask
,
956 &match
->flow
.arp_tha
, &match
->wc
.masks
.arp_tha
);
960 match_set_ipv6_src(struct match
*match
, const struct in6_addr
*src
)
962 match
->flow
.ipv6_src
= *src
;
963 match
->wc
.masks
.ipv6_src
= in6addr_exact
;
967 match_set_ipv6_src_masked(struct match
*match
, const struct in6_addr
*src
,
968 const struct in6_addr
*mask
)
970 match
->flow
.ipv6_src
= ipv6_addr_bitand(src
, mask
);
971 match
->wc
.masks
.ipv6_src
= *mask
;
975 match_set_ipv6_dst(struct match
*match
, const struct in6_addr
*dst
)
977 match
->flow
.ipv6_dst
= *dst
;
978 match
->wc
.masks
.ipv6_dst
= in6addr_exact
;
982 match_set_ipv6_dst_masked(struct match
*match
, const struct in6_addr
*dst
,
983 const struct in6_addr
*mask
)
985 match
->flow
.ipv6_dst
= ipv6_addr_bitand(dst
, mask
);
986 match
->wc
.masks
.ipv6_dst
= *mask
;
990 match_set_ipv6_label(struct match
*match
, ovs_be32 ipv6_label
)
992 match
->wc
.masks
.ipv6_label
= OVS_BE32_MAX
;
993 match
->flow
.ipv6_label
= ipv6_label
;
998 match_set_ipv6_label_masked(struct match
*match
, ovs_be32 ipv6_label
,
1001 match
->flow
.ipv6_label
= ipv6_label
& mask
;
1002 match
->wc
.masks
.ipv6_label
= mask
;
1006 match_set_nd_target(struct match
*match
, const struct in6_addr
*target
)
1008 match
->flow
.nd_target
= *target
;
1009 match
->wc
.masks
.nd_target
= in6addr_exact
;
1013 match_set_nd_target_masked(struct match
*match
,
1014 const struct in6_addr
*target
,
1015 const struct in6_addr
*mask
)
1017 match
->flow
.nd_target
= ipv6_addr_bitand(target
, mask
);
1018 match
->wc
.masks
.nd_target
= *mask
;
1021 /* Returns true if 'a' and 'b' wildcard the same fields and have the same
1022 * values for fixed fields, otherwise false. */
1024 match_equal(const struct match
*a
, const struct match
*b
)
1026 return (flow_wildcards_equal(&a
->wc
, &b
->wc
)
1027 && flow_equal(&a
->flow
, &b
->flow
));
1030 /* Returns a hash value for the flow and wildcards in 'match', starting from
1033 match_hash(const struct match
*match
, uint32_t basis
)
1035 return flow_wildcards_hash(&match
->wc
, flow_hash(&match
->flow
, basis
));
1039 match_has_default_recirc_id(const struct match
*m
)
1041 return m
->flow
.recirc_id
== 0 && (m
->wc
.masks
.recirc_id
== UINT32_MAX
||
1042 m
->wc
.masks
.recirc_id
== 0);
1046 match_has_default_dp_hash(const struct match
*m
)
1048 return ((m
->flow
.dp_hash
| m
->wc
.masks
.dp_hash
) == 0);
1051 /* Return true if the hidden fields of the match are set to the default values.
1052 * The default values equals to those set up by match_init_hidden_fields(). */
1054 match_has_default_hidden_fields(const struct match
*m
)
1056 return match_has_default_recirc_id(m
) && match_has_default_dp_hash(m
);
1060 match_init_hidden_fields(struct match
*m
)
1062 match_set_recirc_id(m
, 0);
1063 match_set_dp_hash_masked(m
, 0, 0);
1067 format_eth_masked(struct ds
*s
, const char *name
,
1068 const struct eth_addr eth
, const struct eth_addr mask
)
1070 if (!eth_addr_is_zero(mask
)) {
1071 ds_put_format(s
, "%s%s=%s", colors
.param
, name
, colors
.end
);
1072 eth_format_masked(eth
, &mask
, s
);
1073 ds_put_char(s
, ',');
1078 format_ip_netmask(struct ds
*s
, const char *name
, ovs_be32 ip
,
1082 ds_put_format(s
, "%s%s=%s", colors
.param
, name
, colors
.end
);
1083 ip_format_masked(ip
, netmask
, s
);
1084 ds_put_char(s
, ',');
1089 format_ipv6_netmask(struct ds
*s
, const char *name
,
1090 const struct in6_addr
*addr
,
1091 const struct in6_addr
*netmask
)
1093 if (!ipv6_mask_is_any(netmask
)) {
1094 ds_put_format(s
, "%s%s=%s", colors
.param
, name
, colors
.end
);
1095 ipv6_format_masked(addr
, netmask
, s
);
1096 ds_put_char(s
, ',');
1101 format_uint8_masked(struct ds
*s
, const char *name
,
1102 uint8_t value
, uint8_t mask
)
1105 ds_put_format(s
, "%s%s=%s", colors
.param
, name
, colors
.end
);
1106 if (mask
== UINT8_MAX
) {
1107 ds_put_format(s
, "%"PRIu8
, value
);
1109 ds_put_format(s
, "0x%02"PRIx8
"/0x%02"PRIx8
, value
, mask
);
1111 ds_put_char(s
, ',');
1116 format_uint16_masked(struct ds
*s
, const char *name
,
1117 uint16_t value
, uint16_t mask
)
1120 ds_put_format(s
, "%s%s=%s", colors
.param
, name
, colors
.end
);
1121 if (mask
== UINT16_MAX
) {
1122 ds_put_format(s
, "%"PRIu16
, value
);
1124 ds_put_format(s
, "0x%"PRIx16
"/0x%"PRIx16
, value
, mask
);
1126 ds_put_char(s
, ',');
1131 format_be16_masked(struct ds
*s
, const char *name
,
1132 ovs_be16 value
, ovs_be16 mask
)
1134 if (mask
!= htons(0)) {
1135 ds_put_format(s
, "%s%s=%s", colors
.param
, name
, colors
.end
);
1136 if (mask
== OVS_BE16_MAX
) {
1137 ds_put_format(s
, "%"PRIu16
, ntohs(value
));
1139 ds_put_format(s
, "0x%"PRIx16
"/0x%"PRIx16
,
1140 ntohs(value
), ntohs(mask
));
1142 ds_put_char(s
, ',');
1147 format_be32_masked(struct ds
*s
, const char *name
,
1148 ovs_be32 value
, ovs_be32 mask
)
1150 if (mask
!= htonl(0)) {
1151 ds_put_format(s
, "%s%s=%s", colors
.param
, name
, colors
.end
);
1152 if (mask
== OVS_BE32_MAX
) {
1153 ds_put_format(s
, "%"PRIu32
, ntohl(value
));
1155 ds_put_format(s
, "0x%08"PRIx32
"/0x%08"PRIx32
,
1156 ntohl(value
), ntohl(mask
));
1158 ds_put_char(s
, ',');
1163 format_be32_masked_hex(struct ds
*s
, const char *name
,
1164 ovs_be32 value
, ovs_be32 mask
)
1166 if (mask
!= htonl(0)) {
1167 ds_put_format(s
, "%s%s=%s", colors
.param
, name
, colors
.end
);
1168 if (mask
== OVS_BE32_MAX
) {
1169 ds_put_format(s
, "0x%"PRIx32
, ntohl(value
));
1171 ds_put_format(s
, "0x%"PRIx32
"/0x%"PRIx32
,
1172 ntohl(value
), ntohl(mask
));
1174 ds_put_char(s
, ',');
1179 format_uint32_masked(struct ds
*s
, const char *name
,
1180 uint32_t value
, uint32_t mask
)
1183 ds_put_format(s
, "%s%s=%s%#"PRIx32
,
1184 colors
.param
, name
, colors
.end
, value
);
1185 if (mask
!= UINT32_MAX
) {
1186 ds_put_format(s
, "/%#"PRIx32
, mask
);
1188 ds_put_char(s
, ',');
1193 format_be64_masked(struct ds
*s
, const char *name
,
1194 ovs_be64 value
, ovs_be64 mask
)
1196 if (mask
!= htonll(0)) {
1197 ds_put_format(s
, "%s%s=%s%#"PRIx64
,
1198 colors
.param
, name
, colors
.end
, ntohll(value
));
1199 if (mask
!= OVS_BE64_MAX
) {
1200 ds_put_format(s
, "/%#"PRIx64
, ntohll(mask
));
1202 ds_put_char(s
, ',');
1207 format_flow_tunnel(struct ds
*s
, const struct match
*match
)
1209 const struct flow_wildcards
*wc
= &match
->wc
;
1210 const struct flow_tnl
*tnl
= &match
->flow
.tunnel
;
1212 format_be64_masked(s
, "tun_id", tnl
->tun_id
, wc
->masks
.tunnel
.tun_id
);
1213 format_ip_netmask(s
, "tun_src", tnl
->ip_src
, wc
->masks
.tunnel
.ip_src
);
1214 format_ip_netmask(s
, "tun_dst", tnl
->ip_dst
, wc
->masks
.tunnel
.ip_dst
);
1215 format_ipv6_netmask(s
, "tun_ipv6_src", &tnl
->ipv6_src
,
1216 &wc
->masks
.tunnel
.ipv6_src
);
1217 format_ipv6_netmask(s
, "tun_ipv6_dst", &tnl
->ipv6_dst
,
1218 &wc
->masks
.tunnel
.ipv6_dst
);
1220 if (wc
->masks
.tunnel
.gbp_id
) {
1221 format_be16_masked(s
, "tun_gbp_id", tnl
->gbp_id
,
1222 wc
->masks
.tunnel
.gbp_id
);
1225 if (wc
->masks
.tunnel
.gbp_flags
) {
1226 ds_put_format(s
, "tun_gbp_flags=%#"PRIx8
",", tnl
->gbp_flags
);
1229 if (wc
->masks
.tunnel
.ip_tos
) {
1230 ds_put_format(s
, "tun_tos=%"PRIx8
",", tnl
->ip_tos
);
1232 if (wc
->masks
.tunnel
.ip_ttl
) {
1233 ds_put_format(s
, "tun_ttl=%"PRIu8
",", tnl
->ip_ttl
);
1235 if (wc
->masks
.tunnel
.flags
& FLOW_TNL_F_MASK
) {
1236 format_flags_masked(s
, "tun_flags", flow_tun_flag_to_string
,
1237 tnl
->flags
& FLOW_TNL_F_MASK
,
1238 wc
->masks
.tunnel
.flags
& FLOW_TNL_F_MASK
,
1240 ds_put_char(s
, ',');
1242 tun_metadata_match_format(s
, match
);
1246 format_ct_label_masked(struct ds
*s
, const ovs_u128
*key
, const ovs_u128
*mask
)
1248 if (!ovs_u128_is_zero(*mask
)) {
1249 ovs_be128 value
= hton128(*key
);
1250 ds_put_format(s
, "%sct_label=%s", colors
.param
, colors
.end
);
1251 ds_put_hex(s
, &value
, sizeof value
);
1252 if (!is_all_ones(mask
, sizeof(*mask
))) {
1253 value
= hton128(*mask
);
1254 ds_put_char(s
, '/');
1255 ds_put_hex(s
, &value
, sizeof value
);
1257 ds_put_char(s
, ',');
1262 format_nsh_masked(struct ds
*s
, const struct flow
*f
, const struct flow
*m
)
1264 ovs_be32 spi_mask
= nsh_path_hdr_to_spi(m
->nsh
.path_hdr
);
1265 if (spi_mask
== htonl(NSH_SPI_MASK
>> NSH_SPI_SHIFT
)) {
1266 spi_mask
= OVS_BE32_MAX
;
1268 format_uint8_masked(s
, "nsh_flags", f
->nsh
.flags
, m
->nsh
.flags
);
1269 format_uint8_masked(s
, "nsh_ttl", f
->nsh
.ttl
, m
->nsh
.ttl
);
1270 format_uint8_masked(s
, "nsh_mdtype", f
->nsh
.mdtype
, m
->nsh
.mdtype
);
1271 format_uint8_masked(s
, "nsh_np", f
->nsh
.np
, m
->nsh
.np
);
1273 format_be32_masked_hex(s
, "nsh_spi", nsh_path_hdr_to_spi(f
->nsh
.path_hdr
),
1275 format_uint8_masked(s
, "nsh_si", nsh_path_hdr_to_si(f
->nsh
.path_hdr
),
1276 nsh_path_hdr_to_si(m
->nsh
.path_hdr
));
1277 if (m
->nsh
.mdtype
== UINT8_MAX
&& f
->nsh
.mdtype
== NSH_M_TYPE1
) {
1278 format_be32_masked_hex(s
, "nsh_c1", f
->nsh
.context
[0],
1280 format_be32_masked_hex(s
, "nsh_c2", f
->nsh
.context
[1],
1282 format_be32_masked_hex(s
, "nsh_c3", f
->nsh
.context
[2],
1284 format_be32_masked_hex(s
, "nsh_c4", f
->nsh
.context
[3],
1289 /* Appends a string representation of 'match' to 's'. If 'priority' is
1290 * different from OFP_DEFAULT_PRIORITY, includes it in 's'. If 'port_map' is
1291 * nonnull, uses it to translate port numbers to names in output. */
1293 match_format(const struct match
*match
,
1294 const struct ofputil_port_map
*port_map
,
1295 struct ds
*s
, int priority
)
1297 const struct flow_wildcards
*wc
= &match
->wc
;
1298 size_t start_len
= s
->length
;
1299 const struct flow
*f
= &match
->flow
;
1300 bool skip_type
= false;
1301 bool skip_proto
= false;
1302 ovs_be16 dl_type
= f
->dl_type
;
1303 bool is_megaflow
= false;
1306 BUILD_ASSERT_DECL(FLOW_WC_SEQ
== 40);
1308 if (priority
!= OFP_DEFAULT_PRIORITY
) {
1309 ds_put_format(s
, "%spriority=%s%d,",
1310 colors
.special
, colors
.end
, priority
);
1313 format_uint32_masked(s
, "pkt_mark", f
->pkt_mark
, wc
->masks
.pkt_mark
);
1315 if (wc
->masks
.recirc_id
) {
1316 format_uint32_masked(s
, "recirc_id", f
->recirc_id
,
1317 wc
->masks
.recirc_id
);
1321 if (wc
->masks
.dp_hash
) {
1322 format_uint32_masked(s
, "dp_hash", f
->dp_hash
,
1326 if (wc
->masks
.conj_id
) {
1327 ds_put_format(s
, "%sconj_id%s=%"PRIu32
",",
1328 colors
.param
, colors
.end
, f
->conj_id
);
1331 if (wc
->masks
.skb_priority
) {
1332 ds_put_format(s
, "%sskb_priority=%s%#"PRIx32
",",
1333 colors
.param
, colors
.end
, f
->skb_priority
);
1336 if (wc
->masks
.actset_output
) {
1337 ds_put_format(s
, "%sactset_output=%s", colors
.param
, colors
.end
);
1338 ofputil_format_port(f
->actset_output
, port_map
, s
);
1339 ds_put_char(s
, ',');
1342 if (wc
->masks
.ct_state
) {
1343 if (wc
->masks
.ct_state
== UINT8_MAX
) {
1344 ds_put_format(s
, "%sct_state=%s", colors
.param
, colors
.end
);
1346 format_flags(s
, ct_state_to_string
, f
->ct_state
, '|');
1348 ds_put_cstr(s
, "0"); /* No state. */
1351 format_flags_masked(s
, "ct_state", ct_state_to_string
,
1352 f
->ct_state
, wc
->masks
.ct_state
, UINT8_MAX
);
1354 ds_put_char(s
, ',');
1357 if (wc
->masks
.ct_zone
) {
1358 format_uint16_masked(s
, "ct_zone", f
->ct_zone
, wc
->masks
.ct_zone
);
1361 if (wc
->masks
.ct_mark
) {
1362 format_uint32_masked(s
, "ct_mark", f
->ct_mark
, wc
->masks
.ct_mark
);
1365 if (!ovs_u128_is_zero(wc
->masks
.ct_label
)) {
1366 format_ct_label_masked(s
, &f
->ct_label
, &wc
->masks
.ct_label
);
1369 format_ip_netmask(s
, "ct_nw_src", f
->ct_nw_src
,
1370 wc
->masks
.ct_nw_src
);
1371 format_ipv6_netmask(s
, "ct_ipv6_src", &f
->ct_ipv6_src
,
1372 &wc
->masks
.ct_ipv6_src
);
1373 format_ip_netmask(s
, "ct_nw_dst", f
->ct_nw_dst
,
1374 wc
->masks
.ct_nw_dst
);
1375 format_ipv6_netmask(s
, "ct_ipv6_dst", &f
->ct_ipv6_dst
,
1376 &wc
->masks
.ct_ipv6_dst
);
1377 if (wc
->masks
.ct_nw_proto
) {
1378 ds_put_format(s
, "%sct_nw_proto=%s%"PRIu8
",",
1379 colors
.param
, colors
.end
, f
->ct_nw_proto
);
1380 format_be16_masked(s
, "ct_tp_src", f
->ct_tp_src
, wc
->masks
.ct_tp_src
);
1381 format_be16_masked(s
, "ct_tp_dst", f
->ct_tp_dst
, wc
->masks
.ct_tp_dst
);
1384 if (wc
->masks
.packet_type
&&
1385 (!match_has_default_packet_type(match
) || is_megaflow
)) {
1386 format_packet_type_masked(s
, f
->packet_type
, wc
->masks
.packet_type
);
1387 ds_put_char(s
, ',');
1388 if (pt_ns(f
->packet_type
) == OFPHTN_ETHERTYPE
) {
1389 dl_type
= pt_ns_type_be(f
->packet_type
);
1393 if (wc
->masks
.dl_type
) {
1395 if (dl_type
== htons(ETH_TYPE_IP
)) {
1396 if (wc
->masks
.nw_proto
) {
1398 if (f
->nw_proto
== IPPROTO_ICMP
) {
1399 ds_put_format(s
, "%sicmp%s,", colors
.value
, colors
.end
);
1400 } else if (f
->nw_proto
== IPPROTO_IGMP
) {
1401 ds_put_format(s
, "%sigmp%s,", colors
.value
, colors
.end
);
1402 } else if (f
->nw_proto
== IPPROTO_TCP
) {
1403 ds_put_format(s
, "%stcp%s,", colors
.value
, colors
.end
);
1404 } else if (f
->nw_proto
== IPPROTO_UDP
) {
1405 ds_put_format(s
, "%sudp%s,", colors
.value
, colors
.end
);
1406 } else if (f
->nw_proto
== IPPROTO_SCTP
) {
1407 ds_put_format(s
, "%ssctp%s,", colors
.value
, colors
.end
);
1409 ds_put_format(s
, "%sip%s,", colors
.value
, colors
.end
);
1413 ds_put_format(s
, "%sip%s,", colors
.value
, colors
.end
);
1415 } else if (dl_type
== htons(ETH_TYPE_IPV6
)) {
1416 if (wc
->masks
.nw_proto
) {
1418 if (f
->nw_proto
== IPPROTO_ICMPV6
) {
1419 ds_put_format(s
, "%sicmp6%s,", colors
.value
, colors
.end
);
1420 } else if (f
->nw_proto
== IPPROTO_TCP
) {
1421 ds_put_format(s
, "%stcp6%s,", colors
.value
, colors
.end
);
1422 } else if (f
->nw_proto
== IPPROTO_UDP
) {
1423 ds_put_format(s
, "%sudp6%s,", colors
.value
, colors
.end
);
1424 } else if (f
->nw_proto
== IPPROTO_SCTP
) {
1425 ds_put_format(s
, "%ssctp6%s,", colors
.value
, colors
.end
);
1427 ds_put_format(s
, "%sipv6%s,", colors
.value
, colors
.end
);
1431 ds_put_format(s
, "%sipv6%s,", colors
.value
, colors
.end
);
1433 } else if (dl_type
== htons(ETH_TYPE_ARP
)) {
1434 ds_put_format(s
, "%sarp%s,", colors
.value
, colors
.end
);
1435 } else if (dl_type
== htons(ETH_TYPE_RARP
)) {
1436 ds_put_format(s
, "%srarp%s,", colors
.value
, colors
.end
);
1437 } else if (dl_type
== htons(ETH_TYPE_MPLS
)) {
1438 ds_put_format(s
, "%smpls%s,", colors
.value
, colors
.end
);
1439 } else if (dl_type
== htons(ETH_TYPE_MPLS_MCAST
)) {
1440 ds_put_format(s
, "%smplsm%s,", colors
.value
, colors
.end
);
1445 for (i
= 0; i
< FLOW_N_REGS
; i
++) {
1446 #define REGNAME_LEN 20
1447 char regname
[REGNAME_LEN
];
1448 if (snprintf(regname
, REGNAME_LEN
, "reg%d", i
) >= REGNAME_LEN
) {
1449 strcpy(regname
, "reg?");
1451 format_uint32_masked(s
, regname
, f
->regs
[i
], wc
->masks
.regs
[i
]);
1454 format_flow_tunnel(s
, match
);
1456 format_be64_masked(s
, "metadata", f
->metadata
, wc
->masks
.metadata
);
1458 if (wc
->masks
.in_port
.ofp_port
) {
1459 ds_put_format(s
, "%sin_port=%s", colors
.param
, colors
.end
);
1460 ofputil_format_port(f
->in_port
.ofp_port
, port_map
, s
);
1461 ds_put_char(s
, ',');
1463 for (i
= 0; i
< FLOW_MAX_VLAN_HEADERS
; i
++) {
1466 if (!wc
->masks
.vlans
[i
].tci
) {
1470 /* Print VLAN tags as dl_vlan, dl_vlan1, dl_vlan2 ... */
1474 snprintf(str_i
, sizeof(str_i
), "%d", i
);
1476 ovs_be16 vid_mask
= wc
->masks
.vlans
[i
].tci
& htons(VLAN_VID_MASK
);
1477 ovs_be16 pcp_mask
= wc
->masks
.vlans
[i
].tci
& htons(VLAN_PCP_MASK
);
1478 ovs_be16 cfi
= wc
->masks
.vlans
[i
].tci
& htons(VLAN_CFI
);
1480 if (cfi
&& f
->vlans
[i
].tci
& htons(VLAN_CFI
)
1481 && (!vid_mask
|| vid_mask
== htons(VLAN_VID_MASK
))
1482 && (!pcp_mask
|| pcp_mask
== htons(VLAN_PCP_MASK
))
1483 && (vid_mask
|| pcp_mask
)) {
1485 ds_put_format(s
, "%sdl_vlan%s=%s%"PRIu16
",",
1486 colors
.param
, str_i
, colors
.end
,
1487 vlan_tci_to_vid(f
->vlans
[i
].tci
));
1490 ds_put_format(s
, "%sdl_vlan_pcp%s=%s%d,",
1491 colors
.param
, str_i
, colors
.end
,
1492 vlan_tci_to_pcp(f
->vlans
[i
].tci
));
1494 } else if (wc
->masks
.vlans
[i
].tci
== htons(0xffff)) {
1495 ds_put_format(s
, "%svlan_tci%s=%s0x%04"PRIx16
",",
1496 colors
.param
, str_i
, colors
.end
,
1497 ntohs(f
->vlans
[i
].tci
));
1499 ds_put_format(s
, "%svlan_tci%s=%s0x%04"PRIx16
"/0x%04"PRIx16
",",
1500 colors
.param
, str_i
, colors
.end
,
1501 ntohs(f
->vlans
[i
].tci
),
1502 ntohs(wc
->masks
.vlans
[i
].tci
));
1506 format_eth_masked(s
, "dl_src", f
->dl_src
, wc
->masks
.dl_src
);
1507 format_eth_masked(s
, "dl_dst", f
->dl_dst
, wc
->masks
.dl_dst
);
1509 if (!skip_type
&& wc
->masks
.dl_type
) {
1510 ds_put_format(s
, "%sdl_type=%s0x%04"PRIx16
",",
1511 colors
.param
, colors
.end
, ntohs(dl_type
));
1513 if (dl_type
== htons(ETH_TYPE_IPV6
)) {
1514 format_ipv6_netmask(s
, "ipv6_src", &f
->ipv6_src
, &wc
->masks
.ipv6_src
);
1515 format_ipv6_netmask(s
, "ipv6_dst", &f
->ipv6_dst
, &wc
->masks
.ipv6_dst
);
1516 if (wc
->masks
.ipv6_label
) {
1517 if (wc
->masks
.ipv6_label
== OVS_BE32_MAX
) {
1518 ds_put_format(s
, "%sipv6_label=%s0x%05"PRIx32
",",
1519 colors
.param
, colors
.end
,
1520 ntohl(f
->ipv6_label
));
1522 ds_put_format(s
, "%sipv6_label=%s0x%05"PRIx32
"/0x%05"PRIx32
",",
1523 colors
.param
, colors
.end
, ntohl(f
->ipv6_label
),
1524 ntohl(wc
->masks
.ipv6_label
));
1527 } else if (dl_type
== htons(ETH_TYPE_ARP
) ||
1528 dl_type
== htons(ETH_TYPE_RARP
)) {
1529 format_ip_netmask(s
, "arp_spa", f
->nw_src
, wc
->masks
.nw_src
);
1530 format_ip_netmask(s
, "arp_tpa", f
->nw_dst
, wc
->masks
.nw_dst
);
1531 } else if (dl_type
== htons(ETH_TYPE_NSH
)) {
1532 format_nsh_masked(s
, f
, &wc
->masks
);
1534 format_ip_netmask(s
, "nw_src", f
->nw_src
, wc
->masks
.nw_src
);
1535 format_ip_netmask(s
, "nw_dst", f
->nw_dst
, wc
->masks
.nw_dst
);
1537 if (!skip_proto
&& wc
->masks
.nw_proto
) {
1538 if (dl_type
== htons(ETH_TYPE_ARP
) ||
1539 dl_type
== htons(ETH_TYPE_RARP
)) {
1540 ds_put_format(s
, "%sarp_op=%s%"PRIu8
",",
1541 colors
.param
, colors
.end
, f
->nw_proto
);
1543 ds_put_format(s
, "%snw_proto=%s%"PRIu8
",",
1544 colors
.param
, colors
.end
, f
->nw_proto
);
1547 if (dl_type
== htons(ETH_TYPE_ARP
) ||
1548 dl_type
== htons(ETH_TYPE_RARP
)) {
1549 format_eth_masked(s
, "arp_sha", f
->arp_sha
, wc
->masks
.arp_sha
);
1550 format_eth_masked(s
, "arp_tha", f
->arp_tha
, wc
->masks
.arp_tha
);
1552 if (wc
->masks
.nw_tos
& IP_DSCP_MASK
) {
1553 ds_put_format(s
, "%snw_tos=%s%d,",
1554 colors
.param
, colors
.end
, f
->nw_tos
& IP_DSCP_MASK
);
1556 if (wc
->masks
.nw_tos
& IP_ECN_MASK
) {
1557 ds_put_format(s
, "%snw_ecn=%s%d,",
1558 colors
.param
, colors
.end
, f
->nw_tos
& IP_ECN_MASK
);
1560 if (wc
->masks
.nw_ttl
) {
1561 ds_put_format(s
, "%snw_ttl=%s%d,",
1562 colors
.param
, colors
.end
, f
->nw_ttl
);
1564 if (wc
->masks
.mpls_lse
[0] & htonl(MPLS_LABEL_MASK
)) {
1565 ds_put_format(s
, "%smpls_label=%s%"PRIu32
",", colors
.param
,
1566 colors
.end
, mpls_lse_to_label(f
->mpls_lse
[0]));
1568 if (wc
->masks
.mpls_lse
[0] & htonl(MPLS_TC_MASK
)) {
1569 ds_put_format(s
, "%smpls_tc=%s%"PRIu8
",", colors
.param
, colors
.end
,
1570 mpls_lse_to_tc(f
->mpls_lse
[0]));
1572 if (wc
->masks
.mpls_lse
[0] & htonl(MPLS_TTL_MASK
)) {
1573 ds_put_format(s
, "%smpls_ttl=%s%"PRIu8
",", colors
.param
, colors
.end
,
1574 mpls_lse_to_ttl(f
->mpls_lse
[0]));
1576 if (wc
->masks
.mpls_lse
[0] & htonl(MPLS_BOS_MASK
)) {
1577 ds_put_format(s
, "%smpls_bos=%s%"PRIu8
",", colors
.param
, colors
.end
,
1578 mpls_lse_to_bos(f
->mpls_lse
[0]));
1580 format_be32_masked(s
, "mpls_lse1", f
->mpls_lse
[1], wc
->masks
.mpls_lse
[1]);
1581 format_be32_masked(s
, "mpls_lse2", f
->mpls_lse
[2], wc
->masks
.mpls_lse
[2]);
1583 switch (wc
->masks
.nw_frag
) {
1584 case FLOW_NW_FRAG_ANY
| FLOW_NW_FRAG_LATER
:
1585 ds_put_format(s
, "%snw_frag=%s%s,", colors
.param
, colors
.end
,
1586 f
->nw_frag
& FLOW_NW_FRAG_ANY
1587 ? (f
->nw_frag
& FLOW_NW_FRAG_LATER
? "later" : "first")
1588 : (f
->nw_frag
& FLOW_NW_FRAG_LATER
? "<error>" : "no"));
1591 case FLOW_NW_FRAG_ANY
:
1592 ds_put_format(s
, "%snw_frag=%s%s,", colors
.param
, colors
.end
,
1593 f
->nw_frag
& FLOW_NW_FRAG_ANY
? "yes" : "no");
1596 case FLOW_NW_FRAG_LATER
:
1597 ds_put_format(s
, "%snw_frag=%s%s,", colors
.param
, colors
.end
,
1598 f
->nw_frag
& FLOW_NW_FRAG_LATER
? "later" : "not_later");
1601 if (dl_type
== htons(ETH_TYPE_IP
) &&
1602 f
->nw_proto
== IPPROTO_ICMP
) {
1603 format_be16_masked(s
, "icmp_type", f
->tp_src
, wc
->masks
.tp_src
);
1604 format_be16_masked(s
, "icmp_code", f
->tp_dst
, wc
->masks
.tp_dst
);
1605 } else if (dl_type
== htons(ETH_TYPE_IP
) &&
1606 f
->nw_proto
== IPPROTO_IGMP
) {
1607 format_be16_masked(s
, "igmp_type", f
->tp_src
, wc
->masks
.tp_src
);
1608 format_be16_masked(s
, "igmp_code", f
->tp_dst
, wc
->masks
.tp_dst
);
1609 } else if (dl_type
== htons(ETH_TYPE_IPV6
) &&
1610 f
->nw_proto
== IPPROTO_ICMPV6
) {
1611 format_be16_masked(s
, "icmp_type", f
->tp_src
, wc
->masks
.tp_src
);
1612 format_be16_masked(s
, "icmp_code", f
->tp_dst
, wc
->masks
.tp_dst
);
1613 format_ipv6_netmask(s
, "nd_target", &f
->nd_target
,
1614 &wc
->masks
.nd_target
);
1615 format_eth_masked(s
, "nd_sll", f
->arp_sha
, wc
->masks
.arp_sha
);
1616 format_eth_masked(s
, "nd_tll", f
->arp_tha
, wc
->masks
.arp_tha
);
1618 format_be16_masked(s
, "tp_src", f
->tp_src
, wc
->masks
.tp_src
);
1619 format_be16_masked(s
, "tp_dst", f
->tp_dst
, wc
->masks
.tp_dst
);
1621 if (is_ip_any(f
) && f
->nw_proto
== IPPROTO_TCP
&& wc
->masks
.tcp_flags
) {
1622 format_flags_masked(s
, "tcp_flags", packet_tcp_flag_to_string
,
1623 ntohs(f
->tcp_flags
), TCP_FLAGS(wc
->masks
.tcp_flags
),
1624 TCP_FLAGS(OVS_BE16_MAX
));
1627 if (s
->length
> start_len
) {
1632 /* Converts 'match' to a string and returns the string. If 'priority' is
1633 * different from OFP_DEFAULT_PRIORITY, includes it in the string. If
1634 * 'port_map' is nonnull, uses it to translate port numbers to names in
1635 * output. The caller must free the string (with free()). */
1637 match_to_string(const struct match
*match
,
1638 const struct ofputil_port_map
*port_map
, int priority
)
1640 struct ds s
= DS_EMPTY_INITIALIZER
;
1641 match_format(match
, port_map
, &s
, priority
);
1642 return ds_steal_cstr(&s
);
1646 match_print(const struct match
*match
,
1647 const struct ofputil_port_map
*port_map
)
1649 char *s
= match_to_string(match
, port_map
, OFP_DEFAULT_PRIORITY
);
1654 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1655 * with minimatch_destroy(). */
1657 minimatch_init(struct minimatch
*dst
, const struct match
*src
)
1659 struct miniflow tmp
;
1661 miniflow_map_init(&tmp
, &src
->wc
.masks
);
1662 /* Allocate two consecutive miniflows. */
1663 miniflow_alloc(dst
->flows
, 2, &tmp
);
1664 miniflow_init(dst
->flow
, &src
->flow
);
1665 minimask_init(dst
->mask
, &src
->wc
);
1667 dst
->tun_md
= tun_metadata_allocation_clone(&src
->tun_md
);
1670 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1671 * with minimatch_destroy(). */
1673 minimatch_clone(struct minimatch
*dst
, const struct minimatch
*src
)
1675 /* Allocate two consecutive miniflows. */
1676 size_t data_size
= miniflow_alloc(dst
->flows
, 2, &src
->mask
->masks
);
1678 memcpy(miniflow_values(dst
->flow
),
1679 miniflow_get_values(src
->flow
), data_size
);
1680 memcpy(miniflow_values(&dst
->mask
->masks
),
1681 miniflow_get_values(&src
->mask
->masks
), data_size
);
1682 dst
->tun_md
= tun_metadata_allocation_clone(src
->tun_md
);
1685 /* Initializes 'dst' with the data in 'src', destroying 'src'. The caller must
1686 * eventually free 'dst' with minimatch_destroy(). */
1688 minimatch_move(struct minimatch
*dst
, struct minimatch
*src
)
1690 dst
->flow
= src
->flow
;
1691 dst
->mask
= src
->mask
;
1692 dst
->tun_md
= src
->tun_md
;
1695 /* Frees any memory owned by 'match'. Does not free the storage in which
1696 * 'match' itself resides; the caller is responsible for that. */
1698 minimatch_destroy(struct minimatch
*match
)
1701 free(match
->tun_md
);
1704 /* Initializes 'dst' as a copy of 'src'. */
1706 minimatch_expand(const struct minimatch
*src
, struct match
*dst
)
1708 miniflow_expand(src
->flow
, &dst
->flow
);
1709 minimask_expand(src
->mask
, &dst
->wc
);
1710 tun_metadata_allocation_copy(&dst
->tun_md
, src
->tun_md
);
1713 /* Returns true if 'a' and 'b' match the same packets, false otherwise. */
1715 minimatch_equal(const struct minimatch
*a
, const struct minimatch
*b
)
1717 return minimask_equal(a
->mask
, b
->mask
)
1718 && miniflow_equal(a
->flow
, b
->flow
);
1721 /* Returns true if 'target' satisifies 'match', that is, if each bit for which
1722 * 'match' specifies a particular value has the correct value in 'target'.
1724 * This function is equivalent to miniflow_equal_flow_in_minimask(&match->flow,
1725 * target, &match->mask) but it is faster because of the invariant that
1726 * match->flow.map and match->mask.map are the same. */
1728 minimatch_matches_flow(const struct minimatch
*match
,
1729 const struct flow
*target
)
1731 const uint64_t *flowp
= miniflow_get_values(match
->flow
);
1732 const uint64_t *maskp
= miniflow_get_values(&match
->mask
->masks
);
1735 FLOWMAP_FOR_EACH_INDEX(idx
, match
->flow
->map
) {
1736 if ((*flowp
++ ^ flow_u64_value(target
, idx
)) & *maskp
++) {
1744 /* Appends a string representation of 'match' to 's'. If 'priority' is
1745 * different from OFP_DEFAULT_PRIORITY, includes it in 's'. If 'port_map' is
1746 * nonnull, uses it to translate port numbers to names in output. */
1748 minimatch_format(const struct minimatch
*match
,
1749 const struct tun_table
*tun_table
,
1750 const struct ofputil_port_map
*port_map
,
1751 struct ds
*s
, int priority
)
1753 struct match megamatch
;
1755 minimatch_expand(match
, &megamatch
);
1756 megamatch
.flow
.tunnel
.metadata
.tab
= tun_table
;
1758 match_format(&megamatch
, port_map
, s
, priority
);
1761 /* Converts 'match' to a string and returns the string. If 'priority' is
1762 * different from OFP_DEFAULT_PRIORITY, includes it in the string. The caller
1763 * must free the string (with free()). If 'port_map' is nonnull, uses it to
1764 * translate port numbers to names in output. */
1766 minimatch_to_string(const struct minimatch
*match
,
1767 const struct ofputil_port_map
*port_map
, int priority
)
1769 struct match megamatch
;
1771 minimatch_expand(match
, &megamatch
);
1772 return match_to_string(&megamatch
, port_map
, priority
);