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
44 #define CLASSIFY_USE_SSE //Allow usage of SSE operations
47 #define U32X4_ALIGNED(p) PREDICT_TRUE((((u64)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_opaque_index_fns;
167 /* convenience variables */
168 vlib_main_t * vlib_main;
169 vnet_main_t * vnet_main;
172 extern vnet_classify_main_t vnet_classify_main;
174 u8 * format_classify_table (u8 * s, va_list * args);
176 u64 vnet_classify_hash_packet (vnet_classify_table_t * t, u8 * h);
179 vnet_classify_hash_packet_inline (vnet_classify_table_t * t,
187 } xor_sum __attribute__((aligned(sizeof(u32x4))));
191 #ifdef CLASSIFY_USE_SSE
192 if (U32X4_ALIGNED(h)) { //SSE can't handle unaligned data
193 u32x4 *data = (u32x4 *)h;
194 xor_sum.as_u32x4 = data[0 + t->skip_n_vectors] & mask[0];
195 switch (t->match_n_vectors)
198 xor_sum.as_u32x4 ^= data[4 + t->skip_n_vectors] & mask[4];
201 xor_sum.as_u32x4 ^= data[3 + t->skip_n_vectors] & mask[3];
204 xor_sum.as_u32x4 ^= data[2 + t->skip_n_vectors] & mask[2];
207 xor_sum.as_u32x4 ^= data[1 + t->skip_n_vectors] & mask[1];
215 #endif /* CLASSIFY_USE_SSE */
217 u32 skip_u64 = t->skip_n_vectors * 2;
218 u64 *data64 = (u64 *)h;
219 xor_sum.as_u64[0] = data64[0 + skip_u64] & ((u64 *)mask)[0];
220 xor_sum.as_u64[1] = data64[1 + skip_u64] & ((u64 *)mask)[1];
221 switch (t->match_n_vectors)
224 xor_sum.as_u64[0] ^= data64[8 + skip_u64] & ((u64 *)mask)[8];
225 xor_sum.as_u64[1] ^= data64[9 + skip_u64] & ((u64 *)mask)[9];
228 xor_sum.as_u64[0] ^= data64[6 + skip_u64] & ((u64 *)mask)[6];
229 xor_sum.as_u64[1] ^= data64[7 + skip_u64] & ((u64 *)mask)[7];
232 xor_sum.as_u64[0] ^= data64[4 + skip_u64] & ((u64 *)mask)[4];
233 xor_sum.as_u64[1] ^= data64[5 + skip_u64] & ((u64 *)mask)[5];
236 xor_sum.as_u64[0] ^= data64[2 + skip_u64] & ((u64 *)mask)[2];
237 xor_sum.as_u64[1] ^= data64[3 + skip_u64] & ((u64 *)mask)[3];
247 return clib_xxhash (xor_sum.as_u64[0] ^ xor_sum.as_u64[1]);
251 vnet_classify_prefetch_bucket (vnet_classify_table_t * t, u64 hash)
255 ASSERT (is_pow2(t->nbuckets));
257 bucket_index = hash & (t->nbuckets - 1);
259 CLIB_PREFETCH(&t->buckets[bucket_index], CLIB_CACHE_LINE_BYTES, LOAD);
262 static inline vnet_classify_entry_t *
263 vnet_classify_get_entry (vnet_classify_table_t * t, uword offset)
266 u8 * vp = hp + offset;
271 static inline uword vnet_classify_get_offset (vnet_classify_table_t * t,
272 vnet_classify_entry_t * v)
276 hp = (u8 *) t->mheap;
279 ASSERT((vp - hp) < 0x100000000ULL);
283 static inline vnet_classify_entry_t *
284 vnet_classify_entry_at_index (vnet_classify_table_t * t,
285 vnet_classify_entry_t * e,
292 eu8 += index * (sizeof (vnet_classify_entry_t) +
293 (t->match_n_vectors * sizeof (u32x4)));
295 return (vnet_classify_entry_t *) eu8;
299 vnet_classify_prefetch_entry (vnet_classify_table_t * t,
304 vnet_classify_bucket_t * b;
305 vnet_classify_entry_t * e;
307 bucket_index = hash & (t->nbuckets - 1);
309 b = &t->buckets[bucket_index];
314 hash >>= t->log2_nbuckets;
316 e = vnet_classify_get_entry (t, b->offset);
317 value_index = hash & ((1<<b->log2_pages)-1);
319 e = vnet_classify_entry_at_index (t, e, value_index);
321 CLIB_PREFETCH(e, CLIB_CACHE_LINE_BYTES, LOAD);
324 vnet_classify_entry_t *
325 vnet_classify_find_entry (vnet_classify_table_t * t,
326 u8 * h, u64 hash, f64 now);
328 static inline vnet_classify_entry_t *
329 vnet_classify_find_entry_inline (vnet_classify_table_t * t,
330 u8 * h, u64 hash, f64 now)
332 vnet_classify_entry_t * v;
337 } result __attribute__((aligned(sizeof(u32x4))));
338 vnet_classify_bucket_t * b;
343 bucket_index = hash & (t->nbuckets-1);
344 b = &t->buckets[bucket_index];
350 hash >>= t->log2_nbuckets;
352 v = vnet_classify_get_entry (t, b->offset);
353 value_index = hash & ((1<<b->log2_pages)-1);
354 v = vnet_classify_entry_at_index (t, v, value_index);
356 #ifdef CLASSIFY_USE_SSE
357 if (U32X4_ALIGNED(h)) {
358 u32x4 *data = (u32x4 *) h;
359 for (i = 0; i < t->entries_per_page; i++) {
361 result.as_u32x4 = (data[0 + t->skip_n_vectors] & mask[0]) ^ key[0];
362 switch (t->match_n_vectors)
365 result.as_u32x4 |= (data[4 + t->skip_n_vectors] & mask[4]) ^ key[4];
368 result.as_u32x4 |= (data[3 + t->skip_n_vectors] & mask[3]) ^ key[3];
371 result.as_u32x4 |= (data[2 + t->skip_n_vectors] & mask[2]) ^ key[2];
374 result.as_u32x4 |= (data[1 + t->skip_n_vectors] & mask[1]) ^ key[1];
382 if (u32x4_zero_byte_mask (result.as_u32x4) == 0xffff) {
383 if (PREDICT_TRUE(now)) {
389 v = vnet_classify_entry_at_index (t, v, 1);
392 #endif /* CLASSIFY_USE_SSE */
394 u32 skip_u64 = t->skip_n_vectors * 2;
395 u64 *data64 = (u64 *)h;
396 for (i = 0; i < t->entries_per_page; i++) {
399 result.as_u64[0] = (data64[0 + skip_u64] & ((u64 *)mask)[0]) ^ ((u64 *)key)[0];
400 result.as_u64[1] = (data64[1 + skip_u64] & ((u64 *)mask)[1]) ^ ((u64 *)key)[1];
401 switch (t->match_n_vectors)
404 result.as_u64[0] |= (data64[8 + skip_u64] & ((u64 *)mask)[8]) ^ ((u64 *)key)[8];
405 result.as_u64[1] |= (data64[9 + skip_u64] & ((u64 *)mask)[9]) ^ ((u64 *)key)[9];
408 result.as_u64[0] |= (data64[6 + skip_u64] & ((u64 *)mask)[6]) ^ ((u64 *)key)[6];
409 result.as_u64[1] |= (data64[7 + skip_u64] & ((u64 *)mask)[7]) ^ ((u64 *)key)[7];
412 result.as_u64[0] |= (data64[4 + skip_u64] & ((u64 *)mask)[4]) ^ ((u64 *)key)[4];
413 result.as_u64[1] |= (data64[5 + skip_u64] & ((u64 *)mask)[5]) ^ ((u64 *)key)[5];
416 result.as_u64[0] |= (data64[2 + skip_u64] & ((u64 *)mask)[2]) ^ ((u64 *)key)[2];
417 result.as_u64[1] |= (data64[3 + skip_u64] & ((u64 *)mask)[3]) ^ ((u64 *)key)[3];
425 if (result.as_u64[0] == 0 && result.as_u64[1] == 0) {
426 if (PREDICT_TRUE(now)) {
433 v = vnet_classify_entry_at_index (t, v, 1);
439 vnet_classify_table_t *
440 vnet_classify_new_table (vnet_classify_main_t *cm,
441 u8 * mask, u32 nbuckets, u32 memory_size,
443 u32 match_n_vectors);
445 int vnet_classify_add_del_session (vnet_classify_main_t * cm,
453 int vnet_classify_add_del_table (vnet_classify_main_t * cm,
459 u32 next_table_index,
464 unformat_function_t unformat_ip4_mask;
465 unformat_function_t unformat_ip6_mask;
466 unformat_function_t unformat_l3_mask;
467 unformat_function_t unformat_l2_mask;
468 unformat_function_t unformat_classify_mask;
469 unformat_function_t unformat_l2_next_index;
470 unformat_function_t unformat_ip_next_index;
471 unformat_function_t unformat_ip4_match;
472 unformat_function_t unformat_ip6_match;
473 unformat_function_t unformat_l3_match;
474 unformat_function_t unformat_vlan_tag;
475 unformat_function_t unformat_l2_match;
476 unformat_function_t unformat_classify_match;
478 void vnet_classify_register_unformat_ip_next_index_fn
479 (unformat_function_t * fn);
481 void vnet_classify_register_unformat_l2_next_index_fn
482 (unformat_function_t * fn);
484 void vnet_classify_register_unformat_acl_next_index_fn
485 (unformat_function_t * fn);
487 void vnet_classify_register_unformat_opaque_index_fn (unformat_function_t * fn);
489 #endif /* __included_vnet_classify_h__ */