classify: use AVX-512 to find entry
[vpp.git] / src / vnet / classify / vnet_classify.h
1 /*
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 #ifndef __included_vnet_classify_h__
16 #define __included_vnet_classify_h__
17
18 #include <vnet/vnet.h>
19 #include <vnet/api_errno.h>     /* for API error numbers */
20
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>
26
27 extern vlib_node_registration_t ip4_classify_node;
28 extern vlib_node_registration_t ip6_classify_node;
29
30 #define CLASSIFY_TRACE 0
31
32 /*
33  * Classify table option to process packets
34  *  CLASSIFY_FLAG_USE_CURR_DATA:
35  *   - classify packets starting from VPP node’s current data pointer
36  */
37 typedef enum vnet_classify_flags_t_
38 {
39   CLASSIFY_FLAG_NONE = 0,
40   CLASSIFY_FLAG_USE_CURR_DATA = (1 << 0),
41 } __clib_packed vnet_classify_flags_t;
42
43 /*
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
51  */
52 typedef enum vnet_classify_action_t_
53 {
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;
59
60 struct _vnet_classify_main;
61 typedef struct _vnet_classify_main vnet_classify_main_t;
62
63 #define foreach_size_in_u32x4                   \
64 _(1)                                            \
65 _(2)                                            \
66 _(3)                                            \
67 _(4)                                            \
68 _(5)
69
70 typedef struct _vnet_classify_entry
71 {
72   /* put into vnet_buffer(b)->l2_classfy.opaque_index */
73   union
74   {
75     struct
76     {
77       u32 opaque_index;
78       /* advance on hit, note it's a signed quantity... */
79       i32 advance;
80     };
81     u64 opaque_count;
82   };
83   /* Hit counter */
84   union
85   {
86     u64 hits;
87     struct _vnet_classify_entry *next_free;
88   };
89   /* last heard time */
90   f64 last_heard;
91
92   /* Really only need 1 bit */
93   u8 flags;
94 #define VNET_CLASSIFY_ENTRY_FREE        (1<<0)
95
96   vnet_classify_action_t action;
97   u16 metadata;
98   /* Graph node next index */
99   u32 next_index;
100
101   /* Must be aligned to a 16-octet boundary */
102   u32x4 key[0];
103 } vnet_classify_entry_t;
104
105 /**
106  * Check there's no padding in the entry. the key lies on a 16 byte boundary.
107  */
108 STATIC_ASSERT_OFFSET_OF (vnet_classify_entry_t, key, 32);
109
110 static inline int
111 vnet_classify_entry_is_free (vnet_classify_entry_t * e)
112 {
113   return e->flags & VNET_CLASSIFY_ENTRY_FREE;
114 }
115
116 static inline int
117 vnet_classify_entry_is_busy (vnet_classify_entry_t * e)
118 {
119   return ((e->flags & VNET_CLASSIFY_ENTRY_FREE) == 0);
120 }
121
122 /* Need these to con the vector allocator */
123 #define _(size)                                                               \
124   typedef struct                                                              \
125   {                                                                           \
126     vnet_classify_entry_t e;                                                  \
127     u32x4 key[size];                                                          \
128   } __clib_packed vnet_classify_entry_##size##_t;
129 foreach_size_in_u32x4;
130 #undef _
131
132 typedef struct
133 {
134   union
135   {
136     struct
137     {
138       u32 offset;
139       u8 linear_search;
140       u8 pad[2];
141       u8 log2_pages;
142     };
143     u64 as_u64;
144   };
145 } vnet_classify_bucket_t;
146
147 typedef struct
148 {
149   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
150   /* hash Buckets */
151   vnet_classify_bucket_t *buckets;
152
153   /* Private allocation arena, protected by the writer lock,
154    * where the entries are stored. */
155   void *mheap;
156
157   /* User/client data associated with the table */
158   uword user_ctx;
159
160   u32 nbuckets;
161   u32 log2_nbuckets;
162   u32 entries_per_page;
163   u32 skip_n_vectors;
164   u32 match_n_vectors;
165   u16 load_mask;
166
167   /* Index of next table to try */
168   u32 next_table_index;
169
170   /* packet offsets */
171   i16 current_data_offset;
172   vnet_classify_flags_t current_data_flag;
173   /* Miss next index, return if next_table_index = 0 */
174   u32 miss_next_index;
175
176   /**
177    * All members accessed in the DP above here
178    */
179   CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
180
181   /* Config parameters */
182   u32 linear_buckets;
183   u32 active_elements;
184   u32 data_offset;
185
186   /* Per-bucket working copies, one per thread */
187   vnet_classify_entry_t **working_copies;
188   int *working_copy_lengths;
189   vnet_classify_bucket_t saved_bucket;
190
191   /* Free entry freelists */
192   vnet_classify_entry_t **freelists;
193
194   /* Writer (only) lock for this table */
195   clib_spinlock_t writer_lock;
196
197   CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
198   /* Mask to apply after skipping N vectors */
199   u32x4 mask[8];
200
201 } vnet_classify_table_t;
202
203 /**
204  * Ensure DP fields don't spill over to cache-line 2
205  */
206 STATIC_ASSERT_OFFSET_OF (vnet_classify_table_t, cacheline1,
207                          CLIB_CACHE_LINE_BYTES);
208
209 /**
210  * The vector size for the classifier
211  *  in the add/del table 'match' is the number of vectors of this size
212  */
213 #define VNET_CLASSIFY_VECTOR_SIZE                                             \
214   sizeof (((vnet_classify_table_t *) 0)->mask[0])
215
216 struct _vnet_classify_main
217 {
218   /* Table pool */
219   vnet_classify_table_t *tables;
220
221   /* Registered next-index, opaque unformat fcns */
222   unformat_function_t **unformat_l2_next_index_fns;
223   unformat_function_t **unformat_ip_next_index_fns;
224   unformat_function_t **unformat_acl_next_index_fns;
225   unformat_function_t **unformat_policer_next_index_fns;
226   unformat_function_t **unformat_opaque_index_fns;
227
228   /* Per-interface filter table.  [0] is used for pcap */
229   u32 *classify_table_index_by_sw_if_index;
230
231   /* convenience variables */
232   vlib_main_t *vlib_main;
233   vnet_main_t *vnet_main;
234 };
235
236 extern vnet_classify_main_t vnet_classify_main;
237
238 u8 *format_classify_table (u8 * s, va_list * args);
239 u8 *format_vnet_classify_table (u8 *s, va_list *args);
240
241 u64 vnet_classify_hash_packet (vnet_classify_table_t * t, u8 * h);
242
243 static_always_inline vnet_classify_table_t *
244 vnet_classify_table_get (u32 table_index)
245 {
246   vnet_classify_main_t *vcm = &vnet_classify_main;
247
248   return (pool_elt_at_index (vcm->tables, table_index));
249 }
250
251 static inline u64
252 vnet_classify_hash_packet_inline (vnet_classify_table_t *t, const u8 *h)
253 {
254   u64 xor_sum;
255   ASSERT (t);
256   h += t->skip_n_vectors * 16;
257
258 #if defined(CLIB_HAVE_VEC512) && defined(CLIB_HAVE_VEC512_MASK_LOAD_STORE)
259   u64x8 xor_sum_x8, *mask = (u64x8 *) t->mask;
260   u16 load_mask = t->load_mask;
261   u64x8u *data = (u64x8u *) h;
262
263   xor_sum_x8 = u64x8_mask_load_zero (data, load_mask) & mask[0];
264
265   if (PREDICT_FALSE (load_mask >> 8))
266     xor_sum_x8 ^= u64x8_mask_load_zero (data + 1, load_mask >> 8) & mask[1];
267
268   xor_sum_x8 ^= u64x8_align_right (xor_sum_x8, xor_sum_x8, 4);
269   xor_sum_x8 ^= u64x8_align_right (xor_sum_x8, xor_sum_x8, 2);
270   xor_sum = xor_sum_x8[0] ^ xor_sum_x8[1];
271 #elif defined(CLIB_HAVE_VEC256) && defined(CLIB_HAVE_VEC256_MASK_LOAD_STORE)
272   u64x4 xor_sum_x4, *mask = (u64x4 *) t->mask;
273   u16 load_mask = t->load_mask;
274   u64x4u *data = (u64x4u *) h;
275
276   xor_sum_x4 = u64x4_mask_load_zero (data, load_mask) & mask[0];
277   xor_sum_x4 ^= u64x4_mask_load_zero (data + 1, load_mask >> 4) & mask[1];
278
279   if (PREDICT_FALSE (load_mask >> 8))
280     xor_sum_x4 ^= u64x4_mask_load_zero (data + 2, load_mask >> 8) & mask[2];
281
282   xor_sum_x4 ^= u64x4_align_right (xor_sum_x4, xor_sum_x4, 2);
283   xor_sum = xor_sum_x4[0] ^ xor_sum_x4[1];
284 #elif defined(CLIB_HAVE_VEC128)
285   u64x2 *mask = (u64x2 *) t->mask;
286   u64x2u *data = (u64x2u *) h;
287   u64x2 xor_sum_x2;
288
289   xor_sum_x2 = data[0] & mask[0];
290
291   switch (t->match_n_vectors)
292     {
293     case 5:
294       xor_sum_x2 ^= data[4] & mask[4];
295       /* FALLTHROUGH */
296     case 4:
297       xor_sum_x2 ^= data[3] & mask[3];
298       /* FALLTHROUGH */
299     case 3:
300       xor_sum_x2 ^= data[2] & mask[2];
301       /* FALLTHROUGH */
302     case 2:
303       xor_sum_x2 ^= data[1] & mask[1];
304       /* FALLTHROUGH */
305     case 1:
306       break;
307     default:
308       abort ();
309     }
310   xor_sum = xor_sum_x2[0] ^ xor_sum_x2[1];
311 #else
312   u64 *data = (u64 *) h;
313   u64 *mask = (u64 *) t->mask;
314
315   xor_sum = (data[0] & mask[0]) ^ (data[1] & mask[1]);
316
317   switch (t->match_n_vectors)
318     {
319     case 5:
320       xor_sum ^= (data[8] & mask[8]) ^ (data[9] & mask[9]);
321       /* FALLTHROUGH */
322     case 4:
323       xor_sum ^= (data[6] & mask[6]) ^ (data[7] & mask[7]);
324       /* FALLTHROUGH */
325     case 3:
326       xor_sum ^= (data[4] & mask[4]) ^ (data[5] & mask[5]);
327       /* FALLTHROUGH */
328     case 2:
329       xor_sum ^= (data[2] & mask[2]) ^ (data[3] & mask[3]);
330       /* FALLTHROUGH */
331     case 1:
332       break;
333
334     default:
335       abort ();
336     }
337 #endif /* CLIB_HAVE_VEC128 */
338
339 #ifdef clib_crc32c_uses_intrinsics
340   return clib_crc32c ((u8 *) & xor_sum, sizeof (xor_sum));
341 #else
342   return clib_xxhash (xor_sum.as_u64[0] ^ xor_sum.as_u64[1]);
343 #endif
344 }
345
346 static inline void
347 vnet_classify_prefetch_bucket (vnet_classify_table_t * t, u64 hash)
348 {
349   u32 bucket_index;
350
351   ASSERT (is_pow2 (t->nbuckets));
352
353   bucket_index = hash & (t->nbuckets - 1);
354
355   clib_prefetch_load (&t->buckets[bucket_index]);
356 }
357
358 static inline vnet_classify_entry_t *
359 vnet_classify_get_entry (vnet_classify_table_t * t, uword offset)
360 {
361   u8 *hp = clib_mem_get_heap_base (t->mheap);
362   u8 *vp = hp + offset;
363
364   return (vnet_classify_entry_t *) vp;
365 }
366
367 static inline uword
368 vnet_classify_get_offset (vnet_classify_table_t * t,
369                           vnet_classify_entry_t * v)
370 {
371   u8 *hp, *vp;
372
373   hp = (u8 *) clib_mem_get_heap_base (t->mheap);
374   vp = (u8 *) v;
375
376   ASSERT ((vp - hp) < 0x100000000ULL);
377   return vp - hp;
378 }
379
380 static inline vnet_classify_entry_t *
381 vnet_classify_entry_at_index (vnet_classify_table_t * t,
382                               vnet_classify_entry_t * e, u32 index)
383 {
384   u8 *eu8;
385
386   eu8 = (u8 *) e;
387
388   eu8 += index * (sizeof (vnet_classify_entry_t) +
389                   (t->match_n_vectors * sizeof (u32x4)));
390
391   return (vnet_classify_entry_t *) eu8;
392 }
393
394 static inline void
395 vnet_classify_prefetch_entry (vnet_classify_table_t * t, u64 hash)
396 {
397   u32 bucket_index;
398   u32 value_index;
399   vnet_classify_bucket_t *b;
400   vnet_classify_entry_t *e;
401
402   bucket_index = hash & (t->nbuckets - 1);
403
404   b = &t->buckets[bucket_index];
405
406   if (b->offset == 0)
407     return;
408
409   hash >>= t->log2_nbuckets;
410
411   e = vnet_classify_get_entry (t, b->offset);
412   value_index = hash & ((1 << b->log2_pages) - 1);
413
414   e = vnet_classify_entry_at_index (t, e, value_index);
415
416   clib_prefetch_load (e);
417 }
418
419 vnet_classify_entry_t *vnet_classify_find_entry (vnet_classify_table_t * t,
420                                                  u8 * h, u64 hash, f64 now);
421
422 static_always_inline int
423 vnet_classify_entry_is_equal (vnet_classify_entry_t *v, const u8 *d, u8 *m,
424                               u32 match_n_vectors, u16 load_mask)
425 {
426 #if defined(CLIB_HAVE_VEC512) && defined(CLIB_HAVE_VEC512_MASK_LOAD_STORE)
427   u64x8 r, *mask = (u64x8 *) m;
428   u64x8u *data = (u64x8u *) d;
429   u64x4 *key = (u64x4 *) v->key;
430
431   r = (u64x8_mask_load_zero (data, load_mask) & mask[0]) ^
432       u64x8_mask_load_zero (key, load_mask);
433   load_mask >>= 8;
434
435   if (PREDICT_FALSE (load_mask))
436     r |= (u64x8_mask_load_zero (data + 1, load_mask) & mask[1]) ^
437          u64x8_mask_load_zero (key + 1, load_mask);
438
439   if (u64x8_is_all_zero (r))
440     return 1;
441
442 #elif defined(CLIB_HAVE_VEC256) && defined(CLIB_HAVE_VEC256_MASK_LOAD_STORE)
443   u64x4 r, *mask = (u64x4 *) m;
444   u64x4u *data = (u64x4u *) d;
445   u64x4 *key = (u64x4 *) v->key;
446
447   r = (u64x4_mask_load_zero (data, load_mask) & mask[0]) ^
448       u64x4_mask_load_zero (key, load_mask);
449   load_mask >>= 4;
450
451   r |= (u64x4_mask_load_zero (data + 1, load_mask) & mask[1]) ^
452        u64x4_mask_load_zero (key + 1, load_mask);
453   load_mask >>= 4;
454
455   if (PREDICT_FALSE (load_mask))
456     r |= (u64x4_mask_load_zero (data + 2, load_mask) & mask[2]) ^
457          u64x4_mask_load_zero (key + 2, load_mask);
458
459   if (u64x4_is_all_zero (r))
460     return 1;
461
462 #elif defined(CLIB_HAVE_VEC128)
463   u64x2u *data = (u64x2 *) d;
464   u64x2 *key = (u64x2 *) v->key;
465   u64x2 *mask = (u64x2 *) m;
466   u64x2 r;
467
468   r = (data[0] & mask[0]) ^ key[0];
469   switch (match_n_vectors)
470     {
471     case 5:
472       r |= (data[4] & mask[4]) ^ key[4];
473       /* fall through */
474     case 4:
475       r |= (data[3] & mask[3]) ^ key[3];
476       /* fall through */
477     case 3:
478       r |= (data[2] & mask[2]) ^ key[2];
479       /* fall through */
480     case 2:
481       r |= (data[1] & mask[1]) ^ key[1];
482       /* fall through */
483     case 1:
484       break;
485     default:
486       abort ();
487     }
488
489   if (u64x2_is_all_zero (r))
490     return 1;
491
492 #else
493   u64 *data = (u64 *) d;
494   u64 *key = (u64 *) v->key;
495   u64 *mask = (u64 *) m;
496   u64 r;
497
498   r = ((data[0] & mask[0]) ^ key[0]) | ((data[1] & mask[1]) ^ key[1]);
499   switch (match_n_vectors)
500     {
501     case 5:
502       r |= ((data[8] & mask[8]) ^ key[8]) | ((data[9] & mask[9]) ^ key[9]);
503       /* fall through */
504     case 4:
505       r |= ((data[6] & mask[6]) ^ key[6]) | ((data[7] & mask[7]) ^ key[7]);
506       /* fall through */
507     case 3:
508       r |= ((data[4] & mask[4]) ^ key[4]) | ((data[5] & mask[5]) ^ key[5]);
509       /* fall through */
510     case 2:
511       r |= ((data[2] & mask[2]) ^ key[2]) | ((data[3] & mask[3]) ^ key[3]);
512       /* fall through */
513     case 1:
514       break;
515     default:
516       abort ();
517     }
518
519   if (r == 0)
520     return 1;
521
522 #endif /* CLIB_HAVE_VEC128 */
523   return 0;
524 }
525
526 static inline vnet_classify_entry_t *
527 vnet_classify_find_entry_inline (vnet_classify_table_t *t, const u8 *h,
528                                  u64 hash, f64 now)
529 {
530   vnet_classify_entry_t *v;
531   vnet_classify_bucket_t *b;
532   u32 bucket_index, limit, pages, match_n_vectors = t->match_n_vectors;
533   u16 load_mask = t->load_mask;
534   u8 *mask = (u8 *) t->mask;
535   int i;
536
537   bucket_index = hash & (t->nbuckets - 1);
538   b = &t->buckets[bucket_index];
539
540   if (b->offset == 0)
541     return 0;
542
543   pages = 1 << b->log2_pages;
544   v = vnet_classify_get_entry (t, b->offset);
545   limit = t->entries_per_page;
546   if (PREDICT_FALSE (b->linear_search))
547     {
548       limit *= pages;
549       v = vnet_classify_entry_at_index (t, v, 0);
550     }
551   else
552     {
553       hash >>= t->log2_nbuckets;
554       v = vnet_classify_entry_at_index (t, v, hash & (pages - 1));
555     }
556
557   h += t->skip_n_vectors * 16;
558
559   for (i = 0; i < limit; i++)
560     {
561       if (vnet_classify_entry_is_equal (v, h, mask, match_n_vectors,
562                                         load_mask))
563         {
564           if (PREDICT_TRUE (now))
565             {
566               v->hits++;
567               v->last_heard = now;
568             }
569           return (v);
570         }
571       v = vnet_classify_entry_at_index (t, v, 1);
572     }
573   return 0;
574 }
575
576 vnet_classify_table_t *vnet_classify_new_table (vnet_classify_main_t *cm,
577                                                 const u8 *mask, u32 nbuckets,
578                                                 u32 memory_size,
579                                                 u32 skip_n_vectors,
580                                                 u32 match_n_vectors);
581
582 int vnet_classify_add_del_session (vnet_classify_main_t *cm, u32 table_index,
583                                    const u8 *match, u32 hit_next_index,
584                                    u32 opaque_index, i32 advance, u8 action,
585                                    u16 metadata, int is_add);
586
587 int vnet_classify_add_del_table (vnet_classify_main_t *cm, const u8 *mask,
588                                  u32 nbuckets, u32 memory_size, u32 skip,
589                                  u32 match, u32 next_table_index,
590                                  u32 miss_next_index, u32 *table_index,
591                                  u8 current_data_flag, i16 current_data_offset,
592                                  int is_add, int del_chain);
593 void vnet_classify_delete_table_index (vnet_classify_main_t *cm,
594                                        u32 table_index, int del_chain);
595
596 unformat_function_t unformat_ip4_mask;
597 unformat_function_t unformat_ip6_mask;
598 unformat_function_t unformat_l3_mask;
599 unformat_function_t unformat_l2_mask;
600 unformat_function_t unformat_classify_mask;
601 unformat_function_t unformat_l2_next_index;
602 unformat_function_t unformat_ip_next_index;
603 unformat_function_t unformat_ip4_match;
604 unformat_function_t unformat_ip6_match;
605 unformat_function_t unformat_l3_match;
606 unformat_function_t unformat_l4_match;
607 unformat_function_t unformat_vlan_tag;
608 unformat_function_t unformat_l2_match;
609 unformat_function_t unformat_classify_match;
610
611 void vnet_classify_register_unformat_ip_next_index_fn
612   (unformat_function_t * fn);
613
614 void vnet_classify_register_unformat_l2_next_index_fn
615   (unformat_function_t * fn);
616
617 void vnet_classify_register_unformat_acl_next_index_fn
618   (unformat_function_t * fn);
619
620 void vnet_classify_register_unformat_policer_next_index_fn
621   (unformat_function_t * fn);
622
623 void vnet_classify_register_unformat_opaque_index_fn (unformat_function_t *
624                                                       fn);
625
626 u32 classify_get_pcap_chain (vnet_classify_main_t * cm, u32 sw_if_index);
627 void classify_set_pcap_chain (vnet_classify_main_t * cm,
628                               u32 sw_if_index, u32 table_index);
629
630 u32 classify_get_trace_chain (void);
631 void classify_set_trace_chain (vnet_classify_main_t * cm, u32 table_index);
632
633 u32 classify_sort_table_chain (vnet_classify_main_t * cm, u32 table_index);
634 u32 classify_lookup_chain (u32 table_index,
635                            u8 * mask, u32 n_skip, u32 n_match);
636
637 #endif /* __included_vnet_classify_h__ */
638
639 /*
640  * fd.io coding-style-patch-verification: ON
641  *
642  * Local Variables:
643  * eval: (c-set-style "gnu")
644  * End:
645  */