src/vnet/mpls/mpls_api.c

   1 /*
   2  *------------------------------------------------------------------
   3  * mpls_api.c - mpls api
   4  *
   5  * Copyright (c) 2016 Cisco and/or its affiliates.
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *------------------------------------------------------------------
  18  */
  19
  20 #include <vnet/vnet.h>
  21 #include <vlibmemory/api.h>
  22
  23 #include <vnet/interface.h>
  24 #include <vnet/api_errno.h>
  25 #include <vnet/mpls/mpls.h>
  26 #include <vnet/mpls/mpls_tunnel.h>
  27 #include <vnet/fib/fib_table.h>
  28 #include <vnet/fib/fib_api.h>
  29 #include <vnet/fib/mpls_fib.h>
  30 #include <vnet/fib/fib_path_list.h>
  31
  32 #include <vnet/vnet_msg_enum.h>
  33
  34 #define vl_typedefs             /* define message structures */
  35 #include <vnet/vnet_all_api_h.h>
  36 #undef vl_typedefs
  37
  38 #define vl_endianfun            /* define message structures */
  39 #include <vnet/vnet_all_api_h.h>
  40 #undef vl_endianfun
  41
  42 /* instantiate all the print functions we know about */
  43 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  44 #define vl_printfun
  45 #include <vnet/vnet_all_api_h.h>
  46 #undef vl_printfun
  47
  48 #include <vlibapi/api_helper_macros.h>
  49
  50 #define foreach_vpe_api_msg                                 \
  51 _(MPLS_IP_BIND_UNBIND, mpls_ip_bind_unbind)                 \
  52 _(MPLS_ROUTE_ADD_DEL, mpls_route_add_del)                   \
  53 _(MPLS_TABLE_ADD_DEL, mpls_table_add_del)                   \
  54 _(MPLS_TUNNEL_ADD_DEL, mpls_tunnel_add_del)                 \
  55 _(MPLS_TUNNEL_DUMP, mpls_tunnel_dump)                       \
  56 _(SW_INTERFACE_SET_MPLS_ENABLE, sw_interface_set_mpls_enable) \
  57 _(MPLS_FIB_DUMP, mpls_fib_dump)
  58
  59 extern void stats_dslock_with_hint (int hint, int tag);
  60 extern void stats_dsunlock (void);
  61
  62 void
  63 mpls_table_delete (u32 table_id, u8 is_api)
  64 {
  65   u32 fib_index;
  66
  67   /*
  68    * The MPLS defult table must also be explicitly created via the API.
  69    * So in contrast to IP, it gets no special treatment here.
  70    *
  71    * The API holds only one lock on the table.
  72    * i.e. it can be added many times via the API but needs to be
  73    * deleted only once.
  74    */
  75   fib_index = fib_table_find (FIB_PROTOCOL_MPLS, table_id);
  76
  77   if (~0 != fib_index)
  78     {
  79       fib_table_unlock (fib_index,
  80                         FIB_PROTOCOL_MPLS,
  81                         (is_api ? FIB_SOURCE_API : FIB_SOURCE_CLI));
  82     }
  83 }
  84
  85 void
  86 vl_api_mpls_table_add_del_t_handler (vl_api_mpls_table_add_del_t * mp)
  87 {
  88   vl_api_mpls_table_add_del_reply_t *rmp;
  89   vnet_main_t *vnm;
  90   int rv = 0;
  91
  92   vnm = vnet_get_main ();
  93   vnm->api_errno = 0;
  94
  95   if (mp->mt_is_add)
  96     mpls_table_create (ntohl (mp->mt_table_id), 1, mp->mt_name);
  97   else
  98     mpls_table_delete (ntohl (mp->mt_table_id), 1);
  99
 100   // NB: Nothing sets rv; none of the above returns an error
 101
 102   REPLY_MACRO (VL_API_MPLS_TABLE_ADD_DEL_REPLY);
 103 }
 104
 105 static int
 106 mpls_ip_bind_unbind_handler (vnet_main_t * vnm,
 107                              vl_api_mpls_ip_bind_unbind_t * mp)
 108 {
 109   u32 mpls_fib_index, ip_fib_index;
 110
 111   mpls_fib_index =
 112     fib_table_find (FIB_PROTOCOL_MPLS, ntohl (mp->mb_mpls_table_id));
 113
 114   if (~0 == mpls_fib_index)
 115     {
 116       return VNET_API_ERROR_NO_SUCH_FIB;
 117     }
 118
 119   ip_fib_index = fib_table_find ((mp->mb_is_ip4 ?
 120                                   FIB_PROTOCOL_IP4 :
 121                                   FIB_PROTOCOL_IP6),
 122                                  ntohl (mp->mb_ip_table_id));
 123   if (~0 == ip_fib_index)
 124     return VNET_API_ERROR_NO_SUCH_FIB;
 125
 126   fib_prefix_t pfx = {
 127     .fp_len = mp->mb_address_length,
 128   };
 129
 130   if (mp->mb_is_ip4)
 131     {
 132       pfx.fp_proto = FIB_PROTOCOL_IP4;
 133       clib_memcpy (&pfx.fp_addr.ip4, mp->mb_address,
 134                    sizeof (pfx.fp_addr.ip4));
 135     }
 136   else
 137     {
 138       pfx.fp_proto = FIB_PROTOCOL_IP6;
 139       clib_memcpy (&pfx.fp_addr.ip6, mp->mb_address,
 140                    sizeof (pfx.fp_addr.ip6));
 141     }
 142
 143   if (mp->mb_is_bind)
 144     fib_table_entry_local_label_add (ip_fib_index, &pfx,
 145                                      ntohl (mp->mb_label));
 146   else
 147     fib_table_entry_local_label_remove (ip_fib_index, &pfx,
 148                                         ntohl (mp->mb_label));
 149
 150   return (0);
 151 }
 152
 153 void
 154 vl_api_mpls_ip_bind_unbind_t_handler (vl_api_mpls_ip_bind_unbind_t * mp)
 155 {
 156   vl_api_mpls_ip_bind_unbind_reply_t *rmp;
 157   vnet_main_t *vnm;
 158   int rv;
 159
 160   vnm = vnet_get_main ();
 161   vnm->api_errno = 0;
 162
 163   rv = mpls_ip_bind_unbind_handler (vnm, mp);
 164   rv = (rv == 0) ? vnm->api_errno : rv;
 165
 166   REPLY_MACRO (VL_API_MPLS_IP_BIND_UNBIND_REPLY);
 167 }
 168
 169 static int
 170 mpls_route_add_del_t_handler (vnet_main_t * vnm,
 171                               vl_api_mpls_route_add_del_t * mp)
 172 {
 173   fib_mpls_label_t *label_stack = NULL;
 174   u32 fib_index, next_hop_fib_index;
 175   int rv, ii, n_labels;;
 176
 177   fib_prefix_t pfx = {
 178     .fp_len = 21,
 179     .fp_proto = FIB_PROTOCOL_MPLS,
 180     .fp_eos = mp->mr_eos,
 181     .fp_label = ntohl (mp->mr_label),
 182   };
 183   if (pfx.fp_eos)
 184     {
 185       pfx.fp_payload_proto = mp->mr_next_hop_proto;
 186     }
 187   else
 188     {
 189       pfx.fp_payload_proto = DPO_PROTO_MPLS;
 190     }
 191
 192   rv = add_del_route_check (FIB_PROTOCOL_MPLS,
 193                             mp->mr_table_id,
 194                             mp->mr_next_hop_sw_if_index,
 195                             pfx.fp_payload_proto,
 196                             mp->mr_next_hop_table_id,
 197                             mp->mr_is_rpf_id,
 198                             &fib_index, &next_hop_fib_index);
 199
 200   if (0 != rv)
 201     return (rv);
 202
 203   ip46_address_t nh;
 204   memset (&nh, 0, sizeof (nh));
 205
 206   if (DPO_PROTO_IP4 == mp->mr_next_hop_proto)
 207     memcpy (&nh.ip4, mp->mr_next_hop, sizeof (nh.ip4));
 208   else if (DPO_PROTO_IP6 == mp->mr_next_hop_proto)
 209     memcpy (&nh.ip6, mp->mr_next_hop, sizeof (nh.ip6));
 210
 211   n_labels = mp->mr_next_hop_n_out_labels;
 212   if (n_labels == 0)
 213     ;
 214   else
 215     {
 216       vec_validate (label_stack, n_labels - 1);
 217       for (ii = 0; ii < n_labels; ii++)
 218         {
 219           label_stack[ii].fml_value =
 220             ntohl (mp->mr_next_hop_out_label_stack[ii].label);
 221           label_stack[ii].fml_ttl = mp->mr_next_hop_out_label_stack[ii].ttl;
 222           label_stack[ii].fml_exp = mp->mr_next_hop_out_label_stack[ii].exp;
 223           label_stack[ii].fml_mode =
 224             (mp->mr_next_hop_out_label_stack[ii].is_uniform ?
 225              FIB_MPLS_LSP_MODE_UNIFORM : FIB_MPLS_LSP_MODE_PIPE);
 226         }
 227     }
 228
 229   /* *INDENT-OFF* */
 230   return (add_del_route_t_handler (mp->mr_is_multipath, mp->mr_is_add,
 231                                    0,   // mp->is_drop,
 232                                    0,   // mp->is_unreach,
 233                                    0,   // mp->is_prohibit,
 234                                    0,   // mp->is_local,
 235                                    mp->mr_is_multicast,
 236                                    mp->mr_is_classify,
 237                                    mp->mr_classify_table_index,
 238                                    mp->mr_is_resolve_host,
 239                                    mp->mr_is_resolve_attached,
 240                                    mp->mr_is_interface_rx,
 241                                    mp->mr_is_rpf_id,
 242                                    0,   // l2_bridged
 243                                    0,   // is source_lookup
 244                                    0,   // is_udp_encap
 245                                    fib_index, &pfx,
 246                                    mp->mr_next_hop_proto,
 247                                    &nh, ~0, // next_hop_id
 248                                    ntohl (mp->mr_next_hop_sw_if_index),
 249                                    next_hop_fib_index,
 250                                    mp->mr_next_hop_weight,
 251                                    mp->mr_next_hop_preference,
 252                                    ntohl (mp->mr_next_hop_via_label),
 253                                    label_stack));
 254   /* *INDENT-ON* */
 255 }
 256
 257 void
 258 vl_api_mpls_route_add_del_t_handler (vl_api_mpls_route_add_del_t * mp)
 259 {
 260   vl_api_mpls_route_add_del_reply_t *rmp;
 261   vnet_main_t *vnm;
 262   int rv;
 263
 264   vnm = vnet_get_main ();
 265   vnm->api_errno = 0;
 266
 267   rv = mpls_route_add_del_t_handler (vnm, mp);
 268
 269   rv = (rv == 0) ? vnm->api_errno : rv;
 270
 271   REPLY_MACRO (VL_API_MPLS_ROUTE_ADD_DEL_REPLY);
 272 }
 273
 274 void
 275 mpls_table_create (u32 table_id, u8 is_api, const u8 * name)
 276 {
 277   u32 fib_index;
 278
 279   /*
 280    * The MPLS defult table must also be explicitly created via the API.
 281    * So in contrast to IP, it gets no special treatment here.
 282    */
 283
 284   /*
 285    * The API holds only one lock on the table.
 286    * i.e. it can be added many times via the API but needs to be
 287    * deleted only once.
 288    */
 289   fib_index = fib_table_find (FIB_PROTOCOL_MPLS, table_id);
 290
 291   if (~0 == fib_index)
 292     {
 293       fib_table_find_or_create_and_lock_w_name (FIB_PROTOCOL_MPLS,
 294                                                 table_id,
 295                                                 (is_api ?
 296                                                  FIB_SOURCE_API :
 297                                                  FIB_SOURCE_CLI), name);
 298     }
 299 }
 300
 301 static void
 302 vl_api_mpls_tunnel_add_del_t_handler (vl_api_mpls_tunnel_add_del_t * mp)
 303 {
 304   vl_api_mpls_tunnel_add_del_reply_t *rmp;
 305   int rv = 0;
 306   u32 tunnel_sw_if_index;
 307   int ii;
 308   fib_route_path_t rpath, *rpaths = NULL;
 309
 310   memset (&rpath, 0, sizeof (rpath));
 311
 312   stats_dslock_with_hint (1 /* release hint */ , 5 /* tag */ );
 313
 314   if (mp->mt_next_hop_proto_is_ip4)
 315     {
 316       rpath.frp_proto = DPO_PROTO_IP4;
 317       clib_memcpy (&rpath.frp_addr.ip4,
 318                    mp->mt_next_hop, sizeof (rpath.frp_addr.ip4));
 319     }
 320   else
 321     {
 322       rpath.frp_proto = DPO_PROTO_IP6;
 323       clib_memcpy (&rpath.frp_addr.ip6,
 324                    mp->mt_next_hop, sizeof (rpath.frp_addr.ip6));
 325     }
 326   rpath.frp_sw_if_index = ntohl (mp->mt_next_hop_sw_if_index);
 327   rpath.frp_weight = 1;
 328
 329   if (mp->mt_is_add)
 330     {
 331       for (ii = 0; ii < mp->mt_next_hop_n_out_labels; ii++)
 332         {
 333           fib_mpls_label_t fml = {
 334             .fml_value = ntohl (mp->mt_next_hop_out_label_stack[ii].label),
 335             .fml_ttl = mp->mt_next_hop_out_label_stack[ii].ttl,
 336             .fml_exp = mp->mt_next_hop_out_label_stack[ii].exp,
 337             .fml_mode = (mp->mt_next_hop_out_label_stack[ii].is_uniform ?
 338                          FIB_MPLS_LSP_MODE_UNIFORM : FIB_MPLS_LSP_MODE_PIPE),
 339           };
 340           vec_add1 (rpath.frp_label_stack, fml);
 341         }
 342     }
 343
 344   vec_add1 (rpaths, rpath);
 345
 346   tunnel_sw_if_index = ntohl (mp->mt_sw_if_index);
 347
 348   if (mp->mt_is_add)
 349     {
 350       if (~0 == tunnel_sw_if_index)
 351         tunnel_sw_if_index = vnet_mpls_tunnel_create (mp->mt_l2_only,
 352                                                       mp->mt_is_multicast);
 353       vnet_mpls_tunnel_path_add (tunnel_sw_if_index, rpaths);
 354     }
 355   else
 356     {
 357       tunnel_sw_if_index = ntohl (mp->mt_sw_if_index);
 358       if (!vnet_mpls_tunnel_path_remove (tunnel_sw_if_index, rpaths))
 359         vnet_mpls_tunnel_del (tunnel_sw_if_index);
 360     }
 361
 362   vec_free (rpaths);
 363
 364   stats_dsunlock ();
 365
 366   /* *INDENT-OFF* */
 367   REPLY_MACRO2(VL_API_MPLS_TUNNEL_ADD_DEL_REPLY,
 368   ({
 369     rmp->sw_if_index = ntohl(tunnel_sw_if_index);
 370   }));
 371   /* *INDENT-ON* */
 372 }
 373
 374 static void
 375   vl_api_sw_interface_set_mpls_enable_t_handler
 376   (vl_api_sw_interface_set_mpls_enable_t * mp)
 377 {
 378   vl_api_sw_interface_set_mpls_enable_reply_t *rmp;
 379   int rv = 0;
 380
 381   VALIDATE_SW_IF_INDEX (mp);
 382
 383   rv = mpls_sw_interface_enable_disable (&mpls_main,
 384                                          ntohl (mp->sw_if_index),
 385                                          mp->enable, 1);
 386
 387   BAD_SW_IF_INDEX_LABEL;
 388   REPLY_MACRO (VL_API_SW_INTERFACE_SET_MPLS_ENABLE_REPLY);
 389 }
 390
 391 typedef struct mpls_tunnel_send_walk_ctx_t_
 392 {
 393   vl_api_registration_t *reg;
 394   u32 index;
 395   u32 context;
 396 } mpls_tunnel_send_walk_ctx_t;
 397
 398 static void
 399 send_mpls_tunnel_entry (u32 mti, void *arg)
 400 {
 401   fib_route_path_encode_t *api_rpaths = NULL, *api_rpath;
 402   mpls_tunnel_send_walk_ctx_t *ctx;
 403   vl_api_mpls_tunnel_details_t *mp;
 404   const mpls_tunnel_t *mt;
 405   vl_api_fib_path_t *fp;
 406   u32 n;
 407
 408   ctx = arg;
 409
 410   if (~0 != ctx->index && mti != ctx->index)
 411     return;
 412
 413   mt = mpls_tunnel_get (mti);
 414   n = fib_path_list_get_n_paths (mt->mt_path_list);
 415
 416   mp = vl_msg_api_alloc (sizeof (*mp) + n * sizeof (vl_api_fib_path_t));
 417   memset (mp, 0, sizeof (*mp) + n * sizeof (vl_api_fib_path_t));
 418
 419   mp->_vl_msg_id = ntohs (VL_API_MPLS_TUNNEL_DETAILS);
 420   mp->context = ctx->context;
 421
 422   mp->mt_tunnel_index = ntohl (mti);
 423   mp->mt_count = ntohl (n);
 424
 425   fib_path_list_walk (mt->mt_path_list, fib_path_encode, &api_rpaths);
 426
 427   fp = mp->mt_paths;
 428   vec_foreach (api_rpath, api_rpaths)
 429   {
 430     fib_api_path_encode (api_rpath, fp);
 431     fp++;
 432   }
 433
 434   // FIXME
 435   // memcpy (mp->mt_next_hop_out_labels,
 436   //   mt->mt_label_stack, nlabels * sizeof (u32));
 437
 438
 439   vl_api_send_msg (ctx->reg, (u8 *) mp);
 440 }
 441
 442 static void
 443 vl_api_mpls_tunnel_dump_t_handler (vl_api_mpls_tunnel_dump_t * mp)
 444 {
 445   vl_api_registration_t *reg;
 446
 447   reg = vl_api_client_index_to_registration (mp->client_index);
 448   if (!reg)
 449     return;
 450
 451   mpls_tunnel_send_walk_ctx_t ctx = {
 452     .reg = reg,
 453     .index = ntohl (mp->tunnel_index),
 454     .context = mp->context,
 455   };
 456   mpls_tunnel_walk (send_mpls_tunnel_entry, &ctx);
 457 }
 458
 459 static void
 460 send_mpls_fib_details (vpe_api_main_t * am,
 461                        vl_api_registration_t * reg,
 462                        const fib_table_t * table,
 463                        u32 label, u32 eos,
 464                        fib_route_path_encode_t * api_rpaths, u32 context)
 465 {
 466   vl_api_mpls_fib_details_t *mp;
 467   fib_route_path_encode_t *api_rpath;
 468   vl_api_fib_path_t *fp;
 469   int path_count;
 470
 471   path_count = vec_len (api_rpaths);
 472   mp = vl_msg_api_alloc (sizeof (*mp) + path_count * sizeof (*fp));
 473   if (!mp)
 474     return;
 475   memset (mp, 0, sizeof (*mp));
 476   mp->_vl_msg_id = ntohs (VL_API_MPLS_FIB_DETAILS);
 477   mp->context = context;
 478
 479   mp->table_id = htonl (table->ft_table_id);
 480   memcpy (mp->table_name, table->ft_desc,
 481           clib_min (vec_len (table->ft_desc), sizeof (mp->table_name)));
 482   mp->eos_bit = eos;
 483   mp->label = htonl (label);
 484
 485   mp->count = htonl (path_count);
 486   fp = mp->path;
 487   vec_foreach (api_rpath, api_rpaths)
 488   {
 489     fib_api_path_encode (api_rpath, fp);
 490     fp++;
 491   }
 492
 493   vl_api_send_msg (reg, (u8 *) mp);
 494 }
 495
 496 typedef struct vl_api_mpls_fib_dump_table_walk_ctx_t_
 497 {
 498   fib_node_index_t *lfeis;
 499 } vl_api_mpls_fib_dump_table_walk_ctx_t;
 500
 501 static fib_table_walk_rc_t
 502 vl_api_mpls_fib_dump_table_walk (fib_node_index_t fei, void *arg)
 503 {
 504   vl_api_mpls_fib_dump_table_walk_ctx_t *ctx = arg;
 505
 506   vec_add1 (ctx->lfeis, fei);
 507
 508   return (FIB_TABLE_WALK_CONTINUE);
 509 }
 510
 511 static void
 512 vl_api_mpls_fib_dump_t_handler (vl_api_mpls_fib_dump_t * mp)
 513 {
 514   vpe_api_main_t *am = &vpe_api_main;
 515   vl_api_registration_t *reg;
 516   mpls_main_t *mm = &mpls_main;
 517   fib_table_t *fib_table;
 518   mpls_fib_t *mpls_fib;
 519   fib_node_index_t *lfeip = NULL;
 520   fib_prefix_t pfx;
 521   u32 fib_index;
 522   fib_route_path_encode_t *api_rpaths;
 523   vl_api_mpls_fib_dump_table_walk_ctx_t ctx = {
 524     .lfeis = NULL,
 525   };
 526
 527   reg = vl_api_client_index_to_registration (mp->client_index);
 528   if (!reg)
 529     return;
 530
 531   /* *INDENT-OFF* */
 532   pool_foreach (mpls_fib, mm->mpls_fibs,
 533   ({
 534     mpls_fib_table_walk (mpls_fib,
 535                          vl_api_mpls_fib_dump_table_walk,
 536                          &ctx);
 537   }));
 538   /* *INDENT-ON* */
 539   vec_sort_with_function (ctx.lfeis, fib_entry_cmp_for_sort);
 540
 541   vec_foreach (lfeip, ctx.lfeis)
 542   {
 543     fib_entry_get_prefix (*lfeip, &pfx);
 544     fib_index = fib_entry_get_fib_index (*lfeip);
 545     fib_table = fib_table_get (fib_index, pfx.fp_proto);
 546     api_rpaths = NULL;
 547     fib_entry_encode (*lfeip, &api_rpaths);
 548     send_mpls_fib_details (am, reg,
 549                            fib_table, pfx.fp_label,
 550                            pfx.fp_eos, api_rpaths, mp->context);
 551     vec_free (api_rpaths);
 552   }
 553
 554   vec_free (ctx.lfeis);
 555 }
 556
 557 /*
 558  * mpls_api_hookup
 559  * Add vpe's API message handlers to the table.
 560  * vlib has alread mapped shared memory and
 561  * added the client registration handlers.
 562  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
 563  */
 564 #define vl_msg_name_crc_list
 565 #include <vnet/vnet_all_api_h.h>
 566 #undef vl_msg_name_crc_list
 567
 568 static void
 569 setup_message_id_table (api_main_t * am)
 570 {
 571 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
 572   foreach_vl_msg_name_crc_mpls;
 573 #undef _
 574 }
 575
 576 static clib_error_t *
 577 mpls_api_hookup (vlib_main_t * vm)
 578 {
 579   api_main_t *am = &api_main;
 580
 581 #define _(N,n)                                                  \
 582     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
 583                            vl_api_##n##_t_handler,              \
 584                            vl_noop_handler,                     \
 585                            vl_api_##n##_t_endian,               \
 586                            vl_api_##n##_t_print,                \
 587                            sizeof(vl_api_##n##_t), 1);
 588   foreach_vpe_api_msg;
 589 #undef _
 590
 591   /*
 592    * Trace space for 8 MPLS encap labels
 593    */
 594   am->api_trace_cfg[VL_API_MPLS_TUNNEL_ADD_DEL].size += 8 * sizeof (u32);
 595
 596   /*
 597    * Set up the (msg_name, crc, message-id) table
 598    */
 599   setup_message_id_table (am);
 600
 601   return 0;
 602 }
 603
 604 VLIB_API_INIT_FUNCTION (mpls_api_hookup);
 605
 606 /*
 607  * fd.io coding-style-patch-verification: ON
 608  *
 609  * Local Variables:
 610  * eval: (c-set-style "gnu")
 611  * End:
 612  */