2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 /* "White box" tests for classifier.
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.)
24 * This test should receive a clean report from "valgrind --leak-check=full":
25 * it frees every heap block that it allocates.
29 #include "classifier.h"
32 #include "byte-order.h"
33 #include "command-line.h"
38 #include "unaligned.h"
43 /* Fields in a rule. */
45 /* struct flow all-caps */ \
46 /* member name name */ \
47 /* ----------- -------- */ \
48 CLS_FIELD(tunnel.tun_id, TUN_ID) \
49 CLS_FIELD(metadata, METADATA) \
50 CLS_FIELD(nw_src, NW_SRC) \
51 CLS_FIELD(nw_dst, NW_DST) \
52 CLS_FIELD(in_port, IN_PORT) \
53 CLS_FIELD(vlan_tci, VLAN_TCI) \
54 CLS_FIELD(dl_type, DL_TYPE) \
55 CLS_FIELD(tp_src, TP_SRC) \
56 CLS_FIELD(tp_dst, TP_DST) \
57 CLS_FIELD(dl_src, DL_SRC) \
58 CLS_FIELD(dl_dst, DL_DST) \
59 CLS_FIELD(nw_proto, NW_PROTO) \
60 CLS_FIELD(nw_tos, NW_DSCP)
64 * (These are also indexed into struct classifier's 'tables' array.) */
66 #define CLS_FIELD(MEMBER, NAME) CLS_F_IDX_##NAME,
72 /* Field information. */
74 int ofs; /* Offset in struct flow. */
75 int len; /* Length in bytes. */
76 const char *name; /* Name (for debugging). */
79 static const struct cls_field cls_fields[CLS_N_FIELDS] = {
80 #define CLS_FIELD(MEMBER, NAME) \
81 { offsetof(struct flow, MEMBER), \
82 sizeof ((struct flow *)0)->MEMBER, \
89 int aux; /* Auxiliary data. */
90 struct cls_rule cls_rule; /* Classifier rule data. */
93 static struct test_rule *
94 test_rule_from_cls_rule(const struct cls_rule *rule)
96 return rule ? CONTAINER_OF(rule, struct test_rule, cls_rule) : NULL;
100 test_rule_destroy(struct test_rule *rule)
103 cls_rule_destroy(&rule->cls_rule);
108 static struct test_rule *make_rule(int wc_fields, unsigned int priority,
110 static void free_rule(struct test_rule *);
111 static struct test_rule *clone_rule(const struct test_rule *);
113 /* Trivial (linear) classifier. */
116 size_t allocated_rules;
117 struct test_rule **rules;
121 tcls_init(struct tcls *tcls)
124 tcls->allocated_rules = 0;
129 tcls_destroy(struct tcls *tcls)
134 for (i = 0; i < tcls->n_rules; i++) {
135 test_rule_destroy(tcls->rules[i]);
142 tcls_is_empty(const struct tcls *tcls)
144 return tcls->n_rules == 0;
147 static struct test_rule *
148 tcls_insert(struct tcls *tcls, const struct test_rule *rule)
152 for (i = 0; i < tcls->n_rules; i++) {
153 const struct cls_rule *pos = &tcls->rules[i]->cls_rule;
154 if (cls_rule_equal(pos, &rule->cls_rule)) {
156 free_rule(tcls->rules[i]);
157 tcls->rules[i] = clone_rule(rule);
158 return tcls->rules[i];
159 } else if (pos->priority < rule->cls_rule.priority) {
164 if (tcls->n_rules >= tcls->allocated_rules) {
165 tcls->rules = x2nrealloc(tcls->rules, &tcls->allocated_rules,
166 sizeof *tcls->rules);
168 if (i != tcls->n_rules) {
169 memmove(&tcls->rules[i + 1], &tcls->rules[i],
170 sizeof *tcls->rules * (tcls->n_rules - i));
172 tcls->rules[i] = clone_rule(rule);
174 return tcls->rules[i];
178 tcls_remove(struct tcls *cls, const struct test_rule *rule)
182 for (i = 0; i < cls->n_rules; i++) {
183 struct test_rule *pos = cls->rules[i];
185 test_rule_destroy(pos);
187 memmove(&cls->rules[i], &cls->rules[i + 1],
188 sizeof *cls->rules * (cls->n_rules - i - 1));
198 match(const struct cls_rule *wild_, const struct flow *fixed)
203 minimatch_expand(&wild_->match, &wild);
204 for (f_idx = 0; f_idx < CLS_N_FIELDS; f_idx++) {
207 if (f_idx == CLS_F_IDX_NW_SRC) {
208 eq = !((fixed->nw_src ^ wild.flow.nw_src)
209 & wild.wc.masks.nw_src);
210 } else if (f_idx == CLS_F_IDX_NW_DST) {
211 eq = !((fixed->nw_dst ^ wild.flow.nw_dst)
212 & wild.wc.masks.nw_dst);
213 } else if (f_idx == CLS_F_IDX_TP_SRC) {
214 eq = !((fixed->tp_src ^ wild.flow.tp_src)
215 & wild.wc.masks.tp_src);
216 } else if (f_idx == CLS_F_IDX_TP_DST) {
217 eq = !((fixed->tp_dst ^ wild.flow.tp_dst)
218 & wild.wc.masks.tp_dst);
219 } else if (f_idx == CLS_F_IDX_DL_SRC) {
220 eq = eth_addr_equal_except(fixed->dl_src, wild.flow.dl_src,
221 wild.wc.masks.dl_src);
222 } else if (f_idx == CLS_F_IDX_DL_DST) {
223 eq = eth_addr_equal_except(fixed->dl_dst, wild.flow.dl_dst,
224 wild.wc.masks.dl_dst);
225 } else if (f_idx == CLS_F_IDX_VLAN_TCI) {
226 eq = !((fixed->vlan_tci ^ wild.flow.vlan_tci)
227 & wild.wc.masks.vlan_tci);
228 } else if (f_idx == CLS_F_IDX_TUN_ID) {
229 eq = !((fixed->tunnel.tun_id ^ wild.flow.tunnel.tun_id)
230 & wild.wc.masks.tunnel.tun_id);
231 } else if (f_idx == CLS_F_IDX_METADATA) {
232 eq = !((fixed->metadata ^ wild.flow.metadata)
233 & wild.wc.masks.metadata);
234 } else if (f_idx == CLS_F_IDX_NW_DSCP) {
235 eq = !((fixed->nw_tos ^ wild.flow.nw_tos) &
236 (wild.wc.masks.nw_tos & IP_DSCP_MASK));
237 } else if (f_idx == CLS_F_IDX_NW_PROTO) {
238 eq = !((fixed->nw_proto ^ wild.flow.nw_proto)
239 & wild.wc.masks.nw_proto);
240 } else if (f_idx == CLS_F_IDX_DL_TYPE) {
241 eq = !((fixed->dl_type ^ wild.flow.dl_type)
242 & wild.wc.masks.dl_type);
243 } else if (f_idx == CLS_F_IDX_IN_PORT) {
244 eq = !((fixed->in_port.ofp_port
245 ^ wild.flow.in_port.ofp_port)
246 & wild.wc.masks.in_port.ofp_port);
258 static struct cls_rule *
259 tcls_lookup(const struct tcls *cls, const struct flow *flow)
263 for (i = 0; i < cls->n_rules; i++) {
264 struct test_rule *pos = cls->rules[i];
265 if (match(&pos->cls_rule, flow)) {
266 return &pos->cls_rule;
273 tcls_delete_matches(struct tcls *cls, const struct cls_rule *target)
277 for (i = 0; i < cls->n_rules; ) {
278 struct test_rule *pos = cls->rules[i];
279 if (!minimask_has_extra(&pos->cls_rule.match.mask,
280 &target->match.mask)) {
283 miniflow_expand(&pos->cls_rule.match.flow, &flow);
284 if (match(target, &flow)) {
285 tcls_remove(cls, pos);
293 static ovs_be32 nw_src_values[] = { CONSTANT_HTONL(0xc0a80001),
294 CONSTANT_HTONL(0xc0a04455) };
295 static ovs_be32 nw_dst_values[] = { CONSTANT_HTONL(0xc0a80002),
296 CONSTANT_HTONL(0xc0a04455) };
297 static ovs_be64 tun_id_values[] = {
299 CONSTANT_HTONLL(UINT64_C(0xfedcba9876543210)) };
300 static ovs_be64 metadata_values[] = {
302 CONSTANT_HTONLL(UINT64_C(0xfedcba9876543210)) };
303 static ofp_port_t in_port_values[] = { OFP_PORT_C(1), OFPP_LOCAL };
304 static ovs_be16 vlan_tci_values[] = { CONSTANT_HTONS(101), CONSTANT_HTONS(0) };
305 static ovs_be16 dl_type_values[]
306 = { CONSTANT_HTONS(ETH_TYPE_IP), CONSTANT_HTONS(ETH_TYPE_ARP) };
307 static ovs_be16 tp_src_values[] = { CONSTANT_HTONS(49362),
308 CONSTANT_HTONS(80) };
309 static ovs_be16 tp_dst_values[] = { CONSTANT_HTONS(6667), CONSTANT_HTONS(22) };
310 static uint8_t dl_src_values[][6] = { { 0x00, 0x02, 0xe3, 0x0f, 0x80, 0xa4 },
311 { 0x5e, 0x33, 0x7f, 0x5f, 0x1e, 0x99 } };
312 static uint8_t dl_dst_values[][6] = { { 0x4a, 0x27, 0x71, 0xae, 0x64, 0xc1 },
313 { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } };
314 static uint8_t nw_proto_values[] = { IPPROTO_TCP, IPPROTO_ICMP };
315 static uint8_t nw_dscp_values[] = { 48, 0 };
317 static void *values[CLS_N_FIELDS][2];
322 values[CLS_F_IDX_TUN_ID][0] = &tun_id_values[0];
323 values[CLS_F_IDX_TUN_ID][1] = &tun_id_values[1];
325 values[CLS_F_IDX_METADATA][0] = &metadata_values[0];
326 values[CLS_F_IDX_METADATA][1] = &metadata_values[1];
328 values[CLS_F_IDX_IN_PORT][0] = &in_port_values[0];
329 values[CLS_F_IDX_IN_PORT][1] = &in_port_values[1];
331 values[CLS_F_IDX_VLAN_TCI][0] = &vlan_tci_values[0];
332 values[CLS_F_IDX_VLAN_TCI][1] = &vlan_tci_values[1];
334 values[CLS_F_IDX_DL_SRC][0] = dl_src_values[0];
335 values[CLS_F_IDX_DL_SRC][1] = dl_src_values[1];
337 values[CLS_F_IDX_DL_DST][0] = dl_dst_values[0];
338 values[CLS_F_IDX_DL_DST][1] = dl_dst_values[1];
340 values[CLS_F_IDX_DL_TYPE][0] = &dl_type_values[0];
341 values[CLS_F_IDX_DL_TYPE][1] = &dl_type_values[1];
343 values[CLS_F_IDX_NW_SRC][0] = &nw_src_values[0];
344 values[CLS_F_IDX_NW_SRC][1] = &nw_src_values[1];
346 values[CLS_F_IDX_NW_DST][0] = &nw_dst_values[0];
347 values[CLS_F_IDX_NW_DST][1] = &nw_dst_values[1];
349 values[CLS_F_IDX_NW_PROTO][0] = &nw_proto_values[0];
350 values[CLS_F_IDX_NW_PROTO][1] = &nw_proto_values[1];
352 values[CLS_F_IDX_NW_DSCP][0] = &nw_dscp_values[0];
353 values[CLS_F_IDX_NW_DSCP][1] = &nw_dscp_values[1];
355 values[CLS_F_IDX_TP_SRC][0] = &tp_src_values[0];
356 values[CLS_F_IDX_TP_SRC][1] = &tp_src_values[1];
358 values[CLS_F_IDX_TP_DST][0] = &tp_dst_values[0];
359 values[CLS_F_IDX_TP_DST][1] = &tp_dst_values[1];
362 #define N_NW_SRC_VALUES ARRAY_SIZE(nw_src_values)
363 #define N_NW_DST_VALUES ARRAY_SIZE(nw_dst_values)
364 #define N_TUN_ID_VALUES ARRAY_SIZE(tun_id_values)
365 #define N_METADATA_VALUES ARRAY_SIZE(metadata_values)
366 #define N_IN_PORT_VALUES ARRAY_SIZE(in_port_values)
367 #define N_VLAN_TCI_VALUES ARRAY_SIZE(vlan_tci_values)
368 #define N_DL_TYPE_VALUES ARRAY_SIZE(dl_type_values)
369 #define N_TP_SRC_VALUES ARRAY_SIZE(tp_src_values)
370 #define N_TP_DST_VALUES ARRAY_SIZE(tp_dst_values)
371 #define N_DL_SRC_VALUES ARRAY_SIZE(dl_src_values)
372 #define N_DL_DST_VALUES ARRAY_SIZE(dl_dst_values)
373 #define N_NW_PROTO_VALUES ARRAY_SIZE(nw_proto_values)
374 #define N_NW_DSCP_VALUES ARRAY_SIZE(nw_dscp_values)
376 #define N_FLOW_VALUES (N_NW_SRC_VALUES * \
380 N_VLAN_TCI_VALUES * \
386 N_NW_PROTO_VALUES * \
390 get_value(unsigned int *x, unsigned n_values)
392 unsigned int rem = *x % n_values;
398 compare_classifiers(struct classifier *cls, struct tcls *tcls)
399 OVS_REQ_RDLOCK(cls->rwlock)
401 static const int confidence = 500;
404 assert(classifier_count(cls) == tcls->n_rules);
405 for (i = 0; i < confidence; i++) {
406 struct cls_rule *cr0, *cr1, *cr2;
408 struct flow_wildcards wc;
411 flow_wildcards_init_catchall(&wc);
412 x = random_range(N_FLOW_VALUES);
413 memset(&flow, 0, sizeof flow);
414 flow.nw_src = nw_src_values[get_value(&x, N_NW_SRC_VALUES)];
415 flow.nw_dst = nw_dst_values[get_value(&x, N_NW_DST_VALUES)];
416 flow.tunnel.tun_id = tun_id_values[get_value(&x, N_TUN_ID_VALUES)];
417 flow.metadata = metadata_values[get_value(&x, N_METADATA_VALUES)];
418 flow.in_port.ofp_port = in_port_values[get_value(&x,
420 flow.vlan_tci = vlan_tci_values[get_value(&x, N_VLAN_TCI_VALUES)];
421 flow.dl_type = dl_type_values[get_value(&x, N_DL_TYPE_VALUES)];
422 flow.tp_src = tp_src_values[get_value(&x, N_TP_SRC_VALUES)];
423 flow.tp_dst = tp_dst_values[get_value(&x, N_TP_DST_VALUES)];
424 memcpy(flow.dl_src, dl_src_values[get_value(&x, N_DL_SRC_VALUES)],
426 memcpy(flow.dl_dst, dl_dst_values[get_value(&x, N_DL_DST_VALUES)],
428 flow.nw_proto = nw_proto_values[get_value(&x, N_NW_PROTO_VALUES)];
429 flow.nw_tos = nw_dscp_values[get_value(&x, N_NW_DSCP_VALUES)];
431 cr0 = classifier_lookup(cls, &flow, &wc);
432 cr1 = tcls_lookup(tcls, &flow);
433 assert((cr0 == NULL) == (cr1 == NULL));
435 const struct test_rule *tr0 = test_rule_from_cls_rule(cr0);
436 const struct test_rule *tr1 = test_rule_from_cls_rule(cr1);
438 assert(cls_rule_equal(cr0, cr1));
439 assert(tr0->aux == tr1->aux);
441 cr2 = classifier_lookup(cls, &flow, NULL);
447 destroy_classifier(struct classifier *cls)
449 struct test_rule *rule, *next_rule;
450 struct cls_cursor cursor;
452 fat_rwlock_wrlock(&cls->rwlock);
453 cls_cursor_init(&cursor, cls, NULL);
454 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cls_rule, &cursor) {
455 classifier_remove(cls, &rule->cls_rule);
458 fat_rwlock_unlock(&cls->rwlock);
459 classifier_destroy(cls);
463 check_tables(const struct classifier *cls, int n_tables, int n_rules,
464 int n_dups) OVS_REQ_RDLOCK(cls->rwlock)
466 const struct cls_subtable *table;
467 struct test_rule *test_rule;
468 struct cls_cursor cursor;
469 int found_tables = 0;
472 int found_rules2 = 0;
474 HMAP_FOR_EACH (table, hmap_node, &cls->subtables) {
475 const struct cls_rule *head;
476 unsigned int max_priority = 0;
477 unsigned int max_count = 0;
479 assert(!hmap_is_empty(&table->rules));
482 HMAP_FOR_EACH (head, hmap_node, &table->rules) {
483 unsigned int prev_priority = UINT_MAX;
484 const struct cls_rule *rule;
486 if (head->priority > max_priority) {
487 max_priority = head->priority;
489 } else if (head->priority == max_priority) {
494 LIST_FOR_EACH (rule, list, &head->list) {
495 assert(rule->priority < prev_priority);
496 assert(rule->priority <= table->max_priority);
498 prev_priority = rule->priority;
501 assert(classifier_find_rule_exactly(cls, rule) == rule);
504 assert(table->max_priority == max_priority);
505 assert(table->max_count == max_count);
508 assert(found_tables == hmap_count(&cls->subtables));
509 assert(n_tables == -1 || n_tables == hmap_count(&cls->subtables));
510 assert(n_rules == -1 || found_rules == n_rules);
511 assert(n_dups == -1 || found_dups == n_dups);
513 cls_cursor_init(&cursor, cls, NULL);
514 CLS_CURSOR_FOR_EACH (test_rule, cls_rule, &cursor) {
517 assert(found_rules == found_rules2);
520 static struct test_rule *
521 make_rule(int wc_fields, unsigned int priority, int value_pat)
523 const struct cls_field *f;
524 struct test_rule *rule;
527 match_init_catchall(&match);
528 for (f = &cls_fields[0]; f < &cls_fields[CLS_N_FIELDS]; f++) {
529 int f_idx = f - cls_fields;
530 int value_idx = (value_pat & (1u << f_idx)) != 0;
531 memcpy((char *) &match.flow + f->ofs,
532 values[f_idx][value_idx], f->len);
534 if (f_idx == CLS_F_IDX_NW_SRC) {
535 match.wc.masks.nw_src = OVS_BE32_MAX;
536 } else if (f_idx == CLS_F_IDX_NW_DST) {
537 match.wc.masks.nw_dst = OVS_BE32_MAX;
538 } else if (f_idx == CLS_F_IDX_TP_SRC) {
539 match.wc.masks.tp_src = OVS_BE16_MAX;
540 } else if (f_idx == CLS_F_IDX_TP_DST) {
541 match.wc.masks.tp_dst = OVS_BE16_MAX;
542 } else if (f_idx == CLS_F_IDX_DL_SRC) {
543 memset(match.wc.masks.dl_src, 0xff, ETH_ADDR_LEN);
544 } else if (f_idx == CLS_F_IDX_DL_DST) {
545 memset(match.wc.masks.dl_dst, 0xff, ETH_ADDR_LEN);
546 } else if (f_idx == CLS_F_IDX_VLAN_TCI) {
547 match.wc.masks.vlan_tci = OVS_BE16_MAX;
548 } else if (f_idx == CLS_F_IDX_TUN_ID) {
549 match.wc.masks.tunnel.tun_id = OVS_BE64_MAX;
550 } else if (f_idx == CLS_F_IDX_METADATA) {
551 match.wc.masks.metadata = OVS_BE64_MAX;
552 } else if (f_idx == CLS_F_IDX_NW_DSCP) {
553 match.wc.masks.nw_tos |= IP_DSCP_MASK;
554 } else if (f_idx == CLS_F_IDX_NW_PROTO) {
555 match.wc.masks.nw_proto = UINT8_MAX;
556 } else if (f_idx == CLS_F_IDX_DL_TYPE) {
557 match.wc.masks.dl_type = OVS_BE16_MAX;
558 } else if (f_idx == CLS_F_IDX_IN_PORT) {
559 match.wc.masks.in_port.ofp_port = u16_to_ofp(UINT16_MAX);
565 rule = xzalloc(sizeof *rule);
566 cls_rule_init(&rule->cls_rule, &match, wc_fields ? priority : UINT_MAX);
570 static struct test_rule *
571 clone_rule(const struct test_rule *src)
573 struct test_rule *dst;
575 dst = xmalloc(sizeof *dst);
577 cls_rule_clone(&dst->cls_rule, &src->cls_rule);
582 free_rule(struct test_rule *rule)
584 cls_rule_destroy(&rule->cls_rule);
589 shuffle(unsigned int *p, size_t n)
591 for (; n > 1; n--, p++) {
592 unsigned int *q = &p[random_range(n)];
593 unsigned int tmp = *p;
600 shuffle_u32s(uint32_t *p, size_t n)
602 for (; n > 1; n--, p++) {
603 uint32_t *q = &p[random_range(n)];
610 /* Classifier tests. */
612 static enum mf_field_id trie_fields[2] = {
613 MFF_IPV4_DST, MFF_IPV4_SRC
616 /* Tests an empty classifier. */
618 test_empty(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
620 struct classifier cls;
623 classifier_init(&cls, flow_segment_u32s);
624 fat_rwlock_wrlock(&cls.rwlock);
625 classifier_set_prefix_fields(&cls, trie_fields, ARRAY_SIZE(trie_fields));
627 assert(classifier_is_empty(&cls));
628 assert(tcls_is_empty(&tcls));
629 compare_classifiers(&cls, &tcls);
630 fat_rwlock_unlock(&cls.rwlock);
631 classifier_destroy(&cls);
635 /* Destroys a null classifier. */
637 test_destroy_null(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
639 classifier_destroy(NULL);
642 /* Tests classification with one rule at a time. */
644 test_single_rule(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
646 unsigned int wc_fields; /* Hilarious. */
648 for (wc_fields = 0; wc_fields < (1u << CLS_N_FIELDS); wc_fields++) {
649 struct classifier cls;
650 struct test_rule *rule, *tcls_rule;
653 rule = make_rule(wc_fields,
654 hash_bytes(&wc_fields, sizeof wc_fields, 0), 0);
656 classifier_init(&cls, flow_segment_u32s);
657 fat_rwlock_wrlock(&cls.rwlock);
658 classifier_set_prefix_fields(&cls, trie_fields,
659 ARRAY_SIZE(trie_fields));
662 tcls_rule = tcls_insert(&tcls, rule);
663 classifier_insert(&cls, &rule->cls_rule);
664 check_tables(&cls, 1, 1, 0);
665 compare_classifiers(&cls, &tcls);
667 classifier_remove(&cls, &rule->cls_rule);
668 tcls_remove(&tcls, tcls_rule);
669 assert(classifier_is_empty(&cls));
670 assert(tcls_is_empty(&tcls));
671 compare_classifiers(&cls, &tcls);
674 fat_rwlock_unlock(&cls.rwlock);
675 classifier_destroy(&cls);
680 /* Tests replacing one rule by another. */
682 test_rule_replacement(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
684 unsigned int wc_fields;
686 for (wc_fields = 0; wc_fields < (1u << CLS_N_FIELDS); wc_fields++) {
687 struct classifier cls;
688 struct test_rule *rule1;
689 struct test_rule *rule2;
692 rule1 = make_rule(wc_fields, OFP_DEFAULT_PRIORITY, UINT_MAX);
693 rule2 = make_rule(wc_fields, OFP_DEFAULT_PRIORITY, UINT_MAX);
697 classifier_init(&cls, flow_segment_u32s);
698 fat_rwlock_wrlock(&cls.rwlock);
699 classifier_set_prefix_fields(&cls, trie_fields,
700 ARRAY_SIZE(trie_fields));
702 tcls_insert(&tcls, rule1);
703 classifier_insert(&cls, &rule1->cls_rule);
704 check_tables(&cls, 1, 1, 0);
705 compare_classifiers(&cls, &tcls);
709 tcls_insert(&tcls, rule2);
710 assert(test_rule_from_cls_rule(
711 classifier_replace(&cls, &rule2->cls_rule)) == rule1);
713 check_tables(&cls, 1, 1, 0);
714 compare_classifiers(&cls, &tcls);
716 fat_rwlock_unlock(&cls.rwlock);
717 destroy_classifier(&cls);
722 factorial(int n_items)
727 for (i = 2; i <= n_items; i++) {
742 reverse(int *a, int n)
746 for (i = 0; i < n / 2; i++) {
753 next_permutation(int *a, int n)
757 for (k = n - 2; k >= 0; k--) {
758 if (a[k] < a[k + 1]) {
761 for (l = n - 1; ; l--) {
764 reverse(a + (k + 1), n - (k + 1));
773 /* Tests classification with rules that have the same matching criteria. */
775 test_many_rules_in_one_list (int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
777 enum { N_RULES = 3 };
780 for (n_pris = N_RULES; n_pris >= 1; n_pris--) {
781 int ops[N_RULES * 2];
787 for (i = 1; i < N_RULES; i++) {
788 pris[i] = pris[i - 1] + (n_pris > i);
791 for (i = 0; i < N_RULES * 2; i++) {
797 struct test_rule *rules[N_RULES];
798 struct test_rule *tcls_rules[N_RULES];
799 int pri_rules[N_RULES];
800 struct classifier cls;
805 for (i = 0; i < N_RULES; i++) {
806 rules[i] = make_rule(456, pris[i], 0);
807 tcls_rules[i] = NULL;
811 classifier_init(&cls, flow_segment_u32s);
812 fat_rwlock_wrlock(&cls.rwlock);
813 classifier_set_prefix_fields(&cls, trie_fields,
814 ARRAY_SIZE(trie_fields));
817 for (i = 0; i < ARRAY_SIZE(ops); i++) {
821 if (!tcls_rules[j]) {
822 struct test_rule *displaced_rule;
824 tcls_rules[j] = tcls_insert(&tcls, rules[j]);
825 displaced_rule = test_rule_from_cls_rule(
826 classifier_replace(&cls, &rules[j]->cls_rule));
827 if (pri_rules[pris[j]] >= 0) {
828 int k = pri_rules[pris[j]];
829 assert(displaced_rule != NULL);
830 assert(displaced_rule != rules[j]);
831 assert(pris[j] == displaced_rule->cls_rule.priority);
832 tcls_rules[k] = NULL;
834 assert(displaced_rule == NULL);
836 pri_rules[pris[j]] = j;
838 classifier_remove(&cls, &rules[j]->cls_rule);
839 tcls_remove(&tcls, tcls_rules[j]);
840 tcls_rules[j] = NULL;
841 pri_rules[pris[j]] = -1;
845 for (m = 0; m < N_RULES; m++) {
846 n += tcls_rules[m] != NULL;
848 check_tables(&cls, n > 0, n, n - 1);
850 compare_classifiers(&cls, &tcls);
853 fat_rwlock_unlock(&cls.rwlock);
854 classifier_destroy(&cls);
857 for (i = 0; i < N_RULES; i++) {
860 } while (next_permutation(ops, ARRAY_SIZE(ops)));
861 assert(n_permutations == (factorial(N_RULES * 2) >> N_RULES));
866 count_ones(unsigned long int x)
871 x = zero_rightmost_1bit(x);
879 array_contains(int *array, int n, int value)
883 for (i = 0; i < n; i++) {
884 if (array[i] == value) {
892 /* Tests classification with two rules at a time that fall into the same
893 * table but different lists. */
895 test_many_rules_in_one_table(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
899 for (iteration = 0; iteration < 50; iteration++) {
900 enum { N_RULES = 20 };
901 struct test_rule *rules[N_RULES];
902 struct test_rule *tcls_rules[N_RULES];
903 struct classifier cls;
905 int value_pats[N_RULES];
911 wcf = random_uint32() & ((1u << CLS_N_FIELDS) - 1);
912 value_mask = ~wcf & ((1u << CLS_N_FIELDS) - 1);
913 } while ((1 << count_ones(value_mask)) < N_RULES);
915 classifier_init(&cls, flow_segment_u32s);
916 fat_rwlock_wrlock(&cls.rwlock);
917 classifier_set_prefix_fields(&cls, trie_fields,
918 ARRAY_SIZE(trie_fields));
921 for (i = 0; i < N_RULES; i++) {
922 unsigned int priority = random_uint32();
925 value_pats[i] = random_uint32() & value_mask;
926 } while (array_contains(value_pats, i, value_pats[i]));
928 rules[i] = make_rule(wcf, priority, value_pats[i]);
929 tcls_rules[i] = tcls_insert(&tcls, rules[i]);
930 classifier_insert(&cls, &rules[i]->cls_rule);
932 check_tables(&cls, 1, i + 1, 0);
933 compare_classifiers(&cls, &tcls);
936 for (i = 0; i < N_RULES; i++) {
937 tcls_remove(&tcls, tcls_rules[i]);
938 classifier_remove(&cls, &rules[i]->cls_rule);
941 check_tables(&cls, i < N_RULES - 1, N_RULES - (i + 1), 0);
942 compare_classifiers(&cls, &tcls);
945 fat_rwlock_unlock(&cls.rwlock);
946 classifier_destroy(&cls);
951 /* Tests classification with many rules at a time that fall into random lists
954 test_many_rules_in_n_tables(int n_tables)
956 enum { MAX_RULES = 50 };
961 assert(n_tables < 10);
962 for (i = 0; i < n_tables; i++) {
964 wcfs[i] = random_uint32() & ((1u << CLS_N_FIELDS) - 1);
965 } while (array_contains(wcfs, i, wcfs[i]));
968 for (iteration = 0; iteration < 30; iteration++) {
969 unsigned int priorities[MAX_RULES];
970 struct classifier cls;
973 random_set_seed(iteration + 1);
974 for (i = 0; i < MAX_RULES; i++) {
975 priorities[i] = i * 129;
977 shuffle(priorities, ARRAY_SIZE(priorities));
979 classifier_init(&cls, flow_segment_u32s);
980 fat_rwlock_wrlock(&cls.rwlock);
981 classifier_set_prefix_fields(&cls, trie_fields,
982 ARRAY_SIZE(trie_fields));
985 for (i = 0; i < MAX_RULES; i++) {
986 struct test_rule *rule;
987 unsigned int priority = priorities[i];
988 int wcf = wcfs[random_range(n_tables)];
989 int value_pat = random_uint32() & ((1u << CLS_N_FIELDS) - 1);
990 rule = make_rule(wcf, priority, value_pat);
991 tcls_insert(&tcls, rule);
992 classifier_insert(&cls, &rule->cls_rule);
993 check_tables(&cls, -1, i + 1, -1);
994 compare_classifiers(&cls, &tcls);
997 while (!classifier_is_empty(&cls)) {
998 struct test_rule *rule, *next_rule;
999 struct test_rule *target;
1000 struct cls_cursor cursor;
1002 target = clone_rule(tcls.rules[random_range(tcls.n_rules)]);
1004 cls_cursor_init(&cursor, &cls, &target->cls_rule);
1005 CLS_CURSOR_FOR_EACH_SAFE (rule, next_rule, cls_rule, &cursor) {
1006 classifier_remove(&cls, &rule->cls_rule);
1009 tcls_delete_matches(&tcls, &target->cls_rule);
1010 compare_classifiers(&cls, &tcls);
1011 check_tables(&cls, -1, -1, -1);
1015 fat_rwlock_unlock(&cls.rwlock);
1016 destroy_classifier(&cls);
1017 tcls_destroy(&tcls);
1022 test_many_rules_in_two_tables(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1024 test_many_rules_in_n_tables(2);
1028 test_many_rules_in_five_tables(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1030 test_many_rules_in_n_tables(5);
1033 /* Miniflow tests. */
1038 static const uint32_t values[] =
1039 { 0xffffffff, 0xaaaaaaaa, 0x55555555, 0x80000000,
1040 0x00000001, 0xface0000, 0x00d00d1e, 0xdeadbeef };
1042 return values[random_range(ARRAY_SIZE(values))];
1046 choose(unsigned int n, unsigned int *idxp)
1057 init_consecutive_values(int n_consecutive, struct flow *flow,
1060 uint32_t *flow_u32 = (uint32_t *) flow;
1062 if (choose(FLOW_U32S - n_consecutive + 1, idxp)) {
1065 for (i = 0; i < n_consecutive; i++) {
1066 flow_u32[*idxp + i] = random_value();
1075 next_random_flow(struct flow *flow, unsigned int idx)
1077 uint32_t *flow_u32 = (uint32_t *) flow;
1080 memset(flow, 0, sizeof *flow);
1083 if (choose(1, &idx)) {
1087 /* All flows with a small number of consecutive nonzero values. */
1088 for (i = 1; i <= 4; i++) {
1089 if (init_consecutive_values(i, flow, &idx)) {
1094 /* All flows with a large number of consecutive nonzero values. */
1095 for (i = FLOW_U32S - 4; i <= FLOW_U32S; i++) {
1096 if (init_consecutive_values(i, flow, &idx)) {
1101 /* All flows with exactly two nonconsecutive nonzero values. */
1102 if (choose((FLOW_U32S - 1) * (FLOW_U32S - 2) / 2, &idx)) {
1105 for (ofs1 = 0; ofs1 < FLOW_U32S - 2; ofs1++) {
1108 for (ofs2 = ofs1 + 2; ofs2 < FLOW_U32S; ofs2++) {
1109 if (choose(1, &idx)) {
1110 flow_u32[ofs1] = random_value();
1111 flow_u32[ofs2] = random_value();
1119 /* 16 randomly chosen flows with N >= 3 nonzero values. */
1120 if (choose(16 * (FLOW_U32S - 4), &idx)) {
1121 int n = idx / 16 + 3;
1124 for (i = 0; i < n; i++) {
1125 flow_u32[i] = random_value();
1127 shuffle_u32s(flow_u32, FLOW_U32S);
1136 any_random_flow(struct flow *flow)
1138 static unsigned int max;
1140 while (next_random_flow(flow, max)) {
1145 next_random_flow(flow, random_range(max));
1149 toggle_masked_flow_bits(struct flow *flow, const struct flow_wildcards *mask)
1151 const uint32_t *mask_u32 = (const uint32_t *) &mask->masks;
1152 uint32_t *flow_u32 = (uint32_t *) flow;
1155 for (i = 0; i < FLOW_U32S; i++) {
1156 if (mask_u32[i] != 0) {
1160 bit = 1u << random_range(32);
1161 } while (!(bit & mask_u32[i]));
1168 wildcard_extra_bits(struct flow_wildcards *mask)
1170 uint32_t *mask_u32 = (uint32_t *) &mask->masks;
1173 for (i = 0; i < FLOW_U32S; i++) {
1174 if (mask_u32[i] != 0) {
1178 bit = 1u << random_range(32);
1179 } while (!(bit & mask_u32[i]));
1180 mask_u32[i] &= ~bit;
1186 test_miniflow(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1191 random_set_seed(0xb3faca38);
1192 for (idx = 0; next_random_flow(&flow, idx); idx++) {
1193 const uint32_t *flow_u32 = (const uint32_t *) &flow;
1194 struct miniflow miniflow, miniflow2, miniflow3;
1195 struct flow flow2, flow3;
1196 struct flow_wildcards mask;
1197 struct minimask minimask;
1200 /* Convert flow to miniflow. */
1201 miniflow_init(&miniflow, &flow);
1203 /* Check that the flow equals its miniflow. */
1204 assert(miniflow_get_vid(&miniflow) == vlan_tci_to_vid(flow.vlan_tci));
1205 for (i = 0; i < FLOW_U32S; i++) {
1206 assert(miniflow_get(&miniflow, i) == flow_u32[i]);
1209 /* Check that the miniflow equals itself. */
1210 assert(miniflow_equal(&miniflow, &miniflow));
1212 /* Convert miniflow back to flow and verify that it's the same. */
1213 miniflow_expand(&miniflow, &flow2);
1214 assert(flow_equal(&flow, &flow2));
1216 /* Check that copying a miniflow works properly. */
1217 miniflow_clone(&miniflow2, &miniflow);
1218 assert(miniflow_equal(&miniflow, &miniflow2));
1219 assert(miniflow_hash(&miniflow, 0) == miniflow_hash(&miniflow2, 0));
1220 miniflow_expand(&miniflow2, &flow3);
1221 assert(flow_equal(&flow, &flow3));
1223 /* Check that masked matches work as expected for identical flows and
1226 next_random_flow(&mask.masks, 1);
1227 } while (flow_wildcards_is_catchall(&mask));
1228 minimask_init(&minimask, &mask);
1229 assert(minimask_is_catchall(&minimask)
1230 == flow_wildcards_is_catchall(&mask));
1231 assert(miniflow_equal_in_minimask(&miniflow, &miniflow2, &minimask));
1232 assert(miniflow_equal_flow_in_minimask(&miniflow, &flow2, &minimask));
1233 assert(miniflow_hash_in_minimask(&miniflow, &minimask, 0x12345678) ==
1234 flow_hash_in_minimask(&flow, &minimask, 0x12345678));
1236 /* Check that masked matches work as expected for differing flows and
1238 toggle_masked_flow_bits(&flow2, &mask);
1239 assert(!miniflow_equal_flow_in_minimask(&miniflow, &flow2, &minimask));
1240 miniflow_init(&miniflow3, &flow2);
1241 assert(!miniflow_equal_in_minimask(&miniflow, &miniflow3, &minimask));
1244 miniflow_destroy(&miniflow);
1245 miniflow_destroy(&miniflow2);
1246 miniflow_destroy(&miniflow3);
1247 minimask_destroy(&minimask);
1252 test_minimask_has_extra(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1254 struct flow_wildcards catchall;
1255 struct minimask minicatchall;
1259 flow_wildcards_init_catchall(&catchall);
1260 minimask_init(&minicatchall, &catchall);
1261 assert(minimask_is_catchall(&minicatchall));
1263 random_set_seed(0x2ec7905b);
1264 for (idx = 0; next_random_flow(&flow, idx); idx++) {
1265 struct flow_wildcards mask;
1266 struct minimask minimask;
1269 minimask_init(&minimask, &mask);
1270 assert(!minimask_has_extra(&minimask, &minimask));
1271 assert(minimask_has_extra(&minicatchall, &minimask)
1272 == !minimask_is_catchall(&minimask));
1273 if (!minimask_is_catchall(&minimask)) {
1274 struct minimask minimask2;
1276 wildcard_extra_bits(&mask);
1277 minimask_init(&minimask2, &mask);
1278 assert(minimask_has_extra(&minimask2, &minimask));
1279 assert(!minimask_has_extra(&minimask, &minimask2));
1280 minimask_destroy(&minimask2);
1283 minimask_destroy(&minimask);
1286 minimask_destroy(&minicatchall);
1290 test_minimask_combine(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1292 struct flow_wildcards catchall;
1293 struct minimask minicatchall;
1297 flow_wildcards_init_catchall(&catchall);
1298 minimask_init(&minicatchall, &catchall);
1299 assert(minimask_is_catchall(&minicatchall));
1301 random_set_seed(0x181bf0cd);
1302 for (idx = 0; next_random_flow(&flow, idx); idx++) {
1303 struct minimask minimask, minimask2, minicombined;
1304 struct flow_wildcards mask, mask2, combined, combined2;
1305 uint32_t storage[FLOW_U32S];
1309 minimask_init(&minimask, &mask);
1311 minimask_combine(&minicombined, &minimask, &minicatchall, storage);
1312 assert(minimask_is_catchall(&minicombined));
1314 any_random_flow(&flow2);
1315 mask2.masks = flow2;
1316 minimask_init(&minimask2, &mask2);
1318 minimask_combine(&minicombined, &minimask, &minimask2, storage);
1319 flow_wildcards_and(&combined, &mask, &mask2);
1320 minimask_expand(&minicombined, &combined2);
1321 assert(flow_wildcards_equal(&combined, &combined2));
1323 minimask_destroy(&minimask);
1324 minimask_destroy(&minimask2);
1327 minimask_destroy(&minicatchall);
1330 static const struct command commands[] = {
1331 /* Classifier tests. */
1332 {"empty", 0, 0, test_empty},
1333 {"destroy-null", 0, 0, test_destroy_null},
1334 {"single-rule", 0, 0, test_single_rule},
1335 {"rule-replacement", 0, 0, test_rule_replacement},
1336 {"many-rules-in-one-list", 0, 0, test_many_rules_in_one_list},
1337 {"many-rules-in-one-table", 0, 0, test_many_rules_in_one_table},
1338 {"many-rules-in-two-tables", 0, 0, test_many_rules_in_two_tables},
1339 {"many-rules-in-five-tables", 0, 0, test_many_rules_in_five_tables},
1341 /* Miniflow and minimask tests. */
1342 {"miniflow", 0, 0, test_miniflow},
1343 {"minimask_has_extra", 0, 0, test_minimask_has_extra},
1344 {"minimask_combine", 0, 0, test_minimask_combine},
1350 main(int argc, char *argv[])
1352 set_program_name(argv[0]);
1354 run_command(argc - 1, argv + 1, commands);