FD.io VPP  v18.07-34-g55fbdb9
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  /*
127  * we don't want IP TTL decrements for packets hitting the MPLS labels
128  * we stack on, since the IP TTL decrement is done by the adj
129  */
131 
132  /*
133  * found a matching extension. stack it to obtain the forwarding
134  * info for this path.
135  */
136  ctx->next_hops = fib_path_ext_stack(path_ext,
137  ctx->fct,
138  ctx->fct,
139  ctx->next_hops);
140 
142 }
143 
144 static void
146  vnet_link_t linkt,
148  dpo_id_t *dpo_lb)
149 {
150  dpo_proto_t lb_proto;
151 
152  /*
153  * If the entry has path extensions then we construct a load-balance
154  * by stacking the extensions on the forwarding chains of the paths.
155  * Otherwise we use the load-balance of the path-list
156  */
158  .mt = mt,
159  .next_hops = NULL,
160  .fct = fct,
161  };
162 
163  /*
164  * As an optimisation we allocate the vector of next-hops to be sized
165  * equal to the maximum nuber of paths we will need, which is also the
166  * most likely number we will need, since in most cases the paths are 'up'.
167  */
170 
171  lb_proto = fib_forw_chain_type_to_dpo_proto(fct);
172 
175  &ctx);
176 
177  if (!dpo_id_is_valid(dpo_lb))
178  {
179  /*
180  * first time create
181  */
183  {
184  dpo_set(dpo_lb,
186  lb_proto,
187  replicate_create(0, lb_proto));
188  }
189  else
190  {
191  flow_hash_config_t fhc;
192 
193  switch (linkt)
194  {
195  case VNET_LINK_MPLS:
197  break;
198  case VNET_LINK_IP4:
199  case VNET_LINK_IP6:
200  fhc = IP_FLOW_HASH_DEFAULT;
201  break;
202  default:
203  fhc = 0;
204  break;
205  }
206 
207  dpo_set(dpo_lb,
209  lb_proto,
210  load_balance_create(0, lb_proto, fhc));
211  }
212  }
213 
215  {
216  /*
217  * MPLS multicast
218  */
220  }
221  else
222  {
224  ctx.next_hops,
226  vec_free(ctx.next_hops);
227  }
228 }
229 
230 /**
231  * mpls_tunnel_stack
232  *
233  * 'stack' (resolve the recursion for) the tunnel's midchain adjacency
234  */
235 static void
237 {
238  ip_adjacency_t *adj;
239  mpls_tunnel_t *mt;
240  u32 sw_if_index;
241 
242  adj = adj_get(ai);
243  sw_if_index = adj->rewrite_header.sw_if_index;
244 
245  mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
246 
247  if (NULL == mt)
248  return;
249 
250  /*
251  * while we're stacking the adj, remove the tunnel from the child list
252  * of the path list. this breaks a circular dependency of walk updates
253  * where the create of adjacencies in the children can lead to walks
254  * that get back here.
255  */
257 
259  mt->mt_sibling_index);
260 
261  /*
262  * Construct the DPO (load-balance or replicate) that we can stack
263  * the tunnel's midchain on
264  */
266  mt->mt_hw_if_index) &
268  {
269  dpo_id_t dpo = DPO_INVALID;
270 
272  adj->ia_link,
274  adj_get_link_type(ai)),
275  &dpo);
276 
277  adj_nbr_midchain_stack(ai, &dpo);
278  dpo_reset(&dpo);
279  }
280  else
281  {
283  }
284 
287  mt - mpls_tunnel_pool);
288 
290 }
291 
292 /**
293  * @brief Call back when restacking all adjacencies on a MPLS interface
294  */
295 static adj_walk_rc_t
297  void *ctx)
298 {
299  mpls_tunnel_stack(ai);
300 
301  return (ADJ_WALK_RC_CONTINUE);
302 }
303 
304 static void
306 {
307  fib_protocol_t proto;
308 
309  /*
310  * walk all the adjacencies on the MPLS interface and restack them
311  */
312  if (mt->mt_flags & MPLS_TUNNEL_FLAG_L2)
313  {
314  /*
315  * Stack a load-balance that drops, whilst we have no paths
316  */
318  dpo_id_t dpo = DPO_INVALID;
319 
323  &dpo);
324 
327  &mt->mt_l2_lb,
328  &dpo);
329  dpo_reset(&dpo);
330  }
331  else
332  {
333  FOR_EACH_FIB_PROTOCOL(proto)
334  {
336  proto,
338  NULL);
339  }
340  }
341 }
342 
343 static clib_error_t *
345  u32 hw_if_index,
346  u32 flags)
347 {
349  mpls_tunnel_t *mt;
350 
351  hi = vnet_get_hw_interface (vnm, hw_if_index);
352 
354 
355  if (NULL == mt)
356  return (NULL);
357 
359  vnet_hw_interface_set_flags (vnm, hw_if_index,
361  else
362  vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */);
363 
365 
366  return (NULL);
367 }
368 
369 /**
370  * @brief Fixup the adj rewrite post encap. This is a no-op since the
371  * rewrite is a stack of labels.
372  */
373 static void
375  ip_adjacency_t *adj,
376  vlib_buffer_t *b0,
377  const void*data)
378 {
379  /*
380  * A no-op w.r.t. the header. but reset the 'have we pushed any
381  * MPLS labels onto the packet' flag. That way when we enter the
382  * tunnel we'll get a TTL set to 255
383  */
384  vnet_buffer(b0)->mpls.first = 0;
385 }
386 
387 static void
389  u32 sw_if_index,
390  adj_index_t ai)
391 {
392  ip_adjacency_t *adj;
393 
394  ASSERT(ADJ_INDEX_INVALID != ai);
395 
396  adj = adj_get(ai);
397 
398  switch (adj->lookup_next_index)
399  {
400  case IP_LOOKUP_NEXT_ARP:
403  NULL,
406  break;
408  /*
409  * Construct a partial rewrite from the known ethernet mcast dest MAC
410  * There's no MAC fixup, so the last 2 parameters are 0
411  */
413  NULL,
416  0, 0);
417  break;
418 
419  case IP_LOOKUP_NEXT_DROP:
420  case IP_LOOKUP_NEXT_PUNT:
426  case IP_LOOKUP_N_NEXT:
427  ASSERT (0);
428  break;
429  }
430 
431  mpls_tunnel_stack(ai);
432 }
433 
434 static u8 *
435 format_mpls_tunnel_name (u8 * s, va_list * args)
436 {
437  u32 dev_instance = va_arg (*args, u32);
438  return format (s, "mpls-tunnel%d", dev_instance);
439 }
440 
441 static u8 *
442 format_mpls_tunnel_device (u8 * s, va_list * args)
443 {
444  u32 dev_instance = va_arg (*args, u32);
445  CLIB_UNUSED (int verbose) = va_arg (*args, int);
446 
447  return (format (s, "MPLS-tunnel: id %d\n", dev_instance));
448 }
449 
450 /**
451  * @brief Packet trace structure
452  */
453 typedef struct mpls_tunnel_trace_t_
454 {
455  /**
456  * Tunnel-id / index in tunnel vector
457  */
460 
461 static u8 *
463  va_list * args)
464 {
465  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
466  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
467  mpls_tunnel_trace_t * t = va_arg (*args, mpls_tunnel_trace_t *);
468 
469  s = format (s, "MPLS: tunnel %d", t->tunnel_id);
470  return s;
471 }
472 
473 /**
474  * @brief TX function. Only called L2. L3 traffic uses the adj-midchains
475  */
476 static uword
478  vlib_node_runtime_t * node,
479  vlib_frame_t * frame)
480 {
481  u32 next_index;
482  u32 * from, * to_next, n_left_from, n_left_to_next;
483  vnet_interface_output_runtime_t * rd = (void *) node->runtime_data;
484  const mpls_tunnel_t *mt;
485 
486  mt = pool_elt_at_index(mpls_tunnel_pool, rd->dev_instance);
487 
488  /* Vector of buffer / pkt indices we're supposed to process */
489  from = vlib_frame_vector_args (frame);
490 
491  /* Number of buffers / pkts */
492  n_left_from = frame->n_vectors;
493 
494  /* Speculatively send the first buffer to the last disposition we used */
495  next_index = node->cached_next_index;
496 
497  while (n_left_from > 0)
498  {
499  /* set up to enqueue to our disposition with index = next_index */
500  vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
501 
502  /*
503  * FIXME DUAL LOOP
504  */
505  while (n_left_from > 0 && n_left_to_next > 0)
506  {
507  vlib_buffer_t * b0;
508  u32 bi0;
509 
510  bi0 = from[0];
511  to_next[0] = bi0;
512  from += 1;
513  to_next += 1;
514  n_left_from -= 1;
515  n_left_to_next -= 1;
516 
517  b0 = vlib_get_buffer(vm, bi0);
518 
519  vnet_buffer(b0)->ip.adj_index[VLIB_TX] = mt->mt_l2_lb.dpoi_index;
520  /* since we are coming out of the L2 world, where the vlib_buffer
521  * union is used for other things, make sure it is clean for
522  * MPLS from now on.
523  */
524  vnet_buffer(b0)->mpls.first = 0;
525 
526  if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
527  {
528  mpls_tunnel_trace_t *tr = vlib_add_trace (vm, node,
529  b0, sizeof (*tr));
530  tr->tunnel_id = rd->dev_instance;
531  }
532 
533  vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
534  to_next, n_left_to_next,
535  bi0, mt->mt_l2_lb.dpoi_next_node);
536  }
537 
538  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
539  }
540 
541  return frame->n_vectors;
542 }
543 
544 VNET_DEVICE_CLASS (mpls_tunnel_class) = {
545  .name = "MPLS tunnel device",
546  .format_device_name = format_mpls_tunnel_name,
547  .format_device = format_mpls_tunnel_device,
548  .format_tx_trace = format_mpls_tunnel_tx_trace,
549  .tx_function = mpls_tunnel_tx,
550  .admin_up_down_function = mpls_tunnel_admin_up_down,
551 };
552 
553 VNET_HW_INTERFACE_CLASS (mpls_tunnel_hw_interface_class) = {
554  .name = "MPLS-Tunnel",
555  .update_adjacency = mpls_tunnel_update_adj,
556  .build_rewrite = mpls_tunnel_build_rewrite,
558 };
559 
560 const mpls_tunnel_t *
562 {
563  return (pool_elt_at_index(mpls_tunnel_pool, mti));
564 }
565 
566 /**
567  * @brief Walk all the MPLS tunnels
568  */
569 void
571  void *ctx)
572 {
573  u32 mti;
574 
575  pool_foreach_index(mti, mpls_tunnel_pool,
576  ({
577  cb(mti, ctx);
578  }));
579 }
580 
581 void
583 {
584  mpls_tunnel_t *mt;
585 
586  mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
587 
588  if (NULL == mt)
589  return;
590 
593  mt->mt_sibling_index);
594  dpo_reset(&mt->mt_l2_lb);
595 
597  pool_put(mpls_tunnel_pool, mt);
598  mpls_tunnel_db[sw_if_index] = ~0;
599 }
600 
601 u32
603  u8 is_multicast)
604 {
606  mpls_tunnel_t *mt;
607  vnet_main_t * vnm;
608  u32 mti;
609 
610  vnm = vnet_get_main();
611  pool_get(mpls_tunnel_pool, mt);
612  memset (mt, 0, sizeof (*mt));
613  mti = mt - mpls_tunnel_pool;
617 
618  if (is_multicast)
620  if (l2_only)
622 
623  /*
624  * Create a new, or re=use and old, tunnel HW interface
625  */
627  {
628  mt->mt_hw_if_index =
630  _vec_len (mpls_tunnel_free_hw_if_indices) -= 1;
631  hi = vnet_get_hw_interface (vnm, mt->mt_hw_if_index);
632  hi->hw_instance = mti;
633  hi->dev_instance = mti;
634  }
635  else
636  {
638  vnm,
639  mpls_tunnel_class.index,
640  mti,
641  mpls_tunnel_hw_interface_class.index,
642  mti);
643  hi = vnet_get_hw_interface (vnm, mt->mt_hw_if_index);
644  }
645 
646  /* Standard default MPLS tunnel MTU. */
647  vnet_sw_interface_set_mtu (vnm, hi->sw_if_index, 9000);
648 
649  /*
650  * Add the new tunnel to the tunnel DB - key:SW if index
651  */
652  mt->mt_sw_if_index = hi->sw_if_index;
654  mpls_tunnel_db[mt->mt_sw_if_index] = mti;
655 
656  return (mt->mt_sw_if_index);
657 }
658 
659 void
661  fib_route_path_t *rpaths)
662 {
663  mpls_tunnel_t *mt;
664  u32 mti;
665 
666  mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
667 
668  if (NULL == mt)
669  return;
670 
671  mti = mt - mpls_tunnel_pool;
672 
673  /*
674  * construct a path-list from the path provided
675  */
677  {
681  mti);
682  }
683  else
684  {
685  fib_node_index_t old_pl_index;
686 
687  old_pl_index = mt->mt_path_list;
688 
689  mt->mt_path_list =
690  fib_path_list_copy_and_path_add(old_pl_index,
692  rpaths);
693 
694  fib_path_list_child_remove(old_pl_index,
695  mt->mt_sibling_index);
698  mti);
699  /*
700  * re-resolve all the path-extensions with the new path-list
701  */
703  }
705  mt->mt_path_list,
707  rpaths);
709 }
710 
711 int
713  fib_route_path_t *rpaths)
714 {
715  mpls_tunnel_t *mt;
716  u32 mti;
717 
718  mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
719 
720  if (NULL == mt)
721  return (0);
722 
723  mti = mt - mpls_tunnel_pool;
724 
725  /*
726  * construct a path-list from the path provided
727  */
729  {
730  /* can't remove a path if we have onoe */
731  return (0);
732  }
733  else
734  {
735  fib_node_index_t old_pl_index;
736 
737  old_pl_index = mt->mt_path_list;
738 
739  mt->mt_path_list =
742  rpaths);
743 
744  fib_path_list_child_remove(old_pl_index,
745  mt->mt_sibling_index);
746 
748  {
749  /* no paths left */
750  return (0);
751  }
752  else
753  {
754  mt->mt_sibling_index =
757  mti);
758  }
759  /*
760  * find the matching path extension and remove it
761  */
764  rpaths);
765 
766  /*
767  * re-resolve all the path-extensions with the new path-list
768  */
770  mt->mt_path_list);
771 
773  }
774 
776 }
777 
778 
779 static clib_error_t *
781  unformat_input_t * input,
782  vlib_cli_command_t * cmd)
783 {
784  unformat_input_t _line_input, * line_input = &_line_input;
785  vnet_main_t * vnm = vnet_get_main();
786  u8 is_del = 0, l2_only = 0, is_multicast =0;
787  fib_route_path_t rpath, *rpaths = NULL;
788  u32 sw_if_index = ~0, payload_proto;
789  clib_error_t *error = NULL;
790 
791  memset(&rpath, 0, sizeof(rpath));
792  payload_proto = DPO_PROTO_MPLS;
793 
794  /* Get a line of input. */
795  if (! unformat_user (input, unformat_line_input, line_input))
796  return 0;
797 
798  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
799  {
800  if (unformat (line_input, "del %U",
802  &sw_if_index))
803  is_del = 1;
804  else if (unformat (line_input, "add %U",
806  &sw_if_index))
807  is_del = 0;
808  else if (unformat (line_input, "add"))
809  is_del = 0;
810  else if (unformat (line_input, "l2-only"))
811  l2_only = 1;
812  else if (unformat (line_input, "multicast"))
813  is_multicast = 1;
814  else if (unformat (line_input, "via %U",
816  &rpath, &payload_proto))
817  vec_add1(rpaths, rpath);
818  else
819  {
820  error = clib_error_return (0, "unknown input '%U'",
821  format_unformat_error, line_input);
822  goto done;
823  }
824  }
825 
826  if (is_del)
827  {
828  if (!vnet_mpls_tunnel_path_remove(sw_if_index, rpaths))
829  {
830  vnet_mpls_tunnel_del(sw_if_index);
831  }
832  }
833  else
834  {
835  if (0 == vec_len(rpath.frp_label_stack))
836  {
837  error = clib_error_return (0, "No Output Labels '%U'",
838  format_unformat_error, line_input);
839  goto done;
840  }
841 
842  if (~0 == sw_if_index)
843  {
844  sw_if_index = vnet_mpls_tunnel_create(l2_only, is_multicast);
845  }
846  vnet_mpls_tunnel_path_add(sw_if_index, rpaths);
847  }
848 
849 done:
850  vec_free(rpaths);
851  unformat_free (line_input);
852 
853  return error;
854 }
855 
856 /*?
857  * This command create a uni-directional MPLS tunnel
858  *
859  * @cliexpar
860  * @cliexstart{create mpls tunnel}
861  * create mpls tunnel via 10.0.0.1 GigEthernet0/8/0 out-label 33 out-label 34
862  * @cliexend
863  ?*/
864 VLIB_CLI_COMMAND (create_mpls_tunnel_command, static) = {
865  .path = "mpls tunnel",
866  .short_help =
867  "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>]",
869 };
870 
871 static u8 *
872 format_mpls_tunnel (u8 * s, va_list * args)
873 {
874  mpls_tunnel_t *mt = va_arg (*args, mpls_tunnel_t *);
876 
877  s = format(s, "mpls_tunnel%d: sw_if_index:%d hw_if_index:%d",
878  mt - mpls_tunnel_pool,
879  mt->mt_sw_if_index,
880  mt->mt_hw_if_index);
881  if (MPLS_TUNNEL_FLAG_NONE != mt->mt_flags) {
882  s = format(s, " \n flags:");
884  if ((1<<attr) & mt->mt_flags) {
885  s = format (s, "%s,", mpls_tunnel_attribute_names[attr]);
886  }
887  }
888  }
889  s = format(s, "\n via:\n");
891  s = format(s, "%U", format_fib_path_ext_list, &mt->mt_path_exts);
892  s = format(s, "\n");
893 
894  if (mt->mt_flags & MPLS_TUNNEL_FLAG_L2)
895  {
896  s = format(s, " forwarding: %U\n",
899  s = format(s, " %U\n", format_dpo_id, &mt->mt_l2_lb, 2);
900  }
901 
902  return (s);
903 }
904 
905 static clib_error_t *
907  unformat_input_t * input,
908  vlib_cli_command_t * cmd)
909 {
910  mpls_tunnel_t * mt;
911  u32 mti = ~0;
912 
913  if (pool_elts (mpls_tunnel_pool) == 0)
914  vlib_cli_output (vm, "No MPLS tunnels configured...");
915 
917  {
918  if (unformat (input, "%d", &mti))
919  ;
920  else
921  break;
922  }
923 
924  if (~0 == mti)
925  {
926  pool_foreach (mt, mpls_tunnel_pool,
927  ({
928  vlib_cli_output (vm, "[@%d] %U",
929  mt - mpls_tunnel_pool,
930  format_mpls_tunnel, mt);
931  }));
932  }
933  else
934  {
935  if (pool_is_free_index(mpls_tunnel_pool, mti))
936  return clib_error_return (0, "Not atunnel index %d", mti);
937 
938  mt = pool_elt_at_index(mpls_tunnel_pool, mti);
939 
940  vlib_cli_output (vm, "[@%d] %U",
941  mt - mpls_tunnel_pool,
942  format_mpls_tunnel, mt);
943  }
944 
945  return 0;
946 }
947 
948 /*?
949  * This command to show MPLS tunnels
950  *
951  * @cliexpar
952  * @cliexstart{sh mpls tunnel 2}
953  * [@2] mpls_tunnel2: sw_if_index:5 hw_if_index:5
954  * label-stack:
955  * 3,
956  * via:
957  * index:26 locks:1 proto:ipv4 uPRF-list:26 len:1 itfs:[2, ]
958  * index:26 pl-index:26 ipv4 weight=1 attached-nexthop: oper-flags:resolved,
959  * 10.0.0.2 loop0
960  * [@0]: ipv4 via 10.0.0.2 loop0: IP4: de:ad:00:00:00:00 -> 00:00:11:aa:bb:cc
961  * @cliexend
962  ?*/
963 VLIB_CLI_COMMAND (show_mpls_tunnel_command, static) = {
964  .path = "show mpls tunnel",
965  .function = show_mpls_tunnel_command_fn,
966 };
967 
968 static mpls_tunnel_t *
970 {
972  return ((mpls_tunnel_t*) (((char*)node) -
973  STRUCT_OFFSET_OF(mpls_tunnel_t, mt_node)));
974 }
975 
976 /**
977  * Function definition to backwalk a FIB node
978  */
982 {
984 
986 }
987 
988 /**
989  * Function definition to get a FIB node from its index
990  */
991 static fib_node_t*
993 {
994  mpls_tunnel_t * mt;
995 
996  mt = pool_elt_at_index(mpls_tunnel_pool, index);
997 
998  return (&mt->mt_node);
999 }
1000 
1001 /**
1002  * Function definition to inform the FIB node that its last lock has gone.
1003  */
1004 static void
1006 {
1007  /*
1008  * The MPLS MPLS tunnel is a root of the graph. As such
1009  * it never has children and thus is never locked.
1010  */
1011  ASSERT(0);
1012 }
1013 
1014 /*
1015  * Virtual function table registered by MPLS MPLS tunnels
1016  * for participation in the FIB object graph.
1017  */
1018 const static fib_node_vft_t mpls_vft = {
1020  .fnv_last_lock = mpls_tunnel_last_lock_gone,
1021  .fnv_back_walk = mpls_tunnel_back_walk,
1022 };
1023 
1024 static clib_error_t *
1026 {
1028 
1029  return 0;
1030 }
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:437
int fib_path_is_resolved(fib_node_index_t path_index)
Definition: fib_path.c:2557
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:530
static u8 * format_mpls_tunnel_tx_trace(u8 *s, va_list *args)
Definition: mpls_tunnel.c:462
vmrglw vmrglh hi
Packet trace structure.
Definition: mpls_tunnel.c:453
fib_forward_chain_type_t fib_forw_chain_type_from_link_type(vnet_link_t link_type)
Convert from a adjacency&#39;s link type to chain type.
Definition: fib_types.c:337
#define CLIB_UNUSED(x)
Definition: clib.h:79
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 *rpath)
clib_error_t * vnet_hw_interface_set_flags(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: interface.c:541
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:500
A representation of a path as described by a route producer.
Definition: fib_types.h:455
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:384
static int dpo_id_is_valid(const dpo_id_t *dpoi)
Return true if the DPO object is valid, i.e.
Definition: dpo.h:207
#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:388
#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:175
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:360
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:344
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:523
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:477
static u8 * format_mpls_tunnel_name(u8 *s, va_list *args)
Definition: mpls_tunnel.c:435
#define VNET_HW_INTERFACE_FLAG_LINK_UP
Definition: interface.h:458
static void mpls_tunnel_fixup(vlib_main_t *vm, ip_adjacency_t *adj, vlib_buffer_t *b0, const void *data)
Fixup the adj rewrite post encap.
Definition: mpls_tunnel.c:374
const mpls_tunnel_t * mpls_tunnel_get(u32 mti)
Definition: mpls_tunnel.c:561
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:228
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:442
void(* mpls_tunnel_walk_cb_t)(u32 index, void *ctx)
Callback function invoked while walking MPLS tunnels.
Definition: mpls_tunnel.h:129
unsigned char u8
Definition: types.h:56
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:980
#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:196
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
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
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:443
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:156
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
unsigned int u32
Definition: types.h:88
Contribute an object that is to be used to forward Ethernet packets.
Definition: fib_types.h:131
enum dpo_proto_t_ dpo_proto_t
Data path protocol.
static u8 * format_mpls_tunnel(u8 *s, va_list *args)
Definition: mpls_tunnel.c:872
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:758
#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:327
fib_path_ext_mpls_flags_t fpe_mpls_flags
For an MPLS type extension.
Definition: fib_path_ext.h:120
unformat_function_t unformat_line_input
Definition: format.h:282
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:168
void vnet_mpls_tunnel_del(u32 sw_if_index)
Delete an MPLS tunnel.
Definition: mpls_tunnel.c:582
#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:464
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:274
#define FOR_EACH_FIB_PROTOCOL(_item)
Definition: fib_types.h:65
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
fib_mpls_label_t * frp_label_stack
The outgoing MPLS label Stack.
Definition: fib_types.h:510
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:291
#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:287
#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:296
u32 flags
Definition: vhost_user.h:110
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:458
Adjacency to drop this packet.
Definition: adj.h:53
#define UNFORMAT_END_OF_INPUT
Definition: format.h:144
u16 n_vectors
Definition: node.h:380
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:294
VNET_DEVICE_CLASS(mpls_tunnel_class)
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:339
Multicast Midchain Adjacency.
Definition: adj.h:86
static void mpls_tunnel_restack(mpls_tunnel_t *mt)
Definition: mpls_tunnel.c:305
void adj_nbr_midchain_update_rewrite(adj_index_t adj_index, adj_midchain_fixup_t fixup, const void *fixup_data, adj_flags_t flags, u8 *rewrite)
adj_nbr_midchain_update_rewrite
Definition: adj_midchain.c:506
fib_node_get_t fnv_get
Definition: fib_node.h:275
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:426
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:30
void mpls_tunnel_walk(mpls_tunnel_walk_cb_t cb, void *ctx)
Walk all the MPLS tunnels.
Definition: mpls_tunnel.c:570
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:271
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 adj_mcast_midchain_update_rewrite(adj_index_t adj_index, adj_midchain_fixup_t fixup, const void *fixup_data, adj_flags_t flags, u8 *rewrite, u8 offset, u32 mask)
adj_mcast_midchain_update_rewrite
Definition: adj_mcast.c:136
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:185
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:1025
Context passed between object during a back walk.
Definition: fib_node.h:200
#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:492
#define VNET_SW_INTERFACE_FLAG_ADMIN_UP
Definition: interface.h:661
u32 vnet_mpls_tunnel_create(u8 l2_only, u8 is_multicast)
Create a new MPLS tunnel.
Definition: mpls_tunnel.c:602
#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:712
void adj_nbr_midchain_stack(adj_index_t adj_index, const dpo_id_t *next)
adj_nbr_midchain_stack
Definition: adj_midchain.c:570
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.
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:48
#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:548
u8 * format_dpo_id(u8 *s, va_list *args)
Format a DPO_id_t oject
Definition: dpo.c:147
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
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:660
index_t dpoi_index
the index of objects of that type
Definition: dpo.h:184
#define FIB_NODE_INDEX_INVALID
Definition: fib_types.h:31
void fib_path_ext_list_resolve(fib_path_ext_list_t *list, fib_node_index_t path_list_index)
Definition: fib_path_ext.c:414
#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
ip_lookup_next_t lookup_next_index
Next hop after ip4-lookup.
Definition: adj.h:190
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:780
static void mpls_tunnel_stack(adj_index_t ai)
mpls_tunnel_stack
Definition: mpls_tunnel.c:236
u8 * fib_path_list_format(fib_node_index_t path_list_index, u8 *s)
u64 uword
Definition: types.h:112
static void unformat_free(unformat_input_t *i)
Definition: format.h:162
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:195
a point 2 point interface
Definition: interface.h:345
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:1005
One path from an [EU]CMP set that the client wants to add to a load-balance object.
Definition: load_balance.h:62
void vnet_sw_interface_set_mtu(vnet_main_t *vnm, u32 sw_if_index, u32 mtu)
Definition: interface.c:676
A FIB graph nodes virtual function table.
Definition: fib_node.h:274
#define vnet_buffer(b)
Definition: buffer.h:360
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:231
A path extension is a per-entry addition to the forwarding information when packets are sent for that...
Definition: fib_path_ext.h:98
u8 * format_fib_path_ext_list(u8 *s, va_list *args)
Definition: fib_path_ext.c:459
u32 mt_sw_if_index
The SW interface index of the tunnel interfaces.
Definition: mpls_tunnel.h:81
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
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:992
u16 dpoi_next_node
The next VLIB node to follow.
Definition: dpo.h:180
enum mpls_tunnel_attribute_t_ mpls_tunnel_attribute_t
#define pool_foreach_index(i, v, body)
Iterate pool by index.
Definition: pool.h:488
#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:486
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:111
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:681
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:170
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:906
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:370
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:145
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:166
static void mpls_tunnel_update_adj(vnet_main_t *vnm, u32 sw_if_index, adj_index_t ai)
Definition: mpls_tunnel.c:388
static mpls_tunnel_t * mpls_tunnel_from_fib_node(fib_node_t *node)
Definition: mpls_tunnel.c:969
static uword pool_elts(void *v)
Number of active elements in a pool.
Definition: pool.h:128