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_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)
63 send_l2_xconnect_details (unix_shared_memory_queue_t * q, u32 context,
64 u32 rx_sw_if_index, u32 tx_sw_if_index)
66 vl_api_l2_xconnect_details_t *mp;
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);
75 vl_msg_api_send_shmem (q, (u8 *) & mp);
79 vl_api_l2_xconnect_dump_t_handler (vl_api_l2_xconnect_dump_t * mp)
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;
88 q = vl_api_client_index_to_input_queue (mp->client_index);
93 pool_foreach (swif, im->sw_interfaces,
95 config = vec_elt_at_index (l2im->configs, swif->sw_if_index);
97 send_l2_xconnect_details (q, mp->context, swif->sw_if_index,
98 config->output_sw_if_index);
104 vl_api_l2_fib_clear_table_t_handler (vl_api_l2_fib_clear_table_t * mp)
107 vl_api_l2_fib_clear_table_reply_t *rmp;
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.
113 l2fib_clear_table (0);
115 REPLY_MACRO (VL_API_L2_FIB_CLEAR_TABLE_REPLY);
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)
124 vl_api_l2_fib_table_entry_t *mp;
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);
131 ntohl (l2input_main.bd_configs[l2fe_key->fields.bd_index].bd_id);
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;
140 vl_msg_api_send_shmem (q, (u8 *) & mp);
144 vl_api_l2_fib_table_dump_t_handler (vl_api_l2_fib_table_dump_t * mp)
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);
152 unix_shared_memory_queue_t *q;
155 q = vl_api_client_index_to_input_queue (mp->client_index);
159 /* see l2fib_table_dump: ~0 means "any" */
164 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
171 l2fib_table_dump (bd_index, &l2fe_key, &l2fe_res);
173 vec_foreach_index (ni, l2fe_key)
175 send_l2fib_table_entry (am, q, vec_elt_at_index (l2fe_key, ni),
176 vec_elt_at_index (l2fe_res, ni), mp->context);
183 vl_api_l2fib_add_del_t_handler (vl_api_l2fib_add_del_t * mp)
185 bd_main_t *bdm = &bd_main;
186 l2input_main_t *l2im = &l2input_main;
187 vl_api_l2fib_add_del_reply_t *rmp;
190 u32 sw_if_index = ntohl (mp->sw_if_index);
191 u32 bd_id = ntohl (mp->bd_id);
200 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
203 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
204 goto bad_sw_if_index;
210 filter_mac = mp->filter_mac ? 1 : 0;
213 VALIDATE_SW_IF_INDEX (mp);
214 if (vec_len (l2im->configs) <= sw_if_index)
216 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
217 goto bad_sw_if_index;
221 l2_input_config_t *config;
222 config = vec_elt_at_index (l2im->configs, sw_if_index);
223 if (config->bridge == 0)
225 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
226 goto bad_sw_if_index;
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,
237 l2fib_del_entry (mac, bd_index);
240 BAD_SW_IF_INDEX_LABEL;
242 REPLY_MACRO (VL_API_L2FIB_ADD_DEL_REPLY);
246 vl_api_l2fib_flush_int_t_handler (vl_api_l2fib_flush_int_t * mp)
249 vlib_main_t *vm = vlib_get_main ();
250 vl_api_l2fib_flush_int_reply_t *rmp;
252 VALIDATE_SW_IF_INDEX (mp);
254 u32 sw_if_index = ntohl (mp->sw_if_index);
255 l2fib_flush_int_mac (vm, sw_if_index);
257 BAD_SW_IF_INDEX_LABEL;
258 REPLY_MACRO (VL_API_L2FIB_FLUSH_INT_REPLY);
262 vl_api_l2fib_flush_bd_t_handler (vl_api_l2fib_flush_bd_t * mp)
265 vlib_main_t *vm = vlib_get_main ();
266 bd_main_t *bdm = &bd_main;
267 vl_api_l2fib_flush_bd_reply_t *rmp;
269 u32 bd_id = ntohl (mp->bd_id);
270 uword *p = hash_get (bdm->bd_index_by_bd_id, bd_id);
273 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
276 l2fib_flush_bd_mac (vm, *p);
278 REPLY_MACRO (VL_API_L2FIB_FLUSH_BD_REPLY);
282 vl_api_l2_flags_t_handler (vl_api_l2_flags_t * mp)
284 vl_api_l2_flags_reply_t *rmp;
288 VALIDATE_SW_IF_INDEX (mp);
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);
294 BAD_SW_IF_INDEX_LABEL;
297 REPLY_MACRO2(VL_API_L2_FLAGS_REPLY,
299 rmp->resulting_feature_bitmap = ntohl(rbm);
305 vl_api_bridge_domain_set_mac_age_t_handler (vl_api_bridge_domain_set_mac_age_t
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;
312 u32 bd_id = ntohl (mp->bd_id);
313 uword *p = hash_get (bdm->bd_index_by_bd_id, bd_id);
316 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
319 bd_set_mac_age (vm, *p, mp->mac_age);
321 REPLY_MACRO (VL_API_BRIDGE_DOMAIN_SET_MAC_AGE_REPLY);
325 vl_api_bridge_domain_add_del_t_handler (vl_api_bridge_domain_add_del_t * mp)
327 vlib_main_t *vm = vlib_get_main ();
328 bd_main_t *bdm = &bd_main;
329 vl_api_bridge_domain_add_del_reply_t *rmp;
331 u32 enable_flags = 0, disable_flags = 0;
332 u32 bd_id = ntohl (mp->bd_id);
337 bd_index = bd_find_or_add_bd_index (bdm, bd_id);
340 enable_flags |= L2_FLOOD;
342 disable_flags |= L2_FLOOD;
345 enable_flags |= L2_UU_FLOOD;
347 disable_flags |= L2_UU_FLOOD;
350 enable_flags |= L2_FWD;
352 disable_flags |= L2_FWD;
355 enable_flags |= L2_ARP_TERM;
357 disable_flags |= L2_ARP_TERM;
360 enable_flags |= L2_LEARN;
362 disable_flags |= L2_LEARN;
365 bd_set_flags (vm, bd_index, enable_flags, 1 /* enable */ );
368 bd_set_flags (vm, bd_index, disable_flags, 0 /* disable */ );
370 bd_set_mac_age (vm, bd_index, mp->mac_age);
373 rv = bd_delete_bd_index (bdm, bd_id);
375 REPLY_MACRO (VL_API_BRIDGE_DOMAIN_ADD_DEL_REPLY);
379 send_bridge_domain_details (unix_shared_memory_queue_t * q,
380 l2_bridge_domain_t * bd_config,
381 u32 n_sw_ifs, u32 context)
383 vl_api_bridge_domain_details_t *mp;
385 mp = vl_msg_api_alloc (sizeof (*mp));
386 memset (mp, 0, sizeof (*mp));
387 mp->_vl_msg_id = ntohs (VL_API_BRIDGE_DOMAIN_DETAILS);
388 mp->bd_id = ntohl (bd_config->bd_id);
389 mp->flood = bd_feature_flood (bd_config);
390 mp->uu_flood = bd_feature_uu_flood (bd_config);
391 mp->forward = bd_feature_forward (bd_config);
392 mp->learn = bd_feature_learn (bd_config);
393 mp->arp_term = bd_feature_arp_term (bd_config);
394 mp->bvi_sw_if_index = ntohl (bd_config->bvi_sw_if_index);
395 mp->mac_age = bd_config->mac_age;
396 mp->n_sw_ifs = ntohl (n_sw_ifs);
397 mp->context = context;
399 vl_msg_api_send_shmem (q, (u8 *) & mp);
403 send_bd_sw_if_details (l2input_main_t * l2im,
404 unix_shared_memory_queue_t * q,
405 l2_flood_member_t * member, u32 bd_id, u32 context)
407 vl_api_bridge_domain_sw_if_details_t *mp;
408 l2_input_config_t *input_cfg;
410 mp = vl_msg_api_alloc (sizeof (*mp));
411 memset (mp, 0, sizeof (*mp));
412 mp->_vl_msg_id = ntohs (VL_API_BRIDGE_DOMAIN_SW_IF_DETAILS);
413 mp->bd_id = ntohl (bd_id);
414 mp->sw_if_index = ntohl (member->sw_if_index);
415 input_cfg = vec_elt_at_index (l2im->configs, member->sw_if_index);
416 mp->shg = input_cfg->shg;
417 mp->context = context;
419 vl_msg_api_send_shmem (q, (u8 *) & mp);
423 vl_api_bridge_domain_dump_t_handler (vl_api_bridge_domain_dump_t * mp)
425 bd_main_t *bdm = &bd_main;
426 l2input_main_t *l2im = &l2input_main;
427 unix_shared_memory_queue_t *q;
428 l2_bridge_domain_t *bd_config;
432 q = vl_api_client_index_to_input_queue (mp->client_index);
437 bd_id = ntohl (mp->bd_id);
439 bd_index = (bd_id == ~0) ? 0 : bd_find_or_add_bd_index (bdm, bd_id);
440 end = (bd_id == ~0) ? vec_len (l2im->bd_configs) : bd_index + 1;
441 for (; bd_index < end; bd_index++)
443 bd_config = l2input_bd_config_from_index (l2im, bd_index);
444 /* skip dummy bd_id 0 */
445 if (bd_config && (bd_config->bd_id > 0))
448 l2_flood_member_t *m;
450 n_sw_ifs = vec_len (bd_config->members);
451 send_bridge_domain_details (q, bd_config, n_sw_ifs, mp->context);
453 vec_foreach (m, bd_config->members)
455 send_bd_sw_if_details (l2im, q, m, bd_config->bd_id, mp->context);
462 vl_api_bridge_flags_t_handler (vl_api_bridge_flags_t * mp)
464 vlib_main_t *vm = vlib_get_main ();
465 bd_main_t *bdm = &bd_main;
466 vl_api_bridge_flags_reply_t *rmp;
468 u32 bd_id = ntohl (mp->bd_id);
470 u32 flags = ntohl (mp->feature_bitmap);
473 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
476 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
482 bd_set_flags (vm, bd_index, flags, mp->is_set);
486 REPLY_MACRO2(VL_API_BRIDGE_FLAGS_REPLY,
488 rmp->resulting_feature_bitmap = ntohl(flags);
494 vl_api_l2_interface_vlan_tag_rewrite_t_handler
495 (vl_api_l2_interface_vlan_tag_rewrite_t * mp)
498 vl_api_l2_interface_vlan_tag_rewrite_reply_t *rmp;
499 vnet_main_t *vnm = vnet_get_main ();
500 vlib_main_t *vm = vlib_get_main ();
503 VALIDATE_SW_IF_INDEX (mp);
505 vtr_op = ntohl (mp->vtr_op);
507 /* The L2 code is unsuspicious */
510 case L2_VTR_DISABLED:
515 case L2_VTR_TRANSLATE_1_1:
516 case L2_VTR_TRANSLATE_1_2:
517 case L2_VTR_TRANSLATE_2_1:
518 case L2_VTR_TRANSLATE_2_2:
522 rv = VNET_API_ERROR_INVALID_VALUE;
523 goto bad_sw_if_index;
526 rv = l2vtr_configure (vm, vnm, ntohl (mp->sw_if_index), vtr_op,
527 ntohl (mp->push_dot1q), ntohl (mp->tag1),
530 BAD_SW_IF_INDEX_LABEL;
532 REPLY_MACRO (VL_API_L2_INTERFACE_VLAN_TAG_REWRITE_REPLY);
536 vl_api_l2_interface_pbb_tag_rewrite_t_handler
537 (vl_api_l2_interface_pbb_tag_rewrite_t * mp)
539 vl_api_l2_interface_pbb_tag_rewrite_reply_t *rmp;
540 vnet_main_t *vnm = vnet_get_main ();
541 vlib_main_t *vm = vlib_get_main ();
545 VALIDATE_SW_IF_INDEX (mp);
547 vtr_op = ntohl (mp->vtr_op);
551 case L2_VTR_DISABLED:
554 case L2_VTR_TRANSLATE_2_1:
558 rv = VNET_API_ERROR_INVALID_VALUE;
559 goto bad_sw_if_index;
562 rv = l2pbb_configure (vm, vnm, ntohl (mp->sw_if_index), vtr_op,
563 mp->b_dmac, mp->b_smac, ntohs (mp->b_vlanid),
564 ntohl (mp->i_sid), ntohs (mp->outer_tag));
566 BAD_SW_IF_INDEX_LABEL;
568 REPLY_MACRO (VL_API_L2_INTERFACE_PBB_TAG_REWRITE_REPLY);
573 * Add vpe's API message handlers to the table.
574 * vlib has alread mapped shared memory and
575 * added the client registration handlers.
576 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
578 #define vl_msg_name_crc_list
579 #include <vnet/vnet_all_api_h.h>
580 #undef vl_msg_name_crc_list
583 setup_message_id_table (api_main_t * am)
585 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
586 foreach_vl_msg_name_crc_l2;
590 static clib_error_t *
591 l2_api_hookup (vlib_main_t * vm)
593 api_main_t *am = &api_main;
596 vl_msg_api_set_handlers(VL_API_##N, #n, \
597 vl_api_##n##_t_handler, \
599 vl_api_##n##_t_endian, \
600 vl_api_##n##_t_print, \
601 sizeof(vl_api_##n##_t), 1);
606 * Set up the (msg_name, crc, message-id) table
608 setup_message_id_table (am);
613 VLIB_API_INIT_FUNCTION (l2_api_hookup);
616 * fd.io coding-style-patch-verification: ON
619 * eval: (c-set-style "gnu")