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 DB of SW index to tunnel index
  36  */
  37 static u32 *mpls_tunnel_db;
  38
  39 /**
  40  * @brief MPLS tunnel flags strings
  41  */
  42 static const char *mpls_tunnel_attribute_names[] = MPLS_TUNNEL_ATTRIBUTES;
  43
  44 /**
  45  * @brief Get a tunnel object from a SW interface index
  46  */
  47 static mpls_tunnel_t*
  48 mpls_tunnel_get_from_sw_if_index (u32 sw_if_index)
  49 {
  50     if ((vec_len(mpls_tunnel_db) <= sw_if_index) ||
  51         (~0 == mpls_tunnel_db[sw_if_index]))
  52         return (NULL);
  53
  54     return (pool_elt_at_index(mpls_tunnel_pool,
  55                               mpls_tunnel_db[sw_if_index]));
  56 }
  57
  58 /**
  59  * @brief Build a rewrite string for the MPLS tunnel.
  60  */
  61 static u8*
  62 mpls_tunnel_build_rewrite_i (void)
  63 {
  64     /*
  65      * passing the adj code a NULL rewrite means 'i don't have one cos
  66      * t'other end is unresolved'. That's not the case here. For the mpls
  67      * tunnel there are just no bytes of encap to apply in the adj. We'll impose
  68      * the label stack once we choose a path. So return a zero length rewrite.
  69      */
  70     u8 *rewrite = NULL;
  71
  72     vec_validate(rewrite, 0);
  73     vec_reset_length(rewrite);
  74
  75     return (rewrite);
  76 }
  77
  78 /**
  79  * @brief Build a rewrite string for the MPLS tunnel.
  80  */
  81 static u8*
  82 mpls_tunnel_build_rewrite (vnet_main_t * vnm,
  83                            u32 sw_if_index,
  84                            vnet_link_t link_type,
  85                            const void *dst_address)
  86 {
  87     return (mpls_tunnel_build_rewrite_i());
  88 }
  89
  90 typedef struct mpls_tunnel_collect_forwarding_ctx_t_
  91 {
  92     load_balance_path_t * next_hops;
  93     const mpls_tunnel_t *mt;
  94     fib_forward_chain_type_t fct;
  95 } mpls_tunnel_collect_forwarding_ctx_t;
  96
  97 static fib_path_list_walk_rc_t
  98 mpls_tunnel_collect_forwarding (fib_node_index_t pl_index,
  99                                 fib_node_index_t path_index,
 100                                 void *arg)
 101 {
 102     mpls_tunnel_collect_forwarding_ctx_t *ctx;
 103     fib_path_ext_t *path_ext;
 104
 105     ctx = arg;
 106
 107     /*
 108      * if the path is not resolved, don't include it.
 109      */
 110     if (!fib_path_is_resolved(path_index))
 111     {
 112         return (FIB_PATH_LIST_WALK_CONTINUE);
 113     }
 114
 115     /*
 116      * get the matching path-extension for the path being visited.
 117      */
 118     path_ext = fib_path_ext_list_find_by_path_index(&ctx->mt->mt_path_exts,
 119                                                     path_index);
 120
 121     /*
 122      * we don't want IP TTL decrements for packets hitting the MPLS labels
 123      * we stack on, since the IP TTL decrement is done by the adj
 124      */
 125     path_ext->fpe_mpls_flags |= FIB_PATH_EXT_MPLS_FLAG_NO_IP_TTL_DECR;
 126
 127     /*
 128      * found a matching extension. stack it to obtain the forwarding
 129      * info for this path.
 130      */
 131     ctx->next_hops = fib_path_ext_stack(path_ext,
 132                                         ctx->fct,
 133                                         ctx->fct,
 134                                         ctx->next_hops);
 135
 136     return (FIB_PATH_LIST_WALK_CONTINUE);
 137 }
 138
 139 static void
 140 mpls_tunnel_mk_lb (mpls_tunnel_t *mt,
 141                    vnet_link_t linkt,
 142                    fib_forward_chain_type_t fct,
 143                    dpo_id_t *dpo_lb)
 144 {
 145     dpo_proto_t lb_proto;
 146
 147     /*
 148      * If the entry has path extensions then we construct a load-balance
 149      * by stacking the extensions on the forwarding chains of the paths.
 150      * Otherwise we use the load-balance of the path-list
 151      */
 152     mpls_tunnel_collect_forwarding_ctx_t ctx = {
 153         .mt = mt,
 154         .next_hops = NULL,
 155         .fct = fct,
 156     };
 157
 158     /*
 159      * As an optimisation we allocate the vector of next-hops to be sized
 160      * equal to the maximum nuber of paths we will need, which is also the
 161      * most likely number we will need, since in most cases the paths are 'up'.
 162      */
 163     vec_validate(ctx.next_hops, fib_path_list_get_n_paths(mt->mt_path_list));
 164     vec_reset_length(ctx.next_hops);
 165
 166     lb_proto = fib_forw_chain_type_to_dpo_proto(fct);
 167
 168     if (FIB_NODE_INDEX_INVALID != mt->mt_path_list)
 169     {
 170         fib_path_list_walk(mt->mt_path_list,
 171                            mpls_tunnel_collect_forwarding,
 172                            &ctx);
 173     }
 174
 175     if (!dpo_id_is_valid(dpo_lb))
 176     {
 177         /*
 178          * first time create
 179          */
 180         if (mt->mt_flags & MPLS_TUNNEL_FLAG_MCAST)
 181         {
 182             dpo_set(dpo_lb,
 183                     DPO_REPLICATE,
 184                     lb_proto,
 185                     replicate_create(0, lb_proto));
 186         }
 187         else
 188         {
 189             flow_hash_config_t fhc;
 190
 191             switch (linkt)
 192             {
 193             case VNET_LINK_MPLS:
 194                 fhc = MPLS_FLOW_HASH_DEFAULT;
 195                 break;
 196             case VNET_LINK_IP4:
 197             case VNET_LINK_IP6:
 198                 fhc = IP_FLOW_HASH_DEFAULT;
 199                 break;
 200             default:
 201                 fhc = 0;
 202                 break;
 203             }
 204
 205             dpo_set(dpo_lb,
 206                     DPO_LOAD_BALANCE,
 207                     lb_proto,
 208                     load_balance_create(0, lb_proto, fhc));
 209         }
 210     }
 211
 212     if (mt->mt_flags & MPLS_TUNNEL_FLAG_MCAST)
 213     {
 214         /*
 215          * MPLS multicast
 216          */
 217         replicate_multipath_update(dpo_lb, ctx.next_hops);
 218     }
 219     else
 220     {
 221         load_balance_multipath_update(dpo_lb,
 222                                       ctx.next_hops,
 223                                       LOAD_BALANCE_FLAG_NONE);
 224         vec_free(ctx.next_hops);
 225     }
 226 }
 227
 228 /**
 229  * mpls_tunnel_stack
 230  *
 231  * 'stack' (resolve the recursion for) the tunnel's midchain adjacency
 232  */
 233 static void
 234 mpls_tunnel_stack (adj_index_t ai)
 235 {
 236     ip_adjacency_t *adj;
 237     mpls_tunnel_t *mt;
 238     u32 sw_if_index;
 239
 240     adj = adj_get(ai);
 241     sw_if_index = adj->rewrite_header.sw_if_index;
 242
 243     mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
 244
 245     if (NULL == mt)
 246         return;
 247
 248     if (FIB_NODE_INDEX_INVALID == mt->mt_path_list)
 249     {
 250         adj_nbr_midchain_unstack(ai);
 251         return;
 252     }
 253
 254     /*
 255      * while we're stacking the adj, remove the tunnel from the child list
 256      * of the path list. this breaks a circular dependency of walk updates
 257      * where the create of adjacencies in the children can lead to walks
 258      * that get back here.
 259      */
 260     fib_path_list_lock(mt->mt_path_list);
 261
 262     fib_path_list_child_remove(mt->mt_path_list,
 263                                mt->mt_sibling_index);
 264
 265     /*
 266      * Construct the DPO (load-balance or replicate) that we can stack
 267      * the tunnel's midchain on
 268      */
 269     if (vnet_hw_interface_get_flags(vnet_get_main(),
 270                                     mt->mt_hw_if_index) &
 271         VNET_HW_INTERFACE_FLAG_LINK_UP)
 272     {
 273         dpo_id_t dpo = DPO_INVALID;
 274
 275         mpls_tunnel_mk_lb(mt,
 276                           adj->ia_link,
 277                           fib_forw_chain_type_from_link_type(
 278                               adj_get_link_type(ai)),
 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     case IP_LOOKUP_NEXT_BCAST:
 407         adj_nbr_midchain_update_rewrite(ai, mpls_tunnel_fixup,
 408                                         NULL,
 409                                         ADJ_FLAG_NONE,
 410                                         mpls_tunnel_build_rewrite_i());
 411         break;
 412     case IP_LOOKUP_NEXT_MCAST:
 413         /*
 414          * Construct a partial rewrite from the known ethernet mcast dest MAC
 415          * There's no MAC fixup, so the last 2 parameters are 0
 416          */
 417         adj_mcast_midchain_update_rewrite(ai, mpls_tunnel_fixup,
 418                                           NULL,
 419                                           ADJ_FLAG_NONE,
 420                                           mpls_tunnel_build_rewrite_i(),
 421                                           0, 0);
 422         break;
 423
 424     case IP_LOOKUP_NEXT_DROP:
 425     case IP_LOOKUP_NEXT_PUNT:
 426     case IP_LOOKUP_NEXT_LOCAL:
 427     case IP_LOOKUP_NEXT_REWRITE:
 428     case IP_LOOKUP_NEXT_MIDCHAIN:
 429     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
 430     case IP_LOOKUP_NEXT_ICMP_ERROR:
 431     case IP_LOOKUP_N_NEXT:
 432       ASSERT (0);
 433       break;
 434     }
 435
 436     mpls_tunnel_stack(ai);
 437 }
 438
 439 static u8 *
 440 format_mpls_tunnel_name (u8 * s, va_list * args)
 441 {
 442   u32 dev_instance = va_arg (*args, u32);
 443   return format (s, "mpls-tunnel%d", dev_instance);
 444 }
 445
 446 static u8 *
 447 format_mpls_tunnel_device (u8 * s, va_list * args)
 448 {
 449   u32 dev_instance = va_arg (*args, u32);
 450   CLIB_UNUSED (int verbose) = va_arg (*args, int);
 451
 452   return (format (s, "MPLS-tunnel: id %d\n", dev_instance));
 453 }
 454
 455 /**
 456  * @brief Packet trace structure
 457  */
 458 typedef struct mpls_tunnel_trace_t_
 459 {
 460     /**
 461    * Tunnel-id / index in tunnel vector
 462    */
 463   u32 tunnel_id;
 464 } mpls_tunnel_trace_t;
 465
 466 static u8 *
 467 format_mpls_tunnel_tx_trace (u8 * s,
 468                              va_list * args)
 469 {
 470   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
 471   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
 472   mpls_tunnel_trace_t * t = va_arg (*args, mpls_tunnel_trace_t *);
 473
 474   s = format (s, "MPLS: tunnel %d", t->tunnel_id);
 475   return s;
 476 }
 477
 478 /**
 479  * @brief TX function. Only called L2. L3 traffic uses the adj-midchains
 480  */
 481 static uword
 482 mpls_tunnel_tx (vlib_main_t * vm,
 483                 vlib_node_runtime_t * node,
 484                 vlib_frame_t * frame)
 485 {
 486   u32 next_index;
 487   u32 * from, * to_next, n_left_from, n_left_to_next;
 488   vnet_interface_output_runtime_t * rd = (void *) node->runtime_data;
 489   const mpls_tunnel_t *mt;
 490
 491   mt = pool_elt_at_index(mpls_tunnel_pool, rd->dev_instance);
 492
 493   /* Vector of buffer / pkt indices we're supposed to process */
 494   from = vlib_frame_vector_args (frame);
 495
 496   /* Number of buffers / pkts */
 497   n_left_from = frame->n_vectors;
 498
 499   /* Speculatively send the first buffer to the last disposition we used */
 500   next_index = node->cached_next_index;
 501
 502   while (n_left_from > 0)
 503     {
 504       /* set up to enqueue to our disposition with index = next_index */
 505       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 506
 507       /*
 508        * FIXME DUAL LOOP
 509        */
 510       while (n_left_from > 0 && n_left_to_next > 0)
 511         {
 512           vlib_buffer_t * b0;
 513           u32 bi0;
 514
 515           bi0 = from[0];
 516           to_next[0] = bi0;
 517           from += 1;
 518           to_next += 1;
 519           n_left_from -= 1;
 520           n_left_to_next -= 1;
 521
 522           b0 = vlib_get_buffer(vm, bi0);
 523
 524           vnet_buffer(b0)->ip.adj_index[VLIB_TX] = mt->mt_l2_lb.dpoi_index;
 525           /* since we are coming out of the L2 world, where the vlib_buffer
 526            * union is used for other things, make sure it is clean for
 527            * MPLS from now on.
 528            */
 529           vnet_buffer(b0)->mpls.first = 0;
 530
 531           if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
 532             {
 533               mpls_tunnel_trace_t *tr = vlib_add_trace (vm, node,
 534                                                    b0, sizeof (*tr));
 535               tr->tunnel_id = rd->dev_instance;
 536             }
 537
 538           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 539                                            to_next, n_left_to_next,
 540                                            bi0, mt->mt_l2_lb.dpoi_next_node);
 541         }
 542
 543       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 544     }
 545
 546   return frame->n_vectors;
 547 }
 548
 549 VNET_DEVICE_CLASS (mpls_tunnel_class) = {
 550     .name = "MPLS tunnel device",
 551     .format_device_name = format_mpls_tunnel_name,
 552     .format_device = format_mpls_tunnel_device,
 553     .format_tx_trace = format_mpls_tunnel_tx_trace,
 554     .tx_function = mpls_tunnel_tx,
 555     .admin_up_down_function = mpls_tunnel_admin_up_down,
 556 };
 557
 558 VNET_HW_INTERFACE_CLASS (mpls_tunnel_hw_interface_class) = {
 559   .name = "MPLS-Tunnel",
 560   .update_adjacency = mpls_tunnel_update_adj,
 561   .build_rewrite = mpls_tunnel_build_rewrite,
 562   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
 563 };
 564
 565 const mpls_tunnel_t *
 566 mpls_tunnel_get (u32 mti)
 567 {
 568     return (pool_elt_at_index(mpls_tunnel_pool, mti));
 569 }
 570
 571 /**
 572  * @brief Walk all the MPLS tunnels
 573  */
 574 void
 575 mpls_tunnel_walk (mpls_tunnel_walk_cb_t cb,
 576                   void *ctx)
 577 {
 578     u32 mti;
 579
 580     pool_foreach_index(mti, mpls_tunnel_pool,
 581     ({
 582         cb(mti, ctx);
 583     }));
 584 }
 585
 586 void
 587 vnet_mpls_tunnel_del (u32 sw_if_index)
 588 {
 589     mpls_tunnel_t *mt;
 590
 591     mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
 592
 593     if (NULL == mt)
 594         return;
 595
 596     if (FIB_NODE_INDEX_INVALID != mt->mt_path_list)
 597         fib_path_list_child_remove(mt->mt_path_list,
 598                                    mt->mt_sibling_index);
 599     dpo_reset(&mt->mt_l2_lb);
 600
 601     vnet_delete_hw_interface (vnet_get_main(), mt->mt_hw_if_index);
 602
 603     pool_put(mpls_tunnel_pool, mt);
 604     mpls_tunnel_db[sw_if_index] = ~0;
 605 }
 606
 607 u32
 608 vnet_mpls_tunnel_create (u8 l2_only,
 609                          u8 is_multicast)
 610 {
 611     vnet_hw_interface_t * hi;
 612     mpls_tunnel_t *mt;
 613     vnet_main_t * vnm;
 614     u32 mti;
 615
 616     vnm = vnet_get_main();
 617     pool_get(mpls_tunnel_pool, mt);
 618     clib_memset (mt, 0, sizeof (*mt));
 619     mti = mt - mpls_tunnel_pool;
 620     fib_node_init(&mt->mt_node, FIB_NODE_TYPE_MPLS_TUNNEL);
 621     mt->mt_path_list = FIB_NODE_INDEX_INVALID;
 622     mt->mt_sibling_index = FIB_NODE_INDEX_INVALID;
 623
 624     if (is_multicast)
 625         mt->mt_flags |= MPLS_TUNNEL_FLAG_MCAST;
 626     if (l2_only)
 627         mt->mt_flags |= MPLS_TUNNEL_FLAG_L2;
 628
 629     /*
 630      * Create a new tunnel HW interface
 631      */
 632     mt->mt_hw_if_index = vnet_register_interface(
 633         vnm,
 634         mpls_tunnel_class.index,
 635         mti,
 636         mpls_tunnel_hw_interface_class.index,
 637         mti);
 638     hi = vnet_get_hw_interface (vnm, mt->mt_hw_if_index);
 639
 640     /* Standard default MPLS tunnel MTU. */
 641     vnet_sw_interface_set_mtu (vnm, hi->sw_if_index, 9000);
 642
 643     /*
 644      * Add the new tunnel to the tunnel DB - key:SW if index
 645      */
 646     mt->mt_sw_if_index = hi->sw_if_index;
 647     vec_validate_init_empty(mpls_tunnel_db, mt->mt_sw_if_index, ~0);
 648     mpls_tunnel_db[mt->mt_sw_if_index] = mti;
 649
 650     return (mt->mt_sw_if_index);
 651 }
 652
 653 void
 654 vnet_mpls_tunnel_path_add (u32 sw_if_index,
 655                            fib_route_path_t *rpaths)
 656 {
 657     mpls_tunnel_t *mt;
 658     u32 mti;
 659
 660     mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
 661
 662     if (NULL == mt)
 663         return;
 664
 665     mti = mt - mpls_tunnel_pool;
 666
 667     /*
 668      * construct a path-list from the path provided
 669      */
 670     if (FIB_NODE_INDEX_INVALID == mt->mt_path_list)
 671     {
 672         mt->mt_path_list = fib_path_list_create(FIB_PATH_LIST_FLAG_SHARED, rpaths);
 673         mt->mt_sibling_index = fib_path_list_child_add(mt->mt_path_list,
 674                                                        FIB_NODE_TYPE_MPLS_TUNNEL,
 675                                                        mti);
 676     }
 677     else
 678     {
 679         fib_node_index_t old_pl_index;
 680
 681         old_pl_index = mt->mt_path_list;
 682
 683         mt->mt_path_list =
 684             fib_path_list_copy_and_path_add(old_pl_index,
 685                                             FIB_PATH_LIST_FLAG_SHARED,
 686                                             rpaths);
 687
 688         fib_path_list_child_remove(old_pl_index,
 689                                    mt->mt_sibling_index);
 690         mt->mt_sibling_index = fib_path_list_child_add(mt->mt_path_list,
 691                                                        FIB_NODE_TYPE_MPLS_TUNNEL,
 692                                                        mti);
 693         /*
 694          * re-resolve all the path-extensions with the new path-list
 695          */
 696         fib_path_ext_list_resolve(&mt->mt_path_exts, mt->mt_path_list);
 697     }
 698     fib_path_ext_list_insert(&mt->mt_path_exts,
 699                              mt->mt_path_list,
 700                              FIB_PATH_EXT_MPLS,
 701                              rpaths);
 702     mpls_tunnel_restack(mt);
 703 }
 704
 705 int
 706 vnet_mpls_tunnel_path_remove (u32 sw_if_index,
 707                               fib_route_path_t *rpaths)
 708 {
 709     mpls_tunnel_t *mt;
 710     u32 mti;
 711
 712     mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
 713
 714     if (NULL == mt)
 715         return (0);
 716
 717     mti = mt - mpls_tunnel_pool;
 718
 719     /*
 720      * construct a path-list from the path provided
 721      */
 722     if (FIB_NODE_INDEX_INVALID == mt->mt_path_list)
 723     {
 724         /* can't remove a path if we have onoe */
 725         return (0);
 726     }
 727     else
 728     {
 729         fib_node_index_t old_pl_index;
 730
 731         old_pl_index = mt->mt_path_list;
 732
 733         fib_path_list_lock(old_pl_index);
 734         mt->mt_path_list =
 735             fib_path_list_copy_and_path_remove(old_pl_index,
 736                                                FIB_PATH_LIST_FLAG_SHARED,
 737                                                rpaths);
 738
 739         fib_path_list_child_remove(old_pl_index,
 740                                    mt->mt_sibling_index);
 741
 742         if (FIB_NODE_INDEX_INVALID == mt->mt_path_list)
 743         {
 744             /* no paths left */
 745             fib_path_list_unlock(old_pl_index);
 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         fib_path_list_unlock(old_pl_index);
 770    }
 771
 772     return (fib_path_list_get_n_paths(mt->mt_path_list));
 773 }
 774
 775 int
 776 vnet_mpls_tunnel_get_index (u32 sw_if_index)
 777 {
 778     mpls_tunnel_t *mt;
 779
 780     mt = mpls_tunnel_get_from_sw_if_index(sw_if_index);
 781
 782     if (NULL == mt)
 783         return (~0);
 784
 785     return (mt - mpls_tunnel_pool);
 786 }
 787
 788 static clib_error_t *
 789 vnet_create_mpls_tunnel_command_fn (vlib_main_t * vm,
 790                                     unformat_input_t * input,
 791                                     vlib_cli_command_t * cmd)
 792 {
 793     unformat_input_t _line_input, * line_input = &_line_input;
 794     vnet_main_t * vnm = vnet_get_main();
 795     u8 is_del = 0, l2_only = 0, is_multicast =0;
 796     fib_route_path_t rpath, *rpaths = NULL;
 797     u32 sw_if_index = ~0, payload_proto;
 798     clib_error_t *error = NULL;
 799
 800     clib_memset(&rpath, 0, sizeof(rpath));
 801     payload_proto = DPO_PROTO_MPLS;
 802
 803     /* Get a line of input. */
 804     if (! unformat_user (input, unformat_line_input, line_input))
 805         return 0;
 806
 807     while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 808     {
 809         if (unformat (line_input, "del %U",
 810                       unformat_vnet_sw_interface, vnm,
 811                       &sw_if_index))
 812             is_del = 1;
 813         else if (unformat (line_input, "add %U",
 814                            unformat_vnet_sw_interface, vnm,
 815                            &sw_if_index))
 816             is_del = 0;
 817         else if (unformat (line_input, "add"))
 818             is_del = 0;
 819         else if (unformat (line_input, "l2-only"))
 820             l2_only = 1;
 821         else if (unformat (line_input, "multicast"))
 822             is_multicast = 1;
 823         else if (unformat (line_input, "via %U",
 824                            unformat_fib_route_path,
 825                            &rpath, &payload_proto))
 826             vec_add1(rpaths, rpath);
 827         else
 828         {
 829             error = clib_error_return (0, "unknown input '%U'",
 830                                        format_unformat_error, line_input);
 831             goto done;
 832         }
 833     }
 834
 835     if (is_del)
 836     {
 837         if (NULL == rpaths)
 838         {
 839             vnet_mpls_tunnel_del(sw_if_index);
 840         }
 841         else if (!vnet_mpls_tunnel_path_remove(sw_if_index, rpaths))
 842         {
 843             vnet_mpls_tunnel_del(sw_if_index);
 844         }
 845     }
 846     else
 847     {
 848         if (0 == vec_len(rpath.frp_label_stack))
 849         {
 850             error = clib_error_return (0, "No Output Labels '%U'",
 851                                        format_unformat_error, line_input);
 852             goto done;
 853         }
 854
 855         if (~0 == sw_if_index)
 856         {
 857             sw_if_index = vnet_mpls_tunnel_create(l2_only, is_multicast);
 858         }
 859         vnet_mpls_tunnel_path_add(sw_if_index, rpaths);
 860     }
 861
 862 done:
 863     vec_free(rpaths);
 864     unformat_free (line_input);
 865
 866     return error;
 867 }
 868
 869 /*?
 870  * This command create a uni-directional MPLS tunnel
 871  *
 872  * @cliexpar
 873  * @cliexstart{create mpls tunnel}
 874  *  create mpls tunnel via 10.0.0.1 GigEthernet0/8/0 out-label 33 out-label 34
 875  * @cliexend
 876  ?*/
 877 VLIB_CLI_COMMAND (create_mpls_tunnel_command, static) = {
 878   .path = "mpls tunnel",
 879   .short_help =
 880   "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>]",
 881   .function = vnet_create_mpls_tunnel_command_fn,
 882 };
 883
 884 static u8 *
 885 format_mpls_tunnel (u8 * s, va_list * args)
 886 {
 887     mpls_tunnel_t *mt = va_arg (*args, mpls_tunnel_t *);
 888     mpls_tunnel_attribute_t attr;
 889
 890     s = format(s, "mpls-tunnel%d: sw_if_index:%d hw_if_index:%d",
 891                mt - mpls_tunnel_pool,
 892                mt->mt_sw_if_index,
 893                mt->mt_hw_if_index);
 894     if (MPLS_TUNNEL_FLAG_NONE != mt->mt_flags) {
 895         s = format(s, " \n flags:");
 896         FOR_EACH_MPLS_TUNNEL_ATTRIBUTE(attr) {
 897             if ((1<<attr) & mt->mt_flags) {
 898                 s = format (s, "%s,", mpls_tunnel_attribute_names[attr]);
 899             }
 900         }
 901     }
 902     s = format(s, "\n via:\n");
 903     s = fib_path_list_format(mt->mt_path_list, s);
 904     s = format(s, "%U", format_fib_path_ext_list, &mt->mt_path_exts);
 905     s = format(s, "\n");
 906
 907     if (mt->mt_flags & MPLS_TUNNEL_FLAG_L2)
 908     {
 909         s = format(s, " forwarding: %U\n",
 910                    format_fib_forw_chain_type,
 911                    FIB_FORW_CHAIN_TYPE_ETHERNET);
 912         s = format(s, " %U\n", format_dpo_id, &mt->mt_l2_lb, 2);
 913     }
 914
 915     return (s);
 916 }
 917
 918 static clib_error_t *
 919 show_mpls_tunnel_command_fn (vlib_main_t * vm,
 920                              unformat_input_t * input,
 921                              vlib_cli_command_t * cmd)
 922 {
 923     mpls_tunnel_t * mt;
 924     u32 mti = ~0;
 925
 926     if (pool_elts (mpls_tunnel_pool) == 0)
 927         vlib_cli_output (vm, "No MPLS tunnels configured...");
 928
 929     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 930     {
 931         if (unformat (input, "%d", &mti))
 932             ;
 933         else
 934             break;
 935     }
 936
 937     if (~0 == mti)
 938     {
 939         pool_foreach (mt, mpls_tunnel_pool,
 940         ({
 941             vlib_cli_output (vm, "[@%d] %U",
 942                              mt - mpls_tunnel_pool,
 943                              format_mpls_tunnel, mt);
 944         }));
 945     }
 946     else
 947     {
 948         if (pool_is_free_index(mpls_tunnel_pool, mti))
 949             return clib_error_return (0, "Not a tunnel index %d", mti);
 950
 951         mt = pool_elt_at_index(mpls_tunnel_pool, mti);
 952
 953         vlib_cli_output (vm, "[@%d] %U",
 954                          mt - mpls_tunnel_pool,
 955                          format_mpls_tunnel, mt);
 956     }
 957
 958     return 0;
 959 }
 960
 961 /*?
 962  * This command to show MPLS tunnels
 963  *
 964  * @cliexpar
 965  * @cliexstart{sh mpls tunnel 2}
 966  * [@2] mpls_tunnel2: sw_if_index:5 hw_if_index:5
 967  *  label-stack:
 968  *    3,
 969  *  via:
 970  *   index:26 locks:1 proto:ipv4 uPRF-list:26 len:1 itfs:[2, ]
 971  *     index:26 pl-index:26 ipv4 weight=1 attached-nexthop:  oper-flags:resolved,
 972  *      10.0.0.2 loop0
 973  *         [@0]: ipv4 via 10.0.0.2 loop0: IP4: de:ad:00:00:00:00 -> 00:00:11:aa:bb:cc
 974  * @cliexend
 975  ?*/
 976 VLIB_CLI_COMMAND (show_mpls_tunnel_command, static) = {
 977     .path = "show mpls tunnel",
 978     .function = show_mpls_tunnel_command_fn,
 979 };
 980
 981 static mpls_tunnel_t *
 982 mpls_tunnel_from_fib_node (fib_node_t *node)
 983 {
 984     ASSERT(FIB_NODE_TYPE_MPLS_TUNNEL == node->fn_type);
 985     return ((mpls_tunnel_t*) (((char*)node) -
 986                              STRUCT_OFFSET_OF(mpls_tunnel_t, mt_node)));
 987 }
 988
 989 /**
 990  * Function definition to backwalk a FIB node
 991  */
 992 static fib_node_back_walk_rc_t
 993 mpls_tunnel_back_walk (fib_node_t *node,
 994                       fib_node_back_walk_ctx_t *ctx)
 995 {
 996     mpls_tunnel_restack(mpls_tunnel_from_fib_node(node));
 997
 998     return (FIB_NODE_BACK_WALK_CONTINUE);
 999 }
1000
1001 /**
1002  * Function definition to get a FIB node from its index
1003  */
1004 static fib_node_t*
1005 mpls_tunnel_fib_node_get (fib_node_index_t index)
1006 {
1007     mpls_tunnel_t * mt;
1008
1009     mt = pool_elt_at_index(mpls_tunnel_pool, index);
1010
1011     return (&mt->mt_node);
1012 }
1013
1014 /**
1015  * Function definition to inform the FIB node that its last lock has gone.
1016  */
1017 static void
1018 mpls_tunnel_last_lock_gone (fib_node_t *node)
1019 {
1020     /*
1021      * The MPLS MPLS tunnel is a root of the graph. As such
1022      * it never has children and thus is never locked.
1023      */
1024     ASSERT(0);
1025 }
1026
1027 /*
1028  * Virtual function table registered by MPLS MPLS tunnels
1029  * for participation in the FIB object graph.
1030  */
1031 const static fib_node_vft_t mpls_vft = {
1032     .fnv_get = mpls_tunnel_fib_node_get,
1033     .fnv_last_lock = mpls_tunnel_last_lock_gone,
1034     .fnv_back_walk = mpls_tunnel_back_walk,
1035 };
1036
1037 static clib_error_t *
1038 mpls_tunnel_init (vlib_main_t *vm)
1039 {
1040   fib_node_register_type(FIB_NODE_TYPE_MPLS_TUNNEL, &mpls_vft);
1041
1042   return 0;
1043 }
1044 VLIB_INIT_FUNCTION(mpls_tunnel_init);