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_ADD_DEL, l2fib_add_del) \
52 _(L2_FLAGS, l2_flags) \
53 _(BRIDGE_DOMAIN_ADD_DEL, bridge_domain_add_del) \
54 _(BRIDGE_DOMAIN_DUMP, bridge_domain_dump) \
55 _(BRIDGE_FLAGS, bridge_flags) \
56 _(L2_INTERFACE_VLAN_TAG_REWRITE, l2_interface_vlan_tag_rewrite) \
57 _(L2_INTERFACE_PBB_TAG_REWRITE, l2_interface_pbb_tag_rewrite) \
58 _(BRIDGE_DOMAIN_SET_MAC_AGE, bridge_domain_set_mac_age)
61 send_l2_xconnect_details (unix_shared_memory_queue_t * q, u32 context,
62 u32 rx_sw_if_index, u32 tx_sw_if_index)
64 vl_api_l2_xconnect_details_t *mp;
66 mp = vl_msg_api_alloc (sizeof (*mp));
67 memset (mp, 0, sizeof (*mp));
68 mp->_vl_msg_id = ntohs (VL_API_L2_XCONNECT_DETAILS);
69 mp->context = context;
70 mp->rx_sw_if_index = htonl (rx_sw_if_index);
71 mp->tx_sw_if_index = htonl (tx_sw_if_index);
73 vl_msg_api_send_shmem (q, (u8 *) & mp);
77 vl_api_l2_xconnect_dump_t_handler (vl_api_l2_xconnect_dump_t * mp)
79 unix_shared_memory_queue_t *q;
80 vnet_main_t *vnm = vnet_get_main ();
81 vnet_interface_main_t *im = &vnm->interface_main;
82 l2input_main_t *l2im = &l2input_main;
83 vnet_sw_interface_t *swif;
84 l2_input_config_t *config;
86 q = vl_api_client_index_to_input_queue (mp->client_index);
91 pool_foreach (swif, im->sw_interfaces,
93 config = vec_elt_at_index (l2im->configs, swif->sw_if_index);
95 send_l2_xconnect_details (q, mp->context, swif->sw_if_index,
96 config->output_sw_if_index);
102 vl_api_l2_fib_clear_table_t_handler (vl_api_l2_fib_clear_table_t * mp)
105 vl_api_l2_fib_clear_table_reply_t *rmp;
107 /* DAW-FIXME: This API should only clear non-static l2fib entries, but
108 * that is not currently implemented. When that TODO is fixed
109 * this call should be changed to pass 1 instead of 0.
111 l2fib_clear_table (0);
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_l2_flags_t_handler (vl_api_l2_flags_t * mp)
246 vl_api_l2_flags_reply_t *rmp;
250 VALIDATE_SW_IF_INDEX (mp);
252 u32 sw_if_index = ntohl (mp->sw_if_index);
253 u32 flags = ntohl (mp->feature_bitmap) & L2INPUT_VALID_MASK;
254 rbm = l2input_intf_bitmap_enable (sw_if_index, flags, mp->is_set);
256 BAD_SW_IF_INDEX_LABEL;
259 REPLY_MACRO2(VL_API_L2_FLAGS_REPLY,
261 rmp->resulting_feature_bitmap = ntohl(rbm);
267 vl_api_bridge_domain_set_mac_age_t_handler (vl_api_bridge_domain_set_mac_age_t
270 vlib_main_t *vm = vlib_get_main ();
271 bd_main_t *bdm = &bd_main;
272 vl_api_bridge_domain_set_mac_age_reply_t *rmp;
274 u32 bd_id = ntohl (mp->bd_id);
275 uword *p = hash_get (bdm->bd_index_by_bd_id, bd_id);
278 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
281 bd_set_mac_age (vm, *p, mp->mac_age);
283 REPLY_MACRO (VL_API_BRIDGE_DOMAIN_SET_MAC_AGE_REPLY);
287 vl_api_bridge_domain_add_del_t_handler (vl_api_bridge_domain_add_del_t * mp)
289 vlib_main_t *vm = vlib_get_main ();
290 bd_main_t *bdm = &bd_main;
291 vl_api_bridge_domain_add_del_reply_t *rmp;
293 u32 enable_flags = 0, disable_flags = 0;
294 u32 bd_id = ntohl (mp->bd_id);
299 bd_index = bd_find_or_add_bd_index (bdm, bd_id);
302 enable_flags |= L2_FLOOD;
304 disable_flags |= L2_FLOOD;
307 enable_flags |= L2_UU_FLOOD;
309 disable_flags |= L2_UU_FLOOD;
312 enable_flags |= L2_FWD;
314 disable_flags |= L2_FWD;
317 enable_flags |= L2_ARP_TERM;
319 disable_flags |= L2_ARP_TERM;
322 enable_flags |= L2_LEARN;
324 disable_flags |= L2_LEARN;
327 bd_set_flags (vm, bd_index, enable_flags, 1 /* enable */ );
330 bd_set_flags (vm, bd_index, disable_flags, 0 /* disable */ );
332 bd_set_mac_age (vm, bd_index, mp->mac_age);
335 rv = bd_delete_bd_index (bdm, bd_id);
337 REPLY_MACRO (VL_API_BRIDGE_DOMAIN_ADD_DEL_REPLY);
341 send_bridge_domain_details (unix_shared_memory_queue_t * q,
342 l2_bridge_domain_t * bd_config,
343 u32 n_sw_ifs, u32 context)
345 vl_api_bridge_domain_details_t *mp;
347 mp = vl_msg_api_alloc (sizeof (*mp));
348 memset (mp, 0, sizeof (*mp));
349 mp->_vl_msg_id = ntohs (VL_API_BRIDGE_DOMAIN_DETAILS);
350 mp->bd_id = ntohl (bd_config->bd_id);
351 mp->flood = bd_feature_flood (bd_config);
352 mp->uu_flood = bd_feature_uu_flood (bd_config);
353 mp->forward = bd_feature_forward (bd_config);
354 mp->learn = bd_feature_learn (bd_config);
355 mp->arp_term = bd_feature_arp_term (bd_config);
356 mp->bvi_sw_if_index = ntohl (bd_config->bvi_sw_if_index);
357 mp->mac_age = bd_config->mac_age;
358 mp->n_sw_ifs = ntohl (n_sw_ifs);
359 mp->context = context;
361 vl_msg_api_send_shmem (q, (u8 *) & mp);
365 send_bd_sw_if_details (l2input_main_t * l2im,
366 unix_shared_memory_queue_t * q,
367 l2_flood_member_t * member, u32 bd_id, u32 context)
369 vl_api_bridge_domain_sw_if_details_t *mp;
370 l2_input_config_t *input_cfg;
372 mp = vl_msg_api_alloc (sizeof (*mp));
373 memset (mp, 0, sizeof (*mp));
374 mp->_vl_msg_id = ntohs (VL_API_BRIDGE_DOMAIN_SW_IF_DETAILS);
375 mp->bd_id = ntohl (bd_id);
376 mp->sw_if_index = ntohl (member->sw_if_index);
377 input_cfg = vec_elt_at_index (l2im->configs, member->sw_if_index);
378 mp->shg = input_cfg->shg;
379 mp->context = context;
381 vl_msg_api_send_shmem (q, (u8 *) & mp);
385 vl_api_bridge_domain_dump_t_handler (vl_api_bridge_domain_dump_t * mp)
387 bd_main_t *bdm = &bd_main;
388 l2input_main_t *l2im = &l2input_main;
389 unix_shared_memory_queue_t *q;
390 l2_bridge_domain_t *bd_config;
394 q = vl_api_client_index_to_input_queue (mp->client_index);
399 bd_id = ntohl (mp->bd_id);
401 bd_index = (bd_id == ~0) ? 0 : bd_find_or_add_bd_index (bdm, bd_id);
402 end = (bd_id == ~0) ? vec_len (l2im->bd_configs) : bd_index + 1;
403 for (; bd_index < end; bd_index++)
405 bd_config = l2input_bd_config_from_index (l2im, bd_index);
406 /* skip dummy bd_id 0 */
407 if (bd_config && (bd_config->bd_id > 0))
410 l2_flood_member_t *m;
412 n_sw_ifs = vec_len (bd_config->members);
413 send_bridge_domain_details (q, bd_config, n_sw_ifs, mp->context);
415 vec_foreach (m, bd_config->members)
417 send_bd_sw_if_details (l2im, q, m, bd_config->bd_id, mp->context);
424 vl_api_bridge_flags_t_handler (vl_api_bridge_flags_t * mp)
426 vlib_main_t *vm = vlib_get_main ();
427 bd_main_t *bdm = &bd_main;
428 vl_api_bridge_flags_reply_t *rmp;
430 u32 bd_id = ntohl (mp->bd_id);
432 u32 flags = ntohl (mp->feature_bitmap);
435 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
438 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
444 bd_set_flags (vm, bd_index, flags, mp->is_set);
448 REPLY_MACRO2(VL_API_BRIDGE_FLAGS_REPLY,
450 rmp->resulting_feature_bitmap = ntohl(flags);
456 vl_api_l2_interface_vlan_tag_rewrite_t_handler
457 (vl_api_l2_interface_vlan_tag_rewrite_t * mp)
460 vl_api_l2_interface_vlan_tag_rewrite_reply_t *rmp;
461 vnet_main_t *vnm = vnet_get_main ();
462 vlib_main_t *vm = vlib_get_main ();
465 VALIDATE_SW_IF_INDEX (mp);
467 vtr_op = ntohl (mp->vtr_op);
469 /* The L2 code is unsuspicious */
472 case L2_VTR_DISABLED:
477 case L2_VTR_TRANSLATE_1_1:
478 case L2_VTR_TRANSLATE_1_2:
479 case L2_VTR_TRANSLATE_2_1:
480 case L2_VTR_TRANSLATE_2_2:
484 rv = VNET_API_ERROR_INVALID_VALUE;
485 goto bad_sw_if_index;
488 rv = l2vtr_configure (vm, vnm, ntohl (mp->sw_if_index), vtr_op,
489 ntohl (mp->push_dot1q), ntohl (mp->tag1),
492 BAD_SW_IF_INDEX_LABEL;
494 REPLY_MACRO (VL_API_L2_INTERFACE_VLAN_TAG_REWRITE_REPLY);
498 vl_api_l2_interface_pbb_tag_rewrite_t_handler
499 (vl_api_l2_interface_pbb_tag_rewrite_t * mp)
501 vl_api_l2_interface_pbb_tag_rewrite_reply_t *rmp;
502 vnet_main_t *vnm = vnet_get_main ();
503 vlib_main_t *vm = vlib_get_main ();
507 VALIDATE_SW_IF_INDEX (mp);
509 vtr_op = ntohl (mp->vtr_op);
513 case L2_VTR_DISABLED:
516 case L2_VTR_TRANSLATE_2_1:
520 rv = VNET_API_ERROR_INVALID_VALUE;
521 goto bad_sw_if_index;
524 rv = l2pbb_configure (vm, vnm, ntohl (mp->sw_if_index), vtr_op,
525 mp->b_dmac, mp->b_smac, ntohs (mp->b_vlanid),
526 ntohl (mp->i_sid), ntohs (mp->outer_tag));
528 BAD_SW_IF_INDEX_LABEL;
530 REPLY_MACRO (VL_API_L2_INTERFACE_PBB_TAG_REWRITE_REPLY);
535 * Add vpe's API message handlers to the table.
536 * vlib has alread mapped shared memory and
537 * added the client registration handlers.
538 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
540 #define vl_msg_name_crc_list
541 #include <vnet/vnet_all_api_h.h>
542 #undef vl_msg_name_crc_list
545 setup_message_id_table (api_main_t * am)
547 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
548 foreach_vl_msg_name_crc_l2;
552 static clib_error_t *
553 l2_api_hookup (vlib_main_t * vm)
555 api_main_t *am = &api_main;
558 vl_msg_api_set_handlers(VL_API_##N, #n, \
559 vl_api_##n##_t_handler, \
561 vl_api_##n##_t_endian, \
562 vl_api_##n##_t_print, \
563 sizeof(vl_api_##n##_t), 1);
568 * Set up the (msg_name, crc, message-id) table
570 setup_message_id_table (am);
575 VLIB_API_INIT_FUNCTION (l2_api_hookup);
578 * fd.io coding-style-patch-verification: ON
581 * eval: (c-set-style "gnu")