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   return (add_del_route_t_handler (mp->mr_is_multipath, mp->mr_is_add, 0,       // mp->is_drop,
 223                                    0,   // mp->is_unreach,
 224                                    0,   // mp->is_prohibit,
 225                                    0,   // mp->is_local,
 226                                    mp->mr_is_multicast,
 227                                    mp->mr_is_classify,
 228                                    mp->mr_classify_table_index,
 229                                    mp->mr_is_resolve_host,
 230                                    mp->mr_is_resolve_attached,
 231                                    mp->mr_is_interface_rx,
 232                                    mp->mr_is_rpf_id,
 233                                    fib_index, &pfx,
 234                                    mp->mr_next_hop_proto,
 235                                    &nh, ntohl (mp->mr_next_hop_sw_if_index),
 236                                    next_hop_fib_index,
 237                                    mp->mr_next_hop_weight,
 238                                    mp->mr_next_hop_preference,
 239                                    ntohl (mp->mr_next_hop_via_label),
 240                                    label_stack));
 241 }
 242
 243 void
 244 vl_api_mpls_route_add_del_t_handler (vl_api_mpls_route_add_del_t * mp)
 245 {
 246   vl_api_mpls_route_add_del_reply_t *rmp;
 247   vnet_main_t *vnm;
 248   int rv;
 249
 250   vnm = vnet_get_main ();
 251   vnm->api_errno = 0;
 252
 253   rv = mpls_route_add_del_t_handler (vnm, mp);
 254
 255   rv = (rv == 0) ? vnm->api_errno : rv;
 256
 257   REPLY_MACRO (VL_API_MPLS_ROUTE_ADD_DEL_REPLY);
 258 }
 259
 260 void
 261 mpls_table_create (u32 table_id, u8 is_api, const u8 * name)
 262 {
 263   u32 fib_index;
 264
 265   /*
 266    * The MPLS defult table must also be explicitly created via the API.
 267    * So in contrast to IP, it gets no special treatment here.
 268    */
 269
 270   /*
 271    * The API holds only one lock on the table.
 272    * i.e. it can be added many times via the API but needs to be
 273    * deleted only once.
 274    */
 275   fib_index = fib_table_find (FIB_PROTOCOL_MPLS, table_id);
 276
 277   if (~0 == fib_index)
 278     {
 279       fib_table_find_or_create_and_lock_w_name (FIB_PROTOCOL_MPLS,
 280                                                 table_id,
 281                                                 (is_api ?
 282                                                  FIB_SOURCE_API :
 283                                                  FIB_SOURCE_CLI), name);
 284     }
 285 }
 286
 287 static void
 288 vl_api_mpls_tunnel_add_del_t_handler (vl_api_mpls_tunnel_add_del_t * mp)
 289 {
 290   vl_api_mpls_tunnel_add_del_reply_t *rmp;
 291   int rv = 0;
 292   u32 tunnel_sw_if_index;
 293   int ii;
 294   fib_route_path_t rpath, *rpaths = NULL;
 295
 296   memset (&rpath, 0, sizeof (rpath));
 297
 298   stats_dslock_with_hint (1 /* release hint */ , 5 /* tag */ );
 299
 300   if (mp->mt_next_hop_proto_is_ip4)
 301     {
 302       rpath.frp_proto = DPO_PROTO_IP4;
 303       clib_memcpy (&rpath.frp_addr.ip4,
 304                    mp->mt_next_hop, sizeof (rpath.frp_addr.ip4));
 305     }
 306   else
 307     {
 308       rpath.frp_proto = DPO_PROTO_IP6;
 309       clib_memcpy (&rpath.frp_addr.ip6,
 310                    mp->mt_next_hop, sizeof (rpath.frp_addr.ip6));
 311     }
 312   rpath.frp_sw_if_index = ntohl (mp->mt_next_hop_sw_if_index);
 313   rpath.frp_weight = 1;
 314
 315   if (mp->mt_is_add)
 316     {
 317       for (ii = 0; ii < mp->mt_next_hop_n_out_labels; ii++)
 318         vec_add1 (rpath.frp_label_stack,
 319                   ntohl (mp->mt_next_hop_out_label_stack[ii]));
 320     }
 321
 322   vec_add1 (rpaths, rpath);
 323
 324   tunnel_sw_if_index = ntohl (mp->mt_sw_if_index);
 325
 326   if (mp->mt_is_add)
 327     {
 328       if (~0 == tunnel_sw_if_index)
 329         tunnel_sw_if_index = vnet_mpls_tunnel_create (mp->mt_l2_only,
 330                                                       mp->mt_is_multicast);
 331       vnet_mpls_tunnel_path_add (tunnel_sw_if_index, rpaths);
 332     }
 333   else
 334     {
 335       tunnel_sw_if_index = ntohl (mp->mt_sw_if_index);
 336       if (!vnet_mpls_tunnel_path_remove (tunnel_sw_if_index, rpaths))
 337         vnet_mpls_tunnel_del (tunnel_sw_if_index);
 338     }
 339
 340   vec_free (rpaths);
 341
 342   stats_dsunlock ();
 343
 344   /* *INDENT-OFF* */
 345   REPLY_MACRO2(VL_API_MPLS_TUNNEL_ADD_DEL_REPLY,
 346   ({
 347     rmp->sw_if_index = ntohl(tunnel_sw_if_index);
 348   }));
 349   /* *INDENT-ON* */
 350 }
 351
 352 typedef struct mpls_tunnel_send_walk_ctx_t_
 353 {
 354   unix_shared_memory_queue_t *q;
 355   u32 index;
 356   u32 context;
 357 } mpls_tunnel_send_walk_ctx_t;
 358
 359 static void
 360 send_mpls_tunnel_entry (u32 mti, void *arg)
 361 {
 362   fib_route_path_encode_t *api_rpaths, *api_rpath;
 363   mpls_tunnel_send_walk_ctx_t *ctx;
 364   vl_api_mpls_tunnel_details_t *mp;
 365   const mpls_tunnel_t *mt;
 366   vl_api_fib_path2_t *fp;
 367   u32 n;
 368
 369   ctx = arg;
 370
 371   if (~0 != ctx->index && mti != ctx->index)
 372     return;
 373
 374   mt = mpls_tunnel_get (mti);
 375   n = fib_path_list_get_n_paths (mt->mt_path_list);
 376
 377   mp = vl_msg_api_alloc (sizeof (*mp) + n * sizeof (vl_api_fib_path2_t));
 378   memset (mp, 0, sizeof (*mp) + n * sizeof (vl_api_fib_path2_t));
 379
 380   mp->_vl_msg_id = ntohs (VL_API_MPLS_TUNNEL_DETAILS);
 381   mp->context = ctx->context;
 382
 383   mp->mt_tunnel_index = ntohl (mti);
 384   mp->mt_count = ntohl (n);
 385
 386   fib_path_list_walk (mt->mt_path_list, fib_path_encode, &api_rpaths);
 387
 388   fp = mp->mt_paths;
 389   vec_foreach (api_rpath, api_rpaths)
 390   {
 391     memset (fp, 0, sizeof (*fp));
 392
 393     fp->weight = api_rpath->rpath.frp_weight;
 394     fp->preference = api_rpath->rpath.frp_preference;
 395     fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
 396     copy_fib_next_hop (api_rpath, fp);
 397     fp++;
 398   }
 399
 400   // FIXME
 401   // memcpy (mp->mt_next_hop_out_labels,
 402   //   mt->mt_label_stack, nlabels * sizeof (u32));
 403
 404
 405   vl_msg_api_send_shmem (ctx->q, (u8 *) & mp);
 406 }
 407
 408 static void
 409 vl_api_mpls_tunnel_dump_t_handler (vl_api_mpls_tunnel_dump_t * mp)
 410 {
 411   unix_shared_memory_queue_t *q;
 412
 413   q = vl_api_client_index_to_input_queue (mp->client_index);
 414   if (q == 0)
 415     return;
 416
 417   mpls_tunnel_send_walk_ctx_t ctx = {
 418     .q = q,
 419     .index = ntohl (mp->tunnel_index),
 420     .context = mp->context,
 421   };
 422   mpls_tunnel_walk (send_mpls_tunnel_entry, &ctx);
 423 }
 424
 425 static void
 426 send_mpls_fib_details (vpe_api_main_t * am,
 427                        unix_shared_memory_queue_t * q,
 428                        const fib_table_t * table,
 429                        u32 label, u32 eos,
 430                        fib_route_path_encode_t * api_rpaths, u32 context)
 431 {
 432   vl_api_mpls_fib_details_t *mp;
 433   fib_route_path_encode_t *api_rpath;
 434   vl_api_fib_path2_t *fp;
 435   int path_count;
 436
 437   path_count = vec_len (api_rpaths);
 438   mp = vl_msg_api_alloc (sizeof (*mp) + path_count * sizeof (*fp));
 439   if (!mp)
 440     return;
 441   memset (mp, 0, sizeof (*mp));
 442   mp->_vl_msg_id = ntohs (VL_API_MPLS_FIB_DETAILS);
 443   mp->context = context;
 444
 445   mp->table_id = htonl (table->ft_table_id);
 446   memcpy (mp->table_name, table->ft_desc,
 447           clib_min (vec_len (table->ft_desc), sizeof (mp->table_name)));
 448   mp->eos_bit = eos;
 449   mp->label = htonl (label);
 450
 451   mp->count = htonl (path_count);
 452   fp = mp->path;
 453   vec_foreach (api_rpath, api_rpaths)
 454   {
 455     memset (fp, 0, sizeof (*fp));
 456     fp->weight = api_rpath->rpath.frp_weight;
 457     fp->preference = api_rpath->rpath.frp_preference;
 458     fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
 459     copy_fib_next_hop (api_rpath, fp);
 460     fp++;
 461   }
 462
 463   vl_msg_api_send_shmem (q, (u8 *) & mp);
 464 }
 465
 466 typedef struct vl_api_mpls_fib_dump_table_walk_ctx_t_
 467 {
 468   fib_node_index_t *lfeis;
 469 } vl_api_mpls_fib_dump_table_walk_ctx_t;
 470
 471 static int
 472 vl_api_mpls_fib_dump_table_walk (fib_node_index_t fei, void *arg)
 473 {
 474   vl_api_mpls_fib_dump_table_walk_ctx_t *ctx = arg;
 475
 476   vec_add1 (ctx->lfeis, fei);
 477
 478   return (1);
 479 }
 480
 481 static void
 482 vl_api_mpls_fib_dump_t_handler (vl_api_mpls_fib_dump_t * mp)
 483 {
 484   vpe_api_main_t *am = &vpe_api_main;
 485   unix_shared_memory_queue_t *q;
 486   mpls_main_t *mm = &mpls_main;
 487   fib_table_t *fib_table;
 488   mpls_fib_t *mpls_fib;
 489   fib_node_index_t *lfeip = NULL;
 490   fib_prefix_t pfx;
 491   u32 fib_index;
 492   fib_route_path_encode_t *api_rpaths;
 493   vl_api_mpls_fib_dump_table_walk_ctx_t ctx = {
 494     .lfeis = NULL,
 495   };
 496
 497   q = vl_api_client_index_to_input_queue (mp->client_index);
 498   if (q == 0)
 499     return;
 500
 501   /* *INDENT-OFF* */
 502   pool_foreach (mpls_fib, mm->mpls_fibs,
 503   ({
 504     mpls_fib_table_walk (mpls_fib,
 505                          vl_api_mpls_fib_dump_table_walk,
 506                          &ctx);
 507   }));
 508   /* *INDENT-ON* */
 509   vec_sort_with_function (ctx.lfeis, fib_entry_cmp_for_sort);
 510
 511   vec_foreach (lfeip, ctx.lfeis)
 512   {
 513     fib_entry_get_prefix (*lfeip, &pfx);
 514     fib_index = fib_entry_get_fib_index (*lfeip);
 515     fib_table = fib_table_get (fib_index, pfx.fp_proto);
 516     api_rpaths = NULL;
 517     fib_entry_encode (*lfeip, &api_rpaths);
 518     send_mpls_fib_details (am, q,
 519                            fib_table, pfx.fp_label,
 520                            pfx.fp_eos, api_rpaths, mp->context);
 521     vec_free (api_rpaths);
 522   }
 523
 524   vec_free (ctx.lfeis);
 525 }
 526
 527 /*
 528  * mpls_api_hookup
 529  * Add vpe's API message handlers to the table.
 530  * vlib has alread mapped shared memory and
 531  * added the client registration handlers.
 532  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
 533  */
 534 #define vl_msg_name_crc_list
 535 #include <vnet/vnet_all_api_h.h>
 536 #undef vl_msg_name_crc_list
 537
 538 static void
 539 setup_message_id_table (api_main_t * am)
 540 {
 541 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
 542   foreach_vl_msg_name_crc_mpls;
 543 #undef _
 544 }
 545
 546 static clib_error_t *
 547 mpls_api_hookup (vlib_main_t * vm)
 548 {
 549   api_main_t *am = &api_main;
 550
 551 #define _(N,n)                                                  \
 552     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
 553                            vl_api_##n##_t_handler,              \
 554                            vl_noop_handler,                     \
 555                            vl_api_##n##_t_endian,               \
 556                            vl_api_##n##_t_print,                \
 557                            sizeof(vl_api_##n##_t), 1);
 558   foreach_vpe_api_msg;
 559 #undef _
 560
 561   /*
 562    * Trace space for 8 MPLS encap labels
 563    */
 564   am->api_trace_cfg[VL_API_MPLS_TUNNEL_ADD_DEL].size += 8 * sizeof (u32);
 565
 566   /*
 567    * Set up the (msg_name, crc, message-id) table
 568    */
 569   setup_message_id_table (am);
 570
 571   return 0;
 572 }
 573
 574 VLIB_API_INIT_FUNCTION (mpls_api_hookup);
 575
 576 /*
 577  * fd.io coding-style-patch-verification: ON
 578  *
 579  * Local Variables:
 580  * eval: (c-set-style "gnu")
 581  * End:
 582  */