2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vnet/classify/vnet_classify.h>
17 #include <vnet/classify/in_out_acl.h>
18 #include <vnet/ip/ip.h>
19 #include <vnet/api_errno.h> /* for API error numbers */
20 #include <vnet/l2/l2_classify.h> /* for L2_INPUT_CLASSIFY_NEXT_xxx */
21 #include <vnet/fib/fib_table.h>
22 #include <vppinfra/lock.h>
23 #include <vnet/classify/trace_classify.h>
29 * @brief N-tuple classifier
32 vnet_classify_main_t vnet_classify_main;
34 #if VALIDATION_SCAFFOLDING
35 /* Validation scaffolding */
37 mv (vnet_classify_table_t * t)
41 oldheap = clib_mem_set_heap (t->mheap);
43 clib_mem_set_heap (oldheap);
47 rogue (vnet_classify_table_t * t)
50 vnet_classify_entry_t *v, *save_v;
51 u32 active_elements = 0;
52 vnet_classify_bucket_t *b;
54 for (i = 0; i < t->nbuckets; i++)
59 save_v = vnet_classify_get_entry (t, b->offset);
60 for (j = 0; j < (1 << b->log2_pages); j++)
62 for (k = 0; k < t->entries_per_page; k++)
64 v = vnet_classify_entry_at_index
65 (t, save_v, j * t->entries_per_page + k);
67 if (vnet_classify_entry_is_busy (v))
73 if (active_elements != t->active_elements)
74 clib_warning ("found %u expected %u elts", active_elements,
79 mv (vnet_classify_table_t * t)
84 rogue (vnet_classify_table_t * t)
90 vnet_classify_register_unformat_l2_next_index_fn (unformat_function_t * fn)
92 vnet_classify_main_t *cm = &vnet_classify_main;
94 vec_add1 (cm->unformat_l2_next_index_fns, fn);
98 vnet_classify_register_unformat_ip_next_index_fn (unformat_function_t * fn)
100 vnet_classify_main_t *cm = &vnet_classify_main;
102 vec_add1 (cm->unformat_ip_next_index_fns, fn);
106 vnet_classify_register_unformat_acl_next_index_fn (unformat_function_t * fn)
108 vnet_classify_main_t *cm = &vnet_classify_main;
110 vec_add1 (cm->unformat_acl_next_index_fns, fn);
114 vnet_classify_register_unformat_policer_next_index_fn (unformat_function_t *
117 vnet_classify_main_t *cm = &vnet_classify_main;
119 vec_add1 (cm->unformat_policer_next_index_fns, fn);
123 vnet_classify_register_unformat_opaque_index_fn (unformat_function_t * fn)
125 vnet_classify_main_t *cm = &vnet_classify_main;
127 vec_add1 (cm->unformat_opaque_index_fns, fn);
130 vnet_classify_table_t *
131 vnet_classify_new_table (vnet_classify_main_t *cm, const u8 *mask,
132 u32 nbuckets, u32 memory_size, u32 skip_n_vectors,
135 vnet_classify_table_t *t;
138 nbuckets = 1 << (max_log2 (nbuckets));
140 pool_get_aligned_zero (cm->tables, t, CLIB_CACHE_LINE_BYTES);
142 clib_memset_u32 (t->mask, 0, 4 * ARRAY_LEN (t->mask));
143 clib_memcpy_fast (t->mask, mask, match_n_vectors * sizeof (u32x4));
145 t->next_table_index = ~0;
146 t->nbuckets = nbuckets;
147 t->log2_nbuckets = max_log2 (nbuckets);
148 t->match_n_vectors = match_n_vectors;
149 t->skip_n_vectors = skip_n_vectors;
150 t->entries_per_page = 2;
151 t->load_mask = pow2_mask (match_n_vectors * 2);
153 t->mheap = clib_mem_create_heap (0, memory_size, 1 /* locked */ ,
156 vec_validate_aligned (t->buckets, nbuckets - 1, CLIB_CACHE_LINE_BYTES);
157 oldheap = clib_mem_set_heap (t->mheap);
159 clib_spinlock_init (&t->writer_lock);
160 clib_mem_set_heap (oldheap);
165 vnet_classify_delete_table_index (vnet_classify_main_t * cm,
166 u32 table_index, int del_chain)
168 vnet_classify_table_t *t;
170 /* Tolerate multiple frees, up to a point */
171 if (pool_is_free_index (cm->tables, table_index))
174 t = pool_elt_at_index (cm->tables, table_index);
175 if (del_chain && t->next_table_index != ~0)
176 /* Recursively delete the entire chain */
177 vnet_classify_delete_table_index (cm, t->next_table_index, del_chain);
179 vec_free (t->buckets);
180 clib_mem_destroy_heap (t->mheap);
181 pool_put (cm->tables, t);
184 static vnet_classify_entry_t *
185 vnet_classify_entry_alloc (vnet_classify_table_t * t, u32 log2_pages)
187 vnet_classify_entry_t *rv = 0;
191 CLIB_SPINLOCK_ASSERT_LOCKED (&t->writer_lock);
193 (sizeof (vnet_classify_entry_t) + (t->match_n_vectors * sizeof (u32x4)))
194 * t->entries_per_page * (1 << log2_pages);
196 if (log2_pages >= vec_len (t->freelists) || t->freelists[log2_pages] == 0)
198 oldheap = clib_mem_set_heap (t->mheap);
200 vec_validate (t->freelists, log2_pages);
202 rv = clib_mem_alloc_aligned (required_length, CLIB_CACHE_LINE_BYTES);
203 clib_mem_set_heap (oldheap);
206 rv = t->freelists[log2_pages];
207 t->freelists[log2_pages] = rv->next_free;
212 clib_memset (rv, 0xff, required_length);
217 vnet_classify_entry_free (vnet_classify_table_t * t,
218 vnet_classify_entry_t * v, u32 log2_pages)
220 CLIB_SPINLOCK_ASSERT_LOCKED (&t->writer_lock);
222 ASSERT (vec_len (t->freelists) > log2_pages);
224 v->next_free = t->freelists[log2_pages];
225 t->freelists[log2_pages] = v;
228 static inline void make_working_copy
229 (vnet_classify_table_t * t, vnet_classify_bucket_t * b)
231 vnet_classify_entry_t *v;
232 vnet_classify_bucket_t working_bucket __attribute__ ((aligned (8)));
234 vnet_classify_entry_t *working_copy;
235 u32 thread_index = vlib_get_thread_index ();
236 int working_copy_length, required_length;
238 if (thread_index >= vec_len (t->working_copies))
240 oldheap = clib_mem_set_heap (t->mheap);
241 vec_validate (t->working_copies, thread_index);
242 vec_validate (t->working_copy_lengths, thread_index);
243 t->working_copy_lengths[thread_index] = -1;
244 clib_mem_set_heap (oldheap);
248 * working_copies are per-cpu so that near-simultaneous
249 * updates from multiple threads will not result in sporadic, spurious
252 working_copy = t->working_copies[thread_index];
253 working_copy_length = t->working_copy_lengths[thread_index];
255 (sizeof (vnet_classify_entry_t) + (t->match_n_vectors * sizeof (u32x4)))
256 * t->entries_per_page * (1 << b->log2_pages);
258 t->saved_bucket.as_u64 = b->as_u64;
259 oldheap = clib_mem_set_heap (t->mheap);
261 if (required_length > working_copy_length)
264 clib_mem_free (working_copy);
266 clib_mem_alloc_aligned (required_length, CLIB_CACHE_LINE_BYTES);
267 t->working_copies[thread_index] = working_copy;
270 clib_mem_set_heap (oldheap);
272 v = vnet_classify_get_entry (t, b->offset);
274 clib_memcpy_fast (working_copy, v, required_length);
276 working_bucket.as_u64 = b->as_u64;
277 working_bucket.offset = vnet_classify_get_offset (t, working_copy);
278 CLIB_MEMORY_BARRIER ();
279 b->as_u64 = working_bucket.as_u64;
280 t->working_copies[thread_index] = working_copy;
283 static vnet_classify_entry_t *
284 split_and_rehash (vnet_classify_table_t * t,
285 vnet_classify_entry_t * old_values, u32 old_log2_pages,
288 vnet_classify_entry_t *new_values, *v, *new_v;
289 int i, j, length_in_entries;
291 new_values = vnet_classify_entry_alloc (t, new_log2_pages);
292 length_in_entries = (1 << old_log2_pages) * t->entries_per_page;
294 for (i = 0; i < length_in_entries; i++)
298 v = vnet_classify_entry_at_index (t, old_values, i);
300 if (vnet_classify_entry_is_busy (v))
302 /* Hack so we can use the packet hash routine */
304 key_minus_skip = (u8 *) v->key;
305 key_minus_skip -= t->skip_n_vectors * sizeof (u32x4);
307 new_hash = vnet_classify_hash_packet (t, key_minus_skip);
308 new_hash >>= t->log2_nbuckets;
309 new_hash &= (1 << new_log2_pages) - 1;
311 for (j = 0; j < t->entries_per_page; j++)
313 new_v = vnet_classify_entry_at_index (t, new_values,
316 if (vnet_classify_entry_is_free (new_v))
318 clib_memcpy_fast (new_v, v, sizeof (vnet_classify_entry_t)
319 + (t->match_n_vectors * sizeof (u32x4)));
320 new_v->flags &= ~(VNET_CLASSIFY_ENTRY_FREE);
324 /* Crap. Tell caller to try again */
325 vnet_classify_entry_free (t, new_values, new_log2_pages);
334 static vnet_classify_entry_t *
335 split_and_rehash_linear (vnet_classify_table_t * t,
336 vnet_classify_entry_t * old_values,
337 u32 old_log2_pages, u32 new_log2_pages)
339 vnet_classify_entry_t *new_values, *v, *new_v;
340 int i, j, new_length_in_entries, old_length_in_entries;
342 new_values = vnet_classify_entry_alloc (t, new_log2_pages);
343 new_length_in_entries = (1 << new_log2_pages) * t->entries_per_page;
344 old_length_in_entries = (1 << old_log2_pages) * t->entries_per_page;
347 for (i = 0; i < old_length_in_entries; i++)
349 v = vnet_classify_entry_at_index (t, old_values, i);
351 if (vnet_classify_entry_is_busy (v))
353 for (; j < new_length_in_entries; j++)
355 new_v = vnet_classify_entry_at_index (t, new_values, j);
357 if (vnet_classify_entry_is_busy (new_v))
359 clib_warning ("BUG: linear rehash new entry not free!");
362 clib_memcpy_fast (new_v, v, sizeof (vnet_classify_entry_t)
363 + (t->match_n_vectors * sizeof (u32x4)));
364 new_v->flags &= ~(VNET_CLASSIFY_ENTRY_FREE);
369 * Crap. Tell caller to try again.
370 * This should never happen...
372 clib_warning ("BUG: linear rehash failed!");
373 vnet_classify_entry_free (t, new_values, new_log2_pages);
384 vnet_classify_entry_claim_resource (vnet_classify_entry_t * e)
388 case CLASSIFY_ACTION_SET_IP4_FIB_INDEX:
389 fib_table_lock (e->metadata, FIB_PROTOCOL_IP4, FIB_SOURCE_CLASSIFY);
391 case CLASSIFY_ACTION_SET_IP6_FIB_INDEX:
392 fib_table_lock (e->metadata, FIB_PROTOCOL_IP6, FIB_SOURCE_CLASSIFY);
394 case CLASSIFY_ACTION_SET_METADATA:
395 case CLASSIFY_ACTION_NONE:
401 vnet_classify_entry_release_resource (vnet_classify_entry_t * e)
405 case CLASSIFY_ACTION_SET_IP4_FIB_INDEX:
406 fib_table_unlock (e->metadata, FIB_PROTOCOL_IP4, FIB_SOURCE_CLASSIFY);
408 case CLASSIFY_ACTION_SET_IP6_FIB_INDEX:
409 fib_table_unlock (e->metadata, FIB_PROTOCOL_IP6, FIB_SOURCE_CLASSIFY);
411 case CLASSIFY_ACTION_SET_METADATA:
412 case CLASSIFY_ACTION_NONE:
418 vnet_classify_add_del (vnet_classify_table_t *t, vnet_classify_entry_t *add_v,
422 vnet_classify_bucket_t *b, tmp_b;
423 vnet_classify_entry_t *v, *new_v, *save_new_v, *working_copy, *save_v;
429 u32 old_log2_pages, new_log2_pages;
430 u32 thread_index = vlib_get_thread_index ();
432 int resplit_once = 0;
433 int mark_bucket_linear;
435 ASSERT ((add_v->flags & VNET_CLASSIFY_ENTRY_FREE) == 0);
437 key_minus_skip = (u8 *) add_v->key;
438 key_minus_skip -= t->skip_n_vectors * sizeof (u32x4);
440 hash = vnet_classify_hash_packet (t, key_minus_skip);
442 bucket_index = hash & (t->nbuckets - 1);
443 b = &t->buckets[bucket_index];
445 hash >>= t->log2_nbuckets;
447 clib_spinlock_lock (&t->writer_lock);
449 /* First elt in the bucket? */
458 v = vnet_classify_entry_alloc (t, 0 /* new_log2_pages */ );
459 clib_memcpy_fast (v, add_v, sizeof (vnet_classify_entry_t) +
460 t->match_n_vectors * sizeof (u32x4));
461 v->flags &= ~(VNET_CLASSIFY_ENTRY_FREE);
462 vnet_classify_entry_claim_resource (v);
465 tmp_b.offset = vnet_classify_get_offset (t, v);
467 b->as_u64 = tmp_b.as_u64;
468 t->active_elements++;
473 make_working_copy (t, b);
475 save_v = vnet_classify_get_entry (t, t->saved_bucket.offset);
476 value_index = hash & ((1 << t->saved_bucket.log2_pages) - 1);
477 limit = t->entries_per_page;
478 if (PREDICT_FALSE (b->linear_search))
481 limit *= (1 << b->log2_pages);
487 * For obvious (in hindsight) reasons, see if we're supposed to
488 * replace an existing key, then look for an empty slot.
491 for (i = 0; i < limit; i++)
493 v = vnet_classify_entry_at_index (t, save_v, value_index + i);
496 (v->key, add_v->key, t->match_n_vectors * sizeof (u32x4)))
498 clib_memcpy_fast (v, add_v, sizeof (vnet_classify_entry_t) +
499 t->match_n_vectors * sizeof (u32x4));
500 v->flags &= ~(VNET_CLASSIFY_ENTRY_FREE);
501 vnet_classify_entry_claim_resource (v);
503 CLIB_MEMORY_BARRIER ();
504 /* Restore the previous (k,v) pairs */
505 b->as_u64 = t->saved_bucket.as_u64;
509 for (i = 0; i < limit; i++)
511 v = vnet_classify_entry_at_index (t, save_v, value_index + i);
513 if (vnet_classify_entry_is_free (v))
515 clib_memcpy_fast (v, add_v, sizeof (vnet_classify_entry_t) +
516 t->match_n_vectors * sizeof (u32x4));
517 v->flags &= ~(VNET_CLASSIFY_ENTRY_FREE);
518 vnet_classify_entry_claim_resource (v);
520 CLIB_MEMORY_BARRIER ();
521 b->as_u64 = t->saved_bucket.as_u64;
522 t->active_elements++;
526 /* no room at the inn... split case... */
530 for (i = 0; i < limit; i++)
532 v = vnet_classify_entry_at_index (t, save_v, value_index + i);
535 (v->key, add_v->key, t->match_n_vectors * sizeof (u32x4)))
537 vnet_classify_entry_release_resource (v);
538 clib_memset (v, 0xff, sizeof (vnet_classify_entry_t) +
539 t->match_n_vectors * sizeof (u32x4));
540 v->flags |= VNET_CLASSIFY_ENTRY_FREE;
542 CLIB_MEMORY_BARRIER ();
543 b->as_u64 = t->saved_bucket.as_u64;
544 t->active_elements--;
549 b->as_u64 = t->saved_bucket.as_u64;
553 old_log2_pages = t->saved_bucket.log2_pages;
554 new_log2_pages = old_log2_pages + 1;
555 working_copy = t->working_copies[thread_index];
557 if (t->saved_bucket.linear_search)
560 mark_bucket_linear = 0;
562 new_v = split_and_rehash (t, working_copy, old_log2_pages, new_log2_pages);
570 new_v = split_and_rehash (t, working_copy, old_log2_pages,
578 /* pinned collisions, use linear search */
579 new_v = split_and_rehash_linear (t, working_copy, old_log2_pages,
581 /* A new linear-search bucket? */
582 if (!t->saved_bucket.linear_search)
584 mark_bucket_linear = 1;
588 /* Try to add the new entry */
591 key_minus_skip = (u8 *) add_v->key;
592 key_minus_skip -= t->skip_n_vectors * sizeof (u32x4);
594 new_hash = vnet_classify_hash_packet_inline (t, key_minus_skip);
595 new_hash >>= t->log2_nbuckets;
596 new_hash &= (1 << new_log2_pages) - 1;
598 limit = t->entries_per_page;
599 if (mark_bucket_linear)
601 limit *= (1 << new_log2_pages);
605 for (i = 0; i < limit; i++)
607 new_v = vnet_classify_entry_at_index (t, save_new_v, new_hash + i);
609 if (vnet_classify_entry_is_free (new_v))
611 clib_memcpy_fast (new_v, add_v, sizeof (vnet_classify_entry_t) +
612 t->match_n_vectors * sizeof (u32x4));
613 new_v->flags &= ~(VNET_CLASSIFY_ENTRY_FREE);
614 vnet_classify_entry_claim_resource (new_v);
619 /* Crap. Try again */
620 vnet_classify_entry_free (t, save_new_v, new_log2_pages);
628 tmp_b.log2_pages = new_log2_pages;
629 tmp_b.offset = vnet_classify_get_offset (t, save_new_v);
630 tmp_b.linear_search = mark_bucket_linear;
632 CLIB_MEMORY_BARRIER ();
633 b->as_u64 = tmp_b.as_u64;
634 t->active_elements++;
635 v = vnet_classify_get_entry (t, t->saved_bucket.offset);
636 vnet_classify_entry_free (t, v, old_log2_pages);
639 clib_spinlock_unlock (&t->writer_lock);
643 typedef CLIB_PACKED(struct {
644 ethernet_header_t eh;
646 }) classify_data_or_mask_t;
649 vnet_classify_hash_packet (const vnet_classify_table_t *t, u8 *h)
651 return vnet_classify_hash_packet_inline (t, h);
654 vnet_classify_entry_t *
655 vnet_classify_find_entry (const vnet_classify_table_t *t, u8 *h, u32 hash,
658 return vnet_classify_find_entry_inline (t, h, hash, now);
662 format_classify_entry (u8 *s, va_list *args)
664 vnet_classify_table_t *t = va_arg (*args, vnet_classify_table_t *);
665 vnet_classify_entry_t *e = va_arg (*args, vnet_classify_entry_t *);
668 (s, "[%u]: next_index %d advance %d opaque %d action %d metadata %d\n",
669 vnet_classify_get_offset (t, e), e->next_index, e->advance,
670 e->opaque_index, e->action, e->metadata);
673 s = format (s, " k: %U\n", format_hex_bytes, e->key,
674 t->match_n_vectors * sizeof (u32x4));
676 if (vnet_classify_entry_is_busy (e))
677 s = format (s, " hits %lld, last_heard %.2f\n",
678 e->hits, e->last_heard);
680 s = format (s, " entry is free\n");
685 format_classify_table (u8 * s, va_list * args)
687 vnet_classify_table_t *t = va_arg (*args, vnet_classify_table_t *);
688 int verbose = va_arg (*args, int);
689 vnet_classify_bucket_t *b;
690 vnet_classify_entry_t *v, *save_v;
692 u64 active_elements = 0;
694 for (i = 0; i < t->nbuckets; i++)
700 s = format (s, "[%d]: empty\n", i);
706 s = format (s, "[%d]: heap offset %d, elts %d, %s\n", i,
707 b->offset, (1 << b->log2_pages) * t->entries_per_page,
708 b->linear_search ? "LINEAR" : "normal");
711 save_v = vnet_classify_get_entry (t, b->offset);
712 for (j = 0; j < (1 << b->log2_pages); j++)
714 for (k = 0; k < t->entries_per_page; k++)
717 v = vnet_classify_entry_at_index (t, save_v,
718 j * t->entries_per_page + k);
720 if (vnet_classify_entry_is_free (v))
723 s = format (s, " %d: empty\n",
724 j * t->entries_per_page + k);
729 s = format (s, " %d: %U\n",
730 j * t->entries_per_page + k,
731 format_classify_entry, t, v);
738 s = format (s, " %lld active elements\n", active_elements);
739 s = format (s, " %d free lists\n", vec_len (t->freelists));
740 s = format (s, " %d linear-search buckets\n", t->linear_buckets);
745 vnet_classify_add_del_table (vnet_classify_main_t *cm, const u8 *mask,
746 u32 nbuckets, u32 memory_size, u32 skip,
747 u32 match, u32 next_table_index,
748 u32 miss_next_index, u32 *table_index,
749 u8 current_data_flag, i16 current_data_offset,
750 int is_add, int del_chain)
752 vnet_classify_table_t *t;
756 if (*table_index == ~0) /* add */
758 if (memory_size == 0)
759 return VNET_API_ERROR_INVALID_MEMORY_SIZE;
762 return VNET_API_ERROR_INVALID_VALUE;
764 if (match < 1 || match > 5)
765 return VNET_API_ERROR_INVALID_VALUE;
767 t = vnet_classify_new_table (cm, mask, nbuckets, memory_size,
769 t->next_table_index = next_table_index;
770 t->miss_next_index = miss_next_index;
771 t->current_data_flag = current_data_flag;
772 t->current_data_offset = current_data_offset;
773 *table_index = t - cm->tables;
777 vnet_classify_main_t *cm = &vnet_classify_main;
778 if (pool_is_free_index (cm->tables, *table_index))
779 return VNET_API_ERROR_CLASSIFY_TABLE_NOT_FOUND;
781 t = pool_elt_at_index (cm->tables, *table_index);
782 t->next_table_index = next_table_index;
787 vnet_classify_delete_table_index (cm, *table_index, del_chain);
791 #define foreach_tcp_proto_field \
795 #define foreach_udp_proto_field \
799 #define foreach_ip4_proto_field \
810 unformat_tcp_mask (unformat_input_t * input, va_list * args)
812 u8 **maskp = va_arg (*args, u8 **);
814 u8 found_something = 0;
818 foreach_tcp_proto_field;
821 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
824 #define _(a) else if (unformat (input, #a)) a=1;
825 foreach_tcp_proto_field
831 #define _(a) found_something += a;
832 foreach_tcp_proto_field;
835 if (found_something == 0)
838 vec_validate (mask, sizeof (*tcp) - 1);
840 tcp = (tcp_header_t *) mask;
842 #define _(a) if (a) clib_memset (&tcp->a, 0xff, sizeof (tcp->a));
843 foreach_tcp_proto_field;
851 unformat_udp_mask (unformat_input_t * input, va_list * args)
853 u8 **maskp = va_arg (*args, u8 **);
855 u8 found_something = 0;
859 foreach_udp_proto_field;
862 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
865 #define _(a) else if (unformat (input, #a)) a=1;
866 foreach_udp_proto_field
872 #define _(a) found_something += a;
873 foreach_udp_proto_field;
876 if (found_something == 0)
879 vec_validate (mask, sizeof (*udp) - 1);
881 udp = (udp_header_t *) mask;
883 #define _(a) if (a) clib_memset (&udp->a, 0xff, sizeof (udp->a));
884 foreach_udp_proto_field;
893 u16 src_port, dst_port;
897 unformat_l4_mask (unformat_input_t * input, va_list * args)
899 u8 **maskp = va_arg (*args, u8 **);
900 u16 src_port = 0, dst_port = 0;
901 tcpudp_header_t *tcpudp;
903 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
905 if (unformat (input, "tcp %U", unformat_tcp_mask, maskp))
907 else if (unformat (input, "udp %U", unformat_udp_mask, maskp))
909 else if (unformat (input, "src_port"))
911 else if (unformat (input, "dst_port"))
917 if (!src_port && !dst_port)
921 vec_validate (mask, sizeof (tcpudp_header_t) - 1);
923 tcpudp = (tcpudp_header_t *) mask;
924 tcpudp->src_port = src_port;
925 tcpudp->dst_port = dst_port;
933 unformat_ip4_mask (unformat_input_t * input, va_list * args)
935 u8 **maskp = va_arg (*args, u8 **);
937 u8 found_something = 0;
939 u32 src_prefix_len = 32;
940 u32 src_prefix_mask = ~0;
941 u32 dst_prefix_len = 32;
942 u32 dst_prefix_mask = ~0;
945 foreach_ip4_proto_field;
951 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
953 if (unformat (input, "version"))
955 else if (unformat (input, "hdr_length"))
957 else if (unformat (input, "src/%d", &src_prefix_len))
960 src_prefix_mask &= ~((1 << (32 - src_prefix_len)) - 1);
961 src_prefix_mask = clib_host_to_net_u32 (src_prefix_mask);
963 else if (unformat (input, "dst/%d", &dst_prefix_len))
966 dst_prefix_mask &= ~((1 << (32 - dst_prefix_len)) - 1);
967 dst_prefix_mask = clib_host_to_net_u32 (dst_prefix_mask);
969 else if (unformat (input, "src"))
971 else if (unformat (input, "dst"))
973 else if (unformat (input, "proto"))
976 #define _(a) else if (unformat (input, #a)) a=1;
977 foreach_ip4_proto_field
983 found_something = version + hdr_length;
984 #define _(a) found_something += a;
985 foreach_ip4_proto_field;
988 if (found_something == 0)
991 vec_validate (mask, sizeof (*ip) - 1);
993 ip = (ip4_header_t *) mask;
995 #define _(a) if (a) clib_memset (&ip->a, 0xff, sizeof (ip->a));
996 foreach_ip4_proto_field;
1000 ip->src_address.as_u32 = src_prefix_mask;
1003 ip->dst_address.as_u32 = dst_prefix_mask;
1005 ip->ip_version_and_header_length = 0;
1008 ip->ip_version_and_header_length |= 0xF0;
1011 ip->ip_version_and_header_length |= 0x0F;
1017 #define foreach_ip6_proto_field \
1025 unformat_ip6_mask (unformat_input_t * input, va_list * args)
1027 u8 **maskp = va_arg (*args, u8 **);
1031 u32 ip_version_traffic_class_and_flow_label;
1033 #define _(a) u8 a=0;
1034 foreach_ip6_proto_field;
1037 u8 traffic_class = 0;
1040 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1042 if (unformat (input, "version"))
1044 else if (unformat (input, "traffic-class"))
1046 else if (unformat (input, "flow-label"))
1048 else if (unformat (input, "src"))
1050 else if (unformat (input, "dst"))
1052 else if (unformat (input, "proto"))
1055 #define _(a) else if (unformat (input, #a)) a=1;
1056 foreach_ip6_proto_field
1062 /* Account for "special" field names */
1063 found_something = version + traffic_class + flow_label
1064 + src_address + dst_address + protocol;
1066 #define _(a) found_something += a;
1067 foreach_ip6_proto_field;
1070 if (found_something == 0)
1073 vec_validate (mask, sizeof (*ip) - 1);
1075 ip = (ip6_header_t *) mask;
1077 #define _(a) if (a) clib_memset (&ip->a, 0xff, sizeof (ip->a));
1078 foreach_ip6_proto_field;
1081 ip_version_traffic_class_and_flow_label = 0;
1084 ip_version_traffic_class_and_flow_label |= 0xF0000000;
1087 ip_version_traffic_class_and_flow_label |= 0x0FF00000;
1090 ip_version_traffic_class_and_flow_label |= 0x000FFFFF;
1092 ip->ip_version_traffic_class_and_flow_label =
1093 clib_host_to_net_u32 (ip_version_traffic_class_and_flow_label);
1100 unformat_l3_mask (unformat_input_t * input, va_list * args)
1102 u8 **maskp = va_arg (*args, u8 **);
1104 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1106 if (unformat (input, "ip4 %U", unformat_ip4_mask, maskp))
1108 else if (unformat (input, "ip6 %U", unformat_ip6_mask, maskp))
1117 unformat_l2_mask (unformat_input_t * input, va_list * args)
1119 u8 **maskp = va_arg (*args, u8 **);
1134 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1136 if (unformat (input, "src"))
1138 else if (unformat (input, "dst"))
1140 else if (unformat (input, "proto"))
1142 else if (unformat (input, "tag1"))
1144 else if (unformat (input, "tag2"))
1146 else if (unformat (input, "ignore-tag1"))
1148 else if (unformat (input, "ignore-tag2"))
1150 else if (unformat (input, "cos1"))
1152 else if (unformat (input, "cos2"))
1154 else if (unformat (input, "dot1q"))
1156 else if (unformat (input, "dot1ad"))
1161 if ((src + dst + proto + tag1 + tag2 + dot1q + dot1ad +
1162 ignore_tag1 + ignore_tag2 + cos1 + cos2) == 0)
1165 if (tag1 || ignore_tag1 || cos1 || dot1q)
1167 if (tag2 || ignore_tag2 || cos2 || dot1ad)
1170 vec_validate (mask, len - 1);
1173 clib_memset (mask, 0xff, 6);
1176 clib_memset (mask + 6, 0xff, 6);
1180 /* inner vlan tag */
1189 mask[21] = mask[20] = 0xff;
1210 mask[16] = mask[17] = 0xff;
1219 mask[12] = mask[13] = 0xff;
1226 unformat_classify_mask (unformat_input_t * input, va_list * args)
1228 u8 **maskp = va_arg (*args, u8 **);
1229 u32 *skipp = va_arg (*args, u32 *);
1230 u32 *matchp = va_arg (*args, u32 *);
1239 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1241 if (unformat (input, "hex %U", unformat_hex_string, &mask))
1243 else if (unformat (input, "l2 none"))
1244 /* Don't add the l2 header in the mask */
1246 else if (unformat (input, "l2 %U", unformat_l2_mask, &l2))
1248 else if (unformat (input, "l3 %U", unformat_l3_mask, &l3))
1250 else if (unformat (input, "l4 %U", unformat_l4_mask, &l4))
1273 if (mask || l2 || l3 || l4)
1279 /* "With a free Ethernet header in every package" */
1281 vec_validate (l2, 13);
1285 vec_append (mask, l3);
1293 vec_append (mask, l4);
1298 /* Scan forward looking for the first significant mask octet */
1299 for (i = 0; i < vec_len (mask); i++)
1303 /* compute (skip, match) params */
1304 *skipp = i / sizeof (u32x4);
1305 vec_delete (mask, *skipp * sizeof (u32x4), 0);
1307 /* Pad mask to an even multiple of the vector size */
1308 while (vec_len (mask) % sizeof (u32x4))
1311 match = vec_len (mask) / sizeof (u32x4);
1313 for (i = match * sizeof (u32x4); i > 0; i -= sizeof (u32x4))
1315 u64 *tmp = (u64 *) (mask + (i - sizeof (u32x4)));
1316 if (*tmp || *(tmp + 1))
1321 clib_warning ("BUG: match 0");
1323 vec_set_len (mask, match * sizeof (u32x4));
1334 #define foreach_l2_input_next \
1336 _(ethernet, ETHERNET_INPUT) \
1342 unformat_l2_input_next_index (unformat_input_t * input, va_list * args)
1344 vnet_classify_main_t *cm = &vnet_classify_main;
1345 u32 *miss_next_indexp = va_arg (*args, u32 *);
1350 /* First try registered unformat fns, allowing override... */
1351 for (i = 0; i < vec_len (cm->unformat_l2_next_index_fns); i++)
1353 if (unformat (input, "%U", cm->unformat_l2_next_index_fns[i], &tmp))
1361 if (unformat (input, #n)) { next_index = L2_INPUT_CLASSIFY_NEXT_##N; goto out;}
1362 foreach_l2_input_next;
1365 if (unformat (input, "%d", &tmp))
1374 *miss_next_indexp = next_index;
1378 #define foreach_l2_output_next \
1382 unformat_l2_output_next_index (unformat_input_t * input, va_list * args)
1384 vnet_classify_main_t *cm = &vnet_classify_main;
1385 u32 *miss_next_indexp = va_arg (*args, u32 *);
1390 /* First try registered unformat fns, allowing override... */
1391 for (i = 0; i < vec_len (cm->unformat_l2_next_index_fns); i++)
1393 if (unformat (input, "%U", cm->unformat_l2_next_index_fns[i], &tmp))
1401 if (unformat (input, #n)) { next_index = L2_OUTPUT_CLASSIFY_NEXT_##N; goto out;}
1402 foreach_l2_output_next;
1405 if (unformat (input, "%d", &tmp))
1414 *miss_next_indexp = next_index;
1418 #define foreach_ip_next \
1423 unformat_ip_next_index (unformat_input_t * input, va_list * args)
1425 u32 *miss_next_indexp = va_arg (*args, u32 *);
1426 vnet_classify_main_t *cm = &vnet_classify_main;
1431 /* First try registered unformat fns, allowing override... */
1432 for (i = 0; i < vec_len (cm->unformat_ip_next_index_fns); i++)
1434 if (unformat (input, "%U", cm->unformat_ip_next_index_fns[i], &tmp))
1442 if (unformat (input, #n)) { next_index = IP_LOOKUP_NEXT_##N; goto out;}
1446 if (unformat (input, "%d", &tmp))
1455 *miss_next_indexp = next_index;
1459 #define foreach_acl_next \
1463 unformat_acl_next_index (unformat_input_t * input, va_list * args)
1465 u32 *next_indexp = va_arg (*args, u32 *);
1466 vnet_classify_main_t *cm = &vnet_classify_main;
1471 /* First try registered unformat fns, allowing override... */
1472 for (i = 0; i < vec_len (cm->unformat_acl_next_index_fns); i++)
1474 if (unformat (input, "%U", cm->unformat_acl_next_index_fns[i], &tmp))
1482 if (unformat (input, #n)) { next_index = ACL_NEXT_INDEX_##N; goto out;}
1486 if (unformat (input, "permit"))
1491 else if (unformat (input, "%d", &tmp))
1500 *next_indexp = next_index;
1505 unformat_policer_next_index (unformat_input_t * input, va_list * args)
1507 u32 *next_indexp = va_arg (*args, u32 *);
1508 vnet_classify_main_t *cm = &vnet_classify_main;
1513 /* First try registered unformat fns, allowing override... */
1514 for (i = 0; i < vec_len (cm->unformat_policer_next_index_fns); i++)
1517 (input, "%U", cm->unformat_policer_next_index_fns[i], &tmp))
1524 if (unformat (input, "%d", &tmp))
1533 *next_indexp = next_index;
1537 static clib_error_t *
1538 classify_table_command_fn (vlib_main_t * vm,
1539 unformat_input_t * input, vlib_cli_command_t * cmd)
1546 u32 table_index = ~0;
1547 u32 next_table_index = ~0;
1548 u32 miss_next_index = ~0;
1549 u32 memory_size = 2 << 20;
1551 u32 current_data_flag = 0;
1552 int current_data_offset = 0;
1555 vnet_classify_main_t *cm = &vnet_classify_main;
1558 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1560 if (unformat (input, "del"))
1562 else if (unformat (input, "del-chain"))
1567 else if (unformat (input, "buckets %d", &nbuckets))
1569 else if (unformat (input, "skip %d", &skip))
1571 else if (unformat (input, "match %d", &match))
1573 else if (unformat (input, "table %d", &table_index))
1575 else if (unformat (input, "mask %U", unformat_classify_mask,
1576 &mask, &skip, &match))
1578 else if (unformat (input, "memory-size %uM", &tmp))
1579 memory_size = tmp << 20;
1580 else if (unformat (input, "memory-size %uG", &tmp))
1581 memory_size = tmp << 30;
1582 else if (unformat (input, "next-table %d", &next_table_index))
1584 else if (unformat (input, "miss-next %U", unformat_ip_next_index,
1589 (input, "l2-input-miss-next %U", unformat_l2_input_next_index,
1594 (input, "l2-output-miss-next %U", unformat_l2_output_next_index,
1597 else if (unformat (input, "acl-miss-next %U", unformat_acl_next_index,
1600 else if (unformat (input, "current-data-flag %d", ¤t_data_flag))
1603 if (unformat (input, "current-data-offset %d", ¤t_data_offset))
1610 if (is_add && mask == 0 && table_index == ~0)
1611 return clib_error_return (0, "Mask required");
1613 if (is_add && skip == ~0 && table_index == ~0)
1614 return clib_error_return (0, "skip count required");
1616 if (is_add && match == ~0 && table_index == ~0)
1617 return clib_error_return (0, "match count required");
1619 if (!is_add && table_index == ~0)
1620 return clib_error_return (0, "table index required for delete");
1622 rv = vnet_classify_add_del_table (cm, mask, nbuckets, (u32) memory_size,
1623 skip, match, next_table_index,
1624 miss_next_index, &table_index,
1625 current_data_flag, current_data_offset,
1633 return clib_error_return (0, "vnet_classify_add_del_table returned %d",
1639 VLIB_CLI_COMMAND (classify_table, static) =
1641 .path = "classify table",
1643 "classify table [miss-next|l2-miss_next|acl-miss-next <next_index>]"
1644 "\n mask <mask-value> buckets <nn> [skip <n>] [match <n>]"
1645 "\n [current-data-flag <n>] [current-data-offset <n>] [table <n>]"
1646 "\n [memory-size <nn>[M][G]] [next-table <n>]"
1647 "\n [del] [del-chain]",
1648 .function = classify_table_command_fn,
1652 filter_table_mask_compare (void *a1, void *a2)
1654 vnet_classify_main_t *cm = &vnet_classify_main;
1658 vnet_classify_table_t *t1, *t2;
1662 t1 = pool_elt_at_index (cm->tables, *ti1);
1663 t2 = pool_elt_at_index (cm->tables, *ti2);
1665 m1 = (u8 *) (t1->mask);
1666 m2 = (u8 *) (t2->mask);
1668 for (i = 0; i < t1->match_n_vectors * sizeof (u32x4); i++)
1670 n1 += count_set_bits (m1[0]);
1674 for (i = 0; i < t2->match_n_vectors * sizeof (u32x4); i++)
1676 n2 += count_set_bits (m2[0]);
1680 /* Reverse sort: descending number of set bits */
1691 * Reorder the chain of tables starting with table_index such
1692 * that more more-specific masks come before less-specific masks.
1693 * Return the new head of the table chain.
1696 classify_sort_table_chain (vnet_classify_main_t * cm, u32 table_index)
1699 * Form a vector of all classifier tables in this chain.
1702 vnet_classify_table_t *t;
1704 for (cti = table_index; cti != ~0; cti = t->next_table_index)
1706 vec_add1 (tables, cti);
1707 t = pool_elt_at_index (cm->tables, cti);
1711 * Sort filter tables from most-specific mask to least-specific mask.
1713 vec_sort_with_function (tables, filter_table_mask_compare);
1716 * Relink tables via next_table_index fields.
1719 for (i = 0; i < vec_len (tables); i++)
1721 t = pool_elt_at_index (cm->tables, tables[i]);
1723 if ((i + 1) < vec_len (tables))
1724 t->next_table_index = tables[i + 1];
1726 t->next_table_index = ~0;
1729 table_index = tables[0];
1737 classify_get_trace_chain (void)
1741 table_index = vlib_global_main.trace_filter.classify_table_index;
1747 * Seting the Trace chain to ~0 is a request to delete and clear it.
1750 classify_set_trace_chain (vnet_classify_main_t * cm, u32 table_index)
1752 if (table_index == ~0)
1754 u32 old_table_index;
1756 old_table_index = vlib_global_main.trace_filter.classify_table_index;
1757 vnet_classify_delete_table_index (cm, old_table_index, 1);
1760 vlib_global_main.trace_filter.classify_table_index = table_index;
1765 classify_get_pcap_chain (vnet_classify_main_t * cm, u32 sw_if_index)
1767 u32 table_index = ~0;
1769 if (sw_if_index != ~0
1770 && (sw_if_index < vec_len (cm->classify_table_index_by_sw_if_index)))
1771 table_index = cm->classify_table_index_by_sw_if_index[sw_if_index];
1777 classify_set_pcap_chain (vnet_classify_main_t * cm,
1778 u32 sw_if_index, u32 table_index)
1780 vnet_main_t *vnm = vnet_get_main ();
1782 if (sw_if_index != ~0 && table_index != ~0)
1783 vec_validate_init_empty (cm->classify_table_index_by_sw_if_index,
1786 if (table_index == ~0)
1788 u32 old_table_index = ~0;
1790 if (sw_if_index < vec_len (cm->classify_table_index_by_sw_if_index))
1792 cm->classify_table_index_by_sw_if_index[sw_if_index];
1794 vnet_classify_delete_table_index (cm, old_table_index, 1);
1798 * Put the table index where device drivers can find them.
1799 * This table index will be either a valid table or a ~0 to clear it.
1801 if (vec_len (cm->classify_table_index_by_sw_if_index) > sw_if_index)
1802 cm->classify_table_index_by_sw_if_index[sw_if_index] = table_index;
1803 if (sw_if_index > 0)
1805 vnet_hw_interface_t *hi;
1806 hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
1807 hi->trace_classify_table_index = table_index;
1813 * Search for a mask-compatible Classify table within the given table chain.
1816 classify_lookup_chain (u32 table_index, u8 * mask, u32 n_skip, u32 n_match)
1818 vnet_classify_main_t *cm = &vnet_classify_main;
1819 vnet_classify_table_t *t;
1822 if (table_index == ~0)
1825 for (cti = table_index; cti != ~0; cti = t->next_table_index)
1827 t = pool_elt_at_index (cm->tables, cti);
1829 /* Classifier geometry mismatch, can't use this table. */
1830 if (t->match_n_vectors != n_match || t->skip_n_vectors != n_skip)
1833 /* Masks aren't congruent, can't use this table. */
1834 if (t->match_n_vectors * sizeof (u32x4) != vec_len (mask))
1837 /* Masks aren't bit-for-bit identical, can't use this table. */
1838 if (memcmp (t->mask, mask, t->match_n_vectors * sizeof (u32x4)))
1849 static clib_error_t *
1850 classify_filter_command_fn (vlib_main_t * vm,
1851 unformat_input_t * input,
1852 vlib_cli_command_t * cmd)
1855 vnet_main_t *vnm = vnet_get_main ();
1856 uword memory_size = (uword) (128 << 10);
1861 u32 table_index = ~0;
1862 u32 next_table_index = ~0;
1863 u32 miss_next_index = ~0;
1864 u32 current_data_flag = 0;
1865 int current_data_offset = 0;
1866 u32 sw_if_index = ~0;
1870 vnet_classify_main_t *cm = &vnet_classify_main;
1872 clib_error_t *err = 0;
1874 unformat_input_t _line_input, *line_input = &_line_input;
1876 /* Get a line of input. */
1877 if (!unformat_user (input, unformat_line_input, line_input))
1880 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1882 if (unformat (line_input, "del"))
1884 else if (unformat (line_input, "pcap %=", &pcap, 1))
1886 else if (unformat (line_input, "trace"))
1888 else if (unformat (line_input, "%U",
1889 unformat_vnet_sw_interface, vnm, &sw_if_index))
1891 if (sw_if_index == 0)
1892 return clib_error_return (0, "Local interface not supported...");
1894 else if (unformat (line_input, "buckets %d", &nbuckets))
1896 else if (unformat (line_input, "mask %U", unformat_classify_mask,
1897 &mask, &skip, &match))
1899 else if (unformat (line_input, "memory-size %U", unformat_memory_size,
1906 if (is_add && mask == 0)
1907 err = clib_error_return (0, "Mask required");
1909 else if (is_add && skip == ~0)
1910 err = clib_error_return (0, "skip count required");
1912 else if (is_add && match == ~0)
1913 err = clib_error_return (0, "match count required");
1915 else if (sw_if_index == ~0 && pkt_trace == 0 && pcap == 0)
1916 err = clib_error_return (0, "Must specify trace, pcap or interface...");
1918 else if (pkt_trace && pcap)
1919 err = clib_error_return
1920 (0, "Packet trace and pcap are mutually exclusive...");
1922 else if (pkt_trace && sw_if_index != ~0)
1923 err = clib_error_return (0, "Packet trace filter is per-system");
1927 unformat_free (line_input);
1934 * Delete an existing PCAP or trace classify table.
1937 classify_set_trace_chain (cm, ~0);
1939 classify_set_pcap_chain (cm, sw_if_index, ~0);
1942 unformat_free (line_input);
1948 * Find an existing compatible table or else make a new one.
1951 table_index = classify_get_trace_chain ();
1953 table_index = classify_get_pcap_chain (cm, sw_if_index);
1955 if (table_index != ~0)
1958 * look for a compatible table in the existing chain
1959 * - if a compatible table is found, table_index is updated with it
1960 * - if not, table_index is updated to ~0 (aka nil) and because of that
1961 * we are going to create one (see below). We save the original head
1962 * in next_table_index so we can chain it with the newly created
1965 next_table_index = table_index;
1966 table_index = classify_lookup_chain (table_index, mask, skip, match);
1970 * When no table is found, make one.
1972 if (table_index == ~0)
1977 * Matching table wasn't found, so create a new one at the
1978 * head of the next_table_index chain.
1980 rv = vnet_classify_add_del_table (cm, mask, nbuckets, memory_size,
1981 skip, match, next_table_index,
1982 miss_next_index, &table_index,
1984 current_data_offset, 1, 0);
1989 unformat_free (line_input);
1990 return clib_error_return (0,
1991 "vnet_classify_add_del_table returned %d",
1996 * Reorder tables such that masks are most-specify to least-specific.
1998 new_head_index = classify_sort_table_chain (cm, table_index);
2001 * Put first classifier table in chain in a place where
2002 * other data structures expect to find and use it.
2005 classify_set_trace_chain (cm, new_head_index);
2007 classify_set_pcap_chain (cm, sw_if_index, new_head_index);
2013 * Now try to parse a and add a filter-match session.
2015 if (unformat (line_input, "match %U", unformat_classify_match,
2016 cm, &match_vector, table_index) == 0)
2020 * We use hit or miss to determine whether to trace or pcap pkts
2021 * so the session setup is very limited
2023 rv = vnet_classify_add_del_session (cm, table_index,
2024 match_vector, 0 /* hit_next_index */ ,
2025 0 /* opaque_index */ ,
2031 vec_free (match_vector);
2036 /** Enable / disable packet trace filter */
2038 vlib_enable_disable_pkt_trace_filter (int enable)
2042 vlib_global_main.trace_filter.trace_filter_enable = 1;
2046 vlib_global_main.trace_filter.trace_filter_enable = 0;
2052 * Construct an arbitrary set of packet classifier tables for use with
2053 * "pcap trace rx | tx," and with the vpp packet tracer
2055 * Packets which match a rule in the classifier table chain
2056 * will be traced. The tables are automatically ordered so that
2057 * matches in the most specific table are tried first.
2059 * It's reasonably likely that folks will configure a single
2060 * table with one or two matches. As a result, we configure
2061 * 8 hash buckets and 128K of match rule space. One can override
2062 * the defaults by specifying "buckets <nnn>" and "memory-size <xxx>"
2065 * To build up complex filter chains, repeatedly issue the
2066 * classify filter debug CLI command. Each command must specify the desired
2067 * mask and match values. If a classifier table with a suitable mask
2068 * already exists, the CLI command adds a match rule to the existing table.
2069 * If not, the CLI command add a new table and the indicated mask rule
2071 * Here is a terse description of the "mask <xxx>" syntax:
2073 * l2 src dst proto tag1 tag2 ignore-tag1 ignore-tag2 cos1 cos2 dot1q dot1ad
2075 * l3 ip4 <ip4-mask> ip6 <ip6-mask>
2077 * <ip4-mask> version hdr_length src[/width] dst[/width]
2078 * tos length fragment_id ttl protocol checksum
2080 * <ip6-mask> version traffic-class flow-label src dst proto
2081 * payload_length hop_limit protocol
2083 * l4 tcp <tcp-mask> udp <udp_mask> src_port dst_port
2085 * <tcp-mask> src dst # ports
2087 * <udp-mask> src_port dst_port
2089 * To construct matches, add the values to match after the indicated keywords:
2090 * in the match syntax. For example:
2091 * mask l3 ip4 src -> match l3 ip4 src 192.168.1.11
2094 * Configuring the classify filter
2096 * Configure a simple classify filter, and configure pcap trace rx to use it:
2098 * @cliexcmd{classify filter rx mask l3 ip4 src match l3 ip4 src 192.168.1.11}
2099 * <b><em>pcap trace rx max 100 filter</em></b>
2101 * Configure another fairly simple filter
2103 * @cliexcmd{classify filter mask l3 ip4 src dst match l3 ip4 src 192.168.1.10
2107 * Configure a filter for use with the vpp packet tracer:
2108 * @cliexcmd{classify filter trace mask l3 ip4 src dst match l3 ip4 src
2109 * 192.168.1.10 dst 192.168.2.10}
2110 * <b><em>trace add dpdk-input 100 filter</em></b>
2112 * Clear classifier filters
2114 * <b><em>classify filter [trace | rx | tx | <intfc>] del</em></b>
2116 * To display the top-level classifier tables for each use case:
2117 * <b><em>show classify filter</em></b>
2119 * To inspect the classifier tables, use
2121 * <b><em>show classify table [verbose]</em></b>
2122 * The verbose form displays all of the match rules, with hit-counters
2125 VLIB_CLI_COMMAND (classify_filter, static) =
2127 .path = "classify filter",
2129 "classify filter <intfc> | pcap mask <mask-value> match <match-value>\n"
2130 " | trace mask <mask-value> match <match-value> [del]\n"
2131 " [buckets <nn>] [memory-size <n>]",
2132 .function = classify_filter_command_fn,
2135 static clib_error_t *
2136 show_classify_filter_command_fn (vlib_main_t * vm,
2137 unformat_input_t * input,
2138 vlib_cli_command_t * cmd)
2140 vnet_classify_main_t *cm = &vnet_classify_main;
2141 vnet_main_t *vnm = vnet_get_main ();
2148 (void) unformat (input, "verbose %=", &verbose, 1);
2150 vlib_cli_output (vm, "%-30s%s", "Filter Used By", " Table(s)");
2151 vlib_cli_output (vm, "%-30s%s", "--------------", " --------");
2153 limit = vec_len (cm->classify_table_index_by_sw_if_index);
2155 for (i = -1; i < limit; i++)
2160 table_index = vlib_global_main.trace_filter.classify_table_index;
2161 name = format (0, "packet tracer:");
2165 table_index = cm->classify_table_index_by_sw_if_index[i];
2166 name = format (0, "pcap rx/tx/drop:");
2170 table_index = cm->classify_table_index_by_sw_if_index[i];
2171 name = format (0, "%U:", format_vnet_sw_if_index_name, vnm, i);
2177 vnet_classify_table_t *t;
2182 s = format (s, " none");
2185 s = format (s, " %u", j);
2186 t = pool_elt_at_index (cm->tables, j);
2187 j = t->next_table_index;
2192 vlib_cli_output (vm, "%-30v table(s)%v", name, s);
2193 vec_reset_length (s);
2197 if (table_index != ~0)
2198 s = format (s, " %u", table_index);
2200 s = format (s, " none");
2202 vlib_cli_output (vm, "%-30v first table%v", name, s);
2203 vec_reset_length (s);
2205 vec_reset_length (name);
2213 VLIB_CLI_COMMAND (show_classify_filter, static) =
2215 .path = "show classify filter",
2216 .short_help = "show classify filter [verbose [nn]]",
2217 .function = show_classify_filter_command_fn,
2221 format_vnet_classify_table (u8 *s, va_list *args)
2223 vnet_classify_main_t *cm = va_arg (*args, vnet_classify_main_t *);
2224 int verbose = va_arg (*args, int);
2225 u32 index = va_arg (*args, u32);
2226 vnet_classify_table_t *t;
2230 s = format (s, "\n%10s%10s%10s%10s", "TableIdx", "Sessions", "NextTbl",
2231 "NextNode", verbose ? "Details" : "");
2235 t = pool_elt_at_index (cm->tables, index);
2236 s = format (s, "%10u%10d%10d%10d", index, t->active_elements,
2237 t->next_table_index, t->miss_next_index);
2239 s = format (s, "\n Heap: %U", format_clib_mem_heap, t->mheap,
2242 s = format (s, "\n nbuckets %d, skip %d match %d flag %d offset %d",
2243 t->nbuckets, t->skip_n_vectors, t->match_n_vectors,
2244 t->current_data_flag, t->current_data_offset);
2245 s = format (s, "\n mask %U", format_hex_bytes, t->mask,
2246 t->match_n_vectors * sizeof (u32x4));
2247 s = format (s, "\n linear-search buckets %d\n", t->linear_buckets);
2252 s = format (s, "\n%U", format_classify_table, t, verbose);
2257 static clib_error_t *
2258 show_classify_tables_command_fn (vlib_main_t * vm,
2259 unformat_input_t * input,
2260 vlib_cli_command_t * cmd)
2262 vnet_classify_main_t *cm = &vnet_classify_main;
2263 vnet_classify_table_t *t;
2264 u32 match_index = ~0;
2269 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2271 if (unformat (input, "index %d", &match_index))
2273 else if (unformat (input, "verbose %d", &verbose))
2275 else if (unformat (input, "verbose"))
2281 pool_foreach (t, cm->tables)
2283 if (match_index == ~0 || (match_index == t - cm->tables))
2284 vec_add1 (indices, t - cm->tables);
2287 if (vec_len (indices))
2289 for (i = 0; i < vec_len (indices); i++)
2291 vlib_cli_output (vm, "%U", format_vnet_classify_table, cm, verbose,
2293 vlib_cli_output (vm, "%U", format_vnet_classify_table, cm, verbose,
2298 vlib_cli_output (vm, "No classifier tables configured");
2305 VLIB_CLI_COMMAND (show_classify_table_command, static) = {
2306 .path = "show classify tables",
2307 .short_help = "show classify tables [index <nn>]",
2308 .function = show_classify_tables_command_fn,
2312 unformat_l4_match (unformat_input_t * input, va_list * args)
2314 u8 **matchp = va_arg (*args, u8 **);
2316 u8 *proto_header = 0;
2322 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2324 if (unformat (input, "src_port %d", &src_port))
2326 else if (unformat (input, "dst_port %d", &dst_port))
2332 h.src_port = clib_host_to_net_u16 (src_port);
2333 h.dst_port = clib_host_to_net_u16 (dst_port);
2334 vec_validate (proto_header, sizeof (h) - 1);
2335 memcpy (proto_header, &h, sizeof (h));
2337 *matchp = proto_header;
2343 unformat_ip4_match (unformat_input_t * input, va_list * args)
2345 u8 **matchp = va_arg (*args, u8 **);
2352 int src = 0, dst = 0;
2353 ip4_address_t src_val, dst_val;
2360 int fragment_id = 0;
2361 u32 fragment_id_val;
2367 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2369 if (unformat (input, "version %d", &version_val))
2371 else if (unformat (input, "hdr_length %d", &hdr_length_val))
2373 else if (unformat (input, "src %U", unformat_ip4_address, &src_val))
2375 else if (unformat (input, "dst %U", unformat_ip4_address, &dst_val))
2377 else if (unformat (input, "proto %d", &proto_val))
2379 else if (unformat (input, "tos %d", &tos_val))
2381 else if (unformat (input, "length %d", &length_val))
2383 else if (unformat (input, "fragment_id %d", &fragment_id_val))
2385 else if (unformat (input, "ttl %d", &ttl_val))
2387 else if (unformat (input, "checksum %d", &checksum_val))
2393 if (version + hdr_length + src + dst + proto + tos + length + fragment_id
2394 + ttl + checksum == 0)
2398 * Aligned because we use the real comparison functions
2400 vec_validate_aligned (match, sizeof (*ip) - 1, sizeof (u32x4));
2402 ip = (ip4_header_t *) match;
2404 /* These are realistically matched in practice */
2406 ip->src_address.as_u32 = src_val.as_u32;
2409 ip->dst_address.as_u32 = dst_val.as_u32;
2412 ip->protocol = proto_val;
2415 /* These are not, but they're included for completeness */
2417 ip->ip_version_and_header_length |= (version_val & 0xF) << 4;
2420 ip->ip_version_and_header_length |= (hdr_length_val & 0xF);
2426 ip->length = clib_host_to_net_u16 (length_val);
2432 ip->checksum = clib_host_to_net_u16 (checksum_val);
2439 unformat_ip6_match (unformat_input_t * input, va_list * args)
2441 u8 **matchp = va_arg (*args, u8 **);
2446 u8 traffic_class = 0;
2447 u32 traffic_class_val;
2450 int src = 0, dst = 0;
2451 ip6_address_t src_val, dst_val;
2454 int payload_length = 0;
2455 u32 payload_length_val;
2458 u32 ip_version_traffic_class_and_flow_label;
2460 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2462 if (unformat (input, "version %d", &version_val))
2464 else if (unformat (input, "traffic_class %d", &traffic_class_val))
2466 else if (unformat (input, "flow_label %d", &flow_label_val))
2468 else if (unformat (input, "src %U", unformat_ip6_address, &src_val))
2470 else if (unformat (input, "dst %U", unformat_ip6_address, &dst_val))
2472 else if (unformat (input, "proto %d", &proto_val))
2474 else if (unformat (input, "payload_length %d", &payload_length_val))
2476 else if (unformat (input, "hop_limit %d", &hop_limit_val))
2482 if (version + traffic_class + flow_label + src + dst + proto +
2483 payload_length + hop_limit == 0)
2487 * Aligned because we use the real comparison functions
2489 vec_validate_aligned (match, sizeof (*ip) - 1, sizeof (u32x4));
2491 ip = (ip6_header_t *) match;
2494 clib_memcpy_fast (&ip->src_address, &src_val, sizeof (ip->src_address));
2497 clib_memcpy_fast (&ip->dst_address, &dst_val, sizeof (ip->dst_address));
2500 ip->protocol = proto_val;
2502 ip_version_traffic_class_and_flow_label = 0;
2505 ip_version_traffic_class_and_flow_label |= (version_val & 0xF) << 28;
2508 ip_version_traffic_class_and_flow_label |=
2509 (traffic_class_val & 0xFF) << 20;
2512 ip_version_traffic_class_and_flow_label |= (flow_label_val & 0xFFFFF);
2514 ip->ip_version_traffic_class_and_flow_label =
2515 clib_host_to_net_u32 (ip_version_traffic_class_and_flow_label);
2518 ip->payload_length = clib_host_to_net_u16 (payload_length_val);
2521 ip->hop_limit = hop_limit_val;
2528 unformat_l3_match (unformat_input_t * input, va_list * args)
2530 u8 **matchp = va_arg (*args, u8 **);
2532 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2534 if (unformat (input, "ip4 %U", unformat_ip4_match, matchp))
2536 else if (unformat (input, "ip6 %U", unformat_ip6_match, matchp))
2546 unformat_vlan_tag (unformat_input_t * input, va_list * args)
2548 u8 *tagp = va_arg (*args, u8 *);
2551 if (unformat (input, "%d", &tag))
2553 tagp[0] = (tag >> 8) & 0x0F;
2554 tagp[1] = tag & 0xFF;
2562 unformat_l2_match (unformat_input_t * input, va_list * args)
2564 u8 **matchp = va_arg (*args, u8 **);
2584 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2586 if (unformat (input, "src %U", unformat_ethernet_address, &src_val))
2589 if (unformat (input, "dst %U", unformat_ethernet_address, &dst_val))
2591 else if (unformat (input, "proto %U",
2592 unformat_ethernet_type_host_byte_order, &proto_val))
2594 else if (unformat (input, "tag1 %U", unformat_vlan_tag, tag1_val))
2596 else if (unformat (input, "tag2 %U", unformat_vlan_tag, tag2_val))
2598 else if (unformat (input, "ignore-tag1"))
2600 else if (unformat (input, "ignore-tag2"))
2602 else if (unformat (input, "cos1 %d", &cos1_val))
2604 else if (unformat (input, "cos2 %d", &cos2_val))
2609 if ((src + dst + proto + tag1 + tag2 +
2610 ignore_tag1 + ignore_tag2 + cos1 + cos2) == 0)
2613 if (tag1 || ignore_tag1 || cos1)
2615 if (tag2 || ignore_tag2 || cos2)
2618 vec_validate_aligned (match, len - 1, sizeof (u32x4));
2621 clib_memcpy_fast (match, dst_val, 6);
2624 clib_memcpy_fast (match + 6, src_val, 6);
2628 /* inner vlan tag */
2629 match[19] = tag2_val[1];
2630 match[18] = tag2_val[0];
2632 match[18] |= (cos2_val & 0x7) << 5;
2635 match[21] = proto_val & 0xff;
2636 match[20] = proto_val >> 8;
2640 match[15] = tag1_val[1];
2641 match[14] = tag1_val[0];
2644 match[14] |= (cos1_val & 0x7) << 5;
2650 match[15] = tag1_val[1];
2651 match[14] = tag1_val[0];
2654 match[17] = proto_val & 0xff;
2655 match[16] = proto_val >> 8;
2658 match[14] |= (cos1_val & 0x7) << 5;
2664 match[18] |= (cos2_val & 0x7) << 5;
2666 match[14] |= (cos1_val & 0x7) << 5;
2669 match[13] = proto_val & 0xff;
2670 match[12] = proto_val >> 8;
2679 unformat_classify_match (unformat_input_t * input, va_list * args)
2681 vnet_classify_main_t *cm = va_arg (*args, vnet_classify_main_t *);
2682 u8 **matchp = va_arg (*args, u8 **);
2683 u32 table_index = va_arg (*args, u32);
2684 vnet_classify_table_t *t;
2692 if (pool_is_free_index (cm->tables, table_index))
2695 t = pool_elt_at_index (cm->tables, table_index);
2697 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2699 if (unformat (input, "hex %U", unformat_hex_string, &match))
2701 else if (unformat (input, "l2 none"))
2702 /* Don't add the l2 header in the mask */
2704 else if (unformat (input, "l2 %U", unformat_l2_match, &l2))
2706 else if (unformat (input, "l3 %U", unformat_l3_match, &l3))
2708 else if (unformat (input, "l4 %U", unformat_l4_match, &l4))
2731 if (match || l2 || l3 || l4)
2737 /* "Win a free Ethernet header in every packet" */
2739 vec_validate_aligned (l2, 13, sizeof (u32x4));
2743 vec_append_aligned (match, l3, sizeof (u32x4));
2751 vec_append_aligned (match, l4, sizeof (u32x4));
2756 /* Make sure the vector is big enough even if key is all 0's */
2757 vec_validate_aligned
2759 ((t->match_n_vectors + t->skip_n_vectors) * sizeof (u32x4)) - 1,
2762 /* Set size, include skipped vectors */
2764 (t->match_n_vectors + t->skip_n_vectors) * sizeof (u32x4));
2775 vnet_classify_add_del_session (vnet_classify_main_t *cm, u32 table_index,
2776 const u8 *match, u16 hit_next_index,
2777 u32 opaque_index, i32 advance, u8 action,
2778 u32 metadata, int is_add)
2780 vnet_classify_table_t *t;
2781 vnet_classify_entry_5_t _max_e __attribute__ ((aligned (16)));
2782 vnet_classify_entry_t *e;
2785 if (pool_is_free_index (cm->tables, table_index))
2786 return VNET_API_ERROR_NO_SUCH_TABLE;
2788 t = pool_elt_at_index (cm->tables, table_index);
2790 e = (vnet_classify_entry_t *) & _max_e;
2791 e->next_index = hit_next_index;
2792 e->opaque_index = opaque_index;
2793 e->advance = advance;
2798 if (e->action == CLASSIFY_ACTION_SET_IP4_FIB_INDEX)
2799 e->metadata = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP4,
2801 FIB_SOURCE_CLASSIFY);
2802 else if (e->action == CLASSIFY_ACTION_SET_IP6_FIB_INDEX)
2803 e->metadata = fib_table_find_or_create_and_lock (FIB_PROTOCOL_IP6,
2805 FIB_SOURCE_CLASSIFY);
2806 else if (e->action == CLASSIFY_ACTION_SET_METADATA)
2807 e->metadata = metadata;
2811 /* Copy key data, honoring skip_n_vectors */
2812 clib_memcpy_fast (&e->key, match + t->skip_n_vectors * sizeof (u32x4),
2813 t->match_n_vectors * sizeof (u32x4));
2815 /* Clear don't-care bits; likely when dynamically creating sessions */
2816 for (i = 0; i < t->match_n_vectors; i++)
2817 e->key[i] &= t->mask[i];
2819 rv = vnet_classify_add_del (t, e, is_add);
2821 vnet_classify_entry_release_resource (e);
2824 return VNET_API_ERROR_NO_SUCH_ENTRY;
2828 static clib_error_t *
2829 classify_session_command_fn (vlib_main_t * vm,
2830 unformat_input_t * input,
2831 vlib_cli_command_t * cmd)
2833 vnet_classify_main_t *cm = &vnet_classify_main;
2835 u32 table_index = ~0;
2836 u32 hit_next_index = ~0;
2837 u64 opaque_index = ~0;
2844 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2846 if (unformat (input, "del"))
2848 else if (unformat (input, "hit-next %U", unformat_ip_next_index,
2853 (input, "l2-input-hit-next %U", unformat_l2_input_next_index,
2858 (input, "l2-output-hit-next %U", unformat_l2_output_next_index,
2861 else if (unformat (input, "acl-hit-next %U", unformat_acl_next_index,
2864 else if (unformat (input, "policer-hit-next %U",
2865 unformat_policer_next_index, &hit_next_index))
2867 else if (unformat (input, "opaque-index %lld", &opaque_index))
2869 else if (unformat (input, "match %U", unformat_classify_match,
2870 cm, &match, table_index))
2872 else if (unformat (input, "advance %d", &advance))
2874 else if (unformat (input, "table-index %d", &table_index))
2876 else if (unformat (input, "action set-ip4-fib-id %d", &metadata))
2878 else if (unformat (input, "action set-ip6-fib-id %d", &metadata))
2880 else if (unformat (input, "action set-sr-policy-index %d", &metadata))
2884 /* Try registered opaque-index unformat fns */
2885 for (i = 0; i < vec_len (cm->unformat_opaque_index_fns); i++)
2887 if (unformat (input, "%U", cm->unformat_opaque_index_fns[i],
2897 if (table_index == ~0)
2898 return clib_error_return (0, "Table index required");
2900 if (is_add && match == 0)
2901 return clib_error_return (0, "Match value required");
2903 rv = vnet_classify_add_del_session (cm, table_index, match,
2905 opaque_index, advance,
2906 action, metadata, is_add);
2914 return clib_error_return (0,
2915 "vnet_classify_add_del_session returned %d",
2922 VLIB_CLI_COMMAND (classify_session_command, static) = {
2923 .path = "classify session",
2925 "classify session [hit-next|l2-input-hit-next|l2-output-hit-next|"
2926 "acl-hit-next <next_index>|policer-hit-next <policer_name>]"
2927 "\n table-index <nn> match [hex] [l2] [l3 ip4] [opaque-index <index>]"
2928 "\n [action set-ip4-fib-id|set-ip6-fib-id|set-sr-policy-index <n>] [del]",
2929 .function = classify_session_command_fn,
2933 unformat_opaque_sw_if_index (unformat_input_t * input, va_list * args)
2935 u64 *opaquep = va_arg (*args, u64 *);
2938 if (unformat (input, "opaque-sw_if_index %U", unformat_vnet_sw_interface,
2939 vnet_get_main (), &sw_if_index))
2941 *opaquep = sw_if_index;
2948 unformat_ip_next_node (unformat_input_t * input, va_list * args)
2950 vnet_classify_main_t *cm = &vnet_classify_main;
2951 u32 *next_indexp = va_arg (*args, u32 *);
2953 u32 next_index = ~0;
2955 if (unformat (input, "ip6-node %U", unformat_vlib_node,
2956 cm->vlib_main, &node_index))
2958 next_index = vlib_node_add_next (cm->vlib_main,
2959 ip6_classify_node.index, node_index);
2961 else if (unformat (input, "ip4-node %U", unformat_vlib_node,
2962 cm->vlib_main, &node_index))
2964 next_index = vlib_node_add_next (cm->vlib_main,
2965 ip4_classify_node.index, node_index);
2970 *next_indexp = next_index;
2975 unformat_acl_next_node (unformat_input_t * input, va_list * args)
2977 vnet_classify_main_t *cm = &vnet_classify_main;
2978 u32 *next_indexp = va_arg (*args, u32 *);
2982 if (unformat (input, "ip6-node %U", unformat_vlib_node,
2983 cm->vlib_main, &node_index))
2985 next_index = vlib_node_add_next (cm->vlib_main,
2986 ip6_inacl_node.index, node_index);
2988 else if (unformat (input, "ip4-node %U", unformat_vlib_node,
2989 cm->vlib_main, &node_index))
2991 next_index = vlib_node_add_next (cm->vlib_main,
2992 ip4_inacl_node.index, node_index);
2997 *next_indexp = next_index;
3002 unformat_l2_input_next_node (unformat_input_t * input, va_list * args)
3004 vnet_classify_main_t *cm = &vnet_classify_main;
3005 u32 *next_indexp = va_arg (*args, u32 *);
3009 if (unformat (input, "input-node %U", unformat_vlib_node,
3010 cm->vlib_main, &node_index))
3012 next_index = vlib_node_add_next
3013 (cm->vlib_main, l2_input_classify_node.index, node_index);
3015 *next_indexp = next_index;
3022 unformat_l2_output_next_node (unformat_input_t * input, va_list * args)
3024 vnet_classify_main_t *cm = &vnet_classify_main;
3025 u32 *next_indexp = va_arg (*args, u32 *);
3029 if (unformat (input, "output-node %U", unformat_vlib_node,
3030 cm->vlib_main, &node_index))
3032 next_index = vlib_node_add_next
3033 (cm->vlib_main, l2_output_classify_node.index, node_index);
3035 *next_indexp = next_index;
3041 static clib_error_t *
3042 vnet_classify_init (vlib_main_t * vm)
3044 vnet_classify_main_t *cm = &vnet_classify_main;
3047 cm->vnet_main = vnet_get_main ();
3049 vnet_classify_register_unformat_opaque_index_fn
3050 (unformat_opaque_sw_if_index);
3052 vnet_classify_register_unformat_ip_next_index_fn (unformat_ip_next_node);
3054 vnet_classify_register_unformat_l2_next_index_fn
3055 (unformat_l2_input_next_node);
3057 vnet_classify_register_unformat_l2_next_index_fn
3058 (unformat_l2_output_next_node);
3060 vnet_classify_register_unformat_acl_next_index_fn (unformat_acl_next_node);
3062 vlib_global_main.trace_filter.classify_table_index = ~0;
3067 VLIB_INIT_FUNCTION (vnet_classify_init);
3070 vnet_is_packet_traced (vlib_buffer_t * b, u32 classify_table_index, int func)
3072 return vnet_is_packet_traced_inline (b, classify_table_index, func);
3074 VLIB_REGISTER_TRACE_FILTER_FUNCTION (vnet_is_packet_traced_fn, static) = {
3075 .name = "vnet_is_packet_traced",
3076 .description = "classifier based filter",
3078 .function = vnet_is_packet_traced
3093 test_entry_t *entries;
3095 /* test parameters */
3101 vnet_classify_table_t *table;
3109 classify_data_or_mask_t *mask;
3110 classify_data_or_mask_t *data;
3113 vnet_classify_main_t *classify_main;
3114 vlib_main_t *vlib_main;
3116 } test_classify_main_t;
3118 static test_classify_main_t test_classify_main;
3120 static clib_error_t *
3121 test_classify_churn (test_classify_main_t * tm)
3123 classify_data_or_mask_t *mask, *data;
3124 vlib_main_t *vm = tm->vlib_main;
3126 u8 *mp = 0, *dp = 0;
3130 vec_validate_aligned (mp, 3 * sizeof (u32x4), sizeof (u32x4));
3131 vec_validate_aligned (dp, 3 * sizeof (u32x4), sizeof (u32x4));
3133 mask = (classify_data_or_mask_t *) mp;
3134 data = (classify_data_or_mask_t *) dp;
3136 /* Mask on src address */
3137 clib_memset (&mask->ip.src_address, 0xff, 4);
3139 tmp = clib_host_to_net_u32 (tm->src.as_u32);
3141 for (i = 0; i < tm->sessions; i++)
3143 vec_add2 (tm->entries, ep, 1);
3144 ep->addr.as_u32 = clib_host_to_net_u32 (tmp);
3149 tm->table = vnet_classify_new_table (tm->classify_main,
3152 tm->memory_size, 0 /* skip */ ,
3153 3 /* vectors to match */ );
3154 tm->table->miss_next_index = IP_LOOKUP_NEXT_DROP;
3155 tm->table_index = tm->table - tm->classify_main->tables;
3156 vlib_cli_output (vm, "Created table %d, buckets %d",
3157 tm->table_index, tm->buckets);
3159 vlib_cli_output (vm, "Initialize: add %d (approx. half of %d sessions)...",
3160 tm->sessions / 2, tm->sessions);
3162 for (i = 0; i < tm->sessions / 2; i++)
3164 ep = vec_elt_at_index (tm->entries, i);
3166 data->ip.src_address.as_u32 = ep->addr.as_u32;
3169 rv = vnet_classify_add_del_session (tm->classify_main,
3172 IP_LOOKUP_NEXT_DROP,
3173 i /* opaque_index */ ,
3180 clib_warning ("add: returned %d", rv);
3183 vlib_cli_output (vm, "add: %U", format_ip4_address, &ep->addr.as_u32);
3186 vlib_cli_output (vm, "Execute %d random add/delete operations",
3189 for (i = 0; i < tm->iterations; i++)
3193 /* Pick a random entry */
3194 index = random_u32 (&tm->seed) % tm->sessions;
3196 ep = vec_elt_at_index (tm->entries, index);
3198 data->ip.src_address.as_u32 = ep->addr.as_u32;
3200 /* If it's in the table, remove it. Else, add it */
3201 is_add = !ep->in_table;
3204 vlib_cli_output (vm, "%s: %U",
3205 is_add ? "add" : "del",
3206 format_ip4_address, &ep->addr.as_u32);
3208 rv = vnet_classify_add_del_session (tm->classify_main,
3211 IP_LOOKUP_NEXT_DROP,
3212 i /* opaque_index */ ,
3218 vlib_cli_output (vm,
3219 "%s[%d]: %U returned %d", is_add ? "add" : "del",
3220 index, format_ip4_address, &ep->addr.as_u32, rv);
3222 ep->in_table = is_add;
3225 vlib_cli_output (vm, "Remove remaining %d entries from the table",
3226 tm->table->active_elements);
3228 for (i = 0; i < tm->sessions; i++)
3232 vnet_classify_entry_t *e;
3234 ep = tm->entries + i;
3235 if (ep->in_table == 0)
3238 data->ip.src_address.as_u32 = ep->addr.as_u32;
3240 hash = vnet_classify_hash_packet (tm->table, (u8 *) data);
3242 e = vnet_classify_find_entry (tm->table,
3243 (u8 *) data, hash, 0 /* time_now */ );
3246 clib_warning ("Couldn't find %U index %d which should be present",
3247 format_ip4_address, ep->addr, i);
3251 key_minus_skip = (u8 *) e->key;
3252 key_minus_skip -= tm->table->skip_n_vectors * sizeof (u32x4);
3254 rv = vnet_classify_add_del_session
3257 key_minus_skip, IP_LOOKUP_NEXT_DROP, i /* opaque_index */ ,
3258 0 /* advance */ , 0, 0,
3262 clib_warning ("del: returned %d", rv);
3265 vlib_cli_output (vm, "del: %U", format_ip4_address, &ep->addr.as_u32);
3268 vlib_cli_output (vm, "%d entries remain, MUST be zero",
3269 tm->table->active_elements);
3271 vlib_cli_output (vm, "Table after cleanup: \n%U\n",
3272 format_classify_table, tm->table, 0 /* verbose */ );
3277 vnet_classify_delete_table_index (tm->classify_main,
3278 tm->table_index, 1 /* del_chain */ );
3280 tm->table_index = ~0;
3281 vec_free (tm->entries);
3286 static clib_error_t *
3287 test_classify_command_fn (vlib_main_t * vm,
3288 unformat_input_t * input, vlib_cli_command_t * cmd)
3290 test_classify_main_t *tm = &test_classify_main;
3291 vnet_classify_main_t *cm = &vnet_classify_main;
3294 clib_error_t *error = 0;
3297 tm->sessions = 8192;
3298 tm->iterations = 8192;
3299 tm->memory_size = 64 << 20;
3300 tm->src.as_u32 = clib_net_to_host_u32 (0x0100000A);
3302 tm->seed = 0xDEADDABE;
3303 tm->classify_main = cm;
3307 /* Default starting address 1.0.0.10 */
3309 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3311 if (unformat (input, "sessions %d", &tmp))
3314 if (unformat (input, "src %U", unformat_ip4_address, &tm->src.as_u32))
3316 else if (unformat (input, "buckets %d", &tm->buckets))
3318 else if (unformat (input, "memory-size %uM", &tmp))
3319 tm->memory_size = tmp << 20;
3320 else if (unformat (input, "memory-size %uG", &tmp))
3321 tm->memory_size = tmp << 30;
3322 else if (unformat (input, "seed %d", &tm->seed))
3324 else if (unformat (input, "verbose"))
3327 else if (unformat (input, "iterations %d", &tm->iterations))
3329 else if (unformat (input, "churn-test"))
3338 error = test_classify_churn (tm);
3341 error = clib_error_return (0, "No such test");
3348 VLIB_CLI_COMMAND (test_classify_command, static) = {
3349 .path = "test classify",
3351 "test classify [src <ip>] [sessions <nn>] [buckets <nn>] [seed <nnn>]\n"
3352 " [memory-size <nn>[M|G]]\n"
3354 .function = test_classify_command_fn,
3356 #endif /* TEST_CODE */
3359 * fd.io coding-style-patch-verification: ON
3362 * eval: (c-set-style "gnu")