lib/match.c

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