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_fast(&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     clib_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 USE_DLMALLOC != 0
 607     /*
 608      * DLMALLOC is being "helpful" in that it ignores the heap size parameter
 609      * by default and tries to allocate the larger amount of memory.
 610      *
 611      * Pin the heap so this does not happen and if we run out of memory
 612      * in this heap, we will bail out with "out of memory", rather than
 613      * an obscure error sometime later.
 614      */
 615     mspace_disable_expand(am->hash_lookup_mheap);
 616 #endif
 617     if (0 == am->hash_lookup_mheap) {
 618         clib_error("ACL plugin failed to allocate lookup heap of %U bytes",
 619                    format_memory_size, am->hash_lookup_mheap_size);
 620     }
 621   }
 622   void *oldheap = clib_mem_set_heap(am->hash_lookup_mheap);
 623   return oldheap;
 624 }
 625
 626 void
 627 acl_plugin_hash_acl_set_validate_heap(int on)
 628 {
 629   acl_main_t *am = &acl_main;
 630   clib_mem_set_heap(hash_acl_set_heap(am));
 631 #if USE_DLMALLOC == 0
 632   mheap_t *h = mheap_header (am->hash_lookup_mheap);
 633   if (on) {
 634     h->flags |= MHEAP_FLAG_VALIDATE;
 635     h->flags &= ~MHEAP_FLAG_SMALL_OBJECT_CACHE;
 636     mheap_validate(h);
 637   } else {
 638     h->flags &= ~MHEAP_FLAG_VALIDATE;
 639     h->flags |= MHEAP_FLAG_SMALL_OBJECT_CACHE;
 640   }
 641 #endif
 642 }
 643
 644 void
 645 acl_plugin_hash_acl_set_trace_heap(int on)
 646 {
 647   acl_main_t *am = &acl_main;
 648   clib_mem_set_heap(hash_acl_set_heap(am));
 649 #if USE_DLMALLOC == 0
 650   mheap_t *h = mheap_header (am->hash_lookup_mheap);
 651   if (on) {
 652     h->flags |= MHEAP_FLAG_TRACE;
 653   } else {
 654     h->flags &= ~MHEAP_FLAG_TRACE;
 655   }
 656 #endif
 657 }
 658
 659 static void
 660 assign_mask_type_index_to_pae(acl_main_t *am, u32 lc_index, int is_ip6, applied_hash_ace_entry_t *pae)
 661 {
 662   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, pae->acl_index);
 663   hash_ace_info_t *ace_info = vec_elt_at_index(ha->rules, pae->hash_ace_info_index);
 664
 665   ace_mask_type_entry_t *mte;
 666   fa_5tuple_t mask;
 667   /*
 668    * Start taking base_mask associated to ace, and essentially copy it.
 669    * With TupleMerge we will assign a relaxed mask here.
 670    */
 671   mte = vec_elt_at_index(am->ace_mask_type_pool, ace_info->base_mask_type_index);
 672   mask = mte->mask;
 673   if (am->use_tuple_merge)
 674     pae->mask_type_index = tm_assign_mask_type_index(am, &mask, is_ip6, lc_index);
 675   else
 676     pae->mask_type_index = assign_mask_type_index(am, &mask);
 677 }
 678
 679 static void
 680 split_partition(acl_main_t *am, u32 first_index,
 681                             u32 lc_index, int is_ip6);
 682
 683
 684 static void
 685 check_collision_count_and_maybe_split(acl_main_t *am, u32 lc_index, int is_ip6, u32 first_index)
 686 {
 687   applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, lc_index);
 688   applied_hash_ace_entry_t *first_pae = vec_elt_at_index((*applied_hash_aces), first_index);
 689   if (vec_len(first_pae->colliding_rules) > am->tuple_merge_split_threshold) {
 690     split_partition(am, first_index, lc_index, is_ip6);
 691   }
 692 }
 693
 694 void
 695 hash_acl_apply(acl_main_t *am, u32 lc_index, int acl_index, u32 acl_position)
 696 {
 697   int i;
 698
 699   DBG0("HASH ACL apply: lc_index %d acl %d", lc_index, acl_index);
 700   if (!am->acl_lookup_hash_initialized) {
 701     BV (clib_bihash_init) (&am->acl_lookup_hash, "ACL plugin rule lookup bihash",
 702                            am->hash_lookup_hash_buckets, am->hash_lookup_hash_memory);
 703     am->acl_lookup_hash_initialized = 1;
 704   }
 705
 706   void *oldheap = hash_acl_set_heap(am);
 707   vec_validate(am->hash_entry_vec_by_lc_index, lc_index);
 708   vec_validate(am->hash_acl_infos, acl_index);
 709   applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, lc_index);
 710
 711   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
 712   u32 **hash_acl_applied_lc_index = &ha->lc_index_list;
 713
 714   int base_offset = vec_len(*applied_hash_aces);
 715
 716   /* Update the bitmap of the mask types with which the lookup
 717      needs to happen for the ACLs applied to this lc_index */
 718   applied_hash_acl_info_t **applied_hash_acls = &am->applied_hash_acl_info_by_lc_index;
 719   vec_validate((*applied_hash_acls), lc_index);
 720   applied_hash_acl_info_t *pal = vec_elt_at_index((*applied_hash_acls), lc_index);
 721
 722   /* ensure the list of applied hash acls is initialized and add this acl# to it */
 723   u32 index = vec_search(pal->applied_acls, acl_index);
 724   if (index != ~0) {
 725     clib_warning("BUG: trying to apply twice acl_index %d on lc_index %d, according to lc",
 726                  acl_index, lc_index);
 727     goto done;
 728   }
 729   vec_add1(pal->applied_acls, acl_index);
 730   u32 index2 = vec_search((*hash_acl_applied_lc_index), lc_index);
 731   if (index2 != ~0) {
 732     clib_warning("BUG: trying to apply twice acl_index %d on lc_index %d, according to hash h-acl info",
 733                  acl_index, lc_index);
 734     goto done;
 735   }
 736   vec_add1((*hash_acl_applied_lc_index), lc_index);
 737
 738   /*
 739    * if the applied ACL is empty, the current code will cause a
 740    * different behavior compared to current linear search: an empty ACL will
 741    * simply fallthrough to the next ACL, or the default deny in the end.
 742    *
 743    * This is not a problem, because after vpp-dev discussion,
 744    * the consensus was it should not be possible to apply the non-existent
 745    * ACL, so the change adding this code also takes care of that.
 746    */
 747
 748
 749   vec_validate(am->hash_applied_mask_info_vec_by_lc_index, lc_index);
 750
 751   /* since we know (in case of no split) how much we expand, preallocate that space */
 752   int old_vec_len = vec_len(*applied_hash_aces);
 753   vec_validate((*applied_hash_aces), old_vec_len + vec_len(ha->rules) - 1);
 754   _vec_len((*applied_hash_aces)) = old_vec_len;
 755
 756   /* add the rules from the ACL to the hash table for lookup and append to the vector*/
 757   for(i=0; i < vec_len(ha->rules); i++) {
 758     /*
 759      * Expand the applied aces vector to fit a new entry.
 760      * One by one not to upset split_partition() if it is called.
 761      */
 762     vec_resize((*applied_hash_aces), 1);
 763
 764     int is_ip6 = ha->rules[i].match.pkt.is_ip6;
 765     u32 new_index = base_offset + i;
 766     applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), new_index);
 767     pae->acl_index = acl_index;
 768     pae->ace_index = ha->rules[i].ace_index;
 769     pae->acl_position = acl_position;
 770     pae->action = ha->rules[i].action;
 771     pae->hitcount = 0;
 772     pae->hash_ace_info_index = i;
 773     /* we might link it in later */
 774     pae->next_applied_entry_index = ~0;
 775     pae->prev_applied_entry_index = ~0;
 776     pae->tail_applied_entry_index = ~0;
 777     pae->colliding_rules = NULL;
 778     pae->mask_type_index = ~0;
 779     assign_mask_type_index_to_pae(am, lc_index, is_ip6, pae);
 780     u32 first_index = activate_applied_ace_hash_entry(am, lc_index, applied_hash_aces, new_index);
 781     if (am->use_tuple_merge)
 782       check_collision_count_and_maybe_split(am, lc_index, is_ip6, first_index);
 783   }
 784   remake_hash_applied_mask_info_vec(am, applied_hash_aces, lc_index);
 785 done:
 786   clib_mem_set_heap (oldheap);
 787 }
 788
 789 static u32
 790 find_head_applied_ace_index(applied_hash_ace_entry_t **applied_hash_aces, u32 curr_index)
 791 {
 792   /*
 793    * find back the first entry. Inefficient so might need to be a bit cleverer
 794    * if this proves to be a problem..
 795    */
 796   u32 an_index = curr_index;
 797   ASSERT(an_index != ~0);
 798   applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), an_index);
 799   while(head_pae->prev_applied_entry_index != ~0) {
 800     an_index = head_pae->prev_applied_entry_index;
 801     ASSERT(an_index != ~0);
 802     head_pae = vec_elt_at_index((*applied_hash_aces), an_index);
 803   }
 804   return an_index;
 805 }
 806
 807 static void
 808 move_applied_ace_hash_entry(acl_main_t *am,
 809                             u32 lc_index,
 810                             applied_hash_ace_entry_t **applied_hash_aces,
 811                             u32 old_index, u32 new_index)
 812 {
 813   ASSERT(old_index != ~0);
 814   ASSERT(new_index != ~0);
 815   /* move the entry */
 816   *vec_elt_at_index((*applied_hash_aces), new_index) = *vec_elt_at_index((*applied_hash_aces), old_index);
 817
 818   /* update the linkage and hash table if necessary */
 819   applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), old_index);
 820   applied_hash_ace_entry_t *new_pae = vec_elt_at_index((*applied_hash_aces), new_index);
 821
 822   if (ACL_HASH_LOOKUP_DEBUG > 0) {
 823     clib_warning("Moving pae from %d to %d", old_index, new_index);
 824     acl_plugin_print_pae(am->vlib_main, old_index, pae);
 825   }
 826
 827   if (new_pae->tail_applied_entry_index == old_index) {
 828     /* fix-up the tail index if we are the tail and the start */
 829     new_pae->tail_applied_entry_index = new_index;
 830   }
 831
 832   if (pae->prev_applied_entry_index != ~0) {
 833     applied_hash_ace_entry_t *prev_pae = vec_elt_at_index((*applied_hash_aces), pae->prev_applied_entry_index);
 834     ASSERT(prev_pae->next_applied_entry_index == old_index);
 835     prev_pae->next_applied_entry_index = new_index;
 836   } else {
 837     /* first entry - so the hash points to it, update */
 838     add_del_hashtable_entry(am, lc_index,
 839                             applied_hash_aces, new_index, 1);
 840     ASSERT(pae->tail_applied_entry_index != ~0);
 841   }
 842   if (pae->next_applied_entry_index != ~0) {
 843     applied_hash_ace_entry_t *next_pae = vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
 844     ASSERT(next_pae->prev_applied_entry_index == old_index);
 845     next_pae->prev_applied_entry_index = new_index;
 846   } else {
 847     /*
 848      * Moving the very last entry, so we need to update the tail pointer in the first one.
 849      */
 850     u32 head_index = find_head_applied_ace_index(applied_hash_aces, old_index);
 851     ASSERT(head_index != ~0);
 852     applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), head_index);
 853
 854     ASSERT(head_pae->tail_applied_entry_index == old_index);
 855     head_pae->tail_applied_entry_index = new_index;
 856   }
 857   if (new_pae->colliding_rules) {
 858     /* update the information within the collision rule entry */
 859     ASSERT(vec_len(new_pae->colliding_rules) > 0);
 860     collision_match_rule_t *cr = vec_elt_at_index (new_pae->colliding_rules, 0);
 861     ASSERT(cr->applied_entry_index == old_index);
 862     cr->applied_entry_index = new_index;
 863   } else {
 864     /* find the index in the collision rule entry on the head element */
 865     u32 head_index = find_head_applied_ace_index(applied_hash_aces, new_index);
 866     ASSERT(head_index != ~0);
 867     applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), head_index);
 868     ASSERT(vec_len(head_pae->colliding_rules) > 0);
 869     u32 i;
 870     for (i=0; i<vec_len(head_pae->colliding_rules); i++) {
 871       collision_match_rule_t *cr = vec_elt_at_index (head_pae->colliding_rules, i);
 872       if (cr->applied_entry_index == old_index) {
 873         cr->applied_entry_index = new_index;
 874       }
 875     }
 876     if (ACL_HASH_LOOKUP_DEBUG > 0) {
 877       clib_warning("Head pae at index %d after adjustment", head_index);
 878       acl_plugin_print_pae(am->vlib_main, head_index, head_pae);
 879     }
 880   }
 881   /* invalidate the old entry */
 882   pae->prev_applied_entry_index = ~0;
 883   pae->next_applied_entry_index = ~0;
 884   pae->tail_applied_entry_index = ~0;
 885   pae->colliding_rules = NULL;
 886 }
 887
 888 static void
 889 deactivate_applied_ace_hash_entry(acl_main_t *am,
 890                             u32 lc_index,
 891                             applied_hash_ace_entry_t **applied_hash_aces,
 892                             u32 old_index)
 893 {
 894   applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), old_index);
 895   DBG("UNAPPLY DEACTIVATE: lc_index %d applied index %d", lc_index, old_index);
 896   if (ACL_HASH_LOOKUP_DEBUG > 0) {
 897     clib_warning("Deactivating pae at index %d", old_index);
 898     acl_plugin_print_pae(am->vlib_main, old_index, pae);
 899   }
 900
 901   if (pae->prev_applied_entry_index != ~0) {
 902     DBG("UNAPPLY = index %d has prev_applied_entry_index %d", old_index, pae->prev_applied_entry_index);
 903     applied_hash_ace_entry_t *prev_pae = vec_elt_at_index((*applied_hash_aces), pae->prev_applied_entry_index);
 904     ASSERT(prev_pae->next_applied_entry_index == old_index);
 905     prev_pae->next_applied_entry_index = pae->next_applied_entry_index;
 906
 907     u32 head_index = find_head_applied_ace_index(applied_hash_aces, old_index);
 908     ASSERT(head_index != ~0);
 909     applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), head_index);
 910     del_colliding_rule(applied_hash_aces, head_index, old_index);
 911
 912     if (pae->next_applied_entry_index == ~0) {
 913       /* it was a last entry we removed, update the pointer on the first one */
 914       ASSERT(head_pae->tail_applied_entry_index == old_index);
 915       head_pae->tail_applied_entry_index = pae->prev_applied_entry_index;
 916     } else {
 917       applied_hash_ace_entry_t *next_pae = vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
 918       next_pae->prev_applied_entry_index = pae->prev_applied_entry_index;
 919     }
 920   } else {
 921     /* It was the first entry. We need either to reset the hash entry or delete it */
 922     /* delete our entry from the collision vector first */
 923     del_colliding_rule(applied_hash_aces, old_index, old_index);
 924     if (pae->next_applied_entry_index != ~0) {
 925       /* the next element becomes the new first one, so needs the tail pointer to be set */
 926       applied_hash_ace_entry_t *next_pae = vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
 927       ASSERT(pae->tail_applied_entry_index != ~0);
 928       next_pae->tail_applied_entry_index = pae->tail_applied_entry_index;
 929       /* Remove ourselves and transfer the ownership of the colliding rules vector */
 930       next_pae->colliding_rules = pae->colliding_rules;
 931       /* unlink from the next element */
 932       next_pae->prev_applied_entry_index = ~0;
 933       add_del_hashtable_entry(am, lc_index,
 934                               applied_hash_aces, pae->next_applied_entry_index, 1);
 935     } else {
 936       /* no next entry, so just delete the entry in the hash table */
 937       add_del_hashtable_entry(am, lc_index,
 938                               applied_hash_aces, old_index, 0);
 939     }
 940   }
 941   DBG0("Releasing mask type index %d for pae index %d on lc_index %d", pae->mask_type_index, old_index, lc_index);
 942   release_mask_type_index(am, pae->mask_type_index);
 943   /* invalidate the old entry */
 944   pae->mask_type_index = ~0;
 945   pae->prev_applied_entry_index = ~0;
 946   pae->next_applied_entry_index = ~0;
 947   pae->tail_applied_entry_index = ~0;
 948   /* always has to be 0 */
 949   pae->colliding_rules = NULL;
 950 }
 951
 952
 953 void
 954 hash_acl_unapply(acl_main_t *am, u32 lc_index, int acl_index)
 955 {
 956   int i;
 957
 958   DBG0("HASH ACL unapply: lc_index %d acl %d", lc_index, acl_index);
 959   applied_hash_acl_info_t **applied_hash_acls = &am->applied_hash_acl_info_by_lc_index;
 960   applied_hash_acl_info_t *pal = vec_elt_at_index((*applied_hash_acls), lc_index);
 961
 962   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
 963   u32 **hash_acl_applied_lc_index = &ha->lc_index_list;
 964
 965   if (ACL_HASH_LOOKUP_DEBUG > 0) {
 966     clib_warning("unapplying acl %d", acl_index);
 967     acl_plugin_show_tables_mask_type();
 968     acl_plugin_show_tables_acl_hash_info(acl_index);
 969     acl_plugin_show_tables_applied_info(lc_index);
 970   }
 971
 972   /* remove this acl# from the list of applied hash acls */
 973   u32 index = vec_search(pal->applied_acls, acl_index);
 974   if (index == ~0) {
 975     clib_warning("BUG: trying to unapply unapplied acl_index %d on lc_index %d, according to lc",
 976                  acl_index, lc_index);
 977     return;
 978   }
 979   vec_del1(pal->applied_acls, index);
 980
 981   u32 index2 = vec_search((*hash_acl_applied_lc_index), lc_index);
 982   if (index2 == ~0) {
 983     clib_warning("BUG: trying to unapply twice acl_index %d on lc_index %d, according to h-acl info",
 984                  acl_index, lc_index);
 985     return;
 986   }
 987   vec_del1((*hash_acl_applied_lc_index), index2);
 988
 989   applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, lc_index);
 990
 991   for(i=0; i < vec_len((*applied_hash_aces)); i++) {
 992     if (vec_elt_at_index(*applied_hash_aces,i)->acl_index == acl_index) {
 993       DBG("Found applied ACL#%d at applied index %d", acl_index, i);
 994       break;
 995     }
 996   }
 997   if (vec_len((*applied_hash_aces)) <= i) {
 998     DBG("Did not find applied ACL#%d at lc_index %d", acl_index, lc_index);
 999     /* we went all the way without finding any entries. Probably a list was empty. */
1000     return;
1001   }
1002
1003   void *oldheap = hash_acl_set_heap(am);
1004   int base_offset = i;
1005   int tail_offset = base_offset + vec_len(ha->rules);
1006   int tail_len = vec_len((*applied_hash_aces)) - tail_offset;
1007   DBG("base_offset: %d, tail_offset: %d, tail_len: %d", base_offset, tail_offset, tail_len);
1008
1009   for(i=0; i < vec_len(ha->rules); i ++) {
1010     deactivate_applied_ace_hash_entry(am, lc_index,
1011                                       applied_hash_aces, base_offset + i);
1012   }
1013   for(i=0; i < tail_len; i ++) {
1014     /* move the entry at tail offset to base offset */
1015     /* that is, from (tail_offset+i) -> (base_offset+i) */
1016     DBG0("UNAPPLY MOVE: lc_index %d, applied index %d -> %d", lc_index, tail_offset+i, base_offset + i);
1017     move_applied_ace_hash_entry(am, lc_index, applied_hash_aces, tail_offset + i, base_offset + i);
1018   }
1019   /* trim the end of the vector */
1020   _vec_len((*applied_hash_aces)) -= vec_len(ha->rules);
1021
1022   remake_hash_applied_mask_info_vec(am, applied_hash_aces, lc_index);
1023
1024   if (vec_len((*applied_hash_aces)) == 0) {
1025     vec_free((*applied_hash_aces));
1026   }
1027
1028   clib_mem_set_heap (oldheap);
1029 }
1030
1031 /*
1032  * Create the applied ACEs and update the hash table,
1033  * taking into account that the ACL may not be the last
1034  * in the vector of applied ACLs.
1035  *
1036  * For now, walk from the end of the vector and unapply the ACLs,
1037  * then apply the one in question and reapply the rest.
1038  */
1039
1040 void
1041 hash_acl_reapply(acl_main_t *am, u32 lc_index, int acl_index)
1042 {
1043   acl_lookup_context_t *acontext = pool_elt_at_index(am->acl_lookup_contexts, lc_index);
1044   u32 **applied_acls = &acontext->acl_indices;
1045   int i;
1046   int start_index = vec_search((*applied_acls), acl_index);
1047
1048   DBG0("Start index for acl %d in lc_index %d is %d", acl_index, lc_index, start_index);
1049   /*
1050    * This function is called after we find out the lc_index where ACL is applied.
1051    * If the by-lc_index vector does not have the ACL#, then it's a bug.
1052    */
1053   ASSERT(start_index < vec_len(*applied_acls));
1054
1055   /* unapply all the ACLs at the tail side, up to the current one */
1056   for(i = vec_len(*applied_acls) - 1; i > start_index; i--) {
1057     hash_acl_unapply(am, lc_index, *vec_elt_at_index(*applied_acls, i));
1058   }
1059   for(i = start_index; i < vec_len(*applied_acls); i++) {
1060     hash_acl_apply(am, lc_index, *vec_elt_at_index(*applied_acls, i), i);
1061   }
1062 }
1063
1064 static void
1065 make_ip6_address_mask(ip6_address_t *addr, u8 prefix_len)
1066 {
1067   ip6_address_mask_from_width(addr, prefix_len);
1068 }
1069
1070
1071 /* Maybe should be moved into the core somewhere */
1072 always_inline void
1073 ip4_address_mask_from_width (ip4_address_t * a, u32 width)
1074 {
1075   int i, byte, bit, bitnum;
1076   ASSERT (width <= 32);
1077   clib_memset (a, 0, sizeof (a[0]));
1078   for (i = 0; i < width; i++)
1079     {
1080       bitnum = (7 - (i & 7));
1081       byte = i / 8;
1082       bit = 1 << bitnum;
1083       a->as_u8[byte] |= bit;
1084     }
1085 }
1086
1087
1088 static void
1089 make_ip4_address_mask(ip4_address_t *addr, u8 prefix_len)
1090 {
1091   ip4_address_mask_from_width(addr, prefix_len);
1092 }
1093
1094 static void
1095 make_port_mask(u16 *portmask, u16 port_first, u16 port_last)
1096 {
1097   if (port_first == port_last) {
1098     *portmask = 0xffff;
1099     /* single port is representable by masked value */
1100     return;
1101   }
1102
1103   *portmask = 0;
1104   return;
1105 }
1106
1107 static void
1108 make_mask_and_match_from_rule(fa_5tuple_t *mask, acl_rule_t *r, hash_ace_info_t *hi)
1109 {
1110   clib_memset(mask, 0, sizeof(*mask));
1111   clib_memset(&hi->match, 0, sizeof(hi->match));
1112   hi->action = r->is_permit;
1113
1114   /* we will need to be matching based on lc_index and mask_type_index when applied */
1115   mask->pkt.lc_index = ~0;
1116   /* we will assign the match of mask_type_index later when we find it*/
1117   mask->pkt.mask_type_index_lsb = ~0;
1118
1119   mask->pkt.is_ip6 = 1;
1120   hi->match.pkt.is_ip6 = r->is_ipv6;
1121   if (r->is_ipv6) {
1122     make_ip6_address_mask(&mask->ip6_addr[0], r->src_prefixlen);
1123     hi->match.ip6_addr[0] = r->src.ip6;
1124     make_ip6_address_mask(&mask->ip6_addr[1], r->dst_prefixlen);
1125     hi->match.ip6_addr[1] = r->dst.ip6;
1126   } else {
1127     clib_memset(hi->match.l3_zero_pad, 0, sizeof(hi->match.l3_zero_pad));
1128     make_ip4_address_mask(&mask->ip4_addr[0], r->src_prefixlen);
1129     hi->match.ip4_addr[0] = r->src.ip4;
1130     make_ip4_address_mask(&mask->ip4_addr[1], r->dst_prefixlen);
1131     hi->match.ip4_addr[1] = r->dst.ip4;
1132   }
1133
1134   if (r->proto != 0) {
1135     mask->l4.proto = ~0; /* L4 proto needs to be matched */
1136     hi->match.l4.proto = r->proto;
1137
1138     /* Calculate the src/dst port masks and make the src/dst port matches accordingly */
1139     make_port_mask(&mask->l4.port[0], r->src_port_or_type_first, r->src_port_or_type_last);
1140     hi->match.l4.port[0] = r->src_port_or_type_first & mask->l4.port[0];
1141
1142     make_port_mask(&mask->l4.port[1], r->dst_port_or_code_first, r->dst_port_or_code_last);
1143     hi->match.l4.port[1] = r->dst_port_or_code_first & mask->l4.port[1];
1144     /* L4 info must be valid in order to match */
1145     mask->pkt.l4_valid = 1;
1146     hi->match.pkt.l4_valid = 1;
1147     /* And we must set the mask to check that it is an initial fragment */
1148     mask->pkt.is_nonfirst_fragment = 1;
1149     hi->match.pkt.is_nonfirst_fragment = 0;
1150     if ((r->proto == IPPROTO_TCP) && (r->tcp_flags_mask != 0)) {
1151       /* if we want to match on TCP flags, they must be masked off as well */
1152       mask->pkt.tcp_flags = r->tcp_flags_mask;
1153       hi->match.pkt.tcp_flags = r->tcp_flags_value;
1154       /* and the flags need to be present within the packet being matched */
1155       mask->pkt.tcp_flags_valid = 1;
1156       hi->match.pkt.tcp_flags_valid = 1;
1157     }
1158   }
1159   /* Sanitize the mask and the match */
1160   u64 *pmask = (u64 *)mask;
1161   u64 *pmatch = (u64 *)&hi->match;
1162   int j;
1163   for(j=0; j<6; j++) {
1164     pmatch[j] = pmatch[j] & pmask[j];
1165   }
1166 }
1167
1168
1169 int hash_acl_exists(acl_main_t *am, int acl_index)
1170 {
1171   if (acl_index >= vec_len(am->hash_acl_infos))
1172     return 0;
1173
1174   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
1175   return ha->hash_acl_exists;
1176 }
1177
1178 void hash_acl_add(acl_main_t *am, int acl_index)
1179 {
1180   void *oldheap = hash_acl_set_heap(am);
1181   DBG("HASH ACL add : %d", acl_index);
1182   int i;
1183   acl_list_t *a = &am->acls[acl_index];
1184   vec_validate(am->hash_acl_infos, acl_index);
1185   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
1186   clib_memset(ha, 0, sizeof(*ha));
1187   ha->hash_acl_exists = 1;
1188
1189   /* walk the newly added ACL entries and ensure that for each of them there
1190      is a mask type, increment a reference count for that mask type */
1191
1192   /* avoid small requests by preallocating the entire vector before running the additions */
1193   vec_validate(ha->rules, a->count-1);
1194   vec_reset_length(ha->rules);
1195
1196   for(i=0; i < a->count; i++) {
1197     hash_ace_info_t ace_info;
1198     fa_5tuple_t mask;
1199     clib_memset(&ace_info, 0, sizeof(ace_info));
1200     ace_info.acl_index = acl_index;
1201     ace_info.ace_index = i;
1202
1203     make_mask_and_match_from_rule(&mask, &a->rules[i], &ace_info);
1204     mask.pkt.flags_reserved = 0b000;
1205     ace_info.base_mask_type_index = assign_mask_type_index(am, &mask);
1206     /* assign the mask type index for matching itself */
1207     ace_info.match.pkt.mask_type_index_lsb = ace_info.base_mask_type_index;
1208     DBG("ACE: %d mask_type_index: %d", i, ace_info.base_mask_type_index);
1209     vec_add1(ha->rules, ace_info);
1210   }
1211   /*
1212    * if an ACL is applied somewhere, fill the corresponding lookup data structures.
1213    * We need to take care if the ACL is not the last one in the vector of ACLs applied to the interface.
1214    */
1215   if (acl_index < vec_len(am->lc_index_vec_by_acl)) {
1216     u32 *lc_index;
1217     vec_foreach(lc_index, am->lc_index_vec_by_acl[acl_index]) {
1218       hash_acl_reapply(am, *lc_index, acl_index);
1219     }
1220   }
1221   clib_mem_set_heap (oldheap);
1222 }
1223
1224 void hash_acl_delete(acl_main_t *am, int acl_index)
1225 {
1226   void *oldheap = hash_acl_set_heap(am);
1227   DBG0("HASH ACL delete : %d", acl_index);
1228   /*
1229    * If the ACL is applied somewhere, remove the references of it (call hash_acl_unapply)
1230    * this is a different behavior from the linear lookup where an empty ACL is "deny all",
1231    *
1232    * However, following vpp-dev discussion the ACL that is referenced elsewhere
1233    * should not be possible to delete, and the change adding this also adds
1234    * the safeguards to that respect, so this is not a problem.
1235    *
1236    * The part to remember is that this routine is called in process of reapplication
1237    * during the acl_add_replace() API call - the old acl ruleset is deleted, then
1238    * the new one is added, without the change in the applied ACLs - so this case
1239    * has to be handled.
1240    */
1241   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
1242   u32 *lc_list_copy = 0;
1243   {
1244     u32 *lc_index;
1245     lc_list_copy = vec_dup(ha->lc_index_list);
1246     vec_foreach(lc_index, lc_list_copy) {
1247       hash_acl_unapply(am, *lc_index, acl_index);
1248     }
1249     vec_free(lc_list_copy);
1250   }
1251   vec_free(ha->lc_index_list);
1252
1253   /* walk the mask types for the ACL about-to-be-deleted, and decrease
1254    * the reference count, possibly freeing up some of them */
1255   int i;
1256   for(i=0; i < vec_len(ha->rules); i++) {
1257     release_mask_type_index(am, ha->rules[i].base_mask_type_index);
1258   }
1259   ha->hash_acl_exists = 0;
1260   vec_free(ha->rules);
1261   clib_mem_set_heap (oldheap);
1262 }
1263
1264
1265 void
1266 show_hash_acl_hash (vlib_main_t * vm, acl_main_t *am, u32 verbose)
1267 {
1268   vlib_cli_output(vm, "\nACL lookup hash table:\n%U\n",
1269                   BV (format_bihash), &am->acl_lookup_hash, verbose);
1270 }
1271
1272 void
1273 acl_plugin_show_tables_mask_type (void)
1274 {
1275   acl_main_t *am = &acl_main;
1276   vlib_main_t *vm = am->vlib_main;
1277   ace_mask_type_entry_t *mte;
1278
1279   vlib_cli_output (vm, "Mask-type entries:");
1280     /* *INDENT-OFF* */
1281     pool_foreach(mte, am->ace_mask_type_pool,
1282     ({
1283       vlib_cli_output(vm, "     %3d: %016llx %016llx %016llx %016llx %016llx %016llx  refcount %d",
1284                     mte - am->ace_mask_type_pool,
1285                     mte->mask.kv_40_8.key[0], mte->mask.kv_40_8.key[1], mte->mask.kv_40_8.key[2],
1286                     mte->mask.kv_40_8.key[3], mte->mask.kv_40_8.key[4], mte->mask.kv_40_8.value, mte->refcount);
1287     }));
1288     /* *INDENT-ON* */
1289 }
1290
1291 void
1292 acl_plugin_show_tables_acl_hash_info (u32 acl_index)
1293 {
1294   acl_main_t *am = &acl_main;
1295   vlib_main_t *vm = am->vlib_main;
1296   u32 i, j;
1297   u64 *m;
1298   vlib_cli_output (vm, "Mask-ready ACL representations\n");
1299   for (i = 0; i < vec_len (am->hash_acl_infos); i++)
1300     {
1301       if ((acl_index != ~0) && (acl_index != i))
1302         {
1303           continue;
1304         }
1305       hash_acl_info_t *ha = &am->hash_acl_infos[i];
1306       vlib_cli_output (vm, "acl-index %u bitmask-ready layout\n", i);
1307       vlib_cli_output (vm, "  applied lc_index list: %U\n",
1308                        format_vec32, ha->lc_index_list, "%d");
1309       for (j = 0; j < vec_len (ha->rules); j++)
1310         {
1311           hash_ace_info_t *pa = &ha->rules[j];
1312           m = (u64 *) & pa->match;
1313           vlib_cli_output (vm,
1314                            "    %4d: %016llx %016llx %016llx %016llx %016llx %016llx base mask index %d acl %d rule %d action %d\n",
1315                            j, m[0], m[1], m[2], m[3], m[4], m[5],
1316                            pa->base_mask_type_index, pa->acl_index, pa->ace_index,
1317                            pa->action);
1318         }
1319     }
1320 }
1321
1322 static void
1323 acl_plugin_print_colliding_rule (vlib_main_t * vm, int j, collision_match_rule_t *cr) {
1324   vlib_cli_output(vm,
1325                   "        %4d: acl %d ace %d acl pos %d pae index: %d",
1326                   j, cr->acl_index, cr->ace_index, cr->acl_position, cr->applied_entry_index);
1327 }
1328
1329 static void
1330 acl_plugin_print_pae (vlib_main_t * vm, int j, applied_hash_ace_entry_t * pae)
1331 {
1332   vlib_cli_output (vm,
1333                    "    %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",
1334                    j, pae->acl_index, pae->ace_index, pae->action,
1335                    pae->hash_ace_info_index, pae->mask_type_index, vec_len(pae->colliding_rules), pae->next_applied_entry_index,
1336                    pae->prev_applied_entry_index,
1337                    pae->tail_applied_entry_index, pae->hitcount, pae->acl_position);
1338   int jj;
1339   for(jj=0; jj<vec_len(pae->colliding_rules); jj++)
1340     acl_plugin_print_colliding_rule(vm, jj, vec_elt_at_index(pae->colliding_rules, jj));
1341 }
1342
1343 static void
1344 acl_plugin_print_applied_mask_info (vlib_main_t * vm, int j, hash_applied_mask_info_t *mi)
1345 {
1346   vlib_cli_output (vm,
1347                    "    %4d: mask type index %d first rule index %d num_entries %d max_collisions %d",
1348                    j, mi->mask_type_index, mi->first_rule_index, mi->num_entries, mi->max_collisions);
1349 }
1350
1351 void
1352 acl_plugin_show_tables_applied_info (u32 lc_index)
1353 {
1354   acl_main_t *am = &acl_main;
1355   vlib_main_t *vm = am->vlib_main;
1356   u32 lci, j;
1357   vlib_cli_output (vm, "Applied lookup entries for lookup contexts");
1358
1359   for (lci = 0;
1360        (lci < vec_len(am->applied_hash_acl_info_by_lc_index)); lci++)
1361     {
1362       if ((lc_index != ~0) && (lc_index != lci))
1363         {
1364           continue;
1365         }
1366       vlib_cli_output (vm, "lc_index %d:", lci);
1367       if (lci < vec_len (am->applied_hash_acl_info_by_lc_index))
1368         {
1369           applied_hash_acl_info_t *pal =
1370             &am->applied_hash_acl_info_by_lc_index[lci];
1371           vlib_cli_output (vm, "  applied acls: %U", format_vec32,
1372                            pal->applied_acls, "%d");
1373         }
1374       if (lci < vec_len (am->hash_applied_mask_info_vec_by_lc_index))
1375         {
1376           vlib_cli_output (vm, "  applied mask info entries:");
1377           for (j = 0;
1378                j < vec_len (am->hash_applied_mask_info_vec_by_lc_index[lci]);
1379                j++)
1380             {
1381               acl_plugin_print_applied_mask_info (vm, j,
1382                                     &am->hash_applied_mask_info_vec_by_lc_index
1383                                     [lci][j]);
1384             }
1385         }
1386       if (lci < vec_len (am->hash_entry_vec_by_lc_index))
1387         {
1388           vlib_cli_output (vm, "  lookup applied entries:");
1389           for (j = 0;
1390                j < vec_len (am->hash_entry_vec_by_lc_index[lci]);
1391                j++)
1392             {
1393               acl_plugin_print_pae (vm, j,
1394                                     &am->hash_entry_vec_by_lc_index
1395                                     [lci][j]);
1396             }
1397         }
1398     }
1399 }
1400
1401 void
1402 acl_plugin_show_tables_bihash (u32 show_bihash_verbose)
1403 {
1404   acl_main_t *am = &acl_main;
1405   vlib_main_t *vm = am->vlib_main;
1406   show_hash_acl_hash (vm, am, show_bihash_verbose);
1407 }
1408
1409 /*
1410  * Split of the partition needs to happen when the collision count
1411  * goes over a specified threshold.
1412  *
1413  * This is a signal that we ignored too many bits in
1414  * mT and we need to split the table into two tables. We select
1415  * all of the colliding rules L and find their maximum common
1416  * tuple mL. Normally mL is specific enough to hash L with few
1417  * or no collisions. We then create a new table T2 with tuple mL
1418  * and transfer all compatible rules from T to T2. If mL is not
1419  * specific enough, we find the field with the biggest difference
1420  * between the minimum and maximum tuple lengths for all of
1421  * the rules in L and set that field to be the average of those two
1422  * values. We then transfer all compatible rules as before. This
1423  * guarantees that some rules from L will move and that T2 will
1424  * have a smaller number of collisions than T did.
1425  */
1426
1427
1428 static void
1429 ensure_ip6_min_addr (ip6_address_t * min_addr, ip6_address_t * mask_addr)
1430 {
1431   int update =
1432     (clib_net_to_host_u64 (mask_addr->as_u64[0]) <
1433      clib_net_to_host_u64 (min_addr->as_u64[0]))
1434     ||
1435     ((clib_net_to_host_u64 (mask_addr->as_u64[0]) ==
1436       clib_net_to_host_u64 (min_addr->as_u64[0]))
1437      && (clib_net_to_host_u64 (mask_addr->as_u64[1]) <
1438          clib_net_to_host_u64 (min_addr->as_u64[1])));
1439   if (update)
1440     {
1441       min_addr->as_u64[0] = mask_addr->as_u64[0];
1442       min_addr->as_u64[1] = mask_addr->as_u64[1];
1443     }
1444 }
1445
1446 static void
1447 ensure_ip6_max_addr (ip6_address_t * max_addr, ip6_address_t * mask_addr)
1448 {
1449   int update =
1450     (clib_net_to_host_u64 (mask_addr->as_u64[0]) >
1451      clib_net_to_host_u64 (max_addr->as_u64[0]))
1452     ||
1453     ((clib_net_to_host_u64 (mask_addr->as_u64[0]) ==
1454       clib_net_to_host_u64 (max_addr->as_u64[0]))
1455      && (clib_net_to_host_u64 (mask_addr->as_u64[1]) >
1456          clib_net_to_host_u64 (max_addr->as_u64[1])));
1457   if (update)
1458     {
1459       max_addr->as_u64[0] = mask_addr->as_u64[0];
1460       max_addr->as_u64[1] = mask_addr->as_u64[1];
1461     }
1462 }
1463
1464 static void
1465 ensure_ip4_min_addr (ip4_address_t * min_addr, ip4_address_t * mask_addr)
1466 {
1467   int update =
1468     (clib_net_to_host_u32 (mask_addr->as_u32) <
1469      clib_net_to_host_u32 (min_addr->as_u32));
1470   if (update)
1471     min_addr->as_u32 = mask_addr->as_u32;
1472 }
1473
1474 static void
1475 ensure_ip4_max_addr (ip4_address_t * max_addr, ip4_address_t * mask_addr)
1476 {
1477   int update =
1478     (clib_net_to_host_u32 (mask_addr->as_u32) >
1479      clib_net_to_host_u32 (max_addr->as_u32));
1480   if (update)
1481     max_addr->as_u32 = mask_addr->as_u32;
1482 }
1483
1484 enum {
1485   DIM_SRC_ADDR = 0,
1486   DIM_DST_ADDR,
1487   DIM_SRC_PORT,
1488   DIM_DST_PORT,
1489   DIM_PROTO,
1490 };
1491
1492
1493
1494 static void
1495 split_partition(acl_main_t *am, u32 first_index,
1496                             u32 lc_index, int is_ip6){
1497         DBG( "TM-split_partition - first_entry:%d", first_index);
1498         applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, lc_index);
1499         ace_mask_type_entry_t *mte;
1500         fa_5tuple_t the_min_tuple, *min_tuple = &the_min_tuple;
1501         fa_5tuple_t the_max_tuple, *max_tuple = &the_max_tuple;
1502         applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), first_index);
1503         hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, pae->acl_index);
1504         hash_ace_info_t *ace_info;
1505         u32 coll_mask_type_index = pae->mask_type_index;
1506         clib_memset(&the_min_tuple, 0, sizeof(the_min_tuple));
1507         clib_memset(&the_max_tuple, 0, sizeof(the_max_tuple));
1508
1509         int i=0;
1510         u64 collisions = vec_len(pae->colliding_rules);
1511         for(i=0; i<collisions; i++){
1512                 /* reload the hash acl info as it might be a different ACL# */
1513                 ha = vec_elt_at_index(am->hash_acl_infos, pae->acl_index);
1514
1515                 DBG( "TM-collision: base_ace:%d (ace_mask:%d, first_collision_mask:%d)",
1516                                 pae->ace_index, pae->mask_type_index, coll_mask_type_index);
1517
1518                 ace_info = vec_elt_at_index(ha->rules, pae->hash_ace_info_index);
1519                 mte = vec_elt_at_index(am->ace_mask_type_pool, ace_info->base_mask_type_index);
1520                 fa_5tuple_t *mask = &mte->mask;
1521
1522                 if(pae->mask_type_index != coll_mask_type_index) continue;
1523                 /* Computing min_mask and max_mask for colliding rules */
1524                 if(i==0){
1525                         clib_memcpy_fast(min_tuple, mask, sizeof(fa_5tuple_t));
1526                         clib_memcpy_fast(max_tuple, mask, sizeof(fa_5tuple_t));
1527                 }else{
1528                         int j;
1529                         for(j=0; j<2; j++){
1530                                 if (is_ip6)
1531                                   ensure_ip6_min_addr(&min_tuple->ip6_addr[j], &mask->ip6_addr[j]);
1532                                 else
1533                                   ensure_ip4_min_addr(&min_tuple->ip4_addr[j], &mask->ip4_addr[j]);
1534
1535                                 if ((mask->l4.port[j] < min_tuple->l4.port[j]))
1536                                         min_tuple->l4.port[j] = mask->l4.port[j];
1537                         }
1538
1539                         if ((mask->l4.proto < min_tuple->l4.proto))
1540                                 min_tuple->l4.proto = mask->l4.proto;
1541
1542                         if(mask->pkt.as_u64 < min_tuple->pkt.as_u64)
1543                                 min_tuple->pkt.as_u64 = mask->pkt.as_u64;
1544
1545
1546                         for(j=0; j<2; j++){
1547                                 if (is_ip6)
1548                                   ensure_ip6_max_addr(&max_tuple->ip6_addr[j], &mask->ip6_addr[j]);
1549                                 else
1550                                   ensure_ip4_max_addr(&max_tuple->ip4_addr[j], &mask->ip4_addr[j]);
1551
1552                                 if ((mask->l4.port[j] > max_tuple->l4.port[j]))
1553                                         max_tuple->l4.port[j] = mask->l4.port[j];
1554                         }
1555
1556                         if ((mask->l4.proto < max_tuple->l4.proto))
1557                                 max_tuple->l4.proto = mask->l4.proto;
1558
1559                         if(mask->pkt.as_u64 > max_tuple->pkt.as_u64)
1560                                 max_tuple->pkt.as_u64 = mask->pkt.as_u64;
1561                 }
1562
1563                 pae = pae->next_applied_entry_index == ~0 ? 0 : vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
1564         }
1565
1566         /* Computing field with max difference between (min/max)_mask */
1567         int best_dim=-1, best_delta=0, delta=0;
1568
1569         /* SRC_addr dimension */
1570         if (is_ip6) {
1571           int i;
1572           for(i=0; i<2; i++){
1573                 delta += count_bits(max_tuple->ip6_addr[0].as_u64[i]) - count_bits(min_tuple->ip6_addr[0].as_u64[i]);
1574           }
1575         } else {
1576                 delta += count_bits(max_tuple->ip4_addr[0].as_u32) - count_bits(min_tuple->ip4_addr[0].as_u32);
1577         }
1578         if(delta > best_delta){
1579                 best_delta = delta;
1580                 best_dim = DIM_SRC_ADDR;
1581         }
1582
1583         /* DST_addr dimension */
1584         delta = 0;
1585         if (is_ip6) {
1586           int i;
1587           for(i=0; i<2; i++){
1588                 delta += count_bits(max_tuple->ip6_addr[1].as_u64[i]) - count_bits(min_tuple->ip6_addr[1].as_u64[i]);
1589           }
1590         } else {
1591                 delta += count_bits(max_tuple->ip4_addr[1].as_u32) - count_bits(min_tuple->ip4_addr[1].as_u32);
1592         }
1593         if(delta > best_delta){
1594                 best_delta = delta;
1595                 best_dim = DIM_DST_ADDR;
1596         }
1597
1598         /* SRC_port dimension */
1599         delta = count_bits(max_tuple->l4.port[0]) - count_bits(min_tuple->l4.port[0]);
1600         if(delta > best_delta){
1601                 best_delta = delta;
1602                 best_dim = DIM_SRC_PORT;
1603         }
1604
1605         /* DST_port dimension */
1606         delta = count_bits(max_tuple->l4.port[1]) - count_bits(min_tuple->l4.port[1]);
1607         if(delta > best_delta){
1608                 best_delta = delta;
1609                 best_dim = DIM_DST_PORT;
1610         }
1611
1612         /* Proto dimension */
1613         delta = count_bits(max_tuple->l4.proto) - count_bits(min_tuple->l4.proto);
1614         if(delta > best_delta){
1615                 best_delta = delta;
1616                 best_dim = DIM_PROTO;
1617         }
1618
1619         int shifting = 0; //, ipv4_block = 0;
1620         switch(best_dim){
1621                 case DIM_SRC_ADDR:
1622                         shifting = (best_delta)/2; // FIXME IPV4-only
1623                         // ipv4_block = count_bits(max_tuple->ip4_addr[0].as_u32);
1624                         min_tuple->ip4_addr[0].as_u32 =
1625                                         clib_host_to_net_u32((clib_net_to_host_u32(max_tuple->ip4_addr[0].as_u32) << (shifting))&0xFFFFFFFF);
1626
1627                         break;
1628                 case DIM_DST_ADDR:
1629                         shifting = (best_delta)/2;
1630 /*
1631                         ipv4_block = count_bits(max_tuple->addr[1].as_u64[1]);
1632                         if(ipv4_block > shifting)
1633                                 min_tuple->addr[1].as_u64[1] =
1634                                         clib_host_to_net_u64((clib_net_to_host_u64(max_tuple->addr[1].as_u64[1]) << (shifting))&0xFFFFFFFF);
1635                         else{
1636                                 shifting = shifting - ipv4_block;
1637                                 min_tuple->addr[1].as_u64[1] = 0;
1638                                 min_tuple->addr[1].as_u64[0] =
1639                                         clib_host_to_net_u64((clib_net_to_host_u64(max_tuple->addr[1].as_u64[0]) << (shifting))&0xFFFFFFFF);
1640                         }
1641 */
1642                         min_tuple->ip4_addr[1].as_u32 =
1643                                         clib_host_to_net_u32((clib_net_to_host_u32(max_tuple->ip4_addr[1].as_u32) << (shifting))&0xFFFFFFFF);
1644
1645                         break;
1646                 case DIM_SRC_PORT: min_tuple->l4.port[0] = max_tuple->l4.port[0]  << (best_delta)/2;
1647                         break;
1648                 case DIM_DST_PORT: min_tuple->l4.port[1] = max_tuple->l4.port[1] << (best_delta)/2;
1649                         break;
1650                 case DIM_PROTO: min_tuple->l4.proto = max_tuple->l4.proto << (best_delta)/2;
1651                         break;
1652                 default: relax_tuple(min_tuple, is_ip6, 1);
1653                         break;
1654         }
1655
1656         min_tuple->pkt.is_nonfirst_fragment = 0;
1657         u32 new_mask_type_index = assign_mask_type_index(am, min_tuple);
1658
1659         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);
1660
1661         hash_applied_mask_info_t *minfo;
1662         //search in order pool if mask_type_index is already there
1663         int search;
1664         for (search=0; search < vec_len((*hash_applied_mask_info_vec)); search++){
1665                 minfo = vec_elt_at_index((*hash_applied_mask_info_vec), search);
1666                 if(minfo->mask_type_index == new_mask_type_index)
1667                         break;
1668         }
1669
1670         vec_validate((*hash_applied_mask_info_vec), search);
1671         minfo = vec_elt_at_index((*hash_applied_mask_info_vec), search);
1672         minfo->mask_type_index = new_mask_type_index;
1673         minfo->num_entries = 0;
1674         minfo->max_collisions = 0;
1675         minfo->first_rule_index = ~0;
1676
1677         DBG( "TM-split_partition - mask type index-assigned!! -> %d", new_mask_type_index);
1678
1679         if(coll_mask_type_index == new_mask_type_index){
1680                 //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);
1681                 return;
1682         }
1683
1684
1685         /* populate new partition */
1686         DBG( "TM-Populate new partition");
1687         u32 r_ace_index = first_index;
1688         int repopulate_count = 0;
1689
1690 //      for(i=0; i<collisions; i++){
1691         for(r_ace_index=0; r_ace_index < vec_len((*applied_hash_aces)); r_ace_index++) {
1692
1693                 applied_hash_ace_entry_t *pop_pae = vec_elt_at_index((*applied_hash_aces), r_ace_index);
1694                 DBG( "TM-Population-collision: base_ace:%d (ace_mask:%d, first_collision_mask:%d)",
1695                                 pop_pae->ace_index, pop_pae->mask_type_index, coll_mask_type_index);
1696
1697                 if(pop_pae->mask_type_index != coll_mask_type_index) continue;
1698                 u32 next_index = pop_pae->next_applied_entry_index;
1699
1700                 ace_info = vec_elt_at_index(ha->rules, pop_pae->hash_ace_info_index);
1701                 mte = vec_elt_at_index(am->ace_mask_type_pool, ace_info->base_mask_type_index);
1702                 //can insert rule?
1703                 //mte = vec_elt_at_index(am->ace_mask_type_pool, pop_pae->mask_type_index);
1704                 fa_5tuple_t *pop_mask = &mte->mask;
1705
1706                 if(!first_mask_contains_second_mask(is_ip6, min_tuple, pop_mask)) continue;
1707                 DBG( "TM-new partition can insert -> applied_ace:%d", r_ace_index);
1708
1709                 //delete and insert in new format
1710                 deactivate_applied_ace_hash_entry(am, lc_index, applied_hash_aces, r_ace_index);
1711
1712                 /* insert the new entry */
1713                 pop_pae->mask_type_index = new_mask_type_index;
1714                 /* The very first repopulation gets the lock by virtue of a new mask being created above */
1715                 if (++repopulate_count > 1)
1716                   lock_mask_type_index(am, new_mask_type_index);
1717
1718                 activate_applied_ace_hash_entry(am, lc_index, applied_hash_aces, r_ace_index);
1719
1720                 r_ace_index = next_index;
1721         }
1722
1723         DBG( "TM-Populate new partition-END");
1724         DBG( "TM-split_partition - END");
1725
1726 }
1727