lib/match.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc.
   3  *
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #include <config.h>
  18 #include "openvswitch/match.h"
  19 #include <stdlib.h>
  20 #include "flow.h"
  21 #include "byte-order.h"
  22 #include "colors.h"
  23 #include "openvswitch/dynamic-string.h"
  24 #include "openvswitch/ofp-util.h"
  25 #include "packets.h"
  26 #include "tun-metadata.h"
  27
  28 /* Converts the flow in 'flow' into a match in 'match', with the given
  29  * 'wildcards'. */
  30 void
  31 match_init(struct match *match,
  32            const struct flow *flow, const struct flow_wildcards *wc)
  33 {
  34     match->flow = *flow;
  35     match->wc = *wc;
  36     match_zero_wildcarded_fields(match);
  37     memset(&match->tun_md, 0, sizeof match->tun_md);
  38 }
  39
  40 /* Converts a flow into a match.  It sets the wildcard masks based on
  41  * the packet contents.  It will not set the mask for fields that do not
  42  * make sense for the packet type. */
  43 void
  44 match_wc_init(struct match *match, const struct flow *flow)
  45 {
  46     match->flow = *flow;
  47
  48     flow_wildcards_init_for_packet(&match->wc, flow);
  49     WC_MASK_FIELD(&match->wc, regs);
  50     WC_MASK_FIELD(&match->wc, metadata);
  51
  52     memset(&match->tun_md, 0, sizeof match->tun_md);
  53 }
  54
  55 /* Initializes 'match' as a "catch-all" match that matches every packet. */
  56 void
  57 match_init_catchall(struct match *match)
  58 {
  59     memset(&match->flow, 0, sizeof match->flow);
  60     flow_wildcards_init_catchall(&match->wc);
  61     memset(&match->tun_md, 0, sizeof match->tun_md);
  62 }
  63
  64 /* For each bit or field wildcarded in 'match', sets the corresponding bit or
  65  * field in 'flow' to all-0-bits.  It is important to maintain this invariant
  66  * in a match that might be inserted into a classifier.
  67  *
  68  * It is never necessary to call this function directly for a match that is
  69  * initialized or modified only by match_*() functions.  It is useful to
  70  * restore the invariant in a match whose 'wc' member is modified by hand.
  71  */
  72 void
  73 match_zero_wildcarded_fields(struct match *match)
  74 {
  75     flow_zero_wildcards(&match->flow, &match->wc);
  76 }
  77
  78 void
  79 match_set_dp_hash(struct match *match, uint32_t value)
  80 {
  81     match_set_dp_hash_masked(match, value, UINT32_MAX);
  82 }
  83
  84 void
  85 match_set_dp_hash_masked(struct match *match, uint32_t value, uint32_t mask)
  86 {
  87     match->wc.masks.dp_hash = mask;
  88     match->flow.dp_hash = value & mask;
  89 }
  90
  91 void
  92 match_set_recirc_id(struct match *match, uint32_t value)
  93 {
  94     match->flow.recirc_id = value;
  95     match->wc.masks.recirc_id = UINT32_MAX;
  96 }
  97
  98 void
  99 match_set_conj_id(struct match *match, uint32_t value)
 100 {
 101     match->flow.conj_id = value;
 102     match->wc.masks.conj_id = UINT32_MAX;
 103 }
 104
 105 void
 106 match_set_reg(struct match *match, unsigned int reg_idx, uint32_t value)
 107 {
 108     match_set_reg_masked(match, reg_idx, value, UINT32_MAX);
 109 }
 110
 111 void
 112 match_set_reg_masked(struct match *match, unsigned int reg_idx,
 113                      uint32_t value, uint32_t mask)
 114 {
 115     ovs_assert(reg_idx < FLOW_N_REGS);
 116     flow_wildcards_set_reg_mask(&match->wc, reg_idx, mask);
 117     match->flow.regs[reg_idx] = value & mask;
 118 }
 119
 120 void
 121 match_set_xreg(struct match *match, unsigned int xreg_idx, uint64_t value)
 122 {
 123     match_set_xreg_masked(match, xreg_idx, value, UINT64_MAX);
 124 }
 125
 126 void
 127 match_set_xreg_masked(struct match *match, unsigned int xreg_idx,
 128                       uint64_t value, uint64_t mask)
 129 {
 130     ovs_assert(xreg_idx < FLOW_N_XREGS);
 131     flow_wildcards_set_xreg_mask(&match->wc, xreg_idx, mask);
 132     flow_set_xreg(&match->flow, xreg_idx, value & mask);
 133 }
 134
 135 void
 136 match_set_xxreg(struct match *match, unsigned int xxreg_idx, ovs_u128 value)
 137 {
 138     match_set_xxreg_masked(match, xxreg_idx, value, OVS_U128_MAX);
 139 }
 140
 141 void
 142 match_set_xxreg_masked(struct match *match, unsigned int xxreg_idx,
 143                       ovs_u128 value, ovs_u128 mask)
 144 {
 145     ovs_assert(xxreg_idx < FLOW_N_XXREGS);
 146     flow_wildcards_set_xxreg_mask(&match->wc, xxreg_idx, mask);
 147     flow_set_xxreg(&match->flow, xxreg_idx, ovs_u128_and(value, mask));
 148 }
 149
 150 void
 151 match_set_actset_output(struct match *match, ofp_port_t actset_output)
 152 {
 153     match->wc.masks.actset_output = u16_to_ofp(UINT16_MAX);
 154     match->flow.actset_output = actset_output;
 155 }
 156
 157 void
 158 match_set_metadata(struct match *match, ovs_be64 metadata)
 159 {
 160     match_set_metadata_masked(match, metadata, OVS_BE64_MAX);
 161 }
 162
 163 void
 164 match_set_metadata_masked(struct match *match,
 165                           ovs_be64 metadata, ovs_be64 mask)
 166 {
 167     match->wc.masks.metadata = mask;
 168     match->flow.metadata = metadata & mask;
 169 }
 170
 171 void
 172 match_set_tun_id(struct match *match, ovs_be64 tun_id)
 173 {
 174     match_set_tun_id_masked(match, tun_id, OVS_BE64_MAX);
 175 }
 176
 177 void
 178 match_set_tun_id_masked(struct match *match, ovs_be64 tun_id, ovs_be64 mask)
 179 {
 180     match->wc.masks.tunnel.tun_id = mask;
 181     match->flow.tunnel.tun_id = tun_id & mask;
 182 }
 183
 184 void
 185 match_set_tun_src(struct match *match, ovs_be32 src)
 186 {
 187     match_set_tun_src_masked(match, src, OVS_BE32_MAX);
 188 }
 189
 190 void
 191 match_set_tun_src_masked(struct match *match, ovs_be32 src, ovs_be32 mask)
 192 {
 193     match->wc.masks.tunnel.ip_src = mask;
 194     match->flow.tunnel.ip_src = src & mask;
 195 }
 196
 197 void
 198 match_set_tun_dst(struct match *match, ovs_be32 dst)
 199 {
 200     match_set_tun_dst_masked(match, dst, OVS_BE32_MAX);
 201 }
 202
 203 void
 204 match_set_tun_dst_masked(struct match *match, ovs_be32 dst, ovs_be32 mask)
 205 {
 206     match->wc.masks.tunnel.ip_dst = mask;
 207     match->flow.tunnel.ip_dst = dst & mask;
 208 }
 209
 210 void
 211 match_set_tun_ipv6_src(struct match *match, const struct in6_addr *src)
 212 {
 213     match->flow.tunnel.ipv6_src = *src;
 214     match->wc.masks.tunnel.ipv6_src = in6addr_exact;
 215 }
 216
 217 void
 218 match_set_tun_ipv6_src_masked(struct match *match, const struct in6_addr *src,
 219                               const struct in6_addr *mask)
 220 {
 221     match->flow.tunnel.ipv6_src = ipv6_addr_bitand(src, mask);
 222     match->wc.masks.tunnel.ipv6_src = *mask;
 223 }
 224
 225 void
 226 match_set_tun_ipv6_dst(struct match *match, const struct in6_addr *dst)
 227 {
 228     match->flow.tunnel.ipv6_dst = *dst;
 229     match->wc.masks.tunnel.ipv6_dst = in6addr_exact;
 230 }
 231
 232 void
 233 match_set_tun_ipv6_dst_masked(struct match *match, const struct in6_addr *dst,
 234                               const struct in6_addr *mask)
 235 {
 236     match->flow.tunnel.ipv6_dst = ipv6_addr_bitand(dst, mask);
 237     match->wc.masks.tunnel.ipv6_dst = *mask;
 238 }
 239
 240 void
 241 match_set_tun_ttl(struct match *match, uint8_t ttl)
 242 {
 243     match_set_tun_ttl_masked(match, ttl, UINT8_MAX);
 244 }
 245
 246 void
 247 match_set_tun_ttl_masked(struct match *match, uint8_t ttl, uint8_t mask)
 248 {
 249     match->wc.masks.tunnel.ip_ttl = mask;
 250     match->flow.tunnel.ip_ttl = ttl & mask;
 251 }
 252
 253 void
 254 match_set_tun_tos(struct match *match, uint8_t tos)
 255 {
 256     match_set_tun_tos_masked(match, tos, UINT8_MAX);
 257 }
 258
 259 void
 260 match_set_tun_tos_masked(struct match *match, uint8_t tos, uint8_t mask)
 261 {
 262     match->wc.masks.tunnel.ip_tos = mask;
 263     match->flow.tunnel.ip_tos = tos & mask;
 264 }
 265
 266 void
 267 match_set_tun_flags(struct match *match, uint16_t flags)
 268 {
 269     match_set_tun_flags_masked(match, flags, UINT16_MAX);
 270 }
 271
 272 void
 273 match_set_tun_flags_masked(struct match *match, uint16_t flags, uint16_t mask)
 274 {
 275     mask &= FLOW_TNL_PUB_F_MASK;
 276
 277     match->wc.masks.tunnel.flags = mask;
 278     match->flow.tunnel.flags = flags & mask;
 279 }
 280
 281 void
 282 match_set_tun_gbp_id_masked(struct match *match, ovs_be16 gbp_id, ovs_be16 mask)
 283 {
 284     match->wc.masks.tunnel.gbp_id = mask;
 285     match->flow.tunnel.gbp_id = gbp_id & mask;
 286 }
 287
 288 void
 289 match_set_tun_gbp_id(struct match *match, ovs_be16 gbp_id)
 290 {
 291     match_set_tun_gbp_id_masked(match, gbp_id, OVS_BE16_MAX);
 292 }
 293
 294 void
 295 match_set_tun_gbp_flags_masked(struct match *match, uint8_t flags, uint8_t mask)
 296 {
 297     match->wc.masks.tunnel.gbp_flags = mask;
 298     match->flow.tunnel.gbp_flags = flags & mask;
 299 }
 300
 301 void
 302 match_set_tun_gbp_flags(struct match *match, uint8_t flags)
 303 {
 304     match_set_tun_gbp_flags_masked(match, flags, UINT8_MAX);
 305 }
 306
 307 void
 308 match_set_in_port(struct match *match, ofp_port_t ofp_port)
 309 {
 310     match->wc.masks.in_port.ofp_port = u16_to_ofp(UINT16_MAX);
 311     match->flow.in_port.ofp_port = ofp_port;
 312 }
 313
 314 void
 315 match_set_skb_priority(struct match *match, uint32_t skb_priority)
 316 {
 317     match->wc.masks.skb_priority = UINT32_MAX;
 318     match->flow.skb_priority = skb_priority;
 319 }
 320
 321 void
 322 match_set_pkt_mark(struct match *match, uint32_t pkt_mark)
 323 {
 324     match_set_pkt_mark_masked(match, pkt_mark, UINT32_MAX);
 325 }
 326
 327 void
 328 match_set_pkt_mark_masked(struct match *match, uint32_t pkt_mark, uint32_t mask)
 329 {
 330     match->flow.pkt_mark = pkt_mark & mask;
 331     match->wc.masks.pkt_mark = mask;
 332 }
 333
 334 void
 335 match_set_ct_state(struct match *match, uint32_t ct_state)
 336 {
 337     match_set_ct_state_masked(match, ct_state, UINT32_MAX);
 338 }
 339
 340 void
 341 match_set_ct_state_masked(struct match *match, uint32_t ct_state, uint32_t mask)
 342 {
 343     match->flow.ct_state = ct_state & mask & UINT16_MAX;
 344     match->wc.masks.ct_state = mask & UINT16_MAX;
 345 }
 346
 347 void
 348 match_set_ct_zone(struct match *match, uint16_t ct_zone)
 349 {
 350     match->flow.ct_zone = ct_zone;
 351     match->wc.masks.ct_zone = UINT16_MAX;
 352 }
 353
 354 void
 355 match_set_ct_mark(struct match *match, uint32_t ct_mark)
 356 {
 357     match_set_ct_mark_masked(match, ct_mark, UINT32_MAX);
 358 }
 359
 360 void
 361 match_set_ct_mark_masked(struct match *match, uint32_t ct_mark,
 362                            uint32_t mask)
 363 {
 364     match->flow.ct_mark = ct_mark & mask;
 365     match->wc.masks.ct_mark = mask;
 366 }
 367
 368 void
 369 match_set_ct_label(struct match *match, ovs_u128 ct_label)
 370 {
 371     ovs_u128 mask;
 372
 373     mask.u64.lo = UINT64_MAX;
 374     mask.u64.hi = UINT64_MAX;
 375     match_set_ct_label_masked(match, ct_label, mask);
 376 }
 377
 378 void
 379 match_set_ct_label_masked(struct match *match, ovs_u128 value, ovs_u128 mask)
 380 {
 381     match->flow.ct_label.u64.lo = value.u64.lo & mask.u64.lo;
 382     match->flow.ct_label.u64.hi = value.u64.hi & mask.u64.hi;
 383     match->wc.masks.ct_label = mask;
 384 }
 385
 386 void
 387 match_set_dl_type(struct match *match, ovs_be16 dl_type)
 388 {
 389     match->wc.masks.dl_type = OVS_BE16_MAX;
 390     match->flow.dl_type = dl_type;
 391 }
 392
 393 /* Modifies 'value_src' so that the Ethernet address must match 'value_dst'
 394  * exactly.  'mask_dst' is set to all 1s. */
 395 static void
 396 set_eth(const struct eth_addr value_src,
 397         struct eth_addr *value_dst,
 398         struct eth_addr *mask_dst)
 399 {
 400     *value_dst = value_src;
 401     *mask_dst = eth_addr_exact;
 402 }
 403
 404 /* Modifies 'value_src' so that the Ethernet address must match 'value_src'
 405  * after each byte is ANDed with the appropriate byte in 'mask_src'.
 406  * 'mask_dst' is set to 'mask_src' */
 407 static void
 408 set_eth_masked(const struct eth_addr value_src,
 409                const struct eth_addr mask_src,
 410                struct eth_addr *value_dst, struct eth_addr *mask_dst)
 411 {
 412     size_t i;
 413
 414     for (i = 0; i < ARRAY_SIZE(value_dst->be16); i++) {
 415         value_dst->be16[i] = value_src.be16[i] & mask_src.be16[i];
 416     }
 417     *mask_dst = mask_src;
 418 }
 419
 420 /* Modifies 'rule' so that the source Ethernet address must match 'dl_src'
 421  * exactly. */
 422 void
 423 match_set_dl_src(struct match *match, const struct eth_addr dl_src)
 424 {
 425     set_eth(dl_src, &match->flow.dl_src, &match->wc.masks.dl_src);
 426 }
 427
 428 /* Modifies 'rule' so that the source Ethernet address must match 'dl_src'
 429  * after each byte is ANDed with the appropriate byte in 'mask'. */
 430 void
 431 match_set_dl_src_masked(struct match *match,
 432                         const struct eth_addr dl_src,
 433                         const struct eth_addr mask)
 434 {
 435     set_eth_masked(dl_src, mask, &match->flow.dl_src, &match->wc.masks.dl_src);
 436 }
 437
 438 /* Modifies 'match' so that the Ethernet address must match 'dl_dst'
 439  * exactly. */
 440 void
 441 match_set_dl_dst(struct match *match, const struct eth_addr dl_dst)
 442 {
 443     set_eth(dl_dst, &match->flow.dl_dst, &match->wc.masks.dl_dst);
 444 }
 445
 446 /* Modifies 'match' so that the Ethernet address must match 'dl_dst' after each
 447  * byte is ANDed with the appropriate byte in 'mask'.
 448  *
 449  * This function will assert-fail if 'mask' is invalid.  Only 'mask' values
 450  * accepted by flow_wildcards_is_dl_dst_mask_valid() are allowed. */
 451 void
 452 match_set_dl_dst_masked(struct match *match,
 453                         const struct eth_addr dl_dst,
 454                         const struct eth_addr mask)
 455 {
 456     set_eth_masked(dl_dst, mask, &match->flow.dl_dst, &match->wc.masks.dl_dst);
 457 }
 458
 459 void
 460 match_set_dl_tci(struct match *match, ovs_be16 tci)
 461 {
 462     match_set_dl_tci_masked(match, tci, htons(0xffff));
 463 }
 464
 465 void
 466 match_set_dl_tci_masked(struct match *match, ovs_be16 tci, ovs_be16 mask)
 467 {
 468     match->flow.vlan_tci = tci & mask;
 469     match->wc.masks.vlan_tci = mask;
 470 }
 471
 472 /* Modifies 'match' so that the VLAN VID is wildcarded.  If the PCP is already
 473  * wildcarded, then 'match' will match a packet regardless of whether it has an
 474  * 802.1Q header or not. */
 475 void
 476 match_set_any_vid(struct match *match)
 477 {
 478     if (match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK)) {
 479         match->wc.masks.vlan_tci &= ~htons(VLAN_VID_MASK);
 480         match->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
 481     } else {
 482         match_set_dl_tci_masked(match, htons(0), htons(0));
 483     }
 484 }
 485
 486 /* Modifies 'match' depending on 'dl_vlan':
 487  *
 488  *   - If 'dl_vlan' is htons(OFP_VLAN_NONE), makes 'match' match only packets
 489  *     without an 802.1Q header.
 490  *
 491  *   - Otherwise, makes 'match' match only packets with an 802.1Q header whose
 492  *     VID equals the low 12 bits of 'dl_vlan'.
 493  */
 494 void
 495 match_set_dl_vlan(struct match *match, ovs_be16 dl_vlan)
 496 {
 497     flow_set_dl_vlan(&match->flow, dl_vlan);
 498     if (dl_vlan == htons(OFP10_VLAN_NONE)) {
 499         match->wc.masks.vlan_tci = OVS_BE16_MAX;
 500     } else {
 501         match->wc.masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
 502     }
 503 }
 504
 505 /* Sets the VLAN VID that 'match' matches to 'vid', which is interpreted as an
 506  * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
 507  * plus CFI). */
 508 void
 509 match_set_vlan_vid(struct match *match, ovs_be16 vid)
 510 {
 511     match_set_vlan_vid_masked(match, vid, htons(VLAN_VID_MASK | VLAN_CFI));
 512 }
 513
 514
 515 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
 516  * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
 517  * plus CFI), with the corresponding 'mask'. */
 518 void
 519 match_set_vlan_vid_masked(struct match *match, ovs_be16 vid, ovs_be16 mask)
 520 {
 521     ovs_be16 pcp_mask = htons(VLAN_PCP_MASK);
 522     ovs_be16 vid_mask = htons(VLAN_VID_MASK | VLAN_CFI);
 523
 524     mask &= vid_mask;
 525     flow_set_vlan_vid(&match->flow, vid & mask);
 526     match->wc.masks.vlan_tci = mask | (match->wc.masks.vlan_tci & pcp_mask);
 527 }
 528
 529 /* Modifies 'match' so that the VLAN PCP is wildcarded.  If the VID is already
 530  * wildcarded, then 'match' will match a packet regardless of whether it has an
 531  * 802.1Q header or not. */
 532 void
 533 match_set_any_pcp(struct match *match)
 534 {
 535     if (match->wc.masks.vlan_tci & htons(VLAN_VID_MASK)) {
 536         match->wc.masks.vlan_tci &= ~htons(VLAN_PCP_MASK);
 537         match->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
 538     } else {
 539         match_set_dl_tci_masked(match, htons(0), htons(0));
 540     }
 541 }
 542
 543 /* Modifies 'match' so that it matches only packets with an 802.1Q header whose
 544  * PCP equals the low 3 bits of 'dl_vlan_pcp'. */
 545 void
 546 match_set_dl_vlan_pcp(struct match *match, uint8_t dl_vlan_pcp)
 547 {
 548     flow_set_vlan_pcp(&match->flow, dl_vlan_pcp);
 549     match->wc.masks.vlan_tci |= htons(VLAN_CFI | VLAN_PCP_MASK);
 550 }
 551
 552 /* Modifies 'match' so that the MPLS label 'idx' matches 'lse' exactly. */
 553 void
 554 match_set_mpls_lse(struct match *match, int idx, ovs_be32 lse)
 555 {
 556     match->wc.masks.mpls_lse[idx] = OVS_BE32_MAX;
 557     match->flow.mpls_lse[idx] = lse;
 558 }
 559
 560 /* Modifies 'match' so that the MPLS label is wildcarded. */
 561 void
 562 match_set_any_mpls_label(struct match *match, int idx)
 563 {
 564     match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_LABEL_MASK);
 565     flow_set_mpls_label(&match->flow, idx, htonl(0));
 566 }
 567
 568 /* Modifies 'match' so that it matches only packets with an MPLS header whose
 569  * label equals the low 20 bits of 'mpls_label'. */
 570 void
 571 match_set_mpls_label(struct match *match, int idx, ovs_be32 mpls_label)
 572 {
 573     match->wc.masks.mpls_lse[idx] |= htonl(MPLS_LABEL_MASK);
 574     flow_set_mpls_label(&match->flow, idx, mpls_label);
 575 }
 576
 577 /* Modifies 'match' so that the MPLS TC is wildcarded. */
 578 void
 579 match_set_any_mpls_tc(struct match *match, int idx)
 580 {
 581     match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_TC_MASK);
 582     flow_set_mpls_tc(&match->flow, idx, 0);
 583 }
 584
 585 /* Modifies 'match' so that it matches only packets with an MPLS header whose
 586  * Traffic Class equals the low 3 bits of 'mpls_tc'. */
 587 void
 588 match_set_mpls_tc(struct match *match, int idx, uint8_t mpls_tc)
 589 {
 590     match->wc.masks.mpls_lse[idx] |= htonl(MPLS_TC_MASK);
 591     flow_set_mpls_tc(&match->flow, idx, mpls_tc);
 592 }
 593
 594 /* Modifies 'match' so that the MPLS stack flag is wildcarded. */
 595 void
 596 match_set_any_mpls_bos(struct match *match, int idx)
 597 {
 598     match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_BOS_MASK);
 599     flow_set_mpls_bos(&match->flow, idx, 0);
 600 }
 601
 602 /* Modifies 'match' so that it matches only packets with an MPLS header whose
 603  * Stack Flag equals the lower bit of 'mpls_bos' */
 604 void
 605 match_set_mpls_bos(struct match *match, int idx, uint8_t mpls_bos)
 606 {
 607     match->wc.masks.mpls_lse[idx] |= htonl(MPLS_BOS_MASK);
 608     flow_set_mpls_bos(&match->flow, idx, mpls_bos);
 609 }
 610
 611 /* Modifies 'match' so that the TTL of MPLS label 'idx' is wildcarded. */
 612 void
 613 match_set_any_mpls_ttl(struct match *match, int idx)
 614 {
 615     match->wc.masks.mpls_lse[idx] &= ~htonl(MPLS_TTL_MASK);
 616     flow_set_mpls_ttl(&match->flow, idx, 0);
 617 }
 618
 619 /* Modifies 'match' so that it matches only packets in which the TTL of MPLS
 620  * label 'idx' equals 'mpls_ttl'. */
 621 void
 622 match_set_mpls_ttl(struct match *match, int idx, uint8_t mpls_ttl)
 623 {
 624     match->wc.masks.mpls_lse[idx] |= htonl(MPLS_TTL_MASK);
 625     flow_set_mpls_ttl(&match->flow, idx, mpls_ttl);
 626 }
 627
 628 /* Modifies 'match' so that the MPLS LSE is wildcarded. */
 629 void
 630 match_set_any_mpls_lse(struct match *match, int idx)
 631 {
 632     match->wc.masks.mpls_lse[idx] = htonl(0);
 633     flow_set_mpls_lse(&match->flow, idx, htonl(0));
 634 }
 635
 636 void
 637 match_set_tp_src(struct match *match, ovs_be16 tp_src)
 638 {
 639     match_set_tp_src_masked(match, tp_src, OVS_BE16_MAX);
 640 }
 641
 642 void
 643 match_set_tp_src_masked(struct match *match, ovs_be16 port, ovs_be16 mask)
 644 {
 645     match->flow.tp_src = port & mask;
 646     match->wc.masks.tp_src = mask;
 647 }
 648
 649 void
 650 match_set_tp_dst(struct match *match, ovs_be16 tp_dst)
 651 {
 652     match_set_tp_dst_masked(match, tp_dst, OVS_BE16_MAX);
 653 }
 654
 655 void
 656 match_set_tp_dst_masked(struct match *match, ovs_be16 port, ovs_be16 mask)
 657 {
 658     match->flow.tp_dst = port & mask;
 659     match->wc.masks.tp_dst = mask;
 660 }
 661
 662 void
 663 match_set_tcp_flags(struct match *match, ovs_be16 flags)
 664 {
 665     match_set_tcp_flags_masked(match, flags, OVS_BE16_MAX);
 666 }
 667
 668 void
 669 match_set_tcp_flags_masked(struct match *match, ovs_be16 flags, ovs_be16 mask)
 670 {
 671     match->flow.tcp_flags = flags & mask;
 672     match->wc.masks.tcp_flags = mask;
 673 }
 674
 675 void
 676 match_set_nw_proto(struct match *match, uint8_t nw_proto)
 677 {
 678     match->flow.nw_proto = nw_proto;
 679     match->wc.masks.nw_proto = UINT8_MAX;
 680 }
 681
 682 void
 683 match_set_nw_src(struct match *match, ovs_be32 nw_src)
 684 {
 685     match->flow.nw_src = nw_src;
 686     match->wc.masks.nw_src = OVS_BE32_MAX;
 687 }
 688
 689 void
 690 match_set_nw_src_masked(struct match *match,
 691                         ovs_be32 nw_src, ovs_be32 mask)
 692 {
 693     match->flow.nw_src = nw_src & mask;
 694     match->wc.masks.nw_src = mask;
 695 }
 696
 697 void
 698 match_set_nw_dst(struct match *match, ovs_be32 nw_dst)
 699 {
 700     match->flow.nw_dst = nw_dst;
 701     match->wc.masks.nw_dst = OVS_BE32_MAX;
 702 }
 703
 704 void
 705 match_set_nw_dst_masked(struct match *match, ovs_be32 ip, ovs_be32 mask)
 706 {
 707     match->flow.nw_dst = ip & mask;
 708     match->wc.masks.nw_dst = mask;
 709 }
 710
 711 void
 712 match_set_nw_dscp(struct match *match, uint8_t nw_dscp)
 713 {
 714     match->wc.masks.nw_tos |= IP_DSCP_MASK;
 715     match->flow.nw_tos &= ~IP_DSCP_MASK;
 716     match->flow.nw_tos |= nw_dscp & IP_DSCP_MASK;
 717 }
 718
 719 void
 720 match_set_nw_ecn(struct match *match, uint8_t nw_ecn)
 721 {
 722     match->wc.masks.nw_tos |= IP_ECN_MASK;
 723     match->flow.nw_tos &= ~IP_ECN_MASK;
 724     match->flow.nw_tos |= nw_ecn & IP_ECN_MASK;
 725 }
 726
 727 void
 728 match_set_nw_ttl(struct match *match, uint8_t nw_ttl)
 729 {
 730     match->wc.masks.nw_ttl = UINT8_MAX;
 731     match->flow.nw_ttl = nw_ttl;
 732 }
 733
 734 void
 735 match_set_nw_frag(struct match *match, uint8_t nw_frag)
 736 {
 737     match->wc.masks.nw_frag |= FLOW_NW_FRAG_MASK;
 738     match->flow.nw_frag = nw_frag;
 739 }
 740
 741 void
 742 match_set_nw_frag_masked(struct match *match,
 743                          uint8_t nw_frag, uint8_t mask)
 744 {
 745     match->flow.nw_frag = nw_frag & mask;
 746     match->wc.masks.nw_frag = mask;
 747 }
 748
 749 void
 750 match_set_icmp_type(struct match *match, uint8_t icmp_type)
 751 {
 752     match_set_tp_src(match, htons(icmp_type));
 753 }
 754
 755 void
 756 match_set_icmp_code(struct match *match, uint8_t icmp_code)
 757 {
 758     match_set_tp_dst(match, htons(icmp_code));
 759 }
 760
 761 void
 762 match_set_arp_sha(struct match *match, const struct eth_addr sha)
 763 {
 764     match->flow.arp_sha = sha;
 765     match->wc.masks.arp_sha = eth_addr_exact;
 766 }
 767
 768 void
 769 match_set_arp_sha_masked(struct match *match,
 770                          const struct eth_addr arp_sha,
 771                          const struct eth_addr mask)
 772 {
 773     set_eth_masked(arp_sha, mask,
 774                    &match->flow.arp_sha, &match->wc.masks.arp_sha);
 775 }
 776
 777 void
 778 match_set_arp_tha(struct match *match, const struct eth_addr tha)
 779 {
 780     match->flow.arp_tha = tha;
 781     match->wc.masks.arp_tha = eth_addr_exact;
 782 }
 783
 784 void
 785 match_set_arp_tha_masked(struct match *match,
 786                          const struct eth_addr arp_tha,
 787                          const struct eth_addr mask)
 788 {
 789     set_eth_masked(arp_tha, mask,
 790                    &match->flow.arp_tha, &match->wc.masks.arp_tha);
 791 }
 792
 793 void
 794 match_set_ipv6_src(struct match *match, const struct in6_addr *src)
 795 {
 796     match->flow.ipv6_src = *src;
 797     match->wc.masks.ipv6_src = in6addr_exact;
 798 }
 799
 800 void
 801 match_set_ipv6_src_masked(struct match *match, const struct in6_addr *src,
 802                           const struct in6_addr *mask)
 803 {
 804     match->flow.ipv6_src = ipv6_addr_bitand(src, mask);
 805     match->wc.masks.ipv6_src = *mask;
 806 }
 807
 808 void
 809 match_set_ipv6_dst(struct match *match, const struct in6_addr *dst)
 810 {
 811     match->flow.ipv6_dst = *dst;
 812     match->wc.masks.ipv6_dst = in6addr_exact;
 813 }
 814
 815 void
 816 match_set_ipv6_dst_masked(struct match *match, const struct in6_addr *dst,
 817                           const struct in6_addr *mask)
 818 {
 819     match->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
 820     match->wc.masks.ipv6_dst = *mask;
 821 }
 822
 823 void
 824 match_set_ipv6_label(struct match *match, ovs_be32 ipv6_label)
 825 {
 826     match->wc.masks.ipv6_label = OVS_BE32_MAX;
 827     match->flow.ipv6_label = ipv6_label;
 828 }
 829
 830
 831 void
 832 match_set_ipv6_label_masked(struct match *match, ovs_be32 ipv6_label,
 833                             ovs_be32 mask)
 834 {
 835     match->flow.ipv6_label = ipv6_label & mask;
 836     match->wc.masks.ipv6_label = mask;
 837 }
 838
 839 void
 840 match_set_nd_target(struct match *match, const struct in6_addr *target)
 841 {
 842     match->flow.nd_target = *target;
 843     match->wc.masks.nd_target = in6addr_exact;
 844 }
 845
 846 void
 847 match_set_nd_target_masked(struct match *match,
 848                            const struct in6_addr *target,
 849                            const struct in6_addr *mask)
 850 {
 851     match->flow.nd_target = ipv6_addr_bitand(target, mask);
 852     match->wc.masks.nd_target = *mask;
 853 }
 854
 855 /* Returns true if 'a' and 'b' wildcard the same fields and have the same
 856  * values for fixed fields, otherwise false. */
 857 bool
 858 match_equal(const struct match *a, const struct match *b)
 859 {
 860     return (flow_wildcards_equal(&a->wc, &b->wc)
 861             && flow_equal(&a->flow, &b->flow));
 862 }
 863
 864 /* Returns a hash value for the flow and wildcards in 'match', starting from
 865  * 'basis'. */
 866 uint32_t
 867 match_hash(const struct match *match, uint32_t basis)
 868 {
 869     return flow_wildcards_hash(&match->wc, flow_hash(&match->flow, basis));
 870 }
 871
 872 static bool
 873 match_has_default_recirc_id(const struct match *m)
 874 {
 875     return m->flow.recirc_id == 0 && (m->wc.masks.recirc_id == UINT32_MAX ||
 876                                       m->wc.masks.recirc_id == 0);
 877 }
 878
 879 static bool
 880 match_has_default_dp_hash(const struct match *m)
 881 {
 882     return ((m->flow.dp_hash | m->wc.masks.dp_hash) == 0);
 883 }
 884
 885 /* Return true if the hidden fields of the match are set to the default values.
 886  * The default values equals to those set up by match_init_hidden_fields(). */
 887 bool
 888 match_has_default_hidden_fields(const struct match *m)
 889 {
 890     return match_has_default_recirc_id(m) && match_has_default_dp_hash(m);
 891 }
 892
 893 void
 894 match_init_hidden_fields(struct match *m)
 895 {
 896     match_set_recirc_id(m, 0);
 897     match_set_dp_hash_masked(m, 0, 0);
 898 }
 899
 900 static void
 901 format_eth_masked(struct ds *s, const char *name,
 902                   const struct eth_addr eth, const struct eth_addr mask)
 903 {
 904     if (!eth_addr_is_zero(mask)) {
 905         ds_put_format(s, "%s%s=%s", colors.param, name, colors.end);
 906         eth_format_masked(eth, &mask, s);
 907         ds_put_char(s, ',');
 908     }
 909 }
 910
 911 static void
 912 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
 913                   ovs_be32 netmask)
 914 {
 915     if (netmask) {
 916         ds_put_format(s, "%s%s=%s", colors.param, name, colors.end);
 917         ip_format_masked(ip, netmask, s);
 918         ds_put_char(s, ',');
 919     }
 920 }
 921
 922 static void
 923 format_ipv6_netmask(struct ds *s, const char *name,
 924                     const struct in6_addr *addr,
 925                     const struct in6_addr *netmask)
 926 {
 927     if (!ipv6_mask_is_any(netmask)) {
 928         ds_put_format(s, "%s%s=%s", colors.param, name, colors.end);
 929         ipv6_format_masked(addr, netmask, s);
 930         ds_put_char(s, ',');
 931     }
 932 }
 933
 934 static void
 935 format_uint16_masked(struct ds *s, const char *name,
 936                    uint16_t value, uint16_t mask)
 937 {
 938     if (mask != 0) {
 939         ds_put_format(s, "%s%s=%s", colors.param, name, colors.end);
 940         if (mask == UINT16_MAX) {
 941             ds_put_format(s, "%"PRIu16, value);
 942         } else {
 943             ds_put_format(s, "0x%"PRIx16"/0x%"PRIx16, value, mask);
 944         }
 945         ds_put_char(s, ',');
 946     }
 947 }
 948
 949 static void
 950 format_be16_masked(struct ds *s, const char *name,
 951                    ovs_be16 value, ovs_be16 mask)
 952 {
 953     if (mask != htons(0)) {
 954         ds_put_format(s, "%s%s=%s", colors.param, name, colors.end);
 955         if (mask == OVS_BE16_MAX) {
 956             ds_put_format(s, "%"PRIu16, ntohs(value));
 957         } else {
 958             ds_put_format(s, "0x%"PRIx16"/0x%"PRIx16,
 959                           ntohs(value), ntohs(mask));
 960         }
 961         ds_put_char(s, ',');
 962     }
 963 }
 964
 965 static void
 966 format_be32_masked(struct ds *s, const char *name,
 967                    ovs_be32 value, ovs_be32 mask)
 968 {
 969     if (mask != htonl(0)) {
 970         ds_put_format(s, "%s%s=%s", colors.param, name, colors.end);
 971         if (mask == OVS_BE32_MAX) {
 972             ds_put_format(s, "%"PRIu32, ntohl(value));
 973         } else {
 974             ds_put_format(s, "0x%"PRIx32"/0x%"PRIx32,
 975                           ntohl(value), ntohl(mask));
 976         }
 977         ds_put_char(s, ',');
 978     }
 979 }
 980
 981 static void
 982 format_uint32_masked(struct ds *s, const char *name,
 983                    uint32_t value, uint32_t mask)
 984 {
 985     if (mask) {
 986         ds_put_format(s, "%s%s=%s%#"PRIx32,
 987                       colors.param, name, colors.end, value);
 988         if (mask != UINT32_MAX) {
 989             ds_put_format(s, "/%#"PRIx32, mask);
 990         }
 991         ds_put_char(s, ',');
 992     }
 993 }
 994
 995 static void
 996 format_be64_masked(struct ds *s, const char *name,
 997                    ovs_be64 value, ovs_be64 mask)
 998 {
 999     if (mask != htonll(0)) {
1000         ds_put_format(s, "%s%s=%s%#"PRIx64,
1001                       colors.param, name, colors.end, ntohll(value));
1002         if (mask != OVS_BE64_MAX) {
1003             ds_put_format(s, "/%#"PRIx64, ntohll(mask));
1004         }
1005         ds_put_char(s, ',');
1006     }
1007 }
1008
1009 static void
1010 format_flow_tunnel(struct ds *s, const struct match *match)
1011 {
1012     const struct flow_wildcards *wc = &match->wc;
1013     const struct flow_tnl *tnl = &match->flow.tunnel;
1014
1015     format_be64_masked(s, "tun_id", tnl->tun_id, wc->masks.tunnel.tun_id);
1016     format_ip_netmask(s, "tun_src", tnl->ip_src, wc->masks.tunnel.ip_src);
1017     format_ip_netmask(s, "tun_dst", tnl->ip_dst, wc->masks.tunnel.ip_dst);
1018     format_ipv6_netmask(s, "tun_ipv6_src", &tnl->ipv6_src,
1019                         &wc->masks.tunnel.ipv6_src);
1020     format_ipv6_netmask(s, "tun_ipv6_dst", &tnl->ipv6_dst,
1021                         &wc->masks.tunnel.ipv6_dst);
1022
1023     if (wc->masks.tunnel.gbp_id) {
1024         format_be16_masked(s, "tun_gbp_id", tnl->gbp_id,
1025                            wc->masks.tunnel.gbp_id);
1026     }
1027
1028     if (wc->masks.tunnel.gbp_flags) {
1029         ds_put_format(s, "tun_gbp_flags=%#"PRIx8",", tnl->gbp_flags);
1030     }
1031
1032     if (wc->masks.tunnel.ip_tos) {
1033         ds_put_format(s, "tun_tos=%"PRIx8",", tnl->ip_tos);
1034     }
1035     if (wc->masks.tunnel.ip_ttl) {
1036         ds_put_format(s, "tun_ttl=%"PRIu8",", tnl->ip_ttl);
1037     }
1038     if (wc->masks.tunnel.flags) {
1039         format_flags_masked(s, "tun_flags", flow_tun_flag_to_string,
1040                             tnl->flags,
1041                             wc->masks.tunnel.flags & FLOW_TNL_F_MASK,
1042                             FLOW_TNL_F_MASK);
1043         ds_put_char(s, ',');
1044     }
1045     tun_metadata_match_format(s, match);
1046 }
1047
1048 static void
1049 format_ct_label_masked(struct ds *s, const ovs_u128 *key, const ovs_u128 *mask)
1050 {
1051     if (!ovs_u128_is_zero(*mask)) {
1052         ovs_be128 value = hton128(*key);
1053         ds_put_format(s, "%sct_label=%s", colors.param, colors.end);
1054         ds_put_hex(s, &value, sizeof value);
1055         if (!is_all_ones(mask, sizeof(*mask))) {
1056             value = hton128(*mask);
1057             ds_put_char(s, '/');
1058             ds_put_hex(s, &value, sizeof value);
1059         }
1060         ds_put_char(s, ',');
1061     }
1062 }
1063
1064 /* Appends a string representation of 'match' to 's'.  If 'priority' is
1065  * different from OFP_DEFAULT_PRIORITY, includes it in 's'. */
1066 void
1067 match_format(const struct match *match, struct ds *s, int priority)
1068 {
1069     const struct flow_wildcards *wc = &match->wc;
1070     size_t start_len = s->length;
1071     const struct flow *f = &match->flow;
1072     bool skip_type = false;
1073
1074     bool skip_proto = false;
1075
1076     int i;
1077
1078     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 36);
1079
1080     if (priority != OFP_DEFAULT_PRIORITY) {
1081         ds_put_format(s, "%spriority=%s%d,",
1082                       colors.special, colors.end, priority);
1083     }
1084
1085     format_uint32_masked(s, "pkt_mark", f->pkt_mark, wc->masks.pkt_mark);
1086
1087     if (wc->masks.recirc_id) {
1088         format_uint32_masked(s, "recirc_id", f->recirc_id,
1089                              wc->masks.recirc_id);
1090     }
1091
1092     if (wc->masks.dp_hash) {
1093         format_uint32_masked(s, "dp_hash", f->dp_hash,
1094                              wc->masks.dp_hash);
1095     }
1096
1097     if (wc->masks.conj_id) {
1098         ds_put_format(s, "%sconj_id%s=%"PRIu32",",
1099                       colors.param, colors.end, f->conj_id);
1100     }
1101
1102     if (wc->masks.skb_priority) {
1103         ds_put_format(s, "%sskb_priority=%s%#"PRIx32",",
1104                       colors.param, colors.end, f->skb_priority);
1105     }
1106
1107     if (wc->masks.actset_output) {
1108         ds_put_format(s, "%sactset_output=%s", colors.param, colors.end);
1109         ofputil_format_port(f->actset_output, s);
1110         ds_put_char(s, ',');
1111     }
1112
1113     if (wc->masks.ct_state) {
1114         if (wc->masks.ct_state == UINT16_MAX) {
1115             ds_put_format(s, "%sct_state=%s", colors.param, colors.end);
1116             if (f->ct_state) {
1117                 format_flags(s, ct_state_to_string, f->ct_state, '|');
1118             } else {
1119                 ds_put_cstr(s, "0"); /* No state. */
1120             }
1121         } else {
1122             format_flags_masked(s, "ct_state", ct_state_to_string,
1123                                 f->ct_state, wc->masks.ct_state, UINT16_MAX);
1124         }
1125         ds_put_char(s, ',');
1126     }
1127
1128     if (wc->masks.ct_zone) {
1129         format_uint16_masked(s, "ct_zone", f->ct_zone, wc->masks.ct_zone);
1130     }
1131
1132     if (wc->masks.ct_mark) {
1133         format_uint32_masked(s, "ct_mark", f->ct_mark, wc->masks.ct_mark);
1134     }
1135
1136     if (!ovs_u128_is_zero(wc->masks.ct_label)) {
1137         format_ct_label_masked(s, &f->ct_label, &wc->masks.ct_label);
1138     }
1139
1140     if (wc->masks.dl_type) {
1141         skip_type = true;
1142         if (f->dl_type == htons(ETH_TYPE_IP)) {
1143             if (wc->masks.nw_proto) {
1144                 skip_proto = true;
1145                 if (f->nw_proto == IPPROTO_ICMP) {
1146                     ds_put_format(s, "%sicmp%s,", colors.value, colors.end);
1147                 } else if (f->nw_proto == IPPROTO_IGMP) {
1148                     ds_put_format(s, "%sigmp%s,", colors.value, colors.end);
1149                 } else if (f->nw_proto == IPPROTO_TCP) {
1150                     ds_put_format(s, "%stcp%s,", colors.value, colors.end);
1151                 } else if (f->nw_proto == IPPROTO_UDP) {
1152                     ds_put_format(s, "%sudp%s,", colors.value, colors.end);
1153                 } else if (f->nw_proto == IPPROTO_SCTP) {
1154                     ds_put_format(s, "%ssctp%s,", colors.value, colors.end);
1155                 } else {
1156                     ds_put_format(s, "%sip%s,", colors.value, colors.end);
1157                     skip_proto = false;
1158                 }
1159             } else {
1160                 ds_put_format(s, "%sip%s,", colors.value, colors.end);
1161             }
1162         } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
1163             if (wc->masks.nw_proto) {
1164                 skip_proto = true;
1165                 if (f->nw_proto == IPPROTO_ICMPV6) {
1166                     ds_put_format(s, "%sicmp6%s,", colors.value, colors.end);
1167                 } else if (f->nw_proto == IPPROTO_TCP) {
1168                     ds_put_format(s, "%stcp6%s,", colors.value, colors.end);
1169                 } else if (f->nw_proto == IPPROTO_UDP) {
1170                     ds_put_format(s, "%sudp6%s,", colors.value, colors.end);
1171                 } else if (f->nw_proto == IPPROTO_SCTP) {
1172                     ds_put_format(s, "%ssctp6%s,", colors.value, colors.end);
1173                 } else {
1174                     ds_put_format(s, "%sipv6%s,", colors.value, colors.end);
1175                     skip_proto = false;
1176                 }
1177             } else {
1178                 ds_put_format(s, "%sipv6%s,", colors.value, colors.end);
1179             }
1180         } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
1181             ds_put_format(s, "%sarp%s,", colors.value, colors.end);
1182         } else if (f->dl_type == htons(ETH_TYPE_RARP)) {
1183             ds_put_format(s, "%srarp%s,", colors.value, colors.end);
1184         } else if (f->dl_type == htons(ETH_TYPE_MPLS)) {
1185             ds_put_format(s, "%smpls%s,", colors.value, colors.end);
1186         } else if (f->dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
1187             ds_put_format(s, "%smplsm%s,", colors.value, colors.end);
1188         } else {
1189             skip_type = false;
1190         }
1191     }
1192     for (i = 0; i < FLOW_N_REGS; i++) {
1193         #define REGNAME_LEN 20
1194         char regname[REGNAME_LEN];
1195         if (snprintf(regname, REGNAME_LEN, "reg%d", i) >= REGNAME_LEN) {
1196             strcpy(regname, "reg?");
1197         }
1198         format_uint32_masked(s, regname, f->regs[i], wc->masks.regs[i]);
1199     }
1200
1201     format_flow_tunnel(s, match);
1202
1203     format_be64_masked(s, "metadata", f->metadata, wc->masks.metadata);
1204
1205     if (wc->masks.in_port.ofp_port) {
1206         ds_put_format(s, "%sin_port=%s", colors.param, colors.end);
1207         ofputil_format_port(f->in_port.ofp_port, s);
1208         ds_put_char(s, ',');
1209     }
1210     if (wc->masks.vlan_tci) {
1211         ovs_be16 vid_mask = wc->masks.vlan_tci & htons(VLAN_VID_MASK);
1212         ovs_be16 pcp_mask = wc->masks.vlan_tci & htons(VLAN_PCP_MASK);
1213         ovs_be16 cfi = wc->masks.vlan_tci & htons(VLAN_CFI);
1214
1215         if (cfi && f->vlan_tci & htons(VLAN_CFI)
1216             && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
1217             && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
1218             && (vid_mask || pcp_mask)) {
1219             if (vid_mask) {
1220                 ds_put_format(s, "%sdl_vlan=%s%"PRIu16",", colors.param,
1221                               colors.end, vlan_tci_to_vid(f->vlan_tci));
1222             }
1223             if (pcp_mask) {
1224                 ds_put_format(s, "%sdl_vlan_pcp=%s%d,", colors.param,
1225                               colors.end, vlan_tci_to_pcp(f->vlan_tci));
1226             }
1227         } else if (wc->masks.vlan_tci == htons(0xffff)) {
1228             ds_put_format(s, "%svlan_tci=%s0x%04"PRIx16",", colors.param,
1229                           colors.end, ntohs(f->vlan_tci));
1230         } else {
1231             ds_put_format(s, "%svlan_tci=%s0x%04"PRIx16"/0x%04"PRIx16",",
1232                           colors.param, colors.end,
1233                           ntohs(f->vlan_tci), ntohs(wc->masks.vlan_tci));
1234         }
1235     }
1236     format_eth_masked(s, "dl_src", f->dl_src, wc->masks.dl_src);
1237     format_eth_masked(s, "dl_dst", f->dl_dst, wc->masks.dl_dst);
1238     if (!skip_type && wc->masks.dl_type) {
1239         ds_put_format(s, "%sdl_type=%s0x%04"PRIx16",",
1240                       colors.param, colors.end, ntohs(f->dl_type));
1241     }
1242     if (f->dl_type == htons(ETH_TYPE_IPV6)) {
1243         format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->masks.ipv6_src);
1244         format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->masks.ipv6_dst);
1245         if (wc->masks.ipv6_label) {
1246             if (wc->masks.ipv6_label == OVS_BE32_MAX) {
1247                 ds_put_format(s, "%sipv6_label=%s0x%05"PRIx32",",
1248                               colors.param, colors.end,
1249                               ntohl(f->ipv6_label));
1250             } else {
1251                 ds_put_format(s, "%sipv6_label=%s0x%05"PRIx32"/0x%05"PRIx32",",
1252                               colors.param, colors.end, ntohl(f->ipv6_label),
1253                               ntohl(wc->masks.ipv6_label));
1254             }
1255         }
1256     } else if (f->dl_type == htons(ETH_TYPE_ARP) ||
1257                f->dl_type == htons(ETH_TYPE_RARP)) {
1258         format_ip_netmask(s, "arp_spa", f->nw_src, wc->masks.nw_src);
1259         format_ip_netmask(s, "arp_tpa", f->nw_dst, wc->masks.nw_dst);
1260     } else {
1261         format_ip_netmask(s, "nw_src", f->nw_src, wc->masks.nw_src);
1262         format_ip_netmask(s, "nw_dst", f->nw_dst, wc->masks.nw_dst);
1263     }
1264     if (!skip_proto && wc->masks.nw_proto) {
1265         if (f->dl_type == htons(ETH_TYPE_ARP) ||
1266             f->dl_type == htons(ETH_TYPE_RARP)) {
1267             ds_put_format(s, "%sarp_op=%s%"PRIu8",",
1268                           colors.param, colors.end, f->nw_proto);
1269         } else {
1270             ds_put_format(s, "%snw_proto=%s%"PRIu8",",
1271                           colors.param, colors.end, f->nw_proto);
1272         }
1273     }
1274     if (f->dl_type == htons(ETH_TYPE_ARP) ||
1275         f->dl_type == htons(ETH_TYPE_RARP)) {
1276         format_eth_masked(s, "arp_sha", f->arp_sha, wc->masks.arp_sha);
1277         format_eth_masked(s, "arp_tha", f->arp_tha, wc->masks.arp_tha);
1278     }
1279     if (wc->masks.nw_tos & IP_DSCP_MASK) {
1280         ds_put_format(s, "%snw_tos=%s%"PRIu8",",
1281                       colors.param, colors.end, f->nw_tos & IP_DSCP_MASK);
1282     }
1283     if (wc->masks.nw_tos & IP_ECN_MASK) {
1284         ds_put_format(s, "%snw_ecn=%s%"PRIu8",",
1285                       colors.param, colors.end, f->nw_tos & IP_ECN_MASK);
1286     }
1287     if (wc->masks.nw_ttl) {
1288         ds_put_format(s, "%snw_ttl=%s%"PRIu8",",
1289                       colors.param, colors.end, f->nw_ttl);
1290     }
1291     if (wc->masks.mpls_lse[0] & htonl(MPLS_LABEL_MASK)) {
1292         ds_put_format(s, "%smpls_label=%s%"PRIu32",", colors.param,
1293                       colors.end, mpls_lse_to_label(f->mpls_lse[0]));
1294     }
1295     if (wc->masks.mpls_lse[0] & htonl(MPLS_TC_MASK)) {
1296         ds_put_format(s, "%smpls_tc=%s%"PRIu8",", colors.param, colors.end,
1297                       mpls_lse_to_tc(f->mpls_lse[0]));
1298     }
1299     if (wc->masks.mpls_lse[0] & htonl(MPLS_TTL_MASK)) {
1300         ds_put_format(s, "%smpls_ttl=%s%"PRIu8",", colors.param, colors.end,
1301                       mpls_lse_to_ttl(f->mpls_lse[0]));
1302     }
1303     if (wc->masks.mpls_lse[0] & htonl(MPLS_BOS_MASK)) {
1304         ds_put_format(s, "%smpls_bos=%s%"PRIu8",", colors.param, colors.end,
1305                       mpls_lse_to_bos(f->mpls_lse[0]));
1306     }
1307     format_be32_masked(s, "mpls_lse1", f->mpls_lse[1], wc->masks.mpls_lse[1]);
1308     format_be32_masked(s, "mpls_lse2", f->mpls_lse[2], wc->masks.mpls_lse[2]);
1309
1310     switch (wc->masks.nw_frag) {
1311     case FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER:
1312         ds_put_format(s, "%snw_frag=%s%s,", colors.param, colors.end,
1313                       f->nw_frag & FLOW_NW_FRAG_ANY
1314                       ? (f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "first")
1315                       : (f->nw_frag & FLOW_NW_FRAG_LATER ? "<error>" : "no"));
1316         break;
1317
1318     case FLOW_NW_FRAG_ANY:
1319         ds_put_format(s, "%snw_frag=%s%s,", colors.param, colors.end,
1320                       f->nw_frag & FLOW_NW_FRAG_ANY ? "yes" : "no");
1321         break;
1322
1323     case FLOW_NW_FRAG_LATER:
1324         ds_put_format(s, "%snw_frag=%s%s,", colors.param, colors.end,
1325                       f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "not_later");
1326         break;
1327     }
1328     if (f->dl_type == htons(ETH_TYPE_IP) &&
1329         f->nw_proto == IPPROTO_ICMP) {
1330         format_be16_masked(s, "icmp_type", f->tp_src, wc->masks.tp_src);
1331         format_be16_masked(s, "icmp_code", f->tp_dst, wc->masks.tp_dst);
1332     } else if (f->dl_type == htons(ETH_TYPE_IP) &&
1333                f->nw_proto == IPPROTO_IGMP) {
1334         format_be16_masked(s, "igmp_type", f->tp_src, wc->masks.tp_src);
1335         format_be16_masked(s, "igmp_code", f->tp_dst, wc->masks.tp_dst);
1336     } else if (f->dl_type == htons(ETH_TYPE_IPV6) &&
1337                f->nw_proto == IPPROTO_ICMPV6) {
1338         format_be16_masked(s, "icmp_type", f->tp_src, wc->masks.tp_src);
1339         format_be16_masked(s, "icmp_code", f->tp_dst, wc->masks.tp_dst);
1340         format_ipv6_netmask(s, "nd_target", &f->nd_target,
1341                             &wc->masks.nd_target);
1342         format_eth_masked(s, "nd_sll", f->arp_sha, wc->masks.arp_sha);
1343         format_eth_masked(s, "nd_tll", f->arp_tha, wc->masks.arp_tha);
1344     } else {
1345         format_be16_masked(s, "tp_src", f->tp_src, wc->masks.tp_src);
1346         format_be16_masked(s, "tp_dst", f->tp_dst, wc->masks.tp_dst);
1347     }
1348     if (is_ip_any(f) && f->nw_proto == IPPROTO_TCP && wc->masks.tcp_flags) {
1349         format_flags_masked(s, "tcp_flags", packet_tcp_flag_to_string,
1350                             ntohs(f->tcp_flags), TCP_FLAGS(wc->masks.tcp_flags),
1351                             TCP_FLAGS(OVS_BE16_MAX));
1352     }
1353
1354     if (s->length > start_len) {
1355         ds_chomp(s, ',');
1356     }
1357 }
1358
1359 /* Converts 'match' to a string and returns the string.  If 'priority' is
1360  * different from OFP_DEFAULT_PRIORITY, includes it in the string.  The caller
1361  * must free the string (with free()). */
1362 char *
1363 match_to_string(const struct match *match, int priority)
1364 {
1365     struct ds s = DS_EMPTY_INITIALIZER;
1366     match_format(match, &s, priority);
1367     return ds_steal_cstr(&s);
1368 }
1369
1370 void
1371 match_print(const struct match *match)
1372 {
1373     char *s = match_to_string(match, OFP_DEFAULT_PRIORITY);
1374     puts(s);
1375     free(s);
1376 }
1377 \f
1378 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1379  * with minimatch_destroy(). */
1380 void
1381 minimatch_init(struct minimatch *dst, const struct match *src)
1382 {
1383     struct miniflow tmp;
1384
1385     miniflow_map_init(&tmp, &src->wc.masks);
1386     /* Allocate two consecutive miniflows. */
1387     miniflow_alloc(dst->flows, 2, &tmp);
1388     miniflow_init(dst->flow, &src->flow);
1389     minimask_init(dst->mask, &src->wc);
1390 }
1391
1392 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1393  * with minimatch_destroy(). */
1394 void
1395 minimatch_clone(struct minimatch *dst, const struct minimatch *src)
1396 {
1397     /* Allocate two consecutive miniflows. */
1398     size_t data_size = miniflow_alloc(dst->flows, 2, &src->mask->masks);
1399
1400     memcpy(miniflow_values(dst->flow),
1401            miniflow_get_values(src->flow), data_size);
1402     memcpy(miniflow_values(&dst->mask->masks),
1403            miniflow_get_values(&src->mask->masks), data_size);
1404 }
1405
1406 /* Initializes 'dst' with the data in 'src', destroying 'src'.  The caller must
1407  * eventually free 'dst' with minimatch_destroy(). */
1408 void
1409 minimatch_move(struct minimatch *dst, struct minimatch *src)
1410 {
1411     dst->flow = src->flow;
1412     dst->mask = src->mask;
1413 }
1414
1415 /* Frees any memory owned by 'match'.  Does not free the storage in which
1416  * 'match' itself resides; the caller is responsible for that. */
1417 void
1418 minimatch_destroy(struct minimatch *match)
1419 {
1420     free(match->flow);
1421 }
1422
1423 /* Initializes 'dst' as a copy of 'src'. */
1424 void
1425 minimatch_expand(const struct minimatch *src, struct match *dst)
1426 {
1427     miniflow_expand(src->flow, &dst->flow);
1428     minimask_expand(src->mask, &dst->wc);
1429     memset(&dst->tun_md, 0, sizeof dst->tun_md);
1430 }
1431
1432 /* Returns true if 'a' and 'b' match the same packets, false otherwise.  */
1433 bool
1434 minimatch_equal(const struct minimatch *a, const struct minimatch *b)
1435 {
1436     return minimask_equal(a->mask, b->mask)
1437         && miniflow_equal(a->flow, b->flow);
1438 }
1439
1440 /* Returns true if 'target' satisifies 'match', that is, if each bit for which
1441  * 'match' specifies a particular value has the correct value in 'target'.
1442  *
1443  * This function is equivalent to miniflow_equal_flow_in_minimask(&match->flow,
1444  * target, &match->mask) but it is faster because of the invariant that
1445  * match->flow.map and match->mask.map are the same. */
1446 bool
1447 minimatch_matches_flow(const struct minimatch *match,
1448                        const struct flow *target)
1449 {
1450     const uint64_t *flowp = miniflow_get_values(match->flow);
1451     const uint64_t *maskp = miniflow_get_values(&match->mask->masks);
1452     size_t idx;
1453
1454     FLOWMAP_FOR_EACH_INDEX(idx, match->flow->map) {
1455         if ((*flowp++ ^ flow_u64_value(target, idx)) & *maskp++) {
1456             return false;
1457         }
1458     }
1459
1460     return true;
1461 }
1462
1463 /* Appends a string representation of 'match' to 's'.  If 'priority' is
1464  * different from OFP_DEFAULT_PRIORITY, includes it in 's'. */
1465 void
1466 minimatch_format(const struct minimatch *match, struct ds *s, int priority)
1467 {
1468     struct match megamatch;
1469
1470     minimatch_expand(match, &megamatch);
1471     match_format(&megamatch, s, priority);
1472 }
1473
1474 /* Converts 'match' to a string and returns the string.  If 'priority' is
1475  * different from OFP_DEFAULT_PRIORITY, includes it in the string.  The caller
1476  * must free the string (with free()). */
1477 char *
1478 minimatch_to_string(const struct minimatch *match, int priority)
1479 {
1480     struct match megamatch;
1481
1482     minimatch_expand(match, &megamatch);
1483     return match_to_string(&megamatch, priority);
1484 }