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 #define vl_api_bridge_domain_details_t_endian vl_noop_handler
40 #define vl_api_bridge_domain_details_t_print vl_noop_handler
42 /* instantiate all the print functions we know about */
43 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
45 #include <vnet/vnet_all_api_h.h>
48 #include <vlibapi/api_helper_macros.h>
50 #define foreach_vpe_api_msg \
51 _(L2_XCONNECT_DUMP, l2_xconnect_dump) \
52 _(L2_FIB_CLEAR_TABLE, l2_fib_clear_table) \
53 _(L2_FIB_TABLE_DUMP, l2_fib_table_dump) \
54 _(L2FIB_FLUSH_ALL, l2fib_flush_all) \
55 _(L2FIB_FLUSH_INT, l2fib_flush_int) \
56 _(L2FIB_FLUSH_BD, l2fib_flush_bd) \
57 _(L2FIB_ADD_DEL, l2fib_add_del) \
58 _(L2_FLAGS, l2_flags) \
59 _(BRIDGE_DOMAIN_ADD_DEL, bridge_domain_add_del) \
60 _(BRIDGE_DOMAIN_DUMP, bridge_domain_dump) \
61 _(BRIDGE_FLAGS, bridge_flags) \
62 _(L2_INTERFACE_VLAN_TAG_REWRITE, l2_interface_vlan_tag_rewrite) \
63 _(L2_INTERFACE_PBB_TAG_REWRITE, l2_interface_pbb_tag_rewrite) \
64 _(BRIDGE_DOMAIN_SET_MAC_AGE, bridge_domain_set_mac_age)
67 send_l2_xconnect_details (unix_shared_memory_queue_t * q, u32 context,
68 u32 rx_sw_if_index, u32 tx_sw_if_index)
70 vl_api_l2_xconnect_details_t *mp;
72 mp = vl_msg_api_alloc (sizeof (*mp));
73 memset (mp, 0, sizeof (*mp));
74 mp->_vl_msg_id = ntohs (VL_API_L2_XCONNECT_DETAILS);
75 mp->context = context;
76 mp->rx_sw_if_index = htonl (rx_sw_if_index);
77 mp->tx_sw_if_index = htonl (tx_sw_if_index);
79 vl_msg_api_send_shmem (q, (u8 *) & mp);
83 vl_api_l2_xconnect_dump_t_handler (vl_api_l2_xconnect_dump_t * mp)
85 unix_shared_memory_queue_t *q;
86 vnet_main_t *vnm = vnet_get_main ();
87 vnet_interface_main_t *im = &vnm->interface_main;
88 l2input_main_t *l2im = &l2input_main;
89 vnet_sw_interface_t *swif;
90 l2_input_config_t *config;
92 q = vl_api_client_index_to_input_queue (mp->client_index);
97 pool_foreach (swif, im->sw_interfaces,
99 config = vec_elt_at_index (l2im->configs, swif->sw_if_index);
100 if (config->xconnect)
101 send_l2_xconnect_details (q, mp->context, swif->sw_if_index,
102 config->output_sw_if_index);
108 vl_api_l2_fib_clear_table_t_handler (vl_api_l2_fib_clear_table_t * mp)
111 vl_api_l2_fib_clear_table_reply_t *rmp;
113 /* Clear all MACs including static MACs */
114 l2fib_clear_table ();
116 REPLY_MACRO (VL_API_L2_FIB_CLEAR_TABLE_REPLY);
120 send_l2fib_table_entry (vpe_api_main_t * am,
121 unix_shared_memory_queue_t * q,
122 l2fib_entry_key_t * l2fe_key,
123 l2fib_entry_result_t * l2fe_res, u32 context)
125 vl_api_l2_fib_table_details_t *mp;
127 mp = vl_msg_api_alloc (sizeof (*mp));
128 memset (mp, 0, sizeof (*mp));
129 mp->_vl_msg_id = ntohs (VL_API_L2_FIB_TABLE_DETAILS);
132 ntohl (l2input_main.bd_configs[l2fe_key->fields.bd_index].bd_id);
134 mp->mac = l2fib_make_key (l2fe_key->fields.mac, 0);
135 mp->sw_if_index = ntohl (l2fe_res->fields.sw_if_index);
136 mp->static_mac = l2fe_res->fields.static_mac;
137 mp->filter_mac = l2fe_res->fields.filter;
138 mp->bvi_mac = l2fe_res->fields.bvi;
139 mp->context = context;
141 vl_msg_api_send_shmem (q, (u8 *) & mp);
145 vl_api_l2_fib_table_dump_t_handler (vl_api_l2_fib_table_dump_t * mp)
147 vpe_api_main_t *am = &vpe_api_main;
148 bd_main_t *bdm = &bd_main;
149 l2fib_entry_key_t *l2fe_key = NULL;
150 l2fib_entry_result_t *l2fe_res = NULL;
151 u32 ni, bd_id = ntohl (mp->bd_id);
153 unix_shared_memory_queue_t *q;
156 q = vl_api_client_index_to_input_queue (mp->client_index);
160 /* see l2fib_table_dump: ~0 means "any" */
165 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
172 l2fib_table_dump (bd_index, &l2fe_key, &l2fe_res);
174 vec_foreach_index (ni, l2fe_key)
176 send_l2fib_table_entry (am, q, vec_elt_at_index (l2fe_key, ni),
177 vec_elt_at_index (l2fe_res, ni), mp->context);
184 vl_api_l2fib_add_del_t_handler (vl_api_l2fib_add_del_t * mp)
186 bd_main_t *bdm = &bd_main;
187 l2input_main_t *l2im = &l2input_main;
188 vl_api_l2fib_add_del_reply_t *rmp;
191 u32 sw_if_index = ntohl (mp->sw_if_index);
192 u32 bd_id = ntohl (mp->bd_id);
201 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
204 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
205 goto bad_sw_if_index;
211 filter_mac = mp->filter_mac ? 1 : 0;
214 VALIDATE_SW_IF_INDEX (mp);
215 if (vec_len (l2im->configs) <= sw_if_index)
217 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
218 goto bad_sw_if_index;
222 l2_input_config_t *config;
223 config = vec_elt_at_index (l2im->configs, sw_if_index);
224 if (config->bridge == 0)
226 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
227 goto bad_sw_if_index;
231 static_mac = mp->static_mac ? 1 : 0;
232 bvi_mac = mp->bvi_mac ? 1 : 0;
233 l2fib_add_entry (mac, bd_index, sw_if_index, static_mac, filter_mac,
238 l2fib_del_entry (mac, bd_index);
241 BAD_SW_IF_INDEX_LABEL;
243 REPLY_MACRO (VL_API_L2FIB_ADD_DEL_REPLY);
247 vl_api_l2fib_flush_int_t_handler (vl_api_l2fib_flush_int_t * mp)
250 vlib_main_t *vm = vlib_get_main ();
251 vl_api_l2fib_flush_int_reply_t *rmp;
253 VALIDATE_SW_IF_INDEX (mp);
255 u32 sw_if_index = ntohl (mp->sw_if_index);
256 l2fib_flush_int_mac (vm, sw_if_index);
258 BAD_SW_IF_INDEX_LABEL;
259 REPLY_MACRO (VL_API_L2FIB_FLUSH_INT_REPLY);
263 vl_api_l2fib_flush_all_t_handler (vl_api_l2fib_flush_all_t * mp)
266 vl_api_l2fib_flush_all_reply_t *rmp;
268 l2fib_flush_all_mac (vlib_get_main ());
269 REPLY_MACRO (VL_API_L2FIB_FLUSH_ALL_REPLY);
273 vl_api_l2fib_flush_bd_t_handler (vl_api_l2fib_flush_bd_t * mp)
276 vlib_main_t *vm = vlib_get_main ();
277 bd_main_t *bdm = &bd_main;
278 vl_api_l2fib_flush_bd_reply_t *rmp;
280 u32 bd_id = ntohl (mp->bd_id);
281 uword *p = hash_get (bdm->bd_index_by_bd_id, bd_id);
284 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
287 l2fib_flush_bd_mac (vm, *p);
289 REPLY_MACRO (VL_API_L2FIB_FLUSH_BD_REPLY);
293 vl_api_l2_flags_t_handler (vl_api_l2_flags_t * mp)
295 vl_api_l2_flags_reply_t *rmp;
299 VALIDATE_SW_IF_INDEX (mp);
301 u32 sw_if_index = ntohl (mp->sw_if_index);
302 u32 flags = ntohl (mp->feature_bitmap) & L2INPUT_VALID_MASK;
303 rbm = l2input_intf_bitmap_enable (sw_if_index, flags, mp->is_set);
305 BAD_SW_IF_INDEX_LABEL;
308 REPLY_MACRO2(VL_API_L2_FLAGS_REPLY,
310 rmp->resulting_feature_bitmap = ntohl(rbm);
316 vl_api_bridge_domain_set_mac_age_t_handler (vl_api_bridge_domain_set_mac_age_t
319 vlib_main_t *vm = vlib_get_main ();
320 bd_main_t *bdm = &bd_main;
321 vl_api_bridge_domain_set_mac_age_reply_t *rmp;
323 u32 bd_id = ntohl (mp->bd_id);
328 rv = VNET_API_ERROR_BD_NOT_MODIFIABLE;
332 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
335 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
338 bd_set_mac_age (vm, *p, mp->mac_age);
340 REPLY_MACRO (VL_API_BRIDGE_DOMAIN_SET_MAC_AGE_REPLY);
344 vl_api_bridge_domain_add_del_t_handler (vl_api_bridge_domain_add_del_t * mp)
346 l2_bridge_domain_add_del_args_t a = {
347 .is_add = mp->is_add,
349 .uu_flood = mp->uu_flood,
350 .forward = mp->forward,
352 .arp_term = mp->arp_term,
353 .mac_age = mp->mac_age,
354 .bd_id = ntohl (mp->bd_id),
357 int rv = bd_add_del (&a);
359 vl_api_bridge_domain_add_del_reply_t *rmp;
360 REPLY_MACRO (VL_API_BRIDGE_DOMAIN_ADD_DEL_REPLY);
364 send_bridge_domain_details (l2input_main_t * l2im,
365 unix_shared_memory_queue_t * q,
366 l2_bridge_domain_t * bd_config,
367 u32 n_sw_ifs, u32 context)
369 vl_api_bridge_domain_details_t *mp;
370 l2_flood_member_t *m;
371 vl_api_bridge_domain_sw_if_t *sw_ifs;
372 l2_input_config_t *input_cfg;
374 mp = vl_msg_api_alloc (sizeof (*mp) +
375 (n_sw_ifs * sizeof (vl_api_bridge_domain_sw_if_t)));
376 memset (mp, 0, sizeof (*mp));
377 mp->_vl_msg_id = ntohs (VL_API_BRIDGE_DOMAIN_DETAILS);
378 mp->bd_id = ntohl (bd_config->bd_id);
379 mp->flood = bd_feature_flood (bd_config);
380 mp->uu_flood = bd_feature_uu_flood (bd_config);
381 mp->forward = bd_feature_forward (bd_config);
382 mp->learn = bd_feature_learn (bd_config);
383 mp->arp_term = bd_feature_arp_term (bd_config);
384 mp->bvi_sw_if_index = ntohl (bd_config->bvi_sw_if_index);
385 mp->mac_age = bd_config->mac_age;
386 mp->context = context;
388 sw_ifs = (vl_api_bridge_domain_sw_if_t *) mp->sw_if_details;
389 vec_foreach (m, bd_config->members)
391 sw_ifs->sw_if_index = ntohl (m->sw_if_index);
392 input_cfg = vec_elt_at_index (l2im->configs, m->sw_if_index);
393 sw_ifs->shg = input_cfg->shg;
397 mp->n_sw_ifs = htonl (mp->n_sw_ifs);
399 vl_msg_api_send_shmem (q, (u8 *) & mp);
403 vl_api_bridge_domain_dump_t_handler (vl_api_bridge_domain_dump_t * mp)
405 bd_main_t *bdm = &bd_main;
406 l2input_main_t *l2im = &l2input_main;
408 unix_shared_memory_queue_t *q =
409 vl_api_client_index_to_input_queue (mp->client_index);
413 u32 bd_id = ntohl (mp->bd_id);
419 bd_index = 0, end = vec_len (l2im->bd_configs);
422 bd_index = bd_find_index (bdm, bd_id);
429 for (; bd_index < end; bd_index++)
431 l2_bridge_domain_t *bd_config =
432 l2input_bd_config_from_index (l2im, bd_index);
433 /* skip dummy bd_id 0 */
434 if (bd_config && (bd_config->bd_id > 0))
435 send_bridge_domain_details (l2im, q, bd_config,
436 vec_len (bd_config->members),
442 vl_api_bridge_flags_t_handler (vl_api_bridge_flags_t * mp)
444 vlib_main_t *vm = vlib_get_main ();
445 bd_main_t *bdm = &bd_main;
446 vl_api_bridge_flags_reply_t *rmp;
449 u32 flags = ntohl (mp->feature_bitmap);
450 u32 bd_id = ntohl (mp->bd_id);
453 rv = VNET_API_ERROR_BD_NOT_MODIFIABLE;
457 u32 bd_index = bd_find_index (bdm, bd_id);
460 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
464 bd_set_flags (vm, bd_index, flags, mp->is_set);
468 REPLY_MACRO2(VL_API_BRIDGE_FLAGS_REPLY,
470 rmp->resulting_feature_bitmap = ntohl(flags);
476 vl_api_l2_interface_vlan_tag_rewrite_t_handler
477 (vl_api_l2_interface_vlan_tag_rewrite_t * mp)
480 vl_api_l2_interface_vlan_tag_rewrite_reply_t *rmp;
481 vnet_main_t *vnm = vnet_get_main ();
482 vlib_main_t *vm = vlib_get_main ();
485 VALIDATE_SW_IF_INDEX (mp);
487 vtr_op = ntohl (mp->vtr_op);
489 /* The L2 code is unsuspicious */
492 case L2_VTR_DISABLED:
497 case L2_VTR_TRANSLATE_1_1:
498 case L2_VTR_TRANSLATE_1_2:
499 case L2_VTR_TRANSLATE_2_1:
500 case L2_VTR_TRANSLATE_2_2:
504 rv = VNET_API_ERROR_INVALID_VALUE;
505 goto bad_sw_if_index;
508 rv = l2vtr_configure (vm, vnm, ntohl (mp->sw_if_index), vtr_op,
509 ntohl (mp->push_dot1q), ntohl (mp->tag1),
512 BAD_SW_IF_INDEX_LABEL;
514 REPLY_MACRO (VL_API_L2_INTERFACE_VLAN_TAG_REWRITE_REPLY);
518 vl_api_l2_interface_pbb_tag_rewrite_t_handler
519 (vl_api_l2_interface_pbb_tag_rewrite_t * mp)
521 vl_api_l2_interface_pbb_tag_rewrite_reply_t *rmp;
522 vnet_main_t *vnm = vnet_get_main ();
523 vlib_main_t *vm = vlib_get_main ();
527 VALIDATE_SW_IF_INDEX (mp);
529 vtr_op = ntohl (mp->vtr_op);
533 case L2_VTR_DISABLED:
536 case L2_VTR_TRANSLATE_2_1:
540 rv = VNET_API_ERROR_INVALID_VALUE;
541 goto bad_sw_if_index;
544 rv = l2pbb_configure (vm, vnm, ntohl (mp->sw_if_index), vtr_op,
545 mp->b_dmac, mp->b_smac, ntohs (mp->b_vlanid),
546 ntohl (mp->i_sid), ntohs (mp->outer_tag));
548 BAD_SW_IF_INDEX_LABEL;
550 REPLY_MACRO (VL_API_L2_INTERFACE_PBB_TAG_REWRITE_REPLY);
555 * Add vpe's API message handlers to the table.
556 * vlib has alread mapped shared memory and
557 * added the client registration handlers.
558 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
560 #define vl_msg_name_crc_list
561 #include <vnet/vnet_all_api_h.h>
562 #undef vl_msg_name_crc_list
565 setup_message_id_table (api_main_t * am)
567 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
568 foreach_vl_msg_name_crc_l2;
572 static clib_error_t *
573 l2_api_hookup (vlib_main_t * vm)
575 api_main_t *am = &api_main;
578 vl_msg_api_set_handlers(VL_API_##N, #n, \
579 vl_api_##n##_t_handler, \
581 vl_api_##n##_t_endian, \
582 vl_api_##n##_t_print, \
583 sizeof(vl_api_##n##_t), 1);
588 * Set up the (msg_name, crc, message-id) table
590 setup_message_id_table (am);
595 VLIB_API_INIT_FUNCTION (l2_api_hookup);
598 * fd.io coding-style-patch-verification: ON
601 * eval: (c-set-style "gnu")