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 _(MPLS_FIB_DUMP, mpls_fib_dump)
  57
  58 extern void stats_dslock_with_hint (int hint, int tag);
  59 extern void stats_dsunlock (void);
  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_id), 1, mp->mt_name);
  96   else
  97     mpls_table_delete (ntohl (mp->mt_table_id), 1);
  98
  99   // NB: Nothing sets rv; none of the above returns an error
 100
 101   REPLY_MACRO (VL_API_MPLS_TABLE_ADD_DEL_REPLY);
 102 }
 103
 104 static int
 105 mpls_ip_bind_unbind_handler (vnet_main_t * vnm,
 106                              vl_api_mpls_ip_bind_unbind_t * mp)
 107 {
 108   u32 mpls_fib_index, ip_fib_index;
 109
 110   mpls_fib_index =
 111     fib_table_find (FIB_PROTOCOL_MPLS, ntohl (mp->mb_mpls_table_id));
 112
 113   if (~0 == mpls_fib_index)
 114     {
 115       return VNET_API_ERROR_NO_SUCH_FIB;
 116     }
 117
 118   ip_fib_index = fib_table_find ((mp->mb_is_ip4 ?
 119                                   FIB_PROTOCOL_IP4 :
 120                                   FIB_PROTOCOL_IP6),
 121                                  ntohl (mp->mb_ip_table_id));
 122   if (~0 == ip_fib_index)
 123     return VNET_API_ERROR_NO_SUCH_FIB;
 124
 125   fib_prefix_t pfx = {
 126     .fp_len = mp->mb_address_length,
 127   };
 128
 129   if (mp->mb_is_ip4)
 130     {
 131       pfx.fp_proto = FIB_PROTOCOL_IP4;
 132       clib_memcpy (&pfx.fp_addr.ip4, mp->mb_address,
 133                    sizeof (pfx.fp_addr.ip4));
 134     }
 135   else
 136     {
 137       pfx.fp_proto = FIB_PROTOCOL_IP6;
 138       clib_memcpy (&pfx.fp_addr.ip6, mp->mb_address,
 139                    sizeof (pfx.fp_addr.ip6));
 140     }
 141
 142   if (mp->mb_is_bind)
 143     fib_table_entry_local_label_add (ip_fib_index, &pfx,
 144                                      ntohl (mp->mb_label));
 145   else
 146     fib_table_entry_local_label_remove (ip_fib_index, &pfx,
 147                                         ntohl (mp->mb_label));
 148
 149   return (0);
 150 }
 151
 152 void
 153 vl_api_mpls_ip_bind_unbind_t_handler (vl_api_mpls_ip_bind_unbind_t * mp)
 154 {
 155   vl_api_mpls_ip_bind_unbind_reply_t *rmp;
 156   vnet_main_t *vnm;
 157   int rv;
 158
 159   vnm = vnet_get_main ();
 160   vnm->api_errno = 0;
 161
 162   rv = mpls_ip_bind_unbind_handler (vnm, mp);
 163   rv = (rv == 0) ? vnm->api_errno : rv;
 164
 165   REPLY_MACRO (VL_API_MPLS_IP_BIND_UNBIND_REPLY);
 166 }
 167
 168 static int
 169 mpls_route_add_del_t_handler (vnet_main_t * vnm,
 170                               vl_api_mpls_route_add_del_t * mp)
 171 {
 172   u32 fib_index, next_hop_fib_index;
 173   mpls_label_t *label_stack = NULL;
 174   int rv, ii, n_labels;;
 175
 176   fib_prefix_t pfx = {
 177     .fp_len = 21,
 178     .fp_proto = FIB_PROTOCOL_MPLS,
 179     .fp_eos = mp->mr_eos,
 180     .fp_label = ntohl (mp->mr_label),
 181   };
 182   if (pfx.fp_eos)
 183     {
 184       pfx.fp_payload_proto = mp->mr_next_hop_proto;
 185     }
 186   else
 187     {
 188       pfx.fp_payload_proto = DPO_PROTO_MPLS;
 189     }
 190
 191   rv = add_del_route_check (FIB_PROTOCOL_MPLS,
 192                             mp->mr_table_id,
 193                             mp->mr_next_hop_sw_if_index,
 194                             pfx.fp_payload_proto,
 195                             mp->mr_next_hop_table_id,
 196                             mp->mr_is_rpf_id,
 197                             &fib_index, &next_hop_fib_index);
 198
 199   if (0 != rv)
 200     return (rv);
 201
 202   ip46_address_t nh;
 203   memset (&nh, 0, sizeof (nh));
 204
 205   if (DPO_PROTO_IP4 == mp->mr_next_hop_proto)
 206     memcpy (&nh.ip4, mp->mr_next_hop, sizeof (nh.ip4));
 207   else if (DPO_PROTO_IP6 == mp->mr_next_hop_proto)
 208     memcpy (&nh.ip6, mp->mr_next_hop, sizeof (nh.ip6));
 209
 210   n_labels = mp->mr_next_hop_n_out_labels;
 211   if (n_labels == 0)
 212     ;
 213   else if (1 == n_labels)
 214     vec_add1 (label_stack, ntohl (mp->mr_next_hop_out_label_stack[0]));
 215   else
 216     {
 217       vec_validate (label_stack, n_labels - 1);
 218       for (ii = 0; ii < n_labels; ii++)
 219         label_stack[ii] = ntohl (mp->mr_next_hop_out_label_stack[ii]);
 220     }
 221
 222   /* *INDENT-OFF* */
 223   return (add_del_route_t_handler (mp->mr_is_multipath, mp->mr_is_add,
 224                                    0,   // mp->is_drop,
 225                                    0,   // mp->is_unreach,
 226                                    0,   // mp->is_prohibit,
 227                                    0,   // mp->is_local,
 228                                    mp->mr_is_multicast,
 229                                    mp->mr_is_classify,
 230                                    mp->mr_classify_table_index,
 231                                    mp->mr_is_resolve_host,
 232                                    mp->mr_is_resolve_attached,
 233                                    mp->mr_is_interface_rx,
 234                                    mp->mr_is_rpf_id,
 235                                    0,   // l2_bridged
 236                                    0,   // is source_lookup
 237                                    fib_index, &pfx,
 238                                    mp->mr_next_hop_proto,
 239                                    &nh, ntohl (mp->mr_next_hop_sw_if_index),
 240                                    next_hop_fib_index,
 241                                    mp->mr_next_hop_weight,
 242                                    mp->mr_next_hop_preference,
 243                                    ntohl (mp->mr_next_hop_via_label),
 244                                    label_stack));
 245   /* *INDENT-ON* */
 246 }
 247
 248 void
 249 vl_api_mpls_route_add_del_t_handler (vl_api_mpls_route_add_del_t * mp)
 250 {
 251   vl_api_mpls_route_add_del_reply_t *rmp;
 252   vnet_main_t *vnm;
 253   int rv;
 254
 255   vnm = vnet_get_main ();
 256   vnm->api_errno = 0;
 257
 258   rv = mpls_route_add_del_t_handler (vnm, mp);
 259
 260   rv = (rv == 0) ? vnm->api_errno : rv;
 261
 262   REPLY_MACRO (VL_API_MPLS_ROUTE_ADD_DEL_REPLY);
 263 }
 264
 265 void
 266 mpls_table_create (u32 table_id, u8 is_api, const u8 * name)
 267 {
 268   u32 fib_index;
 269
 270   /*
 271    * The MPLS defult table must also be explicitly created via the API.
 272    * So in contrast to IP, it gets no special treatment here.
 273    */
 274
 275   /*
 276    * The API holds only one lock on the table.
 277    * i.e. it can be added many times via the API but needs to be
 278    * deleted only once.
 279    */
 280   fib_index = fib_table_find (FIB_PROTOCOL_MPLS, table_id);
 281
 282   if (~0 == fib_index)
 283     {
 284       fib_table_find_or_create_and_lock_w_name (FIB_PROTOCOL_MPLS,
 285                                                 table_id,
 286                                                 (is_api ?
 287                                                  FIB_SOURCE_API :
 288                                                  FIB_SOURCE_CLI), name);
 289     }
 290 }
 291
 292 static void
 293 vl_api_mpls_tunnel_add_del_t_handler (vl_api_mpls_tunnel_add_del_t * mp)
 294 {
 295   vl_api_mpls_tunnel_add_del_reply_t *rmp;
 296   int rv = 0;
 297   u32 tunnel_sw_if_index;
 298   int ii;
 299   fib_route_path_t rpath, *rpaths = NULL;
 300
 301   memset (&rpath, 0, sizeof (rpath));
 302
 303   stats_dslock_with_hint (1 /* release hint */ , 5 /* tag */ );
 304
 305   if (mp->mt_next_hop_proto_is_ip4)
 306     {
 307       rpath.frp_proto = DPO_PROTO_IP4;
 308       clib_memcpy (&rpath.frp_addr.ip4,
 309                    mp->mt_next_hop, sizeof (rpath.frp_addr.ip4));
 310     }
 311   else
 312     {
 313       rpath.frp_proto = DPO_PROTO_IP6;
 314       clib_memcpy (&rpath.frp_addr.ip6,
 315                    mp->mt_next_hop, sizeof (rpath.frp_addr.ip6));
 316     }
 317   rpath.frp_sw_if_index = ntohl (mp->mt_next_hop_sw_if_index);
 318   rpath.frp_weight = 1;
 319
 320   if (mp->mt_is_add)
 321     {
 322       for (ii = 0; ii < mp->mt_next_hop_n_out_labels; ii++)
 323         vec_add1 (rpath.frp_label_stack,
 324                   ntohl (mp->mt_next_hop_out_label_stack[ii]));
 325     }
 326
 327   vec_add1 (rpaths, rpath);
 328
 329   tunnel_sw_if_index = ntohl (mp->mt_sw_if_index);
 330
 331   if (mp->mt_is_add)
 332     {
 333       if (~0 == tunnel_sw_if_index)
 334         tunnel_sw_if_index = vnet_mpls_tunnel_create (mp->mt_l2_only,
 335                                                       mp->mt_is_multicast);
 336       vnet_mpls_tunnel_path_add (tunnel_sw_if_index, rpaths);
 337     }
 338   else
 339     {
 340       tunnel_sw_if_index = ntohl (mp->mt_sw_if_index);
 341       if (!vnet_mpls_tunnel_path_remove (tunnel_sw_if_index, rpaths))
 342         vnet_mpls_tunnel_del (tunnel_sw_if_index);
 343     }
 344
 345   vec_free (rpaths);
 346
 347   stats_dsunlock ();
 348
 349   /* *INDENT-OFF* */
 350   REPLY_MACRO2(VL_API_MPLS_TUNNEL_ADD_DEL_REPLY,
 351   ({
 352     rmp->sw_if_index = ntohl(tunnel_sw_if_index);
 353   }));
 354   /* *INDENT-ON* */
 355 }
 356
 357 typedef struct mpls_tunnel_send_walk_ctx_t_
 358 {
 359   unix_shared_memory_queue_t *q;
 360   u32 index;
 361   u32 context;
 362 } mpls_tunnel_send_walk_ctx_t;
 363
 364 static void
 365 send_mpls_tunnel_entry (u32 mti, void *arg)
 366 {
 367   fib_route_path_encode_t *api_rpaths, *api_rpath;
 368   mpls_tunnel_send_walk_ctx_t *ctx;
 369   vl_api_mpls_tunnel_details_t *mp;
 370   const mpls_tunnel_t *mt;
 371   vl_api_fib_path2_t *fp;
 372   u32 n;
 373
 374   ctx = arg;
 375
 376   if (~0 != ctx->index && mti != ctx->index)
 377     return;
 378
 379   mt = mpls_tunnel_get (mti);
 380   n = fib_path_list_get_n_paths (mt->mt_path_list);
 381
 382   mp = vl_msg_api_alloc (sizeof (*mp) + n * sizeof (vl_api_fib_path2_t));
 383   memset (mp, 0, sizeof (*mp) + n * sizeof (vl_api_fib_path2_t));
 384
 385   mp->_vl_msg_id = ntohs (VL_API_MPLS_TUNNEL_DETAILS);
 386   mp->context = ctx->context;
 387
 388   mp->mt_tunnel_index = ntohl (mti);
 389   mp->mt_count = ntohl (n);
 390
 391   fib_path_list_walk (mt->mt_path_list, fib_path_encode, &api_rpaths);
 392
 393   fp = mp->mt_paths;
 394   vec_foreach (api_rpath, api_rpaths)
 395   {
 396     memset (fp, 0, sizeof (*fp));
 397
 398     fp->weight = api_rpath->rpath.frp_weight;
 399     fp->preference = api_rpath->rpath.frp_preference;
 400     fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
 401     copy_fib_next_hop (api_rpath, fp);
 402     fp++;
 403   }
 404
 405   // FIXME
 406   // memcpy (mp->mt_next_hop_out_labels,
 407   //   mt->mt_label_stack, nlabels * sizeof (u32));
 408
 409
 410   vl_msg_api_send_shmem (ctx->q, (u8 *) & mp);
 411 }
 412
 413 static void
 414 vl_api_mpls_tunnel_dump_t_handler (vl_api_mpls_tunnel_dump_t * mp)
 415 {
 416   unix_shared_memory_queue_t *q;
 417
 418   q = vl_api_client_index_to_input_queue (mp->client_index);
 419   if (q == 0)
 420     return;
 421
 422   mpls_tunnel_send_walk_ctx_t ctx = {
 423     .q = q,
 424     .index = ntohl (mp->tunnel_index),
 425     .context = mp->context,
 426   };
 427   mpls_tunnel_walk (send_mpls_tunnel_entry, &ctx);
 428 }
 429
 430 static void
 431 send_mpls_fib_details (vpe_api_main_t * am,
 432                        unix_shared_memory_queue_t * q,
 433                        const fib_table_t * table,
 434                        u32 label, u32 eos,
 435                        fib_route_path_encode_t * api_rpaths, u32 context)
 436 {
 437   vl_api_mpls_fib_details_t *mp;
 438   fib_route_path_encode_t *api_rpath;
 439   vl_api_fib_path2_t *fp;
 440   int path_count;
 441
 442   path_count = vec_len (api_rpaths);
 443   mp = vl_msg_api_alloc (sizeof (*mp) + path_count * sizeof (*fp));
 444   if (!mp)
 445     return;
 446   memset (mp, 0, sizeof (*mp));
 447   mp->_vl_msg_id = ntohs (VL_API_MPLS_FIB_DETAILS);
 448   mp->context = context;
 449
 450   mp->table_id = htonl (table->ft_table_id);
 451   memcpy (mp->table_name, table->ft_desc,
 452           clib_min (vec_len (table->ft_desc), sizeof (mp->table_name)));
 453   mp->eos_bit = eos;
 454   mp->label = htonl (label);
 455
 456   mp->count = htonl (path_count);
 457   fp = mp->path;
 458   vec_foreach (api_rpath, api_rpaths)
 459   {
 460     memset (fp, 0, sizeof (*fp));
 461     fp->weight = api_rpath->rpath.frp_weight;
 462     fp->preference = api_rpath->rpath.frp_preference;
 463     fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
 464     copy_fib_next_hop (api_rpath, fp);
 465     fp++;
 466   }
 467
 468   vl_msg_api_send_shmem (q, (u8 *) & mp);
 469 }
 470
 471 typedef struct vl_api_mpls_fib_dump_table_walk_ctx_t_
 472 {
 473   fib_node_index_t *lfeis;
 474 } vl_api_mpls_fib_dump_table_walk_ctx_t;
 475
 476 static int
 477 vl_api_mpls_fib_dump_table_walk (fib_node_index_t fei, void *arg)
 478 {
 479   vl_api_mpls_fib_dump_table_walk_ctx_t *ctx = arg;
 480
 481   vec_add1 (ctx->lfeis, fei);
 482
 483   return (1);
 484 }
 485
 486 static void
 487 vl_api_mpls_fib_dump_t_handler (vl_api_mpls_fib_dump_t * mp)
 488 {
 489   vpe_api_main_t *am = &vpe_api_main;
 490   unix_shared_memory_queue_t *q;
 491   mpls_main_t *mm = &mpls_main;
 492   fib_table_t *fib_table;
 493   mpls_fib_t *mpls_fib;
 494   fib_node_index_t *lfeip = NULL;
 495   fib_prefix_t pfx;
 496   u32 fib_index;
 497   fib_route_path_encode_t *api_rpaths;
 498   vl_api_mpls_fib_dump_table_walk_ctx_t ctx = {
 499     .lfeis = NULL,
 500   };
 501
 502   q = vl_api_client_index_to_input_queue (mp->client_index);
 503   if (q == 0)
 504     return;
 505
 506   /* *INDENT-OFF* */
 507   pool_foreach (mpls_fib, mm->mpls_fibs,
 508   ({
 509     mpls_fib_table_walk (mpls_fib,
 510                          vl_api_mpls_fib_dump_table_walk,
 511                          &ctx);
 512   }));
 513   /* *INDENT-ON* */
 514   vec_sort_with_function (ctx.lfeis, fib_entry_cmp_for_sort);
 515
 516   vec_foreach (lfeip, ctx.lfeis)
 517   {
 518     fib_entry_get_prefix (*lfeip, &pfx);
 519     fib_index = fib_entry_get_fib_index (*lfeip);
 520     fib_table = fib_table_get (fib_index, pfx.fp_proto);
 521     api_rpaths = NULL;
 522     fib_entry_encode (*lfeip, &api_rpaths);
 523     send_mpls_fib_details (am, q,
 524                            fib_table, pfx.fp_label,
 525                            pfx.fp_eos, api_rpaths, mp->context);
 526     vec_free (api_rpaths);
 527   }
 528
 529   vec_free (ctx.lfeis);
 530 }
 531
 532 /*
 533  * mpls_api_hookup
 534  * Add vpe's API message handlers to the table.
 535  * vlib has alread mapped shared memory and
 536  * added the client registration handlers.
 537  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
 538  */
 539 #define vl_msg_name_crc_list
 540 #include <vnet/vnet_all_api_h.h>
 541 #undef vl_msg_name_crc_list
 542
 543 static void
 544 setup_message_id_table (api_main_t * am)
 545 {
 546 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
 547   foreach_vl_msg_name_crc_mpls;
 548 #undef _
 549 }
 550
 551 static clib_error_t *
 552 mpls_api_hookup (vlib_main_t * vm)
 553 {
 554   api_main_t *am = &api_main;
 555
 556 #define _(N,n)                                                  \
 557     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
 558                            vl_api_##n##_t_handler,              \
 559                            vl_noop_handler,                     \
 560                            vl_api_##n##_t_endian,               \
 561                            vl_api_##n##_t_print,                \
 562                            sizeof(vl_api_##n##_t), 1);
 563   foreach_vpe_api_msg;
 564 #undef _
 565
 566   /*
 567    * Trace space for 8 MPLS encap labels
 568    */
 569   am->api_trace_cfg[VL_API_MPLS_TUNNEL_ADD_DEL].size += 8 * sizeof (u32);
 570
 571   /*
 572    * Set up the (msg_name, crc, message-id) table
 573    */
 574   setup_message_id_table (am);
 575
 576   return 0;
 577 }
 578
 579 VLIB_API_INIT_FUNCTION (mpls_api_hookup);
 580
 581 /*
 582  * fd.io coding-style-patch-verification: ON
 583  *
 584  * Local Variables:
 585  * eval: (c-set-style "gnu")
 586  * End:
 587  */