2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * ip/ip_lookup.c: ip4/6 adjacency and lookup table managment
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #include <vppinfra/math.h> /* for fabs */
41 #include <vnet/ip/ip.h>
42 #include <vnet/ip/adj_alloc.h>
45 ip_multipath_del_adjacency (ip_lookup_main_t * lm, u32 del_adj_index);
48 ip_poison_adjacencies (ip_adjacency_t * adj, uword n_adj)
52 u32 save_handle = adj->heap_handle;;
53 u32 save_n_adj = adj->n_adj;
55 memset (adj, 0xfe, n_adj * sizeof (adj[0]));
57 adj->heap_handle = save_handle;
58 adj->n_adj = save_n_adj;
63 ip_share_adjacency(ip_lookup_main_t * lm, u32 adj_index)
65 ip_adjacency_t * adj = ip_get_adjacency(lm, adj_index);
68 uword signature = vnet_ip_adjacency_signature (adj);
70 p = hash_get (lm->adj_index_by_signature, signature);
74 /* Save the adj index, p[0] will be toast after the unset! */
76 hash_unset (lm->adj_index_by_signature, signature);
77 hash_set (lm->adj_index_by_signature, signature, adj_index);
78 adj->next_adj_with_signature = old_ai;
82 adj->next_adj_with_signature = 0;
83 hash_set (lm->adj_index_by_signature, signature, adj_index);
88 ip_unshare_adjacency(ip_lookup_main_t * lm, u32 adj_index)
90 ip_adjacency_t * adj = ip_get_adjacency(lm, adj_index);
94 ip_adjacency_t * this_adj, * prev_adj = 0;
96 signature = vnet_ip_adjacency_signature (adj);
97 p = hash_get (lm->adj_index_by_signature, signature);
102 /* At the top of the signature chain (likely)? */
103 if (this_ai == adj_index)
105 if (adj->next_adj_with_signature == 0)
107 hash_unset (lm->adj_index_by_signature, signature);
112 this_adj = ip_get_adjacency (lm, adj->next_adj_with_signature);
113 hash_unset (lm->adj_index_by_signature, signature);
114 hash_set (lm->adj_index_by_signature, signature,
115 this_adj->heap_handle);
118 else /* walk signature chain */
120 this_adj = ip_get_adjacency (lm, this_ai);
121 while (this_adj != adj)
124 this_adj = ip_get_adjacency
125 (lm, this_adj->next_adj_with_signature);
127 * This can happen when creating the first multipath adj of a set
128 * We end up looking at the miss adjacency (handle==0).
130 if (this_adj->heap_handle == 0)
133 prev_adj->next_adj_with_signature = this_adj->next_adj_with_signature;
137 /* Create new block of given number of contiguous adjacencies. */
139 ip_add_adjacency (ip_lookup_main_t * lm,
140 ip_adjacency_t * copy_adj,
142 u32 * adj_index_return)
144 ip_adjacency_t * adj;
147 /* See if we know enough to attempt to share an existing adjacency */
148 if (copy_adj && n_adj == 1)
153 switch (copy_adj->lookup_next_index)
155 case IP_LOOKUP_NEXT_DROP:
156 if (lm->drop_adj_index)
158 adj = ip_get_adjacency (lm, lm->drop_adj_index);
159 *adj_index_return = lm->drop_adj_index;
164 case IP_LOOKUP_NEXT_LOCAL:
165 if (lm->local_adj_index)
167 adj = ip_get_adjacency (lm, lm->local_adj_index);
168 *adj_index_return = lm->local_adj_index;
175 signature = vnet_ip_adjacency_signature (copy_adj);
176 p = hash_get (lm->adj_index_by_signature, signature);
179 adj = vec_elt_at_index (lm->adjacency_heap, p[0]);
182 if (vnet_ip_adjacency_share_compare (adj, copy_adj))
185 *adj_index_return = p[0];
188 if (adj->next_adj_with_signature == 0)
190 adj = vec_elt_at_index (lm->adjacency_heap,
191 adj->next_adj_with_signature);
196 lm->adjacency_heap = aa_alloc (lm->adjacency_heap, &adj, n_adj);
197 handle = ai = adj->heap_handle;
199 ip_poison_adjacencies (adj, n_adj);
201 /* Validate adjacency counters. */
202 vlib_validate_combined_counter (&lm->adjacency_counters, ai + n_adj - 1);
204 for (i = 0; i < n_adj; i++)
206 /* Make sure certain fields are always initialized. */
207 adj[i].rewrite_header.sw_if_index = ~0;
208 adj[i].explicit_fib_index = ~0;
209 adj[i].mcast_group_index = ~0;
210 adj[i].classify.table_index = ~0;
211 adj[i].saved_lookup_next_index = 0;
214 adj[i] = copy_adj[i];
216 adj[i].heap_handle = handle;
217 adj[i].n_adj = n_adj;
218 adj[i].share_count = 0;
219 adj[i].next_adj_with_signature = 0;
221 /* Zero possibly stale counters for re-used adjacencies. */
222 vlib_zero_combined_counter (&lm->adjacency_counters, ai + i);
225 /* Set up to share the adj later */
226 if (copy_adj && n_adj == 1)
227 ip_share_adjacency(lm, ai);
229 *adj_index_return = ai;
234 ip_update_adjacency (ip_lookup_main_t * lm,
236 ip_adjacency_t * copy_adj)
238 ip_adjacency_t * adj = ip_get_adjacency(lm, adj_index);
240 ip_call_add_del_adjacency_callbacks (lm, adj_index, /* is_del */ 1);
241 ip_unshare_adjacency(lm, adj_index);
243 /* temporary redirect to drop while updating rewrite data */
244 adj->lookup_next_index = IP_LOOKUP_NEXT_ARP;
245 CLIB_MEMORY_BARRIER();
247 clib_memcpy (&adj->rewrite_header, ©_adj->rewrite_header,
248 VLIB_BUFFER_PRE_DATA_SIZE);
249 adj->lookup_next_index = copy_adj->lookup_next_index;
250 ip_share_adjacency(lm, adj_index);
251 ip_call_add_del_adjacency_callbacks (lm, adj_index, /* is_del */ 0);
254 static void ip_del_adjacency2 (ip_lookup_main_t * lm, u32 adj_index, u32 delete_multipath_adjacency)
256 ip_adjacency_t * adj;
258 ip_call_add_del_adjacency_callbacks (lm, adj_index, /* is_del */ 1);
260 adj = ip_get_adjacency (lm, adj_index);
262 /* Special-case miss, local, drop adjs */
268 if (adj->share_count > 0)
274 ip_unshare_adjacency(lm, adj_index);
277 if (delete_multipath_adjacency)
278 ip_multipath_del_adjacency (lm, adj_index);
280 ip_poison_adjacencies (adj, adj->n_adj);
282 aa_free (lm->adjacency_heap, adj);
285 void ip_del_adjacency (ip_lookup_main_t * lm, u32 adj_index)
286 { ip_del_adjacency2 (lm, adj_index, /* delete_multipath_adjacency */ 1); }
289 next_hop_sort_by_weight (ip_multipath_next_hop_t * n1,
290 ip_multipath_next_hop_t * n2)
292 int cmp = (int) n1->weight - (int) n2->weight;
294 ? (int) n1->next_hop_adj_index - (int) n2->next_hop_adj_index
295 : (cmp > 0 ? +1 : -1));
298 /* Given next hop vector is over-written with normalized one with sorted weights and
299 with weights corresponding to the number of adjacencies for each next hop.
300 Returns number of adjacencies in block. */
301 static u32 ip_multipath_normalize_next_hops (ip_lookup_main_t * lm,
302 ip_multipath_next_hop_t * raw_next_hops,
303 ip_multipath_next_hop_t ** normalized_next_hops)
305 ip_multipath_next_hop_t * nhs;
306 uword n_nhs, n_adj, n_adj_left, i;
307 f64 sum_weight, norm, error;
309 n_nhs = vec_len (raw_next_hops);
314 /* Allocate enough space for 2 copies; we'll use second copy to save original weights. */
315 nhs = *normalized_next_hops;
316 vec_validate (nhs, 2*n_nhs - 1);
318 /* Fast path: 1 next hop in block. */
322 nhs[0] = raw_next_hops[0];
330 int cmp = next_hop_sort_by_weight (&raw_next_hops[0], &raw_next_hops[1]) < 0;
333 nhs[0] = raw_next_hops[cmp];
334 nhs[1] = raw_next_hops[cmp ^ 1];
336 /* Fast path: equal cost multipath with 2 next hops. */
337 if (nhs[0].weight == nhs[1].weight)
339 nhs[0].weight = nhs[1].weight = 1;
346 clib_memcpy (nhs, raw_next_hops, n_nhs * sizeof (raw_next_hops[0]));
347 qsort (nhs, n_nhs, sizeof (nhs[0]), (void *) next_hop_sort_by_weight);
350 /* Find total weight to normalize weights. */
352 for (i = 0; i < n_nhs; i++)
353 sum_weight += nhs[i].weight;
355 /* In the unlikely case that all weights are given as 0, set them all to 1. */
358 for (i = 0; i < n_nhs; i++)
363 /* Save copies of all next hop weights to avoid being overwritten in loop below. */
364 for (i = 0; i < n_nhs; i++)
365 nhs[n_nhs + i].weight = nhs[i].weight;
367 /* Try larger and larger power of 2 sized adjacency blocks until we
368 find one where traffic flows to within 1% of specified weights. */
369 for (n_adj = max_pow2 (n_nhs); ; n_adj *= 2)
373 norm = n_adj / sum_weight;
375 for (i = 0; i < n_nhs; i++)
377 f64 nf = nhs[n_nhs + i].weight * norm; /* use saved weights */
378 word n = flt_round_nearest (nf);
380 n = n > n_adj_left ? n_adj_left : n;
382 error += fabs (nf - n);
386 nhs[0].weight += n_adj_left;
388 /* Less than 5% average error per adjacency with this size adjacency block? */
389 if (error <= lm->multipath_next_hop_error_tolerance*n_adj)
391 /* Truncate any next hops with zero weight. */
398 /* Save vector for next call. */
399 *normalized_next_hops = nhs;
404 ip_next_hop_hash_key_from_handle (uword handle)
405 { return 1 + 2*handle; }
408 ip_next_hop_hash_key_is_heap_handle (uword k)
412 ip_next_hop_hash_key_get_heap_handle (uword k)
414 ASSERT (ip_next_hop_hash_key_is_heap_handle (k));
419 ip_multipath_adjacency_get (ip_lookup_main_t * lm,
420 ip_multipath_next_hop_t * raw_next_hops,
421 uword create_if_non_existent)
424 u32 i, j, n_adj, adj_index, adj_heap_handle;
425 ip_adjacency_t * adj, * copy_adj;
426 ip_multipath_next_hop_t * nh, * nhs;
427 ip_multipath_adjacency_t * madj;
429 n_adj = ip_multipath_normalize_next_hops (lm, raw_next_hops, &lm->next_hop_hash_lookup_key_normalized);
430 nhs = lm->next_hop_hash_lookup_key_normalized;
433 ASSERT (n_adj >= vec_len (raw_next_hops));
435 /* Use normalized next hops to see if we've seen a block equivalent to this one before. */
436 p = hash_get_mem (lm->multipath_adjacency_by_next_hops, nhs);
440 if (! create_if_non_existent)
443 adj = ip_add_adjacency (lm, /* copy_adj */ 0, n_adj, &adj_index);
444 adj_heap_handle = adj[0].heap_handle;
446 /* Fill in adjacencies in block based on corresponding next hop adjacencies. */
448 vec_foreach (nh, nhs)
450 copy_adj = ip_get_adjacency (lm, nh->next_hop_adj_index);
451 for (j = 0; j < nh->weight; j++)
453 adj[i] = copy_adj[0];
454 adj[i].heap_handle = adj_heap_handle;
455 adj[i].n_adj = n_adj;
460 /* All adjacencies should have been initialized. */
463 vec_validate (lm->multipath_adjacencies, adj_heap_handle);
464 madj = vec_elt_at_index (lm->multipath_adjacencies, adj_heap_handle);
466 madj->adj_index = adj_index;
467 madj->n_adj_in_block = n_adj;
468 madj->reference_count = 0; /* caller will set to one. */
470 madj->normalized_next_hops.count = vec_len (nhs);
471 madj->normalized_next_hops.heap_offset
472 = heap_alloc (lm->next_hop_heap, vec_len (nhs),
473 madj->normalized_next_hops.heap_handle);
474 clib_memcpy (lm->next_hop_heap + madj->normalized_next_hops.heap_offset,
475 nhs, vec_bytes (nhs));
477 hash_set (lm->multipath_adjacency_by_next_hops,
478 ip_next_hop_hash_key_from_handle (madj->normalized_next_hops.heap_handle),
479 madj - lm->multipath_adjacencies);
481 madj->unnormalized_next_hops.count = vec_len (raw_next_hops);
482 madj->unnormalized_next_hops.heap_offset
483 = heap_alloc (lm->next_hop_heap, vec_len (raw_next_hops),
484 madj->unnormalized_next_hops.heap_handle);
485 clib_memcpy (lm->next_hop_heap + madj->unnormalized_next_hops.heap_offset,
486 raw_next_hops, vec_bytes (raw_next_hops));
488 ip_call_add_del_adjacency_callbacks (lm, adj_index, /* is_del */ 0);
490 return adj_heap_handle;
493 /* Returns 0 for next hop not found. */
495 ip_multipath_adjacency_add_del_next_hop (ip_lookup_main_t * lm,
497 u32 old_mp_adj_index,
498 u32 next_hop_adj_index,
500 u32 * new_mp_adj_index)
502 ip_multipath_adjacency_t * mp_old, * mp_new;
503 ip_multipath_next_hop_t * nh, * nhs, * hash_nhs;
511 /* If old adj is not multipath, we need to "convert" it by calling this
512 * function recursively */
513 if (old_mp_adj_index != ~0 && !ip_adjacency_is_multipath(lm, old_mp_adj_index))
515 ip_multipath_adjacency_add_del_next_hop(lm, /* is_del */ 0,
516 /* old_mp_adj_index */ ~0,
517 /* nh_adj_index */ old_mp_adj_index,
522 /* If old multipath adjacency is valid, find requested next hop. */
523 if (old_mp_adj_index < vec_len (lm->multipath_adjacencies)
524 && lm->multipath_adjacencies[old_mp_adj_index].normalized_next_hops.count > 0)
526 mp_old = vec_elt_at_index (lm->multipath_adjacencies, old_mp_adj_index);
528 nhs = vec_elt_at_index (lm->next_hop_heap, mp_old->unnormalized_next_hops.heap_offset);
529 n_nhs = mp_old->unnormalized_next_hops.count;
531 /* Linear search: ok since n_next_hops is small. */
532 for (i_nh = 0; i_nh < n_nhs; i_nh++)
533 if (nhs[i_nh].next_hop_adj_index == next_hop_adj_index)
536 /* Given next hop not found. */
537 if (i_nh >= n_nhs && is_del)
541 hash_nhs = lm->next_hop_hash_lookup_key;
543 _vec_len (hash_nhs) = 0;
549 /* Prepare lookup key for multipath with target next hop deleted. */
551 vec_add (hash_nhs, nhs + 0, i_nh);
552 if (i_nh + 1 < n_nhs)
553 vec_add (hash_nhs, nhs + i_nh + 1, n_nhs - (i_nh + 1));
556 else /* it's an add. */
558 /* If next hop is already there with the same weight, we have nothing to do. */
559 if (i_nh < n_nhs && nhs[i_nh].weight == next_hop_weight)
561 new_mp_adj_index[0] = ~0;
565 /* Copy old next hops to lookup key vector. */
567 vec_add (hash_nhs, nhs, n_nhs);
571 /* Change weight of existing next hop. */
572 nh = vec_elt_at_index (hash_nhs, i_nh);
576 /* Add a new next hop. */
577 vec_add2 (hash_nhs, nh, 1);
578 nh->next_hop_adj_index = next_hop_adj_index;
581 /* Set weight for added or old next hop. */
582 nh->weight = next_hop_weight;
585 if (vec_len (hash_nhs) > 0)
587 u32 tmp = ip_multipath_adjacency_get (lm, hash_nhs,
588 /* create_if_non_existent */ 1);
590 mp_new = vec_elt_at_index (lm->multipath_adjacencies, tmp);
592 /* Fetch again since pool may have moved. */
594 mp_old = vec_elt_at_index (lm->multipath_adjacencies, old_mp_adj_index);
597 new_mp_adj_index[0] = mp_new ? mp_new - lm->multipath_adjacencies : ~0;
599 if (mp_new != mp_old)
603 ASSERT (mp_old->reference_count > 0);
604 mp_old->reference_count -= 1;
607 mp_new->reference_count += 1;
610 if (mp_old && mp_old->reference_count == 0)
611 ip_multipath_adjacency_free (lm, mp_old);
614 /* Save key vector next call. */
615 lm->next_hop_hash_lookup_key = hash_nhs;
621 ip_multipath_del_adjacency (ip_lookup_main_t * lm, u32 del_adj_index)
623 ip_adjacency_t * adj = ip_get_adjacency (lm, del_adj_index);
624 ip_multipath_adjacency_t * madj, * new_madj;
625 ip_multipath_next_hop_t * nhs, * hash_nhs;
626 u32 i, n_nhs, madj_index, new_madj_index;
628 if (adj->heap_handle >= vec_len (lm->multipath_adjacencies))
631 vec_validate (lm->adjacency_remap_table, vec_len (lm->adjacency_heap) - 1);
633 for (madj_index = 0; madj_index < vec_len (lm->multipath_adjacencies); madj_index++)
635 madj = vec_elt_at_index (lm->multipath_adjacencies, madj_index);
636 if (madj->n_adj_in_block == 0)
639 nhs = heap_elt_at_index (lm->next_hop_heap, madj->unnormalized_next_hops.heap_offset);
640 n_nhs = madj->unnormalized_next_hops.count;
641 for (i = 0; i < n_nhs; i++)
642 if (nhs[i].next_hop_adj_index == del_adj_index)
645 /* del_adj_index not found in unnormalized_next_hops? We're done. */
652 hash_nhs = lm->next_hop_hash_lookup_key;
654 _vec_len (hash_nhs) = 0;
656 vec_add (hash_nhs, nhs + 0, i);
658 vec_add (hash_nhs, nhs + i + 1, n_nhs - (i + 1));
660 new_madj_index = ip_multipath_adjacency_get (lm, hash_nhs, /* create_if_non_existent */ 1);
662 lm->next_hop_hash_lookup_key = hash_nhs;
664 if (new_madj_index == madj_index)
667 new_madj = vec_elt_at_index (lm->multipath_adjacencies, new_madj_index);
670 lm->adjacency_remap_table[madj->adj_index] = new_madj ? 1 + new_madj->adj_index : ~0;
671 lm->n_adjacency_remaps += 1;
672 ip_multipath_adjacency_free (lm, madj);
677 ip_multipath_adjacency_free (ip_lookup_main_t * lm,
678 ip_multipath_adjacency_t * a)
680 hash_unset (lm->multipath_adjacency_by_next_hops,
681 ip_next_hop_hash_key_from_handle (a->normalized_next_hops.heap_handle));
682 heap_dealloc (lm->next_hop_heap, a->normalized_next_hops.heap_handle);
683 heap_dealloc (lm->next_hop_heap, a->unnormalized_next_hops.heap_handle);
685 ip_del_adjacency2 (lm, a->adj_index, a->reference_count == 0);
686 memset (a, 0, sizeof (a[0]));
689 always_inline ip_multipath_next_hop_t *
690 ip_next_hop_hash_key_get_next_hops (ip_lookup_main_t * lm, uword k,
693 ip_multipath_next_hop_t * nhs;
695 if (ip_next_hop_hash_key_is_heap_handle (k))
697 uword handle = ip_next_hop_hash_key_get_heap_handle (k);
698 nhs = heap_elt_with_handle (lm->next_hop_heap, handle);
699 n_nhs = heap_len (lm->next_hop_heap, handle);
703 nhs = uword_to_pointer (k, ip_multipath_next_hop_t *);
704 n_nhs = vec_len (nhs);
706 *n_next_hops = n_nhs;
711 ip_next_hop_hash_key_sum (hash_t * h, uword key0)
713 ip_lookup_main_t * lm = uword_to_pointer (h->user, ip_lookup_main_t *);
714 ip_multipath_next_hop_t * k0;
717 k0 = ip_next_hop_hash_key_get_next_hops (lm, key0, &n0);
718 return hash_memory (k0, n0 * sizeof (k0[0]), /* seed */ n0);
722 ip_next_hop_hash_key_equal (hash_t * h, uword key0, uword key1)
724 ip_lookup_main_t * lm = uword_to_pointer (h->user, ip_lookup_main_t *);
725 ip_multipath_next_hop_t * k0, * k1;
728 k0 = ip_next_hop_hash_key_get_next_hops (lm, key0, &n0);
729 k1 = ip_next_hop_hash_key_get_next_hops (lm, key1, &n1);
731 return n0 == n1 && ! memcmp (k0, k1, n0 * sizeof (k0[0]));
735 ip_interface_address_add_del (ip_lookup_main_t * lm,
740 u32 * result_if_address_index)
742 vnet_main_t * vnm = vnet_get_main();
743 ip_interface_address_t * a, * prev, * next;
744 uword * p = mhash_get (&lm->address_to_if_address_index, addr_fib);
746 vec_validate_init_empty (lm->if_address_pool_index_by_sw_if_index, sw_if_index, ~0);
747 a = p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
749 /* Verify given length. */
750 if ((a && (address_length != a->address_length)) || (address_length == 0))
752 vnm->api_errno = VNET_API_ERROR_ADDRESS_LENGTH_MISMATCH;
753 return clib_error_create
754 ( "%U wrong length (expected %d) for interface %U",
755 lm->format_address_and_length, addr_fib,
756 address_length, a? a->address_length : -1,
757 format_vnet_sw_if_index_name, vnm, sw_if_index);
764 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, sw_if_index);
765 vnm->api_errno = VNET_API_ERROR_ADDRESS_NOT_FOUND_FOR_INTERFACE;
766 return clib_error_create ("%U not found for interface %U",
767 lm->format_address_and_length,
768 addr_fib, address_length,
769 format_vnet_sw_interface_name, vnm, si);
772 if (a->prev_this_sw_interface != ~0)
774 prev = pool_elt_at_index (lm->if_address_pool, a->prev_this_sw_interface);
775 prev->next_this_sw_interface = a->next_this_sw_interface;
777 if (a->next_this_sw_interface != ~0)
779 next = pool_elt_at_index (lm->if_address_pool, a->next_this_sw_interface);
780 next->prev_this_sw_interface = a->prev_this_sw_interface;
782 if(a->prev_this_sw_interface == ~0)
783 lm->if_address_pool_index_by_sw_if_index[sw_if_index] = a->next_this_sw_interface;
786 if ((a->next_this_sw_interface == ~0) && (a->prev_this_sw_interface == ~0))
787 lm->if_address_pool_index_by_sw_if_index[sw_if_index] = ~0;
789 mhash_unset (&lm->address_to_if_address_index, addr_fib,
791 pool_put (lm->if_address_pool, a);
793 if (result_if_address_index)
794 *result_if_address_index = ~0;
799 u32 pi; /* previous index */
801 u32 hi; /* head index */
803 pool_get (lm->if_address_pool, a);
804 memset (a, ~0, sizeof (a[0]));
805 ai = a - lm->if_address_pool;
807 hi = pi = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
809 while (pi != (u32)~0)
811 prev = pool_elt_at_index(lm->if_address_pool, pi);
812 pi = prev->next_this_sw_interface;
814 pi = prev ? prev - lm->if_address_pool : (u32)~0;
816 a->address_key = mhash_set (&lm->address_to_if_address_index,
817 addr_fib, ai, /* old_value */ 0);
818 a->address_length = address_length;
819 a->sw_if_index = sw_if_index;
821 a->prev_this_sw_interface = pi;
822 a->next_this_sw_interface = ~0;
824 prev->next_this_sw_interface = ai;
826 lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
827 (hi != ~0) ? hi : ai;
828 if (result_if_address_index)
829 *result_if_address_index = ai;
833 if (result_if_address_index)
834 *result_if_address_index = a - lm->if_address_pool;
838 return /* no error */ 0;
841 void ip_lookup_init (ip_lookup_main_t * lm, u32 is_ip6)
843 ip_adjacency_t * adj;
844 ip_adjacency_t template_adj;
846 /* ensure that adjacency is cacheline aligned and sized */
847 ASSERT(STRUCT_OFFSET_OF(ip_adjacency_t, cacheline0) == 0);
848 ASSERT(STRUCT_OFFSET_OF(ip_adjacency_t, cacheline1) == CLIB_CACHE_LINE_BYTES);
850 lm->adj_index_by_signature = hash_create (0, sizeof (uword));
851 memset (&template_adj, 0, sizeof (template_adj));
853 /* Preallocate three "special" adjacencies */
854 lm->adjacency_heap = aa_bootstrap (0, 3 /* n=1 free items */);
856 /* Hand-craft special miss adjacency to use when nothing matches in the
857 routing table. Same for drop adjacency. */
858 adj = ip_add_adjacency (lm, /* template */ 0, /* n-adj */ 1,
859 &lm->miss_adj_index);
860 adj->lookup_next_index = IP_LOOKUP_NEXT_MISS;
861 ASSERT (lm->miss_adj_index == IP_LOOKUP_MISS_ADJ_INDEX);
863 /* Make the "drop" adj sharable */
864 template_adj.lookup_next_index = IP_LOOKUP_NEXT_DROP;
865 adj = ip_add_adjacency (lm, &template_adj, /* n-adj */ 1,
866 &lm->drop_adj_index);
868 /* Make the "local" adj sharable */
869 template_adj.lookup_next_index = IP_LOOKUP_NEXT_LOCAL;
870 template_adj.if_address_index = ~0;
871 adj = ip_add_adjacency (lm, &template_adj, /* n-adj */ 1,
872 &lm->local_adj_index);
874 if (! lm->fib_result_n_bytes)
875 lm->fib_result_n_bytes = sizeof (uword);
877 lm->multipath_adjacency_by_next_hops
878 = hash_create2 (/* elts */ 0,
879 /* user */ pointer_to_uword (lm),
880 /* value_bytes */ sizeof (uword),
881 ip_next_hop_hash_key_sum,
882 ip_next_hop_hash_key_equal,
883 /* format pair/arg */
886 /* 1% max error tolerance for multipath. */
887 lm->multipath_next_hop_error_tolerance = .01;
892 lm->format_address_and_length = format_ip6_address_and_length;
893 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
894 sizeof (ip6_address_fib_t));
898 lm->format_address_and_length = format_ip4_address_and_length;
899 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
900 sizeof (ip4_address_fib_t));
906 /* Setup all IP protocols to be punted and builtin-unknown. */
907 for (i = 0; i < 256; i++)
909 lm->local_next_by_ip_protocol[i] = IP_LOCAL_NEXT_PUNT;
910 lm->builtin_protocol_by_ip_protocol[i] = IP_BUILTIN_PROTOCOL_UNKNOWN;
913 lm->local_next_by_ip_protocol[IP_PROTOCOL_UDP] = IP_LOCAL_NEXT_UDP_LOOKUP;
914 lm->local_next_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 : IP_PROTOCOL_ICMP] = IP_LOCAL_NEXT_ICMP;
915 lm->builtin_protocol_by_ip_protocol[IP_PROTOCOL_UDP] = IP_BUILTIN_PROTOCOL_UDP;
916 lm->builtin_protocol_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 : IP_PROTOCOL_ICMP] = IP_BUILTIN_PROTOCOL_ICMP;
920 u8 * format_ip_flow_hash_config (u8 * s, va_list * args)
922 u32 flow_hash_config = va_arg (*args, u32);
924 #define _(n,v) if (flow_hash_config & v) s = format (s, "%s ", #n);
925 foreach_flow_hash_bit;
931 u8 * format_ip_lookup_next (u8 * s, va_list * args)
933 ip_lookup_next_t n = va_arg (*args, ip_lookup_next_t);
939 s = format (s, "unknown %d", n);
942 case IP_LOOKUP_NEXT_MISS: t = "miss"; break;
943 case IP_LOOKUP_NEXT_DROP: t = "drop"; break;
944 case IP_LOOKUP_NEXT_PUNT: t = "punt"; break;
945 case IP_LOOKUP_NEXT_LOCAL: t = "local"; break;
946 case IP_LOOKUP_NEXT_ARP: t = "arp"; break;
947 case IP_LOOKUP_NEXT_CLASSIFY: t = "classify"; break;
948 case IP_LOOKUP_NEXT_MAP: t = "map"; break;
949 case IP_LOOKUP_NEXT_MAP_T: t = "map-t"; break;
950 case IP_LOOKUP_NEXT_SIXRD: t = "sixrd"; break;
951 case IP_LOOKUP_NEXT_REWRITE:
956 vec_add (s, t, strlen (t));
961 static u8 * format_ip_interface_address (u8 * s, va_list * args)
963 ip_lookup_main_t * lm = va_arg (*args, ip_lookup_main_t *);
964 u32 if_address_index = va_arg (*args, u32);
965 ip_interface_address_t * ia = pool_elt_at_index (lm->if_address_pool, if_address_index);
966 void * a = ip_interface_address_get_address (lm, ia);
969 return format (s, "%U", format_ip6_address_and_length, a, ia->address_length);
971 return format (s, "%U", format_ip4_address_and_length, a, ia->address_length);
974 u8 * format_ip_adjacency (u8 * s, va_list * args)
976 vnet_main_t * vnm = va_arg (*args, vnet_main_t *);
977 ip_lookup_main_t * lm = va_arg (*args, ip_lookup_main_t *);
978 u32 adj_index = va_arg (*args, u32);
979 ip_adjacency_t * adj = ip_get_adjacency (lm, adj_index);
981 switch (adj->lookup_next_index)
983 case IP_LOOKUP_NEXT_REWRITE:
986 vnm->vlib_main, &adj->rewrite_header, sizeof (adj->rewrite_data));
990 s = format (s, "%U", format_ip_lookup_next, adj->lookup_next_index);
991 if (adj->lookup_next_index == IP_LOOKUP_NEXT_ARP)
992 s = format (s, " %U",
993 format_vnet_sw_interface_name,
995 vnet_get_sw_interface (vnm, adj->rewrite_header.sw_if_index));
996 switch (adj->lookup_next_index)
998 case IP_LOOKUP_NEXT_ARP:
999 if (adj->if_address_index != ~0)
1000 s = format (s, " %U", format_ip_interface_address, lm, adj->if_address_index);
1001 if (adj->arp.next_hop.ip4.as_u32)
1002 s = format (s, " via %U", format_ip4_address, &adj->arp.next_hop.ip4.as_u32);
1004 case IP_LOOKUP_NEXT_LOCAL:
1005 if (adj->if_address_index != ~0)
1006 s = format (s, " %U", format_ip_interface_address, lm, adj->if_address_index);
1009 case IP_LOOKUP_NEXT_CLASSIFY:
1010 s = format (s, " table %d", adj->classify.table_index);
1017 if (adj->explicit_fib_index != ~0 && adj->explicit_fib_index != 0)
1018 s = format (s, " lookup fib index %d", adj->explicit_fib_index);
1019 if (adj->share_count > 0)
1020 s = format (s, " shared %d", adj->share_count + 1);
1021 if (adj->next_adj_with_signature)
1022 s = format (s, " next_adj_with_signature %d", adj->next_adj_with_signature);
1027 u8 * format_ip_adjacency_packet_data (u8 * s, va_list * args)
1029 vnet_main_t * vnm = va_arg (*args, vnet_main_t *);
1030 ip_lookup_main_t * lm = va_arg (*args, ip_lookup_main_t *);
1031 u32 adj_index = va_arg (*args, u32);
1032 u8 * packet_data = va_arg (*args, u8 *);
1033 u32 n_packet_data_bytes = va_arg (*args, u32);
1034 ip_adjacency_t * adj = ip_get_adjacency (lm, adj_index);
1036 switch (adj->lookup_next_index)
1038 case IP_LOOKUP_NEXT_REWRITE:
1039 s = format (s, "%U",
1040 format_vnet_rewrite_header,
1041 vnm->vlib_main, &adj->rewrite_header, packet_data, n_packet_data_bytes);
1051 static uword unformat_ip_lookup_next (unformat_input_t * input, va_list * args)
1053 ip_lookup_next_t * result = va_arg (*args, ip_lookup_next_t *);
1056 if (unformat (input, "drop"))
1057 n = IP_LOOKUP_NEXT_DROP;
1059 else if (unformat (input, "punt"))
1060 n = IP_LOOKUP_NEXT_PUNT;
1062 else if (unformat (input, "local"))
1063 n = IP_LOOKUP_NEXT_LOCAL;
1065 else if (unformat (input, "arp"))
1066 n = IP_LOOKUP_NEXT_ARP;
1068 else if (unformat (input, "classify"))
1069 n = IP_LOOKUP_NEXT_CLASSIFY;
1078 static uword unformat_ip_adjacency (unformat_input_t * input, va_list * args)
1080 vlib_main_t * vm = va_arg (*args, vlib_main_t *);
1081 ip_adjacency_t * adj = va_arg (*args, ip_adjacency_t *);
1082 u32 node_index = va_arg (*args, u32);
1083 vnet_main_t * vnm = vnet_get_main();
1084 u32 sw_if_index, is_ip6;
1086 ip_lookup_next_t next;
1088 is_ip6 = node_index == ip6_rewrite_node.index;
1089 adj->rewrite_header.node_index = node_index;
1090 adj->explicit_fib_index = ~0;
1092 if (unformat (input, "arp %U %U",
1093 unformat_vnet_sw_interface, vnm, &sw_if_index,
1094 unformat_ip46_address, &a46, is_ip6))
1096 ip_lookup_main_t * lm = is_ip6 ? &ip6_main.lookup_main : &ip4_main.lookup_main;
1097 ip_adjacency_t * a_adj;
1101 adj_index = ip6_fib_lookup (&ip6_main, sw_if_index, &a46.ip6);
1103 adj_index = ip4_fib_lookup (&ip4_main, sw_if_index, &a46.ip4);
1105 a_adj = ip_get_adjacency (lm, adj_index);
1107 if (a_adj->rewrite_header.sw_if_index != sw_if_index)
1111 ip6_adjacency_set_interface_route (vnm, adj, sw_if_index, a_adj->if_address_index);
1113 ip4_adjacency_set_interface_route (vnm, adj, sw_if_index, a_adj->if_address_index);
1116 else if (unformat_user (input, unformat_ip_lookup_next, &next))
1118 adj->lookup_next_index = next;
1119 adj->if_address_index = ~0;
1120 if (next == IP_LOOKUP_NEXT_LOCAL)
1121 (void) unformat (input, "%d", &adj->if_address_index);
1122 else if (next == IP_LOOKUP_NEXT_CLASSIFY)
1124 if (!unformat (input, "%d", &adj->classify.table_index))
1126 clib_warning ("classify adj must specify table index");
1130 else if (next == IP_LOOKUP_NEXT_DROP)
1132 adj->rewrite_header.node_index = 0;
1136 else if (unformat_user (input,
1137 unformat_vnet_rewrite,
1138 vm, &adj->rewrite_header, sizeof (adj->rewrite_data)))
1139 adj->lookup_next_index = IP_LOOKUP_NEXT_REWRITE;
1148 vnet_ip_route_cmd (vlib_main_t * vm, unformat_input_t * main_input, vlib_cli_command_t * cmd)
1150 vnet_main_t * vnm = vnet_get_main();
1151 clib_error_t * error = 0;
1152 u32 table_id, is_del;
1153 u32 weight, * weights = 0;
1154 u32 * table_ids = 0;
1155 u32 sw_if_index, * sw_if_indices = 0;
1156 ip4_address_t ip4_addr, * ip4_dst_addresses = 0, * ip4_via_next_hops = 0;
1157 ip6_address_t ip6_addr, * ip6_dst_addresses = 0, * ip6_via_next_hops = 0;
1158 u32 dst_address_length, * dst_address_lengths = 0;
1159 ip_adjacency_t parse_adj, * add_adj = 0;
1160 unformat_input_t _line_input, * line_input = &_line_input;
1168 /* Get a line of input. */
1169 if (! unformat_user (main_input, unformat_line_input, line_input))
1172 memset(&parse_adj, 0, sizeof (parse_adj));
1174 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1176 if (unformat (line_input, "table %d", &table_id))
1178 else if (unformat (line_input, "del"))
1180 else if (unformat (line_input, "add"))
1182 else if (unformat (line_input, "count %f", &count))
1185 else if (unformat (line_input, "%U/%d",
1186 unformat_ip4_address, &ip4_addr,
1187 &dst_address_length))
1189 vec_add1 (ip4_dst_addresses, ip4_addr);
1190 vec_add1 (dst_address_lengths, dst_address_length);
1193 else if (unformat (line_input, "%U/%d",
1194 unformat_ip6_address, &ip6_addr,
1195 &dst_address_length))
1197 vec_add1 (ip6_dst_addresses, ip6_addr);
1198 vec_add1 (dst_address_lengths, dst_address_length);
1201 else if (unformat (line_input, "via %U %U weight %u",
1202 unformat_ip4_address, &ip4_addr,
1203 unformat_vnet_sw_interface, vnm, &sw_if_index,
1206 vec_add1 (ip4_via_next_hops, ip4_addr);
1207 vec_add1 (sw_if_indices, sw_if_index);
1208 vec_add1 (weights, weight);
1209 vec_add1 (table_ids, (u32)~0);
1212 else if (unformat (line_input, "via %U %U weight %u",
1213 unformat_ip6_address, &ip6_addr,
1214 unformat_vnet_sw_interface, vnm, &sw_if_index,
1217 vec_add1 (ip6_via_next_hops, ip6_addr);
1218 vec_add1 (sw_if_indices, sw_if_index);
1219 vec_add1 (weights, weight);
1220 vec_add1 (table_ids, (u32)~0);
1223 else if (unformat (line_input, "via %U %U",
1224 unformat_ip4_address, &ip4_addr,
1225 unformat_vnet_sw_interface, vnm, &sw_if_index))
1227 vec_add1 (ip4_via_next_hops, ip4_addr);
1228 vec_add1 (sw_if_indices, sw_if_index);
1229 vec_add1 (weights, 1);
1230 vec_add1 (table_ids, (u32)~0);
1233 else if (unformat (line_input, "via %U %U",
1234 unformat_ip6_address, &ip6_addr,
1235 unformat_vnet_sw_interface, vnm, &sw_if_index))
1237 vec_add1 (ip6_via_next_hops, ip6_addr);
1238 vec_add1 (sw_if_indices, sw_if_index);
1239 vec_add1 (weights, 1);
1240 vec_add1 (table_ids, (u32)~0);
1242 else if (unformat (line_input, "via %U",
1243 unformat_ip4_address, &ip4_addr))
1245 vec_add1 (ip4_via_next_hops, ip4_addr);
1246 vec_add1 (sw_if_indices, (u32)~0);
1247 vec_add1 (weights, 1);
1248 vec_add1 (table_ids, table_id);
1250 else if (unformat (line_input, "via %U",
1251 unformat_ip6_address, &ip6_addr))
1253 vec_add1 (ip6_via_next_hops, ip6_addr);
1254 vec_add1 (sw_if_indices, (u32)~0);
1255 vec_add1 (weights, 1);
1256 vec_add1 (table_ids, (u32)table_id);
1259 else if (vec_len (ip4_dst_addresses) > 0
1260 && unformat (line_input, "via %U",
1261 unformat_ip_adjacency, vm, &parse_adj, ip4_rewrite_node.index))
1262 vec_add1 (add_adj, parse_adj);
1264 else if (vec_len (ip6_dst_addresses) > 0
1265 && unformat (line_input, "via %U",
1266 unformat_ip_adjacency, vm, &parse_adj, ip6_rewrite_node.index))
1267 vec_add1 (add_adj, parse_adj);
1268 else if (unformat (line_input, "lookup in table %d", &outer_table_id))
1272 if (vec_len (ip4_dst_addresses) > 0)
1273 p = hash_get (ip4_main.fib_index_by_table_id, outer_table_id);
1275 p = hash_get (ip6_main.fib_index_by_table_id, outer_table_id);
1279 error = clib_error_return (0, "Nonexistent outer table id %d",
1284 parse_adj.lookup_next_index = IP_LOOKUP_NEXT_LOCAL;
1285 parse_adj.explicit_fib_index = p[0];
1286 vec_add1 (add_adj, parse_adj);
1290 error = unformat_parse_error (line_input);
1295 unformat_free (line_input);
1297 if (vec_len (ip4_dst_addresses) + vec_len (ip6_dst_addresses) == 0)
1299 error = clib_error_return (0, "expected ip4/ip6 destination address/length.");
1303 if (vec_len (ip4_dst_addresses) > 0 && vec_len (ip6_dst_addresses) > 0)
1305 error = clib_error_return (0, "mixed ip4/ip6 address/length.");
1309 if (vec_len (ip4_dst_addresses) > 0 && vec_len (ip6_via_next_hops) > 0)
1311 error = clib_error_return (0, "ip4 destinations with ip6 next hops.");
1315 if (vec_len (ip6_dst_addresses) > 0 && vec_len (ip4_via_next_hops) > 0)
1317 error = clib_error_return (0, "ip6 destinations with ip4 next hops.");
1321 if (! is_del && vec_len (add_adj) + vec_len (weights) == 0)
1323 error = clib_error_return (0, "no next hops or adjacencies to add.");
1329 ip4_main_t * im4 = &ip4_main;
1330 ip6_main_t * im6 = &ip6_main;
1332 for (i = 0; i < vec_len (ip4_dst_addresses); i++)
1334 ip4_add_del_route_args_t a;
1336 memset (&a, 0, sizeof (a));
1337 a.flags = IP4_ROUTE_FLAG_TABLE_ID;
1338 a.table_index_or_table_id = table_id;
1339 a.dst_address = ip4_dst_addresses[i];
1340 a.dst_address_length = dst_address_lengths[i];
1345 if (vec_len (ip4_via_next_hops) == 0)
1347 uword * dst_hash, * dst_result;
1348 u32 dst_address_u32;
1351 fib = find_ip4_fib_by_table_index_or_id (im4, table_id,
1352 0 /* by table id */);
1354 a.flags |= IP4_ROUTE_FLAG_DEL;
1355 dst_address_u32 = a.dst_address.as_u32
1356 & im4->fib_masks[a.dst_address_length];
1359 fib->adj_index_by_dst_address[a.dst_address_length];
1360 dst_result = hash_get (dst_hash, dst_address_u32);
1362 a.adj_index = dst_result[0];
1365 clib_warning ("%U/%d not in FIB",
1366 format_ip4_address, &a.dst_address,
1367 a.dst_address_length);
1371 ip4_add_del_route (im4, &a);
1372 ip4_maybe_remap_adjacencies (im4, table_id,
1373 IP4_ROUTE_FLAG_TABLE_ID);
1377 u32 i, j, n, f, incr;
1378 ip4_address_t dst = a.dst_address;
1381 t[0] = vlib_time_now (vm);
1382 incr = 1<<(32 - a.dst_address_length);
1383 for (i = 0; i < n; i++)
1385 f = i + 1 < n ? IP4_ROUTE_FLAG_NOT_LAST_IN_GROUP : 0;
1386 a.dst_address = dst;
1387 for (j = 0; j < vec_len (ip4_via_next_hops); j++)
1389 if (table_ids[j] != (u32)~0)
1391 uword * p = hash_get (im4->fib_index_by_table_id,
1395 clib_warning ("no such FIB table %d",
1399 table_ids[j] = p[0];
1402 ip4_add_del_route_next_hop (im4,
1403 IP4_ROUTE_FLAG_DEL | f,
1405 a.dst_address_length,
1406 &ip4_via_next_hops[j],
1408 weights[j], (u32)~0,
1409 table_ids[j] /* fib index */);
1411 dst.as_u32 = clib_host_to_net_u32 (incr + clib_net_to_host_u32 (dst.as_u32));
1413 t[1] = vlib_time_now (vm);
1415 vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
1420 if (vec_len (add_adj) > 0)
1422 a.flags |= IP4_ROUTE_FLAG_ADD;
1423 a.add_adj = add_adj;
1424 a.n_add_adj = vec_len (add_adj);
1426 ip4_add_del_route (im4, &a);
1428 else if (vec_len (ip4_via_next_hops) > 0)
1430 u32 i, j, n, f, incr;
1431 ip4_address_t dst = a.dst_address;
1434 t[0] = vlib_time_now (vm);
1435 incr = 1<<(32 - a.dst_address_length);
1436 for (i = 0; i < n; i++)
1438 f = i + 1 < n ? IP4_ROUTE_FLAG_NOT_LAST_IN_GROUP : 0;
1439 a.dst_address = dst;
1440 for (j = 0; j < vec_len (ip4_via_next_hops); j++)
1442 if (table_ids[j] != (u32)~0)
1444 uword * p = hash_get (im4->fib_index_by_table_id,
1448 clib_warning ("no such FIB table %d",
1452 table_ids[j] = p[0];
1454 ip4_add_del_route_next_hop (im4,
1455 IP4_ROUTE_FLAG_ADD | f,
1457 a.dst_address_length,
1458 &ip4_via_next_hops[j],
1460 weights[j], (u32)~0,
1461 table_ids[j] /* fib index */);
1463 dst.as_u32 = clib_host_to_net_u32 (incr + clib_net_to_host_u32 (dst.as_u32));
1465 t[1] = vlib_time_now (vm);
1467 vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
1472 for (i = 0; i < vec_len (ip6_dst_addresses); i++)
1474 ip6_add_del_route_args_t a;
1477 memset (&a, 0, sizeof (a));
1478 a.flags = IP6_ROUTE_FLAG_TABLE_ID;
1479 a.table_index_or_table_id = table_id;
1480 a.dst_address = ip6_dst_addresses[i];
1481 a.dst_address_length = dst_address_lengths[i];
1486 if (vec_len (ip6_via_next_hops) == 0)
1488 BVT(clib_bihash_kv) kv, value;
1489 ip6_address_t dst_address;
1492 fib = find_ip6_fib_by_table_index_or_id (im6, table_id,
1493 0 /* by table id */);
1495 a.flags |= IP4_ROUTE_FLAG_DEL;
1497 dst_address = ip6_dst_addresses[i];
1499 ip6_address_mask (&dst_address,
1500 &im6->fib_masks[dst_address_length]);
1502 kv.key[0] = dst_address.as_u64[0];
1503 kv.key[1] = dst_address.as_u64[1];
1504 kv.key[2] = ((u64)(fib - im6->fibs)<<32)
1505 | a.dst_address_length;
1507 if (BV(clib_bihash_search)(&im6->ip6_lookup_table,
1509 a.adj_index = value.value;
1512 clib_warning ("%U/%d not in FIB",
1513 format_ip6_address, &a.dst_address,
1514 a.dst_address_length);
1518 a.flags |= IP6_ROUTE_FLAG_DEL;
1519 ip6_add_del_route (im6, &a);
1520 ip6_maybe_remap_adjacencies (im6, table_id,
1521 IP6_ROUTE_FLAG_TABLE_ID);
1526 for (i = 0; i < vec_len (ip6_via_next_hops); i++)
1528 ip6_add_del_route_next_hop (im6,
1531 a.dst_address_length,
1532 &ip6_via_next_hops[i],
1534 weights[i], (u32)~0,
1535 table_ids[i] /* fib index */);
1541 if (vec_len (add_adj) > 0)
1543 a.flags |= IP6_ROUTE_FLAG_ADD;
1544 a.add_adj = add_adj;
1545 a.n_add_adj = vec_len (add_adj);
1547 ip6_add_del_route (im6, &a);
1549 else if (vec_len (ip6_via_next_hops) > 0)
1552 for (i = 0; i < vec_len (ip6_via_next_hops); i++)
1554 ip6_add_del_route_next_hop (im6,
1557 a.dst_address_length,
1558 &ip6_via_next_hops[i],
1560 weights[i], (u32)~0,
1571 vec_free (dst_address_lengths);
1572 vec_free (ip4_dst_addresses);
1573 vec_free (ip6_dst_addresses);
1574 vec_free (ip4_via_next_hops);
1575 vec_free (ip6_via_next_hops);
1579 VLIB_CLI_COMMAND (vlib_cli_ip_command, static) = {
1581 .short_help = "Internet protocol (IP) commands",
1584 VLIB_CLI_COMMAND (vlib_cli_show_ip_command, static) = {
1586 .short_help = "Internet protocol (IP) show commands",
1589 VLIB_CLI_COMMAND (vlib_cli_show_ip4_command, static) = {
1591 .short_help = "Internet protocol version 4 (IP4) show commands",
1594 VLIB_CLI_COMMAND (vlib_cli_show_ip6_command, static) = {
1596 .short_help = "Internet protocol version 6 (IP6) show commands",
1599 VLIB_CLI_COMMAND (ip_route_command, static) = {
1601 .short_help = "Add/delete IP routes",
1602 .function = vnet_ip_route_cmd,
1607 * The next two routines address a longstanding script hemorrhoid.
1608 * Probing a v4 or v6 neighbor needs to appear to be synchronous,
1609 * or dependent route-adds will simply fail.
1611 static clib_error_t *
1612 ip6_probe_neighbor_wait (vlib_main_t *vm, ip6_address_t * a, u32 sw_if_index,
1615 vnet_main_t * vnm = vnet_get_main();
1620 uword *event_data = 0;
1622 ASSERT (vlib_in_process_context(vm));
1624 if (retry_count > 0)
1625 vnet_register_ip6_neighbor_resolution_event
1626 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1627 1 /* event */, 0 /* data */);
1629 for (i = 0; i < retry_count; i++)
1631 /* The interface may be down, etc. */
1632 e = ip6_probe_neighbor (vm, a, sw_if_index);
1637 vlib_process_wait_for_event_or_clock (vm, 1.0);
1638 event_type = vlib_process_get_events (vm, &event_data);
1641 case 1: /* resolved... */
1642 vlib_cli_output (vm, "Resolved %U",
1643 format_ip6_address, a);
1647 case ~0: /* timeout */
1651 clib_warning ("unknown event_type %d", event_type);
1653 vec_reset_length (event_data);
1659 return clib_error_return (0, "Resolution failed for %U",
1660 format_ip6_address, a);
1664 static clib_error_t *
1665 ip4_probe_neighbor_wait (vlib_main_t *vm, ip4_address_t * a, u32 sw_if_index,
1668 vnet_main_t * vnm = vnet_get_main();
1673 uword *event_data = 0;
1675 ASSERT (vlib_in_process_context(vm));
1677 if (retry_count > 0)
1678 vnet_register_ip4_arp_resolution_event
1679 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
1680 1 /* event */, 0 /* data */);
1682 for (i = 0; i < retry_count; i++)
1684 /* The interface may be down, etc. */
1685 e = ip4_probe_neighbor (vm, a, sw_if_index);
1690 vlib_process_wait_for_event_or_clock (vm, 1.0);
1691 event_type = vlib_process_get_events (vm, &event_data);
1694 case 1: /* resolved... */
1695 vlib_cli_output (vm, "Resolved %U",
1696 format_ip4_address, a);
1700 case ~0: /* timeout */
1704 clib_warning ("unknown event_type %d", event_type);
1706 vec_reset_length (event_data);
1711 vec_reset_length (event_data);
1714 return clib_error_return (0, "Resolution failed for %U",
1715 format_ip4_address, a);
1719 static clib_error_t *
1720 probe_neighbor_address (vlib_main_t * vm,
1721 unformat_input_t * input,
1722 vlib_cli_command_t * cmd)
1724 vnet_main_t * vnm = vnet_get_main();
1725 unformat_input_t _line_input, * line_input = &_line_input;
1728 clib_error_t * error = 0;
1729 u32 sw_if_index = ~0;
1730 int retry_count = 3;
1732 int address_set = 0;
1734 /* Get a line of input. */
1735 if (! unformat_user (input, unformat_line_input, line_input))
1738 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1740 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm,
1743 else if (unformat (line_input, "retry %d", &retry_count))
1746 else if (unformat (line_input, "%U", unformat_ip4_address, &a4))
1748 else if (unformat (line_input, "%U", unformat_ip6_address, &a6))
1754 return clib_error_return (0, "unknown input '%U'",
1755 format_unformat_error, line_input);
1758 unformat_free (line_input);
1760 if (sw_if_index == ~0)
1761 return clib_error_return (0, "Interface required, not set.");
1762 if (address_set == 0)
1763 return clib_error_return (0, "ip address required, not set.");
1764 if (address_set > 1)
1765 return clib_error_return (0, "Multiple ip addresses not supported.");
1768 error = ip4_probe_neighbor_wait (vm, &a4, sw_if_index, retry_count);
1770 error = ip6_probe_neighbor_wait (vm, &a6, sw_if_index, retry_count);
1775 VLIB_CLI_COMMAND (ip_probe_neighbor_command, static) = {
1776 .path = "ip probe-neighbor",
1777 .function = probe_neighbor_address,
1778 .short_help = "ip probe-neighbor <intfc> <ip4-addr> | <ip6-addr> [retry nn]",
1782 typedef CLIB_PACKED (struct {
1783 ip4_address_t address;
1785 u32 address_length : 6;
1791 ip4_route_cmp (void * a1, void * a2)
1793 ip4_route_t * r1 = a1;
1794 ip4_route_t * r2 = a2;
1796 int cmp = ip4_address_compare (&r1->address, &r2->address);
1797 return cmp ? cmp : ((int) r1->address_length - (int) r2->address_length);
1800 static clib_error_t *
1801 ip4_show_fib (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1803 vnet_main_t * vnm = vnet_get_main();
1804 ip4_main_t * im4 = &ip4_main;
1805 ip4_route_t * routes, * r;
1807 ip_lookup_main_t * lm = &im4->lookup_main;
1809 int verbose, matching, mtrie, include_empty_fibs;
1810 ip4_address_t matching_address;
1817 include_empty_fibs = 0;
1820 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1822 if (unformat (input, "brief") || unformat (input, "summary")
1823 || unformat (input, "sum"))
1826 else if (unformat (input, "mtrie"))
1829 else if (unformat (input, "include-empty"))
1830 include_empty_fibs = 1;
1832 else if (unformat (input, "%U", unformat_ip4_address, &matching_address))
1835 else if (unformat (input, "clear"))
1838 else if (unformat (input, "table %d", &table_id))
1844 vec_foreach (fib, im4->fibs)
1849 for (i = 0; i < ARRAY_LEN (fib->adj_index_by_dst_address); i++)
1851 uword * hash = fib->adj_index_by_dst_address[i];
1852 uword n_elts = hash_elts (hash);
1860 if (fib_not_empty == 0 && include_empty_fibs == 0)
1863 if (table_id >= 0 && table_id != (int)fib->table_id)
1866 if (include_empty_fibs)
1867 vlib_cli_output (vm, "Table %d, fib_index %d, flow hash: %U",
1868 fib->table_id, fib - im4->fibs,
1869 format_ip_flow_hash_config, fib->flow_hash_config);
1874 if (include_empty_fibs == 0)
1875 vlib_cli_output (vm, "Table %d, fib_index %d, flow hash: %U",
1876 fib->table_id, fib - im4->fibs,
1877 format_ip_flow_hash_config, fib->flow_hash_config);
1878 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
1879 for (i = 0; i < ARRAY_LEN (fib->adj_index_by_dst_address); i++)
1881 uword * hash = fib->adj_index_by_dst_address[i];
1882 uword n_elts = hash_elts (hash);
1884 vlib_cli_output (vm, "%20d%16d", i, n_elts);
1890 _vec_len (routes) = 0;
1892 _vec_len (results) = 0;
1894 for (i = 0; i < ARRAY_LEN (fib->adj_index_by_dst_address); i++)
1896 uword * hash = fib->adj_index_by_dst_address[i];
1900 x.address_length = i;
1904 x.address.as_u32 = matching_address.as_u32 & im4->fib_masks[i];
1905 p = hash_get_pair (hash, x.address.as_u32);
1908 if (lm->fib_result_n_words > 1)
1910 x.index = vec_len (results);
1911 vec_add (results, p->value, lm->fib_result_n_words);
1914 x.index = p->value[0];
1915 vec_add1 (routes, x);
1920 hash_foreach_pair (p, hash, ({
1921 x.address.data_u32 = p->key;
1922 if (lm->fib_result_n_words > 1)
1924 x.index = vec_len (results);
1925 vec_add (results, p->value, lm->fib_result_n_words);
1928 x.index = p->value[0];
1930 vec_add1 (routes, x);
1935 vec_sort_with_function (routes, ip4_route_cmp);
1936 if (vec_len(routes)) {
1937 if (include_empty_fibs == 0)
1938 vlib_cli_output (vm, "Table %d, fib_index %d, flow hash: %U",
1939 fib->table_id, fib - im4->fibs,
1940 format_ip_flow_hash_config, fib->flow_hash_config);
1942 vlib_cli_output (vm, "%U", format_ip4_fib_mtrie, &fib->mtrie);
1943 vlib_cli_output (vm, "%=20s%=16s%=16s%=16s",
1944 "Destination", "Packets", "Bytes", "Adjacency");
1946 vec_foreach (r, routes)
1948 vlib_counter_t c, sum;
1949 uword i, j, n_left, n_nhs, adj_index, * result = 0;
1950 ip_adjacency_t * adj;
1951 ip_multipath_next_hop_t * nhs, tmp_nhs[1];
1953 adj_index = r->index;
1954 if (lm->fib_result_n_words > 1)
1956 result = vec_elt_at_index (results, adj_index);
1957 adj_index = result[0];
1960 adj = ip_get_adjacency (lm, adj_index);
1961 if (adj->n_adj == 1)
1964 nhs[0].next_hop_adj_index = ~0; /* not used */
1970 ip_multipath_adjacency_t * madj;
1971 madj = vec_elt_at_index (lm->multipath_adjacencies, adj->heap_handle);
1972 nhs = heap_elt_at_index (lm->next_hop_heap, madj->normalized_next_hops.heap_offset);
1973 n_nhs = madj->normalized_next_hops.count;
1976 n_left = nhs[0].weight;
1977 vlib_counter_zero (&sum);
1978 for (i = j = 0; i < adj->n_adj; i++)
1981 vlib_get_combined_counter (&lm->adjacency_counters,
1984 vlib_zero_combined_counter (&lm->adjacency_counters,
1986 vlib_counter_add (&sum, &c);
1993 msg = format (msg, "%-20U",
1994 format_ip4_address_and_length,
1995 r->address.data, r->address_length);
1997 msg = format (msg, "%U", format_white_space, 20);
1999 msg = format (msg, "%16Ld%16Ld ", sum.packets, sum.bytes);
2001 indent = vec_len (msg);
2002 msg = format (msg, "weight %d, index %d",
2003 nhs[j].weight, adj_index + i);
2005 if (ip_adjacency_is_multipath(lm, adj_index))
2006 msg = format (msg, ", multipath");
2008 msg = format (msg, "\n%U%U",
2009 format_white_space, indent,
2010 format_ip_adjacency,
2011 vnm, lm, adj_index + i);
2013 vlib_cli_output (vm, "%v", msg);
2016 if (result && lm->format_fib_result)
2017 vlib_cli_output (vm, "%20s%U", "",
2018 lm->format_fib_result, vm, lm, result,
2019 i + 1 - nhs[j].weight,
2025 n_left = nhs[j].weight;
2026 vlib_counter_zero (&sum);
2039 VLIB_CLI_COMMAND (ip4_show_fib_command, static) = {
2040 .path = "show ip fib",
2041 .short_help = "show ip fib [mtrie] [summary] [table <n>] [<ip4-addr>] [clear] [include-empty]",
2042 .function = ip4_show_fib,
2046 ip6_address_t address;
2055 ip6_route_t ** routep;
2056 } add_routes_in_fib_arg_t;
2058 static void add_routes_in_fib (BVT(clib_bihash_kv) * kvp, void *arg)
2060 add_routes_in_fib_arg_t * ap = arg;
2062 if (kvp->key[2]>>32 == ap->fib_index)
2064 ip6_address_t *addr;
2066 addr = (ip6_address_t *) kvp;
2067 vec_add2 (*ap->routep, r, 1);
2068 r->address = addr[0];
2069 r->address_length = kvp->key[2] & 0xFF;
2070 r->index = kvp->value;
2076 u64 count_by_prefix_length[129];
2077 } count_routes_in_fib_at_prefix_length_arg_t;
2079 static void count_routes_in_fib_at_prefix_length
2080 (BVT(clib_bihash_kv) * kvp, void *arg)
2082 count_routes_in_fib_at_prefix_length_arg_t * ap = arg;
2085 if ((kvp->key[2]>>32) != ap->fib_index)
2088 mask_width = kvp->key[2] & 0xFF;
2090 ap->count_by_prefix_length[mask_width]++;
2094 ip6_route_cmp (void * a1, void * a2)
2096 ip6_route_t * r1 = a1;
2097 ip6_route_t * r2 = a2;
2099 int cmp = ip6_address_compare (&r1->address, &r2->address);
2100 return cmp ? cmp : ((int) r1->address_length - (int) r2->address_length);
2103 static clib_error_t *
2104 ip6_show_fib (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
2106 vnet_main_t * vnm = vnet_get_main();
2107 ip6_main_t * im6 = &ip6_main;
2108 ip6_route_t * routes, * r;
2110 ip_lookup_main_t * lm = &im6->lookup_main;
2113 BVT(clib_bihash) * h = &im6->ip6_lookup_table;
2114 __attribute__((unused)) u8 clear = 0;
2115 add_routes_in_fib_arg_t _a, *a=&_a;
2116 count_routes_in_fib_at_prefix_length_arg_t _ca, *ca = &_ca;
2121 if (unformat (input, "brief") || unformat (input, "summary")
2122 || unformat (input, "sum"))
2125 if (unformat (input, "clear"))
2128 vlib_cli_output (vm, "FIB lookup table: %d buckets, %lld MB heap",
2129 im6->lookup_table_nbuckets, im6->lookup_table_size>>20);
2130 vlib_cli_output (vm, "%U", format_mheap, h->mheap, 0 /*verbose*/);
2131 vlib_cli_output (vm, " ");
2133 vec_foreach (fib, im6->fibs)
2135 vlib_cli_output (vm, "VRF %d, fib_index %d, flow hash: %U",
2136 fib->table_id, fib - im6->fibs,
2137 format_ip_flow_hash_config, fib->flow_hash_config);
2143 vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count");
2145 memset (ca, 0, sizeof(*ca));
2146 ca->fib_index = fib - im6->fibs;
2148 BV(clib_bihash_foreach_key_value_pair)
2149 (h, count_routes_in_fib_at_prefix_length, ca);
2151 for (len = 128; len >= 0; len--)
2153 if (ca->count_by_prefix_length[len])
2154 vlib_cli_output (vm, "%=20d%=16lld",
2155 len, ca->count_by_prefix_length[len]);
2161 _vec_len (routes) = 0;
2163 _vec_len (results) = 0;
2165 a->fib_index = fib - im6->fibs;
2166 a->routep = &routes;
2168 BV(clib_bihash_foreach_key_value_pair)(h, add_routes_in_fib, a);
2170 vec_sort_with_function (routes, ip6_route_cmp);
2172 vlib_cli_output (vm, "%=45s%=16s%=16s%=16s",
2173 "Destination", "Packets", "Bytes", "Adjacency");
2174 vec_foreach (r, routes)
2176 vlib_counter_t c, sum;
2177 uword i, j, n_left, n_nhs, adj_index, * result = 0;
2178 ip_adjacency_t * adj;
2179 ip_multipath_next_hop_t * nhs, tmp_nhs[1];
2181 adj_index = r->index;
2182 if (lm->fib_result_n_words > 1)
2184 result = vec_elt_at_index (results, adj_index);
2185 adj_index = result[0];
2188 adj = ip_get_adjacency (lm, adj_index);
2189 if (adj->n_adj == 1)
2192 nhs[0].next_hop_adj_index = ~0; /* not used */
2198 ip_multipath_adjacency_t * madj;
2199 madj = vec_elt_at_index (lm->multipath_adjacencies, adj->heap_handle);
2200 nhs = heap_elt_at_index (lm->next_hop_heap, madj->normalized_next_hops.heap_offset);
2201 n_nhs = madj->normalized_next_hops.count;
2204 n_left = nhs[0].weight;
2205 vlib_counter_zero (&sum);
2206 for (i = j = 0; i < adj->n_adj; i++)
2209 vlib_get_combined_counter (&lm->adjacency_counters,
2212 vlib_zero_combined_counter (&lm->adjacency_counters,
2214 vlib_counter_add (&sum, &c);
2221 msg = format (msg, "%-45U",
2222 format_ip6_address_and_length,
2223 r->address.as_u8, r->address_length);
2225 msg = format (msg, "%U", format_white_space, 20);
2227 msg = format (msg, "%16Ld%16Ld ", sum.packets, sum.bytes);
2229 indent = vec_len (msg);
2230 msg = format (msg, "weight %d, index %d",
2231 nhs[j].weight, adj_index + i);
2233 if (ip_adjacency_is_multipath(lm, adj_index + i))
2234 msg = format (msg, ", multipath");
2236 msg = format (msg, "\n%U%U",
2237 format_white_space, indent,
2238 format_ip_adjacency,
2239 vnm, lm, adj_index + i);
2241 vlib_cli_output (vm, "%v", msg);
2247 n_left = nhs[j].weight;
2248 vlib_counter_zero (&sum);
2253 if (result && lm->format_fib_result)
2254 vlib_cli_output (vm, "%20s%U", "", lm->format_fib_result, vm, lm, result, 0);
2256 vlib_cli_output (vm, " ");
2265 VLIB_CLI_COMMAND (ip6_show_fib_command, static) = {
2266 .path = "show ip6 fib",
2267 .short_help = "show ip6 fib [summary] [clear]",
2268 .function = ip6_show_fib,