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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
19 #include <netinet/in.h>
21 #include <vlibapi/api.h>
22 #include <vlibmemory/api.h>
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>
30 #include <vppinfra/bihash_48_8.h>
32 #include "hash_lookup.h"
33 #include "hash_lookup_private.h"
36 always_inline applied_hash_ace_entry_t **get_applied_hash_aces(acl_main_t *am, u32 lc_index)
38 applied_hash_ace_entry_t **applied_hash_aces = vec_elt_at_index(am->hash_entry_vec_by_lc_index, lc_index);
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);
43 return applied_hash_aces;
48 hashtable_add_del(acl_main_t *am, clib_bihash_kv_48_8_t *kv, int is_add)
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);
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.
65 * [1] James Daly, Eric Torng "TupleMerge: Building Online Packet Classifiers
66 * by Omitting Bits", In Proc. IEEE ICCCN 2017, pp. 1-10
82 /* check if mask2 can be contained by mask1 */
84 first_mask_contains_second_mask(int is_ip6, fa_5tuple_t * mask1, fa_5tuple_t * mask2)
89 for (i = 0; i < 2; i++)
91 if ((mask1->ip6_addr[0].as_u64[i] & mask2->ip6_addr[0].as_u64[i]) !=
92 mask1->ip6_addr[0].as_u64[i])
94 if ((mask1->ip6_addr[1].as_u64[i] & mask2->ip6_addr[1].as_u64[i]) !=
95 mask1->ip6_addr[1].as_u64[i])
101 /* check the pads, both masks must have it 0 */
104 for (i=0; i<6; i++) {
105 padcheck |= mask1->l3_zero_pad[i];
106 padcheck |= mask2->l3_zero_pad[i];
110 if ((mask1->ip4_addr[0].as_u32 & mask2->ip4_addr[0].as_u32) !=
111 mask1->ip4_addr[0].as_u32)
113 if ((mask1->ip4_addr[1].as_u32 & mask2->ip4_addr[1].as_u32) !=
114 mask1->ip4_addr[1].as_u32)
118 /* take care if port are not exact-match */
119 if ((mask1->l4.as_u64 & mask2->l4.as_u64) != mask1->l4.as_u64)
122 if ((mask1->pkt.as_u64 & mask2->pkt.as_u64) != mask1->pkt.as_u64)
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.
165 shift_ip4_if(u32 mask, u32 thresh, int numshifts, u32 else_val)
168 return clib_host_to_net_u32((clib_net_to_host_u32(mask) << numshifts) & 0xFFFFFFFF);
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 } };
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);
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)));
187 relax_ip6_addr(ip6_address_t *ip6_mask, int relax2) {
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.
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);
205 relax_tuple(fa_5tuple_t *mask, int is_ip6, int relax2){
206 fa_5tuple_t save_mask = *mask;
208 int counter_s = 0, counter_d = 0;
212 counter_s += count_bits(mask->ip6_addr[0].as_u64[i]);
213 counter_d += count_bits(mask->ip6_addr[1].as_u64[i]);
216 counter_s += count_bits(mask->ip4_addr[0].as_u32);
217 counter_d += count_bits(mask->ip4_addr[1].as_u32);
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
228 const int deltaThreshold = 4;
229 /* const int deltaThreshold = 8; if IPV6? */
230 int delta = counter_s - counter_d;
231 if (-delta > deltaThreshold) {
233 mask->ip6_addr[0].as_u64[1] = mask->ip6_addr[0].as_u64[0] = 0;
235 mask->ip4_addr[0].as_u32 = 0;
236 mask->l4.port[0] = 0;
237 } else if (delta > deltaThreshold) {
239 mask->ip6_addr[1].as_u64[1] = mask->ip6_addr[1].as_u64[0] = 0;
241 mask->ip4_addr[1].as_u32 = 0;
242 mask->l4.port[1] = 0;
246 relax_ip6_addr(&mask->ip6_addr[0], relax2);
247 relax_ip6_addr(&mask->ip6_addr[1], relax2);
249 relax_ip4_addr(&mask->ip4_addr[0], relax2);
250 relax_ip4_addr(&mask->ip4_addr[1], relax2);
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");
258 DBG( "TM-relaxing-end");
263 tm_assign_mask_type_index(acl_main_t *am, fa_5tuple_t *mask, int is_ip6, u32 lc_index)
265 u32 mask_type_index = ~0;
266 u32 for_mask_type_index = ~0;
267 ace_mask_type_entry_t *mte;
269 /* look for existing mask comparable with the one in input */
271 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);
272 hash_applied_mask_info_t *minfo;
274 if (vec_len(*hash_applied_mask_info_vec) > 0) {
275 for(order_index = vec_len((*hash_applied_mask_info_vec)) -1; order_index >= 0; order_index--) {
276 minfo = vec_elt_at_index((*hash_applied_mask_info_vec), order_index);
277 for_mask_type_index = minfo->mask_type_index;
278 mte = vec_elt_at_index(am->ace_mask_type_pool, for_mask_type_index);
279 if(first_mask_contains_second_mask(is_ip6, &mte->mask, mask)){
280 mask_type_index = (mte - am->ace_mask_type_pool);
286 if(~0 == mask_type_index) {
287 /* 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 */
288 DBG( "TM-assigning mask type index-new one");
289 pool_get_aligned (am->ace_mask_type_pool, mte, CLIB_CACHE_LINE_BYTES);
290 mask_type_index = mte - am->ace_mask_type_pool;
292 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);
294 int spot = vec_len((*hash_applied_mask_info_vec));
295 vec_validate((*hash_applied_mask_info_vec), spot);
296 minfo = vec_elt_at_index((*hash_applied_mask_info_vec), spot);
297 minfo->mask_type_index = mask_type_index;
298 minfo->num_entries = 0;
299 minfo->max_collisions = 0;
300 minfo->first_rule_index = ~0;
302 clib_memcpy(&mte->mask, mask, sizeof(mte->mask));
303 relax_tuple(&mte->mask, is_ip6, 0);
307 * We can use only 16 bits, since in the match there is only u16 field.
308 * Realistically, once you go to 64K of mask types, it is a huge
309 * problem anyway, so we might as well stop half way.
311 ASSERT(mask_type_index < 32768);
313 mte = am->ace_mask_type_pool + mask_type_index;
315 return mask_type_index;
320 fill_applied_hash_ace_kv(acl_main_t *am,
321 applied_hash_ace_entry_t **applied_hash_aces,
323 u32 new_index, clib_bihash_kv_48_8_t *kv)
325 fa_5tuple_t *kv_key = (fa_5tuple_t *)kv->key;
326 hash_acl_lookup_value_t *kv_val = (hash_acl_lookup_value_t *)&kv->value;
327 applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), new_index);
328 hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, pae->acl_index);
330 /* apply the mask to ace key */
331 hash_ace_info_t *ace_info = vec_elt_at_index(ha->rules, pae->hash_ace_info_index);
332 ace_mask_type_entry_t *mte = vec_elt_at_index(am->ace_mask_type_pool, pae->mask_type_index);
334 u64 *pmatch = (u64 *) &ace_info->match;
335 u64 *pmask = (u64 *)&mte->mask;
336 u64 *pkey = (u64 *)kv->key;
338 *pkey++ = *pmatch++ & *pmask++;
339 *pkey++ = *pmatch++ & *pmask++;
340 *pkey++ = *pmatch++ & *pmask++;
341 *pkey++ = *pmatch++ & *pmask++;
342 *pkey++ = *pmatch++ & *pmask++;
343 *pkey++ = *pmatch++ & *pmask++;
345 kv_key->pkt.mask_type_index_lsb = pae->mask_type_index;
346 kv_key->pkt.lc_index = lc_index;
348 kv_val->applied_entry_index = new_index;
352 add_del_hashtable_entry(acl_main_t *am,
354 applied_hash_ace_entry_t **applied_hash_aces,
355 u32 index, int is_add)
357 clib_bihash_kv_48_8_t kv;
359 fill_applied_hash_ace_kv(am, applied_hash_aces, lc_index, index, &kv);
360 hashtable_add_del(am, &kv, is_add);
365 find_mask_type_index(acl_main_t *am, fa_5tuple_t *mask)
367 ace_mask_type_entry_t *mte;
369 pool_foreach(mte, am->ace_mask_type_pool,
371 if(memcmp(&mte->mask, mask, sizeof(*mask)) == 0)
372 return (mte - am->ace_mask_type_pool);
379 assign_mask_type_index(acl_main_t *am, fa_5tuple_t *mask)
381 u32 mask_type_index = find_mask_type_index(am, mask);
382 ace_mask_type_entry_t *mte;
383 if(~0 == mask_type_index) {
384 pool_get_aligned (am->ace_mask_type_pool, mte, CLIB_CACHE_LINE_BYTES);
385 mask_type_index = mte - am->ace_mask_type_pool;
386 clib_memcpy(&mte->mask, mask, sizeof(mte->mask));
389 * We can use only 16 bits, since in the match there is only u16 field.
390 * Realistically, once you go to 64K of mask types, it is a huge
391 * problem anyway, so we might as well stop half way.
393 ASSERT(mask_type_index < 32768);
395 mte = am->ace_mask_type_pool + mask_type_index;
397 return mask_type_index;
401 release_mask_type_index(acl_main_t *am, u32 mask_type_index)
403 ace_mask_type_entry_t *mte = pool_elt_at_index(am->ace_mask_type_pool, mask_type_index);
405 if (mte->refcount == 0) {
406 /* we are not using this entry anymore */
407 pool_put(am->ace_mask_type_pool, mte);
412 remake_hash_applied_mask_info_vec (acl_main_t * am,
413 applied_hash_ace_entry_t **
414 applied_hash_aces, u32 lc_index)
416 hash_applied_mask_info_t *new_hash_applied_mask_info_vec =
417 vec_new (hash_applied_mask_info_t, 0);
419 hash_applied_mask_info_t *minfo;
421 for (i = 0; i < vec_len ((*applied_hash_aces)); i++)
423 applied_hash_ace_entry_t *pae =
424 vec_elt_at_index ((*applied_hash_aces), i);
426 /* check if mask_type_index is already there */
427 u32 new_pointer = vec_len (new_hash_applied_mask_info_vec);
429 for (search = 0; search < vec_len (new_hash_applied_mask_info_vec);
432 minfo = vec_elt_at_index (new_hash_applied_mask_info_vec, search);
433 if (minfo->mask_type_index == pae->mask_type_index)
437 vec_validate ((new_hash_applied_mask_info_vec), search);
438 minfo = vec_elt_at_index ((new_hash_applied_mask_info_vec), search);
439 if (search == new_pointer)
441 minfo->mask_type_index = pae->mask_type_index;
442 minfo->num_entries = 0;
443 minfo->max_collisions = 0;
444 minfo->first_rule_index = ~0;
447 minfo->num_entries = minfo->num_entries + 1;
449 if (vec_len (pae->colliding_rules) > minfo->max_collisions)
450 minfo->max_collisions = vec_len (pae->colliding_rules);
452 if (minfo->first_rule_index > i)
453 minfo->first_rule_index = i;
456 hash_applied_mask_info_t **hash_applied_mask_info_vec =
457 vec_elt_at_index (am->hash_applied_mask_info_vec_by_lc_index, lc_index);
459 vec_free ((*hash_applied_mask_info_vec));
460 (*hash_applied_mask_info_vec) = new_hash_applied_mask_info_vec;
464 vec_del_collision_rule (collision_match_rule_t ** pvec,
465 u32 applied_entry_index)
469 while (i < _vec_len ((*pvec)))
471 collision_match_rule_t *cr = vec_elt_at_index ((*pvec), i);
472 if (cr->applied_entry_index == applied_entry_index)
474 /* vec_del1 ((*pvec), i) would be more efficient but would reorder the elements. */
475 vec_delete((*pvec), 1, i);
477 DBG0("vec_del_collision_rule deleting one at index %d", i);
488 acl_plugin_print_pae (vlib_main_t * vm, int j, applied_hash_ace_entry_t * pae);
491 del_colliding_rule (applied_hash_ace_entry_t ** applied_hash_aces,
492 u32 head_index, u32 applied_entry_index)
494 DBG0("DEL COLLIDING RULE: head_index %d applied index %d", head_index, applied_entry_index);
497 applied_hash_ace_entry_t *head_pae =
498 vec_elt_at_index ((*applied_hash_aces), head_index);
499 if (ACL_HASH_LOOKUP_DEBUG > 0)
500 acl_plugin_print_pae(acl_main.vlib_main, head_index, head_pae);
501 vec_del_collision_rule (&head_pae->colliding_rules, applied_entry_index);
502 if (vec_len(head_pae->colliding_rules) == 0) {
503 vec_free(head_pae->colliding_rules);
505 if (ACL_HASH_LOOKUP_DEBUG > 0)
506 acl_plugin_print_pae(acl_main.vlib_main, head_index, head_pae);
510 add_colliding_rule (acl_main_t * am,
511 applied_hash_ace_entry_t ** applied_hash_aces,
512 u32 head_index, u32 applied_entry_index)
514 applied_hash_ace_entry_t *head_pae =
515 vec_elt_at_index ((*applied_hash_aces), head_index);
516 applied_hash_ace_entry_t *pae =
517 vec_elt_at_index ((*applied_hash_aces), applied_entry_index);
518 DBG0("ADD COLLIDING RULE: head_index %d applied index %d", head_index, applied_entry_index);
519 if (ACL_HASH_LOOKUP_DEBUG > 0)
520 acl_plugin_print_pae(acl_main.vlib_main, head_index, head_pae);
522 collision_match_rule_t cr;
524 cr.acl_index = pae->acl_index;
525 cr.ace_index = pae->ace_index;
526 cr.acl_position = pae->acl_position;
527 cr.applied_entry_index = applied_entry_index;
528 cr.rule = am->acls[pae->acl_index].rules[pae->ace_index];
529 vec_add1 (head_pae->colliding_rules, cr);
530 if (ACL_HASH_LOOKUP_DEBUG > 0)
531 acl_plugin_print_pae(acl_main.vlib_main, head_index, head_pae);
535 activate_applied_ace_hash_entry(acl_main_t *am,
537 applied_hash_ace_entry_t **applied_hash_aces,
540 clib_bihash_kv_48_8_t kv;
541 ASSERT(new_index != ~0);
542 applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), new_index);
543 DBG("activate_applied_ace_hash_entry lc_index %d new_index %d", lc_index, new_index);
545 fill_applied_hash_ace_kv(am, applied_hash_aces, lc_index, new_index, &kv);
547 DBG("APPLY ADD KY: %016llx %016llx %016llx %016llx %016llx %016llx",
548 kv.key[0], kv.key[1], kv.key[2],
549 kv.key[3], kv.key[4], kv.key[5]);
551 clib_bihash_kv_48_8_t result;
552 hash_acl_lookup_value_t *result_val = (hash_acl_lookup_value_t *)&result.value;
553 int res = BV (clib_bihash_search) (&am->acl_lookup_hash, &kv, &result);
554 ASSERT(new_index != ~0);
555 ASSERT(new_index < vec_len((*applied_hash_aces)));
557 /* There already exists an entry or more. Append at the end. */
558 u32 first_index = result_val->applied_entry_index;
559 ASSERT(first_index != ~0);
560 DBG("A key already exists, with applied entry index: %d", first_index);
561 applied_hash_ace_entry_t *first_pae = vec_elt_at_index((*applied_hash_aces), first_index);
562 u32 last_index = first_pae->tail_applied_entry_index;
563 ASSERT(last_index != ~0);
564 applied_hash_ace_entry_t *last_pae = vec_elt_at_index((*applied_hash_aces), last_index);
565 DBG("...advance to chained entry index: %d", last_index);
566 /* link ourseves in */
567 last_pae->next_applied_entry_index = new_index;
568 pae->prev_applied_entry_index = last_index;
569 /* adjust the pointer to the new tail */
570 first_pae->tail_applied_entry_index = new_index;
571 add_colliding_rule(am, applied_hash_aces, first_index, new_index);
574 /* It's the very first entry */
575 hashtable_add_del(am, &kv, 1);
576 ASSERT(new_index != ~0);
577 pae->tail_applied_entry_index = new_index;
578 add_colliding_rule(am, applied_hash_aces, new_index, new_index);
585 hash_acl_set_heap(acl_main_t *am)
587 if (0 == am->hash_lookup_mheap) {
588 am->hash_lookup_mheap = mheap_alloc (0 /* use VM */ , am->hash_lookup_mheap_size);
589 if (0 == am->hash_lookup_mheap) {
590 clib_error("ACL plugin failed to allocate hash lookup heap of %U bytes, abort", format_memory_size, am->hash_lookup_mheap_size);
592 mheap_t *h = mheap_header (am->hash_lookup_mheap);
593 h->flags |= MHEAP_FLAG_THREAD_SAFE;
595 void *oldheap = clib_mem_set_heap(am->hash_lookup_mheap);
600 acl_plugin_hash_acl_set_validate_heap(int on)
602 acl_main_t *am = &acl_main;
603 clib_mem_set_heap(hash_acl_set_heap(am));
604 mheap_t *h = mheap_header (am->hash_lookup_mheap);
606 h->flags |= MHEAP_FLAG_VALIDATE;
607 h->flags &= ~MHEAP_FLAG_SMALL_OBJECT_CACHE;
610 h->flags &= ~MHEAP_FLAG_VALIDATE;
611 h->flags |= MHEAP_FLAG_SMALL_OBJECT_CACHE;
616 acl_plugin_hash_acl_set_trace_heap(int on)
618 acl_main_t *am = &acl_main;
619 clib_mem_set_heap(hash_acl_set_heap(am));
620 mheap_t *h = mheap_header (am->hash_lookup_mheap);
622 h->flags |= MHEAP_FLAG_TRACE;
624 h->flags &= ~MHEAP_FLAG_TRACE;
629 assign_mask_type_index_to_pae(acl_main_t *am, u32 lc_index, int is_ip6, applied_hash_ace_entry_t *pae)
631 hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, pae->acl_index);
632 hash_ace_info_t *ace_info = vec_elt_at_index(ha->rules, pae->hash_ace_info_index);
634 ace_mask_type_entry_t *mte;
637 * Start taking base_mask associated to ace, and essentially copy it.
638 * With TupleMerge we will assign a relaxed mask here.
640 mte = vec_elt_at_index(am->ace_mask_type_pool, ace_info->base_mask_type_index);
642 if (am->use_tuple_merge)
643 pae->mask_type_index = tm_assign_mask_type_index(am, mask, is_ip6, lc_index);
645 pae->mask_type_index = assign_mask_type_index(am, mask);
649 split_partition(acl_main_t *am, u32 first_index,
650 u32 lc_index, int is_ip6);
654 check_collision_count_and_maybe_split(acl_main_t *am, u32 lc_index, int is_ip6, u32 first_index)
656 applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, lc_index);
657 applied_hash_ace_entry_t *first_pae = vec_elt_at_index((*applied_hash_aces), first_index);
658 if (vec_len(first_pae->colliding_rules) > am->tuple_merge_split_threshold) {
659 split_partition(am, first_index, lc_index, is_ip6);
664 hash_acl_apply(acl_main_t *am, u32 lc_index, int acl_index, u32 acl_position)
668 DBG0("HASH ACL apply: lc_index %d acl %d", lc_index, acl_index);
669 if (!am->acl_lookup_hash_initialized) {
670 BV (clib_bihash_init) (&am->acl_lookup_hash, "ACL plugin rule lookup bihash",
671 am->hash_lookup_hash_buckets, am->hash_lookup_hash_memory);
672 am->acl_lookup_hash_initialized = 1;
675 void *oldheap = hash_acl_set_heap(am);
676 vec_validate(am->hash_entry_vec_by_lc_index, lc_index);
677 vec_validate(am->hash_acl_infos, acl_index);
678 applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, lc_index);
680 hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
681 u32 **hash_acl_applied_lc_index = &ha->lc_index_list;
683 int base_offset = vec_len(*applied_hash_aces);
685 /* Update the bitmap of the mask types with which the lookup
686 needs to happen for the ACLs applied to this lc_index */
687 applied_hash_acl_info_t **applied_hash_acls = &am->applied_hash_acl_info_by_lc_index;
688 vec_validate((*applied_hash_acls), lc_index);
689 applied_hash_acl_info_t *pal = vec_elt_at_index((*applied_hash_acls), lc_index);
691 /* ensure the list of applied hash acls is initialized and add this acl# to it */
692 u32 index = vec_search(pal->applied_acls, acl_index);
694 clib_warning("BUG: trying to apply twice acl_index %d on lc_index %d, according to lc",
695 acl_index, lc_index);
698 vec_add1(pal->applied_acls, acl_index);
699 u32 index2 = vec_search((*hash_acl_applied_lc_index), lc_index);
701 clib_warning("BUG: trying to apply twice acl_index %d on lc_index %d, according to hash h-acl info",
702 acl_index, lc_index);
705 vec_add1((*hash_acl_applied_lc_index), lc_index);
708 * if the applied ACL is empty, the current code will cause a
709 * different behavior compared to current linear search: an empty ACL will
710 * simply fallthrough to the next ACL, or the default deny in the end.
712 * This is not a problem, because after vpp-dev discussion,
713 * the consensus was it should not be possible to apply the non-existent
714 * ACL, so the change adding this code also takes care of that.
717 /* expand the applied aces vector by the necessary amount */
718 vec_resize((*applied_hash_aces), vec_len(ha->rules));
720 vec_validate(am->hash_applied_mask_info_vec_by_lc_index, lc_index);
721 /* add the rules from the ACL to the hash table for lookup and append to the vector*/
722 for(i=0; i < vec_len(ha->rules); i++) {
723 int is_ip6 = ha->rules[i].match.pkt.is_ip6;
724 u32 new_index = base_offset + i;
725 applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), new_index);
726 pae->acl_index = acl_index;
727 pae->ace_index = ha->rules[i].ace_index;
728 pae->acl_position = acl_position;
729 pae->action = ha->rules[i].action;
731 pae->hash_ace_info_index = i;
732 /* we might link it in later */
733 pae->next_applied_entry_index = ~0;
734 pae->prev_applied_entry_index = ~0;
735 pae->tail_applied_entry_index = ~0;
736 pae->colliding_rules = NULL;
737 pae->mask_type_index = ~0;
738 assign_mask_type_index_to_pae(am, lc_index, is_ip6, pae);
739 u32 first_index = activate_applied_ace_hash_entry(am, lc_index, applied_hash_aces, new_index);
740 if (am->use_tuple_merge)
741 check_collision_count_and_maybe_split(am, lc_index, is_ip6, first_index);
743 remake_hash_applied_mask_info_vec(am, applied_hash_aces, lc_index);
745 clib_mem_set_heap (oldheap);
749 find_head_applied_ace_index(applied_hash_ace_entry_t **applied_hash_aces, u32 curr_index)
752 * find back the first entry. Inefficient so might need to be a bit cleverer
753 * if this proves to be a problem..
755 u32 an_index = curr_index;
756 ASSERT(an_index != ~0);
757 applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), an_index);
758 while(head_pae->prev_applied_entry_index != ~0) {
759 an_index = head_pae->prev_applied_entry_index;
760 ASSERT(an_index != ~0);
761 head_pae = vec_elt_at_index((*applied_hash_aces), an_index);
767 move_applied_ace_hash_entry(acl_main_t *am,
769 applied_hash_ace_entry_t **applied_hash_aces,
770 u32 old_index, u32 new_index)
772 ASSERT(old_index != ~0);
773 ASSERT(new_index != ~0);
775 *vec_elt_at_index((*applied_hash_aces), new_index) = *vec_elt_at_index((*applied_hash_aces), old_index);
777 /* update the linkage and hash table if necessary */
778 applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), old_index);
779 applied_hash_ace_entry_t *new_pae = vec_elt_at_index((*applied_hash_aces), new_index);
781 if (ACL_HASH_LOOKUP_DEBUG > 0) {
782 clib_warning("Moving pae from %d to %d", old_index, new_index);
783 acl_plugin_print_pae(am->vlib_main, old_index, pae);
786 if (new_pae->tail_applied_entry_index == old_index) {
787 /* fix-up the tail index if we are the tail and the start */
788 new_pae->tail_applied_entry_index = new_index;
791 if (pae->prev_applied_entry_index != ~0) {
792 applied_hash_ace_entry_t *prev_pae = vec_elt_at_index((*applied_hash_aces), pae->prev_applied_entry_index);
793 ASSERT(prev_pae->next_applied_entry_index == old_index);
794 prev_pae->next_applied_entry_index = new_index;
796 /* first entry - so the hash points to it, update */
797 add_del_hashtable_entry(am, lc_index,
798 applied_hash_aces, new_index, 1);
799 ASSERT(pae->tail_applied_entry_index != ~0);
801 if (pae->next_applied_entry_index != ~0) {
802 applied_hash_ace_entry_t *next_pae = vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
803 ASSERT(next_pae->prev_applied_entry_index == old_index);
804 next_pae->prev_applied_entry_index = new_index;
807 * Moving the very last entry, so we need to update the tail pointer in the first one.
809 u32 head_index = find_head_applied_ace_index(applied_hash_aces, old_index);
810 ASSERT(head_index != ~0);
811 applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), head_index);
813 ASSERT(head_pae->tail_applied_entry_index == old_index);
814 head_pae->tail_applied_entry_index = new_index;
816 if (new_pae->colliding_rules) {
817 /* update the information within the collision rule entry */
818 ASSERT(vec_len(new_pae->colliding_rules) > 0);
819 collision_match_rule_t *cr = vec_elt_at_index (new_pae->colliding_rules, 0);
820 ASSERT(cr->applied_entry_index == old_index);
821 cr->applied_entry_index = new_index;
823 /* find the index in the collision rule entry on the head element */
824 u32 head_index = find_head_applied_ace_index(applied_hash_aces, new_index);
825 ASSERT(head_index != ~0);
826 applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), head_index);
827 ASSERT(vec_len(head_pae->colliding_rules) > 0);
829 for (i=0; i<vec_len(head_pae->colliding_rules); i++) {
830 collision_match_rule_t *cr = vec_elt_at_index (head_pae->colliding_rules, i);
831 if (cr->applied_entry_index == old_index) {
832 cr->applied_entry_index = new_index;
835 if (ACL_HASH_LOOKUP_DEBUG > 0) {
836 clib_warning("Head pae at index %d after adjustment", head_index);
837 acl_plugin_print_pae(am->vlib_main, head_index, head_pae);
840 /* invalidate the old entry */
841 pae->prev_applied_entry_index = ~0;
842 pae->next_applied_entry_index = ~0;
843 pae->tail_applied_entry_index = ~0;
844 pae->colliding_rules = NULL;
848 deactivate_applied_ace_hash_entry(acl_main_t *am,
850 applied_hash_ace_entry_t **applied_hash_aces,
853 applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), old_index);
854 DBG("UNAPPLY DEACTIVATE: lc_index %d applied index %d", lc_index, old_index);
856 if (pae->prev_applied_entry_index != ~0) {
857 DBG("UNAPPLY = index %d has prev_applied_entry_index %d", old_index, pae->prev_applied_entry_index);
858 applied_hash_ace_entry_t *prev_pae = vec_elt_at_index((*applied_hash_aces), pae->prev_applied_entry_index);
859 ASSERT(prev_pae->next_applied_entry_index == old_index);
860 prev_pae->next_applied_entry_index = pae->next_applied_entry_index;
862 u32 head_index = find_head_applied_ace_index(applied_hash_aces, old_index);
863 ASSERT(head_index != ~0);
864 applied_hash_ace_entry_t *head_pae = vec_elt_at_index((*applied_hash_aces), head_index);
865 del_colliding_rule(applied_hash_aces, head_index, old_index);
867 if (pae->next_applied_entry_index == ~0) {
868 /* it was a last entry we removed, update the pointer on the first one */
869 ASSERT(head_pae->tail_applied_entry_index == old_index);
870 head_pae->tail_applied_entry_index = pae->prev_applied_entry_index;
872 applied_hash_ace_entry_t *next_pae = vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
873 next_pae->prev_applied_entry_index = pae->prev_applied_entry_index;
876 /* It was the first entry. We need either to reset the hash entry or delete it */
877 /* delete our entry from the collision vector first */
878 del_colliding_rule(applied_hash_aces, old_index, old_index);
879 if (pae->next_applied_entry_index != ~0) {
880 /* the next element becomes the new first one, so needs the tail pointer to be set */
881 applied_hash_ace_entry_t *next_pae = vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
882 ASSERT(pae->tail_applied_entry_index != ~0);
883 next_pae->tail_applied_entry_index = pae->tail_applied_entry_index;
884 /* Remove ourselves and transfer the ownership of the colliding rules vector */
885 next_pae->colliding_rules = pae->colliding_rules;
886 /* unlink from the next element */
887 next_pae->prev_applied_entry_index = ~0;
888 add_del_hashtable_entry(am, lc_index,
889 applied_hash_aces, pae->next_applied_entry_index, 1);
891 /* no next entry, so just delete the entry in the hash table */
892 add_del_hashtable_entry(am, lc_index,
893 applied_hash_aces, old_index, 0);
897 release_mask_type_index(am, pae->mask_type_index);
898 /* invalidate the old entry */
899 pae->mask_type_index = ~0;
900 pae->prev_applied_entry_index = ~0;
901 pae->next_applied_entry_index = ~0;
902 pae->tail_applied_entry_index = ~0;
903 /* always has to be 0 */
904 pae->colliding_rules = NULL;
909 hash_acl_unapply(acl_main_t *am, u32 lc_index, int acl_index)
913 DBG0("HASH ACL unapply: lc_index %d acl %d", lc_index, acl_index);
914 applied_hash_acl_info_t **applied_hash_acls = &am->applied_hash_acl_info_by_lc_index;
915 applied_hash_acl_info_t *pal = vec_elt_at_index((*applied_hash_acls), lc_index);
917 hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
918 u32 **hash_acl_applied_lc_index = &ha->lc_index_list;
920 /* remove this acl# from the list of applied hash acls */
921 u32 index = vec_search(pal->applied_acls, acl_index);
923 clib_warning("BUG: trying to unapply unapplied acl_index %d on lc_index %d, according to lc",
924 acl_index, lc_index);
927 vec_del1(pal->applied_acls, index);
929 u32 index2 = vec_search((*hash_acl_applied_lc_index), lc_index);
931 clib_warning("BUG: trying to unapply twice acl_index %d on lc_index %d, according to h-acl info",
932 acl_index, lc_index);
935 vec_del1((*hash_acl_applied_lc_index), index2);
937 applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, lc_index);
939 for(i=0; i < vec_len((*applied_hash_aces)); i++) {
940 if (vec_elt_at_index(*applied_hash_aces,i)->acl_index == acl_index) {
941 DBG("Found applied ACL#%d at applied index %d", acl_index, i);
945 if (vec_len((*applied_hash_aces)) <= i) {
946 DBG("Did not find applied ACL#%d at lc_index %d", acl_index, lc_index);
947 /* we went all the way without finding any entries. Probably a list was empty. */
951 void *oldheap = hash_acl_set_heap(am);
953 int tail_offset = base_offset + vec_len(ha->rules);
954 int tail_len = vec_len((*applied_hash_aces)) - tail_offset;
955 DBG("base_offset: %d, tail_offset: %d, tail_len: %d", base_offset, tail_offset, tail_len);
957 for(i=0; i < vec_len(ha->rules); i ++) {
958 deactivate_applied_ace_hash_entry(am, lc_index,
959 applied_hash_aces, base_offset + i);
961 for(i=0; i < tail_len; i ++) {
962 /* move the entry at tail offset to base offset */
963 /* that is, from (tail_offset+i) -> (base_offset+i) */
964 DBG("UNAPPLY MOVE: lc_index %d, applied index %d -> %d", lc_index, tail_offset+i, base_offset + i);
965 move_applied_ace_hash_entry(am, lc_index, applied_hash_aces, tail_offset + i, base_offset + i);
967 /* trim the end of the vector */
968 _vec_len((*applied_hash_aces)) -= vec_len(ha->rules);
970 remake_hash_applied_mask_info_vec(am, applied_hash_aces, lc_index);
972 if (vec_len((*applied_hash_aces)) == 0) {
973 vec_free((*applied_hash_aces));
976 clib_mem_set_heap (oldheap);
980 * Create the applied ACEs and update the hash table,
981 * taking into account that the ACL may not be the last
982 * in the vector of applied ACLs.
984 * For now, walk from the end of the vector and unapply the ACLs,
985 * then apply the one in question and reapply the rest.
989 hash_acl_reapply(acl_main_t *am, u32 lc_index, int acl_index)
991 acl_lookup_context_t *acontext = pool_elt_at_index(am->acl_lookup_contexts, lc_index);
992 u32 **applied_acls = &acontext->acl_indices;
994 int start_index = vec_search((*applied_acls), acl_index);
996 DBG0("Start index for acl %d in lc_index %d is %d", acl_index, lc_index, start_index);
998 * This function is called after we find out the lc_index where ACL is applied.
999 * If the by-lc_index vector does not have the ACL#, then it's a bug.
1001 ASSERT(start_index < vec_len(*applied_acls));
1003 /* unapply all the ACLs at the tail side, up to the current one */
1004 for(i = vec_len(*applied_acls) - 1; i > start_index; i--) {
1005 hash_acl_unapply(am, lc_index, *vec_elt_at_index(*applied_acls, i));
1007 for(i = start_index; i < vec_len(*applied_acls); i++) {
1008 hash_acl_apply(am, lc_index, *vec_elt_at_index(*applied_acls, i), i);
1013 make_ip6_address_mask(ip6_address_t *addr, u8 prefix_len)
1015 ip6_address_mask_from_width(addr, prefix_len);
1019 /* Maybe should be moved into the core somewhere */
1021 ip4_address_mask_from_width (ip4_address_t * a, u32 width)
1023 int i, byte, bit, bitnum;
1024 ASSERT (width <= 32);
1025 memset (a, 0, sizeof (a[0]));
1026 for (i = 0; i < width; i++)
1028 bitnum = (7 - (i & 7));
1031 a->as_u8[byte] |= bit;
1037 make_ip4_address_mask(ip4_address_t *addr, u8 prefix_len)
1039 ip4_address_mask_from_width(addr, prefix_len);
1043 make_port_mask(u16 *portmask, u16 port_first, u16 port_last)
1045 if (port_first == port_last) {
1047 /* single port is representable by masked value */
1056 make_mask_and_match_from_rule(fa_5tuple_t *mask, acl_rule_t *r, hash_ace_info_t *hi)
1058 memset(mask, 0, sizeof(*mask));
1059 memset(&hi->match, 0, sizeof(hi->match));
1060 hi->action = r->is_permit;
1062 /* we will need to be matching based on lc_index and mask_type_index when applied */
1063 mask->pkt.lc_index = ~0;
1064 /* we will assign the match of mask_type_index later when we find it*/
1065 mask->pkt.mask_type_index_lsb = ~0;
1067 mask->pkt.is_ip6 = 1;
1068 hi->match.pkt.is_ip6 = r->is_ipv6;
1070 make_ip6_address_mask(&mask->ip6_addr[0], r->src_prefixlen);
1071 hi->match.ip6_addr[0] = r->src.ip6;
1072 make_ip6_address_mask(&mask->ip6_addr[1], r->dst_prefixlen);
1073 hi->match.ip6_addr[1] = r->dst.ip6;
1075 memset(hi->match.l3_zero_pad, 0, sizeof(hi->match.l3_zero_pad));
1076 make_ip4_address_mask(&mask->ip4_addr[0], r->src_prefixlen);
1077 hi->match.ip4_addr[0] = r->src.ip4;
1078 make_ip4_address_mask(&mask->ip4_addr[1], r->dst_prefixlen);
1079 hi->match.ip4_addr[1] = r->dst.ip4;
1082 if (r->proto != 0) {
1083 mask->l4.proto = ~0; /* L4 proto needs to be matched */
1084 hi->match.l4.proto = r->proto;
1086 /* Calculate the src/dst port masks and make the src/dst port matches accordingly */
1087 make_port_mask(&mask->l4.port[0], r->src_port_or_type_first, r->src_port_or_type_last);
1088 hi->match.l4.port[0] = r->src_port_or_type_first & mask->l4.port[0];
1090 make_port_mask(&mask->l4.port[1], r->dst_port_or_code_first, r->dst_port_or_code_last);
1091 hi->match.l4.port[1] = r->dst_port_or_code_first & mask->l4.port[1];
1092 /* L4 info must be valid in order to match */
1093 mask->pkt.l4_valid = 1;
1094 hi->match.pkt.l4_valid = 1;
1095 /* And we must set the mask to check that it is an initial fragment */
1096 mask->pkt.is_nonfirst_fragment = 1;
1097 hi->match.pkt.is_nonfirst_fragment = 0;
1098 if ((r->proto == IPPROTO_TCP) && (r->tcp_flags_mask != 0)) {
1099 /* if we want to match on TCP flags, they must be masked off as well */
1100 mask->pkt.tcp_flags = r->tcp_flags_mask;
1101 hi->match.pkt.tcp_flags = r->tcp_flags_value;
1102 /* and the flags need to be present within the packet being matched */
1103 mask->pkt.tcp_flags_valid = 1;
1104 hi->match.pkt.tcp_flags_valid = 1;
1107 /* Sanitize the mask and the match */
1108 u64 *pmask = (u64 *)mask;
1109 u64 *pmatch = (u64 *)&hi->match;
1111 for(j=0; j<6; j++) {
1112 pmatch[j] = pmatch[j] & pmask[j];
1117 int hash_acl_exists(acl_main_t *am, int acl_index)
1119 if (acl_index >= vec_len(am->hash_acl_infos))
1122 hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
1123 return ha->hash_acl_exists;
1126 void hash_acl_add(acl_main_t *am, int acl_index)
1128 void *oldheap = hash_acl_set_heap(am);
1129 DBG("HASH ACL add : %d", acl_index);
1131 acl_list_t *a = &am->acls[acl_index];
1132 vec_validate(am->hash_acl_infos, acl_index);
1133 hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
1134 memset(ha, 0, sizeof(*ha));
1135 ha->hash_acl_exists = 1;
1137 /* walk the newly added ACL entries and ensure that for each of them there
1138 is a mask type, increment a reference count for that mask type */
1139 for(i=0; i < a->count; i++) {
1140 hash_ace_info_t ace_info;
1142 memset(&ace_info, 0, sizeof(ace_info));
1143 ace_info.acl_index = acl_index;
1144 ace_info.ace_index = i;
1146 make_mask_and_match_from_rule(&mask, &a->rules[i], &ace_info);
1147 mask.pkt.flags_reserved = 0b000;
1148 ace_info.base_mask_type_index = assign_mask_type_index(am, &mask);
1149 /* assign the mask type index for matching itself */
1150 ace_info.match.pkt.mask_type_index_lsb = ace_info.base_mask_type_index;
1151 DBG("ACE: %d mask_type_index: %d", i, ace_info.base_mask_type_index);
1152 vec_add1(ha->rules, ace_info);
1155 * if an ACL is applied somewhere, fill the corresponding lookup data structures.
1156 * We need to take care if the ACL is not the last one in the vector of ACLs applied to the interface.
1158 if (acl_index < vec_len(am->lc_index_vec_by_acl)) {
1160 vec_foreach(lc_index, am->lc_index_vec_by_acl[acl_index]) {
1161 hash_acl_reapply(am, *lc_index, acl_index);
1164 clib_mem_set_heap (oldheap);
1167 void hash_acl_delete(acl_main_t *am, int acl_index)
1169 void *oldheap = hash_acl_set_heap(am);
1170 DBG0("HASH ACL delete : %d", acl_index);
1172 * If the ACL is applied somewhere, remove the references of it (call hash_acl_unapply)
1173 * this is a different behavior from the linear lookup where an empty ACL is "deny all",
1175 * However, following vpp-dev discussion the ACL that is referenced elsewhere
1176 * should not be possible to delete, and the change adding this also adds
1177 * the safeguards to that respect, so this is not a problem.
1179 * The part to rememeber is that this routine is called in process of reapplication
1180 * during the acl_add_replace() API call - the old acl ruleset is deleted, then
1181 * the new one is added, without the change in the applied ACLs - so this case
1182 * has to be handled.
1184 hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, acl_index);
1185 u32 *lc_list_copy = 0;
1188 lc_list_copy = vec_dup(ha->lc_index_list);
1189 vec_foreach(lc_index, lc_list_copy) {
1190 hash_acl_unapply(am, *lc_index, acl_index);
1192 vec_free(lc_list_copy);
1194 vec_free(ha->lc_index_list);
1196 /* walk the mask types for the ACL about-to-be-deleted, and decrease
1197 * the reference count, possibly freeing up some of them */
1199 for(i=0; i < vec_len(ha->rules); i++) {
1200 release_mask_type_index(am, ha->rules[i].base_mask_type_index);
1202 ha->hash_acl_exists = 0;
1203 vec_free(ha->rules);
1204 clib_mem_set_heap (oldheap);
1209 show_hash_acl_hash (vlib_main_t * vm, acl_main_t *am, u32 verbose)
1211 vlib_cli_output(vm, "\nACL lookup hash table:\n%U\n",
1212 BV (format_bihash), &am->acl_lookup_hash, verbose);
1216 acl_plugin_show_tables_mask_type (void)
1218 acl_main_t *am = &acl_main;
1219 vlib_main_t *vm = am->vlib_main;
1220 ace_mask_type_entry_t *mte;
1222 vlib_cli_output (vm, "Mask-type entries:");
1224 pool_foreach(mte, am->ace_mask_type_pool,
1226 vlib_cli_output(vm, " %3d: %016llx %016llx %016llx %016llx %016llx %016llx refcount %d",
1227 mte - am->ace_mask_type_pool,
1228 mte->mask.kv_40_8.key[0], mte->mask.kv_40_8.key[1], mte->mask.kv_40_8.key[2],
1229 mte->mask.kv_40_8.key[3], mte->mask.kv_40_8.key[4], mte->mask.kv_40_8.value, mte->refcount);
1235 acl_plugin_show_tables_acl_hash_info (u32 acl_index)
1237 acl_main_t *am = &acl_main;
1238 vlib_main_t *vm = am->vlib_main;
1241 vlib_cli_output (vm, "Mask-ready ACL representations\n");
1242 for (i = 0; i < vec_len (am->hash_acl_infos); i++)
1244 if ((acl_index != ~0) && (acl_index != i))
1248 hash_acl_info_t *ha = &am->hash_acl_infos[i];
1249 vlib_cli_output (vm, "acl-index %u bitmask-ready layout\n", i);
1250 vlib_cli_output (vm, " applied lc_index list: %U\n",
1251 format_vec32, ha->lc_index_list, "%d");
1252 for (j = 0; j < vec_len (ha->rules); j++)
1254 hash_ace_info_t *pa = &ha->rules[j];
1255 m = (u64 *) & pa->match;
1256 vlib_cli_output (vm,
1257 " %4d: %016llx %016llx %016llx %016llx %016llx %016llx base mask index %d acl %d rule %d action %d\n",
1258 j, m[0], m[1], m[2], m[3], m[4], m[5],
1259 pa->base_mask_type_index, pa->acl_index, pa->ace_index,
1266 acl_plugin_print_colliding_rule (vlib_main_t * vm, int j, collision_match_rule_t *cr) {
1268 " %4d: acl %d ace %d acl pos %d pae index: %d",
1269 j, cr->acl_index, cr->ace_index, cr->acl_position, cr->applied_entry_index);
1273 acl_plugin_print_pae (vlib_main_t * vm, int j, applied_hash_ace_entry_t * pae)
1275 vlib_cli_output (vm,
1276 " %4d: acl %d rule %d action %d bitmask-ready rule %d colliding_rules: %d next %d prev %d tail %d hitcount %lld acl_pos: %d",
1277 j, pae->acl_index, pae->ace_index, pae->action,
1278 pae->hash_ace_info_index, vec_len(pae->colliding_rules), pae->next_applied_entry_index,
1279 pae->prev_applied_entry_index,
1280 pae->tail_applied_entry_index, pae->hitcount, pae->acl_position);
1282 for(jj=0; jj<vec_len(pae->colliding_rules); jj++)
1283 acl_plugin_print_colliding_rule(vm, jj, vec_elt_at_index(pae->colliding_rules, jj));
1287 acl_plugin_print_applied_mask_info (vlib_main_t * vm, int j, hash_applied_mask_info_t *mi)
1289 vlib_cli_output (vm,
1290 " %4d: mask type index %d first rule index %d num_entries %d max_collisions %d",
1291 j, mi->mask_type_index, mi->first_rule_index, mi->num_entries, mi->max_collisions);
1295 acl_plugin_show_tables_applied_info (u32 lc_index)
1297 acl_main_t *am = &acl_main;
1298 vlib_main_t *vm = am->vlib_main;
1300 vlib_cli_output (vm, "Applied lookup entries for lookup contexts");
1303 (lci < vec_len(am->applied_hash_acl_info_by_lc_index)); lci++)
1305 if ((lc_index != ~0) && (lc_index != lci))
1309 vlib_cli_output (vm, "lc_index %d:", lci);
1310 if (lci < vec_len (am->applied_hash_acl_info_by_lc_index))
1312 applied_hash_acl_info_t *pal =
1313 &am->applied_hash_acl_info_by_lc_index[lci];
1314 vlib_cli_output (vm, " applied acls: %U", format_vec32,
1315 pal->applied_acls, "%d");
1317 if (lci < vec_len (am->hash_applied_mask_info_vec_by_lc_index))
1319 vlib_cli_output (vm, " applied mask info entries:");
1321 j < vec_len (am->hash_applied_mask_info_vec_by_lc_index[lci]);
1324 acl_plugin_print_applied_mask_info (vm, j,
1325 &am->hash_applied_mask_info_vec_by_lc_index
1329 if (lci < vec_len (am->hash_entry_vec_by_lc_index))
1331 vlib_cli_output (vm, " lookup applied entries:");
1333 j < vec_len (am->hash_entry_vec_by_lc_index[lci]);
1336 acl_plugin_print_pae (vm, j,
1337 &am->hash_entry_vec_by_lc_index
1345 acl_plugin_show_tables_bihash (u32 show_bihash_verbose)
1347 acl_main_t *am = &acl_main;
1348 vlib_main_t *vm = am->vlib_main;
1349 show_hash_acl_hash (vm, am, show_bihash_verbose);
1353 * Split of the partition needs to happen when the collision count
1354 * goes over a specified threshold.
1356 * This is a signal that we ignored too many bits in
1357 * mT and we need to split the table into two tables. We select
1358 * all of the colliding rules L and find their maximum common
1359 * tuple mL. Normally mL is specific enough to hash L with few
1360 * or no collisions. We then create a new table T2 with tuple mL
1361 * and transfer all compatible rules from T to T2. If mL is not
1362 * specific enough, we find the field with the biggest difference
1363 * between the minimum and maximum tuple lengths for all of
1364 * the rules in L and set that field to be the average of those two
1365 * values. We then transfer all compatible rules as before. This
1366 * guarantees that some rules from L will move and that T2 will
1367 * have a smaller number of collisions than T did.
1372 ensure_ip6_min_addr (ip6_address_t * min_addr, ip6_address_t * mask_addr)
1375 (clib_net_to_host_u64 (mask_addr->as_u64[0]) <
1376 clib_net_to_host_u64 (min_addr->as_u64[0]))
1378 ((clib_net_to_host_u64 (mask_addr->as_u64[0]) ==
1379 clib_net_to_host_u64 (min_addr->as_u64[0]))
1380 && (clib_net_to_host_u64 (mask_addr->as_u64[1]) <
1381 clib_net_to_host_u64 (min_addr->as_u64[1])));
1384 min_addr->as_u64[0] = mask_addr->as_u64[0];
1385 min_addr->as_u64[1] = mask_addr->as_u64[1];
1390 ensure_ip6_max_addr (ip6_address_t * max_addr, ip6_address_t * mask_addr)
1393 (clib_net_to_host_u64 (mask_addr->as_u64[0]) >
1394 clib_net_to_host_u64 (max_addr->as_u64[0]))
1396 ((clib_net_to_host_u64 (mask_addr->as_u64[0]) ==
1397 clib_net_to_host_u64 (max_addr->as_u64[0]))
1398 && (clib_net_to_host_u64 (mask_addr->as_u64[1]) >
1399 clib_net_to_host_u64 (max_addr->as_u64[1])));
1402 max_addr->as_u64[0] = mask_addr->as_u64[0];
1403 max_addr->as_u64[1] = mask_addr->as_u64[1];
1408 ensure_ip4_min_addr (ip4_address_t * min_addr, ip4_address_t * mask_addr)
1411 (clib_net_to_host_u32 (mask_addr->as_u32) <
1412 clib_net_to_host_u32 (min_addr->as_u32));
1414 min_addr->as_u32 = mask_addr->as_u32;
1418 ensure_ip4_max_addr (ip4_address_t * max_addr, ip4_address_t * mask_addr)
1421 (clib_net_to_host_u32 (mask_addr->as_u32) >
1422 clib_net_to_host_u32 (max_addr->as_u32));
1424 max_addr->as_u32 = mask_addr->as_u32;
1438 split_partition(acl_main_t *am, u32 first_index,
1439 u32 lc_index, int is_ip6){
1440 DBG( "TM-split_partition - first_entry:%d", first_index);
1441 applied_hash_ace_entry_t **applied_hash_aces = get_applied_hash_aces(am, lc_index);
1442 ace_mask_type_entry_t *mte;
1443 fa_5tuple_t the_min_tuple, *min_tuple = &the_min_tuple;
1444 fa_5tuple_t the_max_tuple, *max_tuple = &the_max_tuple;
1445 applied_hash_ace_entry_t *pae = vec_elt_at_index((*applied_hash_aces), first_index);
1446 hash_acl_info_t *ha = vec_elt_at_index(am->hash_acl_infos, pae->acl_index);
1447 hash_ace_info_t *ace_info;
1448 u32 coll_mask_type_index = pae->mask_type_index;
1449 memset(&the_min_tuple, 0, sizeof(the_min_tuple));
1450 memset(&the_max_tuple, 0, sizeof(the_max_tuple));
1453 u64 collisions = vec_len(pae->colliding_rules);
1454 // while(pae->next_applied_entry_index == ~0){
1455 for(i=0; i<collisions; i++){
1457 DBG( "TM-collision: base_ace:%d (ace_mask:%d, first_collision_mask:%d)",
1458 pae->ace_index, pae->mask_type_index, coll_mask_type_index);
1460 ace_info = vec_elt_at_index(ha->rules, pae->hash_ace_info_index);
1461 mte = vec_elt_at_index(am->ace_mask_type_pool, ace_info->base_mask_type_index);
1462 fa_5tuple_t *mask = &mte->mask;
1464 if(pae->mask_type_index != coll_mask_type_index) continue;
1465 /* Computing min_mask and max_mask for colliding rules */
1467 clib_memcpy(min_tuple, mask, sizeof(fa_5tuple_t));
1468 clib_memcpy(max_tuple, mask, sizeof(fa_5tuple_t));
1473 ensure_ip6_min_addr(&min_tuple->ip6_addr[j], &mask->ip6_addr[j]);
1475 ensure_ip4_min_addr(&min_tuple->ip4_addr[j], &mask->ip4_addr[j]);
1477 if ((mask->l4.port[j] < min_tuple->l4.port[j]))
1478 min_tuple->l4.port[j] = mask->l4.port[j];
1481 if ((mask->l4.proto < min_tuple->l4.proto))
1482 min_tuple->l4.proto = mask->l4.proto;
1484 if(mask->pkt.as_u64 < min_tuple->pkt.as_u64)
1485 min_tuple->pkt.as_u64 = mask->pkt.as_u64;
1490 ensure_ip6_max_addr(&max_tuple->ip6_addr[j], &mask->ip6_addr[j]);
1492 ensure_ip4_max_addr(&max_tuple->ip4_addr[j], &mask->ip4_addr[j]);
1494 if ((mask->l4.port[j] > max_tuple->l4.port[j]))
1495 max_tuple->l4.port[j] = mask->l4.port[j];
1498 if ((mask->l4.proto < max_tuple->l4.proto))
1499 max_tuple->l4.proto = mask->l4.proto;
1501 if(mask->pkt.as_u64 > max_tuple->pkt.as_u64)
1502 max_tuple->pkt.as_u64 = mask->pkt.as_u64;
1505 pae = vec_elt_at_index((*applied_hash_aces), pae->next_applied_entry_index);
1508 /* Computing field with max difference between (min/max)_mask */
1509 int best_dim=-1, best_delta=0, delta=0;
1511 /* SRC_addr dimension */
1515 delta += count_bits(max_tuple->ip6_addr[0].as_u64[i]) - count_bits(min_tuple->ip6_addr[0].as_u64[i]);
1518 delta += count_bits(max_tuple->ip4_addr[0].as_u32) - count_bits(min_tuple->ip4_addr[0].as_u32);
1520 if(delta > best_delta){
1522 best_dim = DIM_SRC_ADDR;
1525 /* DST_addr dimension */
1530 delta += count_bits(max_tuple->ip6_addr[1].as_u64[i]) - count_bits(min_tuple->ip6_addr[1].as_u64[i]);
1533 delta += count_bits(max_tuple->ip4_addr[1].as_u32) - count_bits(min_tuple->ip4_addr[1].as_u32);
1535 if(delta > best_delta){
1537 best_dim = DIM_DST_ADDR;
1540 /* SRC_port dimension */
1541 delta = count_bits(max_tuple->l4.port[0]) - count_bits(min_tuple->l4.port[0]);
1542 if(delta > best_delta){
1544 best_dim = DIM_SRC_PORT;
1547 /* DST_port dimension */
1548 delta = count_bits(max_tuple->l4.port[1]) - count_bits(min_tuple->l4.port[1]);
1549 if(delta > best_delta){
1551 best_dim = DIM_DST_PORT;
1554 /* Proto dimension */
1555 delta = count_bits(max_tuple->l4.proto) - count_bits(min_tuple->l4.proto);
1556 if(delta > best_delta){
1558 best_dim = DIM_PROTO;
1561 int shifting = 0; //, ipv4_block = 0;
1564 shifting = (best_delta)/2; // FIXME IPV4-only
1565 // ipv4_block = count_bits(max_tuple->ip4_addr[0].as_u32);
1566 min_tuple->ip4_addr[0].as_u32 =
1567 clib_host_to_net_u32((clib_net_to_host_u32(max_tuple->ip4_addr[0].as_u32) << (shifting))&0xFFFFFFFF);
1571 shifting = (best_delta)/2;
1573 ipv4_block = count_bits(max_tuple->addr[1].as_u64[1]);
1574 if(ipv4_block > shifting)
1575 min_tuple->addr[1].as_u64[1] =
1576 clib_host_to_net_u64((clib_net_to_host_u64(max_tuple->addr[1].as_u64[1]) << (shifting))&0xFFFFFFFF);
1578 shifting = shifting - ipv4_block;
1579 min_tuple->addr[1].as_u64[1] = 0;
1580 min_tuple->addr[1].as_u64[0] =
1581 clib_host_to_net_u64((clib_net_to_host_u64(max_tuple->addr[1].as_u64[0]) << (shifting))&0xFFFFFFFF);
1584 min_tuple->ip4_addr[1].as_u32 =
1585 clib_host_to_net_u32((clib_net_to_host_u32(max_tuple->ip4_addr[1].as_u32) << (shifting))&0xFFFFFFFF);
1588 case DIM_SRC_PORT: min_tuple->l4.port[0] = max_tuple->l4.port[0] << (best_delta)/2;
1590 case DIM_DST_PORT: min_tuple->l4.port[1] = max_tuple->l4.port[1] << (best_delta)/2;
1592 case DIM_PROTO: min_tuple->l4.proto = max_tuple->l4.proto << (best_delta)/2;
1594 default: relax_tuple(min_tuple, is_ip6, 1);
1598 min_tuple->pkt.is_nonfirst_fragment = 0;
1599 u32 new_mask_type_index = assign_mask_type_index(am, min_tuple);
1601 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);
1603 hash_applied_mask_info_t *minfo;
1604 //search in order pool if mask_type_index is already there
1606 for (search=0; search < vec_len((*hash_applied_mask_info_vec)); search++){
1607 minfo = vec_elt_at_index((*hash_applied_mask_info_vec), search);
1608 if(minfo->mask_type_index == new_mask_type_index)
1612 vec_validate((*hash_applied_mask_info_vec), search);
1613 minfo = vec_elt_at_index((*hash_applied_mask_info_vec), search);
1614 minfo->mask_type_index = new_mask_type_index;
1615 minfo->num_entries = 0;
1616 minfo->max_collisions = 0;
1617 minfo->first_rule_index = ~0;
1619 DBG( "TM-split_partition - mask type index-assigned!! -> %d", new_mask_type_index);
1621 if(coll_mask_type_index == new_mask_type_index){
1622 //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);
1627 /* populate new partition */
1628 DBG( "TM-Populate new partition");
1629 u32 r_ace_index = first_index;
1631 // for(i=0; i<collisions; i++){
1632 for(r_ace_index=0; r_ace_index < vec_len((*applied_hash_aces)); r_ace_index++) {
1634 applied_hash_ace_entry_t *pop_pae = vec_elt_at_index((*applied_hash_aces), r_ace_index);
1635 DBG( "TM-Population-collision: base_ace:%d (ace_mask:%d, first_collision_mask:%d)",
1636 pop_pae->ace_index, pop_pae->mask_type_index, coll_mask_type_index);
1638 if(pop_pae->mask_type_index != coll_mask_type_index) continue;
1639 u32 next_index = pop_pae->next_applied_entry_index;
1641 ace_info = vec_elt_at_index(ha->rules, pop_pae->hash_ace_info_index);
1642 mte = vec_elt_at_index(am->ace_mask_type_pool, ace_info->base_mask_type_index);
1644 //mte = vec_elt_at_index(am->ace_mask_type_pool, pop_pae->mask_type_index);
1645 fa_5tuple_t *pop_mask = &mte->mask;
1647 if(!first_mask_contains_second_mask(is_ip6, min_tuple, pop_mask)) continue;
1648 DBG( "TM-new partition can insert -> applied_ace:%d", r_ace_index);
1650 //delete and insert in new format
1651 deactivate_applied_ace_hash_entry(am, lc_index, applied_hash_aces, r_ace_index);
1653 /* insert the new entry */
1654 pop_pae->mask_type_index = new_mask_type_index;
1656 activate_applied_ace_hash_entry(am, lc_index, applied_hash_aces, r_ace_index);
1658 r_ace_index = next_index;
1661 DBG( "TM-Populate new partition-END");
1662 DBG( "TM-split_partition - END");