2 * Copyright (c) 2011-2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
17 * @brief BFD nodes implementation
21 #include <openssl/sha.h>
25 #include <x86intrin.h>
28 #include <vlibmemory/api.h>
29 #include <vppinfra/random.h>
30 #include <vppinfra/error.h>
31 #include <vppinfra/hash.h>
32 #include <vppinfra/xxhash.h>
33 #include <vnet/ethernet/ethernet.h>
34 #include <vnet/ethernet/packet.h>
35 #include <vnet/bfd/bfd_debug.h>
36 #include <vnet/bfd/bfd_protocol.h>
37 #include <vnet/bfd/bfd_main.h>
41 bfd_calc_echo_checksum (u32 discriminator, u64 expire_time, u32 secret)
44 #if defined(clib_crc32c_uses_intrinsics) && !defined (__i386__)
45 checksum = crc32_u64 (0, discriminator);
46 checksum = crc32_u64 (checksum, expire_time);
47 checksum = crc32_u64 (checksum, secret);
49 checksum = clib_xxhash (discriminator ^ expire_time ^ secret);
55 bfd_usec_to_clocks (const bfd_main_t * bm, u64 us)
57 return bm->cpu_cps * ((f64) us / USEC_PER_SECOND);
61 bfd_clocks_to_usec (const bfd_main_t * bm, u64 clocks)
63 return (clocks / bm->cpu_cps) * USEC_PER_SECOND;
66 static vlib_node_registration_t bfd_process_node;
69 format_bfd_auth_key (u8 * s, va_list * args)
71 const bfd_auth_key_t *key = va_arg (*args, bfd_auth_key_t *);
74 s = format (s, "{auth-type=%u:%s, conf-key-id=%u, use-count=%u}, ",
75 key->auth_type, bfd_auth_type_str (key->auth_type),
76 key->conf_key_id, key->use_count);
80 s = format (s, "{none}");
86 * We actually send all bfd pkts to the "error" node after scanning
87 * them, so the graph node has only one next-index. The "error-drop"
88 * node automatically bumps our per-node packet counters for us.
92 BFD_INPUT_NEXT_NORMAL,
96 static void bfd_on_state_change (bfd_main_t * bm, bfd_session_t * bs, u64 now,
100 bfd_set_defaults (bfd_main_t * bm, bfd_session_t * bs)
102 bs->local_state = BFD_STATE_down;
103 bs->local_diag = BFD_DIAG_CODE_no_diag;
104 bs->remote_state = BFD_STATE_down;
105 bs->remote_discr = 0;
106 bs->hop_type = BFD_HOP_TYPE_SINGLE;
107 bs->config_desired_min_tx_usec = BFD_DEFAULT_DESIRED_MIN_TX_USEC;
108 bs->config_desired_min_tx_clocks = bm->default_desired_min_tx_clocks;
109 bs->effective_desired_min_tx_clocks = bm->default_desired_min_tx_clocks;
110 bs->remote_min_rx_usec = 1;
111 bs->remote_min_rx_clocks = bfd_usec_to_clocks (bm, bs->remote_min_rx_usec);
112 bs->remote_min_echo_rx_usec = 0;
113 bs->remote_min_echo_rx_clocks = 0;
114 bs->remote_demand = 0;
115 bs->auth.remote_seq_number = 0;
116 bs->auth.remote_seq_number_known = 0;
117 bs->auth.local_seq_number = random_u32 (&bm->random_seed);
118 bs->echo_secret = random_u32 (&bm->random_seed);
122 bfd_set_diag (bfd_session_t * bs, bfd_diag_code_e code)
124 if (bs->local_diag != code)
126 BFD_DBG ("set local_diag, bs_idx=%d: '%d:%s'", bs->bs_idx, code,
127 bfd_diag_code_string (code));
128 bs->local_diag = code;
133 bfd_set_state (bfd_main_t * bm, bfd_session_t * bs,
134 bfd_state_e new_state, int handling_wakeup)
136 if (bs->local_state != new_state)
138 BFD_DBG ("Change state, bs_idx=%d: %s->%s", bs->bs_idx,
139 bfd_state_string (bs->local_state),
140 bfd_state_string (new_state));
141 bs->local_state = new_state;
142 bfd_on_state_change (bm, bs, clib_cpu_time_now (), handling_wakeup);
147 bfd_poll_state_string (bfd_poll_state_e state)
153 return "BFD_POLL_" #x;
154 foreach_bfd_poll_state (F)
161 bfd_set_poll_state (bfd_session_t * bs, bfd_poll_state_e state)
163 if (bs->poll_state != state)
165 BFD_DBG ("Setting poll state=%s, bs_idx=%u",
166 bfd_poll_state_string (state), bs->bs_idx);
167 bs->poll_state = state;
172 bfd_recalc_tx_interval (bfd_main_t * bm, bfd_session_t * bs)
174 bs->transmit_interval_clocks =
175 clib_max (bs->effective_desired_min_tx_clocks, bs->remote_min_rx_clocks);
176 BFD_DBG ("Recalculated transmit interval " BFD_CLK_FMT,
177 BFD_CLK_PRN (bs->transmit_interval_clocks));
181 bfd_recalc_echo_tx_interval (bfd_main_t * bm, bfd_session_t * bs)
183 bs->echo_transmit_interval_clocks =
184 clib_max (bs->effective_desired_min_tx_clocks,
185 bs->remote_min_echo_rx_clocks);
186 BFD_DBG ("Recalculated echo transmit interval " BFD_CLK_FMT,
187 BFD_CLK_PRN (bs->echo_transmit_interval_clocks));
191 bfd_calc_next_tx (bfd_main_t * bm, bfd_session_t * bs, u64 now)
193 if (bs->local_detect_mult > 1)
195 /* common case - 75-100% of transmit interval */
196 bs->tx_timeout_clocks = bs->last_tx_clocks +
197 (1 - .25 * (random_f64 (&bm->random_seed))) *
198 bs->transmit_interval_clocks;
199 if (bs->tx_timeout_clocks < now)
202 * the timeout is in the past, which means that either remote
203 * demand mode was set or performance/clock issues ...
205 BFD_DBG ("Missed %lu transmit events (now is %lu, calc "
206 "tx_timeout is %lu)",
207 (now - bs->tx_timeout_clocks) /
208 bs->transmit_interval_clocks, now, bs->tx_timeout_clocks);
209 bs->tx_timeout_clocks = now;
214 /* special case - 75-90% of transmit interval */
215 bs->tx_timeout_clocks = bs->last_tx_clocks +
216 (.9 - .15 * (random_f64 (&bm->random_seed))) *
217 bs->transmit_interval_clocks;
218 if (bs->tx_timeout_clocks < now)
221 * the timeout is in the past, which means that either remote
222 * demand mode was set or performance/clock issues ...
224 BFD_DBG ("Missed %lu transmit events (now is %lu, calc "
225 "tx_timeout is %lu)",
226 (now - bs->tx_timeout_clocks) /
227 bs->transmit_interval_clocks, now, bs->tx_timeout_clocks);
228 bs->tx_timeout_clocks = now;
231 if (bs->tx_timeout_clocks)
233 BFD_DBG ("Next transmit in %lu clocks/%.02fs@%lu",
234 bs->tx_timeout_clocks - now,
235 (bs->tx_timeout_clocks - now) / bm->cpu_cps,
236 bs->tx_timeout_clocks);
241 bfd_calc_next_echo_tx (bfd_main_t * bm, bfd_session_t * bs, u64 now)
243 bs->echo_tx_timeout_clocks =
244 bs->echo_last_tx_clocks + bs->echo_transmit_interval_clocks;
245 if (bs->echo_tx_timeout_clocks < now)
247 /* huh, we've missed it already, transmit now */
248 BFD_DBG ("Missed %lu echo transmit events (now is %lu, calc tx_timeout "
250 (now - bs->echo_tx_timeout_clocks) /
251 bs->echo_transmit_interval_clocks,
252 now, bs->echo_tx_timeout_clocks);
253 bs->echo_tx_timeout_clocks = now;
255 BFD_DBG ("Next echo transmit in %lu clocks/%.02fs@%lu",
256 bs->echo_tx_timeout_clocks - now,
257 (bs->echo_tx_timeout_clocks - now) / bm->cpu_cps,
258 bs->echo_tx_timeout_clocks);
262 bfd_recalc_detection_time (bfd_main_t * bm, bfd_session_t * bs)
264 if (bs->local_state == BFD_STATE_init || bs->local_state == BFD_STATE_up)
266 bs->detection_time_clocks =
267 bs->remote_detect_mult *
268 clib_max (bs->effective_required_min_rx_clocks,
269 bs->remote_desired_min_tx_clocks);
270 BFD_DBG ("Recalculated detection time %lu clocks/%.2fs",
271 bs->detection_time_clocks,
272 bs->detection_time_clocks / bm->cpu_cps);
277 bfd_set_timer (bfd_main_t * bm, bfd_session_t * bs, u64 now,
283 if (BFD_STATE_up == bs->local_state)
285 rx_timeout = bs->last_rx_clocks + bs->detection_time_clocks;
287 if (BFD_STATE_up != bs->local_state ||
288 (!bs->remote_demand && bs->remote_min_rx_usec) ||
289 BFD_POLL_NOT_NEEDED != bs->poll_state)
291 tx_timeout = bs->tx_timeout_clocks;
293 if (tx_timeout && rx_timeout)
295 next = clib_min (tx_timeout, rx_timeout);
305 if (bs->echo && next > bs->echo_tx_timeout_clocks)
307 next = bs->echo_tx_timeout_clocks;
309 BFD_DBG ("bs_idx=%u, tx_timeout=%lu, echo_tx_timeout=%lu, rx_timeout=%lu, "
311 bs->bs_idx, tx_timeout, bs->echo_tx_timeout_clocks, rx_timeout,
313 ? "tx" : (next == bs->echo_tx_timeout_clocks ? "echo tx" : "rx"));
314 /* sometimes the wheel expires an event a bit sooner than requested, account
316 if (next && (now + bm->wheel_inaccuracy > bs->wheel_time_clocks ||
317 next < bs->wheel_time_clocks || !bs->wheel_time_clocks))
320 bs->wheel_time_clocks = next;
321 BFD_DBG ("timing_wheel_insert(%p, %lu (%ld clocks/%.2fs in the "
323 &bm->wheel, bs->wheel_time_clocks,
324 (i64) bs->wheel_time_clocks - clib_cpu_time_now (),
325 (i64) (bs->wheel_time_clocks - clib_cpu_time_now ()) /
326 bm->cpu_cps, bs->bs_idx);
328 timing_wheel_insert (&bm->wheel, bs->wheel_time_clocks, bs->bs_idx);
330 if (!handling_wakeup)
333 /* Send only if it is earlier than current awaited wakeup time */
335 (bs->wheel_time_clocks < bm->bfd_process_next_wakeup_clocks) &&
337 * If the wake-up time is within 2x the delay of the event propagation delay,
338 * avoid the expense of sending the event. The 2x multiplier is to workaround the race whereby
339 * simultaneous event + expired timer create one recurring bogus wakeup/suspend instance,
340 * due to double scheduling of the node on the pending list.
342 (bm->bfd_process_next_wakeup_clocks - bs->wheel_time_clocks >
343 2 * bm->bfd_process_wakeup_event_delay_clocks) &&
344 /* Must be no events in flight to send an event */
345 (!bm->bfd_process_wakeup_events_in_flight);
347 /* If we do send the signal, note this down along with the start timestamp */
350 bm->bfd_process_wakeup_events_in_flight++;
351 bm->bfd_process_wakeup_event_start_clocks = now;
356 /* Use the multithreaded event sending so the workers can send events too */
359 vlib_process_signal_event_mt (bm->vlib_main,
360 bm->bfd_process_node_index,
361 BFD_EVENT_RESCHEDULE, ~0);
367 bfd_set_effective_desired_min_tx (bfd_main_t * bm,
368 bfd_session_t * bs, u64 now,
369 u64 desired_min_tx_clocks)
371 bs->effective_desired_min_tx_clocks = desired_min_tx_clocks;
372 BFD_DBG ("Set effective desired min tx to " BFD_CLK_FMT,
373 BFD_CLK_PRN (bs->effective_desired_min_tx_clocks));
374 bfd_recalc_detection_time (bm, bs);
375 bfd_recalc_tx_interval (bm, bs);
376 bfd_recalc_echo_tx_interval (bm, bs);
377 bfd_calc_next_tx (bm, bs, now);
381 bfd_set_effective_required_min_rx (bfd_main_t * bm,
383 u64 required_min_rx_clocks)
385 bs->effective_required_min_rx_clocks = required_min_rx_clocks;
386 BFD_DBG ("Set effective required min rx to " BFD_CLK_FMT,
387 BFD_CLK_PRN (bs->effective_required_min_rx_clocks));
388 bfd_recalc_detection_time (bm, bs);
392 bfd_set_remote_required_min_rx (bfd_main_t * bm, bfd_session_t * bs,
393 u64 now, u32 remote_required_min_rx_usec)
395 if (bs->remote_min_rx_usec != remote_required_min_rx_usec)
397 bs->remote_min_rx_usec = remote_required_min_rx_usec;
398 bs->remote_min_rx_clocks =
399 bfd_usec_to_clocks (bm, remote_required_min_rx_usec);
400 BFD_DBG ("Set remote min rx to " BFD_CLK_FMT,
401 BFD_CLK_PRN (bs->remote_min_rx_clocks));
402 bfd_recalc_detection_time (bm, bs);
403 bfd_recalc_tx_interval (bm, bs);
408 bfd_set_remote_required_min_echo_rx (bfd_main_t * bm, bfd_session_t * bs,
410 u32 remote_required_min_echo_rx_usec)
412 if (bs->remote_min_echo_rx_usec != remote_required_min_echo_rx_usec)
414 bs->remote_min_echo_rx_usec = remote_required_min_echo_rx_usec;
415 bs->remote_min_echo_rx_clocks =
416 bfd_usec_to_clocks (bm, bs->remote_min_echo_rx_usec);
417 BFD_DBG ("Set remote min echo rx to " BFD_CLK_FMT,
418 BFD_CLK_PRN (bs->remote_min_echo_rx_clocks));
419 bfd_recalc_echo_tx_interval (bm, bs);
424 bfd_notify_listeners (bfd_main_t * bm,
425 bfd_listen_event_e event, const bfd_session_t * bs)
428 vec_foreach (fn, bm->listeners)
435 bfd_session_start (bfd_main_t * bm, bfd_session_t * bs)
437 BFD_DBG ("\nStarting session: %U", format_bfd_session, bs);
438 vlib_log_info (bm->log_class, "start BFD session: %U",
439 format_bfd_session_brief, bs);
440 bfd_set_effective_required_min_rx (bm, bs,
441 bs->config_required_min_rx_clocks);
442 bfd_recalc_tx_interval (bm, bs);
443 vlib_process_signal_event (bm->vlib_main, bm->bfd_process_node_index,
444 BFD_EVENT_NEW_SESSION, bs->bs_idx);
445 bfd_notify_listeners (bm, BFD_LISTEN_EVENT_CREATE, bs);
449 bfd_session_set_flags (bfd_session_t * bs, u8 admin_up_down)
451 bfd_main_t *bm = &bfd_main;
452 u64 now = clib_cpu_time_now ();
455 BFD_DBG ("Session set admin-up, bs-idx=%u", bs->bs_idx);
456 vlib_log_info (bm->log_class, "set session admin-up: %U",
457 format_bfd_session_brief, bs);
458 bfd_set_state (bm, bs, BFD_STATE_down, 0);
459 bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
460 bfd_calc_next_tx (bm, bs, now);
461 bfd_set_timer (bm, bs, now, 0);
465 BFD_DBG ("Session set admin-down, bs-idx=%u", bs->bs_idx);
466 vlib_log_info (bm->log_class, "set session admin-down: %U",
467 format_bfd_session_brief, bs);
468 bfd_set_diag (bs, BFD_DIAG_CODE_admin_down);
469 bfd_set_state (bm, bs, BFD_STATE_admin_down, 0);
470 bfd_calc_next_tx (bm, bs, now);
471 bfd_set_timer (bm, bs, now, 0);
476 bfd_input_format_trace (u8 * s, va_list * args)
478 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
479 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
480 const bfd_input_trace_t *t = va_arg (*args, bfd_input_trace_t *);
481 const bfd_pkt_t *pkt = (bfd_pkt_t *) t->data;
482 if (t->len > STRUCT_SIZE_OF (bfd_pkt_t, head))
484 s = format (s, "BFD v%u, diag=%u(%s), state=%u(%s),\n"
485 " flags=(P:%u, F:%u, C:%u, A:%u, D:%u, M:%u), "
486 "detect_mult=%u, length=%u\n",
487 bfd_pkt_get_version (pkt), bfd_pkt_get_diag_code (pkt),
488 bfd_diag_code_string (bfd_pkt_get_diag_code (pkt)),
489 bfd_pkt_get_state (pkt),
490 bfd_state_string (bfd_pkt_get_state (pkt)),
491 bfd_pkt_get_poll (pkt), bfd_pkt_get_final (pkt),
492 bfd_pkt_get_control_plane_independent (pkt),
493 bfd_pkt_get_auth_present (pkt), bfd_pkt_get_demand (pkt),
494 bfd_pkt_get_multipoint (pkt), pkt->head.detect_mult,
496 if (t->len >= sizeof (bfd_pkt_t) &&
497 pkt->head.length >= sizeof (bfd_pkt_t))
499 s = format (s, " my discriminator: %u\n",
500 clib_net_to_host_u32 (pkt->my_disc));
501 s = format (s, " your discriminator: %u\n",
502 clib_net_to_host_u32 (pkt->your_disc));
503 s = format (s, " desired min tx interval: %u\n",
504 clib_net_to_host_u32 (pkt->des_min_tx));
505 s = format (s, " required min rx interval: %u\n",
506 clib_net_to_host_u32 (pkt->req_min_rx));
507 s = format (s, " required min echo rx interval: %u",
508 clib_net_to_host_u32 (pkt->req_min_echo_rx));
510 if (t->len >= sizeof (bfd_pkt_with_common_auth_t) &&
511 pkt->head.length >= sizeof (bfd_pkt_with_common_auth_t) &&
512 bfd_pkt_get_auth_present (pkt))
514 const bfd_pkt_with_common_auth_t *with_auth = (void *) pkt;
515 const bfd_auth_common_t *common = &with_auth->common_auth;
516 s = format (s, "\n auth len: %u\n", common->len);
517 s = format (s, " auth type: %u:%s\n", common->type,
518 bfd_auth_type_str (common->type));
519 if (t->len >= sizeof (bfd_pkt_with_sha1_auth_t) &&
520 pkt->head.length >= sizeof (bfd_pkt_with_sha1_auth_t) &&
521 (BFD_AUTH_TYPE_keyed_sha1 == common->type ||
522 BFD_AUTH_TYPE_meticulous_keyed_sha1 == common->type))
524 const bfd_pkt_with_sha1_auth_t *with_sha1 = (void *) pkt;
525 const bfd_auth_sha1_t *sha1 = &with_sha1->sha1_auth;
526 s = format (s, " seq num: %u\n",
527 clib_net_to_host_u32 (sha1->seq_num));
528 s = format (s, " key id: %u\n", sha1->key_id);
529 s = format (s, " hash: %U", format_hex_bytes, sha1->hash,
530 sizeof (sha1->hash));
535 s = format (s, "\n");
548 bfd_rpc_event_cb (const bfd_rpc_event_t * a)
550 bfd_main_t *bm = &bfd_main;
551 u32 bs_idx = a->bs_idx;
553 bfd_session_t session_data;
556 if (!pool_is_free_index (bm->sessions, bs_idx))
558 bfd_session_t *bs = pool_elt_at_index (bm->sessions, bs_idx);
559 clib_memcpy (&session_data, bs, sizeof (bfd_session_t));
564 BFD_DBG ("Ignoring event RPC for non-existent session index %u",
570 bfd_event (bm, &session_data);
574 bfd_event_rpc (u32 bs_idx)
576 const u32 data_size = sizeof (bfd_rpc_event_t);
578 bfd_rpc_event_t *event = (bfd_rpc_event_t *) data;
580 event->bs_idx = bs_idx;
581 vl_api_rpc_call_main_thread (bfd_rpc_event_cb, data, data_size);
587 } bfd_rpc_notify_listeners_t;
590 bfd_rpc_notify_listeners_cb (const bfd_rpc_notify_listeners_t * a)
592 bfd_main_t *bm = &bfd_main;
593 u32 bs_idx = a->bs_idx;
595 if (!pool_is_free_index (bm->sessions, bs_idx))
597 bfd_session_t *bs = pool_elt_at_index (bm->sessions, bs_idx);
598 bfd_notify_listeners (bm, BFD_LISTEN_EVENT_UPDATE, bs);
602 BFD_DBG ("Ignoring notify RPC for non-existent session index %u",
609 bfd_notify_listeners_rpc (u32 bs_idx)
611 const u32 data_size = sizeof (bfd_rpc_notify_listeners_t);
613 bfd_rpc_notify_listeners_t *notify = (bfd_rpc_notify_listeners_t *) data;
614 notify->bs_idx = bs_idx;
615 vl_api_rpc_call_main_thread (bfd_rpc_notify_listeners_cb, data, data_size);
619 bfd_on_state_change (bfd_main_t * bm, bfd_session_t * bs, u64 now,
622 BFD_DBG ("\nState changed: %U", format_bfd_session, bs);
624 if (vlib_get_thread_index () == 0)
630 /* without RPC - a REGRESSION: BFD event are not propagated */
631 bfd_event_rpc (bs->bs_idx);
634 switch (bs->local_state)
636 case BFD_STATE_admin_down:
638 bfd_set_effective_desired_min_tx (bm, bs, now,
640 (bs->config_desired_min_tx_clocks,
641 bm->default_desired_min_tx_clocks));
642 bfd_set_effective_required_min_rx (bm, bs,
643 bs->config_required_min_rx_clocks);
644 bfd_set_timer (bm, bs, now, handling_wakeup);
648 bfd_set_effective_desired_min_tx (bm, bs, now,
650 (bs->config_desired_min_tx_clocks,
651 bm->default_desired_min_tx_clocks));
652 bfd_set_effective_required_min_rx (bm, bs,
653 bs->config_required_min_rx_clocks);
654 bfd_set_timer (bm, bs, now, handling_wakeup);
658 bfd_set_effective_desired_min_tx (bm, bs, now,
659 bs->config_desired_min_tx_clocks);
660 bfd_set_timer (bm, bs, now, handling_wakeup);
663 bfd_set_effective_desired_min_tx (bm, bs, now,
664 bs->config_desired_min_tx_clocks);
665 if (BFD_POLL_NOT_NEEDED == bs->poll_state)
667 bfd_set_effective_required_min_rx (bm, bs,
668 bs->config_required_min_rx_clocks);
670 bfd_set_timer (bm, bs, now, handling_wakeup);
673 if (vlib_get_thread_index () == 0)
675 bfd_notify_listeners (bm, BFD_LISTEN_EVENT_UPDATE, bs);
679 /* without RPC - a REGRESSION: state changes are not propagated */
680 bfd_notify_listeners_rpc (bs->bs_idx);
685 bfd_on_config_change (vlib_main_t * vm, vlib_node_runtime_t * rt,
686 bfd_main_t * bm, bfd_session_t * bs, u64 now)
689 * if remote demand mode is set and we need to do a poll, set the next
690 * timeout so that the session wakes up immediately
692 if (bs->remote_demand && BFD_POLL_NEEDED == bs->poll_state &&
693 bs->poll_state_start_or_timeout_clocks < now)
695 bs->tx_timeout_clocks = now;
697 bfd_recalc_detection_time (bm, bs);
698 bfd_set_timer (bm, bs, now, 0);
702 bfd_add_transport_layer (vlib_main_t * vm, u32 bi, bfd_session_t * bs)
704 switch (bs->transport)
706 case BFD_TRANSPORT_UDP4:
707 BFD_DBG ("Transport bfd via udp4, bs_idx=%u", bs->bs_idx);
708 bfd_add_udp4_transport (vm, bi, bs, 0 /* is_echo */ );
710 case BFD_TRANSPORT_UDP6:
711 BFD_DBG ("Transport bfd via udp6, bs_idx=%u", bs->bs_idx);
712 bfd_add_udp6_transport (vm, bi, bs, 0 /* is_echo */ );
718 bfd_transport_control_frame (vlib_main_t * vm, u32 bi, bfd_session_t * bs)
720 switch (bs->transport)
722 case BFD_TRANSPORT_UDP4:
723 BFD_DBG ("Transport bfd via udp4, bs_idx=%u", bs->bs_idx);
724 return bfd_transport_udp4 (vm, bi, bs);
726 case BFD_TRANSPORT_UDP6:
727 BFD_DBG ("Transport bfd via udp6, bs_idx=%u", bs->bs_idx);
728 return bfd_transport_udp6 (vm, bi, bs);
735 bfd_echo_add_transport_layer (vlib_main_t * vm, u32 bi, bfd_session_t * bs)
737 switch (bs->transport)
739 case BFD_TRANSPORT_UDP4:
740 BFD_DBG ("Transport bfd echo via udp4, bs_idx=%u", bs->bs_idx);
741 return bfd_add_udp4_transport (vm, bi, bs, 1 /* is_echo */ );
743 case BFD_TRANSPORT_UDP6:
744 BFD_DBG ("Transport bfd echo via udp6, bs_idx=%u", bs->bs_idx);
745 return bfd_add_udp6_transport (vm, bi, bs, 1 /* is_echo */ );
752 bfd_transport_echo (vlib_main_t * vm, u32 bi, bfd_session_t * bs)
754 switch (bs->transport)
756 case BFD_TRANSPORT_UDP4:
757 BFD_DBG ("Transport bfd echo via udp4, bs_idx=%u", bs->bs_idx);
758 return bfd_transport_udp4 (vm, bi, bs);
760 case BFD_TRANSPORT_UDP6:
761 BFD_DBG ("Transport bfd echo via udp6, bs_idx=%u", bs->bs_idx);
762 return bfd_transport_udp6 (vm, bi, bs);
770 bfd_add_sha1_auth_section (vlib_buffer_t * b, bfd_session_t * bs)
772 bfd_pkt_with_sha1_auth_t *pkt = vlib_buffer_get_current (b);
773 bfd_auth_sha1_t *auth = &pkt->sha1_auth;
774 b->current_length += sizeof (*auth);
775 pkt->pkt.head.length += sizeof (*auth);
776 bfd_pkt_set_auth_present (&pkt->pkt);
777 clib_memset (auth, 0, sizeof (*auth));
778 auth->type_len.type = bs->auth.curr_key->auth_type;
780 * only meticulous authentication types require incrementing seq number
781 * for every message, but doing so doesn't violate the RFC
783 ++bs->auth.local_seq_number;
784 auth->type_len.len = sizeof (bfd_auth_sha1_t);
785 auth->key_id = bs->auth.curr_bfd_key_id;
786 auth->seq_num = clib_host_to_net_u32 (bs->auth.local_seq_number);
788 * first copy the password into the packet, then calculate the hash
789 * and finally replace the password with the calculated hash
791 clib_memcpy (auth->hash, bs->auth.curr_key->key,
792 sizeof (bs->auth.curr_key->key));
793 unsigned char hash[sizeof (auth->hash)];
794 SHA1 ((unsigned char *) pkt, sizeof (*pkt), hash);
795 BFD_DBG ("hashing: %U", format_hex_bytes, pkt, sizeof (*pkt));
796 clib_memcpy (auth->hash, hash, sizeof (hash));
801 bfd_add_auth_section (vlib_buffer_t * b, bfd_session_t * bs)
803 bfd_main_t *bm = &bfd_main;
804 if (bs->auth.curr_key)
806 const bfd_auth_type_e auth_type = bs->auth.curr_key->auth_type;
809 case BFD_AUTH_TYPE_reserved:
811 case BFD_AUTH_TYPE_simple_password:
813 case BFD_AUTH_TYPE_keyed_md5:
815 case BFD_AUTH_TYPE_meticulous_keyed_md5:
816 vlib_log_crit (bm->log_class,
817 "internal error, unexpected BFD auth type '%d'",
821 case BFD_AUTH_TYPE_keyed_sha1:
823 case BFD_AUTH_TYPE_meticulous_keyed_sha1:
824 bfd_add_sha1_auth_section (b, bs);
827 case BFD_AUTH_TYPE_keyed_sha1:
829 case BFD_AUTH_TYPE_meticulous_keyed_sha1:
830 vlib_log_crit (bm->log_class,
831 "internal error, unexpected BFD auth type '%d'",
840 bfd_is_echo_possible (bfd_session_t * bs)
842 if (BFD_STATE_up == bs->local_state && BFD_STATE_up == bs->remote_state &&
843 bs->remote_min_echo_rx_usec > 0)
845 switch (bs->transport)
847 case BFD_TRANSPORT_UDP4:
848 return bfd_udp_is_echo_available (BFD_TRANSPORT_UDP4);
849 case BFD_TRANSPORT_UDP6:
850 return bfd_udp_is_echo_available (BFD_TRANSPORT_UDP6);
857 bfd_init_control_frame (bfd_main_t * bm, bfd_session_t * bs,
860 bfd_pkt_t *pkt = vlib_buffer_get_current (b);
862 bfd_length = sizeof (bfd_pkt_t);
863 clib_memset (pkt, 0, sizeof (*pkt));
864 bfd_pkt_set_version (pkt, 1);
865 bfd_pkt_set_diag_code (pkt, bs->local_diag);
866 bfd_pkt_set_state (pkt, bs->local_state);
867 pkt->head.detect_mult = bs->local_detect_mult;
868 pkt->head.length = bfd_length;
869 pkt->my_disc = bs->local_discr;
870 pkt->your_disc = bs->remote_discr;
871 pkt->des_min_tx = clib_host_to_net_u32 (bs->config_desired_min_tx_usec);
875 clib_host_to_net_u32 (bfd_clocks_to_usec
876 (bm, bs->effective_required_min_rx_clocks));
881 clib_host_to_net_u32 (bs->config_required_min_rx_usec);
883 pkt->req_min_echo_rx = clib_host_to_net_u32 (1);
884 b->current_length = bfd_length;
888 bfd_send_echo (vlib_main_t * vm, vlib_node_runtime_t * rt,
889 bfd_main_t * bm, bfd_session_t * bs, u64 now)
891 if (!bfd_is_echo_possible (bs))
893 BFD_DBG ("\nSwitching off echo function: %U", format_bfd_session, bs);
897 /* sometimes the wheel expires an event a bit sooner than requested,
900 if (now + bm->wheel_inaccuracy >= bs->echo_tx_timeout_clocks)
902 BFD_DBG ("\nSending echo packet: %U", format_bfd_session, bs);
904 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
906 vlib_log_crit (bm->log_class, "buffer allocation failure");
909 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
910 ASSERT (b->current_data == 0);
911 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
912 bfd_echo_pkt_t *pkt = vlib_buffer_get_current (b);
913 clib_memset (pkt, 0, sizeof (*pkt));
914 pkt->discriminator = bs->local_discr;
915 pkt->expire_time_clocks =
916 now + bs->echo_transmit_interval_clocks * bs->local_detect_mult;
918 bfd_calc_echo_checksum (bs->local_discr, pkt->expire_time_clocks,
920 b->current_length = sizeof (*pkt);
921 if (!bfd_echo_add_transport_layer (vm, bi, bs))
923 BFD_ERR ("cannot send echo packet out, turning echo off");
925 vlib_buffer_free_one (vm, bi);
928 if (!bfd_transport_echo (vm, bi, bs))
930 BFD_ERR ("cannot send echo packet out, turning echo off");
932 vlib_buffer_free_one (vm, bi);
935 bs->echo_last_tx_clocks = now;
936 bfd_calc_next_echo_tx (bm, bs, now);
941 ("No need to send echo packet now, now is %lu, tx_timeout is %lu",
942 now, bs->echo_tx_timeout_clocks);
947 bfd_send_periodic (vlib_main_t * vm, vlib_node_runtime_t * rt,
948 bfd_main_t * bm, bfd_session_t * bs, u64 now)
950 if (!bs->remote_min_rx_usec && BFD_POLL_NOT_NEEDED == bs->poll_state)
952 BFD_DBG ("Remote min rx interval is zero, not sending periodic control "
956 if (BFD_POLL_NOT_NEEDED == bs->poll_state && bs->remote_demand &&
957 BFD_STATE_up == bs->local_state && BFD_STATE_up == bs->remote_state)
960 * A system MUST NOT periodically transmit BFD Control packets if Demand
961 * mode is active on the remote system (bfd.RemoteDemandMode is 1,
962 * bfd.SessionState is Up, and bfd.RemoteSessionState is Up) and a Poll
963 * Sequence is not being transmitted.
965 BFD_DBG ("Remote demand is set, not sending periodic control frame");
969 * sometimes the wheel expires an event a bit sooner than requested, account
972 if (now + bm->wheel_inaccuracy >= bs->tx_timeout_clocks)
974 BFD_DBG ("\nSending periodic control frame: %U", format_bfd_session,
977 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
979 vlib_log_crit (bm->log_class, "buffer allocation failure");
982 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
983 ASSERT (b->current_data == 0);
984 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
985 bfd_init_control_frame (bm, bs, b);
986 switch (bs->poll_state)
988 case BFD_POLL_NEEDED:
989 if (now < bs->poll_state_start_or_timeout_clocks)
991 BFD_DBG ("Cannot start a poll sequence yet, need to wait "
993 BFD_CLK_PRN (bs->poll_state_start_or_timeout_clocks -
997 bs->poll_state_start_or_timeout_clocks = now;
998 bfd_set_poll_state (bs, BFD_POLL_IN_PROGRESS);
1000 case BFD_POLL_IN_PROGRESS:
1001 case BFD_POLL_IN_PROGRESS_AND_QUEUED:
1002 bfd_pkt_set_poll (vlib_buffer_get_current (b));
1003 BFD_DBG ("Setting poll bit in packet, bs_idx=%u", bs->bs_idx);
1005 case BFD_POLL_NOT_NEEDED:
1009 bfd_add_auth_section (b, bs);
1010 bfd_add_transport_layer (vm, bi, bs);
1011 if (!bfd_transport_control_frame (vm, bi, bs))
1013 vlib_buffer_free_one (vm, bi);
1015 bs->last_tx_clocks = now;
1016 bfd_calc_next_tx (bm, bs, now);
1021 ("No need to send control frame now, now is %lu, tx_timeout is %lu",
1022 now, bs->tx_timeout_clocks);
1027 bfd_init_final_control_frame (vlib_main_t * vm, vlib_buffer_t * b,
1028 bfd_main_t * bm, bfd_session_t * bs,
1031 BFD_DBG ("Send final control frame for bs_idx=%lu", bs->bs_idx);
1032 bfd_init_control_frame (bm, bs, b);
1033 bfd_pkt_set_final (vlib_buffer_get_current (b));
1034 bfd_add_auth_section (b, bs);
1035 u32 bi = vlib_get_buffer_index (vm, b);
1036 bfd_add_transport_layer (vm, bi, bs);
1037 bs->last_tx_clocks = clib_cpu_time_now ();
1039 * RFC allows to include changes in final frame, so if there were any
1040 * pending, we already did that, thus we can clear any pending poll needs
1042 bfd_set_poll_state (bs, BFD_POLL_NOT_NEEDED);
1046 bfd_check_rx_timeout (bfd_main_t * bm, bfd_session_t * bs, u64 now,
1047 int handling_wakeup)
1050 * sometimes the wheel expires an event a bit sooner than requested, account
1053 if (bs->last_rx_clocks + bs->detection_time_clocks <=
1054 now + bm->wheel_inaccuracy)
1056 BFD_DBG ("Rx timeout, session goes down");
1058 * RFC 5880 6.8.1. State Variables
1062 * The remote discriminator for this BFD session. This is the
1063 * discriminator chosen by the remote system, and is totally opaque
1064 * to the local system. This MUST be initialized to zero. If a
1065 * period of a Detection Time passes without the receipt of a valid,
1066 * authenticated BFD packet from the remote system, this variable
1067 * MUST be set to zero.
1069 bs->remote_discr = 0;
1070 bfd_set_diag (bs, BFD_DIAG_CODE_det_time_exp);
1071 bfd_set_state (bm, bs, BFD_STATE_down, handling_wakeup);
1073 * If the remote system does not receive any
1074 * BFD Control packets for a Detection Time, it SHOULD reset
1075 * bfd.RemoteMinRxInterval to its initial value of 1 (per section 6.8.1,
1076 * since it is no longer required to maintain previous session state)
1077 * and then can transmit at its own rate.
1079 bfd_set_remote_required_min_rx (bm, bs, now, 1);
1081 else if (bs->echo &&
1082 bs->echo_last_rx_clocks +
1083 bs->echo_transmit_interval_clocks * bs->local_detect_mult <=
1084 now + bm->wheel_inaccuracy)
1086 BFD_DBG ("Echo rx timeout, session goes down");
1087 bfd_set_diag (bs, BFD_DIAG_CODE_echo_failed);
1088 bfd_set_state (bm, bs, BFD_STATE_down, handling_wakeup);
1093 bfd_on_timeout (vlib_main_t * vm, vlib_node_runtime_t * rt, bfd_main_t * bm,
1094 bfd_session_t * bs, u64 now)
1096 BFD_DBG ("Timeout for bs_idx=%lu", bs->bs_idx);
1097 switch (bs->local_state)
1099 case BFD_STATE_admin_down:
1100 bfd_send_periodic (vm, rt, bm, bs, now);
1102 case BFD_STATE_down:
1103 bfd_send_periodic (vm, rt, bm, bs, now);
1105 case BFD_STATE_init:
1106 bfd_check_rx_timeout (bm, bs, now, 1);
1107 bfd_send_periodic (vm, rt, bm, bs, now);
1110 bfd_check_rx_timeout (bm, bs, now, 1);
1111 if (BFD_POLL_NOT_NEEDED == bs->poll_state && !bs->echo &&
1112 bfd_is_echo_possible (bs))
1114 /* switch on echo function as main detection method now */
1115 BFD_DBG ("Switching on echo function, bs_idx=%u", bs->bs_idx);
1117 bs->echo_last_rx_clocks = now;
1118 bs->echo_tx_timeout_clocks = now;
1119 bfd_set_effective_required_min_rx (bm, bs,
1121 (bm->min_required_min_rx_while_echo_clocks,
1122 bs->config_required_min_rx_clocks));
1123 bfd_set_poll_state (bs, BFD_POLL_NEEDED);
1125 bfd_send_periodic (vm, rt, bm, bs, now);
1128 bfd_send_echo (vm, rt, bm, bs, now);
1135 * bfd process node function
1138 bfd_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
1140 bfd_main_t *bm = &bfd_main;
1142 uword event_type, *event_data = 0;
1144 /* So we can send events to the bfd process */
1145 bm->bfd_process_node_index = bfd_process_node.index;
1149 u64 now = clib_cpu_time_now ();
1151 u64 next_expire = timing_wheel_next_expiring_elt_time (&bm->wheel);
1152 BFD_DBG ("timing_wheel_next_expiring_elt_time(%p) returns %lu",
1153 &bm->wheel, next_expire);
1154 bm->bfd_process_next_wakeup_clocks =
1155 (i64) next_expire >= 0 ? next_expire : ~0;
1157 if ((i64) next_expire < 0)
1159 BFD_DBG ("wait for event without timeout");
1160 (void) vlib_process_wait_for_event (vm);
1161 event_type = vlib_process_get_events (vm, &event_data);
1165 f64 timeout = ((i64) next_expire - (i64) now) / bm->cpu_cps;
1166 BFD_DBG ("wait for event with timeout %.02f", timeout);
1169 BFD_DBG ("negative timeout, already expired, skipping wait");
1174 (void) vlib_process_wait_for_event_or_clock (vm, timeout);
1175 event_type = vlib_process_get_events (vm, &event_data);
1178 now = clib_cpu_time_now ();
1179 uword *session_index;
1182 case ~0: /* no events => timeout */
1183 /* nothing to do here */
1185 case BFD_EVENT_RESCHEDULE:
1187 bm->bfd_process_wakeup_event_delay_clocks =
1188 now - bm->bfd_process_wakeup_event_start_clocks;
1189 bm->bfd_process_wakeup_events_in_flight--;
1191 /* nothing to do here - reschedule is done automatically after
1192 * each event or timeout */
1194 case BFD_EVENT_NEW_SESSION:
1195 vec_foreach (session_index, event_data)
1198 if (!pool_is_free_index (bm->sessions, *session_index))
1201 pool_elt_at_index (bm->sessions, *session_index);
1202 bfd_send_periodic (vm, rt, bm, bs, now);
1203 bfd_set_timer (bm, bs, now, 1);
1207 BFD_DBG ("Ignoring event for non-existent session index %u",
1208 (u32) * session_index);
1213 case BFD_EVENT_CONFIG_CHANGED:
1214 vec_foreach (session_index, event_data)
1217 if (!pool_is_free_index (bm->sessions, *session_index))
1220 pool_elt_at_index (bm->sessions, *session_index);
1221 bfd_on_config_change (vm, rt, bm, bs, now);
1225 BFD_DBG ("Ignoring event for non-existent session index %u",
1226 (u32) * session_index);
1232 vlib_log_err (bm->log_class, "BUG: event type 0x%wx", event_type);
1235 BFD_DBG ("advancing wheel, now is %lu", now);
1236 BFD_DBG ("timing_wheel_advance (%p, %lu, %p, 0);", &bm->wheel, now,
1239 expired = timing_wheel_advance (&bm->wheel, now, expired, 0);
1240 BFD_DBG ("Expired %d elements", vec_len (expired));
1242 vec_foreach (p, expired)
1244 const u32 bs_idx = *p;
1245 if (!pool_is_free_index (bm->sessions, bs_idx))
1247 bfd_session_t *bs = pool_elt_at_index (bm->sessions, bs_idx);
1248 bfd_on_timeout (vm, rt, bm, bs, now);
1249 bfd_set_timer (bm, bs, now, 1);
1255 _vec_len (expired) = 0;
1259 _vec_len (event_data) = 0;
1267 * bfd process node declaration
1270 VLIB_REGISTER_NODE (bfd_process_node, static) = {
1271 .function = bfd_process,
1272 .type = VLIB_NODE_TYPE_PROCESS,
1273 .name = "bfd-process",
1279 static clib_error_t *
1280 bfd_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
1282 // bfd_main_t *bm = &bfd_main;
1283 // vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
1284 if (!(flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
1291 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (bfd_sw_interface_up_down);
1293 static clib_error_t *
1294 bfd_hw_interface_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
1296 // bfd_main_t *bm = &bfd_main;
1297 if (flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
1304 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION (bfd_hw_interface_up_down);
1307 bfd_register_listener (bfd_notify_fn_t fn)
1309 bfd_main_t *bm = &bfd_main;
1311 vec_add1 (bm->listeners, fn);
1317 static clib_error_t *
1318 bfd_main_init (vlib_main_t * vm)
1320 vlib_thread_main_t *tm = &vlib_thread_main;
1321 u32 n_vlib_mains = tm->n_vlib_mains;
1323 setbuf (stdout, NULL);
1325 bfd_main_t *bm = &bfd_main;
1326 bm->random_seed = random_default_seed ();
1328 bm->vnet_main = vnet_get_main ();
1329 clib_memset (&bm->wheel, 0, sizeof (bm->wheel));
1330 bm->cpu_cps = vm->clib_time.clocks_per_second;
1331 BFD_DBG ("cps is %.2f", bm->cpu_cps);
1332 bm->default_desired_min_tx_clocks =
1333 bfd_usec_to_clocks (bm, BFD_DEFAULT_DESIRED_MIN_TX_USEC);
1334 bm->min_required_min_rx_while_echo_clocks =
1335 bfd_usec_to_clocks (bm, BFD_REQUIRED_MIN_RX_USEC_WHILE_ECHO);
1336 const u64 now = clib_cpu_time_now ();
1337 timing_wheel_init (&bm->wheel, now, bm->cpu_cps);
1338 bm->wheel_inaccuracy = 2 << bm->wheel.log2_clocks_per_bin;
1339 bm->log_class = vlib_log_register_class ("bfd", 0);
1340 vlib_log_debug (bm->log_class, "initialized");
1341 bm->owner_thread_index = ~0;
1342 if (n_vlib_mains > 1)
1343 clib_spinlock_init (&bm->lock);
1347 VLIB_INIT_FUNCTION (bfd_main_init);
1350 bfd_get_session (bfd_main_t * bm, bfd_transport_e t)
1352 bfd_session_t *result;
1356 pool_get (bm->sessions, result);
1357 clib_memset (result, 0, sizeof (*result));
1358 result->bs_idx = result - bm->sessions;
1359 result->transport = t;
1360 const unsigned limit = 1000;
1361 unsigned counter = 0;
1364 result->local_discr = random_u32 (&bm->random_seed);
1365 if (counter > limit)
1367 vlib_log_crit (bm->log_class,
1368 "couldn't allocate unused session discriminator even "
1369 "after %u tries!", limit);
1370 pool_put (bm->sessions, result);
1376 while (hash_get (bm->session_by_disc, result->local_discr));
1377 bfd_set_defaults (bm, result);
1378 hash_set (bm->session_by_disc, result->local_discr, result->bs_idx);
1384 bfd_put_session (bfd_main_t * bm, bfd_session_t * bs)
1388 vlib_log_info (bm->log_class, "delete session: %U",
1389 format_bfd_session_brief, bs);
1390 bfd_notify_listeners (bm, BFD_LISTEN_EVENT_DELETE, bs);
1391 if (bs->auth.curr_key)
1393 --bs->auth.curr_key->use_count;
1395 if (bs->auth.next_key)
1397 --bs->auth.next_key->use_count;
1399 hash_unset (bm->session_by_disc, bs->local_discr);
1400 pool_put (bm->sessions, bs);
1405 bfd_find_session_by_idx (bfd_main_t * bm, uword bs_idx)
1407 bfd_lock_check (bm);
1408 if (!pool_is_free_index (bm->sessions, bs_idx))
1410 return pool_elt_at_index (bm->sessions, bs_idx);
1416 bfd_find_session_by_disc (bfd_main_t * bm, u32 disc)
1418 bfd_lock_check (bm);
1419 uword *p = hash_get (bfd_main.session_by_disc, disc);
1422 return pool_elt_at_index (bfd_main.sessions, *p);
1428 * @brief verify bfd packet - common checks
1432 * @return 1 if bfd packet is valid
1435 bfd_verify_pkt_common (const bfd_pkt_t * pkt)
1437 if (1 != bfd_pkt_get_version (pkt))
1439 BFD_ERR ("BFD verification failed - unexpected version: '%d'",
1440 bfd_pkt_get_version (pkt));
1443 if (pkt->head.length < sizeof (bfd_pkt_t) ||
1444 (bfd_pkt_get_auth_present (pkt) &&
1445 pkt->head.length < sizeof (bfd_pkt_with_common_auth_t)))
1447 BFD_ERR ("BFD verification failed - unexpected length: '%d' (auth "
1449 pkt->head.length, bfd_pkt_get_auth_present (pkt));
1452 if (!pkt->head.detect_mult)
1454 BFD_ERR ("BFD verification failed - unexpected detect-mult: '%d'",
1455 pkt->head.detect_mult);
1458 if (bfd_pkt_get_multipoint (pkt))
1460 BFD_ERR ("BFD verification failed - unexpected multipoint: '%d'",
1461 bfd_pkt_get_multipoint (pkt));
1466 BFD_ERR ("BFD verification failed - unexpected my-disc: '%d'",
1470 if (!pkt->your_disc)
1472 const u8 pkt_state = bfd_pkt_get_state (pkt);
1473 if (pkt_state != BFD_STATE_down && pkt_state != BFD_STATE_admin_down)
1475 BFD_ERR ("BFD verification failed - unexpected state: '%s' "
1476 "(your-disc is zero)", bfd_state_string (pkt_state));
1484 bfd_session_switch_auth_to_next (bfd_session_t * bs)
1486 BFD_DBG ("Switching authentication key from %U to %U for bs_idx=%u",
1487 format_bfd_auth_key, bs->auth.curr_key, format_bfd_auth_key,
1488 bs->auth.next_key, bs->bs_idx);
1489 bs->auth.is_delayed = 0;
1490 if (bs->auth.curr_key)
1492 --bs->auth.curr_key->use_count;
1494 bs->auth.curr_key = bs->auth.next_key;
1495 bs->auth.next_key = NULL;
1496 bs->auth.curr_bfd_key_id = bs->auth.next_bfd_key_id;
1500 bfd_auth_type_is_meticulous (bfd_auth_type_e auth_type)
1502 if (BFD_AUTH_TYPE_meticulous_keyed_md5 == auth_type ||
1503 BFD_AUTH_TYPE_meticulous_keyed_sha1 == auth_type)
1511 bfd_verify_pkt_auth_seq_num (bfd_session_t * bs,
1512 u32 received_seq_num, int is_meticulous)
1517 * This variable MUST be set to zero after no packets have been
1518 * received on this session for at least twice the Detection Time.
1520 u64 now = clib_cpu_time_now ();
1521 if (now - bs->last_rx_clocks > bs->detection_time_clocks * 2)
1523 BFD_DBG ("BFD peer unresponsive for %lu clocks, which is > 2 * "
1524 "detection_time=%u clocks, resetting remote_seq_number_known "
1526 now - bs->last_rx_clocks, bs->detection_time_clocks * 2);
1527 bs->auth.remote_seq_number_known = 0;
1529 if (bs->auth.remote_seq_number_known)
1531 /* remote sequence number is known, verify its validity */
1532 const u32 max_u32 = 0xffffffff;
1533 /* the calculation might wrap, account for the special case... */
1534 if (bs->auth.remote_seq_number > max_u32 - 3 * bs->local_detect_mult)
1540 * |----------+----------------------------+-----------|
1542 * | remote_seq_num------+
1544 * +-----(remote_seq_num + 3*detect_mult) % * 0xffffffff
1546 * x + y + z = 0xffffffff
1547 * x + z = 3 * detect_mult
1549 const u32 z = max_u32 - bs->auth.remote_seq_number;
1550 const u32 x = 3 * bs->local_detect_mult - z;
1551 if (received_seq_num > x &&
1552 received_seq_num < bs->auth.remote_seq_number + is_meticulous)
1555 ("Recvd sequence number=%u out of ranges <0, %u>, <%u, %u>",
1556 received_seq_num, x,
1557 bs->auth.remote_seq_number + is_meticulous, max_u32);
1564 const u32 min = bs->auth.remote_seq_number + is_meticulous;
1566 bs->auth.remote_seq_number + 3 * bs->local_detect_mult;
1567 if (received_seq_num < min || received_seq_num > max)
1569 BFD_ERR ("Recvd sequence number=%u out of range <%u, %u>",
1570 received_seq_num, min, max);
1579 bfd_verify_pkt_auth_key_sha1 (const bfd_pkt_t * pkt, u32 pkt_size,
1580 bfd_session_t * bs, u8 bfd_key_id,
1581 bfd_auth_key_t * auth_key)
1583 ASSERT (auth_key->auth_type == BFD_AUTH_TYPE_keyed_sha1 ||
1584 auth_key->auth_type == BFD_AUTH_TYPE_meticulous_keyed_sha1);
1586 u8 result[SHA_DIGEST_LENGTH];
1587 bfd_pkt_with_common_auth_t *with_common = (void *) pkt;
1588 if (pkt_size < sizeof (*with_common))
1590 BFD_ERR ("Packet size too small to hold authentication common header");
1593 if (with_common->common_auth.type != auth_key->auth_type)
1595 BFD_ERR ("BFD auth type mismatch, packet auth=%d:%s doesn't match "
1596 "in-use auth=%d:%s",
1597 with_common->common_auth.type,
1598 bfd_auth_type_str (with_common->common_auth.type),
1599 auth_key->auth_type, bfd_auth_type_str (auth_key->auth_type));
1602 bfd_pkt_with_sha1_auth_t *with_sha1 = (void *) pkt;
1603 if (pkt_size < sizeof (*with_sha1) ||
1604 with_sha1->sha1_auth.type_len.len < sizeof (with_sha1->sha1_auth))
1607 ("BFD size mismatch, payload size=%u, expected=%u, auth_len=%u, "
1608 "expected=%u", pkt_size, sizeof (*with_sha1),
1609 with_sha1->sha1_auth.type_len.len, sizeof (with_sha1->sha1_auth));
1612 if (with_sha1->sha1_auth.key_id != bfd_key_id)
1615 ("BFD key ID mismatch, packet key ID=%u doesn't match key ID=%u%s",
1616 with_sha1->sha1_auth.key_id, bfd_key_id,
1618 auth.is_delayed ? " (but a delayed auth change is scheduled)" : "");
1622 if (!SHA1_Init (&ctx))
1624 BFD_ERR ("SHA1_Init failed");
1627 /* ignore last 20 bytes - use the actual key data instead pkt data */
1628 if (!SHA1_Update (&ctx, with_sha1,
1629 sizeof (*with_sha1) - sizeof (with_sha1->sha1_auth.hash)))
1631 BFD_ERR ("SHA1_Update failed");
1634 if (!SHA1_Update (&ctx, auth_key->key, sizeof (auth_key->key)))
1636 BFD_ERR ("SHA1_Update failed");
1639 if (!SHA1_Final (result, &ctx))
1641 BFD_ERR ("SHA1_Final failed");
1644 if (0 == memcmp (result, with_sha1->sha1_auth.hash, SHA_DIGEST_LENGTH))
1648 BFD_ERR ("SHA1 hash: %U doesn't match the expected value: %U",
1649 format_hex_bytes, with_sha1->sha1_auth.hash, SHA_DIGEST_LENGTH,
1650 format_hex_bytes, result, SHA_DIGEST_LENGTH);
1655 bfd_verify_pkt_auth_key (const bfd_pkt_t * pkt, u32 pkt_size,
1656 bfd_session_t * bs, u8 bfd_key_id,
1657 bfd_auth_key_t * auth_key)
1659 bfd_main_t *bm = &bfd_main;
1660 switch (auth_key->auth_type)
1662 case BFD_AUTH_TYPE_reserved:
1663 vlib_log_err (bm->log_class,
1664 "internal error, unexpected auth_type=%d:%s",
1665 auth_key->auth_type,
1666 bfd_auth_type_str (auth_key->auth_type));
1668 case BFD_AUTH_TYPE_simple_password:
1669 vlib_log_err (bm->log_class,
1670 "internal error, not implemented, unexpected auth_type=%d:%s",
1671 auth_key->auth_type,
1672 bfd_auth_type_str (auth_key->auth_type));
1674 case BFD_AUTH_TYPE_keyed_md5:
1676 case BFD_AUTH_TYPE_meticulous_keyed_md5:
1679 "internal error, not implemented, unexpected auth_type=%d:%s",
1680 auth_key->auth_type, bfd_auth_type_str (auth_key->auth_type));
1682 case BFD_AUTH_TYPE_keyed_sha1:
1684 case BFD_AUTH_TYPE_meticulous_keyed_sha1:
1688 const u32 seq_num = clib_net_to_host_u32 (((bfd_pkt_with_sha1_auth_t
1691 return bfd_verify_pkt_auth_seq_num (bs, seq_num,
1692 bfd_auth_type_is_meticulous
1693 (auth_key->auth_type))
1694 && bfd_verify_pkt_auth_key_sha1 (pkt, pkt_size, bs, bfd_key_id,
1701 "internal error, attempt to use SHA1 without SSL support");
1709 * @brief verify bfd packet - authentication
1713 * @return 1 if bfd packet is valid
1716 bfd_verify_pkt_auth (const bfd_pkt_t * pkt, u16 pkt_size, bfd_session_t * bs)
1718 if (bfd_pkt_get_auth_present (pkt))
1720 /* authentication present in packet */
1721 if (!bs->auth.curr_key)
1723 /* currently not using authentication - can we turn it on? */
1724 if (bs->auth.is_delayed && bs->auth.next_key)
1726 /* yes, switch is scheduled - make sure the auth is valid */
1727 if (bfd_verify_pkt_auth_key (pkt, pkt_size, bs,
1728 bs->auth.next_bfd_key_id,
1731 /* auth matches next key, do the switch, packet is valid */
1732 bfd_session_switch_auth_to_next (bs);
1739 /* yes, using authentication, verify the key */
1740 if (bfd_verify_pkt_auth_key (pkt, pkt_size, bs,
1741 bs->auth.curr_bfd_key_id,
1744 /* verification passed, packet is valid */
1749 /* verification failed - but maybe we need to switch key */
1750 if (bs->auth.is_delayed && bs->auth.next_key)
1752 /* delayed switch present, verify if that key works */
1753 if (bfd_verify_pkt_auth_key (pkt, pkt_size, bs,
1754 bs->auth.next_bfd_key_id,
1757 /* auth matches next key, switch key, packet is valid */
1758 bfd_session_switch_auth_to_next (bs);
1767 /* authentication in packet not present */
1768 if (pkt_size > sizeof (*pkt))
1770 BFD_ERR ("BFD verification failed - unexpected packet size '%d' "
1771 "(auth not present)", pkt_size);
1774 if (bs->auth.curr_key)
1776 /* currently authenticating - could we turn it off? */
1777 if (bs->auth.is_delayed && !bs->auth.next_key)
1779 /* yes, delayed switch to NULL key is scheduled */
1780 bfd_session_switch_auth_to_next (bs);
1786 /* no auth in packet, no auth in use - packet is valid */
1794 bfd_consume_pkt (bfd_main_t * bm, const bfd_pkt_t * pkt, u32 bs_idx)
1796 bfd_lock_check (bm);
1798 bfd_session_t *bs = bfd_find_session_by_idx (bm, bs_idx);
1799 if (!bs || (pkt->your_disc && pkt->your_disc != bs->local_discr))
1803 BFD_DBG ("Scanning bfd packet, bs_idx=%d", bs->bs_idx);
1804 bs->remote_discr = pkt->my_disc;
1805 bs->remote_state = bfd_pkt_get_state (pkt);
1806 bs->remote_demand = bfd_pkt_get_demand (pkt);
1807 bs->remote_diag = bfd_pkt_get_diag_code (pkt);
1808 u64 now = clib_cpu_time_now ();
1809 bs->last_rx_clocks = now;
1810 if (bfd_pkt_get_auth_present (pkt))
1812 bfd_auth_type_e auth_type =
1813 ((bfd_pkt_with_common_auth_t *) (pkt))->common_auth.type;
1816 case BFD_AUTH_TYPE_reserved:
1818 case BFD_AUTH_TYPE_simple_password:
1820 case BFD_AUTH_TYPE_keyed_md5:
1822 case BFD_AUTH_TYPE_meticulous_keyed_md5:
1823 vlib_log_crit (bm->log_class,
1824 "internal error, unexpected auth_type=%d:%s",
1825 auth_type, bfd_auth_type_str (auth_type));
1827 case BFD_AUTH_TYPE_keyed_sha1:
1829 case BFD_AUTH_TYPE_meticulous_keyed_sha1:
1832 bfd_pkt_with_sha1_auth_t *with_sha1 =
1833 (bfd_pkt_with_sha1_auth_t *) pkt;
1834 bs->auth.remote_seq_number =
1835 clib_net_to_host_u32 (with_sha1->sha1_auth.seq_num);
1836 bs->auth.remote_seq_number_known = 1;
1837 BFD_DBG ("Received sequence number %u",
1838 bs->auth.remote_seq_number);
1843 bs->remote_desired_min_tx_clocks =
1844 bfd_usec_to_clocks (bm, clib_net_to_host_u32 (pkt->des_min_tx));
1845 bs->remote_detect_mult = pkt->head.detect_mult;
1846 bfd_set_remote_required_min_rx (bm, bs, now,
1847 clib_net_to_host_u32 (pkt->req_min_rx));
1848 bfd_set_remote_required_min_echo_rx (bm, bs, now,
1849 clib_net_to_host_u32
1850 (pkt->req_min_echo_rx));
1851 if (bfd_pkt_get_final (pkt))
1853 if (BFD_POLL_IN_PROGRESS == bs->poll_state)
1855 BFD_DBG ("Poll sequence terminated, bs_idx=%u", bs->bs_idx);
1856 bfd_set_poll_state (bs, BFD_POLL_NOT_NEEDED);
1857 if (BFD_STATE_up == bs->local_state)
1859 bfd_set_effective_required_min_rx (bm, bs,
1860 clib_max (bs->echo *
1861 bm->min_required_min_rx_while_echo_clocks,
1862 bs->config_required_min_rx_clocks));
1865 else if (BFD_POLL_IN_PROGRESS_AND_QUEUED == bs->poll_state)
1868 * next poll sequence must be delayed by at least the round trip
1869 * time, so calculate that here
1871 BFD_DBG ("Next poll sequence can commence in " BFD_CLK_FMT,
1873 bs->poll_state_start_or_timeout_clocks));
1874 bs->poll_state_start_or_timeout_clocks =
1875 now + (now - bs->poll_state_start_or_timeout_clocks);
1877 ("Poll sequence terminated, but another is needed, bs_idx=%u",
1879 bfd_set_poll_state (bs, BFD_POLL_NEEDED);
1882 bfd_calc_next_tx (bm, bs, now);
1883 bfd_set_timer (bm, bs, now, 0);
1884 if (BFD_STATE_admin_down == bs->local_state)
1886 BFD_DBG ("Session is admin-down, ignoring packet, bs_idx=%u",
1890 if (BFD_STATE_admin_down == bs->remote_state)
1892 bfd_set_diag (bs, BFD_DIAG_CODE_neighbor_sig_down);
1893 bfd_set_state (bm, bs, BFD_STATE_down, 0);
1895 else if (BFD_STATE_down == bs->local_state)
1897 if (BFD_STATE_down == bs->remote_state)
1899 bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
1900 bfd_set_state (bm, bs, BFD_STATE_init, 0);
1902 else if (BFD_STATE_init == bs->remote_state)
1904 bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
1905 bfd_set_state (bm, bs, BFD_STATE_up, 0);
1908 else if (BFD_STATE_init == bs->local_state)
1910 if (BFD_STATE_up == bs->remote_state ||
1911 BFD_STATE_init == bs->remote_state)
1913 bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
1914 bfd_set_state (bm, bs, BFD_STATE_up, 0);
1917 else /* BFD_STATE_up == bs->local_state */
1919 if (BFD_STATE_down == bs->remote_state)
1921 bfd_set_diag (bs, BFD_DIAG_CODE_neighbor_sig_down);
1922 bfd_set_state (bm, bs, BFD_STATE_down, 0);
1928 bfd_consume_echo_pkt (bfd_main_t * bm, vlib_buffer_t * b)
1930 bfd_echo_pkt_t *pkt = NULL;
1931 if (b->current_length != sizeof (*pkt))
1935 pkt = vlib_buffer_get_current (b);
1936 bfd_session_t *bs = bfd_find_session_by_disc (bm, pkt->discriminator);
1941 BFD_DBG ("Scanning bfd echo packet, bs_idx=%d", bs->bs_idx);
1943 bfd_calc_echo_checksum (bs->local_discr, pkt->expire_time_clocks,
1945 if (checksum != pkt->checksum)
1947 BFD_DBG ("Invalid echo packet, checksum mismatch");
1950 u64 now = clib_cpu_time_now ();
1951 if (pkt->expire_time_clocks < now)
1953 BFD_DBG ("Stale packet received, expire time %lu < now %lu",
1954 pkt->expire_time_clocks, now);
1958 bs->echo_last_rx_clocks = now;
1964 format_bfd_session (u8 * s, va_list * args)
1966 const bfd_session_t *bs = va_arg (*args, bfd_session_t *);
1967 u32 indent = format_get_indent (s) + vlib_log_get_indent ();
1968 s = format (s, "bs_idx=%u local-state=%s remote-state=%s\n"
1969 "%Ulocal-discriminator=%u remote-discriminator=%u\n"
1970 "%Ulocal-diag=%s echo-active=%s\n"
1971 "%Udesired-min-tx=%u required-min-rx=%u\n"
1972 "%Urequired-min-echo-rx=%u detect-mult=%u\n"
1973 "%Uremote-min-rx=%u remote-min-echo-rx=%u\n"
1974 "%Uremote-demand=%s poll-state=%s\n"
1975 "%Uauth: local-seq-num=%u remote-seq-num=%u\n"
1976 "%U is-delayed=%s\n"
1979 bs->bs_idx, bfd_state_string (bs->local_state),
1980 bfd_state_string (bs->remote_state), format_white_space, indent,
1981 bs->local_discr, bs->remote_discr, format_white_space, indent,
1982 bfd_diag_code_string (bs->local_diag),
1983 (bs->echo ? "yes" : "no"), format_white_space, indent,
1984 bs->config_desired_min_tx_usec, bs->config_required_min_rx_usec,
1985 format_white_space, indent, 1, bs->local_detect_mult,
1986 format_white_space, indent, bs->remote_min_rx_usec,
1987 bs->remote_min_echo_rx_usec, format_white_space, indent,
1988 (bs->remote_demand ? "yes" : "no"),
1989 bfd_poll_state_string (bs->poll_state), format_white_space,
1990 indent, bs->auth.local_seq_number, bs->auth.remote_seq_number,
1991 format_white_space, indent,
1992 (bs->auth.is_delayed ? "yes" : "no"), format_white_space,
1993 indent, format_bfd_auth_key, bs->auth.curr_key,
1994 format_white_space, indent, format_bfd_auth_key,
2000 format_bfd_session_brief (u8 * s, va_list * args)
2002 const bfd_session_t *bs = va_arg (*args, bfd_session_t *);
2004 format (s, "bs_idx=%u local-state=%s remote-state=%s", bs->bs_idx,
2005 bfd_state_string (bs->local_state),
2006 bfd_state_string (bs->remote_state));
2011 bfd_auth_type_supported (bfd_auth_type_e auth_type)
2013 if (auth_type == BFD_AUTH_TYPE_keyed_sha1 ||
2014 auth_type == BFD_AUTH_TYPE_meticulous_keyed_sha1)
2022 bfd_auth_activate (bfd_session_t * bs, u32 conf_key_id,
2023 u8 bfd_key_id, u8 is_delayed)
2025 bfd_main_t *bm = &bfd_main;
2026 const uword *key_idx_p =
2027 hash_get (bm->auth_key_by_conf_key_id, conf_key_id);
2030 vlib_log_err (bm->log_class,
2031 "authentication key with config ID %u doesn't exist)",
2033 return VNET_API_ERROR_BFD_ENOENT;
2035 const uword key_idx = *key_idx_p;
2036 bfd_auth_key_t *key = pool_elt_at_index (bm->auth_keys, key_idx);
2039 if (bs->auth.next_key == key)
2041 /* already using this key, no changes required */
2044 bs->auth.next_key = key;
2045 bs->auth.next_bfd_key_id = bfd_key_id;
2046 bs->auth.is_delayed = 1;
2050 if (bs->auth.curr_key == key)
2052 /* already using this key, no changes required */
2055 if (bs->auth.curr_key)
2057 --bs->auth.curr_key->use_count;
2059 bs->auth.curr_key = key;
2060 bs->auth.curr_bfd_key_id = bfd_key_id;
2061 bs->auth.is_delayed = 0;
2064 BFD_DBG ("\nSession auth modified: %U", format_bfd_session, bs);
2065 vlib_log_info (bm->log_class, "session auth modified: %U",
2066 format_bfd_session_brief, bs);
2071 bfd_auth_deactivate (bfd_session_t * bs, u8 is_delayed)
2073 bfd_main_t *bm = &bfd_main;
2077 /* not delayed - deactivate the current key right now */
2078 if (bs->auth.curr_key)
2080 --bs->auth.curr_key->use_count;
2081 bs->auth.curr_key = NULL;
2083 bs->auth.is_delayed = 0;
2087 /* delayed - mark as so */
2088 bs->auth.is_delayed = 1;
2091 * clear the next key unconditionally - either the auth change is not delayed
2092 * in which case the caller expects the session to not use authentication
2093 * from this point forward, or it is delayed, in which case the next_key
2094 * needs to be set to NULL to make it so in the future
2096 if (bs->auth.next_key)
2098 --bs->auth.next_key->use_count;
2099 bs->auth.next_key = NULL;
2101 BFD_DBG ("\nSession auth modified: %U", format_bfd_session, bs);
2102 vlib_log_info (bm->log_class, "session auth modified: %U",
2103 format_bfd_session_brief, bs);
2106 vlib_log_err (bm->log_class,
2107 "SSL missing, cannot deactivate BFD authentication");
2108 return VNET_API_ERROR_BFD_NOTSUPP;
2113 bfd_session_set_params (bfd_main_t * bm, bfd_session_t * bs,
2114 u32 desired_min_tx_usec,
2115 u32 required_min_rx_usec, u8 detect_mult)
2117 if (bs->local_detect_mult != detect_mult ||
2118 bs->config_desired_min_tx_usec != desired_min_tx_usec ||
2119 bs->config_required_min_rx_usec != required_min_rx_usec)
2121 BFD_DBG ("\nChanging session params: %U", format_bfd_session, bs);
2122 switch (bs->poll_state)
2124 case BFD_POLL_NOT_NEEDED:
2125 if (BFD_STATE_up == bs->local_state ||
2126 BFD_STATE_init == bs->local_state)
2128 /* poll sequence is not needed for detect multiplier change */
2129 if (bs->config_desired_min_tx_usec != desired_min_tx_usec ||
2130 bs->config_required_min_rx_usec != required_min_rx_usec)
2132 bfd_set_poll_state (bs, BFD_POLL_NEEDED);
2136 case BFD_POLL_NEEDED:
2137 case BFD_POLL_IN_PROGRESS_AND_QUEUED:
2139 * nothing to do - will be handled in the future poll which is
2140 * already scheduled for execution
2143 case BFD_POLL_IN_PROGRESS:
2144 /* poll sequence is not needed for detect multiplier change */
2145 if (bs->config_desired_min_tx_usec != desired_min_tx_usec ||
2146 bs->config_required_min_rx_usec != required_min_rx_usec)
2148 BFD_DBG ("Poll in progress, queueing extra poll, bs_idx=%u",
2150 bfd_set_poll_state (bs, BFD_POLL_IN_PROGRESS_AND_QUEUED);
2154 bs->local_detect_mult = detect_mult;
2155 bs->config_desired_min_tx_usec = desired_min_tx_usec;
2156 bs->config_desired_min_tx_clocks =
2157 bfd_usec_to_clocks (bm, desired_min_tx_usec);
2158 bs->config_required_min_rx_usec = required_min_rx_usec;
2159 bs->config_required_min_rx_clocks =
2160 bfd_usec_to_clocks (bm, required_min_rx_usec);
2161 BFD_DBG ("\nChanged session params: %U", format_bfd_session, bs);
2163 vlib_log_info (bm->log_class, "changed session params: %U",
2164 format_bfd_session_brief, bs);
2165 vlib_process_signal_event (bm->vlib_main, bm->bfd_process_node_index,
2166 BFD_EVENT_CONFIG_CHANGED, bs->bs_idx);
2170 BFD_DBG ("Ignore parameter change - no change, bs_idx=%u", bs->bs_idx);
2176 bfd_auth_set_key (u32 conf_key_id, u8 auth_type, u8 key_len,
2177 const u8 * key_data)
2179 bfd_main_t *bm = &bfd_main;
2181 bfd_auth_key_t *auth_key = NULL;
2182 if (!key_len || key_len > bfd_max_key_len_for_auth_type (auth_type))
2184 vlib_log_err (bm->log_class,
2185 "invalid authentication key length for auth_type=%d:%s "
2186 "(key_len=%u, must be non-zero, expected max=%u)",
2187 auth_type, bfd_auth_type_str (auth_type), key_len,
2188 (u32) bfd_max_key_len_for_auth_type (auth_type));
2189 return VNET_API_ERROR_INVALID_VALUE;
2191 if (!bfd_auth_type_supported (auth_type))
2193 vlib_log_err (bm->log_class, "unsupported auth type=%d:%s", auth_type,
2194 bfd_auth_type_str (auth_type));
2195 return VNET_API_ERROR_BFD_NOTSUPP;
2197 uword *key_idx_p = hash_get (bm->auth_key_by_conf_key_id, conf_key_id);
2200 /* modifying existing key - must not be used */
2201 const uword key_idx = *key_idx_p;
2202 auth_key = pool_elt_at_index (bm->auth_keys, key_idx);
2203 if (auth_key->use_count > 0)
2205 vlib_log_err (bm->log_class,
2206 "authentication key with conf ID %u in use by %u BFD "
2207 "session(s) - cannot modify", conf_key_id,
2208 auth_key->use_count);
2209 return VNET_API_ERROR_BFD_EINUSE;
2214 /* adding new key */
2215 pool_get (bm->auth_keys, auth_key);
2216 auth_key->conf_key_id = conf_key_id;
2217 hash_set (bm->auth_key_by_conf_key_id, conf_key_id,
2218 auth_key - bm->auth_keys);
2220 auth_key->auth_type = auth_type;
2221 clib_memset (auth_key->key, 0, sizeof (auth_key->key));
2222 clib_memcpy (auth_key->key, key_data, key_len);
2225 vlib_log_err (bm->log_class,
2226 "SSL missing, cannot manipulate authentication keys");
2227 return VNET_API_ERROR_BFD_NOTSUPP;
2232 bfd_auth_del_key (u32 conf_key_id)
2235 bfd_auth_key_t *auth_key = NULL;
2236 bfd_main_t *bm = &bfd_main;
2237 uword *key_idx_p = hash_get (bm->auth_key_by_conf_key_id, conf_key_id);
2240 /* deleting existing key - must not be used */
2241 const uword key_idx = *key_idx_p;
2242 auth_key = pool_elt_at_index (bm->auth_keys, key_idx);
2243 if (auth_key->use_count > 0)
2245 vlib_log_err (bm->log_class,
2246 "authentication key with conf ID %u in use by %u BFD "
2247 "session(s) - cannot delete", conf_key_id,
2248 auth_key->use_count);
2249 return VNET_API_ERROR_BFD_EINUSE;
2251 hash_unset (bm->auth_key_by_conf_key_id, conf_key_id);
2252 clib_memset (auth_key, 0, sizeof (*auth_key));
2253 pool_put (bm->auth_keys, auth_key);
2258 vlib_log_err (bm->log_class,
2259 "authentication key with conf ID %u does not exist",
2261 return VNET_API_ERROR_BFD_ENOENT;
2265 vlib_log_err (bm->log_class,
2266 "SSL missing, cannot manipulate authentication keys");
2267 return VNET_API_ERROR_BFD_NOTSUPP;
2271 bfd_main_t bfd_main;
2274 * fd.io coding-style-patch-verification: ON
2277 * eval: (c-set-style "gnu")