2 *------------------------------------------------------------------
3 * l2_api.c - layer 2 forwarding api
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:
10 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
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>
29 #include <vnet/vnet_msg_enum.h>
31 #define vl_typedefs /* define message structures */
32 #include <vnet/vnet_all_api_h.h>
35 #define vl_endianfun /* define message structures */
36 #include <vnet/vnet_all_api_h.h>
39 /* instantiate all the print functions we know about */
40 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
42 #include <vnet/vnet_all_api_h.h>
45 #include <vlibapi/api_helper_macros.h>
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_ALL, l2fib_flush_all) \
52 _(L2FIB_FLUSH_INT, l2fib_flush_int) \
53 _(L2FIB_FLUSH_BD, l2fib_flush_bd) \
54 _(L2FIB_ADD_DEL, l2fib_add_del) \
55 _(L2_FLAGS, l2_flags) \
56 _(BRIDGE_DOMAIN_ADD_DEL, bridge_domain_add_del) \
57 _(BRIDGE_DOMAIN_DUMP, bridge_domain_dump) \
58 _(BRIDGE_FLAGS, bridge_flags) \
59 _(L2_INTERFACE_VLAN_TAG_REWRITE, l2_interface_vlan_tag_rewrite) \
60 _(L2_INTERFACE_PBB_TAG_REWRITE, l2_interface_pbb_tag_rewrite) \
61 _(BRIDGE_DOMAIN_SET_MAC_AGE, bridge_domain_set_mac_age)
64 send_l2_xconnect_details (unix_shared_memory_queue_t * q, u32 context,
65 u32 rx_sw_if_index, u32 tx_sw_if_index)
67 vl_api_l2_xconnect_details_t *mp;
69 mp = vl_msg_api_alloc (sizeof (*mp));
70 memset (mp, 0, sizeof (*mp));
71 mp->_vl_msg_id = ntohs (VL_API_L2_XCONNECT_DETAILS);
72 mp->context = context;
73 mp->rx_sw_if_index = htonl (rx_sw_if_index);
74 mp->tx_sw_if_index = htonl (tx_sw_if_index);
76 vl_msg_api_send_shmem (q, (u8 *) & mp);
80 vl_api_l2_xconnect_dump_t_handler (vl_api_l2_xconnect_dump_t * mp)
82 unix_shared_memory_queue_t *q;
83 vnet_main_t *vnm = vnet_get_main ();
84 vnet_interface_main_t *im = &vnm->interface_main;
85 l2input_main_t *l2im = &l2input_main;
86 vnet_sw_interface_t *swif;
87 l2_input_config_t *config;
89 q = vl_api_client_index_to_input_queue (mp->client_index);
94 pool_foreach (swif, im->sw_interfaces,
96 config = vec_elt_at_index (l2im->configs, swif->sw_if_index);
98 send_l2_xconnect_details (q, mp->context, swif->sw_if_index,
99 config->output_sw_if_index);
105 vl_api_l2_fib_clear_table_t_handler (vl_api_l2_fib_clear_table_t * mp)
108 vl_api_l2_fib_clear_table_reply_t *rmp;
110 /* Clear all MACs including static MACs */
111 l2fib_clear_table ();
113 REPLY_MACRO (VL_API_L2_FIB_CLEAR_TABLE_REPLY);
117 send_l2fib_table_entry (vpe_api_main_t * am,
118 unix_shared_memory_queue_t * q,
119 l2fib_entry_key_t * l2fe_key,
120 l2fib_entry_result_t * l2fe_res, u32 context)
122 vl_api_l2_fib_table_entry_t *mp;
124 mp = vl_msg_api_alloc (sizeof (*mp));
125 memset (mp, 0, sizeof (*mp));
126 mp->_vl_msg_id = ntohs (VL_API_L2_FIB_TABLE_ENTRY);
129 ntohl (l2input_main.bd_configs[l2fe_key->fields.bd_index].bd_id);
131 mp->mac = l2fib_make_key (l2fe_key->fields.mac, 0);
132 mp->sw_if_index = ntohl (l2fe_res->fields.sw_if_index);
133 mp->static_mac = l2fe_res->fields.static_mac;
134 mp->filter_mac = l2fe_res->fields.filter;
135 mp->bvi_mac = l2fe_res->fields.bvi;
136 mp->context = context;
138 vl_msg_api_send_shmem (q, (u8 *) & mp);
142 vl_api_l2_fib_table_dump_t_handler (vl_api_l2_fib_table_dump_t * mp)
144 vpe_api_main_t *am = &vpe_api_main;
145 bd_main_t *bdm = &bd_main;
146 l2fib_entry_key_t *l2fe_key = NULL;
147 l2fib_entry_result_t *l2fe_res = NULL;
148 u32 ni, bd_id = ntohl (mp->bd_id);
150 unix_shared_memory_queue_t *q;
153 q = vl_api_client_index_to_input_queue (mp->client_index);
157 /* see l2fib_table_dump: ~0 means "any" */
162 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
169 l2fib_table_dump (bd_index, &l2fe_key, &l2fe_res);
171 vec_foreach_index (ni, l2fe_key)
173 send_l2fib_table_entry (am, q, vec_elt_at_index (l2fe_key, ni),
174 vec_elt_at_index (l2fe_res, ni), mp->context);
181 vl_api_l2fib_add_del_t_handler (vl_api_l2fib_add_del_t * mp)
183 bd_main_t *bdm = &bd_main;
184 l2input_main_t *l2im = &l2input_main;
185 vl_api_l2fib_add_del_reply_t *rmp;
188 u32 sw_if_index = ntohl (mp->sw_if_index);
189 u32 bd_id = ntohl (mp->bd_id);
198 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
201 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
202 goto bad_sw_if_index;
208 filter_mac = mp->filter_mac ? 1 : 0;
211 VALIDATE_SW_IF_INDEX (mp);
212 if (vec_len (l2im->configs) <= sw_if_index)
214 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
215 goto bad_sw_if_index;
219 l2_input_config_t *config;
220 config = vec_elt_at_index (l2im->configs, sw_if_index);
221 if (config->bridge == 0)
223 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
224 goto bad_sw_if_index;
228 static_mac = mp->static_mac ? 1 : 0;
229 bvi_mac = mp->bvi_mac ? 1 : 0;
230 l2fib_add_entry (mac, bd_index, sw_if_index, static_mac, filter_mac,
235 l2fib_del_entry (mac, bd_index);
238 BAD_SW_IF_INDEX_LABEL;
240 REPLY_MACRO (VL_API_L2FIB_ADD_DEL_REPLY);
244 vl_api_l2fib_flush_int_t_handler (vl_api_l2fib_flush_int_t * mp)
247 vlib_main_t *vm = vlib_get_main ();
248 vl_api_l2fib_flush_int_reply_t *rmp;
250 VALIDATE_SW_IF_INDEX (mp);
252 u32 sw_if_index = ntohl (mp->sw_if_index);
253 l2fib_flush_int_mac (vm, sw_if_index);
255 BAD_SW_IF_INDEX_LABEL;
256 REPLY_MACRO (VL_API_L2FIB_FLUSH_INT_REPLY);
260 vl_api_l2fib_flush_all_t_handler (vl_api_l2fib_flush_all_t * mp)
263 vl_api_l2fib_flush_all_reply_t *rmp;
265 l2fib_flush_all_mac (vlib_get_main ());
266 REPLY_MACRO (VL_API_L2FIB_FLUSH_ALL_REPLY);
270 vl_api_l2fib_flush_bd_t_handler (vl_api_l2fib_flush_bd_t * mp)
273 vlib_main_t *vm = vlib_get_main ();
274 bd_main_t *bdm = &bd_main;
275 vl_api_l2fib_flush_bd_reply_t *rmp;
277 u32 bd_id = ntohl (mp->bd_id);
278 uword *p = hash_get (bdm->bd_index_by_bd_id, bd_id);
281 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
284 l2fib_flush_bd_mac (vm, *p);
286 REPLY_MACRO (VL_API_L2FIB_FLUSH_BD_REPLY);
290 vl_api_l2_flags_t_handler (vl_api_l2_flags_t * mp)
292 vl_api_l2_flags_reply_t *rmp;
296 VALIDATE_SW_IF_INDEX (mp);
298 u32 sw_if_index = ntohl (mp->sw_if_index);
299 u32 flags = ntohl (mp->feature_bitmap) & L2INPUT_VALID_MASK;
300 rbm = l2input_intf_bitmap_enable (sw_if_index, flags, mp->is_set);
302 BAD_SW_IF_INDEX_LABEL;
305 REPLY_MACRO2(VL_API_L2_FLAGS_REPLY,
307 rmp->resulting_feature_bitmap = ntohl(rbm);
313 vl_api_bridge_domain_set_mac_age_t_handler (vl_api_bridge_domain_set_mac_age_t
316 vlib_main_t *vm = vlib_get_main ();
317 bd_main_t *bdm = &bd_main;
318 vl_api_bridge_domain_set_mac_age_reply_t *rmp;
320 u32 bd_id = ntohl (mp->bd_id);
325 rv = VNET_API_ERROR_BD_NOT_MODIFIABLE;
329 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
332 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
335 bd_set_mac_age (vm, *p, mp->mac_age);
337 REPLY_MACRO (VL_API_BRIDGE_DOMAIN_SET_MAC_AGE_REPLY);
341 vl_api_bridge_domain_add_del_t_handler (vl_api_bridge_domain_add_del_t * mp)
343 l2_bridge_domain_add_del_args_t a = {
344 .is_add = mp->is_add,
346 .uu_flood = mp->uu_flood,
347 .forward = mp->forward,
349 .arp_term = mp->arp_term,
350 .mac_age = mp->mac_age,
351 .bd_id = ntohl (mp->bd_id),
354 int rv = bd_add_del (&a);
356 vl_api_bridge_domain_add_del_reply_t *rmp;
357 REPLY_MACRO (VL_API_BRIDGE_DOMAIN_ADD_DEL_REPLY);
361 send_bridge_domain_details (unix_shared_memory_queue_t * q,
362 l2_bridge_domain_t * bd_config,
363 u32 n_sw_ifs, u32 context)
365 vl_api_bridge_domain_details_t *mp;
367 mp = vl_msg_api_alloc (sizeof (*mp));
368 memset (mp, 0, sizeof (*mp));
369 mp->_vl_msg_id = ntohs (VL_API_BRIDGE_DOMAIN_DETAILS);
370 mp->bd_id = ntohl (bd_config->bd_id);
371 mp->flood = bd_feature_flood (bd_config);
372 mp->uu_flood = bd_feature_uu_flood (bd_config);
373 mp->forward = bd_feature_forward (bd_config);
374 mp->learn = bd_feature_learn (bd_config);
375 mp->arp_term = bd_feature_arp_term (bd_config);
376 mp->bvi_sw_if_index = ntohl (bd_config->bvi_sw_if_index);
377 mp->mac_age = bd_config->mac_age;
378 mp->n_sw_ifs = ntohl (n_sw_ifs);
379 mp->context = context;
381 vl_msg_api_send_shmem (q, (u8 *) & mp);
385 send_bd_sw_if_details (l2input_main_t * l2im,
386 unix_shared_memory_queue_t * q,
387 l2_flood_member_t * member, u32 bd_id, u32 context)
389 vl_api_bridge_domain_sw_if_details_t *mp;
390 l2_input_config_t *input_cfg;
392 mp = vl_msg_api_alloc (sizeof (*mp));
393 memset (mp, 0, sizeof (*mp));
394 mp->_vl_msg_id = ntohs (VL_API_BRIDGE_DOMAIN_SW_IF_DETAILS);
395 mp->bd_id = ntohl (bd_id);
396 mp->sw_if_index = ntohl (member->sw_if_index);
397 input_cfg = vec_elt_at_index (l2im->configs, member->sw_if_index);
398 mp->shg = input_cfg->shg;
399 mp->context = context;
401 vl_msg_api_send_shmem (q, (u8 *) & mp);
405 vl_api_bridge_domain_dump_t_handler (vl_api_bridge_domain_dump_t * mp)
407 bd_main_t *bdm = &bd_main;
408 l2input_main_t *l2im = &l2input_main;
410 unix_shared_memory_queue_t *q =
411 vl_api_client_index_to_input_queue (mp->client_index);
415 u32 bd_id = ntohl (mp->bd_id);
421 bd_index = 0, end = vec_len (l2im->bd_configs);
424 bd_index = bd_find_index (bdm, bd_id);
431 for (; bd_index < end; bd_index++)
433 l2_bridge_domain_t *bd_config =
434 l2input_bd_config_from_index (l2im, bd_index);
435 /* skip dummy bd_id 0 */
436 if (bd_config && (bd_config->bd_id > 0))
439 l2_flood_member_t *m;
441 n_sw_ifs = vec_len (bd_config->members);
442 send_bridge_domain_details (q, bd_config, n_sw_ifs, mp->context);
444 vec_foreach (m, bd_config->members)
446 send_bd_sw_if_details (l2im, q, m, bd_config->bd_id, mp->context);
453 vl_api_bridge_flags_t_handler (vl_api_bridge_flags_t * mp)
455 vlib_main_t *vm = vlib_get_main ();
456 bd_main_t *bdm = &bd_main;
457 vl_api_bridge_flags_reply_t *rmp;
460 u32 flags = ntohl (mp->feature_bitmap);
461 u32 bd_id = ntohl (mp->bd_id);
464 rv = VNET_API_ERROR_BD_NOT_MODIFIABLE;
468 u32 bd_index = bd_find_index (bdm, bd_id);
471 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
475 bd_set_flags (vm, bd_index, flags, mp->is_set);
479 REPLY_MACRO2(VL_API_BRIDGE_FLAGS_REPLY,
481 rmp->resulting_feature_bitmap = ntohl(flags);
487 vl_api_l2_interface_vlan_tag_rewrite_t_handler
488 (vl_api_l2_interface_vlan_tag_rewrite_t * mp)
491 vl_api_l2_interface_vlan_tag_rewrite_reply_t *rmp;
492 vnet_main_t *vnm = vnet_get_main ();
493 vlib_main_t *vm = vlib_get_main ();
496 VALIDATE_SW_IF_INDEX (mp);
498 vtr_op = ntohl (mp->vtr_op);
500 /* The L2 code is unsuspicious */
503 case L2_VTR_DISABLED:
508 case L2_VTR_TRANSLATE_1_1:
509 case L2_VTR_TRANSLATE_1_2:
510 case L2_VTR_TRANSLATE_2_1:
511 case L2_VTR_TRANSLATE_2_2:
515 rv = VNET_API_ERROR_INVALID_VALUE;
516 goto bad_sw_if_index;
519 rv = l2vtr_configure (vm, vnm, ntohl (mp->sw_if_index), vtr_op,
520 ntohl (mp->push_dot1q), ntohl (mp->tag1),
523 BAD_SW_IF_INDEX_LABEL;
525 REPLY_MACRO (VL_API_L2_INTERFACE_VLAN_TAG_REWRITE_REPLY);
529 vl_api_l2_interface_pbb_tag_rewrite_t_handler
530 (vl_api_l2_interface_pbb_tag_rewrite_t * mp)
532 vl_api_l2_interface_pbb_tag_rewrite_reply_t *rmp;
533 vnet_main_t *vnm = vnet_get_main ();
534 vlib_main_t *vm = vlib_get_main ();
538 VALIDATE_SW_IF_INDEX (mp);
540 vtr_op = ntohl (mp->vtr_op);
544 case L2_VTR_DISABLED:
547 case L2_VTR_TRANSLATE_2_1:
551 rv = VNET_API_ERROR_INVALID_VALUE;
552 goto bad_sw_if_index;
555 rv = l2pbb_configure (vm, vnm, ntohl (mp->sw_if_index), vtr_op,
556 mp->b_dmac, mp->b_smac, ntohs (mp->b_vlanid),
557 ntohl (mp->i_sid), ntohs (mp->outer_tag));
559 BAD_SW_IF_INDEX_LABEL;
561 REPLY_MACRO (VL_API_L2_INTERFACE_PBB_TAG_REWRITE_REPLY);
566 * Add vpe's API message handlers to the table.
567 * vlib has alread mapped shared memory and
568 * added the client registration handlers.
569 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
571 #define vl_msg_name_crc_list
572 #include <vnet/vnet_all_api_h.h>
573 #undef vl_msg_name_crc_list
576 setup_message_id_table (api_main_t * am)
578 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
579 foreach_vl_msg_name_crc_l2;
583 static clib_error_t *
584 l2_api_hookup (vlib_main_t * vm)
586 api_main_t *am = &api_main;
589 vl_msg_api_set_handlers(VL_API_##N, #n, \
590 vl_api_##n##_t_handler, \
592 vl_api_##n##_t_endian, \
593 vl_api_##n##_t_print, \
594 sizeof(vl_api_##n##_t), 1);
599 * Set up the (msg_name, crc, message-id) table
601 setup_message_id_table (am);
606 VLIB_API_INIT_FUNCTION (l2_api_hookup);
609 * fd.io coding-style-patch-verification: ON
612 * eval: (c-set-style "gnu")