FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
mfib_entry.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016 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 #include <vlib/vlib.h>
17 
18 #include <vnet/mfib/mfib_entry.h>
21 #include <vnet/fib/fib_path_list.h>
22 #include <vnet/fib/fib_walk.h>
23 
24 #include <vnet/dpo/drop_dpo.h>
25 #include <vnet/dpo/replicate_dpo.h>
26 
27 /**
28  * the logger
29  */
31 
32 /**
33  * Pool of path extensions
34  */
36 
37 /**
38  * String names for each source
39  */
40 static const char *mfib_source_names[] = MFIB_SOURCE_NAMES;
42 
43 /*
44  * Pool for all fib_entries
45  */
47 
48 static fib_node_t *
50 {
51  return ((fib_node_t*)mfib_entry_get(index));
52 }
53 
54 static fib_protocol_t
55 mfib_entry_get_proto (const mfib_entry_t * mfib_entry)
56 {
57  return (mfib_entry->mfe_prefix.fp_proto);
58 }
59 
62 {
63  switch (mfib_entry->mfe_prefix.fp_proto)
64  {
65  case FIB_PROTOCOL_IP4:
67  case FIB_PROTOCOL_IP6:
69  case FIB_PROTOCOL_MPLS:
70  ASSERT(0);
71  break;
72  }
74 }
75 
76 static u8 *
77 format_mfib_entry_dpo (u8 * s, va_list * args)
78 {
79  index_t fei = va_arg(*args, index_t);
80  CLIB_UNUSED(u32 indent) = va_arg(*args, u32);
81 
82  return (format(s, "%U",
83  format_mfib_entry, fei,
85 }
86 
87 static inline mfib_path_ext_t *
89 {
90  return (pool_elt_at_index(mfib_path_ext_pool, mi));
91 }
92 
93 static u8 *
94 format_mfib_entry_path_ext (u8 * s, va_list * args)
95 {
96  mfib_path_ext_t *path_ext;
97  index_t mpi = va_arg(*args, index_t);
98 
99  path_ext = mfib_entry_path_ext_get(mpi);
100  return (format(s, "path:%d flags:%U",
101  path_ext->mfpe_path,
102  format_mfib_itf_flags, path_ext->mfpe_flags));
103 }
104 
105 u8 *
106 format_mfib_entry_src_flags (u8 *s, va_list *args)
107 {
109  mfib_entry_src_flags_t flag = va_arg(*args, int);
110 
111  if (!flag)
112  {
113  return format(s, "none");
114  }
115 
117  if ((1 << sattr) & flag) {
118  s = format (s, "%s,", mfib_src_attribute_names[sattr]);
119  }
120  }
121 
122  return (s);
123 }
124 
125 u8 *
126 format_mfib_entry (u8 * s, va_list * args)
127 {
128  fib_node_index_t fei, mfi;
129  mfib_entry_t *mfib_entry;
130  mfib_entry_src_t *msrc;
132  int level;
133 
134  fei = va_arg (*args, fib_node_index_t);
135  level = va_arg (*args, int);
136  mfib_entry = mfib_entry_get(fei);
137 
138  s = format (s, "%U", format_mfib_prefix, &mfib_entry->mfe_prefix);
139  s = format (s, ": %U", format_mfib_entry_flags, mfib_entry->mfe_flags);
140 
141  if (level >= MFIB_ENTRY_FORMAT_DETAIL)
142  {
143  fib_node_index_t path_index, mpi;
144 
145  s = format (s, "\n");
146  s = format (s, " fib:%d", mfib_entry->mfe_fib_index);
147  s = format (s, " index:%d", mfib_entry_get_index(mfib_entry));
148  s = format (s, " locks:%d\n", mfib_entry->mfe_node.fn_locks);
149  vec_foreach(msrc, mfib_entry->mfe_srcs)
150  {
151  s = format (s, " src:%s flags:%U locks:%d:",
154  msrc->mfes_ref_count);
155  if (msrc->mfes_cover != FIB_NODE_INDEX_INVALID)
156  {
157  s = format (s, " cover:%d", msrc->mfes_cover);
158  }
159  s = format (s, " %U\n", format_mfib_entry_flags, msrc->mfes_route_flags);
160  if (FIB_NODE_INDEX_INVALID != msrc->mfes_pl)
161  {
162  s = fib_path_list_format(msrc->mfes_pl, s);
163  }
164  s = format (s, " Extensions:\n");
165  hash_foreach(path_index, mpi, msrc->mfes_exts,
166  ({
167  s = format(s, " %U\n", format_mfib_entry_path_ext, mpi);
168  }));
169  s = format (s, " Interface-Forwarding:\n");
170  hash_foreach(sw_if_index, mfi, msrc->mfes_itfs,
171  ({
172  s = format(s, " %U\n", format_mfib_itf, mfi);
173  }));
174  }
175  }
176 
177  s = format(s, "\n Interfaces:");
178  hash_foreach(sw_if_index, mfi, mfib_entry->mfe_itfs,
179  ({
180  s = format(s, "\n %U", format_mfib_itf, mfi);
181  }));
182  if (MFIB_RPF_ID_NONE != mfib_entry->mfe_rpf_id)
183  {
184  s = format(s, "\n RPF-ID:%d", mfib_entry->mfe_rpf_id);
185  }
186  s = format(s, "\n %U-chain\n %U",
190  &mfib_entry->mfe_rep,
191  2);
192  s = format(s, "\n");
193 
194  if (level >= MFIB_ENTRY_FORMAT_DETAIL2)
195  {
196  s = format(s, "\nchildren:");
197  s = fib_node_children_format(mfib_entry->mfe_node.fn_children, s);
198  }
199 
200  return (s);
201 }
202 
203 static mfib_entry_t*
205 {
207  return ((mfib_entry_t*)node);
208 }
209 
210 static int
212  void * v2)
213 {
214  mfib_entry_src_t *esrc1 = v1, *esrc2 = v2;
215 
216  return (esrc1->mfes_src - esrc2->mfes_src);
217 }
218 
219 static void
221  mfib_source_t source)
222 
223 {
224  mfib_entry_src_t esrc = {
226  .mfes_route_flags = MFIB_ENTRY_FLAG_NONE,
227  .mfes_src = source,
228  .mfes_cover = FIB_NODE_INDEX_INVALID,
229  .mfes_sibling = FIB_NODE_INDEX_INVALID,
230  .mfes_ref_count = 1,
231  };
232 
233  vec_add1(mfib_entry->mfe_srcs, esrc);
234  vec_sort_with_function(mfib_entry->mfe_srcs,
236 }
237 
238 static mfib_entry_src_t *
240  mfib_source_t source,
241  u32 *index)
242 
243 {
244  mfib_entry_src_t *esrc;
245  int ii;
246 
247  ii = 0;
248  vec_foreach(esrc, mfib_entry->mfe_srcs)
249  {
250  if (esrc->mfes_src == source)
251  {
252  if (NULL != index)
253  {
254  *index = ii;
255  }
256  return (esrc);
257  }
258  else
259  {
260  ii++;
261  }
262  }
263 
264  return (NULL);
265 }
266 
267 static mfib_entry_src_t *
269  mfib_source_t source)
270 {
271  mfib_entry_src_t *msrc;
272 
273  msrc = mfib_entry_src_find(mfib_entry, source, NULL);
274 
275  if (NULL == msrc)
276  {
277  mfib_entry_src_init(mfib_entry, source);
278  msrc = mfib_entry_src_find(mfib_entry, source, NULL);
279  }
280 
281  return (msrc);
282 }
283 
284 static mfib_entry_src_t *
286  mfib_source_t source,
289 {
290  mfib_entry_src_t *msrc;
291 
292  msrc = mfib_entry_src_find_or_create(mfib_entry, source);
293 
295  msrc->mfes_rpf_id = rpf_id;
297 
298  return (msrc);
299 }
300 
301 static mfib_entry_src_t *
303  mfib_source_t source,
306 {
307  mfib_entry_src_t *msrc;
308 
309  msrc = mfib_entry_src_update(mfib_entry, source, rpf_id, entry_flags);
310 
311  msrc->mfes_ref_count++;
313 
314  return (msrc);
315 }
316 
319 {
320  mfib_entry_src_t *bsrc;
321 
322  /*
323  * the enum of sources is deliberately arranged in priority order
324  */
325  if (0 == vec_len(mfib_entry->mfe_srcs))
326  {
327  bsrc = NULL;
328  }
329  else
330  {
331  bsrc = vec_elt_at_index(mfib_entry->mfe_srcs, 0);
332  }
333 
334  return (bsrc);
335 }
336 
337 static mfib_source_t
339 {
340  mfib_entry_src_t *bsrc;
341 
342  bsrc = mfib_entry_get_best_src(mfib_entry);
343 
344  return (bsrc->mfes_src);
345 }
346 
347 int
349  mfib_source_t source)
350 {
351  mfib_entry_t *mfib_entry;
352 
353  mfib_entry = mfib_entry_get(mfib_entry_index);
354 
355  return (NULL != mfib_entry_src_find(mfib_entry, source, NULL));
356 }
357 
358 int
360  mfib_source_t source)
361 {
362  mfib_entry_t *mfib_entry;
363  mfib_entry_src_t *esrc;
364 
365  mfib_entry = mfib_entry_get(mfib_entry_index);
366 
367  esrc = mfib_entry_src_find(mfib_entry, source, NULL);
368 
369  if (NULL == esrc)
370  {
371  return (0);
372  }
373  else
374  {
375  return (!!(esrc->mfes_flags & MFIB_ENTRY_SRC_FLAG_STALE));
376  }
377 }
378 
379 void
381  mfib_source_t source)
382 {
383  mfib_entry_t *mfib_entry;
384  mfib_entry_src_t *esrc;
385 
386  mfib_entry = mfib_entry_get(fib_entry_index);
387 
388  esrc = mfib_entry_src_find(mfib_entry, source, NULL);
389 
390  if (NULL != esrc)
391  {
393  }
394 }
395 
396 int
398 {
399  return (mfib_prefix_is_host(mfib_entry_get_prefix(mfib_entry_index)));
400 }
401 
402 
403 static void
405 {
407  index_t mfii;
408 
409  hash_foreach(sw_if_index, mfii, msrc->mfes_itfs,
410  ({
411  mfib_itf_delete(mfib_itf_get(mfii));
412  }));
413  hash_free(msrc->mfes_itfs);
414  msrc->mfes_itfs = NULL;
416 }
417 
418 static void
420  mfib_source_t source)
421 
422 {
423  mfib_entry_src_t *msrc;
424  u32 index = ~0;
425 
426  msrc = mfib_entry_src_find(mfib_entry, source, &index);
427 
428  if (NULL != msrc)
429  {
430  ASSERT(0 != msrc->mfes_ref_count);
431  msrc->mfes_ref_count--;
432 
433  if (0 == msrc->mfes_ref_count)
434  {
435  mfib_entry_src_deactivate(mfib_entry, msrc);
436  mfib_entry_src_flush(msrc);
437 
438  vec_del1(mfib_entry->mfe_srcs, index);
439  if (vec_len (mfib_entry->mfe_srcs) > 1)
440  vec_sort_with_function(mfib_entry->mfe_srcs,
442  }
443  }
444 }
445 
446 u32
448  fib_node_type_t child_type,
449  fib_node_index_t child_index)
450 {
452  mfib_entry_index,
453  child_type,
454  child_index));
455 };
456 
457 void
459  u32 sibling_index)
460 {
462  mfib_entry_index,
463  sibling_index);
464 }
465 
466 static mfib_entry_t *
468  const mfib_prefix_t *prefix,
469  fib_node_index_t *mfib_entry_index)
470 {
471  mfib_entry_t *mfib_entry;
472 
473  pool_get_aligned(mfib_entry_pool, mfib_entry, CLIB_CACHE_LINE_BYTES);
474 
475  fib_node_init(&mfib_entry->mfe_node,
477 
478  /*
479  * Some of the members require non-default initialisation
480  * so we also init those that don't and thus save on the call to clib_memset.
481  */
482  mfib_entry->mfe_flags = 0;
483  mfib_entry->mfe_fib_index = fib_index;
484  mfib_entry->mfe_prefix = *prefix;
485  mfib_entry->mfe_srcs = NULL;
486  mfib_entry->mfe_itfs = NULL;
487  mfib_entry->mfe_rpf_id = MFIB_RPF_ID_NONE;
488  mfib_entry->mfe_pl = FIB_NODE_INDEX_INVALID;
489 
490  dpo_reset(&mfib_entry->mfe_rep);
491 
492  *mfib_entry_index = mfib_entry_get_index(mfib_entry);
493 
494  MFIB_ENTRY_DBG(mfib_entry, "alloc");
495 
496  return (mfib_entry);
497 }
498 
499 static inline mfib_path_ext_t *
501  fib_node_index_t path_index)
502 {
503  uword *p;
504 
505  p = hash_get(exts, path_index);
506 
507  if (NULL != p)
508  {
509  return (mfib_entry_path_ext_get(p[0]));
510  }
511 
512  return (NULL);
513 }
514 
515 static mfib_path_ext_t*
517  fib_node_index_t path_index,
518  mfib_itf_flags_t mfi_flags)
519 {
520  mfib_path_ext_t *path_ext;
521 
522  pool_get(mfib_path_ext_pool, path_ext);
523 
524  path_ext->mfpe_flags = mfi_flags;
525  path_ext->mfpe_path = path_index;
526 
527  hash_set(msrc->mfes_exts, path_index,
528  path_ext - mfib_path_ext_pool);
529 
530  return (path_ext);
531 }
532 
533 static void
535  fib_node_index_t path_index)
536 {
537  mfib_path_ext_t *path_ext;
538 
539  path_ext = mfib_entry_path_ext_find(msrc->mfes_exts, path_index);
540 
541  hash_unset(msrc->mfes_exts, path_index);
542  pool_put(mfib_path_ext_pool, path_ext);
543 }
544 
546 {
551 
554  fib_node_index_t path_index,
555  void *arg)
556 {
559 
560  ctx = arg;
561 
562  /*
563  * if the path is not resolved, don't include it.
564  */
565  if (!fib_path_is_resolved(path_index))
566  {
568  }
569 
570  /*
571  * If the path is not forwarding to use it
572  */
573  mfib_path_ext_t *path_ext;
574 
575  path_ext = mfib_entry_path_ext_find(ctx->msrc->mfes_exts,
576  path_index);
577 
578  if (NULL != path_ext &&
579  !(path_ext->mfpe_flags & MFIB_ITF_FLAG_FORWARD))
580  {
582  }
583 
584  switch (ctx->fct)
585  {
588  /*
589  * EOS traffic with no label to stack, we need the IP Adj
590  */
591  vec_add2(ctx->next_hops, nh, 1);
592 
593  nh->path_index = path_index;
594  nh->path_weight = fib_path_get_weight(path_index);
595  fib_path_contribute_forwarding(path_index, ctx->fct, &nh->path_dpo);
596  break;
597 
605  ASSERT(0);
606  break;
607  }
608 
610 }
611 
612 static void
615 {
616  dpo_proto_t dp;
617 
618  dp = fib_proto_to_dpo(mfib_entry_get_proto(mfib_entry));
619 
620  /*
621  * unlink the enty from the previous path list.
622  */
623  if (FIB_NODE_INDEX_INVALID != mfib_entry->mfe_pl)
624  {
626  mfib_entry->mfe_sibling);
627  }
628 
629  if (NULL != msrc)
630  {
632  .next_hops = NULL,
633  .fct = mfib_entry_get_default_chain_type(mfib_entry),
634  .msrc = msrc,
635  };
636 
637  /*
638  * link the entry to the path-list.
639  * The entry needs to be a child so that we receive the back-walk
640  * updates to recalculate forwarding.
641  */
642  mfib_entry->mfe_pl = msrc->mfes_pl;
643  mfib_entry->mfe_flags = msrc->mfes_route_flags;
644  mfib_entry->mfe_itfs = msrc->mfes_itfs;
645  mfib_entry->mfe_rpf_id = msrc->mfes_rpf_id;
646 
647  if (FIB_NODE_INDEX_INVALID != mfib_entry->mfe_pl)
648  {
649  mfib_entry->mfe_sibling =
650  fib_path_list_child_add(mfib_entry->mfe_pl,
652  mfib_entry_get_index(mfib_entry));
653 
654  fib_path_list_walk(mfib_entry->mfe_pl,
656  &ctx);
657  }
658  if (!(MFIB_ENTRY_FLAG_EXCLUSIVE & mfib_entry->mfe_flags))
659  {
660  if (NULL == ctx.next_hops)
661  {
662  /*
663  * no next-hops, stack directly on the drop
664  */
666  &mfib_entry->mfe_rep,
667  drop_dpo_get(dp));
668  }
669  else
670  {
671  /*
672  * each path contirbutes a next-hop. form a replicate
673  * from those choices.
674  */
675  if (!dpo_id_is_valid(&mfib_entry->mfe_rep) ||
676  dpo_is_drop(&mfib_entry->mfe_rep))
677  {
678  dpo_id_t tmp_dpo = DPO_INVALID;
679 
680  dpo_set(&tmp_dpo,
681  DPO_REPLICATE, dp,
682  replicate_create(0, dp));
683 
685  &mfib_entry->mfe_rep,
686  &tmp_dpo);
687 
688  dpo_reset(&tmp_dpo);
689  }
690  replicate_multipath_update(&mfib_entry->mfe_rep,
691  ctx.next_hops);
692  }
693  }
694  else
695  {
696  /*
697  * for exclusive routes the source provided a replicate DPO
698  * which we stashed in the special path list with one path,
699  * so we can stack directly on that.
700  */
701  ASSERT(1 == vec_len(ctx.next_hops));
702 
703  if (NULL != ctx.next_hops)
704  {
706  &mfib_entry->mfe_rep,
707  &ctx.next_hops[0].path_dpo);
708  dpo_reset(&ctx.next_hops[0].path_dpo);
709  vec_free(ctx.next_hops);
710  }
711  else
712  {
714  &mfib_entry->mfe_rep,
715  drop_dpo_get(dp));
716  }
717  }
718  }
719  else
720  {
722  &mfib_entry->mfe_rep,
723  drop_dpo_get(dp));
724  }
725 
726  /*
727  * time for walkies fido.
728  */
729  fib_node_back_walk_ctx_t bw_ctx = {
731  };
732 
734  mfib_entry_get_index(mfib_entry),
735  &bw_ctx);
736 }
737 
738 static fib_node_index_t*
740  const fib_route_path_t *rpaths)
741 {
743 
745 
746  if (FIB_NODE_INDEX_INVALID == msrc->mfes_pl)
747  {
748  /* A non-shared path-list */
750  NULL);
752  }
753 
754  return (fib_path_list_paths_add(msrc->mfes_pl, rpaths));
755 }
756 
757 static fib_node_index_t*
759  const fib_route_path_t *rpaths)
760 {
762 
764 
765  return (fib_path_list_paths_remove(msrc->mfes_pl, rpaths));
766 }
767 
768 static void
770  mfib_source_t old_best)
771 {
772  mfib_entry_src_t *bsrc, *osrc;
773 
774  /*
775  * copy the forwarding data from the bast source
776  */
777  bsrc = mfib_entry_get_best_src(mfib_entry);
778  osrc = mfib_entry_src_find(mfib_entry, old_best, NULL);
779 
780  if (NULL != bsrc)
781  {
782  if (bsrc->mfes_src != old_best)
783  {
784  /*
785  * we are changing from one source to another
786  * deactivate the old, and activate the new
787  */
788  mfib_entry_src_deactivate(mfib_entry, osrc);
789  mfib_entry_src_activate(mfib_entry, bsrc);
790  }
791  }
792  else
793  {
794  mfib_entry_src_deactivate(mfib_entry, osrc);
795  }
796 
797  mfib_entry_stack(mfib_entry, bsrc);
798  mfib_entry_cover_update_notify(mfib_entry);
799 }
800 
801 
804  mfib_source_t source,
805  const mfib_prefix_t *prefix,
808  index_t repi)
809 {
810  fib_node_index_t mfib_entry_index;
811  mfib_entry_t *mfib_entry;
813 
814  mfib_entry = mfib_entry_alloc(fib_index, prefix,
815  &mfib_entry_index);
816  msrc = mfib_entry_src_update(mfib_entry, source,
817  rpf_id, entry_flags);
818 
819  if (INDEX_INVALID != repi)
820  {
821  /*
822  * The source is providing its own replicate DPO.
823  * Create a sepcial path-list to manage it, that way
824  * this entry and the source are equivalent to a normal
825  * entry
826  */
827  fib_node_index_t old_pl_index;
828  dpo_proto_t dp;
829  dpo_id_t dpo = DPO_INVALID;
830 
831  dp = fib_proto_to_dpo(mfib_entry_get_proto(mfib_entry));
832  old_pl_index = msrc->mfes_pl;
833 
834  dpo_set(&dpo, DPO_REPLICATE, dp, repi);
835 
836  msrc->mfes_pl =
839  &dpo);
840 
841  dpo_reset(&dpo);
843  fib_path_list_unlock(old_pl_index);
844  }
845 
847 
848  return (mfib_entry_index);
849 }
850 
851 static int
853 {
854  return (0 == vec_len(mfib_entry->mfe_srcs));
855 }
856 
857 static int
859 {
860  return ((INDEX_INVALID == msrc->mfes_cover &&
862  0 == fib_path_list_get_n_paths(msrc->mfes_pl)) &&
863  (0 == hash_elts(msrc->mfes_itfs)));
864 
865  /* return ((MFIB_ENTRY_FLAG_NONE == msrc->mfes_route_flags) && */
866  /* (0 == fib_path_list_get_n_paths(msrc->mfes_pl)) && */
867  /* (0 == hash_elts(msrc->mfes_itfs))); */
868 }
869 
870 
871 static void
874  mfib_source_t current_best,
875  index_t repi)
876 {
877  if (INDEX_INVALID != repi)
878  {
879  /*
880  * The source is providing its own replicate DPO.
881  * Create a sepcial path-list to manage it, that way
882  * this entry and the source are equivalent to a normal
883  * entry
884  */
885  fib_node_index_t old_pl_index;
886  dpo_proto_t dp;
887  dpo_id_t dpo = DPO_INVALID;
888 
889  dp = fib_proto_to_dpo(mfib_entry_get_proto(mfib_entry));
890  old_pl_index = msrc->mfes_pl;
891 
892  dpo_set(&dpo, DPO_REPLICATE, dp, repi);
893 
894  msrc->mfes_pl =
897  &dpo);
898 
899  dpo_reset(&dpo);
901  fib_path_list_unlock(old_pl_index);
902  }
903 
905  {
906  /*
907  * this source has no interfaces and no flags.
908  * it has nothing left to give - remove it
909  */
910  mfib_entry_src_remove(mfib_entry, msrc->mfes_src);
911  }
912 
913  mfib_entry_recalculate_forwarding(mfib_entry, current_best);
914 }
915 
916 int
918  mfib_source_t source,
921  index_t repi)
922 {
923  mfib_source_t current_best;
924  mfib_entry_t *mfib_entry;
926 
927  mfib_entry = mfib_entry_get(mfib_entry_index);
928  current_best = mfib_entry_get_best_source(mfib_entry);
929 
930  msrc = mfib_entry_src_update_and_lock(mfib_entry, source, rpf_id,
931  entry_flags);
932 
933  mfib_entry_update_i(mfib_entry, msrc, current_best, repi);
934 
935  return (mfib_entry_ok_for_delete(mfib_entry));
936 }
937 
938 int
940  mfib_source_t source,
943  index_t repi)
944 {
945  mfib_source_t current_best;
946  mfib_entry_t *mfib_entry;
948 
949  mfib_entry = mfib_entry_get(mfib_entry_index);
950  current_best = mfib_entry_get_best_source(mfib_entry);
951  msrc = mfib_entry_src_update(mfib_entry, source, rpf_id, entry_flags);
952 
953  mfib_entry_update_i(mfib_entry, msrc, current_best, repi);
954 
955  return (mfib_entry_ok_for_delete(mfib_entry));
956 }
957 
958 static void
961  index_t mi)
962 {
963  hash_set(msrc->mfes_itfs, sw_if_index, mi);
964 }
965 
966 static void
969 {
970  mfib_itf_t *mfi;
971 
972  mfi = mfib_entry_itf_find(msrc->mfes_itfs, sw_if_index);
973 
974  mfib_itf_delete(mfi);
975 
976  hash_unset(msrc->mfes_itfs, sw_if_index);
977 }
978 
979 static int
981 {
982  return (!(rpath->frp_flags & FIB_ROUTE_PATH_BIER_IMP) &&
983  ~0 != rpath->frp_sw_if_index);
984 }
985 
986 void
988  mfib_source_t source,
989  const fib_route_path_t *rpaths)
990 {
991  fib_node_index_t* path_indices, path_index;
992  const fib_route_path_t *rpath;
993  mfib_source_t current_best;
994  mfib_path_ext_t *path_ext;
995  mfib_entry_t *mfib_entry;
997  mfib_itf_flags_t old;
998  u32 ii;
999 
1000  mfib_entry = mfib_entry_get(mfib_entry_index);
1001  ASSERT(NULL != mfib_entry);
1002  current_best = mfib_entry_get_best_source(mfib_entry);
1003  msrc = mfib_entry_src_find_or_create(mfib_entry, source);
1004 
1005  /*
1006  * add the path to the path-list. If it's a duplicate we'll get
1007  * back the original path.
1008  */
1009  path_indices = mfib_entry_src_paths_add(msrc, rpaths);
1010 
1011  vec_foreach_index(ii, path_indices)
1012  {
1013  path_index = path_indices[ii];
1014  rpath = &rpaths[ii];
1015 
1016  if (FIB_NODE_INDEX_INVALID == path_index)
1017  continue;
1018 
1019  /*
1020  * find the path extension for that path
1021  */
1022  path_ext = mfib_entry_path_ext_find(msrc->mfes_exts, path_index);
1023 
1024  if (NULL == path_ext)
1025  {
1026  old = MFIB_ITF_FLAG_NONE;
1027  path_ext = mfib_path_ext_add(msrc, path_index,
1028  rpath->frp_mitf_flags);
1029  }
1030  else
1031  {
1032  old = path_ext->mfpe_flags;
1033  path_ext->mfpe_flags = rpath->frp_mitf_flags;
1034  }
1035 
1036  /*
1037  * Has the path changed its contribution to the input interface set.
1038  * Which only paths with interfaces can do...
1039  */
1040  if (mfib_entry_path_itf_based(rpath))
1041  {
1042  mfib_itf_t *mfib_itf;
1043 
1044  if (old != rpath->frp_mitf_flags)
1045  {
1046  /*
1047  * change of flag contributions
1048  */
1049  mfib_itf = mfib_entry_itf_find(msrc->mfes_itfs,
1050  rpath->frp_sw_if_index);
1051 
1052  if (NULL == mfib_itf)
1053  {
1054  mfib_entry_itf_add(msrc,
1055  rpath->frp_sw_if_index,
1056  mfib_itf_create(path_index,
1057  rpath->frp_mitf_flags));
1058  }
1059  else
1060  {
1061  if (mfib_itf_update(mfib_itf,
1062  path_index,
1063  rpath->frp_mitf_flags))
1064  {
1065  /*
1066  * no more interface flags on this path, remove
1067  * from the data-plane set
1068  */
1069  mfib_entry_itf_remove(msrc, rpath->frp_sw_if_index);
1070  }
1071  }
1072  }
1073  }
1074  }
1075  vec_free(path_indices);
1076 
1077  mfib_entry_recalculate_forwarding(mfib_entry, current_best);
1078 }
1079 
1080 /*
1081  * mfib_entry_path_remove
1082  *
1083  * remove a path from the entry.
1084  * return the mfib_entry's index if it is still present, INVALID otherwise.
1085  */
1086 int
1088  mfib_source_t source,
1089  const fib_route_path_t *rpaths)
1090 {
1091  fib_node_index_t path_index, *path_indices;
1092  const fib_route_path_t *rpath;
1093  mfib_source_t current_best;
1094  mfib_entry_t *mfib_entry;
1096  u32 ii;
1097 
1098  mfib_entry = mfib_entry_get(mfib_entry_index);
1099  ASSERT(NULL != mfib_entry);
1100  current_best = mfib_entry_get_best_source(mfib_entry);
1101  msrc = mfib_entry_src_find(mfib_entry, source, NULL);
1102 
1103  if (NULL == msrc)
1104  {
1105  /*
1106  * there are no paths left for this source
1107  */
1108  return (mfib_entry_ok_for_delete(mfib_entry));
1109  }
1110 
1111  /*
1112  * remove the paths from the path-list. If it's not there we'll get
1113  * back an empty vector
1114  */
1115  path_indices = mfib_entry_src_paths_remove(msrc, rpaths);
1116 
1117  vec_foreach_index(ii, path_indices)
1118  {
1119  path_index = path_indices[ii];
1120  rpath = &rpaths[ii];
1121 
1122  if (FIB_NODE_INDEX_INVALID == path_index)
1123  continue;
1124 
1125  /*
1126  * don't need the extension, nor the interface anymore
1127  */
1128  mfib_path_ext_remove(msrc, path_index);
1129  if (mfib_entry_path_itf_based(rpath))
1130  {
1131  mfib_itf_t *mfib_itf;
1132 
1133  mfib_itf = mfib_entry_itf_find(msrc->mfes_itfs,
1134  rpath->frp_sw_if_index);
1135 
1136  if (mfib_itf_update(mfib_itf,
1137  path_index,
1139  {
1140  /*
1141  * no more interface flags on this path, remove
1142  * from the data-plane set
1143  */
1144  mfib_entry_itf_remove(msrc, rpath->frp_sw_if_index);
1145  }
1146  }
1147  }
1148  vec_free(path_indices);
1149 
1150  if (mfib_entry_src_ok_for_delete(msrc))
1151  {
1152  /*
1153  * this source has no interfaces and no flags.
1154  * it has nothing left to give - remove it
1155  */
1156  mfib_entry_src_remove(mfib_entry, source);
1157  }
1158 
1159  mfib_entry_recalculate_forwarding(mfib_entry, current_best);
1160 
1161  return (mfib_entry_ok_for_delete(mfib_entry));
1162 }
1163 
1164 /**
1165  * mfib_entry_delete
1166  *
1167  * The source is withdrawing all the paths it provided
1168  */
1169 int
1171  mfib_source_t source)
1172 {
1173  mfib_source_t current_best;
1174  mfib_entry_t *mfib_entry;
1175 
1176  mfib_entry = mfib_entry_get(mfib_entry_index);
1177  current_best = mfib_entry_get_best_source(mfib_entry);
1178  mfib_entry_src_remove(mfib_entry, source);
1179 
1180  mfib_entry_recalculate_forwarding(mfib_entry, current_best);
1181 
1182  return (mfib_entry_ok_for_delete(mfib_entry));
1183 }
1184 
1185 static int
1187  ip4_address_t * a2)
1188 {
1189  /*
1190  * IP addresses are unsiged ints. the return value here needs to be signed
1191  * a simple subtraction won't cut it.
1192  * If the addresses are the same, the sort order is undefiend, so phoey.
1193  */
1194  return ((clib_net_to_host_u32(a1->data_u32) >
1195  clib_net_to_host_u32(a2->data_u32) ) ?
1196  1 : -1);
1197 }
1198 
1199 static int
1200 fib_ip6_address_compare (ip6_address_t * a1,
1201  ip6_address_t * a2)
1202 {
1203  int i;
1204  for (i = 0; i < ARRAY_LEN (a1->as_u16); i++)
1205  {
1206  int cmp = (clib_net_to_host_u16 (a1->as_u16[i]) -
1207  clib_net_to_host_u16 (a2->as_u16[i]));
1208  if (cmp != 0)
1209  return cmp;
1210  }
1211  return 0;
1212 }
1213 
1214 static int
1216  fib_node_index_t mfib_entry_index2)
1217 {
1218  mfib_entry_t *mfib_entry1, *mfib_entry2;
1219  int cmp = 0;
1220 
1221  mfib_entry1 = mfib_entry_get(mfib_entry_index1);
1222  mfib_entry2 = mfib_entry_get(mfib_entry_index2);
1223 
1224  switch (mfib_entry1->mfe_prefix.fp_proto)
1225  {
1226  case FIB_PROTOCOL_IP4:
1227  cmp = fib_ip4_address_compare(&mfib_entry1->mfe_prefix.fp_grp_addr.ip4,
1228  &mfib_entry2->mfe_prefix.fp_grp_addr.ip4);
1229 
1230  if (0 == cmp)
1231  {
1232  cmp = fib_ip4_address_compare(&mfib_entry1->mfe_prefix.fp_src_addr.ip4,
1233  &mfib_entry2->mfe_prefix.fp_src_addr.ip4);
1234  }
1235  break;
1236  case FIB_PROTOCOL_IP6:
1237  cmp = fib_ip6_address_compare(&mfib_entry1->mfe_prefix.fp_grp_addr.ip6,
1238  &mfib_entry2->mfe_prefix.fp_grp_addr.ip6);
1239 
1240  if (0 == cmp)
1241  {
1242  cmp = fib_ip6_address_compare(&mfib_entry1->mfe_prefix.fp_src_addr.ip6,
1243  &mfib_entry2->mfe_prefix.fp_src_addr.ip6);
1244  }
1245  break;
1246  case FIB_PROTOCOL_MPLS:
1247  ASSERT(0);
1248  cmp = 0;
1249  break;
1250  }
1251 
1252  if (0 == cmp) {
1253  cmp = (mfib_entry1->mfe_prefix.fp_len - mfib_entry2->mfe_prefix.fp_len);
1254  }
1255  return (cmp);
1256 }
1257 
1258 int
1259 mfib_entry_cmp_for_sort (void *i1, void *i2)
1260 {
1261  fib_node_index_t *mfib_entry_index1 = i1, *mfib_entry_index2 = i2;
1262 
1263  return (mfib_entry_cmp(*mfib_entry_index1,
1264  *mfib_entry_index2));
1265 }
1266 
1267 static void
1269 {
1270  mfib_entry_t *mfib_entry;
1272 
1273  mfib_entry = mfib_entry_from_fib_node(node);
1274 
1275  dpo_reset(&mfib_entry->mfe_rep);
1276 
1277  MFIB_ENTRY_DBG(mfib_entry, "last-lock");
1278 
1279  vec_foreach(msrc, mfib_entry->mfe_srcs)
1280  {
1281  mfib_entry_src_flush(msrc);
1282  }
1283 
1284  vec_free(mfib_entry->mfe_srcs);
1285 
1286  fib_node_deinit(&mfib_entry->mfe_node);
1287  pool_put(mfib_entry_pool, mfib_entry);
1288 }
1289 
1290 u32
1292 {
1293  mfib_entry_t *mfib_entry;
1294 
1295  mfib_entry = mfib_entry_get(fib_entry_index);
1296 
1297  return (mfib_entry->mfe_rep.dpoi_index);
1298 }
1299 
1300 /*
1301  * mfib_entry_back_walk_notify
1302  *
1303  * A back walk has reach this entry.
1304  */
1308 {
1309  mfib_entry_t *mfib_entry;
1310 
1311  mfib_entry = mfib_entry_from_fib_node(node);
1313  mfib_entry_get_best_source(mfib_entry));
1314 
1315  return (FIB_NODE_BACK_WALK_CONTINUE);
1316 }
1317 
1318 static void
1320 {
1321  fib_show_memory_usage("multicast-Entry",
1322  pool_elts(mfib_entry_pool),
1323  pool_len(mfib_entry_pool),
1324  sizeof(mfib_entry_t));
1325 }
1326 
1327 /*
1328  * The MFIB entry's graph node virtual function table
1329  */
1330 static const fib_node_vft_t mfib_entry_vft = {
1332  .fnv_last_lock = mfib_entry_last_lock_gone,
1333  .fnv_back_walk = mfib_entry_back_walk_notify,
1334  .fnv_mem_show = mfib_entry_show_memory,
1335 };
1336 
1337 void
1339 {
1340  mfib_entry_t *mfib_entry;
1341 
1342  mfib_entry = mfib_entry_get(mfib_entry_index);
1343 
1344  fib_node_lock(&mfib_entry->mfe_node);
1345 }
1346 
1347 void
1349 {
1350  mfib_entry_t *mfib_entry;
1351 
1352  mfib_entry = mfib_entry_get(mfib_entry_index);
1353 
1354  fib_node_unlock(&mfib_entry->mfe_node);
1355 }
1356 
1357 static void
1359 {
1360 }
1361 static void
1363 {
1364 }
1365 
1366 const static dpo_vft_t mfib_entry_dpo_vft = {
1368  .dv_unlock = mfib_entry_dpo_unlock,
1369  .dv_format = format_mfib_entry_dpo,
1370  .dv_mem_show = mfib_entry_show_memory,
1371 };
1372 
1373 const static char* const mfib_entry_ip4_nodes[] =
1374 {
1375  "ip4-mfib-forward-rpf",
1376  NULL,
1377 };
1378 const static char* const mfib_entry_ip6_nodes[] =
1379 {
1380  "ip6-mfib-forward-rpf",
1381  NULL,
1382 };
1383 
1384 const static char* const * const mfib_entry_nodes[DPO_PROTO_NUM] =
1385 {
1388 };
1389 
1390 void
1392 {
1394  dpo_register(DPO_MFIB_ENTRY, &mfib_entry_dpo_vft, mfib_entry_nodes);
1395  mfib_entry_logger = vlib_log_register_class("mfib", "entry");
1396 }
1397 
1400 {
1402  .rpaths = NULL,
1403  };
1404  mfib_entry_t *mfib_entry;
1405  fib_route_path_t *rpath;
1406  mfib_entry_src_t *bsrc;
1407 
1408  mfib_entry = mfib_entry_get(mfib_entry_index);
1409  bsrc = mfib_entry_get_best_src(mfib_entry);
1410 
1411  if (FIB_NODE_INDEX_INVALID != bsrc->mfes_pl)
1412  {
1414  NULL,
1416  &ctx);
1417  }
1418 
1419  vec_foreach(rpath, ctx.rpaths)
1420  {
1421  mfib_itf_t *mfib_itf;
1422 
1423  mfib_itf = mfib_entry_itf_find(bsrc->mfes_itfs,
1424  rpath->frp_sw_if_index);
1425  if (mfib_itf)
1426  {
1427  rpath->frp_mitf_flags = mfib_itf->mfi_flags;
1428  }
1429  }
1430 
1431  return (ctx.rpaths);
1432 }
1433 
1434 const mfib_prefix_t *
1436 {
1437  mfib_entry_t *mfib_entry;
1438 
1439  mfib_entry = mfib_entry_get(mfib_entry_index);
1440 
1441  return (&mfib_entry->mfe_prefix);
1442 }
1443 
1444 u32
1446 {
1447  mfib_entry_t *mfib_entry;
1448 
1449  mfib_entry = mfib_entry_get(mfib_entry_index);
1450 
1451  return (mfib_entry->mfe_fib_index);
1452 }
1453 
1454 const dpo_id_t*
1456 {
1457  mfib_entry_t *mfib_entry;
1458 
1459  mfib_entry = mfib_entry_get(mfib_entry_index);
1460 
1461  return (&mfib_entry->mfe_rep);
1462 }
1463 
1464 void
1468  dpo_id_t *dpo)
1469 {
1470  /*
1471  * An IP mFIB entry can only provide a forwarding chain that
1472  * is the same IP proto as the prefix.
1473  * No use-cases (i know of) for other combinations.
1474  */
1475  mfib_entry_t *mfib_entry;
1476  dpo_proto_t dp;
1477 
1478  mfib_entry = mfib_entry_get(mfib_entry_index);
1479 
1480  dp = fib_proto_to_dpo(mfib_entry->mfe_prefix.fp_proto);
1481 
1482  if (type == mfib_forw_chain_type_from_dpo_proto(dp))
1483  {
1484  replicate_t * rep;
1485 
1486  rep = replicate_get(mfib_entry->mfe_rep.dpoi_index);
1487 
1488  if ((rep->rep_flags & REPLICATE_FLAGS_HAS_LOCAL) &&
1489  (flags & MFIB_ENTRY_FWD_FLAG_NO_LOCAL))
1490  {
1491  /*
1492  * caller does not want the local paths that the entry has
1493  */
1494  dpo_proto_t rep_proto = rep->rep_proto;
1495  dpo_set(dpo, DPO_REPLICATE, rep_proto,
1497  mfib_entry->mfe_rep.dpoi_index));
1498  }
1499  else
1500  {
1501  dpo_copy(dpo, &mfib_entry->mfe_rep);
1502  }
1503  }
1504  else
1505  {
1506  dpo_copy(dpo, drop_dpo_get(dp));
1507  }
1508 }
1509 
1510 /*
1511  * fib_entry_cover_changed
1512  *
1513  * this entry is tracking its cover and that cover has changed.
1514  */
1515 void
1517 {
1518  mfib_entry_t *mfib_entry;
1520  mfib_src_res_t res;
1521 
1522  mfib_entry = mfib_entry_get(mfib_entry_index);
1523  msrc = mfib_entry_get_best_src(mfib_entry);
1524 
1525  res = mfib_entry_src_cover_change(mfib_entry, msrc);
1526 
1527  if (MFIB_SRC_REEVALUATE == res)
1528  {
1529  mfib_entry_recalculate_forwarding(mfib_entry, msrc->mfes_src);
1530  }
1531  MFIB_ENTRY_DBG(mfib_entry, "cover-changed");
1532 }
1533 
1534 /*
1535  * mfib_entry_cover_updated
1536  *
1537  * this entry is tracking its cover and that cover has been updated
1538  * (i.e. its forwarding information has changed).
1539  */
1540 void
1542 {
1543  mfib_entry_t *mfib_entry;
1545  mfib_src_res_t res;
1546 
1547  mfib_entry = mfib_entry_get(mfib_entry_index);
1548  msrc = mfib_entry_get_best_src(mfib_entry);
1549 
1550  res = mfib_entry_src_cover_update(mfib_entry, msrc);
1551 
1552  if (MFIB_SRC_REEVALUATE == res)
1553  {
1554  mfib_entry_recalculate_forwarding(mfib_entry, msrc->mfes_src);
1555  }
1556  MFIB_ENTRY_DBG(mfib_entry, "cover-updated");
1557 }
1558 
1559 u32
1561 {
1562  return (pool_elts(mfib_entry_pool));
1563 }
1564 
1565 static clib_error_t *
1567  unformat_input_t * input,
1568  vlib_cli_command_t * cmd)
1569 {
1570  fib_node_index_t fei;
1571 
1572  if (unformat (input, "%d", &fei))
1573  {
1574  /*
1575  * show one in detail
1576  */
1577  if (!pool_is_free_index(mfib_entry_pool, fei))
1578  {
1579  vlib_cli_output (vm, "%d@%U",
1580  fei,
1581  format_mfib_entry, fei,
1583  }
1584  else
1585  {
1586  vlib_cli_output (vm, "entry %d invalid", fei);
1587  }
1588  }
1589  else
1590  {
1591  /*
1592  * show all
1593  */
1594  vlib_cli_output (vm, "FIB Entries:");
1595  pool_foreach_index(fei, mfib_entry_pool,
1596  ({
1597  vlib_cli_output (vm, "%d@%U",
1598  fei,
1599  format_mfib_entry, fei,
1601  }));
1602  }
1603 
1604  return (NULL);
1605 }
1606 
1607 /*?
1608  * This commnad displays an entry, or all entries, in the mfib tables indexed by their unique
1609  * numerical indentifier.
1610  ?*/
1611 VLIB_CLI_COMMAND (show_mfib_entry, static) = {
1612  .path = "show mfib entry",
1613  .function = show_mfib_entry_command,
1614  .short_help = "show mfib entry",
1615 };
int mfib_itf_update(mfib_itf_t *mfib_itf, fib_node_index_t path_index, mfib_itf_flags_t mfi_flags)
update an interface from a path.
Definition: mfib_itf.c:66
vlib_log_class_t vlib_log_register_class(char *class, char *subclass)
Definition: log.c:209
int fib_path_is_resolved(fib_node_index_t path_index)
Definition: fib_path.c:2683
dpo_lock_fn_t dv_lock
A reference counting lock function.
Definition: dpo.h:406
Contribute an object that is to be used to forward BIER packets.
Definition: fib_types.h:122
#define MFIB_ENTRY_FORMAT_DETAIL
Definition: mfib_entry.h:111
static const char *const mfib_entry_ip4_nodes[]
Definition: mfib_entry.c:1373
Contribute an object that is to be used to forward IP6 packets.
Definition: fib_types.h:137
#define vec_foreach_index(var, v)
Iterate over vector indices.
ip46_address_t fp_src_addr
Definition: mfib_types.h:47
Contribute an object that is to be used to forward IP6 packets.
Definition: fib_types.h:113
#define hash_set(h, key, value)
Definition: hash.h:255
static mfib_entry_src_t * mfib_entry_src_find_or_create(mfib_entry_t *mfib_entry, mfib_source_t source)
Definition: mfib_entry.c:268
fib_node_index_t path_index
The index of the FIB path.
Definition: load_balance.h:71
#define CLIB_UNUSED(x)
Definition: clib.h:87
A virtual function table regisitered for a DPO type.
Definition: dpo.h:401
fib_forward_chain_type_t fct
Definition: mfib_entry.c:548
void fib_path_contribute_forwarding(fib_node_index_t path_index, fib_forward_chain_type_t fct, dpo_id_t *dpo)
Definition: fib_path.c:2419
static const char *const *const mfib_entry_nodes[DPO_PROTO_NUM]
Definition: mfib_entry.c:1384
u32 mfib_entry_pool_size(void)
Definition: mfib_entry.c:1560
void fib_path_list_child_remove(fib_node_index_t path_list_index, u32 si)
int mfib_entry_delete(fib_node_index_t mfib_entry_index, mfib_source_t source)
mfib_entry_delete
Definition: mfib_entry.c:1170
enum mfib_entry_flags_t_ mfib_entry_flags_t
#define hash_unset(h, key)
Definition: hash.h:261
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:103
fib_node_index_t mfes_cover
A representation of a path as described by a route producer.
Definition: fib_types.h:490
dpo_id_t path_dpo
ID of the Data-path object.
Definition: load_balance.h:66
The FIB DPO provieds;.
Definition: replicate_dpo.h:63
enum mfib_entry_fwd_flags_t_ mfib_entry_fwd_flags_t
Flags to control what is present in the replicate DPO returned when the entry contributes forwarding...
static const char * mfib_src_attribute_names[]
Definition: mfib_entry.c:41
vl_api_fib_path_nh_t nh
Definition: fib_types.api:126
void fib_node_init(fib_node_t *node, fib_node_type_t type)
Definition: fib_node.c:185
u32 frp_mitf_flags
MFIB interface flags.
Definition: fib_types.h:559
static int dpo_id_is_valid(const dpo_id_t *dpoi)
Return true if the DPO object is valid, i.e.
Definition: dpo.h:209
void mfib_entry_unlock(fib_node_index_t mfib_entry_index)
Definition: mfib_entry.c:1348
struct mfib_entry_src_t_ * mfe_srcs
A vector of sources contributing forwarding.
Definition: mfib_entry.h:52
An entry in a FIB table.
Definition: mfib_entry.h:32
A path that resolves via a BIER impostion object.
Definition: fib_types.h:379
u32 mfe_sibling
The sibling index on the path-list.
Definition: mfib_entry.h:62
#define MFIB_SOURCE_NONE
Definition: mfib_types.h:204
enum fib_node_back_walk_rc_t_ fib_node_back_walk_rc_t
Return code from a back walk function.
fib_node_index_t fib_path_list_create_special(dpo_proto_t nh_proto, fib_path_list_flags_t flags, const dpo_id_t *dpo)
#define MFIB_ENTRY_SRC_ATTRIBUTES
vlib_log_class_t mfib_entry_logger
the logger
Definition: mfib_entry.c:30
#define MFIB_SOURCE_NAMES
Definition: mfib_types.h:180
enum mfib_entry_src_flag_t_ mfib_entry_src_flags_t
void dpo_copy(dpo_id_t *dst, const dpo_id_t *src)
atomic copy a data-plane object.
Definition: dpo.c:262
u32 index_t
A Data-Path Object is an object that represents actions that are applied to packets are they are swit...
Definition: dpo.h:41
static void mfib_entry_dpo_unlock(dpo_id_t *dpo)
Definition: mfib_entry.c:1362
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:592
static fib_node_t * mfib_entry_get_node(fib_node_index_t index)
Definition: mfib_entry.c:49
dpo_proto_t rep_proto
The protocol of packets that traverse this REP.
Definition: replicate_dpo.h:80
static fib_node_index_t * mfib_entry_src_paths_remove(mfib_entry_src_t *msrc, const fib_route_path_t *rpaths)
Definition: mfib_entry.c:758
static void mfib_entry_itf_remove(mfib_entry_src_t *msrc, u32 sw_if_index)
Definition: mfib_entry.c:967
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:630
static fib_node_index_t mfib_entry_get_index(const mfib_entry_t *mfe)
Definition: mfib_entry.h:205
void fib_path_list_walk(fib_node_index_t path_list_index, fib_path_list_walk_fn_t func, void *ctx)
Contribute an object that is to be used to forward IP4 packets.
Definition: fib_types.h:109
void fib_node_deinit(fib_node_t *node)
Definition: fib_node.c:197
vlib_main_t * vm
Definition: in2out_ed.c:1582
u32 mfib_entry_child_add(fib_node_index_t mfib_entry_index, fib_node_type_t child_type, fib_node_index_t child_index)
Definition: mfib_entry.c:447
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
static mfib_path_ext_t * mfib_entry_path_ext_find(mfib_path_ext_t *exts, fib_node_index_t path_index)
Definition: mfib_entry.c:500
vl_api_prefix_t prefix
Definition: ip.api:144
static replicate_t * replicate_get(index_t repi)
static const char *const mfib_entry_ip6_nodes[]
Definition: mfib_entry.c:1378
#define MFIB_ENTRY_FORMAT_BRIEF
Definition: mfib_entry.h:110
fib_node_index_t * fib_path_list_paths_add(fib_node_index_t path_list_index, const fib_route_path_t *rpaths)
mfib_itf_t * mfes_itfs
The hash table of all interfaces.
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:252
fib_forward_chain_type_t mfib_forw_chain_type_from_dpo_proto(dpo_proto_t proto)
Definition: mfib_types.c:71
void mfib_entry_cover_changed(fib_node_index_t mfib_entry_index)
Definition: mfib_entry.c:1516
u32 fib_path_list_child_add(fib_node_index_t path_list_index, fib_node_type_t child_type, fib_node_index_t child_index)
unsigned char u8
Definition: types.h:56
#define pool_len(p)
Number of elements in pool vector.
Definition: pool.h:140
fib_forward_chain_type_t mfib_entry_get_default_chain_type(const mfib_entry_t *mfib_entry)
Definition: mfib_entry.c:61
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
static mfib_entry_t * mfib_entry_from_fib_node(fib_node_t *node)
Definition: mfib_entry.c:204
u32 fib_node_child_add(fib_node_type_t parent_type, fib_node_index_t parent_index, fib_node_type_t type, fib_node_index_t index)
Definition: fib_node.c:98
void fib_node_register_type(fib_node_type_t type, const fib_node_vft_t *vft)
fib_node_register_type
Definition: fib_node.c:60
const dpo_id_t * drop_dpo_get(dpo_proto_t proto)
Definition: drop_dpo.c:25
u8 * format_mfib_entry_flags(u8 *s, va_list *args)
Definition: mfib_types.c:161
enum mfib_source_t_ mfib_source_t
Possible [control plane] sources of MFIB entries.
static mfib_entry_t * mfib_entry_alloc(u32 fib_index, const mfib_prefix_t *prefix, fib_node_index_t *mfib_entry_index)
Definition: mfib_entry.c:467
u32 vlib_log_class_t
Definition: vlib.h:51
static void mfib_entry_recalculate_forwarding(mfib_entry_t *mfib_entry, mfib_source_t old_best)
Definition: mfib_entry.c:769
void dpo_register(dpo_type_t type, const dpo_vft_t *vft, const char *const *const *nodes)
For a given DPO type Register:
Definition: dpo.c:322
u32 frp_sw_if_index
The interface.
Definition: fib_types.h:530
mfib_entry_src_flags_t mfes_flags
Source flags.
#define MFIB_RPF_ID_NONE
Definition: fib_types.h:413
The source of an MFIB entry.
void fib_walk_sync(fib_node_type_t parent_type, fib_node_index_t parent_index, fib_node_back_walk_ctx_t *ctx)
Back walk all the children of a FIB node.
Definition: fib_walk.c:745
mfib_source_t mfes_src
Which source this is.
#define hash_foreach(key_var, value_var, h, body)
Definition: hash.h:442
load_balance_path_t * next_hops
Definition: mfib_entry.c:547
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
index_t replicate_dup(replicate_flags_t flags, index_t repi)
static fib_protocol_t mfib_entry_get_proto(const mfib_entry_t *mfib_entry)
Definition: mfib_entry.c:55
static int mfib_entry_path_itf_based(const fib_route_path_t *rpath)
Definition: mfib_entry.c:980
mfib_prefix_t mfe_prefix
The prefix of the route.
Definition: mfib_entry.h:42
void fib_show_memory_usage(const char *name, u32 in_use_elts, u32 allocd_elts, size_t size_elt)
Show the memory usage for a type.
Definition: fib_node.c:220
void mfib_entry_module_init(void)
Definition: mfib_entry.c:1391
u32 mfib_entry_get_stats_index(fib_node_index_t fib_entry_index)
Definition: mfib_entry.c:1291
void mfib_entry_contribute_forwarding(fib_node_index_t mfib_entry_index, fib_forward_chain_type_t type, mfib_entry_fwd_flags_t flags, dpo_id_t *dpo)
Definition: mfib_entry.c:1465
struct mfib_entry_collect_forwarding_ctx_t_ mfib_entry_collect_forwarding_ctx_t
unsigned int u32
Definition: types.h:88
Contribute an object that is to be used to forward Ethernet packets.
Definition: fib_types.h:141
enum dpo_proto_t_ dpo_proto_t
Data path protocol.
u16 fib_path_get_weight(fib_node_index_t path_index)
Definition: fib_path.c:2244
static mfib_entry_src_t * mfib_entry_src_update(mfib_entry_t *mfib_entry, mfib_source_t source, fib_rpf_id_t rpf_id, mfib_entry_flags_t entry_flags)
Definition: mfib_entry.c:285
u32 mfib_entry_get_fib_index(fib_node_index_t mfib_entry_index)
Definition: mfib_entry.c:1445
void mfib_entry_src_deactivate(mfib_entry_t *mfib_entry, mfib_entry_src_t *msrc)
static mfib_source_t mfib_entry_get_best_source(const mfib_entry_t *mfib_entry)
Definition: mfib_entry.c:338
vl_api_fib_path_type_t type
Definition: fib_types.api:123
u32 rpf_id
Definition: fib_types.api:119
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:170
Contribute an object that is to be used to forward end-of-stack MPLS packets.
Definition: fib_types.h:129
fib_node_bw_reason_flag_t fnbw_reason
The reason/trigger for the backwalk.
Definition: fib_node.h:212
int mfib_entry_update(fib_node_index_t mfib_entry_index, mfib_source_t source, mfib_entry_flags_t entry_flags, fib_rpf_id_t rpf_id, index_t repi)
Definition: mfib_entry.c:939
#define hash_get(h, key)
Definition: hash.h:249
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:534
fib_node_index_t fib_path_list_create(fib_path_list_flags_t flags, const fib_route_path_t *rpaths)
dpo_id_t mfe_rep
The DPO used for forwarding; replicate, drop, etc.
Definition: mfib_entry.h:72
static fib_path_list_walk_rc_t mfib_entry_src_collect_forwarding(fib_node_index_t pl_index, fib_node_index_t path_index, void *arg)
Definition: mfib_entry.c:553
int mfib_entry_path_remove(fib_node_index_t mfib_entry_index, mfib_source_t source, const fib_route_path_t *rpaths)
Definition: mfib_entry.c:1087
u32 mfes_ref_count
The reference count on the entry.
int mfib_entry_is_host(fib_node_index_t mfib_entry_index)
Definition: mfib_entry.c:397
static void mfib_entry_src_flush(mfib_entry_src_t *msrc)
Definition: mfib_entry.c:404
void fib_node_lock(fib_node_t *node)
Definition: fib_node.c:203
long ctx[MAX_CONNS]
Definition: main.c:144
static int fib_ip6_address_compare(ip6_address_t *a1, ip6_address_t *a2)
Definition: mfib_entry.c:1200
struct _unformat_input_t unformat_input_t
int mfib_entry_is_sourced(fib_node_index_t mfib_entry_index, mfib_source_t source)
Definition: mfib_entry.c:348
#define hash_free(h)
Definition: hash.h:310
int mfib_entry_special_add(fib_node_index_t mfib_entry_index, mfib_source_t source, mfib_entry_flags_t entry_flags, fib_rpf_id_t rpf_id, index_t repi)
Definition: mfib_entry.c:917
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:302
fib_node_t mfe_node
Base class.
Definition: mfib_entry.h:37
int mfib_entry_cmp_for_sort(void *i1, void *i2)
Definition: mfib_entry.c:1259
mfib_entry_t * mfib_entry_pool
Definition: mfib_entry.c:46
#define vec_del1(v, i)
Delete the element at index I.
Definition: vec.h:875
void fib_path_list_lock(fib_node_index_t path_list_index)
static mfib_path_ext_t * mfib_entry_path_ext_get(index_t mi)
Definition: mfib_entry.c:88
fib_rpf_id_t mfes_rpf_id
RPF-ID.
u8 * format_mfib_entry_src_flags(u8 *s, va_list *args)
Definition: mfib_entry.c:106
fib_node_type_t fn_type
The node&#39;s type.
Definition: fib_node.h:299
static void mfib_entry_dpo_lock(dpo_id_t *dpo)
Definition: mfib_entry.c:1358
An node in the FIB graph.
Definition: fib_node.h:295
void fib_node_unlock(fib_node_t *node)
Definition: fib_node.c:209
void mfib_entry_lock(fib_node_index_t mfib_entry_index)
Definition: mfib_entry.c:1338
u32 mfe_fib_index
The index of the FIB table this entry is in.
Definition: mfib_entry.h:47
static mfib_entry_t * mfib_entry_get(fib_node_index_t index)
Definition: mfib_entry.h:200
#define pool_get_aligned(P, E, A)
Allocate an object E from a pool P with alignment A.
Definition: pool.h:246
static mfib_path_ext_t * mfib_path_ext_add(mfib_entry_src_t *msrc, fib_node_index_t path_index, mfib_itf_flags_t mfi_flags)
Definition: mfib_entry.c:516
#define MFIB_ENTRY_DBG(_e, _fmt, _args...)
Definition: mfib_entry.h:100
void replicate_multipath_update(const dpo_id_t *dpo, load_balance_path_t *next_hops)
void mfib_entry_path_update(fib_node_index_t mfib_entry_index, mfib_source_t source, const fib_route_path_t *rpaths)
Definition: mfib_entry.c:987
fib_node_list_t fn_children
Vector of nodes that depend upon/use/share this node.
Definition: fib_node.h:309
static u8 * format_mfib_entry_dpo(u8 *s, va_list *args)
Definition: mfib_entry.c:77
Do not reutrn any local replications in the set.
Definition: mfib_entry.h:183
static mfib_entry_src_t * mfib_entry_src_find(const mfib_entry_t *mfib_entry, mfib_source_t source, u32 *index)
Definition: mfib_entry.c:239
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:317
Contribute an object that is to be used to forward NSH packets.
Definition: fib_types.h:147
#define FOR_EACH_MFIB_SRC_ATTRIBUTE(_item)
u8 * format_mfib_entry(u8 *s, va_list *args)
Definition: mfib_entry.c:126
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:380
static mfib_itf_t * mfib_entry_itf_find(mfib_itf_t *itfs, u32 sw_if_index)
Definition: mfib_entry.h:212
mfib_itf_flags_t mfi_flags
Forwarding Flags on the entry - checked in the data-path.
Definition: mfib_itf.h:35
static mfib_entry_src_t * mfib_entry_src_update_and_lock(mfib_entry_t *mfib_entry, mfib_source_t source, fib_rpf_id_t rpf_id, mfib_entry_flags_t entry_flags)
Definition: mfib_entry.c:302
fib_node_get_t fnv_get
Definition: fib_node.h:283
u32 fib_path_list_get_n_paths(fib_node_index_t path_list_index)
fib_node_index_t mfes_pl
The path-list of forwarding interfaces.
mfib_itf_t * mfe_itfs
A hash table of interfaces.
Definition: mfib_entry.h:87
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:30
mfib_entry_flags_t mfe_flags
Route flags.
Definition: mfib_entry.h:77
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:299
#define ARRAY_LEN(x)
Definition: clib.h:67
mfib_path_ext_t * mfes_exts
Hash table of path extensions.
void dpo_set(dpo_id_t *dpo, dpo_type_t type, dpo_proto_t proto, index_t index)
Set/create a DPO ID The DPO will be locked.
Definition: dpo.c:186
void fib_path_list_unlock(fib_node_index_t path_list_index)
void mfib_entry_mark(fib_node_index_t fib_entry_index, mfib_source_t source)
Definition: mfib_entry.c:380
index_t replicate_create(u32 n_buckets, dpo_proto_t rep_proto)
static void mfib_entry_itf_add(mfib_entry_src_t *msrc, u32 sw_if_index, index_t mi)
Definition: mfib_entry.c:959
Aggregate type for a prefix.
Definition: mfib_types.h:24
enum mfib_src_res_t_ mfib_src_res_t
signals from the sources to the caller
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1582
Context passed between object during a back walk.
Definition: fib_node.h:208
u32 fib_rpf_id_t
An RPF-ID is numerical value that is used RPF validate.
Definition: fib_types.h:411
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:158
fib_node_index_t mfe_pl
The path-list of which this entry is a child.
Definition: mfib_entry.h:57
int mfib_entry_is_marked(fib_node_index_t mfib_entry_index, mfib_source_t source)
Definition: mfib_entry.c:359
static void mfib_path_ext_remove(mfib_entry_src_t *msrc, fib_node_index_t path_index)
Definition: mfib_entry.c:534
MFIB extensions to each path.
static void mfib_entry_last_lock_gone(fib_node_t *node)
Definition: mfib_entry.c:1268
static uword hash_elts(void *v)
Definition: hash.h:118
#define ASSERT(truth)
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:696
static void mfib_entry_update_i(mfib_entry_t *mfib_entry, mfib_entry_src_t *msrc, mfib_source_t current_best, index_t repi)
Definition: mfib_entry.c:872
mfib_src_res_t mfib_entry_src_cover_update(mfib_entry_t *mfib_entry, mfib_entry_src_t *msrc)
void mfib_entry_cover_updated(fib_node_index_t mfib_entry_index)
Definition: mfib_entry.c:1541
static void mfib_entry_stack(mfib_entry_t *mfib_entry, mfib_entry_src_t *msrc)
Definition: mfib_entry.c:613
mfib_itf_flags_t mfpe_flags
const dpo_id_t * mfib_entry_contribute_ip_forwarding(fib_node_index_t mfib_entry_index)
Definition: mfib_entry.c:1455
An interface associated with a particular MFIB entry.
Definition: mfib_itf.h:25
static fib_node_index_t * mfib_entry_src_paths_add(mfib_entry_src_t *msrc, const fib_route_path_t *rpaths)
Definition: mfib_entry.c:739
static int mfib_entry_ok_for_delete(mfib_entry_t *mfib_entry)
Definition: mfib_entry.c:852
Path encode context to use when walking a path-list to encode paths.
Definition: fib_path.h:213
static u8 * format_mfib_entry_path_ext(u8 *s, va_list *args)
Definition: mfib_entry.c:94
enum fib_forward_chain_type_t_ fib_forward_chain_type_t
FIB output chain type.
fib_route_path_flags_t frp_flags
flags on the path
Definition: fib_types.h:600
u8 * format_fib_forw_chain_type(u8 *s, va_list *args)
Definition: fib_types.c:49
static int mfib_entry_cmp(fib_node_index_t mfib_entry_index1, fib_node_index_t mfib_entry_index2)
Definition: mfib_entry.c:1215
void fib_node_child_remove(fib_node_type_t parent_type, fib_node_index_t parent_index, fib_node_index_t sibling_index)
Definition: fib_node.c:123
dpo_proto_t fib_proto_to_dpo(fib_protocol_t fib_proto)
Definition: fib_types.c:324
fib_rpf_id_t mfe_rpf_id
RPF-ID used when the packets ingress not from an interface.
Definition: mfib_entry.h:82
u8 * format_dpo_id(u8 *s, va_list *args)
Format a DPO_id_t oject.
Definition: dpo.c:148
static clib_error_t * show_mfib_entry_command(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: mfib_entry.c:1566
fib_route_path_t * rpaths
Definition: fib_path.h:215
index_t mfib_itf_create(fib_node_index_t path_index, mfib_itf_flags_t mfi_flags)
Definition: mfib_itf.c:25
fib_protocol_t fp_proto
protocol type
Definition: mfib_types.h:33
#define DPO_PROTO_NUM
Definition: dpo.h:70
enum fib_path_list_walk_rc_t_ fib_path_list_walk_rc_t
return code to control pat-hlist walk
index_t dpoi_index
the index of objects of that type
Definition: dpo.h:186
#define FIB_NODE_INDEX_INVALID
Definition: fib_types.h:31
mfib_src_res_t mfib_entry_src_cover_change(mfib_entry_t *mfib_entry, mfib_entry_src_t *msrc)
fib_node_index_t mfpe_path
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u32 path_weight
weight for the path.
Definition: load_balance.h:76
fib_node_index_t mfib_entry_create(u32 fib_index, mfib_source_t source, const mfib_prefix_t *prefix, fib_rpf_id_t rpf_id, mfib_entry_flags_t entry_flags, index_t repi)
Definition: mfib_entry.c:803
u32 fn_locks
Number of dependents on this node.
Definition: fib_node.h:315
const mfib_prefix_t * mfib_entry_get_prefix(fib_node_index_t mfib_entry_index)
Definition: mfib_entry.c:1435
#define INDEX_INVALID
Invalid index - used when no index is known blazoned capitals INVALID speak volumes where ~0 does not...
Definition: dpo.h:47
static mfib_path_ext_t * mfib_path_ext_pool
Pool of path extensions.
Definition: mfib_entry.c:35
u8 * fib_path_list_format(fib_node_index_t path_list_index, u8 *s)
u64 uword
Definition: types.h:112
#define vec_sort_with_function(vec, f)
Sort a vector using the supplied element comparison function.
Definition: vec.h:1055
int mfib_prefix_is_host(const mfib_prefix_t *pfx)
Return true is the prefix is a host prefix.
Definition: mfib_types.c:55
static int fib_ip4_address_compare(ip4_address_t *a1, ip4_address_t *a2)
Definition: mfib_entry.c:1186
u8 * format_mfib_itf_flags(u8 *s, va_list *args)
Definition: mfib_types.c:181
#define DPO_INVALID
An initialiser for DPOs declared on the stack.
Definition: dpo.h:197
u32 index
Definition: flow_types.api:221
One path from an [EU]CMP set that the client wants to add to a load-balance object.
Definition: load_balance.h:62
enum mfib_itf_flags_t_ mfib_itf_flags_t
Definition: mfib_entry.c:545
mfib_entry_flags_t mfes_route_flags
Route flags.
void mfib_entry_src_activate(mfib_entry_t *mfib_entry, mfib_entry_src_t *msrc)
static int mfib_entry_src_ok_for_delete(const mfib_entry_src_t *msrc)
Definition: mfib_entry.c:858
A FIB graph nodes virtual function table.
Definition: fib_node.h:282
static const char * mfib_source_names[]
String names for each source.
Definition: mfib_entry.c:40
static void mfib_entry_src_init(mfib_entry_t *mfib_entry, mfib_source_t source)
Definition: mfib_entry.c:220
enum fib_node_type_t_ fib_node_type_t
The types of nodes in a FIB graph.
u32 entry_flags
Definition: ip.api:307
static fib_node_back_walk_rc_t mfib_entry_back_walk_notify(fib_node_t *node, fib_node_back_walk_ctx_t *ctx)
Definition: mfib_entry.c:1306
int dpo_is_drop(const dpo_id_t *dpo)
The Drop DPO will drop all packets, no questions asked.
Definition: drop_dpo.c:33
void dpo_reset(dpo_id_t *dpo)
reset a DPO ID The DPO will be unlocked.
Definition: dpo.c:232
void mfib_entry_cover_update_notify(mfib_entry_t *mfib_entry)
#define vec_foreach(var, vec)
Vector iterator.
void mfib_itf_delete(mfib_itf_t *mfi)
Definition: mfib_itf.c:113
mfib_entry_src_t * mfib_entry_get_best_src(const mfib_entry_t *mfib_entry)
Definition: mfib_entry.c:318
static void mfib_entry_show_memory(void)
Definition: mfib_entry.c:1319
void fib_path_list_walk_w_ext(fib_node_index_t path_list_index, const fib_path_ext_list_t *ext_list, fib_path_list_walk_w_ext_fn_t func, void *ctx)
Contribute an object that is to be used to forward non-end-of-stack MPLS packets. ...
Definition: fib_types.h:118
fib_route_path_t * mfib_entry_encode(fib_node_index_t mfib_entry_index)
Definition: mfib_entry.c:1399
replicate_flags_t rep_flags
Flags specifying the replicate properties/behaviour.
Definition: replicate_dpo.h:85
static void mfib_entry_src_remove(mfib_entry_t *mfib_entry, mfib_source_t source)
Definition: mfib_entry.c:419
#define pool_foreach_index(i, v, body)
Iterate pool by index.
Definition: pool.h:558
#define MFIB_ENTRY_FORMAT_DETAIL2
Definition: mfib_entry.h:112
u16 fp_len
The mask length.
Definition: mfib_types.h:28
u8 * fib_node_children_format(fib_node_list_t list, u8 *s)
Definition: fib_node.c:176
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
void mfib_entry_child_remove(fib_node_index_t mfib_entry_index, u32 sibling_index)
Definition: mfib_entry.c:458
mfib_entry_src_t * msrc
Definition: mfib_entry.c:549
static int mfib_entry_src_cmp_for_sort(void *v1, void *v2)
Definition: mfib_entry.c:211
Contribute an object that is to be used to forward IP4 packets.
Definition: fib_types.h:133
fib_node_index_t * fib_path_list_paths_remove(fib_node_index_t path_list_index, const fib_route_path_t *rpaths)
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:33
u8 * format_mfib_prefix(u8 *s, va_list *args)
Definition: mfib_types.c:106
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978
enum mfib_entry_src_attribute_t_ mfib_entry_src_attribute_t
Flags for the source data.
ip46_address_t fp_grp_addr
The address type is not deriveable from the fp_addr member.
Definition: mfib_types.h:46
fib_path_list_walk_rc_t fib_path_encode(fib_node_index_t path_list_index, fib_node_index_t path_index, const fib_path_ext_t *path_ext, void *args)
Definition: fib_path.c:2706
void dpo_stack(dpo_type_t child_type, dpo_proto_t child_proto, dpo_id_t *dpo, const dpo_id_t *parent)
Stack one DPO object on another, and thus establish a child-parent relationship.
Definition: dpo.c:516
static uword pool_elts(void *v)
Number of active elements in a pool.
Definition: pool.h:128