src/vnet/l2/l2_api.c

   1 /*
   2  *------------------------------------------------------------------
   3  * l2_api.c - layer 2 forwarding 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/l2/l2_input.h>
  26 #include <vnet/l2/l2_fib.h>
  27 #include <vnet/l2/l2_vtr.h>
  28
  29 #include <vnet/vnet_msg_enum.h>
  30
  31 #define vl_typedefs             /* define message structures */
  32 #include <vnet/vnet_all_api_h.h>
  33 #undef vl_typedefs
  34
  35 #define vl_endianfun            /* define message structures */
  36 #include <vnet/vnet_all_api_h.h>
  37 #undef vl_endianfun
  38
  39 /* instantiate all the print functions we know about */
  40 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  41 #define vl_printfun
  42 #include <vnet/vnet_all_api_h.h>
  43 #undef vl_printfun
  44
  45 #include <vlibapi/api_helper_macros.h>
  46
  47 #define foreach_vpe_api_msg                                 \
  48 _(L2_XCONNECT_DUMP, l2_xconnect_dump)                       \
  49 _(L2_FIB_CLEAR_TABLE, l2_fib_clear_table)                   \
  50 _(L2_FIB_TABLE_DUMP, l2_fib_table_dump)                     \
  51 _(L2FIB_FLUSH_INT, l2fib_flush_int)                         \
  52 _(L2FIB_FLUSH_BD, l2fib_flush_bd)                           \
  53 _(L2FIB_ADD_DEL, l2fib_add_del)                             \
  54 _(L2_FLAGS, l2_flags)                                       \
  55 _(BRIDGE_DOMAIN_ADD_DEL, bridge_domain_add_del)             \
  56 _(BRIDGE_DOMAIN_DUMP, bridge_domain_dump)                   \
  57 _(BRIDGE_FLAGS, bridge_flags)                               \
  58 _(L2_INTERFACE_VLAN_TAG_REWRITE, l2_interface_vlan_tag_rewrite) \
  59 _(L2_INTERFACE_PBB_TAG_REWRITE, l2_interface_pbb_tag_rewrite) \
  60 _(BRIDGE_DOMAIN_SET_MAC_AGE, bridge_domain_set_mac_age)
  61
  62 static void
  63 send_l2_xconnect_details (unix_shared_memory_queue_t * q, u32 context,
  64                           u32 rx_sw_if_index, u32 tx_sw_if_index)
  65 {
  66   vl_api_l2_xconnect_details_t *mp;
  67
  68   mp = vl_msg_api_alloc (sizeof (*mp));
  69   memset (mp, 0, sizeof (*mp));
  70   mp->_vl_msg_id = ntohs (VL_API_L2_XCONNECT_DETAILS);
  71   mp->context = context;
  72   mp->rx_sw_if_index = htonl (rx_sw_if_index);
  73   mp->tx_sw_if_index = htonl (tx_sw_if_index);
  74
  75   vl_msg_api_send_shmem (q, (u8 *) & mp);
  76 }
  77
  78 static void
  79 vl_api_l2_xconnect_dump_t_handler (vl_api_l2_xconnect_dump_t * mp)
  80 {
  81   unix_shared_memory_queue_t *q;
  82   vnet_main_t *vnm = vnet_get_main ();
  83   vnet_interface_main_t *im = &vnm->interface_main;
  84   l2input_main_t *l2im = &l2input_main;
  85   vnet_sw_interface_t *swif;
  86   l2_input_config_t *config;
  87
  88   q = vl_api_client_index_to_input_queue (mp->client_index);
  89   if (q == 0)
  90     return;
  91
  92   /* *INDENT-OFF* */
  93   pool_foreach (swif, im->sw_interfaces,
  94   ({
  95     config = vec_elt_at_index (l2im->configs, swif->sw_if_index);
  96     if (config->xconnect)
  97       send_l2_xconnect_details (q, mp->context, swif->sw_if_index,
  98                                 config->output_sw_if_index);
  99   }));
 100   /* *INDENT-ON* */
 101 }
 102
 103 static void
 104 vl_api_l2_fib_clear_table_t_handler (vl_api_l2_fib_clear_table_t * mp)
 105 {
 106   int rv = 0;
 107   vl_api_l2_fib_clear_table_reply_t *rmp;
 108
 109   /* DAW-FIXME: This API should only clear non-static l2fib entries, but
 110    *            that is not currently implemented.  When that TODO is fixed
 111    *            this call should be changed to pass 1 instead of 0.
 112    */
 113   l2fib_clear_table (0);
 114
 115   REPLY_MACRO (VL_API_L2_FIB_CLEAR_TABLE_REPLY);
 116 }
 117
 118 static void
 119 send_l2fib_table_entry (vpe_api_main_t * am,
 120                         unix_shared_memory_queue_t * q,
 121                         l2fib_entry_key_t * l2fe_key,
 122                         l2fib_entry_result_t * l2fe_res, u32 context)
 123 {
 124   vl_api_l2_fib_table_entry_t *mp;
 125
 126   mp = vl_msg_api_alloc (sizeof (*mp));
 127   memset (mp, 0, sizeof (*mp));
 128   mp->_vl_msg_id = ntohs (VL_API_L2_FIB_TABLE_ENTRY);
 129
 130   mp->bd_id =
 131     ntohl (l2input_main.bd_configs[l2fe_key->fields.bd_index].bd_id);
 132
 133   mp->mac = l2fib_make_key (l2fe_key->fields.mac, 0);
 134   mp->sw_if_index = ntohl (l2fe_res->fields.sw_if_index);
 135   mp->static_mac = l2fe_res->fields.static_mac;
 136   mp->filter_mac = l2fe_res->fields.filter;
 137   mp->bvi_mac = l2fe_res->fields.bvi;
 138   mp->context = context;
 139
 140   vl_msg_api_send_shmem (q, (u8 *) & mp);
 141 }
 142
 143 static void
 144 vl_api_l2_fib_table_dump_t_handler (vl_api_l2_fib_table_dump_t * mp)
 145 {
 146   vpe_api_main_t *am = &vpe_api_main;
 147   bd_main_t *bdm = &bd_main;
 148   l2fib_entry_key_t *l2fe_key = NULL;
 149   l2fib_entry_result_t *l2fe_res = NULL;
 150   u32 ni, bd_id = ntohl (mp->bd_id);
 151   u32 bd_index;
 152   unix_shared_memory_queue_t *q;
 153   uword *p;
 154
 155   q = vl_api_client_index_to_input_queue (mp->client_index);
 156   if (q == 0)
 157     return;
 158
 159   /* see l2fib_table_dump: ~0 means "any" */
 160   if (bd_id == ~0)
 161     bd_index = ~0;
 162   else
 163     {
 164       p = hash_get (bdm->bd_index_by_bd_id, bd_id);
 165       if (p == 0)
 166         return;
 167
 168       bd_index = p[0];
 169     }
 170
 171   l2fib_table_dump (bd_index, &l2fe_key, &l2fe_res);
 172
 173   vec_foreach_index (ni, l2fe_key)
 174   {
 175     send_l2fib_table_entry (am, q, vec_elt_at_index (l2fe_key, ni),
 176                             vec_elt_at_index (l2fe_res, ni), mp->context);
 177   }
 178   vec_free (l2fe_key);
 179   vec_free (l2fe_res);
 180 }
 181
 182 static void
 183 vl_api_l2fib_add_del_t_handler (vl_api_l2fib_add_del_t * mp)
 184 {
 185   bd_main_t *bdm = &bd_main;
 186   l2input_main_t *l2im = &l2input_main;
 187   vl_api_l2fib_add_del_reply_t *rmp;
 188   int rv = 0;
 189   u64 mac = 0;
 190   u32 sw_if_index = ntohl (mp->sw_if_index);
 191   u32 bd_id = ntohl (mp->bd_id);
 192   u32 bd_index;
 193   u32 static_mac;
 194   u32 filter_mac;
 195   u32 bvi_mac;
 196   uword *p;
 197
 198   mac = mp->mac;
 199
 200   p = hash_get (bdm->bd_index_by_bd_id, bd_id);
 201   if (!p)
 202     {
 203       rv = VNET_API_ERROR_NO_SUCH_ENTRY;
 204       goto bad_sw_if_index;
 205     }
 206   bd_index = p[0];
 207
 208   if (mp->is_add)
 209     {
 210       filter_mac = mp->filter_mac ? 1 : 0;
 211       if (filter_mac == 0)
 212         {
 213           VALIDATE_SW_IF_INDEX (mp);
 214           if (vec_len (l2im->configs) <= sw_if_index)
 215             {
 216               rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
 217               goto bad_sw_if_index;
 218             }
 219           else
 220             {
 221               l2_input_config_t *config;
 222               config = vec_elt_at_index (l2im->configs, sw_if_index);
 223               if (config->bridge == 0)
 224                 {
 225                   rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
 226                   goto bad_sw_if_index;
 227                 }
 228             }
 229         }
 230       static_mac = mp->static_mac ? 1 : 0;
 231       bvi_mac = mp->bvi_mac ? 1 : 0;
 232       l2fib_add_entry (mac, bd_index, sw_if_index, static_mac, filter_mac,
 233                        bvi_mac);
 234     }
 235   else
 236     {
 237       l2fib_del_entry (mac, bd_index);
 238     }
 239
 240   BAD_SW_IF_INDEX_LABEL;
 241
 242   REPLY_MACRO (VL_API_L2FIB_ADD_DEL_REPLY);
 243 }
 244
 245 static void
 246 vl_api_l2fib_flush_int_t_handler (vl_api_l2fib_flush_int_t * mp)
 247 {
 248   int rv = 0;
 249   vlib_main_t *vm = vlib_get_main ();
 250   vl_api_l2fib_flush_int_reply_t *rmp;
 251
 252   VALIDATE_SW_IF_INDEX (mp);
 253
 254   u32 sw_if_index = ntohl (mp->sw_if_index);
 255   l2fib_flush_int_mac (vm, sw_if_index);
 256
 257   BAD_SW_IF_INDEX_LABEL;
 258   REPLY_MACRO (VL_API_L2FIB_FLUSH_INT_REPLY);
 259 }
 260
 261 static void
 262 vl_api_l2fib_flush_bd_t_handler (vl_api_l2fib_flush_bd_t * mp)
 263 {
 264   int rv = 0;
 265   vlib_main_t *vm = vlib_get_main ();
 266   bd_main_t *bdm = &bd_main;
 267   vl_api_l2fib_flush_bd_reply_t *rmp;
 268
 269   u32 bd_id = ntohl (mp->bd_id);
 270   uword *p = hash_get (bdm->bd_index_by_bd_id, bd_id);
 271   if (p == 0)
 272     {
 273       rv = VNET_API_ERROR_NO_SUCH_ENTRY;
 274       goto out;
 275     }
 276   l2fib_flush_bd_mac (vm, *p);
 277 out:
 278   REPLY_MACRO (VL_API_L2FIB_FLUSH_BD_REPLY);
 279 }
 280
 281 static void
 282 vl_api_l2_flags_t_handler (vl_api_l2_flags_t * mp)
 283 {
 284   vl_api_l2_flags_reply_t *rmp;
 285   int rv = 0;
 286   u32 rbm = 0;
 287
 288   VALIDATE_SW_IF_INDEX (mp);
 289
 290   u32 sw_if_index = ntohl (mp->sw_if_index);
 291   u32 flags = ntohl (mp->feature_bitmap) & L2INPUT_VALID_MASK;
 292   rbm = l2input_intf_bitmap_enable (sw_if_index, flags, mp->is_set);
 293
 294   BAD_SW_IF_INDEX_LABEL;
 295
 296   /* *INDENT-OFF* */
 297   REPLY_MACRO2(VL_API_L2_FLAGS_REPLY,
 298   ({
 299     rmp->resulting_feature_bitmap = ntohl(rbm);
 300   }));
 301   /* *INDENT-ON* */
 302 }
 303
 304 static void
 305 vl_api_bridge_domain_set_mac_age_t_handler (vl_api_bridge_domain_set_mac_age_t
 306                                             * mp)
 307 {
 308   vlib_main_t *vm = vlib_get_main ();
 309   bd_main_t *bdm = &bd_main;
 310   vl_api_bridge_domain_set_mac_age_reply_t *rmp;
 311   int rv = 0;
 312   u32 bd_id = ntohl (mp->bd_id);
 313   uword *p;
 314
 315   if (bd_id == 0)
 316     {
 317       rv = VNET_API_ERROR_BD_NOT_MODIFIABLE;
 318       goto out;
 319     }
 320
 321   p = hash_get (bdm->bd_index_by_bd_id, bd_id);
 322   if (p == 0)
 323     {
 324       rv = VNET_API_ERROR_NO_SUCH_ENTRY;
 325       goto out;
 326     }
 327   bd_set_mac_age (vm, *p, mp->mac_age);
 328 out:
 329   REPLY_MACRO (VL_API_BRIDGE_DOMAIN_SET_MAC_AGE_REPLY);
 330 }
 331
 332 static void
 333 vl_api_bridge_domain_add_del_t_handler (vl_api_bridge_domain_add_del_t * mp)
 334 {
 335   l2_bridge_domain_add_del_args_t a = {
 336     .is_add = mp->is_add,
 337     .flood = mp->flood,
 338     .uu_flood = mp->uu_flood,
 339     .forward = mp->forward,
 340     .learn = mp->learn,
 341     .arp_term = mp->arp_term,
 342     .mac_age = mp->mac_age,
 343     .bd_id = ntohl (mp->bd_id),
 344   };
 345
 346   int rv = bd_add_del (&a);
 347
 348   vl_api_bridge_domain_add_del_reply_t *rmp;
 349   REPLY_MACRO (VL_API_BRIDGE_DOMAIN_ADD_DEL_REPLY);
 350 }
 351
 352 static void
 353 send_bridge_domain_details (unix_shared_memory_queue_t * q,
 354                             l2_bridge_domain_t * bd_config,
 355                             u32 n_sw_ifs, u32 context)
 356 {
 357   vl_api_bridge_domain_details_t *mp;
 358
 359   mp = vl_msg_api_alloc (sizeof (*mp));
 360   memset (mp, 0, sizeof (*mp));
 361   mp->_vl_msg_id = ntohs (VL_API_BRIDGE_DOMAIN_DETAILS);
 362   mp->bd_id = ntohl (bd_config->bd_id);
 363   mp->flood = bd_feature_flood (bd_config);
 364   mp->uu_flood = bd_feature_uu_flood (bd_config);
 365   mp->forward = bd_feature_forward (bd_config);
 366   mp->learn = bd_feature_learn (bd_config);
 367   mp->arp_term = bd_feature_arp_term (bd_config);
 368   mp->bvi_sw_if_index = ntohl (bd_config->bvi_sw_if_index);
 369   mp->mac_age = bd_config->mac_age;
 370   mp->n_sw_ifs = ntohl (n_sw_ifs);
 371   mp->context = context;
 372
 373   vl_msg_api_send_shmem (q, (u8 *) & mp);
 374 }
 375
 376 static void
 377 send_bd_sw_if_details (l2input_main_t * l2im,
 378                        unix_shared_memory_queue_t * q,
 379                        l2_flood_member_t * member, u32 bd_id, u32 context)
 380 {
 381   vl_api_bridge_domain_sw_if_details_t *mp;
 382   l2_input_config_t *input_cfg;
 383
 384   mp = vl_msg_api_alloc (sizeof (*mp));
 385   memset (mp, 0, sizeof (*mp));
 386   mp->_vl_msg_id = ntohs (VL_API_BRIDGE_DOMAIN_SW_IF_DETAILS);
 387   mp->bd_id = ntohl (bd_id);
 388   mp->sw_if_index = ntohl (member->sw_if_index);
 389   input_cfg = vec_elt_at_index (l2im->configs, member->sw_if_index);
 390   mp->shg = input_cfg->shg;
 391   mp->context = context;
 392
 393   vl_msg_api_send_shmem (q, (u8 *) & mp);
 394 }
 395
 396 static void
 397 vl_api_bridge_domain_dump_t_handler (vl_api_bridge_domain_dump_t * mp)
 398 {
 399   bd_main_t *bdm = &bd_main;
 400   l2input_main_t *l2im = &l2input_main;
 401   unix_shared_memory_queue_t *q;
 402   l2_bridge_domain_t *bd_config;
 403   u32 bd_id, bd_index;
 404   u32 end;
 405
 406   q = vl_api_client_index_to_input_queue (mp->client_index);
 407
 408   if (q == 0)
 409     return;
 410
 411   bd_id = ntohl (mp->bd_id);
 412   if (bd_id == 0)
 413     return;
 414
 415   bd_index = (bd_id == ~0) ? 0 : bd_find_index (bdm, bd_id);
 416   ASSERT (bd_index != ~0);
 417   end = (bd_id == ~0) ? vec_len (l2im->bd_configs) : bd_index + 1;
 418
 419   for (; bd_index < end; bd_index++)
 420     {
 421       bd_config = l2input_bd_config_from_index (l2im, bd_index);
 422       /* skip dummy bd_id 0 */
 423       if (bd_config && (bd_config->bd_id > 0))
 424         {
 425           u32 n_sw_ifs;
 426           l2_flood_member_t *m;
 427
 428           n_sw_ifs = vec_len (bd_config->members);
 429           send_bridge_domain_details (q, bd_config, n_sw_ifs, mp->context);
 430
 431           vec_foreach (m, bd_config->members)
 432           {
 433             send_bd_sw_if_details (l2im, q, m, bd_config->bd_id, mp->context);
 434           }
 435         }
 436     }
 437 }
 438
 439 static void
 440 vl_api_bridge_flags_t_handler (vl_api_bridge_flags_t * mp)
 441 {
 442   vlib_main_t *vm = vlib_get_main ();
 443   bd_main_t *bdm = &bd_main;
 444   vl_api_bridge_flags_reply_t *rmp;
 445   int rv = 0;
 446   u32 bd_id = ntohl (mp->bd_id);
 447   u32 bd_index;
 448   u32 flags = ntohl (mp->feature_bitmap);
 449   uword *p;
 450
 451   if (bd_id == 0)
 452     {
 453       rv = VNET_API_ERROR_BD_NOT_MODIFIABLE;
 454       goto out;
 455     }
 456
 457   p = hash_get (bdm->bd_index_by_bd_id, bd_id);
 458   if (p == 0)
 459     {
 460       rv = VNET_API_ERROR_NO_SUCH_ENTRY;
 461       goto out;
 462     }
 463
 464   bd_index = p[0];
 465
 466   bd_set_flags (vm, bd_index, flags, mp->is_set);
 467
 468 out:
 469   /* *INDENT-OFF* */
 470   REPLY_MACRO2(VL_API_BRIDGE_FLAGS_REPLY,
 471   ({
 472     rmp->resulting_feature_bitmap = ntohl(flags);
 473   }));
 474   /* *INDENT-ON* */
 475 }
 476
 477 static void
 478   vl_api_l2_interface_vlan_tag_rewrite_t_handler
 479   (vl_api_l2_interface_vlan_tag_rewrite_t * mp)
 480 {
 481   int rv = 0;
 482   vl_api_l2_interface_vlan_tag_rewrite_reply_t *rmp;
 483   vnet_main_t *vnm = vnet_get_main ();
 484   vlib_main_t *vm = vlib_get_main ();
 485   u32 vtr_op;
 486
 487   VALIDATE_SW_IF_INDEX (mp);
 488
 489   vtr_op = ntohl (mp->vtr_op);
 490
 491   /* The L2 code is unsuspicious */
 492   switch (vtr_op)
 493     {
 494     case L2_VTR_DISABLED:
 495     case L2_VTR_PUSH_1:
 496     case L2_VTR_PUSH_2:
 497     case L2_VTR_POP_1:
 498     case L2_VTR_POP_2:
 499     case L2_VTR_TRANSLATE_1_1:
 500     case L2_VTR_TRANSLATE_1_2:
 501     case L2_VTR_TRANSLATE_2_1:
 502     case L2_VTR_TRANSLATE_2_2:
 503       break;
 504
 505     default:
 506       rv = VNET_API_ERROR_INVALID_VALUE;
 507       goto bad_sw_if_index;
 508     }
 509
 510   rv = l2vtr_configure (vm, vnm, ntohl (mp->sw_if_index), vtr_op,
 511                         ntohl (mp->push_dot1q), ntohl (mp->tag1),
 512                         ntohl (mp->tag2));
 513
 514   BAD_SW_IF_INDEX_LABEL;
 515
 516   REPLY_MACRO (VL_API_L2_INTERFACE_VLAN_TAG_REWRITE_REPLY);
 517 }
 518
 519 static void
 520   vl_api_l2_interface_pbb_tag_rewrite_t_handler
 521   (vl_api_l2_interface_pbb_tag_rewrite_t * mp)
 522 {
 523   vl_api_l2_interface_pbb_tag_rewrite_reply_t *rmp;
 524   vnet_main_t *vnm = vnet_get_main ();
 525   vlib_main_t *vm = vlib_get_main ();
 526   u32 vtr_op;
 527   int rv = 0;
 528
 529   VALIDATE_SW_IF_INDEX (mp);
 530
 531   vtr_op = ntohl (mp->vtr_op);
 532
 533   switch (vtr_op)
 534     {
 535     case L2_VTR_DISABLED:
 536     case L2_VTR_PUSH_2:
 537     case L2_VTR_POP_2:
 538     case L2_VTR_TRANSLATE_2_1:
 539       break;
 540
 541     default:
 542       rv = VNET_API_ERROR_INVALID_VALUE;
 543       goto bad_sw_if_index;
 544     }
 545
 546   rv = l2pbb_configure (vm, vnm, ntohl (mp->sw_if_index), vtr_op,
 547                         mp->b_dmac, mp->b_smac, ntohs (mp->b_vlanid),
 548                         ntohl (mp->i_sid), ntohs (mp->outer_tag));
 549
 550   BAD_SW_IF_INDEX_LABEL;
 551
 552   REPLY_MACRO (VL_API_L2_INTERFACE_PBB_TAG_REWRITE_REPLY);
 553 }
 554
 555 /*
 556  * l2_api_hookup
 557  * Add vpe's API message handlers to the table.
 558  * vlib has alread mapped shared memory and
 559  * added the client registration handlers.
 560  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
 561  */
 562 #define vl_msg_name_crc_list
 563 #include <vnet/vnet_all_api_h.h>
 564 #undef vl_msg_name_crc_list
 565
 566 static void
 567 setup_message_id_table (api_main_t * am)
 568 {
 569 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
 570   foreach_vl_msg_name_crc_l2;
 571 #undef _
 572 }
 573
 574 static clib_error_t *
 575 l2_api_hookup (vlib_main_t * vm)
 576 {
 577   api_main_t *am = &api_main;
 578
 579 #define _(N,n)                                                  \
 580     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
 581                            vl_api_##n##_t_handler,              \
 582                            vl_noop_handler,                     \
 583                            vl_api_##n##_t_endian,               \
 584                            vl_api_##n##_t_print,                \
 585                            sizeof(vl_api_##n##_t), 1);
 586   foreach_vpe_api_msg;
 587 #undef _
 588
 589   /*
 590    * Set up the (msg_name, crc, message-id) table
 591    */
 592   setup_message_id_table (am);
 593
 594   return 0;
 595 }
 596
 597 VLIB_API_INIT_FUNCTION (l2_api_hookup);
 598
 599 /*
 600  * fd.io coding-style-patch-verification: ON
 601  *
 602  * Local Variables:
 603  * eval: (c-set-style "gnu")
 604  * End:
 605  */