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 "classifier.h"
  30 #include <errno.h>
  31 #include <limits.h>
  32 #include "byte-order.h"
  33 #include "command-line.h"
  34 #include "flow.h"
  35 #include "packets.h"
  36 #include "unaligned.h"
  37
  38 #undef NDEBUG
  39 #include <assert.h>
  40
  41 /* Fields in a rule. */
  42 #define CLS_FIELDS                                          \
  43     /*                           struct flow  all-caps */   \
  44     /*        wildcard bit(s)    member name  name     */   \
  45     /*        -----------------  -----------  -------- */   \
  46     CLS_FIELD(NXFW_TUN_ID,       tun_id,      TUN_ID)       \
  47     CLS_FIELD(OFPFW_NW_SRC_MASK, nw_src,      NW_SRC)       \
  48     CLS_FIELD(OFPFW_NW_DST_MASK, nw_dst,      NW_DST)       \
  49     CLS_FIELD(OFPFW_IN_PORT,     in_port,     IN_PORT)      \
  50     CLS_FIELD(OFPFW_DL_VLAN,     dl_vlan,     DL_VLAN)      \
  51     CLS_FIELD(OFPFW_DL_TYPE,     dl_type,     DL_TYPE)      \
  52     CLS_FIELD(OFPFW_TP_SRC,      tp_src,      TP_SRC)       \
  53     CLS_FIELD(OFPFW_TP_DST,      tp_dst,      TP_DST)       \
  54     CLS_FIELD(OFPFW_DL_SRC,      dl_src,      DL_SRC)       \
  55     CLS_FIELD(OFPFW_DL_DST | FWW_ETH_MCAST,                 \
  56                                  dl_dst,      DL_DST)       \
  57     CLS_FIELD(OFPFW_NW_PROTO,    nw_proto,    NW_PROTO)     \
  58     CLS_FIELD(OFPFW_DL_VLAN_PCP, dl_vlan_pcp, DL_VLAN_PCP)  \
  59     CLS_FIELD(OFPFW_NW_TOS,      nw_tos,      NW_TOS)
  60
  61 /* Field indexes.
  62  *
  63  * (These are also indexed into struct classifier's 'tables' array.) */
  64 enum {
  65 #define CLS_FIELD(WILDCARDS, MEMBER, NAME) CLS_F_IDX_##NAME,
  66     CLS_FIELDS
  67 #undef CLS_FIELD
  68     CLS_N_FIELDS
  69 };
  70
  71 /* Field information. */
  72 struct cls_field {
  73     int ofs;                    /* Offset in struct flow. */
  74     int len;                    /* Length in bytes. */
  75     uint32_t wildcards;         /* OFPFW_* bit or bits for this field. */
  76     const char *name;           /* Name (for debugging). */
  77 };
  78
  79 static const struct cls_field cls_fields[CLS_N_FIELDS] = {
  80 #define CLS_FIELD(WILDCARDS, MEMBER, NAME)      \
  81     { offsetof(struct flow, MEMBER),            \
  82       sizeof ((struct flow *)0)->MEMBER,        \
  83       WILDCARDS,                                \
  84       #NAME },
  85     CLS_FIELDS
  86 #undef CLS_FIELD
  87 };
  88
  89 struct test_rule {
  90     int aux;                    /* Auxiliary data. */
  91     struct cls_rule cls_rule;   /* Classifier rule data. */
  92 };
  93
  94 static struct test_rule *
  95 test_rule_from_cls_rule(const struct cls_rule *rule)
  96 {
  97     return rule ? CONTAINER_OF(rule, struct test_rule, cls_rule) : NULL;
  98 }
  99
 100 /* Trivial (linear) classifier. */
 101 struct tcls {
 102     size_t n_rules;
 103     size_t allocated_rules;
 104     struct test_rule **rules;
 105 };
 106
 107 static void
 108 tcls_init(struct tcls *tcls)
 109 {
 110     tcls->n_rules = 0;
 111     tcls->allocated_rules = 0;
 112     tcls->rules = NULL;
 113 }
 114
 115 static void
 116 tcls_destroy(struct tcls *tcls)
 117 {
 118     if (tcls) {
 119         size_t i;
 120
 121         for (i = 0; i < tcls->n_rules; i++) {
 122             free(tcls->rules[i]);
 123         }
 124         free(tcls->rules);
 125     }
 126 }
 127
 128 static bool
 129 tcls_is_empty(const struct tcls *tcls)
 130 {
 131     return tcls->n_rules == 0;
 132 }
 133
 134 static struct test_rule *
 135 tcls_insert(struct tcls *tcls, const struct test_rule *rule)
 136 {
 137     size_t i;
 138
 139     assert(rule->cls_rule.wc.wildcards || rule->cls_rule.priority == UINT_MAX);
 140     for (i = 0; i < tcls->n_rules; i++) {
 141         const struct cls_rule *pos = &tcls->rules[i]->cls_rule;
 142         if (pos->priority == rule->cls_rule.priority
 143             && pos->wc.wildcards == rule->cls_rule.wc.wildcards
 144             && flow_equal(&pos->flow, &rule->cls_rule.flow)) {
 145             /* Exact match.
 146              * XXX flow_equal should ignore wildcarded fields */
 147             free(tcls->rules[i]);
 148             tcls->rules[i] = xmemdup(rule, sizeof *rule);
 149             return tcls->rules[i];
 150         } else if (pos->priority < rule->cls_rule.priority) {
 151             break;
 152         }
 153     }
 154
 155     if (tcls->n_rules >= tcls->allocated_rules) {
 156         tcls->rules = x2nrealloc(tcls->rules, &tcls->allocated_rules,
 157                                  sizeof *tcls->rules);
 158     }
 159     if (i != tcls->n_rules) {
 160         memmove(&tcls->rules[i + 1], &tcls->rules[i],
 161                 sizeof *tcls->rules * (tcls->n_rules - i));
 162     }
 163     tcls->rules[i] = xmemdup(rule, sizeof *rule);
 164     tcls->n_rules++;
 165     return tcls->rules[i];
 166 }
 167
 168 static void
 169 tcls_remove(struct tcls *cls, const struct test_rule *rule)
 170 {
 171     size_t i;
 172
 173     for (i = 0; i < cls->n_rules; i++) {
 174         struct test_rule *pos = cls->rules[i];
 175         if (pos == rule) {
 176             free(pos);
 177             memmove(&cls->rules[i], &cls->rules[i + 1],
 178                     sizeof *cls->rules * (cls->n_rules - i - 1));
 179             cls->n_rules--;
 180             return;
 181         }
 182     }
 183     NOT_REACHED();
 184 }
 185
 186 static bool
 187 match(const struct cls_rule *wild, const struct flow *fixed)
 188 {
 189     int f_idx;
 190
 191     for (f_idx = 0; f_idx < CLS_N_FIELDS; f_idx++) {
 192         const struct cls_field *f = &cls_fields[f_idx];
 193         void *wild_field = (char *) &wild->flow + f->ofs;
 194         void *fixed_field = (char *) fixed + f->ofs;
 195
 196         if ((wild->wc.wildcards & f->wildcards) == f->wildcards ||
 197             !memcmp(wild_field, fixed_field, f->len)) {
 198             /* Definite match. */
 199             continue;
 200         }
 201
 202         if (wild->wc.wildcards & f->wildcards) {
 203             uint32_t test = get_unaligned_u32(wild_field);
 204             uint32_t ip = get_unaligned_u32(fixed_field);
 205             int shift = (f_idx == CLS_F_IDX_NW_SRC
 206                          ? OFPFW_NW_SRC_SHIFT : OFPFW_NW_DST_SHIFT);
 207             uint32_t mask = flow_nw_bits_to_mask(wild->wc.wildcards, shift);
 208             if (!((test ^ ip) & mask)) {
 209                 continue;
 210             }
 211         }
 212
 213         return false;
 214     }
 215     return true;
 216 }
 217
 218 static struct cls_rule *
 219 tcls_lookup(const struct tcls *cls, const struct flow *flow)
 220 {
 221     size_t i;
 222
 223     for (i = 0; i < cls->n_rules; i++) {
 224         struct test_rule *pos = cls->rules[i];
 225         if (match(&pos->cls_rule, flow)) {
 226             return &pos->cls_rule;
 227         }
 228     }
 229     return NULL;
 230 }
 231
 232 static void
 233 tcls_delete_matches(struct tcls *cls, const struct cls_rule *target)
 234 {
 235     size_t i;
 236
 237     for (i = 0; i < cls->n_rules; ) {
 238         struct test_rule *pos = cls->rules[i];
 239         if (!flow_wildcards_has_extra(&pos->cls_rule.wc, &target->wc)
 240             && match(target, &pos->cls_rule.flow)) {
 241             tcls_remove(cls, pos);
 242         } else {
 243             i++;
 244         }
 245     }
 246 }
 247 \f
 248 static ovs_be32 nw_src_values[] = { CONSTANT_HTONL(0xc0a80001),
 249                                     CONSTANT_HTONL(0xc0a04455) };
 250 static ovs_be32 nw_dst_values[] = { CONSTANT_HTONL(0xc0a80002),
 251                                     CONSTANT_HTONL(0xc0a04455) };
 252 static ovs_be32 tun_id_values[] = { 0, 0xffff0000 };
 253 static uint16_t in_port_values[] = { 1, ODPP_LOCAL };
 254 static ovs_be16 dl_vlan_values[] = { CONSTANT_HTONS(101), CONSTANT_HTONS(0) };
 255 static uint8_t dl_vlan_pcp_values[] = { 7, 0 };
 256 static ovs_be16 dl_type_values[]
 257             = { CONSTANT_HTONS(ETH_TYPE_IP), CONSTANT_HTONS(ETH_TYPE_ARP) };
 258 static ovs_be16 tp_src_values[] = { CONSTANT_HTONS(49362),
 259                                     CONSTANT_HTONS(80) };
 260 static ovs_be16 tp_dst_values[] = { CONSTANT_HTONS(6667), CONSTANT_HTONS(22) };
 261 static uint8_t dl_src_values[][6] = { { 0x00, 0x02, 0xe3, 0x0f, 0x80, 0xa4 },
 262                                       { 0x5e, 0x33, 0x7f, 0x5f, 0x1e, 0x99 } };
 263 static uint8_t dl_dst_values[][6] = { { 0x4a, 0x27, 0x71, 0xae, 0x64, 0xc1 },
 264                                       { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } };
 265 static uint8_t nw_proto_values[] = { IP_TYPE_TCP, IP_TYPE_ICMP };
 266 static uint8_t nw_tos_values[] = { 49, 0 };
 267
 268 static void *values[CLS_N_FIELDS][2];
 269
 270 static void
 271 init_values(void)
 272 {
 273     values[CLS_F_IDX_TUN_ID][0] = &tun_id_values[0];
 274     values[CLS_F_IDX_TUN_ID][1] = &tun_id_values[1];
 275
 276     values[CLS_F_IDX_IN_PORT][0] = &in_port_values[0];
 277     values[CLS_F_IDX_IN_PORT][1] = &in_port_values[1];
 278
 279     values[CLS_F_IDX_DL_VLAN][0] = &dl_vlan_values[0];
 280     values[CLS_F_IDX_DL_VLAN][1] = &dl_vlan_values[1];
 281
 282     values[CLS_F_IDX_DL_VLAN_PCP][0] = &dl_vlan_pcp_values[0];
 283     values[CLS_F_IDX_DL_VLAN_PCP][1] = &dl_vlan_pcp_values[1];
 284
 285     values[CLS_F_IDX_DL_SRC][0] = dl_src_values[0];
 286     values[CLS_F_IDX_DL_SRC][1] = dl_src_values[1];
 287
 288     values[CLS_F_IDX_DL_DST][0] = dl_dst_values[0];
 289     values[CLS_F_IDX_DL_DST][1] = dl_dst_values[1];
 290
 291     values[CLS_F_IDX_DL_TYPE][0] = &dl_type_values[0];
 292     values[CLS_F_IDX_DL_TYPE][1] = &dl_type_values[1];
 293
 294     values[CLS_F_IDX_NW_SRC][0] = &nw_src_values[0];
 295     values[CLS_F_IDX_NW_SRC][1] = &nw_src_values[1];
 296
 297     values[CLS_F_IDX_NW_DST][0] = &nw_dst_values[0];
 298     values[CLS_F_IDX_NW_DST][1] = &nw_dst_values[1];
 299
 300     values[CLS_F_IDX_NW_PROTO][0] = &nw_proto_values[0];
 301     values[CLS_F_IDX_NW_PROTO][1] = &nw_proto_values[1];
 302
 303     values[CLS_F_IDX_NW_TOS][0] = &nw_tos_values[0];
 304     values[CLS_F_IDX_NW_TOS][1] = &nw_tos_values[1];
 305
 306     values[CLS_F_IDX_TP_SRC][0] = &tp_src_values[0];
 307     values[CLS_F_IDX_TP_SRC][1] = &tp_src_values[1];
 308
 309     values[CLS_F_IDX_TP_DST][0] = &tp_dst_values[0];
 310     values[CLS_F_IDX_TP_DST][1] = &tp_dst_values[1];
 311 }
 312
 313 #define N_NW_SRC_VALUES ARRAY_SIZE(nw_src_values)
 314 #define N_NW_DST_VALUES ARRAY_SIZE(nw_dst_values)
 315 #define N_TUN_ID_VALUES ARRAY_SIZE(tun_id_values)
 316 #define N_IN_PORT_VALUES ARRAY_SIZE(in_port_values)
 317 #define N_DL_VLAN_VALUES ARRAY_SIZE(dl_vlan_values)
 318 #define N_DL_VLAN_PCP_VALUES ARRAY_SIZE(dl_vlan_pcp_values)
 319 #define N_DL_TYPE_VALUES ARRAY_SIZE(dl_type_values)
 320 #define N_TP_SRC_VALUES ARRAY_SIZE(tp_src_values)
 321 #define N_TP_DST_VALUES ARRAY_SIZE(tp_dst_values)
 322 #define N_DL_SRC_VALUES ARRAY_SIZE(dl_src_values)
 323 #define N_DL_DST_VALUES ARRAY_SIZE(dl_dst_values)
 324 #define N_NW_PROTO_VALUES ARRAY_SIZE(nw_proto_values)
 325 #define N_NW_TOS_VALUES ARRAY_SIZE(nw_tos_values)
 326
 327 #define N_FLOW_VALUES (N_NW_SRC_VALUES *        \
 328                        N_NW_DST_VALUES *        \
 329                        N_TUN_ID_VALUES *        \
 330                        N_IN_PORT_VALUES *       \
 331                        N_DL_VLAN_VALUES *       \
 332                        N_DL_VLAN_PCP_VALUES *   \
 333                        N_DL_TYPE_VALUES *       \
 334                        N_TP_SRC_VALUES *        \
 335                        N_TP_DST_VALUES *        \
 336                        N_DL_SRC_VALUES *        \
 337                        N_DL_DST_VALUES *        \
 338                        N_NW_PROTO_VALUES *      \
 339                        N_NW_TOS_VALUES)
 340
 341 static unsigned int
 342 get_value(unsigned int *x, unsigned n_values)
 343 {
 344     unsigned int rem = *x % n_values;
 345     *x /= n_values;
 346     return rem;
 347 }
 348
 349 static void
 350 compare_classifiers(struct classifier *cls, struct tcls *tcls)
 351 {
 352     static const int confidence = 500;
 353     unsigned int i;
 354
 355     assert(classifier_count(cls) == tcls->n_rules);
 356     for (i = 0; i < confidence; i++) {
 357         struct cls_rule *cr0, *cr1;
 358         struct flow flow;
 359         unsigned int x;
 360
 361         x = rand () % N_FLOW_VALUES;
 362         flow.nw_src = nw_src_values[get_value(&x, N_NW_SRC_VALUES)];
 363         flow.nw_dst = nw_dst_values[get_value(&x, N_NW_DST_VALUES)];
 364         flow.tun_id = tun_id_values[get_value(&x, N_TUN_ID_VALUES)];
 365         flow.in_port = in_port_values[get_value(&x, N_IN_PORT_VALUES)];
 366         flow.dl_vlan = dl_vlan_values[get_value(&x, N_DL_VLAN_VALUES)];
 367         flow.dl_vlan_pcp = dl_vlan_pcp_values[get_value(&x,
 368                 N_DL_VLAN_PCP_VALUES)];
 369         flow.dl_type = dl_type_values[get_value(&x, N_DL_TYPE_VALUES)];
 370         flow.tp_src = tp_src_values[get_value(&x, N_TP_SRC_VALUES)];
 371         flow.tp_dst = tp_dst_values[get_value(&x, N_TP_DST_VALUES)];
 372         memcpy(flow.dl_src, dl_src_values[get_value(&x, N_DL_SRC_VALUES)],
 373                ETH_ADDR_LEN);
 374         memcpy(flow.dl_dst, dl_dst_values[get_value(&x, N_DL_DST_VALUES)],
 375                ETH_ADDR_LEN);
 376         flow.nw_proto = nw_proto_values[get_value(&x, N_NW_PROTO_VALUES)];
 377         flow.nw_tos = nw_tos_values[get_value(&x, N_NW_TOS_VALUES)];
 378
 379         cr0 = classifier_lookup(cls, &flow);
 380         cr1 = tcls_lookup(tcls, &flow);
 381         assert((cr0 == NULL) == (cr1 == NULL));
 382         if (cr0 != NULL) {
 383             const struct test_rule *tr0 = test_rule_from_cls_rule(cr0);
 384             const struct test_rule *tr1 = test_rule_from_cls_rule(cr1);
 385
 386             assert(flow_equal(&cr0->flow, &cr1->flow));
 387             assert(cr0->wc.wildcards == cr1->wc.wildcards);
 388             assert(cr0->priority == cr1->priority);
 389             /* Skip nw_src_mask and nw_dst_mask, because they are derived
 390              * members whose values are used only for optimization. */
 391             assert(tr0->aux == tr1->aux);
 392         }
 393     }
 394 }
 395
 396 static void
 397 destroy_classifier(struct classifier *cls)
 398 {
 399     struct test_rule *rule, *next_rule;
 400     struct cls_cursor cursor;
 401
 402     cls_cursor_init(&cursor, cls, NULL);
 403     CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cls_rule, &cursor) {
 404         classifier_remove(cls, &rule->cls_rule);
 405         free(rule);
 406     }
 407     classifier_destroy(cls);
 408 }
 409
 410 static void
 411 check_tables(const struct classifier *cls,
 412              int n_tables, int n_rules, int n_dups)
 413 {
 414     const struct cls_table *table;
 415     struct flow_wildcards exact_wc;
 416     struct test_rule *test_rule;
 417     struct cls_cursor cursor;
 418     int found_tables = 0;
 419     int found_rules = 0;
 420     int found_dups = 0;
 421     int found_rules2 = 0;
 422
 423     flow_wildcards_init_exact(&exact_wc);
 424     HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
 425         const struct cls_rule *head;
 426
 427         assert(!hmap_is_empty(&table->rules));
 428
 429         found_tables++;
 430         HMAP_FOR_EACH (head, hmap_node, &table->rules) {
 431             unsigned int prev_priority = UINT_MAX;
 432             const struct cls_rule *rule;
 433
 434             found_rules++;
 435             LIST_FOR_EACH (rule, list, &head->list) {
 436                 assert(rule->priority < prev_priority);
 437                 prev_priority = rule->priority;
 438                 found_rules++;
 439                 found_dups++;
 440                 assert(classifier_find_rule_exactly(cls, rule) == rule);
 441             }
 442         }
 443     }
 444
 445     assert(found_tables == hmap_count(&cls->tables));
 446     assert(n_tables == -1 || n_tables == hmap_count(&cls->tables));
 447     assert(n_rules == -1 || found_rules == n_rules);
 448     assert(n_dups == -1 || found_dups == n_dups);
 449
 450     cls_cursor_init(&cursor, cls, NULL);
 451     CLS_CURSOR_FOR_EACH (test_rule, cls_rule, &cursor) {
 452         found_rules2++;
 453     }
 454     assert(found_rules == found_rules2);
 455 }
 456
 457 static struct test_rule *
 458 make_rule(int wc_fields, unsigned int priority, int value_pat)
 459 {
 460     const struct cls_field *f;
 461     struct flow_wildcards wc;
 462     struct test_rule *rule;
 463     uint32_t wildcards;
 464     struct flow flow;
 465
 466     wildcards = 0;
 467     memset(&flow, 0, sizeof flow);
 468     for (f = &cls_fields[0]; f < &cls_fields[CLS_N_FIELDS]; f++) {
 469         int f_idx = f - cls_fields;
 470         if (wc_fields & (1u << f_idx)) {
 471             wildcards |= f->wildcards;
 472         } else {
 473             int value_idx = (value_pat & (1u << f_idx)) != 0;
 474             memcpy((char *) &flow + f->ofs, values[f_idx][value_idx], f->len);
 475         }
 476     }
 477
 478     rule = xzalloc(sizeof *rule);
 479     flow_wildcards_init(&wc, wildcards);
 480     cls_rule_init(&flow, &wc, !wildcards ? UINT_MAX : priority,
 481                   &rule->cls_rule);
 482     return rule;
 483 }
 484
 485 static void
 486 shuffle(unsigned int *p, size_t n)
 487 {
 488     for (; n > 1; n--, p++) {
 489         unsigned int *q = &p[rand() % n];
 490         unsigned int tmp = *p;
 491         *p = *q;
 492         *q = tmp;
 493     }
 494 }
 495 \f
 496 /* Tests an empty classifier. */
 497 static void
 498 test_empty(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 499 {
 500     struct classifier cls;
 501     struct tcls tcls;
 502
 503     classifier_init(&cls);
 504     tcls_init(&tcls);
 505     assert(classifier_is_empty(&cls));
 506     assert(tcls_is_empty(&tcls));
 507     compare_classifiers(&cls, &tcls);
 508     classifier_destroy(&cls);
 509     tcls_destroy(&tcls);
 510 }
 511
 512 /* Destroys a null classifier. */
 513 static void
 514 test_destroy_null(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 515 {
 516     classifier_destroy(NULL);
 517 }
 518
 519 /* Tests classification with one rule at a time. */
 520 static void
 521 test_single_rule(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 522 {
 523     unsigned int wc_fields;     /* Hilarious. */
 524
 525     for (wc_fields = 0; wc_fields < (1u << CLS_N_FIELDS); wc_fields++) {
 526         struct classifier cls;
 527         struct test_rule *rule, *tcls_rule;
 528         struct tcls tcls;
 529
 530         rule = make_rule(wc_fields,
 531                          hash_bytes(&wc_fields, sizeof wc_fields, 0), 0);
 532
 533         classifier_init(&cls);
 534         tcls_init(&tcls);
 535
 536         tcls_rule = tcls_insert(&tcls, rule);
 537         assert(!classifier_insert(&cls, &rule->cls_rule));
 538         check_tables(&cls, 1, 1, 0);
 539         compare_classifiers(&cls, &tcls);
 540
 541         classifier_remove(&cls, &rule->cls_rule);
 542         tcls_remove(&tcls, tcls_rule);
 543         assert(classifier_is_empty(&cls));
 544         assert(tcls_is_empty(&tcls));
 545         compare_classifiers(&cls, &tcls);
 546
 547         free(rule);
 548         classifier_destroy(&cls);
 549         tcls_destroy(&tcls);
 550     }
 551 }
 552
 553 /* Tests replacing one rule by another. */
 554 static void
 555 test_rule_replacement(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 556 {
 557     unsigned int wc_fields;
 558
 559     for (wc_fields = 0; wc_fields < (1u << CLS_N_FIELDS); wc_fields++) {
 560         struct classifier cls;
 561         struct test_rule *rule1;
 562         struct test_rule *rule2;
 563         struct tcls tcls;
 564
 565         rule1 = make_rule(wc_fields, OFP_DEFAULT_PRIORITY, UINT_MAX);
 566         rule2 = make_rule(wc_fields, OFP_DEFAULT_PRIORITY, UINT_MAX);
 567         rule2->aux += 5;
 568         rule2->aux += 5;
 569
 570         classifier_init(&cls);
 571         tcls_init(&tcls);
 572         tcls_insert(&tcls, rule1);
 573         assert(!classifier_insert(&cls, &rule1->cls_rule));
 574         check_tables(&cls, 1, 1, 0);
 575         compare_classifiers(&cls, &tcls);
 576         tcls_destroy(&tcls);
 577
 578         tcls_init(&tcls);
 579         tcls_insert(&tcls, rule2);
 580         assert(test_rule_from_cls_rule(
 581                    classifier_insert(&cls, &rule2->cls_rule)) == rule1);
 582         free(rule1);
 583         check_tables(&cls, 1, 1, 0);
 584         compare_classifiers(&cls, &tcls);
 585         tcls_destroy(&tcls);
 586         destroy_classifier(&cls);
 587     }
 588 }
 589
 590 static int
 591 factorial(int n_items)
 592 {
 593     int n, i;
 594
 595     n = 1;
 596     for (i = 2; i <= n_items; i++) {
 597         n *= i;
 598     }
 599     return n;
 600 }
 601
 602 static void
 603 swap(int *a, int *b)
 604 {
 605     int tmp = *a;
 606     *a = *b;
 607     *b = tmp;
 608 }
 609
 610 static void
 611 reverse(int *a, int n)
 612 {
 613     int i;
 614
 615     for (i = 0; i < n / 2; i++) {
 616         int j = n - (i + 1);
 617         swap(&a[i], &a[j]);
 618     }
 619 }
 620
 621 static bool
 622 next_permutation(int *a, int n)
 623 {
 624     int k;
 625
 626     for (k = n - 2; k >= 0; k--) {
 627         if (a[k] < a[k + 1]) {
 628             int l;
 629
 630             for (l = n - 1; ; l--) {
 631                 if (a[l] > a[k]) {
 632                     swap(&a[k], &a[l]);
 633                     reverse(a + (k + 1), n - (k + 1));
 634                     return true;
 635                 }
 636             }
 637         }
 638     }
 639     return false;
 640 }
 641
 642 /* Tests classification with rules that have the same matching criteria. */
 643 static void
 644 test_many_rules_in_one_list (int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 645 {
 646     enum { N_RULES = 3 };
 647     int n_pris;
 648
 649     for (n_pris = N_RULES; n_pris >= 1; n_pris--) {
 650         int ops[N_RULES * 2];
 651         int pris[N_RULES];
 652         int n_permutations;
 653         int i;
 654
 655         pris[0] = 0;
 656         for (i = 1; i < N_RULES; i++) {
 657             pris[i] = pris[i - 1] + (n_pris > i);
 658         }
 659
 660         for (i = 0; i < N_RULES * 2; i++) {
 661             ops[i] = i / 2;
 662         }
 663
 664         n_permutations = 0;
 665         do {
 666             struct test_rule *rules[N_RULES];
 667             struct test_rule *tcls_rules[N_RULES];
 668             int pri_rules[N_RULES];
 669             struct classifier cls;
 670             struct tcls tcls;
 671
 672             n_permutations++;
 673
 674             for (i = 0; i < N_RULES; i++) {
 675                 rules[i] = make_rule(456, pris[i], 0);
 676                 tcls_rules[i] = NULL;
 677                 pri_rules[i] = -1;
 678             }
 679
 680             classifier_init(&cls);
 681             tcls_init(&tcls);
 682
 683             for (i = 0; i < ARRAY_SIZE(ops); i++) {
 684                 int j = ops[i];
 685                 int m, n;
 686
 687                 if (!tcls_rules[j]) {
 688                     struct test_rule *displaced_rule;
 689
 690                     tcls_rules[j] = tcls_insert(&tcls, rules[j]);
 691                     displaced_rule = test_rule_from_cls_rule(
 692                         classifier_insert(&cls, &rules[j]->cls_rule));
 693                     if (pri_rules[pris[j]] >= 0) {
 694                         int k = pri_rules[pris[j]];
 695                         assert(displaced_rule != NULL);
 696                         assert(displaced_rule != rules[j]);
 697                         assert(pris[j] == displaced_rule->cls_rule.priority);
 698                         tcls_rules[k] = NULL;
 699                     } else {
 700                         assert(displaced_rule == NULL);
 701                     }
 702                     pri_rules[pris[j]] = j;
 703                 } else {
 704                     classifier_remove(&cls, &rules[j]->cls_rule);
 705                     tcls_remove(&tcls, tcls_rules[j]);
 706                     tcls_rules[j] = NULL;
 707                     pri_rules[pris[j]] = -1;
 708                 }
 709
 710                 n = 0;
 711                 for (m = 0; m < N_RULES; m++) {
 712                     n += tcls_rules[m] != NULL;
 713                 }
 714                 check_tables(&cls, n > 0, n, n - 1);
 715
 716                 compare_classifiers(&cls, &tcls);
 717             }
 718
 719             classifier_destroy(&cls);
 720             tcls_destroy(&tcls);
 721
 722             for (i = 0; i < N_RULES; i++) {
 723                 free(rules[i]);
 724             }
 725         } while (next_permutation(ops, ARRAY_SIZE(ops)));
 726         assert(n_permutations == (factorial(N_RULES * 2) >> N_RULES));
 727     }
 728 }
 729
 730 static int
 731 count_ones(unsigned long int x)
 732 {
 733     int n = 0;
 734
 735     while (x) {
 736         x &= x - 1;
 737         n++;
 738     }
 739
 740     return n;
 741 }
 742
 743 static bool
 744 array_contains(int *array, int n, int value)
 745 {
 746     int i;
 747
 748     for (i = 0; i < n; i++) {
 749         if (array[i] == value) {
 750             return true;
 751         }
 752     }
 753
 754     return false;
 755 }
 756
 757 /* Tests classification with two rules at a time that fall into the same
 758  * table but different lists. */
 759 static void
 760 test_many_rules_in_one_table(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 761 {
 762     int iteration;
 763
 764     for (iteration = 0; iteration < 50; iteration++) {
 765         enum { N_RULES = 20 };
 766         struct test_rule *rules[N_RULES];
 767         struct test_rule *tcls_rules[N_RULES];
 768         struct classifier cls;
 769         struct tcls tcls;
 770         int value_pats[N_RULES];
 771         int value_mask;
 772         int wcf;
 773         int i;
 774
 775         do {
 776             wcf = rand() & ((1u << CLS_N_FIELDS) - 1);
 777             value_mask = ~wcf & ((1u << CLS_N_FIELDS) - 1);
 778         } while ((1 << count_ones(value_mask)) < N_RULES);
 779
 780         classifier_init(&cls);
 781         tcls_init(&tcls);
 782
 783         for (i = 0; i < N_RULES; i++) {
 784             unsigned int priority = rand();
 785
 786             do {
 787                 value_pats[i] = rand() & value_mask;
 788             } while (array_contains(value_pats, i, value_pats[i]));
 789
 790             rules[i] = make_rule(wcf, priority, value_pats[i]);
 791             tcls_rules[i] = tcls_insert(&tcls, rules[i]);
 792             assert(!classifier_insert(&cls, &rules[i]->cls_rule));
 793
 794             check_tables(&cls, 1, i + 1, 0);
 795             compare_classifiers(&cls, &tcls);
 796         }
 797
 798         for (i = 0; i < N_RULES; i++) {
 799             tcls_remove(&tcls, tcls_rules[i]);
 800             classifier_remove(&cls, &rules[i]->cls_rule);
 801             free(rules[i]);
 802
 803             check_tables(&cls, i < N_RULES - 1, N_RULES - (i + 1), 0);
 804             compare_classifiers(&cls, &tcls);
 805         }
 806
 807         classifier_destroy(&cls);
 808         tcls_destroy(&tcls);
 809     }
 810 }
 811
 812 /* Tests classification with many rules at a time that fall into random lists
 813  * in 'n' tables. */
 814 static void
 815 test_many_rules_in_n_tables(int n_tables)
 816 {
 817     enum { MAX_RULES = 50 };
 818     int wcfs[10];
 819     int iteration;
 820     int i;
 821
 822     assert(n_tables < 10);
 823     for (i = 0; i < n_tables; i++) {
 824         do {
 825             wcfs[i] = rand() & ((1u << CLS_N_FIELDS) - 1);
 826         } while (array_contains(wcfs, i, wcfs[i]));
 827     }
 828
 829     for (iteration = 0; iteration < 30; iteration++) {
 830         unsigned int priorities[MAX_RULES];
 831         struct classifier cls;
 832         struct tcls tcls;
 833
 834         srand(iteration);
 835         for (i = 0; i < MAX_RULES; i++) {
 836             priorities[i] = i * 129;
 837         }
 838         shuffle(priorities, ARRAY_SIZE(priorities));
 839
 840         classifier_init(&cls);
 841         tcls_init(&tcls);
 842
 843         for (i = 0; i < MAX_RULES; i++) {
 844             struct test_rule *rule;
 845             unsigned int priority = priorities[i];
 846             int wcf = wcfs[rand() % n_tables];
 847             int value_pat = rand() & ((1u << CLS_N_FIELDS) - 1);
 848             rule = make_rule(wcf, priority, value_pat);
 849             tcls_insert(&tcls, rule);
 850             assert(!classifier_insert(&cls, &rule->cls_rule));
 851             check_tables(&cls, -1, i + 1, -1);
 852             compare_classifiers(&cls, &tcls);
 853         }
 854
 855         while (!classifier_is_empty(&cls)) {
 856             struct test_rule *rule, *next_rule;
 857             struct test_rule *target;
 858             struct cls_cursor cursor;
 859
 860             target = xmemdup(tcls.rules[rand() % tcls.n_rules],
 861                              sizeof(struct test_rule));
 862
 863             cls_cursor_init(&cursor, &cls, &target->cls_rule);
 864             CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cls_rule, &cursor) {
 865                 classifier_remove(&cls, &rule->cls_rule);
 866                 free(rule);
 867             }
 868             tcls_delete_matches(&tcls, &target->cls_rule);
 869             compare_classifiers(&cls, &tcls);
 870             check_tables(&cls, -1, -1, -1);
 871             free(target);
 872         }
 873
 874         destroy_classifier(&cls);
 875         tcls_destroy(&tcls);
 876     }
 877 }
 878
 879 static void
 880 test_many_rules_in_two_tables(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 881 {
 882     test_many_rules_in_n_tables(2);
 883 }
 884
 885 static void
 886 test_many_rules_in_five_tables(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 887 {
 888     test_many_rules_in_n_tables(5);
 889 }
 890 \f
 891 static const struct command commands[] = {
 892     {"empty", 0, 0, test_empty},
 893     {"destroy-null", 0, 0, test_destroy_null},
 894     {"single-rule", 0, 0, test_single_rule},
 895     {"rule-replacement", 0, 0, test_rule_replacement},
 896     {"many-rules-in-one-list", 0, 0, test_many_rules_in_one_list},
 897     {"many-rules-in-one-table", 0, 0, test_many_rules_in_one_table},
 898     {"many-rules-in-two-tables", 0, 0, test_many_rules_in_two_tables},
 899     {"many-rules-in-five-tables", 0, 0, test_many_rules_in_five_tables},
 900     {NULL, 0, 0, NULL},
 901 };
 902
 903 int
 904 main(int argc, char *argv[])
 905 {
 906     set_program_name(argv[0]);
 907     init_values();
 908     run_command(argc - 1, argv + 1, commands);
 909     return 0;
 910 }