FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
mpls_tunnel.c
Go to the documentation of this file.
1 /*
2  * mpls_tunnel.c: MPLS tunnel interfaces (i.e. for RSVP-TE)
3  *
4  * Copyright (c) 2012 Cisco and/or its affiliates.
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #include <vnet/vnet.h>
19 #include <vnet/pg/pg.h>
20 #include <vnet/mpls/mpls_tunnel.h>
21 #include <vnet/mpls/mpls_types.h>
22 #include <vnet/ip/ip.h>
23 #include <vnet/fib/fib_path_list.h>
24 #include <vnet/adj/adj_midchain.h>
25 #include <vnet/adj/adj_mcast.h>
26 #include <vnet/dpo/replicate_dpo.h>
27 #include <vnet/fib/mpls_fib.h>
28 
29 /**
30  * @brief pool of tunnel instances
31  */
33 
34 /**
35  * @brief Pool of free tunnel SW indices - i.e. recycled indices
36  */
38 
39 /**
40  * @brief DB of SW index to tunnel index
41  */
43 
44 /**
45  * @brief MPLS tunnel flags strings
46  */
48 
49 /**
50  * @brief Get a tunnel object from a SW interface index
51  */
52 static mpls_tunnel_t*
54 {
55  if ((vec_len(mpls_tunnel_db) < sw_if_index) ||
56  (~0 == mpls_tunnel_db[sw_if_index]))
57  return (NULL);
58 
59  return (pool_elt_at_index(mpls_tunnel_pool,
60  mpls_tunnel_db[sw_if_index]));
61 }
62 
63 /**
64  * @brief Build a rewrite string for the MPLS tunnel.
65  */
66 static u8*
68 {
69  /*
70  * passing the adj code a NULL rewirte means 'i don't have one cos
71  * t'other end is unresolved'. That's not the case here. For the mpls
72  * tunnel there are just no bytes of encap to apply in the adj. We'll impose
73  * the label stack once we choose a path. So return a zero length rewrite.
74  */
75  u8 *rewrite = NULL;
76 
77  vec_validate(rewrite, 0);
78  vec_reset_length(rewrite);
79 
80  return (rewrite);
81 }
82 
83 /**
84  * @brief Build a rewrite string for the MPLS tunnel.
85  */
86 static u8*
88  u32 sw_if_index,
89  vnet_link_t link_type,
90  const void *dst_address)
91 {
92  return (mpls_tunnel_build_rewrite_i());
93 }
94 
96 {
98  const mpls_tunnel_t *mt;
101 
104  fib_node_index_t path_index,
105  void *arg)
106 {
108  fib_path_ext_t *path_ext;
109 
110  ctx = arg;
111 
112  /*
113  * if the path is not resolved, don't include it.
114  */
115  if (!fib_path_is_resolved(path_index))
116  {
118  }
119 
120  /*
121  * get the matching path-extension for the path being visited.
122  */
124  path_index);
125 
126  if (NULL != path_ext)
127  {
128  /*
129  * found a matching extension. stack it to obtain the forwarding
130  * info for this path.
131  */
132  ctx->next_hops = fib_path_ext_stack(path_ext,
133  ctx->fct,
134  ctx->fct,
135  ctx->next_hops);
136  }
137  else
138  ASSERT(0);
139  /*
140  * else
141  * There should be a path-extenios associated with each path
142  */
143 
145 }
146 
147 static void
149  vnet_link_t linkt,
151  dpo_id_t *dpo_lb)
152 {
153  dpo_proto_t lb_proto;
154 
155  /*
156  * If the entry has path extensions then we construct a load-balance
157  * by stacking the extensions on the forwarding chains of the paths.
158  * Otherwise we use the load-balance of the path-list
159  */
161  .mt = mt,
162  .next_hops = NULL,
163  .fct = fct,
164  };
165 
166  /*
167  * As an optimisation we allocate the vector of next-hops to be sized
168  * equal to the maximum nuber of paths we will need, which is also the
169  * most likely number we will need, since in most cases the paths are 'up'.
170  */
173 
174  lb_proto = fib_forw_chain_type_to_dpo_proto(fct);
175 
178  &ctx);
179 
180  if (!dpo_id_is_valid(dpo_lb))
181  {
182  /*
183  * first time create
184  */
186  {
187  dpo_set(dpo_lb,
189  lb_proto,
190  replicate_create(0, lb_proto));
191  }
192  else
193  {
194  flow_hash_config_t fhc;
195 
196  switch (linkt)
197  {
198  case VNET_LINK_MPLS:
200  break;
201  case VNET_LINK_IP4:
202  case VNET_LINK_IP6:
203  fhc = IP_FLOW_HASH_DEFAULT;
204  break;
205  default:
206  fhc = 0;
207  break;
208  }
209 
210  dpo_set(dpo_lb,
212  lb_proto,
213  load_balance_create(0, lb_proto, fhc));
214  }
215  }
216 
218  {
219  /*
220  * MPLS multicast
221  */
223  }
224  else
225  {
227  ctx.next_hops,
229  vec_free(ctx.next_hops);
230  }
231 }
232 
233 /**
234  * mpls_tunnel_stack
235  *
236  * 'stack' (resolve the recursion for) the tunnel's midchain adjacency
237  */
238 static void
240 {
241  ip_adjacency_t *adj;
242  mpls_tunnel_t *mt;
243  u32 sw_if_index;
244 
245  adj = adj_get(ai);
246  sw_if_index = adj->rewrite_header.sw_if_index;
247 
248  mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
249 
250  if (NULL == mt)
251  return;
252 
253  /*
254  * while we're stacking the adj, remove the tunnel from the child list
255  * of the path list. this breaks a circular dependency of walk updates
256  * where the create of adjacencies in the children can lead to walks
257  * that get back here.
258  */
260 
262  mt->mt_sibling_index);
263 
264  /*
265  * Construct the DPO (load-balance or replicate) that we can stack
266  * the tunnel's midchain on
267  */
269  mt->mt_hw_if_index) &
271  {
272  dpo_id_t dpo = DPO_INVALID;
273 
275  adj->ia_link,
279  &dpo);
280 
281  adj_nbr_midchain_stack(ai, &dpo);
282  dpo_reset(&dpo);
283  }
284  else
285  {
287  }
288 
291  mt - mpls_tunnel_pool);
292 
294 }
295 
296 /**
297  * @brief Call back when restacking all adjacencies on a MPLS interface
298  */
299 static adj_walk_rc_t
301  void *ctx)
302 {
303  mpls_tunnel_stack(ai);
304 
305  return (ADJ_WALK_RC_CONTINUE);
306 }
307 
308 static void
310 {
311  fib_protocol_t proto;
312 
313  /*
314  * walk all the adjacencies on the MPLS interface and restack them
315  */
316  if (mt->mt_flags & MPLS_TUNNEL_FLAG_L2)
317  {
318  /*
319  * Stack a load-balance that drops, whilst we have no paths
320  */
322  dpo_id_t dpo = DPO_INVALID;
323 
327  &dpo);
328 
331  &mt->mt_l2_lb,
332  &dpo);
333  dpo_reset(&dpo);
334  }
335  else
336  {
337  FOR_EACH_FIB_PROTOCOL(proto)
338  {
340  proto,
342  NULL);
343  }
344  }
345 }
346 
347 static clib_error_t *
349  u32 hw_if_index,
350  u32 flags)
351 {
353  mpls_tunnel_t *mt;
354 
355  hi = vnet_get_hw_interface (vnm, hw_if_index);
356 
358 
359  if (NULL == mt)
360  return (NULL);
361 
363  vnet_hw_interface_set_flags (vnm, hw_if_index,
365  else
366  vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */);
367 
369 
370  return (NULL);
371 }
372 
373 /**
374  * @brief Fixup the adj rewrite post encap. This is a no-op since the
375  * rewrite is a stack of labels.
376  */
377 static void
379  ip_adjacency_t *adj,
380  vlib_buffer_t *b0)
381 {
382  /*
383  * A no-op w.r.t. the header. but reset the 'have we pushed any
384  * MPLS labels onto the packet' flag. That way when we enter the
385  * tunnel we'll get a TTL set to 255
386  */
387  vnet_buffer(b0)->mpls.first = 0;
388 }
389 
390 static void
392  u32 sw_if_index,
393  adj_index_t ai)
394 {
395  ip_adjacency_t *adj;
396 
397  ASSERT(ADJ_INDEX_INVALID != ai);
398 
399  adj = adj_get(ai);
400 
401  switch (adj->lookup_next_index)
402  {
403  case IP_LOOKUP_NEXT_ARP:
408  break;
410  /*
411  * Construct a partial rewrite from the known ethernet mcast dest MAC
412  * There's no MAC fixup, so the last 2 parameters are 0
413  */
417  0, 0);
418  break;
419 
420  case IP_LOOKUP_NEXT_DROP:
421  case IP_LOOKUP_NEXT_PUNT:
427  case IP_LOOKUP_N_NEXT:
428  ASSERT (0);
429  break;
430  }
431 
432  mpls_tunnel_stack(ai);
433 }
434 
435 static u8 *
436 format_mpls_tunnel_name (u8 * s, va_list * args)
437 {
438  u32 dev_instance = va_arg (*args, u32);
439  return format (s, "mpls-tunnel%d", dev_instance);
440 }
441 
442 static u8 *
443 format_mpls_tunnel_device (u8 * s, va_list * args)
444 {
445  u32 dev_instance = va_arg (*args, u32);
446  CLIB_UNUSED (int verbose) = va_arg (*args, int);
447 
448  return (format (s, "MPLS-tunnel: id %d\n", dev_instance));
449 }
450 
451 /**
452  * @brief Packet trace structure
453  */
454 typedef struct mpls_tunnel_trace_t_
455 {
456  /**
457  * Tunnel-id / index in tunnel vector
458  */
461 
462 static u8 *
464  va_list * args)
465 {
466  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
467  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
468  mpls_tunnel_trace_t * t = va_arg (*args, mpls_tunnel_trace_t *);
469 
470  s = format (s, "MPLS: tunnel %d", t->tunnel_id);
471  return s;
472 }
473 
474 /**
475  * @brief TX function. Only called L2. L3 traffic uses the adj-midchains
476  */
477 static uword
479  vlib_node_runtime_t * node,
480  vlib_frame_t * frame)
481 {
482  u32 next_index;
483  u32 * from, * to_next, n_left_from, n_left_to_next;
484  vnet_interface_output_runtime_t * rd = (void *) node->runtime_data;
485  const mpls_tunnel_t *mt;
486 
487  mt = pool_elt_at_index(mpls_tunnel_pool, rd->dev_instance);
488 
489  /* Vector of buffer / pkt indices we're supposed to process */
490  from = vlib_frame_vector_args (frame);
491 
492  /* Number of buffers / pkts */
493  n_left_from = frame->n_vectors;
494 
495  /* Speculatively send the first buffer to the last disposition we used */
496  next_index = node->cached_next_index;
497 
498  while (n_left_from > 0)
499  {
500  /* set up to enqueue to our disposition with index = next_index */
501  vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
502 
503  /*
504  * FIXME DUAL LOOP
505  */
506  while (n_left_from > 0 && n_left_to_next > 0)
507  {
508  vlib_buffer_t * b0;
509  u32 bi0;
510 
511  bi0 = from[0];
512  to_next[0] = bi0;
513  from += 1;
514  to_next += 1;
515  n_left_from -= 1;
516  n_left_to_next -= 1;
517 
518  b0 = vlib_get_buffer(vm, bi0);
519 
520  vnet_buffer(b0)->ip.adj_index[VLIB_TX] = mt->mt_l2_lb.dpoi_index;
521 
523  {
524  mpls_tunnel_trace_t *tr = vlib_add_trace (vm, node,
525  b0, sizeof (*tr));
526  tr->tunnel_id = rd->dev_instance;
527  }
528 
529  vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
530  to_next, n_left_to_next,
531  bi0, mt->mt_l2_lb.dpoi_next_node);
532  }
533 
534  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
535  }
536 
537  return frame->n_vectors;
538 }
539 
540 VNET_DEVICE_CLASS (mpls_tunnel_class) = {
541  .name = "MPLS tunnel device",
542  .format_device_name = format_mpls_tunnel_name,
543  .format_device = format_mpls_tunnel_device,
544  .format_tx_trace = format_mpls_tunnel_tx_trace,
545  .tx_function = mpls_tunnel_tx,
546  .admin_up_down_function = mpls_tunnel_admin_up_down,
547 };
548 
549 VNET_HW_INTERFACE_CLASS (mpls_tunnel_hw_interface_class) = {
550  .name = "MPLS-Tunnel",
551  .update_adjacency = mpls_tunnel_update_adj,
552  .build_rewrite = mpls_tunnel_build_rewrite,
554 };
555 
556 const mpls_tunnel_t *
558 {
559  return (pool_elt_at_index(mpls_tunnel_pool, mti));
560 }
561 
562 /**
563  * @brief Walk all the MPLS tunnels
564  */
565 void
567  void *ctx)
568 {
569  u32 mti;
570 
571  pool_foreach_index(mti, mpls_tunnel_pool,
572  ({
573  cb(mti, ctx);
574  }));
575 }
576 
577 void
579 {
580  mpls_tunnel_t *mt;
581 
582  mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
583 
584  if (NULL == mt)
585  return;
586 
589  mt->mt_sibling_index);
590  dpo_reset(&mt->mt_l2_lb);
591 
593  pool_put(mpls_tunnel_pool, mt);
594  mpls_tunnel_db[sw_if_index] = ~0;
595 }
596 
597 u32
599  u8 is_multicast)
600 {
602  mpls_tunnel_t *mt;
603  vnet_main_t * vnm;
604  u32 mti;
605 
606  vnm = vnet_get_main();
607  pool_get(mpls_tunnel_pool, mt);
608  memset (mt, 0, sizeof (*mt));
609  mti = mt - mpls_tunnel_pool;
613 
614  if (is_multicast)
616  if (l2_only)
618 
619  /*
620  * Create a new, or re=use and old, tunnel HW interface
621  */
623  {
624  mt->mt_hw_if_index =
626  _vec_len (mpls_tunnel_free_hw_if_indices) -= 1;
627  hi = vnet_get_hw_interface (vnm, mt->mt_hw_if_index);
628  hi->hw_instance = mti;
629  hi->dev_instance = mti;
630  }
631  else
632  {
634  vnm,
635  mpls_tunnel_class.index,
636  mti,
637  mpls_tunnel_hw_interface_class.index,
638  mti);
639  hi = vnet_get_hw_interface (vnm, mt->mt_hw_if_index);
640  }
641 
642  /*
643  * Add the new tunnel to the tunnel DB - key:SW if index
644  */
645  mt->mt_sw_if_index = hi->sw_if_index;
647  mpls_tunnel_db[mt->mt_sw_if_index] = mti;
648 
649  return (mt->mt_sw_if_index);
650 }
651 
652 void
654  fib_route_path_t *rpaths)
655 {
656  mpls_tunnel_t *mt;
657  u32 mti;
658 
659  mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
660 
661  if (NULL == mt)
662  return;
663 
664  mti = mt - mpls_tunnel_pool;
665 
666  /*
667  * construct a path-list from the path provided
668  */
670  {
674  mti);
675  }
676  else
677  {
678  fib_node_index_t old_pl_index;
679 
680  old_pl_index = mt->mt_path_list;
681 
682  mt->mt_path_list =
683  fib_path_list_copy_and_path_add(old_pl_index,
685  rpaths);
686 
687  fib_path_list_child_remove(old_pl_index,
688  mt->mt_sibling_index);
691  mti);
692  /*
693  * re-resolve all the path-extensions with the new path-list
694  */
696  }
698  mt->mt_path_list,
700  rpaths);
702 }
703 
704 int
706  fib_route_path_t *rpaths)
707 {
708  mpls_tunnel_t *mt;
709  u32 mti;
710 
711  mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
712 
713  if (NULL == mt)
714  return (0);
715 
716  mti = mt - mpls_tunnel_pool;
717 
718  /*
719  * construct a path-list from the path provided
720  */
722  {
723  /* can't remove a path if we have onoe */
724  return (0);
725  }
726  else
727  {
728  fib_node_index_t old_pl_index;
729 
730  old_pl_index = mt->mt_path_list;
731 
732  mt->mt_path_list =
735  rpaths);
736 
737  fib_path_list_child_remove(old_pl_index,
738  mt->mt_sibling_index);
739 
741  {
742  /* no paths left */
743  return (0);
744  }
745  else
746  {
747  mt->mt_sibling_index =
750  mti);
751  }
752  /*
753  * find the matching path extension and remove it
754  */
757  rpaths);
758 
759  /*
760  * re-resolve all the path-extensions with the new path-list
761  */
763  mt->mt_path_list);
764 
766  }
767 
769 }
770 
771 
772 static clib_error_t *
774  unformat_input_t * input,
775  vlib_cli_command_t * cmd)
776 {
777  unformat_input_t _line_input, * line_input = &_line_input;
778  vnet_main_t * vnm = vnet_get_main();
779  u8 is_del = 0, l2_only = 0, is_multicast =0;
780  fib_route_path_t rpath, *rpaths = NULL;
781  u32 sw_if_index = ~0, payload_proto;
782  clib_error_t *error = NULL;
783 
784  memset(&rpath, 0, sizeof(rpath));
785  payload_proto = DPO_PROTO_MPLS;
786 
787  /* Get a line of input. */
788  if (! unformat_user (input, unformat_line_input, line_input))
789  return 0;
790 
791  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
792  {
793  if (unformat (line_input, "del %U",
795  &sw_if_index))
796  is_del = 1;
797  else if (unformat (line_input, "add %U",
799  &sw_if_index))
800  is_del = 0;
801  else if (unformat (line_input, "add"))
802  is_del = 0;
803  else if (unformat (line_input, "l2-only"))
804  l2_only = 1;
805  else if (unformat (line_input, "multicast"))
806  is_multicast = 1;
807  else if (unformat (line_input, "via %U",
809  &rpath, &payload_proto))
810  vec_add1(rpaths, rpath);
811  else
812  {
813  error = clib_error_return (0, "unknown input '%U'",
814  format_unformat_error, line_input);
815  goto done;
816  }
817  }
818 
819  if (is_del)
820  {
821  if (!vnet_mpls_tunnel_path_remove(sw_if_index, rpaths))
822  {
823  vnet_mpls_tunnel_del(sw_if_index);
824  }
825  }
826  else
827  {
828  if (0 == vec_len(rpath.frp_label_stack))
829  {
830  error = clib_error_return (0, "No Output Labels '%U'",
831  format_unformat_error, line_input);
832  goto done;
833  }
834 
835  if (~0 == sw_if_index)
836  {
837  sw_if_index = vnet_mpls_tunnel_create(l2_only, is_multicast);
838  }
839  vnet_mpls_tunnel_path_add(sw_if_index, rpaths);
840  }
841 
842 done:
843  vec_free(rpaths);
844  unformat_free (line_input);
845 
846  return error;
847 }
848 
849 /*?
850  * This command create a uni-directional MPLS tunnel
851  *
852  * @cliexpar
853  * @cliexstart{create mpls tunnel}
854  * create mpls tunnel via 10.0.0.1 GigEthernet0/8/0 out-label 33 out-label 34
855  * @cliexend
856  ?*/
857 VLIB_CLI_COMMAND (create_mpls_tunnel_command, static) = {
858  .path = "mpls tunnel",
859  .short_help =
860  "mpls tunnel [multicast] [l2-only] via [next-hop-address] [next-hop-interface] [next-hop-table <value>] [weight <value>] [preference <value>] [udp-encap-id <value>] [ip4-lookup-in-table <value>] [ip6-lookup-in-table <value>] [mpls-lookup-in-table <value>] [resolve-via-host] [resolve-via-connected] [rx-ip4 <interface>] [out-labels <value value value>]",
862 };
863 
864 static u8 *
865 format_mpls_tunnel (u8 * s, va_list * args)
866 {
867  mpls_tunnel_t *mt = va_arg (*args, mpls_tunnel_t *);
869 
870  s = format(s, "mpls_tunnel%d: sw_if_index:%d hw_if_index:%d",
871  mt - mpls_tunnel_pool,
872  mt->mt_sw_if_index,
873  mt->mt_hw_if_index);
874  if (MPLS_TUNNEL_FLAG_NONE != mt->mt_flags) {
875  s = format(s, " \n flags:");
877  if ((1<<attr) & mt->mt_flags) {
878  s = format (s, "%s,", mpls_tunnel_attribute_names[attr]);
879  }
880  }
881  }
882  s = format(s, "\n via:\n");
884  s = format(s, "%U", format_fib_path_ext_list, &mt->mt_path_exts);
885  s = format(s, "\n");
886 
887  if (mt->mt_flags & MPLS_TUNNEL_FLAG_L2)
888  {
889  s = format(s, " forwarding: %U\n",
892  s = format(s, " %U\n", format_dpo_id, &mt->mt_l2_lb, 2);
893  }
894 
895  return (s);
896 }
897 
898 static clib_error_t *
900  unformat_input_t * input,
901  vlib_cli_command_t * cmd)
902 {
903  mpls_tunnel_t * mt;
904  u32 mti = ~0;
905 
906  if (pool_elts (mpls_tunnel_pool) == 0)
907  vlib_cli_output (vm, "No MPLS tunnels configured...");
908 
910  {
911  if (unformat (input, "%d", &mti))
912  ;
913  else
914  break;
915  }
916 
917  if (~0 == mti)
918  {
919  pool_foreach (mt, mpls_tunnel_pool,
920  ({
921  vlib_cli_output (vm, "[@%d] %U",
922  mt - mpls_tunnel_pool,
923  format_mpls_tunnel, mt);
924  }));
925  }
926  else
927  {
928  if (pool_is_free_index(mpls_tunnel_pool, mti))
929  return clib_error_return (0, "Not atunnel index %d", mti);
930 
931  mt = pool_elt_at_index(mpls_tunnel_pool, mti);
932 
933  vlib_cli_output (vm, "[@%d] %U",
934  mt - mpls_tunnel_pool,
935  format_mpls_tunnel, mt);
936  }
937 
938  return 0;
939 }
940 
941 /*?
942  * This command to show MPLS tunnels
943  *
944  * @cliexpar
945  * @cliexstart{sh mpls tunnel 2}
946  * [@2] mpls_tunnel2: sw_if_index:5 hw_if_index:5
947  * label-stack:
948  * 3,
949  * via:
950  * index:26 locks:1 proto:ipv4 uPRF-list:26 len:1 itfs:[2, ]
951  * index:26 pl-index:26 ipv4 weight=1 attached-nexthop: oper-flags:resolved,
952  * 10.0.0.2 loop0
953  * [@0]: ipv4 via 10.0.0.2 loop0: IP4: de:ad:00:00:00:00 -> 00:00:11:aa:bb:cc
954  * @cliexend
955  ?*/
956 VLIB_CLI_COMMAND (show_mpls_tunnel_command, static) = {
957  .path = "show mpls tunnel",
958  .function = show_mpls_tunnel_command_fn,
959 };
960 
961 static mpls_tunnel_t *
963 {
965  return ((mpls_tunnel_t*) (((char*)node) -
966  STRUCT_OFFSET_OF(mpls_tunnel_t, mt_node)));
967 }
968 
969 /**
970  * Function definition to backwalk a FIB node
971  */
975 {
977 
979 }
980 
981 /**
982  * Function definition to get a FIB node from its index
983  */
984 static fib_node_t*
986 {
987  mpls_tunnel_t * mt;
988 
989  mt = pool_elt_at_index(mpls_tunnel_pool, index);
990 
991  return (&mt->mt_node);
992 }
993 
994 /**
995  * Function definition to inform the FIB node that its last lock has gone.
996  */
997 static void
999 {
1000  /*
1001  * The MPLS MPLS tunnel is a root of the graph. As such
1002  * it never has children and thus is never locked.
1003  */
1004  ASSERT(0);
1005 }
1006 
1007 /*
1008  * Virtual function table registered by MPLS MPLS tunnels
1009  * for participation in the FIB object graph.
1010  */
1011 const static fib_node_vft_t mpls_vft = {
1013  .fnv_last_lock = mpls_tunnel_last_lock_gone,
1014  .fnv_back_walk = mpls_tunnel_back_walk,
1015 };
1016 
1017 static clib_error_t *
1019 {
1021 
1022  return 0;
1023 }
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:432
int fib_path_is_resolved(fib_node_index_t path_index)
Definition: fib_path.c:2528
void dpo_stack_from_node(u32 child_node_index, 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:485
static u8 * format_mpls_tunnel_tx_trace(u8 *s, va_list *args)
Definition: mpls_tunnel.c:463
vmrglw vmrglh hi
Packet trace structure.
Definition: mpls_tunnel.c:454
#define CLIB_UNUSED(x)
Definition: clib.h:79
clib_error_t * vnet_hw_interface_set_flags(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: interface.c:538
void fib_path_list_child_remove(fib_node_index_t path_list_index, u32 si)
u8 runtime_data[0]
Function dependent node-runtime data.
Definition: node.h:464
A representation of a path as described by a route producer.
Definition: fib_types.h:377
static fib_path_list_walk_rc_t mpls_tunnel_collect_forwarding(fib_node_index_t pl_index, fib_node_index_t path_index, void *arg)
Definition: mpls_tunnel.c:103
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
fib_node_index_t mt_path_list
The path-list over which the tunnel&#39;s destination is reachable.
Definition: mpls_tunnel.h:86
void fib_node_init(fib_node_t *node, fib_node_type_t type)
Definition: fib_node.c:185
uword unformat_fib_route_path(unformat_input_t *input, va_list *args)
Unformat a fib_route_path_t from CLI input.
Definition: fib_types.c:335
static int dpo_id_is_valid(const dpo_id_t *dpoi)
Return true if the DPO object is valid, i.e.
Definition: dpo.h:205
#define FOR_EACH_MPLS_TUNNEL_ATTRIBUTE(_item)
Definition: mpls_tunnel.h:40
Multicast Adjacency.
Definition: adj.h:82
vnet_link_t adj_get_link_type(adj_index_t ai)
Return the link type of the adjacency.
Definition: adj.c:365
#define NULL
Definition: clib.h:55
mpls_tunnel_flags_t mt_flags
Tunnel flags.
Definition: mpls_tunnel.h:65
IP unicast adjacency.
Definition: adj.h:174
An MPLS extension that maintains the path&#39;s outgoing labels,.
Definition: fib_path_ext.h:31
enum fib_node_back_walk_rc_t_ fib_node_back_walk_rc_t
Return code from a back walk function.
A uni-directional MPLS tunnel.
Definition: mpls_tunnel.h:55
static vnet_hw_interface_t * vnet_get_hw_interface(vnet_main_t *vnm, u32 hw_if_index)
dpo_proto_t fib_forw_chain_type_to_dpo_proto(fib_forward_chain_type_t fct)
Convert from a chain type to the DPO proto it will install.
Definition: fib_types.c:311
This packet is to be rewritten and forwarded to the next processing node.
Definition: adj.h:73
static clib_error_t * mpls_tunnel_admin_up_down(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: mpls_tunnel.c:348
struct mpls_tunnel_collect_forwarding_ctx_t_ mpls_tunnel_collect_forwarding_ctx_t
fib_node_t mt_node
The tunnel hooks into the FIB control plane graph.
Definition: mpls_tunnel.h:60
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:518
void fib_path_list_walk(fib_node_index_t path_list_index, fib_path_list_walk_fn_t func, void *ctx)
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:983
#define STRUCT_OFFSET_OF(t, f)
Definition: clib.h:62
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
unformat_function_t unformat_vnet_sw_interface
static uword mpls_tunnel_tx(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
TX function.
Definition: mpls_tunnel.c:478
static u8 * format_mpls_tunnel_name(u8 *s, va_list *args)
Definition: mpls_tunnel.c:436
#define VNET_HW_INTERFACE_FLAG_LINK_UP
Definition: interface.h:394
const mpls_tunnel_t * mpls_tunnel_get(u32 mti)
Definition: mpls_tunnel.c:557
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:225
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)
static u8 * format_mpls_tunnel_device(u8 *s, va_list *args)
Definition: mpls_tunnel.c:443
void(* mpls_tunnel_walk_cb_t)(u32 index, void *ctx)
Callback function invoked while walking MPLS tunnels.
Definition: mpls_tunnel.h:129
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
static fib_node_back_walk_rc_t mpls_tunnel_back_walk(fib_node_t *node, fib_node_back_walk_ctx_t *ctx)
Function definition to backwalk a FIB node.
Definition: mpls_tunnel.c:973
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
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
vnet_link_t ia_link
link/ether-type 1 bytes
Definition: adj.h:195
index_t load_balance_create(u32 n_buckets, dpo_proto_t lb_proto, flow_hash_config_t fhc)
Definition: load_balance.c:194
Adjacency to punt this packet.
Definition: adj.h:55
void adj_nbr_midchain_update_rewrite(adj_index_t adj_index, adj_midchain_fixup_t fixup, adj_flags_t flags, u8 *rewrite)
adj_nbr_midchain_update_rewrite
Definition: adj_midchain.c:504
static ip_adjacency_t * adj_get(adj_index_t adj_index)
Get a pointer to an adjacency object from its index.
Definition: adj.h:365
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:438
mpls_label_t * frp_label_stack
The outgoing MPLS label Stack.
Definition: fib_types.h:432
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:111
static u32 * mpls_tunnel_db
DB of SW index to tunnel index.
Definition: mpls_tunnel.c:42
enum adj_walk_rc_t_ adj_walk_rc_t
return codes from a adjacency walker callback function
VNET_HW_INTERFACE_CLASS(mpls_tunnel_hw_interface_class)
#define clib_error_return(e, args...)
Definition: error.h:99
fib_path_ext_list_t mt_path_exts
A vector of path extensions o hold the label stack for each path.
Definition: mpls_tunnel.h:96
void load_balance_multipath_update(const dpo_id_t *dpo, const load_balance_path_t *raw_nhs, load_balance_flags_t flags)
Definition: load_balance.c:494
Contribute an object that is to be used to forward Ethernet packets.
Definition: fib_types.h:120
enum dpo_proto_t_ dpo_proto_t
Data path protocol.
static u8 * format_mpls_tunnel(u8 *s, va_list *args)
Definition: mpls_tunnel.c:865
u32 vnet_register_interface(vnet_main_t *vnm, u32 dev_class_index, u32 dev_instance, u32 hw_class_index, u32 hw_instance)
Definition: interface.c:689
#define MPLS_TUNNEL_ATTRIBUTES
Definition: mpls_tunnel.h:36
fib_path_ext_t * fib_path_ext_list_find_by_path_index(const fib_path_ext_list_t *list, fib_node_index_t path_index)
Definition: fib_path_ext.c:292
static void mpls_tunnel_fixup(vlib_main_t *vm, ip_adjacency_t *adj, vlib_buffer_t *b0)
Fixup the adj rewrite post encap.
Definition: mpls_tunnel.c:378
unformat_function_t unformat_line_input
Definition: format.h:281
fib_node_index_t fib_path_list_copy_and_path_add(fib_node_index_t orig_path_list_index, fib_path_list_flags_t flags, const fib_route_path_t *rpaths)
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:166
Contribute an object that is to be used to forward end-of-stack MPLS packets.
Definition: fib_types.h:108
void vnet_mpls_tunnel_del(u32 sw_if_index)
Delete an MPLS tunnel.
Definition: mpls_tunnel.c:578
#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
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:459
fib_node_index_t fib_path_list_create(fib_path_list_flags_t flags, const fib_route_path_t *rpaths)
static const char * mpls_tunnel_attribute_names[]
MPLS tunnel flags strings.
Definition: mpls_tunnel.c:47
static uword vnet_hw_interface_get_flags(vnet_main_t *vnm, u32 hw_if_index)
struct _unformat_input_t unformat_input_t
load-balancing over a choice of [un]equal cost paths
Definition: dpo.h:102
#define MPLS_FLOW_HASH_DEFAULT
There are no options for controlling the MPLS flow hash.
Definition: mpls_fib.h:39
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:271
#define FOR_EACH_FIB_PROTOCOL(_item)
Definition: fib_types.h:64
static mpls_tunnel_t * mpls_tunnel_get_from_sw_if_index(u32 sw_if_index)
Get a tunnel object from a SW interface index.
Definition: mpls_tunnel.c:53
#define PREDICT_FALSE(x)
Definition: clib.h:105
This packet matches an "interface route" and packets need to be passed to ARP to find rewrite string ...
Definition: adj.h:68
void fib_path_list_lock(fib_node_index_t path_list_index)
u32 mt_sibling_index
sibling index on the path-list so notifications are received.
Definition: mpls_tunnel.h:91
fib_node_type_t fn_type
The node&#39;s type.
Definition: fib_node.h:290
#define vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, bi0, next0)
Finish enqueueing one buffer forward in the graph.
Definition: buffer_node.h:218
An node in the FIB graph.
Definition: fib_node.h:286
#define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left)
Get pointer to next frame vector data by (vlib_node_runtime_t, next_index).
Definition: node_funcs.h:364
static adj_walk_rc_t mpls_adj_walk_cb(adj_index_t ai, void *ctx)
Call back when restacking all adjacencies on a MPLS interface.
Definition: mpls_tunnel.c:300
fib_node_index_t fib_path_list_copy_and_path_remove(fib_node_index_t orig_path_list_index, fib_path_list_flags_t flags, const fib_route_path_t *rpaths)
void replicate_multipath_update(const dpo_id_t *dpo, load_balance_path_t *next_hops)
This packet matches an "incomplete adjacency" and packets need to be passed to ARP to find rewrite st...
Definition: adj.h:63
u32 tunnel_id
Tunnel-id / index in tunnel vector.
Definition: mpls_tunnel.c:459
Adjacency to drop this packet.
Definition: adj.h:53
#define UNFORMAT_END_OF_INPUT
Definition: format.h:143
u16 n_vectors
Definition: node.h:344
static u8 * mpls_tunnel_build_rewrite_i(void)
Build a rewrite string for the MPLS tunnel.
Definition: mpls_tunnel.c:67
vlib_main_t * vm
Definition: buffer.c:283
VNET_DEVICE_CLASS(mpls_tunnel_class)
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:336
Multicast Midchain Adjacency.
Definition: adj.h:86
static void mpls_tunnel_restack(mpls_tunnel_t *mt)
Definition: mpls_tunnel.c:309
#define VLIB_BUFFER_IS_TRACED
Definition: buffer.h:93
fib_node_get_t fnv_get
Definition: fib_node.h:274
void fib_path_ext_list_remove(fib_path_ext_list_t *list, fib_path_ext_type_t ext_type, const fib_route_path_t *rpath)
Definition: fib_path_ext.c:391
u32 fib_path_list_get_n_paths(fib_node_index_t path_list_index)
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:29
void mpls_tunnel_walk(mpls_tunnel_walk_cb_t cb, void *ctx)
Walk all the MPLS tunnels.
Definition: mpls_tunnel.c:566
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:268
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
void vlib_put_next_frame(vlib_main_t *vm, vlib_node_runtime_t *r, u32 next_index, u32 n_vectors_left)
Release pointer to next frame vector data.
Definition: main.c:454
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:182
void fib_path_list_unlock(fib_node_index_t path_list_index)
index_t replicate_create(u32 n_buckets, dpo_proto_t rep_proto)
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
static clib_error_t * mpls_tunnel_init(vlib_main_t *vm)
Definition: mpls_tunnel.c:1018
Context passed between object during a back walk.
Definition: fib_node.h:199
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:154
static mpls_tunnel_t * mpls_tunnel_pool
pool of tunnel instances
Definition: mpls_tunnel.c:32
This packets follow a mid-chain adjacency.
Definition: adj.h:76
u16 cached_next_index
Next frame index that vector arguments were last enqueued to last time this node ran.
Definition: node.h:456
#define VNET_SW_INTERFACE_FLAG_ADMIN_UP
Definition: interface.h:576
u32 vnet_mpls_tunnel_create(u8 l2_only, u8 is_multicast)
Create a new MPLS tunnel.
Definition: mpls_tunnel.c:598
#define ASSERT(truth)
int vnet_mpls_tunnel_path_remove(u32 sw_if_index, fib_route_path_t *rpaths)
remove a path from a tunnel.
Definition: mpls_tunnel.c:705
void adj_nbr_midchain_stack(adj_index_t adj_index, const dpo_id_t *next)
adj_nbr_midchain_stack
Definition: adj_midchain.c:565
unsigned int u32
Definition: types.h:88
long ctx[MAX_CONNS]
Definition: main.c:122
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
enum fib_forward_chain_type_t_ fib_forward_chain_type_t
FIB output chain type.
u32 mt_hw_if_index
The HW interface index of the tunnel interfaces.
Definition: mpls_tunnel.h:76
u8 * format_fib_forw_chain_type(u8 *s, va_list *args)
Definition: fib_types.c:46
#define IP_FLOW_HASH_DEFAULT
Default: 5-tuple without the "reverse" bit.
Definition: lookup.h:69
void adj_nbr_midchain_unstack(adj_index_t adj_index)
adj_nbr_midchain_unstack
Definition: adj_midchain.c:543
u8 * format_dpo_id(u8 *s, va_list *args)
Format a DPO_id_t oject
Definition: dpo.c:146
u32 flow_hash_config_t
A flow hash configuration is a mask of the flow hash options.
Definition: lookup.h:82
static u8 * mpls_tunnel_build_rewrite(vnet_main_t *vnm, u32 sw_if_index, vnet_link_t link_type, const void *dst_address)
Build a rewrite string for the MPLS tunnel.
Definition: mpls_tunnel.c:87
u64 uword
Definition: types.h:112
static void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace_funcs.h:55
This packets needs to go to ICMP error.
Definition: adj.h:79
This packet is for one of our own IP addresses.
Definition: adj.h:58
Definition: defs.h:47
enum fib_path_list_walk_rc_t_ fib_path_list_walk_rc_t
return code to control pat-hlist walk
void vnet_mpls_tunnel_path_add(u32 sw_if_index, fib_route_path_t *rpaths)
Add a path to an MPLS tunnel.
Definition: mpls_tunnel.c:653
index_t dpoi_index
the index of objects of that type
Definition: dpo.h:182
#define FIB_NODE_INDEX_INVALID
Definition: fib_types.h:30
void fib_path_ext_list_resolve(fib_path_ext_list_t *list, fib_node_index_t path_list_index)
Definition: fib_path_ext.c:379
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
static u32 * mpls_tunnel_free_hw_if_indices
Pool of free tunnel SW indices - i.e.
Definition: mpls_tunnel.c:37
unsigned char u8
Definition: types.h:56
ip_lookup_next_t lookup_next_index
Next hop after ip4-lookup.
Definition: adj.h:189
static clib_error_t * vnet_create_mpls_tunnel_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: mpls_tunnel.c:773
static void mpls_tunnel_stack(adj_index_t ai)
mpls_tunnel_stack
Definition: mpls_tunnel.c:239
u8 * fib_path_list_format(fib_node_index_t path_list_index, u8 *s)
static void unformat_free(unformat_input_t *i)
Definition: format.h:161
struct mpls_tunnel_trace_t_ mpls_tunnel_trace_t
Packet trace structure.
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:267
#define DPO_INVALID
An initialiser for DPOs declared on the stack.
Definition: dpo.h:193
a point 2 point interface
Definition: interface.h:289
static void mpls_tunnel_last_lock_gone(fib_node_t *node)
Function definition to inform the FIB node that its last lock has gone.
Definition: mpls_tunnel.c:998
One path from an [EU]CMP set that the client wants to add to a load-balance object.
Definition: load_balance.h:62
A FIB graph nodes virtual function table.
Definition: fib_node.h:273
#define vnet_buffer(b)
Definition: buffer.h:326
load_balance_path_t * next_hops
Definition: mpls_tunnel.c:97
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
void dpo_reset(dpo_id_t *dpo)
reset a DPO ID The DPO will be unlocked.
Definition: dpo.c:228
A path extension is a per-entry addition to the forwarding information when packets are sent for that...
Definition: fib_path_ext.h:72
u8 * format_fib_path_ext_list(u8 *s, va_list *args)
Definition: fib_path_ext.c:424
u32 mt_sw_if_index
The SW interface index of the tunnel interfaces.
Definition: mpls_tunnel.h:81
void adj_mcast_midchain_update_rewrite(adj_index_t adj_index, adj_midchain_fixup_t fixup, adj_flags_t flags, u8 *rewrite, u8 offset, u32 mask)
adj_mcast_midchain_update_rewrite
Definition: adj_mcast.c:140
dpo_id_t mt_l2_lb
If the tunnel is an L2 tunnel, this is the link type ETHERNET load-balance.
Definition: mpls_tunnel.h:71
Contribute an object that is to be used to forward non-end-of-stack MPLS packets. ...
Definition: fib_types.h:97
static fib_node_t * mpls_tunnel_fib_node_get(fib_node_index_t index)
Function definition to get a FIB node from its index.
Definition: mpls_tunnel.c:985
u16 dpoi_next_node
The next VLIB node to follow.
Definition: dpo.h:178
enum mpls_tunnel_attribute_t_ mpls_tunnel_attribute_t
#define pool_foreach_index(i, v, body)
Iterate pool by index.
Definition: pool.h:480
u32 flags
Definition: vhost-user.h:77
#define vec_validate_init_empty(V, I, INIT)
Make sure vector is long enough for given index and initialize empty space (no header, unspecified alignment)
Definition: vec.h:481
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:75
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:680
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:57
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:169
static clib_error_t * show_mpls_tunnel_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: mpls_tunnel.c:899
fib_forward_chain_type_t fct
Definition: mpls_tunnel.c:99
fib_path_ext_t * fib_path_ext_list_insert(fib_path_ext_list_t *list, fib_node_index_t path_list_index, fib_path_ext_type_t ext_type, const fib_route_path_t *rpath)
Definition: fib_path_ext.c:335
static void mpls_tunnel_mk_lb(mpls_tunnel_t *mt, vnet_link_t linkt, fib_forward_chain_type_t fct, dpo_id_t *dpo_lb)
Definition: mpls_tunnel.c:148
load_balance_path_t * fib_path_ext_stack(fib_path_ext_t *path_ext, fib_forward_chain_type_t child_fct, fib_forward_chain_type_t imp_null_fct, load_balance_path_t *nhs)
Definition: fib_path_ext.c:133
static void mpls_tunnel_update_adj(vnet_main_t *vnm, u32 sw_if_index, adj_index_t ai)
Definition: mpls_tunnel.c:391
static mpls_tunnel_t * mpls_tunnel_from_fib_node(fib_node_t *node)
Definition: mpls_tunnel.c:962
static uword pool_elts(void *v)
Number of active elements in a pool.
Definition: pool.h:128