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>
31 #include <vnet/ip/ip_types_api.h>
33 #include <vnet/format_fns.h>
34 #include <vnet/bfd/bfd.api_enum.h>
35 #include <vnet/bfd/bfd.api_types.h>
37 #define REPLY_MSG_ID_BASE bfd_main.msg_id_base
38 #include <vlibapi/api_helper_macros.h>
41 pub_sub_handler (bfd_events, BFD_EVENTS);
43 #define BFD_UDP_API_PARAM_COMMON_CODE \
44 ip46_address_t local_addr; \
45 ip46_address_t peer_addr; \
46 ip_address_decode(&mp->local_addr, &local_addr); \
47 ip_address_decode(&mp->peer_addr, &peer_addr);
49 #define BFD_UDP_API_PARAM_FROM_MP(mp) \
50 clib_net_to_host_u32 (mp->sw_if_index), &local_addr, &peer_addr
53 vl_api_bfd_udp_add_t_handler (vl_api_bfd_udp_add_t * mp)
55 vl_api_bfd_udp_add_reply_t *rmp;
58 VALIDATE_SW_IF_INDEX (mp);
60 BFD_UDP_API_PARAM_COMMON_CODE;
62 rv = bfd_udp_add_session (BFD_UDP_API_PARAM_FROM_MP (mp),
63 clib_net_to_host_u32 (mp->desired_min_tx),
64 clib_net_to_host_u32 (mp->required_min_rx),
65 mp->detect_mult, mp->is_authenticated,
66 clib_net_to_host_u32 (mp->conf_key_id),
69 BAD_SW_IF_INDEX_LABEL;
70 REPLY_MACRO (VL_API_BFD_UDP_ADD_REPLY);
74 vl_api_bfd_udp_mod_t_handler (vl_api_bfd_udp_mod_t * mp)
76 vl_api_bfd_udp_mod_reply_t *rmp;
79 VALIDATE_SW_IF_INDEX (mp);
81 BFD_UDP_API_PARAM_COMMON_CODE;
83 rv = bfd_udp_mod_session (BFD_UDP_API_PARAM_FROM_MP (mp),
84 clib_net_to_host_u32 (mp->desired_min_tx),
85 clib_net_to_host_u32 (mp->required_min_rx),
88 BAD_SW_IF_INDEX_LABEL;
89 REPLY_MACRO (VL_API_BFD_UDP_MOD_REPLY);
93 vl_api_bfd_udp_del_t_handler (vl_api_bfd_udp_del_t * mp)
95 vl_api_bfd_udp_del_reply_t *rmp;
98 VALIDATE_SW_IF_INDEX (mp);
100 BFD_UDP_API_PARAM_COMMON_CODE;
102 rv = bfd_udp_del_session (BFD_UDP_API_PARAM_FROM_MP (mp));
104 BAD_SW_IF_INDEX_LABEL;
105 REPLY_MACRO (VL_API_BFD_UDP_DEL_REPLY);
109 send_bfd_udp_session_details (vl_api_registration_t * reg, u32 context,
112 if (bs->transport != BFD_TRANSPORT_UDP4 &&
113 bs->transport != BFD_TRANSPORT_UDP6)
118 vl_api_bfd_udp_session_details_t *mp = vl_msg_api_alloc (sizeof (*mp));
119 clib_memset (mp, 0, sizeof (*mp));
120 mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_BFD_UDP_SESSION_DETAILS);
121 mp->context = context;
122 mp->state = clib_host_to_net_u32 (bs->local_state);
123 bfd_udp_session_t *bus = &bs->udp;
124 bfd_udp_key_t *key = &bus->key;
125 mp->sw_if_index = clib_host_to_net_u32 (key->sw_if_index);
126 if ((!bs->auth.is_delayed && bs->auth.curr_key) ||
127 (bs->auth.is_delayed && bs->auth.next_key))
129 mp->is_authenticated = true;
131 if (bs->auth.is_delayed && bs->auth.next_key)
133 mp->bfd_key_id = bs->auth.next_bfd_key_id;
134 mp->conf_key_id = clib_host_to_net_u32 (bs->auth.next_key->conf_key_id);
136 else if (!bs->auth.is_delayed && bs->auth.curr_key)
138 mp->bfd_key_id = bs->auth.curr_bfd_key_id;
139 mp->conf_key_id = clib_host_to_net_u32 (bs->auth.curr_key->conf_key_id);
141 ip_address_encode (&key->local_addr, IP46_TYPE_ANY, &mp->local_addr);
142 ip_address_encode (&key->peer_addr, IP46_TYPE_ANY, &mp->peer_addr);
144 mp->required_min_rx =
145 clib_host_to_net_u32 (bs->config_required_min_rx_usec);
146 mp->desired_min_tx = clib_host_to_net_u32 (bs->config_desired_min_tx_usec);
147 mp->detect_mult = bs->local_detect_mult;
148 vl_api_send_msg (reg, (u8 *) mp);
152 send_bfd_udp_session_event (vl_api_registration_t *reg, u32 pid,
155 if (bs->transport != BFD_TRANSPORT_UDP4 &&
156 bs->transport != BFD_TRANSPORT_UDP6)
161 vl_api_bfd_udp_session_event_t *mp = vl_msg_api_alloc (sizeof (*mp));
162 clib_memset (mp, 0, sizeof (*mp));
163 mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_BFD_UDP_SESSION_EVENT);
165 mp->state = clib_host_to_net_u32 (bs->local_state);
166 bfd_udp_session_t *bus = &bs->udp;
167 bfd_udp_key_t *key = &bus->key;
168 mp->sw_if_index = clib_host_to_net_u32 (key->sw_if_index);
169 if ((!bs->auth.is_delayed && bs->auth.curr_key) ||
170 (bs->auth.is_delayed && bs->auth.next_key))
172 mp->is_authenticated = true;
174 if (bs->auth.is_delayed && bs->auth.next_key)
176 mp->bfd_key_id = bs->auth.next_bfd_key_id;
177 mp->conf_key_id = clib_host_to_net_u32 (bs->auth.next_key->conf_key_id);
179 else if (!bs->auth.is_delayed && bs->auth.curr_key)
181 mp->bfd_key_id = bs->auth.curr_bfd_key_id;
182 mp->conf_key_id = clib_host_to_net_u32 (bs->auth.curr_key->conf_key_id);
184 ip_address_encode (&key->local_addr, IP46_TYPE_ANY, &mp->local_addr);
185 ip_address_encode (&key->peer_addr, IP46_TYPE_ANY, &mp->peer_addr);
187 mp->required_min_rx = clib_host_to_net_u32 (bs->config_required_min_rx_usec);
188 mp->desired_min_tx = clib_host_to_net_u32 (bs->config_desired_min_tx_usec);
189 mp->detect_mult = bs->local_detect_mult;
190 vl_api_send_msg (reg, (u8 *) mp);
194 bfd_event (bfd_main_t * bm, bfd_session_t * bs)
196 vpe_api_main_t *vam = &vpe_api_main;
197 vpe_client_registration_t *reg;
198 vl_api_registration_t *vl_reg;
200 pool_foreach (reg, vam->bfd_events_registrations) {
201 vl_reg = vl_api_client_index_to_registration (reg->client_index);
204 switch (bs->transport)
206 case BFD_TRANSPORT_UDP4:
208 case BFD_TRANSPORT_UDP6:
209 send_bfd_udp_session_event (vl_reg, 0, bs);
217 vl_api_bfd_udp_session_dump_t_handler (vl_api_bfd_udp_session_dump_t * mp)
219 vl_api_registration_t *reg;
221 reg = vl_api_client_index_to_registration (mp->client_index);
225 bfd_session_t *bs = NULL;
227 pool_foreach (bs, bfd_main.sessions) {
228 if (bs->transport == BFD_TRANSPORT_UDP4 ||
229 bs->transport == BFD_TRANSPORT_UDP6)
230 send_bfd_udp_session_details (reg, mp->context, bs);
236 vl_api_bfd_udp_session_set_flags_t_handler (vl_api_bfd_udp_session_set_flags_t
239 vl_api_bfd_udp_session_set_flags_reply_t *rmp;
242 BFD_UDP_API_PARAM_COMMON_CODE;
244 rv = bfd_udp_session_set_flags (vlib_get_main (),
245 BFD_UDP_API_PARAM_FROM_MP (mp),
246 clib_net_to_host_u32 (mp->flags) &
247 IF_STATUS_API_FLAG_ADMIN_UP);
249 REPLY_MACRO (VL_API_BFD_UDP_SESSION_SET_FLAGS_REPLY);
253 vl_api_bfd_auth_set_key_t_handler (vl_api_bfd_auth_set_key_t * mp)
255 vl_api_bfd_auth_set_key_reply_t *rmp;
256 int rv = bfd_auth_set_key (clib_net_to_host_u32 (mp->conf_key_id),
257 mp->auth_type, mp->key_len, mp->key);
259 REPLY_MACRO (VL_API_BFD_AUTH_SET_KEY_REPLY);
263 vl_api_bfd_auth_del_key_t_handler (vl_api_bfd_auth_del_key_t * mp)
265 vl_api_bfd_auth_del_key_reply_t *rmp;
266 int rv = bfd_auth_del_key (clib_net_to_host_u32 (mp->conf_key_id));
268 REPLY_MACRO (VL_API_BFD_AUTH_DEL_KEY_REPLY);
272 vl_api_bfd_auth_keys_dump_t_handler (vl_api_bfd_auth_keys_dump_t * mp)
274 vl_api_registration_t *reg;
276 reg = vl_api_client_index_to_registration (mp->client_index);
280 bfd_auth_key_t *key = NULL;
281 vl_api_bfd_auth_keys_details_t *rmp = NULL;
284 pool_foreach (key, bfd_main.auth_keys) {
285 rmp = vl_msg_api_alloc (sizeof (*rmp));
286 clib_memset (rmp, 0, sizeof (*rmp));
287 rmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_BFD_AUTH_KEYS_DETAILS);
288 rmp->context = mp->context;
289 rmp->conf_key_id = clib_host_to_net_u32 (key->conf_key_id);
290 rmp->auth_type = key->auth_type;
291 rmp->use_count = clib_host_to_net_u32 (key->use_count);
292 vl_api_send_msg (reg, (u8 *)rmp);
298 vl_api_bfd_udp_auth_activate_t_handler (vl_api_bfd_udp_auth_activate_t * mp)
300 vl_api_bfd_udp_auth_activate_reply_t *rmp;
303 VALIDATE_SW_IF_INDEX (mp);
305 BFD_UDP_API_PARAM_COMMON_CODE;
307 rv = bfd_udp_auth_activate (BFD_UDP_API_PARAM_FROM_MP (mp),
308 clib_net_to_host_u32 (mp->conf_key_id),
309 mp->bfd_key_id, mp->is_delayed);
311 BAD_SW_IF_INDEX_LABEL;
312 REPLY_MACRO (VL_API_BFD_UDP_AUTH_ACTIVATE_REPLY);
316 vl_api_bfd_udp_auth_deactivate_t_handler (vl_api_bfd_udp_auth_deactivate_t *
319 vl_api_bfd_udp_auth_deactivate_reply_t *rmp;
322 VALIDATE_SW_IF_INDEX (mp);
324 BFD_UDP_API_PARAM_COMMON_CODE;
327 bfd_udp_auth_deactivate (BFD_UDP_API_PARAM_FROM_MP (mp), mp->is_delayed);
329 BAD_SW_IF_INDEX_LABEL;
330 REPLY_MACRO (VL_API_BFD_UDP_AUTH_DEACTIVATE_REPLY);
334 vl_api_bfd_udp_set_echo_source_t_handler (vl_api_bfd_udp_set_echo_source_t *
337 vl_api_bfd_udp_set_echo_source_reply_t *rmp;
340 VALIDATE_SW_IF_INDEX (mp);
342 rv = bfd_udp_set_echo_source (clib_net_to_host_u32 (mp->sw_if_index));
344 BAD_SW_IF_INDEX_LABEL;
345 REPLY_MACRO (VL_API_BFD_UDP_SET_ECHO_SOURCE_REPLY);
349 vl_api_bfd_udp_del_echo_source_t_handler (vl_api_bfd_udp_del_echo_source_t *
352 vl_api_bfd_udp_del_echo_source_reply_t *rmp;
355 rv = bfd_udp_del_echo_source ();
357 REPLY_MACRO (VL_API_BFD_UDP_DEL_ECHO_SOURCE_REPLY);
361 vl_api_bfd_udp_get_echo_source_t_handler (vl_api_bfd_udp_get_echo_source_t *
364 vl_api_bfd_udp_get_echo_source_reply_t *rmp;
373 bfd_udp_get_echo_source (&is_set, &sw_if_index, &have_usable_ip4, &ip4,
374 &have_usable_ip6, &ip6);
377 REPLY_MACRO2 (VL_API_BFD_UDP_GET_ECHO_SOURCE_REPLY,
379 rmp->sw_if_index = ntohl (sw_if_index);
383 rmp->sw_if_index = clib_host_to_net_u32 (sw_if_index);
386 rmp->have_usable_ip4 = true;
387 ip4_address_encode(&ip4, rmp->ip4_addr);
391 rmp->have_usable_ip4 = false;
395 rmp->have_usable_ip6 = true;
396 ip6_address_encode(&ip6, rmp->ip6_addr);
400 rmp->have_usable_ip6 = false;
406 rmp->have_usable_ip4 = false;
407 rmp->have_usable_ip6 = false;
413 #include <vnet/bfd/bfd.api.c>
414 static clib_error_t *
415 bfd_api_hookup (vlib_main_t * vm)
418 * Set up the (msg_name, crc, message-id) table
420 REPLY_MSG_ID_BASE = setup_message_id_table ();
425 VLIB_API_INIT_FUNCTION (bfd_api_hookup);
428 * fd.io coding-style-patch-verification: ON
431 * eval: (c-set-style "gnu")