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.
15 #ifndef __included_vnet_classify_h__
16 #define __included_vnet_classify_h__
18 #include <vnet/vnet.h>
19 #include <vnet/api_errno.h> /* for API error numbers */
21 #include <vppinfra/error.h>
22 #include <vppinfra/hash.h>
23 #include <vppinfra/cache.h>
24 #include <vppinfra/crc32.h>
25 #include <vppinfra/xxhash.h>
27 extern vlib_node_registration_t ip4_classify_node;
28 extern vlib_node_registration_t ip6_classify_node;
30 #define CLASSIFY_TRACE 0
33 * Classify table option to process packets
34 * CLASSIFY_FLAG_USE_CURR_DATA:
35 * - classify packets starting from VPP node’s current data pointer
37 typedef enum vnet_classify_flags_t_
39 CLASSIFY_FLAG_NONE = 0,
40 CLASSIFY_FLAG_USE_CURR_DATA = (1 << 0),
41 } __clib_packed vnet_classify_flags_t;
44 * Classify session action
45 * CLASSIFY_ACTION_SET_IP4_FIB_INDEX:
46 * - Classified IP packets will be looked up
47 * from the specified ipv4 fib table
48 * CLASSIFY_ACTION_SET_IP6_FIB_INDEX:
49 * - Classified IP packets will be looked up
50 * from the specified ipv6 fib table
52 typedef enum vnet_classify_action_t_
54 CLASSIFY_ACTION_NONE = 0,
55 CLASSIFY_ACTION_SET_IP4_FIB_INDEX = 1,
56 CLASSIFY_ACTION_SET_IP6_FIB_INDEX = 2,
57 CLASSIFY_ACTION_SET_METADATA = 3,
58 } __clib_packed vnet_classify_action_t;
60 struct _vnet_classify_main;
61 typedef struct _vnet_classify_main vnet_classify_main_t;
63 #define foreach_size_in_u32x4 \
70 typedef struct _vnet_classify_entry
72 /* put into vnet_buffer(b)->l2_classfy.opaque_index */
78 /* advance on hit, note it's a signed quantity... */
87 struct _vnet_classify_entry *next_free;
92 /* Really only need 1 bit */
94 #define VNET_CLASSIFY_ENTRY_FREE (1<<0)
96 vnet_classify_action_t action;
98 /* Graph node next index */
101 /* Must be aligned to a 16-octet boundary */
103 } vnet_classify_entry_t;
106 * Check there's no padding in the entry. the key lies on a 16 byte boundary.
108 STATIC_ASSERT_OFFSET_OF (vnet_classify_entry_t, key, 32);
111 vnet_classify_entry_is_free (vnet_classify_entry_t * e)
113 return e->flags & VNET_CLASSIFY_ENTRY_FREE;
117 vnet_classify_entry_is_busy (vnet_classify_entry_t * e)
119 return ((e->flags & VNET_CLASSIFY_ENTRY_FREE) == 0);
122 /* Need these to con the vector allocator */
126 vnet_classify_entry_t e; \
128 } __clib_packed vnet_classify_entry_##size##_t;
129 foreach_size_in_u32x4;
145 } vnet_classify_bucket_t;
149 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
151 vnet_classify_bucket_t *buckets;
153 /* Private allocation arena, protected by the writer lock,
154 * where the entries are stored. */
157 /* User/client data associated with the table */
162 u32 entries_per_page;
167 /* Index of next table to try */
168 u32 next_table_index;
171 i16 current_data_offset;
172 vnet_classify_flags_t current_data_flag;
173 /* Miss next index, return if next_table_index = 0 */
177 * All members accessed in the DP above here
179 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
181 /* Config parameters */
186 /* Per-bucket working copies, one per thread */
187 vnet_classify_entry_t **working_copies;
188 int *working_copy_lengths;
189 vnet_classify_bucket_t saved_bucket;
191 /* Free entry freelists */
192 vnet_classify_entry_t **freelists;
194 /* Writer (only) lock for this table */
195 clib_spinlock_t writer_lock;
197 CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
198 /* Mask to apply after skipping N vectors */
205 } vnet_classify_table_t;
208 * Ensure DP fields don't spill over to cache-line 2
210 STATIC_ASSERT_OFFSET_OF (vnet_classify_table_t, cacheline1,
211 CLIB_CACHE_LINE_BYTES);
214 * The vector size for the classifier
215 * in the add/del table 'match' is the number of vectors of this size
217 #define VNET_CLASSIFY_VECTOR_SIZE \
218 sizeof (((vnet_classify_table_t *) 0)->mask[0])
220 struct _vnet_classify_main
223 vnet_classify_table_t *tables;
225 /* Registered next-index, opaque unformat fcns */
226 unformat_function_t **unformat_l2_next_index_fns;
227 unformat_function_t **unformat_ip_next_index_fns;
228 unformat_function_t **unformat_acl_next_index_fns;
229 unformat_function_t **unformat_policer_next_index_fns;
230 unformat_function_t **unformat_opaque_index_fns;
232 /* Per-interface filter table. [0] is used for pcap */
233 u32 *classify_table_index_by_sw_if_index;
235 /* convenience variables */
236 vlib_main_t *vlib_main;
237 vnet_main_t *vnet_main;
240 extern vnet_classify_main_t vnet_classify_main;
242 u8 *format_classify_table (u8 * s, va_list * args);
243 u8 *format_vnet_classify_table (u8 *s, va_list *args);
245 u64 vnet_classify_hash_packet (vnet_classify_table_t * t, u8 * h);
247 static_always_inline vnet_classify_table_t *
248 vnet_classify_table_get (u32 table_index)
250 vnet_classify_main_t *vcm = &vnet_classify_main;
252 return (pool_elt_at_index (vcm->tables, table_index));
256 vnet_classify_hash_packet_inline (vnet_classify_table_t *t, const u8 *h)
260 h += t->skip_n_vectors * 16;
262 #if defined(CLIB_HAVE_VEC512) && defined(CLIB_HAVE_VEC512_MASK_LOAD_STORE)
263 u64x8 xor_sum_x8, *mask = (u64x8 *) t->mask;
264 u16 load_mask = t->load_mask;
265 u64x8u *data = (u64x8u *) h;
267 xor_sum_x8 = u64x8_mask_load_zero (data, load_mask) & mask[0];
269 if (PREDICT_FALSE (load_mask >> 8))
270 xor_sum_x8 ^= u64x8_mask_load_zero (data + 1, load_mask >> 8) & mask[1];
272 xor_sum_x8 ^= u64x8_align_right (xor_sum_x8, xor_sum_x8, 4);
273 xor_sum_x8 ^= u64x8_align_right (xor_sum_x8, xor_sum_x8, 2);
274 xor_sum = xor_sum_x8[0] ^ xor_sum_x8[1];
275 #elif defined(CLIB_HAVE_VEC256) && defined(CLIB_HAVE_VEC256_MASK_LOAD_STORE)
276 u64x4 xor_sum_x4, *mask = (u64x4 *) t->mask;
277 u16 load_mask = t->load_mask;
278 u64x4u *data = (u64x4u *) h;
280 xor_sum_x4 = u64x4_mask_load_zero (data, load_mask) & mask[0];
281 xor_sum_x4 ^= u64x4_mask_load_zero (data + 1, load_mask >> 4) & mask[1];
283 if (PREDICT_FALSE (load_mask >> 8))
284 xor_sum_x4 ^= u64x4_mask_load_zero (data + 2, load_mask >> 8) & mask[2];
286 xor_sum_x4 ^= u64x4_align_right (xor_sum_x4, xor_sum_x4, 2);
287 xor_sum = xor_sum_x4[0] ^ xor_sum_x4[1];
288 #elif defined(CLIB_HAVE_VEC128)
289 u64x2 *mask = (u64x2 *) t->mask;
290 u64x2u *data = (u64x2u *) h;
293 xor_sum_x2 = data[0] & mask[0];
295 switch (t->match_n_vectors)
298 xor_sum_x2 ^= data[4] & mask[4];
301 xor_sum_x2 ^= data[3] & mask[3];
304 xor_sum_x2 ^= data[2] & mask[2];
307 xor_sum_x2 ^= data[1] & mask[1];
314 xor_sum = xor_sum_x2[0] ^ xor_sum_x2[1];
316 u64 *data = (u64 *) h;
317 u64 *mask = (u64 *) t->mask;
319 xor_sum = (data[0] & mask[0]) ^ (data[1] & mask[1]);
321 switch (t->match_n_vectors)
324 xor_sum ^= (data[8] & mask[8]) ^ (data[9] & mask[9]);
327 xor_sum ^= (data[6] & mask[6]) ^ (data[7] & mask[7]);
330 xor_sum ^= (data[4] & mask[4]) ^ (data[5] & mask[5]);
333 xor_sum ^= (data[2] & mask[2]) ^ (data[3] & mask[3]);
341 #endif /* CLIB_HAVE_VEC128 */
343 #ifdef clib_crc32c_uses_intrinsics
344 return clib_crc32c ((u8 *) & xor_sum, sizeof (xor_sum));
346 return clib_xxhash (xor_sum);
351 vnet_classify_prefetch_bucket (vnet_classify_table_t * t, u64 hash)
355 ASSERT (is_pow2 (t->nbuckets));
357 bucket_index = hash & (t->nbuckets - 1);
359 clib_prefetch_load (&t->buckets[bucket_index]);
362 static inline vnet_classify_entry_t *
363 vnet_classify_get_entry (vnet_classify_table_t * t, uword offset)
365 u8 *hp = clib_mem_get_heap_base (t->mheap);
366 u8 *vp = hp + offset;
368 return (vnet_classify_entry_t *) vp;
372 vnet_classify_get_offset (vnet_classify_table_t * t,
373 vnet_classify_entry_t * v)
377 hp = (u8 *) clib_mem_get_heap_base (t->mheap);
380 ASSERT ((vp - hp) < 0x100000000ULL);
384 static inline vnet_classify_entry_t *
385 vnet_classify_entry_at_index (vnet_classify_table_t * t,
386 vnet_classify_entry_t * e, u32 index)
392 eu8 += index * (sizeof (vnet_classify_entry_t) +
393 (t->match_n_vectors * sizeof (u32x4)));
395 return (vnet_classify_entry_t *) eu8;
399 vnet_classify_prefetch_entry (vnet_classify_table_t * t, u64 hash)
403 vnet_classify_bucket_t *b;
404 vnet_classify_entry_t *e;
406 bucket_index = hash & (t->nbuckets - 1);
408 b = &t->buckets[bucket_index];
413 hash >>= t->log2_nbuckets;
415 e = vnet_classify_get_entry (t, b->offset);
416 value_index = hash & ((1 << b->log2_pages) - 1);
418 e = vnet_classify_entry_at_index (t, e, value_index);
420 clib_prefetch_load (e);
423 vnet_classify_entry_t *vnet_classify_find_entry (vnet_classify_table_t * t,
424 u8 * h, u64 hash, f64 now);
426 static_always_inline int
427 vnet_classify_entry_is_equal (vnet_classify_entry_t *v, const u8 *d, u8 *m,
428 u32 match_n_vectors, u16 load_mask)
430 #if defined(CLIB_HAVE_VEC512) && defined(CLIB_HAVE_VEC512_MASK_LOAD_STORE)
431 u64x8 r, *mask = (u64x8 *) m;
432 u64x8u *data = (u64x8u *) d;
433 u64x8 *key = (u64x8 *) v->key;
435 r = (u64x8_mask_load_zero (data, load_mask) & mask[0]) ^
436 u64x8_mask_load_zero (key, load_mask);
439 if (PREDICT_FALSE (load_mask))
440 r |= (u64x8_mask_load_zero (data + 1, load_mask) & mask[1]) ^
441 u64x8_mask_load_zero (key + 1, load_mask);
443 if (u64x8_is_all_zero (r))
446 #elif defined(CLIB_HAVE_VEC256) && defined(CLIB_HAVE_VEC256_MASK_LOAD_STORE)
447 u64x4 r, *mask = (u64x4 *) m;
448 u64x4u *data = (u64x4u *) d;
449 u64x4 *key = (u64x4 *) v->key;
451 r = (u64x4_mask_load_zero (data, load_mask) & mask[0]) ^
452 u64x4_mask_load_zero (key, load_mask);
455 r |= (u64x4_mask_load_zero (data + 1, load_mask) & mask[1]) ^
456 u64x4_mask_load_zero (key + 1, load_mask);
459 if (PREDICT_FALSE (load_mask))
460 r |= (u64x4_mask_load_zero (data + 2, load_mask) & mask[2]) ^
461 u64x4_mask_load_zero (key + 2, load_mask);
463 if (u64x4_is_all_zero (r))
466 #elif defined(CLIB_HAVE_VEC128)
467 u64x2u *data = (u64x2 *) d;
468 u64x2 *key = (u64x2 *) v->key;
469 u64x2 *mask = (u64x2 *) m;
472 r = (data[0] & mask[0]) ^ key[0];
473 switch (match_n_vectors)
476 r |= (data[4] & mask[4]) ^ key[4];
479 r |= (data[3] & mask[3]) ^ key[3];
482 r |= (data[2] & mask[2]) ^ key[2];
485 r |= (data[1] & mask[1]) ^ key[1];
493 if (u64x2_is_all_zero (r))
497 u64 *data = (u64 *) d;
498 u64 *key = (u64 *) v->key;
499 u64 *mask = (u64 *) m;
502 r = ((data[0] & mask[0]) ^ key[0]) | ((data[1] & mask[1]) ^ key[1]);
503 switch (match_n_vectors)
506 r |= ((data[8] & mask[8]) ^ key[8]) | ((data[9] & mask[9]) ^ key[9]);
509 r |= ((data[6] & mask[6]) ^ key[6]) | ((data[7] & mask[7]) ^ key[7]);
512 r |= ((data[4] & mask[4]) ^ key[4]) | ((data[5] & mask[5]) ^ key[5]);
515 r |= ((data[2] & mask[2]) ^ key[2]) | ((data[3] & mask[3]) ^ key[3]);
526 #endif /* CLIB_HAVE_VEC128 */
530 static inline vnet_classify_entry_t *
531 vnet_classify_find_entry_inline (vnet_classify_table_t *t, const u8 *h,
534 vnet_classify_entry_t *v;
535 vnet_classify_bucket_t *b;
536 u32 bucket_index, limit, pages, match_n_vectors = t->match_n_vectors;
537 u16 load_mask = t->load_mask;
538 u8 *mask = (u8 *) t->mask;
541 bucket_index = hash & (t->nbuckets - 1);
542 b = &t->buckets[bucket_index];
547 pages = 1 << b->log2_pages;
548 v = vnet_classify_get_entry (t, b->offset);
549 limit = t->entries_per_page;
550 if (PREDICT_FALSE (b->linear_search))
553 v = vnet_classify_entry_at_index (t, v, 0);
557 hash >>= t->log2_nbuckets;
558 v = vnet_classify_entry_at_index (t, v, hash & (pages - 1));
561 h += t->skip_n_vectors * 16;
563 for (i = 0; i < limit; i++)
565 if (vnet_classify_entry_is_equal (v, h, mask, match_n_vectors,
568 if (PREDICT_TRUE (now))
575 v = vnet_classify_entry_at_index (t, v, 1);
580 vnet_classify_table_t *vnet_classify_new_table (vnet_classify_main_t *cm,
581 const u8 *mask, u32 nbuckets,
584 u32 match_n_vectors);
586 int vnet_classify_add_del_session (vnet_classify_main_t *cm, u32 table_index,
587 const u8 *match, u32 hit_next_index,
588 u32 opaque_index, i32 advance, u8 action,
589 u16 metadata, int is_add);
591 int vnet_classify_add_del_table (vnet_classify_main_t *cm, const u8 *mask,
592 u32 nbuckets, u32 memory_size, u32 skip,
593 u32 match, u32 next_table_index,
594 u32 miss_next_index, u32 *table_index,
595 u8 current_data_flag, i16 current_data_offset,
596 int is_add, int del_chain);
597 void vnet_classify_delete_table_index (vnet_classify_main_t *cm,
598 u32 table_index, int del_chain);
600 unformat_function_t unformat_ip4_mask;
601 unformat_function_t unformat_ip6_mask;
602 unformat_function_t unformat_l3_mask;
603 unformat_function_t unformat_l2_mask;
604 unformat_function_t unformat_classify_mask;
605 unformat_function_t unformat_l2_next_index;
606 unformat_function_t unformat_ip_next_index;
607 unformat_function_t unformat_ip4_match;
608 unformat_function_t unformat_ip6_match;
609 unformat_function_t unformat_l3_match;
610 unformat_function_t unformat_l4_match;
611 unformat_function_t unformat_vlan_tag;
612 unformat_function_t unformat_l2_match;
613 unformat_function_t unformat_classify_match;
615 void vnet_classify_register_unformat_ip_next_index_fn
616 (unformat_function_t * fn);
618 void vnet_classify_register_unformat_l2_next_index_fn
619 (unformat_function_t * fn);
621 void vnet_classify_register_unformat_acl_next_index_fn
622 (unformat_function_t * fn);
624 void vnet_classify_register_unformat_policer_next_index_fn
625 (unformat_function_t * fn);
627 void vnet_classify_register_unformat_opaque_index_fn (unformat_function_t *
630 u32 classify_get_pcap_chain (vnet_classify_main_t * cm, u32 sw_if_index);
631 void classify_set_pcap_chain (vnet_classify_main_t * cm,
632 u32 sw_if_index, u32 table_index);
634 u32 classify_get_trace_chain (void);
635 void classify_set_trace_chain (vnet_classify_main_t * cm, u32 table_index);
637 u32 classify_sort_table_chain (vnet_classify_main_t * cm, u32 table_index);
638 u32 classify_lookup_chain (u32 table_index,
639 u8 * mask, u32 n_skip, u32 n_match);
641 #endif /* __included_vnet_classify_h__ */
644 * fd.io coding-style-patch-verification: ON
647 * eval: (c-set-style "gnu")