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/xxhash.h>
26 extern vlib_node_registration_t ip4_classify_node;
27 extern vlib_node_registration_t ip6_classify_node;
29 #define CLASSIFY_TRACE 0
32 * Classify table option to process packets
33 * CLASSIFY_FLAG_USE_CURR_DATA:
34 * - classify packets starting from VPP node’s current data pointer
36 #define CLASSIFY_FLAG_USE_CURR_DATA 1
39 * Classify session action
40 * CLASSIFY_ACTION_SET_IP4_FIB_INDEX:
41 * - Classified IP packets will be looked up
42 * from the specified ipv4 fib table
43 * CLASSIFY_ACTION_SET_IP6_FIB_INDEX:
44 * - Classified IP packets will be looked up
45 * from the specified ipv6 fib table
47 typedef enum vnet_classify_action_t_
49 CLASSIFY_ACTION_SET_IP4_FIB_INDEX = 1,
50 CLASSIFY_ACTION_SET_IP6_FIB_INDEX = 2,
51 CLASSIFY_ACTION_SET_METADATA = 3,
52 } __attribute__ ((packed)) vnet_classify_action_t;
54 struct _vnet_classify_main;
55 typedef struct _vnet_classify_main vnet_classify_main_t;
57 #define foreach_size_in_u32x4 \
65 typedef CLIB_PACKED(struct _vnet_classify_entry {
66 /* Graph node next index */
69 /* put into vnet_buffer(b)->l2_classfy.opaque_index */
73 /* advance on hit, note it's a signed quantity... */
79 /* Really only need 1 bit */
81 #define VNET_CLASSIFY_ENTRY_FREE (1<<0)
83 vnet_classify_action_t action;
86 /* Hit counter, last heard time */
89 struct _vnet_classify_entry * next_free;
94 /* Must be aligned to a 16-octet boundary */
96 }) vnet_classify_entry_t;
100 vnet_classify_entry_is_free (vnet_classify_entry_t * e)
102 return e->flags & VNET_CLASSIFY_ENTRY_FREE;
106 vnet_classify_entry_is_busy (vnet_classify_entry_t * e)
108 return ((e->flags & VNET_CLASSIFY_ENTRY_FREE) == 0);
111 /* Need these to con the vector allocator */
114 typedef CLIB_PACKED(struct { \
118 }) vnet_classify_entry_##size##_t;
119 foreach_size_in_u32x4;
136 } vnet_classify_bucket_t;
140 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
141 /* Mask to apply after skipping N vectors */
143 /* Buckets and entries */
144 vnet_classify_bucket_t *buckets;
145 vnet_classify_entry_t *entries;
147 /* Config parameters */
153 int entries_per_page;
155 u32 current_data_flag;
156 int current_data_offset;
158 /* Index of next table to try */
159 u32 next_table_index;
161 /* Miss next index, return if next_table_index = 0 */
164 /* Per-bucket working copies, one per thread */
165 vnet_classify_entry_t **working_copies;
166 int *working_copy_lengths;
167 vnet_classify_bucket_t saved_bucket;
169 /* Free entry freelists */
170 vnet_classify_entry_t **freelists;
174 /* Private allocation arena, protected by the writer lock */
177 /* Writer (only) lock for this table */
178 clib_spinlock_t writer_lock;
180 } vnet_classify_table_t;
186 } vnet_classify_filter_set_t;
188 struct _vnet_classify_main
191 vnet_classify_table_t *tables;
193 /* Registered next-index, opaque unformat fcns */
194 unformat_function_t **unformat_l2_next_index_fns;
195 unformat_function_t **unformat_ip_next_index_fns;
196 unformat_function_t **unformat_acl_next_index_fns;
197 unformat_function_t **unformat_policer_next_index_fns;
198 unformat_function_t **unformat_opaque_index_fns;
200 /* Pool of filter sets */
201 vnet_classify_filter_set_t *filter_sets;
203 /* Per-interface filter set map. [0] is used for pcap */
204 u32 *filter_set_by_sw_if_index;
206 /* convenience variables */
207 vlib_main_t *vlib_main;
208 vnet_main_t *vnet_main;
211 extern vnet_classify_main_t vnet_classify_main;
213 u8 *format_classify_table (u8 * s, va_list * args);
215 u64 vnet_classify_hash_packet (vnet_classify_table_t * t, u8 * h);
218 vnet_classify_hash_packet_inline (vnet_classify_table_t * t, u8 * h)
226 } xor_sum __attribute__ ((aligned (sizeof (u32x4))));
230 #ifdef CLIB_HAVE_VEC128
231 u32x4u *data = (u32x4u *) h;
232 xor_sum.as_u32x4 = data[0 + t->skip_n_vectors] & mask[0];
233 switch (t->match_n_vectors)
236 xor_sum.as_u32x4 ^= data[4 + t->skip_n_vectors] & mask[4];
239 xor_sum.as_u32x4 ^= data[3 + t->skip_n_vectors] & mask[3];
242 xor_sum.as_u32x4 ^= data[2 + t->skip_n_vectors] & mask[2];
245 xor_sum.as_u32x4 ^= data[1 + t->skip_n_vectors] & mask[1];
253 u32 skip_u64 = t->skip_n_vectors * 2;
254 u64 *data64 = (u64 *) h;
255 xor_sum.as_u64[0] = data64[0 + skip_u64] & ((u64 *) mask)[0];
256 xor_sum.as_u64[1] = data64[1 + skip_u64] & ((u64 *) mask)[1];
257 switch (t->match_n_vectors)
260 xor_sum.as_u64[0] ^= data64[8 + skip_u64] & ((u64 *) mask)[8];
261 xor_sum.as_u64[1] ^= data64[9 + skip_u64] & ((u64 *) mask)[9];
264 xor_sum.as_u64[0] ^= data64[6 + skip_u64] & ((u64 *) mask)[6];
265 xor_sum.as_u64[1] ^= data64[7 + skip_u64] & ((u64 *) mask)[7];
268 xor_sum.as_u64[0] ^= data64[4 + skip_u64] & ((u64 *) mask)[4];
269 xor_sum.as_u64[1] ^= data64[5 + skip_u64] & ((u64 *) mask)[5];
272 xor_sum.as_u64[0] ^= data64[2 + skip_u64] & ((u64 *) mask)[2];
273 xor_sum.as_u64[1] ^= data64[3 + skip_u64] & ((u64 *) mask)[3];
281 #endif /* CLIB_HAVE_VEC128 */
283 return clib_xxhash (xor_sum.as_u64[0] ^ xor_sum.as_u64[1]);
287 vnet_classify_prefetch_bucket (vnet_classify_table_t * t, u64 hash)
291 ASSERT (is_pow2 (t->nbuckets));
293 bucket_index = hash & (t->nbuckets - 1);
295 CLIB_PREFETCH (&t->buckets[bucket_index], CLIB_CACHE_LINE_BYTES, LOAD);
298 static inline vnet_classify_entry_t *
299 vnet_classify_get_entry (vnet_classify_table_t * t, uword offset)
302 u8 *vp = hp + offset;
308 vnet_classify_get_offset (vnet_classify_table_t * t,
309 vnet_classify_entry_t * v)
313 hp = (u8 *) t->mheap;
316 ASSERT ((vp - hp) < 0x100000000ULL);
320 static inline vnet_classify_entry_t *
321 vnet_classify_entry_at_index (vnet_classify_table_t * t,
322 vnet_classify_entry_t * e, u32 index)
328 eu8 += index * (sizeof (vnet_classify_entry_t) +
329 (t->match_n_vectors * sizeof (u32x4)));
331 return (vnet_classify_entry_t *) eu8;
335 vnet_classify_prefetch_entry (vnet_classify_table_t * t, u64 hash)
339 vnet_classify_bucket_t *b;
340 vnet_classify_entry_t *e;
342 bucket_index = hash & (t->nbuckets - 1);
344 b = &t->buckets[bucket_index];
349 hash >>= t->log2_nbuckets;
351 e = vnet_classify_get_entry (t, b->offset);
352 value_index = hash & ((1 << b->log2_pages) - 1);
354 e = vnet_classify_entry_at_index (t, e, value_index);
356 CLIB_PREFETCH (e, CLIB_CACHE_LINE_BYTES, LOAD);
359 vnet_classify_entry_t *vnet_classify_find_entry (vnet_classify_table_t * t,
360 u8 * h, u64 hash, f64 now);
362 static inline vnet_classify_entry_t *
363 vnet_classify_find_entry_inline (vnet_classify_table_t * t,
364 u8 * h, u64 hash, f64 now)
366 vnet_classify_entry_t *v;
372 } result __attribute__ ((aligned (sizeof (u32x4))));
373 vnet_classify_bucket_t *b;
379 bucket_index = hash & (t->nbuckets - 1);
380 b = &t->buckets[bucket_index];
386 hash >>= t->log2_nbuckets;
388 v = vnet_classify_get_entry (t, b->offset);
389 value_index = hash & ((1 << b->log2_pages) - 1);
390 limit = t->entries_per_page;
391 if (PREDICT_FALSE (b->linear_search))
394 limit *= (1 << b->log2_pages);
397 v = vnet_classify_entry_at_index (t, v, value_index);
399 #ifdef CLIB_HAVE_VEC128
400 u32x4u *data = (u32x4u *) h;
401 for (i = 0; i < limit; i++)
404 result.as_u32x4 = (data[0 + t->skip_n_vectors] & mask[0]) ^ key[0];
405 switch (t->match_n_vectors)
408 result.as_u32x4 |= (data[4 + t->skip_n_vectors] & mask[4]) ^ key[4];
411 result.as_u32x4 |= (data[3 + t->skip_n_vectors] & mask[3]) ^ key[3];
414 result.as_u32x4 |= (data[2 + t->skip_n_vectors] & mask[2]) ^ key[2];
417 result.as_u32x4 |= (data[1 + t->skip_n_vectors] & mask[1]) ^ key[1];
425 if (u32x4_zero_byte_mask (result.as_u32x4) == 0xffff)
427 if (PREDICT_TRUE (now))
434 v = vnet_classify_entry_at_index (t, v, 1);
437 u32 skip_u64 = t->skip_n_vectors * 2;
438 u64 *data64 = (u64 *) h;
439 for (i = 0; i < limit; i++)
444 (data64[0 + skip_u64] & ((u64 *) mask)[0]) ^ ((u64 *) key)[0];
446 (data64[1 + skip_u64] & ((u64 *) mask)[1]) ^ ((u64 *) key)[1];
447 switch (t->match_n_vectors)
451 (data64[8 + skip_u64] & ((u64 *) mask)[8]) ^ ((u64 *) key)[8];
453 (data64[9 + skip_u64] & ((u64 *) mask)[9]) ^ ((u64 *) key)[9];
457 (data64[6 + skip_u64] & ((u64 *) mask)[6]) ^ ((u64 *) key)[6];
459 (data64[7 + skip_u64] & ((u64 *) mask)[7]) ^ ((u64 *) key)[7];
463 (data64[4 + skip_u64] & ((u64 *) mask)[4]) ^ ((u64 *) key)[4];
465 (data64[5 + skip_u64] & ((u64 *) mask)[5]) ^ ((u64 *) key)[5];
469 (data64[2 + skip_u64] & ((u64 *) mask)[2]) ^ ((u64 *) key)[2];
471 (data64[3 + skip_u64] & ((u64 *) mask)[3]) ^ ((u64 *) key)[3];
479 if (result.as_u64[0] == 0 && result.as_u64[1] == 0)
481 if (PREDICT_TRUE (now))
489 v = vnet_classify_entry_at_index (t, v, 1);
491 #endif /* CLIB_HAVE_VEC128 */
495 vnet_classify_table_t *vnet_classify_new_table (vnet_classify_main_t * cm,
496 u8 * mask, u32 nbuckets,
499 u32 match_n_vectors);
501 int vnet_classify_add_del_session (vnet_classify_main_t * cm,
507 u8 action, u32 metadata, int is_add);
509 int vnet_classify_add_del_table (vnet_classify_main_t * cm,
515 u32 next_table_index,
518 u8 current_data_flag,
519 i16 current_data_offset,
520 int is_add, int del_chain);
522 unformat_function_t unformat_ip4_mask;
523 unformat_function_t unformat_ip6_mask;
524 unformat_function_t unformat_l3_mask;
525 unformat_function_t unformat_l2_mask;
526 unformat_function_t unformat_classify_mask;
527 unformat_function_t unformat_l2_next_index;
528 unformat_function_t unformat_ip_next_index;
529 unformat_function_t unformat_ip4_match;
530 unformat_function_t unformat_ip6_match;
531 unformat_function_t unformat_l3_match;
532 unformat_function_t unformat_l4_match;
533 unformat_function_t unformat_vlan_tag;
534 unformat_function_t unformat_l2_match;
535 unformat_function_t unformat_classify_match;
537 void vnet_classify_register_unformat_ip_next_index_fn
538 (unformat_function_t * fn);
540 void vnet_classify_register_unformat_l2_next_index_fn
541 (unformat_function_t * fn);
543 void vnet_classify_register_unformat_acl_next_index_fn
544 (unformat_function_t * fn);
546 void vnet_classify_register_unformat_policer_next_index_fn
547 (unformat_function_t * fn);
549 void vnet_classify_register_unformat_opaque_index_fn (unformat_function_t *
552 #endif /* __included_vnet_classify_h__ */
555 * fd.io coding-style-patch-verification: ON
558 * eval: (c-set-style "gnu")