FD.io VPP  v18.07-34-g55fbdb9
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,
48  u32 sw_if_index,
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,
83  u32 sw_if_index)
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,
100  u32 sw_if_index)
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;
145  u32 sw_if_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,
179  u32 sw_if_index)
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,
217  u32 sw_if_index)
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  vnet_rewrite_init(vnm, sw_if_index, link_type,
234  adj_get_nd_node(nh_proto),
235  vnet_tx_node_index_for_sw_interface(vnm, sw_if_index),
236  &adj->rewrite_header);
237 
238  /*
239  * we need a rewrite where the destination IP address is converted
240  * to the appropriate link-layer address. This is interface specific.
241  * So ask the interface to do it.
242  */
243  vnet_update_adjacency_for_sw_interface(vnm, sw_if_index, adj_index);
244  }
245  else
246  {
247  adj_lock(adj_index);
248  }
249 
250  return (adj_index);
251 }
252 
255  vnet_link_t link_type,
256  const ip46_address_t *nh_addr,
257  u32 sw_if_index,
258  u8 *rewrite)
259 {
260  adj_index_t adj_index;
261  ip_adjacency_t *adj;
262 
263  adj_index = adj_nbr_find(nh_proto, link_type, nh_addr, sw_if_index);
264 
265  if (ADJ_INDEX_INVALID == adj_index)
266  {
267  adj = adj_nbr_alloc(nh_proto, link_type, nh_addr, sw_if_index);
268  adj->rewrite_header.sw_if_index = sw_if_index;
269  }
270  else
271  {
272  adj = adj_get(adj_index);
273  }
274 
275  adj_lock(adj_get_index(adj));
278  rewrite);
279 
280  return (adj_get_index(adj));
281 }
282 
283 /**
284  * adj_nbr_update_rewrite
285  *
286  * Update the adjacency's rewrite string. A NULL string implies the
287  * rewirte is reset (i.e. when ARP/ND etnry is gone).
288  * NB: the adj being updated may be handling traffic in the DP.
289  */
290 void
293  u8 *rewrite)
294 {
295  ip_adjacency_t *adj;
296 
297  ASSERT(ADJ_INDEX_INVALID != adj_index);
298 
299  adj = adj_get(adj_index);
300 
301  if (flags & ADJ_NBR_REWRITE_FLAG_COMPLETE)
302  {
303  /*
304  * update the adj's rewrite string and build the arc
305  * from the rewrite node to the interface's TX node
306  */
310  vnet_get_main(),
311  adj->rewrite_header.sw_if_index),
312  rewrite);
313  }
314  else
315  {
319  vnet_get_main(),
320  adj->rewrite_header.sw_if_index),
321  rewrite);
322  }
323 }
324 
325 /**
326  * adj_nbr_update_rewrite_internal
327  *
328  * Update the adjacency's rewrite string. A NULL string implies the
329  * rewirte is reset (i.e. when ARP/ND etnry is gone).
330  * NB: the adj being updated may be handling traffic in the DP.
331  */
332 void
334  ip_lookup_next_t adj_next_index,
335  u32 this_node,
336  u32 next_node,
337  u8 *rewrite)
338 {
339  ip_adjacency_t *walk_adj;
340  adj_index_t walk_ai;
341  vlib_main_t * vm;
342  u32 old_next;
343  int do_walk;
344 
345  vm = vlib_get_main();
346  old_next = adj->lookup_next_index;
347 
348  walk_ai = adj_get_index(adj);
349  if (VNET_LINK_MPLS == adj->ia_link)
350  {
351  /*
352  * The link type MPLS has no children in the control plane graph, it only
353  * has children in the data-palne graph. The backwalk is up the former.
354  * So we need to walk from its IP cousin.
355  */
356  walk_ai = adj_nbr_find(adj->ia_nh_proto,
358  &adj->sub_type.nbr.next_hop,
359  adj->rewrite_header.sw_if_index);
360  }
361 
362  /*
363  * Don't call the walk re-entrantly
364  */
365  if (ADJ_INDEX_INVALID != walk_ai)
366  {
367  walk_adj = adj_get(walk_ai);
368  if (ADJ_FLAG_SYNC_WALK_ACTIVE & walk_adj->ia_flags)
369  {
370  do_walk = 0;
371  }
372  else
373  {
374  /*
375  * Prevent re-entrant walk of the same adj
376  */
377  walk_adj->ia_flags |= ADJ_FLAG_SYNC_WALK_ACTIVE;
378  do_walk = 1;
379  }
380  }
381  else
382  {
383  do_walk = 0;
384  }
385 
386  /*
387  * lock the adjacencies that are affected by updates this walk will provoke.
388  * Since the aim of the walk is to update children to link to a different
389  * DPO, this adj will no longer be in use and its lock count will drop to 0.
390  * We don't want it to be deleted as part of this endevour.
391  */
392  adj_lock(adj_get_index(adj));
393  adj_lock(walk_ai);
394 
395  /*
396  * Updating a rewrite string is not atomic;
397  * - the rewrite string is too long to write in one instruction
398  * - when swapping from incomplete to complete, we also need to update
399  * the VLIB graph next-index of the adj.
400  * ideally we would only want to suspend forwarding via this adj whilst we
401  * do this, but we do not have that level of granularity - it's suspend all
402  * worker threads or nothing.
403  * The other chioces are:
404  * - to mark the adj down and back walk so child load-balances drop this adj
405  * from the set.
406  * - update the next_node index of this adj to point to error-drop
407  * both of which will mean for MAC change we will drop for this adj
408  * which is not acceptable. However, when the adj changes type (from
409  * complete to incomplete and vice-versa) the child DPOs, which have the
410  * VLIB graph next node index, will be sending packets to the wrong graph
411  * node. So from the options above, updating the next_node of the adj to
412  * be drop will work, but it relies on each graph node v4/v6/mpls, rewrite/
413  * arp/midchain always be valid w.r.t. a mis-match of adj type and node type
414  * (i.e. a rewrite adj in the arp node). This is not enforcable. Getting it
415  * wrong will lead to hard to find bugs since its a race condition. So we
416  * choose the more reliable method of updating the children to use the drop,
417  * then switching adj's type, then updating the children again. Did I mention
418  * that this doesn't happen often...
419  * So we need to distinguish between the two cases:
420  * 1 - mac change
421  * 2 - adj type change
422  */
423  if (do_walk &&
424  old_next != adj_next_index &&
425  ADJ_INDEX_INVALID != walk_ai)
426  {
427  /*
428  * the adj is changing type. we need to fix all children so that they
429  * stack momentarily on a drop, while the adj changes. If we don't do
430  * this the children will send packets to a VLIB graph node that does
431  * not correspond to the adj's type - and it goes downhill from there.
432  */
433  fib_node_back_walk_ctx_t bw_ctx = {
435  /*
436  * force this walk to be synchrous. if we don't and a node in the graph
437  * (a heavily shared path-list) chooses to back-ground the walk (make it
438  * async) then it will pause and we will do the adj update below, before
439  * all the children are updated. not good.
440  */
441  .fnbw_flags = FIB_NODE_BW_FLAG_FORCE_SYNC,
442  };
443 
444  fib_walk_sync(FIB_NODE_TYPE_ADJ, walk_ai, &bw_ctx);
445  }
446 
447  /*
448  * If we are just updating the MAC string of the adj (which we also can't
449  * do atomically), then we need to stop packets switching through the adj.
450  * We can't do that on a per-adj basis, so it's all the packets.
451  * If we are updating the type, and we walked back to the children above,
452  * then this barrier serves to flush the queues/frames.
453  */
455 
456  adj->lookup_next_index = adj_next_index;
457 
458  if (NULL != rewrite)
459  {
460  /*
461  * new rewrite provided.
462  * fill in the adj's rewrite string, and build the VLIB graph arc.
463  */
464  vnet_rewrite_set_data_internal(&adj->rewrite_header,
465  sizeof(adj->rewrite_data),
466  rewrite,
467  vec_len(rewrite));
468  vec_free(rewrite);
469  }
470  else
471  {
472  vnet_rewrite_clear_data_internal(&adj->rewrite_header,
473  sizeof(adj->rewrite_data));
474  }
475  adj->rewrite_header.next_index = vlib_node_add_next(vlib_get_main(),
476  this_node,
477  next_node);
478 
479  /*
480  * done with the rewirte update - let the workers loose.
481  */
483 
484  if (do_walk &&
485  (old_next != adj->lookup_next_index) &&
486  (ADJ_INDEX_INVALID != walk_ai))
487  {
488  /*
489  * backwalk to the children so they can stack on the now updated
490  * adjacency
491  */
492  fib_node_back_walk_ctx_t bw_ctx = {
494  };
495 
496  fib_walk_sync(FIB_NODE_TYPE_ADJ, walk_ai, &bw_ctx);
497  }
498  /*
499  * Prevent re-entrant walk of the same adj
500  */
501  if (do_walk)
502  {
503  walk_adj->ia_flags &= ~ADJ_FLAG_SYNC_WALK_ACTIVE;
504  }
505 
507  adj_unlock(walk_ai);
508 }
509 
510 typedef struct adj_db_count_ctx_t_ {
513 
514 static void
515 adj_db_count (BVT(clib_bihash_kv) * kvp,
516  void *arg)
517 {
518  adj_db_count_ctx_t * ctx = arg;
519  ctx->count++;
520 }
521 
522 u32
524 {
526  .count = 0,
527  };
528  fib_protocol_t proto;
529  u32 sw_if_index = 0;
530 
531  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
532  {
533  vec_foreach_index(sw_if_index, adj_nbr_tables[proto])
534  {
535  if (NULL != adj_nbr_tables[proto][sw_if_index])
536  {
538  adj_nbr_tables[proto][sw_if_index],
539  adj_db_count,
540  &ctx);
541  }
542  }
543  }
544  return (ctx.count);
545 }
546 
547 /**
548  * @brief Context for a walk of the adjacency neighbour DB
549  */
550 typedef struct adj_walk_ctx_t_
551 {
553  void *awc_ctx;
555 
556 static void
557 adj_nbr_walk_cb (BVT(clib_bihash_kv) * kvp,
558  void *arg)
559 {
560  adj_walk_ctx_t *ctx = arg;
561 
562  // FIXME: can't stop early...
563  ctx->awc_cb(kvp->value, ctx->awc_ctx);
564 }
565 
566 void
567 adj_nbr_walk (u32 sw_if_index,
568  fib_protocol_t adj_nh_proto,
569  adj_walk_cb_t cb,
570  void *ctx)
571 {
572  if (!ADJ_NBR_ITF_OK(adj_nh_proto, sw_if_index))
573  return;
574 
575  adj_walk_ctx_t awc = {
576  .awc_ctx = ctx,
577  .awc_cb = cb,
578  };
579 
581  adj_nbr_tables[adj_nh_proto][sw_if_index],
583  &awc);
584 }
585 
586 /**
587  * @brief Walk adjacencies on a link with a given v4 next-hop.
588  * that is visit the adjacencies with different link types.
589  */
590 void
591 adj_nbr_walk_nh4 (u32 sw_if_index,
592  const ip4_address_t *addr,
593  adj_walk_cb_t cb,
594  void *ctx)
595 {
596  if (!ADJ_NBR_ITF_OK(FIB_PROTOCOL_IP4, sw_if_index))
597  return;
598 
599  ip46_address_t nh = {
600  .ip4 = *addr,
601  };
602  vnet_link_t linkt;
603  adj_index_t ai;
604 
605  FOR_EACH_VNET_LINK(linkt)
606  {
607  ai = adj_nbr_find (FIB_PROTOCOL_IP4, linkt, &nh, sw_if_index);
608 
609  if (INDEX_INVALID != ai)
610  cb(ai, ctx);
611  }
612 }
613 
614 /**
615  * @brief Walk adjacencies on a link with a given v6 next-hop.
616  * that is visit the adjacencies with different link types.
617  */
618 void
619 adj_nbr_walk_nh6 (u32 sw_if_index,
620  const ip6_address_t *addr,
621  adj_walk_cb_t cb,
622  void *ctx)
623 {
624  if (!ADJ_NBR_ITF_OK(FIB_PROTOCOL_IP6, sw_if_index))
625  return;
626 
627  ip46_address_t nh = {
628  .ip6 = *addr,
629  };
630  vnet_link_t linkt;
631  adj_index_t ai;
632 
633  FOR_EACH_VNET_LINK(linkt)
634  {
635  ai = adj_nbr_find (FIB_PROTOCOL_IP6, linkt, &nh, sw_if_index);
636 
637  if (INDEX_INVALID != ai)
638  cb(ai, ctx);
639  }
640 }
641 
642 /**
643  * @brief Walk adjacencies on a link with a given next-hop.
644  * that is visit the adjacencies with different link types.
645  */
646 void
647 adj_nbr_walk_nh (u32 sw_if_index,
648  fib_protocol_t adj_nh_proto,
649  const ip46_address_t *nh,
650  adj_walk_cb_t cb,
651  void *ctx)
652 {
653  if (!ADJ_NBR_ITF_OK(adj_nh_proto, sw_if_index))
654  return;
655 
656  vnet_link_t linkt;
657  adj_index_t ai;
658 
659  FOR_EACH_VNET_LINK(linkt)
660  {
661  ai = adj_nbr_find (FIB_PROTOCOL_IP4, linkt, nh, sw_if_index);
662 
663  if (INDEX_INVALID != ai)
664  cb(ai, ctx);
665  }
666 }
667 
668 /**
669  * Flags associated with the interface state walks
670  */
672 {
675 
676 /**
677  * Context for the state change walk of the DB
678  */
680 {
681  /**
682  * Flags on the interface
683  */
686 
687 static adj_walk_rc_t
689  void *arg)
690 {
691  /*
692  * Back walk the graph to inform the forwarding entries
693  * that this interface state has changed. Do this synchronously
694  * since this is the walk that provides convergence
695  */
697  fib_node_back_walk_ctx_t bw_ctx = {
698  .fnbw_reason = ((ctx->flags & ADJ_NBR_INTERFACE_UP) ?
701  /*
702  * the force sync applies only as far as the first fib_entry.
703  * And it's the fib_entry's we need to converge away from
704  * the adjacencies on the now down link
705  */
706  .fnbw_flags = (!(ctx->flags & ADJ_NBR_INTERFACE_UP) ?
709  };
710  ip_adjacency_t *adj;
711 
712  adj = adj_get(ai);
713 
715  fib_walk_sync(FIB_NODE_TYPE_ADJ, ai, &bw_ctx);
717 
718  return (ADJ_WALK_RC_CONTINUE);
719 }
720 
721 /**
722  * @brief Registered function for SW interface state changes
723  */
724 static clib_error_t *
726  u32 sw_if_index,
727  u32 flags)
728 {
729  fib_protocol_t proto;
730 
731  /*
732  * walk each adj on the interface and trigger a walk from that adj
733  */
734  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
735  {
737  .flags = ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
739  0),
740  };
741 
742  adj_nbr_walk(sw_if_index, proto,
744  &ctx);
745  }
746 
747  return (NULL);
748 }
749 
753 
754 /**
755  * @brief Invoked on each SW interface of a HW interface when the
756  * HW interface state changes
757  */
758 static walk_rc_t
760  u32 sw_if_index,
761  void *arg)
762 {
764  fib_protocol_t proto;
765 
766  /*
767  * walk each adj on the interface and trigger a walk from that adj
768  */
769  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
770  {
771  adj_nbr_walk(sw_if_index, proto,
773  ctx);
774  }
775  return (WALK_CONTINUE);
776 }
777 
778 /**
779  * @brief Registered callback for HW interface state changes
780  */
781 static clib_error_t *
783  u32 hw_if_index,
784  u32 flags)
785 {
786  /*
787  * walk SW interface on the HW
788  */
790  .flags = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
792  0),
793  };
794 
795  vnet_hw_interface_walk_sw(vnm, hw_if_index,
797  &ctx);
798 
799  return (NULL);
800 }
801 
805 
806 static adj_walk_rc_t
808  void *arg)
809 {
810  /*
811  * Back walk the graph to inform the forwarding entries
812  * that this interface has been deleted.
813  */
814  fib_node_back_walk_ctx_t bw_ctx = {
816  };
817  ip_adjacency_t *adj;
818 
819  adj = adj_get(ai);
820 
822  fib_walk_sync(FIB_NODE_TYPE_ADJ, ai, &bw_ctx);
824 
825  return (ADJ_WALK_RC_CONTINUE);
826 }
827 
828 /**
829  * adj_nbr_interface_add_del
830  *
831  * Registered to receive interface Add and delete notifications
832  */
833 static clib_error_t *
835  u32 sw_if_index,
836  u32 is_add)
837 {
838  fib_protocol_t proto;
839 
840  if (is_add)
841  {
842  /*
843  * not interested in interface additions. we will not back walk
844  * to resolve paths through newly added interfaces. Why? The control
845  * plane should have the brains to add interfaces first, then routes.
846  * So the case where there are paths with a interface that matches
847  * one just created is the case where the path resolved through an
848  * interface that was deleted, and still has not been removed. The
849  * new interface added, is NO GUARANTEE that the interface being
850  * added now, even though it may have the same sw_if_index, is the
851  * same interface that the path needs. So tough!
852  * If the control plane wants these routes to resolve it needs to
853  * remove and add them again.
854  */
855  return (NULL);
856  }
857 
858  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
859  {
860  adj_nbr_walk(sw_if_index, proto,
862  NULL);
863  }
864 
865  return (NULL);
866 
867 }
868 
870 
871 
872 static adj_walk_rc_t
874  void *arg)
875 {
876  vlib_cli_output (arg, "[@%d] %U",
877  ai,
880 
881  return (ADJ_WALK_RC_CONTINUE);
882 }
883 
884 static clib_error_t *
886  unformat_input_t * input,
887  vlib_cli_command_t * cmd)
888 {
890  u32 sw_if_index = ~0;
891 
893  {
894  if (unformat (input, "%d", &ai))
895  ;
896  else if (unformat (input, "%U",
898  &sw_if_index))
899  ;
900  else
901  break;
902  }
903 
904  if (ADJ_INDEX_INVALID != ai)
905  {
906  vlib_cli_output (vm, "[@%d] %U",
907  ai,
910  }
911  else if (~0 != sw_if_index)
912  {
913  fib_protocol_t proto;
914 
915  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
916  {
917  adj_nbr_walk(sw_if_index, proto,
919  vm);
920  }
921  }
922  else
923  {
924  fib_protocol_t proto;
925 
926  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
927  {
928  vec_foreach_index(sw_if_index, adj_nbr_tables[proto])
929  {
930  adj_nbr_walk(sw_if_index, proto,
932  vm);
933  }
934  }
935  }
936 
937  return 0;
938 }
939 
940 /*?
941  * Show all neighbour adjacencies.
942  * @cliexpar
943  * @cliexstart{sh adj nbr}
944  * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
945  * [@3] mpls via 1.0.0.2 loop0: MPLS_UNICAST: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
946  * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
947  * [@5] mpls via 1.0.0.3 loop0: MPLS_UNICAST: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
948  * @cliexend
949  ?*/
950 VLIB_CLI_COMMAND (ip4_show_fib_command, static) = {
951  .path = "show adj nbr",
952  .short_help = "show adj nbr [<adj_index>] [interface]",
953  .function = adj_nbr_show,
954 };
955 
956 u8*
957 format_adj_nbr_incomplete (u8* s, va_list *ap)
958 {
959  index_t index = va_arg(*ap, index_t);
960  CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
961  vnet_main_t * vnm = vnet_get_main();
962  ip_adjacency_t * adj = adj_get(index);
963 
964  s = format (s, "arp-%U", format_vnet_link, adj->ia_link);
965  s = format (s, ": via %U",
966  format_ip46_address, &adj->sub_type.nbr.next_hop,
968  s = format (s, " %U",
970  vnm, adj->rewrite_header.sw_if_index);
971 
972  return (s);
973 }
974 
975 u8*
976 format_adj_nbr (u8* s, va_list *ap)
977 {
978  index_t index = va_arg(*ap, index_t);
979  CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
980  ip_adjacency_t * adj = adj_get(index);
981 
982  s = format (s, "%U", format_vnet_link, adj->ia_link);
983  s = format (s, " via %U ",
984  format_ip46_address, &adj->sub_type.nbr.next_hop,
986  s = format (s, "%U",
988  &adj->rewrite_header, sizeof (adj->rewrite_data), 0);
989 
990  return (s);
991 }
992 
993 static void
995 {
996  adj_lock(dpo->dpoi_index);
997 }
998 static void
1000 {
1001  adj_unlock(dpo->dpoi_index);
1002 }
1003 
1004 static void
1006 {
1007  fib_show_memory_usage("Adjacency",
1009  pool_len(adj_pool),
1010  sizeof(ip_adjacency_t));
1011 }
1012 
1013 const static dpo_vft_t adj_nbr_dpo_vft = {
1014  .dv_lock = adj_dpo_lock,
1015  .dv_unlock = adj_dpo_unlock,
1016  .dv_format = format_adj_nbr,
1017  .dv_mem_show = adj_mem_show,
1018  .dv_get_urpf = adj_dpo_get_urpf,
1019 };
1020 const static dpo_vft_t adj_nbr_incompl_dpo_vft = {
1021  .dv_lock = adj_dpo_lock,
1022  .dv_unlock = adj_dpo_unlock,
1023  .dv_format = format_adj_nbr_incomplete,
1024  .dv_get_urpf = adj_dpo_get_urpf,
1025 };
1026 
1027 /**
1028  * @brief The per-protocol VLIB graph nodes that are assigned to an adjacency
1029  * object.
1030  *
1031  * this means that these graph nodes are ones from which a nbr is the
1032  * parent object in the DPO-graph.
1033  */
1034 const static char* const nbr_ip4_nodes[] =
1035 {
1036  "ip4-rewrite",
1037  NULL,
1038 };
1039 const static char* const nbr_ip6_nodes[] =
1040 {
1041  "ip6-rewrite",
1042  NULL,
1043 };
1044 const static char* const nbr_mpls_nodes[] =
1045 {
1046  "mpls-output",
1047  NULL,
1048 };
1049 const static char* const nbr_ethernet_nodes[] =
1050 {
1051  "adj-l2-rewrite",
1052  NULL,
1053 };
1054 const static char* const * const nbr_nodes[DPO_PROTO_NUM] =
1055 {
1060 };
1061 
1062 const static char* const nbr_incomplete_ip4_nodes[] =
1063 {
1064  "ip4-arp",
1065  NULL,
1066 };
1067 const static char* const nbr_incomplete_ip6_nodes[] =
1068 {
1069  "ip6-discover-neighbor",
1070  NULL,
1071 };
1072 const static char* const nbr_incomplete_mpls_nodes[] =
1073 {
1074  "mpls-adj-incomplete",
1075  NULL,
1076 };
1077 
1078 const static char* const * const nbr_incomplete_nodes[DPO_PROTO_NUM] =
1079 {
1083 };
1084 
1085 void
1087 {
1089  &adj_nbr_dpo_vft,
1090  nbr_nodes);
1092  &adj_nbr_incompl_dpo_vft,
1093  nbr_incomplete_nodes);
1094 }
#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:647
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:782
#define vec_foreach_index(var, v)
Iterate over vector indices.
adj_flags_t ia_flags
Flags on the adjacency 1-bytes.
Definition: adj.h:209
Context for a walk of the adjacency neighbour DB.
Definition: adj_nbr.c:550
ip_adjacency_t * adj_pool
The global adjacnecy pool.
Definition: adj.c:30
#define CLIB_UNUSED(x)
Definition: clib.h:79
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:976
void adj_lock(adj_index_t adj_index)
Take a reference counting lock on the adjacency.
Definition: adj.c:223
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:1049
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:1067
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:688
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:1037
#define NULL
Definition: clib.h:55
IP unicast adjacency.
Definition: adj.h:175
union ip_adjacency_t_::@45 sub_type
Context for the state change walk of the DB.
Definition: adj_nbr.c:679
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:97
adj_walk_cb_t awc_cb
Definition: adj_nbr.c:552
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:591
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:957
#define VNET_HW_INTERFACE_FLAG_LINK_UP
Definition: interface.h:458
static const char *const nbr_incomplete_mpls_nodes[]
Definition: adj_nbr.c:1072
u32 adj_dpo_get_urpf(const dpo_id_t *dpo)
Definition: adj.c:213
vhost_vring_addr_t addr
Definition: vhost_user.h:116
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:254
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:1110
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:212
vnet_link_t ia_link
link/ether-type 1 bytes
Definition: adj.h:196
enum walk_rc_t_ walk_rc_t
Walk return code.
u8 output_feature_arc_index
Definition: lookup.h:137
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:725
static ip_adjacency_t * adj_get(adj_index_t adj_index)
Get a pointer to an adjacency object from its index.
Definition: adj.h:370
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
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:727
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:1062
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:759
static clib_error_t * adj_nbr_show(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: adj_nbr.c:885
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:1044
static void adj_nbr_walk_cb(BVT(clib_bihash_kv)*kvp, void *arg)
Definition: adj_nbr.c:557
static void adj_dpo_lock(dpo_id_t *dpo)
Definition: adj_nbr.c:994
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:240
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:1039
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:523
#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:1865
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:204
#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
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:834
#define ADJ_NBR_DEFAULT_HASH_MEMORY_SIZE
void adj_nbr_module_init(void)
Module initialisation.
Definition: adj_nbr.c:1086
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:110
#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:157
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:873
Force the walk to be synchronous.
Definition: fib_node.h:166
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:1005
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:567
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:321
Context passed between object during a back walk.
Definition: fib_node.h:200
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:154
VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(adj_nbr_hw_interface_state_change, VNET_ITF_FUNC_PRIORITY_HIGH)
#define VNET_SW_INTERFACE_FLAG_ADMIN_UP
Definition: interface.h:661
adj_nbr_interface_flags_t flags
Flags on the interface.
Definition: adj_nbr.c:684
#define ASSERT(truth)
ip6_main_t ip6_main
Definition: ip6_forward.c:2574
ip_lookup_main_t lookup_main
Definition: ip6.h:161
long ctx[MAX_CONNS]
Definition: main.c:126
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:553
static const char *const nbr_ip4_nodes[]
The per-protocol VLIB graph nodes that are assigned to an adjacency object.
Definition: adj_nbr.c:1034
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:203
#define DPO_PROTO_NUM
Definition: dpo.h:70
index_t dpoi_index
the index of objects of that type
Definition: dpo.h:184
#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:190
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:333
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:48
static void adj_db_count(BVT(clib_bihash_kv)*kvp, void *arg)
Definition: adj_nbr.c:515
static adj_walk_rc_t adj_nbr_interface_delete_one(adj_index_t ai, void *arg)
Definition: adj_nbr.c:807
#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:120
adj_nbr_interface_flags_t_
Flags associated with the interface state walks.
Definition: adj_nbr.c:671
void vlib_worker_thread_barrier_release(vlib_main_t *vm)
Definition: threads.c:1513
ip4_main_t ip4_main
Global ip4 main structure.
Definition: ip4_forward.c:832
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:999
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:62
#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:291
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:681
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:619
static uword pool_elts(void *v)
Number of active elements in a pool.
Definition: pool.h:128