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
20 #include <vlibmemory/api.h>
21 #include <vppinfra/random.h>
22 #include <vppinfra/error.h>
23 #include <vppinfra/hash.h>
24 #include <vppinfra/xxhash.h>
25 #include <vnet/ethernet/ethernet.h>
26 #include <vnet/ethernet/packet.h>
27 #include <vnet/bfd/bfd_debug.h>
28 #include <vnet/bfd/bfd_protocol.h>
29 #include <vnet/bfd/bfd_main.h>
31 #include <vnet/crypto/crypto.h>
34 bfd_calc_echo_checksum (u32 discriminator, u64 expire_time, u32 secret)
37 #if defined(clib_crc32c_uses_intrinsics) && !defined (__i386__)
38 checksum = clib_crc32c_u64 (0, discriminator);
39 checksum = clib_crc32c_u64 (checksum, expire_time);
40 checksum = clib_crc32c_u64 (checksum, secret);
42 checksum = clib_xxhash (discriminator ^ expire_time ^ secret);
48 bfd_usec_to_nsec (u64 us)
50 return us * NSEC_PER_USEC;
54 bfd_nsec_to_usec (u64 nsec)
56 return nsec / NSEC_PER_USEC;
60 bfd_time_now_nsec (vlib_main_t * vm, f64 * vm_time)
62 f64 _vm_time = vlib_time_now (vm);
65 return _vm_time * NSEC_PER_SEC;
68 static vlib_node_registration_t bfd_process_node;
71 format_bfd_auth_key (u8 * s, va_list * args)
73 const bfd_auth_key_t *key = va_arg (*args, bfd_auth_key_t *);
76 s = format (s, "{auth-type=%u:%s, conf-key-id=%u, use-count=%u}, ",
77 key->auth_type, bfd_auth_type_str (key->auth_type),
78 key->conf_key_id, key->use_count);
82 s = format (s, "{none}");
88 * We actually send all bfd pkts to the "error" node after scanning
89 * them, so the graph node has only one next-index. The "error-drop"
90 * node automatically bumps our per-node packet counters for us.
94 BFD_INPUT_NEXT_NORMAL,
98 static void bfd_on_state_change (bfd_main_t * bm, bfd_session_t * bs, u64 now,
102 bfd_set_defaults (bfd_main_t * bm, bfd_session_t * bs)
104 bs->local_state = BFD_STATE_down;
105 bs->local_diag = BFD_DIAG_CODE_no_diag;
106 bs->remote_state = BFD_STATE_down;
107 bs->remote_discr = 0;
108 bs->hop_type = BFD_HOP_TYPE_SINGLE;
109 bs->config_desired_min_tx_usec = BFD_DEFAULT_DESIRED_MIN_TX_USEC;
110 bs->config_desired_min_tx_nsec = bm->default_desired_min_tx_nsec;
111 bs->effective_desired_min_tx_nsec = bm->default_desired_min_tx_nsec;
112 bs->remote_min_rx_usec = 1;
113 bs->remote_min_rx_nsec = bfd_usec_to_nsec (bs->remote_min_rx_usec);
114 bs->remote_min_echo_rx_usec = 0;
115 bs->remote_min_echo_rx_nsec = 0;
116 bs->remote_demand = 0;
117 bs->auth.remote_seq_number = 0;
118 bs->auth.remote_seq_number_known = 0;
119 bs->auth.local_seq_number = random_u32 (&bm->random_seed);
120 bs->echo_secret = random_u32 (&bm->random_seed);
124 bfd_set_diag (bfd_session_t * bs, bfd_diag_code_e code)
126 if (bs->local_diag != code)
128 BFD_DBG ("set local_diag, bs_idx=%d: '%d:%s'", bs->bs_idx, code,
129 bfd_diag_code_string (code));
130 bs->local_diag = code;
135 bfd_set_state (vlib_main_t * vm, bfd_main_t * bm, bfd_session_t * bs,
136 bfd_state_e new_state, int handling_wakeup)
138 if (bs->local_state != new_state)
140 BFD_DBG ("Change state, bs_idx=%d: %s->%s", bs->bs_idx,
141 bfd_state_string (bs->local_state),
142 bfd_state_string (new_state));
143 bs->local_state = new_state;
144 bfd_on_state_change (bm, bs, bfd_time_now_nsec (vm, NULL),
150 bfd_poll_state_string (bfd_poll_state_e state)
156 return "BFD_POLL_" #x;
157 foreach_bfd_poll_state (F)
164 bfd_set_poll_state (bfd_session_t * bs, bfd_poll_state_e state)
166 if (bs->poll_state != state)
168 BFD_DBG ("Setting poll state=%s, bs_idx=%u",
169 bfd_poll_state_string (state), bs->bs_idx);
170 bs->poll_state = state;
175 bfd_recalc_tx_interval (bfd_main_t * bm, bfd_session_t * bs)
177 bs->transmit_interval_nsec =
178 clib_max (bs->effective_desired_min_tx_nsec, bs->remote_min_rx_nsec);
179 BFD_DBG ("Recalculated transmit interval " BFD_CLK_FMT,
180 BFD_CLK_PRN (bs->transmit_interval_nsec));
184 bfd_recalc_echo_tx_interval (bfd_main_t * bm, bfd_session_t * bs)
186 bs->echo_transmit_interval_nsec =
187 clib_max (bs->effective_desired_min_tx_nsec, bs->remote_min_echo_rx_nsec);
188 BFD_DBG ("Recalculated echo transmit interval " BFD_CLK_FMT,
189 BFD_CLK_PRN (bs->echo_transmit_interval_nsec));
193 bfd_calc_next_tx (bfd_main_t * bm, bfd_session_t * bs, u64 now)
195 if (bs->local_detect_mult > 1)
197 /* common case - 75-100% of transmit interval */
198 bs->tx_timeout_nsec = bs->last_tx_nsec +
199 (1 - .25 * (random_f64 (&bm->random_seed))) *
200 bs->transmit_interval_nsec;
201 if (bs->tx_timeout_nsec < now)
204 * the timeout is in the past, which means that either remote
205 * demand mode was set or performance/clock issues ...
207 BFD_DBG ("Missed %lu transmit events (now is %lu, calc "
208 "tx_timeout is %lu)",
209 (now - bs->tx_timeout_nsec) /
210 bs->transmit_interval_nsec, now, bs->tx_timeout_nsec);
211 bs->tx_timeout_nsec = now;
216 /* special case - 75-90% of transmit interval */
217 bs->tx_timeout_nsec = bs->last_tx_nsec +
218 (.9 - .15 * (random_f64 (&bm->random_seed))) *
219 bs->transmit_interval_nsec;
220 if (bs->tx_timeout_nsec < now)
223 * the timeout is in the past, which means that either remote
224 * demand mode was set or performance/clock issues ...
226 BFD_DBG ("Missed %lu transmit events (now is %lu, calc "
227 "tx_timeout is %lu)",
228 (now - bs->tx_timeout_nsec) /
229 bs->transmit_interval_nsec, now, bs->tx_timeout_nsec);
230 bs->tx_timeout_nsec = now;
233 if (bs->tx_timeout_nsec)
235 BFD_DBG ("Next transmit in %lu nsec/%.02fs@%lu",
236 bs->tx_timeout_nsec - now,
237 (bs->tx_timeout_nsec - now) * SEC_PER_NSEC,
238 bs->tx_timeout_nsec);
243 bfd_calc_next_echo_tx (bfd_main_t * bm, bfd_session_t * bs, u64 now)
245 bs->echo_tx_timeout_nsec =
246 bs->echo_last_tx_nsec + bs->echo_transmit_interval_nsec;
247 if (bs->echo_tx_timeout_nsec < now)
249 /* huh, we've missed it already, transmit now */
250 BFD_DBG ("Missed %lu echo transmit events (now is %lu, calc tx_timeout "
252 (now - bs->echo_tx_timeout_nsec) /
253 bs->echo_transmit_interval_nsec,
254 now, bs->echo_tx_timeout_nsec);
255 bs->echo_tx_timeout_nsec = now;
257 BFD_DBG ("Next echo transmit in %lu nsec/%.02fs@%lu",
258 bs->echo_tx_timeout_nsec - now,
259 (bs->echo_tx_timeout_nsec - now) * SEC_PER_NSEC,
260 bs->echo_tx_timeout_nsec);
264 bfd_recalc_detection_time (bfd_main_t * bm, bfd_session_t * bs)
266 if (bs->local_state == BFD_STATE_init || bs->local_state == BFD_STATE_up)
268 bs->detection_time_nsec =
269 bs->remote_detect_mult *
270 clib_max (bs->effective_required_min_rx_nsec,
271 bs->remote_desired_min_tx_nsec);
272 BFD_DBG ("Recalculated detection time %lu nsec/%.3fs",
273 bs->detection_time_nsec,
274 bs->detection_time_nsec * SEC_PER_NSEC);
279 bfd_set_timer (bfd_main_t * bm, bfd_session_t * bs, u64 now,
285 if (BFD_STATE_up == bs->local_state)
287 rx_timeout = bs->last_rx_nsec + bs->detection_time_nsec;
289 if (BFD_STATE_up != bs->local_state ||
290 (!bs->remote_demand && bs->remote_min_rx_usec) ||
291 BFD_POLL_NOT_NEEDED != bs->poll_state)
293 tx_timeout = bs->tx_timeout_nsec;
295 if (tx_timeout && rx_timeout)
297 next = clib_min (tx_timeout, rx_timeout);
307 if (bs->echo && next > bs->echo_tx_timeout_nsec)
309 next = bs->echo_tx_timeout_nsec;
311 BFD_DBG ("bs_idx=%u, tx_timeout=%lu, echo_tx_timeout=%lu, rx_timeout=%lu, "
313 bs->bs_idx, tx_timeout, bs->echo_tx_timeout_nsec, rx_timeout,
315 ? "tx" : (next == bs->echo_tx_timeout_nsec ? "echo tx" : "rx"));
319 bs->event_time_nsec = next;
320 /* add extra tick if it's not even */
321 u32 wheel_time_ticks =
322 (bs->event_time_nsec - now) / bm->nsec_per_tw_tick +
323 ((bs->event_time_nsec - now) % bm->nsec_per_tw_tick != 0);
324 BFD_DBG ("event_time_nsec %lu (%lu nsec/%.3fs in future) -> "
325 "wheel_time_ticks %u", bs->event_time_nsec,
326 bs->event_time_nsec - now,
327 (bs->event_time_nsec - now) * SEC_PER_NSEC, wheel_time_ticks);
328 wheel_time_ticks = wheel_time_ticks ? wheel_time_ticks : 1;
332 TW (tw_timer_update) (&bm->wheel, bs->tw_id, wheel_time_ticks);
333 BFD_DBG ("tw_timer_update(%p, %u, %lu);", &bm->wheel, bs->tw_id,
339 TW (tw_timer_start) (&bm->wheel, bs->bs_idx, 0, wheel_time_ticks);
340 BFD_DBG ("tw_timer_start(%p, %u, 0, %lu) == %u;", &bm->wheel,
341 bs->bs_idx, wheel_time_ticks);
344 if (!handling_wakeup)
347 /* Send only if it is earlier than current awaited wakeup time */
349 (bs->event_time_nsec < bm->bfd_process_next_wakeup_nsec) &&
351 * If the wake-up time is within 2x the delay of the event propagation delay,
352 * avoid the expense of sending the event. The 2x multiplier is to workaround the race whereby
353 * simultaneous event + expired timer create one recurring bogus wakeup/suspend instance,
354 * due to double scheduling of the node on the pending list.
356 (bm->bfd_process_next_wakeup_nsec - bs->event_time_nsec >
357 2 * bm->bfd_process_wakeup_event_delay_nsec) &&
358 /* Must be no events in flight to send an event */
359 (!bm->bfd_process_wakeup_events_in_flight);
361 /* If we do send the signal, note this down along with the start timestamp */
364 bm->bfd_process_wakeup_events_in_flight++;
365 bm->bfd_process_wakeup_event_start_nsec = now;
370 /* Use the multithreaded event sending so the workers can send events too */
373 vlib_process_signal_event_mt (bm->vlib_main,
374 bm->bfd_process_node_index,
375 BFD_EVENT_RESCHEDULE, ~0);
381 bfd_set_effective_desired_min_tx (bfd_main_t * bm,
382 bfd_session_t * bs, u64 now,
383 u64 desired_min_tx_nsec)
385 bs->effective_desired_min_tx_nsec = desired_min_tx_nsec;
386 BFD_DBG ("Set effective desired min tx to " BFD_CLK_FMT,
387 BFD_CLK_PRN (bs->effective_desired_min_tx_nsec));
388 bfd_recalc_detection_time (bm, bs);
389 bfd_recalc_tx_interval (bm, bs);
390 bfd_recalc_echo_tx_interval (bm, bs);
391 bfd_calc_next_tx (bm, bs, now);
395 bfd_set_effective_required_min_rx (bfd_main_t * bm,
397 u64 required_min_rx_nsec)
399 bs->effective_required_min_rx_nsec = required_min_rx_nsec;
400 BFD_DBG ("Set effective required min rx to " BFD_CLK_FMT,
401 BFD_CLK_PRN (bs->effective_required_min_rx_nsec));
402 bfd_recalc_detection_time (bm, bs);
406 bfd_set_remote_required_min_rx (bfd_main_t * bm, bfd_session_t * bs,
407 u64 now, u32 remote_required_min_rx_usec)
409 if (bs->remote_min_rx_usec != remote_required_min_rx_usec)
411 bs->remote_min_rx_usec = remote_required_min_rx_usec;
412 bs->remote_min_rx_nsec = bfd_usec_to_nsec (remote_required_min_rx_usec);
413 BFD_DBG ("Set remote min rx to " BFD_CLK_FMT,
414 BFD_CLK_PRN (bs->remote_min_rx_nsec));
415 bfd_recalc_detection_time (bm, bs);
416 bfd_recalc_tx_interval (bm, bs);
421 bfd_set_remote_required_min_echo_rx (bfd_main_t * bm, bfd_session_t * bs,
423 u32 remote_required_min_echo_rx_usec)
425 if (bs->remote_min_echo_rx_usec != remote_required_min_echo_rx_usec)
427 bs->remote_min_echo_rx_usec = remote_required_min_echo_rx_usec;
428 bs->remote_min_echo_rx_nsec =
429 bfd_usec_to_nsec (bs->remote_min_echo_rx_usec);
430 BFD_DBG ("Set remote min echo rx to " BFD_CLK_FMT,
431 BFD_CLK_PRN (bs->remote_min_echo_rx_nsec));
432 bfd_recalc_echo_tx_interval (bm, bs);
437 bfd_notify_listeners (bfd_main_t * bm,
438 bfd_listen_event_e event, const bfd_session_t * bs)
441 vec_foreach (fn, bm->listeners)
448 bfd_session_start (bfd_main_t * bm, bfd_session_t * bs)
450 BFD_DBG ("\nStarting session: %U", format_bfd_session, bs);
451 vlib_log_info (bm->log_class, "start BFD session: %U",
452 format_bfd_session_brief, bs);
453 bfd_set_effective_required_min_rx (bm, bs, bs->config_required_min_rx_nsec);
454 bfd_recalc_tx_interval (bm, bs);
455 vlib_process_signal_event (bm->vlib_main, bm->bfd_process_node_index,
456 BFD_EVENT_NEW_SESSION, bs->bs_idx);
457 bfd_notify_listeners (bm, BFD_LISTEN_EVENT_CREATE, bs);
461 bfd_session_set_flags (vlib_main_t * vm, bfd_session_t * bs, u8 admin_up_down)
463 bfd_main_t *bm = &bfd_main;
464 u64 now = bfd_time_now_nsec (vm, NULL);
467 BFD_DBG ("Session set admin-up, bs-idx=%u", bs->bs_idx);
468 vlib_log_info (bm->log_class, "set session admin-up: %U",
469 format_bfd_session_brief, bs);
470 bfd_set_state (vm, bm, bs, BFD_STATE_down, 0);
471 bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
472 bfd_calc_next_tx (bm, bs, now);
473 bfd_set_timer (bm, bs, now, 0);
477 BFD_DBG ("Session set admin-down, bs-idx=%u", bs->bs_idx);
478 vlib_log_info (bm->log_class, "set session admin-down: %U",
479 format_bfd_session_brief, bs);
480 bfd_set_diag (bs, BFD_DIAG_CODE_admin_down);
481 bfd_set_state (vm, bm, bs, BFD_STATE_admin_down, 0);
482 bfd_calc_next_tx (bm, bs, now);
483 bfd_set_timer (bm, bs, now, 0);
488 bfd_input_format_trace (u8 * s, va_list * args)
490 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
491 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
492 const bfd_input_trace_t *t = va_arg (*args, bfd_input_trace_t *);
493 const bfd_pkt_t *pkt = (bfd_pkt_t *) t->data;
494 if (t->len > STRUCT_SIZE_OF (bfd_pkt_t, head))
496 s = format (s, "BFD v%u, diag=%u(%s), state=%u(%s),\n"
497 " flags=(P:%u, F:%u, C:%u, A:%u, D:%u, M:%u), "
498 "detect_mult=%u, length=%u\n",
499 bfd_pkt_get_version (pkt), bfd_pkt_get_diag_code (pkt),
500 bfd_diag_code_string (bfd_pkt_get_diag_code (pkt)),
501 bfd_pkt_get_state (pkt),
502 bfd_state_string (bfd_pkt_get_state (pkt)),
503 bfd_pkt_get_poll (pkt), bfd_pkt_get_final (pkt),
504 bfd_pkt_get_control_plane_independent (pkt),
505 bfd_pkt_get_auth_present (pkt), bfd_pkt_get_demand (pkt),
506 bfd_pkt_get_multipoint (pkt), pkt->head.detect_mult,
508 if (t->len >= sizeof (bfd_pkt_t) &&
509 pkt->head.length >= sizeof (bfd_pkt_t))
511 s = format (s, " my discriminator: %u\n",
512 clib_net_to_host_u32 (pkt->my_disc));
513 s = format (s, " your discriminator: %u\n",
514 clib_net_to_host_u32 (pkt->your_disc));
515 s = format (s, " desired min tx interval: %u\n",
516 clib_net_to_host_u32 (pkt->des_min_tx));
517 s = format (s, " required min rx interval: %u\n",
518 clib_net_to_host_u32 (pkt->req_min_rx));
519 s = format (s, " required min echo rx interval: %u",
520 clib_net_to_host_u32 (pkt->req_min_echo_rx));
522 if (t->len >= sizeof (bfd_pkt_with_common_auth_t) &&
523 pkt->head.length >= sizeof (bfd_pkt_with_common_auth_t) &&
524 bfd_pkt_get_auth_present (pkt))
526 const bfd_pkt_with_common_auth_t *with_auth = (void *) pkt;
527 const bfd_auth_common_t *common = &with_auth->common_auth;
528 s = format (s, "\n auth len: %u\n", common->len);
529 s = format (s, " auth type: %u:%s\n", common->type,
530 bfd_auth_type_str (common->type));
531 if (t->len >= sizeof (bfd_pkt_with_sha1_auth_t) &&
532 pkt->head.length >= sizeof (bfd_pkt_with_sha1_auth_t) &&
533 (BFD_AUTH_TYPE_keyed_sha1 == common->type ||
534 BFD_AUTH_TYPE_meticulous_keyed_sha1 == common->type))
536 const bfd_pkt_with_sha1_auth_t *with_sha1 = (void *) pkt;
537 const bfd_auth_sha1_t *sha1 = &with_sha1->sha1_auth;
538 s = format (s, " seq num: %u\n",
539 clib_net_to_host_u32 (sha1->seq_num));
540 s = format (s, " key id: %u\n", sha1->key_id);
541 s = format (s, " hash: %U", format_hex_bytes, sha1->hash,
542 sizeof (sha1->hash));
547 s = format (s, "\n");
560 bfd_rpc_event_cb (const bfd_rpc_event_t * a)
562 bfd_main_t *bm = &bfd_main;
563 u32 bs_idx = a->bs_idx;
565 bfd_session_t session_data;
568 if (!pool_is_free_index (bm->sessions, bs_idx))
570 bfd_session_t *bs = pool_elt_at_index (bm->sessions, bs_idx);
571 clib_memcpy (&session_data, bs, sizeof (bfd_session_t));
576 BFD_DBG ("Ignoring event RPC for non-existent session index %u",
582 bfd_event (bm, &session_data);
586 bfd_event_rpc (u32 bs_idx)
588 const u32 data_size = sizeof (bfd_rpc_event_t);
590 bfd_rpc_event_t *event = (bfd_rpc_event_t *) data;
592 event->bs_idx = bs_idx;
593 vl_api_rpc_call_main_thread (bfd_rpc_event_cb, data, data_size);
599 } bfd_rpc_notify_listeners_t;
602 bfd_rpc_notify_listeners_cb (const bfd_rpc_notify_listeners_t * a)
604 bfd_main_t *bm = &bfd_main;
605 u32 bs_idx = a->bs_idx;
607 if (!pool_is_free_index (bm->sessions, bs_idx))
609 bfd_session_t *bs = pool_elt_at_index (bm->sessions, bs_idx);
610 bfd_notify_listeners (bm, BFD_LISTEN_EVENT_UPDATE, bs);
614 BFD_DBG ("Ignoring notify RPC for non-existent session index %u",
621 bfd_notify_listeners_rpc (u32 bs_idx)
623 const u32 data_size = sizeof (bfd_rpc_notify_listeners_t);
625 bfd_rpc_notify_listeners_t *notify = (bfd_rpc_notify_listeners_t *) data;
626 notify->bs_idx = bs_idx;
627 vl_api_rpc_call_main_thread (bfd_rpc_notify_listeners_cb, data, data_size);
631 bfd_on_state_change (bfd_main_t * bm, bfd_session_t * bs, u64 now,
634 BFD_DBG ("\nState changed: %U", format_bfd_session, bs);
636 if (vlib_get_thread_index () == 0)
642 /* without RPC - a REGRESSION: BFD event are not propagated */
643 bfd_event_rpc (bs->bs_idx);
646 switch (bs->local_state)
648 case BFD_STATE_admin_down:
650 bfd_set_effective_desired_min_tx (bm, bs, now,
652 (bs->config_desired_min_tx_nsec,
653 bm->default_desired_min_tx_nsec));
654 bfd_set_effective_required_min_rx (bm, bs,
655 bs->config_required_min_rx_nsec);
656 bfd_set_timer (bm, bs, now, handling_wakeup);
660 bfd_set_effective_desired_min_tx (bm, bs, now,
662 (bs->config_desired_min_tx_nsec,
663 bm->default_desired_min_tx_nsec));
664 bfd_set_effective_required_min_rx (bm, bs,
665 bs->config_required_min_rx_nsec);
666 bfd_set_timer (bm, bs, now, handling_wakeup);
670 bfd_set_effective_desired_min_tx (bm, bs, now,
671 bs->config_desired_min_tx_nsec);
672 bfd_set_timer (bm, bs, now, handling_wakeup);
675 bfd_set_effective_desired_min_tx (bm, bs, now,
676 bs->config_desired_min_tx_nsec);
677 if (BFD_POLL_NOT_NEEDED == bs->poll_state)
679 bfd_set_effective_required_min_rx (bm, bs,
680 bs->config_required_min_rx_nsec);
682 bfd_set_timer (bm, bs, now, handling_wakeup);
685 if (vlib_get_thread_index () == 0)
687 bfd_notify_listeners (bm, BFD_LISTEN_EVENT_UPDATE, bs);
691 /* without RPC - a REGRESSION: state changes are not propagated */
692 bfd_notify_listeners_rpc (bs->bs_idx);
697 bfd_on_config_change (vlib_main_t * vm, vlib_node_runtime_t * rt,
698 bfd_main_t * bm, bfd_session_t * bs, u64 now)
701 * if remote demand mode is set and we need to do a poll, set the next
702 * timeout so that the session wakes up immediately
704 if (bs->remote_demand && BFD_POLL_NEEDED == bs->poll_state &&
705 bs->poll_state_start_or_timeout_nsec < now)
707 bs->tx_timeout_nsec = now;
709 bfd_recalc_detection_time (bm, bs);
710 bfd_set_timer (bm, bs, now, 0);
714 bfd_add_transport_layer (vlib_main_t * vm, u32 bi, bfd_session_t * bs)
716 switch (bs->transport)
718 case BFD_TRANSPORT_UDP4:
719 BFD_DBG ("Transport bfd via udp4, bs_idx=%u", bs->bs_idx);
720 bfd_add_udp4_transport (vm, bi, bs, 0 /* is_echo */ );
722 case BFD_TRANSPORT_UDP6:
723 BFD_DBG ("Transport bfd via udp6, bs_idx=%u", bs->bs_idx);
724 bfd_add_udp6_transport (vm, bi, bs, 0 /* is_echo */ );
730 bfd_transport_control_frame (vlib_main_t * vm, u32 bi, bfd_session_t * bs)
732 switch (bs->transport)
734 case BFD_TRANSPORT_UDP4:
735 BFD_DBG ("Transport bfd via udp4, bs_idx=%u", bs->bs_idx);
736 return bfd_transport_udp4 (vm, bi, bs);
738 case BFD_TRANSPORT_UDP6:
739 BFD_DBG ("Transport bfd via udp6, bs_idx=%u", bs->bs_idx);
740 return bfd_transport_udp6 (vm, bi, bs);
747 bfd_echo_add_transport_layer (vlib_main_t * vm, u32 bi, bfd_session_t * bs)
749 switch (bs->transport)
751 case BFD_TRANSPORT_UDP4:
752 BFD_DBG ("Transport bfd echo via udp4, bs_idx=%u", bs->bs_idx);
753 return bfd_add_udp4_transport (vm, bi, bs, 1 /* is_echo */ );
755 case BFD_TRANSPORT_UDP6:
756 BFD_DBG ("Transport bfd echo via udp6, bs_idx=%u", bs->bs_idx);
757 return bfd_add_udp6_transport (vm, bi, bs, 1 /* is_echo */ );
764 bfd_transport_echo (vlib_main_t * vm, u32 bi, bfd_session_t * bs)
766 switch (bs->transport)
768 case BFD_TRANSPORT_UDP4:
769 BFD_DBG ("Transport bfd echo via udp4, bs_idx=%u", bs->bs_idx);
770 return bfd_transport_udp4 (vm, bi, bs);
772 case BFD_TRANSPORT_UDP6:
773 BFD_DBG ("Transport bfd echo via udp6, bs_idx=%u", bs->bs_idx);
774 return bfd_transport_udp6 (vm, bi, bs);
781 bfd_add_sha1_auth_section (vlib_main_t *vm, vlib_buffer_t *b,
784 bfd_pkt_with_sha1_auth_t *pkt = vlib_buffer_get_current (b);
785 bfd_auth_sha1_t *auth = &pkt->sha1_auth;
786 b->current_length += sizeof (*auth);
787 pkt->pkt.head.length += sizeof (*auth);
788 bfd_pkt_set_auth_present (&pkt->pkt);
789 clib_memset (auth, 0, sizeof (*auth));
790 auth->type_len.type = bs->auth.curr_key->auth_type;
792 * only meticulous authentication types require incrementing seq number
793 * for every message, but doing so doesn't violate the RFC
795 ++bs->auth.local_seq_number;
796 auth->type_len.len = sizeof (bfd_auth_sha1_t);
797 auth->key_id = bs->auth.curr_bfd_key_id;
798 auth->seq_num = clib_host_to_net_u32 (bs->auth.local_seq_number);
800 * first copy the password into the packet, then calculate the hash
801 * and finally replace the password with the calculated hash
803 clib_memcpy (auth->hash, bs->auth.curr_key->key,
804 sizeof (bs->auth.curr_key->key));
805 unsigned char hash[sizeof (auth->hash)];
808 vnet_crypto_op_init (&op, VNET_CRYPTO_OP_SHA1_HASH);
810 op.len = sizeof (*pkt);
812 vnet_crypto_process_ops (vm, &op, 1);
813 BFD_DBG ("hashing: %U", format_hex_bytes, pkt, sizeof (*pkt));
814 clib_memcpy (auth->hash, hash, sizeof (hash));
818 bfd_add_auth_section (vlib_main_t *vm, vlib_buffer_t *b, bfd_session_t *bs)
820 bfd_main_t *bm = &bfd_main;
821 if (bs->auth.curr_key)
823 const bfd_auth_type_e auth_type = bs->auth.curr_key->auth_type;
826 case BFD_AUTH_TYPE_reserved:
828 case BFD_AUTH_TYPE_simple_password:
830 case BFD_AUTH_TYPE_keyed_md5:
832 case BFD_AUTH_TYPE_meticulous_keyed_md5:
833 vlib_log_crit (bm->log_class,
834 "internal error, unexpected BFD auth type '%d'",
837 case BFD_AUTH_TYPE_keyed_sha1:
839 case BFD_AUTH_TYPE_meticulous_keyed_sha1:
840 bfd_add_sha1_auth_section (vm, b, bs);
847 bfd_is_echo_possible (bfd_session_t * bs)
849 if (BFD_STATE_up == bs->local_state && BFD_STATE_up == bs->remote_state &&
850 bs->remote_min_echo_rx_usec > 0)
852 switch (bs->transport)
854 case BFD_TRANSPORT_UDP4:
855 return bfd_udp_is_echo_available (BFD_TRANSPORT_UDP4);
856 case BFD_TRANSPORT_UDP6:
857 return bfd_udp_is_echo_available (BFD_TRANSPORT_UDP6);
864 bfd_init_control_frame (bfd_main_t * bm, bfd_session_t * bs,
867 bfd_pkt_t *pkt = vlib_buffer_get_current (b);
869 bfd_length = sizeof (bfd_pkt_t);
870 clib_memset (pkt, 0, sizeof (*pkt));
871 bfd_pkt_set_version (pkt, 1);
872 bfd_pkt_set_diag_code (pkt, bs->local_diag);
873 bfd_pkt_set_state (pkt, bs->local_state);
874 pkt->head.detect_mult = bs->local_detect_mult;
875 pkt->head.length = bfd_length;
876 pkt->my_disc = bs->local_discr;
877 pkt->your_disc = bs->remote_discr;
878 pkt->des_min_tx = clib_host_to_net_u32 (bs->config_desired_min_tx_usec);
882 clib_host_to_net_u32 (bfd_nsec_to_usec
883 (bs->effective_required_min_rx_nsec));
888 clib_host_to_net_u32 (bs->config_required_min_rx_usec);
890 pkt->req_min_echo_rx = clib_host_to_net_u32 (1);
891 b->current_length = bfd_length;
895 bfd_send_echo (vlib_main_t * vm, vlib_node_runtime_t * rt,
896 bfd_main_t * bm, bfd_session_t * bs, u64 now)
898 if (!bfd_is_echo_possible (bs))
900 BFD_DBG ("\nSwitching off echo function: %U", format_bfd_session, bs);
904 if (now >= bs->echo_tx_timeout_nsec)
906 BFD_DBG ("\nSending echo packet: %U", format_bfd_session, bs);
908 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
910 vlib_log_crit (bm->log_class, "buffer allocation failure");
913 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
914 ASSERT (b->current_data == 0);
915 bfd_echo_pkt_t *pkt = vlib_buffer_get_current (b);
916 clib_memset (pkt, 0, sizeof (*pkt));
917 pkt->discriminator = bs->local_discr;
918 pkt->expire_time_nsec =
919 now + bs->echo_transmit_interval_nsec * bs->local_detect_mult;
921 bfd_calc_echo_checksum (bs->local_discr, pkt->expire_time_nsec,
923 b->current_length = sizeof (*pkt);
924 if (!bfd_echo_add_transport_layer (vm, bi, bs))
926 BFD_ERR ("cannot send echo packet out, turning echo off");
928 vlib_buffer_free_one (vm, bi);
931 if (!bfd_transport_echo (vm, bi, bs))
933 BFD_ERR ("cannot send echo packet out, turning echo off");
935 vlib_buffer_free_one (vm, bi);
938 bs->echo_last_tx_nsec = now;
939 bfd_calc_next_echo_tx (bm, bs, now);
944 ("No need to send echo packet now, now is %lu, tx_timeout is %lu",
945 now, bs->echo_tx_timeout_nsec);
950 bfd_send_periodic (vlib_main_t * vm, vlib_node_runtime_t * rt,
951 bfd_main_t * bm, bfd_session_t * bs, u64 now)
953 if (!bs->remote_min_rx_usec && BFD_POLL_NOT_NEEDED == bs->poll_state)
955 BFD_DBG ("Remote min rx interval is zero, not sending periodic control "
959 if (BFD_POLL_NOT_NEEDED == bs->poll_state && bs->remote_demand &&
960 BFD_STATE_up == bs->local_state && BFD_STATE_up == bs->remote_state)
963 * A system MUST NOT periodically transmit BFD Control packets if Demand
964 * mode is active on the remote system (bfd.RemoteDemandMode is 1,
965 * bfd.SessionState is Up, and bfd.RemoteSessionState is Up) and a Poll
966 * Sequence is not being transmitted.
968 BFD_DBG ("Remote demand is set, not sending periodic control frame");
971 if (now >= bs->tx_timeout_nsec)
973 BFD_DBG ("\nSending periodic control frame: %U", format_bfd_session,
976 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
978 vlib_log_crit (bm->log_class, "buffer allocation failure");
981 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
982 ASSERT (b->current_data == 0);
983 bfd_init_control_frame (bm, bs, b);
984 switch (bs->poll_state)
986 case BFD_POLL_NEEDED:
987 if (now < bs->poll_state_start_or_timeout_nsec)
989 BFD_DBG ("Cannot start a poll sequence yet, need to wait for "
991 BFD_CLK_PRN (bs->poll_state_start_or_timeout_nsec -
995 bs->poll_state_start_or_timeout_nsec = now;
996 bfd_set_poll_state (bs, BFD_POLL_IN_PROGRESS);
998 case BFD_POLL_IN_PROGRESS:
999 case BFD_POLL_IN_PROGRESS_AND_QUEUED:
1000 bfd_pkt_set_poll (vlib_buffer_get_current (b));
1001 BFD_DBG ("Setting poll bit in packet, bs_idx=%u", bs->bs_idx);
1003 case BFD_POLL_NOT_NEEDED:
1007 bfd_add_auth_section (vm, b, bs);
1008 bfd_add_transport_layer (vm, bi, bs);
1009 if (!bfd_transport_control_frame (vm, bi, bs))
1011 vlib_buffer_free_one (vm, bi);
1013 bs->last_tx_nsec = now;
1014 bfd_calc_next_tx (bm, bs, now);
1019 ("No need to send control frame now, now is %lu, tx_timeout is %lu",
1020 now, bs->tx_timeout_nsec);
1025 bfd_init_final_control_frame (vlib_main_t * vm, vlib_buffer_t * b,
1026 bfd_main_t * bm, bfd_session_t * bs,
1029 BFD_DBG ("Send final control frame for bs_idx=%lu", bs->bs_idx);
1030 bfd_init_control_frame (bm, bs, b);
1031 bfd_pkt_set_final (vlib_buffer_get_current (b));
1032 bfd_add_auth_section (vm, b, bs);
1033 u32 bi = vlib_get_buffer_index (vm, b);
1034 bfd_add_transport_layer (vm, bi, bs);
1035 bs->last_tx_nsec = bfd_time_now_nsec (vm, NULL);
1037 * RFC allows to include changes in final frame, so if there were any
1038 * pending, we already did that, thus we can clear any pending poll needs
1040 bfd_set_poll_state (bs, BFD_POLL_NOT_NEEDED);
1044 bfd_check_rx_timeout (vlib_main_t * vm, bfd_main_t * bm, bfd_session_t * bs,
1045 u64 now, int handling_wakeup)
1047 if (bs->last_rx_nsec + bs->detection_time_nsec <= now)
1049 BFD_DBG ("Rx timeout, session goes down");
1051 * RFC 5880 6.8.1. State Variables
1055 * The remote discriminator for this BFD session. This is the
1056 * discriminator chosen by the remote system, and is totally opaque
1057 * to the local system. This MUST be initialized to zero. If a
1058 * period of a Detection Time passes without the receipt of a valid,
1059 * authenticated BFD packet from the remote system, this variable
1060 * MUST be set to zero.
1062 bs->remote_discr = 0;
1063 bfd_set_diag (bs, BFD_DIAG_CODE_det_time_exp);
1064 bfd_set_state (vm, bm, bs, BFD_STATE_down, handling_wakeup);
1066 * If the remote system does not receive any
1067 * BFD Control packets for a Detection Time, it SHOULD reset
1068 * bfd.RemoteMinRxInterval to its initial value of 1 (per section 6.8.1,
1069 * since it is no longer required to maintain previous session state)
1070 * and then can transmit at its own rate.
1072 bfd_set_remote_required_min_rx (bm, bs, now, 1);
1075 && bs->echo_last_rx_nsec +
1076 bs->echo_transmit_interval_nsec * bs->local_detect_mult <= now)
1078 BFD_DBG ("Echo rx timeout, session goes down");
1079 bfd_set_diag (bs, BFD_DIAG_CODE_echo_failed);
1080 bfd_set_state (vm, bm, bs, BFD_STATE_down, handling_wakeup);
1085 bfd_on_timeout (vlib_main_t * vm, vlib_node_runtime_t * rt, bfd_main_t * bm,
1086 bfd_session_t * bs, u64 now)
1088 BFD_DBG ("Timeout for bs_idx=%lu", bs->bs_idx);
1089 switch (bs->local_state)
1091 case BFD_STATE_admin_down:
1092 bfd_send_periodic (vm, rt, bm, bs, now);
1094 case BFD_STATE_down:
1095 bfd_send_periodic (vm, rt, bm, bs, now);
1097 case BFD_STATE_init:
1098 bfd_check_rx_timeout (vm, bm, bs, now, 1);
1099 bfd_send_periodic (vm, rt, bm, bs, now);
1102 bfd_check_rx_timeout (vm, bm, bs, now, 1);
1103 if (BFD_POLL_NOT_NEEDED == bs->poll_state && !bs->echo &&
1104 bfd_is_echo_possible (bs))
1106 /* switch on echo function as main detection method now */
1107 BFD_DBG ("Switching on echo function, bs_idx=%u", bs->bs_idx);
1109 bs->echo_last_rx_nsec = now;
1110 bs->echo_tx_timeout_nsec = now;
1111 bfd_set_effective_required_min_rx (bm, bs,
1113 (bm->min_required_min_rx_while_echo_nsec,
1114 bs->config_required_min_rx_nsec));
1115 bfd_set_poll_state (bs, BFD_POLL_NEEDED);
1117 bfd_send_periodic (vm, rt, bm, bs, now);
1120 bfd_send_echo (vm, rt, bm, bs, now);
1127 * bfd process node function
1130 bfd_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
1132 bfd_main_t *bm = &bfd_main;
1134 uword event_type, *event_data = 0;
1136 /* So we can send events to the bfd process */
1137 bm->bfd_process_node_index = bfd_process_node.index;
1142 u64 now = bfd_time_now_nsec (vm, &vm_time);
1143 BFD_DBG ("wakeup, now is %llunsec, vlib_time_now() is %.9f", now,
1147 if (pool_elts (bm->sessions))
1149 u32 first_expires_in_ticks =
1150 TW (tw_timer_first_expires_in_ticks) (&bm->wheel);
1151 if (!first_expires_in_ticks)
1154 ("tw_timer_first_expires_in_ticks(%p) returns 0ticks",
1156 timeout = bm->wheel.next_run_time - vm_time;
1157 BFD_DBG ("wheel.next_run_time is %.9f",
1158 bm->wheel.next_run_time);
1159 u64 next_expire_nsec = now + timeout * SEC_PER_NSEC;
1160 bm->bfd_process_next_wakeup_nsec = next_expire_nsec;
1165 BFD_DBG ("tw_timer_first_expires_in_ticks(%p) returns %luticks",
1166 &bm->wheel, first_expires_in_ticks);
1167 u64 next_expire_nsec =
1168 now + first_expires_in_ticks * bm->nsec_per_tw_tick;
1169 bm->bfd_process_next_wakeup_nsec = next_expire_nsec;
1171 timeout = (next_expire_nsec - now) * SEC_PER_NSEC;
1173 BFD_DBG ("vlib_process_wait_for_event_or_clock(vm, %.09f)",
1175 (void) vlib_process_wait_for_event_or_clock (vm, timeout);
1180 (void) vlib_process_wait_for_event (vm);
1182 event_type = vlib_process_get_events (vm, &event_data);
1183 now = bfd_time_now_nsec (vm, &vm_time);
1184 uword *session_index;
1187 case ~0: /* no events => timeout */
1188 /* nothing to do here */
1190 case BFD_EVENT_RESCHEDULE:
1191 BFD_DBG ("reschedule event");
1193 bm->bfd_process_wakeup_event_delay_nsec =
1194 now - bm->bfd_process_wakeup_event_start_nsec;
1195 bm->bfd_process_wakeup_events_in_flight--;
1197 /* nothing to do here - reschedule is done automatically after
1198 * each event or timeout */
1200 case BFD_EVENT_NEW_SESSION:
1201 vec_foreach (session_index, event_data)
1204 if (!pool_is_free_index (bm->sessions, *session_index))
1207 pool_elt_at_index (bm->sessions, *session_index);
1208 bfd_send_periodic (vm, rt, bm, bs, now);
1209 bfd_set_timer (bm, bs, now, 1);
1213 BFD_DBG ("Ignoring event for non-existent session index %u",
1214 (u32) * session_index);
1219 case BFD_EVENT_CONFIG_CHANGED:
1220 vec_foreach (session_index, event_data)
1223 if (!pool_is_free_index (bm->sessions, *session_index))
1226 pool_elt_at_index (bm->sessions, *session_index);
1227 bfd_on_config_change (vm, rt, bm, bs, now);
1231 BFD_DBG ("Ignoring event for non-existent session index %u",
1232 (u32) * session_index);
1238 vlib_log_err (bm->log_class, "BUG: event type 0x%wx", event_type);
1241 BFD_DBG ("tw_timer_expire_timers_vec(%p, %.04f);", &bm->wheel, vm_time);
1244 TW (tw_timer_expire_timers_vec) (&bm->wheel, vm_time, expired);
1245 BFD_DBG ("Expired %d elements", vec_len (expired));
1247 vec_foreach (p, expired)
1249 const u32 bs_idx = *p;
1250 if (!pool_is_free_index (bm->sessions, bs_idx))
1252 bfd_session_t *bs = pool_elt_at_index (bm->sessions, bs_idx);
1253 bs->tw_id = 0; /* timer is gone because it expired */
1254 bfd_on_timeout (vm, rt, bm, bs, now);
1255 bfd_set_timer (bm, bs, now, 1);
1261 _vec_len (expired) = 0;
1265 _vec_len (event_data) = 0;
1273 * bfd process node declaration
1276 VLIB_REGISTER_NODE (bfd_process_node, static) = {
1277 .function = bfd_process,
1278 .type = VLIB_NODE_TYPE_PROCESS,
1279 .name = "bfd-process",
1285 static clib_error_t *
1286 bfd_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
1288 // bfd_main_t *bm = &bfd_main;
1289 // vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
1290 if (!(flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
1297 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (bfd_sw_interface_up_down);
1299 static clib_error_t *
1300 bfd_hw_interface_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
1302 // bfd_main_t *bm = &bfd_main;
1303 if (flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
1310 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION (bfd_hw_interface_up_down);
1313 bfd_register_listener (bfd_notify_fn_t fn)
1315 bfd_main_t *bm = &bfd_main;
1317 vec_add1 (bm->listeners, fn);
1323 static clib_error_t *
1324 bfd_main_init (vlib_main_t * vm)
1326 vlib_thread_main_t *tm = &vlib_thread_main;
1327 u32 n_vlib_mains = tm->n_vlib_mains;
1329 setbuf (stdout, NULL);
1331 bfd_main_t *bm = &bfd_main;
1332 bm->random_seed = random_default_seed ();
1334 bm->vnet_main = vnet_get_main ();
1335 clib_memset (&bm->wheel, 0, sizeof (bm->wheel));
1336 bm->nsec_per_tw_tick = (f64) NSEC_PER_SEC / BFD_TW_TPS;
1337 bm->default_desired_min_tx_nsec =
1338 bfd_usec_to_nsec (BFD_DEFAULT_DESIRED_MIN_TX_USEC);
1339 bm->min_required_min_rx_while_echo_nsec =
1340 bfd_usec_to_nsec (BFD_REQUIRED_MIN_RX_USEC_WHILE_ECHO);
1341 BFD_DBG ("tw_timer_wheel_init(%p, %p, %.04f, %u)", &bm->wheel, NULL,
1342 1.00 / BFD_TW_TPS, ~0);
1343 TW (tw_timer_wheel_init) (&bm->wheel, NULL, 1.00 / BFD_TW_TPS, ~0);
1344 bm->log_class = vlib_log_register_class ("bfd", 0);
1345 vlib_log_debug (bm->log_class, "initialized");
1346 bm->owner_thread_index = ~0;
1347 if (n_vlib_mains > 1)
1348 clib_spinlock_init (&bm->lock);
1352 VLIB_INIT_FUNCTION (bfd_main_init);
1355 bfd_get_session (bfd_main_t * bm, bfd_transport_e t)
1357 bfd_session_t *result;
1361 pool_get (bm->sessions, result);
1362 clib_memset (result, 0, sizeof (*result));
1363 result->bs_idx = result - bm->sessions;
1364 result->transport = t;
1365 const unsigned limit = 1000;
1366 unsigned counter = 0;
1369 result->local_discr = random_u32 (&bm->random_seed);
1370 if (counter > limit)
1372 vlib_log_crit (bm->log_class,
1373 "couldn't allocate unused session discriminator even "
1374 "after %u tries!", limit);
1375 pool_put (bm->sessions, result);
1381 while (hash_get (bm->session_by_disc, result->local_discr));
1382 bfd_set_defaults (bm, result);
1383 hash_set (bm->session_by_disc, result->local_discr, result->bs_idx);
1389 bfd_put_session (bfd_main_t * bm, bfd_session_t * bs)
1393 vlib_log_info (bm->log_class, "delete session: %U",
1394 format_bfd_session_brief, bs);
1395 bfd_notify_listeners (bm, BFD_LISTEN_EVENT_DELETE, bs);
1396 if (bs->auth.curr_key)
1398 --bs->auth.curr_key->use_count;
1400 if (bs->auth.next_key)
1402 --bs->auth.next_key->use_count;
1404 hash_unset (bm->session_by_disc, bs->local_discr);
1405 pool_put (bm->sessions, bs);
1410 bfd_find_session_by_idx (bfd_main_t * bm, uword bs_idx)
1412 bfd_lock_check (bm);
1413 if (!pool_is_free_index (bm->sessions, bs_idx))
1415 return pool_elt_at_index (bm->sessions, bs_idx);
1421 bfd_find_session_by_disc (bfd_main_t * bm, u32 disc)
1423 bfd_lock_check (bm);
1424 uword *p = hash_get (bfd_main.session_by_disc, disc);
1427 return pool_elt_at_index (bfd_main.sessions, *p);
1433 * @brief verify bfd packet - common checks
1437 * @return 1 if bfd packet is valid
1440 bfd_verify_pkt_common (const bfd_pkt_t * pkt)
1442 if (1 != bfd_pkt_get_version (pkt))
1444 BFD_ERR ("BFD verification failed - unexpected version: '%d'",
1445 bfd_pkt_get_version (pkt));
1448 if (pkt->head.length < sizeof (bfd_pkt_t) ||
1449 (bfd_pkt_get_auth_present (pkt) &&
1450 pkt->head.length < sizeof (bfd_pkt_with_common_auth_t)))
1452 BFD_ERR ("BFD verification failed - unexpected length: '%d' (auth "
1454 pkt->head.length, bfd_pkt_get_auth_present (pkt));
1457 if (!pkt->head.detect_mult)
1459 BFD_ERR ("BFD verification failed - unexpected detect-mult: '%d'",
1460 pkt->head.detect_mult);
1463 if (bfd_pkt_get_multipoint (pkt))
1465 BFD_ERR ("BFD verification failed - unexpected multipoint: '%d'",
1466 bfd_pkt_get_multipoint (pkt));
1471 BFD_ERR ("BFD verification failed - unexpected my-disc: '%d'",
1475 if (!pkt->your_disc)
1477 const u8 pkt_state = bfd_pkt_get_state (pkt);
1478 if (pkt_state != BFD_STATE_down && pkt_state != BFD_STATE_admin_down)
1480 BFD_ERR ("BFD verification failed - unexpected state: '%s' "
1481 "(your-disc is zero)", bfd_state_string (pkt_state));
1489 bfd_session_switch_auth_to_next (bfd_session_t * bs)
1491 BFD_DBG ("Switching authentication key from %U to %U for bs_idx=%u",
1492 format_bfd_auth_key, bs->auth.curr_key, format_bfd_auth_key,
1493 bs->auth.next_key, bs->bs_idx);
1494 bs->auth.is_delayed = 0;
1495 if (bs->auth.curr_key)
1497 --bs->auth.curr_key->use_count;
1499 bs->auth.curr_key = bs->auth.next_key;
1500 bs->auth.next_key = NULL;
1501 bs->auth.curr_bfd_key_id = bs->auth.next_bfd_key_id;
1505 bfd_auth_type_is_meticulous (bfd_auth_type_e auth_type)
1507 if (BFD_AUTH_TYPE_meticulous_keyed_md5 == auth_type ||
1508 BFD_AUTH_TYPE_meticulous_keyed_sha1 == auth_type)
1516 bfd_verify_pkt_auth_seq_num (vlib_main_t * vm, bfd_session_t * bs,
1517 u32 received_seq_num, int is_meticulous)
1522 * This variable MUST be set to zero after no packets have been
1523 * received on this session for at least twice the Detection Time.
1525 u64 now = bfd_time_now_nsec (vm, NULL);
1526 if (now - bs->last_rx_nsec > bs->detection_time_nsec * 2)
1528 BFD_DBG ("BFD peer unresponsive for %lu nsec, which is > 2 * "
1529 "detection_time=%u nsec, resetting remote_seq_number_known "
1530 "flag", now - bs->last_rx_nsec, bs->detection_time_nsec * 2);
1531 bs->auth.remote_seq_number_known = 0;
1533 if (bs->auth.remote_seq_number_known)
1535 /* remote sequence number is known, verify its validity */
1536 const u32 max_u32 = 0xffffffff;
1537 /* the calculation might wrap, account for the special case... */
1538 if (bs->auth.remote_seq_number > max_u32 - 3 * bs->local_detect_mult)
1544 * |----------+----------------------------+-----------|
1546 * | remote_seq_num------+
1548 * +-----(remote_seq_num + 3*detect_mult) % * 0xffffffff
1550 * x + y + z = 0xffffffff
1551 * x + z = 3 * detect_mult
1553 const u32 z = max_u32 - bs->auth.remote_seq_number;
1554 const u32 x = 3 * bs->local_detect_mult - z;
1555 if (received_seq_num > x &&
1556 received_seq_num < bs->auth.remote_seq_number + is_meticulous)
1559 ("Recvd sequence number=%u out of ranges <0, %u>, <%u, %u>",
1560 received_seq_num, x,
1561 bs->auth.remote_seq_number + is_meticulous, max_u32);
1568 const u32 min = bs->auth.remote_seq_number + is_meticulous;
1570 bs->auth.remote_seq_number + 3 * bs->local_detect_mult;
1571 if (received_seq_num < min || received_seq_num > max)
1573 BFD_ERR ("Recvd sequence number=%u out of range <%u, %u>",
1574 received_seq_num, min, max);
1583 bfd_verify_pkt_auth_key_sha1 (vlib_main_t *vm, const bfd_pkt_t *pkt,
1584 u32 pkt_size, bfd_session_t *bs, u8 bfd_key_id,
1585 bfd_auth_key_t *auth_key)
1587 ASSERT (auth_key->auth_type == BFD_AUTH_TYPE_keyed_sha1 ||
1588 auth_key->auth_type == BFD_AUTH_TYPE_meticulous_keyed_sha1);
1590 bfd_pkt_with_common_auth_t *with_common = (void *) pkt;
1591 if (pkt_size < sizeof (*with_common))
1593 BFD_ERR ("Packet size too small to hold authentication common header");
1596 if (with_common->common_auth.type != auth_key->auth_type)
1598 BFD_ERR ("BFD auth type mismatch, packet auth=%d:%s doesn't match "
1599 "in-use auth=%d:%s",
1600 with_common->common_auth.type,
1601 bfd_auth_type_str (with_common->common_auth.type),
1602 auth_key->auth_type, bfd_auth_type_str (auth_key->auth_type));
1605 bfd_pkt_with_sha1_auth_t *with_sha1 = (void *) pkt;
1606 if (pkt_size < sizeof (*with_sha1) ||
1607 with_sha1->sha1_auth.type_len.len < sizeof (with_sha1->sha1_auth))
1610 ("BFD size mismatch, payload size=%u, expected=%u, auth_len=%u, "
1611 "expected=%u", pkt_size, sizeof (*with_sha1),
1612 with_sha1->sha1_auth.type_len.len, sizeof (with_sha1->sha1_auth));
1615 if (with_sha1->sha1_auth.key_id != bfd_key_id)
1618 ("BFD key ID mismatch, packet key ID=%u doesn't match key ID=%u%s",
1619 with_sha1->sha1_auth.key_id, bfd_key_id,
1621 auth.is_delayed ? " (but a delayed auth change is scheduled)" : "");
1625 u8 hash_from_packet[STRUCT_SIZE_OF (bfd_auth_sha1_t, hash)];
1626 u8 calculated_hash[STRUCT_SIZE_OF (bfd_auth_sha1_t, hash)];
1627 clib_memcpy (hash_from_packet, with_sha1->sha1_auth.hash,
1628 sizeof (with_sha1->sha1_auth.hash));
1629 clib_memcpy (with_sha1->sha1_auth.hash, auth_key->key,
1630 sizeof (auth_key->key));
1631 vnet_crypto_op_t op;
1632 vnet_crypto_op_init (&op, VNET_CRYPTO_OP_SHA1_HASH);
1633 op.src = (u8 *) with_sha1;
1634 op.len = sizeof (*with_sha1);
1635 op.digest = calculated_hash;
1636 vnet_crypto_process_ops (vm, &op, 1);
1638 memcmp (calculated_hash, hash_from_packet, sizeof (calculated_hash)))
1640 clib_memcpy (with_sha1->sha1_auth.hash, hash_from_packet,
1641 sizeof (hash_from_packet));
1644 BFD_ERR ("SHA1 hash: %U doesn't match the expected value: %U",
1645 format_hex_bytes, hash_from_packet, sizeof (hash_from_packet),
1646 format_hex_bytes, calculated_hash, sizeof (calculated_hash));
1651 bfd_verify_pkt_auth_key (vlib_main_t * vm, const bfd_pkt_t * pkt,
1652 u32 pkt_size, bfd_session_t * bs, u8 bfd_key_id,
1653 bfd_auth_key_t * auth_key)
1655 bfd_main_t *bm = &bfd_main;
1656 switch (auth_key->auth_type)
1658 case BFD_AUTH_TYPE_reserved:
1659 vlib_log_err (bm->log_class,
1660 "internal error, unexpected auth_type=%d:%s",
1661 auth_key->auth_type,
1662 bfd_auth_type_str (auth_key->auth_type));
1664 case BFD_AUTH_TYPE_simple_password:
1665 vlib_log_err (bm->log_class,
1666 "internal error, not implemented, unexpected auth_type=%d:%s",
1667 auth_key->auth_type,
1668 bfd_auth_type_str (auth_key->auth_type));
1670 case BFD_AUTH_TYPE_keyed_md5:
1672 case BFD_AUTH_TYPE_meticulous_keyed_md5:
1675 "internal error, not implemented, unexpected auth_type=%d:%s",
1676 auth_key->auth_type, bfd_auth_type_str (auth_key->auth_type));
1678 case BFD_AUTH_TYPE_keyed_sha1:
1680 case BFD_AUTH_TYPE_meticulous_keyed_sha1:
1683 const u32 seq_num = clib_net_to_host_u32 (((bfd_pkt_with_sha1_auth_t
1686 return bfd_verify_pkt_auth_seq_num (
1688 bfd_auth_type_is_meticulous (auth_key->auth_type)) &&
1689 bfd_verify_pkt_auth_key_sha1 (vm, pkt, pkt_size, bs,
1690 bfd_key_id, auth_key);
1698 * @brief verify bfd packet - authentication
1702 * @return 1 if bfd packet is valid
1705 bfd_verify_pkt_auth (vlib_main_t * vm, const bfd_pkt_t * pkt, u16 pkt_size,
1708 if (bfd_pkt_get_auth_present (pkt))
1710 /* authentication present in packet */
1711 if (!bs->auth.curr_key)
1713 /* currently not using authentication - can we turn it on? */
1714 if (bs->auth.is_delayed && bs->auth.next_key)
1716 /* yes, switch is scheduled - make sure the auth is valid */
1717 if (bfd_verify_pkt_auth_key (vm, pkt, pkt_size, bs,
1718 bs->auth.next_bfd_key_id,
1721 /* auth matches next key, do the switch, packet is valid */
1722 bfd_session_switch_auth_to_next (bs);
1729 /* yes, using authentication, verify the key */
1730 if (bfd_verify_pkt_auth_key (vm, pkt, pkt_size, bs,
1731 bs->auth.curr_bfd_key_id,
1734 /* verification passed, packet is valid */
1739 /* verification failed - but maybe we need to switch key */
1740 if (bs->auth.is_delayed && bs->auth.next_key)
1742 /* delayed switch present, verify if that key works */
1743 if (bfd_verify_pkt_auth_key (vm, pkt, pkt_size, bs,
1744 bs->auth.next_bfd_key_id,
1747 /* auth matches next key, switch key, packet is valid */
1748 bfd_session_switch_auth_to_next (bs);
1757 /* authentication in packet not present */
1758 if (pkt_size > sizeof (*pkt))
1760 BFD_ERR ("BFD verification failed - unexpected packet size '%d' "
1761 "(auth not present)", pkt_size);
1764 if (bs->auth.curr_key)
1766 /* currently authenticating - could we turn it off? */
1767 if (bs->auth.is_delayed && !bs->auth.next_key)
1769 /* yes, delayed switch to NULL key is scheduled */
1770 bfd_session_switch_auth_to_next (bs);
1776 /* no auth in packet, no auth in use - packet is valid */
1784 bfd_consume_pkt (vlib_main_t * vm, bfd_main_t * bm, const bfd_pkt_t * pkt,
1787 bfd_lock_check (bm);
1789 bfd_session_t *bs = bfd_find_session_by_idx (bm, bs_idx);
1790 if (!bs || (pkt->your_disc && pkt->your_disc != bs->local_discr))
1794 BFD_DBG ("Scanning bfd packet, bs_idx=%d", bs->bs_idx);
1795 bs->remote_discr = pkt->my_disc;
1796 bs->remote_state = bfd_pkt_get_state (pkt);
1797 bs->remote_demand = bfd_pkt_get_demand (pkt);
1798 bs->remote_diag = bfd_pkt_get_diag_code (pkt);
1799 u64 now = bfd_time_now_nsec (vm, NULL);
1800 bs->last_rx_nsec = now;
1801 if (bfd_pkt_get_auth_present (pkt))
1803 bfd_auth_type_e auth_type =
1804 ((bfd_pkt_with_common_auth_t *) (pkt))->common_auth.type;
1807 case BFD_AUTH_TYPE_reserved:
1809 case BFD_AUTH_TYPE_simple_password:
1811 case BFD_AUTH_TYPE_keyed_md5:
1813 case BFD_AUTH_TYPE_meticulous_keyed_md5:
1814 vlib_log_crit (bm->log_class,
1815 "internal error, unexpected auth_type=%d:%s",
1816 auth_type, bfd_auth_type_str (auth_type));
1818 case BFD_AUTH_TYPE_keyed_sha1:
1820 case BFD_AUTH_TYPE_meticulous_keyed_sha1:
1823 bfd_pkt_with_sha1_auth_t *with_sha1 =
1824 (bfd_pkt_with_sha1_auth_t *) pkt;
1825 bs->auth.remote_seq_number =
1826 clib_net_to_host_u32 (with_sha1->sha1_auth.seq_num);
1827 bs->auth.remote_seq_number_known = 1;
1828 BFD_DBG ("Received sequence number %u",
1829 bs->auth.remote_seq_number);
1834 bs->remote_desired_min_tx_nsec =
1835 bfd_usec_to_nsec (clib_net_to_host_u32 (pkt->des_min_tx));
1836 bs->remote_detect_mult = pkt->head.detect_mult;
1837 bfd_set_remote_required_min_rx (bm, bs, now,
1838 clib_net_to_host_u32 (pkt->req_min_rx));
1839 bfd_set_remote_required_min_echo_rx (bm, bs, now,
1840 clib_net_to_host_u32
1841 (pkt->req_min_echo_rx));
1842 if (bfd_pkt_get_final (pkt))
1844 if (BFD_POLL_IN_PROGRESS == bs->poll_state)
1846 BFD_DBG ("Poll sequence terminated, bs_idx=%u", bs->bs_idx);
1847 bfd_set_poll_state (bs, BFD_POLL_NOT_NEEDED);
1848 if (BFD_STATE_up == bs->local_state)
1850 bfd_set_effective_desired_min_tx (
1851 bm, bs, now, bs->config_desired_min_tx_nsec);
1852 bfd_set_effective_required_min_rx (bm, bs,
1853 clib_max (bs->echo *
1854 bm->min_required_min_rx_while_echo_nsec,
1855 bs->config_required_min_rx_nsec));
1858 else if (BFD_POLL_IN_PROGRESS_AND_QUEUED == bs->poll_state)
1861 * next poll sequence must be delayed by at least the round trip
1862 * time, so calculate that here
1864 BFD_DBG ("Next poll sequence can commence in " BFD_CLK_FMT,
1865 BFD_CLK_PRN (now - bs->poll_state_start_or_timeout_nsec));
1866 bs->poll_state_start_or_timeout_nsec =
1867 now + (now - bs->poll_state_start_or_timeout_nsec);
1869 ("Poll sequence terminated, but another is needed, bs_idx=%u",
1871 bfd_set_poll_state (bs, BFD_POLL_NEEDED);
1874 bfd_calc_next_tx (bm, bs, now);
1875 bfd_set_timer (bm, bs, now, 0);
1876 if (BFD_STATE_admin_down == bs->local_state)
1878 BFD_DBG ("Session is admin-down, ignoring packet, bs_idx=%u",
1882 if (BFD_STATE_admin_down == bs->remote_state)
1884 bfd_set_diag (bs, BFD_DIAG_CODE_neighbor_sig_down);
1885 bfd_set_state (vm, bm, bs, BFD_STATE_down, 0);
1887 else if (BFD_STATE_down == bs->local_state)
1889 if (BFD_STATE_down == bs->remote_state)
1891 bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
1892 bfd_set_state (vm, bm, bs, BFD_STATE_init, 0);
1894 else if (BFD_STATE_init == bs->remote_state)
1896 bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
1897 bfd_set_state (vm, bm, bs, BFD_STATE_up, 0);
1900 else if (BFD_STATE_init == bs->local_state)
1902 if (BFD_STATE_up == bs->remote_state ||
1903 BFD_STATE_init == bs->remote_state)
1905 bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
1906 bfd_set_state (vm, bm, bs, BFD_STATE_up, 0);
1909 else /* BFD_STATE_up == bs->local_state */
1911 if (BFD_STATE_down == bs->remote_state)
1913 bfd_set_diag (bs, BFD_DIAG_CODE_neighbor_sig_down);
1914 bfd_set_state (vm, bm, bs, BFD_STATE_down, 0);
1920 bfd_consume_echo_pkt (vlib_main_t * vm, bfd_main_t * bm, vlib_buffer_t * b)
1922 bfd_echo_pkt_t *pkt = NULL;
1923 if (b->current_length != sizeof (*pkt))
1927 pkt = vlib_buffer_get_current (b);
1928 bfd_session_t *bs = bfd_find_session_by_disc (bm, pkt->discriminator);
1933 BFD_DBG ("Scanning bfd echo packet, bs_idx=%d", bs->bs_idx);
1935 bfd_calc_echo_checksum (bs->local_discr, pkt->expire_time_nsec,
1937 if (checksum != pkt->checksum)
1939 BFD_DBG ("Invalid echo packet, checksum mismatch");
1942 u64 now = bfd_time_now_nsec (vm, NULL);
1943 if (pkt->expire_time_nsec < now)
1945 BFD_DBG ("Stale packet received, expire time %lu < now %lu",
1946 pkt->expire_time_nsec, now);
1950 bs->echo_last_rx_nsec = now;
1956 format_bfd_session (u8 * s, va_list * args)
1958 const bfd_session_t *bs = va_arg (*args, bfd_session_t *);
1959 s = format (s, "bs_idx=%u local-state=%s remote-state=%s\n"
1960 "local-discriminator=%u remote-discriminator=%u\n"
1961 "local-diag=%s echo-active=%s\n"
1962 "desired-min-tx=%u required-min-rx=%u\n"
1963 "required-min-echo-rx=%u detect-mult=%u\n"
1964 "remote-min-rx=%u remote-min-echo-rx=%u\n"
1965 "remote-demand=%s poll-state=%s\n"
1966 "auth: local-seq-num=%u remote-seq-num=%u\n"
1970 bs->bs_idx, bfd_state_string (bs->local_state),
1971 bfd_state_string (bs->remote_state), bs->local_discr,
1972 bs->remote_discr, bfd_diag_code_string (bs->local_diag),
1973 (bs->echo ? "yes" : "no"), bs->config_desired_min_tx_usec,
1974 bs->config_required_min_rx_usec, 1, bs->local_detect_mult,
1975 bs->remote_min_rx_usec, bs->remote_min_echo_rx_usec,
1976 (bs->remote_demand ? "yes" : "no"),
1977 bfd_poll_state_string (bs->poll_state),
1978 bs->auth.local_seq_number, bs->auth.remote_seq_number,
1979 (bs->auth.is_delayed ? "yes" : "no"),
1980 format_bfd_auth_key, bs->auth.curr_key, format_bfd_auth_key,
1986 format_bfd_session_brief (u8 * s, va_list * args)
1988 const bfd_session_t *bs = va_arg (*args, bfd_session_t *);
1990 format (s, "bs_idx=%u local-state=%s remote-state=%s", bs->bs_idx,
1991 bfd_state_string (bs->local_state),
1992 bfd_state_string (bs->remote_state));
1997 bfd_auth_type_supported (bfd_auth_type_e auth_type)
1999 if (auth_type == BFD_AUTH_TYPE_keyed_sha1 ||
2000 auth_type == BFD_AUTH_TYPE_meticulous_keyed_sha1)
2008 bfd_auth_activate (bfd_session_t * bs, u32 conf_key_id,
2009 u8 bfd_key_id, u8 is_delayed)
2011 bfd_main_t *bm = &bfd_main;
2012 const uword *key_idx_p =
2013 hash_get (bm->auth_key_by_conf_key_id, conf_key_id);
2016 vlib_log_err (bm->log_class,
2017 "authentication key with config ID %u doesn't exist)",
2019 return VNET_API_ERROR_BFD_ENOENT;
2021 const uword key_idx = *key_idx_p;
2022 bfd_auth_key_t *key = pool_elt_at_index (bm->auth_keys, key_idx);
2025 if (bs->auth.next_key == key && bs->auth.next_bfd_key_id == bfd_key_id)
2027 /* already using this key, no changes required */
2030 if (bs->auth.next_key != key)
2033 bs->auth.next_key = key;
2035 bs->auth.next_bfd_key_id = bfd_key_id;
2036 bs->auth.is_delayed = 1;
2040 if (bs->auth.curr_key == key && bs->auth.curr_bfd_key_id == bfd_key_id)
2042 /* already using this key, no changes required */
2046 if (bs->auth.curr_key)
2048 --bs->auth.curr_key->use_count;
2050 bs->auth.curr_key = key;
2051 bs->auth.curr_bfd_key_id = bfd_key_id;
2052 bs->auth.is_delayed = 0;
2054 BFD_DBG ("\nSession auth modified: %U", format_bfd_session, bs);
2055 vlib_log_info (bm->log_class, "session auth modified: %U",
2056 format_bfd_session_brief, bs);
2061 bfd_auth_deactivate (bfd_session_t * bs, u8 is_delayed)
2063 bfd_main_t *bm = &bfd_main;
2066 /* not delayed - deactivate the current key right now */
2067 if (bs->auth.curr_key)
2069 --bs->auth.curr_key->use_count;
2070 bs->auth.curr_key = NULL;
2072 bs->auth.is_delayed = 0;
2076 /* delayed - mark as so */
2077 bs->auth.is_delayed = 1;
2080 * clear the next key unconditionally - either the auth change is not delayed
2081 * in which case the caller expects the session to not use authentication
2082 * from this point forward, or it is delayed, in which case the next_key
2083 * needs to be set to NULL to make it so in the future
2085 if (bs->auth.next_key)
2087 --bs->auth.next_key->use_count;
2088 bs->auth.next_key = NULL;
2090 BFD_DBG ("\nSession auth modified: %U", format_bfd_session, bs);
2091 vlib_log_info (bm->log_class, "session auth modified: %U",
2092 format_bfd_session_brief, bs);
2097 bfd_session_set_params (bfd_main_t * bm, bfd_session_t * bs,
2098 u32 desired_min_tx_usec,
2099 u32 required_min_rx_usec, u8 detect_mult)
2101 if (bs->local_detect_mult != detect_mult ||
2102 bs->config_desired_min_tx_usec != desired_min_tx_usec ||
2103 bs->config_required_min_rx_usec != required_min_rx_usec)
2105 BFD_DBG ("\nChanging session params: %U", format_bfd_session, bs);
2106 switch (bs->poll_state)
2108 case BFD_POLL_NOT_NEEDED:
2109 if (BFD_STATE_up == bs->local_state ||
2110 BFD_STATE_init == bs->local_state)
2112 /* poll sequence is not needed for detect multiplier change */
2113 if (bs->config_desired_min_tx_usec != desired_min_tx_usec ||
2114 bs->config_required_min_rx_usec != required_min_rx_usec)
2116 bfd_set_poll_state (bs, BFD_POLL_NEEDED);
2120 case BFD_POLL_NEEDED:
2121 case BFD_POLL_IN_PROGRESS_AND_QUEUED:
2123 * nothing to do - will be handled in the future poll which is
2124 * already scheduled for execution
2127 case BFD_POLL_IN_PROGRESS:
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_DBG ("Poll in progress, queueing extra poll, bs_idx=%u",
2134 bfd_set_poll_state (bs, BFD_POLL_IN_PROGRESS_AND_QUEUED);
2138 bs->local_detect_mult = detect_mult;
2139 bs->config_desired_min_tx_usec = desired_min_tx_usec;
2140 bs->config_desired_min_tx_nsec = bfd_usec_to_nsec (desired_min_tx_usec);
2141 bs->config_required_min_rx_usec = required_min_rx_usec;
2142 bs->config_required_min_rx_nsec =
2143 bfd_usec_to_nsec (required_min_rx_usec);
2144 BFD_DBG ("\nChanged session params: %U", format_bfd_session, bs);
2146 vlib_log_info (bm->log_class, "changed session params: %U",
2147 format_bfd_session_brief, bs);
2148 vlib_process_signal_event (bm->vlib_main, bm->bfd_process_node_index,
2149 BFD_EVENT_CONFIG_CHANGED, bs->bs_idx);
2153 BFD_DBG ("Ignore parameter change - no change, bs_idx=%u", bs->bs_idx);
2159 bfd_auth_set_key (u32 conf_key_id, u8 auth_type, u8 key_len,
2160 const u8 * key_data)
2162 bfd_main_t *bm = &bfd_main;
2163 bfd_auth_key_t *auth_key = NULL;
2164 if (!key_len || key_len > bfd_max_key_len_for_auth_type (auth_type))
2166 vlib_log_err (bm->log_class,
2167 "invalid authentication key length for auth_type=%d:%s "
2168 "(key_len=%u, must be non-zero, expected max=%u)",
2169 auth_type, bfd_auth_type_str (auth_type), key_len,
2170 (u32) bfd_max_key_len_for_auth_type (auth_type));
2171 return VNET_API_ERROR_INVALID_VALUE;
2173 if (!bfd_auth_type_supported (auth_type))
2175 vlib_log_err (bm->log_class, "unsupported auth type=%d:%s", auth_type,
2176 bfd_auth_type_str (auth_type));
2177 return VNET_API_ERROR_BFD_NOTSUPP;
2179 uword *key_idx_p = hash_get (bm->auth_key_by_conf_key_id, conf_key_id);
2182 /* modifying existing key - must not be used */
2183 const uword key_idx = *key_idx_p;
2184 auth_key = pool_elt_at_index (bm->auth_keys, key_idx);
2185 if (auth_key->use_count > 0)
2187 vlib_log_err (bm->log_class,
2188 "authentication key with conf ID %u in use by %u BFD "
2189 "session(s) - cannot modify", conf_key_id,
2190 auth_key->use_count);
2191 return VNET_API_ERROR_BFD_EINUSE;
2196 /* adding new key */
2197 pool_get (bm->auth_keys, auth_key);
2198 auth_key->conf_key_id = conf_key_id;
2199 hash_set (bm->auth_key_by_conf_key_id, conf_key_id,
2200 auth_key - bm->auth_keys);
2202 auth_key->auth_type = auth_type;
2203 clib_memset (auth_key->key, 0, sizeof (auth_key->key));
2204 clib_memcpy (auth_key->key, key_data, key_len);
2209 bfd_auth_del_key (u32 conf_key_id)
2211 bfd_auth_key_t *auth_key = NULL;
2212 bfd_main_t *bm = &bfd_main;
2213 uword *key_idx_p = hash_get (bm->auth_key_by_conf_key_id, conf_key_id);
2216 /* deleting existing key - must not be used */
2217 const uword key_idx = *key_idx_p;
2218 auth_key = pool_elt_at_index (bm->auth_keys, key_idx);
2219 if (auth_key->use_count > 0)
2221 vlib_log_err (bm->log_class,
2222 "authentication key with conf ID %u in use by %u BFD "
2223 "session(s) - cannot delete", conf_key_id,
2224 auth_key->use_count);
2225 return VNET_API_ERROR_BFD_EINUSE;
2227 hash_unset (bm->auth_key_by_conf_key_id, conf_key_id);
2228 clib_memset (auth_key, 0, sizeof (*auth_key));
2229 pool_put (bm->auth_keys, auth_key);
2234 vlib_log_err (bm->log_class,
2235 "authentication key with conf ID %u does not exist",
2237 return VNET_API_ERROR_BFD_ENOENT;
2242 bfd_main_t bfd_main;
2245 * fd.io coding-style-patch-verification: ON
2248 * eval: (c-set-style "gnu")