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