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 #include <vnet/ip/ip_types_api.h>
  32
  33 #include <vnet/vnet_msg_enum.h>
  34
  35 #define vl_typedefs             /* define message structures */
  36 #include <vnet/vnet_all_api_h.h>
  37 #undef vl_typedefs
  38
  39 #define vl_endianfun            /* define message structures */
  40 #include <vnet/vnet_all_api_h.h>
  41 #undef vl_endianfun
  42
  43 /* instantiate all the print functions we know about */
  44 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  45 #define vl_printfun
  46 #include <vnet/vnet_all_api_h.h>
  47 #undef vl_printfun
  48
  49 #include <vlibapi/api_helper_macros.h>
  50
  51 #define foreach_vpe_api_msg                                 \
  52 _(MPLS_IP_BIND_UNBIND, mpls_ip_bind_unbind)                 \
  53 _(MPLS_ROUTE_ADD_DEL, mpls_route_add_del)                   \
  54 _(MPLS_TABLE_ADD_DEL, mpls_table_add_del)                   \
  55 _(MPLS_TUNNEL_ADD_DEL, mpls_tunnel_add_del)                 \
  56 _(MPLS_TUNNEL_DUMP, mpls_tunnel_dump)                       \
  57 _(SW_INTERFACE_SET_MPLS_ENABLE, sw_interface_set_mpls_enable) \
  58 _(MPLS_TABLE_DUMP, mpls_table_dump)                         \
  59 _(MPLS_ROUTE_DUMP, mpls_route_dump)
  60
  61 void
  62 mpls_table_delete (u32 table_id, u8 is_api)
  63 {
  64   u32 fib_index;
  65
  66   /*
  67    * The MPLS defult table must also be explicitly created via the API.
  68    * So in contrast to IP, it gets no special treatment here.
  69    *
  70    * The API holds only one lock on the table.
  71    * i.e. it can be added many times via the API but needs to be
  72    * deleted only once.
  73    */
  74   fib_index = fib_table_find (FIB_PROTOCOL_MPLS, table_id);
  75
  76   if (~0 != fib_index)
  77     {
  78       fib_table_unlock (fib_index,
  79                         FIB_PROTOCOL_MPLS,
  80                         (is_api ? FIB_SOURCE_API : FIB_SOURCE_CLI));
  81     }
  82 }
  83
  84 void
  85 vl_api_mpls_table_add_del_t_handler (vl_api_mpls_table_add_del_t * mp)
  86 {
  87   vl_api_mpls_table_add_del_reply_t *rmp;
  88   vnet_main_t *vnm;
  89   int rv = 0;
  90
  91   vnm = vnet_get_main ();
  92   vnm->api_errno = 0;
  93
  94   if (mp->mt_is_add)
  95     mpls_table_create (ntohl (mp->mt_table.mt_table_id),
  96                        1, mp->mt_table.mt_name);
  97   else
  98     mpls_table_delete (ntohl (mp->mt_table.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   fib_prefix_t pfx;
 111
 112   mpls_fib_index =
 113     fib_table_find (FIB_PROTOCOL_MPLS, ntohl (mp->mb_mpls_table_id));
 114
 115   if (~0 == mpls_fib_index)
 116     {
 117       return VNET_API_ERROR_NO_SUCH_FIB;
 118     }
 119
 120   ip_prefix_decode (&mp->mb_prefix, &pfx);
 121
 122   ip_fib_index = fib_table_find (pfx.fp_proto, ntohl (mp->mb_ip_table_id));
 123   if (~0 == ip_fib_index)
 124     return VNET_API_ERROR_NO_SUCH_FIB;
 125
 126   if (mp->mb_is_bind)
 127     fib_table_entry_local_label_add (ip_fib_index, &pfx,
 128                                      ntohl (mp->mb_label));
 129   else
 130     fib_table_entry_local_label_remove (ip_fib_index, &pfx,
 131                                         ntohl (mp->mb_label));
 132
 133   return (0);
 134 }
 135
 136 void
 137 vl_api_mpls_ip_bind_unbind_t_handler (vl_api_mpls_ip_bind_unbind_t * mp)
 138 {
 139   vl_api_mpls_ip_bind_unbind_reply_t *rmp;
 140   vnet_main_t *vnm;
 141   int rv;
 142
 143   vnm = vnet_get_main ();
 144   vnm->api_errno = 0;
 145
 146   rv = mpls_ip_bind_unbind_handler (vnm, mp);
 147   rv = (rv == 0) ? vnm->api_errno : rv;
 148
 149   REPLY_MACRO (VL_API_MPLS_IP_BIND_UNBIND_REPLY);
 150 }
 151
 152 static int
 153 mpls_route_add_del_t_handler (vnet_main_t * vnm,
 154                               vl_api_mpls_route_add_del_t * mp,
 155                               u32 * stats_index)
 156 {
 157   fib_route_path_t *rpaths = NULL, *rpath;
 158   vl_api_fib_path_t *apath;
 159   u32 fib_index;
 160   int rv, ii;
 161
 162   fib_prefix_t pfx = {
 163     .fp_len = 21,
 164     .fp_proto = FIB_PROTOCOL_MPLS,
 165     .fp_eos = mp->mr_route.mr_eos,
 166     .fp_label = ntohl (mp->mr_route.mr_label),
 167   };
 168   if (pfx.fp_eos)
 169     {
 170       pfx.fp_payload_proto = mp->mr_route.mr_eos_proto;
 171     }
 172   else
 173     {
 174       pfx.fp_payload_proto = DPO_PROTO_MPLS;
 175     }
 176
 177   rv = fib_api_table_id_decode (FIB_PROTOCOL_MPLS,
 178                                 ntohl (mp->mr_route.mr_table_id), &fib_index);
 179   if (0 != rv)
 180     goto out;
 181
 182   vec_validate (rpaths, mp->mr_route.mr_n_paths - 1);
 183
 184   for (ii = 0; ii < mp->mr_route.mr_n_paths; ii++)
 185     {
 186       apath = &mp->mr_route.mr_paths[ii];
 187       rpath = &rpaths[ii];
 188
 189       rv = fib_api_path_decode (apath, rpath);
 190
 191       if (0 != rv)
 192         goto out;
 193     }
 194
 195   rv = fib_api_route_add_del (
 196     mp->mr_is_add, mp->mr_is_multipath, fib_index, &pfx, FIB_SOURCE_API,
 197     (mp->mr_route.mr_is_multicast ? FIB_ENTRY_FLAG_MULTICAST :
 198                                     FIB_ENTRY_FLAG_NONE),
 199     rpaths);
 200
 201   if (mp->mr_is_add && 0 == rv)
 202     *stats_index = fib_table_entry_get_stats_index (fib_index, &pfx);
 203
 204 out:
 205   vec_free (rpaths);
 206
 207   return (rv);
 208 }
 209
 210 void
 211 vl_api_mpls_route_add_del_t_handler (vl_api_mpls_route_add_del_t * mp)
 212 {
 213   vl_api_mpls_route_add_del_reply_t *rmp;
 214   vnet_main_t *vnm;
 215   u32 stats_index;
 216   int rv;
 217
 218   vnm = vnet_get_main ();
 219   stats_index = ~0;
 220
 221   rv = mpls_route_add_del_t_handler (vnm, mp, &stats_index);
 222
 223   /* *INDENT-OFF* */
 224   REPLY_MACRO2 (VL_API_MPLS_ROUTE_ADD_DEL_REPLY,
 225   ({
 226     rmp->stats_index = htonl (stats_index);
 227   }));
 228   /* *INDENT-ON* */
 229 }
 230
 231 void
 232 mpls_table_create (u32 table_id, u8 is_api, const u8 * name)
 233 {
 234   u32 fib_index;
 235
 236   /*
 237    * The MPLS defult table must also be explicitly created via the API.
 238    * So in contrast to IP, it gets no special treatment here.
 239    */
 240
 241   /*
 242    * The API holds only one lock on the table.
 243    * i.e. it can be added many times via the API but needs to be
 244    * deleted only once.
 245    */
 246   fib_index = fib_table_find (FIB_PROTOCOL_MPLS, table_id);
 247
 248   if (~0 == fib_index)
 249     {
 250       fib_table_find_or_create_and_lock_w_name (FIB_PROTOCOL_MPLS,
 251                                                 table_id,
 252                                                 (is_api ?
 253                                                  FIB_SOURCE_API :
 254                                                  FIB_SOURCE_CLI), name);
 255     }
 256 }
 257
 258 static void
 259 vl_api_mpls_tunnel_add_del_t_handler (vl_api_mpls_tunnel_add_del_t * mp)
 260 {
 261   u32 tunnel_sw_if_index = ~0, tunnel_index = ~0;
 262   vl_api_mpls_tunnel_add_del_reply_t *rmp;
 263   fib_route_path_t *rpath, *rpaths = NULL;
 264   int ii, rv = 0;
 265
 266   vec_validate (rpaths, mp->mt_tunnel.mt_n_paths - 1);
 267
 268   for (ii = 0; ii < mp->mt_tunnel.mt_n_paths; ii++)
 269     {
 270       rpath = &rpaths[ii];
 271
 272       rv = fib_api_path_decode (&mp->mt_tunnel.mt_paths[ii], rpath);
 273
 274       if (0 != rv)
 275         goto out;
 276     }
 277   tunnel_sw_if_index = ntohl (mp->mt_tunnel.mt_sw_if_index);
 278
 279   if (mp->mt_is_add)
 280     {
 281       if (~0 == tunnel_sw_if_index)
 282         tunnel_sw_if_index =
 283           vnet_mpls_tunnel_create (mp->mt_tunnel.mt_l2_only,
 284                                    mp->mt_tunnel.mt_is_multicast,
 285                                    mp->mt_tunnel.mt_tag);
 286       vnet_mpls_tunnel_path_add (tunnel_sw_if_index, rpaths);
 287
 288       tunnel_index = vnet_mpls_tunnel_get_index (tunnel_sw_if_index);
 289     }
 290   else
 291     {
 292       tunnel_index = vnet_mpls_tunnel_get_index (tunnel_sw_if_index);
 293       tunnel_sw_if_index = ntohl (mp->mt_tunnel.mt_sw_if_index);
 294       if (!vnet_mpls_tunnel_path_remove (tunnel_sw_if_index, rpaths))
 295         vnet_mpls_tunnel_del (tunnel_sw_if_index);
 296     }
 297
 298   vec_free (rpaths);
 299
 300 out:
 301   /* *INDENT-OFF* */
 302   REPLY_MACRO2(VL_API_MPLS_TUNNEL_ADD_DEL_REPLY,
 303   ({
 304     rmp->sw_if_index = ntohl(tunnel_sw_if_index);
 305     rmp->tunnel_index = ntohl(tunnel_index);
 306   }));
 307   /* *INDENT-ON* */
 308 }
 309
 310 static void
 311   vl_api_sw_interface_set_mpls_enable_t_handler
 312   (vl_api_sw_interface_set_mpls_enable_t * mp)
 313 {
 314   vl_api_sw_interface_set_mpls_enable_reply_t *rmp;
 315   int rv = 0;
 316
 317   VALIDATE_SW_IF_INDEX (mp);
 318
 319   rv = mpls_sw_interface_enable_disable (&mpls_main,
 320                                          ntohl (mp->sw_if_index),
 321                                          mp->enable, 1);
 322
 323   BAD_SW_IF_INDEX_LABEL;
 324   REPLY_MACRO (VL_API_SW_INTERFACE_SET_MPLS_ENABLE_REPLY);
 325 }
 326
 327 typedef struct mpls_tunnel_send_walk_ctx_t_
 328 {
 329   vl_api_registration_t *reg;
 330   u32 sw_if_index;
 331   u32 context;
 332 } mpls_tunnel_send_walk_ctx_t;
 333
 334 static void
 335 send_mpls_tunnel_entry (u32 mti, void *arg)
 336 {
 337   mpls_tunnel_send_walk_ctx_t *ctx;
 338   vl_api_mpls_tunnel_details_t *mp;
 339   fib_path_encode_ctx_t path_ctx = {
 340     .rpaths = NULL,
 341   };
 342   const mpls_tunnel_t *mt;
 343   fib_route_path_t *rpath;
 344   vl_api_fib_path_t *fp;
 345   u32 n;
 346
 347   ctx = arg;
 348
 349   mt = mpls_tunnel_get (mti);
 350
 351   if (~0 != ctx->sw_if_index && mt->mt_sw_if_index != ctx->sw_if_index)
 352     return;
 353
 354   n = fib_path_list_get_n_paths (mt->mt_path_list);
 355
 356   mp = vl_msg_api_alloc (sizeof (*mp) + n * sizeof (vl_api_fib_path_t));
 357   clib_memset (mp, 0, sizeof (*mp) + n * sizeof (vl_api_fib_path_t));
 358
 359   mp->_vl_msg_id = ntohs (VL_API_MPLS_TUNNEL_DETAILS);
 360   mp->context = ctx->context;
 361
 362   mp->mt_tunnel.mt_n_paths = n;
 363   mp->mt_tunnel.mt_sw_if_index = ntohl (mt->mt_sw_if_index);
 364   mp->mt_tunnel.mt_tunnel_index = ntohl (mti);
 365   mp->mt_tunnel.mt_l2_only = ! !(MPLS_TUNNEL_FLAG_L2 & mt->mt_flags);
 366   mp->mt_tunnel.mt_is_multicast = ! !(MPLS_TUNNEL_FLAG_MCAST & mt->mt_flags);
 367   memcpy (mp->mt_tunnel.mt_tag, mt->mt_tag, sizeof (mp->mt_tunnel.mt_tag));
 368
 369   fib_path_list_walk_w_ext (mt->mt_path_list,
 370                             &mt->mt_path_exts, fib_path_encode, &path_ctx);
 371
 372   fp = mp->mt_tunnel.mt_paths;
 373   vec_foreach (rpath, path_ctx.rpaths)
 374   {
 375     fib_api_path_encode (rpath, fp);
 376     fp++;
 377   }
 378
 379   vl_api_send_msg (ctx->reg, (u8 *) mp);
 380
 381   vec_free (path_ctx.rpaths);
 382 }
 383
 384 static void
 385 vl_api_mpls_tunnel_dump_t_handler (vl_api_mpls_tunnel_dump_t * mp)
 386 {
 387   vl_api_registration_t *reg;
 388
 389   reg = vl_api_client_index_to_registration (mp->client_index);
 390   if (!reg)
 391     return;
 392
 393   mpls_tunnel_send_walk_ctx_t ctx = {
 394     .reg = reg,
 395     .sw_if_index = ntohl (mp->sw_if_index),
 396     .context = mp->context,
 397   };
 398   mpls_tunnel_walk (send_mpls_tunnel_entry, &ctx);
 399 }
 400
 401 static void
 402 send_mpls_table_details (vpe_api_main_t * am,
 403                          vl_api_registration_t * reg,
 404                          u32 context, const fib_table_t * table)
 405 {
 406   vl_api_mpls_table_details_t *mp;
 407
 408   mp = vl_msg_api_alloc (sizeof (*mp));
 409   memset (mp, 0, sizeof (*mp));
 410   mp->_vl_msg_id = ntohs (VL_API_MPLS_TABLE_DETAILS);
 411   mp->context = context;
 412
 413   mp->mt_table.mt_table_id = htonl (table->ft_table_id);
 414   memcpy (mp->mt_table.mt_name,
 415           table->ft_desc,
 416           clib_min (vec_len (table->ft_desc), sizeof (mp->mt_table.mt_name)));
 417
 418   vl_api_send_msg (reg, (u8 *) mp);
 419 }
 420
 421 static void
 422 vl_api_mpls_table_dump_t_handler (vl_api_mpls_table_dump_t * mp)
 423 {
 424   vpe_api_main_t *am = &vpe_api_main;
 425   vl_api_registration_t *reg;
 426   mpls_main_t *mm = &mpls_main;
 427   fib_table_t *fib_table;
 428
 429   reg = vl_api_client_index_to_registration (mp->client_index);
 430   if (!reg)
 431     return;
 432
 433   /* *INDENT-OFF* */
 434   pool_foreach (fib_table, mm->fibs)
 435    {
 436     send_mpls_table_details(am, reg, mp->context, fib_table);
 437   }
 438   /* *INDENT-ON* */
 439 }
 440
 441 static void
 442 send_mpls_route_details (vpe_api_main_t * am,
 443                          vl_api_registration_t * reg,
 444                          u32 context, fib_node_index_t fib_entry_index)
 445 {
 446   fib_route_path_t *rpaths, *rpath;
 447   vl_api_mpls_route_details_t *mp;
 448   const fib_prefix_t *pfx;
 449   vl_api_fib_path_t *fp;
 450   int path_count;
 451
 452   rpaths = fib_entry_encode (fib_entry_index);
 453   pfx = fib_entry_get_prefix (fib_entry_index);
 454
 455   path_count = vec_len (rpaths);
 456   mp = vl_msg_api_alloc (sizeof (*mp) + path_count * sizeof (*fp));
 457   if (!mp)
 458     return;
 459   clib_memset (mp, 0, sizeof (*mp));
 460   mp->_vl_msg_id = ntohs (VL_API_MPLS_ROUTE_DETAILS);
 461   mp->context = context;
 462
 463   mp->mr_route.mr_table_id =
 464     htonl (fib_table_get_table_id
 465            (fib_entry_get_fib_index (fib_entry_index), pfx->fp_proto));
 466   mp->mr_route.mr_eos = pfx->fp_eos;
 467   mp->mr_route.mr_eos_proto = pfx->fp_payload_proto;
 468   mp->mr_route.mr_label = htonl (pfx->fp_label);
 469
 470   mp->mr_route.mr_n_paths = path_count;
 471   fp = mp->mr_route.mr_paths;
 472   vec_foreach (rpath, rpaths)
 473   {
 474     fib_api_path_encode (rpath, fp);
 475     fp++;
 476   }
 477
 478   vec_free (rpaths);
 479   vl_api_send_msg (reg, (u8 *) mp);
 480 }
 481
 482 typedef struct vl_api_mpls_route_dump_table_walk_ctx_t_
 483 {
 484   fib_node_index_t *lfeis;
 485 } vl_api_mpls_route_dump_table_walk_ctx_t;
 486
 487 static fib_table_walk_rc_t
 488 vl_api_mpls_route_dump_table_walk (fib_node_index_t fei, void *arg)
 489 {
 490   vl_api_mpls_route_dump_table_walk_ctx_t *ctx = arg;
 491
 492   vec_add1 (ctx->lfeis, fei);
 493
 494   return (FIB_TABLE_WALK_CONTINUE);
 495 }
 496
 497 static void
 498 vl_api_mpls_route_dump_t_handler (vl_api_mpls_route_dump_t * mp)
 499 {
 500   vpe_api_main_t *am = &vpe_api_main;
 501   vl_api_registration_t *reg;
 502   fib_node_index_t *lfeip = NULL;
 503   vl_api_mpls_route_dump_table_walk_ctx_t ctx = {
 504     .lfeis = NULL,
 505   };
 506   u32 fib_index;
 507
 508   reg = vl_api_client_index_to_registration (mp->client_index);
 509   if (!reg)
 510     return;
 511
 512   fib_index = fib_table_find (FIB_PROTOCOL_MPLS,
 513                               ntohl (mp->table.mt_table_id));
 514
 515   if (INDEX_INVALID != fib_index)
 516     {
 517       fib_table_walk (fib_index,
 518                       FIB_PROTOCOL_MPLS,
 519                       vl_api_mpls_route_dump_table_walk, &ctx);
 520       vec_sort_with_function (ctx.lfeis, fib_entry_cmp_for_sort);
 521
 522       vec_foreach (lfeip, ctx.lfeis)
 523       {
 524         send_mpls_route_details (am, reg, mp->context, *lfeip);
 525       }
 526
 527       vec_free (ctx.lfeis);
 528     }
 529 }
 530
 531 /*
 532  * mpls_api_hookup
 533  * Add vpe's API message handlers to the table.
 534  * vlib has already mapped shared memory and
 535  * added the client registration handlers.
 536  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
 537  */
 538 #define vl_msg_name_crc_list
 539 #include <vnet/vnet_all_api_h.h>
 540 #undef vl_msg_name_crc_list
 541
 542 static void
 543 setup_message_id_table (api_main_t * am)
 544 {
 545 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
 546   foreach_vl_msg_name_crc_mpls;
 547 #undef _
 548 }
 549
 550 static clib_error_t *
 551 mpls_api_hookup (vlib_main_t * vm)
 552 {
 553   api_main_t *am = vlibapi_get_main ();
 554
 555 #define _(N,n)                                                  \
 556     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
 557                            vl_api_##n##_t_handler,              \
 558                            vl_noop_handler,                     \
 559                            vl_api_##n##_t_endian,               \
 560                            vl_api_##n##_t_print,                \
 561                            sizeof(vl_api_##n##_t), 1);
 562   foreach_vpe_api_msg;
 563 #undef _
 564
 565   /*
 566    * Trace space for 8 MPLS encap labels
 567    */
 568   am->api_trace_cfg[VL_API_MPLS_TUNNEL_ADD_DEL].size += 8 * sizeof (u32);
 569
 570   /*
 571    * Set up the (msg_name, crc, message-id) table
 572    */
 573   setup_message_id_table (am);
 574
 575   return 0;
 576 }
 577
 578 VLIB_API_INIT_FUNCTION (mpls_api_hookup);
 579
 580 /*
 581  * fd.io coding-style-patch-verification: ON
 582  *
 583  * Local Variables:
 584  * eval: (c-set-style "gnu")
 585  * End:
 586  */