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);
145 /* Initializes 'match' as a "catch-all" match that matches every packet. */
147 match_init_catchall(struct match *match)
149 memset(&match->flow, 0, sizeof match->flow);
150 flow_wildcards_init_catchall(&match->wc);
153 /* For each bit or field wildcarded in 'match', sets the corresponding bit or
154 * field in 'flow' to all-0-bits. It is important to maintain this invariant
155 * in a match that might be inserted into a classifier.
157 * It is never necessary to call this function directly for a match that is
158 * initialized or modified only by match_*() functions. It is useful to
159 * restore the invariant in a match whose 'wc' member is modified by hand.
162 match_zero_wildcarded_fields(struct match *match)
164 flow_zero_wildcards(&match->flow, &match->wc);
168 match_set_reg(struct match *match, unsigned int reg_idx, uint32_t value)
170 match_set_reg_masked(match, reg_idx, value, UINT32_MAX);
174 match_set_reg_masked(struct match *match, unsigned int reg_idx,
175 uint32_t value, uint32_t mask)
177 ovs_assert(reg_idx < FLOW_N_REGS);
178 flow_wildcards_set_reg_mask(&match->wc, reg_idx, mask);
179 match->flow.regs[reg_idx] = value & mask;
183 match_set_metadata(struct match *match, ovs_be64 metadata)
185 match_set_metadata_masked(match, metadata, OVS_BE64_MAX);
189 match_set_metadata_masked(struct match *match,
190 ovs_be64 metadata, ovs_be64 mask)
192 match->wc.masks.metadata = mask;
193 match->flow.metadata = metadata & mask;
197 match_set_tun_id(struct match *match, ovs_be64 tun_id)
199 match_set_tun_id_masked(match, tun_id, OVS_BE64_MAX);
203 match_set_tun_id_masked(struct match *match, ovs_be64 tun_id, ovs_be64 mask)
205 match->wc.masks.tunnel.tun_id = mask;
206 match->flow.tunnel.tun_id = tun_id & mask;
210 match_set_tun_src(struct match *match, ovs_be32 src)
212 match_set_tun_src_masked(match, src, OVS_BE32_MAX);
216 match_set_tun_src_masked(struct match *match, ovs_be32 src, ovs_be32 mask)
218 match->wc.masks.tunnel.ip_src = mask;
219 match->flow.tunnel.ip_src = src & mask;
223 match_set_tun_dst(struct match *match, ovs_be32 dst)
225 match_set_tun_dst_masked(match, dst, OVS_BE32_MAX);
229 match_set_tun_dst_masked(struct match *match, ovs_be32 dst, ovs_be32 mask)
231 match->wc.masks.tunnel.ip_dst = mask;
232 match->flow.tunnel.ip_dst = dst & mask;
236 match_set_tun_ttl(struct match *match, uint8_t ttl)
238 match_set_tun_ttl_masked(match, ttl, UINT8_MAX);
242 match_set_tun_ttl_masked(struct match *match, uint8_t ttl, uint8_t mask)
244 match->wc.masks.tunnel.ip_ttl = mask;
245 match->flow.tunnel.ip_ttl = ttl & mask;
249 match_set_tun_tos(struct match *match, uint8_t tos)
251 match_set_tun_tos_masked(match, tos, UINT8_MAX);
255 match_set_tun_tos_masked(struct match *match, uint8_t tos, uint8_t mask)
257 match->wc.masks.tunnel.ip_tos = mask;
258 match->flow.tunnel.ip_tos = tos & mask;
262 match_set_tun_flags(struct match *match, uint16_t flags)
264 match_set_tun_flags_masked(match, flags, UINT16_MAX);
268 match_set_tun_flags_masked(struct match *match, uint16_t flags, uint16_t mask)
270 match->wc.masks.tunnel.flags = mask;
271 match->flow.tunnel.flags = flags & mask;
275 match_set_in_port(struct match *match, ofp_port_t ofp_port)
277 match->wc.masks.in_port.ofp_port = u16_to_ofp(UINT16_MAX);
278 match->flow.in_port.ofp_port = ofp_port;
282 match_set_skb_priority(struct match *match, uint32_t skb_priority)
284 match->wc.masks.skb_priority = UINT32_MAX;
285 match->flow.skb_priority = skb_priority;
289 match_set_pkt_mark(struct match *match, uint32_t pkt_mark)
291 match_set_pkt_mark_masked(match, pkt_mark, UINT32_MAX);
295 match_set_pkt_mark_masked(struct match *match, uint32_t pkt_mark, uint32_t mask)
297 match->flow.pkt_mark = pkt_mark & mask;
298 match->wc.masks.pkt_mark = mask;
302 match_set_dl_type(struct match *match, ovs_be16 dl_type)
304 match->wc.masks.dl_type = OVS_BE16_MAX;
305 match->flow.dl_type = dl_type;
308 /* Modifies 'value_src' so that the Ethernet address must match 'value_dst'
309 * exactly. 'mask_dst' is set to all 1s. */
311 set_eth(const uint8_t value_src[ETH_ADDR_LEN],
312 uint8_t value_dst[ETH_ADDR_LEN],
313 uint8_t mask_dst[ETH_ADDR_LEN])
315 memcpy(value_dst, value_src, ETH_ADDR_LEN);
316 memset(mask_dst, 0xff, ETH_ADDR_LEN);
319 /* Modifies 'value_src' so that the Ethernet address must match 'value_src'
320 * after each byte is ANDed with the appropriate byte in 'mask_src'.
321 * 'mask_dst' is set to 'mask_src' */
323 set_eth_masked(const uint8_t value_src[ETH_ADDR_LEN],
324 const uint8_t mask_src[ETH_ADDR_LEN],
325 uint8_t value_dst[ETH_ADDR_LEN],
326 uint8_t mask_dst[ETH_ADDR_LEN])
330 for (i = 0; i < ETH_ADDR_LEN; i++) {
331 value_dst[i] = value_src[i] & mask_src[i];
332 mask_dst[i] = mask_src[i];
336 /* Modifies 'rule' so that the source Ethernet address must match 'dl_src'
339 match_set_dl_src(struct match *match, const uint8_t dl_src[ETH_ADDR_LEN])
341 set_eth(dl_src, match->flow.dl_src, match->wc.masks.dl_src);
344 /* Modifies 'rule' so that the source Ethernet address must match 'dl_src'
345 * after each byte is ANDed with the appropriate byte in 'mask'. */
347 match_set_dl_src_masked(struct match *match,
348 const uint8_t dl_src[ETH_ADDR_LEN],
349 const uint8_t mask[ETH_ADDR_LEN])
351 set_eth_masked(dl_src, mask, match->flow.dl_src, match->wc.masks.dl_src);
354 /* Modifies 'match' so that the Ethernet address must match 'dl_dst'
357 match_set_dl_dst(struct match *match, const uint8_t dl_dst[ETH_ADDR_LEN])
359 set_eth(dl_dst, match->flow.dl_dst, match->wc.masks.dl_dst);
362 /* Modifies 'match' so that the Ethernet address must match 'dl_dst' after each
363 * byte is ANDed with the appropriate byte in 'mask'.
365 * This function will assert-fail if 'mask' is invalid. Only 'mask' values
366 * accepted by flow_wildcards_is_dl_dst_mask_valid() are allowed. */
368 match_set_dl_dst_masked(struct match *match,
369 const uint8_t dl_dst[ETH_ADDR_LEN],
370 const uint8_t mask[ETH_ADDR_LEN])
372 set_eth_masked(dl_dst, mask, match->flow.dl_dst, match->wc.masks.dl_dst);
376 match_set_dl_tci(struct match *match, ovs_be16 tci)
378 match_set_dl_tci_masked(match, tci, htons(0xffff));
382 match_set_dl_tci_masked(struct match *match, ovs_be16 tci, ovs_be16 mask)
384 match->flow.vlan_tci = tci & mask;
385 match->wc.masks.vlan_tci = mask;
388 /* Modifies 'match' so that the VLAN VID is wildcarded. If the PCP is already
389 * wildcarded, then 'match' will match a packet regardless of whether it has an
390 * 802.1Q header or not. */
392 match_set_any_vid(struct match *match)
394 if (match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK)) {
395 match->wc.masks.vlan_tci &= ~htons(VLAN_VID_MASK);
396 match->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
398 match_set_dl_tci_masked(match, htons(0), htons(0));
402 /* Modifies 'match' depending on 'dl_vlan':
404 * - If 'dl_vlan' is htons(OFP_VLAN_NONE), makes 'match' match only packets
405 * without an 802.1Q header.
407 * - Otherwise, makes 'match' match only packets with an 802.1Q header whose
408 * VID equals the low 12 bits of 'dl_vlan'.
411 match_set_dl_vlan(struct match *match, ovs_be16 dl_vlan)
413 flow_set_dl_vlan(&match->flow, dl_vlan);
414 if (dl_vlan == htons(OFP10_VLAN_NONE)) {
415 match->wc.masks.vlan_tci = OVS_BE16_MAX;
417 match->wc.masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
421 /* Sets the VLAN VID that 'match' matches to 'vid', which is interpreted as an
422 * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
425 match_set_vlan_vid(struct match *match, ovs_be16 vid)
427 match_set_vlan_vid_masked(match, vid, htons(VLAN_VID_MASK | VLAN_CFI));
431 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
432 * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
433 * plus CFI), with the corresponding 'mask'. */
435 match_set_vlan_vid_masked(struct match *match, ovs_be16 vid, ovs_be16 mask)
437 ovs_be16 pcp_mask = htons(VLAN_PCP_MASK);
438 ovs_be16 vid_mask = htons(VLAN_VID_MASK | VLAN_CFI);
441 flow_set_vlan_vid(&match->flow, vid & mask);
442 match->wc.masks.vlan_tci = mask | (match->wc.masks.vlan_tci & pcp_mask);
445 /* Modifies 'match' so that the VLAN PCP is wildcarded. If the VID is already
446 * wildcarded, then 'match' will match a packet regardless of whether it has an
447 * 802.1Q header or not. */
449 match_set_any_pcp(struct match *match)
451 if (match->wc.masks.vlan_tci & htons(VLAN_VID_MASK)) {
452 match->wc.masks.vlan_tci &= ~htons(VLAN_PCP_MASK);
453 match->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
455 match_set_dl_tci_masked(match, htons(0), htons(0));
459 /* Modifies 'match' so that it matches only packets with an 802.1Q header whose
460 * PCP equals the low 3 bits of 'dl_vlan_pcp'. */
462 match_set_dl_vlan_pcp(struct match *match, uint8_t dl_vlan_pcp)
464 flow_set_vlan_pcp(&match->flow, dl_vlan_pcp);
465 match->wc.masks.vlan_tci |= htons(VLAN_CFI | VLAN_PCP_MASK);
468 /* Modifies 'match' so that the MPLS label 'idx' matches 'lse' exactly. */
470 match_set_mpls_lse(struct match *match, int idx, ovs_be32 lse)
472 match->wc.masks.mpls_lse[idx] = OVS_BE32_MAX;
473 match->flow.mpls_lse[idx] = lse;
476 /* Modifies 'match' so that the MPLS label is wildcarded. */
478 match_set_any_mpls_label(struct match *match, int idx)
480 match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_LABEL_MASK);
481 flow_set_mpls_label(&match->flow, idx, htonl(0));
484 /* Modifies 'match' so that it matches only packets with an MPLS header whose
485 * label equals the low 20 bits of 'mpls_label'. */
487 match_set_mpls_label(struct match *match, int idx, ovs_be32 mpls_label)
489 match->wc.masks.mpls_lse[idx] |= htonl(MPLS_LABEL_MASK);
490 flow_set_mpls_label(&match->flow, idx, mpls_label);
493 /* Modifies 'match' so that the MPLS TC is wildcarded. */
495 match_set_any_mpls_tc(struct match *match, int idx)
497 match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_TC_MASK);
498 flow_set_mpls_tc(&match->flow, idx, 0);
501 /* Modifies 'match' so that it matches only packets with an MPLS header whose
502 * Traffic Class equals the low 3 bits of 'mpls_tc'. */
504 match_set_mpls_tc(struct match *match, int idx, uint8_t mpls_tc)
506 match->wc.masks.mpls_lse[idx] |= htonl(MPLS_TC_MASK);
507 flow_set_mpls_tc(&match->flow, idx, mpls_tc);
510 /* Modifies 'match' so that the MPLS stack flag is wildcarded. */
512 match_set_any_mpls_bos(struct match *match, int idx)
514 match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_BOS_MASK);
515 flow_set_mpls_bos(&match->flow, idx, 0);
518 /* Modifies 'match' so that it matches only packets with an MPLS header whose
519 * Stack Flag equals the lower bit of 'mpls_bos' */
521 match_set_mpls_bos(struct match *match, int idx, uint8_t mpls_bos)
523 match->wc.masks.mpls_lse[idx] |= htonl(MPLS_BOS_MASK);
524 flow_set_mpls_bos(&match->flow, idx, mpls_bos);
527 /* Modifies 'match' so that the MPLS LSE is wildcarded. */
529 match_set_any_mpls_lse(struct match *match, int idx)
531 match->wc.masks.mpls_lse[idx] = htonl(0);
532 flow_set_mpls_lse(&match->flow, idx, htonl(0));
536 match_set_tp_src(struct match *match, ovs_be16 tp_src)
538 match_set_tp_src_masked(match, tp_src, OVS_BE16_MAX);
542 match_set_tp_src_masked(struct match *match, ovs_be16 port, ovs_be16 mask)
544 match->flow.tp_src = port & mask;
545 match->wc.masks.tp_src = mask;
549 match_set_tp_dst(struct match *match, ovs_be16 tp_dst)
551 match_set_tp_dst_masked(match, tp_dst, OVS_BE16_MAX);
555 match_set_tp_dst_masked(struct match *match, ovs_be16 port, ovs_be16 mask)
557 match->flow.tp_dst = port & mask;
558 match->wc.masks.tp_dst = mask;
562 match_set_tcp_flags(struct match *match, ovs_be16 flags)
564 match_set_tcp_flags_masked(match, flags, OVS_BE16_MAX);
568 match_set_tcp_flags_masked(struct match *match, ovs_be16 flags, ovs_be16 mask)
570 match->flow.tcp_flags = flags & mask;
571 match->wc.masks.tcp_flags = mask;
575 match_set_nw_proto(struct match *match, uint8_t nw_proto)
577 match->flow.nw_proto = nw_proto;
578 match->wc.masks.nw_proto = UINT8_MAX;
582 match_set_nw_src(struct match *match, ovs_be32 nw_src)
584 match->flow.nw_src = nw_src;
585 match->wc.masks.nw_src = OVS_BE32_MAX;
589 match_set_nw_src_masked(struct match *match,
590 ovs_be32 nw_src, ovs_be32 mask)
592 match->flow.nw_src = nw_src & mask;
593 match->wc.masks.nw_src = mask;
597 match_set_nw_dst(struct match *match, ovs_be32 nw_dst)
599 match->flow.nw_dst = nw_dst;
600 match->wc.masks.nw_dst = OVS_BE32_MAX;
604 match_set_nw_dst_masked(struct match *match, ovs_be32 ip, ovs_be32 mask)
606 match->flow.nw_dst = ip & mask;
607 match->wc.masks.nw_dst = mask;
611 match_set_nw_dscp(struct match *match, uint8_t nw_dscp)
613 match->wc.masks.nw_tos |= IP_DSCP_MASK;
614 match->flow.nw_tos &= ~IP_DSCP_MASK;
615 match->flow.nw_tos |= nw_dscp & IP_DSCP_MASK;
619 match_set_nw_ecn(struct match *match, uint8_t nw_ecn)
621 match->wc.masks.nw_tos |= IP_ECN_MASK;
622 match->flow.nw_tos &= ~IP_ECN_MASK;
623 match->flow.nw_tos |= nw_ecn & IP_ECN_MASK;
627 match_set_nw_ttl(struct match *match, uint8_t nw_ttl)
629 match->wc.masks.nw_ttl = UINT8_MAX;
630 match->flow.nw_ttl = nw_ttl;
634 match_set_nw_frag(struct match *match, uint8_t nw_frag)
636 match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
637 match->flow.nw_frag = nw_frag;
641 match_set_nw_frag_masked(struct match *match,
642 uint8_t nw_frag, uint8_t mask)
644 match->flow.nw_frag = nw_frag & mask;
645 match->wc.masks.nw_frag = mask;
649 match_set_icmp_type(struct match *match, uint8_t icmp_type)
651 match_set_tp_src(match, htons(icmp_type));
655 match_set_icmp_code(struct match *match, uint8_t icmp_code)
657 match_set_tp_dst(match, htons(icmp_code));
661 match_set_arp_sha(struct match *match, const uint8_t sha[ETH_ADDR_LEN])
663 memcpy(match->flow.arp_sha, sha, ETH_ADDR_LEN);
664 memset(match->wc.masks.arp_sha, UINT8_MAX, ETH_ADDR_LEN);
668 match_set_arp_sha_masked(struct match *match,
669 const uint8_t arp_sha[ETH_ADDR_LEN],
670 const uint8_t mask[ETH_ADDR_LEN])
672 set_eth_masked(arp_sha, mask,
673 match->flow.arp_sha, match->wc.masks.arp_sha);
677 match_set_arp_tha(struct match *match, const uint8_t tha[ETH_ADDR_LEN])
679 memcpy(match->flow.arp_tha, tha, ETH_ADDR_LEN);
680 memset(match->wc.masks.arp_tha, UINT8_MAX, ETH_ADDR_LEN);
684 match_set_arp_tha_masked(struct match *match,
685 const uint8_t arp_tha[ETH_ADDR_LEN],
686 const uint8_t mask[ETH_ADDR_LEN])
688 set_eth_masked(arp_tha, mask,
689 match->flow.arp_tha, match->wc.masks.arp_tha);
693 match_set_ipv6_src(struct match *match, const struct in6_addr *src)
695 match->flow.ipv6_src = *src;
696 match->wc.masks.ipv6_src = in6addr_exact;
700 match_set_ipv6_src_masked(struct match *match, const struct in6_addr *src,
701 const struct in6_addr *mask)
703 match->flow.ipv6_src = ipv6_addr_bitand(src, mask);
704 match->wc.masks.ipv6_src = *mask;
708 match_set_ipv6_dst(struct match *match, const struct in6_addr *dst)
710 match->flow.ipv6_dst = *dst;
711 match->wc.masks.ipv6_dst = in6addr_exact;
715 match_set_ipv6_dst_masked(struct match *match, const struct in6_addr *dst,
716 const struct in6_addr *mask)
718 match->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
719 match->wc.masks.ipv6_dst = *mask;
723 match_set_ipv6_label(struct match *match, ovs_be32 ipv6_label)
725 match->wc.masks.ipv6_label = OVS_BE32_MAX;
726 match->flow.ipv6_label = ipv6_label;
731 match_set_ipv6_label_masked(struct match *match, ovs_be32 ipv6_label,
734 match->flow.ipv6_label = ipv6_label & mask;
735 match->wc.masks.ipv6_label = mask;
739 match_set_nd_target(struct match *match, const struct in6_addr *target)
741 match->flow.nd_target = *target;
742 match->wc.masks.nd_target = in6addr_exact;
746 match_set_nd_target_masked(struct match *match,
747 const struct in6_addr *target,
748 const struct in6_addr *mask)
750 match->flow.nd_target = ipv6_addr_bitand(target, mask);
751 match->wc.masks.nd_target = *mask;
754 /* Returns true if 'a' and 'b' wildcard the same fields and have the same
755 * values for fixed fields, otherwise false. */
757 match_equal(const struct match *a, const struct match *b)
759 return (flow_wildcards_equal(&a->wc, &b->wc)
760 && flow_equal(&a->flow, &b->flow));
763 /* Returns a hash value for the flow and wildcards in 'match', starting from
766 match_hash(const struct match *match, uint32_t basis)
768 return flow_wildcards_hash(&match->wc, flow_hash(&match->flow, basis));
772 format_eth_masked(struct ds *s, const char *name, const uint8_t eth[6],
773 const uint8_t mask[6])
775 if (!eth_addr_is_zero(mask)) {
776 ds_put_format(s, "%s=", name);
777 eth_format_masked(eth, mask, s);
783 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
787 ds_put_format(s, "%s=", name);
788 ip_format_masked(ip, netmask, s);
794 format_ipv6_netmask(struct ds *s, const char *name,
795 const struct in6_addr *addr,
796 const struct in6_addr *netmask)
798 if (!ipv6_mask_is_any(netmask)) {
799 ds_put_format(s, "%s=", name);
800 print_ipv6_masked(s, addr, netmask);
806 format_be16_masked(struct ds *s, const char *name,
807 ovs_be16 value, ovs_be16 mask)
809 if (mask != htons(0)) {
810 ds_put_format(s, "%s=", name);
811 if (mask == OVS_BE16_MAX) {
812 ds_put_format(s, "%"PRIu16, ntohs(value));
814 ds_put_format(s, "0x%"PRIx16"/0x%"PRIx16,
815 ntohs(value), ntohs(mask));
822 format_be32_masked(struct ds *s, const char *name,
823 ovs_be32 value, ovs_be32 mask)
825 if (mask != htonl(0)) {
826 ds_put_format(s, "%s=", name);
827 if (mask == OVS_BE32_MAX) {
828 ds_put_format(s, "%"PRIu32, ntohl(value));
830 ds_put_format(s, "0x%"PRIx32"/0x%"PRIx32,
831 ntohl(value), ntohl(mask));
838 format_uint32_masked(struct ds *s, const char *name,
839 uint32_t value, uint32_t mask)
842 ds_put_format(s, "%s=%#"PRIx32, name, value);
843 if (mask != UINT32_MAX) {
844 ds_put_format(s, "/%#"PRIx32, mask);
851 format_be64_masked(struct ds *s, const char *name,
852 ovs_be64 value, ovs_be64 mask)
854 if (mask != htonll(0)) {
855 ds_put_format(s, "%s=%#"PRIx64, name, ntohll(value));
856 if (mask != OVS_BE64_MAX) {
857 ds_put_format(s, "/%#"PRIx64, ntohll(mask));
864 format_flow_tunnel(struct ds *s, const struct match *match)
866 const struct flow_wildcards *wc = &match->wc;
867 const struct flow_tnl *tnl = &match->flow.tunnel;
869 format_be64_masked(s, "tun_id", tnl->tun_id, wc->masks.tunnel.tun_id);
870 format_ip_netmask(s, "tun_src", tnl->ip_src, wc->masks.tunnel.ip_src);
871 format_ip_netmask(s, "tun_dst", tnl->ip_dst, wc->masks.tunnel.ip_dst);
873 if (wc->masks.tunnel.ip_tos) {
874 ds_put_format(s, "tun_tos=%"PRIx8",", tnl->ip_tos);
876 if (wc->masks.tunnel.ip_ttl) {
877 ds_put_format(s, "tun_ttl=%"PRIu8",", tnl->ip_ttl);
879 if (wc->masks.tunnel.flags) {
880 format_flags(s, flow_tun_flag_to_string, tnl->flags, '|');
885 /* Appends a string representation of 'match' to 's'. If 'priority' is
886 * different from OFP_DEFAULT_PRIORITY, includes it in 's'. */
888 match_format(const struct match *match, struct ds *s, unsigned int priority)
890 const struct flow_wildcards *wc = &match->wc;
891 size_t start_len = s->length;
892 const struct flow *f = &match->flow;
893 bool skip_type = false;
894 bool skip_proto = false;
898 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 24);
900 if (priority != OFP_DEFAULT_PRIORITY) {
901 ds_put_format(s, "priority=%u,", priority);
904 format_uint32_masked(s, "pkt_mark", f->pkt_mark, wc->masks.pkt_mark);
906 if (wc->masks.skb_priority) {
907 ds_put_format(s, "skb_priority=%#"PRIx32",", f->skb_priority);
910 if (wc->masks.dl_type) {
912 if (f->dl_type == htons(ETH_TYPE_IP)) {
913 if (wc->masks.nw_proto) {
915 if (f->nw_proto == IPPROTO_ICMP) {
916 ds_put_cstr(s, "icmp,");
917 } else if (f->nw_proto == IPPROTO_TCP) {
918 ds_put_cstr(s, "tcp,");
919 } else if (f->nw_proto == IPPROTO_UDP) {
920 ds_put_cstr(s, "udp,");
921 } else if (f->nw_proto == IPPROTO_SCTP) {
922 ds_put_cstr(s, "sctp,");
924 ds_put_cstr(s, "ip,");
928 ds_put_cstr(s, "ip,");
930 } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
931 if (wc->masks.nw_proto) {
933 if (f->nw_proto == IPPROTO_ICMPV6) {
934 ds_put_cstr(s, "icmp6,");
935 } else if (f->nw_proto == IPPROTO_TCP) {
936 ds_put_cstr(s, "tcp6,");
937 } else if (f->nw_proto == IPPROTO_UDP) {
938 ds_put_cstr(s, "udp6,");
939 } else if (f->nw_proto == IPPROTO_SCTP) {
940 ds_put_cstr(s, "sctp6,");
942 ds_put_cstr(s, "ipv6,");
946 ds_put_cstr(s, "ipv6,");
948 } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
949 ds_put_cstr(s, "arp,");
950 } else if (f->dl_type == htons(ETH_TYPE_RARP)) {
951 ds_put_cstr(s, "rarp,");
952 } else if (f->dl_type == htons(ETH_TYPE_MPLS)) {
953 ds_put_cstr(s, "mpls,");
954 } else if (f->dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
955 ds_put_cstr(s, "mplsm,");
960 for (i = 0; i < FLOW_N_REGS; i++) {
961 #define REGNAME_LEN 20
962 char regname[REGNAME_LEN];
963 if (snprintf(regname, REGNAME_LEN, "reg%d", i) >= REGNAME_LEN) {
964 strcpy(regname, "reg?");
966 format_uint32_masked(s, regname, f->regs[i], wc->masks.regs[i]);
969 format_flow_tunnel(s, match);
971 format_be64_masked(s, "metadata", f->metadata, wc->masks.metadata);
973 if (wc->masks.in_port.ofp_port) {
974 ds_put_cstr(s, "in_port=");
975 ofputil_format_port(f->in_port.ofp_port, s);
978 if (wc->masks.vlan_tci) {
979 ovs_be16 vid_mask = wc->masks.vlan_tci & htons(VLAN_VID_MASK);
980 ovs_be16 pcp_mask = wc->masks.vlan_tci & htons(VLAN_PCP_MASK);
981 ovs_be16 cfi = wc->masks.vlan_tci & htons(VLAN_CFI);
983 if (cfi && f->vlan_tci & htons(VLAN_CFI)
984 && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
985 && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
986 && (vid_mask || pcp_mask)) {
988 ds_put_format(s, "dl_vlan=%"PRIu16",",
989 vlan_tci_to_vid(f->vlan_tci));
992 ds_put_format(s, "dl_vlan_pcp=%d,",
993 vlan_tci_to_pcp(f->vlan_tci));
995 } else if (wc->masks.vlan_tci == htons(0xffff)) {
996 ds_put_format(s, "vlan_tci=0x%04"PRIx16",", ntohs(f->vlan_tci));
998 ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
999 ntohs(f->vlan_tci), ntohs(wc->masks.vlan_tci));
1002 format_eth_masked(s, "dl_src", f->dl_src, wc->masks.dl_src);
1003 format_eth_masked(s, "dl_dst", f->dl_dst, wc->masks.dl_dst);
1004 if (!skip_type && wc->masks.dl_type) {
1005 ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
1007 if (f->dl_type == htons(ETH_TYPE_IPV6)) {
1008 format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->masks.ipv6_src);
1009 format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->masks.ipv6_dst);
1010 if (wc->masks.ipv6_label) {
1011 if (wc->masks.ipv6_label == OVS_BE32_MAX) {
1012 ds_put_format(s, "ipv6_label=0x%05"PRIx32",",
1013 ntohl(f->ipv6_label));
1015 ds_put_format(s, "ipv6_label=0x%05"PRIx32"/0x%05"PRIx32",",
1016 ntohl(f->ipv6_label),
1017 ntohl(wc->masks.ipv6_label));
1020 } else if (f->dl_type == htons(ETH_TYPE_ARP) ||
1021 f->dl_type == htons(ETH_TYPE_RARP)) {
1022 format_ip_netmask(s, "arp_spa", f->nw_src, wc->masks.nw_src);
1023 format_ip_netmask(s, "arp_tpa", f->nw_dst, wc->masks.nw_dst);
1025 format_ip_netmask(s, "nw_src", f->nw_src, wc->masks.nw_src);
1026 format_ip_netmask(s, "nw_dst", f->nw_dst, wc->masks.nw_dst);
1028 if (!skip_proto && wc->masks.nw_proto) {
1029 if (f->dl_type == htons(ETH_TYPE_ARP) ||
1030 f->dl_type == htons(ETH_TYPE_RARP)) {
1031 ds_put_format(s, "arp_op=%"PRIu8",", f->nw_proto);
1033 ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
1036 if (f->dl_type == htons(ETH_TYPE_ARP) ||
1037 f->dl_type == htons(ETH_TYPE_RARP)) {
1038 format_eth_masked(s, "arp_sha", f->arp_sha, wc->masks.arp_sha);
1039 format_eth_masked(s, "arp_tha", f->arp_tha, wc->masks.arp_tha);
1041 if (wc->masks.nw_tos & IP_DSCP_MASK) {
1042 ds_put_format(s, "nw_tos=%"PRIu8",", f->nw_tos & IP_DSCP_MASK);
1044 if (wc->masks.nw_tos & IP_ECN_MASK) {
1045 ds_put_format(s, "nw_ecn=%"PRIu8",", f->nw_tos & IP_ECN_MASK);
1047 if (wc->masks.nw_ttl) {
1048 ds_put_format(s, "nw_ttl=%"PRIu8",", f->nw_ttl);
1050 if (wc->masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK)) {
1051 ds_put_format(s, "mpls_label=%"PRIu32",",
1052 mpls_lse_to_label(f->mpls_lse[0]));
1054 if (wc->masks.mpls_lse[0] & htonl(MPLS_TC_MASK)) {
1055 ds_put_format(s, "mpls_tc=%"PRIu8",",
1056 mpls_lse_to_tc(f->mpls_lse[0]));
1058 if (wc->masks.mpls_lse[0] & htonl(MPLS_TTL_MASK)) {
1059 ds_put_format(s, "mpls_ttl=%"PRIu8",",
1060 mpls_lse_to_ttl(f->mpls_lse[0]));
1062 if (wc->masks.mpls_lse[0] & htonl(MPLS_BOS_MASK)) {
1063 ds_put_format(s, "mpls_bos=%"PRIu8",",
1064 mpls_lse_to_bos(f->mpls_lse[0]));
1066 format_be32_masked(s, "mpls_lse1", f->mpls_lse[1], wc->masks.mpls_lse[1]);
1067 format_be32_masked(s, "mpls_lse2", f->mpls_lse[2], wc->masks.mpls_lse[2]);
1069 switch (wc->masks.nw_frag) {
1070 case FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER:
1071 ds_put_format(s, "nw_frag=%s,",
1072 f->nw_frag & FLOW_NW_FRAG_ANY
1073 ? (f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "first")
1074 : (f->nw_frag & FLOW_NW_FRAG_LATER ? "<error>" : "no"));
1077 case FLOW_NW_FRAG_ANY:
1078 ds_put_format(s, "nw_frag=%s,",
1079 f->nw_frag & FLOW_NW_FRAG_ANY ? "yes" : "no");
1082 case FLOW_NW_FRAG_LATER:
1083 ds_put_format(s, "nw_frag=%s,",
1084 f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "not_later");
1087 if (f->dl_type == htons(ETH_TYPE_IP) &&
1088 f->nw_proto == IPPROTO_ICMP) {
1089 format_be16_masked(s, "icmp_type", f->tp_src, wc->masks.tp_src);
1090 format_be16_masked(s, "icmp_code", f->tp_dst, wc->masks.tp_dst);
1091 } else if (f->dl_type == htons(ETH_TYPE_IPV6) &&
1092 f->nw_proto == IPPROTO_ICMPV6) {
1093 format_be16_masked(s, "icmp_type", f->tp_src, wc->masks.tp_src);
1094 format_be16_masked(s, "icmp_code", f->tp_dst, wc->masks.tp_dst);
1095 format_ipv6_netmask(s, "nd_target", &f->nd_target,
1096 &wc->masks.nd_target);
1097 format_eth_masked(s, "nd_sll", f->arp_sha, wc->masks.arp_sha);
1098 format_eth_masked(s, "nd_tll", f->arp_tha, wc->masks.arp_tha);
1100 format_be16_masked(s, "tp_src", f->tp_src, wc->masks.tp_src);
1101 format_be16_masked(s, "tp_dst", f->tp_dst, wc->masks.tp_dst);
1103 if (is_ip_any(f) && f->nw_proto == IPPROTO_TCP && wc->masks.tcp_flags) {
1104 uint16_t mask = TCP_FLAGS(wc->masks.tcp_flags);
1105 if (mask == TCP_FLAGS(OVS_BE16_MAX)) {
1106 ds_put_format(s, "tcp_flags=0x%03"PRIx16",", ntohs(f->tcp_flags));
1108 format_flags_masked(s, "tcp_flags", packet_tcp_flag_to_string,
1109 ntohs(f->tcp_flags), mask);
1113 if (s->length > start_len && ds_last(s) == ',') {
1118 /* Converts 'match' to a string and returns the string. If 'priority' is
1119 * different from OFP_DEFAULT_PRIORITY, includes it in the string. The caller
1120 * must free the string (with free()). */
1122 match_to_string(const struct match *match, unsigned int priority)
1124 struct ds s = DS_EMPTY_INITIALIZER;
1125 match_format(match, &s, priority);
1126 return ds_steal_cstr(&s);
1130 match_print(const struct match *match)
1132 char *s = match_to_string(match, OFP_DEFAULT_PRIORITY);
1137 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1138 * with minimatch_destroy(). */
1140 minimatch_init(struct minimatch *dst, const struct match *src)
1142 minimask_init(&dst->mask, &src->wc);
1143 miniflow_init_with_minimask(&dst->flow, &src->flow, &dst->mask);
1146 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1147 * with minimatch_destroy(). */
1149 minimatch_clone(struct minimatch *dst, const struct minimatch *src)
1151 miniflow_clone(&dst->flow, &src->flow);
1152 minimask_clone(&dst->mask, &src->mask);
1155 /* Initializes 'dst' with the data in 'src', destroying 'src'. The caller must
1156 * eventually free 'dst' with minimatch_destroy(). */
1158 minimatch_move(struct minimatch *dst, struct minimatch *src)
1160 miniflow_move(&dst->flow, &src->flow);
1161 minimask_move(&dst->mask, &src->mask);
1164 /* Frees any memory owned by 'match'. Does not free the storage in which
1165 * 'match' itself resides; the caller is responsible for that. */
1167 minimatch_destroy(struct minimatch *match)
1169 miniflow_destroy(&match->flow);
1170 minimask_destroy(&match->mask);
1173 /* Initializes 'dst' as a copy of 'src'. */
1175 minimatch_expand(const struct minimatch *src, struct match *dst)
1177 miniflow_expand(&src->flow, &dst->flow);
1178 minimask_expand(&src->mask, &dst->wc);
1181 /* Returns true if 'a' and 'b' match the same packets, false otherwise. */
1183 minimatch_equal(const struct minimatch *a, const struct minimatch *b)
1185 return (miniflow_equal(&a->flow, &b->flow)
1186 && minimask_equal(&a->mask, &b->mask));
1189 /* Returns a hash value for 'match', given 'basis'. */
1191 minimatch_hash(const struct minimatch *match, uint32_t basis)
1193 return miniflow_hash(&match->flow, minimask_hash(&match->mask, basis));
1196 /* Returns true if 'target' satisifies 'match', that is, if each bit for which
1197 * 'match' specifies a particular value has the correct value in 'target'.
1199 * This function is equivalent to miniflow_equal_flow_in_minimask(&match->flow,
1200 * target, &match->mask) but it is faster because of the invariant that
1201 * match->flow.map and match->mask.map are the same. */
1203 minimatch_matches_flow(const struct minimatch *match,
1204 const struct flow *target)
1206 const uint32_t *target_u32 = (const uint32_t *) target;
1207 const uint32_t *flowp = match->flow.values;
1208 const uint32_t *maskp = match->mask.masks.values;
1211 for (map = match->flow.map; map; map = zero_rightmost_1bit(map)) {
1212 if ((*flowp++ ^ target_u32[raw_ctz(map)]) & *maskp++) {
1220 /* Returns a hash value for the bits of range [start, end) in 'minimatch',
1223 * The hash values returned by this function are the same as those returned by
1224 * flow_hash_in_minimask_range(), only the form of the arguments differ. */
1226 minimatch_hash_range(const struct minimatch *match, uint8_t start, uint8_t end,
1229 unsigned int offset;
1230 const uint32_t *p, *q;
1231 uint32_t hash = *basis;
1234 n = count_1bits(miniflow_get_map_in_range(&match->mask.masks, start, end,
1236 q = match->mask.masks.values + offset;
1237 p = match->flow.values + offset;
1239 for (i = 0; i < n; i++) {
1240 hash = mhash_add(hash, p[i] & q[i]);
1242 *basis = hash; /* Allow continuation from the unfinished value. */
1243 return mhash_finish(hash, (offset + n) * 4);
1246 /* Appends a string representation of 'match' to 's'. If 'priority' is
1247 * different from OFP_DEFAULT_PRIORITY, includes it in 's'. */
1249 minimatch_format(const struct minimatch *match, struct ds *s,
1250 unsigned int priority)
1252 struct match megamatch;
1254 minimatch_expand(match, &megamatch);
1255 match_format(&megamatch, s, priority);
1258 /* Converts 'match' to a string and returns the string. If 'priority' is
1259 * different from OFP_DEFAULT_PRIORITY, includes it in the string. The caller
1260 * must free the string (with free()). */
1262 minimatch_to_string(const struct minimatch *match, unsigned int priority)
1264 struct match megamatch;
1266 minimatch_expand(match, &megamatch);
1267 return match_to_string(&megamatch, priority);