8ed2c409ce8efdf922fc8d13f4a9c3f1c65c638f
[vpp.git] / src / vnet / mpls / mpls_tunnel.c
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  */
32 static mpls_tunnel_t *mpls_tunnel_pool;
33
34 /**
35  * @brief Pool of free tunnel SW indices - i.e. recycled indices
36  */
37 static u32 * mpls_tunnel_free_hw_if_indices;
38
39 /**
40  * @brief DB of SW index to tunnel index
41  */
42 static u32 *mpls_tunnel_db;
43
44 /**
45  * @brief MPLS tunnel flags strings
46  */
47 static const char *mpls_tunnel_attribute_names[] = MPLS_TUNNEL_ATTRIBUTES;
48
49 /**
50  * @brief Get a tunnel object from a SW interface index
51  */
52 static mpls_tunnel_t*
53 mpls_tunnel_get_from_sw_if_index (u32 sw_if_index)
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*
67 mpls_tunnel_build_rewrite_i (void)
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*
87 mpls_tunnel_build_rewrite (vnet_main_t * vnm,
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
95 typedef struct mpls_tunnel_collect_forwarding_ctx_t_
96 {
97     load_balance_path_t * next_hops;
98     const mpls_tunnel_t *mt;
99     fib_forward_chain_type_t fct;
100 } mpls_tunnel_collect_forwarding_ctx_t;
101
102 static fib_path_list_walk_rc_t
103 mpls_tunnel_collect_forwarding (fib_node_index_t pl_index,
104                                 fib_node_index_t path_index,
105                                 void *arg)
106 {
107     mpls_tunnel_collect_forwarding_ctx_t *ctx;
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     {
117         return (FIB_PATH_LIST_WALK_CONTINUE);
118     }
119
120     /*
121      * get the matching path-extension for the path being visited.
122      */
123     path_ext = fib_path_ext_list_find_by_path_index(&ctx->mt->mt_path_exts,
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
144     return (FIB_PATH_LIST_WALK_CONTINUE);
145 }
146
147 static void
148 mpls_tunnel_mk_lb (mpls_tunnel_t *mt,
149                    vnet_link_t linkt,
150                    fib_forward_chain_type_t fct,
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      */
160     mpls_tunnel_collect_forwarding_ctx_t ctx = {
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      */
171     vec_validate(ctx.next_hops, fib_path_list_get_n_paths(mt->mt_path_list));
172     vec_reset_length(ctx.next_hops);
173
174     lb_proto = fib_forw_chain_type_to_dpo_proto(fct);
175
176     fib_path_list_walk(mt->mt_path_list,
177                        mpls_tunnel_collect_forwarding,
178                        &ctx);
179
180     if (!dpo_id_is_valid(dpo_lb))
181     {
182         /*
183          * first time create
184          */
185         if (mt->mt_flags & MPLS_TUNNEL_FLAG_MCAST)
186         {
187             dpo_set(dpo_lb,
188                     DPO_REPLICATE,
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:
199                 fhc = MPLS_FLOW_HASH_DEFAULT;
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,
211                     DPO_LOAD_BALANCE,
212                     lb_proto,
213                     load_balance_create(0, lb_proto, fhc));
214         }
215     }
216
217     if (mt->mt_flags & MPLS_TUNNEL_FLAG_MCAST)
218     {
219         /*
220          * MPLS multicast
221          */
222         replicate_multipath_update(dpo_lb, ctx.next_hops);
223     }
224     else
225     {
226         load_balance_multipath_update(dpo_lb,
227                                       ctx.next_hops,
228                                       LOAD_BALANCE_FLAG_NONE);
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
239 mpls_tunnel_stack (adj_index_t ai)
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      */
259     fib_path_list_lock(mt->mt_path_list);
260
261     fib_path_list_child_remove(mt->mt_path_list,
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      */
268     if (vnet_hw_interface_get_flags(vnet_get_main(),
269                                     mt->mt_hw_if_index) &
270         VNET_HW_INTERFACE_FLAG_LINK_UP)
271     {
272         dpo_id_t dpo = DPO_INVALID;
273
274         mpls_tunnel_mk_lb(mt,
275                           adj->ia_link,
276                           (VNET_LINK_MPLS == adj_get_link_type(ai) ?
277                            FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS:
278                            FIB_FORW_CHAIN_TYPE_MPLS_EOS),
279                           &dpo);
280
281         adj_nbr_midchain_stack(ai, &dpo);
282         dpo_reset(&dpo);
283     }
284     else
285     {
286         adj_nbr_midchain_unstack(ai);
287     }
288
289     mt->mt_sibling_index = fib_path_list_child_add(mt->mt_path_list,
290                                                    FIB_NODE_TYPE_MPLS_TUNNEL,
291                                                    mt - mpls_tunnel_pool);
292
293     fib_path_list_unlock(mt->mt_path_list);
294 }
295
296 /**
297  * @brief Call back when restacking all adjacencies on a MPLS interface
298  */
299 static adj_walk_rc_t
300 mpls_adj_walk_cb (adj_index_t ai,
301                  void *ctx)
302 {
303     mpls_tunnel_stack(ai);
304
305     return (ADJ_WALK_RC_CONTINUE);
306 }
307
308 static void
309 mpls_tunnel_restack (mpls_tunnel_t *mt)
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          */
321         vnet_hw_interface_t * hi;
322         dpo_id_t dpo = DPO_INVALID;
323
324         mpls_tunnel_mk_lb(mt,
325                           VNET_LINK_MPLS,
326                           FIB_FORW_CHAIN_TYPE_ETHERNET,
327                           &dpo);
328
329         hi = vnet_get_hw_interface(vnet_get_main(), mt->mt_hw_if_index);
330         dpo_stack_from_node(hi->tx_node_index,
331                             &mt->mt_l2_lb,
332                             &dpo);
333         dpo_reset(&dpo);
334     }
335     else
336     {
337         FOR_EACH_FIB_PROTOCOL(proto)
338         {
339             adj_nbr_walk(mt->mt_sw_if_index,
340                          proto,
341                          mpls_adj_walk_cb,
342                          NULL);
343         }
344     }
345 }
346
347 static clib_error_t *
348 mpls_tunnel_admin_up_down (vnet_main_t * vnm,
349                            u32 hw_if_index,
350                            u32 flags)
351 {
352     vnet_hw_interface_t * hi;
353     mpls_tunnel_t *mt;
354
355     hi = vnet_get_hw_interface (vnm, hw_if_index);
356
357     mt = mpls_tunnel_get_from_sw_if_index(hi->sw_if_index);
358
359     if (NULL == mt)
360         return (NULL);
361
362     if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
363         vnet_hw_interface_set_flags (vnm, hw_if_index,
364                                      VNET_HW_INTERFACE_FLAG_LINK_UP);
365     else
366         vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */);
367
368     mpls_tunnel_restack(mt);
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
378 mpls_tunnel_fixup (vlib_main_t *vm,
379                    ip_adjacency_t *adj,
380                    vlib_buffer_t *b0,
381                    const void*data)
382 {
383     /*
384      * A no-op w.r.t. the header. but reset the 'have we pushed any
385      * MPLS labels onto the packet' flag. That way when we enter the
386      * tunnel we'll get a TTL set to 255
387      */
388     vnet_buffer(b0)->mpls.first = 0;
389 }
390
391 static void
392 mpls_tunnel_update_adj (vnet_main_t * vnm,
393                         u32 sw_if_index,
394                         adj_index_t ai)
395 {
396     ip_adjacency_t *adj;
397
398     ASSERT(ADJ_INDEX_INVALID != ai);
399
400     adj = adj_get(ai);
401
402     switch (adj->lookup_next_index)
403     {
404     case IP_LOOKUP_NEXT_ARP:
405     case IP_LOOKUP_NEXT_GLEAN:
406         adj_nbr_midchain_update_rewrite(ai, mpls_tunnel_fixup,
407                                         NULL,
408                                         ADJ_FLAG_NONE,
409                                         mpls_tunnel_build_rewrite_i());
410         break;
411     case IP_LOOKUP_NEXT_MCAST:
412         /*
413          * Construct a partial rewrite from the known ethernet mcast dest MAC
414          * There's no MAC fixup, so the last 2 parameters are 0
415          */
416         adj_mcast_midchain_update_rewrite(ai, mpls_tunnel_fixup,
417                                           NULL,
418                                           ADJ_FLAG_NONE,
419                                           mpls_tunnel_build_rewrite_i(),
420                                           0, 0);
421         break;
422
423     case IP_LOOKUP_NEXT_DROP:
424     case IP_LOOKUP_NEXT_PUNT:
425     case IP_LOOKUP_NEXT_LOCAL:
426     case IP_LOOKUP_NEXT_REWRITE:
427     case IP_LOOKUP_NEXT_MIDCHAIN:
428     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
429     case IP_LOOKUP_NEXT_ICMP_ERROR:
430     case IP_LOOKUP_N_NEXT:
431       ASSERT (0);
432       break;
433     }
434
435     mpls_tunnel_stack(ai);
436 }
437
438 static u8 *
439 format_mpls_tunnel_name (u8 * s, va_list * args)
440 {
441   u32 dev_instance = va_arg (*args, u32);
442   return format (s, "mpls-tunnel%d", dev_instance);
443 }
444
445 static u8 *
446 format_mpls_tunnel_device (u8 * s, va_list * args)
447 {
448   u32 dev_instance = va_arg (*args, u32);
449   CLIB_UNUSED (int verbose) = va_arg (*args, int);
450
451   return (format (s, "MPLS-tunnel: id %d\n", dev_instance));
452 }
453
454 /**
455  * @brief Packet trace structure
456  */
457 typedef struct mpls_tunnel_trace_t_
458 {
459     /**
460    * Tunnel-id / index in tunnel vector
461    */
462   u32 tunnel_id;
463 } mpls_tunnel_trace_t;
464
465 static u8 *
466 format_mpls_tunnel_tx_trace (u8 * s,
467                              va_list * args)
468 {
469   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
470   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
471   mpls_tunnel_trace_t * t = va_arg (*args, mpls_tunnel_trace_t *);
472
473   s = format (s, "MPLS: tunnel %d", t->tunnel_id);
474   return s;
475 }
476
477 /**
478  * @brief TX function. Only called L2. L3 traffic uses the adj-midchains
479  */
480 static uword
481 mpls_tunnel_tx (vlib_main_t * vm,
482                 vlib_node_runtime_t * node,
483                 vlib_frame_t * frame)
484 {
485   u32 next_index;
486   u32 * from, * to_next, n_left_from, n_left_to_next;
487   vnet_interface_output_runtime_t * rd = (void *) node->runtime_data;
488   const mpls_tunnel_t *mt;
489
490   mt = pool_elt_at_index(mpls_tunnel_pool, rd->dev_instance);
491
492   /* Vector of buffer / pkt indices we're supposed to process */
493   from = vlib_frame_vector_args (frame);
494
495   /* Number of buffers / pkts */
496   n_left_from = frame->n_vectors;
497
498   /* Speculatively send the first buffer to the last disposition we used */
499   next_index = node->cached_next_index;
500
501   while (n_left_from > 0)
502     {
503       /* set up to enqueue to our disposition with index = next_index */
504       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
505
506       /*
507        * FIXME DUAL LOOP
508        */
509       while (n_left_from > 0 && n_left_to_next > 0)
510         {
511           vlib_buffer_t * b0;
512           u32 bi0;
513
514           bi0 = from[0];
515           to_next[0] = bi0;
516           from += 1;
517           to_next += 1;
518           n_left_from -= 1;
519           n_left_to_next -= 1;
520
521           b0 = vlib_get_buffer(vm, bi0);
522
523           vnet_buffer(b0)->ip.adj_index[VLIB_TX] = mt->mt_l2_lb.dpoi_index;
524
525           if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
526             {
527               mpls_tunnel_trace_t *tr = vlib_add_trace (vm, node,
528                                                    b0, sizeof (*tr));
529               tr->tunnel_id = rd->dev_instance;
530             }
531
532           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
533                                            to_next, n_left_to_next,
534                                            bi0, mt->mt_l2_lb.dpoi_next_node);
535         }
536
537       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
538     }
539
540   return frame->n_vectors;
541 }
542
543 VNET_DEVICE_CLASS (mpls_tunnel_class) = {
544     .name = "MPLS tunnel device",
545     .format_device_name = format_mpls_tunnel_name,
546     .format_device = format_mpls_tunnel_device,
547     .format_tx_trace = format_mpls_tunnel_tx_trace,
548     .tx_function = mpls_tunnel_tx,
549     .admin_up_down_function = mpls_tunnel_admin_up_down,
550 };
551
552 VNET_HW_INTERFACE_CLASS (mpls_tunnel_hw_interface_class) = {
553   .name = "MPLS-Tunnel",
554   .update_adjacency = mpls_tunnel_update_adj,
555   .build_rewrite = mpls_tunnel_build_rewrite,
556   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
557 };
558
559 const mpls_tunnel_t *
560 mpls_tunnel_get (u32 mti)
561 {
562     return (pool_elt_at_index(mpls_tunnel_pool, mti));
563 }
564
565 /**
566  * @brief Walk all the MPLS tunnels
567  */
568 void
569 mpls_tunnel_walk (mpls_tunnel_walk_cb_t cb,
570                   void *ctx)
571 {
572     u32 mti;
573
574     pool_foreach_index(mti, mpls_tunnel_pool,
575     ({
576         cb(mti, ctx);
577     }));
578 }
579
580 void
581 vnet_mpls_tunnel_del (u32 sw_if_index)
582 {
583     mpls_tunnel_t *mt;
584
585     mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
586
587     if (NULL == mt)
588         return;
589
590     if (FIB_NODE_INDEX_INVALID != mt->mt_path_list)
591         fib_path_list_child_remove(mt->mt_path_list,
592                                    mt->mt_sibling_index);
593     dpo_reset(&mt->mt_l2_lb);
594
595     vec_add1 (mpls_tunnel_free_hw_if_indices, mt->mt_hw_if_index);
596     pool_put(mpls_tunnel_pool, mt);
597     mpls_tunnel_db[sw_if_index] = ~0;
598 }
599
600 u32
601 vnet_mpls_tunnel_create (u8 l2_only,
602                          u8 is_multicast)
603 {
604     vnet_hw_interface_t * hi;
605     mpls_tunnel_t *mt;
606     vnet_main_t * vnm;
607     u32 mti;
608
609     vnm = vnet_get_main();
610     pool_get(mpls_tunnel_pool, mt);
611     memset (mt, 0, sizeof (*mt));
612     mti = mt - mpls_tunnel_pool;
613     fib_node_init(&mt->mt_node, FIB_NODE_TYPE_MPLS_TUNNEL);
614     mt->mt_path_list = FIB_NODE_INDEX_INVALID;
615     mt->mt_sibling_index = FIB_NODE_INDEX_INVALID;
616
617     if (is_multicast)
618         mt->mt_flags |= MPLS_TUNNEL_FLAG_MCAST;
619     if (l2_only)
620         mt->mt_flags |= MPLS_TUNNEL_FLAG_L2;
621
622     /*
623      * Create a new, or re=use and old, tunnel HW interface
624      */
625     if (vec_len (mpls_tunnel_free_hw_if_indices) > 0)
626     {
627         mt->mt_hw_if_index =
628             mpls_tunnel_free_hw_if_indices[vec_len(mpls_tunnel_free_hw_if_indices)-1];
629         _vec_len (mpls_tunnel_free_hw_if_indices) -= 1;
630         hi = vnet_get_hw_interface (vnm, mt->mt_hw_if_index);
631         hi->hw_instance = mti;
632         hi->dev_instance = mti;
633     }
634     else
635     {
636         mt->mt_hw_if_index = vnet_register_interface(
637                                  vnm,
638                                  mpls_tunnel_class.index,
639                                  mti,
640                                  mpls_tunnel_hw_interface_class.index,
641                                  mti);
642         hi = vnet_get_hw_interface (vnm, mt->mt_hw_if_index);
643     }
644
645     /*
646      * Add the new tunnel to the tunnel DB - key:SW if index
647      */
648     mt->mt_sw_if_index = hi->sw_if_index;
649     vec_validate_init_empty(mpls_tunnel_db, mt->mt_sw_if_index, ~0);
650     mpls_tunnel_db[mt->mt_sw_if_index] = mti;
651
652     return (mt->mt_sw_if_index);
653 }
654
655 void
656 vnet_mpls_tunnel_path_add (u32 sw_if_index,
657                            fib_route_path_t *rpaths)
658 {
659     mpls_tunnel_t *mt;
660     u32 mti;
661
662     mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
663
664     if (NULL == mt)
665         return;
666
667     mti = mt - mpls_tunnel_pool;
668
669     /*
670      * construct a path-list from the path provided
671      */
672     if (FIB_NODE_INDEX_INVALID == mt->mt_path_list)
673     {
674         mt->mt_path_list = fib_path_list_create(FIB_PATH_LIST_FLAG_SHARED, rpaths);
675         mt->mt_sibling_index = fib_path_list_child_add(mt->mt_path_list,
676                                                        FIB_NODE_TYPE_MPLS_TUNNEL,
677                                                        mti);
678     }
679     else
680     {
681         fib_node_index_t old_pl_index;
682
683         old_pl_index = mt->mt_path_list;
684
685         mt->mt_path_list =
686             fib_path_list_copy_and_path_add(old_pl_index,
687                                             FIB_PATH_LIST_FLAG_SHARED,
688                                             rpaths);
689
690         fib_path_list_child_remove(old_pl_index,
691                                    mt->mt_sibling_index);
692         mt->mt_sibling_index = fib_path_list_child_add(mt->mt_path_list,
693                                                        FIB_NODE_TYPE_MPLS_TUNNEL,
694                                                        mti);
695         /*
696          * re-resolve all the path-extensions with the new path-list
697          */
698         fib_path_ext_list_resolve(&mt->mt_path_exts, mt->mt_path_list);
699     }
700     fib_path_ext_list_insert(&mt->mt_path_exts,
701                              mt->mt_path_list,
702                              FIB_PATH_EXT_MPLS,
703                              rpaths);
704     mpls_tunnel_restack(mt);
705 }
706
707 int
708 vnet_mpls_tunnel_path_remove (u32 sw_if_index,
709                               fib_route_path_t *rpaths)
710 {
711     mpls_tunnel_t *mt;
712     u32 mti;
713
714     mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
715
716     if (NULL == mt)
717         return (0);
718
719     mti = mt - mpls_tunnel_pool;
720
721     /*
722      * construct a path-list from the path provided
723      */
724     if (FIB_NODE_INDEX_INVALID == mt->mt_path_list)
725     {
726         /* can't remove a path if we have onoe */
727         return (0);
728     }
729     else
730     {
731         fib_node_index_t old_pl_index;
732
733         old_pl_index = mt->mt_path_list;
734
735         mt->mt_path_list =
736             fib_path_list_copy_and_path_remove(old_pl_index,
737                                                FIB_PATH_LIST_FLAG_SHARED,
738                                                rpaths);
739
740         fib_path_list_child_remove(old_pl_index,
741                                    mt->mt_sibling_index);
742
743         if (FIB_NODE_INDEX_INVALID == mt->mt_path_list)
744         {
745             /* no paths left */
746             return (0);
747         }
748         else
749         {
750             mt->mt_sibling_index =
751                 fib_path_list_child_add(mt->mt_path_list,
752                                         FIB_NODE_TYPE_MPLS_TUNNEL,
753                                         mti);
754         }
755         /*
756          * find the matching path extension and remove it
757          */
758         fib_path_ext_list_remove(&mt->mt_path_exts,
759                                   FIB_PATH_EXT_MPLS,
760                                   rpaths);
761
762         /*
763          * re-resolve all the path-extensions with the new path-list
764          */
765         fib_path_ext_list_resolve(&mt->mt_path_exts,
766                                   mt->mt_path_list);
767
768         mpls_tunnel_restack(mt);
769    }
770
771     return (fib_path_list_get_n_paths(mt->mt_path_list));
772 }
773
774
775 static clib_error_t *
776 vnet_create_mpls_tunnel_command_fn (vlib_main_t * vm,
777                                     unformat_input_t * input,
778                                     vlib_cli_command_t * cmd)
779 {
780     unformat_input_t _line_input, * line_input = &_line_input;
781     vnet_main_t * vnm = vnet_get_main();
782     u8 is_del = 0, l2_only = 0, is_multicast =0;
783     fib_route_path_t rpath, *rpaths = NULL;
784     u32 sw_if_index = ~0, payload_proto;
785     clib_error_t *error = NULL;
786
787     memset(&rpath, 0, sizeof(rpath));
788     payload_proto = DPO_PROTO_MPLS;
789
790     /* Get a line of input. */
791     if (! unformat_user (input, unformat_line_input, line_input))
792         return 0;
793
794     while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
795     {
796         if (unformat (line_input, "del %U",
797                       unformat_vnet_sw_interface, vnm,
798                       &sw_if_index))
799             is_del = 1;
800         else if (unformat (line_input, "add %U",
801                            unformat_vnet_sw_interface, vnm,
802                            &sw_if_index))
803             is_del = 0;
804         else if (unformat (line_input, "add"))
805             is_del = 0;
806         else if (unformat (line_input, "l2-only"))
807             l2_only = 1;
808         else if (unformat (line_input, "multicast"))
809             is_multicast = 1;
810         else if (unformat (line_input, "via %U",
811                            unformat_fib_route_path,
812                            &rpath, &payload_proto))
813             vec_add1(rpaths, rpath);
814         else
815         {
816             error = clib_error_return (0, "unknown input '%U'",
817                                        format_unformat_error, line_input);
818             goto done;
819         }
820     }
821
822     if (is_del)
823     {
824         if (!vnet_mpls_tunnel_path_remove(sw_if_index, rpaths))
825         {
826             vnet_mpls_tunnel_del(sw_if_index);
827         }
828     }
829     else
830     {
831         if (0 == vec_len(rpath.frp_label_stack))
832         {
833             error = clib_error_return (0, "No Output Labels '%U'",
834                                        format_unformat_error, line_input);
835             goto done;
836         }
837
838         if (~0 == sw_if_index)
839         {
840             sw_if_index = vnet_mpls_tunnel_create(l2_only, is_multicast);
841         }
842         vnet_mpls_tunnel_path_add(sw_if_index, rpaths);
843     }
844
845 done:
846     vec_free(rpaths);
847     unformat_free (line_input);
848
849     return error;
850 }
851
852 /*?
853  * This command create a uni-directional MPLS tunnel
854  *
855  * @cliexpar
856  * @cliexstart{create mpls tunnel}
857  *  create mpls tunnel via 10.0.0.1 GigEthernet0/8/0 out-label 33 out-label 34
858  * @cliexend
859  ?*/
860 VLIB_CLI_COMMAND (create_mpls_tunnel_command, static) = {
861   .path = "mpls tunnel",
862   .short_help =
863   "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>]",
864   .function = vnet_create_mpls_tunnel_command_fn,
865 };
866
867 static u8 *
868 format_mpls_tunnel (u8 * s, va_list * args)
869 {
870     mpls_tunnel_t *mt = va_arg (*args, mpls_tunnel_t *);
871     mpls_tunnel_attribute_t attr;
872
873     s = format(s, "mpls_tunnel%d: sw_if_index:%d hw_if_index:%d",
874                mt - mpls_tunnel_pool,
875                mt->mt_sw_if_index,
876                mt->mt_hw_if_index);
877     if (MPLS_TUNNEL_FLAG_NONE != mt->mt_flags) {
878         s = format(s, " \n flags:");
879         FOR_EACH_MPLS_TUNNEL_ATTRIBUTE(attr) {
880             if ((1<<attr) & mt->mt_flags) {
881                 s = format (s, "%s,", mpls_tunnel_attribute_names[attr]);
882             }
883         }
884     }
885     s = format(s, "\n via:\n");
886     s = fib_path_list_format(mt->mt_path_list, s);
887     s = format(s, "%U", format_fib_path_ext_list, &mt->mt_path_exts);
888     s = format(s, "\n");
889
890     if (mt->mt_flags & MPLS_TUNNEL_FLAG_L2)
891     {
892         s = format(s, " forwarding: %U\n",
893                    format_fib_forw_chain_type,
894                    FIB_FORW_CHAIN_TYPE_ETHERNET);
895         s = format(s, " %U\n", format_dpo_id, &mt->mt_l2_lb, 2);
896     }
897
898     return (s);
899 }
900
901 static clib_error_t *
902 show_mpls_tunnel_command_fn (vlib_main_t * vm,
903                              unformat_input_t * input,
904                              vlib_cli_command_t * cmd)
905 {
906     mpls_tunnel_t * mt;
907     u32 mti = ~0;
908
909     if (pool_elts (mpls_tunnel_pool) == 0)
910         vlib_cli_output (vm, "No MPLS tunnels configured...");
911
912     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
913     {
914         if (unformat (input, "%d", &mti))
915             ;
916         else
917             break;
918     }
919
920     if (~0 == mti)
921     {
922         pool_foreach (mt, mpls_tunnel_pool,
923         ({
924             vlib_cli_output (vm, "[@%d] %U",
925                              mt - mpls_tunnel_pool,
926                              format_mpls_tunnel, mt);
927         }));
928     }
929     else
930     {
931         if (pool_is_free_index(mpls_tunnel_pool, mti))
932             return clib_error_return (0, "Not atunnel index %d", mti);
933
934         mt = pool_elt_at_index(mpls_tunnel_pool, mti);
935
936         vlib_cli_output (vm, "[@%d] %U",
937                          mt - mpls_tunnel_pool,
938                          format_mpls_tunnel, mt);
939     }
940
941     return 0;
942 }
943
944 /*?
945  * This command to show MPLS tunnels
946  *
947  * @cliexpar
948  * @cliexstart{sh mpls tunnel 2}
949  * [@2] mpls_tunnel2: sw_if_index:5 hw_if_index:5
950  *  label-stack:
951  *    3,
952  *  via:
953  *   index:26 locks:1 proto:ipv4 uPRF-list:26 len:1 itfs:[2, ]
954  *     index:26 pl-index:26 ipv4 weight=1 attached-nexthop:  oper-flags:resolved,
955  *      10.0.0.2 loop0
956  *         [@0]: ipv4 via 10.0.0.2 loop0: IP4: de:ad:00:00:00:00 -> 00:00:11:aa:bb:cc
957  * @cliexend
958  ?*/
959 VLIB_CLI_COMMAND (show_mpls_tunnel_command, static) = {
960     .path = "show mpls tunnel",
961     .function = show_mpls_tunnel_command_fn,
962 };
963
964 static mpls_tunnel_t *
965 mpls_tunnel_from_fib_node (fib_node_t *node)
966 {
967     ASSERT(FIB_NODE_TYPE_MPLS_TUNNEL == node->fn_type);
968     return ((mpls_tunnel_t*) (((char*)node) -
969                              STRUCT_OFFSET_OF(mpls_tunnel_t, mt_node)));
970 }
971
972 /**
973  * Function definition to backwalk a FIB node
974  */
975 static fib_node_back_walk_rc_t
976 mpls_tunnel_back_walk (fib_node_t *node,
977                       fib_node_back_walk_ctx_t *ctx)
978 {
979     mpls_tunnel_restack(mpls_tunnel_from_fib_node(node));
980
981     return (FIB_NODE_BACK_WALK_CONTINUE);
982 }
983
984 /**
985  * Function definition to get a FIB node from its index
986  */
987 static fib_node_t*
988 mpls_tunnel_fib_node_get (fib_node_index_t index)
989 {
990     mpls_tunnel_t * mt;
991
992     mt = pool_elt_at_index(mpls_tunnel_pool, index);
993
994     return (&mt->mt_node);
995 }
996
997 /**
998  * Function definition to inform the FIB node that its last lock has gone.
999  */
1000 static void
1001 mpls_tunnel_last_lock_gone (fib_node_t *node)
1002 {
1003     /*
1004      * The MPLS MPLS tunnel is a root of the graph. As such
1005      * it never has children and thus is never locked.
1006      */
1007     ASSERT(0);
1008 }
1009
1010 /*
1011  * Virtual function table registered by MPLS MPLS tunnels
1012  * for participation in the FIB object graph.
1013  */
1014 const static fib_node_vft_t mpls_vft = {
1015     .fnv_get = mpls_tunnel_fib_node_get,
1016     .fnv_last_lock = mpls_tunnel_last_lock_gone,
1017     .fnv_back_walk = mpls_tunnel_back_walk,
1018 };
1019
1020 static clib_error_t *
1021 mpls_tunnel_init (vlib_main_t *vm)
1022 {
1023   fib_node_register_type(FIB_NODE_TYPE_MPLS_TUNNEL, &mpls_vft);
1024
1025   return 0;
1026 }
1027 VLIB_INIT_FUNCTION(mpls_tunnel_init);