2 * Copyright (c) 2009, 2010, 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.
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)
42 struct flow_wildcards *wc;
47 memset(&wc->masks, 0x0, sizeof wc->masks);
49 memset(&wc->masks.dl_type, 0xff, sizeof wc->masks.dl_type);
52 memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
55 if (flow->skb_priority) {
56 memset(&wc->masks.skb_priority, 0xff, sizeof wc->masks.skb_priority);
60 memset(&wc->masks.pkt_mark, 0xff, sizeof wc->masks.pkt_mark);
63 for (i = 0; i < FLOW_N_REGS; i++) {
65 memset(&wc->masks.regs[i], 0xff, sizeof wc->masks.regs[i]);
69 if (flow->tunnel.ip_dst) {
70 if (flow->tunnel.flags & FLOW_TNL_F_KEY) {
71 memset(&wc->masks.tunnel.tun_id, 0xff, sizeof wc->masks.tunnel.tun_id);
73 memset(&wc->masks.tunnel.ip_src, 0xff, sizeof wc->masks.tunnel.ip_src);
74 memset(&wc->masks.tunnel.ip_dst, 0xff, sizeof wc->masks.tunnel.ip_dst);
75 memset(&wc->masks.tunnel.flags, 0xff, sizeof wc->masks.tunnel.flags);
76 memset(&wc->masks.tunnel.ip_tos, 0xff, sizeof wc->masks.tunnel.ip_tos);
77 memset(&wc->masks.tunnel.ip_ttl, 0xff, sizeof wc->masks.tunnel.ip_ttl);
78 } else if (flow->tunnel.tun_id) {
79 memset(&wc->masks.tunnel.tun_id, 0xff, sizeof wc->masks.tunnel.tun_id);
82 memset(&wc->masks.metadata, 0xff, sizeof wc->masks.metadata);
83 memset(&wc->masks.in_port, 0xff, sizeof wc->masks.in_port);
84 memset(&wc->masks.vlan_tci, 0xff, sizeof wc->masks.vlan_tci);
85 memset(&wc->masks.dl_src, 0xff, sizeof wc->masks.dl_src);
86 memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
88 if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
89 memset(&wc->masks.ipv6_src, 0xff, sizeof wc->masks.ipv6_src);
90 memset(&wc->masks.ipv6_dst, 0xff, sizeof wc->masks.ipv6_dst);
91 memset(&wc->masks.ipv6_label, 0xff, sizeof wc->masks.ipv6_label);
92 } else if (flow->dl_type == htons(ETH_TYPE_IP) ||
93 (flow->dl_type == htons(ETH_TYPE_ARP)) ||
94 (flow->dl_type == htons(ETH_TYPE_RARP))) {
95 memset(&wc->masks.nw_src, 0xff, sizeof wc->masks.nw_src);
96 memset(&wc->masks.nw_dst, 0xff, sizeof wc->masks.nw_dst);
97 } else if (eth_type_mpls(flow->dl_type)) {
100 for (i = 0; i < FLOW_MAX_MPLS_LABELS; i++) {
101 wc->masks.mpls_lse[i] = OVS_BE32_MAX;
102 if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
108 if (flow->dl_type == htons(ETH_TYPE_ARP) ||
109 flow->dl_type == htons(ETH_TYPE_RARP)) {
110 memset(&wc->masks.arp_sha, 0xff, sizeof wc->masks.arp_sha);
111 memset(&wc->masks.arp_tha, 0xff, sizeof wc->masks.arp_tha);
114 if (is_ip_any(flow)) {
115 memset(&wc->masks.nw_tos, 0xff, sizeof wc->masks.nw_tos);
116 memset(&wc->masks.nw_ttl, 0xff, sizeof wc->masks.nw_ttl);
119 memset(&wc->masks.nw_frag, 0xff, sizeof wc->masks.nw_frag);
120 if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
121 /* No transport layer header in later fragments. */
126 if (flow->nw_proto == IPPROTO_ICMP ||
127 flow->nw_proto == IPPROTO_ICMPV6 ||
128 (flow->tp_src || flow->tp_dst)) {
129 memset(&wc->masks.tp_src, 0xff, sizeof wc->masks.tp_src);
130 memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
132 if (flow->nw_proto == IPPROTO_TCP) {
133 memset(&wc->masks.tcp_flags, 0xff, sizeof wc->masks.tcp_flags);
136 if (flow->nw_proto == IPPROTO_ICMPV6) {
137 memset(&wc->masks.arp_sha, 0xff, sizeof wc->masks.arp_sha);
138 memset(&wc->masks.arp_tha, 0xff, sizeof wc->masks.arp_tha);
139 memset(&wc->masks.nd_target, 0xff, sizeof wc->masks.nd_target);
146 /* Initializes 'match' as a "catch-all" match that matches every packet. */
148 match_init_catchall(struct match *match)
150 memset(&match->flow, 0, sizeof match->flow);
151 flow_wildcards_init_catchall(&match->wc);
154 /* For each bit or field wildcarded in 'match', sets the corresponding bit or
155 * field in 'flow' to all-0-bits. It is important to maintain this invariant
156 * in a match that might be inserted into a classifier.
158 * It is never necessary to call this function directly for a match that is
159 * initialized or modified only by match_*() functions. It is useful to
160 * restore the invariant in a match whose 'wc' member is modified by hand.
163 match_zero_wildcarded_fields(struct match *match)
165 flow_zero_wildcards(&match->flow, &match->wc);
169 match_set_dp_hash(struct match *match, uint32_t value)
171 match_set_dp_hash_masked(match, value, UINT32_MAX);
175 match_set_dp_hash_masked(struct match *match, uint32_t value, uint32_t mask)
177 match->wc.masks.dp_hash = mask;
178 match->flow.dp_hash = value & mask;
182 match_set_recirc_id(struct match *match, uint32_t value)
184 match->flow.recirc_id = value;
185 match->wc.masks.recirc_id = UINT32_MAX;
189 match_set_reg(struct match *match, unsigned int reg_idx, uint32_t value)
191 match_set_reg_masked(match, reg_idx, value, UINT32_MAX);
195 match_set_reg_masked(struct match *match, unsigned int reg_idx,
196 uint32_t value, uint32_t mask)
198 ovs_assert(reg_idx < FLOW_N_REGS);
199 flow_wildcards_set_reg_mask(&match->wc, reg_idx, mask);
200 match->flow.regs[reg_idx] = value & mask;
204 match_set_metadata(struct match *match, ovs_be64 metadata)
206 match_set_metadata_masked(match, metadata, OVS_BE64_MAX);
210 match_set_metadata_masked(struct match *match,
211 ovs_be64 metadata, ovs_be64 mask)
213 match->wc.masks.metadata = mask;
214 match->flow.metadata = metadata & mask;
218 match_set_tun_id(struct match *match, ovs_be64 tun_id)
220 match_set_tun_id_masked(match, tun_id, OVS_BE64_MAX);
224 match_set_tun_id_masked(struct match *match, ovs_be64 tun_id, ovs_be64 mask)
226 match->wc.masks.tunnel.tun_id = mask;
227 match->flow.tunnel.tun_id = tun_id & mask;
231 match_set_tun_src(struct match *match, ovs_be32 src)
233 match_set_tun_src_masked(match, src, OVS_BE32_MAX);
237 match_set_tun_src_masked(struct match *match, ovs_be32 src, ovs_be32 mask)
239 match->wc.masks.tunnel.ip_src = mask;
240 match->flow.tunnel.ip_src = src & mask;
244 match_set_tun_dst(struct match *match, ovs_be32 dst)
246 match_set_tun_dst_masked(match, dst, OVS_BE32_MAX);
250 match_set_tun_dst_masked(struct match *match, ovs_be32 dst, ovs_be32 mask)
252 match->wc.masks.tunnel.ip_dst = mask;
253 match->flow.tunnel.ip_dst = dst & mask;
257 match_set_tun_ttl(struct match *match, uint8_t ttl)
259 match_set_tun_ttl_masked(match, ttl, UINT8_MAX);
263 match_set_tun_ttl_masked(struct match *match, uint8_t ttl, uint8_t mask)
265 match->wc.masks.tunnel.ip_ttl = mask;
266 match->flow.tunnel.ip_ttl = ttl & mask;
270 match_set_tun_tos(struct match *match, uint8_t tos)
272 match_set_tun_tos_masked(match, tos, UINT8_MAX);
276 match_set_tun_tos_masked(struct match *match, uint8_t tos, uint8_t mask)
278 match->wc.masks.tunnel.ip_tos = mask;
279 match->flow.tunnel.ip_tos = tos & mask;
283 match_set_tun_flags(struct match *match, uint16_t flags)
285 match_set_tun_flags_masked(match, flags, UINT16_MAX);
289 match_set_tun_flags_masked(struct match *match, uint16_t flags, uint16_t mask)
291 match->wc.masks.tunnel.flags = mask;
292 match->flow.tunnel.flags = flags & mask;
296 match_set_in_port(struct match *match, ofp_port_t ofp_port)
298 match->wc.masks.in_port.ofp_port = u16_to_ofp(UINT16_MAX);
299 match->flow.in_port.ofp_port = ofp_port;
303 match_set_skb_priority(struct match *match, uint32_t skb_priority)
305 match->wc.masks.skb_priority = UINT32_MAX;
306 match->flow.skb_priority = skb_priority;
310 match_set_pkt_mark(struct match *match, uint32_t pkt_mark)
312 match_set_pkt_mark_masked(match, pkt_mark, UINT32_MAX);
316 match_set_pkt_mark_masked(struct match *match, uint32_t pkt_mark, uint32_t mask)
318 match->flow.pkt_mark = pkt_mark & mask;
319 match->wc.masks.pkt_mark = mask;
323 match_set_dl_type(struct match *match, ovs_be16 dl_type)
325 match->wc.masks.dl_type = OVS_BE16_MAX;
326 match->flow.dl_type = dl_type;
329 /* Modifies 'value_src' so that the Ethernet address must match 'value_dst'
330 * exactly. 'mask_dst' is set to all 1s. */
332 set_eth(const uint8_t value_src[ETH_ADDR_LEN],
333 uint8_t value_dst[ETH_ADDR_LEN],
334 uint8_t mask_dst[ETH_ADDR_LEN])
336 memcpy(value_dst, value_src, ETH_ADDR_LEN);
337 memset(mask_dst, 0xff, ETH_ADDR_LEN);
340 /* Modifies 'value_src' so that the Ethernet address must match 'value_src'
341 * after each byte is ANDed with the appropriate byte in 'mask_src'.
342 * 'mask_dst' is set to 'mask_src' */
344 set_eth_masked(const uint8_t value_src[ETH_ADDR_LEN],
345 const uint8_t mask_src[ETH_ADDR_LEN],
346 uint8_t value_dst[ETH_ADDR_LEN],
347 uint8_t mask_dst[ETH_ADDR_LEN])
351 for (i = 0; i < ETH_ADDR_LEN; i++) {
352 value_dst[i] = value_src[i] & mask_src[i];
353 mask_dst[i] = mask_src[i];
357 /* Modifies 'rule' so that the source Ethernet address must match 'dl_src'
360 match_set_dl_src(struct match *match, const uint8_t dl_src[ETH_ADDR_LEN])
362 set_eth(dl_src, match->flow.dl_src, match->wc.masks.dl_src);
365 /* Modifies 'rule' so that the source Ethernet address must match 'dl_src'
366 * after each byte is ANDed with the appropriate byte in 'mask'. */
368 match_set_dl_src_masked(struct match *match,
369 const uint8_t dl_src[ETH_ADDR_LEN],
370 const uint8_t mask[ETH_ADDR_LEN])
372 set_eth_masked(dl_src, mask, match->flow.dl_src, match->wc.masks.dl_src);
375 /* Modifies 'match' so that the Ethernet address must match 'dl_dst'
378 match_set_dl_dst(struct match *match, const uint8_t dl_dst[ETH_ADDR_LEN])
380 set_eth(dl_dst, match->flow.dl_dst, match->wc.masks.dl_dst);
383 /* Modifies 'match' so that the Ethernet address must match 'dl_dst' after each
384 * byte is ANDed with the appropriate byte in 'mask'.
386 * This function will assert-fail if 'mask' is invalid. Only 'mask' values
387 * accepted by flow_wildcards_is_dl_dst_mask_valid() are allowed. */
389 match_set_dl_dst_masked(struct match *match,
390 const uint8_t dl_dst[ETH_ADDR_LEN],
391 const uint8_t mask[ETH_ADDR_LEN])
393 set_eth_masked(dl_dst, mask, match->flow.dl_dst, match->wc.masks.dl_dst);
397 match_set_dl_tci(struct match *match, ovs_be16 tci)
399 match_set_dl_tci_masked(match, tci, htons(0xffff));
403 match_set_dl_tci_masked(struct match *match, ovs_be16 tci, ovs_be16 mask)
405 match->flow.vlan_tci = tci & mask;
406 match->wc.masks.vlan_tci = mask;
409 /* Modifies 'match' so that the VLAN VID is wildcarded. If the PCP is already
410 * wildcarded, then 'match' will match a packet regardless of whether it has an
411 * 802.1Q header or not. */
413 match_set_any_vid(struct match *match)
415 if (match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK)) {
416 match->wc.masks.vlan_tci &= ~htons(VLAN_VID_MASK);
417 match->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
419 match_set_dl_tci_masked(match, htons(0), htons(0));
423 /* Modifies 'match' depending on 'dl_vlan':
425 * - If 'dl_vlan' is htons(OFP_VLAN_NONE), makes 'match' match only packets
426 * without an 802.1Q header.
428 * - Otherwise, makes 'match' match only packets with an 802.1Q header whose
429 * VID equals the low 12 bits of 'dl_vlan'.
432 match_set_dl_vlan(struct match *match, ovs_be16 dl_vlan)
434 flow_set_dl_vlan(&match->flow, dl_vlan);
435 if (dl_vlan == htons(OFP10_VLAN_NONE)) {
436 match->wc.masks.vlan_tci = OVS_BE16_MAX;
438 match->wc.masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
442 /* Sets the VLAN VID that 'match' matches to 'vid', which is interpreted as an
443 * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
446 match_set_vlan_vid(struct match *match, ovs_be16 vid)
448 match_set_vlan_vid_masked(match, vid, htons(VLAN_VID_MASK | VLAN_CFI));
452 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
453 * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
454 * plus CFI), with the corresponding 'mask'. */
456 match_set_vlan_vid_masked(struct match *match, ovs_be16 vid, ovs_be16 mask)
458 ovs_be16 pcp_mask = htons(VLAN_PCP_MASK);
459 ovs_be16 vid_mask = htons(VLAN_VID_MASK | VLAN_CFI);
462 flow_set_vlan_vid(&match->flow, vid & mask);
463 match->wc.masks.vlan_tci = mask | (match->wc.masks.vlan_tci & pcp_mask);
466 /* Modifies 'match' so that the VLAN PCP is wildcarded. If the VID is already
467 * wildcarded, then 'match' will match a packet regardless of whether it has an
468 * 802.1Q header or not. */
470 match_set_any_pcp(struct match *match)
472 if (match->wc.masks.vlan_tci & htons(VLAN_VID_MASK)) {
473 match->wc.masks.vlan_tci &= ~htons(VLAN_PCP_MASK);
474 match->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
476 match_set_dl_tci_masked(match, htons(0), htons(0));
480 /* Modifies 'match' so that it matches only packets with an 802.1Q header whose
481 * PCP equals the low 3 bits of 'dl_vlan_pcp'. */
483 match_set_dl_vlan_pcp(struct match *match, uint8_t dl_vlan_pcp)
485 flow_set_vlan_pcp(&match->flow, dl_vlan_pcp);
486 match->wc.masks.vlan_tci |= htons(VLAN_CFI | VLAN_PCP_MASK);
489 /* Modifies 'match' so that the MPLS label 'idx' matches 'lse' exactly. */
491 match_set_mpls_lse(struct match *match, int idx, ovs_be32 lse)
493 match->wc.masks.mpls_lse[idx] = OVS_BE32_MAX;
494 match->flow.mpls_lse[idx] = lse;
497 /* Modifies 'match' so that the MPLS label is wildcarded. */
499 match_set_any_mpls_label(struct match *match, int idx)
501 match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_LABEL_MASK);
502 flow_set_mpls_label(&match->flow, idx, htonl(0));
505 /* Modifies 'match' so that it matches only packets with an MPLS header whose
506 * label equals the low 20 bits of 'mpls_label'. */
508 match_set_mpls_label(struct match *match, int idx, ovs_be32 mpls_label)
510 match->wc.masks.mpls_lse[idx] |= htonl(MPLS_LABEL_MASK);
511 flow_set_mpls_label(&match->flow, idx, mpls_label);
514 /* Modifies 'match' so that the MPLS TC is wildcarded. */
516 match_set_any_mpls_tc(struct match *match, int idx)
518 match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_TC_MASK);
519 flow_set_mpls_tc(&match->flow, idx, 0);
522 /* Modifies 'match' so that it matches only packets with an MPLS header whose
523 * Traffic Class equals the low 3 bits of 'mpls_tc'. */
525 match_set_mpls_tc(struct match *match, int idx, uint8_t mpls_tc)
527 match->wc.masks.mpls_lse[idx] |= htonl(MPLS_TC_MASK);
528 flow_set_mpls_tc(&match->flow, idx, mpls_tc);
531 /* Modifies 'match' so that the MPLS stack flag is wildcarded. */
533 match_set_any_mpls_bos(struct match *match, int idx)
535 match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_BOS_MASK);
536 flow_set_mpls_bos(&match->flow, idx, 0);
539 /* Modifies 'match' so that it matches only packets with an MPLS header whose
540 * Stack Flag equals the lower bit of 'mpls_bos' */
542 match_set_mpls_bos(struct match *match, int idx, uint8_t mpls_bos)
544 match->wc.masks.mpls_lse[idx] |= htonl(MPLS_BOS_MASK);
545 flow_set_mpls_bos(&match->flow, idx, mpls_bos);
548 /* Modifies 'match' so that the MPLS LSE is wildcarded. */
550 match_set_any_mpls_lse(struct match *match, int idx)
552 match->wc.masks.mpls_lse[idx] = htonl(0);
553 flow_set_mpls_lse(&match->flow, idx, htonl(0));
557 match_set_tp_src(struct match *match, ovs_be16 tp_src)
559 match_set_tp_src_masked(match, tp_src, OVS_BE16_MAX);
563 match_set_tp_src_masked(struct match *match, ovs_be16 port, ovs_be16 mask)
565 match->flow.tp_src = port & mask;
566 match->wc.masks.tp_src = mask;
570 match_set_tp_dst(struct match *match, ovs_be16 tp_dst)
572 match_set_tp_dst_masked(match, tp_dst, OVS_BE16_MAX);
576 match_set_tp_dst_masked(struct match *match, ovs_be16 port, ovs_be16 mask)
578 match->flow.tp_dst = port & mask;
579 match->wc.masks.tp_dst = mask;
583 match_set_tcp_flags(struct match *match, ovs_be16 flags)
585 match_set_tcp_flags_masked(match, flags, OVS_BE16_MAX);
589 match_set_tcp_flags_masked(struct match *match, ovs_be16 flags, ovs_be16 mask)
591 match->flow.tcp_flags = flags & mask;
592 match->wc.masks.tcp_flags = mask;
596 match_set_nw_proto(struct match *match, uint8_t nw_proto)
598 match->flow.nw_proto = nw_proto;
599 match->wc.masks.nw_proto = UINT8_MAX;
603 match_set_nw_src(struct match *match, ovs_be32 nw_src)
605 match->flow.nw_src = nw_src;
606 match->wc.masks.nw_src = OVS_BE32_MAX;
610 match_set_nw_src_masked(struct match *match,
611 ovs_be32 nw_src, ovs_be32 mask)
613 match->flow.nw_src = nw_src & mask;
614 match->wc.masks.nw_src = mask;
618 match_set_nw_dst(struct match *match, ovs_be32 nw_dst)
620 match->flow.nw_dst = nw_dst;
621 match->wc.masks.nw_dst = OVS_BE32_MAX;
625 match_set_nw_dst_masked(struct match *match, ovs_be32 ip, ovs_be32 mask)
627 match->flow.nw_dst = ip & mask;
628 match->wc.masks.nw_dst = mask;
632 match_set_nw_dscp(struct match *match, uint8_t nw_dscp)
634 match->wc.masks.nw_tos |= IP_DSCP_MASK;
635 match->flow.nw_tos &= ~IP_DSCP_MASK;
636 match->flow.nw_tos |= nw_dscp & IP_DSCP_MASK;
640 match_set_nw_ecn(struct match *match, uint8_t nw_ecn)
642 match->wc.masks.nw_tos |= IP_ECN_MASK;
643 match->flow.nw_tos &= ~IP_ECN_MASK;
644 match->flow.nw_tos |= nw_ecn & IP_ECN_MASK;
648 match_set_nw_ttl(struct match *match, uint8_t nw_ttl)
650 match->wc.masks.nw_ttl = UINT8_MAX;
651 match->flow.nw_ttl = nw_ttl;
655 match_set_nw_frag(struct match *match, uint8_t nw_frag)
657 match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
658 match->flow.nw_frag = nw_frag;
662 match_set_nw_frag_masked(struct match *match,
663 uint8_t nw_frag, uint8_t mask)
665 match->flow.nw_frag = nw_frag & mask;
666 match->wc.masks.nw_frag = mask;
670 match_set_icmp_type(struct match *match, uint8_t icmp_type)
672 match_set_tp_src(match, htons(icmp_type));
676 match_set_icmp_code(struct match *match, uint8_t icmp_code)
678 match_set_tp_dst(match, htons(icmp_code));
682 match_set_arp_sha(struct match *match, const uint8_t sha[ETH_ADDR_LEN])
684 memcpy(match->flow.arp_sha, sha, ETH_ADDR_LEN);
685 memset(match->wc.masks.arp_sha, UINT8_MAX, ETH_ADDR_LEN);
689 match_set_arp_sha_masked(struct match *match,
690 const uint8_t arp_sha[ETH_ADDR_LEN],
691 const uint8_t mask[ETH_ADDR_LEN])
693 set_eth_masked(arp_sha, mask,
694 match->flow.arp_sha, match->wc.masks.arp_sha);
698 match_set_arp_tha(struct match *match, const uint8_t tha[ETH_ADDR_LEN])
700 memcpy(match->flow.arp_tha, tha, ETH_ADDR_LEN);
701 memset(match->wc.masks.arp_tha, UINT8_MAX, ETH_ADDR_LEN);
705 match_set_arp_tha_masked(struct match *match,
706 const uint8_t arp_tha[ETH_ADDR_LEN],
707 const uint8_t mask[ETH_ADDR_LEN])
709 set_eth_masked(arp_tha, mask,
710 match->flow.arp_tha, match->wc.masks.arp_tha);
714 match_set_ipv6_src(struct match *match, const struct in6_addr *src)
716 match->flow.ipv6_src = *src;
717 match->wc.masks.ipv6_src = in6addr_exact;
721 match_set_ipv6_src_masked(struct match *match, const struct in6_addr *src,
722 const struct in6_addr *mask)
724 match->flow.ipv6_src = ipv6_addr_bitand(src, mask);
725 match->wc.masks.ipv6_src = *mask;
729 match_set_ipv6_dst(struct match *match, const struct in6_addr *dst)
731 match->flow.ipv6_dst = *dst;
732 match->wc.masks.ipv6_dst = in6addr_exact;
736 match_set_ipv6_dst_masked(struct match *match, const struct in6_addr *dst,
737 const struct in6_addr *mask)
739 match->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
740 match->wc.masks.ipv6_dst = *mask;
744 match_set_ipv6_label(struct match *match, ovs_be32 ipv6_label)
746 match->wc.masks.ipv6_label = OVS_BE32_MAX;
747 match->flow.ipv6_label = ipv6_label;
752 match_set_ipv6_label_masked(struct match *match, ovs_be32 ipv6_label,
755 match->flow.ipv6_label = ipv6_label & mask;
756 match->wc.masks.ipv6_label = mask;
760 match_set_nd_target(struct match *match, const struct in6_addr *target)
762 match->flow.nd_target = *target;
763 match->wc.masks.nd_target = in6addr_exact;
767 match_set_nd_target_masked(struct match *match,
768 const struct in6_addr *target,
769 const struct in6_addr *mask)
771 match->flow.nd_target = ipv6_addr_bitand(target, mask);
772 match->wc.masks.nd_target = *mask;
775 /* Returns true if 'a' and 'b' wildcard the same fields and have the same
776 * values for fixed fields, otherwise false. */
778 match_equal(const struct match *a, const struct match *b)
780 return (flow_wildcards_equal(&a->wc, &b->wc)
781 && flow_equal(&a->flow, &b->flow));
784 /* Returns a hash value for the flow and wildcards in 'match', starting from
787 match_hash(const struct match *match, uint32_t basis)
789 return flow_wildcards_hash(&match->wc, flow_hash(&match->flow, basis));
793 match_has_default_recirc_id(const struct match *m)
795 return m->flow.recirc_id == 0 && (m->wc.masks.recirc_id == UINT32_MAX ||
796 m->wc.masks.recirc_id == 0);
800 match_has_default_dp_hash(const struct match *m)
802 return ((m->flow.dp_hash | m->wc.masks.dp_hash) == 0);
805 /* Return true if the hidden fields of the match are set to the default values.
806 * The default values equals to those set up by match_init_hidden_fields(). */
808 match_has_default_hidden_fields(const struct match *m)
810 return match_has_default_recirc_id(m) && match_has_default_dp_hash(m);
814 match_init_hidden_fields(struct match *m)
816 match_set_recirc_id(m, 0);
817 match_set_dp_hash_masked(m, 0, 0);
821 format_eth_masked(struct ds *s, const char *name, const uint8_t eth[6],
822 const uint8_t mask[6])
824 if (!eth_addr_is_zero(mask)) {
825 ds_put_format(s, "%s=", name);
826 eth_format_masked(eth, mask, s);
832 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
836 ds_put_format(s, "%s=", name);
837 ip_format_masked(ip, netmask, s);
843 format_ipv6_netmask(struct ds *s, const char *name,
844 const struct in6_addr *addr,
845 const struct in6_addr *netmask)
847 if (!ipv6_mask_is_any(netmask)) {
848 ds_put_format(s, "%s=", name);
849 print_ipv6_masked(s, addr, netmask);
855 format_be16_masked(struct ds *s, const char *name,
856 ovs_be16 value, ovs_be16 mask)
858 if (mask != htons(0)) {
859 ds_put_format(s, "%s=", name);
860 if (mask == OVS_BE16_MAX) {
861 ds_put_format(s, "%"PRIu16, ntohs(value));
863 ds_put_format(s, "0x%"PRIx16"/0x%"PRIx16,
864 ntohs(value), ntohs(mask));
871 format_be32_masked(struct ds *s, const char *name,
872 ovs_be32 value, ovs_be32 mask)
874 if (mask != htonl(0)) {
875 ds_put_format(s, "%s=", name);
876 if (mask == OVS_BE32_MAX) {
877 ds_put_format(s, "%"PRIu32, ntohl(value));
879 ds_put_format(s, "0x%"PRIx32"/0x%"PRIx32,
880 ntohl(value), ntohl(mask));
887 format_uint32_masked(struct ds *s, const char *name,
888 uint32_t value, uint32_t mask)
891 ds_put_format(s, "%s=%#"PRIx32, name, value);
892 if (mask != UINT32_MAX) {
893 ds_put_format(s, "/%#"PRIx32, mask);
900 format_be64_masked(struct ds *s, const char *name,
901 ovs_be64 value, ovs_be64 mask)
903 if (mask != htonll(0)) {
904 ds_put_format(s, "%s=%#"PRIx64, name, ntohll(value));
905 if (mask != OVS_BE64_MAX) {
906 ds_put_format(s, "/%#"PRIx64, ntohll(mask));
913 format_flow_tunnel(struct ds *s, const struct match *match)
915 const struct flow_wildcards *wc = &match->wc;
916 const struct flow_tnl *tnl = &match->flow.tunnel;
918 format_be64_masked(s, "tun_id", tnl->tun_id, wc->masks.tunnel.tun_id);
919 format_ip_netmask(s, "tun_src", tnl->ip_src, wc->masks.tunnel.ip_src);
920 format_ip_netmask(s, "tun_dst", tnl->ip_dst, wc->masks.tunnel.ip_dst);
922 if (wc->masks.tunnel.ip_tos) {
923 ds_put_format(s, "tun_tos=%"PRIx8",", tnl->ip_tos);
925 if (wc->masks.tunnel.ip_ttl) {
926 ds_put_format(s, "tun_ttl=%"PRIu8",", tnl->ip_ttl);
928 if (wc->masks.tunnel.flags) {
929 format_flags(s, flow_tun_flag_to_string, tnl->flags, '|');
934 /* Appends a string representation of 'match' to 's'. If 'priority' is
935 * different from OFP_DEFAULT_PRIORITY, includes it in 's'. */
937 match_format(const struct match *match, struct ds *s, unsigned int priority)
939 const struct flow_wildcards *wc = &match->wc;
940 size_t start_len = s->length;
941 const struct flow *f = &match->flow;
942 bool skip_type = false;
943 bool skip_proto = false;
947 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 27);
949 if (priority != OFP_DEFAULT_PRIORITY) {
950 ds_put_format(s, "priority=%u,", priority);
953 format_uint32_masked(s, "pkt_mark", f->pkt_mark, wc->masks.pkt_mark);
955 if (wc->masks.recirc_id) {
956 format_uint32_masked(s, "recirc_id", f->recirc_id,
957 wc->masks.recirc_id);
960 if (f->dp_hash && wc->masks.dp_hash) {
961 format_uint32_masked(s, "dp_hash", f->dp_hash,
965 if (wc->masks.skb_priority) {
966 ds_put_format(s, "skb_priority=%#"PRIx32",", f->skb_priority);
969 if (wc->masks.dl_type) {
971 if (f->dl_type == htons(ETH_TYPE_IP)) {
972 if (wc->masks.nw_proto) {
974 if (f->nw_proto == IPPROTO_ICMP) {
975 ds_put_cstr(s, "icmp,");
976 } else if (f->nw_proto == IPPROTO_IGMP) {
977 ds_put_cstr(s, "igmp,");
978 } else if (f->nw_proto == IPPROTO_TCP) {
979 ds_put_cstr(s, "tcp,");
980 } else if (f->nw_proto == IPPROTO_UDP) {
981 ds_put_cstr(s, "udp,");
982 } else if (f->nw_proto == IPPROTO_SCTP) {
983 ds_put_cstr(s, "sctp,");
985 ds_put_cstr(s, "ip,");
989 ds_put_cstr(s, "ip,");
991 } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
992 if (wc->masks.nw_proto) {
994 if (f->nw_proto == IPPROTO_ICMPV6) {
995 ds_put_cstr(s, "icmp6,");
996 } else if (f->nw_proto == IPPROTO_TCP) {
997 ds_put_cstr(s, "tcp6,");
998 } else if (f->nw_proto == IPPROTO_UDP) {
999 ds_put_cstr(s, "udp6,");
1000 } else if (f->nw_proto == IPPROTO_SCTP) {
1001 ds_put_cstr(s, "sctp6,");
1003 ds_put_cstr(s, "ipv6,");
1007 ds_put_cstr(s, "ipv6,");
1009 } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
1010 ds_put_cstr(s, "arp,");
1011 } else if (f->dl_type == htons(ETH_TYPE_RARP)) {
1012 ds_put_cstr(s, "rarp,");
1013 } else if (f->dl_type == htons(ETH_TYPE_MPLS)) {
1014 ds_put_cstr(s, "mpls,");
1015 } else if (f->dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
1016 ds_put_cstr(s, "mplsm,");
1021 for (i = 0; i < FLOW_N_REGS; i++) {
1022 #define REGNAME_LEN 20
1023 char regname[REGNAME_LEN];
1024 if (snprintf(regname, REGNAME_LEN, "reg%d", i) >= REGNAME_LEN) {
1025 strcpy(regname, "reg?");
1027 format_uint32_masked(s, regname, f->regs[i], wc->masks.regs[i]);
1030 format_flow_tunnel(s, match);
1032 format_be64_masked(s, "metadata", f->metadata, wc->masks.metadata);
1034 if (wc->masks.in_port.ofp_port) {
1035 ds_put_cstr(s, "in_port=");
1036 ofputil_format_port(f->in_port.ofp_port, s);
1037 ds_put_char(s, ',');
1039 if (wc->masks.vlan_tci) {
1040 ovs_be16 vid_mask = wc->masks.vlan_tci & htons(VLAN_VID_MASK);
1041 ovs_be16 pcp_mask = wc->masks.vlan_tci & htons(VLAN_PCP_MASK);
1042 ovs_be16 cfi = wc->masks.vlan_tci & htons(VLAN_CFI);
1044 if (cfi && f->vlan_tci & htons(VLAN_CFI)
1045 && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
1046 && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
1047 && (vid_mask || pcp_mask)) {
1049 ds_put_format(s, "dl_vlan=%"PRIu16",",
1050 vlan_tci_to_vid(f->vlan_tci));
1053 ds_put_format(s, "dl_vlan_pcp=%d,",
1054 vlan_tci_to_pcp(f->vlan_tci));
1056 } else if (wc->masks.vlan_tci == htons(0xffff)) {
1057 ds_put_format(s, "vlan_tci=0x%04"PRIx16",", ntohs(f->vlan_tci));
1059 ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
1060 ntohs(f->vlan_tci), ntohs(wc->masks.vlan_tci));
1063 format_eth_masked(s, "dl_src", f->dl_src, wc->masks.dl_src);
1064 format_eth_masked(s, "dl_dst", f->dl_dst, wc->masks.dl_dst);
1065 if (!skip_type && wc->masks.dl_type) {
1066 ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
1068 if (f->dl_type == htons(ETH_TYPE_IPV6)) {
1069 format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->masks.ipv6_src);
1070 format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->masks.ipv6_dst);
1071 if (wc->masks.ipv6_label) {
1072 if (wc->masks.ipv6_label == OVS_BE32_MAX) {
1073 ds_put_format(s, "ipv6_label=0x%05"PRIx32",",
1074 ntohl(f->ipv6_label));
1076 ds_put_format(s, "ipv6_label=0x%05"PRIx32"/0x%05"PRIx32",",
1077 ntohl(f->ipv6_label),
1078 ntohl(wc->masks.ipv6_label));
1081 } else if (f->dl_type == htons(ETH_TYPE_ARP) ||
1082 f->dl_type == htons(ETH_TYPE_RARP)) {
1083 format_ip_netmask(s, "arp_spa", f->nw_src, wc->masks.nw_src);
1084 format_ip_netmask(s, "arp_tpa", f->nw_dst, wc->masks.nw_dst);
1086 format_ip_netmask(s, "nw_src", f->nw_src, wc->masks.nw_src);
1087 format_ip_netmask(s, "nw_dst", f->nw_dst, wc->masks.nw_dst);
1089 if (!skip_proto && wc->masks.nw_proto) {
1090 if (f->dl_type == htons(ETH_TYPE_ARP) ||
1091 f->dl_type == htons(ETH_TYPE_RARP)) {
1092 ds_put_format(s, "arp_op=%"PRIu8",", f->nw_proto);
1094 ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
1097 if (f->dl_type == htons(ETH_TYPE_ARP) ||
1098 f->dl_type == htons(ETH_TYPE_RARP)) {
1099 format_eth_masked(s, "arp_sha", f->arp_sha, wc->masks.arp_sha);
1100 format_eth_masked(s, "arp_tha", f->arp_tha, wc->masks.arp_tha);
1102 if (wc->masks.nw_tos & IP_DSCP_MASK) {
1103 ds_put_format(s, "nw_tos=%"PRIu8",", f->nw_tos & IP_DSCP_MASK);
1105 if (wc->masks.nw_tos & IP_ECN_MASK) {
1106 ds_put_format(s, "nw_ecn=%"PRIu8",", f->nw_tos & IP_ECN_MASK);
1108 if (wc->masks.nw_ttl) {
1109 ds_put_format(s, "nw_ttl=%"PRIu8",", f->nw_ttl);
1111 if (wc->masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK)) {
1112 ds_put_format(s, "mpls_label=%"PRIu32",",
1113 mpls_lse_to_label(f->mpls_lse[0]));
1115 if (wc->masks.mpls_lse[0] & htonl(MPLS_TC_MASK)) {
1116 ds_put_format(s, "mpls_tc=%"PRIu8",",
1117 mpls_lse_to_tc(f->mpls_lse[0]));
1119 if (wc->masks.mpls_lse[0] & htonl(MPLS_TTL_MASK)) {
1120 ds_put_format(s, "mpls_ttl=%"PRIu8",",
1121 mpls_lse_to_ttl(f->mpls_lse[0]));
1123 if (wc->masks.mpls_lse[0] & htonl(MPLS_BOS_MASK)) {
1124 ds_put_format(s, "mpls_bos=%"PRIu8",",
1125 mpls_lse_to_bos(f->mpls_lse[0]));
1127 format_be32_masked(s, "mpls_lse1", f->mpls_lse[1], wc->masks.mpls_lse[1]);
1128 format_be32_masked(s, "mpls_lse2", f->mpls_lse[2], wc->masks.mpls_lse[2]);
1130 switch (wc->masks.nw_frag) {
1131 case FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER:
1132 ds_put_format(s, "nw_frag=%s,",
1133 f->nw_frag & FLOW_NW_FRAG_ANY
1134 ? (f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "first")
1135 : (f->nw_frag & FLOW_NW_FRAG_LATER ? "<error>" : "no"));
1138 case FLOW_NW_FRAG_ANY:
1139 ds_put_format(s, "nw_frag=%s,",
1140 f->nw_frag & FLOW_NW_FRAG_ANY ? "yes" : "no");
1143 case FLOW_NW_FRAG_LATER:
1144 ds_put_format(s, "nw_frag=%s,",
1145 f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "not_later");
1148 if (f->dl_type == htons(ETH_TYPE_IP) &&
1149 f->nw_proto == IPPROTO_ICMP) {
1150 format_be16_masked(s, "icmp_type", f->tp_src, wc->masks.tp_src);
1151 format_be16_masked(s, "icmp_code", f->tp_dst, wc->masks.tp_dst);
1152 } else if (f->dl_type == htons(ETH_TYPE_IP) &&
1153 f->nw_proto == IPPROTO_IGMP) {
1154 format_be16_masked(s, "igmp_type", f->tp_src, wc->masks.tp_src);
1155 format_be16_masked(s, "igmp_code", f->tp_dst, wc->masks.tp_dst);
1156 } else if (f->dl_type == htons(ETH_TYPE_IPV6) &&
1157 f->nw_proto == IPPROTO_ICMPV6) {
1158 format_be16_masked(s, "icmp_type", f->tp_src, wc->masks.tp_src);
1159 format_be16_masked(s, "icmp_code", f->tp_dst, wc->masks.tp_dst);
1160 format_ipv6_netmask(s, "nd_target", &f->nd_target,
1161 &wc->masks.nd_target);
1162 format_eth_masked(s, "nd_sll", f->arp_sha, wc->masks.arp_sha);
1163 format_eth_masked(s, "nd_tll", f->arp_tha, wc->masks.arp_tha);
1165 format_be16_masked(s, "tp_src", f->tp_src, wc->masks.tp_src);
1166 format_be16_masked(s, "tp_dst", f->tp_dst, wc->masks.tp_dst);
1168 if (is_ip_any(f) && f->nw_proto == IPPROTO_TCP && wc->masks.tcp_flags) {
1169 uint16_t mask = TCP_FLAGS(wc->masks.tcp_flags);
1170 if (mask == TCP_FLAGS(OVS_BE16_MAX)) {
1171 ds_put_format(s, "tcp_flags=0x%03"PRIx16",", ntohs(f->tcp_flags));
1173 format_flags_masked(s, "tcp_flags", packet_tcp_flag_to_string,
1174 ntohs(f->tcp_flags), mask);
1178 if (s->length > start_len && ds_last(s) == ',') {
1183 /* Converts 'match' to a string and returns the string. If 'priority' is
1184 * different from OFP_DEFAULT_PRIORITY, includes it in the string. The caller
1185 * must free the string (with free()). */
1187 match_to_string(const struct match *match, unsigned int priority)
1189 struct ds s = DS_EMPTY_INITIALIZER;
1190 match_format(match, &s, priority);
1191 return ds_steal_cstr(&s);
1195 match_print(const struct match *match)
1197 char *s = match_to_string(match, OFP_DEFAULT_PRIORITY);
1202 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1203 * with minimatch_destroy(). */
1205 minimatch_init(struct minimatch *dst, const struct match *src)
1207 minimask_init(&dst->mask, &src->wc);
1208 miniflow_init_with_minimask(&dst->flow, &src->flow, &dst->mask);
1211 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1212 * with minimatch_destroy(). */
1214 minimatch_clone(struct minimatch *dst, const struct minimatch *src)
1216 miniflow_clone(&dst->flow, &src->flow);
1217 minimask_clone(&dst->mask, &src->mask);
1220 /* Initializes 'dst' with the data in 'src', destroying 'src'. The caller must
1221 * eventually free 'dst' with minimatch_destroy(). */
1223 minimatch_move(struct minimatch *dst, struct minimatch *src)
1225 miniflow_move(&dst->flow, &src->flow);
1226 minimask_move(&dst->mask, &src->mask);
1229 /* Frees any memory owned by 'match'. Does not free the storage in which
1230 * 'match' itself resides; the caller is responsible for that. */
1232 minimatch_destroy(struct minimatch *match)
1234 miniflow_destroy(&match->flow);
1235 minimask_destroy(&match->mask);
1238 /* Initializes 'dst' as a copy of 'src'. */
1240 minimatch_expand(const struct minimatch *src, struct match *dst)
1242 miniflow_expand(&src->flow, &dst->flow);
1243 minimask_expand(&src->mask, &dst->wc);
1246 /* Returns true if 'a' and 'b' match the same packets, false otherwise. */
1248 minimatch_equal(const struct minimatch *a, const struct minimatch *b)
1250 return (miniflow_equal(&a->flow, &b->flow)
1251 && minimask_equal(&a->mask, &b->mask));
1254 /* Returns true if 'target' satisifies 'match', that is, if each bit for which
1255 * 'match' specifies a particular value has the correct value in 'target'.
1257 * This function is equivalent to miniflow_equal_flow_in_minimask(&match->flow,
1258 * target, &match->mask) but it is faster because of the invariant that
1259 * match->flow.map and match->mask.map are the same. */
1261 minimatch_matches_flow(const struct minimatch *match,
1262 const struct flow *target)
1264 const uint32_t *target_u32 = (const uint32_t *) target;
1265 const uint32_t *flowp = miniflow_get_u32_values(&match->flow);
1266 const uint32_t *maskp = miniflow_get_u32_values(&match->mask.masks);
1269 for (map = match->flow.map; map; map = zero_rightmost_1bit(map)) {
1270 if ((*flowp++ ^ target_u32[raw_ctz(map)]) & *maskp++) {
1278 /* Appends a string representation of 'match' to 's'. If 'priority' is
1279 * different from OFP_DEFAULT_PRIORITY, includes it in 's'. */
1281 minimatch_format(const struct minimatch *match, struct ds *s,
1282 unsigned int priority)
1284 struct match megamatch;
1286 minimatch_expand(match, &megamatch);
1287 match_format(&megamatch, s, priority);
1290 /* Converts 'match' to a string and returns the string. If 'priority' is
1291 * different from OFP_DEFAULT_PRIORITY, includes it in the string. The caller
1292 * must free the string (with free()). */
1294 minimatch_to_string(const struct minimatch *match, unsigned int priority)
1296 struct match megamatch;
1298 minimatch_expand(match, &megamatch);
1299 return match_to_string(&megamatch, priority);