lib/classifier.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012 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 "classifier.h"
  19 #include <assert.h>
  20 #include <errno.h>
  21 #include <netinet/in.h>
  22 #include "byte-order.h"
  23 #include "dynamic-string.h"
  24 #include "flow.h"
  25 #include "hash.h"
  26 #include "odp-util.h"
  27 #include "ofp-util.h"
  28 #include "packets.h"
  29
  30 static struct cls_table *find_table(const struct classifier *,
  31                                     const struct flow_wildcards *);
  32 static struct cls_table *insert_table(struct classifier *,
  33                                       const struct flow_wildcards *);
  34
  35 static void destroy_table(struct classifier *, struct cls_table *);
  36
  37 static struct cls_rule *find_match(const struct cls_table *,
  38                                    const struct flow *);
  39 static struct cls_rule *find_equal(struct cls_table *, const struct flow *,
  40                                    uint32_t hash);
  41 static struct cls_rule *insert_rule(struct cls_table *, struct cls_rule *);
  42
  43 static bool flow_equal_except(const struct flow *, const struct flow *,
  44                                 const struct flow_wildcards *);
  45
  46 /* Iterates RULE over HEAD and all of the cls_rules on HEAD->list. */
  47 #define FOR_EACH_RULE_IN_LIST(RULE, HEAD)                               \
  48     for ((RULE) = (HEAD); (RULE) != NULL; (RULE) = next_rule_in_list(RULE))
  49 #define FOR_EACH_RULE_IN_LIST_SAFE(RULE, NEXT, HEAD)                    \
  50     for ((RULE) = (HEAD);                                               \
  51          (RULE) != NULL && ((NEXT) = next_rule_in_list(RULE), true);    \
  52          (RULE) = (NEXT))
  53
  54 static struct cls_rule *next_rule_in_list__(struct cls_rule *);
  55 static struct cls_rule *next_rule_in_list(struct cls_rule *);
  56
  57 /* Converts the flow in 'flow' into a cls_rule in 'rule', with the given
  58  * 'wildcards' and 'priority'. */
  59 void
  60 cls_rule_init(const struct flow *flow, const struct flow_wildcards *wildcards,
  61               unsigned int priority, struct cls_rule *rule)
  62 {
  63     rule->flow = *flow;
  64     rule->wc = *wildcards;
  65     rule->priority = priority;
  66     cls_rule_zero_wildcarded_fields(rule);
  67 }
  68
  69 /* Converts the flow in 'flow' into an exact-match cls_rule in 'rule', with the
  70  * given 'priority'.  (For OpenFlow 1.0, exact-match rule are always highest
  71  * priority, so 'priority' should be at least 65535.) */
  72 void
  73 cls_rule_init_exact(const struct flow *flow,
  74                     unsigned int priority, struct cls_rule *rule)
  75 {
  76     rule->flow = *flow;
  77     rule->flow.skb_priority = 0;
  78     flow_wildcards_init_exact(&rule->wc);
  79     rule->priority = priority;
  80 }
  81
  82 /* Initializes 'rule' as a "catch-all" rule that matches every packet, with
  83  * priority 'priority'. */
  84 void
  85 cls_rule_init_catchall(struct cls_rule *rule, unsigned int priority)
  86 {
  87     memset(&rule->flow, 0, sizeof rule->flow);
  88     flow_wildcards_init_catchall(&rule->wc);
  89     rule->priority = priority;
  90 }
  91
  92 /* For each bit or field wildcarded in 'rule', sets the corresponding bit or
  93  * field in 'flow' to all-0-bits.  It is important to maintain this invariant
  94  * in a clr_rule that might be inserted into a classifier.
  95  *
  96  * It is never necessary to call this function directly for a cls_rule that is
  97  * initialized or modified only by cls_rule_*() functions.  It is useful to
  98  * restore the invariant in a cls_rule whose 'wc' member is modified by hand.
  99  */
 100 void
 101 cls_rule_zero_wildcarded_fields(struct cls_rule *rule)
 102 {
 103     flow_zero_wildcards(&rule->flow, &rule->wc);
 104 }
 105
 106 void
 107 cls_rule_set_reg(struct cls_rule *rule, unsigned int reg_idx, uint32_t value)
 108 {
 109     cls_rule_set_reg_masked(rule, reg_idx, value, UINT32_MAX);
 110 }
 111
 112 void
 113 cls_rule_set_reg_masked(struct cls_rule *rule, unsigned int reg_idx,
 114                         uint32_t value, uint32_t mask)
 115 {
 116     assert(reg_idx < FLOW_N_REGS);
 117     flow_wildcards_set_reg_mask(&rule->wc, reg_idx, mask);
 118     rule->flow.regs[reg_idx] = value & mask;
 119 }
 120
 121 void
 122 cls_rule_set_metadata(struct cls_rule *rule, ovs_be64 metadata)
 123 {
 124     cls_rule_set_metadata_masked(rule, metadata, htonll(UINT64_MAX));
 125 }
 126
 127 void
 128 cls_rule_set_metadata_masked(struct cls_rule *rule, ovs_be64 metadata,
 129                              ovs_be64 mask)
 130 {
 131     rule->wc.metadata_mask = mask;
 132     rule->flow.metadata = metadata & mask;
 133 }
 134
 135 void
 136 cls_rule_set_tun_id(struct cls_rule *rule, ovs_be64 tun_id)
 137 {
 138     cls_rule_set_tun_id_masked(rule, tun_id, htonll(UINT64_MAX));
 139 }
 140
 141 void
 142 cls_rule_set_tun_id_masked(struct cls_rule *rule,
 143                            ovs_be64 tun_id, ovs_be64 mask)
 144 {
 145     rule->wc.tun_id_mask = mask;
 146     rule->flow.tun_id = tun_id & mask;
 147 }
 148
 149 void
 150 cls_rule_set_in_port(struct cls_rule *rule, uint16_t ofp_port)
 151 {
 152     rule->wc.wildcards &= ~FWW_IN_PORT;
 153     rule->flow.in_port = ofp_port;
 154 }
 155
 156 void
 157 cls_rule_set_dl_type(struct cls_rule *rule, ovs_be16 dl_type)
 158 {
 159     rule->wc.wildcards &= ~FWW_DL_TYPE;
 160     rule->flow.dl_type = dl_type;
 161 }
 162
 163 /* Modifies 'value_src' so that the Ethernet address must match
 164  * 'value_dst' exactly. 'mask_dst' is set to all 1s */
 165 static void
 166 cls_rule_set_eth(const uint8_t value_src[ETH_ADDR_LEN],
 167                  uint8_t value_dst[ETH_ADDR_LEN],
 168                  uint8_t mask_dst[ETH_ADDR_LEN])
 169 {
 170     memcpy(value_dst, value_src, ETH_ADDR_LEN);
 171     memset(mask_dst, 0xff, ETH_ADDR_LEN);
 172 }
 173
 174 /* Modifies 'value_src' so that the Ethernet address must match
 175  * 'value_src' after each byte is ANDed with the appropriate byte in
 176  * 'mask_src'. 'mask_dst' is set to 'mask_src' */
 177 static void
 178 cls_rule_set_eth_masked(const uint8_t value_src[ETH_ADDR_LEN],
 179                         const uint8_t mask_src[ETH_ADDR_LEN],
 180                         uint8_t value_dst[ETH_ADDR_LEN],
 181                         uint8_t mask_dst[ETH_ADDR_LEN])
 182 {
 183     size_t i;
 184
 185     for (i = 0; i < ETH_ADDR_LEN; i++) {
 186         value_dst[i] = value_src[i] & mask_src[i];
 187         mask_dst[i] = mask_src[i];
 188     }
 189 }
 190
 191 /* Modifies 'rule' so that the source Ethernet address
 192  * must match 'dl_src' exactly. */
 193 void
 194 cls_rule_set_dl_src(struct cls_rule *rule, const uint8_t dl_src[ETH_ADDR_LEN])
 195 {
 196     cls_rule_set_eth(dl_src, rule->flow.dl_src, rule->wc.dl_src_mask);
 197 }
 198
 199 /* Modifies 'rule' so that the source Ethernet address
 200  * must match 'dl_src' after each byte is ANDed with
 201  * the appropriate byte in 'mask'. */
 202 void
 203 cls_rule_set_dl_src_masked(struct cls_rule *rule,
 204                            const uint8_t dl_src[ETH_ADDR_LEN],
 205                            const uint8_t mask[ETH_ADDR_LEN])
 206 {
 207     cls_rule_set_eth_masked(dl_src, mask,
 208                             rule->flow.dl_src, rule->wc.dl_src_mask);
 209 }
 210
 211 /* Modifies 'rule' so that the destination Ethernet address
 212  * must match 'dl_dst' exactly. */
 213 void
 214 cls_rule_set_dl_dst(struct cls_rule *rule, const uint8_t dl_dst[ETH_ADDR_LEN])
 215 {
 216     cls_rule_set_eth(dl_dst, rule->flow.dl_dst, rule->wc.dl_dst_mask);
 217 }
 218
 219 /* Modifies 'rule' so that the destination Ethernet address
 220  * must match 'dl_src' after each byte is ANDed with
 221  * the appropriate byte in 'mask'. */
 222 void
 223 cls_rule_set_dl_dst_masked(struct cls_rule *rule,
 224                            const uint8_t dl_dst[ETH_ADDR_LEN],
 225                            const uint8_t mask[ETH_ADDR_LEN])
 226 {
 227     cls_rule_set_eth_masked(dl_dst, mask,
 228                             rule->flow.dl_dst, rule->wc.dl_dst_mask);
 229 }
 230
 231 void
 232 cls_rule_set_dl_tci(struct cls_rule *rule, ovs_be16 tci)
 233 {
 234     cls_rule_set_dl_tci_masked(rule, tci, htons(0xffff));
 235 }
 236
 237 void
 238 cls_rule_set_dl_tci_masked(struct cls_rule *rule, ovs_be16 tci, ovs_be16 mask)
 239 {
 240     rule->flow.vlan_tci = tci & mask;
 241     rule->wc.vlan_tci_mask = mask;
 242 }
 243
 244 /* Modifies 'rule' so that the VLAN VID is wildcarded.  If the PCP is already
 245  * wildcarded, then 'rule' will match a packet regardless of whether it has an
 246  * 802.1Q header or not. */
 247 void
 248 cls_rule_set_any_vid(struct cls_rule *rule)
 249 {
 250     if (rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK)) {
 251         rule->wc.vlan_tci_mask &= ~htons(VLAN_VID_MASK);
 252         rule->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
 253     } else {
 254         cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
 255     }
 256 }
 257
 258 /* Modifies 'rule' depending on 'dl_vlan':
 259  *
 260  *   - If 'dl_vlan' is htons(OFP_VLAN_NONE), makes 'rule' match only packets
 261  *     without an 802.1Q header.
 262  *
 263  *   - Otherwise, makes 'rule' match only packets with an 802.1Q header whose
 264  *     VID equals the low 12 bits of 'dl_vlan'.
 265  */
 266 void
 267 cls_rule_set_dl_vlan(struct cls_rule *rule, ovs_be16 dl_vlan)
 268 {
 269     flow_set_vlan_vid(&rule->flow, dl_vlan);
 270     if (dl_vlan == htons(OFP10_VLAN_NONE)) {
 271         rule->wc.vlan_tci_mask = htons(UINT16_MAX);
 272     } else {
 273         rule->wc.vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
 274     }
 275 }
 276
 277 /* Modifies 'rule' so that the VLAN PCP is wildcarded.  If the VID is already
 278  * wildcarded, then 'rule' will match a packet regardless of whether it has an
 279  * 802.1Q header or not. */
 280 void
 281 cls_rule_set_any_pcp(struct cls_rule *rule)
 282 {
 283     if (rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK)) {
 284         rule->wc.vlan_tci_mask &= ~htons(VLAN_PCP_MASK);
 285         rule->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
 286     } else {
 287         cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
 288     }
 289 }
 290
 291 /* Modifies 'rule' so that it matches only packets with an 802.1Q header whose
 292  * PCP equals the low 3 bits of 'dl_vlan_pcp'. */
 293 void
 294 cls_rule_set_dl_vlan_pcp(struct cls_rule *rule, uint8_t dl_vlan_pcp)
 295 {
 296     flow_set_vlan_pcp(&rule->flow, dl_vlan_pcp);
 297     rule->wc.vlan_tci_mask |= htons(VLAN_CFI | VLAN_PCP_MASK);
 298 }
 299
 300 void
 301 cls_rule_set_tp_src(struct cls_rule *rule, ovs_be16 tp_src)
 302 {
 303     cls_rule_set_tp_src_masked(rule, tp_src, htons(UINT16_MAX));
 304 }
 305
 306 void
 307 cls_rule_set_tp_src_masked(struct cls_rule *rule, ovs_be16 port, ovs_be16 mask)
 308 {
 309     rule->flow.tp_src = port & mask;
 310     rule->wc.tp_src_mask = mask;
 311 }
 312
 313 void
 314 cls_rule_set_tp_dst(struct cls_rule *rule, ovs_be16 tp_dst)
 315 {
 316     cls_rule_set_tp_dst_masked(rule, tp_dst, htons(UINT16_MAX));
 317 }
 318
 319 void
 320 cls_rule_set_tp_dst_masked(struct cls_rule *rule, ovs_be16 port, ovs_be16 mask)
 321 {
 322     rule->flow.tp_dst = port & mask;
 323     rule->wc.tp_dst_mask = mask;
 324 }
 325
 326 void
 327 cls_rule_set_nw_proto(struct cls_rule *rule, uint8_t nw_proto)
 328 {
 329     rule->wc.wildcards &= ~FWW_NW_PROTO;
 330     rule->flow.nw_proto = nw_proto;
 331 }
 332
 333 void
 334 cls_rule_set_nw_src(struct cls_rule *rule, ovs_be32 nw_src)
 335 {
 336     rule->flow.nw_src = nw_src;
 337     rule->wc.nw_src_mask = htonl(UINT32_MAX);
 338 }
 339
 340 void
 341 cls_rule_set_nw_src_masked(struct cls_rule *rule,
 342                            ovs_be32 nw_src, ovs_be32 mask)
 343 {
 344     rule->flow.nw_src = nw_src & mask;
 345     rule->wc.nw_src_mask = mask;
 346 }
 347
 348 void
 349 cls_rule_set_nw_dst(struct cls_rule *rule, ovs_be32 nw_dst)
 350 {
 351     rule->flow.nw_dst = nw_dst;
 352     rule->wc.nw_dst_mask = htonl(UINT32_MAX);
 353 }
 354
 355 void
 356 cls_rule_set_nw_dst_masked(struct cls_rule *rule, ovs_be32 ip, ovs_be32 mask)
 357 {
 358     rule->flow.nw_dst = ip & mask;
 359     rule->wc.nw_dst_mask = mask;
 360 }
 361
 362 void
 363 cls_rule_set_nw_dscp(struct cls_rule *rule, uint8_t nw_dscp)
 364 {
 365     rule->wc.wildcards &= ~FWW_NW_DSCP;
 366     rule->flow.nw_tos &= ~IP_DSCP_MASK;
 367     rule->flow.nw_tos |= nw_dscp & IP_DSCP_MASK;
 368 }
 369
 370 void
 371 cls_rule_set_nw_ecn(struct cls_rule *rule, uint8_t nw_ecn)
 372 {
 373     rule->wc.wildcards &= ~FWW_NW_ECN;
 374     rule->flow.nw_tos &= ~IP_ECN_MASK;
 375     rule->flow.nw_tos |= nw_ecn & IP_ECN_MASK;
 376 }
 377
 378 void
 379 cls_rule_set_nw_ttl(struct cls_rule *rule, uint8_t nw_ttl)
 380 {
 381     rule->wc.wildcards &= ~FWW_NW_TTL;
 382     rule->flow.nw_ttl = nw_ttl;
 383 }
 384
 385 void
 386 cls_rule_set_nw_frag(struct cls_rule *rule, uint8_t nw_frag)
 387 {
 388     rule->wc.nw_frag_mask |= FLOW_NW_FRAG_MASK;
 389     rule->flow.nw_frag = nw_frag;
 390 }
 391
 392 void
 393 cls_rule_set_nw_frag_masked(struct cls_rule *rule,
 394                             uint8_t nw_frag, uint8_t mask)
 395 {
 396     rule->flow.nw_frag = nw_frag & mask;
 397     rule->wc.nw_frag_mask = mask;
 398 }
 399
 400 void
 401 cls_rule_set_icmp_type(struct cls_rule *rule, uint8_t icmp_type)
 402 {
 403     cls_rule_set_tp_src(rule, htons(icmp_type));
 404 }
 405
 406 void
 407 cls_rule_set_icmp_code(struct cls_rule *rule, uint8_t icmp_code)
 408 {
 409     cls_rule_set_tp_dst(rule, htons(icmp_code));
 410 }
 411
 412 void
 413 cls_rule_set_arp_sha(struct cls_rule *rule, const uint8_t sha[ETH_ADDR_LEN])
 414 {
 415     cls_rule_set_eth(sha, rule->flow.arp_sha, rule->wc.arp_sha_mask);
 416 }
 417
 418 void
 419 cls_rule_set_arp_sha_masked(struct cls_rule *rule,
 420                            const uint8_t arp_sha[ETH_ADDR_LEN],
 421                            const uint8_t mask[ETH_ADDR_LEN])
 422 {
 423     cls_rule_set_eth_masked(arp_sha, mask,
 424                             rule->flow.arp_sha, rule->wc.arp_sha_mask);
 425 }
 426
 427 void
 428 cls_rule_set_arp_tha(struct cls_rule *rule, const uint8_t tha[ETH_ADDR_LEN])
 429 {
 430     cls_rule_set_eth(tha, rule->flow.arp_tha, rule->wc.arp_tha_mask);
 431 }
 432
 433 void
 434 cls_rule_set_arp_tha_masked(struct cls_rule *rule,
 435                            const uint8_t arp_tha[ETH_ADDR_LEN],
 436                            const uint8_t mask[ETH_ADDR_LEN])
 437 {
 438     cls_rule_set_eth_masked(arp_tha, mask,
 439                             rule->flow.arp_tha, rule->wc.arp_tha_mask);
 440 }
 441
 442 void
 443 cls_rule_set_ipv6_src(struct cls_rule *rule, const struct in6_addr *src)
 444 {
 445     rule->flow.ipv6_src = *src;
 446     rule->wc.ipv6_src_mask = in6addr_exact;
 447 }
 448
 449 void
 450 cls_rule_set_ipv6_src_masked(struct cls_rule *rule, const struct in6_addr *src,
 451                              const struct in6_addr *mask)
 452 {
 453     rule->flow.ipv6_src = ipv6_addr_bitand(src, mask);
 454     rule->wc.ipv6_src_mask = *mask;
 455 }
 456
 457 void
 458 cls_rule_set_ipv6_dst(struct cls_rule *rule, const struct in6_addr *dst)
 459 {
 460     rule->flow.ipv6_dst = *dst;
 461     rule->wc.ipv6_dst_mask = in6addr_exact;
 462 }
 463
 464 void
 465 cls_rule_set_ipv6_dst_masked(struct cls_rule *rule, const struct in6_addr *dst,
 466                              const struct in6_addr *mask)
 467 {
 468     rule->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
 469     rule->wc.ipv6_dst_mask = *mask;
 470 }
 471
 472 void
 473 cls_rule_set_ipv6_label(struct cls_rule *rule, ovs_be32 ipv6_label)
 474 {
 475     cls_rule_set_ipv6_label_masked(rule, ipv6_label, htonl(UINT32_MAX));
 476 }
 477
 478 void
 479 cls_rule_set_ipv6_label_masked(struct cls_rule *rule, ovs_be32 ipv6_label,
 480                                ovs_be32 mask)
 481 {
 482     rule->flow.ipv6_label = ipv6_label & mask;
 483     rule->wc.ipv6_label_mask = mask;
 484 }
 485
 486 void
 487 cls_rule_set_nd_target(struct cls_rule *rule, const struct in6_addr *target)
 488 {
 489     rule->flow.nd_target = *target;
 490     rule->wc.nd_target_mask = in6addr_exact;
 491 }
 492
 493 void
 494 cls_rule_set_nd_target_masked(struct cls_rule *rule,
 495                               const struct in6_addr *target,
 496                               const struct in6_addr *mask)
 497 {
 498     rule->flow.nd_target = ipv6_addr_bitand(target, mask);
 499     rule->wc.nd_target_mask = *mask;
 500 }
 501
 502 /* Returns true if 'a' and 'b' have the same priority, wildcard the same
 503  * fields, and have the same values for fixed fields, otherwise false. */
 504 bool
 505 cls_rule_equal(const struct cls_rule *a, const struct cls_rule *b)
 506 {
 507     return (a->priority == b->priority
 508             && flow_wildcards_equal(&a->wc, &b->wc)
 509             && flow_equal(&a->flow, &b->flow));
 510 }
 511
 512 /* Returns a hash value for the flow, wildcards, and priority in 'rule',
 513  * starting from 'basis'. */
 514 uint32_t
 515 cls_rule_hash(const struct cls_rule *rule, uint32_t basis)
 516 {
 517     uint32_t h0 = flow_hash(&rule->flow, basis);
 518     uint32_t h1 = flow_wildcards_hash(&rule->wc, h0);
 519     return hash_int(rule->priority, h1);
 520 }
 521
 522 static void
 523 format_eth_masked(struct ds *s, const char *name, const uint8_t eth[6],
 524                   const uint8_t mask[6])
 525 {
 526     if (!eth_addr_is_zero(mask)) {
 527         ds_put_format(s, "%s=", name);
 528         eth_format_masked(eth, mask, s);
 529         ds_put_char(s, ',');
 530     }
 531 }
 532
 533 static void
 534 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
 535                   ovs_be32 netmask)
 536 {
 537     if (netmask) {
 538         ds_put_format(s, "%s=", name);
 539         ip_format_masked(ip, netmask, s);
 540         ds_put_char(s, ',');
 541     }
 542 }
 543
 544 static void
 545 format_ipv6_netmask(struct ds *s, const char *name,
 546                     const struct in6_addr *addr,
 547                     const struct in6_addr *netmask)
 548 {
 549     if (!ipv6_mask_is_any(netmask)) {
 550         ds_put_format(s, "%s=", name);
 551         print_ipv6_masked(s, addr, netmask);
 552         ds_put_char(s, ',');
 553     }
 554 }
 555
 556
 557 static void
 558 format_be16_masked(struct ds *s, const char *name,
 559                    ovs_be16 value, ovs_be16 mask)
 560 {
 561     if (mask != htons(0)) {
 562         ds_put_format(s, "%s=", name);
 563         if (mask == htons(UINT16_MAX)) {
 564             ds_put_format(s, "%"PRIu16, ntohs(value));
 565         } else {
 566             ds_put_format(s, "0x%"PRIx16"/0x%"PRIx16,
 567                           ntohs(value), ntohs(mask));
 568         }
 569         ds_put_char(s, ',');
 570     }
 571 }
 572
 573 void
 574 cls_rule_format(const struct cls_rule *rule, struct ds *s)
 575 {
 576     const struct flow_wildcards *wc = &rule->wc;
 577     size_t start_len = s->length;
 578     flow_wildcards_t w = wc->wildcards;
 579     const struct flow *f = &rule->flow;
 580     bool skip_type = false;
 581     bool skip_proto = false;
 582
 583     int i;
 584
 585     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 14);
 586
 587     if (rule->priority != OFP_DEFAULT_PRIORITY) {
 588         ds_put_format(s, "priority=%d,", rule->priority);
 589     }
 590
 591     if (!(w & FWW_DL_TYPE)) {
 592         skip_type = true;
 593         if (f->dl_type == htons(ETH_TYPE_IP)) {
 594             if (!(w & FWW_NW_PROTO)) {
 595                 skip_proto = true;
 596                 if (f->nw_proto == IPPROTO_ICMP) {
 597                     ds_put_cstr(s, "icmp,");
 598                 } else if (f->nw_proto == IPPROTO_TCP) {
 599                     ds_put_cstr(s, "tcp,");
 600                 } else if (f->nw_proto == IPPROTO_UDP) {
 601                     ds_put_cstr(s, "udp,");
 602                 } else {
 603                     ds_put_cstr(s, "ip,");
 604                     skip_proto = false;
 605                 }
 606             } else {
 607                 ds_put_cstr(s, "ip,");
 608             }
 609         } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
 610             if (!(w & FWW_NW_PROTO)) {
 611                 skip_proto = true;
 612                 if (f->nw_proto == IPPROTO_ICMPV6) {
 613                     ds_put_cstr(s, "icmp6,");
 614                 } else if (f->nw_proto == IPPROTO_TCP) {
 615                     ds_put_cstr(s, "tcp6,");
 616                 } else if (f->nw_proto == IPPROTO_UDP) {
 617                     ds_put_cstr(s, "udp6,");
 618                 } else {
 619                     ds_put_cstr(s, "ipv6,");
 620                     skip_proto = false;
 621                 }
 622             } else {
 623                 ds_put_cstr(s, "ipv6,");
 624             }
 625         } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
 626             ds_put_cstr(s, "arp,");
 627         } else {
 628             skip_type = false;
 629         }
 630     }
 631     for (i = 0; i < FLOW_N_REGS; i++) {
 632         switch (wc->reg_masks[i]) {
 633         case 0:
 634             break;
 635         case UINT32_MAX:
 636             ds_put_format(s, "reg%d=0x%"PRIx32",", i, f->regs[i]);
 637             break;
 638         default:
 639             ds_put_format(s, "reg%d=0x%"PRIx32"/0x%"PRIx32",",
 640                           i, f->regs[i], wc->reg_masks[i]);
 641             break;
 642         }
 643     }
 644     switch (wc->tun_id_mask) {
 645     case 0:
 646         break;
 647     case CONSTANT_HTONLL(UINT64_MAX):
 648         ds_put_format(s, "tun_id=%#"PRIx64",", ntohll(f->tun_id));
 649         break;
 650     default:
 651         ds_put_format(s, "tun_id=%#"PRIx64"/%#"PRIx64",",
 652                       ntohll(f->tun_id), ntohll(wc->tun_id_mask));
 653         break;
 654     }
 655     switch (wc->metadata_mask) {
 656     case 0:
 657         break;
 658     case CONSTANT_HTONLL(UINT64_MAX):
 659         ds_put_format(s, "metadata=%#"PRIx64",", ntohll(f->metadata));
 660         break;
 661     default:
 662         ds_put_format(s, "metadata=%#"PRIx64"/%#"PRIx64",",
 663                       ntohll(f->metadata), ntohll(wc->metadata_mask));
 664         break;
 665     }
 666     if (!(w & FWW_IN_PORT)) {
 667         ds_put_format(s, "in_port=%"PRIu16",", f->in_port);
 668     }
 669     if (wc->vlan_tci_mask) {
 670         ovs_be16 vid_mask = wc->vlan_tci_mask & htons(VLAN_VID_MASK);
 671         ovs_be16 pcp_mask = wc->vlan_tci_mask & htons(VLAN_PCP_MASK);
 672         ovs_be16 cfi = wc->vlan_tci_mask & htons(VLAN_CFI);
 673
 674         if (cfi && f->vlan_tci & htons(VLAN_CFI)
 675             && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
 676             && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
 677             && (vid_mask || pcp_mask)) {
 678             if (vid_mask) {
 679                 ds_put_format(s, "dl_vlan=%"PRIu16",",
 680                               vlan_tci_to_vid(f->vlan_tci));
 681             }
 682             if (pcp_mask) {
 683                 ds_put_format(s, "dl_vlan_pcp=%d,",
 684                               vlan_tci_to_pcp(f->vlan_tci));
 685             }
 686         } else if (wc->vlan_tci_mask == htons(0xffff)) {
 687             ds_put_format(s, "vlan_tci=0x%04"PRIx16",", ntohs(f->vlan_tci));
 688         } else {
 689             ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
 690                           ntohs(f->vlan_tci), ntohs(wc->vlan_tci_mask));
 691         }
 692     }
 693     format_eth_masked(s, "dl_src", f->dl_src, wc->dl_src_mask);
 694     format_eth_masked(s, "dl_dst", f->dl_dst, wc->dl_dst_mask);
 695     if (!skip_type && !(w & FWW_DL_TYPE)) {
 696         ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
 697     }
 698     if (f->dl_type == htons(ETH_TYPE_IPV6)) {
 699         format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->ipv6_src_mask);
 700         format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->ipv6_dst_mask);
 701         if (wc->ipv6_label_mask) {
 702             if (wc->ipv6_label_mask == htonl(UINT32_MAX)) {
 703                 ds_put_format(s, "ipv6_label=0x%05"PRIx32",",
 704                               ntohl(f->ipv6_label));
 705             } else {
 706                 ds_put_format(s, "ipv6_label=0x%05"PRIx32"/0x%05"PRIx32",",
 707                               ntohl(f->ipv6_label),
 708                               ntohl(wc->ipv6_label_mask));
 709             }
 710         }
 711     } else {
 712         format_ip_netmask(s, "nw_src", f->nw_src, wc->nw_src_mask);
 713         format_ip_netmask(s, "nw_dst", f->nw_dst, wc->nw_dst_mask);
 714     }
 715     if (!skip_proto && !(w & FWW_NW_PROTO)) {
 716         if (f->dl_type == htons(ETH_TYPE_ARP)) {
 717             ds_put_format(s, "arp_op=%"PRIu8",", f->nw_proto);
 718         } else {
 719             ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
 720         }
 721     }
 722     if (f->dl_type == htons(ETH_TYPE_ARP)) {
 723         format_eth_masked(s, "arp_sha", f->arp_sha, wc->arp_sha_mask);
 724         format_eth_masked(s, "arp_tha", f->arp_tha, wc->arp_tha_mask);
 725     }
 726     if (!(w & FWW_NW_DSCP)) {
 727         ds_put_format(s, "nw_tos=%"PRIu8",", f->nw_tos & IP_DSCP_MASK);
 728     }
 729     if (!(w & FWW_NW_ECN)) {
 730         ds_put_format(s, "nw_ecn=%"PRIu8",", f->nw_tos & IP_ECN_MASK);
 731     }
 732     if (!(w & FWW_NW_TTL)) {
 733         ds_put_format(s, "nw_ttl=%"PRIu8",", f->nw_ttl);
 734     }
 735     switch (wc->nw_frag_mask) {
 736     case FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER:
 737         ds_put_format(s, "nw_frag=%s,",
 738                       f->nw_frag & FLOW_NW_FRAG_ANY
 739                       ? (f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "first")
 740                       : (f->nw_frag & FLOW_NW_FRAG_LATER ? "<error>" : "no"));
 741         break;
 742
 743     case FLOW_NW_FRAG_ANY:
 744         ds_put_format(s, "nw_frag=%s,",
 745                       f->nw_frag & FLOW_NW_FRAG_ANY ? "yes" : "no");
 746         break;
 747
 748     case FLOW_NW_FRAG_LATER:
 749         ds_put_format(s, "nw_frag=%s,",
 750                       f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "not_later");
 751         break;
 752     }
 753     if (f->nw_proto == IPPROTO_ICMP) {
 754         format_be16_masked(s, "icmp_type", f->tp_src, wc->tp_src_mask);
 755         format_be16_masked(s, "icmp_code", f->tp_dst, wc->tp_dst_mask);
 756     } else if (f->nw_proto == IPPROTO_ICMPV6) {
 757         format_be16_masked(s, "icmp_type", f->tp_src, wc->tp_src_mask);
 758         format_be16_masked(s, "icmp_code", f->tp_dst, wc->tp_dst_mask);
 759         format_ipv6_netmask(s, "nd_target", &f->nd_target,
 760                             &wc->nd_target_mask);
 761         format_eth_masked(s, "nd_sll", f->arp_sha, wc->arp_sha_mask);
 762         format_eth_masked(s, "nd_tll", f->arp_tha, wc->arp_tha_mask);
 763    } else {
 764         format_be16_masked(s, "tp_src", f->tp_src, wc->tp_src_mask);
 765         format_be16_masked(s, "tp_dst", f->tp_dst, wc->tp_dst_mask);
 766     }
 767
 768     if (s->length > start_len && ds_last(s) == ',') {
 769         s->length--;
 770     }
 771 }
 772
 773 /* Converts 'rule' to a string and returns the string.  The caller must free
 774  * the string (with free()). */
 775 char *
 776 cls_rule_to_string(const struct cls_rule *rule)
 777 {
 778     struct ds s = DS_EMPTY_INITIALIZER;
 779     cls_rule_format(rule, &s);
 780     return ds_steal_cstr(&s);
 781 }
 782
 783 void
 784 cls_rule_print(const struct cls_rule *rule)
 785 {
 786     char *s = cls_rule_to_string(rule);
 787     puts(s);
 788     free(s);
 789 }
 790 \f
 791 /* Initializes 'cls' as a classifier that initially contains no classification
 792  * rules. */
 793 void
 794 classifier_init(struct classifier *cls)
 795 {
 796     cls->n_rules = 0;
 797     hmap_init(&cls->tables);
 798 }
 799
 800 /* Destroys 'cls'.  Rules within 'cls', if any, are not freed; this is the
 801  * caller's responsibility. */
 802 void
 803 classifier_destroy(struct classifier *cls)
 804 {
 805     if (cls) {
 806         struct cls_table *table, *next_table;
 807
 808         HMAP_FOR_EACH_SAFE (table, next_table, hmap_node, &cls->tables) {
 809             hmap_destroy(&table->rules);
 810             hmap_remove(&cls->tables, &table->hmap_node);
 811             free(table);
 812         }
 813         hmap_destroy(&cls->tables);
 814     }
 815 }
 816
 817 /* Returns true if 'cls' contains no classification rules, false otherwise. */
 818 bool
 819 classifier_is_empty(const struct classifier *cls)
 820 {
 821     return cls->n_rules == 0;
 822 }
 823
 824 /* Returns the number of rules in 'classifier'. */
 825 int
 826 classifier_count(const struct classifier *cls)
 827 {
 828     return cls->n_rules;
 829 }
 830
 831 /* Inserts 'rule' into 'cls'.  Until 'rule' is removed from 'cls', the caller
 832  * must not modify or free it.
 833  *
 834  * If 'cls' already contains an identical rule (including wildcards, values of
 835  * fixed fields, and priority), replaces the old rule by 'rule' and returns the
 836  * rule that was replaced.  The caller takes ownership of the returned rule and
 837  * is thus responsible for freeing it, etc., as necessary.
 838  *
 839  * Returns NULL if 'cls' does not contain a rule with an identical key, after
 840  * inserting the new rule.  In this case, no rules are displaced by the new
 841  * rule, even rules that cannot have any effect because the new rule matches a
 842  * superset of their flows and has higher priority. */
 843 struct cls_rule *
 844 classifier_replace(struct classifier *cls, struct cls_rule *rule)
 845 {
 846     struct cls_rule *old_rule;
 847     struct cls_table *table;
 848
 849     table = find_table(cls, &rule->wc);
 850     if (!table) {
 851         table = insert_table(cls, &rule->wc);
 852     }
 853
 854     old_rule = insert_rule(table, rule);
 855     if (!old_rule) {
 856         table->n_table_rules++;
 857         cls->n_rules++;
 858     }
 859     return old_rule;
 860 }
 861
 862 /* Inserts 'rule' into 'cls'.  Until 'rule' is removed from 'cls', the caller
 863  * must not modify or free it.
 864  *
 865  * 'cls' must not contain an identical rule (including wildcards, values of
 866  * fixed fields, and priority).  Use classifier_find_rule_exactly() to find
 867  * such a rule. */
 868 void
 869 classifier_insert(struct classifier *cls, struct cls_rule *rule)
 870 {
 871     struct cls_rule *displaced_rule = classifier_replace(cls, rule);
 872     assert(!displaced_rule);
 873 }
 874
 875 /* Removes 'rule' from 'cls'.  It is the caller's responsibility to free
 876  * 'rule', if this is desirable. */
 877 void
 878 classifier_remove(struct classifier *cls, struct cls_rule *rule)
 879 {
 880     struct cls_rule *head;
 881     struct cls_table *table;
 882
 883     table = find_table(cls, &rule->wc);
 884     head = find_equal(table, &rule->flow, rule->hmap_node.hash);
 885     if (head != rule) {
 886         list_remove(&rule->list);
 887     } else if (list_is_empty(&rule->list)) {
 888         hmap_remove(&table->rules, &rule->hmap_node);
 889     } else {
 890         struct cls_rule *next = CONTAINER_OF(rule->list.next,
 891                                              struct cls_rule, list);
 892
 893         list_remove(&rule->list);
 894         hmap_replace(&table->rules, &rule->hmap_node, &next->hmap_node);
 895     }
 896
 897     if (--table->n_table_rules == 0) {
 898         destroy_table(cls, table);
 899     }
 900
 901     cls->n_rules--;
 902 }
 903
 904 /* Finds and returns the highest-priority rule in 'cls' that matches 'flow'.
 905  * Returns a null pointer if no rules in 'cls' match 'flow'.  If multiple rules
 906  * of equal priority match 'flow', returns one arbitrarily. */
 907 struct cls_rule *
 908 classifier_lookup(const struct classifier *cls, const struct flow *flow)
 909 {
 910     struct cls_table *table;
 911     struct cls_rule *best;
 912
 913     best = NULL;
 914     HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
 915         struct cls_rule *rule = find_match(table, flow);
 916         if (rule && (!best || rule->priority > best->priority)) {
 917             best = rule;
 918         }
 919     }
 920     return best;
 921 }
 922
 923 /* Finds and returns a rule in 'cls' with exactly the same priority and
 924  * matching criteria as 'target'.  Returns a null pointer if 'cls' doesn't
 925  * contain an exact match. */
 926 struct cls_rule *
 927 classifier_find_rule_exactly(const struct classifier *cls,
 928                              const struct cls_rule *target)
 929 {
 930     struct cls_rule *head, *rule;
 931     struct cls_table *table;
 932
 933     table = find_table(cls, &target->wc);
 934     if (!table) {
 935         return NULL;
 936     }
 937
 938     head = find_equal(table, &target->flow, flow_hash(&target->flow, 0));
 939     FOR_EACH_RULE_IN_LIST (rule, head) {
 940         if (target->priority >= rule->priority) {
 941             return target->priority == rule->priority ? rule : NULL;
 942         }
 943     }
 944     return NULL;
 945 }
 946
 947 /* Checks if 'target' would overlap any other rule in 'cls'.  Two rules are
 948  * considered to overlap if both rules have the same priority and a packet
 949  * could match both. */
 950 bool
 951 classifier_rule_overlaps(const struct classifier *cls,
 952                          const struct cls_rule *target)
 953 {
 954     struct cls_table *table;
 955
 956     HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
 957         struct flow_wildcards wc;
 958         struct cls_rule *head;
 959
 960         flow_wildcards_combine(&wc, &target->wc, &table->wc);
 961         HMAP_FOR_EACH (head, hmap_node, &table->rules) {
 962             struct cls_rule *rule;
 963
 964             FOR_EACH_RULE_IN_LIST (rule, head) {
 965                 if (rule->priority == target->priority
 966                     && flow_equal_except(&target->flow, &rule->flow, &wc)) {
 967                     return true;
 968                 }
 969             }
 970         }
 971     }
 972
 973     return false;
 974 }
 975
 976 /* Returns true if 'rule' exactly matches 'criteria' or if 'rule' is more
 977  * specific than 'criteria'.  That is, 'rule' matches 'criteria' and this
 978  * function returns true if, for every field:
 979  *
 980  *   - 'criteria' and 'rule' specify the same (non-wildcarded) value for the
 981  *     field, or
 982  *
 983  *   - 'criteria' wildcards the field,
 984  *
 985  * Conversely, 'rule' does not match 'criteria' and this function returns false
 986  * if, for at least one field:
 987  *
 988  *   - 'criteria' and 'rule' specify different values for the field, or
 989  *
 990  *   - 'criteria' specifies a value for the field but 'rule' wildcards it.
 991  *
 992  * Equivalently, the truth table for whether a field matches is:
 993  *
 994  *                                     rule
 995  *
 996  *                   c         wildcard    exact
 997  *                   r        +---------+---------+
 998  *                   i   wild |   yes   |   yes   |
 999  *                   t   card |         |         |
1000  *                   e        +---------+---------+
1001  *                   r  exact |    no   |if values|
1002  *                   i        |         |are equal|
1003  *                   a        +---------+---------+
1004  *
1005  * This is the matching rule used by OpenFlow 1.0 non-strict OFPT_FLOW_MOD
1006  * commands and by OpenFlow 1.0 aggregate and flow stats.
1007  *
1008  * Ignores rule->priority and criteria->priority. */
1009 bool
1010 cls_rule_is_loose_match(const struct cls_rule *rule,
1011                         const struct cls_rule *criteria)
1012 {
1013     return (!flow_wildcards_has_extra(&rule->wc, &criteria->wc)
1014             && flow_equal_except(&rule->flow, &criteria->flow, &criteria->wc));
1015 }
1016 \f
1017 /* Iteration. */
1018
1019 static bool
1020 rule_matches(const struct cls_rule *rule, const struct cls_rule *target)
1021 {
1022     return (!target
1023             || flow_equal_except(&rule->flow, &target->flow, &target->wc));
1024 }
1025
1026 static struct cls_rule *
1027 search_table(const struct cls_table *table, const struct cls_rule *target)
1028 {
1029     if (!target || !flow_wildcards_has_extra(&table->wc, &target->wc)) {
1030         struct cls_rule *rule;
1031
1032         HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
1033             if (rule_matches(rule, target)) {
1034                 return rule;
1035             }
1036         }
1037     }
1038     return NULL;
1039 }
1040
1041 /* Initializes 'cursor' for iterating through rules in 'cls':
1042  *
1043  *     - If 'target' is null, the cursor will visit every rule in 'cls'.
1044  *
1045  *     - If 'target' is nonnull, the cursor will visit each 'rule' in 'cls'
1046  *       such that cls_rule_is_loose_match(rule, target) returns true.
1047  *
1048  * Ignores target->priority. */
1049 void
1050 cls_cursor_init(struct cls_cursor *cursor, const struct classifier *cls,
1051                 const struct cls_rule *target)
1052 {
1053     cursor->cls = cls;
1054     cursor->target = target;
1055 }
1056
1057 /* Returns the first matching cls_rule in 'cursor''s iteration, or a null
1058  * pointer if there are no matches. */
1059 struct cls_rule *
1060 cls_cursor_first(struct cls_cursor *cursor)
1061 {
1062     struct cls_table *table;
1063
1064     HMAP_FOR_EACH (table, hmap_node, &cursor->cls->tables) {
1065         struct cls_rule *rule = search_table(table, cursor->target);
1066         if (rule) {
1067             cursor->table = table;
1068             return rule;
1069         }
1070     }
1071
1072     return NULL;
1073 }
1074
1075 /* Returns the next matching cls_rule in 'cursor''s iteration, or a null
1076  * pointer if there are no more matches. */
1077 struct cls_rule *
1078 cls_cursor_next(struct cls_cursor *cursor, struct cls_rule *rule)
1079 {
1080     const struct cls_table *table;
1081     struct cls_rule *next;
1082
1083     next = next_rule_in_list__(rule);
1084     if (next->priority < rule->priority) {
1085         return next;
1086     }
1087
1088     /* 'next' is the head of the list, that is, the rule that is included in
1089      * the table's hmap.  (This is important when the classifier contains rules
1090      * that differ only in priority.) */
1091     rule = next;
1092     HMAP_FOR_EACH_CONTINUE (rule, hmap_node, &cursor->table->rules) {
1093         if (rule_matches(rule, cursor->target)) {
1094             return rule;
1095         }
1096     }
1097
1098     table = cursor->table;
1099     HMAP_FOR_EACH_CONTINUE (table, hmap_node, &cursor->cls->tables) {
1100         rule = search_table(table, cursor->target);
1101         if (rule) {
1102             cursor->table = table;
1103             return rule;
1104         }
1105     }
1106
1107     return NULL;
1108 }
1109 \f
1110 static struct cls_table *
1111 find_table(const struct classifier *cls, const struct flow_wildcards *wc)
1112 {
1113     struct cls_table *table;
1114
1115     HMAP_FOR_EACH_IN_BUCKET (table, hmap_node, flow_wildcards_hash(wc, 0),
1116                              &cls->tables) {
1117         if (flow_wildcards_equal(wc, &table->wc)) {
1118             return table;
1119         }
1120     }
1121     return NULL;
1122 }
1123
1124 static struct cls_table *
1125 insert_table(struct classifier *cls, const struct flow_wildcards *wc)
1126 {
1127     struct cls_table *table;
1128
1129     table = xzalloc(sizeof *table);
1130     hmap_init(&table->rules);
1131     table->wc = *wc;
1132     table->is_catchall = flow_wildcards_is_catchall(&table->wc);
1133     hmap_insert(&cls->tables, &table->hmap_node, flow_wildcards_hash(wc, 0));
1134
1135     return table;
1136 }
1137
1138 static void
1139 destroy_table(struct classifier *cls, struct cls_table *table)
1140 {
1141     hmap_remove(&cls->tables, &table->hmap_node);
1142     hmap_destroy(&table->rules);
1143     free(table);
1144 }
1145
1146 static struct cls_rule *
1147 find_match(const struct cls_table *table, const struct flow *flow)
1148 {
1149     struct cls_rule *rule;
1150
1151     if (table->is_catchall) {
1152         HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
1153             return rule;
1154         }
1155     } else {
1156         struct flow f;
1157
1158         f = *flow;
1159         flow_zero_wildcards(&f, &table->wc);
1160         HMAP_FOR_EACH_WITH_HASH (rule, hmap_node, flow_hash(&f, 0),
1161                                  &table->rules) {
1162             if (flow_equal(&f, &rule->flow)) {
1163                 return rule;
1164             }
1165         }
1166     }
1167
1168     return NULL;
1169 }
1170
1171 static struct cls_rule *
1172 find_equal(struct cls_table *table, const struct flow *flow, uint32_t hash)
1173 {
1174     struct cls_rule *head;
1175
1176     HMAP_FOR_EACH_WITH_HASH (head, hmap_node, hash, &table->rules) {
1177         if (flow_equal(&head->flow, flow)) {
1178             return head;
1179         }
1180     }
1181     return NULL;
1182 }
1183
1184 static struct cls_rule *
1185 insert_rule(struct cls_table *table, struct cls_rule *new)
1186 {
1187     struct cls_rule *head;
1188
1189     new->hmap_node.hash = flow_hash(&new->flow, 0);
1190
1191     head = find_equal(table, &new->flow, new->hmap_node.hash);
1192     if (!head) {
1193         hmap_insert(&table->rules, &new->hmap_node, new->hmap_node.hash);
1194         list_init(&new->list);
1195         return NULL;
1196     } else {
1197         /* Scan the list for the insertion point that will keep the list in
1198          * order of decreasing priority. */
1199         struct cls_rule *rule;
1200         FOR_EACH_RULE_IN_LIST (rule, head) {
1201             if (new->priority >= rule->priority) {
1202                 if (rule == head) {
1203                     /* 'new' is the new highest-priority flow in the list. */
1204                     hmap_replace(&table->rules,
1205                                  &rule->hmap_node, &new->hmap_node);
1206                 }
1207
1208                 if (new->priority == rule->priority) {
1209                     list_replace(&new->list, &rule->list);
1210                     return rule;
1211                 } else {
1212                     list_insert(&rule->list, &new->list);
1213                     return NULL;
1214                 }
1215             }
1216         }
1217
1218         /* Insert 'new' at the end of the list. */
1219         list_push_back(&head->list, &new->list);
1220         return NULL;
1221     }
1222 }
1223
1224 static struct cls_rule *
1225 next_rule_in_list__(struct cls_rule *rule)
1226 {
1227     struct cls_rule *next = OBJECT_CONTAINING(rule->list.next, next, list);
1228     return next;
1229 }
1230
1231 static struct cls_rule *
1232 next_rule_in_list(struct cls_rule *rule)
1233 {
1234     struct cls_rule *next = next_rule_in_list__(rule);
1235     return next->priority < rule->priority ? next : NULL;
1236 }
1237
1238 static bool
1239 ipv6_equal_except(const struct in6_addr *a, const struct in6_addr *b,
1240                   const struct in6_addr *mask)
1241 {
1242     int i;
1243
1244 #ifdef s6_addr32
1245     for (i=0; i<4; i++) {
1246         if ((a->s6_addr32[i] ^ b->s6_addr32[i]) & mask->s6_addr32[i]) {
1247             return false;
1248         }
1249     }
1250 #else
1251     for (i=0; i<16; i++) {
1252         if ((a->s6_addr[i] ^ b->s6_addr[i]) & mask->s6_addr[i]) {
1253             return false;
1254         }
1255     }
1256 #endif
1257
1258     return true;
1259 }
1260
1261
1262 static bool
1263 flow_equal_except(const struct flow *a, const struct flow *b,
1264                   const struct flow_wildcards *wildcards)
1265 {
1266     const flow_wildcards_t wc = wildcards->wildcards;
1267     int i;
1268
1269     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 14);
1270
1271     for (i = 0; i < FLOW_N_REGS; i++) {
1272         if ((a->regs[i] ^ b->regs[i]) & wildcards->reg_masks[i]) {
1273             return false;
1274         }
1275     }
1276
1277     return (!((a->tun_id ^ b->tun_id) & wildcards->tun_id_mask)
1278             && !((a->metadata ^ b->metadata) & wildcards->metadata_mask)
1279             && !((a->nw_src ^ b->nw_src) & wildcards->nw_src_mask)
1280             && !((a->nw_dst ^ b->nw_dst) & wildcards->nw_dst_mask)
1281             && (wc & FWW_IN_PORT || a->in_port == b->in_port)
1282             && !((a->vlan_tci ^ b->vlan_tci) & wildcards->vlan_tci_mask)
1283             && (wc & FWW_DL_TYPE || a->dl_type == b->dl_type)
1284             && !((a->tp_src ^ b->tp_src) & wildcards->tp_src_mask)
1285             && !((a->tp_dst ^ b->tp_dst) & wildcards->tp_dst_mask)
1286             && eth_addr_equal_except(a->dl_src, b->dl_src,
1287                                      wildcards->dl_src_mask)
1288             && eth_addr_equal_except(a->dl_dst, b->dl_dst,
1289                                      wildcards->dl_dst_mask)
1290             && (wc & FWW_NW_PROTO || a->nw_proto == b->nw_proto)
1291             && (wc & FWW_NW_TTL || a->nw_ttl == b->nw_ttl)
1292             && (wc & FWW_NW_DSCP || !((a->nw_tos ^ b->nw_tos) & IP_DSCP_MASK))
1293             && (wc & FWW_NW_ECN || !((a->nw_tos ^ b->nw_tos) & IP_ECN_MASK))
1294             && !((a->nw_frag ^ b->nw_frag) & wildcards->nw_frag_mask)
1295             && eth_addr_equal_except(a->arp_sha, b->arp_sha,
1296                                      wildcards->arp_sha_mask)
1297             && eth_addr_equal_except(a->arp_tha, b->arp_tha,
1298                                      wildcards->arp_tha_mask)
1299             && !((a->ipv6_label ^ b->ipv6_label) & wildcards->ipv6_label_mask)
1300             && ipv6_equal_except(&a->ipv6_src, &b->ipv6_src,
1301                     &wildcards->ipv6_src_mask)
1302             && ipv6_equal_except(&a->ipv6_dst, &b->ipv6_dst,
1303                     &wildcards->ipv6_dst_mask)
1304             && ipv6_equal_except(&a->nd_target, &b->nd_target,
1305                                  &wildcards->nd_target_mask));
1306 }