FD.io VPP  v19.08-27-gf4dcae4
Vector Packet Processing
ip4_mtrie.c
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 /*
16  * ip/ip4_fib.h: ip4 mtrie fib
17  *
18  * Copyright (c) 2012 Eliot Dresselhaus
19  *
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:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
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.
38  */
39 
40 #include <vnet/ip/ip.h>
41 #include <vnet/ip/ip4_mtrie.h>
42 #include <vnet/fib/ip4_fib.h>
43 
44 
45 /**
46  * Global pool of IPv4 8bit PLYs
47  */
49 
52 {
53  /*
54  * It's 'non-empty' if the length of the leaf stored is greater than the
55  * length of a leaf in the covering ply. i.e. the leaf is more specific
56  * than it's would be cover in the covering ply
57  */
59  return (1);
60  return (0);
61 }
62 
65 {
67  l = 1 + 2 * adj_index;
68  ASSERT (ip4_fib_mtrie_leaf_get_adj_index (l) == adj_index);
69  return l;
70 }
71 
74 {
75  return (n & 1) == 0;
76 }
77 
80 {
82  return n >> 1;
83 }
84 
87 {
89  l = 0 + 2 * i;
91  return l;
92 }
93 
94 #ifndef __ALTIVEC__
95 #define PLY_X4_SPLAT_INIT(init_x4, init) \
96  init_x4 = u32x4_splat (init);
97 #else
98 #define PLY_X4_SPLAT_INIT(init_x4, init) \
99 { \
100  u32x4_union_t y; \
101  y.as_u32[0] = init; \
102  y.as_u32[1] = init; \
103  y.as_u32[2] = init; \
104  y.as_u32[3] = init; \
105  init_x4 = y.as_u32x4; \
106 }
107 #endif
108 
109 #ifdef CLIB_HAVE_VEC128
110 #define PLY_INIT_LEAVES(p) \
111 { \
112  u32x4 *l, init_x4; \
113  \
114  PLY_X4_SPLAT_INIT(init_x4, init); \
115  for (l = p->leaves_as_u32x4; \
116  l < p->leaves_as_u32x4 + ARRAY_LEN (p->leaves_as_u32x4); \
117  l += 4) \
118  { \
119  l[0] = init_x4; \
120  l[1] = init_x4; \
121  l[2] = init_x4; \
122  l[3] = init_x4; \
123  } \
124 }
125 #else
126 #define PLY_INIT_LEAVES(p) \
127 { \
128  u32 *l; \
129  \
130  for (l = p->leaves; l < p->leaves + ARRAY_LEN (p->leaves); l += 4) \
131  { \
132  l[0] = init; \
133  l[1] = init; \
134  l[2] = init; \
135  l[3] = init; \
136  } \
137 }
138 #endif
139 
140 #define PLY_INIT(p, init, prefix_len, ply_base_len) \
141 { \
142  /* \
143  * A leaf is 'empty' if it represents a leaf from the covering PLY \
144  * i.e. if the prefix length of the leaf is less than or equal to \
145  * the prefix length of the PLY \
146  */ \
147  p->n_non_empty_leafs = (prefix_len > ply_base_len ? \
148  ARRAY_LEN (p->leaves) : 0); \
149  clib_memset (p->dst_address_bits_of_leaves, prefix_len, \
150  sizeof (p->dst_address_bits_of_leaves)); \
151  p->dst_address_bits_base = ply_base_len; \
152  \
153  /* Initialize leaves. */ \
154  PLY_INIT_LEAVES(p); \
155 }
156 
157 static void
159  ip4_fib_mtrie_leaf_t init, uword prefix_len, u32 ply_base_len)
160 {
161  PLY_INIT (p, init, prefix_len, ply_base_len);
162 }
163 
164 static void
166  ip4_fib_mtrie_leaf_t init, uword prefix_len)
167 {
168  clib_memset (p->dst_address_bits_of_leaves, prefix_len,
169  sizeof (p->dst_address_bits_of_leaves));
170  PLY_INIT_LEAVES (p);
171 }
172 
175  ip4_fib_mtrie_leaf_t init_leaf,
176  u32 leaf_prefix_len, u32 ply_base_len)
177 {
179  void *old_heap;
180  /* Get cache aligned ply. */
181 
183  pool_get_aligned (ip4_ply_pool, p, CLIB_CACHE_LINE_BYTES);
184  clib_mem_set_heap (old_heap);
185 
186  ply_8_init (p, init_leaf, leaf_prefix_len, ply_base_len);
187  return ip4_fib_mtrie_leaf_set_next_ply_index (p - ip4_ply_pool);
188 }
189 
192 {
194 
195  return pool_elt_at_index (ip4_ply_pool, n);
196 }
197 
198 void
200 {
201  /* the root ply is embedded so the is nothing to do,
202  * the assumption being that the IP4 FIB table has emptied the trie
203  * before deletion.
204  */
205 #if CLIB_DEBUG > 0
206  int i;
207  for (i = 0; i < ARRAY_LEN (m->root_ply.leaves); i++)
208  {
210  }
211 #endif
212 }
213 
214 void
216 {
218 }
219 
220 typedef struct
221 {
228 
229 static void
231  ip4_fib_mtrie_8_ply_t * ply,
232  ip4_fib_mtrie_leaf_t new_leaf,
233  uword new_leaf_dst_address_bits)
234 {
235  ip4_fib_mtrie_leaf_t old_leaf;
236  uword i;
237 
239 
240  for (i = 0; i < ARRAY_LEN (ply->leaves); i++)
241  {
242  old_leaf = ply->leaves[i];
243 
244  /* Recurse into sub plies. */
245  if (!ip4_fib_mtrie_leaf_is_terminal (old_leaf))
246  {
247  ip4_fib_mtrie_8_ply_t *sub_ply =
248  get_next_ply_for_leaf (m, old_leaf);
249  set_ply_with_more_specific_leaf (m, sub_ply, new_leaf,
250  new_leaf_dst_address_bits);
251  }
252 
253  /* Replace less specific terminal leaves with new leaf. */
254  else if (new_leaf_dst_address_bits >=
256  {
257  clib_atomic_cmp_and_swap (&ply->leaves[i], old_leaf, new_leaf);
258  ASSERT (ply->leaves[i] == new_leaf);
259  ply->dst_address_bits_of_leaves[i] = new_leaf_dst_address_bits;
261  }
262  }
263 }
264 
265 static void
268  u32 old_ply_index, u32 dst_address_byte_index)
269 {
270  ip4_fib_mtrie_leaf_t old_leaf, new_leaf;
271  i32 n_dst_bits_next_plies;
272  u8 dst_byte;
273  ip4_fib_mtrie_8_ply_t *old_ply;
274 
275  old_ply = pool_elt_at_index (ip4_ply_pool, old_ply_index);
276 
277  ASSERT (a->dst_address_length <= 32);
278  ASSERT (dst_address_byte_index < ARRAY_LEN (a->dst_address.as_u8));
279 
280  /* how many bits of the destination address are in the next PLY */
281  n_dst_bits_next_plies =
282  a->dst_address_length - BITS (u8) * (dst_address_byte_index + 1);
283 
284  dst_byte = a->dst_address.as_u8[dst_address_byte_index];
285 
286  /* Number of bits next plies <= 0 => insert leaves this ply. */
287  if (n_dst_bits_next_plies <= 0)
288  {
289  /* The mask length of the address to insert maps to this ply */
290  uword old_leaf_is_terminal;
291  u32 i, n_dst_bits_this_ply;
292 
293  /* The number of bits, and hence slots/buckets, we will fill */
294  n_dst_bits_this_ply = clib_min (8, -n_dst_bits_next_plies);
295  ASSERT ((a->dst_address.as_u8[dst_address_byte_index] &
296  pow2_mask (n_dst_bits_this_ply)) == 0);
297 
298  /* Starting at the value of the byte at this section of the v4 address
299  * fill the buckets/slots of the ply */
300  for (i = dst_byte; i < dst_byte + (1 << n_dst_bits_this_ply); i++)
301  {
302  ip4_fib_mtrie_8_ply_t *new_ply;
303 
304  old_leaf = old_ply->leaves[i];
305  old_leaf_is_terminal = ip4_fib_mtrie_leaf_is_terminal (old_leaf);
306 
307  if (a->dst_address_length >= old_ply->dst_address_bits_of_leaves[i])
308  {
309  /* The new leaf is more or equally specific than the one currently
310  * occupying the slot */
312 
313  if (old_leaf_is_terminal)
314  {
315  /* The current leaf is terminal, we can replace it with
316  * the new one */
317  old_ply->n_non_empty_leafs -=
318  ip4_fib_mtrie_leaf_is_non_empty (old_ply, i);
319 
320  old_ply->dst_address_bits_of_leaves[i] =
322  clib_atomic_cmp_and_swap (&old_ply->leaves[i], old_leaf,
323  new_leaf);
324  ASSERT (old_ply->leaves[i] == new_leaf);
325 
326  old_ply->n_non_empty_leafs +=
327  ip4_fib_mtrie_leaf_is_non_empty (old_ply, i);
328  ASSERT (old_ply->n_non_empty_leafs <=
329  ARRAY_LEN (old_ply->leaves));
330  }
331  else
332  {
333  /* Existing leaf points to another ply. We need to place
334  * new_leaf into all more specific slots. */
335  new_ply = get_next_ply_for_leaf (m, old_leaf);
336  set_ply_with_more_specific_leaf (m, new_ply, new_leaf,
337  a->dst_address_length);
338  }
339  }
340  else if (!old_leaf_is_terminal)
341  {
342  /* The current leaf is less specific and not termial (i.e. a ply),
343  * recurse on down the trie */
344  new_ply = get_next_ply_for_leaf (m, old_leaf);
345  set_leaf (m, a, new_ply - ip4_ply_pool,
346  dst_address_byte_index + 1);
347  }
348  /*
349  * else
350  * the route we are adding is less specific than the leaf currently
351  * occupying this slot. leave it there
352  */
353  }
354  }
355  else
356  {
357  /* The address to insert requires us to move down at a lower level of
358  * the trie - recurse on down */
359  ip4_fib_mtrie_8_ply_t *new_ply;
360  u8 ply_base_len;
361 
362  ply_base_len = 8 * (dst_address_byte_index + 1);
363 
364  old_leaf = old_ply->leaves[dst_byte];
365 
366  if (ip4_fib_mtrie_leaf_is_terminal (old_leaf))
367  {
368  /* There is a leaf occupying the slot. Replace it with a new ply */
369  old_ply->n_non_empty_leafs -=
370  ip4_fib_mtrie_leaf_is_non_empty (old_ply, dst_byte);
371 
372  new_leaf =
373  ply_create (m, old_leaf,
374  old_ply->dst_address_bits_of_leaves[dst_byte],
375  ply_base_len);
376  new_ply = get_next_ply_for_leaf (m, new_leaf);
377 
378  /* Refetch since ply_create may move pool. */
379  old_ply = pool_elt_at_index (ip4_ply_pool, old_ply_index);
380 
381  clib_atomic_cmp_and_swap (&old_ply->leaves[dst_byte], old_leaf,
382  new_leaf);
383  ASSERT (old_ply->leaves[dst_byte] == new_leaf);
384  old_ply->dst_address_bits_of_leaves[dst_byte] = ply_base_len;
385 
386  old_ply->n_non_empty_leafs +=
387  ip4_fib_mtrie_leaf_is_non_empty (old_ply, dst_byte);
388  ASSERT (old_ply->n_non_empty_leafs >= 0);
389  }
390  else
391  new_ply = get_next_ply_for_leaf (m, old_leaf);
392 
393  set_leaf (m, a, new_ply - ip4_ply_pool, dst_address_byte_index + 1);
394  }
395 }
396 
397 static void
400 {
401  ip4_fib_mtrie_leaf_t old_leaf, new_leaf;
402  ip4_fib_mtrie_16_ply_t *old_ply;
403  i32 n_dst_bits_next_plies;
404  u16 dst_byte;
405 
406  old_ply = &m->root_ply;
407 
408  ASSERT (a->dst_address_length <= 32);
409 
410  /* how many bits of the destination address are in the next PLY */
411  n_dst_bits_next_plies = a->dst_address_length - BITS (u16);
412 
413  dst_byte = a->dst_address.as_u16[0];
414 
415  /* Number of bits next plies <= 0 => insert leaves this ply. */
416  if (n_dst_bits_next_plies <= 0)
417  {
418  /* The mask length of the address to insert maps to this ply */
419  uword old_leaf_is_terminal;
420  u32 i, n_dst_bits_this_ply;
421 
422  /* The number of bits, and hence slots/buckets, we will fill */
423  n_dst_bits_this_ply = 16 - a->dst_address_length;
424  ASSERT ((clib_host_to_net_u16 (a->dst_address.as_u16[0]) &
425  pow2_mask (n_dst_bits_this_ply)) == 0);
426 
427  /* Starting at the value of the byte at this section of the v4 address
428  * fill the buckets/slots of the ply */
429  for (i = 0; i < (1 << n_dst_bits_this_ply); i++)
430  {
431  ip4_fib_mtrie_8_ply_t *new_ply;
432  u16 slot;
433 
434  slot = clib_net_to_host_u16 (dst_byte);
435  slot += i;
436  slot = clib_host_to_net_u16 (slot);
437 
438  old_leaf = old_ply->leaves[slot];
439  old_leaf_is_terminal = ip4_fib_mtrie_leaf_is_terminal (old_leaf);
440 
441  if (a->dst_address_length >=
442  old_ply->dst_address_bits_of_leaves[slot])
443  {
444  /* The new leaf is more or equally specific than the one currently
445  * occupying the slot */
447 
448  if (old_leaf_is_terminal)
449  {
450  /* The current leaf is terminal, we can replace it with
451  * the new one */
452  old_ply->dst_address_bits_of_leaves[slot] =
454  clib_atomic_cmp_and_swap (&old_ply->leaves[slot],
455  old_leaf, new_leaf);
456  ASSERT (old_ply->leaves[slot] == new_leaf);
457  }
458  else
459  {
460  /* Existing leaf points to another ply. We need to place
461  * new_leaf into all more specific slots. */
462  new_ply = get_next_ply_for_leaf (m, old_leaf);
463  set_ply_with_more_specific_leaf (m, new_ply, new_leaf,
464  a->dst_address_length);
465  }
466  }
467  else if (!old_leaf_is_terminal)
468  {
469  /* The current leaf is less specific and not termial (i.e. a ply),
470  * recurse on down the trie */
471  new_ply = get_next_ply_for_leaf (m, old_leaf);
472  set_leaf (m, a, new_ply - ip4_ply_pool, 2);
473  }
474  /*
475  * else
476  * the route we are adding is less specific than the leaf currently
477  * occupying this slot. leave it there
478  */
479  }
480  }
481  else
482  {
483  /* The address to insert requires us to move down at a lower level of
484  * the trie - recurse on down */
485  ip4_fib_mtrie_8_ply_t *new_ply;
486  u8 ply_base_len;
487 
488  ply_base_len = 16;
489 
490  old_leaf = old_ply->leaves[dst_byte];
491 
492  if (ip4_fib_mtrie_leaf_is_terminal (old_leaf))
493  {
494  /* There is a leaf occupying the slot. Replace it with a new ply */
495  new_leaf =
496  ply_create (m, old_leaf,
497  old_ply->dst_address_bits_of_leaves[dst_byte],
498  ply_base_len);
499  new_ply = get_next_ply_for_leaf (m, new_leaf);
500 
501  clib_atomic_cmp_and_swap (&old_ply->leaves[dst_byte], old_leaf,
502  new_leaf);
503  ASSERT (old_ply->leaves[dst_byte] == new_leaf);
504  old_ply->dst_address_bits_of_leaves[dst_byte] = ply_base_len;
505  }
506  else
507  new_ply = get_next_ply_for_leaf (m, old_leaf);
508 
509  set_leaf (m, a, new_ply - ip4_ply_pool, 2);
510  }
511 }
512 
513 static uword
516  ip4_fib_mtrie_8_ply_t * old_ply, u32 dst_address_byte_index)
517 {
518  ip4_fib_mtrie_leaf_t old_leaf, del_leaf;
519  i32 n_dst_bits_next_plies;
520  i32 i, n_dst_bits_this_ply, old_leaf_is_terminal;
521  u8 dst_byte;
522 
523  ASSERT (a->dst_address_length <= 32);
524  ASSERT (dst_address_byte_index < ARRAY_LEN (a->dst_address.as_u8));
525 
526  n_dst_bits_next_plies =
527  a->dst_address_length - BITS (u8) * (dst_address_byte_index + 1);
528 
529  dst_byte = a->dst_address.as_u8[dst_address_byte_index];
530  if (n_dst_bits_next_plies < 0)
531  dst_byte &= ~pow2_mask (-n_dst_bits_next_plies);
532 
533  n_dst_bits_this_ply =
534  n_dst_bits_next_plies <= 0 ? -n_dst_bits_next_plies : 0;
535  n_dst_bits_this_ply = clib_min (8, n_dst_bits_this_ply);
536 
538 
539  for (i = dst_byte; i < dst_byte + (1 << n_dst_bits_this_ply); i++)
540  {
541  old_leaf = old_ply->leaves[i];
542  old_leaf_is_terminal = ip4_fib_mtrie_leaf_is_terminal (old_leaf);
543 
544  if (old_leaf == del_leaf
545  || (!old_leaf_is_terminal
546  && unset_leaf (m, a, get_next_ply_for_leaf (m, old_leaf),
547  dst_address_byte_index + 1)))
548  {
549  old_ply->n_non_empty_leafs -=
550  ip4_fib_mtrie_leaf_is_non_empty (old_ply, i);
551 
552  old_ply->leaves[i] =
555 
556  old_ply->n_non_empty_leafs +=
557  ip4_fib_mtrie_leaf_is_non_empty (old_ply, i);
558 
559  ASSERT (old_ply->n_non_empty_leafs >= 0);
560  if (old_ply->n_non_empty_leafs == 0 && dst_address_byte_index > 0)
561  {
562  pool_put (ip4_ply_pool, old_ply);
563  /* Old ply was deleted. */
564  return 1;
565  }
566 #if CLIB_DEBUG > 0
567  else if (dst_address_byte_index)
568  {
569  int ii, count = 0;
570  for (ii = 0; ii < ARRAY_LEN (old_ply->leaves); ii++)
571  {
572  count += ip4_fib_mtrie_leaf_is_non_empty (old_ply, ii);
573  }
574  ASSERT (count);
575  }
576 #endif
577  }
578  }
579 
580  /* Old ply was not deleted. */
581  return 0;
582 }
583 
584 static void
587 {
588  ip4_fib_mtrie_leaf_t old_leaf, del_leaf;
589  i32 n_dst_bits_next_plies;
590  i32 i, n_dst_bits_this_ply, old_leaf_is_terminal;
591  u16 dst_byte;
592  ip4_fib_mtrie_16_ply_t *old_ply;
593 
594  ASSERT (a->dst_address_length <= 32);
595 
596  old_ply = &m->root_ply;
597  n_dst_bits_next_plies = a->dst_address_length - BITS (u16);
598 
599  dst_byte = a->dst_address.as_u16[0];
600 
601  n_dst_bits_this_ply = (n_dst_bits_next_plies <= 0 ?
602  (16 - a->dst_address_length) : 0);
603 
605 
606  /* Starting at the value of the byte at this section of the v4 address
607  * fill the buckets/slots of the ply */
608  for (i = 0; i < (1 << n_dst_bits_this_ply); i++)
609  {
610  u16 slot;
611 
612  slot = clib_net_to_host_u16 (dst_byte);
613  slot += i;
614  slot = clib_host_to_net_u16 (slot);
615 
616  old_leaf = old_ply->leaves[slot];
617  old_leaf_is_terminal = ip4_fib_mtrie_leaf_is_terminal (old_leaf);
618 
619  if (old_leaf == del_leaf
620  || (!old_leaf_is_terminal
621  && unset_leaf (m, a, get_next_ply_for_leaf (m, old_leaf), 2)))
622  {
623  old_ply->leaves[slot] =
626  }
627  }
628 }
629 
630 void
632  const ip4_address_t * dst_address,
633  u32 dst_address_length, u32 adj_index)
634 {
636  ip4_main_t *im = &ip4_main;
637 
638  /* Honor dst_address_length. Fib masks are in network byte order */
639  a.dst_address.as_u32 = (dst_address->as_u32 &
640  im->fib_masks[dst_address_length]);
641  a.dst_address_length = dst_address_length;
642  a.adj_index = adj_index;
643 
644  set_root_leaf (m, &a);
645 }
646 
647 void
649  const ip4_address_t * dst_address,
650  u32 dst_address_length,
651  u32 adj_index,
652  u32 cover_address_length, u32 cover_adj_index)
653 {
655  ip4_main_t *im = &ip4_main;
656 
657  /* Honor dst_address_length. Fib masks are in network byte order */
658  a.dst_address.as_u32 = (dst_address->as_u32 &
659  im->fib_masks[dst_address_length]);
660  a.dst_address_length = dst_address_length;
661  a.adj_index = adj_index;
662  a.cover_adj_index = cover_adj_index;
663  a.cover_address_length = cover_address_length;
664 
665  /* the top level ply is never removed */
666  unset_root_leaf (m, &a);
667 }
668 
669 /* Returns number of bytes of memory used by mtrie. */
670 static uword
672 {
673  uword bytes, i;
674 
675  bytes = sizeof (p[0]);
676  for (i = 0; i < ARRAY_LEN (p->leaves); i++)
677  {
678  ip4_fib_mtrie_leaf_t l = p->leaves[i];
680  bytes += mtrie_ply_memory_usage (m, get_next_ply_for_leaf (m, l));
681  }
682 
683  return bytes;
684 }
685 
686 /* Returns number of bytes of memory used by mtrie. */
687 uword
689 {
690  uword bytes, i;
691 
692  bytes = sizeof (*m);
693  for (i = 0; i < ARRAY_LEN (m->root_ply.leaves); i++)
694  {
697  bytes += mtrie_ply_memory_usage (m, get_next_ply_for_leaf (m, l));
698  }
699 
700  return bytes;
701 }
702 
703 static u8 *
704 format_ip4_fib_mtrie_leaf (u8 * s, va_list * va)
705 {
706  ip4_fib_mtrie_leaf_t l = va_arg (*va, ip4_fib_mtrie_leaf_t);
707 
709  s = format (s, "lb-index %d", ip4_fib_mtrie_leaf_get_adj_index (l));
710  else
711  s = format (s, "next ply %d", ip4_fib_mtrie_leaf_get_next_ply_index (l));
712  return s;
713 }
714 
715 #define FORMAT_PLY(s, _p, _a, _i, _base_address, _ply_max_len, _indent) \
716 ({ \
717  u32 a, ia_length; \
718  ip4_address_t ia; \
719  ip4_fib_mtrie_leaf_t _l = p->leaves[(_i)]; \
720  \
721  a = (_base_address) + ((_a) << (32 - (_ply_max_len))); \
722  ia.as_u32 = clib_host_to_net_u32 (a); \
723  ia_length = (_p)->dst_address_bits_of_leaves[(_i)]; \
724  s = format (s, "\n%U%U %U", \
725  format_white_space, (_indent) + 4, \
726  format_ip4_address_and_length, &ia, ia_length, \
727  format_ip4_fib_mtrie_leaf, _l); \
728  \
729  if (ip4_fib_mtrie_leaf_is_next_ply (_l)) \
730  s = format (s, "\n%U", \
731  format_ip4_fib_mtrie_ply, m, a, (_indent) + 8, \
732  ip4_fib_mtrie_leaf_get_next_ply_index (_l)); \
733  s; \
734 })
735 
736 static u8 *
737 format_ip4_fib_mtrie_ply (u8 * s, va_list * va)
738 {
739  ip4_fib_mtrie_t *m = va_arg (*va, ip4_fib_mtrie_t *);
740  u32 base_address = va_arg (*va, u32);
741  u32 indent = va_arg (*va, u32);
742  u32 ply_index = va_arg (*va, u32);
744  int i;
745 
746  p = pool_elt_at_index (ip4_ply_pool, ply_index);
747  s = format (s, "%Uply index %d, %d non-empty leaves",
748  format_white_space, indent, ply_index, p->n_non_empty_leafs);
749 
750  for (i = 0; i < ARRAY_LEN (p->leaves); i++)
751  {
753  {
754  s = FORMAT_PLY (s, p, i, i, base_address,
755  p->dst_address_bits_base + 8, indent);
756  }
757  }
758 
759  return s;
760 }
761 
762 u8 *
763 format_ip4_fib_mtrie (u8 * s, va_list * va)
764 {
765  ip4_fib_mtrie_t *m = va_arg (*va, ip4_fib_mtrie_t *);
766  int verbose = va_arg (*va, int);
768  u32 base_address = 0;
769  int i;
770 
771  s = format (s, "%d plies, memory usage %U\n",
772  pool_elts (ip4_ply_pool),
774  s = format (s, "root-ply");
775  p = &m->root_ply;
776 
777  if (verbose)
778  {
779  s = format (s, "root-ply");
780  p = &m->root_ply;
781 
782  for (i = 0; i < ARRAY_LEN (p->leaves); i++)
783  {
784  u16 slot;
785 
786  slot = clib_host_to_net_u16 (i);
787 
788  if (p->dst_address_bits_of_leaves[slot] > 0)
789  {
790  s = FORMAT_PLY (s, p, i, slot, base_address, 16, 0);
791  }
792  }
793  }
794 
795  return s;
796 }
797 
798 /** Default heap size for the IPv4 mtries */
799 #define IP4_FIB_DEFAULT_MTRIE_HEAP_SIZE (32<<20)
800 
801 static clib_error_t *
803 {
805  ip4_main_t *im = &ip4_main;
806  clib_error_t *error = NULL;
807  uword *old_heap;
808 
809  if (0 == im->mtrie_heap_size)
811 #if USE_DLMALLOC == 0
812  im->mtrie_mheap = mheap_alloc (0, im->mtrie_heap_size);
813 #else
814  im->mtrie_mheap = create_mspace (im->mtrie_heap_size, 1 /* locked */ );
815 #endif
816 
817  /* Burn one ply so index 0 is taken */
819  pool_get (ip4_ply_pool, p);
820  clib_mem_set_heap (old_heap);
821 
822  return (error);
823 }
824 
826 
827 /*
828  * fd.io coding-style-patch-verification: ON
829  *
830  * Local Variables:
831  * eval: (c-set-style "gnu")
832  * End:
833  */
static ip4_fib_mtrie_8_ply_t * get_next_ply_for_leaf(ip4_fib_mtrie_t *m, ip4_fib_mtrie_leaf_t l)
Definition: ip4_mtrie.c:191
#define clib_min(x, y)
Definition: clib.h:295
#define CLIB_UNUSED(x)
Definition: clib.h:82
static ip4_fib_mtrie_leaf_t ply_create(ip4_fib_mtrie_t *m, ip4_fib_mtrie_leaf_t init_leaf, u32 leaf_prefix_len, u32 ply_base_len)
Definition: ip4_mtrie.c:174
a
Definition: bitmap.h:538
The mutiway-TRIE.
Definition: ip4_mtrie.h:129
#define PLY_INIT_LEAVES(p)
Definition: ip4_mtrie.c:126
static void set_leaf(ip4_fib_mtrie_t *m, const ip4_fib_mtrie_set_unset_leaf_args_t *a, u32 old_ply_index, u32 dst_address_byte_index)
Definition: ip4_mtrie.c:266
void * mheap_alloc(void *memory, uword size)
Definition: mheap.c:963
ip4_fib_mtrie_8_ply_t * ip4_ply_pool
Global pool of IPv4 8bit PLYs.
Definition: ip4_mtrie.c:48
#define NULL
Definition: clib.h:58
ip4_fib_mtrie_leaf_t leaves[256]
Definition: ip4_mtrie.h:93
int i
static void unset_root_leaf(ip4_fib_mtrie_t *m, const ip4_fib_mtrie_set_unset_leaf_args_t *a)
Definition: ip4_mtrie.c:585
clib_memset(h->entries, 0, sizeof(h->entries[0])*entries)
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
static u32 ip4_fib_mtrie_leaf_is_non_empty(ip4_fib_mtrie_8_ply_t *p, u8 dst_byte)
Definition: ip4_mtrie.c:51
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:236
unsigned char u8
Definition: types.h:56
u8 dst_address_bits_of_leaves[PLY_16_SIZE]
Prefix length for terminal leaves.
Definition: ip4_mtrie.h:80
#define IP4_FIB_MTRIE_LEAF_EMPTY
Definition: ip4_mtrie.h:54
One ply of the 4 ply mtrie fib.
Definition: ip4_mtrie.h:86
static void set_ply_with_more_specific_leaf(ip4_fib_mtrie_t *m, ip4_fib_mtrie_8_ply_t *ply, ip4_fib_mtrie_leaf_t new_leaf, uword new_leaf_dst_address_bits)
Definition: ip4_mtrie.c:230
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:173
#define FORMAT_PLY(s, _p, _a, _i, _base_address, _ply_max_len, _indent)
Definition: ip4_mtrie.c:715
#define always_inline
Definition: clib.h:98
static uword pow2_mask(uword x)
Definition: clib.h:220
u8 * format_white_space(u8 *s, va_list *va)
Definition: std-formats.c:129
void ip4_mtrie_free(ip4_fib_mtrie_t *m)
Free an mtrie, It must be emty when free&#39;d.
Definition: ip4_mtrie.c:199
u32 ip4_fib_mtrie_leaf_t
Definition: ip4_mtrie.h:52
u8 * format_memory_size(u8 *s, va_list *va)
Definition: std-formats.c:209
ip4_fib_mtrie_leaf_t leaves[PLY_16_SIZE]
Definition: ip4_mtrie.h:70
unsigned int u32
Definition: types.h:88
#define IP4_FIB_DEFAULT_MTRIE_HEAP_SIZE
Default heap size for the IPv4 mtries.
Definition: ip4_mtrie.c:799
static u32 ip4_fib_mtrie_leaf_get_adj_index(ip4_fib_mtrie_leaf_t n)
From the stored slot value extract the LB index value.
Definition: ip4_mtrie.h:192
void ip4_mtrie_init(ip4_fib_mtrie_t *m)
Initialise an mtrie.
Definition: ip4_mtrie.c:215
static u8 * format_ip4_fib_mtrie_leaf(u8 *s, va_list *va)
Definition: ip4_mtrie.c:704
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:514
u16 as_u16[2]
Definition: ip4_packet.h:55
u8 * format_ip4_fib_mtrie(u8 *s, va_list *va)
Definition: ip4_mtrie.c:763
uword mtrie_heap_size
Heapsize for the Mtries.
Definition: ip4.h:167
unsigned short u16
Definition: types.h:57
static void set_root_leaf(ip4_fib_mtrie_t *m, const ip4_fib_mtrie_set_unset_leaf_args_t *a)
Definition: ip4_mtrie.c:398
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:286
static uword mtrie_ply_memory_usage(ip4_fib_mtrie_t *m, ip4_fib_mtrie_8_ply_t *p)
Definition: ip4_mtrie.c:671
void * mtrie_mheap
The memory heap for the mtries.
Definition: ip4.h:170
#define pool_get_aligned(P, E, A)
Allocate an object E from a pool P with alignment A.
Definition: pool.h:230
u8 dst_address_bits_of_leaves[256]
Prefix length for leaves/ply.
Definition: ip4_mtrie.h:103
DLMALLOC_EXPORT mspace create_mspace(size_t capacity, int locked)
uword ip4_fib_mtrie_memory_usage(ip4_fib_mtrie_t *m)
return the memory used by the table
Definition: ip4_mtrie.c:688
vlib_main_t * vm
Definition: buffer.c:312
ip4_fib_mtrie_16_ply_t root_ply
Embed the PLY with the mtrie struct.
Definition: ip4_mtrie.h:136
static void * clib_mem_set_heap(void *heap)
Definition: mem.h:282
#define ARRAY_LEN(x)
Definition: clib.h:62
#define PLY_INIT(p, init, prefix_len, ply_base_len)
Definition: ip4_mtrie.c:140
#define clib_atomic_cmp_and_swap(addr, old, new)
Definition: atomics.h:37
signed int i32
Definition: types.h:77
static clib_error_t * ip4_mtrie_module_init(vlib_main_t *vm)
Definition: ip4_mtrie.c:802
#define ASSERT(truth)
IPv4 main type.
Definition: ip4.h:105
i32 n_non_empty_leafs
Number of non-empty leafs (whether terminal or not).
Definition: ip4_mtrie.h:108
size_t count
Definition: vapi.c:47
static void init(void)
Definition: client.c:116
static u32 ip4_fib_mtrie_leaf_is_next_ply(ip4_fib_mtrie_leaf_t n)
Definition: ip4_mtrie.c:73
i32 dst_address_bits_base
The length of the ply&#39;s coviering prefix.
Definition: ip4_mtrie.h:115
void ip4_fib_mtrie_route_add(ip4_fib_mtrie_t *m, const ip4_address_t *dst_address, u32 dst_address_length, u32 adj_index)
Add a route/rntry to the mtrie.
Definition: ip4_mtrie.c:631
u64 uword
Definition: types.h:112
static ip4_fib_mtrie_leaf_t ip4_fib_mtrie_leaf_set_adj_index(u32 adj_index)
Definition: ip4_mtrie.c:64
ip4_main_t ip4_main
Global ip4 main structure.
Definition: ip4_forward.c:921
static u32 ip4_fib_mtrie_leaf_get_next_ply_index(ip4_fib_mtrie_leaf_t n)
Definition: ip4_mtrie.c:79
void ip4_fib_mtrie_route_del(ip4_fib_mtrie_t *m, const ip4_address_t *dst_address, u32 dst_address_length, u32 adj_index, u32 cover_address_length, u32 cover_adj_index)
remove a route/rntry to the mtrie
Definition: ip4_mtrie.c:648
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
static uword unset_leaf(ip4_fib_mtrie_t *m, const ip4_fib_mtrie_set_unset_leaf_args_t *a, ip4_fib_mtrie_8_ply_t *old_ply, u32 dst_address_byte_index)
Definition: ip4_mtrie.c:514
#define BITS(x)
Definition: clib.h:61
static u8 * format_ip4_fib_mtrie_ply(u8 *s, va_list *va)
Definition: ip4_mtrie.c:737
static void ply_16_init(ip4_fib_mtrie_16_ply_t *p, ip4_fib_mtrie_leaf_t init, uword prefix_len)
Definition: ip4_mtrie.c:165
static u32 ip4_fib_mtrie_leaf_is_terminal(ip4_fib_mtrie_leaf_t n)
Is the leaf terminal (i.e.
Definition: ip4_mtrie.h:183
static void ply_8_init(ip4_fib_mtrie_8_ply_t *p, ip4_fib_mtrie_leaf_t init, uword prefix_len, u32 ply_base_len)
Definition: ip4_mtrie.c:158
u32 fib_masks[33]
Definition: ip4.h:118
static ip4_fib_mtrie_leaf_t ip4_fib_mtrie_leaf_set_next_ply_index(u32 i)
Definition: ip4_mtrie.c:86
static uword pool_elts(void *v)
Number of active elements in a pool.
Definition: pool.h:128