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)
50 * Classify table option to process packets
51 * CLASSIFY_FLAG_USE_CURR_DATA:
52 * - classify packets starting from VPP node’s current data pointer
54 #define CLASSIFY_FLAG_USE_CURR_DATA 1
57 * Classify session action
58 * CLASSIFY_ACTION_SET_IP4_FIB_INDEX:
59 * - Classified IP packets will be looked up
60 * from the specified ipv4 fib table
61 * CLASSIFY_ACTION_SET_IP6_FIB_INDEX:
62 * - Classified IP packets will be looked up
63 * from the specified ipv6 fib table
65 typedef enum vnet_classify_action_t_
67 CLASSIFY_ACTION_SET_IP4_FIB_INDEX = 1,
68 CLASSIFY_ACTION_SET_IP6_FIB_INDEX = 2,
69 } __attribute__ ((packed)) vnet_classify_action_t;
71 struct _vnet_classify_main;
72 typedef struct _vnet_classify_main vnet_classify_main_t;
74 #define foreach_size_in_u32x4 \
81 typedef CLIB_PACKED(struct _vnet_classify_entry {
82 /* Graph node next index */
85 /* put into vnet_buffer(b)->l2_classfy.opaque_index */
89 /* advance on hit, note it's a signed quantity... */
95 /* Really only need 1 bit */
97 #define VNET_CLASSIFY_ENTRY_FREE (1<<0)
99 vnet_classify_action_t action;
102 /* Hit counter, last heard time */
105 struct _vnet_classify_entry * next_free;
110 /* Must be aligned to a 16-octet boundary */
112 }) vnet_classify_entry_t;
114 static inline int vnet_classify_entry_is_free (vnet_classify_entry_t * e)
116 return e->flags & VNET_CLASSIFY_ENTRY_FREE;
119 static inline int vnet_classify_entry_is_busy (vnet_classify_entry_t * e)
121 return ((e->flags & VNET_CLASSIFY_ENTRY_FREE) == 0);
124 /* Need these to con the vector allocator */
126 typedef CLIB_PACKED(struct { \
130 }) vnet_classify_entry_##size##_t;
131 foreach_size_in_u32x4;
144 } vnet_classify_bucket_t;
147 /* Mask to apply after skipping N vectors */
149 /* Buckets and entries */
150 vnet_classify_bucket_t * buckets;
151 vnet_classify_entry_t * entries;
153 /* Config parameters */
159 int entries_per_page;
161 u32 current_data_flag;
162 int current_data_offset;
164 /* Index of next table to try */
165 u32 next_table_index;
167 /* Miss next index, return if next_table_index = 0 */
170 /* Per-bucket working copies, one per thread */
171 vnet_classify_entry_t ** working_copies;
172 int *working_copy_lengths;
173 vnet_classify_bucket_t saved_bucket;
175 /* Free entry freelists */
176 vnet_classify_entry_t **freelists;
180 /* Private allocation arena, protected by the writer lock */
183 /* Writer (only) lock for this table */
184 volatile u32 * writer_lock;
186 } vnet_classify_table_t;
188 struct _vnet_classify_main {
190 vnet_classify_table_t * tables;
192 /* Registered next-index, opaque unformat fcns */
193 unformat_function_t ** unformat_l2_next_index_fns;
194 unformat_function_t ** unformat_ip_next_index_fns;
195 unformat_function_t ** unformat_acl_next_index_fns;
196 unformat_function_t ** unformat_policer_next_index_fns;
197 unformat_function_t ** unformat_opaque_index_fns;
199 /* convenience variables */
200 vlib_main_t * vlib_main;
201 vnet_main_t * vnet_main;
204 extern vnet_classify_main_t vnet_classify_main;
206 u8 * format_classify_table (u8 * s, va_list * args);
208 u64 vnet_classify_hash_packet (vnet_classify_table_t * t, u8 * h);
211 vnet_classify_hash_packet_inline (vnet_classify_table_t * t,
219 } xor_sum __attribute__((aligned(sizeof(u32x4))));
223 #ifdef CLASSIFY_USE_SSE
224 if (U32X4_ALIGNED(h)) { //SSE can't handle unaligned data
225 u32x4 *data = (u32x4 *)h;
226 xor_sum.as_u32x4 = data[0 + t->skip_n_vectors] & mask[0];
227 switch (t->match_n_vectors)
230 xor_sum.as_u32x4 ^= data[4 + t->skip_n_vectors] & mask[4];
233 xor_sum.as_u32x4 ^= data[3 + t->skip_n_vectors] & mask[3];
236 xor_sum.as_u32x4 ^= data[2 + t->skip_n_vectors] & mask[2];
239 xor_sum.as_u32x4 ^= data[1 + t->skip_n_vectors] & mask[1];
247 #endif /* CLASSIFY_USE_SSE */
249 u32 skip_u64 = t->skip_n_vectors * 2;
250 u64 *data64 = (u64 *)h;
251 xor_sum.as_u64[0] = data64[0 + skip_u64] & ((u64 *)mask)[0];
252 xor_sum.as_u64[1] = data64[1 + skip_u64] & ((u64 *)mask)[1];
253 switch (t->match_n_vectors)
256 xor_sum.as_u64[0] ^= data64[8 + skip_u64] & ((u64 *)mask)[8];
257 xor_sum.as_u64[1] ^= data64[9 + skip_u64] & ((u64 *)mask)[9];
260 xor_sum.as_u64[0] ^= data64[6 + skip_u64] & ((u64 *)mask)[6];
261 xor_sum.as_u64[1] ^= data64[7 + skip_u64] & ((u64 *)mask)[7];
264 xor_sum.as_u64[0] ^= data64[4 + skip_u64] & ((u64 *)mask)[4];
265 xor_sum.as_u64[1] ^= data64[5 + skip_u64] & ((u64 *)mask)[5];
268 xor_sum.as_u64[0] ^= data64[2 + skip_u64] & ((u64 *)mask)[2];
269 xor_sum.as_u64[1] ^= data64[3 + skip_u64] & ((u64 *)mask)[3];
279 return clib_xxhash (xor_sum.as_u64[0] ^ xor_sum.as_u64[1]);
283 vnet_classify_prefetch_bucket (vnet_classify_table_t * t, u64 hash)
287 ASSERT (is_pow2(t->nbuckets));
289 bucket_index = hash & (t->nbuckets - 1);
291 CLIB_PREFETCH(&t->buckets[bucket_index], CLIB_CACHE_LINE_BYTES, LOAD);
294 static inline vnet_classify_entry_t *
295 vnet_classify_get_entry (vnet_classify_table_t * t, uword offset)
298 u8 * vp = hp + offset;
303 static inline uword vnet_classify_get_offset (vnet_classify_table_t * t,
304 vnet_classify_entry_t * v)
308 hp = (u8 *) t->mheap;
311 ASSERT((vp - hp) < 0x100000000ULL);
315 static inline vnet_classify_entry_t *
316 vnet_classify_entry_at_index (vnet_classify_table_t * t,
317 vnet_classify_entry_t * e,
324 eu8 += index * (sizeof (vnet_classify_entry_t) +
325 (t->match_n_vectors * sizeof (u32x4)));
327 return (vnet_classify_entry_t *) eu8;
331 vnet_classify_prefetch_entry (vnet_classify_table_t * t,
336 vnet_classify_bucket_t * b;
337 vnet_classify_entry_t * e;
339 bucket_index = hash & (t->nbuckets - 1);
341 b = &t->buckets[bucket_index];
346 hash >>= t->log2_nbuckets;
348 e = vnet_classify_get_entry (t, b->offset);
349 value_index = hash & ((1<<b->log2_pages)-1);
351 e = vnet_classify_entry_at_index (t, e, value_index);
353 CLIB_PREFETCH(e, CLIB_CACHE_LINE_BYTES, LOAD);
356 vnet_classify_entry_t *
357 vnet_classify_find_entry (vnet_classify_table_t * t,
358 u8 * h, u64 hash, f64 now);
360 static inline vnet_classify_entry_t *
361 vnet_classify_find_entry_inline (vnet_classify_table_t * t,
362 u8 * h, u64 hash, f64 now)
364 vnet_classify_entry_t * v;
369 } result __attribute__((aligned(sizeof(u32x4))));
370 vnet_classify_bucket_t * b;
376 bucket_index = hash & (t->nbuckets-1);
377 b = &t->buckets[bucket_index];
383 hash >>= t->log2_nbuckets;
385 v = vnet_classify_get_entry (t, b->offset);
386 value_index = hash & ((1<<b->log2_pages)-1);
387 limit = t->entries_per_page;
388 if (PREDICT_FALSE (b->linear_search))
391 limit *= (1<<b->log2_pages);
394 v = vnet_classify_entry_at_index (t, v, value_index);
396 #ifdef CLASSIFY_USE_SSE
397 if (U32X4_ALIGNED(h)) {
398 u32x4 *data = (u32x4 *) h;
399 for (i = 0; i < limit; i++) {
401 result.as_u32x4 = (data[0 + t->skip_n_vectors] & mask[0]) ^ key[0];
402 switch (t->match_n_vectors)
405 result.as_u32x4 |= (data[4 + t->skip_n_vectors] & mask[4]) ^ key[4];
408 result.as_u32x4 |= (data[3 + t->skip_n_vectors] & mask[3]) ^ key[3];
411 result.as_u32x4 |= (data[2 + t->skip_n_vectors] & mask[2]) ^ key[2];
414 result.as_u32x4 |= (data[1 + t->skip_n_vectors] & mask[1]) ^ key[1];
422 if (u32x4_zero_byte_mask (result.as_u32x4) == 0xffff) {
423 if (PREDICT_TRUE(now)) {
429 v = vnet_classify_entry_at_index (t, v, 1);
432 #endif /* CLASSIFY_USE_SSE */
434 u32 skip_u64 = t->skip_n_vectors * 2;
435 u64 *data64 = (u64 *)h;
436 for (i = 0; i < limit; i++) {
439 result.as_u64[0] = (data64[0 + skip_u64] & ((u64 *)mask)[0]) ^ ((u64 *)key)[0];
440 result.as_u64[1] = (data64[1 + skip_u64] & ((u64 *)mask)[1]) ^ ((u64 *)key)[1];
441 switch (t->match_n_vectors)
444 result.as_u64[0] |= (data64[8 + skip_u64] & ((u64 *)mask)[8]) ^ ((u64 *)key)[8];
445 result.as_u64[1] |= (data64[9 + skip_u64] & ((u64 *)mask)[9]) ^ ((u64 *)key)[9];
448 result.as_u64[0] |= (data64[6 + skip_u64] & ((u64 *)mask)[6]) ^ ((u64 *)key)[6];
449 result.as_u64[1] |= (data64[7 + skip_u64] & ((u64 *)mask)[7]) ^ ((u64 *)key)[7];
452 result.as_u64[0] |= (data64[4 + skip_u64] & ((u64 *)mask)[4]) ^ ((u64 *)key)[4];
453 result.as_u64[1] |= (data64[5 + skip_u64] & ((u64 *)mask)[5]) ^ ((u64 *)key)[5];
456 result.as_u64[0] |= (data64[2 + skip_u64] & ((u64 *)mask)[2]) ^ ((u64 *)key)[2];
457 result.as_u64[1] |= (data64[3 + skip_u64] & ((u64 *)mask)[3]) ^ ((u64 *)key)[3];
465 if (result.as_u64[0] == 0 && result.as_u64[1] == 0) {
466 if (PREDICT_TRUE(now)) {
473 v = vnet_classify_entry_at_index (t, v, 1);
479 vnet_classify_table_t *
480 vnet_classify_new_table (vnet_classify_main_t *cm,
481 u8 * mask, u32 nbuckets, u32 memory_size,
483 u32 match_n_vectors);
485 int vnet_classify_add_del_session (vnet_classify_main_t * cm,
495 int vnet_classify_add_del_table (vnet_classify_main_t * cm,
501 u32 next_table_index,
504 u8 current_data_flag,
505 i16 current_data_offset,
509 unformat_function_t unformat_ip4_mask;
510 unformat_function_t unformat_ip6_mask;
511 unformat_function_t unformat_l3_mask;
512 unformat_function_t unformat_l2_mask;
513 unformat_function_t unformat_classify_mask;
514 unformat_function_t unformat_l2_next_index;
515 unformat_function_t unformat_ip_next_index;
516 unformat_function_t unformat_ip4_match;
517 unformat_function_t unformat_ip6_match;
518 unformat_function_t unformat_l3_match;
519 unformat_function_t unformat_l4_match;
520 unformat_function_t unformat_vlan_tag;
521 unformat_function_t unformat_l2_match;
522 unformat_function_t unformat_classify_match;
524 void vnet_classify_register_unformat_ip_next_index_fn
525 (unformat_function_t * fn);
527 void vnet_classify_register_unformat_l2_next_index_fn
528 (unformat_function_t * fn);
530 void vnet_classify_register_unformat_acl_next_index_fn
531 (unformat_function_t * fn);
533 void vnet_classify_register_unformat_policer_next_index_fn
534 (unformat_function_t * fn);
536 void vnet_classify_register_unformat_opaque_index_fn (unformat_function_t * fn);
538 #endif /* __included_vnet_classify_h__ */