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