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 #define CLASSIFY_FLAG_USE_CURR_DATA              1
  38
  39 /*
  40  * Classify session action
  41  *  CLASSIFY_ACTION_SET_IP4_FIB_INDEX:
  42  *   - Classified IP packets will be looked up
  43  *     from the specified ipv4 fib table
  44  *  CLASSIFY_ACTION_SET_IP6_FIB_INDEX:
  45  *   - Classified IP packets will be looked up
  46  *     from the specified ipv6 fib table
  47  */
  48 typedef enum vnet_classify_action_t_
  49 {
  50   CLASSIFY_ACTION_SET_IP4_FIB_INDEX = 1,
  51   CLASSIFY_ACTION_SET_IP6_FIB_INDEX = 2,
  52   CLASSIFY_ACTION_SET_METADATA = 3,
  53 } __attribute__ ((packed)) vnet_classify_action_t;
  54
  55 struct _vnet_classify_main;
  56 typedef struct _vnet_classify_main vnet_classify_main_t;
  57
  58 #define foreach_size_in_u32x4                   \
  59 _(1)                                            \
  60 _(2)                                            \
  61 _(3)                                            \
  62 _(4)                                            \
  63 _(5)
  64
  65 /* *INDENT-OFF* */
  66 typedef CLIB_PACKED(struct _vnet_classify_entry {
  67   /* Graph node next index */
  68   u32 next_index;
  69
  70   /* put into vnet_buffer(b)->l2_classfy.opaque_index */
  71   union {
  72     struct {
  73       u32 opaque_index;
  74       /* advance on hit, note it's a signed quantity... */
  75       i32 advance;
  76     };
  77     u64 opaque_count;
  78   };
  79
  80   /* Really only need 1 bit */
  81   u8 flags;
  82 #define VNET_CLASSIFY_ENTRY_FREE        (1<<0)
  83
  84   vnet_classify_action_t action;
  85   u16 metadata;
  86
  87   /* Hit counter, last heard time */
  88   union {
  89     u64 hits;
  90     struct _vnet_classify_entry * next_free;
  91   };
  92
  93   f64 last_heard;
  94
  95   /* Must be aligned to a 16-octet boundary */
  96   u32x4 key[0];
  97 }) vnet_classify_entry_t;
  98 /* *INDENT-ON* */
  99
 100 static inline int
 101 vnet_classify_entry_is_free (vnet_classify_entry_t * e)
 102 {
 103   return e->flags & VNET_CLASSIFY_ENTRY_FREE;
 104 }
 105
 106 static inline int
 107 vnet_classify_entry_is_busy (vnet_classify_entry_t * e)
 108 {
 109   return ((e->flags & VNET_CLASSIFY_ENTRY_FREE) == 0);
 110 }
 111
 112 /* Need these to con the vector allocator */
 113 /* *INDENT-OFF* */
 114 #define _(size)                                 \
 115 typedef CLIB_PACKED(struct {                    \
 116   u32 pad0[4];                                  \
 117   u64 pad1[2];                                  \
 118   u32x4 key[size];                              \
 119 }) vnet_classify_entry_##size##_t;
 120 foreach_size_in_u32x4;
 121 /* *INDENT-ON* */
 122 #undef _
 123
 124 typedef struct
 125 {
 126   union
 127   {
 128     struct
 129     {
 130       u32 offset;
 131       u8 linear_search;
 132       u8 pad[2];
 133       u8 log2_pages;
 134     };
 135     u64 as_u64;
 136   };
 137 } vnet_classify_bucket_t;
 138
 139 typedef struct
 140 {
 141   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 142   /* Mask to apply after skipping N vectors */
 143   u32x4 *mask;
 144   /* Buckets and entries */
 145   vnet_classify_bucket_t *buckets;
 146   vnet_classify_entry_t *entries;
 147
 148   /* Config parameters */
 149   u32 match_n_vectors;
 150   u32 skip_n_vectors;
 151   u32 nbuckets;
 152   u32 log2_nbuckets;
 153   u32 linear_buckets;
 154   int entries_per_page;
 155   u32 active_elements;
 156   u32 current_data_flag;
 157   int current_data_offset;
 158   u32 data_offset;
 159   /* Index of next table to try */
 160   u32 next_table_index;
 161
 162   /* Miss next index, return if next_table_index = 0 */
 163   u32 miss_next_index;
 164
 165   /* Per-bucket working copies, one per thread */
 166   vnet_classify_entry_t **working_copies;
 167   int *working_copy_lengths;
 168   vnet_classify_bucket_t saved_bucket;
 169
 170   /* Free entry freelists */
 171   vnet_classify_entry_t **freelists;
 172
 173   u8 *name;
 174
 175   /* Private allocation arena, protected by the writer lock */
 176   void *mheap;
 177
 178   /* Writer (only) lock for this table */
 179   clib_spinlock_t writer_lock;
 180
 181 } vnet_classify_table_t;
 182
 183 typedef struct
 184 {
 185   int refcnt;
 186   u32 *table_indices;
 187 } vnet_classify_filter_set_t;
 188
 189 struct _vnet_classify_main
 190 {
 191   /* Table pool */
 192   vnet_classify_table_t *tables;
 193
 194   /* Registered next-index, opaque unformat fcns */
 195   unformat_function_t **unformat_l2_next_index_fns;
 196   unformat_function_t **unformat_ip_next_index_fns;
 197   unformat_function_t **unformat_acl_next_index_fns;
 198   unformat_function_t **unformat_policer_next_index_fns;
 199   unformat_function_t **unformat_opaque_index_fns;
 200
 201   /* Pool of filter sets */
 202   vnet_classify_filter_set_t *filter_sets;
 203
 204   /* Per-interface filter set map. [0] is used for pcap */
 205   u32 *filter_set_by_sw_if_index;
 206
 207   /* convenience variables */
 208   vlib_main_t *vlib_main;
 209   vnet_main_t *vnet_main;
 210 };
 211
 212 extern vnet_classify_main_t vnet_classify_main;
 213
 214 u8 *format_classify_table (u8 * s, va_list * args);
 215
 216 u64 vnet_classify_hash_packet (vnet_classify_table_t * t, u8 * h);
 217
 218 static inline u64
 219 vnet_classify_hash_packet_inline (vnet_classify_table_t * t, u8 * h)
 220 {
 221   u32x4 *mask;
 222
 223   union
 224   {
 225     u32x4 as_u32x4;
 226     u64 as_u64[2];
 227   } xor_sum __attribute__ ((aligned (sizeof (u32x4))));
 228
 229   ASSERT (t);
 230   mask = t->mask;
 231 #ifdef CLIB_HAVE_VEC128
 232   u32x4u *data = (u32x4u *) h;
 233   xor_sum.as_u32x4 = data[0 + t->skip_n_vectors] & mask[0];
 234   switch (t->match_n_vectors)
 235     {
 236     case 5:
 237       xor_sum.as_u32x4 ^= data[4 + t->skip_n_vectors] & mask[4];
 238       /* FALLTHROUGH */
 239     case 4:
 240       xor_sum.as_u32x4 ^= data[3 + t->skip_n_vectors] & mask[3];
 241       /* FALLTHROUGH */
 242     case 3:
 243       xor_sum.as_u32x4 ^= data[2 + t->skip_n_vectors] & mask[2];
 244       /* FALLTHROUGH */
 245     case 2:
 246       xor_sum.as_u32x4 ^= data[1 + t->skip_n_vectors] & mask[1];
 247       /* FALLTHROUGH */
 248     case 1:
 249       break;
 250     default:
 251       abort ();
 252     }
 253 #else
 254   u32 skip_u64 = t->skip_n_vectors * 2;
 255   u64 *data64 = (u64 *) h;
 256   xor_sum.as_u64[0] = data64[0 + skip_u64] & ((u64 *) mask)[0];
 257   xor_sum.as_u64[1] = data64[1 + skip_u64] & ((u64 *) mask)[1];
 258   switch (t->match_n_vectors)
 259     {
 260     case 5:
 261       xor_sum.as_u64[0] ^= data64[8 + skip_u64] & ((u64 *) mask)[8];
 262       xor_sum.as_u64[1] ^= data64[9 + skip_u64] & ((u64 *) mask)[9];
 263       /* FALLTHROUGH */
 264     case 4:
 265       xor_sum.as_u64[0] ^= data64[6 + skip_u64] & ((u64 *) mask)[6];
 266       xor_sum.as_u64[1] ^= data64[7 + skip_u64] & ((u64 *) mask)[7];
 267       /* FALLTHROUGH */
 268     case 3:
 269       xor_sum.as_u64[0] ^= data64[4 + skip_u64] & ((u64 *) mask)[4];
 270       xor_sum.as_u64[1] ^= data64[5 + skip_u64] & ((u64 *) mask)[5];
 271       /* FALLTHROUGH */
 272     case 2:
 273       xor_sum.as_u64[0] ^= data64[2 + skip_u64] & ((u64 *) mask)[2];
 274       xor_sum.as_u64[1] ^= data64[3 + skip_u64] & ((u64 *) mask)[3];
 275       /* FALLTHROUGH */
 276     case 1:
 277       break;
 278
 279     default:
 280       abort ();
 281     }
 282 #endif /* CLIB_HAVE_VEC128 */
 283
 284 #ifdef clib_crc32c_uses_intrinsics
 285   return clib_crc32c ((u8 *) & xor_sum, sizeof (xor_sum));
 286 #else
 287   return clib_xxhash (xor_sum.as_u64[0] ^ xor_sum.as_u64[1]);
 288 #endif
 289 }
 290
 291 static inline void
 292 vnet_classify_prefetch_bucket (vnet_classify_table_t * t, u64 hash)
 293 {
 294   u32 bucket_index;
 295
 296   ASSERT (is_pow2 (t->nbuckets));
 297
 298   bucket_index = hash & (t->nbuckets - 1);
 299
 300   CLIB_PREFETCH (&t->buckets[bucket_index], CLIB_CACHE_LINE_BYTES, LOAD);
 301 }
 302
 303 static inline vnet_classify_entry_t *
 304 vnet_classify_get_entry (vnet_classify_table_t * t, uword offset)
 305 {
 306   u8 *hp = t->mheap;
 307   u8 *vp = hp + offset;
 308
 309   return (void *) vp;
 310 }
 311
 312 static inline uword
 313 vnet_classify_get_offset (vnet_classify_table_t * t,
 314                           vnet_classify_entry_t * v)
 315 {
 316   u8 *hp, *vp;
 317
 318   hp = (u8 *) t->mheap;
 319   vp = (u8 *) v;
 320
 321   ASSERT ((vp - hp) < 0x100000000ULL);
 322   return vp - hp;
 323 }
 324
 325 static inline vnet_classify_entry_t *
 326 vnet_classify_entry_at_index (vnet_classify_table_t * t,
 327                               vnet_classify_entry_t * e, u32 index)
 328 {
 329   u8 *eu8;
 330
 331   eu8 = (u8 *) e;
 332
 333   eu8 += index * (sizeof (vnet_classify_entry_t) +
 334                   (t->match_n_vectors * sizeof (u32x4)));
 335
 336   return (vnet_classify_entry_t *) eu8;
 337 }
 338
 339 static inline void
 340 vnet_classify_prefetch_entry (vnet_classify_table_t * t, u64 hash)
 341 {
 342   u32 bucket_index;
 343   u32 value_index;
 344   vnet_classify_bucket_t *b;
 345   vnet_classify_entry_t *e;
 346
 347   bucket_index = hash & (t->nbuckets - 1);
 348
 349   b = &t->buckets[bucket_index];
 350
 351   if (b->offset == 0)
 352     return;
 353
 354   hash >>= t->log2_nbuckets;
 355
 356   e = vnet_classify_get_entry (t, b->offset);
 357   value_index = hash & ((1 << b->log2_pages) - 1);
 358
 359   e = vnet_classify_entry_at_index (t, e, value_index);
 360
 361   CLIB_PREFETCH (e, CLIB_CACHE_LINE_BYTES, LOAD);
 362 }
 363
 364 vnet_classify_entry_t *vnet_classify_find_entry (vnet_classify_table_t * t,
 365                                                  u8 * h, u64 hash, f64 now);
 366
 367 static inline vnet_classify_entry_t *
 368 vnet_classify_find_entry_inline (vnet_classify_table_t * t,
 369                                  u8 * h, u64 hash, f64 now)
 370 {
 371   vnet_classify_entry_t *v;
 372   u32x4 *mask, *key;
 373   union
 374   {
 375     u32x4 as_u32x4;
 376     u64 as_u64[2];
 377   } result __attribute__ ((aligned (sizeof (u32x4))));
 378   vnet_classify_bucket_t *b;
 379   u32 value_index;
 380   u32 bucket_index;
 381   u32 limit;
 382   int i;
 383
 384   bucket_index = hash & (t->nbuckets - 1);
 385   b = &t->buckets[bucket_index];
 386   mask = t->mask;
 387
 388   if (b->offset == 0)
 389     return 0;
 390
 391   hash >>= t->log2_nbuckets;
 392
 393   v = vnet_classify_get_entry (t, b->offset);
 394   value_index = hash & ((1 << b->log2_pages) - 1);
 395   limit = t->entries_per_page;
 396   if (PREDICT_FALSE (b->linear_search))
 397     {
 398       value_index = 0;
 399       limit *= (1 << b->log2_pages);
 400     }
 401
 402   v = vnet_classify_entry_at_index (t, v, value_index);
 403
 404 #ifdef CLIB_HAVE_VEC128
 405   u32x4u *data = (u32x4u *) h;
 406   for (i = 0; i < limit; i++)
 407     {
 408       key = v->key;
 409       result.as_u32x4 = (data[0 + t->skip_n_vectors] & mask[0]) ^ key[0];
 410       switch (t->match_n_vectors)
 411         {
 412         case 5:
 413           result.as_u32x4 |= (data[4 + t->skip_n_vectors] & mask[4]) ^ key[4];
 414           /* FALLTHROUGH */
 415         case 4:
 416           result.as_u32x4 |= (data[3 + t->skip_n_vectors] & mask[3]) ^ key[3];
 417           /* FALLTHROUGH */
 418         case 3:
 419           result.as_u32x4 |= (data[2 + t->skip_n_vectors] & mask[2]) ^ key[2];
 420           /* FALLTHROUGH */
 421         case 2:
 422           result.as_u32x4 |= (data[1 + t->skip_n_vectors] & mask[1]) ^ key[1];
 423           /* FALLTHROUGH */
 424         case 1:
 425           break;
 426         default:
 427           abort ();
 428         }
 429
 430       if (u32x4_zero_byte_mask (result.as_u32x4) == 0xffff)
 431         {
 432           if (PREDICT_TRUE (now))
 433             {
 434               v->hits++;
 435               v->last_heard = now;
 436             }
 437           return (v);
 438         }
 439       v = vnet_classify_entry_at_index (t, v, 1);
 440     }
 441 #else
 442   u32 skip_u64 = t->skip_n_vectors * 2;
 443   u64 *data64 = (u64 *) h;
 444   for (i = 0; i < limit; i++)
 445     {
 446       key = v->key;
 447
 448       result.as_u64[0] =
 449         (data64[0 + skip_u64] & ((u64 *) mask)[0]) ^ ((u64 *) key)[0];
 450       result.as_u64[1] =
 451         (data64[1 + skip_u64] & ((u64 *) mask)[1]) ^ ((u64 *) key)[1];
 452       switch (t->match_n_vectors)
 453         {
 454         case 5:
 455           result.as_u64[0] |=
 456             (data64[8 + skip_u64] & ((u64 *) mask)[8]) ^ ((u64 *) key)[8];
 457           result.as_u64[1] |=
 458             (data64[9 + skip_u64] & ((u64 *) mask)[9]) ^ ((u64 *) key)[9];
 459           /* FALLTHROUGH */
 460         case 4:
 461           result.as_u64[0] |=
 462             (data64[6 + skip_u64] & ((u64 *) mask)[6]) ^ ((u64 *) key)[6];
 463           result.as_u64[1] |=
 464             (data64[7 + skip_u64] & ((u64 *) mask)[7]) ^ ((u64 *) key)[7];
 465           /* FALLTHROUGH */
 466         case 3:
 467           result.as_u64[0] |=
 468             (data64[4 + skip_u64] & ((u64 *) mask)[4]) ^ ((u64 *) key)[4];
 469           result.as_u64[1] |=
 470             (data64[5 + skip_u64] & ((u64 *) mask)[5]) ^ ((u64 *) key)[5];
 471           /* FALLTHROUGH */
 472         case 2:
 473           result.as_u64[0] |=
 474             (data64[2 + skip_u64] & ((u64 *) mask)[2]) ^ ((u64 *) key)[2];
 475           result.as_u64[1] |=
 476             (data64[3 + skip_u64] & ((u64 *) mask)[3]) ^ ((u64 *) key)[3];
 477           /* FALLTHROUGH */
 478         case 1:
 479           break;
 480         default:
 481           abort ();
 482         }
 483
 484       if (result.as_u64[0] == 0 && result.as_u64[1] == 0)
 485         {
 486           if (PREDICT_TRUE (now))
 487             {
 488               v->hits++;
 489               v->last_heard = now;
 490             }
 491           return (v);
 492         }
 493
 494       v = vnet_classify_entry_at_index (t, v, 1);
 495     }
 496 #endif /* CLIB_HAVE_VEC128 */
 497   return 0;
 498 }
 499
 500 vnet_classify_table_t *vnet_classify_new_table (vnet_classify_main_t * cm,
 501                                                 u8 * mask, u32 nbuckets,
 502                                                 u32 memory_size,
 503                                                 u32 skip_n_vectors,
 504                                                 u32 match_n_vectors);
 505
 506 int vnet_classify_add_del_session (vnet_classify_main_t * cm,
 507                                    u32 table_index,
 508                                    u8 * match,
 509                                    u32 hit_next_index,
 510                                    u32 opaque_index,
 511                                    i32 advance,
 512                                    u8 action, u32 metadata, int is_add);
 513
 514 int vnet_classify_add_del_table (vnet_classify_main_t * cm,
 515                                  u8 * mask,
 516                                  u32 nbuckets,
 517                                  u32 memory_size,
 518                                  u32 skip,
 519                                  u32 match,
 520                                  u32 next_table_index,
 521                                  u32 miss_next_index,
 522                                  u32 * table_index,
 523                                  u8 current_data_flag,
 524                                  i16 current_data_offset,
 525                                  int is_add, int del_chain);
 526
 527 unformat_function_t unformat_ip4_mask;
 528 unformat_function_t unformat_ip6_mask;
 529 unformat_function_t unformat_l3_mask;
 530 unformat_function_t unformat_l2_mask;
 531 unformat_function_t unformat_classify_mask;
 532 unformat_function_t unformat_l2_next_index;
 533 unformat_function_t unformat_ip_next_index;
 534 unformat_function_t unformat_ip4_match;
 535 unformat_function_t unformat_ip6_match;
 536 unformat_function_t unformat_l3_match;
 537 unformat_function_t unformat_l4_match;
 538 unformat_function_t unformat_vlan_tag;
 539 unformat_function_t unformat_l2_match;
 540 unformat_function_t unformat_classify_match;
 541
 542 void vnet_classify_register_unformat_ip_next_index_fn
 543   (unformat_function_t * fn);
 544
 545 void vnet_classify_register_unformat_l2_next_index_fn
 546   (unformat_function_t * fn);
 547
 548 void vnet_classify_register_unformat_acl_next_index_fn
 549   (unformat_function_t * fn);
 550
 551 void vnet_classify_register_unformat_policer_next_index_fn
 552   (unformat_function_t * fn);
 553
 554 void vnet_classify_register_unformat_opaque_index_fn (unformat_function_t *
 555                                                       fn);
 556
 557 #endif /* __included_vnet_classify_h__ */
 558
 559 /*
 560  * fd.io coding-style-patch-verification: ON
 561  *
 562  * Local Variables:
 563  * eval: (c-set-style "gnu")
 564  * End:
 565  */