2 *------------------------------------------------------------------
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 *------------------------------------------------------------------
21 * @brief BFD binary API implementation
24 #include <vnet/vnet.h>
25 #include <vlibmemory/api.h>
27 #include <vnet/interface.h>
28 #include <vnet/api_errno.h>
29 #include <vnet/bfd/bfd_main.h>
30 #include <vnet/bfd/bfd_api.h>
32 #include <vnet/vnet_msg_enum.h>
34 #define vl_typedefs /* define message structures */
35 #include <vnet/vnet_all_api_h.h>
38 #define vl_endianfun /* define message structures */
39 #include <vnet/vnet_all_api_h.h>
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 _ (BFD_UDP_ADD, bfd_udp_add) \
52 _ (BFD_UDP_MOD, bfd_udp_mod) \
53 _ (BFD_UDP_DEL, bfd_udp_del) \
54 _ (BFD_UDP_SESSION_DUMP, bfd_udp_session_dump) \
55 _ (BFD_UDP_SESSION_SET_FLAGS, bfd_udp_session_set_flags) \
56 _ (WANT_BFD_EVENTS, want_bfd_events) \
57 _ (BFD_AUTH_SET_KEY, bfd_auth_set_key) \
58 _ (BFD_AUTH_DEL_KEY, bfd_auth_del_key) \
59 _ (BFD_AUTH_KEYS_DUMP, bfd_auth_keys_dump) \
60 _ (BFD_UDP_AUTH_ACTIVATE, bfd_udp_auth_activate) \
61 _ (BFD_UDP_AUTH_DEACTIVATE, bfd_udp_auth_deactivate) \
62 _ (BFD_UDP_SET_ECHO_SOURCE, bfd_udp_set_echo_source) \
63 _ (BFD_UDP_DEL_ECHO_SOURCE, bfd_udp_del_echo_source)
65 pub_sub_handler (bfd_events, BFD_EVENTS);
67 #define BFD_UDP_API_PARAM_COMMON_CODE \
68 ip46_address_t local_addr; \
69 memset (&local_addr, 0, sizeof (local_addr)); \
70 ip46_address_t peer_addr; \
71 memset (&peer_addr, 0, sizeof (peer_addr)); \
74 clib_memcpy (&local_addr.ip6, mp->local_addr, sizeof (local_addr.ip6)); \
75 clib_memcpy (&peer_addr.ip6, mp->peer_addr, sizeof (peer_addr.ip6)); \
79 clib_memcpy (&local_addr.ip4, mp->local_addr, sizeof (local_addr.ip4)); \
80 clib_memcpy (&peer_addr.ip4, mp->peer_addr, sizeof (peer_addr.ip4)); \
83 #define BFD_UDP_API_PARAM_FROM_MP(mp) \
84 clib_net_to_host_u32 (mp->sw_if_index), &local_addr, &peer_addr
87 vl_api_bfd_udp_add_t_handler (vl_api_bfd_udp_add_t * mp)
89 vl_api_bfd_udp_add_reply_t *rmp;
92 VALIDATE_SW_IF_INDEX (mp);
94 BFD_UDP_API_PARAM_COMMON_CODE;
96 rv = bfd_udp_add_session (BFD_UDP_API_PARAM_FROM_MP (mp),
97 clib_net_to_host_u32 (mp->desired_min_tx),
98 clib_net_to_host_u32 (mp->required_min_rx),
99 mp->detect_mult, mp->is_authenticated,
100 clib_net_to_host_u32 (mp->conf_key_id),
103 BAD_SW_IF_INDEX_LABEL;
104 REPLY_MACRO (VL_API_BFD_UDP_ADD_REPLY);
108 vl_api_bfd_udp_mod_t_handler (vl_api_bfd_udp_mod_t * mp)
110 vl_api_bfd_udp_mod_reply_t *rmp;
113 VALIDATE_SW_IF_INDEX (mp);
115 BFD_UDP_API_PARAM_COMMON_CODE;
117 rv = bfd_udp_mod_session (BFD_UDP_API_PARAM_FROM_MP (mp),
118 clib_net_to_host_u32 (mp->desired_min_tx),
119 clib_net_to_host_u32 (mp->required_min_rx),
122 BAD_SW_IF_INDEX_LABEL;
123 REPLY_MACRO (VL_API_BFD_UDP_MOD_REPLY);
127 vl_api_bfd_udp_del_t_handler (vl_api_bfd_udp_del_t * mp)
129 vl_api_bfd_udp_del_reply_t *rmp;
132 VALIDATE_SW_IF_INDEX (mp);
134 BFD_UDP_API_PARAM_COMMON_CODE;
136 rv = bfd_udp_del_session (BFD_UDP_API_PARAM_FROM_MP (mp));
138 BAD_SW_IF_INDEX_LABEL;
139 REPLY_MACRO (VL_API_BFD_UDP_DEL_REPLY);
143 send_bfd_udp_session_details (vl_api_registration_t * reg, u32 context,
146 if (bs->transport != BFD_TRANSPORT_UDP4 &&
147 bs->transport != BFD_TRANSPORT_UDP6)
152 vl_api_bfd_udp_session_details_t *mp = vl_msg_api_alloc (sizeof (*mp));
153 memset (mp, 0, sizeof (*mp));
154 mp->_vl_msg_id = ntohs (VL_API_BFD_UDP_SESSION_DETAILS);
155 mp->context = context;
156 mp->state = bs->local_state;
157 bfd_udp_session_t *bus = &bs->udp;
158 bfd_udp_key_t *key = &bus->key;
159 mp->sw_if_index = clib_host_to_net_u32 (key->sw_if_index);
160 mp->is_ipv6 = !(ip46_address_is_ip4 (&key->local_addr));
161 if ((!bs->auth.is_delayed && bs->auth.curr_key) ||
162 (bs->auth.is_delayed && bs->auth.next_key))
164 mp->is_authenticated = 1;
166 if (bs->auth.is_delayed && bs->auth.next_key)
168 mp->bfd_key_id = bs->auth.next_bfd_key_id;
169 mp->conf_key_id = clib_host_to_net_u32 (bs->auth.next_key->conf_key_id);
171 else if (!bs->auth.is_delayed && bs->auth.curr_key)
173 mp->bfd_key_id = bs->auth.curr_bfd_key_id;
174 mp->conf_key_id = clib_host_to_net_u32 (bs->auth.curr_key->conf_key_id);
178 clib_memcpy (mp->local_addr, &key->local_addr,
179 sizeof (key->local_addr));
180 clib_memcpy (mp->peer_addr, &key->peer_addr, sizeof (key->peer_addr));
184 clib_memcpy (mp->local_addr, key->local_addr.ip4.data,
185 sizeof (key->local_addr.ip4.data));
186 clib_memcpy (mp->peer_addr, key->peer_addr.ip4.data,
187 sizeof (key->peer_addr.ip4.data));
190 mp->required_min_rx =
191 clib_host_to_net_u32 (bs->config_required_min_rx_usec);
192 mp->desired_min_tx = clib_host_to_net_u32 (bs->config_desired_min_tx_usec);
193 mp->detect_mult = bs->local_detect_mult;
194 vl_api_send_msg (reg, (u8 *) mp);
198 bfd_event (bfd_main_t * bm, bfd_session_t * bs)
200 vpe_api_main_t *vam = &vpe_api_main;
201 vpe_client_registration_t *reg;
202 vl_api_registration_t *vl_reg;
204 pool_foreach (reg, vam->bfd_events_registrations, ({
205 vl_reg = vl_api_client_index_to_registration (reg->client_index);
208 switch (bs->transport)
210 case BFD_TRANSPORT_UDP4:
212 case BFD_TRANSPORT_UDP6:
213 send_bfd_udp_session_details (vl_reg, 0, bs);
221 vl_api_bfd_udp_session_dump_t_handler (vl_api_bfd_udp_session_dump_t * mp)
223 vl_api_registration_t *reg;
225 reg = vl_api_client_index_to_registration (mp->client_index);
229 bfd_session_t *bs = NULL;
231 pool_foreach (bs, bfd_main.sessions, ({
232 if (bs->transport == BFD_TRANSPORT_UDP4 ||
233 bs->transport == BFD_TRANSPORT_UDP6)
234 send_bfd_udp_session_details (reg, mp->context, bs);
240 vl_api_bfd_udp_session_set_flags_t_handler (vl_api_bfd_udp_session_set_flags_t
243 vl_api_bfd_udp_session_set_flags_reply_t *rmp;
246 BFD_UDP_API_PARAM_COMMON_CODE;
248 rv = bfd_udp_session_set_flags (BFD_UDP_API_PARAM_FROM_MP (mp),
251 REPLY_MACRO (VL_API_BFD_UDP_SESSION_SET_FLAGS_REPLY);
255 vl_api_bfd_auth_set_key_t_handler (vl_api_bfd_auth_set_key_t * mp)
257 vl_api_bfd_auth_set_key_reply_t *rmp;
258 int rv = bfd_auth_set_key (clib_net_to_host_u32 (mp->conf_key_id),
259 mp->auth_type, mp->key_len, mp->key);
261 REPLY_MACRO (VL_API_BFD_AUTH_SET_KEY_REPLY);
265 vl_api_bfd_auth_del_key_t_handler (vl_api_bfd_auth_del_key_t * mp)
267 vl_api_bfd_auth_del_key_reply_t *rmp;
268 int rv = bfd_auth_del_key (clib_net_to_host_u32 (mp->conf_key_id));
270 REPLY_MACRO (VL_API_BFD_AUTH_DEL_KEY_REPLY);
274 vl_api_bfd_auth_keys_dump_t_handler (vl_api_bfd_auth_keys_dump_t * mp)
276 vl_api_registration_t *reg;
278 reg = vl_api_client_index_to_registration (mp->client_index);
282 bfd_auth_key_t *key = NULL;
283 vl_api_bfd_auth_keys_details_t *rmp = NULL;
286 pool_foreach (key, bfd_main.auth_keys, ({
287 rmp = vl_msg_api_alloc (sizeof (*rmp));
288 memset (rmp, 0, sizeof (*rmp));
289 rmp->_vl_msg_id = ntohs (VL_API_BFD_AUTH_KEYS_DETAILS);
290 rmp->context = mp->context;
291 rmp->conf_key_id = clib_host_to_net_u32 (key->conf_key_id);
292 rmp->auth_type = key->auth_type;
293 rmp->use_count = clib_host_to_net_u32 (key->use_count);
294 vl_api_send_msg (reg, (u8 *)rmp);
300 vl_api_bfd_udp_auth_activate_t_handler (vl_api_bfd_udp_auth_activate_t * mp)
302 vl_api_bfd_udp_auth_activate_reply_t *rmp;
305 VALIDATE_SW_IF_INDEX (mp);
307 BFD_UDP_API_PARAM_COMMON_CODE;
309 rv = bfd_udp_auth_activate (BFD_UDP_API_PARAM_FROM_MP (mp),
310 clib_net_to_host_u32 (mp->conf_key_id),
311 mp->bfd_key_id, mp->is_delayed);
313 BAD_SW_IF_INDEX_LABEL;
314 REPLY_MACRO (VL_API_BFD_UDP_AUTH_ACTIVATE_REPLY);
318 vl_api_bfd_udp_auth_deactivate_t_handler (vl_api_bfd_udp_auth_deactivate_t *
321 vl_api_bfd_udp_auth_deactivate_reply_t *rmp;
324 VALIDATE_SW_IF_INDEX (mp);
326 BFD_UDP_API_PARAM_COMMON_CODE;
329 bfd_udp_auth_deactivate (BFD_UDP_API_PARAM_FROM_MP (mp), mp->is_delayed);
331 BAD_SW_IF_INDEX_LABEL;
332 REPLY_MACRO (VL_API_BFD_UDP_AUTH_DEACTIVATE_REPLY);
336 vl_api_bfd_udp_set_echo_source_t_handler (vl_api_bfd_udp_set_echo_source_t *
339 vl_api_bfd_udp_set_echo_source_reply_t *rmp;
342 VALIDATE_SW_IF_INDEX (mp);
344 rv = bfd_udp_set_echo_source (clib_net_to_host_u32 (mp->sw_if_index));
346 BAD_SW_IF_INDEX_LABEL;
347 REPLY_MACRO (VL_API_BFD_UDP_SET_ECHO_SOURCE_REPLY);
351 vl_api_bfd_udp_del_echo_source_t_handler (vl_api_bfd_udp_del_echo_source_t *
354 vl_api_bfd_udp_del_echo_source_reply_t *rmp;
357 rv = bfd_udp_del_echo_source ();
359 REPLY_MACRO (VL_API_BFD_UDP_DEL_ECHO_SOURCE_REPLY);
364 * Add vpe's API message handlers to the table.
365 * vlib has alread mapped shared memory and
366 * added the client registration handlers.
367 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
369 #define vl_msg_name_crc_list
370 #include <vnet/vnet_all_api_h.h>
371 #undef vl_msg_name_crc_list
374 setup_message_id_table (api_main_t * am)
376 #define _(id, n, crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
377 foreach_vl_msg_name_crc_bfd;
381 static clib_error_t *
382 bfd_api_hookup (vlib_main_t * vm)
384 api_main_t *am = &api_main;
387 vl_msg_api_set_handlers (VL_API_##N, #n, vl_api_##n##_t_handler, \
388 vl_noop_handler, vl_api_##n##_t_endian, \
389 vl_api_##n##_t_print, sizeof (vl_api_##n##_t), 1);
394 * Set up the (msg_name, crc, message-id) table
396 setup_message_id_table (am);
401 VLIB_API_INIT_FUNCTION (bfd_api_hookup);
404 * fd.io coding-style-patch-verification: ON
407 * eval: (c-set-style "gnu")