FD.io VPP  v18.10-34-gcce845e
Vector Packet Processing
adj_nbr.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 <vnet/adj/adj_nbr.h>
17 #include <vnet/adj/adj_internal.h>
19 #include <vnet/fib/fib_walk.h>
20 
21 /*
22  * Vector Hash tables of neighbour (traditional) adjacencies
23  * Key: interface(for the vector index), address (and its proto),
24  * link-type/ether-type.
25  */
26 static BVT(clib_bihash) **adj_nbr_tables[FIB_PROTOCOL_MAX];
27 
28 // FIXME SIZE APPROPRIATELY. ASK DAVEB.
29 #define ADJ_NBR_DEFAULT_HASH_NUM_BUCKETS (64 * 64)
30 #define ADJ_NBR_DEFAULT_HASH_MEMORY_SIZE (32<<20)
31 
32 
33 #define ADJ_NBR_SET_KEY(_key, _lt, _nh) \
34 { \
35  _key.key[0] = (_nh)->as_u64[0]; \
36  _key.key[1] = (_nh)->as_u64[1]; \
37  _key.key[2] = (_lt); \
38 }
39 
40 #define ADJ_NBR_ITF_OK(_proto, _itf) \
41  (((_itf) < vec_len(adj_nbr_tables[_proto])) && \
42  (NULL != adj_nbr_tables[_proto][sw_if_index]))
43 
44 static void
45 adj_nbr_insert (fib_protocol_t nh_proto,
46  vnet_link_t link_type,
47  const ip46_address_t *nh_addr,
49  adj_index_t adj_index)
50 {
51  BVT(clib_bihash_kv) kv;
52 
53  if (sw_if_index >= vec_len(adj_nbr_tables[nh_proto]))
54  {
55  vec_validate(adj_nbr_tables[nh_proto], sw_if_index);
56  }
57  if (NULL == adj_nbr_tables[nh_proto][sw_if_index])
58  {
59  adj_nbr_tables[nh_proto][sw_if_index] =
60  clib_mem_alloc_aligned(sizeof(BVT(clib_bihash)),
62  memset(adj_nbr_tables[nh_proto][sw_if_index],
63  0,
64  sizeof(BVT(clib_bihash)));
65 
66  BV(clib_bihash_init) (adj_nbr_tables[nh_proto][sw_if_index],
67  "Adjacency Neighbour table",
70  }
71 
72  ADJ_NBR_SET_KEY(kv, link_type, nh_addr);
73  kv.value = adj_index;
74 
75  BV(clib_bihash_add_del) (adj_nbr_tables[nh_proto][sw_if_index], &kv, 1);
76 }
77 
78 void
80  fib_protocol_t nh_proto,
81  vnet_link_t link_type,
82  const ip46_address_t *nh_addr,
84 {
85  BVT(clib_bihash_kv) kv;
86 
87  if (!ADJ_NBR_ITF_OK(nh_proto, sw_if_index))
88  return;
89 
90  ADJ_NBR_SET_KEY(kv, link_type, nh_addr);
91  kv.value = ai;
92 
93  BV(clib_bihash_add_del) (adj_nbr_tables[nh_proto][sw_if_index], &kv, 0);
94 }
95 
98  vnet_link_t link_type,
99  const ip46_address_t *nh_addr,
101 {
102  BVT(clib_bihash_kv) kv;
103 
104  ADJ_NBR_SET_KEY(kv, link_type, nh_addr);
105 
106  if (!ADJ_NBR_ITF_OK(nh_proto, sw_if_index))
107  return (ADJ_INDEX_INVALID);
108 
109  if (BV(clib_bihash_search)(adj_nbr_tables[nh_proto][sw_if_index],
110  &kv, &kv) < 0)
111  {
112  return (ADJ_INDEX_INVALID);
113  }
114  else
115  {
116  return (kv.value);
117  }
118 }
119 
120 static inline u32
122 {
123  switch (proto) {
124  case FIB_PROTOCOL_IP4:
125  return (ip4_arp_node.index);
126  case FIB_PROTOCOL_IP6:
127  return (ip6_discover_neighbor_node.index);
128  case FIB_PROTOCOL_MPLS:
129  break;
130  }
131  ASSERT(0);
132  return (ip4_arp_node.index);
133 }
134 
135 /**
136  * @brief Check and set feature flags if o/p interface has any o/p features.
137  */
138 static void
140 {
141  ip_adjacency_t *adj;
143  i16 feature_count;
144  u8 arc_index;
146 
147  adj = adj_get(ai);
148 
149  switch (adj->ia_link)
150  {
151  case VNET_LINK_IP4:
153  break;
154  case VNET_LINK_IP6:
156  break;
157  case VNET_LINK_MPLS:
159  break;
160  default:
161  return;
162  }
163 
164  sw_if_index = adj->rewrite_header.sw_if_index;
165  if (vec_len(fm->feature_count_by_sw_if_index[arc_index]) > sw_if_index)
166  {
167  feature_count = fm->feature_count_by_sw_if_index[arc_index][sw_if_index];
168  if (feature_count > 0)
169  adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
170  }
171 
172  return;
173 }
174 
175 static ip_adjacency_t*
177  vnet_link_t link_type,
178  const ip46_address_t *nh_addr,
180 {
181  ip_adjacency_t *adj;
182 
183  adj = adj_alloc(nh_proto);
184 
185  adj_nbr_insert(nh_proto, link_type, nh_addr,
186  sw_if_index,
187  adj_get_index(adj));
188 
189  /*
190  * since we just added the ADJ we have no rewrite string for it,
191  * so its for ARP
192  */
194  adj->sub_type.nbr.next_hop = *nh_addr;
195  adj->ia_link = link_type;
196  adj->ia_nh_proto = nh_proto;
197  adj->rewrite_header.sw_if_index = sw_if_index;
198 
200  return (adj);
201 }
202 
203 /*
204  * adj_nbr_add_or_lock
205  *
206  * Add an adjacency for the neighbour requested.
207  *
208  * The key for an adj is:
209  * - the Next-hops protocol (i.e. v4 or v6)
210  * - the address of the next-hop
211  * - the interface the next-hop is reachable through
212  */
215  vnet_link_t link_type,
216  const ip46_address_t *nh_addr,
218 {
219  adj_index_t adj_index;
220  ip_adjacency_t *adj;
221 
222  adj_index = adj_nbr_find(nh_proto, link_type, nh_addr, sw_if_index);
223 
224  if (ADJ_INDEX_INVALID == adj_index)
225  {
226  vnet_main_t *vnm;
227 
228  vnm = vnet_get_main();
229  adj = adj_nbr_alloc(nh_proto, link_type, nh_addr, sw_if_index);
230  adj_index = adj_get_index(adj);
231  adj_lock(adj_index);
232 
233  if (ip46_address_is_equal(&ADJ_BCAST_ADDR, nh_addr))
234  {
236  }
237 
238  vnet_rewrite_init(vnm, sw_if_index, link_type,
239  adj_get_nd_node(nh_proto),
240  vnet_tx_node_index_for_sw_interface(vnm, sw_if_index),
241  &adj->rewrite_header);
242 
243  /*
244  * we need a rewrite where the destination IP address is converted
245  * to the appropriate link-layer address. This is interface specific.
246  * So ask the interface to do it.
247  */
248  vnet_update_adjacency_for_sw_interface(vnm, sw_if_index, adj_index);
249  }
250  else
251  {
252  adj_lock(adj_index);
253  }
254 
255  return (adj_index);
256 }
257 
260  vnet_link_t link_type,
261  const ip46_address_t *nh_addr,
263  u8 *rewrite)
264 {
265  adj_index_t adj_index;
266  ip_adjacency_t *adj;
267 
268  adj_index = adj_nbr_find(nh_proto, link_type, nh_addr, sw_if_index);
269 
270  if (ADJ_INDEX_INVALID == adj_index)
271  {
272  adj = adj_nbr_alloc(nh_proto, link_type, nh_addr, sw_if_index);
273  adj->rewrite_header.sw_if_index = sw_if_index;
274  }
275  else
276  {
277  adj = adj_get(adj_index);
278  }
279 
280  adj_lock(adj_get_index(adj));
283  rewrite);
284 
285  return (adj_get_index(adj));
286 }
287 
288 /**
289  * adj_nbr_update_rewrite
290  *
291  * Update the adjacency's rewrite string. A NULL string implies the
292  * rewirte is reset (i.e. when ARP/ND etnry is gone).
293  * NB: the adj being updated may be handling traffic in the DP.
294  */
295 void
298  u8 *rewrite)
299 {
300  ip_adjacency_t *adj;
301 
302  ASSERT(ADJ_INDEX_INVALID != adj_index);
303 
304  adj = adj_get(adj_index);
305 
306  if (flags & ADJ_NBR_REWRITE_FLAG_COMPLETE)
307  {
308  /*
309  * update the adj's rewrite string and build the arc
310  * from the rewrite node to the interface's TX node
311  */
315  vnet_get_main(),
316  adj->rewrite_header.sw_if_index),
317  rewrite);
318  }
319  else
320  {
324  vnet_get_main(),
325  adj->rewrite_header.sw_if_index),
326  rewrite);
327  }
328 }
329 
330 /**
331  * adj_nbr_update_rewrite_internal
332  *
333  * Update the adjacency's rewrite string. A NULL string implies the
334  * rewirte is reset (i.e. when ARP/ND etnry is gone).
335  * NB: the adj being updated may be handling traffic in the DP.
336  */
337 void
339  ip_lookup_next_t adj_next_index,
340  u32 this_node,
341  u32 next_node,
342  u8 *rewrite)
343 {
344  ip_adjacency_t *walk_adj;
345  adj_index_t walk_ai;
346  vlib_main_t * vm;
347  u32 old_next;
348  int do_walk;
349 
350  vm = vlib_get_main();
351  old_next = adj->lookup_next_index;
352 
353  walk_ai = adj_get_index(adj);
354  if (VNET_LINK_MPLS == adj->ia_link)
355  {
356  /*
357  * The link type MPLS has no children in the control plane graph, it only
358  * has children in the data-palne graph. The backwalk is up the former.
359  * So we need to walk from its IP cousin.
360  */
361  walk_ai = adj_nbr_find(adj->ia_nh_proto,
363  &adj->sub_type.nbr.next_hop,
364  adj->rewrite_header.sw_if_index);
365  }
366 
367  /*
368  * Don't call the walk re-entrantly
369  */
370  if (ADJ_INDEX_INVALID != walk_ai)
371  {
372  walk_adj = adj_get(walk_ai);
373  if (ADJ_FLAG_SYNC_WALK_ACTIVE & walk_adj->ia_flags)
374  {
375  do_walk = 0;
376  }
377  else
378  {
379  /*
380  * Prevent re-entrant walk of the same adj
381  */
382  walk_adj->ia_flags |= ADJ_FLAG_SYNC_WALK_ACTIVE;
383  do_walk = 1;
384  }
385  }
386  else
387  {
388  do_walk = 0;
389  }
390 
391  /*
392  * lock the adjacencies that are affected by updates this walk will provoke.
393  * Since the aim of the walk is to update children to link to a different
394  * DPO, this adj will no longer be in use and its lock count will drop to 0.
395  * We don't want it to be deleted as part of this endevour.
396  */
397  adj_lock(adj_get_index(adj));
398  adj_lock(walk_ai);
399 
400  /*
401  * Updating a rewrite string is not atomic;
402  * - the rewrite string is too long to write in one instruction
403  * - when swapping from incomplete to complete, we also need to update
404  * the VLIB graph next-index of the adj.
405  * ideally we would only want to suspend forwarding via this adj whilst we
406  * do this, but we do not have that level of granularity - it's suspend all
407  * worker threads or nothing.
408  * The other chioces are:
409  * - to mark the adj down and back walk so child load-balances drop this adj
410  * from the set.
411  * - update the next_node index of this adj to point to error-drop
412  * both of which will mean for MAC change we will drop for this adj
413  * which is not acceptable. However, when the adj changes type (from
414  * complete to incomplete and vice-versa) the child DPOs, which have the
415  * VLIB graph next node index, will be sending packets to the wrong graph
416  * node. So from the options above, updating the next_node of the adj to
417  * be drop will work, but it relies on each graph node v4/v6/mpls, rewrite/
418  * arp/midchain always be valid w.r.t. a mis-match of adj type and node type
419  * (i.e. a rewrite adj in the arp node). This is not enforcable. Getting it
420  * wrong will lead to hard to find bugs since its a race condition. So we
421  * choose the more reliable method of updating the children to use the drop,
422  * then switching adj's type, then updating the children again. Did I mention
423  * that this doesn't happen often...
424  * So we need to distinguish between the two cases:
425  * 1 - mac change
426  * 2 - adj type change
427  */
428  if (do_walk &&
429  old_next != adj_next_index &&
430  ADJ_INDEX_INVALID != walk_ai)
431  {
432  /*
433  * the adj is changing type. we need to fix all children so that they
434  * stack momentarily on a drop, while the adj changes. If we don't do
435  * this the children will send packets to a VLIB graph node that does
436  * not correspond to the adj's type - and it goes downhill from there.
437  */
438  fib_node_back_walk_ctx_t bw_ctx = {
440  /*
441  * force this walk to be synchrous. if we don't and a node in the graph
442  * (a heavily shared path-list) chooses to back-ground the walk (make it
443  * async) then it will pause and we will do the adj update below, before
444  * all the children are updated. not good.
445  */
446  .fnbw_flags = FIB_NODE_BW_FLAG_FORCE_SYNC,
447  };
448 
449  fib_walk_sync(FIB_NODE_TYPE_ADJ, walk_ai, &bw_ctx);
450  }
451 
452  /*
453  * If we are just updating the MAC string of the adj (which we also can't
454  * do atomically), then we need to stop packets switching through the adj.
455  * We can't do that on a per-adj basis, so it's all the packets.
456  * If we are updating the type, and we walked back to the children above,
457  * then this barrier serves to flush the queues/frames.
458  */
460 
461  adj->lookup_next_index = adj_next_index;
462 
463  if (NULL != rewrite)
464  {
465  /*
466  * new rewrite provided.
467  * fill in the adj's rewrite string, and build the VLIB graph arc.
468  */
469  vnet_rewrite_set_data_internal(&adj->rewrite_header,
470  sizeof(adj->rewrite_data),
471  rewrite,
472  vec_len(rewrite));
473  vec_free(rewrite);
474  }
475  else
476  {
477  vnet_rewrite_clear_data_internal(&adj->rewrite_header,
478  sizeof(adj->rewrite_data));
479  }
480  adj->rewrite_header.next_index = vlib_node_add_next(vlib_get_main(),
481  this_node,
482  next_node);
483 
484  /*
485  * done with the rewirte update - let the workers loose.
486  */
488 
489  if (do_walk &&
490  (old_next != adj->lookup_next_index) &&
491  (ADJ_INDEX_INVALID != walk_ai))
492  {
493  /*
494  * backwalk to the children so they can stack on the now updated
495  * adjacency
496  */
497  fib_node_back_walk_ctx_t bw_ctx = {
499  };
500 
501  fib_walk_sync(FIB_NODE_TYPE_ADJ, walk_ai, &bw_ctx);
502  }
503  /*
504  * Prevent re-entrant walk of the same adj
505  */
506  if (do_walk)
507  {
508  walk_adj->ia_flags &= ~ADJ_FLAG_SYNC_WALK_ACTIVE;
509  }
510 
512  adj_unlock(walk_ai);
513 }
514 
515 typedef struct adj_db_count_ctx_t_ {
518 
519 static void
520 adj_db_count (BVT(clib_bihash_kv) * kvp,
521  void *arg)
522 {
523  adj_db_count_ctx_t * ctx = arg;
524  ctx->count++;
525 }
526 
527 u32
529 {
531  .count = 0,
532  };
533  fib_protocol_t proto;
534  u32 sw_if_index = 0;
535 
536  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
537  {
538  vec_foreach_index(sw_if_index, adj_nbr_tables[proto])
539  {
540  if (NULL != adj_nbr_tables[proto][sw_if_index])
541  {
543  adj_nbr_tables[proto][sw_if_index],
544  adj_db_count,
545  &ctx);
546  }
547  }
548  }
549  return (ctx.count);
550 }
551 
552 /**
553  * @brief Context for a walk of the adjacency neighbour DB
554  */
555 typedef struct adj_walk_ctx_t_
556 {
558  void *awc_ctx;
560 
561 static void
562 adj_nbr_walk_cb (BVT(clib_bihash_kv) * kvp,
563  void *arg)
564 {
565  adj_walk_ctx_t *ctx = arg;
566 
567  // FIXME: can't stop early...
568  ctx->awc_cb(kvp->value, ctx->awc_ctx);
569 }
570 
571 void
573  fib_protocol_t adj_nh_proto,
574  adj_walk_cb_t cb,
575  void *ctx)
576 {
577  if (!ADJ_NBR_ITF_OK(adj_nh_proto, sw_if_index))
578  return;
579 
580  adj_walk_ctx_t awc = {
581  .awc_ctx = ctx,
582  .awc_cb = cb,
583  };
584 
586  adj_nbr_tables[adj_nh_proto][sw_if_index],
588  &awc);
589 }
590 
591 /**
592  * @brief Walk adjacencies on a link with a given v4 next-hop.
593  * that is visit the adjacencies with different link types.
594  */
595 void
597  const ip4_address_t *addr,
598  adj_walk_cb_t cb,
599  void *ctx)
600 {
601  if (!ADJ_NBR_ITF_OK(FIB_PROTOCOL_IP4, sw_if_index))
602  return;
603 
604  ip46_address_t nh = {
605  .ip4 = *addr,
606  };
607  vnet_link_t linkt;
608  adj_index_t ai;
609 
610  FOR_EACH_VNET_LINK(linkt)
611  {
612  ai = adj_nbr_find (FIB_PROTOCOL_IP4, linkt, &nh, sw_if_index);
613 
614  if (INDEX_INVALID != ai)
615  cb(ai, ctx);
616  }
617 }
618 
619 /**
620  * @brief Walk adjacencies on a link with a given v6 next-hop.
621  * that is visit the adjacencies with different link types.
622  */
623 void
625  const ip6_address_t *addr,
626  adj_walk_cb_t cb,
627  void *ctx)
628 {
629  if (!ADJ_NBR_ITF_OK(FIB_PROTOCOL_IP6, sw_if_index))
630  return;
631 
632  ip46_address_t nh = {
633  .ip6 = *addr,
634  };
635  vnet_link_t linkt;
636  adj_index_t ai;
637 
638  FOR_EACH_VNET_LINK(linkt)
639  {
640  ai = adj_nbr_find (FIB_PROTOCOL_IP6, linkt, &nh, sw_if_index);
641 
642  if (INDEX_INVALID != ai)
643  cb(ai, ctx);
644  }
645 }
646 
647 /**
648  * @brief Walk adjacencies on a link with a given next-hop.
649  * that is visit the adjacencies with different link types.
650  */
651 void
653  fib_protocol_t adj_nh_proto,
654  const ip46_address_t *nh,
655  adj_walk_cb_t cb,
656  void *ctx)
657 {
658  if (!ADJ_NBR_ITF_OK(adj_nh_proto, sw_if_index))
659  return;
660 
661  vnet_link_t linkt;
662  adj_index_t ai;
663 
664  FOR_EACH_VNET_LINK(linkt)
665  {
666  ai = adj_nbr_find (FIB_PROTOCOL_IP4, linkt, nh, sw_if_index);
667 
668  if (INDEX_INVALID != ai)
669  cb(ai, ctx);
670  }
671 }
672 
673 /**
674  * Flags associated with the interface state walks
675  */
677 {
680 
681 /**
682  * Context for the state change walk of the DB
683  */
685 {
686  /**
687  * Flags on the interface
688  */
691 
692 static adj_walk_rc_t
694  void *arg)
695 {
696  /*
697  * Back walk the graph to inform the forwarding entries
698  * that this interface state has changed. Do this synchronously
699  * since this is the walk that provides convergence
700  */
702  fib_node_back_walk_ctx_t bw_ctx = {
703  .fnbw_reason = ((ctx->flags & ADJ_NBR_INTERFACE_UP) ?
706  /*
707  * the force sync applies only as far as the first fib_entry.
708  * And it's the fib_entry's we need to converge away from
709  * the adjacencies on the now down link
710  */
711  .fnbw_flags = (!(ctx->flags & ADJ_NBR_INTERFACE_UP) ?
714  };
715  ip_adjacency_t *adj;
716 
717  adj = adj_get(ai);
718 
720  fib_walk_sync(FIB_NODE_TYPE_ADJ, ai, &bw_ctx);
722 
723  return (ADJ_WALK_RC_CONTINUE);
724 }
725 
726 /**
727  * @brief Registered function for SW interface state changes
728  */
729 static clib_error_t *
732  u32 flags)
733 {
734  fib_protocol_t proto;
735 
736  /*
737  * walk each adj on the interface and trigger a walk from that adj
738  */
739  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
740  {
742  .flags = ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
744  0),
745  };
746 
747  adj_nbr_walk(sw_if_index, proto,
749  &ctx);
750  }
751 
752  return (NULL);
753 }
754 
758 
759 /**
760  * @brief Invoked on each SW interface of a HW interface when the
761  * HW interface state changes
762  */
763 static walk_rc_t
766  void *arg)
767 {
769  fib_protocol_t proto;
770 
771  /*
772  * walk each adj on the interface and trigger a walk from that adj
773  */
774  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
775  {
776  adj_nbr_walk(sw_if_index, proto,
778  ctx);
779  }
780  return (WALK_CONTINUE);
781 }
782 
783 /**
784  * @brief Registered callback for HW interface state changes
785  */
786 static clib_error_t *
788  u32 hw_if_index,
789  u32 flags)
790 {
791  /*
792  * walk SW interface on the HW
793  */
795  .flags = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
797  0),
798  };
799 
800  vnet_hw_interface_walk_sw(vnm, hw_if_index,
802  &ctx);
803 
804  return (NULL);
805 }
806 
810 
811 static adj_walk_rc_t
813  void *arg)
814 {
815  /*
816  * Back walk the graph to inform the forwarding entries
817  * that this interface has been deleted.
818  */
819  fib_node_back_walk_ctx_t bw_ctx = {
821  };
822  ip_adjacency_t *adj;
823 
824  adj = adj_get(ai);
825 
827  fib_walk_sync(FIB_NODE_TYPE_ADJ, ai, &bw_ctx);
829 
830  return (ADJ_WALK_RC_CONTINUE);
831 }
832 
833 /**
834  * adj_nbr_interface_add_del
835  *
836  * Registered to receive interface Add and delete notifications
837  */
838 static clib_error_t *
841  u32 is_add)
842 {
843  fib_protocol_t proto;
844 
845  if (is_add)
846  {
847  /*
848  * not interested in interface additions. we will not back walk
849  * to resolve paths through newly added interfaces. Why? The control
850  * plane should have the brains to add interfaces first, then routes.
851  * So the case where there are paths with a interface that matches
852  * one just created is the case where the path resolved through an
853  * interface that was deleted, and still has not been removed. The
854  * new interface added, is NO GUARANTEE that the interface being
855  * added now, even though it may have the same sw_if_index, is the
856  * same interface that the path needs. So tough!
857  * If the control plane wants these routes to resolve it needs to
858  * remove and add them again.
859  */
860  return (NULL);
861  }
862 
863  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
864  {
865  adj_nbr_walk(sw_if_index, proto,
867  NULL);
868  }
869 
870  return (NULL);
871 
872 }
873 
875 
876 
877 static adj_walk_rc_t
879  void *arg)
880 {
881  vlib_cli_output (arg, "[@%d] %U",
882  ai,
885 
886  return (ADJ_WALK_RC_CONTINUE);
887 }
888 
889 static clib_error_t *
891  unformat_input_t * input,
892  vlib_cli_command_t * cmd)
893 {
895  u32 sw_if_index = ~0;
896 
898  {
899  if (unformat (input, "%d", &ai))
900  ;
901  else if (unformat (input, "%U",
903  &sw_if_index))
904  ;
905  else
906  break;
907  }
908 
909  if (ADJ_INDEX_INVALID != ai)
910  {
911  vlib_cli_output (vm, "[@%d] %U",
912  ai,
915  }
916  else if (~0 != sw_if_index)
917  {
918  fib_protocol_t proto;
919 
920  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
921  {
922  adj_nbr_walk(sw_if_index, proto,
924  vm);
925  }
926  }
927  else
928  {
929  fib_protocol_t proto;
930 
931  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
932  {
933  vec_foreach_index(sw_if_index, adj_nbr_tables[proto])
934  {
935  adj_nbr_walk(sw_if_index, proto,
937  vm);
938  }
939  }
940  }
941 
942  return 0;
943 }
944 
945 /*?
946  * Show all neighbour adjacencies.
947  * @cliexpar
948  * @cliexstart{sh adj nbr}
949  * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
950  * [@3] mpls via 1.0.0.2 loop0: MPLS_UNICAST: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
951  * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
952  * [@5] mpls via 1.0.0.3 loop0: MPLS_UNICAST: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
953  * @cliexend
954  ?*/
955 VLIB_CLI_COMMAND (ip4_show_fib_command, static) = {
956  .path = "show adj nbr",
957  .short_help = "show adj nbr [<adj_index>] [interface]",
958  .function = adj_nbr_show,
959 };
960 
961 u8*
962 format_adj_nbr_incomplete (u8* s, va_list *ap)
963 {
964  index_t index = va_arg(*ap, index_t);
965  CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
966  vnet_main_t * vnm = vnet_get_main();
967  ip_adjacency_t * adj = adj_get(index);
968 
969  s = format (s, "arp-%U", format_vnet_link, adj->ia_link);
970  s = format (s, ": via %U",
971  format_ip46_address, &adj->sub_type.nbr.next_hop,
973  s = format (s, " %U",
975  vnm, adj->rewrite_header.sw_if_index);
976 
977  return (s);
978 }
979 
980 u8*
981 format_adj_nbr (u8* s, va_list *ap)
982 {
983  index_t index = va_arg(*ap, index_t);
984  CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
985  ip_adjacency_t * adj = adj_get(index);
986 
987  s = format (s, "%U", format_vnet_link, adj->ia_link);
988  s = format (s, " via %U ",
989  format_ip46_address, &adj->sub_type.nbr.next_hop,
991  s = format (s, "%U",
993  &adj->rewrite_header, sizeof (adj->rewrite_data), 0);
994 
995  return (s);
996 }
997 
998 static void
1000 {
1001  adj_lock(dpo->dpoi_index);
1002 }
1003 static void
1005 {
1006  adj_unlock(dpo->dpoi_index);
1007 }
1008 
1009 static void
1011 {
1012  fib_show_memory_usage("Adjacency",
1014  pool_len(adj_pool),
1015  sizeof(ip_adjacency_t));
1016 }
1017 
1018 const static dpo_vft_t adj_nbr_dpo_vft = {
1019  .dv_lock = adj_dpo_lock,
1020  .dv_unlock = adj_dpo_unlock,
1021  .dv_format = format_adj_nbr,
1022  .dv_mem_show = adj_mem_show,
1023  .dv_get_urpf = adj_dpo_get_urpf,
1024 };
1025 const static dpo_vft_t adj_nbr_incompl_dpo_vft = {
1026  .dv_lock = adj_dpo_lock,
1027  .dv_unlock = adj_dpo_unlock,
1028  .dv_format = format_adj_nbr_incomplete,
1029  .dv_get_urpf = adj_dpo_get_urpf,
1030 };
1031 
1032 /**
1033  * @brief The per-protocol VLIB graph nodes that are assigned to an adjacency
1034  * object.
1035  *
1036  * this means that these graph nodes are ones from which a nbr is the
1037  * parent object in the DPO-graph.
1038  */
1039 const static char* const nbr_ip4_nodes[] =
1040 {
1041  "ip4-rewrite",
1042  NULL,
1043 };
1044 const static char* const nbr_ip6_nodes[] =
1045 {
1046  "ip6-rewrite",
1047  NULL,
1048 };
1049 const static char* const nbr_mpls_nodes[] =
1050 {
1051  "mpls-output",
1052  NULL,
1053 };
1054 const static char* const nbr_ethernet_nodes[] =
1055 {
1056  "adj-l2-rewrite",
1057  NULL,
1058 };
1059 const static char* const * const nbr_nodes[DPO_PROTO_NUM] =
1060 {
1065 };
1066 
1067 const static char* const nbr_incomplete_ip4_nodes[] =
1068 {
1069  "ip4-arp",
1070  NULL,
1071 };
1072 const static char* const nbr_incomplete_ip6_nodes[] =
1073 {
1074  "ip6-discover-neighbor",
1075  NULL,
1076 };
1077 const static char* const nbr_incomplete_mpls_nodes[] =
1078 {
1079  "mpls-adj-incomplete",
1080  NULL,
1081 };
1082 
1083 const static char* const * const nbr_incomplete_nodes[DPO_PROTO_NUM] =
1084 {
1088 };
1089 
1090 void
1092 {
1094  &adj_nbr_dpo_vft,
1095  nbr_nodes);
1097  &adj_nbr_incompl_dpo_vft,
1098  nbr_incomplete_nodes);
1099 }
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:437
dpo_lock_fn_t dv_lock
A reference counting lock function.
Definition: dpo.h:404
void adj_nbr_walk_nh(u32 sw_if_index, fib_protocol_t adj_nh_proto, const ip46_address_t *nh, adj_walk_cb_t cb, void *ctx)
Walk adjacencies on a link with a given next-hop.
Definition: adj_nbr.c:652
static clib_error_t * adj_nbr_hw_interface_state_change(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Registered callback for HW interface state changes.
Definition: adj_nbr.c:787
#define vec_foreach_index(var, v)
Iterate over vector indices.
adj_flags_t ia_flags
Flags on the adjacency 1-bytes.
Definition: adj.h:219
Context for a walk of the adjacency neighbour DB.
Definition: adj_nbr.c:555
ip_adjacency_t * adj_pool
The global adjacnecy pool.
Definition: adj.c:33
#define CLIB_UNUSED(x)
Definition: clib.h:81
A virtual function table regisitered for a DPO type.
Definition: dpo.h:399
enum adj_nbr_interface_flags_t_ adj_nbr_interface_flags_t
Flags associated with the interface state walks.
u8 * format_adj_nbr(u8 *s, va_list *ap)
Format a neigbour (REWRITE) adjacency.
Definition: adj_nbr.c:981
void adj_lock(adj_index_t adj_index)
Take a reference counting lock on the adjacency.
Definition: adj.c:235
An indication that the rewrite is complete, i.e.
Definition: adj_nbr.h:98
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
static const char *const nbr_ethernet_nodes[]
Definition: adj_nbr.c:1054
struct ip_adjacency_t_::@45::@46 nbr
IP_LOOKUP_NEXT_ARP/IP_LOOKUP_NEXT_REWRITE.
static const char *const nbr_incomplete_ip6_nodes[]
Definition: adj_nbr.c:1072
unsigned long u64
Definition: types.h:89
static adj_walk_rc_t adj_nbr_interface_state_change_one(adj_index_t ai, void *arg)
Definition: adj_nbr.c:693
void vnet_hw_interface_walk_sw(vnet_main_t *vnm, u32 hw_if_index, vnet_hw_sw_interface_walk_t fn, void *ctx)
Walk the SW interfaces on a HW interface - this is the super interface and any sub-interfaces.
Definition: interface.c:982
#define NULL
Definition: clib.h:57
Broadcasr Adjacency.
Definition: adj.h:85
IP unicast adjacency.
Definition: adj.h:185
union ip_adjacency_t_::@45 sub_type
Context for the state change walk of the DB.
Definition: adj_nbr.c:684
This packet is to be rewritten and forwarded to the next processing node.
Definition: adj.h:73
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
format_function_t format_ip46_address
Definition: format.h:61
ip_lookup_main_t lookup_main
Definition: ip4.h:98
adj_walk_cb_t awc_cb
Definition: adj_nbr.c:557
void adj_nbr_walk_nh4(u32 sw_if_index, const ip4_address_t *addr, adj_walk_cb_t cb, void *ctx)
Walk adjacencies on a link with a given v4 next-hop.
Definition: adj_nbr.c:596
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
unformat_function_t unformat_vnet_sw_interface
u8 * format_adj_nbr_incomplete(u8 *s, va_list *ap)
Format aa incomplete neigbour (ARP) adjacency.
Definition: adj_nbr.c:962
#define VNET_HW_INTERFACE_FLAG_LINK_UP
Definition: interface.h:494
static const char *const nbr_incomplete_mpls_nodes[]
Definition: adj_nbr.c:1077
u32 adj_dpo_get_urpf(const dpo_id_t *dpo)
Definition: adj.c:225
vhost_vring_addr_t addr
Definition: vhost_user.h:121
adj_index_t adj_nbr_add_or_lock_w_rewrite(fib_protocol_t nh_proto, vnet_link_t link_type, const ip46_address_t *nh_addr, u32 sw_if_index, u8 *rewrite)
Add (and lock) a new or lock an existing neighbour adjacency.
Definition: adj_nbr.c:259
format_function_t format_vnet_sw_if_index_name
static uword vlib_node_add_next(vlib_main_t *vm, uword node, uword next_node)
Definition: node_funcs.h:1118
unsigned char u8
Definition: types.h:56
ip_lookup_next_t
An adjacency is a representation of an attached L3 peer.
Definition: adj.h:50
#define pool_len(p)
Number of elements in pool vector.
Definition: pool.h:140
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
#define vlib_worker_thread_barrier_sync(X)
Definition: threads.h:204
vnet_link_t ia_link
link/ether-type 1 bytes
Definition: adj.h:206
#define fm
enum walk_rc_t_ walk_rc_t
Walk return code.
u8 output_feature_arc_index
Definition: lookup.h:138
static clib_error_t * adj_nbr_sw_interface_state_change(vnet_main_t *vnm, u32 sw_if_index, u32 flags)
Registered function for SW interface state changes.
Definition: adj_nbr.c:730
static ip_adjacency_t * adj_get(adj_index_t adj_index)
Get a pointer to an adjacency object from its index.
Definition: adj.h:380
memset(h->entries, 0, sizeof(h->entries[0])*entries)
vlib_node_registration_t ip6_discover_neighbor_node
(constructor) VLIB_REGISTER_NODE (ip6_discover_neighbor_node)
VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(adj_nbr_sw_interface_state_change, VNET_ITF_FUNC_PRIORITY_HIGH)
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:321
int clib_bihash_add_del(clib_bihash *h, clib_bihash_kv *add_v, int is_add)
Add or delete a (key,value) pair from a bi-hash table.
format_function_t format_ip_adjacency
Definition: format.h:58
u32 sw_if_index
Definition: vxlan_gbp.api:39
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:729
static void vnet_rewrite_clear_data_internal(vnet_rewrite_header_t *rw, int max_size)
Definition: rewrite.h:116
static const char *const nbr_incomplete_ip4_nodes[]
Definition: adj_nbr.c:1067
static BVT(clib_bihash)
Definition: adj_nbr.c:26
enum adj_walk_rc_t_ adj_walk_rc_t
return codes from a adjacency walker callback function
static walk_rc_t adj_nbr_hw_sw_interface_state_change(vnet_main_t *vnm, u32 sw_if_index, void *arg)
Invoked on each SW interface of a HW interface when the HW interface state changes.
Definition: adj_nbr.c:764
static clib_error_t * adj_nbr_show(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: adj_nbr.c:890
struct adj_walk_ctx_t_ adj_walk_ctx_t
Context for a walk of the adjacency neighbour DB.
static const char *const nbr_mpls_nodes[]
Definition: adj_nbr.c:1049
static void adj_nbr_walk_cb(BVT(clib_bihash_kv)*kvp, void *arg)
Definition: adj_nbr.c:562
static void adj_dpo_lock(dpo_id_t *dpo)
Definition: adj_nbr.c:999
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 adj_unlock(adj_index_t adj_index)
Release a reference counting lock on the adjacency.
Definition: adj.c:252
void vnet_update_adjacency_for_sw_interface(vnet_main_t *vnm, u32 sw_if_index, u32 ai)
Definition: rewrite.c:228
unsigned int u32
Definition: types.h:88
static const char *const nbr_ip6_nodes[]
Definition: adj_nbr.c:1044
static void adj_nbr_evaluate_feature(adj_index_t ai)
Check and set feature flags if o/p interface has any o/p features.
Definition: adj_nbr.c:139
format_function_t format_vnet_rewrite
Definition: rewrite.h:331
u8 output_feature_arc_index
Definition: mpls.h:57
u32 adj_nbr_db_size(void)
Return the size of the adjacency database.
Definition: adj_nbr.c:528
#define ADJ_NBR_DEFAULT_HASH_NUM_BUCKETS
vlib_node_registration_t ip4_arp_node
(constructor) VLIB_REGISTER_NODE (ip4_arp_node)
Definition: ip4_forward.c:1937
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:168
fib_node_bw_reason_flag_t fnbw_reason
The reason/trigger for the backwalk.
Definition: fib_node.h:206
#define ADJ_INDEX_INVALID
Invalid ADJ index - used when no adj is known likewise blazoned capitals INVALID speak volumes where ...
Definition: adj_types.h:36
void adj_nbr_remove(adj_index_t ai, fib_protocol_t nh_proto, vnet_link_t link_type, const ip46_address_t *nh_addr, u32 sw_if_index)
Definition: adj_nbr.c:79
long ctx[MAX_CONNS]
Definition: main.c:144
struct _unformat_input_t unformat_input_t
static adj_index_t adj_get_index(ip_adjacency_t *adj)
Get a pointer to an adjacency object from its index.
Definition: adj_internal.h:101
static clib_error_t * adj_nbr_interface_add_del(vnet_main_t *vnm, u32 sw_if_index, u32 is_add)
adj_nbr_interface_add_del
Definition: adj_nbr.c:839
#define ADJ_NBR_DEFAULT_HASH_MEMORY_SIZE
void adj_nbr_module_init(void)
Module initialisation.
Definition: adj_nbr.c:1091
void clib_bihash_init(clib_bihash *h, char *name, u32 nbuckets, uword memory_size)
initialize a bounded index extensible hash table
u32 flags
Definition: vhost_user.h:115
#define ADJ_NBR_SET_KEY(_key, _lt, _nh)
void clib_bihash_foreach_key_value_pair(clib_bihash *h, void *callback, void *arg)
Visit active (key,value) pairs in a bi-hash table.
Currently a sync walk is active.
Definition: adj.h:167
This packet matches an "incomplete adjacency" and packets need to be passed to ARP to find rewrite st...
Definition: adj.h:63
#define UNFORMAT_END_OF_INPUT
Definition: format.h:144
void vnet_rewrite_init(vnet_main_t *vnm, u32 sw_if_index, vnet_link_t linkt, u32 this_node, u32 next_node, vnet_rewrite_header_t *rw)
Definition: rewrite.c:104
mpls_main_t mpls_main
Definition: mpls.c:25
vlib_main_t * vm
Definition: buffer.c:294
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:339
static adj_walk_rc_t adj_nbr_show_one(adj_index_t ai, void *arg)
Definition: adj_nbr.c:878
Force the walk to be synchronous.
Definition: fib_node.h:168
u32 vnet_tx_node_index_for_sw_interface(vnet_main_t *vnm, u32 sw_if_index)
Definition: rewrite.c:97
static void vnet_rewrite_set_data_internal(vnet_rewrite_header_t *rw, int max_size, void *data, int data_bytes)
Definition: rewrite.h:126
adj_walk_rc_t(* adj_walk_cb_t)(adj_index_t ai, void *ctx)
Call back function when walking adjacencies.
Definition: adj_types.h:50
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
static void adj_mem_show(void)
Definition: adj_nbr.c:1010
static ip_adjacency_t * adj_nbr_alloc(fib_protocol_t nh_proto, vnet_link_t link_type, const ip46_address_t *nh_addr, u32 sw_if_index)
Definition: adj_nbr.c:176
void adj_nbr_walk(u32 sw_if_index, fib_protocol_t adj_nh_proto, adj_walk_cb_t cb, void *ctx)
Walk the neighbour Adjacencies on a given interface.
Definition: adj_nbr.c:572
i16 ** feature_count_by_sw_if_index
feature reference counts by interface
Definition: feature.h:90
#define FOR_EACH_VNET_LINK(_link)
Definition: interface.h:357
Context passed between object during a back walk.
Definition: fib_node.h:202
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:155
VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(adj_nbr_hw_interface_state_change, VNET_ITF_FUNC_PRIORITY_HIGH)
adj_nbr_interface_flags_t flags
Flags on the interface.
Definition: adj_nbr.c:689
#define ASSERT(truth)
ip6_main_t ip6_main
Definition: ip6_forward.c:2590
ip_lookup_main_t lookup_main
Definition: ip6.h:161
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
void * awc_ctx
Definition: adj_nbr.c:558
static const char *const nbr_ip4_nodes[]
The per-protocol VLIB graph nodes that are assigned to an adjacency object.
Definition: adj_nbr.c:1039
static u32 adj_get_rewrite_node(vnet_link_t linkt)
Definition: adj_internal.h:46
static u32 adj_get_nd_node(fib_protocol_t proto)
Definition: adj_nbr.c:121
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
fib_protocol_t ia_nh_proto
The protocol of the neighbor/peer.
Definition: adj.h:213
#define DPO_PROTO_NUM
Definition: dpo.h:70
index_t dpoi_index
the index of objects of that type
Definition: dpo.h:184
#define ip46_address_is_equal(a1, a2)
Definition: ip6_packet.h:94
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
ip_lookup_next_t lookup_next_index
Next hop after ip4-lookup.
Definition: adj.h:200
void adj_nbr_update_rewrite_internal(ip_adjacency_t *adj, ip_lookup_next_t adj_next_index, u32 this_node, u32 next_node, u8 *rewrite)
adj_nbr_update_rewrite_internal
Definition: adj_nbr.c:338
enum adj_nbr_rewrite_flag_t_ adj_nbr_rewrite_flag_t
When adding a rewrite to an adjacency these are flags that apply to that rewrite. ...
#define INDEX_INVALID
Invalid index - used when no index is known blazoned capitals INVALID speak volumes where ~0 does not...
Definition: dpo.h:47
ip_adjacency_t * adj_alloc(fib_protocol_t proto)
Definition: adj.c:58
static void adj_db_count(BVT(clib_bihash_kv)*kvp, void *arg)
Definition: adj_nbr.c:520
static adj_walk_rc_t adj_nbr_interface_delete_one(adj_index_t ai, void *arg)
Definition: adj_nbr.c:812
#define FIB_PROTOCOL_MAX
Definition outside of enum so it does not need to be included in non-defaulted switch statements...
Definition: fib_types.h:52
static void * clib_mem_alloc_aligned(uword size, uword align)
Definition: mem.h:140
adj_nbr_interface_flags_t_
Flags associated with the interface state walks.
Definition: adj_nbr.c:676
void vlib_worker_thread_barrier_release(vlib_main_t *vm)
Definition: threads.c:1455
ip4_main_t ip4_main
Global ip4 main structure.
Definition: ip4_forward.c:900
adj_index_t adj_nbr_add_or_lock(fib_protocol_t nh_proto, vnet_link_t link_type, const ip46_address_t *nh_addr, u32 sw_if_index)
Neighbour Adjacency sub-type.
Definition: adj_nbr.c:214
struct adj_db_count_ctx_t_ adj_db_count_ctx_t
vnet_link_t fib_proto_to_link(fib_protocol_t proto)
Convert from a protocol to a link type.
Definition: fib_types.c:271
u8 * format_vnet_link(u8 *s, va_list *ap)
Definition: fib_types.c:40
VNET_SW_INTERFACE_ADD_DEL_FUNCTION(adj_nbr_interface_add_del)
static void adj_dpo_unlock(dpo_id_t *dpo)
Definition: adj_nbr.c:1004
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
#define ADJ_NBR_ITF_OK(_proto, _itf)
This adjacency/interface has output features configured.
Definition: rewrite.h:57
vnet_feature_main_t feature_main
Definition: feature.c:19
void adj_nbr_update_rewrite(adj_index_t adj_index, adj_nbr_rewrite_flag_t flags, u8 *rewrite)
adj_nbr_update_rewrite
Definition: adj_nbr.c:296
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:725
const ip46_address_t ADJ_BCAST_ADDR
The special broadcast address (to construct a broadcast adjacency.
Definition: adj.c:41
struct adj_nbr_interface_state_change_ctx_t_ adj_nbr_interface_state_change_ctx_t
Context for the state change walk of the DB.
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:170
static ip46_type_t adj_proto_to_46(fib_protocol_t proto)
Definition: adj_internal.h:82
signed short i16
Definition: types.h:46
adj_index_t adj_nbr_find(fib_protocol_t nh_proto, vnet_link_t link_type, const ip46_address_t *nh_addr, u32 sw_if_index)
Lookup neighbor adjancency.
Definition: adj_nbr.c:97
void adj_nbr_walk_nh6(u32 sw_if_index, const ip6_address_t *addr, adj_walk_cb_t cb, void *ctx)
Walk adjacencies on a link with a given v6 next-hop.
Definition: adj_nbr.c:624
static uword pool_elts(void *v)
Number of active elements in a pool.
Definition: pool.h:128