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 #define CLASSIFY_FLAG_USE_CURR_DATA 1
40 * Classify session action
41 * CLASSIFY_ACTION_SET_IP4_FIB_INDEX:
42 * - Classified IP packets will be looked up
43 * from the specified ipv4 fib table
44 * CLASSIFY_ACTION_SET_IP6_FIB_INDEX:
45 * - Classified IP packets will be looked up
46 * from the specified ipv6 fib table
48 typedef enum vnet_classify_action_t_
50 CLASSIFY_ACTION_SET_IP4_FIB_INDEX = 1,
51 CLASSIFY_ACTION_SET_IP6_FIB_INDEX = 2,
52 CLASSIFY_ACTION_SET_METADATA = 3,
53 } __attribute__ ((packed)) vnet_classify_action_t;
55 struct _vnet_classify_main;
56 typedef struct _vnet_classify_main vnet_classify_main_t;
58 #define foreach_size_in_u32x4 \
66 typedef CLIB_PACKED(struct _vnet_classify_entry {
67 /* Graph node next index */
70 /* put into vnet_buffer(b)->l2_classfy.opaque_index */
74 /* advance on hit, note it's a signed quantity... */
80 /* Really only need 1 bit */
82 #define VNET_CLASSIFY_ENTRY_FREE (1<<0)
84 vnet_classify_action_t action;
87 /* Hit counter, last heard time */
90 struct _vnet_classify_entry * next_free;
95 /* Must be aligned to a 16-octet boundary */
97 }) vnet_classify_entry_t;
101 vnet_classify_entry_is_free (vnet_classify_entry_t * e)
103 return e->flags & VNET_CLASSIFY_ENTRY_FREE;
107 vnet_classify_entry_is_busy (vnet_classify_entry_t * e)
109 return ((e->flags & VNET_CLASSIFY_ENTRY_FREE) == 0);
112 /* Need these to con the vector allocator */
115 typedef CLIB_PACKED(struct { \
119 }) vnet_classify_entry_##size##_t;
120 foreach_size_in_u32x4;
137 } vnet_classify_bucket_t;
141 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
142 /* Mask to apply after skipping N vectors */
144 /* Buckets and entries */
145 vnet_classify_bucket_t *buckets;
146 vnet_classify_entry_t *entries;
148 /* Config parameters */
154 int entries_per_page;
156 u32 current_data_flag;
157 int current_data_offset;
159 /* Index of next table to try */
160 u32 next_table_index;
162 /* Miss next index, return if next_table_index = 0 */
165 /* Per-bucket working copies, one per thread */
166 vnet_classify_entry_t **working_copies;
167 int *working_copy_lengths;
168 vnet_classify_bucket_t saved_bucket;
170 /* Free entry freelists */
171 vnet_classify_entry_t **freelists;
175 /* Private allocation arena, protected by the writer lock */
178 /* Writer (only) lock for this table */
179 clib_spinlock_t writer_lock;
181 } vnet_classify_table_t;
187 } vnet_classify_filter_set_t;
189 struct _vnet_classify_main
192 vnet_classify_table_t *tables;
194 /* Registered next-index, opaque unformat fcns */
195 unformat_function_t **unformat_l2_next_index_fns;
196 unformat_function_t **unformat_ip_next_index_fns;
197 unformat_function_t **unformat_acl_next_index_fns;
198 unformat_function_t **unformat_policer_next_index_fns;
199 unformat_function_t **unformat_opaque_index_fns;
201 /* Pool of filter sets */
202 vnet_classify_filter_set_t *filter_sets;
204 /* Per-interface filter set map. [0] is used for pcap */
205 u32 *filter_set_by_sw_if_index;
207 /* convenience variables */
208 vlib_main_t *vlib_main;
209 vnet_main_t *vnet_main;
212 extern vnet_classify_main_t vnet_classify_main;
214 u8 *format_classify_table (u8 * s, va_list * args);
216 u64 vnet_classify_hash_packet (vnet_classify_table_t * t, u8 * h);
219 vnet_classify_hash_packet_inline (vnet_classify_table_t * t, u8 * h)
227 } xor_sum __attribute__ ((aligned (sizeof (u32x4))));
231 #ifdef CLIB_HAVE_VEC128
232 u32x4u *data = (u32x4u *) h;
233 xor_sum.as_u32x4 = data[0 + t->skip_n_vectors] & mask[0];
234 switch (t->match_n_vectors)
237 xor_sum.as_u32x4 ^= data[4 + t->skip_n_vectors] & mask[4];
240 xor_sum.as_u32x4 ^= data[3 + t->skip_n_vectors] & mask[3];
243 xor_sum.as_u32x4 ^= data[2 + t->skip_n_vectors] & mask[2];
246 xor_sum.as_u32x4 ^= data[1 + t->skip_n_vectors] & mask[1];
254 u32 skip_u64 = t->skip_n_vectors * 2;
255 u64 *data64 = (u64 *) h;
256 xor_sum.as_u64[0] = data64[0 + skip_u64] & ((u64 *) mask)[0];
257 xor_sum.as_u64[1] = data64[1 + skip_u64] & ((u64 *) mask)[1];
258 switch (t->match_n_vectors)
261 xor_sum.as_u64[0] ^= data64[8 + skip_u64] & ((u64 *) mask)[8];
262 xor_sum.as_u64[1] ^= data64[9 + skip_u64] & ((u64 *) mask)[9];
265 xor_sum.as_u64[0] ^= data64[6 + skip_u64] & ((u64 *) mask)[6];
266 xor_sum.as_u64[1] ^= data64[7 + skip_u64] & ((u64 *) mask)[7];
269 xor_sum.as_u64[0] ^= data64[4 + skip_u64] & ((u64 *) mask)[4];
270 xor_sum.as_u64[1] ^= data64[5 + skip_u64] & ((u64 *) mask)[5];
273 xor_sum.as_u64[0] ^= data64[2 + skip_u64] & ((u64 *) mask)[2];
274 xor_sum.as_u64[1] ^= data64[3 + skip_u64] & ((u64 *) mask)[3];
282 #endif /* CLIB_HAVE_VEC128 */
284 #ifdef clib_crc32c_uses_intrinsics
285 return clib_crc32c ((u8 *) & xor_sum, sizeof (xor_sum));
287 return clib_xxhash (xor_sum.as_u64[0] ^ xor_sum.as_u64[1]);
292 vnet_classify_prefetch_bucket (vnet_classify_table_t * t, u64 hash)
296 ASSERT (is_pow2 (t->nbuckets));
298 bucket_index = hash & (t->nbuckets - 1);
300 CLIB_PREFETCH (&t->buckets[bucket_index], CLIB_CACHE_LINE_BYTES, LOAD);
303 static inline vnet_classify_entry_t *
304 vnet_classify_get_entry (vnet_classify_table_t * t, uword offset)
306 u8 *hp = clib_mem_get_heap_base (t->mheap);
307 u8 *vp = hp + offset;
313 vnet_classify_get_offset (vnet_classify_table_t * t,
314 vnet_classify_entry_t * v)
318 hp = (u8 *) clib_mem_get_heap_base (t->mheap);
321 ASSERT ((vp - hp) < 0x100000000ULL);
325 static inline vnet_classify_entry_t *
326 vnet_classify_entry_at_index (vnet_classify_table_t * t,
327 vnet_classify_entry_t * e, u32 index)
333 eu8 += index * (sizeof (vnet_classify_entry_t) +
334 (t->match_n_vectors * sizeof (u32x4)));
336 return (vnet_classify_entry_t *) eu8;
340 vnet_classify_prefetch_entry (vnet_classify_table_t * t, u64 hash)
344 vnet_classify_bucket_t *b;
345 vnet_classify_entry_t *e;
347 bucket_index = hash & (t->nbuckets - 1);
349 b = &t->buckets[bucket_index];
354 hash >>= t->log2_nbuckets;
356 e = vnet_classify_get_entry (t, b->offset);
357 value_index = hash & ((1 << b->log2_pages) - 1);
359 e = vnet_classify_entry_at_index (t, e, value_index);
361 CLIB_PREFETCH (e, CLIB_CACHE_LINE_BYTES, LOAD);
364 vnet_classify_entry_t *vnet_classify_find_entry (vnet_classify_table_t * t,
365 u8 * h, u64 hash, f64 now);
367 static inline vnet_classify_entry_t *
368 vnet_classify_find_entry_inline (vnet_classify_table_t * t,
369 u8 * h, u64 hash, f64 now)
371 vnet_classify_entry_t *v;
377 } result __attribute__ ((aligned (sizeof (u32x4))));
378 vnet_classify_bucket_t *b;
384 bucket_index = hash & (t->nbuckets - 1);
385 b = &t->buckets[bucket_index];
391 hash >>= t->log2_nbuckets;
393 v = vnet_classify_get_entry (t, b->offset);
394 value_index = hash & ((1 << b->log2_pages) - 1);
395 limit = t->entries_per_page;
396 if (PREDICT_FALSE (b->linear_search))
399 limit *= (1 << b->log2_pages);
402 v = vnet_classify_entry_at_index (t, v, value_index);
404 #ifdef CLIB_HAVE_VEC128
405 u32x4u *data = (u32x4u *) h;
406 for (i = 0; i < limit; i++)
409 result.as_u32x4 = (data[0 + t->skip_n_vectors] & mask[0]) ^ key[0];
410 switch (t->match_n_vectors)
413 result.as_u32x4 |= (data[4 + t->skip_n_vectors] & mask[4]) ^ key[4];
416 result.as_u32x4 |= (data[3 + t->skip_n_vectors] & mask[3]) ^ key[3];
419 result.as_u32x4 |= (data[2 + t->skip_n_vectors] & mask[2]) ^ key[2];
422 result.as_u32x4 |= (data[1 + t->skip_n_vectors] & mask[1]) ^ key[1];
430 if (u32x4_zero_byte_mask (result.as_u32x4) == 0xffff)
432 if (PREDICT_TRUE (now))
439 v = vnet_classify_entry_at_index (t, v, 1);
442 u32 skip_u64 = t->skip_n_vectors * 2;
443 u64 *data64 = (u64 *) h;
444 for (i = 0; i < limit; i++)
449 (data64[0 + skip_u64] & ((u64 *) mask)[0]) ^ ((u64 *) key)[0];
451 (data64[1 + skip_u64] & ((u64 *) mask)[1]) ^ ((u64 *) key)[1];
452 switch (t->match_n_vectors)
456 (data64[8 + skip_u64] & ((u64 *) mask)[8]) ^ ((u64 *) key)[8];
458 (data64[9 + skip_u64] & ((u64 *) mask)[9]) ^ ((u64 *) key)[9];
462 (data64[6 + skip_u64] & ((u64 *) mask)[6]) ^ ((u64 *) key)[6];
464 (data64[7 + skip_u64] & ((u64 *) mask)[7]) ^ ((u64 *) key)[7];
468 (data64[4 + skip_u64] & ((u64 *) mask)[4]) ^ ((u64 *) key)[4];
470 (data64[5 + skip_u64] & ((u64 *) mask)[5]) ^ ((u64 *) key)[5];
474 (data64[2 + skip_u64] & ((u64 *) mask)[2]) ^ ((u64 *) key)[2];
476 (data64[3 + skip_u64] & ((u64 *) mask)[3]) ^ ((u64 *) key)[3];
484 if (result.as_u64[0] == 0 && result.as_u64[1] == 0)
486 if (PREDICT_TRUE (now))
494 v = vnet_classify_entry_at_index (t, v, 1);
496 #endif /* CLIB_HAVE_VEC128 */
500 vnet_classify_table_t *vnet_classify_new_table (vnet_classify_main_t * cm,
501 u8 * mask, u32 nbuckets,
504 u32 match_n_vectors);
506 int vnet_classify_add_del_session (vnet_classify_main_t * cm,
512 u8 action, u32 metadata, int is_add);
514 int vnet_classify_add_del_table (vnet_classify_main_t * cm,
520 u32 next_table_index,
523 u8 current_data_flag,
524 i16 current_data_offset,
525 int is_add, int del_chain);
527 unformat_function_t unformat_ip4_mask;
528 unformat_function_t unformat_ip6_mask;
529 unformat_function_t unformat_l3_mask;
530 unformat_function_t unformat_l2_mask;
531 unformat_function_t unformat_classify_mask;
532 unformat_function_t unformat_l2_next_index;
533 unformat_function_t unformat_ip_next_index;
534 unformat_function_t unformat_ip4_match;
535 unformat_function_t unformat_ip6_match;
536 unformat_function_t unformat_l3_match;
537 unformat_function_t unformat_l4_match;
538 unformat_function_t unformat_vlan_tag;
539 unformat_function_t unformat_l2_match;
540 unformat_function_t unformat_classify_match;
542 void vnet_classify_register_unformat_ip_next_index_fn
543 (unformat_function_t * fn);
545 void vnet_classify_register_unformat_l2_next_index_fn
546 (unformat_function_t * fn);
548 void vnet_classify_register_unformat_acl_next_index_fn
549 (unformat_function_t * fn);
551 void vnet_classify_register_unformat_policer_next_index_fn
552 (unformat_function_t * fn);
554 void vnet_classify_register_unformat_opaque_index_fn (unformat_function_t *
557 #endif /* __included_vnet_classify_h__ */
560 * fd.io coding-style-patch-verification: ON
563 * eval: (c-set-style "gnu")