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.in_port_mask = UINT16_MAX;
 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.dl_type_mask = htons(UINT16_MAX);
 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_dl_vlan(&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 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
 278  * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
 279  * plus CFI). */
 280 void
 281 cls_rule_set_vlan_vid(struct cls_rule *rule, ovs_be16 vid)
 282 {
 283     cls_rule_set_vlan_vid_masked(rule, vid, htons(VLAN_VID_MASK | VLAN_CFI));
 284 }
 285
 286
 287 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
 288  * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
 289  * plus CFI), with the corresponding 'mask'. */
 290 void
 291 cls_rule_set_vlan_vid_masked(struct cls_rule *rule,
 292                              ovs_be16 vid, ovs_be16 mask)
 293 {
 294     ovs_be16 pcp_mask = htons(VLAN_PCP_MASK);
 295     ovs_be16 vid_mask = htons(VLAN_VID_MASK | VLAN_CFI);
 296
 297     mask &= vid_mask;
 298     flow_set_vlan_vid(&rule->flow, vid & mask);
 299     rule->wc.vlan_tci_mask = mask | (rule->wc.vlan_tci_mask & pcp_mask);
 300 }
 301
 302 /* Modifies 'rule' so that the VLAN PCP is wildcarded.  If the VID is already
 303  * wildcarded, then 'rule' will match a packet regardless of whether it has an
 304  * 802.1Q header or not. */
 305 void
 306 cls_rule_set_any_pcp(struct cls_rule *rule)
 307 {
 308     if (rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK)) {
 309         rule->wc.vlan_tci_mask &= ~htons(VLAN_PCP_MASK);
 310         rule->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
 311     } else {
 312         cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
 313     }
 314 }
 315
 316 /* Modifies 'rule' so that it matches only packets with an 802.1Q header whose
 317  * PCP equals the low 3 bits of 'dl_vlan_pcp'. */
 318 void
 319 cls_rule_set_dl_vlan_pcp(struct cls_rule *rule, uint8_t dl_vlan_pcp)
 320 {
 321     flow_set_vlan_pcp(&rule->flow, dl_vlan_pcp);
 322     rule->wc.vlan_tci_mask |= htons(VLAN_CFI | VLAN_PCP_MASK);
 323 }
 324
 325 void
 326 cls_rule_set_tp_src(struct cls_rule *rule, ovs_be16 tp_src)
 327 {
 328     cls_rule_set_tp_src_masked(rule, tp_src, htons(UINT16_MAX));
 329 }
 330
 331 void
 332 cls_rule_set_tp_src_masked(struct cls_rule *rule, ovs_be16 port, ovs_be16 mask)
 333 {
 334     rule->flow.tp_src = port & mask;
 335     rule->wc.tp_src_mask = mask;
 336 }
 337
 338 void
 339 cls_rule_set_tp_dst(struct cls_rule *rule, ovs_be16 tp_dst)
 340 {
 341     cls_rule_set_tp_dst_masked(rule, tp_dst, htons(UINT16_MAX));
 342 }
 343
 344 void
 345 cls_rule_set_tp_dst_masked(struct cls_rule *rule, ovs_be16 port, ovs_be16 mask)
 346 {
 347     rule->flow.tp_dst = port & mask;
 348     rule->wc.tp_dst_mask = mask;
 349 }
 350
 351 void
 352 cls_rule_set_nw_proto(struct cls_rule *rule, uint8_t nw_proto)
 353 {
 354     rule->flow.nw_proto = nw_proto;
 355     rule->wc.nw_proto_mask = UINT8_MAX;
 356 }
 357
 358 void
 359 cls_rule_set_nw_src(struct cls_rule *rule, ovs_be32 nw_src)
 360 {
 361     rule->flow.nw_src = nw_src;
 362     rule->wc.nw_src_mask = htonl(UINT32_MAX);
 363 }
 364
 365 void
 366 cls_rule_set_nw_src_masked(struct cls_rule *rule,
 367                            ovs_be32 nw_src, ovs_be32 mask)
 368 {
 369     rule->flow.nw_src = nw_src & mask;
 370     rule->wc.nw_src_mask = mask;
 371 }
 372
 373 void
 374 cls_rule_set_nw_dst(struct cls_rule *rule, ovs_be32 nw_dst)
 375 {
 376     rule->flow.nw_dst = nw_dst;
 377     rule->wc.nw_dst_mask = htonl(UINT32_MAX);
 378 }
 379
 380 void
 381 cls_rule_set_nw_dst_masked(struct cls_rule *rule, ovs_be32 ip, ovs_be32 mask)
 382 {
 383     rule->flow.nw_dst = ip & mask;
 384     rule->wc.nw_dst_mask = mask;
 385 }
 386
 387 void
 388 cls_rule_set_nw_dscp(struct cls_rule *rule, uint8_t nw_dscp)
 389 {
 390     rule->wc.nw_tos_mask |= IP_DSCP_MASK;
 391     rule->flow.nw_tos &= ~IP_DSCP_MASK;
 392     rule->flow.nw_tos |= nw_dscp & IP_DSCP_MASK;
 393 }
 394
 395 void
 396 cls_rule_set_nw_ecn(struct cls_rule *rule, uint8_t nw_ecn)
 397 {
 398     rule->wc.nw_tos_mask |= IP_ECN_MASK;
 399     rule->flow.nw_tos &= ~IP_ECN_MASK;
 400     rule->flow.nw_tos |= nw_ecn & IP_ECN_MASK;
 401 }
 402
 403 void
 404 cls_rule_set_nw_ttl(struct cls_rule *rule, uint8_t nw_ttl)
 405 {
 406     rule->wc.nw_ttl_mask = UINT8_MAX;
 407     rule->flow.nw_ttl = nw_ttl;
 408 }
 409
 410 void
 411 cls_rule_set_nw_frag(struct cls_rule *rule, uint8_t nw_frag)
 412 {
 413     rule->wc.nw_frag_mask |= FLOW_NW_FRAG_MASK;
 414     rule->flow.nw_frag = nw_frag;
 415 }
 416
 417 void
 418 cls_rule_set_nw_frag_masked(struct cls_rule *rule,
 419                             uint8_t nw_frag, uint8_t mask)
 420 {
 421     rule->flow.nw_frag = nw_frag & mask;
 422     rule->wc.nw_frag_mask = mask;
 423 }
 424
 425 void
 426 cls_rule_set_icmp_type(struct cls_rule *rule, uint8_t icmp_type)
 427 {
 428     cls_rule_set_tp_src(rule, htons(icmp_type));
 429 }
 430
 431 void
 432 cls_rule_set_icmp_code(struct cls_rule *rule, uint8_t icmp_code)
 433 {
 434     cls_rule_set_tp_dst(rule, htons(icmp_code));
 435 }
 436
 437 void
 438 cls_rule_set_arp_sha(struct cls_rule *rule, const uint8_t sha[ETH_ADDR_LEN])
 439 {
 440     cls_rule_set_eth(sha, rule->flow.arp_sha, rule->wc.arp_sha_mask);
 441 }
 442
 443 void
 444 cls_rule_set_arp_sha_masked(struct cls_rule *rule,
 445                            const uint8_t arp_sha[ETH_ADDR_LEN],
 446                            const uint8_t mask[ETH_ADDR_LEN])
 447 {
 448     cls_rule_set_eth_masked(arp_sha, mask,
 449                             rule->flow.arp_sha, rule->wc.arp_sha_mask);
 450 }
 451
 452 void
 453 cls_rule_set_arp_tha(struct cls_rule *rule, const uint8_t tha[ETH_ADDR_LEN])
 454 {
 455     cls_rule_set_eth(tha, rule->flow.arp_tha, rule->wc.arp_tha_mask);
 456 }
 457
 458 void
 459 cls_rule_set_arp_tha_masked(struct cls_rule *rule,
 460                            const uint8_t arp_tha[ETH_ADDR_LEN],
 461                            const uint8_t mask[ETH_ADDR_LEN])
 462 {
 463     cls_rule_set_eth_masked(arp_tha, mask,
 464                             rule->flow.arp_tha, rule->wc.arp_tha_mask);
 465 }
 466
 467 void
 468 cls_rule_set_ipv6_src(struct cls_rule *rule, const struct in6_addr *src)
 469 {
 470     rule->flow.ipv6_src = *src;
 471     rule->wc.ipv6_src_mask = in6addr_exact;
 472 }
 473
 474 void
 475 cls_rule_set_ipv6_src_masked(struct cls_rule *rule, const struct in6_addr *src,
 476                              const struct in6_addr *mask)
 477 {
 478     rule->flow.ipv6_src = ipv6_addr_bitand(src, mask);
 479     rule->wc.ipv6_src_mask = *mask;
 480 }
 481
 482 void
 483 cls_rule_set_ipv6_dst(struct cls_rule *rule, const struct in6_addr *dst)
 484 {
 485     rule->flow.ipv6_dst = *dst;
 486     rule->wc.ipv6_dst_mask = in6addr_exact;
 487 }
 488
 489 void
 490 cls_rule_set_ipv6_dst_masked(struct cls_rule *rule, const struct in6_addr *dst,
 491                              const struct in6_addr *mask)
 492 {
 493     rule->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
 494     rule->wc.ipv6_dst_mask = *mask;
 495 }
 496
 497 void
 498 cls_rule_set_ipv6_label(struct cls_rule *rule, ovs_be32 ipv6_label)
 499 {
 500     cls_rule_set_ipv6_label_masked(rule, ipv6_label, htonl(UINT32_MAX));
 501 }
 502
 503 void
 504 cls_rule_set_ipv6_label_masked(struct cls_rule *rule, ovs_be32 ipv6_label,
 505                                ovs_be32 mask)
 506 {
 507     rule->flow.ipv6_label = ipv6_label & mask;
 508     rule->wc.ipv6_label_mask = mask;
 509 }
 510
 511 void
 512 cls_rule_set_nd_target(struct cls_rule *rule, const struct in6_addr *target)
 513 {
 514     rule->flow.nd_target = *target;
 515     rule->wc.nd_target_mask = in6addr_exact;
 516 }
 517
 518 void
 519 cls_rule_set_nd_target_masked(struct cls_rule *rule,
 520                               const struct in6_addr *target,
 521                               const struct in6_addr *mask)
 522 {
 523     rule->flow.nd_target = ipv6_addr_bitand(target, mask);
 524     rule->wc.nd_target_mask = *mask;
 525 }
 526
 527 /* Returns true if 'a' and 'b' have the same priority, wildcard the same
 528  * fields, and have the same values for fixed fields, otherwise false. */
 529 bool
 530 cls_rule_equal(const struct cls_rule *a, const struct cls_rule *b)
 531 {
 532     return (a->priority == b->priority
 533             && flow_wildcards_equal(&a->wc, &b->wc)
 534             && flow_equal(&a->flow, &b->flow));
 535 }
 536
 537 /* Returns a hash value for the flow, wildcards, and priority in 'rule',
 538  * starting from 'basis'. */
 539 uint32_t
 540 cls_rule_hash(const struct cls_rule *rule, uint32_t basis)
 541 {
 542     uint32_t h0 = flow_hash(&rule->flow, basis);
 543     uint32_t h1 = flow_wildcards_hash(&rule->wc, h0);
 544     return hash_int(rule->priority, h1);
 545 }
 546
 547 static void
 548 format_eth_masked(struct ds *s, const char *name, const uint8_t eth[6],
 549                   const uint8_t mask[6])
 550 {
 551     if (!eth_addr_is_zero(mask)) {
 552         ds_put_format(s, "%s=", name);
 553         eth_format_masked(eth, mask, s);
 554         ds_put_char(s, ',');
 555     }
 556 }
 557
 558 static void
 559 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
 560                   ovs_be32 netmask)
 561 {
 562     if (netmask) {
 563         ds_put_format(s, "%s=", name);
 564         ip_format_masked(ip, netmask, s);
 565         ds_put_char(s, ',');
 566     }
 567 }
 568
 569 static void
 570 format_ipv6_netmask(struct ds *s, const char *name,
 571                     const struct in6_addr *addr,
 572                     const struct in6_addr *netmask)
 573 {
 574     if (!ipv6_mask_is_any(netmask)) {
 575         ds_put_format(s, "%s=", name);
 576         print_ipv6_masked(s, addr, netmask);
 577         ds_put_char(s, ',');
 578     }
 579 }
 580
 581
 582 static void
 583 format_be16_masked(struct ds *s, const char *name,
 584                    ovs_be16 value, ovs_be16 mask)
 585 {
 586     if (mask != htons(0)) {
 587         ds_put_format(s, "%s=", name);
 588         if (mask == htons(UINT16_MAX)) {
 589             ds_put_format(s, "%"PRIu16, ntohs(value));
 590         } else {
 591             ds_put_format(s, "0x%"PRIx16"/0x%"PRIx16,
 592                           ntohs(value), ntohs(mask));
 593         }
 594         ds_put_char(s, ',');
 595     }
 596 }
 597
 598 void
 599 cls_rule_format(const struct cls_rule *rule, struct ds *s)
 600 {
 601     const struct flow_wildcards *wc = &rule->wc;
 602     size_t start_len = s->length;
 603     const struct flow *f = &rule->flow;
 604     bool skip_type = false;
 605     bool skip_proto = false;
 606
 607     int i;
 608
 609     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 17);
 610
 611     if (rule->priority != OFP_DEFAULT_PRIORITY) {
 612         ds_put_format(s, "priority=%d,", rule->priority);
 613     }
 614
 615     if (wc->dl_type_mask) {
 616         skip_type = true;
 617         if (f->dl_type == htons(ETH_TYPE_IP)) {
 618             if (wc->nw_proto_mask) {
 619                 skip_proto = true;
 620                 if (f->nw_proto == IPPROTO_ICMP) {
 621                     ds_put_cstr(s, "icmp,");
 622                 } else if (f->nw_proto == IPPROTO_TCP) {
 623                     ds_put_cstr(s, "tcp,");
 624                 } else if (f->nw_proto == IPPROTO_UDP) {
 625                     ds_put_cstr(s, "udp,");
 626                 } else {
 627                     ds_put_cstr(s, "ip,");
 628                     skip_proto = false;
 629                 }
 630             } else {
 631                 ds_put_cstr(s, "ip,");
 632             }
 633         } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
 634             if (wc->nw_proto_mask) {
 635                 skip_proto = true;
 636                 if (f->nw_proto == IPPROTO_ICMPV6) {
 637                     ds_put_cstr(s, "icmp6,");
 638                 } else if (f->nw_proto == IPPROTO_TCP) {
 639                     ds_put_cstr(s, "tcp6,");
 640                 } else if (f->nw_proto == IPPROTO_UDP) {
 641                     ds_put_cstr(s, "udp6,");
 642                 } else {
 643                     ds_put_cstr(s, "ipv6,");
 644                     skip_proto = false;
 645                 }
 646             } else {
 647                 ds_put_cstr(s, "ipv6,");
 648             }
 649         } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
 650             ds_put_cstr(s, "arp,");
 651         } else {
 652             skip_type = false;
 653         }
 654     }
 655     for (i = 0; i < FLOW_N_REGS; i++) {
 656         switch (wc->reg_masks[i]) {
 657         case 0:
 658             break;
 659         case UINT32_MAX:
 660             ds_put_format(s, "reg%d=0x%"PRIx32",", i, f->regs[i]);
 661             break;
 662         default:
 663             ds_put_format(s, "reg%d=0x%"PRIx32"/0x%"PRIx32",",
 664                           i, f->regs[i], wc->reg_masks[i]);
 665             break;
 666         }
 667     }
 668     switch (wc->tun_id_mask) {
 669     case 0:
 670         break;
 671     case CONSTANT_HTONLL(UINT64_MAX):
 672         ds_put_format(s, "tun_id=%#"PRIx64",", ntohll(f->tun_id));
 673         break;
 674     default:
 675         ds_put_format(s, "tun_id=%#"PRIx64"/%#"PRIx64",",
 676                       ntohll(f->tun_id), ntohll(wc->tun_id_mask));
 677         break;
 678     }
 679     switch (wc->metadata_mask) {
 680     case 0:
 681         break;
 682     case CONSTANT_HTONLL(UINT64_MAX):
 683         ds_put_format(s, "metadata=%#"PRIx64",", ntohll(f->metadata));
 684         break;
 685     default:
 686         ds_put_format(s, "metadata=%#"PRIx64"/%#"PRIx64",",
 687                       ntohll(f->metadata), ntohll(wc->metadata_mask));
 688         break;
 689     }
 690     if (wc->in_port_mask) {
 691         ds_put_format(s, "in_port=%"PRIu16",", f->in_port);
 692     }
 693     if (wc->vlan_tci_mask) {
 694         ovs_be16 vid_mask = wc->vlan_tci_mask & htons(VLAN_VID_MASK);
 695         ovs_be16 pcp_mask = wc->vlan_tci_mask & htons(VLAN_PCP_MASK);
 696         ovs_be16 cfi = wc->vlan_tci_mask & htons(VLAN_CFI);
 697
 698         if (cfi && f->vlan_tci & htons(VLAN_CFI)
 699             && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
 700             && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
 701             && (vid_mask || pcp_mask)) {
 702             if (vid_mask) {
 703                 ds_put_format(s, "dl_vlan=%"PRIu16",",
 704                               vlan_tci_to_vid(f->vlan_tci));
 705             }
 706             if (pcp_mask) {
 707                 ds_put_format(s, "dl_vlan_pcp=%d,",
 708                               vlan_tci_to_pcp(f->vlan_tci));
 709             }
 710         } else if (wc->vlan_tci_mask == htons(0xffff)) {
 711             ds_put_format(s, "vlan_tci=0x%04"PRIx16",", ntohs(f->vlan_tci));
 712         } else {
 713             ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
 714                           ntohs(f->vlan_tci), ntohs(wc->vlan_tci_mask));
 715         }
 716     }
 717     format_eth_masked(s, "dl_src", f->dl_src, wc->dl_src_mask);
 718     format_eth_masked(s, "dl_dst", f->dl_dst, wc->dl_dst_mask);
 719     if (!skip_type && wc->dl_type_mask) {
 720         ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
 721     }
 722     if (f->dl_type == htons(ETH_TYPE_IPV6)) {
 723         format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->ipv6_src_mask);
 724         format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->ipv6_dst_mask);
 725         if (wc->ipv6_label_mask) {
 726             if (wc->ipv6_label_mask == htonl(UINT32_MAX)) {
 727                 ds_put_format(s, "ipv6_label=0x%05"PRIx32",",
 728                               ntohl(f->ipv6_label));
 729             } else {
 730                 ds_put_format(s, "ipv6_label=0x%05"PRIx32"/0x%05"PRIx32",",
 731                               ntohl(f->ipv6_label),
 732                               ntohl(wc->ipv6_label_mask));
 733             }
 734         }
 735     } else {
 736         format_ip_netmask(s, "nw_src", f->nw_src, wc->nw_src_mask);
 737         format_ip_netmask(s, "nw_dst", f->nw_dst, wc->nw_dst_mask);
 738     }
 739     if (!skip_proto && wc->nw_proto_mask) {
 740         if (f->dl_type == htons(ETH_TYPE_ARP)) {
 741             ds_put_format(s, "arp_op=%"PRIu8",", f->nw_proto);
 742         } else {
 743             ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
 744         }
 745     }
 746     if (f->dl_type == htons(ETH_TYPE_ARP)) {
 747         format_eth_masked(s, "arp_sha", f->arp_sha, wc->arp_sha_mask);
 748         format_eth_masked(s, "arp_tha", f->arp_tha, wc->arp_tha_mask);
 749     }
 750     if (wc->nw_tos_mask & IP_DSCP_MASK) {
 751         ds_put_format(s, "nw_tos=%"PRIu8",", f->nw_tos & IP_DSCP_MASK);
 752     }
 753     if (wc->nw_tos_mask & IP_ECN_MASK) {
 754         ds_put_format(s, "nw_ecn=%"PRIu8",", f->nw_tos & IP_ECN_MASK);
 755     }
 756     if (wc->nw_ttl_mask) {
 757         ds_put_format(s, "nw_ttl=%"PRIu8",", f->nw_ttl);
 758     }
 759     switch (wc->nw_frag_mask) {
 760     case FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER:
 761         ds_put_format(s, "nw_frag=%s,",
 762                       f->nw_frag & FLOW_NW_FRAG_ANY
 763                       ? (f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "first")
 764                       : (f->nw_frag & FLOW_NW_FRAG_LATER ? "<error>" : "no"));
 765         break;
 766
 767     case FLOW_NW_FRAG_ANY:
 768         ds_put_format(s, "nw_frag=%s,",
 769                       f->nw_frag & FLOW_NW_FRAG_ANY ? "yes" : "no");
 770         break;
 771
 772     case FLOW_NW_FRAG_LATER:
 773         ds_put_format(s, "nw_frag=%s,",
 774                       f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "not_later");
 775         break;
 776     }
 777     if (f->nw_proto == IPPROTO_ICMP) {
 778         format_be16_masked(s, "icmp_type", f->tp_src, wc->tp_src_mask);
 779         format_be16_masked(s, "icmp_code", f->tp_dst, wc->tp_dst_mask);
 780     } else if (f->nw_proto == IPPROTO_ICMPV6) {
 781         format_be16_masked(s, "icmp_type", f->tp_src, wc->tp_src_mask);
 782         format_be16_masked(s, "icmp_code", f->tp_dst, wc->tp_dst_mask);
 783         format_ipv6_netmask(s, "nd_target", &f->nd_target,
 784                             &wc->nd_target_mask);
 785         format_eth_masked(s, "nd_sll", f->arp_sha, wc->arp_sha_mask);
 786         format_eth_masked(s, "nd_tll", f->arp_tha, wc->arp_tha_mask);
 787    } else {
 788         format_be16_masked(s, "tp_src", f->tp_src, wc->tp_src_mask);
 789         format_be16_masked(s, "tp_dst", f->tp_dst, wc->tp_dst_mask);
 790     }
 791
 792     if (s->length > start_len && ds_last(s) == ',') {
 793         s->length--;
 794     }
 795 }
 796
 797 /* Converts 'rule' to a string and returns the string.  The caller must free
 798  * the string (with free()). */
 799 char *
 800 cls_rule_to_string(const struct cls_rule *rule)
 801 {
 802     struct ds s = DS_EMPTY_INITIALIZER;
 803     cls_rule_format(rule, &s);
 804     return ds_steal_cstr(&s);
 805 }
 806
 807 void
 808 cls_rule_print(const struct cls_rule *rule)
 809 {
 810     char *s = cls_rule_to_string(rule);
 811     puts(s);
 812     free(s);
 813 }
 814 \f
 815 /* Initializes 'cls' as a classifier that initially contains no classification
 816  * rules. */
 817 void
 818 classifier_init(struct classifier *cls)
 819 {
 820     cls->n_rules = 0;
 821     hmap_init(&cls->tables);
 822 }
 823
 824 /* Destroys 'cls'.  Rules within 'cls', if any, are not freed; this is the
 825  * caller's responsibility. */
 826 void
 827 classifier_destroy(struct classifier *cls)
 828 {
 829     if (cls) {
 830         struct cls_table *table, *next_table;
 831
 832         HMAP_FOR_EACH_SAFE (table, next_table, hmap_node, &cls->tables) {
 833             hmap_destroy(&table->rules);
 834             hmap_remove(&cls->tables, &table->hmap_node);
 835             free(table);
 836         }
 837         hmap_destroy(&cls->tables);
 838     }
 839 }
 840
 841 /* Returns true if 'cls' contains no classification rules, false otherwise. */
 842 bool
 843 classifier_is_empty(const struct classifier *cls)
 844 {
 845     return cls->n_rules == 0;
 846 }
 847
 848 /* Returns the number of rules in 'classifier'. */
 849 int
 850 classifier_count(const struct classifier *cls)
 851 {
 852     return cls->n_rules;
 853 }
 854
 855 /* Inserts 'rule' into 'cls'.  Until 'rule' is removed from 'cls', the caller
 856  * must not modify or free it.
 857  *
 858  * If 'cls' already contains an identical rule (including wildcards, values of
 859  * fixed fields, and priority), replaces the old rule by 'rule' and returns the
 860  * rule that was replaced.  The caller takes ownership of the returned rule and
 861  * is thus responsible for freeing it, etc., as necessary.
 862  *
 863  * Returns NULL if 'cls' does not contain a rule with an identical key, after
 864  * inserting the new rule.  In this case, no rules are displaced by the new
 865  * rule, even rules that cannot have any effect because the new rule matches a
 866  * superset of their flows and has higher priority. */
 867 struct cls_rule *
 868 classifier_replace(struct classifier *cls, struct cls_rule *rule)
 869 {
 870     struct cls_rule *old_rule;
 871     struct cls_table *table;
 872
 873     table = find_table(cls, &rule->wc);
 874     if (!table) {
 875         table = insert_table(cls, &rule->wc);
 876     }
 877
 878     old_rule = insert_rule(table, rule);
 879     if (!old_rule) {
 880         table->n_table_rules++;
 881         cls->n_rules++;
 882     }
 883     return old_rule;
 884 }
 885
 886 /* Inserts 'rule' into 'cls'.  Until 'rule' is removed from 'cls', the caller
 887  * must not modify or free it.
 888  *
 889  * 'cls' must not contain an identical rule (including wildcards, values of
 890  * fixed fields, and priority).  Use classifier_find_rule_exactly() to find
 891  * such a rule. */
 892 void
 893 classifier_insert(struct classifier *cls, struct cls_rule *rule)
 894 {
 895     struct cls_rule *displaced_rule = classifier_replace(cls, rule);
 896     assert(!displaced_rule);
 897 }
 898
 899 /* Removes 'rule' from 'cls'.  It is the caller's responsibility to free
 900  * 'rule', if this is desirable. */
 901 void
 902 classifier_remove(struct classifier *cls, struct cls_rule *rule)
 903 {
 904     struct cls_rule *head;
 905     struct cls_table *table;
 906
 907     table = find_table(cls, &rule->wc);
 908     head = find_equal(table, &rule->flow, rule->hmap_node.hash);
 909     if (head != rule) {
 910         list_remove(&rule->list);
 911     } else if (list_is_empty(&rule->list)) {
 912         hmap_remove(&table->rules, &rule->hmap_node);
 913     } else {
 914         struct cls_rule *next = CONTAINER_OF(rule->list.next,
 915                                              struct cls_rule, list);
 916
 917         list_remove(&rule->list);
 918         hmap_replace(&table->rules, &rule->hmap_node, &next->hmap_node);
 919     }
 920
 921     if (--table->n_table_rules == 0) {
 922         destroy_table(cls, table);
 923     }
 924
 925     cls->n_rules--;
 926 }
 927
 928 /* Finds and returns the highest-priority rule in 'cls' that matches 'flow'.
 929  * Returns a null pointer if no rules in 'cls' match 'flow'.  If multiple rules
 930  * of equal priority match 'flow', returns one arbitrarily. */
 931 struct cls_rule *
 932 classifier_lookup(const struct classifier *cls, const struct flow *flow)
 933 {
 934     struct cls_table *table;
 935     struct cls_rule *best;
 936
 937     best = NULL;
 938     HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
 939         struct cls_rule *rule = find_match(table, flow);
 940         if (rule && (!best || rule->priority > best->priority)) {
 941             best = rule;
 942         }
 943     }
 944     return best;
 945 }
 946
 947 /* Finds and returns a rule in 'cls' with exactly the same priority and
 948  * matching criteria as 'target'.  Returns a null pointer if 'cls' doesn't
 949  * contain an exact match. */
 950 struct cls_rule *
 951 classifier_find_rule_exactly(const struct classifier *cls,
 952                              const struct cls_rule *target)
 953 {
 954     struct cls_rule *head, *rule;
 955     struct cls_table *table;
 956
 957     table = find_table(cls, &target->wc);
 958     if (!table) {
 959         return NULL;
 960     }
 961
 962     head = find_equal(table, &target->flow, flow_hash(&target->flow, 0));
 963     FOR_EACH_RULE_IN_LIST (rule, head) {
 964         if (target->priority >= rule->priority) {
 965             return target->priority == rule->priority ? rule : NULL;
 966         }
 967     }
 968     return NULL;
 969 }
 970
 971 /* Checks if 'target' would overlap any other rule in 'cls'.  Two rules are
 972  * considered to overlap if both rules have the same priority and a packet
 973  * could match both. */
 974 bool
 975 classifier_rule_overlaps(const struct classifier *cls,
 976                          const struct cls_rule *target)
 977 {
 978     struct cls_table *table;
 979
 980     HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
 981         struct flow_wildcards wc;
 982         struct cls_rule *head;
 983
 984         flow_wildcards_combine(&wc, &target->wc, &table->wc);
 985         HMAP_FOR_EACH (head, hmap_node, &table->rules) {
 986             struct cls_rule *rule;
 987
 988             FOR_EACH_RULE_IN_LIST (rule, head) {
 989                 if (rule->priority == target->priority
 990                     && flow_equal_except(&target->flow, &rule->flow, &wc)) {
 991                     return true;
 992                 }
 993             }
 994         }
 995     }
 996
 997     return false;
 998 }
 999
1000 /* Returns true if 'rule' exactly matches 'criteria' or if 'rule' is more
1001  * specific than 'criteria'.  That is, 'rule' matches 'criteria' and this
1002  * function returns true if, for every field:
1003  *
1004  *   - 'criteria' and 'rule' specify the same (non-wildcarded) value for the
1005  *     field, or
1006  *
1007  *   - 'criteria' wildcards the field,
1008  *
1009  * Conversely, 'rule' does not match 'criteria' and this function returns false
1010  * if, for at least one field:
1011  *
1012  *   - 'criteria' and 'rule' specify different values for the field, or
1013  *
1014  *   - 'criteria' specifies a value for the field but 'rule' wildcards it.
1015  *
1016  * Equivalently, the truth table for whether a field matches is:
1017  *
1018  *                                     rule
1019  *
1020  *                   c         wildcard    exact
1021  *                   r        +---------+---------+
1022  *                   i   wild |   yes   |   yes   |
1023  *                   t   card |         |         |
1024  *                   e        +---------+---------+
1025  *                   r  exact |    no   |if values|
1026  *                   i        |         |are equal|
1027  *                   a        +---------+---------+
1028  *
1029  * This is the matching rule used by OpenFlow 1.0 non-strict OFPT_FLOW_MOD
1030  * commands and by OpenFlow 1.0 aggregate and flow stats.
1031  *
1032  * Ignores rule->priority and criteria->priority. */
1033 bool
1034 cls_rule_is_loose_match(const struct cls_rule *rule,
1035                         const struct cls_rule *criteria)
1036 {
1037     return (!flow_wildcards_has_extra(&rule->wc, &criteria->wc)
1038             && flow_equal_except(&rule->flow, &criteria->flow, &criteria->wc));
1039 }
1040 \f
1041 /* Iteration. */
1042
1043 static bool
1044 rule_matches(const struct cls_rule *rule, const struct cls_rule *target)
1045 {
1046     return (!target
1047             || flow_equal_except(&rule->flow, &target->flow, &target->wc));
1048 }
1049
1050 static struct cls_rule *
1051 search_table(const struct cls_table *table, const struct cls_rule *target)
1052 {
1053     if (!target || !flow_wildcards_has_extra(&table->wc, &target->wc)) {
1054         struct cls_rule *rule;
1055
1056         HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
1057             if (rule_matches(rule, target)) {
1058                 return rule;
1059             }
1060         }
1061     }
1062     return NULL;
1063 }
1064
1065 /* Initializes 'cursor' for iterating through rules in 'cls':
1066  *
1067  *     - If 'target' is null, the cursor will visit every rule in 'cls'.
1068  *
1069  *     - If 'target' is nonnull, the cursor will visit each 'rule' in 'cls'
1070  *       such that cls_rule_is_loose_match(rule, target) returns true.
1071  *
1072  * Ignores target->priority. */
1073 void
1074 cls_cursor_init(struct cls_cursor *cursor, const struct classifier *cls,
1075                 const struct cls_rule *target)
1076 {
1077     cursor->cls = cls;
1078     cursor->target = target;
1079 }
1080
1081 /* Returns the first matching cls_rule in 'cursor''s iteration, or a null
1082  * pointer if there are no matches. */
1083 struct cls_rule *
1084 cls_cursor_first(struct cls_cursor *cursor)
1085 {
1086     struct cls_table *table;
1087
1088     HMAP_FOR_EACH (table, hmap_node, &cursor->cls->tables) {
1089         struct cls_rule *rule = search_table(table, cursor->target);
1090         if (rule) {
1091             cursor->table = table;
1092             return rule;
1093         }
1094     }
1095
1096     return NULL;
1097 }
1098
1099 /* Returns the next matching cls_rule in 'cursor''s iteration, or a null
1100  * pointer if there are no more matches. */
1101 struct cls_rule *
1102 cls_cursor_next(struct cls_cursor *cursor, struct cls_rule *rule)
1103 {
1104     const struct cls_table *table;
1105     struct cls_rule *next;
1106
1107     next = next_rule_in_list__(rule);
1108     if (next->priority < rule->priority) {
1109         return next;
1110     }
1111
1112     /* 'next' is the head of the list, that is, the rule that is included in
1113      * the table's hmap.  (This is important when the classifier contains rules
1114      * that differ only in priority.) */
1115     rule = next;
1116     HMAP_FOR_EACH_CONTINUE (rule, hmap_node, &cursor->table->rules) {
1117         if (rule_matches(rule, cursor->target)) {
1118             return rule;
1119         }
1120     }
1121
1122     table = cursor->table;
1123     HMAP_FOR_EACH_CONTINUE (table, hmap_node, &cursor->cls->tables) {
1124         rule = search_table(table, cursor->target);
1125         if (rule) {
1126             cursor->table = table;
1127             return rule;
1128         }
1129     }
1130
1131     return NULL;
1132 }
1133 \f
1134 static struct cls_table *
1135 find_table(const struct classifier *cls, const struct flow_wildcards *wc)
1136 {
1137     struct cls_table *table;
1138
1139     HMAP_FOR_EACH_IN_BUCKET (table, hmap_node, flow_wildcards_hash(wc, 0),
1140                              &cls->tables) {
1141         if (flow_wildcards_equal(wc, &table->wc)) {
1142             return table;
1143         }
1144     }
1145     return NULL;
1146 }
1147
1148 static struct cls_table *
1149 insert_table(struct classifier *cls, const struct flow_wildcards *wc)
1150 {
1151     struct cls_table *table;
1152
1153     table = xzalloc(sizeof *table);
1154     hmap_init(&table->rules);
1155     table->wc = *wc;
1156     table->is_catchall = flow_wildcards_is_catchall(&table->wc);
1157     hmap_insert(&cls->tables, &table->hmap_node, flow_wildcards_hash(wc, 0));
1158
1159     return table;
1160 }
1161
1162 static void
1163 destroy_table(struct classifier *cls, struct cls_table *table)
1164 {
1165     hmap_remove(&cls->tables, &table->hmap_node);
1166     hmap_destroy(&table->rules);
1167     free(table);
1168 }
1169
1170 static struct cls_rule *
1171 find_match(const struct cls_table *table, const struct flow *flow)
1172 {
1173     struct cls_rule *rule;
1174
1175     if (table->is_catchall) {
1176         HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
1177             return rule;
1178         }
1179     } else {
1180         struct flow f;
1181
1182         f = *flow;
1183         flow_zero_wildcards(&f, &table->wc);
1184         HMAP_FOR_EACH_WITH_HASH (rule, hmap_node, flow_hash(&f, 0),
1185                                  &table->rules) {
1186             if (flow_equal(&f, &rule->flow)) {
1187                 return rule;
1188             }
1189         }
1190     }
1191
1192     return NULL;
1193 }
1194
1195 static struct cls_rule *
1196 find_equal(struct cls_table *table, const struct flow *flow, uint32_t hash)
1197 {
1198     struct cls_rule *head;
1199
1200     HMAP_FOR_EACH_WITH_HASH (head, hmap_node, hash, &table->rules) {
1201         if (flow_equal(&head->flow, flow)) {
1202             return head;
1203         }
1204     }
1205     return NULL;
1206 }
1207
1208 static struct cls_rule *
1209 insert_rule(struct cls_table *table, struct cls_rule *new)
1210 {
1211     struct cls_rule *head;
1212
1213     new->hmap_node.hash = flow_hash(&new->flow, 0);
1214
1215     head = find_equal(table, &new->flow, new->hmap_node.hash);
1216     if (!head) {
1217         hmap_insert(&table->rules, &new->hmap_node, new->hmap_node.hash);
1218         list_init(&new->list);
1219         return NULL;
1220     } else {
1221         /* Scan the list for the insertion point that will keep the list in
1222          * order of decreasing priority. */
1223         struct cls_rule *rule;
1224         FOR_EACH_RULE_IN_LIST (rule, head) {
1225             if (new->priority >= rule->priority) {
1226                 if (rule == head) {
1227                     /* 'new' is the new highest-priority flow in the list. */
1228                     hmap_replace(&table->rules,
1229                                  &rule->hmap_node, &new->hmap_node);
1230                 }
1231
1232                 if (new->priority == rule->priority) {
1233                     list_replace(&new->list, &rule->list);
1234                     return rule;
1235                 } else {
1236                     list_insert(&rule->list, &new->list);
1237                     return NULL;
1238                 }
1239             }
1240         }
1241
1242         /* Insert 'new' at the end of the list. */
1243         list_push_back(&head->list, &new->list);
1244         return NULL;
1245     }
1246 }
1247
1248 static struct cls_rule *
1249 next_rule_in_list__(struct cls_rule *rule)
1250 {
1251     struct cls_rule *next = OBJECT_CONTAINING(rule->list.next, next, list);
1252     return next;
1253 }
1254
1255 static struct cls_rule *
1256 next_rule_in_list(struct cls_rule *rule)
1257 {
1258     struct cls_rule *next = next_rule_in_list__(rule);
1259     return next->priority < rule->priority ? next : NULL;
1260 }
1261
1262 static bool
1263 ipv6_equal_except(const struct in6_addr *a, const struct in6_addr *b,
1264                   const struct in6_addr *mask)
1265 {
1266     int i;
1267
1268 #ifdef s6_addr32
1269     for (i=0; i<4; i++) {
1270         if ((a->s6_addr32[i] ^ b->s6_addr32[i]) & mask->s6_addr32[i]) {
1271             return false;
1272         }
1273     }
1274 #else
1275     for (i=0; i<16; i++) {
1276         if ((a->s6_addr[i] ^ b->s6_addr[i]) & mask->s6_addr[i]) {
1277             return false;
1278         }
1279     }
1280 #endif
1281
1282     return true;
1283 }
1284
1285
1286 static bool
1287 flow_equal_except(const struct flow *a, const struct flow *b,
1288                   const struct flow_wildcards *wildcards)
1289 {
1290     int i;
1291
1292     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 17);
1293
1294     for (i = 0; i < FLOW_N_REGS; i++) {
1295         if ((a->regs[i] ^ b->regs[i]) & wildcards->reg_masks[i]) {
1296             return false;
1297         }
1298     }
1299
1300     return (!((a->tun_id ^ b->tun_id) & wildcards->tun_id_mask)
1301             && !((a->metadata ^ b->metadata) & wildcards->metadata_mask)
1302             && !((a->nw_src ^ b->nw_src) & wildcards->nw_src_mask)
1303             && !((a->nw_dst ^ b->nw_dst) & wildcards->nw_dst_mask)
1304             && !((a->in_port ^ b->in_port) & wildcards->in_port_mask)
1305             && !((a->vlan_tci ^ b->vlan_tci) & wildcards->vlan_tci_mask)
1306             && !((a->dl_type ^ b->dl_type) & wildcards->dl_type_mask)
1307             && !((a->tp_src ^ b->tp_src) & wildcards->tp_src_mask)
1308             && !((a->tp_dst ^ b->tp_dst) & wildcards->tp_dst_mask)
1309             && eth_addr_equal_except(a->dl_src, b->dl_src,
1310                                      wildcards->dl_src_mask)
1311             && eth_addr_equal_except(a->dl_dst, b->dl_dst,
1312                                      wildcards->dl_dst_mask)
1313             && !((a->nw_proto ^ b->nw_proto) & wildcards->nw_proto_mask)
1314             && !((a->nw_ttl ^ b->nw_ttl) & wildcards->nw_ttl_mask)
1315             && !((a->nw_tos ^ b->nw_tos) & wildcards->nw_tos_mask)
1316             && !((a->nw_frag ^ b->nw_frag) & wildcards->nw_frag_mask)
1317             && eth_addr_equal_except(a->arp_sha, b->arp_sha,
1318                                      wildcards->arp_sha_mask)
1319             && eth_addr_equal_except(a->arp_tha, b->arp_tha,
1320                                      wildcards->arp_tha_mask)
1321             && !((a->ipv6_label ^ b->ipv6_label) & wildcards->ipv6_label_mask)
1322             && ipv6_equal_except(&a->ipv6_src, &b->ipv6_src,
1323                     &wildcards->ipv6_src_mask)
1324             && ipv6_equal_except(&a->ipv6_dst, &b->ipv6_dst,
1325                     &wildcards->ipv6_dst_mask)
1326             && ipv6_equal_except(&a->nd_target, &b->nd_target,
1327                                  &wildcards->nd_target_mask));
1328 }