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