lib/classifier.c

   1 /*
   2  * Copyright (c) 2009, 2010 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 "dynamic-string.h"
  23 #include "flow.h"
  24 #include "hash.h"
  25
  26 const struct cls_field cls_fields[CLS_N_FIELDS + 1] = {
  27 #define CLS_FIELD(WILDCARDS, MEMBER, NAME)      \
  28     { offsetof(struct flow, MEMBER),            \
  29       sizeof ((struct flow *)0)->MEMBER,        \
  30       WILDCARDS,                                \
  31       #NAME },
  32     CLS_FIELDS
  33 #undef CLS_FIELD
  34     { sizeof(struct flow), 0, 0, "exact" },
  35 };
  36
  37 static uint32_t hash_fields(const struct flow *, int table_idx);
  38 static bool equal_fields(const struct flow *, const struct flow *,
  39                          int table_idx);
  40
  41 static int table_idx_from_wildcards(uint32_t wildcards);
  42 static struct cls_rule *table_insert(struct hmap *, struct cls_rule *);
  43 static struct cls_rule *insert_exact_rule(struct classifier *,
  44                                           struct cls_rule *);
  45 static struct cls_bucket *find_bucket(struct hmap *, size_t hash,
  46                                       const struct cls_rule *);
  47 static struct cls_rule *search_table(const struct hmap *table, int field_idx,
  48                                      const struct cls_rule *);
  49 static struct cls_rule *search_exact_table(const struct classifier *,
  50                                            size_t hash, const struct flow *);
  51 static bool rules_match_1wild(const struct cls_rule *fixed,
  52                               const struct cls_rule *wild, int field_idx);
  53 static bool rules_match_2wild(const struct cls_rule *wild1,
  54                               const struct cls_rule *wild2, int field_idx);
  55
  56 /* Converts the flow in 'flow' into a cls_rule in 'rule', with the given
  57  * 'wildcards' and 'priority'.*/
  58 void
  59 cls_rule_from_flow(const struct flow *flow, uint32_t wildcards,
  60                    unsigned int priority, struct cls_rule *rule)
  61 {
  62     rule->flow = *flow;
  63     flow_wildcards_init(&rule->wc, wildcards);
  64     rule->priority = priority;
  65     rule->table_idx = table_idx_from_wildcards(rule->wc.wildcards);
  66 }
  67
  68 /* Converts the ofp_match in 'match' into a cls_rule in 'rule', with the given
  69  * 'priority'.  If 'tun_id_from_cookie' is set then the upper 32 bits of
  70  * 'cookie' are stored in the rule as the tunnel ID. */
  71 void
  72 cls_rule_from_match(const struct ofp_match *match, unsigned int priority,
  73                     bool tun_id_from_cookie, uint64_t cookie,
  74                     struct cls_rule *rule)
  75 {
  76     uint32_t wildcards;
  77     flow_from_match(match, tun_id_from_cookie, cookie, &rule->flow, &wildcards);
  78     flow_wildcards_init(&rule->wc, wildcards);
  79     rule->priority = rule->wc.wildcards ? priority : UINT16_MAX;
  80     rule->table_idx = table_idx_from_wildcards(rule->wc.wildcards);
  81 }
  82
  83 /* Converts 'rule' to a string and returns the string.  The caller must free
  84  * the string (with free()). */
  85 char *
  86 cls_rule_to_string(const struct cls_rule *rule)
  87 {
  88     struct ds s = DS_EMPTY_INITIALIZER;
  89     ds_put_format(&s, "wildcards=%x priority=%u ",
  90                   rule->wc.wildcards, rule->priority);
  91     flow_format(&s, &rule->flow);
  92     return ds_cstr(&s);
  93 }
  94
  95 /* Prints cls_rule 'rule', for debugging.
  96  *
  97  * (The output could be improved and expanded, but this was good enough to
  98  * debug the classifier.) */
  99 void
 100 cls_rule_print(const struct cls_rule *rule)
 101 {
 102     printf("wildcards=%x priority=%u ", rule->wc.wildcards, rule->priority);
 103     flow_print(stdout, &rule->flow);
 104     putc('\n', stdout);
 105 }
 106 \f
 107 /* Initializes 'cls' as a classifier that initially contains no classification
 108  * rules. */
 109 void
 110 classifier_init(struct classifier *cls)
 111 {
 112     int i;
 113
 114     cls->n_rules = 0;
 115     for (i = 0; i < ARRAY_SIZE(cls->tables); i++) {
 116         hmap_init(&cls->tables[i]);
 117     }
 118     hmap_init(&cls->exact_table);
 119 }
 120
 121 /* Destroys 'cls'.  Rules within 'cls', if any, are not freed; this is the
 122  * caller's responsibility. */
 123 void
 124 classifier_destroy(struct classifier *cls)
 125 {
 126     if (cls) {
 127         struct cls_bucket *bucket, *next_bucket;
 128         struct hmap *tbl;
 129
 130         for (tbl = &cls->tables[0]; tbl < &cls->tables[CLS_N_FIELDS]; tbl++) {
 131             HMAP_FOR_EACH_SAFE (bucket, next_bucket, hmap_node, tbl) {
 132                 free(bucket);
 133             }
 134             hmap_destroy(tbl);
 135         }
 136         hmap_destroy(&cls->exact_table);
 137     }
 138 }
 139
 140 /* Returns true if 'cls' does not contain any classification rules, false
 141  * otherwise. */
 142 bool
 143 classifier_is_empty(const struct classifier *cls)
 144 {
 145     return cls->n_rules == 0;
 146 }
 147
 148 /* Returns the number of rules in 'classifier'. */
 149 int
 150 classifier_count(const struct classifier *cls)
 151 {
 152     return cls->n_rules;
 153 }
 154
 155 /* Returns the number of rules in 'classifier' that have no wildcards. */
 156 int
 157 classifier_count_exact(const struct classifier *cls)
 158 {
 159     return hmap_count(&cls->exact_table);
 160 }
 161
 162 /* Inserts 'rule' into 'cls'.  Transfers ownership of 'rule' to 'cls'.
 163  *
 164  * If 'cls' already contains an identical rule (including wildcards, values of
 165  * fixed fields, and priority), replaces the old rule by 'rule' and returns the
 166  * rule that was replaced.  The caller takes ownership of the returned rule and
 167  * is thus responsible for freeing it, etc., as necessary.
 168  *
 169  * Returns NULL if 'cls' does not contain a rule with an identical key, after
 170  * inserting the new rule.  In this case, no rules are displaced by the new
 171  * rule, even rules that cannot have any effect because the new rule matches a
 172  * superset of their flows and has higher priority. */
 173 struct cls_rule *
 174 classifier_insert(struct classifier *cls, struct cls_rule *rule)
 175 {
 176     struct cls_rule *old;
 177     assert((rule->wc.wildcards == 0) == (rule->table_idx == CLS_F_IDX_EXACT));
 178     old = (rule->wc.wildcards
 179            ? table_insert(&cls->tables[rule->table_idx], rule)
 180            : insert_exact_rule(cls, rule));
 181     if (!old) {
 182         cls->n_rules++;
 183     }
 184     return old;
 185 }
 186
 187 /* Removes 'rule' from 'cls'.  It is caller's responsibility to free 'rule', if
 188  * this is desirable. */
 189 void
 190 classifier_remove(struct classifier *cls, struct cls_rule *rule)
 191 {
 192     if (rule->wc.wildcards) {
 193         /* Remove 'rule' from bucket.  If that empties the bucket, remove the
 194          * bucket from its table. */
 195         struct hmap *table = &cls->tables[rule->table_idx];
 196         struct list *rules = list_remove(&rule->node.list);
 197         if (list_is_empty(rules)) {
 198             /* This code is a little tricky.  list_remove() returns the list
 199              * element just after the one removed.  Since the list is now
 200              * empty, this will be the address of the 'rules' member of the
 201              * bucket that was just emptied, so pointer arithmetic (via
 202              * CONTAINER_OF) can find that bucket. */
 203             struct cls_bucket *bucket;
 204             bucket = CONTAINER_OF(rules, struct cls_bucket, rules);
 205             hmap_remove(table, &bucket->hmap_node);
 206             free(bucket);
 207         }
 208     } else {
 209         /* Remove 'rule' from cls->exact_table. */
 210         hmap_remove(&cls->exact_table, &rule->node.hmap);
 211     }
 212     cls->n_rules--;
 213 }
 214
 215 /* Finds and returns the highest-priority rule in 'cls' that matches 'flow'.
 216  * Returns a null pointer if no rules in 'cls' match 'flow'.  If multiple rules
 217  * of equal priority match 'flow', returns one arbitrarily.
 218  *
 219  * (When multiple rules of equal priority happen to fall into the same bucket,
 220  * rules added more recently take priority over rules added less recently, but
 221  * this is subject to change and should not be depended upon.) */
 222 struct cls_rule *
 223 classifier_lookup(const struct classifier *cls, const struct flow *flow)
 224 {
 225     struct cls_rule *rule = classifier_lookup_exact(cls, flow);
 226     if (!rule) {
 227         rule = classifier_lookup_wild(cls, flow);
 228     }
 229     return rule;
 230 }
 231
 232 struct cls_rule *
 233 classifier_lookup_exact(const struct classifier *cls, const struct flow *flow)
 234 {
 235     return (!hmap_is_empty(&cls->exact_table)
 236             ? search_exact_table(cls, flow_hash(flow, 0), flow)
 237             : NULL);
 238 }
 239
 240 struct cls_rule *
 241 classifier_lookup_wild(const struct classifier *cls, const struct flow *flow)
 242 {
 243     struct cls_rule *best = NULL;
 244     if (cls->n_rules > hmap_count(&cls->exact_table)) {
 245         struct cls_rule target;
 246         int i;
 247
 248         cls_rule_from_flow(flow, 0, 0, &target);
 249         for (i = 0; i < CLS_N_FIELDS; i++) {
 250             struct cls_rule *rule = search_table(&cls->tables[i], i, &target);
 251             if (rule && (!best || rule->priority > best->priority)) {
 252                 best = rule;
 253             }
 254         }
 255     }
 256     return best;
 257 }
 258
 259 struct cls_rule *
 260 classifier_find_rule_exactly(const struct classifier *cls,
 261                              const struct flow *target, uint32_t wildcards,
 262                              unsigned int priority)
 263 {
 264     struct cls_bucket *bucket;
 265     int table_idx;
 266     uint32_t hash;
 267
 268     if (!wildcards) {
 269         /* Ignores 'priority'. */
 270         return search_exact_table(cls, flow_hash(target, 0), target);
 271     }
 272
 273     assert(wildcards == (wildcards & OVSFW_ALL));
 274     table_idx = table_idx_from_wildcards(wildcards);
 275     hash = hash_fields(target, table_idx);
 276     HMAP_FOR_EACH_WITH_HASH (bucket, hmap_node, hash,
 277                              &cls->tables[table_idx]) {
 278         if (equal_fields(&bucket->fixed, target, table_idx)) {
 279             struct cls_rule *pos;
 280             LIST_FOR_EACH (pos, node.list, &bucket->rules) {
 281                 if (pos->priority < priority) {
 282                     return NULL;
 283                 } else if (pos->priority == priority &&
 284                            pos->wc.wildcards == wildcards &&
 285                            flow_equal(target, &pos->flow)) {
 286                     return pos;
 287                 }
 288             }
 289         }
 290     }
 291     return NULL;
 292 }
 293
 294 /* Checks if the flow defined by 'target' with 'wildcards' at 'priority'
 295  * overlaps with any other rule at the same priority in the classifier.
 296  * Two rules are considered overlapping if a packet could match both. */
 297 bool
 298 classifier_rule_overlaps(const struct classifier *cls,
 299                          const struct flow *target, uint32_t wildcards,
 300                          unsigned int priority)
 301 {
 302     struct cls_rule target_rule;
 303     const struct hmap *tbl;
 304
 305     if (!wildcards) {
 306         return search_exact_table(cls, flow_hash(target, 0), target) ?
 307             true : false;
 308     }
 309
 310     cls_rule_from_flow(target, wildcards, priority, &target_rule);
 311
 312     for (tbl = &cls->tables[0]; tbl < &cls->tables[CLS_N_FIELDS]; tbl++) {
 313         struct cls_bucket *bucket;
 314
 315         HMAP_FOR_EACH (bucket, hmap_node, tbl) {
 316             struct cls_rule *rule;
 317
 318             LIST_FOR_EACH (rule, node.list, &bucket->rules) {
 319                 if (rule->priority == priority
 320                     && rules_match_2wild(rule, &target_rule, 0)) {
 321                     return true;
 322                 }
 323             }
 324         }
 325     }
 326
 327     return false;
 328 }
 329
 330 /* Ignores target->priority.
 331  *
 332  * 'callback' is allowed to delete the rule that is passed as its argument, but
 333  * it must not delete (or move) any other rules in 'cls' that are in the same
 334  * table as the argument rule.  Two rules are in the same table if their
 335  * cls_rule structs have the same table_idx; as a special case, a rule with
 336  * wildcards and an exact-match rule will never be in the same table. */
 337 void
 338 classifier_for_each_match(const struct classifier *cls,
 339                           const struct cls_rule *target,
 340                           int include, cls_cb_func *callback, void *aux)
 341 {
 342     if (include & CLS_INC_WILD) {
 343         const struct hmap *table;
 344
 345         for (table = &cls->tables[0]; table < &cls->tables[CLS_N_FIELDS];
 346              table++) {
 347             struct cls_bucket *bucket, *next_bucket;
 348
 349             HMAP_FOR_EACH_SAFE (bucket, next_bucket, hmap_node, table) {
 350                 /* XXX there is a bit of room for optimization here based on
 351                  * rejecting entire buckets on their fixed fields, but it will
 352                  * only be worthwhile for big buckets (which we hope we won't
 353                  * get anyway, but...) */
 354                 struct cls_rule *prev_rule, *rule;
 355
 356                 /* We can't just use LIST_FOR_EACH_SAFE here because, if the
 357                  * callback deletes the last rule in the bucket, then the
 358                  * bucket itself will be destroyed.  The bucket contains the
 359                  * list head so that's a use-after-free error. */
 360                 prev_rule = NULL;
 361                 LIST_FOR_EACH (rule, node.list, &bucket->rules) {
 362                     if (rules_match_1wild(rule, target, 0)) {
 363                         if (prev_rule) {
 364                             callback(prev_rule, aux);
 365                         }
 366                         prev_rule = rule;
 367                     }
 368                 }
 369                 if (prev_rule) {
 370                     callback(prev_rule, aux);
 371                 }
 372             }
 373         }
 374     }
 375
 376     if (include & CLS_INC_EXACT) {
 377         if (target->wc.wildcards) {
 378             struct cls_rule *rule, *next_rule;
 379
 380             HMAP_FOR_EACH_SAFE (rule, next_rule, node.hmap,
 381                                 &cls->exact_table) {
 382                 if (rules_match_1wild(rule, target, 0)) {
 383                     callback(rule, aux);
 384                 }
 385             }
 386         } else {
 387             /* Optimization: there can be at most one match in the exact
 388              * table. */
 389             size_t hash = flow_hash(&target->flow, 0);
 390             struct cls_rule *rule = search_exact_table(cls, hash,
 391                                                        &target->flow);
 392             if (rule) {
 393                 callback(rule, aux);
 394             }
 395         }
 396     }
 397 }
 398
 399 /* 'callback' is allowed to delete the rule that is passed as its argument, but
 400  * it must not delete (or move) any other rules in 'cls' that are in the same
 401  * table as the argument rule.  Two rules are in the same table if their
 402  * cls_rule structs have the same table_idx; as a special case, a rule with
 403  * wildcards and an exact-match rule will never be in the same table.
 404  *
 405  * If 'include' is CLS_INC_EXACT then CLASSIFIER_FOR_EACH_EXACT_RULE(_SAFE) is
 406  * probably easier to use. */
 407 void
 408 classifier_for_each(const struct classifier *cls, int include,
 409                     void (*callback)(struct cls_rule *, void *aux),
 410                     void *aux)
 411 {
 412     if (include & CLS_INC_WILD) {
 413         const struct hmap *tbl;
 414
 415         for (tbl = &cls->tables[0]; tbl < &cls->tables[CLS_N_FIELDS]; tbl++) {
 416             struct cls_bucket *bucket, *next_bucket;
 417
 418             HMAP_FOR_EACH_SAFE (bucket, next_bucket, hmap_node, tbl) {
 419                 struct cls_rule *prev_rule, *rule;
 420
 421                 /* We can't just use LIST_FOR_EACH_SAFE here because, if the
 422                  * callback deletes the last rule in the bucket, then the
 423                  * bucket itself will be destroyed.  The bucket contains the
 424                  * list head so that's a use-after-free error. */
 425                 prev_rule = NULL;
 426                 LIST_FOR_EACH (rule, node.list, &bucket->rules) {
 427                     if (prev_rule) {
 428                         callback(prev_rule, aux);
 429                     }
 430                     prev_rule = rule;
 431                 }
 432                 if (prev_rule) {
 433                     callback(prev_rule, aux);
 434                 }
 435             }
 436         }
 437     }
 438
 439     if (include & CLS_INC_EXACT) {
 440         struct cls_rule *rule, *next_rule;
 441
 442         HMAP_FOR_EACH_SAFE (rule, next_rule, node.hmap, &cls->exact_table) {
 443             callback(rule, aux);
 444         }
 445     }
 446 }
 447 \f
 448 static struct cls_bucket *create_bucket(struct hmap *, size_t hash,
 449                                         const struct flow *fixed);
 450 static struct cls_rule *bucket_insert(struct cls_bucket *, struct cls_rule *);
 451
 452 static inline bool equal_bytes(const void *, const void *, size_t n);
 453
 454 /* Returns a hash computed across the fields in 'flow' whose field indexes
 455  * (CLS_F_IDX_*) are less than 'table_idx'.  (If 'table_idx' is
 456  * CLS_F_IDX_EXACT, hashes all the fields in 'flow'). */
 457 static uint32_t
 458 hash_fields(const struct flow *flow, int table_idx)
 459 {
 460     /* I just know I'm going to hell for writing code this way.
 461      *
 462      * GCC generates pretty good code here, with only a single taken
 463      * conditional jump per execution.  Now the question is, would we be better
 464      * off marking this function ALWAYS_INLINE and writing a wrapper that
 465      * switches on the value of 'table_idx' to get rid of all the conditional
 466      * jumps entirely (except for one in the wrapper)?  Honestly I really,
 467      * really hope that it doesn't matter in practice.
 468      *
 469      * We could do better by calculating hashes incrementally, instead of
 470      * starting over from the top each time.  But that would be even uglier. */
 471     uint32_t a, b, c;
 472     uint32_t tmp[3];
 473     size_t n;
 474
 475     a = b = c = 0xdeadbeef + table_idx;
 476     n = 0;
 477
 478 #define CLS_FIELD(WILDCARDS, MEMBER, NAME)                      \
 479     if (table_idx == CLS_F_IDX_##NAME) {                        \
 480         /* Done. */                                             \
 481         memset((uint8_t *) tmp + n, 0, sizeof tmp - n);         \
 482         goto finish;                                            \
 483     } else {                                                    \
 484         const size_t size = sizeof flow->MEMBER;                \
 485         const uint8_t *p1 = (const uint8_t *) &flow->MEMBER;    \
 486         const size_t p1_size = MIN(sizeof tmp - n, size);       \
 487         const uint8_t *p2 = p1 + p1_size;                       \
 488         const size_t p2_size = size - p1_size;                  \
 489                                                                 \
 490         /* Append to 'tmp' as much data as will fit. */         \
 491         memcpy((uint8_t *) tmp + n, p1, p1_size);               \
 492         n += p1_size;                                           \
 493                                                                 \
 494         /* If 'tmp' is full, mix. */                            \
 495         if (n == sizeof tmp) {                                  \
 496             a += tmp[0];                                        \
 497             b += tmp[1];                                        \
 498             c += tmp[2];                                        \
 499             HASH_MIX(a, b, c);                                  \
 500             n = 0;                                              \
 501         }                                                       \
 502                                                                 \
 503         /* Append to 'tmp' any data that didn't fit. */         \
 504         memcpy(tmp, p2, p2_size);                               \
 505         n += p2_size;                                           \
 506     }
 507     CLS_FIELDS
 508 #undef CLS_FIELD
 509
 510 finish:
 511     a += tmp[0];
 512     b += tmp[1];
 513     c += tmp[2];
 514     HASH_FINAL(a, b, c);
 515     return c;
 516 }
 517
 518 /* Compares the fields in 'a' and 'b' whose field indexes (CLS_F_IDX_*) are
 519  * less than 'table_idx'.  (If 'table_idx' is CLS_F_IDX_EXACT, compares all the
 520  * fields in 'a' and 'b').
 521  *
 522  * Returns true if all the compared fields are equal, false otherwise. */
 523 static bool
 524 equal_fields(const struct flow *a, const struct flow *b, int table_idx)
 525 {
 526     /* XXX The generated code could be better here. */
 527 #define CLS_FIELD(WILDCARDS, MEMBER, NAME)                              \
 528     if (table_idx == CLS_F_IDX_##NAME) {                                \
 529         return true;                                                    \
 530     } else if (!equal_bytes(&a->MEMBER, &b->MEMBER, sizeof a->MEMBER)) { \
 531         return false;                                                   \
 532     }
 533     CLS_FIELDS
 534 #undef CLS_FIELD
 535
 536     return true;
 537 }
 538
 539 static int
 540 table_idx_from_wildcards(uint32_t wildcards)
 541 {
 542     if (!wildcards) {
 543         return CLS_F_IDX_EXACT;
 544     }
 545 #define CLS_FIELD(WILDCARDS, MEMBER, NAME) \
 546     if (wildcards & WILDCARDS) {           \
 547         return CLS_F_IDX_##NAME;           \
 548     }
 549     CLS_FIELDS
 550 #undef CLS_FIELD
 551     NOT_REACHED();
 552 }
 553
 554 /* Inserts 'rule' into 'table'.  Returns the rule, if any, that was displaced
 555  * in favor of 'rule'. */
 556 static struct cls_rule *
 557 table_insert(struct hmap *table, struct cls_rule *rule)
 558 {
 559     struct cls_bucket *bucket;
 560     size_t hash;
 561
 562     hash = hash_fields(&rule->flow, rule->table_idx);
 563     bucket = find_bucket(table, hash, rule);
 564     if (!bucket) {
 565         bucket = create_bucket(table, hash, &rule->flow);
 566     }
 567
 568     return bucket_insert(bucket, rule);
 569 }
 570
 571 /* Inserts 'rule' into 'bucket', given that 'field' is the first wildcarded
 572  * field in 'rule'.
 573  *
 574  * Returns the rule, if any, that was displaced in favor of 'rule'. */
 575 static struct cls_rule *
 576 bucket_insert(struct cls_bucket *bucket, struct cls_rule *rule)
 577 {
 578     struct cls_rule *pos;
 579     LIST_FOR_EACH (pos, node.list, &bucket->rules) {
 580         if (pos->priority == rule->priority) {
 581             if (pos->wc.wildcards == rule->wc.wildcards
 582                 && rules_match_1wild(pos, rule, rule->table_idx))
 583             {
 584                 list_replace(&rule->node.list, &pos->node.list);
 585                 return pos;
 586             }
 587         } else if (pos->priority < rule->priority) {
 588             break;
 589         }
 590     }
 591     list_insert(&pos->node.list, &rule->node.list);
 592     return NULL;
 593 }
 594
 595 static struct cls_rule *
 596 insert_exact_rule(struct classifier *cls, struct cls_rule *rule)
 597 {
 598     struct cls_rule *old_rule;
 599     size_t hash;
 600
 601     hash = flow_hash(&rule->flow, 0);
 602     old_rule = search_exact_table(cls, hash, &rule->flow);
 603     if (old_rule) {
 604         hmap_remove(&cls->exact_table, &old_rule->node.hmap);
 605     }
 606     hmap_insert(&cls->exact_table, &rule->node.hmap, hash);
 607     return old_rule;
 608 }
 609
 610 /* Returns the bucket in 'table' that has the given 'hash' and the same fields
 611  * as 'rule->flow' (up to 'rule->table_idx'), or a null pointer if no bucket
 612  * matches. */
 613 static struct cls_bucket *
 614 find_bucket(struct hmap *table, size_t hash, const struct cls_rule *rule)
 615 {
 616     struct cls_bucket *bucket;
 617     HMAP_FOR_EACH_WITH_HASH (bucket, hmap_node, hash, table) {
 618         if (equal_fields(&bucket->fixed, &rule->flow, rule->table_idx)) {
 619             return bucket;
 620         }
 621     }
 622     return NULL;
 623 }
 624
 625 /* Creates a bucket and inserts it in 'table' with the given 'hash' and 'fixed'
 626  * values.  Returns the new bucket. */
 627 static struct cls_bucket *
 628 create_bucket(struct hmap *table, size_t hash, const struct flow *fixed)
 629 {
 630     struct cls_bucket *bucket = xmalloc(sizeof *bucket);
 631     list_init(&bucket->rules);
 632     bucket->fixed = *fixed;
 633     hmap_insert(table, &bucket->hmap_node, hash);
 634     return bucket;
 635 }
 636
 637 /* Returns true if the 'n' bytes in 'a' and 'b' are equal, false otherwise. */
 638 static inline bool ALWAYS_INLINE
 639 equal_bytes(const void *a, const void *b, size_t n)
 640 {
 641 #ifdef __i386__
 642     /* For some reason GCC generates stupid code for memcmp() of small
 643      * constant integer lengths.  Help it out.
 644      *
 645      * This function is always inlined, and it is always called with 'n' as a
 646      * compile-time constant, so the switch statement gets optimized out and
 647      * this whole function just expands to an instruction or two. */
 648     switch (n) {
 649     case 1:
 650         return *(uint8_t *) a == *(uint8_t *) b;
 651
 652     case 2:
 653         return *(uint16_t *) a == *(uint16_t *) b;
 654
 655     case 4:
 656         return *(uint32_t *) a == *(uint32_t *) b;
 657
 658     case 6:
 659         return (*(uint32_t *) a == *(uint32_t *) b
 660                 && ((uint16_t *) a)[2] == ((uint16_t *) b)[2]);
 661
 662     default:
 663         abort();
 664     }
 665 #else
 666     /* I hope GCC is smarter on your platform. */
 667     return !memcmp(a, b, n);
 668 #endif
 669 }
 670
 671 /* Returns the 32-bit unsigned integer at 'p'. */
 672 static inline uint32_t
 673 read_uint32(const void *p)
 674 {
 675     /* GCC optimizes this into a single machine instruction on x86. */
 676     uint32_t x;
 677     memcpy(&x, p, sizeof x);
 678     return x;
 679 }
 680
 681 /* Compares the specified field in 'a' and 'b'.  Returns true if the fields are
 682  * equal, or if the ofp_match wildcard bits in 'wildcards' are set such that
 683  * non-equal values may be ignored.  'nw_src_mask' and 'nw_dst_mask' must be
 684  * those that would be set for 'wildcards' by cls_rule_set_masks().
 685  *
 686  * The compared field is the one with wildcard bit or bits 'field_wc', offset
 687  * 'rule_ofs' within cls_rule's "fields" member, and length 'len', in bytes. */
 688 static inline bool ALWAYS_INLINE
 689 field_matches(const struct flow *a_, const struct flow *b_,
 690               uint32_t wildcards, uint32_t nw_src_mask, uint32_t nw_dst_mask,
 691               uint32_t field_wc, int ofs, int len)
 692 {
 693     /* This function is always inlined, and it is always called with 'field_wc'
 694      * as a compile-time constant, so the "if" conditionals here generate no
 695      * code. */
 696     const void *a = (const uint8_t *) a_ + ofs;
 697     const void *b = (const uint8_t *) b_ + ofs;
 698     if (!(field_wc & (field_wc - 1))) {
 699         /* Handle all the single-bit wildcard cases. */
 700         return wildcards & field_wc || equal_bytes(a, b, len);
 701     } else if (field_wc == OFPFW_NW_SRC_MASK ||
 702                field_wc == OFPFW_NW_DST_MASK) {
 703         uint32_t a_ip = read_uint32(a);
 704         uint32_t b_ip = read_uint32(b);
 705         uint32_t mask = (field_wc == OFPFW_NW_SRC_MASK
 706                          ? nw_src_mask : nw_dst_mask);
 707         return ((a_ip ^ b_ip) & mask) == 0;
 708     } else {
 709         abort();
 710     }
 711 }
 712
 713 /* Returns true if 'a' and 'b' match, ignoring fields for which the wildcards
 714  * in 'wildcards' are set.  'nw_src_mask' and 'nw_dst_mask' must be those that
 715  * would be set for 'wildcards' by cls_rule_set_masks().  'field_idx' is the
 716  * index of the first field to be compared; fields before 'field_idx' are
 717  * assumed to match.  (Always returns true if 'field_idx' is CLS_N_FIELDS.) */
 718 static bool
 719 rules_match(const struct cls_rule *a, const struct cls_rule *b,
 720             uint32_t wildcards, uint32_t nw_src_mask, uint32_t nw_dst_mask,
 721             int field_idx)
 722 {
 723     /* This is related to Duff's device (see
 724      * http://en.wikipedia.org/wiki/Duff's_device).  */
 725     switch (field_idx) {
 726 #define CLS_FIELD(WILDCARDS, MEMBER, NAME)                          \
 727         case CLS_F_IDX_##NAME:                                      \
 728             if (!field_matches(&a->flow, &b->flow,                  \
 729                                wildcards, nw_src_mask, nw_dst_mask, \
 730                                WILDCARDS, offsetof(struct flow, MEMBER), \
 731                                sizeof a->flow.MEMBER)) {            \
 732                 return false;                                       \
 733             }                                                       \
 734         /* Fall though */
 735         CLS_FIELDS
 736 #undef CLS_FIELD
 737     }
 738     return true;
 739 }
 740
 741 /* Returns true if 'fixed' and 'wild' match.  All fields in 'fixed' must have
 742  * fixed values; 'wild' may contain wildcards.
 743  *
 744  * 'field_idx' is the index of the first field to be compared; fields before
 745  * 'field_idx' are assumed to match.  Always returns true if 'field_idx' is
 746  * CLS_N_FIELDS. */
 747 static bool
 748 rules_match_1wild(const struct cls_rule *fixed, const struct cls_rule *wild,
 749                   int field_idx)
 750 {
 751     return rules_match(fixed, wild, wild->wc.wildcards, wild->wc.nw_src_mask,
 752                        wild->wc.nw_dst_mask, field_idx);
 753 }
 754
 755 /* Returns true if 'wild1' and 'wild2' match, that is, if their fields
 756  * are equal modulo wildcards in 'wild1' or 'wild2'.
 757  *
 758  * 'field_idx' is the index of the first field to be compared; fields before
 759  * 'field_idx' are assumed to match.  Always returns true if 'field_idx' is
 760  * CLS_N_FIELDS. */
 761 static bool
 762 rules_match_2wild(const struct cls_rule *wild1, const struct cls_rule *wild2,
 763                   int field_idx)
 764 {
 765     return rules_match(wild1, wild2,
 766                        wild1->wc.wildcards | wild2->wc.wildcards,
 767                        wild1->wc.nw_src_mask & wild2->wc.nw_src_mask,
 768                        wild1->wc.nw_dst_mask & wild2->wc.nw_dst_mask,
 769                        field_idx);
 770 }
 771
 772 /* Searches 'bucket' for a rule that matches 'target'.  Returns the
 773  * highest-priority match, if one is found, or a null pointer if there is no
 774  * match.
 775  *
 776  * 'field_idx' must be the index of the first wildcarded field in 'bucket'. */
 777 static struct cls_rule *
 778 search_bucket(struct cls_bucket *bucket, int field_idx,
 779               const struct cls_rule *target)
 780 {
 781     struct cls_rule *pos;
 782
 783     if (!equal_fields(&bucket->fixed, &target->flow, field_idx)) {
 784         return NULL;
 785     }
 786
 787     LIST_FOR_EACH (pos, node.list, &bucket->rules) {
 788         if (rules_match_1wild(target, pos, field_idx)) {
 789             return pos;
 790         }
 791     }
 792     return NULL;
 793 }
 794
 795 /* Searches 'table' for a rule that matches 'target'.  Returns the
 796  * highest-priority match, if one is found, or a null pointer if there is no
 797  * match.
 798  *
 799  * 'field_idx' must be the index of the first wildcarded field in 'table'. */
 800 static struct cls_rule *
 801 search_table(const struct hmap *table, int field_idx,
 802              const struct cls_rule *target)
 803 {
 804     struct cls_bucket *bucket;
 805
 806     switch (hmap_count(table)) {
 807         /* In these special cases there's no need to hash.  */
 808     case 0:
 809         return NULL;
 810     case 1:
 811         bucket = CONTAINER_OF(hmap_first(table), struct cls_bucket, hmap_node);
 812         return search_bucket(bucket, field_idx, target);
 813     }
 814
 815     HMAP_FOR_EACH_WITH_HASH (bucket, hmap_node,
 816                              hash_fields(&target->flow, field_idx), table) {
 817         struct cls_rule *rule = search_bucket(bucket, field_idx, target);
 818         if (rule) {
 819             return rule;
 820         }
 821     }
 822     return NULL;
 823 }
 824
 825 static struct cls_rule *
 826 search_exact_table(const struct classifier *cls, size_t hash,
 827                    const struct flow *target)
 828 {
 829     struct cls_rule *rule;
 830
 831     HMAP_FOR_EACH_WITH_HASH (rule, node.hmap, hash, &cls->exact_table) {
 832         if (flow_equal(&rule->flow, target)) {
 833             return rule;
 834         }
 835     }
 836     return NULL;
 837 }