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;
166 /* Index of next table to try */
167 u32 next_table_index;
170 i16 current_data_offset;
171 vnet_classify_flags_t current_data_flag;
172 /* Miss next index, return if next_table_index = 0 */
176 * All members accessed in the DP above here
178 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
180 /* Config parameters */
185 /* Per-bucket working copies, one per thread */
186 vnet_classify_entry_t **working_copies;
187 int *working_copy_lengths;
188 vnet_classify_bucket_t saved_bucket;
190 /* Free entry freelists */
191 vnet_classify_entry_t **freelists;
193 /* Writer (only) lock for this table */
194 clib_spinlock_t writer_lock;
196 CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
197 /* Mask to apply after skipping N vectors */
200 } vnet_classify_table_t;
203 * Ensure DP fields don't spill over to cache-line 2
205 STATIC_ASSERT_OFFSET_OF (vnet_classify_table_t, cacheline1,
206 CLIB_CACHE_LINE_BYTES);
209 * The vector size for the classifier
210 * in the add/del table 'match' is the number of vectors of this size
212 #define VNET_CLASSIFY_VECTOR_SIZE \
213 sizeof (((vnet_classify_table_t *) 0)->mask[0])
215 struct _vnet_classify_main
218 vnet_classify_table_t *tables;
220 /* Registered next-index, opaque unformat fcns */
221 unformat_function_t **unformat_l2_next_index_fns;
222 unformat_function_t **unformat_ip_next_index_fns;
223 unformat_function_t **unformat_acl_next_index_fns;
224 unformat_function_t **unformat_policer_next_index_fns;
225 unformat_function_t **unformat_opaque_index_fns;
227 /* Per-interface filter table. [0] is used for pcap */
228 u32 *classify_table_index_by_sw_if_index;
230 /* convenience variables */
231 vlib_main_t *vlib_main;
232 vnet_main_t *vnet_main;
235 extern vnet_classify_main_t vnet_classify_main;
237 u8 *format_classify_table (u8 * s, va_list * args);
238 u8 *format_vnet_classify_table (u8 *s, va_list *args);
240 u64 vnet_classify_hash_packet (vnet_classify_table_t * t, u8 * h);
242 static_always_inline vnet_classify_table_t *
243 vnet_classify_table_get (u32 table_index)
245 vnet_classify_main_t *vcm = &vnet_classify_main;
247 return (pool_elt_at_index (vcm->tables, table_index));
251 vnet_classify_hash_packet_inline (vnet_classify_table_t *t, const u8 *h)
259 } xor_sum __attribute__ ((aligned (sizeof (u32x4))));
263 #ifdef CLIB_HAVE_VEC128
264 u32x4u *data = (u32x4u *) h;
265 xor_sum.as_u32x4 = data[0 + t->skip_n_vectors] & mask[0];
266 switch (t->match_n_vectors)
269 xor_sum.as_u32x4 ^= data[4 + t->skip_n_vectors] & mask[4];
272 xor_sum.as_u32x4 ^= data[3 + t->skip_n_vectors] & mask[3];
275 xor_sum.as_u32x4 ^= data[2 + t->skip_n_vectors] & mask[2];
278 xor_sum.as_u32x4 ^= data[1 + t->skip_n_vectors] & mask[1];
286 u32 skip_u64 = t->skip_n_vectors * 2;
287 u64 *data64 = (u64 *) h;
288 xor_sum.as_u64[0] = data64[0 + skip_u64] & ((u64 *) mask)[0];
289 xor_sum.as_u64[1] = data64[1 + skip_u64] & ((u64 *) mask)[1];
290 switch (t->match_n_vectors)
293 xor_sum.as_u64[0] ^= data64[8 + skip_u64] & ((u64 *) mask)[8];
294 xor_sum.as_u64[1] ^= data64[9 + skip_u64] & ((u64 *) mask)[9];
297 xor_sum.as_u64[0] ^= data64[6 + skip_u64] & ((u64 *) mask)[6];
298 xor_sum.as_u64[1] ^= data64[7 + skip_u64] & ((u64 *) mask)[7];
301 xor_sum.as_u64[0] ^= data64[4 + skip_u64] & ((u64 *) mask)[4];
302 xor_sum.as_u64[1] ^= data64[5 + skip_u64] & ((u64 *) mask)[5];
305 xor_sum.as_u64[0] ^= data64[2 + skip_u64] & ((u64 *) mask)[2];
306 xor_sum.as_u64[1] ^= data64[3 + skip_u64] & ((u64 *) mask)[3];
314 #endif /* CLIB_HAVE_VEC128 */
316 #ifdef clib_crc32c_uses_intrinsics
317 return clib_crc32c ((u8 *) & xor_sum, sizeof (xor_sum));
319 return clib_xxhash (xor_sum.as_u64[0] ^ xor_sum.as_u64[1]);
324 vnet_classify_prefetch_bucket (vnet_classify_table_t * t, u64 hash)
328 ASSERT (is_pow2 (t->nbuckets));
330 bucket_index = hash & (t->nbuckets - 1);
332 clib_prefetch_load (&t->buckets[bucket_index]);
335 static inline vnet_classify_entry_t *
336 vnet_classify_get_entry (vnet_classify_table_t * t, uword offset)
338 u8 *hp = clib_mem_get_heap_base (t->mheap);
339 u8 *vp = hp + offset;
341 return (vnet_classify_entry_t *) vp;
345 vnet_classify_get_offset (vnet_classify_table_t * t,
346 vnet_classify_entry_t * v)
350 hp = (u8 *) clib_mem_get_heap_base (t->mheap);
353 ASSERT ((vp - hp) < 0x100000000ULL);
357 static inline vnet_classify_entry_t *
358 vnet_classify_entry_at_index (vnet_classify_table_t * t,
359 vnet_classify_entry_t * e, u32 index)
365 eu8 += index * (sizeof (vnet_classify_entry_t) +
366 (t->match_n_vectors * sizeof (u32x4)));
368 return (vnet_classify_entry_t *) eu8;
372 vnet_classify_prefetch_entry (vnet_classify_table_t * t, u64 hash)
376 vnet_classify_bucket_t *b;
377 vnet_classify_entry_t *e;
379 bucket_index = hash & (t->nbuckets - 1);
381 b = &t->buckets[bucket_index];
386 hash >>= t->log2_nbuckets;
388 e = vnet_classify_get_entry (t, b->offset);
389 value_index = hash & ((1 << b->log2_pages) - 1);
391 e = vnet_classify_entry_at_index (t, e, value_index);
393 clib_prefetch_load (e);
396 vnet_classify_entry_t *vnet_classify_find_entry (vnet_classify_table_t * t,
397 u8 * h, u64 hash, f64 now);
399 static_always_inline int
400 vnet_classify_entry_is_equal (vnet_classify_entry_t *v, const u8 *d, u8 *m,
403 #ifdef CLIB_HAVE_VEC128
404 u64x2u *data = (u64x2 *) d;
405 u64x2 *key = (u64x2 *) v->key;
406 u64x2 *mask = (u64x2 *) m;
409 r = (data[0] & mask[0]) ^ key[0];
410 switch (match_n_vectors)
413 r |= (data[4] & mask[4]) ^ key[4];
416 r |= (data[3] & mask[3]) ^ key[3];
419 r |= (data[2] & mask[2]) ^ key[2];
422 r |= (data[1] & mask[1]) ^ key[1];
430 if (u64x2_is_all_zero (r))
434 u64 *data = (u64 *) d;
435 u64 *key = (u64 *) v->key;
436 u64 *mask = (u64 *) m;
439 r = ((data[0] & mask[0]) ^ key[0]) | ((data[1] & mask[1]) ^ key[1]);
440 switch (match_n_vectors)
443 r |= ((data[8] & mask[8]) ^ key[8]) | ((data[9] & mask[9]) ^ key[9]);
446 r |= ((data[6] & mask[6]) ^ key[6]) | ((data[7] & mask[7]) ^ key[7]);
449 r |= ((data[4] & mask[4]) ^ key[4]) | ((data[5] & mask[5]) ^ key[5]);
452 r |= ((data[2] & mask[2]) ^ key[2]) | ((data[3] & mask[3]) ^ key[3]);
463 #endif /* CLIB_HAVE_VEC128 */
467 static inline vnet_classify_entry_t *
468 vnet_classify_find_entry_inline (vnet_classify_table_t *t, const u8 *h,
471 vnet_classify_entry_t *v;
472 vnet_classify_bucket_t *b;
473 u32 bucket_index, limit, pages, match_n_vectors = t->match_n_vectors;
474 u8 *mask = (u8 *) t->mask;
477 bucket_index = hash & (t->nbuckets - 1);
478 b = &t->buckets[bucket_index];
483 pages = 1 << b->log2_pages;
484 v = vnet_classify_get_entry (t, b->offset);
485 limit = t->entries_per_page;
486 if (PREDICT_FALSE (b->linear_search))
489 v = vnet_classify_entry_at_index (t, v, 0);
493 hash >>= t->log2_nbuckets;
494 v = vnet_classify_entry_at_index (t, v, hash & (pages - 1));
497 h += t->skip_n_vectors * 16;
499 for (i = 0; i < limit; i++)
501 if (vnet_classify_entry_is_equal (v, h, mask, match_n_vectors))
503 if (PREDICT_TRUE (now))
510 v = vnet_classify_entry_at_index (t, v, 1);
515 vnet_classify_table_t *vnet_classify_new_table (vnet_classify_main_t *cm,
516 const u8 *mask, u32 nbuckets,
519 u32 match_n_vectors);
521 int vnet_classify_add_del_session (vnet_classify_main_t *cm, u32 table_index,
522 const u8 *match, u32 hit_next_index,
523 u32 opaque_index, i32 advance, u8 action,
524 u16 metadata, int is_add);
526 int vnet_classify_add_del_table (vnet_classify_main_t *cm, const u8 *mask,
527 u32 nbuckets, u32 memory_size, u32 skip,
528 u32 match, u32 next_table_index,
529 u32 miss_next_index, u32 *table_index,
530 u8 current_data_flag, i16 current_data_offset,
531 int is_add, int del_chain);
532 void vnet_classify_delete_table_index (vnet_classify_main_t *cm,
533 u32 table_index, int del_chain);
535 unformat_function_t unformat_ip4_mask;
536 unformat_function_t unformat_ip6_mask;
537 unformat_function_t unformat_l3_mask;
538 unformat_function_t unformat_l2_mask;
539 unformat_function_t unformat_classify_mask;
540 unformat_function_t unformat_l2_next_index;
541 unformat_function_t unformat_ip_next_index;
542 unformat_function_t unformat_ip4_match;
543 unformat_function_t unformat_ip6_match;
544 unformat_function_t unformat_l3_match;
545 unformat_function_t unformat_l4_match;
546 unformat_function_t unformat_vlan_tag;
547 unformat_function_t unformat_l2_match;
548 unformat_function_t unformat_classify_match;
550 void vnet_classify_register_unformat_ip_next_index_fn
551 (unformat_function_t * fn);
553 void vnet_classify_register_unformat_l2_next_index_fn
554 (unformat_function_t * fn);
556 void vnet_classify_register_unformat_acl_next_index_fn
557 (unformat_function_t * fn);
559 void vnet_classify_register_unformat_policer_next_index_fn
560 (unformat_function_t * fn);
562 void vnet_classify_register_unformat_opaque_index_fn (unformat_function_t *
565 u32 classify_get_pcap_chain (vnet_classify_main_t * cm, u32 sw_if_index);
566 void classify_set_pcap_chain (vnet_classify_main_t * cm,
567 u32 sw_if_index, u32 table_index);
569 u32 classify_get_trace_chain (void);
570 void classify_set_trace_chain (vnet_classify_main_t * cm, u32 table_index);
572 u32 classify_sort_table_chain (vnet_classify_main_t * cm, u32 table_index);
573 u32 classify_lookup_chain (u32 table_index,
574 u8 * mask, u32 n_skip, u32 n_match);
576 #endif /* __included_vnet_classify_h__ */
579 * fd.io coding-style-patch-verification: ON
582 * eval: (c-set-style "gnu")