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