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"
24 #include "tun-metadata.h"
26 /* Converts the flow in 'flow' into a match in 'match', with the given
29 match_init(struct match *match,
30 const struct flow *flow, const struct flow_wildcards *wc)
34 match_zero_wildcarded_fields(match);
35 memset(&match->tun_md, 0, sizeof match->tun_md);
38 /* Converts a flow into a match. It sets the wildcard masks based on
39 * the packet contents. It will not set the mask for fields that do not
40 * make sense for the packet type. */
42 match_wc_init(struct match *match, const struct flow *flow)
46 flow_wildcards_init_for_packet(&match->wc, flow);
47 WC_MASK_FIELD(&match->wc, regs);
48 WC_MASK_FIELD(&match->wc, metadata);
50 memset(&match->tun_md, 0, sizeof match->tun_md);
53 /* Initializes 'match' as a "catch-all" match that matches every packet. */
55 match_init_catchall(struct match *match)
57 memset(&match->flow, 0, sizeof match->flow);
58 flow_wildcards_init_catchall(&match->wc);
59 memset(&match->tun_md, 0, sizeof match->tun_md);
62 /* For each bit or field wildcarded in 'match', sets the corresponding bit or
63 * field in 'flow' to all-0-bits. It is important to maintain this invariant
64 * in a match that might be inserted into a classifier.
66 * It is never necessary to call this function directly for a match that is
67 * initialized or modified only by match_*() functions. It is useful to
68 * restore the invariant in a match whose 'wc' member is modified by hand.
71 match_zero_wildcarded_fields(struct match *match)
73 flow_zero_wildcards(&match->flow, &match->wc);
77 match_set_dp_hash(struct match *match, uint32_t value)
79 match_set_dp_hash_masked(match, value, UINT32_MAX);
83 match_set_dp_hash_masked(struct match *match, uint32_t value, uint32_t mask)
85 match->wc.masks.dp_hash = mask;
86 match->flow.dp_hash = value & mask;
90 match_set_recirc_id(struct match *match, uint32_t value)
92 match->flow.recirc_id = value;
93 match->wc.masks.recirc_id = UINT32_MAX;
97 match_set_conj_id(struct match *match, uint32_t value)
99 match->flow.conj_id = value;
100 match->wc.masks.conj_id = UINT32_MAX;
104 match_set_reg(struct match *match, unsigned int reg_idx, uint32_t value)
106 match_set_reg_masked(match, reg_idx, value, UINT32_MAX);
110 match_set_reg_masked(struct match *match, unsigned int reg_idx,
111 uint32_t value, uint32_t mask)
113 ovs_assert(reg_idx < FLOW_N_REGS);
114 flow_wildcards_set_reg_mask(&match->wc, reg_idx, mask);
115 match->flow.regs[reg_idx] = value & mask;
119 match_set_xreg(struct match *match, unsigned int xreg_idx, uint64_t value)
121 match_set_xreg_masked(match, xreg_idx, value, UINT64_MAX);
125 match_set_xreg_masked(struct match *match, unsigned int xreg_idx,
126 uint64_t value, uint64_t mask)
128 ovs_assert(xreg_idx < FLOW_N_XREGS);
129 flow_wildcards_set_xreg_mask(&match->wc, xreg_idx, mask);
130 flow_set_xreg(&match->flow, xreg_idx, value & mask);
134 match_set_actset_output(struct match *match, ofp_port_t actset_output)
136 match->wc.masks.actset_output = u16_to_ofp(UINT16_MAX);
137 match->flow.actset_output = actset_output;
141 match_set_metadata(struct match *match, ovs_be64 metadata)
143 match_set_metadata_masked(match, metadata, OVS_BE64_MAX);
147 match_set_metadata_masked(struct match *match,
148 ovs_be64 metadata, ovs_be64 mask)
150 match->wc.masks.metadata = mask;
151 match->flow.metadata = metadata & mask;
155 match_set_tun_id(struct match *match, ovs_be64 tun_id)
157 match_set_tun_id_masked(match, tun_id, OVS_BE64_MAX);
161 match_set_tun_id_masked(struct match *match, ovs_be64 tun_id, ovs_be64 mask)
163 match->wc.masks.tunnel.tun_id = mask;
164 match->flow.tunnel.tun_id = tun_id & mask;
168 match_set_tun_src(struct match *match, ovs_be32 src)
170 match_set_tun_src_masked(match, src, OVS_BE32_MAX);
174 match_set_tun_src_masked(struct match *match, ovs_be32 src, ovs_be32 mask)
176 match->wc.masks.tunnel.ip_src = mask;
177 match->flow.tunnel.ip_src = src & mask;
181 match_set_tun_dst(struct match *match, ovs_be32 dst)
183 match_set_tun_dst_masked(match, dst, OVS_BE32_MAX);
187 match_set_tun_dst_masked(struct match *match, ovs_be32 dst, ovs_be32 mask)
189 match->wc.masks.tunnel.ip_dst = mask;
190 match->flow.tunnel.ip_dst = dst & mask;
194 match_set_tun_ipv6_src(struct match *match, const struct in6_addr *src)
196 match->flow.tunnel.ipv6_src = *src;
197 match->wc.masks.tunnel.ipv6_src = in6addr_exact;
201 match_set_tun_ipv6_src_masked(struct match *match, const struct in6_addr *src,
202 const struct in6_addr *mask)
204 match->flow.tunnel.ipv6_src = ipv6_addr_bitand(src, mask);
205 match->wc.masks.tunnel.ipv6_src = *mask;
209 match_set_tun_ipv6_dst(struct match *match, const struct in6_addr *dst)
211 match->flow.tunnel.ipv6_dst = *dst;
212 match->wc.masks.tunnel.ipv6_dst = in6addr_exact;
216 match_set_tun_ipv6_dst_masked(struct match *match, const struct in6_addr *dst,
217 const struct in6_addr *mask)
219 match->flow.tunnel.ipv6_dst = ipv6_addr_bitand(dst, mask);
220 match->wc.masks.tunnel.ipv6_dst = *mask;
224 match_set_tun_ttl(struct match *match, uint8_t ttl)
226 match_set_tun_ttl_masked(match, ttl, UINT8_MAX);
230 match_set_tun_ttl_masked(struct match *match, uint8_t ttl, uint8_t mask)
232 match->wc.masks.tunnel.ip_ttl = mask;
233 match->flow.tunnel.ip_ttl = ttl & mask;
237 match_set_tun_tos(struct match *match, uint8_t tos)
239 match_set_tun_tos_masked(match, tos, UINT8_MAX);
243 match_set_tun_tos_masked(struct match *match, uint8_t tos, uint8_t mask)
245 match->wc.masks.tunnel.ip_tos = mask;
246 match->flow.tunnel.ip_tos = tos & mask;
250 match_set_tun_flags(struct match *match, uint16_t flags)
252 match_set_tun_flags_masked(match, flags, UINT16_MAX);
256 match_set_tun_flags_masked(struct match *match, uint16_t flags, uint16_t mask)
258 mask &= FLOW_TNL_PUB_F_MASK;
260 match->wc.masks.tunnel.flags = mask;
261 match->flow.tunnel.flags = flags & mask;
265 match_set_tun_gbp_id_masked(struct match *match, ovs_be16 gbp_id, ovs_be16 mask)
267 match->wc.masks.tunnel.gbp_id = mask;
268 match->flow.tunnel.gbp_id = gbp_id & mask;
272 match_set_tun_gbp_id(struct match *match, ovs_be16 gbp_id)
274 match_set_tun_gbp_id_masked(match, gbp_id, OVS_BE16_MAX);
278 match_set_tun_gbp_flags_masked(struct match *match, uint8_t flags, uint8_t mask)
280 match->wc.masks.tunnel.gbp_flags = mask;
281 match->flow.tunnel.gbp_flags = flags & mask;
285 match_set_tun_gbp_flags(struct match *match, uint8_t flags)
287 match_set_tun_gbp_flags_masked(match, flags, UINT8_MAX);
291 match_set_in_port(struct match *match, ofp_port_t ofp_port)
293 match->wc.masks.in_port.ofp_port = u16_to_ofp(UINT16_MAX);
294 match->flow.in_port.ofp_port = ofp_port;
298 match_set_skb_priority(struct match *match, uint32_t skb_priority)
300 match->wc.masks.skb_priority = UINT32_MAX;
301 match->flow.skb_priority = skb_priority;
305 match_set_pkt_mark(struct match *match, uint32_t pkt_mark)
307 match_set_pkt_mark_masked(match, pkt_mark, UINT32_MAX);
311 match_set_pkt_mark_masked(struct match *match, uint32_t pkt_mark, uint32_t mask)
313 match->flow.pkt_mark = pkt_mark & mask;
314 match->wc.masks.pkt_mark = mask;
318 match_set_ct_state(struct match *match, uint32_t ct_state)
320 match_set_ct_state_masked(match, ct_state, UINT32_MAX);
324 match_set_ct_state_masked(struct match *match, uint32_t ct_state, uint32_t mask)
326 match->flow.ct_state = ct_state & mask & UINT16_MAX;
327 match->wc.masks.ct_state = mask & UINT16_MAX;
331 match_set_ct_zone(struct match *match, uint16_t ct_zone)
333 match->flow.ct_zone = ct_zone;
334 match->wc.masks.ct_zone = UINT16_MAX;
338 match_set_ct_mark(struct match *match, uint32_t ct_mark)
340 match_set_ct_mark_masked(match, ct_mark, UINT32_MAX);
344 match_set_ct_mark_masked(struct match *match, uint32_t ct_mark,
347 match->flow.ct_mark = ct_mark & mask;
348 match->wc.masks.ct_mark = mask;
352 match_set_ct_label(struct match *match, ovs_u128 ct_label)
356 mask.u64.lo = UINT64_MAX;
357 mask.u64.hi = UINT64_MAX;
358 match_set_ct_label_masked(match, ct_label, mask);
362 match_set_ct_label_masked(struct match *match, ovs_u128 value, ovs_u128 mask)
364 match->flow.ct_label.u64.lo = value.u64.lo & mask.u64.lo;
365 match->flow.ct_label.u64.hi = value.u64.hi & mask.u64.hi;
366 match->wc.masks.ct_label = mask;
370 match_set_dl_type(struct match *match, ovs_be16 dl_type)
372 match->wc.masks.dl_type = OVS_BE16_MAX;
373 match->flow.dl_type = dl_type;
376 /* Modifies 'value_src' so that the Ethernet address must match 'value_dst'
377 * exactly. 'mask_dst' is set to all 1s. */
379 set_eth(const struct eth_addr value_src,
380 struct eth_addr *value_dst,
381 struct eth_addr *mask_dst)
383 *value_dst = value_src;
384 *mask_dst = eth_addr_exact;
387 /* Modifies 'value_src' so that the Ethernet address must match 'value_src'
388 * after each byte is ANDed with the appropriate byte in 'mask_src'.
389 * 'mask_dst' is set to 'mask_src' */
391 set_eth_masked(const struct eth_addr value_src,
392 const struct eth_addr mask_src,
393 struct eth_addr *value_dst, struct eth_addr *mask_dst)
397 for (i = 0; i < ARRAY_SIZE(value_dst->be16); i++) {
398 value_dst->be16[i] = value_src.be16[i] & mask_src.be16[i];
400 *mask_dst = mask_src;
403 /* Modifies 'rule' so that the source Ethernet address must match 'dl_src'
406 match_set_dl_src(struct match *match, const struct eth_addr dl_src)
408 set_eth(dl_src, &match->flow.dl_src, &match->wc.masks.dl_src);
411 /* Modifies 'rule' so that the source Ethernet address must match 'dl_src'
412 * after each byte is ANDed with the appropriate byte in 'mask'. */
414 match_set_dl_src_masked(struct match *match,
415 const struct eth_addr dl_src,
416 const struct eth_addr mask)
418 set_eth_masked(dl_src, mask, &match->flow.dl_src, &match->wc.masks.dl_src);
421 /* Modifies 'match' so that the Ethernet address must match 'dl_dst'
424 match_set_dl_dst(struct match *match, const struct eth_addr dl_dst)
426 set_eth(dl_dst, &match->flow.dl_dst, &match->wc.masks.dl_dst);
429 /* Modifies 'match' so that the Ethernet address must match 'dl_dst' after each
430 * byte is ANDed with the appropriate byte in 'mask'.
432 * This function will assert-fail if 'mask' is invalid. Only 'mask' values
433 * accepted by flow_wildcards_is_dl_dst_mask_valid() are allowed. */
435 match_set_dl_dst_masked(struct match *match,
436 const struct eth_addr dl_dst,
437 const struct eth_addr mask)
439 set_eth_masked(dl_dst, mask, &match->flow.dl_dst, &match->wc.masks.dl_dst);
443 match_set_dl_tci(struct match *match, ovs_be16 tci)
445 match_set_dl_tci_masked(match, tci, htons(0xffff));
449 match_set_dl_tci_masked(struct match *match, ovs_be16 tci, ovs_be16 mask)
451 match->flow.vlan_tci = tci & mask;
452 match->wc.masks.vlan_tci = mask;
455 /* Modifies 'match' so that the VLAN VID is wildcarded. If the PCP is already
456 * wildcarded, then 'match' will match a packet regardless of whether it has an
457 * 802.1Q header or not. */
459 match_set_any_vid(struct match *match)
461 if (match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK)) {
462 match->wc.masks.vlan_tci &= ~htons(VLAN_VID_MASK);
463 match->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
465 match_set_dl_tci_masked(match, htons(0), htons(0));
469 /* Modifies 'match' depending on 'dl_vlan':
471 * - If 'dl_vlan' is htons(OFP_VLAN_NONE), makes 'match' match only packets
472 * without an 802.1Q header.
474 * - Otherwise, makes 'match' match only packets with an 802.1Q header whose
475 * VID equals the low 12 bits of 'dl_vlan'.
478 match_set_dl_vlan(struct match *match, ovs_be16 dl_vlan)
480 flow_set_dl_vlan(&match->flow, dl_vlan);
481 if (dl_vlan == htons(OFP10_VLAN_NONE)) {
482 match->wc.masks.vlan_tci = OVS_BE16_MAX;
484 match->wc.masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
488 /* Sets the VLAN VID that 'match' matches to 'vid', which is interpreted as an
489 * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
492 match_set_vlan_vid(struct match *match, ovs_be16 vid)
494 match_set_vlan_vid_masked(match, vid, htons(VLAN_VID_MASK | VLAN_CFI));
498 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
499 * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
500 * plus CFI), with the corresponding 'mask'. */
502 match_set_vlan_vid_masked(struct match *match, ovs_be16 vid, ovs_be16 mask)
504 ovs_be16 pcp_mask = htons(VLAN_PCP_MASK);
505 ovs_be16 vid_mask = htons(VLAN_VID_MASK | VLAN_CFI);
508 flow_set_vlan_vid(&match->flow, vid & mask);
509 match->wc.masks.vlan_tci = mask | (match->wc.masks.vlan_tci & pcp_mask);
512 /* Modifies 'match' so that the VLAN PCP is wildcarded. If the VID is already
513 * wildcarded, then 'match' will match a packet regardless of whether it has an
514 * 802.1Q header or not. */
516 match_set_any_pcp(struct match *match)
518 if (match->wc.masks.vlan_tci & htons(VLAN_VID_MASK)) {
519 match->wc.masks.vlan_tci &= ~htons(VLAN_PCP_MASK);
520 match->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
522 match_set_dl_tci_masked(match, htons(0), htons(0));
526 /* Modifies 'match' so that it matches only packets with an 802.1Q header whose
527 * PCP equals the low 3 bits of 'dl_vlan_pcp'. */
529 match_set_dl_vlan_pcp(struct match *match, uint8_t dl_vlan_pcp)
531 flow_set_vlan_pcp(&match->flow, dl_vlan_pcp);
532 match->wc.masks.vlan_tci |= htons(VLAN_CFI | VLAN_PCP_MASK);
535 /* Modifies 'match' so that the MPLS label 'idx' matches 'lse' exactly. */
537 match_set_mpls_lse(struct match *match, int idx, ovs_be32 lse)
539 match->wc.masks.mpls_lse[idx] = OVS_BE32_MAX;
540 match->flow.mpls_lse[idx] = lse;
543 /* Modifies 'match' so that the MPLS label is wildcarded. */
545 match_set_any_mpls_label(struct match *match, int idx)
547 match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_LABEL_MASK);
548 flow_set_mpls_label(&match->flow, idx, htonl(0));
551 /* Modifies 'match' so that it matches only packets with an MPLS header whose
552 * label equals the low 20 bits of 'mpls_label'. */
554 match_set_mpls_label(struct match *match, int idx, ovs_be32 mpls_label)
556 match->wc.masks.mpls_lse[idx] |= htonl(MPLS_LABEL_MASK);
557 flow_set_mpls_label(&match->flow, idx, mpls_label);
560 /* Modifies 'match' so that the MPLS TC is wildcarded. */
562 match_set_any_mpls_tc(struct match *match, int idx)
564 match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_TC_MASK);
565 flow_set_mpls_tc(&match->flow, idx, 0);
568 /* Modifies 'match' so that it matches only packets with an MPLS header whose
569 * Traffic Class equals the low 3 bits of 'mpls_tc'. */
571 match_set_mpls_tc(struct match *match, int idx, uint8_t mpls_tc)
573 match->wc.masks.mpls_lse[idx] |= htonl(MPLS_TC_MASK);
574 flow_set_mpls_tc(&match->flow, idx, mpls_tc);
577 /* Modifies 'match' so that the MPLS stack flag is wildcarded. */
579 match_set_any_mpls_bos(struct match *match, int idx)
581 match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_BOS_MASK);
582 flow_set_mpls_bos(&match->flow, idx, 0);
585 /* Modifies 'match' so that it matches only packets with an MPLS header whose
586 * Stack Flag equals the lower bit of 'mpls_bos' */
588 match_set_mpls_bos(struct match *match, int idx, uint8_t mpls_bos)
590 match->wc.masks.mpls_lse[idx] |= htonl(MPLS_BOS_MASK);
591 flow_set_mpls_bos(&match->flow, idx, mpls_bos);
594 /* Modifies 'match' so that the MPLS LSE is wildcarded. */
596 match_set_any_mpls_lse(struct match *match, int idx)
598 match->wc.masks.mpls_lse[idx] = htonl(0);
599 flow_set_mpls_lse(&match->flow, idx, htonl(0));
603 match_set_tp_src(struct match *match, ovs_be16 tp_src)
605 match_set_tp_src_masked(match, tp_src, OVS_BE16_MAX);
609 match_set_tp_src_masked(struct match *match, ovs_be16 port, ovs_be16 mask)
611 match->flow.tp_src = port & mask;
612 match->wc.masks.tp_src = mask;
616 match_set_tp_dst(struct match *match, ovs_be16 tp_dst)
618 match_set_tp_dst_masked(match, tp_dst, OVS_BE16_MAX);
622 match_set_tp_dst_masked(struct match *match, ovs_be16 port, ovs_be16 mask)
624 match->flow.tp_dst = port & mask;
625 match->wc.masks.tp_dst = mask;
629 match_set_tcp_flags(struct match *match, ovs_be16 flags)
631 match_set_tcp_flags_masked(match, flags, OVS_BE16_MAX);
635 match_set_tcp_flags_masked(struct match *match, ovs_be16 flags, ovs_be16 mask)
637 match->flow.tcp_flags = flags & mask;
638 match->wc.masks.tcp_flags = mask;
642 match_set_nw_proto(struct match *match, uint8_t nw_proto)
644 match->flow.nw_proto = nw_proto;
645 match->wc.masks.nw_proto = UINT8_MAX;
649 match_set_nw_src(struct match *match, ovs_be32 nw_src)
651 match->flow.nw_src = nw_src;
652 match->wc.masks.nw_src = OVS_BE32_MAX;
656 match_set_nw_src_masked(struct match *match,
657 ovs_be32 nw_src, ovs_be32 mask)
659 match->flow.nw_src = nw_src & mask;
660 match->wc.masks.nw_src = mask;
664 match_set_nw_dst(struct match *match, ovs_be32 nw_dst)
666 match->flow.nw_dst = nw_dst;
667 match->wc.masks.nw_dst = OVS_BE32_MAX;
671 match_set_nw_dst_masked(struct match *match, ovs_be32 ip, ovs_be32 mask)
673 match->flow.nw_dst = ip & mask;
674 match->wc.masks.nw_dst = mask;
678 match_set_nw_dscp(struct match *match, uint8_t nw_dscp)
680 match->wc.masks.nw_tos |= IP_DSCP_MASK;
681 match->flow.nw_tos &= ~IP_DSCP_MASK;
682 match->flow.nw_tos |= nw_dscp & IP_DSCP_MASK;
686 match_set_nw_ecn(struct match *match, uint8_t nw_ecn)
688 match->wc.masks.nw_tos |= IP_ECN_MASK;
689 match->flow.nw_tos &= ~IP_ECN_MASK;
690 match->flow.nw_tos |= nw_ecn & IP_ECN_MASK;
694 match_set_nw_ttl(struct match *match, uint8_t nw_ttl)
696 match->wc.masks.nw_ttl = UINT8_MAX;
697 match->flow.nw_ttl = nw_ttl;
701 match_set_nw_frag(struct match *match, uint8_t nw_frag)
703 match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
704 match->flow.nw_frag = nw_frag;
708 match_set_nw_frag_masked(struct match *match,
709 uint8_t nw_frag, uint8_t mask)
711 match->flow.nw_frag = nw_frag & mask;
712 match->wc.masks.nw_frag = mask;
716 match_set_icmp_type(struct match *match, uint8_t icmp_type)
718 match_set_tp_src(match, htons(icmp_type));
722 match_set_icmp_code(struct match *match, uint8_t icmp_code)
724 match_set_tp_dst(match, htons(icmp_code));
728 match_set_arp_sha(struct match *match, const struct eth_addr sha)
730 match->flow.arp_sha = sha;
731 match->wc.masks.arp_sha = eth_addr_exact;
735 match_set_arp_sha_masked(struct match *match,
736 const struct eth_addr arp_sha,
737 const struct eth_addr mask)
739 set_eth_masked(arp_sha, mask,
740 &match->flow.arp_sha, &match->wc.masks.arp_sha);
744 match_set_arp_tha(struct match *match, const struct eth_addr tha)
746 match->flow.arp_tha = tha;
747 match->wc.masks.arp_tha = eth_addr_exact;
751 match_set_arp_tha_masked(struct match *match,
752 const struct eth_addr arp_tha,
753 const struct eth_addr mask)
755 set_eth_masked(arp_tha, mask,
756 &match->flow.arp_tha, &match->wc.masks.arp_tha);
760 match_set_ipv6_src(struct match *match, const struct in6_addr *src)
762 match->flow.ipv6_src = *src;
763 match->wc.masks.ipv6_src = in6addr_exact;
767 match_set_ipv6_src_masked(struct match *match, const struct in6_addr *src,
768 const struct in6_addr *mask)
770 match->flow.ipv6_src = ipv6_addr_bitand(src, mask);
771 match->wc.masks.ipv6_src = *mask;
775 match_set_ipv6_dst(struct match *match, const struct in6_addr *dst)
777 match->flow.ipv6_dst = *dst;
778 match->wc.masks.ipv6_dst = in6addr_exact;
782 match_set_ipv6_dst_masked(struct match *match, const struct in6_addr *dst,
783 const struct in6_addr *mask)
785 match->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
786 match->wc.masks.ipv6_dst = *mask;
790 match_set_ipv6_label(struct match *match, ovs_be32 ipv6_label)
792 match->wc.masks.ipv6_label = OVS_BE32_MAX;
793 match->flow.ipv6_label = ipv6_label;
798 match_set_ipv6_label_masked(struct match *match, ovs_be32 ipv6_label,
801 match->flow.ipv6_label = ipv6_label & mask;
802 match->wc.masks.ipv6_label = mask;
806 match_set_nd_target(struct match *match, const struct in6_addr *target)
808 match->flow.nd_target = *target;
809 match->wc.masks.nd_target = in6addr_exact;
813 match_set_nd_target_masked(struct match *match,
814 const struct in6_addr *target,
815 const struct in6_addr *mask)
817 match->flow.nd_target = ipv6_addr_bitand(target, mask);
818 match->wc.masks.nd_target = *mask;
821 /* Returns true if 'a' and 'b' wildcard the same fields and have the same
822 * values for fixed fields, otherwise false. */
824 match_equal(const struct match *a, const struct match *b)
826 return (flow_wildcards_equal(&a->wc, &b->wc)
827 && flow_equal(&a->flow, &b->flow));
830 /* Returns a hash value for the flow and wildcards in 'match', starting from
833 match_hash(const struct match *match, uint32_t basis)
835 return flow_wildcards_hash(&match->wc, flow_hash(&match->flow, basis));
839 match_has_default_recirc_id(const struct match *m)
841 return m->flow.recirc_id == 0 && (m->wc.masks.recirc_id == UINT32_MAX ||
842 m->wc.masks.recirc_id == 0);
846 match_has_default_dp_hash(const struct match *m)
848 return ((m->flow.dp_hash | m->wc.masks.dp_hash) == 0);
851 /* Return true if the hidden fields of the match are set to the default values.
852 * The default values equals to those set up by match_init_hidden_fields(). */
854 match_has_default_hidden_fields(const struct match *m)
856 return match_has_default_recirc_id(m) && match_has_default_dp_hash(m);
860 match_init_hidden_fields(struct match *m)
862 match_set_recirc_id(m, 0);
863 match_set_dp_hash_masked(m, 0, 0);
867 format_eth_masked(struct ds *s, const char *name,
868 const struct eth_addr eth, const struct eth_addr mask)
870 if (!eth_addr_is_zero(mask)) {
871 ds_put_format(s, "%s=", name);
872 eth_format_masked(eth, &mask, s);
878 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
882 ds_put_format(s, "%s=", name);
883 ip_format_masked(ip, netmask, s);
889 format_ipv6_netmask(struct ds *s, const char *name,
890 const struct in6_addr *addr,
891 const struct in6_addr *netmask)
893 if (!ipv6_mask_is_any(netmask)) {
894 ds_put_format(s, "%s=", name);
895 ipv6_format_masked(addr, netmask, s);
901 format_uint16_masked(struct ds *s, const char *name,
902 uint16_t value, uint16_t mask)
905 ds_put_format(s, "%s=", name);
906 if (mask == UINT16_MAX) {
907 ds_put_format(s, "%"PRIu16, value);
909 ds_put_format(s, "0x%"PRIx16"/0x%"PRIx16, value, mask);
916 format_be16_masked(struct ds *s, const char *name,
917 ovs_be16 value, ovs_be16 mask)
919 if (mask != htons(0)) {
920 ds_put_format(s, "%s=", name);
921 if (mask == OVS_BE16_MAX) {
922 ds_put_format(s, "%"PRIu16, ntohs(value));
924 ds_put_format(s, "0x%"PRIx16"/0x%"PRIx16,
925 ntohs(value), ntohs(mask));
932 format_be32_masked(struct ds *s, const char *name,
933 ovs_be32 value, ovs_be32 mask)
935 if (mask != htonl(0)) {
936 ds_put_format(s, "%s=", name);
937 if (mask == OVS_BE32_MAX) {
938 ds_put_format(s, "%"PRIu32, ntohl(value));
940 ds_put_format(s, "0x%"PRIx32"/0x%"PRIx32,
941 ntohl(value), ntohl(mask));
948 format_uint32_masked(struct ds *s, const char *name,
949 uint32_t value, uint32_t mask)
952 ds_put_format(s, "%s=%#"PRIx32, name, value);
953 if (mask != UINT32_MAX) {
954 ds_put_format(s, "/%#"PRIx32, mask);
961 format_be64_masked(struct ds *s, const char *name,
962 ovs_be64 value, ovs_be64 mask)
964 if (mask != htonll(0)) {
965 ds_put_format(s, "%s=%#"PRIx64, name, ntohll(value));
966 if (mask != OVS_BE64_MAX) {
967 ds_put_format(s, "/%#"PRIx64, ntohll(mask));
974 format_flow_tunnel(struct ds *s, const struct match *match)
976 const struct flow_wildcards *wc = &match->wc;
977 const struct flow_tnl *tnl = &match->flow.tunnel;
979 format_be64_masked(s, "tun_id", tnl->tun_id, wc->masks.tunnel.tun_id);
980 format_ip_netmask(s, "tun_src", tnl->ip_src, wc->masks.tunnel.ip_src);
981 format_ip_netmask(s, "tun_dst", tnl->ip_dst, wc->masks.tunnel.ip_dst);
982 format_ipv6_netmask(s, "tun_ipv6_src", &tnl->ipv6_src,
983 &wc->masks.tunnel.ipv6_src);
984 format_ipv6_netmask(s, "tun_ipv6_dst", &tnl->ipv6_dst,
985 &wc->masks.tunnel.ipv6_dst);
987 if (wc->masks.tunnel.gbp_id) {
988 format_be16_masked(s, "tun_gbp_id", tnl->gbp_id,
989 wc->masks.tunnel.gbp_id);
992 if (wc->masks.tunnel.gbp_flags) {
993 ds_put_format(s, "tun_gbp_flags=%#"PRIx8",", tnl->gbp_flags);
996 if (wc->masks.tunnel.ip_tos) {
997 ds_put_format(s, "tun_tos=%"PRIx8",", tnl->ip_tos);
999 if (wc->masks.tunnel.ip_ttl) {
1000 ds_put_format(s, "tun_ttl=%"PRIu8",", tnl->ip_ttl);
1002 if (wc->masks.tunnel.flags) {
1003 format_flags_masked(s, "tun_flags", flow_tun_flag_to_string,
1005 wc->masks.tunnel.flags & FLOW_TNL_F_MASK,
1007 ds_put_char(s, ',');
1009 tun_metadata_match_format(s, match);
1013 format_ct_label_masked(struct ds *s, const ovs_u128 *key, const ovs_u128 *mask)
1015 if (!ovs_u128_is_zero(mask)) {
1016 ovs_be128 value = hton128(*key);
1017 ds_put_format(s, "ct_label=");
1018 ds_put_hex(s, &value, sizeof value);
1019 if (!is_all_ones(mask, sizeof(*mask))) {
1020 value = hton128(*mask);
1021 ds_put_char(s, '/');
1022 ds_put_hex(s, &value, sizeof value);
1024 ds_put_char(s, ',');
1028 /* Appends a string representation of 'match' to 's'. If 'priority' is
1029 * different from OFP_DEFAULT_PRIORITY, includes it in 's'. */
1031 match_format(const struct match *match, struct ds *s, int priority)
1033 const struct flow_wildcards *wc = &match->wc;
1034 size_t start_len = s->length;
1035 const struct flow *f = &match->flow;
1036 bool skip_type = false;
1037 bool skip_proto = false;
1041 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 35);
1043 if (priority != OFP_DEFAULT_PRIORITY) {
1044 ds_put_format(s, "priority=%d,", priority);
1047 format_uint32_masked(s, "pkt_mark", f->pkt_mark, wc->masks.pkt_mark);
1049 if (wc->masks.recirc_id) {
1050 format_uint32_masked(s, "recirc_id", f->recirc_id,
1051 wc->masks.recirc_id);
1054 if (wc->masks.dp_hash) {
1055 format_uint32_masked(s, "dp_hash", f->dp_hash,
1059 if (wc->masks.conj_id) {
1060 ds_put_format(s, "conj_id=%"PRIu32",", f->conj_id);
1063 if (wc->masks.skb_priority) {
1064 ds_put_format(s, "skb_priority=%#"PRIx32",", f->skb_priority);
1067 if (wc->masks.actset_output) {
1068 ds_put_cstr(s, "actset_output=");
1069 ofputil_format_port(f->actset_output, s);
1070 ds_put_char(s, ',');
1073 if (wc->masks.ct_state) {
1074 if (wc->masks.ct_state == UINT16_MAX) {
1075 ds_put_cstr(s, "ct_state=");
1077 format_flags(s, ct_state_to_string, f->ct_state, '|');
1079 ds_put_cstr(s, "0"); /* No state. */
1082 format_flags_masked(s, "ct_state", ct_state_to_string,
1083 f->ct_state, wc->masks.ct_state, UINT16_MAX);
1085 ds_put_char(s, ',');
1088 if (wc->masks.ct_zone) {
1089 format_uint16_masked(s, "ct_zone", f->ct_zone, wc->masks.ct_zone);
1092 if (wc->masks.ct_mark) {
1093 format_uint32_masked(s, "ct_mark", f->ct_mark, wc->masks.ct_mark);
1096 if (!ovs_u128_is_zero(&wc->masks.ct_label)) {
1097 format_ct_label_masked(s, &f->ct_label, &wc->masks.ct_label);
1100 if (wc->masks.dl_type) {
1102 if (f->dl_type == htons(ETH_TYPE_IP)) {
1103 if (wc->masks.nw_proto) {
1105 if (f->nw_proto == IPPROTO_ICMP) {
1106 ds_put_cstr(s, "icmp,");
1107 } else if (f->nw_proto == IPPROTO_IGMP) {
1108 ds_put_cstr(s, "igmp,");
1109 } else if (f->nw_proto == IPPROTO_TCP) {
1110 ds_put_cstr(s, "tcp,");
1111 } else if (f->nw_proto == IPPROTO_UDP) {
1112 ds_put_cstr(s, "udp,");
1113 } else if (f->nw_proto == IPPROTO_SCTP) {
1114 ds_put_cstr(s, "sctp,");
1116 ds_put_cstr(s, "ip,");
1120 ds_put_cstr(s, "ip,");
1122 } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
1123 if (wc->masks.nw_proto) {
1125 if (f->nw_proto == IPPROTO_ICMPV6) {
1126 ds_put_cstr(s, "icmp6,");
1127 } else if (f->nw_proto == IPPROTO_TCP) {
1128 ds_put_cstr(s, "tcp6,");
1129 } else if (f->nw_proto == IPPROTO_UDP) {
1130 ds_put_cstr(s, "udp6,");
1131 } else if (f->nw_proto == IPPROTO_SCTP) {
1132 ds_put_cstr(s, "sctp6,");
1134 ds_put_cstr(s, "ipv6,");
1138 ds_put_cstr(s, "ipv6,");
1140 } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
1141 ds_put_cstr(s, "arp,");
1142 } else if (f->dl_type == htons(ETH_TYPE_RARP)) {
1143 ds_put_cstr(s, "rarp,");
1144 } else if (f->dl_type == htons(ETH_TYPE_MPLS)) {
1145 ds_put_cstr(s, "mpls,");
1146 } else if (f->dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
1147 ds_put_cstr(s, "mplsm,");
1152 for (i = 0; i < FLOW_N_REGS; i++) {
1153 #define REGNAME_LEN 20
1154 char regname[REGNAME_LEN];
1155 if (snprintf(regname, REGNAME_LEN, "reg%d", i) >= REGNAME_LEN) {
1156 strcpy(regname, "reg?");
1158 format_uint32_masked(s, regname, f->regs[i], wc->masks.regs[i]);
1161 format_flow_tunnel(s, match);
1163 format_be64_masked(s, "metadata", f->metadata, wc->masks.metadata);
1165 if (wc->masks.in_port.ofp_port) {
1166 ds_put_cstr(s, "in_port=");
1167 ofputil_format_port(f->in_port.ofp_port, s);
1168 ds_put_char(s, ',');
1170 if (wc->masks.vlan_tci) {
1171 ovs_be16 vid_mask = wc->masks.vlan_tci & htons(VLAN_VID_MASK);
1172 ovs_be16 pcp_mask = wc->masks.vlan_tci & htons(VLAN_PCP_MASK);
1173 ovs_be16 cfi = wc->masks.vlan_tci & htons(VLAN_CFI);
1175 if (cfi && f->vlan_tci & htons(VLAN_CFI)
1176 && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
1177 && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
1178 && (vid_mask || pcp_mask)) {
1180 ds_put_format(s, "dl_vlan=%"PRIu16",",
1181 vlan_tci_to_vid(f->vlan_tci));
1184 ds_put_format(s, "dl_vlan_pcp=%d,",
1185 vlan_tci_to_pcp(f->vlan_tci));
1187 } else if (wc->masks.vlan_tci == htons(0xffff)) {
1188 ds_put_format(s, "vlan_tci=0x%04"PRIx16",", ntohs(f->vlan_tci));
1190 ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
1191 ntohs(f->vlan_tci), ntohs(wc->masks.vlan_tci));
1194 format_eth_masked(s, "dl_src", f->dl_src, wc->masks.dl_src);
1195 format_eth_masked(s, "dl_dst", f->dl_dst, wc->masks.dl_dst);
1196 if (!skip_type && wc->masks.dl_type) {
1197 ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
1199 if (f->dl_type == htons(ETH_TYPE_IPV6)) {
1200 format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->masks.ipv6_src);
1201 format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->masks.ipv6_dst);
1202 if (wc->masks.ipv6_label) {
1203 if (wc->masks.ipv6_label == OVS_BE32_MAX) {
1204 ds_put_format(s, "ipv6_label=0x%05"PRIx32",",
1205 ntohl(f->ipv6_label));
1207 ds_put_format(s, "ipv6_label=0x%05"PRIx32"/0x%05"PRIx32",",
1208 ntohl(f->ipv6_label),
1209 ntohl(wc->masks.ipv6_label));
1212 } else if (f->dl_type == htons(ETH_TYPE_ARP) ||
1213 f->dl_type == htons(ETH_TYPE_RARP)) {
1214 format_ip_netmask(s, "arp_spa", f->nw_src, wc->masks.nw_src);
1215 format_ip_netmask(s, "arp_tpa", f->nw_dst, wc->masks.nw_dst);
1217 format_ip_netmask(s, "nw_src", f->nw_src, wc->masks.nw_src);
1218 format_ip_netmask(s, "nw_dst", f->nw_dst, wc->masks.nw_dst);
1220 if (!skip_proto && wc->masks.nw_proto) {
1221 if (f->dl_type == htons(ETH_TYPE_ARP) ||
1222 f->dl_type == htons(ETH_TYPE_RARP)) {
1223 ds_put_format(s, "arp_op=%"PRIu8",", f->nw_proto);
1225 ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
1228 if (f->dl_type == htons(ETH_TYPE_ARP) ||
1229 f->dl_type == htons(ETH_TYPE_RARP)) {
1230 format_eth_masked(s, "arp_sha", f->arp_sha, wc->masks.arp_sha);
1231 format_eth_masked(s, "arp_tha", f->arp_tha, wc->masks.arp_tha);
1233 if (wc->masks.nw_tos & IP_DSCP_MASK) {
1234 ds_put_format(s, "nw_tos=%"PRIu8",", f->nw_tos & IP_DSCP_MASK);
1236 if (wc->masks.nw_tos & IP_ECN_MASK) {
1237 ds_put_format(s, "nw_ecn=%"PRIu8",", f->nw_tos & IP_ECN_MASK);
1239 if (wc->masks.nw_ttl) {
1240 ds_put_format(s, "nw_ttl=%"PRIu8",", f->nw_ttl);
1242 if (wc->masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK)) {
1243 ds_put_format(s, "mpls_label=%"PRIu32",",
1244 mpls_lse_to_label(f->mpls_lse[0]));
1246 if (wc->masks.mpls_lse[0] & htonl(MPLS_TC_MASK)) {
1247 ds_put_format(s, "mpls_tc=%"PRIu8",",
1248 mpls_lse_to_tc(f->mpls_lse[0]));
1250 if (wc->masks.mpls_lse[0] & htonl(MPLS_TTL_MASK)) {
1251 ds_put_format(s, "mpls_ttl=%"PRIu8",",
1252 mpls_lse_to_ttl(f->mpls_lse[0]));
1254 if (wc->masks.mpls_lse[0] & htonl(MPLS_BOS_MASK)) {
1255 ds_put_format(s, "mpls_bos=%"PRIu8",",
1256 mpls_lse_to_bos(f->mpls_lse[0]));
1258 format_be32_masked(s, "mpls_lse1", f->mpls_lse[1], wc->masks.mpls_lse[1]);
1259 format_be32_masked(s, "mpls_lse2", f->mpls_lse[2], wc->masks.mpls_lse[2]);
1261 switch (wc->masks.nw_frag) {
1262 case FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER:
1263 ds_put_format(s, "nw_frag=%s,",
1264 f->nw_frag & FLOW_NW_FRAG_ANY
1265 ? (f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "first")
1266 : (f->nw_frag & FLOW_NW_FRAG_LATER ? "<error>" : "no"));
1269 case FLOW_NW_FRAG_ANY:
1270 ds_put_format(s, "nw_frag=%s,",
1271 f->nw_frag & FLOW_NW_FRAG_ANY ? "yes" : "no");
1274 case FLOW_NW_FRAG_LATER:
1275 ds_put_format(s, "nw_frag=%s,",
1276 f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "not_later");
1279 if (f->dl_type == htons(ETH_TYPE_IP) &&
1280 f->nw_proto == IPPROTO_ICMP) {
1281 format_be16_masked(s, "icmp_type", f->tp_src, wc->masks.tp_src);
1282 format_be16_masked(s, "icmp_code", f->tp_dst, wc->masks.tp_dst);
1283 } else if (f->dl_type == htons(ETH_TYPE_IP) &&
1284 f->nw_proto == IPPROTO_IGMP) {
1285 format_be16_masked(s, "igmp_type", f->tp_src, wc->masks.tp_src);
1286 format_be16_masked(s, "igmp_code", f->tp_dst, wc->masks.tp_dst);
1287 } else if (f->dl_type == htons(ETH_TYPE_IPV6) &&
1288 f->nw_proto == IPPROTO_ICMPV6) {
1289 format_be16_masked(s, "icmp_type", f->tp_src, wc->masks.tp_src);
1290 format_be16_masked(s, "icmp_code", f->tp_dst, wc->masks.tp_dst);
1291 format_ipv6_netmask(s, "nd_target", &f->nd_target,
1292 &wc->masks.nd_target);
1293 format_eth_masked(s, "nd_sll", f->arp_sha, wc->masks.arp_sha);
1294 format_eth_masked(s, "nd_tll", f->arp_tha, wc->masks.arp_tha);
1296 format_be16_masked(s, "tp_src", f->tp_src, wc->masks.tp_src);
1297 format_be16_masked(s, "tp_dst", f->tp_dst, wc->masks.tp_dst);
1299 if (is_ip_any(f) && f->nw_proto == IPPROTO_TCP && wc->masks.tcp_flags) {
1300 format_flags_masked(s, "tcp_flags", packet_tcp_flag_to_string,
1301 ntohs(f->tcp_flags), TCP_FLAGS(wc->masks.tcp_flags),
1302 TCP_FLAGS(OVS_BE16_MAX));
1305 if (s->length > start_len) {
1310 /* Converts 'match' to a string and returns the string. If 'priority' is
1311 * different from OFP_DEFAULT_PRIORITY, includes it in the string. The caller
1312 * must free the string (with free()). */
1314 match_to_string(const struct match *match, int priority)
1316 struct ds s = DS_EMPTY_INITIALIZER;
1317 match_format(match, &s, priority);
1318 return ds_steal_cstr(&s);
1322 match_print(const struct match *match)
1324 char *s = match_to_string(match, OFP_DEFAULT_PRIORITY);
1329 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1330 * with minimatch_destroy(). */
1332 minimatch_init(struct minimatch *dst, const struct match *src)
1334 struct miniflow tmp;
1336 miniflow_map_init(&tmp, &src->wc.masks);
1337 /* Allocate two consecutive miniflows. */
1338 miniflow_alloc(dst->flows, 2, &tmp);
1339 miniflow_init(dst->flow, &src->flow);
1340 minimask_init(dst->mask, &src->wc);
1343 /* Initializes 'dst' as a copy of 'src'. The caller must eventually free 'dst'
1344 * with minimatch_destroy(). */
1346 minimatch_clone(struct minimatch *dst, const struct minimatch *src)
1348 /* Allocate two consecutive miniflows. */
1349 size_t data_size = miniflow_alloc(dst->flows, 2, &src->mask->masks);
1351 memcpy(miniflow_values(dst->flow),
1352 miniflow_get_values(src->flow), data_size);
1353 memcpy(miniflow_values(&dst->mask->masks),
1354 miniflow_get_values(&src->mask->masks), data_size);
1357 /* Initializes 'dst' with the data in 'src', destroying 'src'. The caller must
1358 * eventually free 'dst' with minimatch_destroy(). */
1360 minimatch_move(struct minimatch *dst, struct minimatch *src)
1362 dst->flow = src->flow;
1363 dst->mask = src->mask;
1366 /* Frees any memory owned by 'match'. Does not free the storage in which
1367 * 'match' itself resides; the caller is responsible for that. */
1369 minimatch_destroy(struct minimatch *match)
1374 /* Initializes 'dst' as a copy of 'src'. */
1376 minimatch_expand(const struct minimatch *src, struct match *dst)
1378 miniflow_expand(src->flow, &dst->flow);
1379 minimask_expand(src->mask, &dst->wc);
1380 memset(&dst->tun_md, 0, sizeof dst->tun_md);
1383 /* Returns true if 'a' and 'b' match the same packets, false otherwise. */
1385 minimatch_equal(const struct minimatch *a, const struct minimatch *b)
1387 return minimask_equal(a->mask, b->mask)
1388 && miniflow_equal(a->flow, b->flow);
1391 /* Returns true if 'target' satisifies 'match', that is, if each bit for which
1392 * 'match' specifies a particular value has the correct value in 'target'.
1394 * This function is equivalent to miniflow_equal_flow_in_minimask(&match->flow,
1395 * target, &match->mask) but it is faster because of the invariant that
1396 * match->flow.map and match->mask.map are the same. */
1398 minimatch_matches_flow(const struct minimatch *match,
1399 const struct flow *target)
1401 const uint64_t *flowp = miniflow_get_values(match->flow);
1402 const uint64_t *maskp = miniflow_get_values(&match->mask->masks);
1405 FLOWMAP_FOR_EACH_INDEX(idx, match->flow->map) {
1406 if ((*flowp++ ^ flow_u64_value(target, idx)) & *maskp++) {
1414 /* Appends a string representation of 'match' to 's'. If 'priority' is
1415 * different from OFP_DEFAULT_PRIORITY, includes it in 's'. */
1417 minimatch_format(const struct minimatch *match, struct ds *s, int priority)
1419 struct match megamatch;
1421 minimatch_expand(match, &megamatch);
1422 match_format(&megamatch, s, priority);
1425 /* Converts 'match' to a string and returns the string. If 'priority' is
1426 * different from OFP_DEFAULT_PRIORITY, includes it in the string. The caller
1427 * must free the string (with free()). */
1429 minimatch_to_string(const struct minimatch *match, int priority)
1431 struct match megamatch;
1433 minimatch_expand(match, &megamatch);
1434 return match_to_string(&megamatch, priority);