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>
28 #include <vnet/vnet_msg_enum.h>
30 #define vl_typedefs /* define message structures */
31 #include <vnet/vnet_all_api_h.h>
34 #define vl_endianfun /* define message structures */
35 #include <vnet/vnet_all_api_h.h>
38 /* instantiate all the print functions we know about */
39 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
41 #include <vnet/vnet_all_api_h.h>
44 #include <vlibapi/api_helper_macros.h>
46 #define foreach_vpe_api_msg \
47 _(L2_XCONNECT_DUMP, l2_xconnect_dump) \
48 _(L2_FIB_CLEAR_TABLE, l2_fib_clear_table) \
49 _(L2_FIB_TABLE_DUMP, l2_fib_table_dump) \
50 _(L2_FIB_TABLE_ENTRY, l2_fib_table_entry) \
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_DOMAIN_DETAILS, bridge_domain_details) \
56 _(BRIDGE_DOMAIN_SW_IF_DETAILS, bridge_domain_sw_if_details) \
57 _(BRIDGE_FLAGS, bridge_flags)
60 send_l2_xconnect_details (unix_shared_memory_queue_t * q, u32 context,
61 u32 rx_sw_if_index, u32 tx_sw_if_index)
63 vl_api_l2_xconnect_details_t *mp;
65 mp = vl_msg_api_alloc (sizeof (*mp));
66 memset (mp, 0, sizeof (*mp));
67 mp->_vl_msg_id = ntohs (VL_API_L2_XCONNECT_DETAILS);
68 mp->context = context;
69 mp->rx_sw_if_index = htonl (rx_sw_if_index);
70 mp->tx_sw_if_index = htonl (tx_sw_if_index);
72 vl_msg_api_send_shmem (q, (u8 *) & mp);
76 vl_api_l2_xconnect_dump_t_handler (vl_api_l2_xconnect_dump_t * mp)
78 unix_shared_memory_queue_t *q;
79 vnet_main_t *vnm = vnet_get_main ();
80 vnet_interface_main_t *im = &vnm->interface_main;
81 l2input_main_t *l2im = &l2input_main;
82 vnet_sw_interface_t *swif;
83 l2_input_config_t *config;
85 q = vl_api_client_index_to_input_queue (mp->client_index);
90 pool_foreach (swif, im->sw_interfaces,
92 config = vec_elt_at_index (l2im->configs, swif->sw_if_index);
94 send_l2_xconnect_details (q, mp->context, swif->sw_if_index,
95 config->output_sw_if_index);
101 vl_api_l2_fib_clear_table_t_handler (vl_api_l2_fib_clear_table_t * mp)
104 vl_api_l2_fib_clear_table_reply_t *rmp;
106 /* DAW-FIXME: This API should only clear non-static l2fib entries, but
107 * that is not currently implemented. When that TODO is fixed
108 * this call should be changed to pass 1 instead of 0.
110 l2fib_clear_table (0);
112 REPLY_MACRO (VL_API_L2_FIB_CLEAR_TABLE_REPLY);
116 send_l2fib_table_entry (vpe_api_main_t * am,
117 unix_shared_memory_queue_t * q,
118 l2fib_entry_key_t * l2fe_key,
119 l2fib_entry_result_t * l2fe_res, u32 context)
121 vl_api_l2_fib_table_entry_t *mp;
123 mp = vl_msg_api_alloc (sizeof (*mp));
124 memset (mp, 0, sizeof (*mp));
125 mp->_vl_msg_id = ntohs (VL_API_L2_FIB_TABLE_ENTRY);
128 ntohl (l2input_main.bd_configs[l2fe_key->fields.bd_index].bd_id);
130 mp->mac = l2fib_make_key (l2fe_key->fields.mac, 0);
131 mp->sw_if_index = ntohl (l2fe_res->fields.sw_if_index);
132 mp->static_mac = l2fe_res->fields.static_mac;
133 mp->filter_mac = l2fe_res->fields.filter;
134 mp->bvi_mac = l2fe_res->fields.bvi;
135 mp->context = context;
137 vl_msg_api_send_shmem (q, (u8 *) & mp);
141 vl_api_l2_fib_table_entry_t_handler (vl_api_l2_fib_table_entry_t * mp)
143 clib_warning ("BUG");
147 vl_api_l2_fib_table_dump_t_handler (vl_api_l2_fib_table_dump_t * mp)
149 vpe_api_main_t *am = &vpe_api_main;
150 bd_main_t *bdm = &bd_main;
151 l2fib_entry_key_t *l2fe_key = NULL;
152 l2fib_entry_result_t *l2fe_res = NULL;
153 u32 ni, bd_id = ntohl (mp->bd_id);
155 unix_shared_memory_queue_t *q;
158 q = vl_api_client_index_to_input_queue (mp->client_index);
162 /* see l2fib_table_dump: ~0 means "any" */
167 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
174 l2fib_table_dump (bd_index, &l2fe_key, &l2fe_res);
176 vec_foreach_index (ni, l2fe_key)
178 send_l2fib_table_entry (am, q, vec_elt_at_index (l2fe_key, ni),
179 vec_elt_at_index (l2fe_res, ni), mp->context);
186 vl_api_l2fib_add_del_t_handler (vl_api_l2fib_add_del_t * mp)
188 bd_main_t *bdm = &bd_main;
189 l2input_main_t *l2im = &l2input_main;
190 vl_api_l2fib_add_del_reply_t *rmp;
193 u32 sw_if_index = ntohl (mp->sw_if_index);
194 u32 bd_id = ntohl (mp->bd_id);
203 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
206 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
207 goto bad_sw_if_index;
213 filter_mac = mp->filter_mac ? 1 : 0;
216 VALIDATE_SW_IF_INDEX (mp);
217 if (vec_len (l2im->configs) <= sw_if_index)
219 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
220 goto bad_sw_if_index;
224 l2_input_config_t *config;
225 config = vec_elt_at_index (l2im->configs, sw_if_index);
226 if (config->bridge == 0)
228 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
229 goto bad_sw_if_index;
233 static_mac = mp->static_mac ? 1 : 0;
234 bvi_mac = mp->bvi_mac ? 1 : 0;
235 l2fib_add_entry (mac, bd_index, sw_if_index, static_mac, filter_mac,
240 l2fib_del_entry (mac, bd_index);
243 BAD_SW_IF_INDEX_LABEL;
245 REPLY_MACRO (VL_API_L2FIB_ADD_DEL_REPLY);
249 vl_api_l2_flags_t_handler (vl_api_l2_flags_t * mp)
251 vl_api_l2_flags_reply_t *rmp;
253 u32 sw_if_index = ntohl (mp->sw_if_index);
254 u32 flags = ntohl (mp->feature_bitmap);
257 VALIDATE_SW_IF_INDEX (mp);
260 if (flags & L2INPUT_FEAT_ ## a) \
261 rbm = l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_ ## a, mp->is_set);
262 foreach_l2input_feat;
265 BAD_SW_IF_INDEX_LABEL;
268 REPLY_MACRO2(VL_API_L2_FLAGS_REPLY,
270 rmp->resulting_feature_bitmap = ntohl(rbm);
276 vl_api_bridge_domain_add_del_t_handler (vl_api_bridge_domain_add_del_t * mp)
278 vlib_main_t *vm = vlib_get_main ();
279 bd_main_t *bdm = &bd_main;
280 vl_api_bridge_domain_add_del_reply_t *rmp;
282 u32 enable_flags = 0, disable_flags = 0;
283 u32 bd_id = ntohl (mp->bd_id);
288 bd_index = bd_find_or_add_bd_index (bdm, bd_id);
291 enable_flags |= L2_FLOOD;
293 disable_flags |= L2_FLOOD;
296 enable_flags |= L2_UU_FLOOD;
298 disable_flags |= L2_UU_FLOOD;
301 enable_flags |= L2_FWD;
303 disable_flags |= L2_FWD;
306 enable_flags |= L2_ARP_TERM;
308 disable_flags |= L2_ARP_TERM;
311 enable_flags |= L2_LEARN;
313 disable_flags |= L2_LEARN;
316 bd_set_flags (vm, bd_index, enable_flags, 1 /* enable */ );
319 bd_set_flags (vm, bd_index, disable_flags, 0 /* disable */ );
321 bd_set_mac_age (vm, bd_index, mp->mac_age);
324 rv = bd_delete_bd_index (bdm, bd_id);
326 REPLY_MACRO (VL_API_BRIDGE_DOMAIN_ADD_DEL_REPLY);
330 vl_api_bridge_domain_details_t_handler (vl_api_bridge_domain_details_t * mp)
332 clib_warning ("BUG");
336 vl_api_bridge_domain_sw_if_details_t_handler
337 (vl_api_bridge_domain_sw_if_details_t * mp)
339 clib_warning ("BUG");
343 send_bridge_domain_details (unix_shared_memory_queue_t * q,
344 l2_bridge_domain_t * bd_config,
345 u32 n_sw_ifs, u32 context)
347 vl_api_bridge_domain_details_t *mp;
349 mp = vl_msg_api_alloc (sizeof (*mp));
350 memset (mp, 0, sizeof (*mp));
351 mp->_vl_msg_id = ntohs (VL_API_BRIDGE_DOMAIN_DETAILS);
352 mp->bd_id = ntohl (bd_config->bd_id);
353 mp->flood = bd_feature_flood (bd_config);
354 mp->uu_flood = bd_feature_uu_flood (bd_config);
355 mp->forward = bd_feature_forward (bd_config);
356 mp->learn = bd_feature_learn (bd_config);
357 mp->arp_term = bd_feature_arp_term (bd_config);
358 mp->bvi_sw_if_index = ntohl (bd_config->bvi_sw_if_index);
359 mp->mac_age = bd_config->mac_age;
360 mp->n_sw_ifs = ntohl (n_sw_ifs);
361 mp->context = context;
363 vl_msg_api_send_shmem (q, (u8 *) & mp);
367 send_bd_sw_if_details (l2input_main_t * l2im,
368 unix_shared_memory_queue_t * q,
369 l2_flood_member_t * member, u32 bd_id, u32 context)
371 vl_api_bridge_domain_sw_if_details_t *mp;
372 l2_input_config_t *input_cfg;
374 mp = vl_msg_api_alloc (sizeof (*mp));
375 memset (mp, 0, sizeof (*mp));
376 mp->_vl_msg_id = ntohs (VL_API_BRIDGE_DOMAIN_SW_IF_DETAILS);
377 mp->bd_id = ntohl (bd_id);
378 mp->sw_if_index = ntohl (member->sw_if_index);
379 input_cfg = vec_elt_at_index (l2im->configs, member->sw_if_index);
380 mp->shg = input_cfg->shg;
381 mp->context = context;
383 vl_msg_api_send_shmem (q, (u8 *) & mp);
387 vl_api_bridge_domain_dump_t_handler (vl_api_bridge_domain_dump_t * mp)
389 bd_main_t *bdm = &bd_main;
390 l2input_main_t *l2im = &l2input_main;
391 unix_shared_memory_queue_t *q;
392 l2_bridge_domain_t *bd_config;
396 q = vl_api_client_index_to_input_queue (mp->client_index);
401 bd_id = ntohl (mp->bd_id);
403 bd_index = (bd_id == ~0) ? 0 : bd_find_or_add_bd_index (bdm, bd_id);
404 end = (bd_id == ~0) ? vec_len (l2im->bd_configs) : bd_index + 1;
405 for (; bd_index < end; bd_index++)
407 bd_config = l2input_bd_config_from_index (l2im, bd_index);
408 /* skip dummy bd_id 0 */
409 if (bd_config && (bd_config->bd_id > 0))
412 l2_flood_member_t *m;
414 n_sw_ifs = vec_len (bd_config->members);
415 send_bridge_domain_details (q, bd_config, n_sw_ifs, mp->context);
417 vec_foreach (m, bd_config->members)
419 send_bd_sw_if_details (l2im, q, m, bd_config->bd_id, mp->context);
426 vl_api_bridge_flags_t_handler (vl_api_bridge_flags_t * mp)
428 vlib_main_t *vm = vlib_get_main ();
429 bd_main_t *bdm = &bd_main;
430 vl_api_bridge_flags_reply_t *rmp;
432 u32 bd_id = ntohl (mp->bd_id);
434 u32 flags = ntohl (mp->feature_bitmap);
437 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
440 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
446 bd_set_flags (vm, bd_index, flags, mp->is_set);
450 REPLY_MACRO2(VL_API_BRIDGE_FLAGS_REPLY,
452 rmp->resulting_feature_bitmap = ntohl(flags);
459 * Add vpe's API message handlers to the table.
460 * vlib has alread mapped shared memory and
461 * added the client registration handlers.
462 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
464 #define vl_msg_name_crc_list
465 #include <vnet/vnet_all_api_h.h>
466 #undef vl_msg_name_crc_list
469 setup_message_id_table (api_main_t * am)
471 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
472 foreach_vl_msg_name_crc_l2;
476 static clib_error_t *
477 l2_api_hookup (vlib_main_t * vm)
479 api_main_t *am = &api_main;
482 vl_msg_api_set_handlers(VL_API_##N, #n, \
483 vl_api_##n##_t_handler, \
485 vl_api_##n##_t_endian, \
486 vl_api_##n##_t_print, \
487 sizeof(vl_api_##n##_t), 1);
492 * Set up the (msg_name, crc, message-id) table
494 setup_message_id_table (am);
499 VLIB_API_INIT_FUNCTION (l2_api_hookup);
502 * fd.io coding-style-patch-verification: ON
505 * eval: (c-set-style "gnu")