src/plugins/acl/hash_lookup.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2017 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #include <stddef.h>
  19 #include <netinet/in.h>
  20
  21 #include <vlibapi/api.h>
  22 #include <vlibmemory/api.h>
  23
  24 #include <vlib/vlib.h>
  25 #include <vnet/vnet.h>
  26 #include <vnet/pg/pg.h>
  27 #include <vppinfra/error.h>
  28 #include <vnet/plugin/plugin.h>
  29 #include <acl/acl.h>
  30 #include <vppinfra/bihash_48_8.h>
  31
  32 #include "hash_lookup.h"
  33 #include "hash_lookup_private.h"
  34
  35
  36 always_inline applied_hash_ace_entry_t **get_applied_hash_aces(acl_main_t *am, u32 lc_index)
  37 {
  38   applied_hash_ace_entry_t **applied_hash_aces = vec_elt_at_index(am->hash_entry_vec_by_lc_index, lc_index);
  39
  40 /*is_input ? vec_elt_at_index(am->input_hash_entry_vec_by_sw_if_index, sw_if_index)
  41                                                           : vec_elt_at_index(am->output_hash_entry_vec_by_sw_if_index, sw_if_index);
  42 */
  43   return applied_hash_aces;
  44 }
  45
  46
  47 static void
  48 hashtable_add_del(acl_main_t *am, clib_bihash_kv_48_8_t *kv, int is_add)
  49 {
  50     DBG("HASH ADD/DEL: %016llx %016llx %016llx %016llx %016llx %016llx %016llx add %d",
  51                         kv->key[0], kv->key[1], kv->key[2],
  52                         kv->key[3], kv->key[4], kv->key[5], kv->value, is_add);
  53     BV (clib_bihash_add_del) (&am->acl_lookup_hash, kv, is_add);
  54 }
  55
  56 /*
  57  * TupleMerge
  58  *
  59  * Initial adaptation by Valerio Bruschi (valerio.bruschi@telecom-paristech.fr)
  60  * based on the TupleMerge [1] simulator kindly made available
  61  * by  James Daly (dalyjamese@gmail.com) and  Eric Torng (torng@cse.msu.edu)
  62  * ( http://www.cse.msu.edu/~dalyjame/ or http://www.cse.msu.edu/~torng/ ),
  63  * refactoring by Andrew Yourtchenko.
  64  *
  65  * [1] James Daly, Eric Torng "TupleMerge: Building Online Packet Classifiers
  66  * by Omitting Bits", In Proc. IEEE ICCCN 2017, pp. 1-10
  67  *
  68  */
  69
  70 static int
  71 count_bits (u64 word)
  72 {
  73   int counter = 0;
  74   while (word)
  75     {
  76       counter += word & 1;
  77       word >>= 1;
  78     }
  79   return counter;
  80 }
  81
  82 /* check if mask2 can be contained by mask1 */
  83 static u8
  84 first_mask_contains_second_mask(int is_ip6, fa_5tuple_t * mask1, fa_5tuple_t * mask2)
  85 {
  86   int i;
  87   if (is_ip6)
  88     {
  89       for (i = 0; i < 2; i++)
  90         {
  91           if ((mask1->ip6_addr[0].as_u64[i] & mask2->ip6_addr[0].as_u64[i]) !=
  92               mask1->ip6_addr[0].as_u64[i])
  93             return 0;
  94           if ((mask1->ip6_addr[1].as_u64[i] & mask2->ip6_addr[1].as_u64[i]) !=
  95               mask1->ip6_addr[1].as_u64[i])
  96             return 0;
  97         }
  98     }
  99   else
 100     {
 101       /* check the pads, both masks must have it 0 */
 102       u32 padcheck = 0;
 103       int i;
 104       for (i=0; i<6; i++) {
 105         padcheck |= mask1->l3_zero_pad[i];
 106         padcheck |= mask2->l3_zero_pad[i];
 107       }
 108       if (padcheck != 0)
 109         return 0;
 110       if ((mask1->ip4_addr[0].as_u32 & mask2->ip4_addr[0].as_u32) !=
 111           mask1->ip4_addr[0].as_u32)
 112         return 0;
 113       if ((mask1->ip4_addr[1].as_u32 & mask2->ip4_addr[1].as_u32) !=
 114           mask1->ip4_addr[1].as_u32)
 115         return 0;
 116     }
 117
 118   /* take care if port are not exact-match  */
 119   if ((mask1->l4.as_u64 & mask2->l4.as_u64) != mask1->l4.as_u64)
 120     return 0;
 121
 122   if ((mask1->pkt.as_u64 & mask2->pkt.as_u64) != mask1->pkt.as_u64)
 123     return 0;
 124
 125   return 1;
 126 }
 127
 128
 129
 130 /*
 131  * TupleMerge:
 132  *
 133  * Consider the situation when we have to create a new table
 134  * T for a given rule R. This occurs for the first rule inserted and
 135  * for later rules if it is incompatible with all existing tables.
 136  * In this event, we need to determine mT for a new table.
 137  * Setting mT = mR is not a good strategy; if another similar,
 138  * but slightly less specific, rule appears we will be unable to
 139  * add it to T and will thus have to create another new table. We
 140  * thus consider two factors: is the rule more strongly aligned
 141  * with source or destination addresses (usually the two most
 142  * important fields) and how much slack needs to be given to
 143  * allow for other rules. If the source and destination addresses
 144  * are close together (within 4 bits for our experiments), we use
 145  * both of them. Otherwise, we drop the smaller (less specific)
 146  * address and its associated port field from consideration; R is
 147  * predominantly aligned with one of the two fields and should
 148  * be grouped with other similar rules. This is similar to TSS
 149  * dropping port fields, but since it is based on observable rule
 150  * characteristics it is more likely to keep important fields and
 151  * discard less useful ones.
 152  * We then look at the absolute lengths of the addresses. If
 153  * the address is long, we are more likely to try to add shorter
 154  * lengths and likewise the reverse. We thus remove a few bits
 155  * from both address fields with more bits removed from longer
 156  * addresses. For 32 bit addresses, we remove 4 bits, 3 for more
 157  * than 24, 2 for more than 16, and so on (so 8 and fewer bits
 158  * don’t have any removed). We only do this for prefix fields like
 159  * addresses; both range fields (like ports) and exact match fields
 160  * (like protocol) should remain as they are.
 161  */
 162
 163
 164 static u32
 165 shift_ip4_if(u32 mask, u32 thresh, int numshifts, u32 else_val)
 166 {
 167   if (mask > thresh)
 168      return clib_host_to_net_u32((clib_net_to_host_u32(mask) << numshifts) & 0xFFFFFFFF);
 169   else
 170      return else_val;
 171 }
 172
 173 static void
 174 relax_ip4_addr(ip4_address_t *ip4_mask, int relax2) {
 175   int shifts_per_relax[2][4] = { { 6, 5, 4, 2 }, { 3, 2, 1, 1 } };
 176
 177   int *shifts = shifts_per_relax[relax2];
 178   if(ip4_mask->as_u32 == 0xffffffff)
 179     ip4_mask->as_u32 = clib_host_to_net_u32((clib_net_to_host_u32(ip4_mask->as_u32) << shifts[0])&0xFFFFFFFF);
 180   else
 181     ip4_mask->as_u32 = shift_ip4_if(ip4_mask->as_u32, 0xffffff00, shifts[1],
 182                         shift_ip4_if(ip4_mask->as_u32, 0xffff0000, shifts[2],
 183                           shift_ip4_if(ip4_mask->as_u32, 0xff000000, shifts[3], ip4_mask->as_u32)));
 184 }
 185
 186 static void
 187 relax_ip6_addr(ip6_address_t *ip6_mask, int relax2) {
 188   /*
 189    * This "better than nothing" relax logic is based on heuristics
 190    * from IPv6 knowledge, and may not be optimal.
 191    * Some further tuning may be needed in the future.
 192    */
 193   if (ip6_mask->as_u64[0] == 0xffffffffffffffffULL) {
 194     if (ip6_mask->as_u64[1] == 0xffffffffffffffffULL) {
 195       /* relax a /128 down to /64  - likely to have more hosts */
 196       ip6_mask->as_u64[1] = 0;
 197     } else if (ip6_mask->as_u64[1] == 0) {
 198       /* relax a /64 down to /56 - likely to have more subnets */
 199       ip6_mask->as_u64[0] = clib_host_to_net_u64(0xffffffffffffff00ULL);
 200     }
 201   }
 202 }
 203
 204 static void
 205 relax_tuple(fa_5tuple_t *mask, int is_ip6, int relax2){
 206         fa_5tuple_t save_mask = *mask;
 207
 208         int counter_s = 0, counter_d = 0;
 209         if (is_ip6) {
 210           int i;
 211           for(i=0; i<2; i++){
 212                 counter_s += count_bits(mask->ip6_addr[0].as_u64[i]);
 213                 counter_d += count_bits(mask->ip6_addr[1].as_u64[i]);
 214           }
 215         } else {
 216                 counter_s += count_bits(mask->ip4_addr[0].as_u32);
 217                 counter_d += count_bits(mask->ip4_addr[1].as_u32);
 218         }
 219
 220 /*
 221  * is the rule more strongly aligned with source or destination addresses
 222  * (usually the two most important fields) and how much slack needs to be
 223  * given to allow for other rules. If the source and destination addresses
 224  * are close together (within 4 bits for our experiments), we use both of them.
 225  * Otherwise, we drop the smaller (less specific) address and its associated
 226  * port field from consideration
 227  */
 228         const int deltaThreshold = 4;
 229         /* const int deltaThreshold = 8; if IPV6? */
 230         int delta = counter_s - counter_d;
 231         if (-delta > deltaThreshold) {
 232                 if (is_ip6)
 233                   mask->ip6_addr[0].as_u64[1] = mask->ip6_addr[0].as_u64[0] = 0;
 234                 else
 235                   mask->ip4_addr[0].as_u32 = 0;
 236                 mask->l4.port[0] = 0;
 237         } else if (delta > deltaThreshold) {
 238                 if (is_ip6)
 239                   mask->ip6_addr[1].as_u64[1] = mask->ip6_addr[1].as_u64[0] = 0;
 240                 else
 241                   mask->ip4_addr[1].as_u32 = 0;
 242                 mask->l4.port[1] = 0;
 243         }
 244
 245         if (is_ip6) {
 246           relax_ip6_addr(&mask->ip6_addr[0], relax2);
 247           relax_ip6_addr(&mask->ip6_addr[1], relax2);
 248         } else {
 249           relax_ip4_addr(&mask->ip4_addr[0], relax2);
 250           relax_ip4_addr(&mask->ip4_addr[1], relax2);
 251         }
 252         mask->pkt.is_nonfirst_fragment = 0;
 253         mask->pkt.l4_valid = 0;
 254         if(!first_mask_contains_second_mask(is_ip6, mask, &save_mask)){
 255                 DBG( "TM-relaxing-ERROR");
 256                 *mask = save_mask;
 257         }
 258         DBG( "TM-relaxing-end");
 259 }
 260
 261 static u32
 262 find_mask_type_index(acl_main_t *am, fa_5tuple_t *mask)
 263 {
 264   ace_mask_type_entry_t *mte;
 265   /* *INDENT-OFF* */
 266   pool_foreach(mte, am->ace_mask_type_pool,
 267   ({
 268     if(memcmp(&mte->mask, mask, sizeof(*mask)) == 0)
 269       return (mte - am->ace_mask_type_pool);
 270   }));
 271   /* *INDENT-ON* */
 272   return ~0;
 273 }
 274
 275 static u32
 276 assign_mask_type_index(acl_main_t *am, fa_5tuple_t *mask)
 277 {
 278   u32 mask_type_index = find_mask_type_index(am, mask);
 279   ace_mask_type_entry_t *mte;
 280   if(~0 == mask_type_index) {
 281     pool_get_aligned (am->ace_mask_type_pool, mte, CLIB_CACHE_LINE_BYTES);
 282     mask_type_index = mte - am->ace_mask_type_pool;
 283     clib_memcpy(&mte->mask, mask, sizeof(mte->mask));
 284     mte->refcount = 0;
 285
 286     /*
 287      * We can use only 16 bits, since in the match there is only u16 field.
 288      * Realistically, once you go to 64K of mask types, it is a huge
 289      * problem anyway, so we might as well stop half way.
 290      */
 291     ASSERT(mask_type_index < 32768);
 292   }
 293   mte = am->ace_mask_type_pool + mask_type_index;
 294   mte->refcount++;
 295   DBG0("ASSIGN MTE index %d new refcount %d", mask_type_index, mte->refcount);
 296   return mask_type_index;
 297 }
 298
 299 static void
 300 lock_mask_type_index(acl_main_t *am, u32 mask_type_index)
 301 {
 302   DBG0("LOCK MTE index %d", mask_type_index);
 303   ace_mask_type_entry_t *mte = pool_elt_at_index(am->ace_mask_type_pool, mask_type_index);
 304   mte->refcount++;
 305   DBG0("LOCK MTE index %d new refcount %d", mask_type_index, mte->refcount);
 306 }
 307
 308
 309 static void
 310 release_mask_type_index(acl_main_t *am, u32 mask_type_index)
 311 {
 312   DBG0("RELEAS MTE index %d", mask_type_index);
 313   ace_mask_type_entry_t *mte = pool_elt_at_index(am->ace_mask_type_pool, mask_type_index);
 314   mte->refcount--;
 315   DBG0("RELEAS MTE index %d new refcount %d", mask_type_index, mte->refcount);
 316   if (mte->refcount == 0) {
 317     /* we are not using this entry anymore */
 318     memset(mte, 0xae, sizeof(*mte));
 319     pool_put(am->ace_mask_type_pool, mte);
 320   }
 321 }
 322
 323
 324 static u32
 325 tm_assign_mask_type_index(acl_main_t *am, fa_5tuple_t *mask, int is_ip6, u32 lc_index)
 326 {
 327         u32 mask_type_index = ~0;
 328         u32 for_mask_type_index = ~0;
 329         ace_mask_type_entry_t *mte = 0;
 330         int order_index;
 331         /* look for existing mask comparable with the one in input */
 332
 333         hash_applied_mask_info_t **hash_applied_mask_info_vec = vec_elt_at_index(am->hash_applied_mask_info_vec_by_lc_index, lc_index);
 334         hash_applied_mask_info_t *minfo;
 335
 336         if (vec_len(*hash_applied_mask_info_vec) > 0) {
 337             for(order_index = vec_len((*hash_applied_mask_info_vec)) -1; order_index >= 0; order_index--) {
 338                 minfo = vec_elt_at_index((*hash_applied_mask_info_vec), order_index);
 339                 for_mask_type_index = minfo->mask_type_index;
 340                 mte = vec_elt_at_index(am->ace_mask_type_pool, for_mask_type_index);
 341                 if(first_mask_contains_second_mask(is_ip6, &mte->mask, mask)){
 342                         mask_type_index = (mte - am->ace_mask_type_pool);
 343                         lock_mask_type_index(am, mask_type_index);
 344                         break;
 345                 }
 346             }
 347         }
 348
 349         if(~0 == mask_type_index) {
 350                 /* if no mask is found, then let's use a relaxed version of the original one, in order to be used by new ace_entries */
 351                 DBG( "TM-assigning mask type index-new one");
 352                 fa_5tuple_t relaxed_mask = *mask;
 353                 relax_tuple(&relaxed_mask, is_ip6, 0);
 354                 mask_type_index = assign_mask_type_index(am, &relaxed_mask);
 355
 356                 hash_applied_mask_info_t **hash_applied_mask_info_vec = vec_elt_at_index(am->hash_applied_mask_info_vec_by_lc_index, lc_index);
 357
 358                 int spot = vec_len((*hash_applied_mask_info_vec));
 359                 vec_validate((*hash_applied_mask_info_vec), spot);
 360                 minfo = vec_elt_at_index((*hash_applied_mask_info_vec), spot);
 361                 minfo->mask_type_index = mask_type_index;
 362                 minfo->num_entries = 0;
 363                 minfo->max_collisions = 0;
 364                 minfo->first_rule_index = ~0;
 365
 366                 /*
 367                  * We can use only 16 bits, since in the match there is only u16 field.
 368                  * Realistically, once you go to 64K of mask types, it is a huge
 369                  * problem anyway, so we might as well stop half way.
 370                  */
 371                 ASSERT(mask_type_index < 32768);
 372         }
 373         mte = am->ace_mask_type_pool + mask_type_index;
 374         DBG0("TM-ASSIGN MTE index %d new refcount %d", mask_type_index, mte->refcount);
 375         return mask_type_index;
 376 }
 377
 378
 379 static void
 380 fill_applied_hash_ace_kv(acl_main_t *am,
 381                             applied_hash_ace_entry_t **applied_hash_aces,
 382                             u32 lc_index,
 383                             u32 new_index, clib_bihash_kv_48_8_t *kv)
 384 {
 385   fa_5tuple_t *kv_key = (fa_5tuple_t *)kv->key;
 386   hash_acl_lookup_value_t *kv_val = (hash_acl_lookup_value_t *)&kv->value;
 387   applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), new_index);
 388   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, pae->acl_index);
 389
 390   /* apply the mask to ace key */
 391   hash_ace_info_t *ace_info = vec_elt_at_index(ha->rules, pae->hash_ace_info_index);
 392   ace_mask_type_entry_t *mte = vec_elt_at_index(am->ace_mask_type_pool, pae->mask_type_index);
 393
 394   u64 *pmatch = (u64 *) &ace_info->match;
 395   u64 *pmask = (u64 *)&mte->mask;
 396   u64 *pkey = (u64 *)kv->key;
 397
 398   *pkey++ = *pmatch++ & *pmask++;
 399   *pkey++ = *pmatch++ & *pmask++;
 400   *pkey++ = *pmatch++ & *pmask++;
 401   *pkey++ = *pmatch++ & *pmask++;
 402   *pkey++ = *pmatch++ & *pmask++;
 403   *pkey++ = *pmatch++ & *pmask++;
 404
 405   kv_key->pkt.mask_type_index_lsb = pae->mask_type_index;
 406   kv_key->pkt.lc_index = lc_index;
 407   kv_val->as_u64 = 0;
 408   kv_val->applied_entry_index = new_index;
 409 }
 410
 411 static void
 412 add_del_hashtable_entry(acl_main_t *am,
 413                             u32 lc_index,
 414                             applied_hash_ace_entry_t **applied_hash_aces,
 415                             u32 index, int is_add)
 416 {
 417   clib_bihash_kv_48_8_t kv;
 418
 419   fill_applied_hash_ace_kv(am, applied_hash_aces, lc_index, index, &kv);
 420   hashtable_add_del(am, &kv, is_add);
 421 }
 422
 423
 424 static void
 425 remake_hash_applied_mask_info_vec (acl_main_t * am,
 426                                    applied_hash_ace_entry_t **
 427                                    applied_hash_aces, u32 lc_index)
 428 {
 429   DBG0("remake applied hash mask info lc_index %d", lc_index);
 430   hash_applied_mask_info_t *new_hash_applied_mask_info_vec =
 431     vec_new (hash_applied_mask_info_t, 0);
 432
 433   hash_applied_mask_info_t *minfo;
 434   int i;
 435   for (i = 0; i < vec_len ((*applied_hash_aces)); i++)
 436     {
 437       applied_hash_ace_entry_t *pae =
 438         vec_elt_at_index ((*applied_hash_aces), i);
 439
 440       /* check if mask_type_index is already there */
 441       u32 new_pointer = vec_len (new_hash_applied_mask_info_vec);
 442       int search;
 443       for (search = 0; search < vec_len (new_hash_applied_mask_info_vec);
 444            search++)
 445         {
 446           minfo = vec_elt_at_index (new_hash_applied_mask_info_vec, search);
 447           if (minfo->mask_type_index == pae->mask_type_index)
 448             break;
 449         }
 450
 451       vec_validate ((new_hash_applied_mask_info_vec), search);
 452       minfo = vec_elt_at_index ((new_hash_applied_mask_info_vec), search);
 453       if (search == new_pointer)
 454         {
 455           DBG0("remaking index %d", search);
 456           minfo->mask_type_index = pae->mask_type_index;
 457           minfo->num_entries = 0;
 458           minfo->max_collisions = 0;
 459           minfo->first_rule_index = ~0;
 460         }
 461
 462       minfo->num_entries = minfo->num_entries + 1;
 463
 464       if (vec_len (pae->colliding_rules) > minfo->max_collisions)
 465         minfo->max_collisions = vec_len (pae->colliding_rules);
 466
 467       if (minfo->first_rule_index > i)
 468         minfo->first_rule_index = i;
 469     }
 470
 471   hash_applied_mask_info_t **hash_applied_mask_info_vec =
 472     vec_elt_at_index (am->hash_applied_mask_info_vec_by_lc_index, lc_index);
 473
 474   vec_free ((*hash_applied_mask_info_vec));
 475   (*hash_applied_mask_info_vec) = new_hash_applied_mask_info_vec;
 476 }
 477
 478 static void
 479 vec_del_collision_rule (collision_match_rule_t ** pvec,
 480                         u32 applied_entry_index)
 481 {
 482   u32 i = 0;
 483   u32 deleted = 0;
 484   while (i < _vec_len ((*pvec)))
 485     {
 486       collision_match_rule_t *cr = vec_elt_at_index ((*pvec), i);
 487       if (cr->applied_entry_index == applied_entry_index)
 488         {
 489           /* vec_del1 ((*pvec), i) would be more efficient but would reorder the elements. */
 490           vec_delete((*pvec), 1, i);
 491           deleted++;
 492           DBG0("vec_del_collision_rule deleting one at index %d", i);
 493         }
 494       else
 495         {
 496           i++;
 497         }
 498     }
 499   ASSERT(deleted > 0);
 500 }
 501
 502 static void
 503 acl_plugin_print_pae (vlib_main_t * vm, int j, applied_hash_ace_entry_t * pae);
 504
 505 static void
 506 del_colliding_rule (applied_hash_ace_entry_t ** applied_hash_aces,
 507                     u32 head_index, u32 applied_entry_index)
 508 {
 509   DBG0("DEL COLLIDING RULE: head_index %d applied index %d", head_index, applied_entry_index);
 510
 511
 512   applied_hash_ace_entry_t *head_pae =
 513     vec_elt_at_index ((*applied_hash_aces), head_index);
 514   if (ACL_HASH_LOOKUP_DEBUG > 0)
 515     acl_plugin_print_pae(acl_main.vlib_main, head_index, head_pae);
 516   vec_del_collision_rule (&head_pae->colliding_rules, applied_entry_index);
 517   if (vec_len(head_pae->colliding_rules) == 0) {
 518     vec_free(head_pae->colliding_rules);
 519   }
 520   if (ACL_HASH_LOOKUP_DEBUG > 0)
 521     acl_plugin_print_pae(acl_main.vlib_main, head_index, head_pae);
 522 }
 523
 524 static void
 525 add_colliding_rule (acl_main_t * am,
 526                     applied_hash_ace_entry_t ** applied_hash_aces,
 527                     u32 head_index, u32 applied_entry_index)
 528 {
 529   applied_hash_ace_entry_t *head_pae =
 530     vec_elt_at_index ((*applied_hash_aces), head_index);
 531   applied_hash_ace_entry_t *pae =
 532     vec_elt_at_index ((*applied_hash_aces), applied_entry_index);
 533   DBG0("ADD COLLIDING RULE: head_index %d applied index %d", head_index, applied_entry_index);
 534   if (ACL_HASH_LOOKUP_DEBUG > 0)
 535     acl_plugin_print_pae(acl_main.vlib_main, head_index, head_pae);
 536
 537   collision_match_rule_t cr;
 538
 539   cr.acl_index = pae->acl_index;
 540   cr.ace_index = pae->ace_index;
 541   cr.acl_position = pae->acl_position;
 542   cr.applied_entry_index = applied_entry_index;
 543   cr.rule = am->acls[pae->acl_index].rules[pae->ace_index];
 544   vec_add1 (head_pae->colliding_rules, cr);
 545   if (ACL_HASH_LOOKUP_DEBUG > 0)
 546     acl_plugin_print_pae(acl_main.vlib_main, head_index, head_pae);
 547 }
 548
 549 static u32
 550 activate_applied_ace_hash_entry(acl_main_t *am,
 551                             u32 lc_index,
 552                             applied_hash_ace_entry_t **applied_hash_aces,
 553                             u32 new_index)
 554 {
 555   clib_bihash_kv_48_8_t kv;
 556   ASSERT(new_index != ~0);
 557   applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), new_index);
 558   DBG("activate_applied_ace_hash_entry lc_index %d new_index %d", lc_index, new_index);
 559
 560   fill_applied_hash_ace_kv(am, applied_hash_aces, lc_index, new_index, &kv);
 561
 562   DBG("APPLY ADD KY: %016llx %016llx %016llx %016llx %016llx %016llx",
 563                         kv.key[0], kv.key[1], kv.key[2],
 564                         kv.key[3], kv.key[4], kv.key[5]);
 565
 566   clib_bihash_kv_48_8_t result;
 567   hash_acl_lookup_value_t *result_val = (hash_acl_lookup_value_t *)&result.value;
 568   int res = BV (clib_bihash_search) (&am->acl_lookup_hash, &kv, &result);
 569   ASSERT(new_index != ~0);
 570   ASSERT(new_index < vec_len((*applied_hash_aces)));
 571   if (res == 0) {
 572     /* There already exists an entry or more. Append at the end. */
 573     u32 first_index = result_val->applied_entry_index;
 574     ASSERT(first_index != ~0);
 575     DBG("A key already exists, with applied entry index: %d", first_index);
 576     applied_hash_ace_entry_t *first_pae = vec_elt_at_index((*applied_hash_aces), first_index);
 577     u32 last_index = first_pae->tail_applied_entry_index;
 578     ASSERT(last_index != ~0);
 579     applied_hash_ace_entry_t *last_pae = vec_elt_at_index((*applied_hash_aces), last_index);
 580     DBG("...advance to chained entry index: %d", last_index);
 581     /* link ourselves in */
 582     last_pae->next_applied_entry_index = new_index;
 583     pae->prev_applied_entry_index = last_index;
 584     /* adjust the pointer to the new tail */
 585     first_pae->tail_applied_entry_index = new_index;
 586     add_colliding_rule(am, applied_hash_aces, first_index, new_index);
 587     return first_index;
 588   } else {
 589     /* It's the very first entry */
 590     hashtable_add_del(am, &kv, 1);
 591     ASSERT(new_index != ~0);
 592     pae->tail_applied_entry_index = new_index;
 593     add_colliding_rule(am, applied_hash_aces, new_index, new_index);
 594     return new_index;
 595   }
 596 }
 597
 598
 599 static void *
 600 hash_acl_set_heap(acl_main_t *am)
 601 {
 602   if (0 == am->hash_lookup_mheap) {
 603     am->hash_lookup_mheap = mheap_alloc_with_lock (0 /* use VM */ ,
 604                                                    am->hash_lookup_mheap_size,
 605                                                    1 /* locked */);
 606     if (0 == am->hash_lookup_mheap) {
 607         clib_error("ACL plugin failed to allocate lookup heap of %U bytes",
 608                    format_memory_size, am->hash_lookup_mheap_size);
 609     }
 610   }
 611   void *oldheap = clib_mem_set_heap(am->hash_lookup_mheap);
 612   return oldheap;
 613 }
 614
 615 void
 616 acl_plugin_hash_acl_set_validate_heap(int on)
 617 {
 618   acl_main_t *am = &acl_main;
 619   clib_mem_set_heap(hash_acl_set_heap(am));
 620 #if USE_DLMALLOC == 0
 621   mheap_t *h = mheap_header (am->hash_lookup_mheap);
 622   if (on) {
 623     h->flags |= MHEAP_FLAG_VALIDATE;
 624     h->flags &= ~MHEAP_FLAG_SMALL_OBJECT_CACHE;
 625     mheap_validate(h);
 626   } else {
 627     h->flags &= ~MHEAP_FLAG_VALIDATE;
 628     h->flags |= MHEAP_FLAG_SMALL_OBJECT_CACHE;
 629   }
 630 #endif
 631 }
 632
 633 void
 634 acl_plugin_hash_acl_set_trace_heap(int on)
 635 {
 636   acl_main_t *am = &acl_main;
 637   clib_mem_set_heap(hash_acl_set_heap(am));
 638 #if USE_DLMALLOC == 0
 639   mheap_t *h = mheap_header (am->hash_lookup_mheap);
 640   if (on) {
 641     h->flags |= MHEAP_FLAG_TRACE;
 642   } else {
 643     h->flags &= ~MHEAP_FLAG_TRACE;
 644   }
 645 #endif
 646 }
 647
 648 static void
 649 assign_mask_type_index_to_pae(acl_main_t *am, u32 lc_index, int is_ip6, applied_hash_ace_entry_t *pae)
 650 {
 651   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, pae->acl_index);
 652   hash_ace_info_t *ace_info = vec_elt_at_index(ha->rules, pae->hash_ace_info_index);
 653
 654   ace_mask_type_entry_t *mte;
 655   fa_5tuple_t mask;
 656   /*
 657    * Start taking base_mask associated to ace, and essentially copy it.
 658    * With TupleMerge we will assign a relaxed mask here.
 659    */
 660   mte = vec_elt_at_index(am->ace_mask_type_pool, ace_info->base_mask_type_index);
 661   mask = mte->mask;
 662   if (am->use_tuple_merge)
 663     pae->mask_type_index = tm_assign_mask_type_index(am, &mask, is_ip6, lc_index);
 664   else
 665     pae->mask_type_index = assign_mask_type_index(am, &mask);
 666 }
 667
 668 static void
 669 split_partition(acl_main_t *am, u32 first_index,
 670                             u32 lc_index, int is_ip6);
 671
 672
 673 static void
 674 check_collision_count_and_maybe_split(acl_main_t *am, u32 lc_index, int is_ip6, u32 first_index)
 675 {
 676   applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, lc_index);
 677   applied_hash_ace_entry_t *first_pae = vec_elt_at_index((*applied_hash_aces), first_index);
 678   if (vec_len(first_pae->colliding_rules) > am->tuple_merge_split_threshold) {
 679     split_partition(am, first_index, lc_index, is_ip6);
 680   }
 681 }
 682
 683 void
 684 hash_acl_apply(acl_main_t *am, u32 lc_index, int acl_index, u32 acl_position)
 685 {
 686   int i;
 687
 688   DBG0("HASH ACL apply: lc_index %d acl %d", lc_index, acl_index);
 689   if (!am->acl_lookup_hash_initialized) {
 690     BV (clib_bihash_init) (&am->acl_lookup_hash, "ACL plugin rule lookup bihash",
 691                            am->hash_lookup_hash_buckets, am->hash_lookup_hash_memory);
 692     am->acl_lookup_hash_initialized = 1;
 693   }
 694
 695   void *oldheap = hash_acl_set_heap(am);
 696   vec_validate(am->hash_entry_vec_by_lc_index, lc_index);
 697   vec_validate(am->hash_acl_infos, acl_index);
 698   applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, lc_index);
 699
 700   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
 701   u32 **hash_acl_applied_lc_index = &ha->lc_index_list;
 702
 703   int base_offset = vec_len(*applied_hash_aces);
 704
 705   /* Update the bitmap of the mask types with which the lookup
 706      needs to happen for the ACLs applied to this lc_index */
 707   applied_hash_acl_info_t **applied_hash_acls = &am->applied_hash_acl_info_by_lc_index;
 708   vec_validate((*applied_hash_acls), lc_index);
 709   applied_hash_acl_info_t *pal = vec_elt_at_index((*applied_hash_acls), lc_index);
 710
 711   /* ensure the list of applied hash acls is initialized and add this acl# to it */
 712   u32 index = vec_search(pal->applied_acls, acl_index);
 713   if (index != ~0) {
 714     clib_warning("BUG: trying to apply twice acl_index %d on lc_index %d, according to lc",
 715                  acl_index, lc_index);
 716     goto done;
 717   }
 718   vec_add1(pal->applied_acls, acl_index);
 719   u32 index2 = vec_search((*hash_acl_applied_lc_index), lc_index);
 720   if (index2 != ~0) {
 721     clib_warning("BUG: trying to apply twice acl_index %d on lc_index %d, according to hash h-acl info",
 722                  acl_index, lc_index);
 723     goto done;
 724   }
 725   vec_add1((*hash_acl_applied_lc_index), lc_index);
 726
 727   /*
 728    * if the applied ACL is empty, the current code will cause a
 729    * different behavior compared to current linear search: an empty ACL will
 730    * simply fallthrough to the next ACL, or the default deny in the end.
 731    *
 732    * This is not a problem, because after vpp-dev discussion,
 733    * the consensus was it should not be possible to apply the non-existent
 734    * ACL, so the change adding this code also takes care of that.
 735    */
 736
 737   /* expand the applied aces vector by the necessary amount */
 738   vec_resize((*applied_hash_aces), vec_len(ha->rules));
 739
 740   vec_validate(am->hash_applied_mask_info_vec_by_lc_index, lc_index);
 741   /* add the rules from the ACL to the hash table for lookup and append to the vector*/
 742   for(i=0; i < vec_len(ha->rules); i++) {
 743     int is_ip6 = ha->rules[i].match.pkt.is_ip6;
 744     u32 new_index = base_offset + i;
 745     applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), new_index);
 746     pae->acl_index = acl_index;
 747     pae->ace_index = ha->rules[i].ace_index;
 748     pae->acl_position = acl_position;
 749     pae->action = ha->rules[i].action;
 750     pae->hitcount = 0;
 751     pae->hash_ace_info_index = i;
 752     /* we might link it in later */
 753     pae->next_applied_entry_index = ~0;
 754     pae->prev_applied_entry_index = ~0;
 755     pae->tail_applied_entry_index = ~0;
 756     pae->colliding_rules = NULL;
 757     pae->mask_type_index = ~0;
 758     assign_mask_type_index_to_pae(am, lc_index, is_ip6, pae);
 759     u32 first_index = activate_applied_ace_hash_entry(am, lc_index, applied_hash_aces, new_index);
 760     if (am->use_tuple_merge)
 761       check_collision_count_and_maybe_split(am, lc_index, is_ip6, first_index);
 762   }
 763   remake_hash_applied_mask_info_vec(am, applied_hash_aces, lc_index);
 764 done:
 765   clib_mem_set_heap (oldheap);
 766 }
 767
 768 static u32
 769 find_head_applied_ace_index(applied_hash_ace_entry_t **applied_hash_aces, u32 curr_index)
 770 {
 771   /*
 772    * find back the first entry. Inefficient so might need to be a bit cleverer
 773    * if this proves to be a problem..
 774    */
 775   u32 an_index = curr_index;
 776   ASSERT(an_index != ~0);
 777   applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), an_index);
 778   while(head_pae->prev_applied_entry_index != ~0) {
 779     an_index = head_pae->prev_applied_entry_index;
 780     ASSERT(an_index != ~0);
 781     head_pae = vec_elt_at_index((*applied_hash_aces), an_index);
 782   }
 783   return an_index;
 784 }
 785
 786 static void
 787 move_applied_ace_hash_entry(acl_main_t *am,
 788                             u32 lc_index,
 789                             applied_hash_ace_entry_t **applied_hash_aces,
 790                             u32 old_index, u32 new_index)
 791 {
 792   ASSERT(old_index != ~0);
 793   ASSERT(new_index != ~0);
 794   /* move the entry */
 795   *vec_elt_at_index((*applied_hash_aces), new_index) = *vec_elt_at_index((*applied_hash_aces), old_index);
 796
 797   /* update the linkage and hash table if necessary */
 798   applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), old_index);
 799   applied_hash_ace_entry_t *new_pae = vec_elt_at_index((*applied_hash_aces), new_index);
 800
 801   if (ACL_HASH_LOOKUP_DEBUG > 0) {
 802     clib_warning("Moving pae from %d to %d", old_index, new_index);
 803     acl_plugin_print_pae(am->vlib_main, old_index, pae);
 804   }
 805
 806   if (new_pae->tail_applied_entry_index == old_index) {
 807     /* fix-up the tail index if we are the tail and the start */
 808     new_pae->tail_applied_entry_index = new_index;
 809   }
 810
 811   if (pae->prev_applied_entry_index != ~0) {
 812     applied_hash_ace_entry_t *prev_pae = vec_elt_at_index((*applied_hash_aces), pae->prev_applied_entry_index);
 813     ASSERT(prev_pae->next_applied_entry_index == old_index);
 814     prev_pae->next_applied_entry_index = new_index;
 815   } else {
 816     /* first entry - so the hash points to it, update */
 817     add_del_hashtable_entry(am, lc_index,
 818                             applied_hash_aces, new_index, 1);
 819     ASSERT(pae->tail_applied_entry_index != ~0);
 820   }
 821   if (pae->next_applied_entry_index != ~0) {
 822     applied_hash_ace_entry_t *next_pae = vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
 823     ASSERT(next_pae->prev_applied_entry_index == old_index);
 824     next_pae->prev_applied_entry_index = new_index;
 825   } else {
 826     /*
 827      * Moving the very last entry, so we need to update the tail pointer in the first one.
 828      */
 829     u32 head_index = find_head_applied_ace_index(applied_hash_aces, old_index);
 830     ASSERT(head_index != ~0);
 831     applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), head_index);
 832
 833     ASSERT(head_pae->tail_applied_entry_index == old_index);
 834     head_pae->tail_applied_entry_index = new_index;
 835   }
 836   if (new_pae->colliding_rules) {
 837     /* update the information within the collision rule entry */
 838     ASSERT(vec_len(new_pae->colliding_rules) > 0);
 839     collision_match_rule_t *cr = vec_elt_at_index (new_pae->colliding_rules, 0);
 840     ASSERT(cr->applied_entry_index == old_index);
 841     cr->applied_entry_index = new_index;
 842   } else {
 843     /* find the index in the collision rule entry on the head element */
 844     u32 head_index = find_head_applied_ace_index(applied_hash_aces, new_index);
 845     ASSERT(head_index != ~0);
 846     applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), head_index);
 847     ASSERT(vec_len(head_pae->colliding_rules) > 0);
 848     u32 i;
 849     for (i=0; i<vec_len(head_pae->colliding_rules); i++) {
 850       collision_match_rule_t *cr = vec_elt_at_index (head_pae->colliding_rules, i);
 851       if (cr->applied_entry_index == old_index) {
 852         cr->applied_entry_index = new_index;
 853       }
 854     }
 855     if (ACL_HASH_LOOKUP_DEBUG > 0) {
 856       clib_warning("Head pae at index %d after adjustment", head_index);
 857       acl_plugin_print_pae(am->vlib_main, head_index, head_pae);
 858     }
 859   }
 860   /* invalidate the old entry */
 861   pae->prev_applied_entry_index = ~0;
 862   pae->next_applied_entry_index = ~0;
 863   pae->tail_applied_entry_index = ~0;
 864   pae->colliding_rules = NULL;
 865 }
 866
 867 static void
 868 deactivate_applied_ace_hash_entry(acl_main_t *am,
 869                             u32 lc_index,
 870                             applied_hash_ace_entry_t **applied_hash_aces,
 871                             u32 old_index)
 872 {
 873   applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), old_index);
 874   DBG("UNAPPLY DEACTIVATE: lc_index %d applied index %d", lc_index, old_index);
 875   if (ACL_HASH_LOOKUP_DEBUG > 0) {
 876     clib_warning("Deactivating pae at index %d", old_index);
 877     acl_plugin_print_pae(am->vlib_main, old_index, pae);
 878   }
 879
 880   if (pae->prev_applied_entry_index != ~0) {
 881     DBG("UNAPPLY = index %d has prev_applied_entry_index %d", old_index, pae->prev_applied_entry_index);
 882     applied_hash_ace_entry_t *prev_pae = vec_elt_at_index((*applied_hash_aces), pae->prev_applied_entry_index);
 883     ASSERT(prev_pae->next_applied_entry_index == old_index);
 884     prev_pae->next_applied_entry_index = pae->next_applied_entry_index;
 885
 886     u32 head_index = find_head_applied_ace_index(applied_hash_aces, old_index);
 887     ASSERT(head_index != ~0);
 888     applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), head_index);
 889     del_colliding_rule(applied_hash_aces, head_index, old_index);
 890
 891     if (pae->next_applied_entry_index == ~0) {
 892       /* it was a last entry we removed, update the pointer on the first one */
 893       ASSERT(head_pae->tail_applied_entry_index == old_index);
 894       head_pae->tail_applied_entry_index = pae->prev_applied_entry_index;
 895     } else {
 896       applied_hash_ace_entry_t *next_pae = vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
 897       next_pae->prev_applied_entry_index = pae->prev_applied_entry_index;
 898     }
 899   } else {
 900     /* It was the first entry. We need either to reset the hash entry or delete it */
 901     /* delete our entry from the collision vector first */
 902     del_colliding_rule(applied_hash_aces, old_index, old_index);
 903     if (pae->next_applied_entry_index != ~0) {
 904       /* the next element becomes the new first one, so needs the tail pointer to be set */
 905       applied_hash_ace_entry_t *next_pae = vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
 906       ASSERT(pae->tail_applied_entry_index != ~0);
 907       next_pae->tail_applied_entry_index = pae->tail_applied_entry_index;
 908       /* Remove ourselves and transfer the ownership of the colliding rules vector */
 909       next_pae->colliding_rules = pae->colliding_rules;
 910       /* unlink from the next element */
 911       next_pae->prev_applied_entry_index = ~0;
 912       add_del_hashtable_entry(am, lc_index,
 913                               applied_hash_aces, pae->next_applied_entry_index, 1);
 914     } else {
 915       /* no next entry, so just delete the entry in the hash table */
 916       add_del_hashtable_entry(am, lc_index,
 917                               applied_hash_aces, old_index, 0);
 918     }
 919   }
 920   DBG0("Releasing mask type index %d for pae index %d on lc_index %d", pae->mask_type_index, old_index, lc_index);
 921   release_mask_type_index(am, pae->mask_type_index);
 922   /* invalidate the old entry */
 923   pae->mask_type_index = ~0;
 924   pae->prev_applied_entry_index = ~0;
 925   pae->next_applied_entry_index = ~0;
 926   pae->tail_applied_entry_index = ~0;
 927   /* always has to be 0 */
 928   pae->colliding_rules = NULL;
 929 }
 930
 931
 932 void
 933 hash_acl_unapply(acl_main_t *am, u32 lc_index, int acl_index)
 934 {
 935   int i;
 936
 937   DBG0("HASH ACL unapply: lc_index %d acl %d", lc_index, acl_index);
 938   applied_hash_acl_info_t **applied_hash_acls = &am->applied_hash_acl_info_by_lc_index;
 939   applied_hash_acl_info_t *pal = vec_elt_at_index((*applied_hash_acls), lc_index);
 940
 941   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
 942   u32 **hash_acl_applied_lc_index = &ha->lc_index_list;
 943
 944   if (ACL_HASH_LOOKUP_DEBUG > 0) {
 945     clib_warning("unapplying acl %d", acl_index);
 946     acl_plugin_show_tables_mask_type();
 947     acl_plugin_show_tables_acl_hash_info(acl_index);
 948     acl_plugin_show_tables_applied_info(lc_index);
 949   }
 950
 951   /* remove this acl# from the list of applied hash acls */
 952   u32 index = vec_search(pal->applied_acls, acl_index);
 953   if (index == ~0) {
 954     clib_warning("BUG: trying to unapply unapplied acl_index %d on lc_index %d, according to lc",
 955                  acl_index, lc_index);
 956     return;
 957   }
 958   vec_del1(pal->applied_acls, index);
 959
 960   u32 index2 = vec_search((*hash_acl_applied_lc_index), lc_index);
 961   if (index2 == ~0) {
 962     clib_warning("BUG: trying to unapply twice acl_index %d on lc_index %d, according to h-acl info",
 963                  acl_index, lc_index);
 964     return;
 965   }
 966   vec_del1((*hash_acl_applied_lc_index), index2);
 967
 968   applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, lc_index);
 969
 970   for(i=0; i < vec_len((*applied_hash_aces)); i++) {
 971     if (vec_elt_at_index(*applied_hash_aces,i)->acl_index == acl_index) {
 972       DBG("Found applied ACL#%d at applied index %d", acl_index, i);
 973       break;
 974     }
 975   }
 976   if (vec_len((*applied_hash_aces)) <= i) {
 977     DBG("Did not find applied ACL#%d at lc_index %d", acl_index, lc_index);
 978     /* we went all the way without finding any entries. Probably a list was empty. */
 979     return;
 980   }
 981
 982   void *oldheap = hash_acl_set_heap(am);
 983   int base_offset = i;
 984   int tail_offset = base_offset + vec_len(ha->rules);
 985   int tail_len = vec_len((*applied_hash_aces)) - tail_offset;
 986   DBG("base_offset: %d, tail_offset: %d, tail_len: %d", base_offset, tail_offset, tail_len);
 987
 988   for(i=0; i < vec_len(ha->rules); i ++) {
 989     deactivate_applied_ace_hash_entry(am, lc_index,
 990                                       applied_hash_aces, base_offset + i);
 991   }
 992   for(i=0; i < tail_len; i ++) {
 993     /* move the entry at tail offset to base offset */
 994     /* that is, from (tail_offset+i) -> (base_offset+i) */
 995     DBG0("UNAPPLY MOVE: lc_index %d, applied index %d -> %d", lc_index, tail_offset+i, base_offset + i);
 996     move_applied_ace_hash_entry(am, lc_index, applied_hash_aces, tail_offset + i, base_offset + i);
 997   }
 998   /* trim the end of the vector */
 999   _vec_len((*applied_hash_aces)) -= vec_len(ha->rules);
1000
1001   remake_hash_applied_mask_info_vec(am, applied_hash_aces, lc_index);
1002
1003   if (vec_len((*applied_hash_aces)) == 0) {
1004     vec_free((*applied_hash_aces));
1005   }
1006
1007   clib_mem_set_heap (oldheap);
1008 }
1009
1010 /*
1011  * Create the applied ACEs and update the hash table,
1012  * taking into account that the ACL may not be the last
1013  * in the vector of applied ACLs.
1014  *
1015  * For now, walk from the end of the vector and unapply the ACLs,
1016  * then apply the one in question and reapply the rest.
1017  */
1018
1019 void
1020 hash_acl_reapply(acl_main_t *am, u32 lc_index, int acl_index)
1021 {
1022   acl_lookup_context_t *acontext = pool_elt_at_index(am->acl_lookup_contexts, lc_index);
1023   u32 **applied_acls = &acontext->acl_indices;
1024   int i;
1025   int start_index = vec_search((*applied_acls), acl_index);
1026
1027   DBG0("Start index for acl %d in lc_index %d is %d", acl_index, lc_index, start_index);
1028   /*
1029    * This function is called after we find out the lc_index where ACL is applied.
1030    * If the by-lc_index vector does not have the ACL#, then it's a bug.
1031    */
1032   ASSERT(start_index < vec_len(*applied_acls));
1033
1034   /* unapply all the ACLs at the tail side, up to the current one */
1035   for(i = vec_len(*applied_acls) - 1; i > start_index; i--) {
1036     hash_acl_unapply(am, lc_index, *vec_elt_at_index(*applied_acls, i));
1037   }
1038   for(i = start_index; i < vec_len(*applied_acls); i++) {
1039     hash_acl_apply(am, lc_index, *vec_elt_at_index(*applied_acls, i), i);
1040   }
1041 }
1042
1043 static void
1044 make_ip6_address_mask(ip6_address_t *addr, u8 prefix_len)
1045 {
1046   ip6_address_mask_from_width(addr, prefix_len);
1047 }
1048
1049
1050 /* Maybe should be moved into the core somewhere */
1051 always_inline void
1052 ip4_address_mask_from_width (ip4_address_t * a, u32 width)
1053 {
1054   int i, byte, bit, bitnum;
1055   ASSERT (width <= 32);
1056   memset (a, 0, sizeof (a[0]));
1057   for (i = 0; i < width; i++)
1058     {
1059       bitnum = (7 - (i & 7));
1060       byte = i / 8;
1061       bit = 1 << bitnum;
1062       a->as_u8[byte] |= bit;
1063     }
1064 }
1065
1066
1067 static void
1068 make_ip4_address_mask(ip4_address_t *addr, u8 prefix_len)
1069 {
1070   ip4_address_mask_from_width(addr, prefix_len);
1071 }
1072
1073 static void
1074 make_port_mask(u16 *portmask, u16 port_first, u16 port_last)
1075 {
1076   if (port_first == port_last) {
1077     *portmask = 0xffff;
1078     /* single port is representable by masked value */
1079     return;
1080   }
1081
1082   *portmask = 0;
1083   return;
1084 }
1085
1086 static void
1087 make_mask_and_match_from_rule(fa_5tuple_t *mask, acl_rule_t *r, hash_ace_info_t *hi)
1088 {
1089   memset(mask, 0, sizeof(*mask));
1090   memset(&hi->match, 0, sizeof(hi->match));
1091   hi->action = r->is_permit;
1092
1093   /* we will need to be matching based on lc_index and mask_type_index when applied */
1094   mask->pkt.lc_index = ~0;
1095   /* we will assign the match of mask_type_index later when we find it*/
1096   mask->pkt.mask_type_index_lsb = ~0;
1097
1098   mask->pkt.is_ip6 = 1;
1099   hi->match.pkt.is_ip6 = r->is_ipv6;
1100   if (r->is_ipv6) {
1101     make_ip6_address_mask(&mask->ip6_addr[0], r->src_prefixlen);
1102     hi->match.ip6_addr[0] = r->src.ip6;
1103     make_ip6_address_mask(&mask->ip6_addr[1], r->dst_prefixlen);
1104     hi->match.ip6_addr[1] = r->dst.ip6;
1105   } else {
1106     memset(hi->match.l3_zero_pad, 0, sizeof(hi->match.l3_zero_pad));
1107     make_ip4_address_mask(&mask->ip4_addr[0], r->src_prefixlen);
1108     hi->match.ip4_addr[0] = r->src.ip4;
1109     make_ip4_address_mask(&mask->ip4_addr[1], r->dst_prefixlen);
1110     hi->match.ip4_addr[1] = r->dst.ip4;
1111   }
1112
1113   if (r->proto != 0) {
1114     mask->l4.proto = ~0; /* L4 proto needs to be matched */
1115     hi->match.l4.proto = r->proto;
1116
1117     /* Calculate the src/dst port masks and make the src/dst port matches accordingly */
1118     make_port_mask(&mask->l4.port[0], r->src_port_or_type_first, r->src_port_or_type_last);
1119     hi->match.l4.port[0] = r->src_port_or_type_first & mask->l4.port[0];
1120
1121     make_port_mask(&mask->l4.port[1], r->dst_port_or_code_first, r->dst_port_or_code_last);
1122     hi->match.l4.port[1] = r->dst_port_or_code_first & mask->l4.port[1];
1123     /* L4 info must be valid in order to match */
1124     mask->pkt.l4_valid = 1;
1125     hi->match.pkt.l4_valid = 1;
1126     /* And we must set the mask to check that it is an initial fragment */
1127     mask->pkt.is_nonfirst_fragment = 1;
1128     hi->match.pkt.is_nonfirst_fragment = 0;
1129     if ((r->proto == IPPROTO_TCP) && (r->tcp_flags_mask != 0)) {
1130       /* if we want to match on TCP flags, they must be masked off as well */
1131       mask->pkt.tcp_flags = r->tcp_flags_mask;
1132       hi->match.pkt.tcp_flags = r->tcp_flags_value;
1133       /* and the flags need to be present within the packet being matched */
1134       mask->pkt.tcp_flags_valid = 1;
1135       hi->match.pkt.tcp_flags_valid = 1;
1136     }
1137   }
1138   /* Sanitize the mask and the match */
1139   u64 *pmask = (u64 *)mask;
1140   u64 *pmatch = (u64 *)&hi->match;
1141   int j;
1142   for(j=0; j<6; j++) {
1143     pmatch[j] = pmatch[j] & pmask[j];
1144   }
1145 }
1146
1147
1148 int hash_acl_exists(acl_main_t *am, int acl_index)
1149 {
1150   if (acl_index >= vec_len(am->hash_acl_infos))
1151     return 0;
1152
1153   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
1154   return ha->hash_acl_exists;
1155 }
1156
1157 void hash_acl_add(acl_main_t *am, int acl_index)
1158 {
1159   void *oldheap = hash_acl_set_heap(am);
1160   DBG("HASH ACL add : %d", acl_index);
1161   int i;
1162   acl_list_t *a = &am->acls[acl_index];
1163   vec_validate(am->hash_acl_infos, acl_index);
1164   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
1165   memset(ha, 0, sizeof(*ha));
1166   ha->hash_acl_exists = 1;
1167
1168   /* walk the newly added ACL entries and ensure that for each of them there
1169      is a mask type, increment a reference count for that mask type */
1170   for(i=0; i < a->count; i++) {
1171     hash_ace_info_t ace_info;
1172     fa_5tuple_t mask;
1173     memset(&ace_info, 0, sizeof(ace_info));
1174     ace_info.acl_index = acl_index;
1175     ace_info.ace_index = i;
1176
1177     make_mask_and_match_from_rule(&mask, &a->rules[i], &ace_info);
1178     mask.pkt.flags_reserved = 0b000;
1179     ace_info.base_mask_type_index = assign_mask_type_index(am, &mask);
1180     /* assign the mask type index for matching itself */
1181     ace_info.match.pkt.mask_type_index_lsb = ace_info.base_mask_type_index;
1182     DBG("ACE: %d mask_type_index: %d", i, ace_info.base_mask_type_index);
1183     vec_add1(ha->rules, ace_info);
1184   }
1185   /*
1186    * if an ACL is applied somewhere, fill the corresponding lookup data structures.
1187    * We need to take care if the ACL is not the last one in the vector of ACLs applied to the interface.
1188    */
1189   if (acl_index < vec_len(am->lc_index_vec_by_acl)) {
1190     u32 *lc_index;
1191     vec_foreach(lc_index, am->lc_index_vec_by_acl[acl_index]) {
1192       hash_acl_reapply(am, *lc_index, acl_index);
1193     }
1194   }
1195   clib_mem_set_heap (oldheap);
1196 }
1197
1198 void hash_acl_delete(acl_main_t *am, int acl_index)
1199 {
1200   void *oldheap = hash_acl_set_heap(am);
1201   DBG0("HASH ACL delete : %d", acl_index);
1202   /*
1203    * If the ACL is applied somewhere, remove the references of it (call hash_acl_unapply)
1204    * this is a different behavior from the linear lookup where an empty ACL is "deny all",
1205    *
1206    * However, following vpp-dev discussion the ACL that is referenced elsewhere
1207    * should not be possible to delete, and the change adding this also adds
1208    * the safeguards to that respect, so this is not a problem.
1209    *
1210    * The part to remember is that this routine is called in process of reapplication
1211    * during the acl_add_replace() API call - the old acl ruleset is deleted, then
1212    * the new one is added, without the change in the applied ACLs - so this case
1213    * has to be handled.
1214    */
1215   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
1216   u32 *lc_list_copy = 0;
1217   {
1218     u32 *lc_index;
1219     lc_list_copy = vec_dup(ha->lc_index_list);
1220     vec_foreach(lc_index, lc_list_copy) {
1221       hash_acl_unapply(am, *lc_index, acl_index);
1222     }
1223     vec_free(lc_list_copy);
1224   }
1225   vec_free(ha->lc_index_list);
1226
1227   /* walk the mask types for the ACL about-to-be-deleted, and decrease
1228    * the reference count, possibly freeing up some of them */
1229   int i;
1230   for(i=0; i < vec_len(ha->rules); i++) {
1231     release_mask_type_index(am, ha->rules[i].base_mask_type_index);
1232   }
1233   ha->hash_acl_exists = 0;
1234   vec_free(ha->rules);
1235   clib_mem_set_heap (oldheap);
1236 }
1237
1238
1239 void
1240 show_hash_acl_hash (vlib_main_t * vm, acl_main_t *am, u32 verbose)
1241 {
1242   vlib_cli_output(vm, "\nACL lookup hash table:\n%U\n",
1243                   BV (format_bihash), &am->acl_lookup_hash, verbose);
1244 }
1245
1246 void
1247 acl_plugin_show_tables_mask_type (void)
1248 {
1249   acl_main_t *am = &acl_main;
1250   vlib_main_t *vm = am->vlib_main;
1251   ace_mask_type_entry_t *mte;
1252
1253   vlib_cli_output (vm, "Mask-type entries:");
1254     /* *INDENT-OFF* */
1255     pool_foreach(mte, am->ace_mask_type_pool,
1256     ({
1257       vlib_cli_output(vm, "     %3d: %016llx %016llx %016llx %016llx %016llx %016llx  refcount %d",
1258                     mte - am->ace_mask_type_pool,
1259                     mte->mask.kv_40_8.key[0], mte->mask.kv_40_8.key[1], mte->mask.kv_40_8.key[2],
1260                     mte->mask.kv_40_8.key[3], mte->mask.kv_40_8.key[4], mte->mask.kv_40_8.value, mte->refcount);
1261     }));
1262     /* *INDENT-ON* */
1263 }
1264
1265 void
1266 acl_plugin_show_tables_acl_hash_info (u32 acl_index)
1267 {
1268   acl_main_t *am = &acl_main;
1269   vlib_main_t *vm = am->vlib_main;
1270   u32 i, j;
1271   u64 *m;
1272   vlib_cli_output (vm, "Mask-ready ACL representations\n");
1273   for (i = 0; i < vec_len (am->hash_acl_infos); i++)
1274     {
1275       if ((acl_index != ~0) && (acl_index != i))
1276         {
1277           continue;
1278         }
1279       hash_acl_info_t *ha = &am->hash_acl_infos[i];
1280       vlib_cli_output (vm, "acl-index %u bitmask-ready layout\n", i);
1281       vlib_cli_output (vm, "  applied lc_index list: %U\n",
1282                        format_vec32, ha->lc_index_list, "%d");
1283       for (j = 0; j < vec_len (ha->rules); j++)
1284         {
1285           hash_ace_info_t *pa = &ha->rules[j];
1286           m = (u64 *) & pa->match;
1287           vlib_cli_output (vm,
1288                            "    %4d: %016llx %016llx %016llx %016llx %016llx %016llx base mask index %d acl %d rule %d action %d\n",
1289                            j, m[0], m[1], m[2], m[3], m[4], m[5],
1290                            pa->base_mask_type_index, pa->acl_index, pa->ace_index,
1291                            pa->action);
1292         }
1293     }
1294 }
1295
1296 static void
1297 acl_plugin_print_colliding_rule (vlib_main_t * vm, int j, collision_match_rule_t *cr) {
1298   vlib_cli_output(vm,
1299                   "        %4d: acl %d ace %d acl pos %d pae index: %d",
1300                   j, cr->acl_index, cr->ace_index, cr->acl_position, cr->applied_entry_index);
1301 }
1302
1303 static void
1304 acl_plugin_print_pae (vlib_main_t * vm, int j, applied_hash_ace_entry_t * pae)
1305 {
1306   vlib_cli_output (vm,
1307                    "    %4d: acl %d rule %d action %d bitmask-ready rule %d mask type index: %d colliding_rules: %d next %d prev %d tail %d hitcount %lld acl_pos: %d",
1308                    j, pae->acl_index, pae->ace_index, pae->action,
1309                    pae->hash_ace_info_index, pae->mask_type_index, vec_len(pae->colliding_rules), pae->next_applied_entry_index,
1310                    pae->prev_applied_entry_index,
1311                    pae->tail_applied_entry_index, pae->hitcount, pae->acl_position);
1312   int jj;
1313   for(jj=0; jj<vec_len(pae->colliding_rules); jj++)
1314     acl_plugin_print_colliding_rule(vm, jj, vec_elt_at_index(pae->colliding_rules, jj));
1315 }
1316
1317 static void
1318 acl_plugin_print_applied_mask_info (vlib_main_t * vm, int j, hash_applied_mask_info_t *mi)
1319 {
1320   vlib_cli_output (vm,
1321                    "    %4d: mask type index %d first rule index %d num_entries %d max_collisions %d",
1322                    j, mi->mask_type_index, mi->first_rule_index, mi->num_entries, mi->max_collisions);
1323 }
1324
1325 void
1326 acl_plugin_show_tables_applied_info (u32 lc_index)
1327 {
1328   acl_main_t *am = &acl_main;
1329   vlib_main_t *vm = am->vlib_main;
1330   u32 lci, j;
1331   vlib_cli_output (vm, "Applied lookup entries for lookup contexts");
1332
1333   for (lci = 0;
1334        (lci < vec_len(am->applied_hash_acl_info_by_lc_index)); lci++)
1335     {
1336       if ((lc_index != ~0) && (lc_index != lci))
1337         {
1338           continue;
1339         }
1340       vlib_cli_output (vm, "lc_index %d:", lci);
1341       if (lci < vec_len (am->applied_hash_acl_info_by_lc_index))
1342         {
1343           applied_hash_acl_info_t *pal =
1344             &am->applied_hash_acl_info_by_lc_index[lci];
1345           vlib_cli_output (vm, "  applied acls: %U", format_vec32,
1346                            pal->applied_acls, "%d");
1347         }
1348       if (lci < vec_len (am->hash_applied_mask_info_vec_by_lc_index))
1349         {
1350           vlib_cli_output (vm, "  applied mask info entries:");
1351           for (j = 0;
1352                j < vec_len (am->hash_applied_mask_info_vec_by_lc_index[lci]);
1353                j++)
1354             {
1355               acl_plugin_print_applied_mask_info (vm, j,
1356                                     &am->hash_applied_mask_info_vec_by_lc_index
1357                                     [lci][j]);
1358             }
1359         }
1360       if (lci < vec_len (am->hash_entry_vec_by_lc_index))
1361         {
1362           vlib_cli_output (vm, "  lookup applied entries:");
1363           for (j = 0;
1364                j < vec_len (am->hash_entry_vec_by_lc_index[lci]);
1365                j++)
1366             {
1367               acl_plugin_print_pae (vm, j,
1368                                     &am->hash_entry_vec_by_lc_index
1369                                     [lci][j]);
1370             }
1371         }
1372     }
1373 }
1374
1375 void
1376 acl_plugin_show_tables_bihash (u32 show_bihash_verbose)
1377 {
1378   acl_main_t *am = &acl_main;
1379   vlib_main_t *vm = am->vlib_main;
1380   show_hash_acl_hash (vm, am, show_bihash_verbose);
1381 }
1382
1383 /*
1384  * Split of the partition needs to happen when the collision count
1385  * goes over a specified threshold.
1386  *
1387  * This is a signal that we ignored too many bits in
1388  * mT and we need to split the table into two tables. We select
1389  * all of the colliding rules L and find their maximum common
1390  * tuple mL. Normally mL is specific enough to hash L with few
1391  * or no collisions. We then create a new table T2 with tuple mL
1392  * and transfer all compatible rules from T to T2. If mL is not
1393  * specific enough, we find the field with the biggest difference
1394  * between the minimum and maximum tuple lengths for all of
1395  * the rules in L and set that field to be the average of those two
1396  * values. We then transfer all compatible rules as before. This
1397  * guarantees that some rules from L will move and that T2 will
1398  * have a smaller number of collisions than T did.
1399  */
1400
1401
1402 static void
1403 ensure_ip6_min_addr (ip6_address_t * min_addr, ip6_address_t * mask_addr)
1404 {
1405   int update =
1406     (clib_net_to_host_u64 (mask_addr->as_u64[0]) <
1407      clib_net_to_host_u64 (min_addr->as_u64[0]))
1408     ||
1409     ((clib_net_to_host_u64 (mask_addr->as_u64[0]) ==
1410       clib_net_to_host_u64 (min_addr->as_u64[0]))
1411      && (clib_net_to_host_u64 (mask_addr->as_u64[1]) <
1412          clib_net_to_host_u64 (min_addr->as_u64[1])));
1413   if (update)
1414     {
1415       min_addr->as_u64[0] = mask_addr->as_u64[0];
1416       min_addr->as_u64[1] = mask_addr->as_u64[1];
1417     }
1418 }
1419
1420 static void
1421 ensure_ip6_max_addr (ip6_address_t * max_addr, ip6_address_t * mask_addr)
1422 {
1423   int update =
1424     (clib_net_to_host_u64 (mask_addr->as_u64[0]) >
1425      clib_net_to_host_u64 (max_addr->as_u64[0]))
1426     ||
1427     ((clib_net_to_host_u64 (mask_addr->as_u64[0]) ==
1428       clib_net_to_host_u64 (max_addr->as_u64[0]))
1429      && (clib_net_to_host_u64 (mask_addr->as_u64[1]) >
1430          clib_net_to_host_u64 (max_addr->as_u64[1])));
1431   if (update)
1432     {
1433       max_addr->as_u64[0] = mask_addr->as_u64[0];
1434       max_addr->as_u64[1] = mask_addr->as_u64[1];
1435     }
1436 }
1437
1438 static void
1439 ensure_ip4_min_addr (ip4_address_t * min_addr, ip4_address_t * mask_addr)
1440 {
1441   int update =
1442     (clib_net_to_host_u32 (mask_addr->as_u32) <
1443      clib_net_to_host_u32 (min_addr->as_u32));
1444   if (update)
1445     min_addr->as_u32 = mask_addr->as_u32;
1446 }
1447
1448 static void
1449 ensure_ip4_max_addr (ip4_address_t * max_addr, ip4_address_t * mask_addr)
1450 {
1451   int update =
1452     (clib_net_to_host_u32 (mask_addr->as_u32) >
1453      clib_net_to_host_u32 (max_addr->as_u32));
1454   if (update)
1455     max_addr->as_u32 = mask_addr->as_u32;
1456 }
1457
1458 enum {
1459   DIM_SRC_ADDR = 0,
1460   DIM_DST_ADDR,
1461   DIM_SRC_PORT,
1462   DIM_DST_PORT,
1463   DIM_PROTO,
1464 };
1465
1466
1467
1468 static void
1469 split_partition(acl_main_t *am, u32 first_index,
1470                             u32 lc_index, int is_ip6){
1471         DBG( "TM-split_partition - first_entry:%d", first_index);
1472         applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, lc_index);
1473         ace_mask_type_entry_t *mte;
1474         fa_5tuple_t the_min_tuple, *min_tuple = &the_min_tuple;
1475         fa_5tuple_t the_max_tuple, *max_tuple = &the_max_tuple;
1476         applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), first_index);
1477         hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, pae->acl_index);
1478         hash_ace_info_t *ace_info;
1479         u32 coll_mask_type_index = pae->mask_type_index;
1480         memset(&the_min_tuple, 0, sizeof(the_min_tuple));
1481         memset(&the_max_tuple, 0, sizeof(the_max_tuple));
1482
1483         int i=0;
1484         u64 collisions = vec_len(pae->colliding_rules);
1485         for(i=0; i<collisions; i++){
1486
1487                 DBG( "TM-collision: base_ace:%d (ace_mask:%d, first_collision_mask:%d)",
1488                                 pae->ace_index, pae->mask_type_index, coll_mask_type_index);
1489
1490                 ace_info = vec_elt_at_index(ha->rules, pae->hash_ace_info_index);
1491                 mte = vec_elt_at_index(am->ace_mask_type_pool, ace_info->base_mask_type_index);
1492                 fa_5tuple_t *mask = &mte->mask;
1493
1494                 if(pae->mask_type_index != coll_mask_type_index) continue;
1495                 /* Computing min_mask and max_mask for colliding rules */
1496                 if(i==0){
1497                         clib_memcpy(min_tuple, mask, sizeof(fa_5tuple_t));
1498                         clib_memcpy(max_tuple, mask, sizeof(fa_5tuple_t));
1499                 }else{
1500                         int j;
1501                         for(j=0; j<2; j++){
1502                                 if (is_ip6)
1503                                   ensure_ip6_min_addr(&min_tuple->ip6_addr[j], &mask->ip6_addr[j]);
1504                                 else
1505                                   ensure_ip4_min_addr(&min_tuple->ip4_addr[j], &mask->ip4_addr[j]);
1506
1507                                 if ((mask->l4.port[j] < min_tuple->l4.port[j]))
1508                                         min_tuple->l4.port[j] = mask->l4.port[j];
1509                         }
1510
1511                         if ((mask->l4.proto < min_tuple->l4.proto))
1512                                 min_tuple->l4.proto = mask->l4.proto;
1513
1514                         if(mask->pkt.as_u64 < min_tuple->pkt.as_u64)
1515                                 min_tuple->pkt.as_u64 = mask->pkt.as_u64;
1516
1517
1518                         for(j=0; j<2; j++){
1519                                 if (is_ip6)
1520                                   ensure_ip6_max_addr(&max_tuple->ip6_addr[j], &mask->ip6_addr[j]);
1521                                 else
1522                                   ensure_ip4_max_addr(&max_tuple->ip4_addr[j], &mask->ip4_addr[j]);
1523
1524                                 if ((mask->l4.port[j] > max_tuple->l4.port[j]))
1525                                         max_tuple->l4.port[j] = mask->l4.port[j];
1526                         }
1527
1528                         if ((mask->l4.proto < max_tuple->l4.proto))
1529                                 max_tuple->l4.proto = mask->l4.proto;
1530
1531                         if(mask->pkt.as_u64 > max_tuple->pkt.as_u64)
1532                                 max_tuple->pkt.as_u64 = mask->pkt.as_u64;
1533                 }
1534
1535                 pae = pae->next_applied_entry_index == ~0 ? 0 : vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
1536         }
1537
1538         /* Computing field with max difference between (min/max)_mask */
1539         int best_dim=-1, best_delta=0, delta=0;
1540
1541         /* SRC_addr dimension */
1542         if (is_ip6) {
1543           int i;
1544           for(i=0; i<2; i++){
1545                 delta += count_bits(max_tuple->ip6_addr[0].as_u64[i]) - count_bits(min_tuple->ip6_addr[0].as_u64[i]);
1546           }
1547         } else {
1548                 delta += count_bits(max_tuple->ip4_addr[0].as_u32) - count_bits(min_tuple->ip4_addr[0].as_u32);
1549         }
1550         if(delta > best_delta){
1551                 best_delta = delta;
1552                 best_dim = DIM_SRC_ADDR;
1553         }
1554
1555         /* DST_addr dimension */
1556         delta = 0;
1557         if (is_ip6) {
1558           int i;
1559           for(i=0; i<2; i++){
1560                 delta += count_bits(max_tuple->ip6_addr[1].as_u64[i]) - count_bits(min_tuple->ip6_addr[1].as_u64[i]);
1561           }
1562         } else {
1563                 delta += count_bits(max_tuple->ip4_addr[1].as_u32) - count_bits(min_tuple->ip4_addr[1].as_u32);
1564         }
1565         if(delta > best_delta){
1566                 best_delta = delta;
1567                 best_dim = DIM_DST_ADDR;
1568         }
1569
1570         /* SRC_port dimension */
1571         delta = count_bits(max_tuple->l4.port[0]) - count_bits(min_tuple->l4.port[0]);
1572         if(delta > best_delta){
1573                 best_delta = delta;
1574                 best_dim = DIM_SRC_PORT;
1575         }
1576
1577         /* DST_port dimension */
1578         delta = count_bits(max_tuple->l4.port[1]) - count_bits(min_tuple->l4.port[1]);
1579         if(delta > best_delta){
1580                 best_delta = delta;
1581                 best_dim = DIM_DST_PORT;
1582         }
1583
1584         /* Proto dimension */
1585         delta = count_bits(max_tuple->l4.proto) - count_bits(min_tuple->l4.proto);
1586         if(delta > best_delta){
1587                 best_delta = delta;
1588                 best_dim = DIM_PROTO;
1589         }
1590
1591         int shifting = 0; //, ipv4_block = 0;
1592         switch(best_dim){
1593                 case DIM_SRC_ADDR:
1594                         shifting = (best_delta)/2; // FIXME IPV4-only
1595                         // ipv4_block = count_bits(max_tuple->ip4_addr[0].as_u32);
1596                         min_tuple->ip4_addr[0].as_u32 =
1597                                         clib_host_to_net_u32((clib_net_to_host_u32(max_tuple->ip4_addr[0].as_u32) << (shifting))&0xFFFFFFFF);
1598
1599                         break;
1600                 case DIM_DST_ADDR:
1601                         shifting = (best_delta)/2;
1602 /*
1603                         ipv4_block = count_bits(max_tuple->addr[1].as_u64[1]);
1604                         if(ipv4_block > shifting)
1605                                 min_tuple->addr[1].as_u64[1] =
1606                                         clib_host_to_net_u64((clib_net_to_host_u64(max_tuple->addr[1].as_u64[1]) << (shifting))&0xFFFFFFFF);
1607                         else{
1608                                 shifting = shifting - ipv4_block;
1609                                 min_tuple->addr[1].as_u64[1] = 0;
1610                                 min_tuple->addr[1].as_u64[0] =
1611                                         clib_host_to_net_u64((clib_net_to_host_u64(max_tuple->addr[1].as_u64[0]) << (shifting))&0xFFFFFFFF);
1612                         }
1613 */
1614                         min_tuple->ip4_addr[1].as_u32 =
1615                                         clib_host_to_net_u32((clib_net_to_host_u32(max_tuple->ip4_addr[1].as_u32) << (shifting))&0xFFFFFFFF);
1616
1617                         break;
1618                 case DIM_SRC_PORT: min_tuple->l4.port[0] = max_tuple->l4.port[0]  << (best_delta)/2;
1619                         break;
1620                 case DIM_DST_PORT: min_tuple->l4.port[1] = max_tuple->l4.port[1] << (best_delta)/2;
1621                         break;
1622                 case DIM_PROTO: min_tuple->l4.proto = max_tuple->l4.proto << (best_delta)/2;
1623                         break;
1624                 default: relax_tuple(min_tuple, is_ip6, 1);
1625                         break;
1626         }
1627
1628         min_tuple->pkt.is_nonfirst_fragment = 0;
1629         u32 new_mask_type_index = assign_mask_type_index(am, min_tuple);
1630
1631         hash_applied_mask_info_t **hash_applied_mask_info_vec = vec_elt_at_index(am->hash_applied_mask_info_vec_by_lc_index, lc_index);
1632
1633         hash_applied_mask_info_t *minfo;
1634         //search in order pool if mask_type_index is already there
1635         int search;
1636         for (search=0; search < vec_len((*hash_applied_mask_info_vec)); search++){
1637                 minfo = vec_elt_at_index((*hash_applied_mask_info_vec), search);
1638                 if(minfo->mask_type_index == new_mask_type_index)
1639                         break;
1640         }
1641
1642         vec_validate((*hash_applied_mask_info_vec), search);
1643         minfo = vec_elt_at_index((*hash_applied_mask_info_vec), search);
1644         minfo->mask_type_index = new_mask_type_index;
1645         minfo->num_entries = 0;
1646         minfo->max_collisions = 0;
1647         minfo->first_rule_index = ~0;
1648
1649         DBG( "TM-split_partition - mask type index-assigned!! -> %d", new_mask_type_index);
1650
1651         if(coll_mask_type_index == new_mask_type_index){
1652                 //vlib_cli_output(vm, "TM-There are collisions over threshold, but i'm not able to split! %d %d", coll_mask_type_index, new_mask_type_index);
1653                 return;
1654         }
1655
1656
1657         /* populate new partition */
1658         DBG( "TM-Populate new partition");
1659         u32 r_ace_index = first_index;
1660         int repopulate_count = 0;
1661
1662 //      for(i=0; i<collisions; i++){
1663         for(r_ace_index=0; r_ace_index < vec_len((*applied_hash_aces)); r_ace_index++) {
1664
1665                 applied_hash_ace_entry_t *pop_pae = vec_elt_at_index((*applied_hash_aces), r_ace_index);
1666                 DBG( "TM-Population-collision: base_ace:%d (ace_mask:%d, first_collision_mask:%d)",
1667                                 pop_pae->ace_index, pop_pae->mask_type_index, coll_mask_type_index);
1668
1669                 if(pop_pae->mask_type_index != coll_mask_type_index) continue;
1670                 u32 next_index = pop_pae->next_applied_entry_index;
1671
1672                 ace_info = vec_elt_at_index(ha->rules, pop_pae->hash_ace_info_index);
1673                 mte = vec_elt_at_index(am->ace_mask_type_pool, ace_info->base_mask_type_index);
1674                 //can insert rule?
1675                 //mte = vec_elt_at_index(am->ace_mask_type_pool, pop_pae->mask_type_index);
1676                 fa_5tuple_t *pop_mask = &mte->mask;
1677
1678                 if(!first_mask_contains_second_mask(is_ip6, min_tuple, pop_mask)) continue;
1679                 DBG( "TM-new partition can insert -> applied_ace:%d", r_ace_index);
1680
1681                 //delete and insert in new format
1682                 deactivate_applied_ace_hash_entry(am, lc_index, applied_hash_aces, r_ace_index);
1683
1684                 /* insert the new entry */
1685                 pop_pae->mask_type_index = new_mask_type_index;
1686                 /* The very first repopulation gets the lock by virtue of a new mask being created above */
1687                 if (++repopulate_count > 1)
1688                   lock_mask_type_index(am, new_mask_type_index);
1689
1690                 activate_applied_ace_hash_entry(am, lc_index, applied_hash_aces, r_ace_index);
1691
1692                 r_ace_index = next_index;
1693         }
1694
1695         DBG( "TM-Populate new partition-END");
1696         DBG( "TM-split_partition - END");
1697
1698 }
1699