tests/test-classifier.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /* "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 "ofp-util.h"
  36 #include "packets.h"
  37 #include "unaligned.h"
  38
  39 #undef NDEBUG
  40 #include <assert.h>
  41
  42 /* Fields in a rule. */
  43 #define CLS_FIELDS                                                  \
  44     /*                                    struct flow  all-caps */  \
  45     /*        FWW_* bit(s)                member name  name     */  \
  46     /*        --------------------------  -----------  -------- */  \
  47     CLS_FIELD(0,                          tun_id,      TUN_ID)      \
  48     CLS_FIELD(0,                          metadata,    METADATA)    \
  49     CLS_FIELD(0,                          nw_src,      NW_SRC)      \
  50     CLS_FIELD(0,                          nw_dst,      NW_DST)      \
  51     CLS_FIELD(FWW_IN_PORT,                in_port,     IN_PORT)     \
  52     CLS_FIELD(0,                          vlan_tci,    VLAN_TCI)    \
  53     CLS_FIELD(FWW_DL_TYPE,                dl_type,     DL_TYPE)     \
  54     CLS_FIELD(0,                          tp_src,      TP_SRC)      \
  55     CLS_FIELD(0,                          tp_dst,      TP_DST)      \
  56     CLS_FIELD(0,                          dl_src,      DL_SRC)      \
  57     CLS_FIELD(0,                          dl_dst,      DL_DST)      \
  58     CLS_FIELD(FWW_NW_PROTO,               nw_proto,    NW_PROTO)    \
  59     CLS_FIELD(FWW_NW_DSCP,                nw_tos,      NW_DSCP)
  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     flow_wildcards_t wildcards; /* FWW_* 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(!flow_wildcards_is_exact(&rule->cls_rule.wc)
 140            || rule->cls_rule.priority == UINT_MAX);
 141     for (i = 0; i < tcls->n_rules; i++) {
 142         const struct cls_rule *pos = &tcls->rules[i]->cls_rule;
 143         if (cls_rule_equal(pos, &rule->cls_rule)) {
 144             /* Exact match. */
 145             free(tcls->rules[i]);
 146             tcls->rules[i] = xmemdup(rule, sizeof *rule);
 147             return tcls->rules[i];
 148         } else if (pos->priority < rule->cls_rule.priority) {
 149             break;
 150         }
 151     }
 152
 153     if (tcls->n_rules >= tcls->allocated_rules) {
 154         tcls->rules = x2nrealloc(tcls->rules, &tcls->allocated_rules,
 155                                  sizeof *tcls->rules);
 156     }
 157     if (i != tcls->n_rules) {
 158         memmove(&tcls->rules[i + 1], &tcls->rules[i],
 159                 sizeof *tcls->rules * (tcls->n_rules - i));
 160     }
 161     tcls->rules[i] = xmemdup(rule, sizeof *rule);
 162     tcls->n_rules++;
 163     return tcls->rules[i];
 164 }
 165
 166 static void
 167 tcls_remove(struct tcls *cls, const struct test_rule *rule)
 168 {
 169     size_t i;
 170
 171     for (i = 0; i < cls->n_rules; i++) {
 172         struct test_rule *pos = cls->rules[i];
 173         if (pos == rule) {
 174             free(pos);
 175             memmove(&cls->rules[i], &cls->rules[i + 1],
 176                     sizeof *cls->rules * (cls->n_rules - i - 1));
 177             cls->n_rules--;
 178             return;
 179         }
 180     }
 181     NOT_REACHED();
 182 }
 183
 184 static bool
 185 match(const struct cls_rule *wild, const struct flow *fixed)
 186 {
 187     int f_idx;
 188
 189     for (f_idx = 0; f_idx < CLS_N_FIELDS; f_idx++) {
 190         const struct cls_field *f = &cls_fields[f_idx];
 191         bool eq;
 192
 193         if (f->wildcards) {
 194             void *wild_field = (char *) &wild->flow + f->ofs;
 195             void *fixed_field = (char *) fixed + f->ofs;
 196             eq = ((wild->wc.wildcards & f->wildcards) == f->wildcards
 197                   || !memcmp(wild_field, fixed_field, f->len));
 198         } else if (f_idx == CLS_F_IDX_NW_SRC) {
 199             eq = !((fixed->nw_src ^ wild->flow.nw_src) & wild->wc.nw_src_mask);
 200         } else if (f_idx == CLS_F_IDX_NW_DST) {
 201             eq = !((fixed->nw_dst ^ wild->flow.nw_dst) & wild->wc.nw_dst_mask);
 202         } else if (f_idx == CLS_F_IDX_TP_SRC) {
 203             eq = !((fixed->tp_src ^ wild->flow.tp_src) & wild->wc.tp_src_mask);
 204         } else if (f_idx == CLS_F_IDX_TP_DST) {
 205             eq = !((fixed->tp_dst ^ wild->flow.tp_dst) & wild->wc.tp_dst_mask);
 206         } else if (f_idx == CLS_F_IDX_DL_SRC) {
 207             eq = eth_addr_equal_except(fixed->dl_src, wild->flow.dl_src,
 208                                        wild->wc.dl_src_mask);
 209         } else if (f_idx == CLS_F_IDX_DL_DST) {
 210             eq = eth_addr_equal_except(fixed->dl_dst, wild->flow.dl_dst,
 211                                        wild->wc.dl_dst_mask);
 212         } else if (f_idx == CLS_F_IDX_VLAN_TCI) {
 213             eq = !((fixed->vlan_tci ^ wild->flow.vlan_tci)
 214                    & wild->wc.vlan_tci_mask);
 215         } else if (f_idx == CLS_F_IDX_TUN_ID) {
 216             eq = !((fixed->tun_id ^ wild->flow.tun_id) & wild->wc.tun_id_mask);
 217         } else if (f_idx == CLS_F_IDX_METADATA) {
 218             eq = !((fixed->metadata ^ wild->flow.metadata)
 219                    & wild->wc.metadata_mask);
 220         } else if (f_idx == CLS_F_IDX_NW_DSCP) {
 221             eq = !((fixed->nw_tos ^ wild->flow.nw_tos) & IP_DSCP_MASK);
 222         } else {
 223             NOT_REACHED();
 224         }
 225
 226         if (!eq) {
 227             return false;
 228         }
 229     }
 230     return true;
 231 }
 232
 233 static struct cls_rule *
 234 tcls_lookup(const struct tcls *cls, const struct flow *flow)
 235 {
 236     size_t i;
 237
 238     for (i = 0; i < cls->n_rules; i++) {
 239         struct test_rule *pos = cls->rules[i];
 240         if (match(&pos->cls_rule, flow)) {
 241             return &pos->cls_rule;
 242         }
 243     }
 244     return NULL;
 245 }
 246
 247 static void
 248 tcls_delete_matches(struct tcls *cls, const struct cls_rule *target)
 249 {
 250     size_t i;
 251
 252     for (i = 0; i < cls->n_rules; ) {
 253         struct test_rule *pos = cls->rules[i];
 254         if (!flow_wildcards_has_extra(&pos->cls_rule.wc, &target->wc)
 255             && match(target, &pos->cls_rule.flow)) {
 256             tcls_remove(cls, pos);
 257         } else {
 258             i++;
 259         }
 260     }
 261 }
 262 \f
 263 static ovs_be32 nw_src_values[] = { CONSTANT_HTONL(0xc0a80001),
 264                                     CONSTANT_HTONL(0xc0a04455) };
 265 static ovs_be32 nw_dst_values[] = { CONSTANT_HTONL(0xc0a80002),
 266                                     CONSTANT_HTONL(0xc0a04455) };
 267 static ovs_be64 tun_id_values[] = {
 268     0,
 269     CONSTANT_HTONLL(UINT64_C(0xfedcba9876543210)) };
 270 static ovs_be64 metadata_values[] = {
 271     0,
 272     CONSTANT_HTONLL(UINT64_C(0xfedcba9876543210)) };
 273 static uint16_t in_port_values[] = { 1, OFPP_LOCAL };
 274 static ovs_be16 vlan_tci_values[] = { CONSTANT_HTONS(101), CONSTANT_HTONS(0) };
 275 static ovs_be16 dl_type_values[]
 276             = { CONSTANT_HTONS(ETH_TYPE_IP), CONSTANT_HTONS(ETH_TYPE_ARP) };
 277 static ovs_be16 tp_src_values[] = { CONSTANT_HTONS(49362),
 278                                     CONSTANT_HTONS(80) };
 279 static ovs_be16 tp_dst_values[] = { CONSTANT_HTONS(6667), CONSTANT_HTONS(22) };
 280 static uint8_t dl_src_values[][6] = { { 0x00, 0x02, 0xe3, 0x0f, 0x80, 0xa4 },
 281                                       { 0x5e, 0x33, 0x7f, 0x5f, 0x1e, 0x99 } };
 282 static uint8_t dl_dst_values[][6] = { { 0x4a, 0x27, 0x71, 0xae, 0x64, 0xc1 },
 283                                       { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } };
 284 static uint8_t nw_proto_values[] = { IPPROTO_TCP, IPPROTO_ICMP };
 285 static uint8_t nw_dscp_values[] = { 48, 0 };
 286
 287 static void *values[CLS_N_FIELDS][2];
 288
 289 static void
 290 init_values(void)
 291 {
 292     values[CLS_F_IDX_TUN_ID][0] = &tun_id_values[0];
 293     values[CLS_F_IDX_TUN_ID][1] = &tun_id_values[1];
 294
 295     values[CLS_F_IDX_METADATA][0] = &metadata_values[0];
 296     values[CLS_F_IDX_METADATA][1] = &metadata_values[1];
 297
 298     values[CLS_F_IDX_IN_PORT][0] = &in_port_values[0];
 299     values[CLS_F_IDX_IN_PORT][1] = &in_port_values[1];
 300
 301     values[CLS_F_IDX_VLAN_TCI][0] = &vlan_tci_values[0];
 302     values[CLS_F_IDX_VLAN_TCI][1] = &vlan_tci_values[1];
 303
 304     values[CLS_F_IDX_DL_SRC][0] = dl_src_values[0];
 305     values[CLS_F_IDX_DL_SRC][1] = dl_src_values[1];
 306
 307     values[CLS_F_IDX_DL_DST][0] = dl_dst_values[0];
 308     values[CLS_F_IDX_DL_DST][1] = dl_dst_values[1];
 309
 310     values[CLS_F_IDX_DL_TYPE][0] = &dl_type_values[0];
 311     values[CLS_F_IDX_DL_TYPE][1] = &dl_type_values[1];
 312
 313     values[CLS_F_IDX_NW_SRC][0] = &nw_src_values[0];
 314     values[CLS_F_IDX_NW_SRC][1] = &nw_src_values[1];
 315
 316     values[CLS_F_IDX_NW_DST][0] = &nw_dst_values[0];
 317     values[CLS_F_IDX_NW_DST][1] = &nw_dst_values[1];
 318
 319     values[CLS_F_IDX_NW_PROTO][0] = &nw_proto_values[0];
 320     values[CLS_F_IDX_NW_PROTO][1] = &nw_proto_values[1];
 321
 322     values[CLS_F_IDX_NW_DSCP][0] = &nw_dscp_values[0];
 323     values[CLS_F_IDX_NW_DSCP][1] = &nw_dscp_values[1];
 324
 325     values[CLS_F_IDX_TP_SRC][0] = &tp_src_values[0];
 326     values[CLS_F_IDX_TP_SRC][1] = &tp_src_values[1];
 327
 328     values[CLS_F_IDX_TP_DST][0] = &tp_dst_values[0];
 329     values[CLS_F_IDX_TP_DST][1] = &tp_dst_values[1];
 330 }
 331
 332 #define N_NW_SRC_VALUES ARRAY_SIZE(nw_src_values)
 333 #define N_NW_DST_VALUES ARRAY_SIZE(nw_dst_values)
 334 #define N_TUN_ID_VALUES ARRAY_SIZE(tun_id_values)
 335 #define N_METADATA_VALUES ARRAY_SIZE(metadata_values)
 336 #define N_IN_PORT_VALUES ARRAY_SIZE(in_port_values)
 337 #define N_VLAN_TCI_VALUES ARRAY_SIZE(vlan_tci_values)
 338 #define N_DL_TYPE_VALUES ARRAY_SIZE(dl_type_values)
 339 #define N_TP_SRC_VALUES ARRAY_SIZE(tp_src_values)
 340 #define N_TP_DST_VALUES ARRAY_SIZE(tp_dst_values)
 341 #define N_DL_SRC_VALUES ARRAY_SIZE(dl_src_values)
 342 #define N_DL_DST_VALUES ARRAY_SIZE(dl_dst_values)
 343 #define N_NW_PROTO_VALUES ARRAY_SIZE(nw_proto_values)
 344 #define N_NW_DSCP_VALUES ARRAY_SIZE(nw_dscp_values)
 345
 346 #define N_FLOW_VALUES (N_NW_SRC_VALUES *        \
 347                        N_NW_DST_VALUES *        \
 348                        N_TUN_ID_VALUES *        \
 349                        N_IN_PORT_VALUES *       \
 350                        N_VLAN_TCI_VALUES *       \
 351                        N_DL_TYPE_VALUES *       \
 352                        N_TP_SRC_VALUES *        \
 353                        N_TP_DST_VALUES *        \
 354                        N_DL_SRC_VALUES *        \
 355                        N_DL_DST_VALUES *        \
 356                        N_NW_PROTO_VALUES *      \
 357                        N_NW_DSCP_VALUES)
 358
 359 static unsigned int
 360 get_value(unsigned int *x, unsigned n_values)
 361 {
 362     unsigned int rem = *x % n_values;
 363     *x /= n_values;
 364     return rem;
 365 }
 366
 367 static void
 368 compare_classifiers(struct classifier *cls, struct tcls *tcls)
 369 {
 370     static const int confidence = 500;
 371     unsigned int i;
 372
 373     assert(classifier_count(cls) == tcls->n_rules);
 374     for (i = 0; i < confidence; i++) {
 375         struct cls_rule *cr0, *cr1;
 376         struct flow flow;
 377         unsigned int x;
 378
 379         x = rand () % N_FLOW_VALUES;
 380         flow.nw_src = nw_src_values[get_value(&x, N_NW_SRC_VALUES)];
 381         flow.nw_dst = nw_dst_values[get_value(&x, N_NW_DST_VALUES)];
 382         flow.tun_id = tun_id_values[get_value(&x, N_TUN_ID_VALUES)];
 383         flow.metadata = metadata_values[get_value(&x, N_METADATA_VALUES)];
 384         flow.in_port = in_port_values[get_value(&x, N_IN_PORT_VALUES)];
 385         flow.vlan_tci = vlan_tci_values[get_value(&x, N_VLAN_TCI_VALUES)];
 386         flow.dl_type = dl_type_values[get_value(&x, N_DL_TYPE_VALUES)];
 387         flow.tp_src = tp_src_values[get_value(&x, N_TP_SRC_VALUES)];
 388         flow.tp_dst = tp_dst_values[get_value(&x, N_TP_DST_VALUES)];
 389         memcpy(flow.dl_src, dl_src_values[get_value(&x, N_DL_SRC_VALUES)],
 390                ETH_ADDR_LEN);
 391         memcpy(flow.dl_dst, dl_dst_values[get_value(&x, N_DL_DST_VALUES)],
 392                ETH_ADDR_LEN);
 393         flow.nw_proto = nw_proto_values[get_value(&x, N_NW_PROTO_VALUES)];
 394         flow.nw_tos = nw_dscp_values[get_value(&x, N_NW_DSCP_VALUES)];
 395
 396         cr0 = classifier_lookup(cls, &flow);
 397         cr1 = tcls_lookup(tcls, &flow);
 398         assert((cr0 == NULL) == (cr1 == NULL));
 399         if (cr0 != NULL) {
 400             const struct test_rule *tr0 = test_rule_from_cls_rule(cr0);
 401             const struct test_rule *tr1 = test_rule_from_cls_rule(cr1);
 402
 403             assert(cls_rule_equal(cr0, cr1));
 404             assert(tr0->aux == tr1->aux);
 405         }
 406     }
 407 }
 408
 409 static void
 410 destroy_classifier(struct classifier *cls)
 411 {
 412     struct test_rule *rule, *next_rule;
 413     struct cls_cursor cursor;
 414
 415     cls_cursor_init(&cursor, cls, NULL);
 416     CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cls_rule, &cursor) {
 417         classifier_remove(cls, &rule->cls_rule);
 418         free(rule);
 419     }
 420     classifier_destroy(cls);
 421 }
 422
 423 static void
 424 check_tables(const struct classifier *cls,
 425              int n_tables, int n_rules, int n_dups)
 426 {
 427     const struct cls_table *table;
 428     struct test_rule *test_rule;
 429     struct cls_cursor cursor;
 430     int found_tables = 0;
 431     int found_rules = 0;
 432     int found_dups = 0;
 433     int found_rules2 = 0;
 434
 435     HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
 436         const struct cls_rule *head;
 437
 438         assert(!hmap_is_empty(&table->rules));
 439
 440         found_tables++;
 441         HMAP_FOR_EACH (head, hmap_node, &table->rules) {
 442             unsigned int prev_priority = UINT_MAX;
 443             const struct cls_rule *rule;
 444
 445             found_rules++;
 446             LIST_FOR_EACH (rule, list, &head->list) {
 447                 assert(rule->priority < prev_priority);
 448                 prev_priority = rule->priority;
 449                 found_rules++;
 450                 found_dups++;
 451                 assert(classifier_find_rule_exactly(cls, rule) == rule);
 452             }
 453         }
 454     }
 455
 456     assert(found_tables == hmap_count(&cls->tables));
 457     assert(n_tables == -1 || n_tables == hmap_count(&cls->tables));
 458     assert(n_rules == -1 || found_rules == n_rules);
 459     assert(n_dups == -1 || found_dups == n_dups);
 460
 461     cls_cursor_init(&cursor, cls, NULL);
 462     CLS_CURSOR_FOR_EACH (test_rule, cls_rule, &cursor) {
 463         found_rules2++;
 464     }
 465     assert(found_rules == found_rules2);
 466 }
 467
 468 static struct test_rule *
 469 make_rule(int wc_fields, unsigned int priority, int value_pat)
 470 {
 471     const struct cls_field *f;
 472     struct test_rule *rule;
 473
 474     rule = xzalloc(sizeof *rule);
 475     cls_rule_init_catchall(&rule->cls_rule, wc_fields ? priority : UINT_MAX);
 476     for (f = &cls_fields[0]; f < &cls_fields[CLS_N_FIELDS]; f++) {
 477         int f_idx = f - cls_fields;
 478         int value_idx = (value_pat & (1u << f_idx)) != 0;
 479         memcpy((char *) &rule->cls_rule.flow + f->ofs,
 480                values[f_idx][value_idx], f->len);
 481
 482         if (f->wildcards) {
 483             rule->cls_rule.wc.wildcards &= ~f->wildcards;
 484         } else if (f_idx == CLS_F_IDX_NW_SRC) {
 485             rule->cls_rule.wc.nw_src_mask = htonl(UINT32_MAX);
 486         } else if (f_idx == CLS_F_IDX_NW_DST) {
 487             rule->cls_rule.wc.nw_dst_mask = htonl(UINT32_MAX);
 488         } else if (f_idx == CLS_F_IDX_TP_SRC) {
 489             rule->cls_rule.wc.tp_src_mask = htons(UINT16_MAX);
 490         } else if (f_idx == CLS_F_IDX_TP_DST) {
 491             rule->cls_rule.wc.tp_dst_mask = htons(UINT16_MAX);
 492         } else if (f_idx == CLS_F_IDX_DL_SRC) {
 493             memset(rule->cls_rule.wc.dl_src_mask, 0xff, ETH_ADDR_LEN);
 494         } else if (f_idx == CLS_F_IDX_DL_DST) {
 495             memset(rule->cls_rule.wc.dl_dst_mask, 0xff, ETH_ADDR_LEN);
 496         } else if (f_idx == CLS_F_IDX_VLAN_TCI) {
 497             rule->cls_rule.wc.vlan_tci_mask = htons(UINT16_MAX);
 498         } else if (f_idx == CLS_F_IDX_TUN_ID) {
 499             rule->cls_rule.wc.tun_id_mask = htonll(UINT64_MAX);
 500         } else if (f_idx == CLS_F_IDX_METADATA) {
 501             rule->cls_rule.wc.metadata_mask = htonll(UINT64_MAX);
 502         } else {
 503             NOT_REACHED();
 504         }
 505     }
 506     return rule;
 507 }
 508
 509 static void
 510 shuffle(unsigned int *p, size_t n)
 511 {
 512     for (; n > 1; n--, p++) {
 513         unsigned int *q = &p[rand() % n];
 514         unsigned int tmp = *p;
 515         *p = *q;
 516         *q = tmp;
 517     }
 518 }
 519 \f
 520 /* Tests an empty classifier. */
 521 static void
 522 test_empty(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 523 {
 524     struct classifier cls;
 525     struct tcls tcls;
 526
 527     classifier_init(&cls);
 528     tcls_init(&tcls);
 529     assert(classifier_is_empty(&cls));
 530     assert(tcls_is_empty(&tcls));
 531     compare_classifiers(&cls, &tcls);
 532     classifier_destroy(&cls);
 533     tcls_destroy(&tcls);
 534 }
 535
 536 /* Destroys a null classifier. */
 537 static void
 538 test_destroy_null(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 539 {
 540     classifier_destroy(NULL);
 541 }
 542
 543 /* Tests classification with one rule at a time. */
 544 static void
 545 test_single_rule(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 546 {
 547     unsigned int wc_fields;     /* Hilarious. */
 548
 549     for (wc_fields = 0; wc_fields < (1u << CLS_N_FIELDS); wc_fields++) {
 550         struct classifier cls;
 551         struct test_rule *rule, *tcls_rule;
 552         struct tcls tcls;
 553
 554         rule = make_rule(wc_fields,
 555                          hash_bytes(&wc_fields, sizeof wc_fields, 0), 0);
 556
 557         classifier_init(&cls);
 558         tcls_init(&tcls);
 559
 560         tcls_rule = tcls_insert(&tcls, rule);
 561         classifier_insert(&cls, &rule->cls_rule);
 562         check_tables(&cls, 1, 1, 0);
 563         compare_classifiers(&cls, &tcls);
 564
 565         classifier_remove(&cls, &rule->cls_rule);
 566         tcls_remove(&tcls, tcls_rule);
 567         assert(classifier_is_empty(&cls));
 568         assert(tcls_is_empty(&tcls));
 569         compare_classifiers(&cls, &tcls);
 570
 571         free(rule);
 572         classifier_destroy(&cls);
 573         tcls_destroy(&tcls);
 574     }
 575 }
 576
 577 /* Tests replacing one rule by another. */
 578 static void
 579 test_rule_replacement(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 580 {
 581     unsigned int wc_fields;
 582
 583     for (wc_fields = 0; wc_fields < (1u << CLS_N_FIELDS); wc_fields++) {
 584         struct classifier cls;
 585         struct test_rule *rule1;
 586         struct test_rule *rule2;
 587         struct tcls tcls;
 588
 589         rule1 = make_rule(wc_fields, OFP_DEFAULT_PRIORITY, UINT_MAX);
 590         rule2 = make_rule(wc_fields, OFP_DEFAULT_PRIORITY, UINT_MAX);
 591         rule2->aux += 5;
 592         rule2->aux += 5;
 593
 594         classifier_init(&cls);
 595         tcls_init(&tcls);
 596         tcls_insert(&tcls, rule1);
 597         classifier_insert(&cls, &rule1->cls_rule);
 598         check_tables(&cls, 1, 1, 0);
 599         compare_classifiers(&cls, &tcls);
 600         tcls_destroy(&tcls);
 601
 602         tcls_init(&tcls);
 603         tcls_insert(&tcls, rule2);
 604         assert(test_rule_from_cls_rule(
 605                    classifier_replace(&cls, &rule2->cls_rule)) == rule1);
 606         free(rule1);
 607         check_tables(&cls, 1, 1, 0);
 608         compare_classifiers(&cls, &tcls);
 609         tcls_destroy(&tcls);
 610         destroy_classifier(&cls);
 611     }
 612 }
 613
 614 static int
 615 factorial(int n_items)
 616 {
 617     int n, i;
 618
 619     n = 1;
 620     for (i = 2; i <= n_items; i++) {
 621         n *= i;
 622     }
 623     return n;
 624 }
 625
 626 static void
 627 swap(int *a, int *b)
 628 {
 629     int tmp = *a;
 630     *a = *b;
 631     *b = tmp;
 632 }
 633
 634 static void
 635 reverse(int *a, int n)
 636 {
 637     int i;
 638
 639     for (i = 0; i < n / 2; i++) {
 640         int j = n - (i + 1);
 641         swap(&a[i], &a[j]);
 642     }
 643 }
 644
 645 static bool
 646 next_permutation(int *a, int n)
 647 {
 648     int k;
 649
 650     for (k = n - 2; k >= 0; k--) {
 651         if (a[k] < a[k + 1]) {
 652             int l;
 653
 654             for (l = n - 1; ; l--) {
 655                 if (a[l] > a[k]) {
 656                     swap(&a[k], &a[l]);
 657                     reverse(a + (k + 1), n - (k + 1));
 658                     return true;
 659                 }
 660             }
 661         }
 662     }
 663     return false;
 664 }
 665
 666 /* Tests classification with rules that have the same matching criteria. */
 667 static void
 668 test_many_rules_in_one_list (int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 669 {
 670     enum { N_RULES = 3 };
 671     int n_pris;
 672
 673     for (n_pris = N_RULES; n_pris >= 1; n_pris--) {
 674         int ops[N_RULES * 2];
 675         int pris[N_RULES];
 676         int n_permutations;
 677         int i;
 678
 679         pris[0] = 0;
 680         for (i = 1; i < N_RULES; i++) {
 681             pris[i] = pris[i - 1] + (n_pris > i);
 682         }
 683
 684         for (i = 0; i < N_RULES * 2; i++) {
 685             ops[i] = i / 2;
 686         }
 687
 688         n_permutations = 0;
 689         do {
 690             struct test_rule *rules[N_RULES];
 691             struct test_rule *tcls_rules[N_RULES];
 692             int pri_rules[N_RULES];
 693             struct classifier cls;
 694             struct tcls tcls;
 695
 696             n_permutations++;
 697
 698             for (i = 0; i < N_RULES; i++) {
 699                 rules[i] = make_rule(456, pris[i], 0);
 700                 tcls_rules[i] = NULL;
 701                 pri_rules[i] = -1;
 702             }
 703
 704             classifier_init(&cls);
 705             tcls_init(&tcls);
 706
 707             for (i = 0; i < ARRAY_SIZE(ops); i++) {
 708                 int j = ops[i];
 709                 int m, n;
 710
 711                 if (!tcls_rules[j]) {
 712                     struct test_rule *displaced_rule;
 713
 714                     tcls_rules[j] = tcls_insert(&tcls, rules[j]);
 715                     displaced_rule = test_rule_from_cls_rule(
 716                         classifier_replace(&cls, &rules[j]->cls_rule));
 717                     if (pri_rules[pris[j]] >= 0) {
 718                         int k = pri_rules[pris[j]];
 719                         assert(displaced_rule != NULL);
 720                         assert(displaced_rule != rules[j]);
 721                         assert(pris[j] == displaced_rule->cls_rule.priority);
 722                         tcls_rules[k] = NULL;
 723                     } else {
 724                         assert(displaced_rule == NULL);
 725                     }
 726                     pri_rules[pris[j]] = j;
 727                 } else {
 728                     classifier_remove(&cls, &rules[j]->cls_rule);
 729                     tcls_remove(&tcls, tcls_rules[j]);
 730                     tcls_rules[j] = NULL;
 731                     pri_rules[pris[j]] = -1;
 732                 }
 733
 734                 n = 0;
 735                 for (m = 0; m < N_RULES; m++) {
 736                     n += tcls_rules[m] != NULL;
 737                 }
 738                 check_tables(&cls, n > 0, n, n - 1);
 739
 740                 compare_classifiers(&cls, &tcls);
 741             }
 742
 743             classifier_destroy(&cls);
 744             tcls_destroy(&tcls);
 745
 746             for (i = 0; i < N_RULES; i++) {
 747                 free(rules[i]);
 748             }
 749         } while (next_permutation(ops, ARRAY_SIZE(ops)));
 750         assert(n_permutations == (factorial(N_RULES * 2) >> N_RULES));
 751     }
 752 }
 753
 754 static int
 755 count_ones(unsigned long int x)
 756 {
 757     int n = 0;
 758
 759     while (x) {
 760         x &= x - 1;
 761         n++;
 762     }
 763
 764     return n;
 765 }
 766
 767 static bool
 768 array_contains(int *array, int n, int value)
 769 {
 770     int i;
 771
 772     for (i = 0; i < n; i++) {
 773         if (array[i] == value) {
 774             return true;
 775         }
 776     }
 777
 778     return false;
 779 }
 780
 781 /* Tests classification with two rules at a time that fall into the same
 782  * table but different lists. */
 783 static void
 784 test_many_rules_in_one_table(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 785 {
 786     int iteration;
 787
 788     for (iteration = 0; iteration < 50; iteration++) {
 789         enum { N_RULES = 20 };
 790         struct test_rule *rules[N_RULES];
 791         struct test_rule *tcls_rules[N_RULES];
 792         struct classifier cls;
 793         struct tcls tcls;
 794         int value_pats[N_RULES];
 795         int value_mask;
 796         int wcf;
 797         int i;
 798
 799         do {
 800             wcf = rand() & ((1u << CLS_N_FIELDS) - 1);
 801             value_mask = ~wcf & ((1u << CLS_N_FIELDS) - 1);
 802         } while ((1 << count_ones(value_mask)) < N_RULES);
 803
 804         classifier_init(&cls);
 805         tcls_init(&tcls);
 806
 807         for (i = 0; i < N_RULES; i++) {
 808             unsigned int priority = rand();
 809
 810             do {
 811                 value_pats[i] = rand() & value_mask;
 812             } while (array_contains(value_pats, i, value_pats[i]));
 813
 814             rules[i] = make_rule(wcf, priority, value_pats[i]);
 815             tcls_rules[i] = tcls_insert(&tcls, rules[i]);
 816             classifier_insert(&cls, &rules[i]->cls_rule);
 817
 818             check_tables(&cls, 1, i + 1, 0);
 819             compare_classifiers(&cls, &tcls);
 820         }
 821
 822         for (i = 0; i < N_RULES; i++) {
 823             tcls_remove(&tcls, tcls_rules[i]);
 824             classifier_remove(&cls, &rules[i]->cls_rule);
 825             free(rules[i]);
 826
 827             check_tables(&cls, i < N_RULES - 1, N_RULES - (i + 1), 0);
 828             compare_classifiers(&cls, &tcls);
 829         }
 830
 831         classifier_destroy(&cls);
 832         tcls_destroy(&tcls);
 833     }
 834 }
 835
 836 /* Tests classification with many rules at a time that fall into random lists
 837  * in 'n' tables. */
 838 static void
 839 test_many_rules_in_n_tables(int n_tables)
 840 {
 841     enum { MAX_RULES = 50 };
 842     int wcfs[10];
 843     int iteration;
 844     int i;
 845
 846     assert(n_tables < 10);
 847     for (i = 0; i < n_tables; i++) {
 848         do {
 849             wcfs[i] = rand() & ((1u << CLS_N_FIELDS) - 1);
 850         } while (array_contains(wcfs, i, wcfs[i]));
 851     }
 852
 853     for (iteration = 0; iteration < 30; iteration++) {
 854         unsigned int priorities[MAX_RULES];
 855         struct classifier cls;
 856         struct tcls tcls;
 857
 858         srand(iteration);
 859         for (i = 0; i < MAX_RULES; i++) {
 860             priorities[i] = i * 129;
 861         }
 862         shuffle(priorities, ARRAY_SIZE(priorities));
 863
 864         classifier_init(&cls);
 865         tcls_init(&tcls);
 866
 867         for (i = 0; i < MAX_RULES; i++) {
 868             struct test_rule *rule;
 869             unsigned int priority = priorities[i];
 870             int wcf = wcfs[rand() % n_tables];
 871             int value_pat = rand() & ((1u << CLS_N_FIELDS) - 1);
 872             rule = make_rule(wcf, priority, value_pat);
 873             tcls_insert(&tcls, rule);
 874             classifier_insert(&cls, &rule->cls_rule);
 875             check_tables(&cls, -1, i + 1, -1);
 876             compare_classifiers(&cls, &tcls);
 877         }
 878
 879         while (!classifier_is_empty(&cls)) {
 880             struct test_rule *rule, *next_rule;
 881             struct test_rule *target;
 882             struct cls_cursor cursor;
 883
 884             target = xmemdup(tcls.rules[rand() % tcls.n_rules],
 885                              sizeof(struct test_rule));
 886
 887             cls_cursor_init(&cursor, &cls, &target->cls_rule);
 888             CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cls_rule, &cursor) {
 889                 classifier_remove(&cls, &rule->cls_rule);
 890                 free(rule);
 891             }
 892             tcls_delete_matches(&tcls, &target->cls_rule);
 893             compare_classifiers(&cls, &tcls);
 894             check_tables(&cls, -1, -1, -1);
 895             free(target);
 896         }
 897
 898         destroy_classifier(&cls);
 899         tcls_destroy(&tcls);
 900     }
 901 }
 902
 903 static void
 904 test_many_rules_in_two_tables(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 905 {
 906     test_many_rules_in_n_tables(2);
 907 }
 908
 909 static void
 910 test_many_rules_in_five_tables(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 911 {
 912     test_many_rules_in_n_tables(5);
 913 }
 914 \f
 915 static const struct command commands[] = {
 916     {"empty", 0, 0, test_empty},
 917     {"destroy-null", 0, 0, test_destroy_null},
 918     {"single-rule", 0, 0, test_single_rule},
 919     {"rule-replacement", 0, 0, test_rule_replacement},
 920     {"many-rules-in-one-list", 0, 0, test_many_rules_in_one_list},
 921     {"many-rules-in-one-table", 0, 0, test_many_rules_in_one_table},
 922     {"many-rules-in-two-tables", 0, 0, test_many_rules_in_two_tables},
 923     {"many-rules-in-five-tables", 0, 0, test_many_rules_in_five_tables},
 924     {NULL, 0, 0, NULL},
 925 };
 926
 927 int
 928 main(int argc, char *argv[])
 929 {
 930     set_program_name(argv[0]);
 931     init_values();
 932     run_command(argc - 1, argv + 1, commands);
 933     return 0;
 934 }