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 #include <vlibsocket/api.h>
  24
  25 #include <vlib/vlib.h>
  26 #include <vnet/vnet.h>
  27 #include <vnet/pg/pg.h>
  28 #include <vppinfra/error.h>
  29 #include <vnet/plugin/plugin.h>
  30 #include <acl/acl.h>
  31 #include <vppinfra/bihash_48_8.h>
  32
  33 #include "hash_lookup.h"
  34 #include "hash_lookup_private.h"
  35
  36
  37 static inline applied_hash_ace_entry_t **get_applied_hash_aces(acl_main_t *am, int is_input, u32 sw_if_index)
  38 {
  39   applied_hash_ace_entry_t **applied_hash_aces = is_input ? vec_elt_at_index(am->input_hash_entry_vec_by_sw_if_index, sw_if_index)
  40                                                           : vec_elt_at_index(am->output_hash_entry_vec_by_sw_if_index, sw_if_index);
  41   return applied_hash_aces;
  42 }
  43
  44
  45
  46 /*
  47  * This returns true if there is indeed a match on the portranges.
  48  * With all these levels of indirections, this is not going to be very fast,
  49  * so, best use the individual ports or wildcard ports for performance.
  50  */
  51 static int
  52 match_portranges(acl_main_t *am, fa_5tuple_t *match, u32 index)
  53 {
  54
  55   applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, match->pkt.is_input, match->pkt.sw_if_index);
  56   applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), index);
  57
  58   acl_rule_t *r = &(am->acls[pae->acl_index].rules[pae->ace_index]);
  59   DBG("PORTMATCH: %d <= %d <= %d && %d <= %d <= %d ?",
  60                 r->src_port_or_type_first, match->l4.port[0], r->src_port_or_type_last,
  61                 r->dst_port_or_code_first, match->l4.port[1], r->dst_port_or_code_last);
  62
  63   return ( ((r->src_port_or_type_first <= match->l4.port[0]) && r->src_port_or_type_last >= match->l4.port[0]) &&
  64            ((r->dst_port_or_code_first <= match->l4.port[1]) && r->dst_port_or_code_last >= match->l4.port[1]) );
  65 }
  66
  67 static u32
  68 multi_acl_match_get_applied_ace_index(acl_main_t *am, fa_5tuple_t *match)
  69 {
  70   clib_bihash_kv_48_8_t kv;
  71   clib_bihash_kv_48_8_t result;
  72   fa_5tuple_t *kv_key = (fa_5tuple_t *)kv.key;
  73   hash_acl_lookup_value_t *result_val = (hash_acl_lookup_value_t *)&result.value;
  74   u64 *pmatch = (u64 *)match;
  75   u64 *pmask;
  76   u64 *pkey;
  77   int mask_type_index;
  78   u32 curr_match_index = ~0;
  79
  80   u32 sw_if_index = match->pkt.sw_if_index;
  81   u8 is_input = match->pkt.is_input;
  82   applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, is_input, sw_if_index);
  83   applied_hash_acl_info_t **applied_hash_acls = is_input ? &am->input_applied_hash_acl_info_by_sw_if_index :
  84                                                     &am->output_applied_hash_acl_info_by_sw_if_index;
  85
  86   DBG("TRYING TO MATCH: %016llx %016llx %016llx %016llx %016llx %016llx",
  87                pmatch[0], pmatch[1], pmatch[2], pmatch[3], pmatch[4], pmatch[5]);
  88
  89   for(mask_type_index=0; mask_type_index < pool_len(am->ace_mask_type_pool); mask_type_index++) {
  90     if (!clib_bitmap_get(vec_elt_at_index((*applied_hash_acls), sw_if_index)->mask_type_index_bitmap, mask_type_index)) {
  91       /* This bit is not set. Avoid trying to match */
  92       continue;
  93     }
  94     ace_mask_type_entry_t *mte = vec_elt_at_index(am->ace_mask_type_pool, mask_type_index);
  95     pmatch = (u64 *)match;
  96     pmask = (u64 *)&mte->mask;
  97     pkey = (u64 *)kv.key;
  98     /*
  99     * unrolling the below loop results in a noticeable performance increase.
 100     int i;
 101     for(i=0; i<6; i++) {
 102       kv.key[i] = pmatch[i] & pmask[i];
 103     }
 104     */
 105
 106     *pkey++ = *pmatch++ & *pmask++;
 107     *pkey++ = *pmatch++ & *pmask++;
 108     *pkey++ = *pmatch++ & *pmask++;
 109     *pkey++ = *pmatch++ & *pmask++;
 110     *pkey++ = *pmatch++ & *pmask++;
 111     *pkey++ = *pmatch++ & *pmask++;
 112
 113     kv_key->pkt.mask_type_index_lsb = mask_type_index;
 114     DBG("        KEY %3d: %016llx %016llx %016llx %016llx %016llx %016llx", mask_type_index,
 115                 kv.key[0], kv.key[1], kv.key[2], kv.key[3], kv.key[4], kv.key[5]);
 116     int res = BV (clib_bihash_search) (&am->acl_lookup_hash, &kv, &result);
 117     if (res == 0) {
 118       DBG("ACL-MATCH! result_val: %016llx", result_val->as_u64);
 119       if (result_val->applied_entry_index < curr_match_index) {
 120         if (PREDICT_FALSE(result_val->need_portrange_check)) {
 121           /*
 122            * This is going to be slow, since we can have multiple superset
 123            * entries for narrow-ish portranges, e.g.:
 124            * 0..42 100..400, 230..60000,
 125            * so we need to walk linearly and check if they match.
 126            */
 127
 128           u32 curr_index = result_val->applied_entry_index;
 129           while ((curr_index != ~0) && !match_portranges(am, match, curr_index)) {
 130             /* while no match and there are more entries, walk... */
 131             applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces),curr_index);
 132             DBG("entry %d did not portmatch, advancing to %d", curr_index, pae->next_applied_entry_index);
 133             curr_index = pae->next_applied_entry_index;
 134           }
 135           if (curr_index < curr_match_index) {
 136             DBG("The index %d is the new candidate in portrange matches.", curr_index);
 137             curr_match_index = result_val->applied_entry_index;
 138             if (!result_val->shadowed) {
 139               /* new result is known to not be shadowed, so no point to look up further */
 140               break;
 141             }
 142           } else {
 143             DBG("Curr portmatch index %d is too big vs. current matched one %d", curr_index, curr_match_index);
 144           }
 145         } else {
 146           /* The usual path is here. Found an entry in front of the current candiate - so it's a new one */
 147           DBG("This match is the new candidate");
 148           curr_match_index = result_val->applied_entry_index;
 149           if (!result_val->shadowed) {
 150           /* new result is known to not be shadowed, so no point to look up further */
 151             break;
 152           }
 153         }
 154       }
 155     }
 156   }
 157   DBG("MATCH-RESULT: %d", curr_match_index);
 158   return curr_match_index;
 159 }
 160
 161 static void
 162 hashtable_add_del(acl_main_t *am, clib_bihash_kv_48_8_t *kv, int is_add)
 163 {
 164     DBG("HASH ADD/DEL: %016llx %016llx %016llx %016llx %016llx %016llx %016llx add %d",
 165                         kv->key[0], kv->key[1], kv->key[2],
 166                         kv->key[3], kv->key[4], kv->key[5], kv->value, is_add);
 167     BV (clib_bihash_add_del) (&am->acl_lookup_hash, kv, is_add);
 168 }
 169
 170 static void
 171 fill_applied_hash_ace_kv(acl_main_t *am,
 172                             applied_hash_ace_entry_t **applied_hash_aces,
 173                             u32 sw_if_index, u8 is_input,
 174                             u32 new_index, clib_bihash_kv_48_8_t *kv)
 175 {
 176   fa_5tuple_t *kv_key = (fa_5tuple_t *)kv->key;
 177   hash_acl_lookup_value_t *kv_val = (hash_acl_lookup_value_t *)&kv->value;
 178   applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), new_index);
 179   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, pae->acl_index);
 180
 181   memcpy(kv_key, &(vec_elt_at_index(ha->rules, pae->hash_ace_info_index)->match), sizeof(*kv_key));
 182   /* initialize the sw_if_index and direction */
 183   kv_key->pkt.sw_if_index = sw_if_index;
 184   kv_key->pkt.is_input = is_input;
 185   kv_val->as_u64 = 0;
 186   kv_val->applied_entry_index = new_index;
 187   kv_val->need_portrange_check = vec_elt_at_index(ha->rules, pae->hash_ace_info_index)->src_portrange_not_powerof2 ||
 188                                    vec_elt_at_index(ha->rules, pae->hash_ace_info_index)->dst_portrange_not_powerof2;
 189   /* by default assume all values are shadowed -> check all mask types */
 190   kv_val->shadowed = 1;
 191 }
 192
 193 static void
 194 add_del_hashtable_entry(acl_main_t *am,
 195                             u32 sw_if_index, u8 is_input,
 196                             applied_hash_ace_entry_t **applied_hash_aces,
 197                             u32 index, int is_add)
 198 {
 199   clib_bihash_kv_48_8_t kv;
 200
 201   fill_applied_hash_ace_kv(am, applied_hash_aces, sw_if_index, is_input, index, &kv);
 202   hashtable_add_del(am, &kv, is_add);
 203 }
 204
 205
 206
 207 static void
 208 activate_applied_ace_hash_entry(acl_main_t *am,
 209                             u32 sw_if_index, u8 is_input,
 210                             applied_hash_ace_entry_t **applied_hash_aces,
 211                             u32 new_index)
 212 {
 213   clib_bihash_kv_48_8_t kv;
 214   ASSERT(new_index != ~0);
 215   applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), new_index);
 216   DBG("activate_applied_ace_hash_entry sw_if_index %d is_input %d new_index %d", sw_if_index, is_input, new_index);
 217
 218   fill_applied_hash_ace_kv(am, applied_hash_aces, sw_if_index, is_input, new_index, &kv);
 219
 220   DBG("APPLY ADD KY: %016llx %016llx %016llx %016llx %016llx %016llx",
 221                         kv.key[0], kv.key[1], kv.key[2],
 222                         kv.key[3], kv.key[4], kv.key[5]);
 223
 224   clib_bihash_kv_48_8_t result;
 225   hash_acl_lookup_value_t *result_val = (hash_acl_lookup_value_t *)&result.value;
 226   int res = BV (clib_bihash_search) (&am->acl_lookup_hash, &kv, &result);
 227   ASSERT(new_index != ~0);
 228   ASSERT(new_index < vec_len((*applied_hash_aces)));
 229   if (res == 0) {
 230     /* There already exists an entry or more. Append at the end. */
 231     u32 first_index = result_val->applied_entry_index;
 232     ASSERT(first_index != ~0);
 233     DBG("A key already exists, with applied entry index: %d", first_index);
 234     applied_hash_ace_entry_t *first_pae = vec_elt_at_index((*applied_hash_aces), first_index);
 235     u32 last_index = first_pae->tail_applied_entry_index;
 236     ASSERT(last_index != ~0);
 237     applied_hash_ace_entry_t *last_pae = vec_elt_at_index((*applied_hash_aces), last_index);
 238     DBG("...advance to chained entry index: %d", last_index);
 239     /* link ourseves in */
 240     last_pae->next_applied_entry_index = new_index;
 241     pae->prev_applied_entry_index = last_index;
 242     /* adjust the pointer to the new tail */
 243     first_pae->tail_applied_entry_index = new_index;
 244   } else {
 245     /* It's the very first entry */
 246     hashtable_add_del(am, &kv, 1);
 247     ASSERT(new_index != ~0);
 248     pae->tail_applied_entry_index = new_index;
 249   }
 250 }
 251
 252 static void
 253 applied_hash_entries_analyze(acl_main_t *am, applied_hash_ace_entry_t **applied_hash_aces)
 254 {
 255   /*
 256    * Go over the rules and check which ones are shadowed and which aren't.
 257    * Naive approach: try to match the match value from every ACE as if it
 258    * was a live packet, and see if the resulting match happens earlier in the list.
 259    * if it does not match or it is later in the ACL - then the entry is not shadowed.
 260    *
 261    * This approach fails, an example:
 262    *   deny tcp 2001:db8::/32 2001:db8::/32
 263    *   permit ip 2001:db8::1/128 2001:db8::2/128
 264    */
 265 }
 266
 267 static void *
 268 hash_acl_set_heap(acl_main_t *am)
 269 {
 270   if (0 == am->hash_lookup_mheap) {
 271     am->hash_lookup_mheap = mheap_alloc (0 /* use VM */ , 2 << 25);
 272     mheap_t *h = mheap_header (am->hash_lookup_mheap);
 273     h->flags |= MHEAP_FLAG_THREAD_SAFE;
 274   }
 275   void *oldheap = clib_mem_set_heap(am->hash_lookup_mheap);
 276   return oldheap;
 277 }
 278
 279 void
 280 acl_plugin_hash_acl_set_validate_heap(acl_main_t *am, int on)
 281 {
 282   clib_mem_set_heap(hash_acl_set_heap(am));
 283   mheap_t *h = mheap_header (am->hash_lookup_mheap);
 284   if (on) {
 285     h->flags |= MHEAP_FLAG_VALIDATE;
 286     h->flags &= ~MHEAP_FLAG_SMALL_OBJECT_CACHE;
 287     mheap_validate(h);
 288   } else {
 289     h->flags &= ~MHEAP_FLAG_VALIDATE;
 290     h->flags |= MHEAP_FLAG_SMALL_OBJECT_CACHE;
 291   }
 292 }
 293
 294 void
 295 acl_plugin_hash_acl_set_trace_heap(acl_main_t *am, int on)
 296 {
 297   clib_mem_set_heap(hash_acl_set_heap(am));
 298   mheap_t *h = mheap_header (am->hash_lookup_mheap);
 299   if (on) {
 300     h->flags |= MHEAP_FLAG_TRACE;
 301   } else {
 302     h->flags &= ~MHEAP_FLAG_TRACE;
 303   }
 304 }
 305
 306 void
 307 hash_acl_apply(acl_main_t *am, u32 sw_if_index, u8 is_input, int acl_index)
 308 {
 309   int i;
 310
 311   DBG0("HASH ACL apply: sw_if_index %d is_input %d acl %d", sw_if_index, is_input, acl_index);
 312   if (!am->acl_lookup_hash_initialized) {
 313     BV (clib_bihash_init) (&am->acl_lookup_hash, "ACL plugin rule lookup bihash",
 314                            65536, 2 << 25);
 315     am->acl_lookup_hash_initialized = 1;
 316   }
 317
 318   void *oldheap = hash_acl_set_heap(am);
 319   if (is_input) {
 320     vec_validate(am->input_hash_entry_vec_by_sw_if_index, sw_if_index);
 321   } else {
 322     vec_validate(am->output_hash_entry_vec_by_sw_if_index, sw_if_index);
 323   }
 324   vec_validate(am->hash_acl_infos, acl_index);
 325   applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, is_input, sw_if_index);
 326
 327   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
 328   u32 **hash_acl_applied_sw_if_index = is_input ? &ha->inbound_sw_if_index_list
 329                                                 : &ha->outbound_sw_if_index_list;
 330
 331   int base_offset = vec_len(*applied_hash_aces);
 332
 333   /* Update the bitmap of the mask types with which the lookup
 334      needs to happen for the ACLs applied to this sw_if_index */
 335   applied_hash_acl_info_t **applied_hash_acls = is_input ? &am->input_applied_hash_acl_info_by_sw_if_index :
 336                                                     &am->output_applied_hash_acl_info_by_sw_if_index;
 337   vec_validate((*applied_hash_acls), sw_if_index);
 338   applied_hash_acl_info_t *pal = vec_elt_at_index((*applied_hash_acls), sw_if_index);
 339
 340   /* ensure the list of applied hash acls is initialized and add this acl# to it */
 341   u32 index = vec_search(pal->applied_acls, acl_index);
 342   if (index != ~0) {
 343     clib_warning("BUG: trying to apply twice acl_index %d on sw_if_index %d is_input %d",
 344                  acl_index, sw_if_index, is_input);
 345     goto done;
 346   }
 347   vec_add1(pal->applied_acls, acl_index);
 348   u32 index2 = vec_search((*hash_acl_applied_sw_if_index), sw_if_index);
 349   if (index2 != ~0) {
 350     clib_warning("BUG: trying to apply twice acl_index %d on (sw_if_index %d) is_input %d",
 351                  acl_index, sw_if_index, is_input);
 352     goto done;
 353   }
 354   vec_add1((*hash_acl_applied_sw_if_index), sw_if_index);
 355
 356   pal->mask_type_index_bitmap = clib_bitmap_or(pal->mask_type_index_bitmap,
 357                                      ha->mask_type_index_bitmap);
 358   /*
 359    * if the applied ACL is empty, the current code will cause a
 360    * different behavior compared to current linear search: an empty ACL will
 361    * simply fallthrough to the next ACL, or the default deny in the end.
 362    *
 363    * This is not a problem, because after vpp-dev discussion,
 364    * the consensus was it should not be possible to apply the non-existent
 365    * ACL, so the change adding this code also takes care of that.
 366    */
 367
 368   /* expand the applied aces vector by the necessary amount */
 369   vec_resize((*applied_hash_aces), vec_len(ha->rules));
 370
 371   /* add the rules from the ACL to the hash table for lookup and append to the vector*/
 372   for(i=0; i < vec_len(ha->rules); i++) {
 373     u32 new_index = base_offset + i;
 374     applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), new_index);
 375     pae->acl_index = acl_index;
 376     pae->ace_index = ha->rules[i].ace_index;
 377     pae->action = ha->rules[i].action;
 378     pae->hash_ace_info_index = i;
 379     /* we might link it in later */
 380     pae->next_applied_entry_index = ~0;
 381     pae->prev_applied_entry_index = ~0;
 382     pae->tail_applied_entry_index = ~0;
 383     activate_applied_ace_hash_entry(am, sw_if_index, is_input, applied_hash_aces, new_index);
 384   }
 385   applied_hash_entries_analyze(am, applied_hash_aces);
 386 done:
 387   clib_mem_set_heap (oldheap);
 388 }
 389
 390 static u32
 391 find_head_applied_ace_index(applied_hash_ace_entry_t **applied_hash_aces, u32 curr_index)
 392 {
 393   /*
 394    * find back the first entry. Inefficient so might need to be a bit cleverer
 395    * if this proves to be a problem..
 396    */
 397   u32 an_index = curr_index;
 398   ASSERT(an_index != ~0);
 399   applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), an_index);
 400   while(head_pae->prev_applied_entry_index != ~0) {
 401     an_index = head_pae->prev_applied_entry_index;
 402     ASSERT(an_index != ~0);
 403     head_pae = vec_elt_at_index((*applied_hash_aces), an_index);
 404   }
 405   return an_index;
 406 }
 407
 408 static void
 409 move_applied_ace_hash_entry(acl_main_t *am,
 410                             u32 sw_if_index, u8 is_input,
 411                             applied_hash_ace_entry_t **applied_hash_aces,
 412                             u32 old_index, u32 new_index)
 413 {
 414   ASSERT(old_index != ~0);
 415   ASSERT(new_index != ~0);
 416   /* move the entry */
 417   *vec_elt_at_index((*applied_hash_aces), new_index) = *vec_elt_at_index((*applied_hash_aces), old_index);
 418
 419   /* update the linkage and hash table if necessary */
 420   applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), old_index);
 421
 422   if (pae->prev_applied_entry_index != ~0) {
 423     applied_hash_ace_entry_t *prev_pae = vec_elt_at_index((*applied_hash_aces), pae->prev_applied_entry_index);
 424     ASSERT(prev_pae->next_applied_entry_index == old_index);
 425     prev_pae->next_applied_entry_index = new_index;
 426   } else {
 427     /* first entry - so the hash points to it, update */
 428     add_del_hashtable_entry(am, sw_if_index, is_input,
 429                             applied_hash_aces, new_index, 1);
 430     ASSERT(pae->tail_applied_entry_index != ~0);
 431   }
 432   if (pae->next_applied_entry_index != ~0) {
 433     applied_hash_ace_entry_t *next_pae = vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
 434     ASSERT(next_pae->prev_applied_entry_index == old_index);
 435     next_pae->prev_applied_entry_index = new_index;
 436   } else {
 437     /*
 438      * Moving the very last entry, so we need to update the tail pointer in the first one.
 439      */
 440     u32 head_index = find_head_applied_ace_index(applied_hash_aces, old_index);
 441     ASSERT(head_index != ~0);
 442     applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), head_index);
 443
 444     ASSERT(head_pae->tail_applied_entry_index == old_index);
 445     head_pae->tail_applied_entry_index = new_index;
 446   }
 447   /* invalidate the old entry */
 448   pae->prev_applied_entry_index = ~0;
 449   pae->next_applied_entry_index = ~0;
 450   pae->tail_applied_entry_index = ~0;
 451 }
 452
 453 static void
 454 deactivate_applied_ace_hash_entry(acl_main_t *am,
 455                             u32 sw_if_index, u8 is_input,
 456                             applied_hash_ace_entry_t **applied_hash_aces,
 457                             u32 old_index)
 458 {
 459   applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), old_index);
 460   DBG("UNAPPLY DEACTIVATE: sw_if_index %d is_input %d, applied index %d", sw_if_index, is_input, old_index);
 461
 462   if (pae->prev_applied_entry_index != ~0) {
 463     DBG("UNAPPLY = index %d has prev_applied_entry_index %d", old_index, pae->prev_applied_entry_index);
 464     applied_hash_ace_entry_t *prev_pae = vec_elt_at_index((*applied_hash_aces), pae->prev_applied_entry_index);
 465     ASSERT(prev_pae->next_applied_entry_index == old_index);
 466     prev_pae->next_applied_entry_index = pae->next_applied_entry_index;
 467     if (pae->next_applied_entry_index == ~0) {
 468       /* it was a last entry we removed, update the pointer on the first one */
 469       u32 head_index = find_head_applied_ace_index(applied_hash_aces, old_index);
 470       DBG("UNAPPLY = index %d head index to update %d", old_index, head_index);
 471       ASSERT(head_index != ~0);
 472       applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), head_index);
 473
 474       ASSERT(head_pae->tail_applied_entry_index == old_index);
 475       head_pae->tail_applied_entry_index = pae->prev_applied_entry_index;
 476     } else {
 477       applied_hash_ace_entry_t *next_pae = vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
 478       next_pae->prev_applied_entry_index = pae->prev_applied_entry_index;
 479     }
 480   } else {
 481     /* It was the first entry. We need either to reset the hash entry or delete it */
 482     if (pae->next_applied_entry_index != ~0) {
 483       /* the next element becomes the new first one, so needs the tail pointer to be set */
 484       applied_hash_ace_entry_t *next_pae = vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
 485       ASSERT(pae->tail_applied_entry_index != ~0);
 486       next_pae->tail_applied_entry_index = pae->tail_applied_entry_index;
 487       DBG("Resetting the hash table entry from %d to %d, setting tail index to %d", old_index, pae->next_applied_entry_index, pae->tail_applied_entry_index);
 488       /* unlink from the next element */
 489       next_pae->prev_applied_entry_index = ~0;
 490       add_del_hashtable_entry(am, sw_if_index, is_input,
 491                               applied_hash_aces, pae->next_applied_entry_index, 1);
 492     } else {
 493       /* no next entry, so just delete the entry in the hash table */
 494       add_del_hashtable_entry(am, sw_if_index, is_input,
 495                               applied_hash_aces, old_index, 0);
 496     }
 497   }
 498   /* invalidate the old entry */
 499   pae->prev_applied_entry_index = ~0;
 500   pae->next_applied_entry_index = ~0;
 501   pae->tail_applied_entry_index = ~0;
 502 }
 503
 504
 505 static void
 506 hash_acl_build_applied_lookup_bitmap(acl_main_t *am, u32 sw_if_index, u8 is_input)
 507 {
 508   int i;
 509   uword *new_lookup_bitmap = 0;
 510   applied_hash_acl_info_t **applied_hash_acls = is_input ? &am->input_applied_hash_acl_info_by_sw_if_index
 511                                                          : &am->output_applied_hash_acl_info_by_sw_if_index;
 512   applied_hash_acl_info_t *pal = vec_elt_at_index((*applied_hash_acls), sw_if_index);
 513   for(i=0; i < vec_len(pal->applied_acls); i++) {
 514     u32 a_acl_index = *vec_elt_at_index((pal->applied_acls), i);
 515     hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, a_acl_index);
 516     DBG("Update bitmask = %U or %U (acl_index %d)\n", format_bitmap_hex, new_lookup_bitmap,
 517           format_bitmap_hex, ha->mask_type_index_bitmap, a_acl_index);
 518     new_lookup_bitmap = clib_bitmap_or(new_lookup_bitmap,
 519                                        ha->mask_type_index_bitmap);
 520   }
 521   uword *old_lookup_bitmap = pal->mask_type_index_bitmap;
 522   pal->mask_type_index_bitmap = new_lookup_bitmap;
 523   clib_bitmap_free(old_lookup_bitmap);
 524 }
 525
 526 void
 527 hash_acl_unapply(acl_main_t *am, u32 sw_if_index, u8 is_input, int acl_index)
 528 {
 529   int i;
 530
 531   DBG0("HASH ACL unapply: sw_if_index %d is_input %d acl %d", sw_if_index, is_input, acl_index);
 532   applied_hash_acl_info_t **applied_hash_acls = is_input ? &am->input_applied_hash_acl_info_by_sw_if_index
 533                                                          : &am->output_applied_hash_acl_info_by_sw_if_index;
 534   applied_hash_acl_info_t *pal = vec_elt_at_index((*applied_hash_acls), sw_if_index);
 535
 536   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
 537   u32 **hash_acl_applied_sw_if_index = is_input ? &ha->inbound_sw_if_index_list
 538                                                 : &ha->outbound_sw_if_index_list;
 539
 540   /* remove this acl# from the list of applied hash acls */
 541   u32 index = vec_search(pal->applied_acls, acl_index);
 542   if (index == ~0) {
 543     clib_warning("BUG: trying to unapply unapplied acl_index %d on sw_if_index %d is_input %d",
 544                  acl_index, sw_if_index, is_input);
 545     return;
 546   }
 547   vec_del1(pal->applied_acls, index);
 548
 549   u32 index2 = vec_search((*hash_acl_applied_sw_if_index), sw_if_index);
 550   if (index2 == ~0) {
 551     clib_warning("BUG: trying to unapply twice acl_index %d on (sw_if_index %d) is_input %d",
 552                  acl_index, sw_if_index, is_input);
 553     return;
 554   }
 555   vec_del1((*hash_acl_applied_sw_if_index), index2);
 556
 557   applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, is_input, sw_if_index);
 558
 559   for(i=0; i < vec_len((*applied_hash_aces)); i++) {
 560     if (vec_elt_at_index(*applied_hash_aces,i)->acl_index == acl_index) {
 561       DBG("Found applied ACL#%d at applied index %d", acl_index, i);
 562       break;
 563     }
 564   }
 565   if (vec_len((*applied_hash_aces)) <= i) {
 566     DBG("Did not find applied ACL#%d at sw_if_index %d", acl_index, sw_if_index);
 567     /* we went all the way without finding any entries. Probably a list was empty. */
 568     return;
 569   }
 570
 571   void *oldheap = hash_acl_set_heap(am);
 572   int base_offset = i;
 573   int tail_offset = base_offset + vec_len(ha->rules);
 574   int tail_len = vec_len((*applied_hash_aces)) - tail_offset;
 575   DBG("base_offset: %d, tail_offset: %d, tail_len: %d", base_offset, tail_offset, tail_len);
 576
 577   for(i=0; i < vec_len(ha->rules); i ++) {
 578     deactivate_applied_ace_hash_entry(am, sw_if_index, is_input,
 579                                       applied_hash_aces, base_offset + i);
 580   }
 581   for(i=0; i < tail_len; i ++) {
 582     /* move the entry at tail offset to base offset */
 583     /* that is, from (tail_offset+i) -> (base_offset+i) */
 584     DBG("UNAPPLY MOVE: sw_if_index %d is_input %d, applied index %d ->", sw_if_index, is_input, tail_offset+i, base_offset + i);
 585     move_applied_ace_hash_entry(am, sw_if_index, is_input, applied_hash_aces, tail_offset + i, base_offset + i);
 586   }
 587   /* trim the end of the vector */
 588   _vec_len((*applied_hash_aces)) -= vec_len(ha->rules);
 589
 590   applied_hash_entries_analyze(am, applied_hash_aces);
 591
 592   /* After deletion we might not need some of the mask-types anymore... */
 593   hash_acl_build_applied_lookup_bitmap(am, sw_if_index, is_input);
 594   clib_mem_set_heap (oldheap);
 595 }
 596
 597 /*
 598  * Create the applied ACEs and update the hash table,
 599  * taking into account that the ACL may not be the last
 600  * in the vector of applied ACLs.
 601  *
 602  * For now, walk from the end of the vector and unapply the ACLs,
 603  * then apply the one in question and reapply the rest.
 604  */
 605
 606 void
 607 hash_acl_reapply(acl_main_t *am, u32 sw_if_index, u8 is_input, int acl_index)
 608 {
 609   u32 **applied_acls = is_input ? vec_elt_at_index(am->input_acl_vec_by_sw_if_index, sw_if_index)
 610                                 : vec_elt_at_index(am->output_acl_vec_by_sw_if_index, sw_if_index);
 611   int i;
 612   int start_index = vec_search((*applied_acls), acl_index);
 613   /*
 614    * This function is called after we find out the sw_if_index where ACL is applied.
 615    * If the by-sw_if_index vector does not have the ACL#, then it's a bug.
 616    */
 617   ASSERT(start_index < vec_len(*applied_acls));
 618
 619   /* unapply all the ACLs till the current one */
 620   for(i = vec_len(*applied_acls) - 1; i > start_index; i--) {
 621     hash_acl_unapply(am, sw_if_index, is_input, *vec_elt_at_index(*applied_acls, i));
 622   }
 623   for(i = start_index; i < vec_len(*applied_acls); i++) {
 624     hash_acl_apply(am, sw_if_index, is_input, *vec_elt_at_index(*applied_acls, i));
 625   }
 626 }
 627
 628 static void
 629 make_address_mask(ip46_address_t *addr, u8 is_ipv6, u8 prefix_len)
 630 {
 631   if (is_ipv6) {
 632     ip6_address_mask_from_width(&addr->ip6, prefix_len);
 633   } else {
 634     /* FIXME: this may not be correct way */
 635     ip6_address_mask_from_width(&addr->ip6, prefix_len + 3*32);
 636     ip46_address_mask_ip4(addr);
 637   }
 638 }
 639
 640 static u8
 641 make_port_mask(u16 *portmask, u16 port_first, u16 port_last)
 642 {
 643   if (port_first == port_last) {
 644     *portmask = 0xffff;
 645     /* single port is representable by masked value */
 646     return 0;
 647   }
 648   if ((port_first == 0) && (port_last == 65535)) {
 649     *portmask = 0;
 650     /* wildcard port is representable by a masked value */
 651     return 0;
 652   }
 653
 654   /*
 655    * For now match all the ports, later
 656    * here might be a better optimization which would
 657    * pick out bitmaskable portranges.
 658    *
 659    * However, adding a new mask type potentially
 660    * adds a per-packet extra lookup, so the benefit is not clear.
 661    */
 662   *portmask = 0;
 663   /* This port range can't be represented via bitmask exactly. */
 664   return 1;
 665 }
 666
 667 static void
 668 make_mask_and_match_from_rule(fa_5tuple_t *mask, acl_rule_t *r, hash_ace_info_t *hi, int match_nonfirst_fragment)
 669 {
 670   memset(mask, 0, sizeof(*mask));
 671   memset(&hi->match, 0, sizeof(hi->match));
 672   hi->action = r->is_permit;
 673
 674   /* we will need to be matching based on sw_if_index, direction, and mask_type_index when applied */
 675   mask->pkt.sw_if_index = ~0;
 676   mask->pkt.is_input = 1;
 677   /* we will assign the match of mask_type_index later when we find it*/
 678   mask->pkt.mask_type_index_lsb = ~0;
 679
 680   mask->pkt.is_ip6 = 1;
 681   hi->match.pkt.is_ip6 = r->is_ipv6;
 682
 683   make_address_mask(&mask->addr[0], r->is_ipv6, r->src_prefixlen);
 684   hi->match.addr[0] = r->src;
 685   make_address_mask(&mask->addr[1], r->is_ipv6, r->dst_prefixlen);
 686   hi->match.addr[1] = r->dst;
 687
 688   if (r->proto != 0) {
 689     mask->l4.proto = ~0; /* L4 proto needs to be matched */
 690     hi->match.l4.proto = r->proto;
 691     if (match_nonfirst_fragment) {
 692       /* match the non-first fragments only */
 693       mask->pkt.is_nonfirst_fragment = 1;
 694       hi->match.pkt.is_nonfirst_fragment = 1;
 695     } else {
 696       /* Calculate the src/dst port masks and make the src/dst port matches accordingly */
 697       hi->src_portrange_not_powerof2 = make_port_mask(&mask->l4.port[0], r->src_port_or_type_first, r->src_port_or_type_last);
 698       hi->match.l4.port[0] = r->src_port_or_type_first & mask->l4.port[0];
 699       hi->dst_portrange_not_powerof2 = make_port_mask(&mask->l4.port[1], r->dst_port_or_code_first, r->dst_port_or_code_last);
 700       hi->match.l4.port[1] = r->dst_port_or_code_first & mask->l4.port[1];
 701       /* L4 info must be valid in order to match */
 702       mask->pkt.l4_valid = 1;
 703       hi->match.pkt.l4_valid = 1;
 704       /* And we must set the mask to check that it is an initial fragment */
 705       mask->pkt.is_nonfirst_fragment = 1;
 706       hi->match.pkt.is_nonfirst_fragment = 0;
 707       if ((r->proto == IPPROTO_TCP) && (r->tcp_flags_mask != 0)) {
 708         /* if we want to match on TCP flags, they must be masked off as well */
 709         mask->pkt.tcp_flags = r->tcp_flags_mask;
 710         hi->match.pkt.tcp_flags = r->tcp_flags_value;
 711         /* and the flags need to be present within the packet being matched */
 712         mask->pkt.tcp_flags_valid = 1;
 713         hi->match.pkt.tcp_flags_valid = 1;
 714       }
 715     }
 716   }
 717   /* Sanitize the mask and the match */
 718   u64 *pmask = (u64 *)mask;
 719   u64 *pmatch = (u64 *)&hi->match;
 720   int j;
 721   for(j=0; j<6; j++) {
 722     pmatch[j] = pmatch[j] & pmask[j];
 723   }
 724 }
 725
 726 static u32
 727 find_mask_type_index(acl_main_t *am, fa_5tuple_t *mask)
 728 {
 729   ace_mask_type_entry_t *mte;
 730   /* *INDENT-OFF* */
 731   pool_foreach(mte, am->ace_mask_type_pool,
 732   ({
 733     if(memcmp(&mte->mask, mask, sizeof(*mask)) == 0)
 734       return (mte - am->ace_mask_type_pool);
 735   }));
 736   /* *INDENT-ON* */
 737   return ~0;
 738 }
 739
 740 static u32
 741 assign_mask_type_index(acl_main_t *am, fa_5tuple_t *mask)
 742 {
 743   u32 mask_type_index = find_mask_type_index(am, mask);
 744   ace_mask_type_entry_t *mte;
 745   if(~0 == mask_type_index) {
 746     pool_get_aligned (am->ace_mask_type_pool, mte, CLIB_CACHE_LINE_BYTES);
 747     mask_type_index = mte - am->ace_mask_type_pool;
 748     clib_memcpy(&mte->mask, mask, sizeof(mte->mask));
 749     mte->refcount = 0;
 750     /*
 751      * We can use only 16 bits, since in the match there is only u16 field.
 752      * Realistically, once you go to 64K of mask types, it is a huge
 753      * problem anyway, so we might as well stop half way.
 754      */
 755     ASSERT(mask_type_index < 32768);
 756   }
 757   mte = am->ace_mask_type_pool + mask_type_index;
 758   mte->refcount++;
 759   return mask_type_index;
 760 }
 761
 762 static void
 763 release_mask_type_index(acl_main_t *am, u32 mask_type_index)
 764 {
 765   ace_mask_type_entry_t *mte = pool_elt_at_index(am->ace_mask_type_pool, mask_type_index);
 766   mte->refcount--;
 767   if (mte->refcount == 0) {
 768     /* we are not using this entry anymore */
 769     pool_put(am->ace_mask_type_pool, mte);
 770   }
 771 }
 772
 773 void hash_acl_add(acl_main_t *am, int acl_index)
 774 {
 775   void *oldheap = hash_acl_set_heap(am);
 776   DBG("HASH ACL add : %d", acl_index);
 777   int i;
 778   acl_list_t *a = &am->acls[acl_index];
 779   vec_validate(am->hash_acl_infos, acl_index);
 780   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
 781   memset(ha, 0, sizeof(*ha));
 782
 783   /* walk the newly added ACL entries and ensure that for each of them there
 784      is a mask type, increment a reference count for that mask type */
 785   for(i=0; i < a->count; i++) {
 786     hash_ace_info_t ace_info;
 787     fa_5tuple_t mask;
 788     memset(&ace_info, 0, sizeof(ace_info));
 789     ace_info.acl_index = acl_index;
 790     ace_info.ace_index = i;
 791
 792     make_mask_and_match_from_rule(&mask, &a->rules[i], &ace_info, 0);
 793     ace_info.mask_type_index = assign_mask_type_index(am, &mask);
 794     /* assign the mask type index for matching itself */
 795     ace_info.match.pkt.mask_type_index_lsb = ace_info.mask_type_index;
 796     DBG("ACE: %d mask_type_index: %d", i, ace_info.mask_type_index);
 797     /* Ensure a given index is set in the mask type index bitmap for this ACL */
 798     ha->mask_type_index_bitmap = clib_bitmap_set(ha->mask_type_index_bitmap, ace_info.mask_type_index, 1);
 799     vec_add1(ha->rules, ace_info);
 800     if (am->l4_match_nonfirst_fragment) {
 801       /* add the second rule which matches the noninitial fragments with the respective mask */
 802       make_mask_and_match_from_rule(&mask, &a->rules[i], &ace_info, 1);
 803       ace_info.mask_type_index = assign_mask_type_index(am, &mask);
 804       ace_info.match.pkt.mask_type_index_lsb = ace_info.mask_type_index;
 805       DBG("ACE: %d (non-initial frags) mask_type_index: %d", i, ace_info.mask_type_index);
 806       /* Ensure a given index is set in the mask type index bitmap for this ACL */
 807       ha->mask_type_index_bitmap = clib_bitmap_set(ha->mask_type_index_bitmap, ace_info.mask_type_index, 1);
 808       vec_add1(ha->rules, ace_info);
 809     }
 810   }
 811   /*
 812    * if an ACL is applied somewhere, fill the corresponding lookup data structures.
 813    * We need to take care if the ACL is not the last one in the vector of ACLs applied to the interface.
 814    */
 815   if (acl_index < vec_len(am->input_sw_if_index_vec_by_acl)) {
 816     u32 *sw_if_index;
 817     vec_foreach(sw_if_index, am->input_sw_if_index_vec_by_acl[acl_index]) {
 818       hash_acl_reapply(am, *sw_if_index, 1, acl_index);
 819     }
 820   }
 821   if (acl_index < vec_len(am->output_sw_if_index_vec_by_acl)) {
 822     u32 *sw_if_index;
 823     vec_foreach(sw_if_index, am->output_sw_if_index_vec_by_acl[acl_index]) {
 824       hash_acl_reapply(am, *sw_if_index, 0, acl_index);
 825     }
 826   }
 827   clib_mem_set_heap (oldheap);
 828 }
 829
 830 void hash_acl_delete(acl_main_t *am, int acl_index)
 831 {
 832   void *oldheap = hash_acl_set_heap(am);
 833   DBG0("HASH ACL delete : %d", acl_index);
 834   /*
 835    * If the ACL is applied somewhere, remove the references of it (call hash_acl_unapply)
 836    * this is a different behavior from the linear lookup where an empty ACL is "deny all",
 837    *
 838    * However, following vpp-dev discussion the ACL that is referenced elsewhere
 839    * should not be possible to delete, and the change adding this also adds
 840    * the safeguards to that respect, so this is not a problem.
 841    *
 842    * The part to rememeber is that this routine is called in process of reapplication
 843    * during the acl_add_replace() API call - the old acl ruleset is deleted, then
 844    * the new one is added, without the change in the applied ACLs - so this case
 845    * has to be handled.
 846    */
 847   hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
 848   u32 *interface_list_copy = 0;
 849   {
 850     u32 *sw_if_index;
 851     interface_list_copy = vec_dup(ha->inbound_sw_if_index_list);
 852     vec_foreach(sw_if_index, interface_list_copy) {
 853       hash_acl_unapply(am, *sw_if_index, 1, acl_index);
 854     }
 855     vec_free(interface_list_copy);
 856     interface_list_copy = vec_dup(ha->outbound_sw_if_index_list);
 857     vec_foreach(sw_if_index, interface_list_copy) {
 858       hash_acl_unapply(am, *sw_if_index, 0, acl_index);
 859     }
 860   }
 861
 862   /* walk the mask types for the ACL about-to-be-deleted, and decrease
 863    * the reference count, possibly freeing up some of them */
 864   int i;
 865   for(i=0; i < vec_len(ha->rules); i++) {
 866     release_mask_type_index(am, ha->rules[i].mask_type_index);
 867   }
 868   clib_bitmap_free(ha->mask_type_index_bitmap);
 869   vec_free(ha->rules);
 870   clib_mem_set_heap (oldheap);
 871 }
 872
 873 u8
 874 hash_multi_acl_match_5tuple (u32 sw_if_index, fa_5tuple_t * pkt_5tuple, int is_l2,
 875                        int is_ip6, int is_input, u32 * acl_match_p,
 876                        u32 * rule_match_p, u32 * trace_bitmap)
 877 {
 878   acl_main_t *am = &acl_main;
 879   applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, is_input, sw_if_index);
 880   u32 match_index = multi_acl_match_get_applied_ace_index(am, pkt_5tuple);
 881   if (match_index < vec_len((*applied_hash_aces))) {
 882     applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), match_index);
 883     *acl_match_p = pae->acl_index;
 884     *rule_match_p = pae->ace_index;
 885     return pae->action;
 886   }
 887   return 0;
 888 }
 889
 890
 891 void
 892 show_hash_acl_hash (vlib_main_t * vm, acl_main_t *am, u32 verbose)
 893 {
 894   vlib_cli_output(vm, "\nACL lookup hash table:\n%U\n",
 895                   BV (format_bihash), &am->acl_lookup_hash, verbose);
 896 }