FD.io VPP  v17.10-9-gd594711
Vector Packet Processing
bfd_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * bfd_api.c - bfd api
4  *
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:
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
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  *------------------------------------------------------------------
18  */
19 /**
20  * @file
21  * @brief BFD binary API implementation
22  */
23 
24 #include <vnet/vnet.h>
25 #include <vlibmemory/api.h>
26 
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 
32 #include <vnet/vnet_msg_enum.h>
33 
34 #define vl_typedefs /* define message structures */
35 #include <vnet/vnet_all_api_h.h>
36 #undef vl_typedefs
37 
38 #define vl_endianfun /* define message structures */
39 #include <vnet/vnet_all_api_h.h>
40 #undef vl_endianfun
41 
42 /* instantiate all the print functions we know about */
43 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
44 #define vl_printfun
45 #include <vnet/vnet_all_api_h.h>
46 #undef vl_printfun
47 
49 
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)
64 
65 pub_sub_handler (bfd_events, BFD_EVENTS);
66 
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)); \
72  if (mp->is_ipv6) \
73  { \
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)); \
76  } \
77  else \
78  { \
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)); \
81  }
82 
83 #define BFD_UDP_API_PARAM_FROM_MP(mp) \
84  clib_net_to_host_u32 (mp->sw_if_index), &local_addr, &peer_addr
85 
86 static void
88 {
89  vl_api_bfd_udp_add_reply_t *rmp;
90  int rv;
91 
93 
95 
97  clib_net_to_host_u32 (mp->desired_min_tx),
98  clib_net_to_host_u32 (mp->required_min_rx),
100  clib_net_to_host_u32 (mp->conf_key_id),
101  mp->bfd_key_id);
102 
104  REPLY_MACRO (VL_API_BFD_UDP_ADD_REPLY);
105 }
106 
107 static void
109 {
110  vl_api_bfd_udp_mod_reply_t *rmp;
111  int rv;
112 
114 
116 
118  clib_net_to_host_u32 (mp->desired_min_tx),
119  clib_net_to_host_u32 (mp->required_min_rx),
120  mp->detect_mult);
121 
123  REPLY_MACRO (VL_API_BFD_UDP_MOD_REPLY);
124 }
125 
126 static void
128 {
129  vl_api_bfd_udp_del_reply_t *rmp;
130  int rv;
131 
133 
135 
137 
139  REPLY_MACRO (VL_API_BFD_UDP_DEL_REPLY);
140 }
141 
142 void
144  bfd_session_t * bs)
145 {
146  if (bs->transport != BFD_TRANSPORT_UDP4 &&
147  bs->transport != BFD_TRANSPORT_UDP6)
148  {
149  return;
150  }
151 
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))
163  {
164  mp->is_authenticated = 1;
165  }
166  if (bs->auth.is_delayed && bs->auth.next_key)
167  {
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);
170  }
171  else if (!bs->auth.is_delayed && bs->auth.curr_key)
172  {
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);
175  }
176  if (mp->is_ipv6)
177  {
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));
181  }
182  else
183  {
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));
188  }
189 
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_msg_api_send_shmem (q, (u8 *) & mp);
195 }
196 
197 void
199 {
203  /* *INDENT-OFF* */
204  pool_foreach (reg, vam->bfd_events_registrations, ({
205  q = vl_api_client_index_to_input_queue (reg->client_index);
206  if (q)
207  {
208  switch (bs->transport)
209  {
210  case BFD_TRANSPORT_UDP4:
211  /* fallthrough */
212  case BFD_TRANSPORT_UDP6:
213  send_bfd_udp_session_details (q, 0, bs);
214  }
215  }
216  }));
217  /* *INDENT-ON* */
218 }
219 
220 static void
222 {
224 
226 
227  if (q == 0)
228  return;
229 
230  bfd_session_t *bs = NULL;
231  /* *INDENT-OFF* */
233  if (bs->transport == BFD_TRANSPORT_UDP4 ||
234  bs->transport == BFD_TRANSPORT_UDP6)
235  send_bfd_udp_session_details (q, mp->context, bs);
236  }));
237  /* *INDENT-ON* */
238 }
239 
240 static void
242  * mp)
243 {
244  vl_api_bfd_udp_session_set_flags_reply_t *rmp;
245  int rv;
246 
248 
250  mp->admin_up_down);
251 
252  REPLY_MACRO (VL_API_BFD_UDP_SESSION_SET_FLAGS_REPLY);
253 }
254 
255 static void
257 {
258  vl_api_bfd_auth_set_key_reply_t *rmp;
259  int rv = bfd_auth_set_key (clib_net_to_host_u32 (mp->conf_key_id),
260  mp->auth_type, mp->key_len, mp->key);
261 
262  REPLY_MACRO (VL_API_BFD_AUTH_SET_KEY_REPLY);
263 }
264 
265 static void
267 {
268  vl_api_bfd_auth_del_key_reply_t *rmp;
269  int rv = bfd_auth_del_key (clib_net_to_host_u32 (mp->conf_key_id));
270 
271  REPLY_MACRO (VL_API_BFD_AUTH_DEL_KEY_REPLY);
272 }
273 
274 static void
276 {
278 
280 
281  if (q == 0)
282  return;
283 
284  bfd_auth_key_t *key = NULL;
286 
287  /* *INDENT-OFF* */
289  rmp = vl_msg_api_alloc (sizeof (*rmp));
290  memset (rmp, 0, sizeof (*rmp));
291  rmp->_vl_msg_id = ntohs (VL_API_BFD_AUTH_KEYS_DETAILS);
292  rmp->context = mp->context;
293  rmp->conf_key_id = clib_host_to_net_u32 (key->conf_key_id);
294  rmp->auth_type = key->auth_type;
295  rmp->use_count = clib_host_to_net_u32 (key->use_count);
296  vl_msg_api_send_shmem (q, (u8 *)&rmp);
297  }));
298  /* *INDENT-ON* */
299 }
300 
301 static void
303 {
304  vl_api_bfd_udp_auth_activate_reply_t *rmp;
305  int rv;
306 
308 
310 
312  clib_net_to_host_u32 (mp->conf_key_id),
313  mp->bfd_key_id, mp->is_delayed);
314 
316  REPLY_MACRO (VL_API_BFD_UDP_AUTH_ACTIVATE_REPLY);
317 }
318 
319 static void
321  mp)
322 {
323  vl_api_bfd_udp_auth_deactivate_reply_t *rmp;
324  int rv;
325 
327 
329 
330  rv =
332 
334  REPLY_MACRO (VL_API_BFD_UDP_AUTH_DEACTIVATE_REPLY);
335 }
336 
337 static void
339  mp)
340 {
341  vl_api_bfd_udp_set_echo_source_reply_t *rmp;
342  int rv;
343 
345 
346  rv = bfd_udp_set_echo_source (clib_net_to_host_u32 (mp->sw_if_index));
347 
349  REPLY_MACRO (VL_API_BFD_UDP_SET_ECHO_SOURCE_REPLY);
350 }
351 
352 static void
354  mp)
355 {
356  vl_api_bfd_udp_del_echo_source_reply_t *rmp;
357  int rv;
358 
359  rv = bfd_udp_del_echo_source ();
360 
361  REPLY_MACRO (VL_API_BFD_UDP_DEL_ECHO_SOURCE_REPLY);
362 }
363 
364 /*
365  * bfd_api_hookup
366  * Add vpe's API message handlers to the table.
367  * vlib has alread mapped shared memory and
368  * added the client registration handlers.
369  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
370  */
371 #define vl_msg_name_crc_list
372 #include <vnet/vnet_all_api_h.h>
373 #undef vl_msg_name_crc_list
374 
375 static void
377 {
378 #define _(id, n, crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
379  foreach_vl_msg_name_crc_bfd;
380 #undef _
381 }
382 
383 static clib_error_t *
385 {
386  api_main_t *am = &api_main;
387 
388 #define _(N, n) \
389  vl_msg_api_set_handlers (VL_API_##N, #n, vl_api_##n##_t_handler, \
390  vl_noop_handler, vl_api_##n##_t_endian, \
391  vl_api_##n##_t_print, sizeof (vl_api_##n##_t), 1);
393 #undef _
394 
395  /*
396  * Set up the (msg_name, crc, message-id) table
397  */
399 
400  return 0;
401 }
402 
404 
405 /*
406  * fd.io coding-style-patch-verification: ON
407  *
408  * Local Variables:
409  * eval: (c-set-style "gnu")
410  * End:
411  */
static void vl_api_bfd_auth_keys_dump_t_handler(vl_api_bfd_auth_keys_dump_t *mp)
Definition: bfd_api.c:275
VLIB_API_INIT_FUNCTION(bfd_api_hookup)
static void vl_api_bfd_udp_auth_activate_t_handler(vl_api_bfd_udp_auth_activate_t *mp)
Definition: bfd_api.c:302
u8 curr_bfd_key_id
current key ID sent out in bfd packet
Definition: bfd_main.h:218
Add UDP BFD session on interface.
Definition: bfd.api:52
Set flags of BFD UDP session.
Definition: bfd.api:159
static void vl_api_bfd_udp_auth_deactivate_t_handler(vl_api_bfd_udp_auth_deactivate_t *mp)
Definition: bfd_api.c:320
BFD UDP - add/replace key to configuration.
Definition: bfd.api:192
static void vl_api_bfd_auth_del_key_t_handler(vl_api_bfd_auth_del_key_t *mp)
Definition: bfd_api.c:266
bfd_main_t bfd_main
Definition: bfd_main.c:2050
#define foreach_vpe_api_msg
Definition: bfd_api.c:50
vnet_api_error_t bfd_udp_mod_session(u32 sw_if_index, const ip46_address_t *local_addr, const ip46_address_t *peer_addr, u32 desired_min_tx_usec, u32 required_min_rx_usec, u8 detect_mult)
modify existing session
Definition: bfd_udp.c:695
BFD authentication key details.
Definition: bfd.api:232
#define NULL
Definition: clib.h:55
vnet_api_error_t bfd_udp_add_session(u32 sw_if_index, const ip46_address_t *local_addr, const ip46_address_t *peer_addr, u32 desired_min_tx_usec, u32 required_min_rx_usec, u8 detect_mult, u8 is_authenticated, u32 conf_key_id, u8 bfd_key_id)
create a new bfd session
Definition: bfd_udp.c:653
vnet_api_error_t bfd_auth_del_key(u32 conf_key_id)
delete existing authentication key
Definition: bfd_main.c:2014
#define BFD_UDP_API_PARAM_COMMON_CODE
Definition: bfd_api.c:67
pub_sub_handler(bfd_events, BFD_EVENTS)
vnet_api_error_t bfd_udp_del_echo_source()
unset echo-source interface
static clib_error_t * bfd_api_hookup(vlib_main_t *vm)
Definition: bfd_api.c:384
vnet_api_error_t bfd_udp_del_session(u32 sw_if_index, const ip46_address_t *local_addr, const ip46_address_t *peer_addr)
delete existing session
Definition: bfd_udp.c:716
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:437
UDP transport specific data embedded in bfd_session&#39;s union.
Definition: bfd_udp.h:44
void bfd_event(bfd_main_t *bm, bfd_session_t *bs)
Definition: bfd_api.c:198
#define BFD_UDP_API_PARAM_FROM_MP(mp)
Definition: bfd_api.c:83
vnet_api_error_t bfd_auth_set_key(u32 conf_key_id, u8 auth_type, u8 key_len, const u8 *key)
create or modify bfd authentication key
Definition: bfd_main.c:1960
bfd_auth_key_t * next_key
set to next key to use if delayed switch is enabled - in that case the key is switched when first inc...
Definition: bfd_main.h:206
Get all BFD sessions.
Definition: bfd.api:114
void * vl_msg_api_alloc(int nbytes)
bfd_session_t * sessions
pool of bfd sessions context data
Definition: bfd_main.h:263
bfd_auth_key_t * auth_keys
pool of authentication keys
Definition: bfd_main.h:294
bfd_udp_key_t key
key identifying this session
Definition: bfd_udp.h:47
bfd_transport_e transport
transport type for this session
Definition: bfd_main.h:231
BFD session details structure.
Definition: bfd.api:134
BFD global declarations.
Set BFD echo source.
Definition: bfd.api:21
u8 local_detect_mult
configured detect multiplier
Definition: bfd_main.h:143
#define REPLY_MACRO(t)
Get a list of configured authentication keys.
Definition: bfd.api:220
void send_bfd_udp_session_details(unix_shared_memory_queue_t *q, u32 context, bfd_session_t *bs)
Definition: bfd_api.c:143
vnet_api_error_t bfd_udp_session_set_flags(u32 sw_if_index, const ip46_address_t *local_addr, const ip46_address_t *peer_addr, u8 admin_up_down)
set session admin down/up
Definition: bfd_udp.c:733
bfd_udp_session_t udp
Definition: bfd_main.h:236
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:182
#define ip46_address_is_ip4(ip46)
Definition: ip6_packet.h:76
static void setup_message_id_table(api_main_t *am)
Definition: bfd_api.c:376
#define BAD_SW_IF_INDEX_LABEL
Delete BFD echo source.
Definition: bfd.api:32
static void vl_api_bfd_auth_set_key_t_handler(vl_api_bfd_auth_set_key_t *mp)
Definition: bfd_api.c:256
api_main_t api_main
Definition: api_shared.c:35
vlib_main_t * vm
Definition: buffer.c:283
u32 config_desired_min_tx_usec
configured desired min tx interval (microseconds)
Definition: bfd_main.h:110
#define clib_memcpy(a, b, c)
Definition: string.h:69
unix_shared_memory_queue_t * vl_api_client_index_to_input_queue(u32 index)
static void vl_api_bfd_udp_set_echo_source_t_handler(vl_api_bfd_udp_set_echo_source_t *mp)
Definition: bfd_api.c:338
static void vl_api_bfd_udp_session_dump_t_handler(vl_api_bfd_udp_session_dump_t *mp)
Definition: bfd_api.c:221
BFD UDP - deactivate authentication.
Definition: bfd.api:273
void vl_msg_api_send_shmem(unix_shared_memory_queue_t *q, u8 *elem)
unsigned int u32
Definition: types.h:88
static void vl_api_bfd_udp_add_t_handler(vl_api_bfd_udp_add_t *mp)
Definition: bfd_api.c:87
vnet_api_error_t bfd_udp_auth_activate(u32 sw_if_index, const ip46_address_t *local_addr, const ip46_address_t *peer_addr, u32 conf_key_id, u8 bfd_key_id, u8 is_delayed)
activate authentication for existing session
Definition: bfd_udp.c:750
u32 conf_key_id
global configuration key ID
Definition: bfd_main.h:41
bfd_state_e local_state
session state
Definition: bfd_main.h:89
static void vl_api_bfd_udp_mod_t_handler(vl_api_bfd_udp_mod_t *mp)
Definition: bfd_api.c:108
Delete UDP BFD session on interface.
Definition: bfd.api:100
vnet_api_error_t bfd_udp_set_echo_source(u32 loopback_sw_if_index)
set echo-source interface
Definition: bfd_udp.c:72
u32 config_required_min_rx_usec
configured required min rx interval (microseconds)
Definition: bfd_main.h:119
static void vl_api_bfd_udp_del_t_handler(vl_api_bfd_udp_del_t *mp)
Definition: bfd_api.c:127
unsigned char u8
Definition: types.h:56
BFD API declarations.
BFD UDP - activate/change authentication.
Definition: bfd.api:251
static void vl_api_bfd_udp_session_set_flags_t_handler(vl_api_bfd_udp_session_set_flags_t *mp)
Definition: bfd_api.c:241
u8 next_bfd_key_id
key ID to use when switched to next_key
Definition: bfd_main.h:221
static void vl_api_bfd_udp_del_echo_source_t_handler(vl_api_bfd_udp_del_echo_source_t *mp)
Definition: bfd_api.c:353
vnet_api_error_t bfd_udp_auth_deactivate(u32 sw_if_index, const ip46_address_t *local_addr, const ip46_address_t *peer_addr, u8 is_delayed)
deactivate authentication for existing session
Definition: bfd_udp.c:772
Modify UDP BFD session on interface.
Definition: bfd.api:79
struct bfd_session_s::@47 auth
authentication information
bfd_auth_key_t * curr_key
current key in use
Definition: bfd_main.h:200
vpe_api_main_t vpe_api_main
Definition: interface_api.c:49
BFD UDP - delete key from configuration.
Definition: bfd.api:209
u8 is_delayed
set to 1 if delayed action is pending, which might be activation of authentication, change of key or deactivation
Definition: bfd_main.h:227
#define VALIDATE_SW_IF_INDEX(mp)
struct _unix_shared_memory_queue unix_shared_memory_queue_t