tests/test-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 /* "White box" tests for classifier.
  18  *
  19  * With very few exceptions, these tests obtain complete coverage of every
  20  * basic block and every branch in the classifier implementation, e.g. a clean
  21  * report from "gcov -b".  (Covering the exceptions would require finding
  22  * collisions in the hash function used for flow data, etc.)
  23  *
  24  * This test should receive a clean report from "valgrind --leak-check=full":
  25  * it frees every heap block that it allocates.
  26  */
  27
  28 #include <config.h>
  29 #include <limits.h>
  30 #include "classifier.h"
  31 #include <errno.h>
  32 #include <limits.h>
  33 #include "flow.h"
  34 #include <limits.h>
  35 #include "packets.h"
  36
  37 #undef NDEBUG
  38 #include <assert.h>
  39
  40 struct test_rule {
  41     int aux;                    /* Auxiliary data. */
  42     struct cls_rule cls_rule;   /* Classifier rule data. */
  43 };
  44
  45 static struct test_rule *
  46 test_rule_from_cls_rule(const struct cls_rule *rule)
  47 {
  48     return rule ? CONTAINER_OF(rule, struct test_rule, cls_rule) : NULL;
  49 }
  50
  51 /* Trivial (linear) classifier. */
  52 struct tcls {
  53     size_t n_rules;
  54     size_t allocated_rules;
  55     struct test_rule **rules;
  56 };
  57
  58 static void
  59 tcls_init(struct tcls *tcls)
  60 {
  61     tcls->n_rules = 0;
  62     tcls->allocated_rules = 0;
  63     tcls->rules = NULL;
  64 }
  65
  66 static void
  67 tcls_destroy(struct tcls *tcls)
  68 {
  69     if (tcls) {
  70         size_t i;
  71
  72         for (i = 0; i < tcls->n_rules; i++) {
  73             free(tcls->rules[i]);
  74         }
  75         free(tcls->rules);
  76     }
  77 }
  78
  79 static int
  80 tcls_count_exact(const struct tcls *tcls)
  81 {
  82     int n_exact;
  83     size_t i;
  84
  85     n_exact = 0;
  86     for (i = 0; i < tcls->n_rules; i++) {
  87         n_exact += tcls->rules[i]->cls_rule.wc.wildcards == 0;
  88     }
  89     return n_exact;
  90 }
  91
  92 static bool
  93 tcls_is_empty(const struct tcls *tcls)
  94 {
  95     return tcls->n_rules == 0;
  96 }
  97
  98 static struct test_rule *
  99 tcls_insert(struct tcls *tcls, const struct test_rule *rule)
 100 {
 101     size_t i;
 102
 103     assert(rule->cls_rule.wc.wildcards || rule->cls_rule.priority == UINT_MAX);
 104     for (i = 0; i < tcls->n_rules; i++) {
 105         const struct cls_rule *pos = &tcls->rules[i]->cls_rule;
 106         if (pos->priority == rule->cls_rule.priority
 107             && pos->wc.wildcards == rule->cls_rule.wc.wildcards
 108             && flow_equal(&pos->flow, &rule->cls_rule.flow)) {
 109             /* Exact match.
 110              * XXX flow_equal should ignore wildcarded fields */
 111             free(tcls->rules[i]);
 112             tcls->rules[i] = xmemdup(rule, sizeof *rule);
 113             return tcls->rules[i];
 114         } else if (pos->priority < rule->cls_rule.priority) {
 115             break;
 116         }
 117     }
 118
 119     if (tcls->n_rules >= tcls->allocated_rules) {
 120         tcls->rules = x2nrealloc(tcls->rules, &tcls->allocated_rules,
 121                                  sizeof *tcls->rules);
 122     }
 123     if (i != tcls->n_rules) {
 124         memmove(&tcls->rules[i + 1], &tcls->rules[i],
 125                 sizeof *tcls->rules * (tcls->n_rules - i));
 126     }
 127     tcls->rules[i] = xmemdup(rule, sizeof *rule);
 128     tcls->n_rules++;
 129     return tcls->rules[i];
 130 }
 131
 132 static void
 133 tcls_remove(struct tcls *cls, const struct test_rule *rule)
 134 {
 135     size_t i;
 136
 137     for (i = 0; i < cls->n_rules; i++) {
 138         struct test_rule *pos = cls->rules[i];
 139         if (pos == rule) {
 140             free(pos);
 141             memmove(&cls->rules[i], &cls->rules[i + 1],
 142                     sizeof *cls->rules * (cls->n_rules - i - 1));
 143             cls->n_rules--;
 144             return;
 145         }
 146     }
 147     NOT_REACHED();
 148 }
 149
 150 static uint32_t
 151 read_uint32(const void *p)
 152 {
 153     uint32_t x;
 154     memcpy(&x, p, sizeof x);
 155     return x;
 156 }
 157
 158 static bool
 159 match(const struct cls_rule *wild, const flow_t *fixed)
 160 {
 161     int f_idx;
 162
 163     for (f_idx = 0; f_idx < CLS_N_FIELDS; f_idx++) {
 164         const struct cls_field *f = &cls_fields[f_idx];
 165         void *wild_field = (char *) &wild->flow + f->ofs;
 166         void *fixed_field = (char *) fixed + f->ofs;
 167
 168         if ((wild->wc.wildcards & f->wildcards) == f->wildcards ||
 169             !memcmp(wild_field, fixed_field, f->len)) {
 170             /* Definite match. */
 171             continue;
 172         }
 173
 174         if (wild->wc.wildcards & f->wildcards) {
 175             uint32_t test = read_uint32(wild_field);
 176             uint32_t ip = read_uint32(fixed_field);
 177             int shift = (f_idx == CLS_F_IDX_NW_SRC
 178                          ? OFPFW_NW_SRC_SHIFT : OFPFW_NW_DST_SHIFT);
 179             uint32_t mask = flow_nw_bits_to_mask(wild->wc.wildcards, shift);
 180             if (!((test ^ ip) & mask)) {
 181                 continue;
 182             }
 183         }
 184
 185         return false;
 186     }
 187     return true;
 188 }
 189
 190 static struct cls_rule *
 191 tcls_lookup(const struct tcls *cls, const flow_t *flow, int include)
 192 {
 193     size_t i;
 194
 195     for (i = 0; i < cls->n_rules; i++) {
 196         struct test_rule *pos = cls->rules[i];
 197         uint32_t wildcards = pos->cls_rule.wc.wildcards;
 198         if (include & (wildcards ? CLS_INC_WILD : CLS_INC_EXACT)
 199             && match(&pos->cls_rule, flow)) {
 200             return &pos->cls_rule;
 201         }
 202     }
 203     return NULL;
 204 }
 205
 206 static void
 207 tcls_delete_matches(struct tcls *cls,
 208                     const struct cls_rule *target,
 209                     int include)
 210 {
 211     size_t i;
 212
 213     for (i = 0; i < cls->n_rules; ) {
 214         struct test_rule *pos = cls->rules[i];
 215         uint32_t wildcards = pos->cls_rule.wc.wildcards;
 216         if (include & (wildcards ? CLS_INC_WILD : CLS_INC_EXACT)
 217             && match(target, &pos->cls_rule.flow)) {
 218             tcls_remove(cls, pos);
 219         } else {
 220             i++;
 221         }
 222     }
 223 }
 224 \f
 225 #ifdef WORDS_BIGENDIAN
 226 #define T_HTONL(VALUE) ((uint32_t) (VALUE))
 227 #define T_HTONS(VALUE) ((uint32_t) (VALUE))
 228 #else
 229 #define T_HTONL(VALUE) (((((uint32_t) (VALUE)) & 0x000000ff) << 24) | \
 230                       ((((uint32_t) (VALUE)) & 0x0000ff00) <<  8) | \
 231                       ((((uint32_t) (VALUE)) & 0x00ff0000) >>  8) | \
 232                       ((((uint32_t) (VALUE)) & 0xff000000) >> 24))
 233 #define T_HTONS(VALUE) (((((uint16_t) (VALUE)) & 0xff00) >> 8) |  \
 234                       ((((uint16_t) (VALUE)) & 0x00ff) << 8))
 235 #endif
 236
 237 static uint32_t nw_src_values[] = { T_HTONL(0xc0a80001),
 238                                     T_HTONL(0xc0a04455) };
 239 static uint32_t nw_dst_values[] = { T_HTONL(0xc0a80002),
 240                                     T_HTONL(0xc0a04455) };
 241 static uint32_t tun_id_values[] = { 0, 0xffff0000 };
 242 static uint16_t in_port_values[] = { T_HTONS(1), T_HTONS(OFPP_LOCAL) };
 243 static uint16_t dl_vlan_values[] = { T_HTONS(101), T_HTONS(0) };
 244 static uint8_t dl_vlan_pcp_values[] = { 7, 0 };
 245 static uint16_t dl_type_values[]
 246             = { T_HTONS(ETH_TYPE_IP), T_HTONS(ETH_TYPE_ARP) };
 247 static uint16_t tp_src_values[] = { T_HTONS(49362), T_HTONS(80) };
 248 static uint16_t tp_dst_values[] = { T_HTONS(6667), T_HTONS(22) };
 249 static uint8_t dl_src_values[][6] = { { 0x00, 0x02, 0xe3, 0x0f, 0x80, 0xa4 },
 250                                       { 0x5e, 0x33, 0x7f, 0x5f, 0x1e, 0x99 } };
 251 static uint8_t dl_dst_values[][6] = { { 0x4a, 0x27, 0x71, 0xae, 0x64, 0xc1 },
 252                                       { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } };
 253 static uint8_t nw_proto_values[] = { IP_TYPE_TCP, IP_TYPE_ICMP };
 254 static uint8_t nw_tos_values[] = { 49, 0 };
 255
 256 static void *values[CLS_N_FIELDS][2];
 257
 258 static void
 259 init_values(void)
 260 {
 261     values[CLS_F_IDX_TUN_ID][0] = &tun_id_values[0];
 262     values[CLS_F_IDX_TUN_ID][1] = &tun_id_values[1];
 263
 264     values[CLS_F_IDX_IN_PORT][0] = &in_port_values[0];
 265     values[CLS_F_IDX_IN_PORT][1] = &in_port_values[1];
 266
 267     values[CLS_F_IDX_DL_VLAN][0] = &dl_vlan_values[0];
 268     values[CLS_F_IDX_DL_VLAN][1] = &dl_vlan_values[1];
 269
 270     values[CLS_F_IDX_DL_VLAN_PCP][0] = &dl_vlan_pcp_values[0];
 271     values[CLS_F_IDX_DL_VLAN_PCP][1] = &dl_vlan_pcp_values[1];
 272
 273     values[CLS_F_IDX_DL_SRC][0] = dl_src_values[0];
 274     values[CLS_F_IDX_DL_SRC][1] = dl_src_values[1];
 275
 276     values[CLS_F_IDX_DL_DST][0] = dl_dst_values[0];
 277     values[CLS_F_IDX_DL_DST][1] = dl_dst_values[1];
 278
 279     values[CLS_F_IDX_DL_TYPE][0] = &dl_type_values[0];
 280     values[CLS_F_IDX_DL_TYPE][1] = &dl_type_values[1];
 281
 282     values[CLS_F_IDX_NW_SRC][0] = &nw_src_values[0];
 283     values[CLS_F_IDX_NW_SRC][1] = &nw_src_values[1];
 284
 285     values[CLS_F_IDX_NW_DST][0] = &nw_dst_values[0];
 286     values[CLS_F_IDX_NW_DST][1] = &nw_dst_values[1];
 287
 288     values[CLS_F_IDX_NW_PROTO][0] = &nw_proto_values[0];
 289     values[CLS_F_IDX_NW_PROTO][1] = &nw_proto_values[1];
 290
 291     values[CLS_F_IDX_NW_TOS][0] = &nw_tos_values[0];
 292     values[CLS_F_IDX_NW_TOS][1] = &nw_tos_values[1];
 293
 294     values[CLS_F_IDX_TP_SRC][0] = &tp_src_values[0];
 295     values[CLS_F_IDX_TP_SRC][1] = &tp_src_values[1];
 296
 297     values[CLS_F_IDX_TP_DST][0] = &tp_dst_values[0];
 298     values[CLS_F_IDX_TP_DST][1] = &tp_dst_values[1];
 299 }
 300
 301 #define N_NW_SRC_VALUES ARRAY_SIZE(nw_src_values)
 302 #define N_NW_DST_VALUES ARRAY_SIZE(nw_dst_values)
 303 #define N_TUN_ID_VALUES ARRAY_SIZE(tun_id_values)
 304 #define N_IN_PORT_VALUES ARRAY_SIZE(in_port_values)
 305 #define N_DL_VLAN_VALUES ARRAY_SIZE(dl_vlan_values)
 306 #define N_DL_VLAN_PCP_VALUES ARRAY_SIZE(dl_vlan_pcp_values)
 307 #define N_DL_TYPE_VALUES ARRAY_SIZE(dl_type_values)
 308 #define N_TP_SRC_VALUES ARRAY_SIZE(tp_src_values)
 309 #define N_TP_DST_VALUES ARRAY_SIZE(tp_dst_values)
 310 #define N_DL_SRC_VALUES ARRAY_SIZE(dl_src_values)
 311 #define N_DL_DST_VALUES ARRAY_SIZE(dl_dst_values)
 312 #define N_NW_PROTO_VALUES ARRAY_SIZE(nw_proto_values)
 313 #define N_NW_TOS_VALUES ARRAY_SIZE(nw_tos_values)
 314
 315 #define N_FLOW_VALUES (N_NW_SRC_VALUES *        \
 316                        N_NW_DST_VALUES *        \
 317                        N_TUN_ID_VALUES *        \
 318                        N_IN_PORT_VALUES *       \
 319                        N_DL_VLAN_VALUES *       \
 320                        N_DL_VLAN_PCP_VALUES *   \
 321                        N_DL_TYPE_VALUES *       \
 322                        N_TP_SRC_VALUES *        \
 323                        N_TP_DST_VALUES *        \
 324                        N_DL_SRC_VALUES *        \
 325                        N_DL_DST_VALUES *        \
 326                        N_NW_PROTO_VALUES *      \
 327                        N_NW_TOS_VALUES)
 328
 329 static unsigned int
 330 get_value(unsigned int *x, unsigned n_values)
 331 {
 332     unsigned int rem = *x % n_values;
 333     *x /= n_values;
 334     return rem;
 335 }
 336
 337 static struct cls_rule *
 338 lookup_with_include_bits(const struct classifier *cls,
 339                          const flow_t *flow, int include)
 340 {
 341     switch (include) {
 342     case CLS_INC_WILD:
 343         return classifier_lookup_wild(cls, flow);
 344     case CLS_INC_EXACT:
 345         return classifier_lookup_exact(cls, flow);
 346     case CLS_INC_WILD | CLS_INC_EXACT:
 347         return classifier_lookup(cls, flow);
 348     default:
 349         abort();
 350     }
 351 }
 352
 353 static void
 354 compare_classifiers(struct classifier *cls, struct tcls *tcls)
 355 {
 356     unsigned int i;
 357
 358     assert(classifier_count(cls) == tcls->n_rules);
 359     assert(classifier_count_exact(cls) == tcls_count_exact(tcls));
 360     for (i = 0; i < N_FLOW_VALUES; i++) {
 361         struct cls_rule *cr0, *cr1;
 362         flow_t flow;
 363         unsigned int x;
 364         int include;
 365
 366         x = i;
 367         flow.nw_src = nw_src_values[get_value(&x, N_NW_SRC_VALUES)];
 368         flow.nw_dst = nw_dst_values[get_value(&x, N_NW_DST_VALUES)];
 369         flow.tun_id = tun_id_values[get_value(&x, N_TUN_ID_VALUES)];
 370         flow.in_port = in_port_values[get_value(&x, N_IN_PORT_VALUES)];
 371         flow.dl_vlan = dl_vlan_values[get_value(&x, N_DL_VLAN_VALUES)];
 372         flow.dl_vlan_pcp = dl_vlan_pcp_values[get_value(&x,
 373                 N_DL_VLAN_PCP_VALUES)];
 374         flow.dl_type = dl_type_values[get_value(&x, N_DL_TYPE_VALUES)];
 375         flow.tp_src = tp_src_values[get_value(&x, N_TP_SRC_VALUES)];
 376         flow.tp_dst = tp_dst_values[get_value(&x, N_TP_DST_VALUES)];
 377         memcpy(flow.dl_src, dl_src_values[get_value(&x, N_DL_SRC_VALUES)],
 378                ETH_ADDR_LEN);
 379         memcpy(flow.dl_dst, dl_dst_values[get_value(&x, N_DL_DST_VALUES)],
 380                ETH_ADDR_LEN);
 381         flow.nw_proto = nw_proto_values[get_value(&x, N_NW_PROTO_VALUES)];
 382         flow.nw_tos = nw_tos_values[get_value(&x, N_NW_TOS_VALUES)];
 383         memset(flow.reserved, 0, sizeof flow.reserved);
 384
 385         for (include = 1; include <= 3; include++) {
 386             cr0 = lookup_with_include_bits(cls, &flow, include);
 387             cr1 = tcls_lookup(tcls, &flow, include);
 388             assert((cr0 == NULL) == (cr1 == NULL));
 389             if (cr0 != NULL) {
 390                 const struct test_rule *tr0 = test_rule_from_cls_rule(cr0);
 391                 const struct test_rule *tr1 = test_rule_from_cls_rule(cr1);
 392
 393                 assert(flow_equal(&cr0->flow, &cr1->flow));
 394                 assert(cr0->wc.wildcards == cr1->wc.wildcards);
 395                 assert(cr0->priority == cr1->priority);
 396                 /* Skip nw_src_mask and nw_dst_mask, because they are derived
 397                  * members whose values are used only for optimization. */
 398                 assert(tr0->aux == tr1->aux);
 399             }
 400         }
 401     }
 402 }
 403
 404 static void
 405 free_rule(struct cls_rule *cls_rule, void *cls)
 406 {
 407     classifier_remove(cls, cls_rule);
 408     free(test_rule_from_cls_rule(cls_rule));
 409 }
 410
 411 static void
 412 destroy_classifier(struct classifier *cls)
 413 {
 414     classifier_for_each(cls, CLS_INC_ALL, free_rule, cls);
 415     classifier_destroy(cls);
 416 }
 417
 418 static void
 419 check_tables(const struct classifier *cls,
 420              int n_tables, int n_buckets, int n_rules)
 421 {
 422     int found_tables = 0;
 423     int found_buckets = 0;
 424     int found_rules = 0;
 425     int i;
 426
 427     BUILD_ASSERT(CLS_N_FIELDS == ARRAY_SIZE(cls->tables));
 428     for (i = 0; i < CLS_N_FIELDS; i++) {
 429         const struct cls_bucket *bucket;
 430         if (!hmap_is_empty(&cls->tables[i])) {
 431             found_tables++;
 432         }
 433         HMAP_FOR_EACH (bucket, struct cls_bucket, hmap_node, &cls->tables[i]) {
 434             found_buckets++;
 435             assert(!list_is_empty(&bucket->rules));
 436             found_rules += list_size(&bucket->rules);
 437         }
 438     }
 439
 440     if (!hmap_is_empty(&cls->exact_table)) {
 441         found_tables++;
 442         found_buckets++;
 443         found_rules += hmap_count(&cls->exact_table);
 444     }
 445
 446     assert(n_tables == -1 || found_tables == n_tables);
 447     assert(n_rules == -1 || found_rules == n_rules);
 448     assert(n_buckets == -1 || found_buckets == n_buckets);
 449 }
 450
 451 static struct test_rule *
 452 make_rule(int wc_fields, unsigned int priority, int value_pat)
 453 {
 454     const struct cls_field *f;
 455     struct test_rule *rule;
 456     uint32_t wildcards;
 457     flow_t flow;
 458
 459     wildcards = 0;
 460     memset(&flow, 0, sizeof flow);
 461     for (f = &cls_fields[0]; f < &cls_fields[CLS_N_FIELDS]; f++) {
 462         int f_idx = f - cls_fields;
 463         if (wc_fields & (1u << f_idx)) {
 464             wildcards |= f->wildcards;
 465         } else {
 466             int value_idx = (value_pat & (1u << f_idx)) != 0;
 467             memcpy((char *) &flow + f->ofs, values[f_idx][value_idx], f->len);
 468         }
 469     }
 470
 471     rule = xzalloc(sizeof *rule);
 472     cls_rule_from_flow(&flow, wildcards, !wildcards ? UINT_MAX : priority,
 473                        &rule->cls_rule);
 474     return rule;
 475 }
 476
 477 static void
 478 shuffle(unsigned int *p, size_t n)
 479 {
 480     for (; n > 1; n--, p++) {
 481         unsigned int *q = &p[rand() % n];
 482         unsigned int tmp = *p;
 483         *p = *q;
 484         *q = tmp;
 485     }
 486 }
 487 \f
 488 /* Tests an empty classifier. */
 489 static void
 490 test_empty(void)
 491 {
 492     struct classifier cls;
 493     struct tcls tcls;
 494
 495     classifier_init(&cls);
 496     tcls_init(&tcls);
 497     assert(classifier_is_empty(&cls));
 498     assert(tcls_is_empty(&tcls));
 499     compare_classifiers(&cls, &tcls);
 500     classifier_destroy(&cls);
 501     tcls_destroy(&tcls);
 502 }
 503
 504 /* Destroys a null classifier. */
 505 static void
 506 test_destroy_null(void)
 507 {
 508     classifier_destroy(NULL);
 509 }
 510
 511 /* Tests classification with one rule at a time. */
 512 static void
 513 test_single_rule(void)
 514 {
 515     unsigned int wc_fields;     /* Hilarious. */
 516
 517     for (wc_fields = 0; wc_fields < (1u << CLS_N_FIELDS); wc_fields++) {
 518         struct classifier cls;
 519         struct test_rule *rule, *tcls_rule;
 520         struct tcls tcls;
 521
 522         rule = make_rule(wc_fields,
 523                          hash_bytes(&wc_fields, sizeof wc_fields, 0), 0);
 524
 525         classifier_init(&cls);
 526         tcls_init(&tcls);
 527
 528         tcls_rule = tcls_insert(&tcls, rule);
 529         if (wc_fields) {
 530             assert(!classifier_insert(&cls, &rule->cls_rule));
 531         } else {
 532             classifier_insert_exact(&cls, &rule->cls_rule);
 533         }
 534         check_tables(&cls, 1, 1, 1);
 535         compare_classifiers(&cls, &tcls);
 536
 537         classifier_remove(&cls, &rule->cls_rule);
 538         tcls_remove(&tcls, tcls_rule);
 539         assert(classifier_is_empty(&cls));
 540         assert(tcls_is_empty(&tcls));
 541         compare_classifiers(&cls, &tcls);
 542
 543         free(rule);
 544         classifier_destroy(&cls);
 545         tcls_destroy(&tcls);
 546     }
 547 }
 548
 549 /* Tests replacing one rule by another. */
 550 static void
 551 test_rule_replacement(void)
 552 {
 553     unsigned int wc_fields;
 554
 555     for (wc_fields = 0; wc_fields < (1u << CLS_N_FIELDS); wc_fields++) {
 556         struct classifier cls;
 557         struct test_rule *rule1;
 558         struct test_rule *rule2;
 559         struct tcls tcls;
 560
 561         rule1 = make_rule(wc_fields, OFP_DEFAULT_PRIORITY, UINT_MAX);
 562         rule2 = make_rule(wc_fields, OFP_DEFAULT_PRIORITY, UINT_MAX);
 563         rule2->aux += 5;
 564         rule2->aux += 5;
 565
 566         classifier_init(&cls);
 567         tcls_init(&tcls);
 568         tcls_insert(&tcls, rule1);
 569         assert(!classifier_insert(&cls, &rule1->cls_rule));
 570         check_tables(&cls, 1, 1, 1);
 571         compare_classifiers(&cls, &tcls);
 572         tcls_destroy(&tcls);
 573
 574         tcls_init(&tcls);
 575         tcls_insert(&tcls, rule2);
 576         assert(test_rule_from_cls_rule(
 577                    classifier_insert(&cls, &rule2->cls_rule)) == rule1);
 578         free(rule1);
 579         check_tables(&cls, 1, 1, 1);
 580         compare_classifiers(&cls, &tcls);
 581         tcls_destroy(&tcls);
 582         destroy_classifier(&cls);
 583     }
 584 }
 585
 586 static int
 587 table_mask(int table)
 588 {
 589     return ((1u << CLS_N_FIELDS) - 1) & ~((1u << table) - 1);
 590 }
 591
 592 static int
 593 random_wcf_in_table(int table, int seed)
 594 {
 595     int wc_fields = (1u << table) | hash_int(seed, 0);
 596     return wc_fields & table_mask(table);
 597 }
 598
 599 /* Tests classification with two rules at a time that fall into the same
 600  * bucket. */
 601 static void
 602 test_two_rules_in_one_bucket(void)
 603 {
 604     int table, rel_pri, wcf_pat, value_pat;
 605
 606     for (table = 0; table <= CLS_N_FIELDS; table++) {
 607         for (rel_pri = -1; rel_pri <= +1; rel_pri++) {
 608             for (wcf_pat = 0; wcf_pat < 4; wcf_pat++) {
 609                 int n_value_pats = table == CLS_N_FIELDS - 1 ? 1 : 2;
 610                 for (value_pat = 0; value_pat < n_value_pats; value_pat++) {
 611                     struct test_rule *rule1, *tcls_rule1;
 612                     struct test_rule *rule2, *tcls_rule2;
 613                     struct test_rule *displaced_rule;
 614                     struct classifier cls;
 615                     struct tcls tcls;
 616                     unsigned int pri1, pri2;
 617                     int wcf1, wcf2;
 618
 619                     if (table != CLS_F_IDX_EXACT) {
 620                         /* We can use identical priorities in this test because
 621                          * the classifier always chooses the rule added later
 622                          * for equal-priority rules that fall into the same
 623                          * bucket.  */
 624                         pri1 = table * 257 + 50;
 625                         pri2 = pri1 + rel_pri;
 626
 627                         wcf1 = (wcf_pat & 1
 628                                 ? random_wcf_in_table(table, pri1)
 629                                 : 1u << table);
 630                         wcf2 = (wcf_pat & 2
 631                                 ? random_wcf_in_table(table, pri2)
 632                                 : 1u << table);
 633                         if (value_pat) {
 634                             wcf1 &= ~(1u << (CLS_N_FIELDS - 1));
 635                             wcf2 &= ~(1u << (CLS_N_FIELDS - 1));
 636                         }
 637                     } else {
 638                         /* This classifier always puts exact-match rules at
 639                          * maximum priority.  */
 640                         pri1 = pri2 = UINT_MAX;
 641
 642                         /* No wildcard fields. */
 643                         wcf1 = wcf2 = 0;
 644                     }
 645
 646                     rule1 = make_rule(wcf1, pri1, 0);
 647                     rule2 = make_rule(wcf2, pri2,
 648                                       value_pat << (CLS_N_FIELDS - 1));
 649
 650                     classifier_init(&cls);
 651                     tcls_init(&tcls);
 652
 653                     tcls_rule1 = tcls_insert(&tcls, rule1);
 654                     tcls_rule2 = tcls_insert(&tcls, rule2);
 655                     assert(!classifier_insert(&cls, &rule1->cls_rule));
 656                     displaced_rule = test_rule_from_cls_rule(
 657                         classifier_insert(&cls, &rule2->cls_rule));
 658                     if (wcf1 != wcf2 || pri1 != pri2 || value_pat) {
 659                         assert(!displaced_rule);
 660
 661                         check_tables(&cls, 1, 1, 2);
 662                         compare_classifiers(&cls, &tcls);
 663
 664                         classifier_remove(&cls, &rule1->cls_rule);
 665                         tcls_remove(&tcls, tcls_rule1);
 666                         check_tables(&cls, 1, 1, 1);
 667                         compare_classifiers(&cls, &tcls);
 668                     } else {
 669                         assert(displaced_rule == rule1);
 670                         check_tables(&cls, 1, 1, 1);
 671                         compare_classifiers(&cls, &tcls);
 672                     }
 673                     free(rule1);
 674
 675                     classifier_remove(&cls, &rule2->cls_rule);
 676                     tcls_remove(&tcls, tcls_rule2);
 677                     compare_classifiers(&cls, &tcls);
 678                     free(rule2);
 679
 680                     destroy_classifier(&cls);
 681                     tcls_destroy(&tcls);
 682                 }
 683             }
 684         }
 685     }
 686 }
 687
 688 /* Tests classification with two rules at a time that fall into the same
 689  * table but different buckets. */
 690 static void
 691 test_two_rules_in_one_table(void)
 692 {
 693     int table, rel_pri, wcf_pat;
 694
 695     /* Skip tables 0 and CLS_F_IDX_EXACT because they have one bucket. */
 696     for (table = 1; table < CLS_N_FIELDS; table++) {
 697         for (rel_pri = -1; rel_pri <= +1; rel_pri++) {
 698             for (wcf_pat = 0; wcf_pat < 5; wcf_pat++) {
 699                 struct test_rule *rule1, *tcls_rule1;
 700                 struct test_rule *rule2, *tcls_rule2;
 701                 struct classifier cls;
 702                 struct tcls tcls;
 703                 unsigned int pri1, pri2;
 704                 int wcf1, wcf2;
 705                 int value_mask, value_pat1, value_pat2;
 706                 int i;
 707
 708                 /* We can use identical priorities in this test because the
 709                  * classifier always chooses the rule added later for
 710                  * equal-priority rules that fall into the same table.  */
 711                 pri1 = table * 257 + 50;
 712                 pri2 = pri1 + rel_pri;
 713
 714                 if (wcf_pat & 4) {
 715                     wcf1 = wcf2 = random_wcf_in_table(table, pri1);
 716                 } else {
 717                     wcf1 = (wcf_pat & 1
 718                             ? random_wcf_in_table(table, pri1)
 719                             : 1u << table);
 720                     wcf2 = (wcf_pat & 2
 721                             ? random_wcf_in_table(table, pri2)
 722                             : 1u << table);
 723                 }
 724
 725                 /* Generate value patterns that will put the two rules into
 726                  * different buckets. */
 727                 value_mask = ((1u << table) - 1);
 728                 value_pat1 = hash_int(pri1, 1) & value_mask;
 729                 i = 0;
 730                 do {
 731                     value_pat2 = (hash_int(pri2, i++) & value_mask);
 732                 } while (value_pat1 == value_pat2);
 733                 rule1 = make_rule(wcf1, pri1, value_pat1);
 734                 rule2 = make_rule(wcf2, pri2, value_pat2);
 735
 736                 classifier_init(&cls);
 737                 tcls_init(&tcls);
 738
 739                 tcls_rule1 = tcls_insert(&tcls, rule1);
 740                 tcls_rule2 = tcls_insert(&tcls, rule2);
 741                 assert(!classifier_insert(&cls, &rule1->cls_rule));
 742                 assert(!classifier_insert(&cls, &rule2->cls_rule));
 743                 check_tables(&cls, 1, 2, 2);
 744                 compare_classifiers(&cls, &tcls);
 745
 746                 classifier_remove(&cls, &rule1->cls_rule);
 747                 tcls_remove(&tcls, tcls_rule1);
 748                 check_tables(&cls, 1, 1, 1);
 749                 compare_classifiers(&cls, &tcls);
 750                 free(rule1);
 751
 752                 classifier_remove(&cls, &rule2->cls_rule);
 753                 tcls_remove(&tcls, tcls_rule2);
 754                 compare_classifiers(&cls, &tcls);
 755                 free(rule2);
 756
 757                 classifier_destroy(&cls);
 758                 tcls_destroy(&tcls);
 759             }
 760         }
 761     }
 762 }
 763
 764 /* Tests classification with two rules at a time that fall into different
 765  * tables. */
 766 static void
 767 test_two_rules_in_different_tables(void)
 768 {
 769     int table1, table2, rel_pri, wcf_pat;
 770
 771     for (table1 = 0; table1 < CLS_N_FIELDS; table1++) {
 772         for (table2 = table1 + 1; table2 <= CLS_N_FIELDS; table2++) {
 773             for (rel_pri = 0; rel_pri < 2; rel_pri++) {
 774                 for (wcf_pat = 0; wcf_pat < 4; wcf_pat++) {
 775                     struct test_rule *rule1, *tcls_rule1;
 776                     struct test_rule *rule2, *tcls_rule2;
 777                     struct classifier cls;
 778                     struct tcls tcls;
 779                     unsigned int pri1, pri2;
 780                     int wcf1, wcf2;
 781
 782                     /* We must use unique priorities in this test because the
 783                      * classifier makes the rule choice undefined for rules of
 784                      * equal priority that fall into different tables.  (In
 785                      * practice, lower-numbered tables win.)  */
 786                     pri1 = table1 * 257 + 50;
 787                     pri2 = rel_pri ? pri1 - 1 : pri1 + 1;
 788
 789                     wcf1 = (wcf_pat & 1
 790                             ? random_wcf_in_table(table1, pri1)
 791                             : 1u << table1);
 792                     wcf2 = (wcf_pat & 2
 793                             ? random_wcf_in_table(table2, pri2)
 794                             : 1u << table2);
 795
 796                     if (table2 == CLS_F_IDX_EXACT) {
 797                         pri2 = UINT16_MAX;
 798                         wcf2 = 0;
 799                     }
 800
 801                     rule1 = make_rule(wcf1, pri1, 0);
 802                     rule2 = make_rule(wcf2, pri2, 0);
 803
 804                     classifier_init(&cls);
 805                     tcls_init(&tcls);
 806
 807                     tcls_rule1 = tcls_insert(&tcls, rule1);
 808                     tcls_rule2 = tcls_insert(&tcls, rule2);
 809                     assert(!classifier_insert(&cls, &rule1->cls_rule));
 810                     assert(!classifier_insert(&cls, &rule2->cls_rule));
 811                     check_tables(&cls, 2, 2, 2);
 812                     compare_classifiers(&cls, &tcls);
 813
 814                     classifier_remove(&cls, &rule1->cls_rule);
 815                     tcls_remove(&tcls, tcls_rule1);
 816                     check_tables(&cls, 1, 1, 1);
 817                     compare_classifiers(&cls, &tcls);
 818                     free(rule1);
 819
 820                     classifier_remove(&cls, &rule2->cls_rule);
 821                     tcls_remove(&tcls, tcls_rule2);
 822                     compare_classifiers(&cls, &tcls);
 823                     free(rule2);
 824
 825                     classifier_destroy(&cls);
 826                     tcls_destroy(&tcls);
 827                 }
 828             }
 829         }
 830     }
 831 }
 832
 833 /* Tests classification with many rules at a time that fall into the same
 834  * bucket but have unique priorities (and various wildcards). */
 835 static void
 836 test_many_rules_in_one_bucket(void)
 837 {
 838     enum { MAX_RULES = 50 };
 839     int iteration, table;
 840
 841     for (iteration = 0; iteration < 3; iteration++) {
 842         for (table = 0; table <= CLS_N_FIELDS; table++) {
 843             unsigned int priorities[MAX_RULES];
 844             struct classifier cls;
 845             struct tcls tcls;
 846             int i;
 847
 848             srand(hash_int(table, iteration));
 849             for (i = 0; i < MAX_RULES; i++) {
 850                 priorities[i] = i * 129;
 851             }
 852             shuffle(priorities, ARRAY_SIZE(priorities));
 853
 854             classifier_init(&cls);
 855             tcls_init(&tcls);
 856
 857             for (i = 0; i < MAX_RULES; i++) {
 858                 struct test_rule *rule;
 859                 unsigned int priority = priorities[i];
 860                 int wcf;
 861
 862                 wcf = random_wcf_in_table(table, priority);
 863                 rule = make_rule(wcf, priority,
 864                                  table == CLS_F_IDX_EXACT ? i : 1234);
 865                 tcls_insert(&tcls, rule);
 866                 assert(!classifier_insert(&cls, &rule->cls_rule));
 867                 check_tables(&cls, 1, 1, i + 1);
 868                 compare_classifiers(&cls, &tcls);
 869             }
 870
 871             destroy_classifier(&cls);
 872             tcls_destroy(&tcls);
 873         }
 874     }
 875 }
 876
 877 /* Tests classification with many rules at a time that fall into the same
 878  * table but random buckets. */
 879 static void
 880 test_many_rules_in_one_table(void)
 881 {
 882     enum { MAX_RULES = 50 };
 883     int iteration, table;
 884
 885     for (iteration = 0; iteration < 3; iteration++) {
 886         for (table = 0; table < CLS_N_FIELDS; table++) {
 887             unsigned int priorities[MAX_RULES];
 888             struct classifier cls;
 889             struct tcls tcls;
 890             int i;
 891
 892             srand(hash_int(table, iteration));
 893             for (i = 0; i < MAX_RULES; i++) {
 894                 priorities[i] = i * 129;
 895             }
 896             shuffle(priorities, ARRAY_SIZE(priorities));
 897
 898             classifier_init(&cls);
 899             tcls_init(&tcls);
 900
 901             for (i = 0; i < MAX_RULES; i++) {
 902                 struct test_rule *rule;
 903                 unsigned int priority = priorities[i];
 904                 int wcf;
 905
 906                 wcf = random_wcf_in_table(table, priority);
 907                 rule = make_rule(wcf, priority, hash_int(priority, 1));
 908                 tcls_insert(&tcls, rule);
 909                 assert(!classifier_insert(&cls, &rule->cls_rule));
 910                 check_tables(&cls, 1, -1, i + 1);
 911                 compare_classifiers(&cls, &tcls);
 912             }
 913
 914             destroy_classifier(&cls);
 915             tcls_destroy(&tcls);
 916         }
 917     }
 918 }
 919
 920 /* Tests classification with many rules at a time that fall into random buckets
 921  * in random tables. */
 922 static void
 923 test_many_rules_in_different_tables(void)
 924 {
 925     enum { MAX_RULES = 50 };
 926     int iteration;
 927
 928     for (iteration = 0; iteration < 30; iteration++) {
 929         unsigned int priorities[MAX_RULES];
 930         struct classifier cls;
 931         struct tcls tcls;
 932         int i;
 933
 934         srand(iteration);
 935         for (i = 0; i < MAX_RULES; i++) {
 936             priorities[i] = i * 129;
 937         }
 938         shuffle(priorities, ARRAY_SIZE(priorities));
 939
 940         classifier_init(&cls);
 941         tcls_init(&tcls);
 942
 943         for (i = 0; i < MAX_RULES; i++) {
 944             struct test_rule *rule;
 945             unsigned int priority = priorities[i];
 946             int table = rand() % (CLS_N_FIELDS + 1);
 947             int wcf = random_wcf_in_table(table, rand());
 948             int value_pat = rand() & ((1u << CLS_N_FIELDS) - 1);
 949             rule = make_rule(wcf, priority, value_pat);
 950             tcls_insert(&tcls, rule);
 951             assert(!classifier_insert(&cls, &rule->cls_rule));
 952             check_tables(&cls, -1, -1, i + 1);
 953             compare_classifiers(&cls, &tcls);
 954         }
 955
 956         while (!classifier_is_empty(&cls)) {
 957             struct test_rule *rule = xmemdup(tcls.rules[rand() % tcls.n_rules],
 958                                              sizeof(struct test_rule));
 959             int include = rand() % 2 ? CLS_INC_WILD : CLS_INC_EXACT;
 960             include |= (rule->cls_rule.wc.wildcards
 961                         ? CLS_INC_WILD : CLS_INC_EXACT);
 962             classifier_for_each_match(&cls, &rule->cls_rule, include,
 963                                       free_rule, &cls);
 964             tcls_delete_matches(&tcls, &rule->cls_rule, include);
 965             compare_classifiers(&cls, &tcls);
 966             free(rule);
 967         }
 968         putchar('.');
 969         fflush(stdout);
 970
 971         destroy_classifier(&cls);
 972         tcls_destroy(&tcls);
 973     }
 974 }
 975 \f
 976 static void
 977 run_test(void (*function)(void))
 978 {
 979     function();
 980     putchar('.');
 981     fflush(stdout);
 982 }
 983
 984 int
 985 main(void)
 986 {
 987     init_values();
 988     run_test(test_empty);
 989     run_test(test_destroy_null);
 990     run_test(test_single_rule);
 991     run_test(test_rule_replacement);
 992     run_test(test_two_rules_in_one_bucket);
 993     run_test(test_two_rules_in_one_table);
 994     run_test(test_two_rules_in_different_tables);
 995     run_test(test_many_rules_in_one_bucket);
 996     run_test(test_many_rules_in_one_table);
 997     run_test(test_many_rules_in_different_tables);
 998     putchar('\n');
 999     return 0;
1000 }