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