lib/classifier.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
   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 struct cls_table *classifier_first_table(const struct classifier *);
  36 static struct cls_table *classifier_next_table(const struct classifier *,
  37                                                const struct cls_table *);
  38 static void destroy_table(struct classifier *, struct cls_table *);
  39
  40 static struct cls_rule *find_match(const struct cls_table *,
  41                                    const struct flow *);
  42 static struct cls_rule *find_equal(struct cls_table *, const struct flow *,
  43                                    uint32_t hash);
  44 static struct cls_rule *insert_rule(struct cls_table *, struct cls_rule *);
  45
  46 static bool flow_equal_except(const struct flow *, const struct flow *,
  47                                 const struct flow_wildcards *);
  48 static void zero_wildcards(struct flow *, const struct flow_wildcards *);
  49
  50 /* Iterates RULE over HEAD and all of the cls_rules on HEAD->list. */
  51 #define FOR_EACH_RULE_IN_LIST(RULE, HEAD)                               \
  52     for ((RULE) = (HEAD); (RULE) != NULL; (RULE) = next_rule_in_list(RULE))
  53 #define FOR_EACH_RULE_IN_LIST_SAFE(RULE, NEXT, HEAD)                    \
  54     for ((RULE) = (HEAD);                                               \
  55          (RULE) != NULL && ((NEXT) = next_rule_in_list(RULE), true);    \
  56          (RULE) = (NEXT))
  57
  58 static struct cls_rule *next_rule_in_list__(struct cls_rule *);
  59 static struct cls_rule *next_rule_in_list(struct cls_rule *);
  60
  61 static struct cls_table *
  62 cls_table_from_hmap_node(const struct hmap_node *node)
  63 {
  64     return node ? CONTAINER_OF(node, struct cls_table, hmap_node) : NULL;
  65 }
  66
  67 /* Converts the flow in 'flow' into a cls_rule in 'rule', with the given
  68  * 'wildcards' and 'priority'. */
  69 void
  70 cls_rule_init(const struct flow *flow, const struct flow_wildcards *wildcards,
  71               unsigned int priority, struct cls_rule *rule)
  72 {
  73     rule->flow = *flow;
  74     rule->wc = *wildcards;
  75     rule->priority = priority;
  76     cls_rule_zero_wildcarded_fields(rule);
  77 }
  78
  79 /* Converts the flow in 'flow' into an exact-match cls_rule in 'rule', with the
  80  * given 'priority'.  (For OpenFlow 1.0, exact-match rule are always highest
  81  * priority, so 'priority' should be at least 65535.) */
  82 void
  83 cls_rule_init_exact(const struct flow *flow,
  84                     unsigned int priority, struct cls_rule *rule)
  85 {
  86     rule->flow = *flow;
  87     flow_wildcards_init_exact(&rule->wc);
  88     rule->priority = priority;
  89 }
  90
  91 /* Initializes 'rule' as a "catch-all" rule that matches every packet, with
  92  * priority 'priority'. */
  93 void
  94 cls_rule_init_catchall(struct cls_rule *rule, unsigned int priority)
  95 {
  96     memset(&rule->flow, 0, sizeof rule->flow);
  97     flow_wildcards_init_catchall(&rule->wc);
  98     rule->priority = priority;
  99 }
 100
 101 /* For each bit or field wildcarded in 'rule', sets the corresponding bit or
 102  * field in 'flow' to all-0-bits.  It is important to maintain this invariant
 103  * in a clr_rule that might be inserted into a classifier.
 104  *
 105  * It is never necessary to call this function directly for a cls_rule that is
 106  * initialized or modified only by cls_rule_*() functions.  It is useful to
 107  * restore the invariant in a cls_rule whose 'wc' member is modified by hand.
 108  */
 109 void
 110 cls_rule_zero_wildcarded_fields(struct cls_rule *rule)
 111 {
 112     zero_wildcards(&rule->flow, &rule->wc);
 113 }
 114
 115 void
 116 cls_rule_set_reg(struct cls_rule *rule, unsigned int reg_idx, uint32_t value)
 117 {
 118     cls_rule_set_reg_masked(rule, reg_idx, value, UINT32_MAX);
 119 }
 120
 121 void
 122 cls_rule_set_reg_masked(struct cls_rule *rule, unsigned int reg_idx,
 123                         uint32_t value, uint32_t mask)
 124 {
 125     assert(reg_idx < FLOW_N_REGS);
 126     flow_wildcards_set_reg_mask(&rule->wc, reg_idx, mask);
 127     rule->flow.regs[reg_idx] = value & mask;
 128 }
 129
 130 void
 131 cls_rule_set_tun_id(struct cls_rule *rule, ovs_be64 tun_id)
 132 {
 133     cls_rule_set_tun_id_masked(rule, tun_id, htonll(UINT64_MAX));
 134 }
 135
 136 void
 137 cls_rule_set_tun_id_masked(struct cls_rule *rule,
 138                            ovs_be64 tun_id, ovs_be64 mask)
 139 {
 140     rule->wc.tun_id_mask = mask;
 141     rule->flow.tun_id = tun_id & mask;
 142 }
 143
 144 void
 145 cls_rule_set_in_port(struct cls_rule *rule, uint16_t odp_port)
 146 {
 147     rule->wc.wildcards &= ~FWW_IN_PORT;
 148     rule->flow.in_port = odp_port;
 149 }
 150
 151 void
 152 cls_rule_set_dl_type(struct cls_rule *rule, ovs_be16 dl_type)
 153 {
 154     rule->wc.wildcards &= ~FWW_DL_TYPE;
 155     rule->flow.dl_type = dl_type;
 156 }
 157
 158 void
 159 cls_rule_set_dl_src(struct cls_rule *rule, const uint8_t dl_src[ETH_ADDR_LEN])
 160 {
 161     rule->wc.wildcards &= ~FWW_DL_SRC;
 162     memcpy(rule->flow.dl_src, dl_src, ETH_ADDR_LEN);
 163 }
 164
 165 void
 166 cls_rule_set_dl_dst(struct cls_rule *rule, const uint8_t dl_dst[ETH_ADDR_LEN])
 167 {
 168     rule->wc.wildcards &= ~(FWW_DL_DST | FWW_ETH_MCAST);
 169     memcpy(rule->flow.dl_dst, dl_dst, ETH_ADDR_LEN);
 170 }
 171
 172 void
 173 cls_rule_set_dl_tci(struct cls_rule *rule, ovs_be16 tci)
 174 {
 175     cls_rule_set_dl_tci_masked(rule, tci, htons(0xffff));
 176 }
 177
 178 void
 179 cls_rule_set_dl_tci_masked(struct cls_rule *rule, ovs_be16 tci, ovs_be16 mask)
 180 {
 181     rule->flow.vlan_tci = tci & mask;
 182     rule->wc.vlan_tci_mask = mask;
 183 }
 184
 185 /* Modifies 'rule' so that the VLAN VID is wildcarded.  If the PCP is already
 186  * wildcarded, then 'rule' will match a packet regardless of whether it has an
 187  * 802.1Q header or not. */
 188 void
 189 cls_rule_set_any_vid(struct cls_rule *rule)
 190 {
 191     if (rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK)) {
 192         rule->wc.vlan_tci_mask &= ~htons(VLAN_VID_MASK);
 193         rule->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
 194     } else {
 195         cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
 196     }
 197 }
 198
 199 /* Modifies 'rule' depending on 'dl_vlan':
 200  *
 201  *   - If 'dl_vlan' is htons(OFP_VLAN_NONE), makes 'rule' match only packets
 202  *     without an 802.1Q header.
 203  *
 204  *   - Otherwise, makes 'rule' match only packets with an 802.1Q header whose
 205  *     VID equals the low 12 bits of 'dl_vlan'.
 206  */
 207 void
 208 cls_rule_set_dl_vlan(struct cls_rule *rule, ovs_be16 dl_vlan)
 209 {
 210     if (dl_vlan == htons(OFP_VLAN_NONE)) {
 211         cls_rule_set_dl_tci(rule, htons(0));
 212     } else {
 213         dl_vlan &= htons(VLAN_VID_MASK);
 214         rule->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
 215         rule->flow.vlan_tci |= htons(VLAN_CFI) | dl_vlan;
 216         rule->wc.vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
 217     }
 218 }
 219
 220 /* Modifies 'rule' so that the VLAN PCP is wildcarded.  If the VID is already
 221  * wildcarded, then 'rule' will match a packet regardless of whether it has an
 222  * 802.1Q header or not. */
 223 void
 224 cls_rule_set_any_pcp(struct cls_rule *rule)
 225 {
 226     if (rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK)) {
 227         rule->wc.vlan_tci_mask &= ~htons(VLAN_PCP_MASK);
 228         rule->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
 229     } else {
 230         cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
 231     }
 232 }
 233
 234 /* Modifies 'rule' so that it matches only packets with an 802.1Q header whose
 235  * PCP equals the low 3 bits of 'dl_vlan_pcp'. */
 236 void
 237 cls_rule_set_dl_vlan_pcp(struct cls_rule *rule, uint8_t dl_vlan_pcp)
 238 {
 239     dl_vlan_pcp &= 0x07;
 240     rule->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
 241     rule->flow.vlan_tci |= htons((dl_vlan_pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
 242     rule->wc.vlan_tci_mask |= htons(VLAN_CFI | VLAN_PCP_MASK);
 243 }
 244
 245 void
 246 cls_rule_set_tp_src(struct cls_rule *rule, ovs_be16 tp_src)
 247 {
 248     rule->wc.wildcards &= ~FWW_TP_SRC;
 249     rule->flow.tp_src = tp_src;
 250 }
 251
 252 void
 253 cls_rule_set_tp_dst(struct cls_rule *rule, ovs_be16 tp_dst)
 254 {
 255     rule->wc.wildcards &= ~FWW_TP_DST;
 256     rule->flow.tp_dst = tp_dst;
 257 }
 258
 259 void
 260 cls_rule_set_nw_proto(struct cls_rule *rule, uint8_t nw_proto)
 261 {
 262     rule->wc.wildcards &= ~FWW_NW_PROTO;
 263     rule->flow.nw_proto = nw_proto;
 264 }
 265
 266 void
 267 cls_rule_set_nw_src(struct cls_rule *rule, ovs_be32 nw_src)
 268 {
 269     cls_rule_set_nw_src_masked(rule, nw_src, htonl(UINT32_MAX));
 270 }
 271
 272 bool
 273 cls_rule_set_nw_src_masked(struct cls_rule *rule, ovs_be32 ip, ovs_be32 mask)
 274 {
 275     if (flow_wildcards_set_nw_src_mask(&rule->wc, mask)) {
 276         rule->flow.nw_src = ip & mask;
 277         return true;
 278     } else {
 279         return false;
 280     }
 281 }
 282
 283 void
 284 cls_rule_set_nw_dst(struct cls_rule *rule, ovs_be32 nw_dst)
 285 {
 286     cls_rule_set_nw_dst_masked(rule, nw_dst, htonl(UINT32_MAX));
 287 }
 288
 289 bool
 290 cls_rule_set_nw_dst_masked(struct cls_rule *rule, ovs_be32 ip, ovs_be32 mask)
 291 {
 292     if (flow_wildcards_set_nw_dst_mask(&rule->wc, mask)) {
 293         rule->flow.nw_dst = ip & mask;
 294         return true;
 295     } else {
 296         return false;
 297     }
 298 }
 299
 300 void
 301 cls_rule_set_nw_tos(struct cls_rule *rule, uint8_t nw_tos)
 302 {
 303     rule->wc.wildcards &= ~FWW_NW_TOS;
 304     rule->flow.nw_tos = nw_tos & IP_DSCP_MASK;
 305 }
 306
 307 void
 308 cls_rule_set_icmp_type(struct cls_rule *rule, uint8_t icmp_type)
 309 {
 310     rule->wc.wildcards &= ~FWW_TP_SRC;
 311     rule->flow.icmp_type = htons(icmp_type);
 312
 313 }
 314
 315 void
 316 cls_rule_set_icmp_code(struct cls_rule *rule, uint8_t icmp_code)
 317 {
 318     rule->wc.wildcards &= ~FWW_TP_DST;
 319     rule->flow.icmp_code = htons(icmp_code);
 320 }
 321
 322 /* Returns true if 'a' and 'b' have the same priority, wildcard the same
 323  * fields, and have the same values for fixed fields, otherwise false. */
 324 bool
 325 cls_rule_equal(const struct cls_rule *a, const struct cls_rule *b)
 326 {
 327     return (a->priority == b->priority
 328             && flow_wildcards_equal(&a->wc, &b->wc)
 329             && flow_equal(&a->flow, &b->flow));
 330 }
 331
 332 static void
 333 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
 334                   ovs_be32 netmask)
 335 {
 336     if (netmask) {
 337         ds_put_format(s, "%s="IP_FMT, name, IP_ARGS(&ip));
 338         if (netmask != htonl(UINT32_MAX)) {
 339             if (ip_is_cidr(netmask)) {
 340                 int wcbits = ofputil_netmask_to_wcbits(netmask);
 341                 ds_put_format(s, "/%d", 32 - wcbits);
 342             } else {
 343                 ds_put_format(s, "/"IP_FMT, IP_ARGS(&netmask));
 344             }
 345         }
 346         ds_put_char(s, ',');
 347     }
 348 }
 349
 350 void
 351 cls_rule_format(const struct cls_rule *rule, struct ds *s)
 352 {
 353     const struct flow_wildcards *wc = &rule->wc;
 354     size_t start_len = s->length;
 355     flow_wildcards_t w = wc->wildcards;
 356     const struct flow *f = &rule->flow;
 357     bool skip_type = false;
 358     bool skip_proto = false;
 359
 360     int i;
 361
 362     if (rule->priority != OFP_DEFAULT_PRIORITY) {
 363         ds_put_format(s, "priority=%d,", rule->priority);
 364     }
 365
 366     if (!(w & FWW_DL_TYPE)) {
 367         skip_type = true;
 368         if (f->dl_type == htons(ETH_TYPE_IP)) {
 369             if (!(w & FWW_NW_PROTO)) {
 370                 skip_proto = true;
 371                 if (f->nw_proto == IP_TYPE_ICMP) {
 372                     ds_put_cstr(s, "icmp,");
 373                 } else if (f->nw_proto == IP_TYPE_TCP) {
 374                     ds_put_cstr(s, "tcp,");
 375                 } else if (f->nw_proto == IP_TYPE_UDP) {
 376                     ds_put_cstr(s, "udp,");
 377                 } else {
 378                     ds_put_cstr(s, "ip,");
 379                     skip_proto = false;
 380                 }
 381             } else {
 382                 ds_put_cstr(s, "ip,");
 383             }
 384         } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
 385             ds_put_cstr(s, "arp,");
 386         } else {
 387             skip_type = false;
 388         }
 389     }
 390     for (i = 0; i < FLOW_N_REGS; i++) {
 391         switch (wc->reg_masks[i]) {
 392         case 0:
 393             break;
 394         case UINT32_MAX:
 395             ds_put_format(s, "reg%d=0x%"PRIx32",", i, f->regs[i]);
 396             break;
 397         default:
 398             ds_put_format(s, "reg%d=0x%"PRIx32"/0x%"PRIx32",",
 399                           i, f->regs[i], wc->reg_masks[i]);
 400             break;
 401         }
 402     }
 403     switch (wc->tun_id_mask) {
 404     case 0:
 405         break;
 406     case CONSTANT_HTONLL(UINT64_MAX):
 407         ds_put_format(s, "tun_id=%#"PRIx64",", ntohll(f->tun_id));
 408         break;
 409     default:
 410         ds_put_format(s, "tun_id=%#"PRIx64"/%#"PRIx64",",
 411                       ntohll(f->tun_id), ntohll(wc->tun_id_mask));
 412         break;
 413     }
 414     if (!(w & FWW_IN_PORT)) {
 415         ds_put_format(s, "in_port=%"PRIu16",",
 416                       odp_port_to_ofp_port(f->in_port));
 417     }
 418     if (wc->vlan_tci_mask) {
 419         ovs_be16 vid_mask = wc->vlan_tci_mask & htons(VLAN_VID_MASK);
 420         ovs_be16 pcp_mask = wc->vlan_tci_mask & htons(VLAN_PCP_MASK);
 421         ovs_be16 cfi = wc->vlan_tci_mask & htons(VLAN_CFI);
 422
 423         if (cfi && f->vlan_tci & htons(VLAN_CFI)
 424             && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
 425             && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
 426             && (vid_mask || pcp_mask)) {
 427             if (vid_mask) {
 428                 ds_put_format(s, "dl_vlan=%"PRIu16",",
 429                               vlan_tci_to_vid(f->vlan_tci));
 430             }
 431             if (pcp_mask) {
 432                 ds_put_format(s, "dl_vlan_pcp=%d,",
 433                               vlan_tci_to_pcp(f->vlan_tci));
 434             }
 435         } else {
 436             ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
 437                           ntohs(f->vlan_tci), ntohs(wc->vlan_tci_mask));
 438         }
 439     }
 440     if (!(w & FWW_DL_SRC)) {
 441         ds_put_format(s, "dl_src="ETH_ADDR_FMT",", ETH_ADDR_ARGS(f->dl_src));
 442     }
 443     switch (w & (FWW_DL_DST | FWW_ETH_MCAST)) {
 444     case 0:
 445         ds_put_format(s, "dl_dst="ETH_ADDR_FMT",", ETH_ADDR_ARGS(f->dl_dst));
 446         break;
 447     case FWW_DL_DST:
 448         ds_put_format(s, "dl_dst="ETH_ADDR_FMT"/01:00:00:00:00:00,",
 449                       ETH_ADDR_ARGS(f->dl_dst));
 450         break;
 451     case FWW_ETH_MCAST:
 452         ds_put_format(s, "dl_dst="ETH_ADDR_FMT"/fe:ff:ff:ff:ff:ff,",
 453                       ETH_ADDR_ARGS(f->dl_dst));
 454         break;
 455     case FWW_DL_DST | FWW_ETH_MCAST:
 456         break;
 457     }
 458     if (!skip_type && !(w & FWW_DL_TYPE)) {
 459         ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
 460     }
 461     format_ip_netmask(s, "nw_src", f->nw_src, wc->nw_src_mask);
 462     format_ip_netmask(s, "nw_dst", f->nw_dst, wc->nw_dst_mask);
 463     if (!skip_proto && !(w & FWW_NW_PROTO)) {
 464         if (f->dl_type == htons(ETH_TYPE_ARP)) {
 465             ds_put_format(s, "opcode=%"PRIu8",", f->nw_proto);
 466         } else {
 467             ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
 468         }
 469     }
 470     if (!(w & FWW_NW_TOS)) {
 471         ds_put_format(s, "nw_tos=%"PRIu8",", f->nw_tos);
 472     }
 473     if (f->nw_proto == IP_TYPE_ICMP) {
 474         if (!(w & FWW_TP_SRC)) {
 475             ds_put_format(s, "icmp_type=%"PRIu16",", ntohs(f->tp_src));
 476         }
 477         if (!(w & FWW_TP_DST)) {
 478             ds_put_format(s, "icmp_code=%"PRIu16",", ntohs(f->tp_dst));
 479         }
 480     } else {
 481         if (!(w & FWW_TP_SRC)) {
 482             ds_put_format(s, "tp_src=%"PRIu16",", ntohs(f->tp_src));
 483         }
 484         if (!(w & FWW_TP_DST)) {
 485             ds_put_format(s, "tp_dst=%"PRIu16",", ntohs(f->tp_dst));
 486         }
 487     }
 488
 489     if (s->length > start_len && ds_last(s) == ',') {
 490         s->length--;
 491     }
 492 }
 493
 494 /* Converts 'rule' to a string and returns the string.  The caller must free
 495  * the string (with free()). */
 496 char *
 497 cls_rule_to_string(const struct cls_rule *rule)
 498 {
 499     struct ds s = DS_EMPTY_INITIALIZER;
 500     cls_rule_format(rule, &s);
 501     return ds_steal_cstr(&s);
 502 }
 503
 504 void
 505 cls_rule_print(const struct cls_rule *rule)
 506 {
 507     char *s = cls_rule_to_string(rule);
 508     puts(s);
 509     free(s);
 510 }
 511 \f
 512 /* Initializes 'cls' as a classifier that initially contains no classification
 513  * rules. */
 514 void
 515 classifier_init(struct classifier *cls)
 516 {
 517     cls->n_rules = 0;
 518     hmap_init(&cls->tables);
 519 }
 520
 521 /* Destroys 'cls'.  Rules within 'cls', if any, are not freed; this is the
 522  * caller's responsibility. */
 523 void
 524 classifier_destroy(struct classifier *cls)
 525 {
 526     if (cls) {
 527         struct cls_table *table, *next_table;
 528
 529         HMAP_FOR_EACH_SAFE (table, next_table, hmap_node, &cls->tables) {
 530             hmap_destroy(&table->rules);
 531             hmap_remove(&cls->tables, &table->hmap_node);
 532             free(table);
 533         }
 534         hmap_destroy(&cls->tables);
 535     }
 536 }
 537
 538 /* Returns true if 'cls' contains no classification rules, false otherwise. */
 539 bool
 540 classifier_is_empty(const struct classifier *cls)
 541 {
 542     return cls->n_rules == 0;
 543 }
 544
 545 /* Returns the number of rules in 'classifier'. */
 546 int
 547 classifier_count(const struct classifier *cls)
 548 {
 549     return cls->n_rules;
 550 }
 551
 552 /* Inserts 'rule' into 'cls'.  Until 'rule' is removed from 'cls', the caller
 553  * must not modify or free it.
 554  *
 555  * If 'cls' already contains an identical rule (including wildcards, values of
 556  * fixed fields, and priority), replaces the old rule by 'rule' and returns the
 557  * rule that was replaced.  The caller takes ownership of the returned rule and
 558  * is thus responsible for freeing it, etc., as necessary.
 559  *
 560  * Returns NULL if 'cls' does not contain a rule with an identical key, after
 561  * inserting the new rule.  In this case, no rules are displaced by the new
 562  * rule, even rules that cannot have any effect because the new rule matches a
 563  * superset of their flows and has higher priority. */
 564 struct cls_rule *
 565 classifier_insert(struct classifier *cls, struct cls_rule *rule)
 566 {
 567     struct cls_rule *old_rule;
 568     struct cls_table *table;
 569
 570     table = find_table(cls, &rule->wc);
 571     if (!table) {
 572         table = insert_table(cls, &rule->wc);
 573     }
 574
 575     old_rule = insert_rule(table, rule);
 576     if (!old_rule) {
 577         table->n_table_rules++;
 578         cls->n_rules++;
 579     }
 580     return old_rule;
 581 }
 582
 583 /* Removes 'rule' from 'cls'.  It is the caller's responsibility to free
 584  * 'rule', if this is desirable. */
 585 void
 586 classifier_remove(struct classifier *cls, struct cls_rule *rule)
 587 {
 588     struct cls_rule *head;
 589     struct cls_table *table;
 590
 591     table = find_table(cls, &rule->wc);
 592     head = find_equal(table, &rule->flow, rule->hmap_node.hash);
 593     if (head != rule) {
 594         list_remove(&rule->list);
 595     } else if (list_is_empty(&rule->list)) {
 596         hmap_remove(&table->rules, &rule->hmap_node);
 597     } else {
 598         struct cls_rule *next = CONTAINER_OF(rule->list.next,
 599                                              struct cls_rule, list);
 600
 601         list_remove(&rule->list);
 602         hmap_replace(&table->rules, &rule->hmap_node, &next->hmap_node);
 603     }
 604
 605     if (--table->n_table_rules == 0) {
 606         destroy_table(cls, table);
 607     }
 608
 609     cls->n_rules--;
 610 }
 611
 612 /* Finds and returns the highest-priority rule in 'cls' that matches 'flow'.
 613  * Returns a null pointer if no rules in 'cls' match 'flow'.  If multiple rules
 614  * of equal priority match 'flow', returns one arbitrarily. */
 615 struct cls_rule *
 616 classifier_lookup(const struct classifier *cls, const struct flow *flow)
 617 {
 618     struct cls_table *table;
 619     struct cls_rule *best;
 620
 621     best = NULL;
 622     HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
 623         struct cls_rule *rule = find_match(table, flow);
 624         if (rule && (!best || rule->priority > best->priority)) {
 625             best = rule;
 626         }
 627     }
 628     return best;
 629 }
 630
 631 /* Finds and returns a rule in 'cls' with exactly the same priority and
 632  * matching criteria as 'target'.  Returns a null pointer if 'cls' doesn't
 633  * contain an exact match.
 634  *
 635  * Priority is ignored for exact-match rules (because OpenFlow 1.0 always
 636  * treats exact-match rules as highest priority). */
 637 struct cls_rule *
 638 classifier_find_rule_exactly(const struct classifier *cls,
 639                              const struct cls_rule *target)
 640 {
 641     struct cls_rule *head, *rule;
 642     struct cls_table *table;
 643
 644     table = find_table(cls, &target->wc);
 645     if (!table) {
 646         return NULL;
 647     }
 648
 649     head = find_equal(table, &target->flow, flow_hash(&target->flow, 0));
 650     if (flow_wildcards_is_exact(&target->wc)) {
 651         return head;
 652     }
 653     FOR_EACH_RULE_IN_LIST (rule, head) {
 654         if (target->priority >= rule->priority) {
 655             return target->priority == rule->priority ? rule : NULL;
 656         }
 657     }
 658     return NULL;
 659 }
 660
 661 /* Checks if 'target' would overlap any other rule in 'cls'.  Two rules are
 662  * considered to overlap if both rules have the same priority and a packet
 663  * could match both. */
 664 bool
 665 classifier_rule_overlaps(const struct classifier *cls,
 666                          const struct cls_rule *target)
 667 {
 668     struct cls_table *table;
 669
 670     HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
 671         struct flow_wildcards wc;
 672         struct cls_rule *head;
 673
 674         flow_wildcards_combine(&wc, &target->wc, &table->wc);
 675         HMAP_FOR_EACH (head, hmap_node, &table->rules) {
 676             struct cls_rule *rule;
 677
 678             FOR_EACH_RULE_IN_LIST (rule, head) {
 679                 if (rule->priority == target->priority
 680                     && flow_equal_except(&target->flow, &rule->flow, &wc)) {
 681                     return true;
 682                 }
 683             }
 684         }
 685     }
 686
 687     return false;
 688 }
 689 \f
 690 /* Iteration. */
 691
 692 static bool
 693 rule_matches(const struct cls_rule *rule, const struct cls_rule *target)
 694 {
 695     return (!target
 696             || flow_equal_except(&rule->flow, &target->flow, &target->wc));
 697 }
 698
 699 static struct cls_rule *
 700 search_table(const struct cls_table *table, const struct cls_rule *target)
 701 {
 702     if (!target || !flow_wildcards_has_extra(&table->wc, &target->wc)) {
 703         struct cls_rule *rule;
 704
 705         HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
 706             if (rule_matches(rule, target)) {
 707                 return rule;
 708             }
 709         }
 710     }
 711     return NULL;
 712 }
 713
 714 /* Initializes 'cursor' for iterating through 'cls' rules that exactly match
 715  * 'target' or are more specific than 'target'.  That is, a given 'rule'
 716  * matches 'target' if, for every field:
 717  *
 718  *   - 'target' and 'rule' specify the same (non-wildcarded) value for the
 719  *     field, or
 720  *
 721  *   - 'target' wildcards the field,
 722  *
 723  * but not if:
 724  *
 725  *   - 'target' and 'rule' specify different values for the field, or
 726  *
 727  *   - 'target' specifies a value for the field but 'rule' wildcards it.
 728  *
 729  * Equivalently, the truth table for whether a field matches is:
 730  *
 731  *                                     rule
 732  *
 733  *                             wildcard    exact
 734  *                            +---------+---------+
 735  *                   t   wild |   yes   |   yes   |
 736  *                   a   card |         |         |
 737  *                   r        +---------+---------+
 738  *                   g  exact |    no   |if values|
 739  *                   e        |         |are equal|
 740  *                   t        +---------+---------+
 741  *
 742  * This is the matching rule used by OpenFlow 1.0 non-strict OFPT_FLOW_MOD
 743  * commands and by OpenFlow 1.0 aggregate and flow stats.
 744  *
 745  * Ignores target->priority.
 746  *
 747  * 'target' may be NULL to iterate over every rule in 'cls'. */
 748 void
 749 cls_cursor_init(struct cls_cursor *cursor, const struct classifier *cls,
 750                 const struct cls_rule *target)
 751 {
 752     cursor->cls = cls;
 753     cursor->target = target;
 754 }
 755
 756 /* Returns the first matching cls_rule in 'cursor''s iteration, or a null
 757  * pointer if there are no matches. */
 758 struct cls_rule *
 759 cls_cursor_first(struct cls_cursor *cursor)
 760 {
 761     struct cls_table *table;
 762
 763     for (table = classifier_first_table(cursor->cls); table;
 764          table = classifier_next_table(cursor->cls, table)) {
 765         struct cls_rule *rule = search_table(table, cursor->target);
 766         if (rule) {
 767             cursor->table = table;
 768             return rule;
 769         }
 770     }
 771
 772     return NULL;
 773 }
 774
 775 /* Returns the next matching cls_rule in 'cursor''s iteration, or a null
 776  * pointer if there are no more matches. */
 777 struct cls_rule *
 778 cls_cursor_next(struct cls_cursor *cursor, struct cls_rule *rule)
 779 {
 780     const struct cls_table *table;
 781     struct cls_rule *next;
 782
 783     next = next_rule_in_list__(rule);
 784     if (next->priority < rule->priority) {
 785         return next;
 786     }
 787
 788     /* 'next' is the head of the list, that is, the rule that is included in
 789      * the table's hmap.  (This is important when the classifier contains rules
 790      * that differ only in priority.) */
 791     rule = next;
 792     HMAP_FOR_EACH_CONTINUE (rule, hmap_node, &cursor->table->rules) {
 793         if (rule_matches(rule, cursor->target)) {
 794             return rule;
 795         }
 796     }
 797
 798     for (table = classifier_next_table(cursor->cls, cursor->table); table;
 799          table = classifier_next_table(cursor->cls, table)) {
 800         rule = search_table(table, cursor->target);
 801         if (rule) {
 802             cursor->table = table;
 803             return rule;
 804         }
 805     }
 806
 807     return NULL;
 808 }
 809 \f
 810 static struct cls_table *
 811 find_table(const struct classifier *cls, const struct flow_wildcards *wc)
 812 {
 813     struct cls_table *table;
 814
 815     HMAP_FOR_EACH_IN_BUCKET (table, hmap_node, flow_wildcards_hash(wc),
 816                              &cls->tables) {
 817         if (flow_wildcards_equal(wc, &table->wc)) {
 818             return table;
 819         }
 820     }
 821     return NULL;
 822 }
 823
 824 static struct cls_table *
 825 insert_table(struct classifier *cls, const struct flow_wildcards *wc)
 826 {
 827     struct cls_table *table;
 828
 829     table = xzalloc(sizeof *table);
 830     hmap_init(&table->rules);
 831     table->wc = *wc;
 832     hmap_insert(&cls->tables, &table->hmap_node, flow_wildcards_hash(wc));
 833
 834     return table;
 835 }
 836
 837 static struct cls_table *
 838 classifier_first_table(const struct classifier *cls)
 839 {
 840     return cls_table_from_hmap_node(hmap_first(&cls->tables));
 841 }
 842
 843 static struct cls_table *
 844 classifier_next_table(const struct classifier *cls,
 845                       const struct cls_table *table)
 846 {
 847     return cls_table_from_hmap_node(hmap_next(&cls->tables,
 848                                               &table->hmap_node));
 849 }
 850
 851 static void
 852 destroy_table(struct classifier *cls, struct cls_table *table)
 853 {
 854     hmap_remove(&cls->tables, &table->hmap_node);
 855     hmap_destroy(&table->rules);
 856     free(table);
 857 }
 858
 859 static struct cls_rule *
 860 find_match(const struct cls_table *table, const struct flow *flow)
 861 {
 862     struct cls_rule *rule;
 863     struct flow f;
 864
 865     f = *flow;
 866     zero_wildcards(&f, &table->wc);
 867     HMAP_FOR_EACH_WITH_HASH (rule, hmap_node, flow_hash(&f, 0),
 868                              &table->rules) {
 869         if (flow_equal(&f, &rule->flow)) {
 870             return rule;
 871         }
 872     }
 873     return NULL;
 874 }
 875
 876 static struct cls_rule *
 877 find_equal(struct cls_table *table, const struct flow *flow, uint32_t hash)
 878 {
 879     struct cls_rule *head;
 880
 881     HMAP_FOR_EACH_WITH_HASH (head, hmap_node, hash, &table->rules) {
 882         if (flow_equal(&head->flow, flow)) {
 883             return head;
 884         }
 885     }
 886     return NULL;
 887 }
 888
 889 static struct cls_rule *
 890 insert_rule(struct cls_table *table, struct cls_rule *new)
 891 {
 892     struct cls_rule *head;
 893
 894     new->hmap_node.hash = flow_hash(&new->flow, 0);
 895
 896     head = find_equal(table, &new->flow, new->hmap_node.hash);
 897     if (!head) {
 898         hmap_insert(&table->rules, &new->hmap_node, new->hmap_node.hash);
 899         list_init(&new->list);
 900         return NULL;
 901     } else {
 902         /* Scan the list for the insertion point that will keep the list in
 903          * order of decreasing priority. */
 904         struct cls_rule *rule;
 905         FOR_EACH_RULE_IN_LIST (rule, head) {
 906             if (new->priority >= rule->priority) {
 907                 if (rule == head) {
 908                     /* 'new' is the new highest-priority flow in the list. */
 909                     hmap_replace(&table->rules,
 910                                  &rule->hmap_node, &new->hmap_node);
 911                 }
 912
 913                 if (new->priority == rule->priority) {
 914                     list_replace(&new->list, &rule->list);
 915                     return rule;
 916                 } else {
 917                     list_insert(&rule->list, &new->list);
 918                     return NULL;
 919                 }
 920             }
 921         }
 922
 923         /* Insert 'new' at the end of the list. */
 924         list_push_back(&head->list, &new->list);
 925         return NULL;
 926     }
 927 }
 928
 929 static struct cls_rule *
 930 next_rule_in_list__(struct cls_rule *rule)
 931 {
 932     struct cls_rule *next = OBJECT_CONTAINING(rule->list.next, next, list);
 933     return next;
 934 }
 935
 936 static struct cls_rule *
 937 next_rule_in_list(struct cls_rule *rule)
 938 {
 939     struct cls_rule *next = next_rule_in_list__(rule);
 940     return next->priority < rule->priority ? next : NULL;
 941 }
 942
 943 static bool
 944 flow_equal_except(const struct flow *a, const struct flow *b,
 945                   const struct flow_wildcards *wildcards)
 946 {
 947     const flow_wildcards_t wc = wildcards->wildcards;
 948     int i;
 949
 950     BUILD_ASSERT_DECL(FLOW_SIG_SIZE == 40 + FLOW_N_REGS * 4);
 951
 952     for (i = 0; i < FLOW_N_REGS; i++) {
 953         if ((a->regs[i] ^ b->regs[i]) & wildcards->reg_masks[i]) {
 954             return false;
 955         }
 956     }
 957
 958     return (!((a->tun_id ^ b->tun_id) & wildcards->tun_id_mask)
 959             && !((a->nw_src ^ b->nw_src) & wildcards->nw_src_mask)
 960             && !((a->nw_dst ^ b->nw_dst) & wildcards->nw_dst_mask)
 961             && (wc & FWW_IN_PORT || a->in_port == b->in_port)
 962             && !((a->vlan_tci ^ b->vlan_tci) & wildcards->vlan_tci_mask)
 963             && (wc & FWW_DL_TYPE || a->dl_type == b->dl_type)
 964             && (wc & FWW_TP_SRC || a->tp_src == b->tp_src)
 965             && (wc & FWW_TP_DST || a->tp_dst == b->tp_dst)
 966             && (wc & FWW_DL_SRC || eth_addr_equals(a->dl_src, b->dl_src))
 967             && (wc & FWW_DL_DST
 968                 || (!((a->dl_dst[0] ^ b->dl_dst[0]) & 0xfe)
 969                     && a->dl_dst[1] == b->dl_dst[1]
 970                     && a->dl_dst[2] == b->dl_dst[2]
 971                     && a->dl_dst[3] == b->dl_dst[3]
 972                     && a->dl_dst[4] == b->dl_dst[4]
 973                     && a->dl_dst[5] == b->dl_dst[5]))
 974             && (wc & FWW_ETH_MCAST
 975                 || !((a->dl_dst[0] ^ b->dl_dst[0]) & 0x01))
 976             && (wc & FWW_NW_PROTO || a->nw_proto == b->nw_proto)
 977             && (wc & FWW_NW_TOS || a->nw_tos == b->nw_tos));
 978 }
 979
 980 static void
 981 zero_wildcards(struct flow *flow, const struct flow_wildcards *wildcards)
 982 {
 983     const flow_wildcards_t wc = wildcards->wildcards;
 984     int i;
 985
 986     BUILD_ASSERT_DECL(FLOW_SIG_SIZE == 40 + 4 * FLOW_N_REGS);
 987
 988     for (i = 0; i < FLOW_N_REGS; i++) {
 989         flow->regs[i] &= wildcards->reg_masks[i];
 990     }
 991     flow->tun_id &= wildcards->tun_id_mask;
 992     flow->nw_src &= wildcards->nw_src_mask;
 993     flow->nw_dst &= wildcards->nw_dst_mask;
 994     if (wc & FWW_IN_PORT) {
 995         flow->in_port = 0;
 996     }
 997     flow->vlan_tci &= wildcards->vlan_tci_mask;
 998     if (wc & FWW_DL_TYPE) {
 999         flow->dl_type = 0;
1000     }
1001     if (wc & FWW_TP_SRC) {
1002         flow->tp_src = 0;
1003     }
1004     if (wc & FWW_TP_DST) {
1005         flow->tp_dst = 0;
1006     }
1007     if (wc & FWW_DL_SRC) {
1008         memset(flow->dl_src, 0, sizeof flow->dl_src);
1009     }
1010     if (wc & FWW_DL_DST) {
1011         flow->dl_dst[0] &= 0x01;
1012         memset(&flow->dl_dst[1], 0, 5);
1013     }
1014     if (wc & FWW_ETH_MCAST) {
1015         flow->dl_dst[0] &= 0xfe;
1016     }
1017     if (wc & FWW_NW_PROTO) {
1018         flow->nw_proto = 0;
1019     }
1020     if (wc & FWW_NW_TOS) {
1021         flow->nw_tos = 0;
1022     }
1023 }