2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 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.
20 #include "byte-order.h"
21 #include "dynamic-string.h"
25 /* Converts the flow in 'flow' into a match in 'match', with the given
28 match_init(struct match *match,
29 const struct flow *flow, const struct flow_wildcards *wc)
33 match_zero_wildcarded_fields(match);
36 /* Converts a flow into a match. It sets the wildcard masks based on
37 * the packet contents. It will not set the mask for fields that do not
38 * make sense for the packet type. */
40 match_wc_init(struct match *match, const struct flow *flow)
44 flow_wildcards_init_for_packet(&match->wc, flow);
45 WC_MASK_FIELD(&match->wc, regs);
46 WC_MASK_FIELD(&match->wc, metadata);
49 /* Initializes 'match' as a "catch-all" match that matches every packet. */
51 match_init_catchall(struct match *match)
53 memset(&match->flow, 0, sizeof match->flow);
54 flow_wildcards_init_catchall(&match->wc);
57 /* For each bit or field wildcarded in 'match', sets the corresponding bit or
58 * field in 'flow' to all-0-bits. It is important to maintain this invariant
59 * in a match that might be inserted into a classifier.
61 * It is never necessary to call this function directly for a match that is
62 * initialized or modified only by match_*() functions. It is useful to
63 * restore the invariant in a match whose 'wc' member is modified by hand.
66 match_zero_wildcarded_fields(struct match *match)
68 flow_zero_wildcards(&match->flow, &match->wc);
72 match_set_dp_hash(struct match *match, uint32_t value)
74 match_set_dp_hash_masked(match, value, UINT32_MAX);
78 match_set_dp_hash_masked(struct match *match, uint32_t value, uint32_t mask)
80 match->wc.masks.dp_hash = mask;
81 match->flow.dp_hash = value & mask;
85 match_set_recirc_id(struct match *match, uint32_t value)
87 match->flow.recirc_id = value;
88 match->wc.masks.recirc_id = UINT32_MAX;
92 match_set_conj_id(struct match *match, uint32_t value)
94 match->flow.conj_id = value;
95 match->wc.masks.conj_id = UINT32_MAX;
99 match_set_reg(struct match *match, unsigned int reg_idx, uint32_t value)
101 match_set_reg_masked(match, reg_idx, value, UINT32_MAX);
105 match_set_reg_masked(struct match *match, unsigned int reg_idx,
106 uint32_t value, uint32_t mask)
108 ovs_assert(reg_idx < FLOW_N_REGS);
109 flow_wildcards_set_reg_mask(&match->wc, reg_idx, mask);
110 match->flow.regs[reg_idx] = value & mask;
114 match_set_xreg(struct match *match, unsigned int xreg_idx, uint64_t value)
116 match_set_xreg_masked(match, xreg_idx, value, UINT64_MAX);
120 match_set_xreg_masked(struct match *match, unsigned int xreg_idx,
121 uint64_t value, uint64_t mask)
123 ovs_assert(xreg_idx < FLOW_N_XREGS);
124 flow_wildcards_set_xreg_mask(&match->wc, xreg_idx, mask);
125 flow_set_xreg(&match->flow, xreg_idx, value & mask);
129 match_set_actset_output(struct match *match, ofp_port_t actset_output)
131 match->wc.masks.actset_output = u16_to_ofp(UINT16_MAX);
132 match->flow.actset_output = actset_output;
136 match_set_metadata(struct match *match, ovs_be64 metadata)
138 match_set_metadata_masked(match, metadata, OVS_BE64_MAX);
142 match_set_metadata_masked(struct match *match,
143 ovs_be64 metadata, ovs_be64 mask)
145 match->wc.masks.metadata = mask;
146 match->flow.metadata = metadata & mask;
150 match_set_tun_id(struct match *match, ovs_be64 tun_id)
152 match_set_tun_id_masked(match, tun_id, OVS_BE64_MAX);
156 match_set_tun_id_masked(struct match *match, ovs_be64 tun_id, ovs_be64 mask)
158 match->wc.masks.tunnel.tun_id = mask;
159 match->flow.tunnel.tun_id = tun_id & mask;
163 match_set_tun_src(struct match *match, ovs_be32 src)
165 match_set_tun_src_masked(match, src, OVS_BE32_MAX);
169 match_set_tun_src_masked(struct match *match, ovs_be32 src, ovs_be32 mask)
171 match->wc.masks.tunnel.ip_src = mask;
172 match->flow.tunnel.ip_src = src & mask;
176 match_set_tun_dst(struct match *match, ovs_be32 dst)
178 match_set_tun_dst_masked(match, dst, OVS_BE32_MAX);
182 match_set_tun_dst_masked(struct match *match, ovs_be32 dst, ovs_be32 mask)
184 match->wc.masks.tunnel.ip_dst = mask;
185 match->flow.tunnel.ip_dst = dst & mask;
189 match_set_tun_ttl(struct match *match, uint8_t ttl)
191 match_set_tun_ttl_masked(match, ttl, UINT8_MAX);
195 match_set_tun_ttl_masked(struct match *match, uint8_t ttl, uint8_t mask)
197 match->wc.masks.tunnel.ip_ttl = mask;
198 match->flow.tunnel.ip_ttl = ttl & mask;
202 match_set_tun_tos(struct match *match, uint8_t tos)
204 match_set_tun_tos_masked(match, tos, UINT8_MAX);
208 match_set_tun_tos_masked(struct match *match, uint8_t tos, uint8_t mask)
210 match->wc.masks.tunnel.ip_tos = mask;
211 match->flow.tunnel.ip_tos = tos & mask;
215 match_set_tun_flags(struct match *match, uint16_t flags)
217 match_set_tun_flags_masked(match, flags, UINT16_MAX);
221 match_set_tun_flags_masked(struct match *match, uint16_t flags, uint16_t mask)
223 match->wc.masks.tunnel.flags = mask;
224 match->flow.tunnel.flags = flags & mask;
228 match_set_tun_gbp_id_masked(struct match *match, ovs_be16 gbp_id, ovs_be16 mask)
230 match->wc.masks.tunnel.gbp_id = mask;
231 match->flow.tunnel.gbp_id = gbp_id & mask;
235 match_set_tun_gbp_id(struct match *match, ovs_be16 gbp_id)
237 match_set_tun_gbp_id_masked(match, gbp_id, OVS_BE16_MAX);
241 match_set_tun_gbp_flags_masked(struct match *match, uint8_t flags, uint8_t mask)
243 match->wc.masks.tunnel.gbp_flags = mask;
244 match->flow.tunnel.gbp_flags = flags & mask;
248 match_set_tun_gbp_flags(struct match *match, uint8_t flags)
250 match_set_tun_gbp_flags_masked(match, flags, UINT8_MAX);
254 match_set_in_port(struct match *match, ofp_port_t ofp_port)
256 match->wc.masks.in_port.ofp_port = u16_to_ofp(UINT16_MAX);
257 match->flow.in_port.ofp_port = ofp_port;
261 match_set_skb_priority(struct match *match, uint32_t skb_priority)
263 match->wc.masks.skb_priority = UINT32_MAX;
264 match->flow.skb_priority = skb_priority;
268 match_set_pkt_mark(struct match *match, uint32_t pkt_mark)
270 match_set_pkt_mark_masked(match, pkt_mark, UINT32_MAX);
274 match_set_pkt_mark_masked(struct match *match, uint32_t pkt_mark, uint32_t mask)
276 match->flow.pkt_mark = pkt_mark & mask;
277 match->wc.masks.pkt_mark = mask;
281 match_set_dl_type(struct match *match, ovs_be16 dl_type)
283 match->wc.masks.dl_type = OVS_BE16_MAX;
284 match->flow.dl_type = dl_type;
287 /* Modifies 'value_src' so that the Ethernet address must match 'value_dst'
288 * exactly. 'mask_dst' is set to all 1s. */
290 set_eth(const uint8_t value_src[ETH_ADDR_LEN],
291 uint8_t value_dst[ETH_ADDR_LEN],
292 uint8_t mask_dst[ETH_ADDR_LEN])
294 memcpy(value_dst, value_src, ETH_ADDR_LEN);
295 memset(mask_dst, 0xff, ETH_ADDR_LEN);
298 /* Modifies 'value_src' so that the Ethernet address must match 'value_src'
299 * after each byte is ANDed with the appropriate byte in 'mask_src'.
300 * 'mask_dst' is set to 'mask_src' */
302 set_eth_masked(const uint8_t value_src[ETH_ADDR_LEN],
303 const uint8_t mask_src[ETH_ADDR_LEN],
304 uint8_t value_dst[ETH_ADDR_LEN],
305 uint8_t mask_dst[ETH_ADDR_LEN])
309 for (i = 0; i < ETH_ADDR_LEN; i++) {
310 value_dst[i] = value_src[i] & mask_src[i];
311 mask_dst[i] = mask_src[i];
315 /* Modifies 'rule' so that the source Ethernet address must match 'dl_src'
318 match_set_dl_src(struct match *match, const uint8_t dl_src[ETH_ADDR_LEN])
320 set_eth(dl_src, match->flow.dl_src, match->wc.masks.dl_src);
323 /* Modifies 'rule' so that the source Ethernet address must match 'dl_src'
324 * after each byte is ANDed with the appropriate byte in 'mask'. */
326 match_set_dl_src_masked(struct match *match,
327 const uint8_t dl_src[ETH_ADDR_LEN],
328 const uint8_t mask[ETH_ADDR_LEN])
330 set_eth_masked(dl_src, mask, match->flow.dl_src, match->wc.masks.dl_src);
333 /* Modifies 'match' so that the Ethernet address must match 'dl_dst'
336 match_set_dl_dst(struct match *match, const uint8_t dl_dst[ETH_ADDR_LEN])
338 set_eth(dl_dst, match->flow.dl_dst, match->wc.masks.dl_dst);
341 /* Modifies 'match' so that the Ethernet address must match 'dl_dst' after each
342 * byte is ANDed with the appropriate byte in 'mask'.
344 * This function will assert-fail if 'mask' is invalid. Only 'mask' values
345 * accepted by flow_wildcards_is_dl_dst_mask_valid() are allowed. */
347 match_set_dl_dst_masked(struct match *match,
348 const uint8_t dl_dst[ETH_ADDR_LEN],
349 const uint8_t mask[ETH_ADDR_LEN])
351 set_eth_masked(dl_dst, mask, match->flow.dl_dst, match->wc.masks.dl_dst);
355 match_set_dl_tci(struct match *match, ovs_be16 tci)
357 match_set_dl_tci_masked(match, tci, htons(0xffff));
361 match_set_dl_tci_masked(struct match *match, ovs_be16 tci, ovs_be16 mask)
363 match->flow.vlan_tci = tci & mask;
364 match->wc.masks.vlan_tci = mask;
367 /* Modifies 'match' so that the VLAN VID is wildcarded. If the PCP is already
368 * wildcarded, then 'match' will match a packet regardless of whether it has an
369 * 802.1Q header or not. */
371 match_set_any_vid(struct match *match)
373 if (match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK)) {
374 match->wc.masks.vlan_tci &= ~htons(VLAN_VID_MASK);
375 match->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
377 match_set_dl_tci_masked(match, htons(0), htons(0));
381 /* Modifies 'match' depending on 'dl_vlan':
383 * - If 'dl_vlan' is htons(OFP_VLAN_NONE), makes 'match' match only packets
384 * without an 802.1Q header.
386 * - Otherwise, makes 'match' match only packets with an 802.1Q header whose
387 * VID equals the low 12 bits of 'dl_vlan'.
390 match_set_dl_vlan(struct match *match, ovs_be16 dl_vlan)
392 flow_set_dl_vlan(&match->flow, dl_vlan);
393 if (dl_vlan == htons(OFP10_VLAN_NONE)) {
394 match->wc.masks.vlan_tci = OVS_BE16_MAX;
396 match->wc.masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
400 /* Sets the VLAN VID that 'match' matches to 'vid', which is interpreted as an
401 * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
404 match_set_vlan_vid(struct match *match, ovs_be16 vid)
406 match_set_vlan_vid_masked(match, vid, htons(VLAN_VID_MASK | VLAN_CFI));
410 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
411 * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
412 * plus CFI), with the corresponding 'mask'. */
414 match_set_vlan_vid_masked(struct match *match, ovs_be16 vid, ovs_be16 mask)
416 ovs_be16 pcp_mask = htons(VLAN_PCP_MASK);
417 ovs_be16 vid_mask = htons(VLAN_VID_MASK | VLAN_CFI);
420 flow_set_vlan_vid(&match->flow, vid & mask);
421 match->wc.masks.vlan_tci = mask | (match->wc.masks.vlan_tci & pcp_mask);
424 /* Modifies 'match' so that the VLAN PCP is wildcarded. If the VID is already
425 * wildcarded, then 'match' will match a packet regardless of whether it has an
426 * 802.1Q header or not. */
428 match_set_any_pcp(struct match *match)
430 if (match->wc.masks.vlan_tci & htons(VLAN_VID_MASK)) {
431 match->wc.masks.vlan_tci &= ~htons(VLAN_PCP_MASK);
432 match->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
434 match_set_dl_tci_masked(match, htons(0), htons(0));
438 /* Modifies 'match' so that it matches only packets with an 802.1Q header whose
439 * PCP equals the low 3 bits of 'dl_vlan_pcp'. */
441 match_set_dl_vlan_pcp(struct match *match, uint8_t dl_vlan_pcp)
443 flow_set_vlan_pcp(&match->flow, dl_vlan_pcp);
444 match->wc.masks.vlan_tci |= htons(VLAN_CFI | VLAN_PCP_MASK);
447 /* Modifies 'match' so that the MPLS label 'idx' matches 'lse' exactly. */
449 match_set_mpls_lse(struct match *match, int idx, ovs_be32 lse)
451 match->wc.masks.mpls_lse[idx] = OVS_BE32_MAX;
452 match->flow.mpls_lse[idx] = lse;
455 /* Modifies 'match' so that the MPLS label is wildcarded. */
457 match_set_any_mpls_label(struct match *match, int idx)
459 match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_LABEL_MASK);
460 flow_set_mpls_label(&match->flow, idx, htonl(0));
463 /* Modifies 'match' so that it matches only packets with an MPLS header whose
464 * label equals the low 20 bits of 'mpls_label'. */
466 match_set_mpls_label(struct match *match, int idx, ovs_be32 mpls_label)
468 match->wc.masks.mpls_lse[idx] |= htonl(MPLS_LABEL_MASK);
469 flow_set_mpls_label(&match->flow, idx, mpls_label);
472 /* Modifies 'match' so that the MPLS TC is wildcarded. */
474 match_set_any_mpls_tc(struct match *match, int idx)
476 match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_TC_MASK);
477 flow_set_mpls_tc(&match->flow, idx, 0);
480 /* Modifies 'match' so that it matches only packets with an MPLS header whose
481 * Traffic Class equals the low 3 bits of 'mpls_tc'. */
483 match_set_mpls_tc(struct match *match, int idx, uint8_t mpls_tc)
485 match->wc.masks.mpls_lse[idx] |= htonl(MPLS_TC_MASK);
486 flow_set_mpls_tc(&match->flow, idx, mpls_tc);
489 /* Modifies 'match' so that the MPLS stack flag is wildcarded. */
491 match_set_any_mpls_bos(struct match *match, int idx)
493 match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_BOS_MASK);
494 flow_set_mpls_bos(&match->flow, idx, 0);
497 /* Modifies 'match' so that it matches only packets with an MPLS header whose
498 * Stack Flag equals the lower bit of 'mpls_bos' */
500 match_set_mpls_bos(struct match *match, int idx, uint8_t mpls_bos)
502 match->wc.masks.mpls_lse[idx] |= htonl(MPLS_BOS_MASK);
503 flow_set_mpls_bos(&match->flow, idx, mpls_bos);
506 /* Modifies 'match' so that the MPLS LSE is wildcarded. */
508 match_set_any_mpls_lse(struct match *match, int idx)
510 match->wc.masks.mpls_lse[idx] = htonl(0);
511 flow_set_mpls_lse(&match->flow, idx, htonl(0));
515 match_set_tp_src(struct match *match, ovs_be16 tp_src)
517 match_set_tp_src_masked(match, tp_src, OVS_BE16_MAX);
521 match_set_tp_src_masked(struct match *match, ovs_be16 port, ovs_be16 mask)
523 match->flow.tp_src = port & mask;
524 match->wc.masks.tp_src = mask;
528 match_set_tp_dst(struct match *match, ovs_be16 tp_dst)
530 match_set_tp_dst_masked(match, tp_dst, OVS_BE16_MAX);
534 match_set_tp_dst_masked(struct match *match, ovs_be16 port, ovs_be16 mask)
536 match->flow.tp_dst = port & mask;
537 match->wc.masks.tp_dst = mask;
541 match_set_tcp_flags(struct match *match, ovs_be16 flags)
543 match_set_tcp_flags_masked(match, flags, OVS_BE16_MAX);
547 match_set_tcp_flags_masked(struct match *match, ovs_be16 flags, ovs_be16 mask)
549 match->flow.tcp_flags = flags & mask;
550 match->wc.masks.tcp_flags = mask;
554 match_set_nw_proto(struct match *match, uint8_t nw_proto)
556 match->flow.nw_proto = nw_proto;
557 match->wc.masks.nw_proto = UINT8_MAX;
561 match_set_nw_src(struct match *match, ovs_be32 nw_src)
563 match->flow.nw_src = nw_src;
564 match->wc.masks.nw_src = OVS_BE32_MAX;
568 match_set_nw_src_masked(struct match *match,
569 ovs_be32 nw_src, ovs_be32 mask)
571 match->flow.nw_src = nw_src & mask;
572 match->wc.masks.nw_src = mask;
576 match_set_nw_dst(struct match *match, ovs_be32 nw_dst)
578 match->flow.nw_dst = nw_dst;
579 match->wc.masks.nw_dst = OVS_BE32_MAX;
583 match_set_nw_dst_masked(struct match *match, ovs_be32 ip, ovs_be32 mask)
585 match->flow.nw_dst = ip & mask;
586 match->wc.masks.nw_dst = mask;
590 match_set_nw_dscp(struct match *match, uint8_t nw_dscp)
592 match->wc.masks.nw_tos |= IP_DSCP_MASK;
593 match->flow.nw_tos &= ~IP_DSCP_MASK;
594 match->flow.nw_tos |= nw_dscp & IP_DSCP_MASK;
598 match_set_nw_ecn(struct match *match, uint8_t nw_ecn)
600 match->wc.masks.nw_tos |= IP_ECN_MASK;
601 match->flow.nw_tos &= ~IP_ECN_MASK;
602 match->flow.nw_tos |= nw_ecn & IP_ECN_MASK;
606 match_set_nw_ttl(struct match *match, uint8_t nw_ttl)
608 match->wc.masks.nw_ttl = UINT8_MAX;
609 match->flow.nw_ttl = nw_ttl;
613 match_set_nw_frag(struct match *match, uint8_t nw_frag)
615 match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
616 match->flow.nw_frag = nw_frag;
620 match_set_nw_frag_masked(struct match *match,
621 uint8_t nw_frag, uint8_t mask)
623 match->flow.nw_frag = nw_frag & mask;
624 match->wc.masks.nw_frag = mask;
628 match_set_icmp_type(struct match *match, uint8_t icmp_type)
630 match_set_tp_src(match, htons(icmp_type));
634 match_set_icmp_code(struct match *match, uint8_t icmp_code)
636 match_set_tp_dst(match, htons(icmp_code));
640 match_set_arp_sha(struct match *match, const uint8_t sha[ETH_ADDR_LEN])
642 memcpy(match->flow.arp_sha, sha, ETH_ADDR_LEN);
643 memset(match->wc.masks.arp_sha, UINT8_MAX, ETH_ADDR_LEN);
647 match_set_arp_sha_masked(struct match *match,
648 const uint8_t arp_sha[ETH_ADDR_LEN],
649 const uint8_t mask[ETH_ADDR_LEN])
651 set_eth_masked(arp_sha, mask,
652 match->flow.arp_sha, match->wc.masks.arp_sha);
656 match_set_arp_tha(struct match *match, const uint8_t tha[ETH_ADDR_LEN])
658 memcpy(match->flow.arp_tha, tha, ETH_ADDR_LEN);
659 memset(match->wc.masks.arp_tha, UINT8_MAX, ETH_ADDR_LEN);
663 match_set_arp_tha_masked(struct match *match,
664 const uint8_t arp_tha[ETH_ADDR_LEN],
665 const uint8_t mask[ETH_ADDR_LEN])
667 set_eth_masked(arp_tha, mask,
668 match->flow.arp_tha, match->wc.masks.arp_tha);
672 match_set_ipv6_src(struct match *match, const struct in6_addr *src)
674 match->flow.ipv6_src = *src;
675 match->wc.masks.ipv6_src = in6addr_exact;
679 match_set_ipv6_src_masked(struct match *match, const struct in6_addr *src,
680 const struct in6_addr *mask)
682 match->flow.ipv6_src = ipv6_addr_bitand(src, mask);
683 match->wc.masks.ipv6_src = *mask;
687 match_set_ipv6_dst(struct match *match, const struct in6_addr *dst)
689 match->flow.ipv6_dst = *dst;
690 match->wc.masks.ipv6_dst = in6addr_exact;
694 match_set_ipv6_dst_masked(struct match *match, const struct in6_addr *dst,
695 const struct in6_addr *mask)
697 match->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
698 match->wc.masks.ipv6_dst = *mask;
702 match_set_ipv6_label(struct match *match, ovs_be32 ipv6_label)
704 match->wc.masks.ipv6_label = OVS_BE32_MAX;
705 match->flow.ipv6_label = ipv6_label;
710 match_set_ipv6_label_masked(struct match *match, ovs_be32 ipv6_label,
713 match->flow.ipv6_label = ipv6_label & mask;
714 match->wc.masks.ipv6_label = mask;
718 match_set_nd_target(struct match *match, const struct in6_addr *target)
720 match->flow.nd_target = *target;
721 match->wc.masks.nd_target = in6addr_exact;
725 match_set_nd_target_masked(struct match *match,
726 const struct in6_addr *target,
727 const struct in6_addr *mask)
729 match->flow.nd_target = ipv6_addr_bitand(target, mask);
730 match->wc.masks.nd_target = *mask;
733 /* Returns true if 'a' and 'b' wildcard the same fields and have the same
734 * values for fixed fields, otherwise false. */
736 match_equal(const struct match *a, const struct match *b)
738 return (flow_wildcards_equal(&a->wc, &b->wc)
739 && flow_equal(&a->flow, &b->flow));
742 /* Returns a hash value for the flow and wildcards in 'match', starting from
745 match_hash(const struct match *match, uint32_t basis)
747 return flow_wildcards_hash(&match->wc, flow_hash(&match->flow, basis));
751 match_has_default_recirc_id(const struct match *m)
753 return m->flow.recirc_id == 0 && (m->wc.masks.recirc_id == UINT32_MAX ||
754 m->wc.masks.recirc_id == 0);
758 match_has_default_dp_hash(const struct match *m)
760 return ((m->flow.dp_hash | m->wc.masks.dp_hash) == 0);
763 /* Return true if the hidden fields of the match are set to the default values.
764 * The default values equals to those set up by match_init_hidden_fields(). */
766 match_has_default_hidden_fields(const struct match *m)
768 return match_has_default_recirc_id(m) && match_has_default_dp_hash(m);
772 match_init_hidden_fields(struct match *m)
774 match_set_recirc_id(m, 0);
775 match_set_dp_hash_masked(m, 0, 0);
779 format_eth_masked(struct ds *s, const char *name,
780 const uint8_t eth[ETH_ADDR_LEN],
781 const uint8_t mask[ETH_ADDR_LEN])
783 if (!eth_addr_is_zero(mask)) {
784 ds_put_format(s, "%s=", name);
785 eth_format_masked(eth, mask, s);
791 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
795 ds_put_format(s, "%s=", name);
796 ip_format_masked(ip, netmask, s);
802 format_ipv6_netmask(struct ds *s, const char *name,
803 const struct in6_addr *addr,
804 const struct in6_addr *netmask)
806 if (!ipv6_mask_is_any(netmask)) {
807 ds_put_format(s, "%s=", name);
808 print_ipv6_masked(s, addr, netmask);
814 format_be16_masked(struct ds *s, const char *name,
815 ovs_be16 value, ovs_be16 mask)
817 if (mask != htons(0)) {
818 ds_put_format(s, "%s=", name);
819 if (mask == OVS_BE16_MAX) {
820 ds_put_format(s, "%"PRIu16, ntohs(value));
822 ds_put_format(s, "0x%"PRIx16"/0x%"PRIx16,
823 ntohs(value), ntohs(mask));
830 format_be32_masked(struct ds *s, const char *name,
831 ovs_be32 value, ovs_be32 mask)
833 if (mask != htonl(0)) {
834 ds_put_format(s, "%s=", name);
835 if (mask == OVS_BE32_MAX) {
836 ds_put_format(s, "%"PRIu32, ntohl(value));
838 ds_put_format(s, "0x%"PRIx32"/0x%"PRIx32,
839 ntohl(value), ntohl(mask));
846 format_uint32_masked(struct ds *s, const char *name,
847 uint32_t value, uint32_t mask)
850 ds_put_format(s, "%s=%#"PRIx32, name, value);
851 if (mask != UINT32_MAX) {
852 ds_put_format(s, "/%#"PRIx32, mask);
859 format_be64_masked(struct ds *s, const char *name,
860 ovs_be64 value, ovs_be64 mask)
862 if (mask != htonll(0)) {
863 ds_put_format(s, "%s=%#"PRIx64, name, ntohll(value));
864 if (mask != OVS_BE64_MAX) {
865 ds_put_format(s, "/%#"PRIx64, ntohll(mask));
872 format_flow_tunnel(struct ds *s, const struct match *match)
874 const struct flow_wildcards *wc = &match->wc;
875 const struct flow_tnl *tnl = &match->flow.tunnel;
877 format_be64_masked(s, "tun_id", tnl->tun_id, wc->masks.tunnel.tun_id);
878 format_ip_netmask(s, "tun_src", tnl->ip_src, wc->masks.tunnel.ip_src);
879 format_ip_netmask(s, "tun_dst", tnl->ip_dst, wc->masks.tunnel.ip_dst);
881 if (wc->masks.tunnel.gbp_id) {
882 format_be16_masked(s, "tun_gbp_id", tnl->gbp_id,
883 wc->masks.tunnel.gbp_id);
886 if (wc->masks.tunnel.gbp_flags) {
887 ds_put_format(s, "tun_gbp_flags=%#"PRIx8",", tnl->gbp_flags);
890 if (wc->masks.tunnel.ip_tos) {
891 ds_put_format(s, "tun_tos=%"PRIx8",", tnl->ip_tos);
893 if (wc->masks.tunnel.ip_ttl) {
894 ds_put_format(s, "tun_ttl=%"PRIu8",", tnl->ip_ttl);
896 if (wc->masks.tunnel.flags) {
897 format_flags(s, flow_tun_flag_to_string, tnl->flags, '|');
902 /* Appends a string representation of 'match' to 's'. If 'priority' is
903 * different from OFP_DEFAULT_PRIORITY, includes it in 's'. */
905 match_format(const struct match *match, struct ds *s, int priority)
907 const struct flow_wildcards *wc = &match->wc;
908 size_t start_len = s->length;
909 const struct flow *f = &match->flow;
910 bool skip_type = false;
911 bool skip_proto = false;
915 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 31);
917 if (priority != OFP_DEFAULT_PRIORITY) {
918 ds_put_format(s, "priority=%d,", priority);
921 format_uint32_masked(s, "pkt_mark", f->pkt_mark, wc->masks.pkt_mark);
923 if (wc->masks.recirc_id) {
924 format_uint32_masked(s, "recirc_id", f->recirc_id,
925 wc->masks.recirc_id);
928 if (wc->masks.dp_hash) {
929 format_uint32_masked(s, "dp_hash", f->dp_hash,
933 if (wc->masks.conj_id) {
934 ds_put_format(s, "conj_id=%"PRIu32",", f->conj_id);
937 if (wc->masks.skb_priority) {
938 ds_put_format(s, "skb_priority=%#"PRIx32",", f->skb_priority);
941 if (wc->masks.actset_output) {
942 ds_put_cstr(s, "actset_output=");
943 ofputil_format_port(f->actset_output, s);
947 if (wc->masks.dl_type) {
949 if (f->dl_type == htons(ETH_TYPE_IP)) {
950 if (wc->masks.nw_proto) {
952 if (f->nw_proto == IPPROTO_ICMP) {
953 ds_put_cstr(s, "icmp,");
954 } else if (f->nw_proto == IPPROTO_IGMP) {
955 ds_put_cstr(s, "igmp,");
956 } else if (f->nw_proto == IPPROTO_TCP) {
957 ds_put_cstr(s, "tcp,");
958 } else if (f->nw_proto == IPPROTO_UDP) {
959 ds_put_cstr(s, "udp,");
960 } else if (f->nw_proto == IPPROTO_SCTP) {
961 ds_put_cstr(s, "sctp,");
963 ds_put_cstr(s, "ip,");
967 ds_put_cstr(s, "ip,");
969 } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
970 if (wc->masks.nw_proto) {
972 if (f->nw_proto == IPPROTO_ICMPV6) {
973 ds_put_cstr(s, "icmp6,");
974 } else if (f->nw_proto == IPPROTO_TCP) {
975 ds_put_cstr(s, "tcp6,");
976 } else if (f->nw_proto == IPPROTO_UDP) {
977 ds_put_cstr(s, "udp6,");
978 } else if (f->nw_proto == IPPROTO_SCTP) {
979 ds_put_cstr(s, "sctp6,");
981 ds_put_cstr(s, "ipv6,");
985 ds_put_cstr(s, "ipv6,");
987 } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
988 ds_put_cstr(s, "arp,");
989 } else if (f->dl_type == htons(ETH_TYPE_RARP)) {
990 ds_put_cstr(s, "rarp,");
991 } else if (f->dl_type == htons(ETH_TYPE_MPLS)) {
992 ds_put_cstr(s, "mpls,");
993 } else if (f->dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
994 ds_put_cstr(s, "mplsm,");
999 for (i = 0; i < FLOW_N_REGS; i++) {
1000 #define REGNAME_LEN 20
1001 char regname[REGNAME_LEN];
1002 if (snprintf(regname, REGNAME_LEN, "reg%d", i) >= REGNAME_LEN) {
1003 strcpy(regname, "reg?");
1005 format_uint32_masked(s, regname, f->regs[i], wc->masks.regs[i]);
1008 format_flow_tunnel(s, match);
1010 format_be64_masked(s, "metadata", f->metadata, wc->masks.metadata);
1012 if (wc->masks.in_port.ofp_port) {
1013 ds_put_cstr(s, "in_port=");
1014 ofputil_format_port(f->in_port.ofp_port, s);
1015 ds_put_char(s, ',');
1017 if (wc->masks.vlan_tci) {
1018 ovs_be16 vid_mask = wc->masks.vlan_tci & htons(VLAN_VID_MASK);
1019 ovs_be16 pcp_mask = wc->masks.vlan_tci & htons(VLAN_PCP_MASK);
1020 ovs_be16 cfi = wc->masks.vlan_tci & htons(VLAN_CFI);
1022 if (cfi && f->vlan_tci & htons(VLAN_CFI)
1023 && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
1024 && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
1025 && (vid_mask || pcp_mask)) {
1027 ds_put_format(s, "dl_vlan=%"PRIu16",",
1028 vlan_tci_to_vid(f->vlan_tci));
1031 ds_put_format(s, "dl_vlan_pcp=%d,",
1032 vlan_tci_to_pcp(f->vlan_tci));
1034 } else if (wc->masks.vlan_tci == htons(0xffff)) {
1035 ds_put_format(s, "vlan_tci=0x%04"PRIx16",", ntohs(f->vlan_tci));
1037 ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
1038 ntohs(f->vlan_tci), ntohs(wc->masks.vlan_tci));
1041 format_eth_masked(s, "dl_src", f->dl_src, wc->masks.dl_src);
1042 format_eth_masked(s, "dl_dst", f->dl_dst, wc->masks.dl_dst);
1043 if (!skip_type && wc->masks.dl_type) {
1044 ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
1046 if (f->dl_type == htons(ETH_TYPE_IPV6)) {
1047 format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->masks.ipv6_src);
1048 format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->masks.ipv6_dst);
1049 if (wc->masks.ipv6_label) {
1050 if (wc->masks.ipv6_label == OVS_BE32_MAX) {
1051 ds_put_format(s, "ipv6_label=0x%05"PRIx32",",
1052 ntohl(f->ipv6_label));
1054 ds_put_format(s, "ipv6_label=0x%05"PRIx32"/0x%05"PRIx32",",
1055 ntohl(f->ipv6_label),
1056 ntohl(wc->masks.ipv6_label));
1059 } else if (f->dl_type == htons(ETH_TYPE_ARP) ||
1060 f->dl_type == htons(ETH_TYPE_RARP)) {
1061 format_ip_netmask(s, "arp_spa", f->nw_src, wc->masks.nw_src);
1062 format_ip_netmask(s, "arp_tpa", f->nw_dst, wc->masks.nw_dst);
1064 format_ip_netmask(s, "nw_src", f->nw_src, wc->masks.nw_src);
1065 format_ip_netmask(s, "nw_dst", f->nw_dst, wc->masks.nw_dst);
1067 if (!skip_proto && wc->masks.nw_proto) {
1068 if (f->dl_type == htons(ETH_TYPE_ARP) ||
1069 f->dl_type == htons(ETH_TYPE_RARP)) {
1070 ds_put_format(s, "arp_op=%"PRIu8",", f->nw_proto);
1072 ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
1075 if (f->dl_type == htons(ETH_TYPE_ARP) ||
1076 f->dl_type == htons(ETH_TYPE_RARP)) {
1077 format_eth_masked(s, "arp_sha", f->arp_sha, wc->masks.arp_sha);
1078 format_eth_masked(s, "arp_tha", f->arp_tha, wc->masks.arp_tha);
1080 if (wc->masks.nw_tos & IP_DSCP_MASK) {
1081 ds_put_format(s, "nw_tos=%"PRIu8",", f->nw_tos & IP_DSCP_MASK);
1083 if (wc->masks.nw_tos & IP_ECN_MASK) {
1084 ds_put_format(s, "nw_ecn=%"PRIu8",", f->nw_tos & IP_ECN_MASK);
1086 if (wc->masks.nw_ttl) {
1087 ds_put_format(s, "nw_ttl=%"PRIu8",", f->nw_ttl);
1089 if (wc->masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK)) {
1090 ds_put_format(s, "mpls_label=%"PRIu32",",
1091 mpls_lse_to_label(f->mpls_lse[0]));
1093 if (wc->masks.mpls_lse[0] & htonl(MPLS_TC_MASK)) {
1094 ds_put_format(s, "mpls_tc=%"PRIu8",",
1095 mpls_lse_to_tc(f->mpls_lse[0]));
1097 if (wc->masks.mpls_lse[0] & htonl(MPLS_TTL_MASK)) {
1098 ds_put_format(s, "mpls_ttl=%"PRIu8",",
1099 mpls_lse_to_ttl(f->mpls_lse[0]));
1101 if (wc->masks.mpls_lse[0] & htonl(MPLS_BOS_MASK)) {
1102 ds_put_format(s, "mpls_bos=%"PRIu8",",
1103 mpls_lse_to_bos(f->mpls_lse[0]));
1105 format_be32_masked(s, "mpls_lse1", f->mpls_lse[1], wc->masks.mpls_lse[1]);
1106 format_be32_masked(s, "mpls_lse2", f->mpls_lse[2], wc->masks.mpls_lse[2]);
1108 switch (wc->masks.nw_frag) {
1109 case FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER:
1110 ds_put_format(s, "nw_frag=%s,",
1111 f->nw_frag & FLOW_NW_FRAG_ANY
1112 ? (f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "first")
1113 : (f->nw_frag & FLOW_NW_FRAG_LATER ? "<error>" : "no"));
1116 case FLOW_NW_FRAG_ANY:
1117 ds_put_format(s, "nw_frag=%s,",
1118 f->nw_frag & FLOW_NW_FRAG_ANY ? "yes" : "no");
1121 case FLOW_NW_FRAG_LATER:
1122 ds_put_format(s, "nw_frag=%s,",
1123 f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "not_later");
1126 if (f->dl_type == htons(ETH_TYPE_IP) &&
1127 f->nw_proto == IPPROTO_ICMP) {
1128 format_be16_masked(s, "icmp_type", f->tp_src, wc->masks.tp_src);
1129 format_be16_masked(s, "icmp_code", f->tp_dst, wc->masks.tp_dst);
1130 } else if (f->dl_type == htons(ETH_TYPE_IP) &&
1131 f->nw_proto == IPPROTO_IGMP) {
1132 format_be16_masked(s, "igmp_type", f->tp_src, wc->masks.tp_src);
1133 format_be16_masked(s, "igmp_code", f->tp_dst, wc->masks.tp_dst);
1134 } else if (f->dl_type == htons(ETH_TYPE_IPV6) &&
1135 f->nw_proto == IPPROTO_ICMPV6) {
1136 format_be16_masked(s, "icmp_type", f->tp_src, wc->masks.tp_src);
1137 format_be16_masked(s, "icmp_code", f->tp_dst, wc->masks.tp_dst);
1138 format_ipv6_netmask(s, "nd_target", &f->nd_target,
1139 &wc->masks.nd_target);
1140 format_eth_masked(s, "nd_sll", f->arp_sha, wc->masks.arp_sha);
1141 format_eth_masked(s, "nd_tll", f->arp_tha, wc->masks.arp_tha);
1143 format_be16_masked(s, "tp_src", f->tp_src, wc->masks.tp_src);
1144 format_be16_masked(s, "tp_dst", f->tp_dst, wc->masks.tp_dst);
1146 if (is_ip_any(f) && f->nw_proto == IPPROTO_TCP && wc->masks.tcp_flags) {
1147 uint16_t mask = TCP_FLAGS(wc->masks.tcp_flags);
1149 if (mask == TCP_FLAGS(OVS_BE16_MAX)) {
1150 ds_put_cstr(s, "tcp_flags=");
1152 format_flags(s, packet_tcp_flag_to_string, ntohs(f->tcp_flags),
1155 ds_put_cstr(s, "0"); /* Zero flags. */
1158 format_flags_masked(s, "tcp_flags", packet_tcp_flag_to_string,
1159 ntohs(f->tcp_flags), mask);
1163 if (s->length > start_len) {
1168 /* Converts 'match' to a string and returns the string. If 'priority' is
1169 * different from OFP_DEFAULT_PRIORITY, includes it in the string. The caller
1170 * must free the string (with free()). */
1172 match_to_string(const struct match *match, int priority)
1174 struct ds s = DS_EMPTY_INITIALIZER;
1175 match_format(match, &s, priority);
1176 return ds_steal_cstr(&s);
1180 match_print(const struct match *match)
1182 char *s = match_to_string(match, OFP_DEFAULT_PRIORITY);
1187 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1188 * with minimatch_destroy(). */
1190 minimatch_init(struct minimatch *dst, const struct match *src)
1192 minimask_init(&dst->mask, &src->wc);
1193 miniflow_init_with_minimask(&dst->flow, &src->flow, &dst->mask);
1196 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1197 * with minimatch_destroy(). */
1199 minimatch_clone(struct minimatch *dst, const struct minimatch *src)
1201 miniflow_clone(&dst->flow, &src->flow);
1202 minimask_clone(&dst->mask, &src->mask);
1205 /* Initializes 'dst' with the data in 'src', destroying 'src'. The caller must
1206 * eventually free 'dst' with minimatch_destroy(). */
1208 minimatch_move(struct minimatch *dst, struct minimatch *src)
1210 miniflow_move(&dst->flow, &src->flow);
1211 minimask_move(&dst->mask, &src->mask);
1214 /* Frees any memory owned by 'match'. Does not free the storage in which
1215 * 'match' itself resides; the caller is responsible for that. */
1217 minimatch_destroy(struct minimatch *match)
1219 miniflow_destroy(&match->flow);
1220 minimask_destroy(&match->mask);
1223 /* Initializes 'dst' as a copy of 'src'. */
1225 minimatch_expand(const struct minimatch *src, struct match *dst)
1227 miniflow_expand(&src->flow, &dst->flow);
1228 minimask_expand(&src->mask, &dst->wc);
1231 /* Returns true if 'a' and 'b' match the same packets, false otherwise. */
1233 minimatch_equal(const struct minimatch *a, const struct minimatch *b)
1235 return (miniflow_equal(&a->flow, &b->flow)
1236 && minimask_equal(&a->mask, &b->mask));
1239 /* Returns true if 'target' satisifies 'match', that is, if each bit for which
1240 * 'match' specifies a particular value has the correct value in 'target'.
1242 * This function is equivalent to miniflow_equal_flow_in_minimask(&match->flow,
1243 * target, &match->mask) but it is faster because of the invariant that
1244 * match->flow.map and match->mask.map are the same. */
1246 minimatch_matches_flow(const struct minimatch *match,
1247 const struct flow *target)
1249 const uint64_t *target_u64 = (const uint64_t *) target;
1250 const uint64_t *flowp = miniflow_get_values(&match->flow);
1251 const uint64_t *maskp = miniflow_get_values(&match->mask.masks);
1254 MAP_FOR_EACH_INDEX(idx, match->flow.map) {
1255 if ((*flowp++ ^ target_u64[idx]) & *maskp++) {
1263 /* Appends a string representation of 'match' to 's'. If 'priority' is
1264 * different from OFP_DEFAULT_PRIORITY, includes it in 's'. */
1266 minimatch_format(const struct minimatch *match, struct ds *s, int priority)
1268 struct match megamatch;
1270 minimatch_expand(match, &megamatch);
1271 match_format(&megamatch, s, priority);
1274 /* Converts 'match' to a string and returns the string. If 'priority' is
1275 * different from OFP_DEFAULT_PRIORITY, includes it in the string. The caller
1276 * must free the string (with free()). */
1278 minimatch_to_string(const struct minimatch *match, int priority)
1280 struct match megamatch;
1282 minimatch_expand(match, &megamatch);
1283 return match_to_string(&megamatch, priority);