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__
20 #include <vlib/vlib.h>
21 #include <vnet/vnet.h>
22 #include <vnet/pg/pg.h>
23 #include <vnet/ethernet/ethernet.h>
24 #include <vnet/ethernet/packet.h>
25 #include <vnet/ip/ip_packet.h>
26 #include <vnet/ip/ip4_packet.h>
27 #include <vnet/ip/ip6_packet.h>
29 #include <vnet/l2/l2_input.h>
30 #include <vnet/l2/feat_bitmap.h>
31 #include <vnet/api_errno.h> /* for API error numbers */
33 #include <vppinfra/error.h>
34 #include <vppinfra/hash.h>
35 #include <vppinfra/cache.h>
36 #include <vppinfra/xxhash.h>
38 extern vlib_node_registration_t ip4_classify_node;
39 extern vlib_node_registration_t ip6_classify_node;
41 #define CLASSIFY_TRACE 0
43 #if !defined( __aarch64__) && !defined(__arm__)
44 #define CLASSIFY_USE_SSE //Allow usage of SSE operations
47 #define U32X4_ALIGNED(p) PREDICT_TRUE((((intptr_t)p) & 0xf) == 0)
49 struct _vnet_classify_main;
50 typedef struct _vnet_classify_main vnet_classify_main_t;
52 #define foreach_size_in_u32x4 \
59 typedef CLIB_PACKED(struct _vnet_classify_entry {
60 /* Graph node next index */
63 /* put into vnet_buffer(b)->l2_classfy.opaque_index */
67 /* advance on hit, note it's a signed quantity... */
73 /* Really only need 1 bit */
75 #define VNET_CLASSIFY_ENTRY_FREE (1<<0)
77 /* Hit counter, last heard time */
80 struct _vnet_classify_entry * next_free;
85 /* Must be aligned to a 16-octet boundary */
87 }) vnet_classify_entry_t;
89 static inline int vnet_classify_entry_is_free (vnet_classify_entry_t * e)
91 return e->flags & VNET_CLASSIFY_ENTRY_FREE;
94 static inline int vnet_classify_entry_is_busy (vnet_classify_entry_t * e)
96 return ((e->flags & VNET_CLASSIFY_ENTRY_FREE) == 0);
99 /* Need these to con the vector allocator */
101 typedef CLIB_PACKED(struct { \
105 }) vnet_classify_entry_##size##_t;
106 foreach_size_in_u32x4;
118 } vnet_classify_bucket_t;
121 /* Mask to apply after skipping N vectors */
123 /* Buckets and entries */
124 vnet_classify_bucket_t * buckets;
125 vnet_classify_entry_t * entries;
127 /* Config parameters */
132 int entries_per_page;
134 /* Index of next table to try */
135 u32 next_table_index;
137 /* Miss next index, return if next_table_index = 0 */
140 /* Per-bucket working copies, one per thread */
141 vnet_classify_entry_t ** working_copies;
142 vnet_classify_bucket_t saved_bucket;
144 /* Free entry freelists */
145 vnet_classify_entry_t **freelists;
149 /* Private allocation arena, protected by the writer lock */
152 /* Writer (only) lock for this table */
153 volatile u32 * writer_lock;
155 } vnet_classify_table_t;
157 struct _vnet_classify_main {
159 vnet_classify_table_t * tables;
161 /* Registered next-index, opaque unformat fcns */
162 unformat_function_t ** unformat_l2_next_index_fns;
163 unformat_function_t ** unformat_ip_next_index_fns;
164 unformat_function_t ** unformat_acl_next_index_fns;
165 unformat_function_t ** unformat_policer_next_index_fns;
166 unformat_function_t ** unformat_opaque_index_fns;
168 /* convenience variables */
169 vlib_main_t * vlib_main;
170 vnet_main_t * vnet_main;
173 extern vnet_classify_main_t vnet_classify_main;
175 u8 * format_classify_table (u8 * s, va_list * args);
177 u64 vnet_classify_hash_packet (vnet_classify_table_t * t, u8 * h);
180 vnet_classify_hash_packet_inline (vnet_classify_table_t * t,
188 } xor_sum __attribute__((aligned(sizeof(u32x4))));
192 #ifdef CLASSIFY_USE_SSE
193 if (U32X4_ALIGNED(h)) { //SSE can't handle unaligned data
194 u32x4 *data = (u32x4 *)h;
195 xor_sum.as_u32x4 = data[0 + t->skip_n_vectors] & mask[0];
196 switch (t->match_n_vectors)
199 xor_sum.as_u32x4 ^= data[4 + t->skip_n_vectors] & mask[4];
202 xor_sum.as_u32x4 ^= data[3 + t->skip_n_vectors] & mask[3];
205 xor_sum.as_u32x4 ^= data[2 + t->skip_n_vectors] & mask[2];
208 xor_sum.as_u32x4 ^= data[1 + t->skip_n_vectors] & mask[1];
216 #endif /* CLASSIFY_USE_SSE */
218 u32 skip_u64 = t->skip_n_vectors * 2;
219 u64 *data64 = (u64 *)h;
220 xor_sum.as_u64[0] = data64[0 + skip_u64] & ((u64 *)mask)[0];
221 xor_sum.as_u64[1] = data64[1 + skip_u64] & ((u64 *)mask)[1];
222 switch (t->match_n_vectors)
225 xor_sum.as_u64[0] ^= data64[8 + skip_u64] & ((u64 *)mask)[8];
226 xor_sum.as_u64[1] ^= data64[9 + skip_u64] & ((u64 *)mask)[9];
229 xor_sum.as_u64[0] ^= data64[6 + skip_u64] & ((u64 *)mask)[6];
230 xor_sum.as_u64[1] ^= data64[7 + skip_u64] & ((u64 *)mask)[7];
233 xor_sum.as_u64[0] ^= data64[4 + skip_u64] & ((u64 *)mask)[4];
234 xor_sum.as_u64[1] ^= data64[5 + skip_u64] & ((u64 *)mask)[5];
237 xor_sum.as_u64[0] ^= data64[2 + skip_u64] & ((u64 *)mask)[2];
238 xor_sum.as_u64[1] ^= data64[3 + skip_u64] & ((u64 *)mask)[3];
248 return clib_xxhash (xor_sum.as_u64[0] ^ xor_sum.as_u64[1]);
252 vnet_classify_prefetch_bucket (vnet_classify_table_t * t, u64 hash)
256 ASSERT (is_pow2(t->nbuckets));
258 bucket_index = hash & (t->nbuckets - 1);
260 CLIB_PREFETCH(&t->buckets[bucket_index], CLIB_CACHE_LINE_BYTES, LOAD);
263 static inline vnet_classify_entry_t *
264 vnet_classify_get_entry (vnet_classify_table_t * t, uword offset)
267 u8 * vp = hp + offset;
272 static inline uword vnet_classify_get_offset (vnet_classify_table_t * t,
273 vnet_classify_entry_t * v)
277 hp = (u8 *) t->mheap;
280 ASSERT((vp - hp) < 0x100000000ULL);
284 static inline vnet_classify_entry_t *
285 vnet_classify_entry_at_index (vnet_classify_table_t * t,
286 vnet_classify_entry_t * e,
293 eu8 += index * (sizeof (vnet_classify_entry_t) +
294 (t->match_n_vectors * sizeof (u32x4)));
296 return (vnet_classify_entry_t *) eu8;
300 vnet_classify_prefetch_entry (vnet_classify_table_t * t,
305 vnet_classify_bucket_t * b;
306 vnet_classify_entry_t * e;
308 bucket_index = hash & (t->nbuckets - 1);
310 b = &t->buckets[bucket_index];
315 hash >>= t->log2_nbuckets;
317 e = vnet_classify_get_entry (t, b->offset);
318 value_index = hash & ((1<<b->log2_pages)-1);
320 e = vnet_classify_entry_at_index (t, e, value_index);
322 CLIB_PREFETCH(e, CLIB_CACHE_LINE_BYTES, LOAD);
325 vnet_classify_entry_t *
326 vnet_classify_find_entry (vnet_classify_table_t * t,
327 u8 * h, u64 hash, f64 now);
329 static inline vnet_classify_entry_t *
330 vnet_classify_find_entry_inline (vnet_classify_table_t * t,
331 u8 * h, u64 hash, f64 now)
333 vnet_classify_entry_t * v;
338 } result __attribute__((aligned(sizeof(u32x4))));
339 vnet_classify_bucket_t * b;
344 bucket_index = hash & (t->nbuckets-1);
345 b = &t->buckets[bucket_index];
351 hash >>= t->log2_nbuckets;
353 v = vnet_classify_get_entry (t, b->offset);
354 value_index = hash & ((1<<b->log2_pages)-1);
355 v = vnet_classify_entry_at_index (t, v, value_index);
357 #ifdef CLASSIFY_USE_SSE
358 if (U32X4_ALIGNED(h)) {
359 u32x4 *data = (u32x4 *) h;
360 for (i = 0; i < t->entries_per_page; i++) {
362 result.as_u32x4 = (data[0 + t->skip_n_vectors] & mask[0]) ^ key[0];
363 switch (t->match_n_vectors)
366 result.as_u32x4 |= (data[4 + t->skip_n_vectors] & mask[4]) ^ key[4];
369 result.as_u32x4 |= (data[3 + t->skip_n_vectors] & mask[3]) ^ key[3];
372 result.as_u32x4 |= (data[2 + t->skip_n_vectors] & mask[2]) ^ key[2];
375 result.as_u32x4 |= (data[1 + t->skip_n_vectors] & mask[1]) ^ key[1];
383 if (u32x4_zero_byte_mask (result.as_u32x4) == 0xffff) {
384 if (PREDICT_TRUE(now)) {
390 v = vnet_classify_entry_at_index (t, v, 1);
393 #endif /* CLASSIFY_USE_SSE */
395 u32 skip_u64 = t->skip_n_vectors * 2;
396 u64 *data64 = (u64 *)h;
397 for (i = 0; i < t->entries_per_page; i++) {
400 result.as_u64[0] = (data64[0 + skip_u64] & ((u64 *)mask)[0]) ^ ((u64 *)key)[0];
401 result.as_u64[1] = (data64[1 + skip_u64] & ((u64 *)mask)[1]) ^ ((u64 *)key)[1];
402 switch (t->match_n_vectors)
405 result.as_u64[0] |= (data64[8 + skip_u64] & ((u64 *)mask)[8]) ^ ((u64 *)key)[8];
406 result.as_u64[1] |= (data64[9 + skip_u64] & ((u64 *)mask)[9]) ^ ((u64 *)key)[9];
409 result.as_u64[0] |= (data64[6 + skip_u64] & ((u64 *)mask)[6]) ^ ((u64 *)key)[6];
410 result.as_u64[1] |= (data64[7 + skip_u64] & ((u64 *)mask)[7]) ^ ((u64 *)key)[7];
413 result.as_u64[0] |= (data64[4 + skip_u64] & ((u64 *)mask)[4]) ^ ((u64 *)key)[4];
414 result.as_u64[1] |= (data64[5 + skip_u64] & ((u64 *)mask)[5]) ^ ((u64 *)key)[5];
417 result.as_u64[0] |= (data64[2 + skip_u64] & ((u64 *)mask)[2]) ^ ((u64 *)key)[2];
418 result.as_u64[1] |= (data64[3 + skip_u64] & ((u64 *)mask)[3]) ^ ((u64 *)key)[3];
426 if (result.as_u64[0] == 0 && result.as_u64[1] == 0) {
427 if (PREDICT_TRUE(now)) {
434 v = vnet_classify_entry_at_index (t, v, 1);
440 vnet_classify_table_t *
441 vnet_classify_new_table (vnet_classify_main_t *cm,
442 u8 * mask, u32 nbuckets, u32 memory_size,
444 u32 match_n_vectors);
446 int vnet_classify_add_del_session (vnet_classify_main_t * cm,
454 int vnet_classify_add_del_table (vnet_classify_main_t * cm,
460 u32 next_table_index,
465 unformat_function_t unformat_ip4_mask;
466 unformat_function_t unformat_ip6_mask;
467 unformat_function_t unformat_l3_mask;
468 unformat_function_t unformat_l2_mask;
469 unformat_function_t unformat_classify_mask;
470 unformat_function_t unformat_l2_next_index;
471 unformat_function_t unformat_ip_next_index;
472 unformat_function_t unformat_ip4_match;
473 unformat_function_t unformat_ip6_match;
474 unformat_function_t unformat_l3_match;
475 unformat_function_t unformat_vlan_tag;
476 unformat_function_t unformat_l2_match;
477 unformat_function_t unformat_classify_match;
479 void vnet_classify_register_unformat_ip_next_index_fn
480 (unformat_function_t * fn);
482 void vnet_classify_register_unformat_l2_next_index_fn
483 (unformat_function_t * fn);
485 void vnet_classify_register_unformat_acl_next_index_fn
486 (unformat_function_t * fn);
488 void vnet_classify_register_unformat_policer_next_index_fn
489 (unformat_function_t * fn);
491 void vnet_classify_register_unformat_opaque_index_fn (unformat_function_t * fn);
493 #endif /* __included_vnet_classify_h__ */