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_validate_counters (bfd_main_t *bm)
36 vlib_validate_combined_counter (&bm->rx_counter, pool_elts (bm->sessions));
37 vlib_validate_combined_counter (&bm->rx_echo_counter,
38 pool_elts (bm->sessions));
39 vlib_validate_combined_counter (&bm->tx_counter, pool_elts (bm->sessions));
40 vlib_validate_combined_counter (&bm->tx_echo_counter,
41 pool_elts (bm->sessions));
45 bfd_calc_echo_checksum (u32 discriminator, u64 expire_time, u32 secret)
48 #if defined(clib_crc32c_uses_intrinsics) && !defined (__i386__)
49 checksum = clib_crc32c_u64 (0, discriminator);
50 checksum = clib_crc32c_u64 (checksum, expire_time);
51 checksum = clib_crc32c_u64 (checksum, secret);
53 checksum = clib_xxhash (discriminator ^ expire_time ^ secret);
59 bfd_usec_to_nsec (u64 us)
61 return us * NSEC_PER_USEC;
65 bfd_nsec_to_usec (u64 nsec)
67 return nsec / NSEC_PER_USEC;
71 bfd_time_now_nsec (vlib_main_t * vm, f64 * vm_time)
73 f64 _vm_time = vlib_time_now (vm);
76 return _vm_time * NSEC_PER_SEC;
79 static vlib_node_registration_t bfd_process_node;
82 format_bfd_auth_key (u8 * s, va_list * args)
84 const bfd_auth_key_t *key = va_arg (*args, bfd_auth_key_t *);
87 s = format (s, "{auth-type=%u:%s, conf-key-id=%u, use-count=%u}, ",
88 key->auth_type, bfd_auth_type_str (key->auth_type),
89 key->conf_key_id, key->use_count);
93 s = format (s, "{none}");
99 * We actually send all bfd pkts to the "error" node after scanning
100 * them, so the graph node has only one next-index. The "error-drop"
101 * node automatically bumps our per-node packet counters for us.
105 BFD_INPUT_NEXT_NORMAL,
109 static void bfd_on_state_change (bfd_main_t * bm, bfd_session_t * bs, u64 now,
110 int handling_wakeup);
113 bfd_set_defaults (bfd_main_t * bm, bfd_session_t * bs)
115 bs->local_state = BFD_STATE_down;
116 bs->local_diag = BFD_DIAG_CODE_no_diag;
117 bs->remote_state = BFD_STATE_down;
118 bs->remote_discr = 0;
119 bs->hop_type = BFD_HOP_TYPE_SINGLE;
120 bs->config_desired_min_tx_usec = BFD_DEFAULT_DESIRED_MIN_TX_USEC;
121 bs->config_desired_min_tx_nsec = bm->default_desired_min_tx_nsec;
122 bs->effective_desired_min_tx_nsec = bm->default_desired_min_tx_nsec;
123 bs->remote_min_rx_usec = 1;
124 bs->remote_min_rx_nsec = bfd_usec_to_nsec (bs->remote_min_rx_usec);
125 bs->remote_min_echo_rx_usec = 0;
126 bs->remote_min_echo_rx_nsec = 0;
127 bs->remote_demand = 0;
128 bs->auth.remote_seq_number = 0;
129 bs->auth.remote_seq_number_known = 0;
130 bs->auth.local_seq_number = random_u32 (&bm->random_seed);
131 bs->echo_secret = random_u32 (&bm->random_seed);
135 bfd_set_diag (bfd_session_t * bs, bfd_diag_code_e code)
137 if (bs->local_diag != code)
139 BFD_DBG ("set local_diag, bs_idx=%d: '%d:%s'", bs->bs_idx, code,
140 bfd_diag_code_string (code));
141 bs->local_diag = code;
146 bfd_set_state (vlib_main_t * vm, bfd_main_t * bm, bfd_session_t * bs,
147 bfd_state_e new_state, int handling_wakeup)
149 if (bs->local_state != new_state)
151 BFD_DBG ("Change state, bs_idx=%d: %s->%s", bs->bs_idx,
152 bfd_state_string (bs->local_state),
153 bfd_state_string (new_state));
154 bs->local_state = new_state;
155 bfd_on_state_change (bm, bs, bfd_time_now_nsec (vm, NULL),
161 bfd_poll_state_string (bfd_poll_state_e state)
167 return "BFD_POLL_" #x;
168 foreach_bfd_poll_state (F)
175 bfd_set_poll_state (bfd_session_t * bs, bfd_poll_state_e state)
177 if (bs->poll_state != state)
179 BFD_DBG ("Setting poll state=%s, bs_idx=%u",
180 bfd_poll_state_string (state), bs->bs_idx);
181 bs->poll_state = state;
186 bfd_recalc_tx_interval (bfd_session_t *bs)
188 bs->transmit_interval_nsec =
189 clib_max (bs->effective_desired_min_tx_nsec, bs->remote_min_rx_nsec);
190 BFD_DBG ("Recalculated transmit interval " BFD_CLK_FMT,
191 BFD_CLK_PRN (bs->transmit_interval_nsec));
195 bfd_recalc_echo_tx_interval (bfd_session_t *bs)
197 bs->echo_transmit_interval_nsec =
198 clib_max (bs->effective_desired_min_tx_nsec, bs->remote_min_echo_rx_nsec);
199 BFD_DBG ("Recalculated echo transmit interval " BFD_CLK_FMT,
200 BFD_CLK_PRN (bs->echo_transmit_interval_nsec));
204 bfd_calc_next_tx (bfd_main_t * bm, bfd_session_t * bs, u64 now)
206 if (bs->local_detect_mult > 1)
208 /* common case - 75-100% of transmit interval */
209 bs->tx_timeout_nsec = bs->last_tx_nsec +
210 (1 - .25 * (random_f64 (&bm->random_seed))) *
211 bs->transmit_interval_nsec;
212 if (bs->tx_timeout_nsec < now)
215 * the timeout is in the past, which means that either remote
216 * demand mode was set or performance/clock issues ...
218 BFD_DBG ("Missed %lu transmit events (now is %lu, calc "
219 "tx_timeout is %lu)",
220 (now - bs->tx_timeout_nsec) /
221 bs->transmit_interval_nsec, now, bs->tx_timeout_nsec);
222 bs->tx_timeout_nsec = now;
227 /* special case - 75-90% of transmit interval */
228 bs->tx_timeout_nsec = bs->last_tx_nsec +
229 (.9 - .15 * (random_f64 (&bm->random_seed))) *
230 bs->transmit_interval_nsec;
231 if (bs->tx_timeout_nsec < now)
234 * the timeout is in the past, which means that either remote
235 * demand mode was set or performance/clock issues ...
237 BFD_DBG ("Missed %lu transmit events (now is %lu, calc "
238 "tx_timeout is %lu)",
239 (now - bs->tx_timeout_nsec) /
240 bs->transmit_interval_nsec, now, bs->tx_timeout_nsec);
241 bs->tx_timeout_nsec = now;
244 if (bs->tx_timeout_nsec)
246 BFD_DBG ("Next transmit in %lu nsec/%.02fs@%lu",
247 bs->tx_timeout_nsec - now,
248 (bs->tx_timeout_nsec - now) * SEC_PER_NSEC,
249 bs->tx_timeout_nsec);
254 bfd_calc_next_echo_tx (bfd_session_t *bs, u64 now)
256 bs->echo_tx_timeout_nsec =
257 bs->echo_last_tx_nsec + bs->echo_transmit_interval_nsec;
258 if (bs->echo_tx_timeout_nsec < now)
260 /* huh, we've missed it already, transmit now */
261 BFD_DBG ("Missed %lu echo transmit events (now is %lu, calc tx_timeout "
263 (now - bs->echo_tx_timeout_nsec) /
264 bs->echo_transmit_interval_nsec,
265 now, bs->echo_tx_timeout_nsec);
266 bs->echo_tx_timeout_nsec = now;
268 BFD_DBG ("Next echo transmit in %lu nsec/%.02fs@%lu",
269 bs->echo_tx_timeout_nsec - now,
270 (bs->echo_tx_timeout_nsec - now) * SEC_PER_NSEC,
271 bs->echo_tx_timeout_nsec);
275 bfd_recalc_detection_time (bfd_session_t *bs)
277 if (bs->local_state == BFD_STATE_init || bs->local_state == BFD_STATE_up)
279 bs->detection_time_nsec =
280 bs->remote_detect_mult *
281 clib_max (bs->effective_required_min_rx_nsec,
282 bs->remote_desired_min_tx_nsec);
283 BFD_DBG ("Recalculated detection time %lu nsec/%.3fs",
284 bs->detection_time_nsec,
285 bs->detection_time_nsec * SEC_PER_NSEC);
290 bfd_set_timer (bfd_main_t * bm, bfd_session_t * bs, u64 now,
296 if (BFD_STATE_up == bs->local_state)
298 rx_timeout = bs->last_rx_nsec + bs->detection_time_nsec;
300 if (BFD_STATE_up != bs->local_state ||
301 (!bs->remote_demand && bs->remote_min_rx_usec) ||
302 BFD_POLL_NOT_NEEDED != bs->poll_state)
304 tx_timeout = bs->tx_timeout_nsec;
306 if (tx_timeout && rx_timeout)
308 next = clib_min (tx_timeout, rx_timeout);
318 if (bs->echo && next > bs->echo_tx_timeout_nsec)
320 next = bs->echo_tx_timeout_nsec;
322 BFD_DBG ("bs_idx=%u, tx_timeout=%lu, echo_tx_timeout=%lu, rx_timeout=%lu, "
324 bs->bs_idx, tx_timeout, bs->echo_tx_timeout_nsec, rx_timeout,
326 ? "tx" : (next == bs->echo_tx_timeout_nsec ? "echo tx" : "rx"));
330 bs->event_time_nsec = next;
331 /* add extra tick if it's not even */
332 u32 wheel_time_ticks =
333 (bs->event_time_nsec - now) / bm->nsec_per_tw_tick +
334 ((bs->event_time_nsec - now) % bm->nsec_per_tw_tick != 0);
335 BFD_DBG ("event_time_nsec %lu (%lu nsec/%.3fs in future) -> "
336 "wheel_time_ticks %u", bs->event_time_nsec,
337 bs->event_time_nsec - now,
338 (bs->event_time_nsec - now) * SEC_PER_NSEC, wheel_time_ticks);
339 wheel_time_ticks = wheel_time_ticks ? wheel_time_ticks : 1;
343 TW (tw_timer_update) (&bm->wheel, bs->tw_id, wheel_time_ticks);
344 BFD_DBG ("tw_timer_update(%p, %u, %lu);", &bm->wheel, bs->tw_id,
350 TW (tw_timer_start) (&bm->wheel, bs->bs_idx, 0, wheel_time_ticks);
351 BFD_DBG ("tw_timer_start(%p, %u, 0, %lu) == %u;", &bm->wheel,
352 bs->bs_idx, wheel_time_ticks);
355 if (!handling_wakeup)
358 /* Send only if it is earlier than current awaited wakeup time */
360 (bs->event_time_nsec < bm->bfd_process_next_wakeup_nsec) &&
362 * If the wake-up time is within 2x the delay of the event propagation delay,
363 * avoid the expense of sending the event. The 2x multiplier is to workaround the race whereby
364 * simultaneous event + expired timer create one recurring bogus wakeup/suspend instance,
365 * due to double scheduling of the node on the pending list.
367 (bm->bfd_process_next_wakeup_nsec - bs->event_time_nsec >
368 2 * bm->bfd_process_wakeup_event_delay_nsec) &&
369 /* Must be no events in flight to send an event */
370 (!bm->bfd_process_wakeup_events_in_flight);
372 /* If we do send the signal, note this down along with the start timestamp */
375 bm->bfd_process_wakeup_events_in_flight++;
376 bm->bfd_process_wakeup_event_start_nsec = now;
381 /* Use the multithreaded event sending so the workers can send events too */
384 vlib_process_signal_event_mt (bm->vlib_main,
385 bm->bfd_process_node_index,
386 BFD_EVENT_RESCHEDULE, ~0);
392 bfd_set_effective_desired_min_tx (bfd_main_t * bm,
393 bfd_session_t * bs, u64 now,
394 u64 desired_min_tx_nsec)
396 bs->effective_desired_min_tx_nsec = desired_min_tx_nsec;
397 BFD_DBG ("Set effective desired min tx to " BFD_CLK_FMT,
398 BFD_CLK_PRN (bs->effective_desired_min_tx_nsec));
399 bfd_recalc_detection_time (bs);
400 bfd_recalc_tx_interval (bs);
401 bfd_recalc_echo_tx_interval (bs);
402 bfd_calc_next_tx (bm, bs, now);
406 bfd_set_effective_required_min_rx (bfd_session_t *bs, u64 required_min_rx_nsec)
408 bs->effective_required_min_rx_nsec = required_min_rx_nsec;
409 BFD_DBG ("Set effective required min rx to " BFD_CLK_FMT,
410 BFD_CLK_PRN (bs->effective_required_min_rx_nsec));
411 bfd_recalc_detection_time (bs);
415 bfd_set_remote_required_min_rx (bfd_session_t *bs,
416 u32 remote_required_min_rx_usec)
418 if (bs->remote_min_rx_usec != remote_required_min_rx_usec)
420 bs->remote_min_rx_usec = remote_required_min_rx_usec;
421 bs->remote_min_rx_nsec = bfd_usec_to_nsec (remote_required_min_rx_usec);
422 BFD_DBG ("Set remote min rx to " BFD_CLK_FMT,
423 BFD_CLK_PRN (bs->remote_min_rx_nsec));
424 bfd_recalc_detection_time (bs);
425 bfd_recalc_tx_interval (bs);
430 bfd_set_remote_required_min_echo_rx (bfd_session_t *bs,
431 u32 remote_required_min_echo_rx_usec)
433 if (bs->remote_min_echo_rx_usec != remote_required_min_echo_rx_usec)
435 bs->remote_min_echo_rx_usec = remote_required_min_echo_rx_usec;
436 bs->remote_min_echo_rx_nsec =
437 bfd_usec_to_nsec (bs->remote_min_echo_rx_usec);
438 BFD_DBG ("Set remote min echo rx to " BFD_CLK_FMT,
439 BFD_CLK_PRN (bs->remote_min_echo_rx_nsec));
440 bfd_recalc_echo_tx_interval (bs);
445 bfd_notify_listeners (bfd_main_t * bm,
446 bfd_listen_event_e event, const bfd_session_t * bs)
449 vec_foreach (fn, bm->listeners)
456 bfd_session_start (bfd_main_t * bm, bfd_session_t * bs)
458 BFD_DBG ("\nStarting session: %U", format_bfd_session, bs);
459 vlib_log_info (bm->log_class, "start BFD session: %U",
460 format_bfd_session_brief, bs);
461 bfd_set_effective_required_min_rx (bs, bs->config_required_min_rx_nsec);
462 bfd_recalc_tx_interval (bs);
463 vlib_process_signal_event (bm->vlib_main, bm->bfd_process_node_index,
464 BFD_EVENT_NEW_SESSION, bs->bs_idx);
465 bfd_notify_listeners (bm, BFD_LISTEN_EVENT_CREATE, bs);
469 bfd_session_stop (bfd_main_t *bm, bfd_session_t *bs)
471 BFD_DBG ("\nStopping session: %U", format_bfd_session, bs);
472 bfd_notify_listeners (bm, BFD_LISTEN_EVENT_DELETE, bs);
476 bfd_session_set_flags (vlib_main_t * vm, bfd_session_t * bs, u8 admin_up_down)
478 bfd_main_t *bm = &bfd_main;
479 u64 now = bfd_time_now_nsec (vm, NULL);
482 BFD_DBG ("Session set admin-up, bs-idx=%u", bs->bs_idx);
483 vlib_log_info (bm->log_class, "set session admin-up: %U",
484 format_bfd_session_brief, bs);
485 bfd_set_state (vm, bm, bs, BFD_STATE_down, 0);
486 bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
487 bfd_calc_next_tx (bm, bs, now);
488 bfd_set_timer (bm, bs, now, 0);
492 BFD_DBG ("Session set admin-down, bs-idx=%u", bs->bs_idx);
493 vlib_log_info (bm->log_class, "set session admin-down: %U",
494 format_bfd_session_brief, bs);
495 bfd_set_diag (bs, BFD_DIAG_CODE_admin_down);
496 bfd_set_state (vm, bm, bs, BFD_STATE_admin_down, 0);
497 bfd_calc_next_tx (bm, bs, now);
498 bfd_set_timer (bm, bs, now, 0);
503 bfd_input_format_trace (u8 * s, va_list * args)
505 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
506 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
507 const bfd_input_trace_t *t = va_arg (*args, bfd_input_trace_t *);
508 const bfd_pkt_t *pkt = (bfd_pkt_t *) t->data;
509 if (t->len > STRUCT_SIZE_OF (bfd_pkt_t, head))
511 s = format (s, "BFD v%u, diag=%u(%s), state=%u(%s),\n"
512 " flags=(P:%u, F:%u, C:%u, A:%u, D:%u, M:%u), "
513 "detect_mult=%u, length=%u\n",
514 bfd_pkt_get_version (pkt), bfd_pkt_get_diag_code (pkt),
515 bfd_diag_code_string (bfd_pkt_get_diag_code (pkt)),
516 bfd_pkt_get_state (pkt),
517 bfd_state_string (bfd_pkt_get_state (pkt)),
518 bfd_pkt_get_poll (pkt), bfd_pkt_get_final (pkt),
519 bfd_pkt_get_control_plane_independent (pkt),
520 bfd_pkt_get_auth_present (pkt), bfd_pkt_get_demand (pkt),
521 bfd_pkt_get_multipoint (pkt), pkt->head.detect_mult,
523 if (t->len >= sizeof (bfd_pkt_t) &&
524 pkt->head.length >= sizeof (bfd_pkt_t))
526 s = format (s, " my discriminator: %u\n",
527 clib_net_to_host_u32 (pkt->my_disc));
528 s = format (s, " your discriminator: %u\n",
529 clib_net_to_host_u32 (pkt->your_disc));
530 s = format (s, " desired min tx interval: %u\n",
531 clib_net_to_host_u32 (pkt->des_min_tx));
532 s = format (s, " required min rx interval: %u\n",
533 clib_net_to_host_u32 (pkt->req_min_rx));
534 s = format (s, " required min echo rx interval: %u",
535 clib_net_to_host_u32 (pkt->req_min_echo_rx));
537 if (t->len >= sizeof (bfd_pkt_with_common_auth_t) &&
538 pkt->head.length >= sizeof (bfd_pkt_with_common_auth_t) &&
539 bfd_pkt_get_auth_present (pkt))
541 const bfd_pkt_with_common_auth_t *with_auth = (void *) pkt;
542 const bfd_auth_common_t *common = &with_auth->common_auth;
543 s = format (s, "\n auth len: %u\n", common->len);
544 s = format (s, " auth type: %u:%s\n", common->type,
545 bfd_auth_type_str (common->type));
546 if (t->len >= sizeof (bfd_pkt_with_sha1_auth_t) &&
547 pkt->head.length >= sizeof (bfd_pkt_with_sha1_auth_t) &&
548 (BFD_AUTH_TYPE_keyed_sha1 == common->type ||
549 BFD_AUTH_TYPE_meticulous_keyed_sha1 == common->type))
551 const bfd_pkt_with_sha1_auth_t *with_sha1 = (void *) pkt;
552 const bfd_auth_sha1_t *sha1 = &with_sha1->sha1_auth;
553 s = format (s, " seq num: %u\n",
554 clib_net_to_host_u32 (sha1->seq_num));
555 s = format (s, " key id: %u\n", sha1->key_id);
556 s = format (s, " hash: %U", format_hex_bytes, sha1->hash,
557 sizeof (sha1->hash));
562 s = format (s, "\n");
575 bfd_rpc_event_cb (const bfd_rpc_event_t * a)
577 bfd_main_t *bm = &bfd_main;
578 u32 bs_idx = a->bs_idx;
580 bfd_session_t session_data;
583 if (!pool_is_free_index (bm->sessions, bs_idx))
585 bfd_session_t *bs = pool_elt_at_index (bm->sessions, bs_idx);
586 clib_memcpy (&session_data, bs, sizeof (bfd_session_t));
591 BFD_DBG ("Ignoring event RPC for non-existent session index %u",
597 bfd_event (bm, &session_data);
601 bfd_event_rpc (u32 bs_idx)
603 const u32 data_size = sizeof (bfd_rpc_event_t);
605 bfd_rpc_event_t *event = (bfd_rpc_event_t *) data;
607 event->bs_idx = bs_idx;
608 vl_api_rpc_call_main_thread (bfd_rpc_event_cb, data, data_size);
614 } bfd_rpc_notify_listeners_t;
617 bfd_rpc_notify_listeners_cb (const bfd_rpc_notify_listeners_t * a)
619 bfd_main_t *bm = &bfd_main;
620 u32 bs_idx = a->bs_idx;
622 if (!pool_is_free_index (bm->sessions, bs_idx))
624 bfd_session_t *bs = pool_elt_at_index (bm->sessions, bs_idx);
625 bfd_notify_listeners (bm, BFD_LISTEN_EVENT_UPDATE, bs);
629 BFD_DBG ("Ignoring notify RPC for non-existent session index %u",
636 bfd_notify_listeners_rpc (u32 bs_idx)
638 const u32 data_size = sizeof (bfd_rpc_notify_listeners_t);
640 bfd_rpc_notify_listeners_t *notify = (bfd_rpc_notify_listeners_t *) data;
641 notify->bs_idx = bs_idx;
642 vl_api_rpc_call_main_thread (bfd_rpc_notify_listeners_cb, data, data_size);
646 bfd_on_state_change (bfd_main_t * bm, bfd_session_t * bs, u64 now,
649 BFD_DBG ("\nState changed: %U", format_bfd_session, bs);
651 if (vlib_get_thread_index () == 0)
657 /* without RPC - a REGRESSION: BFD event are not propagated */
658 bfd_event_rpc (bs->bs_idx);
661 switch (bs->local_state)
663 case BFD_STATE_admin_down:
665 bfd_set_effective_desired_min_tx (bm, bs, now,
667 (bs->config_desired_min_tx_nsec,
668 bm->default_desired_min_tx_nsec));
669 bfd_set_effective_required_min_rx (bs, bs->config_required_min_rx_nsec);
670 bfd_set_timer (bm, bs, now, handling_wakeup);
674 bfd_set_effective_desired_min_tx (bm, bs, now,
676 (bs->config_desired_min_tx_nsec,
677 bm->default_desired_min_tx_nsec));
678 bfd_set_effective_required_min_rx (bs, bs->config_required_min_rx_nsec);
679 bfd_set_timer (bm, bs, now, handling_wakeup);
683 bfd_set_effective_desired_min_tx (bm, bs, now,
684 bs->config_desired_min_tx_nsec);
685 bfd_set_timer (bm, bs, now, handling_wakeup);
688 bfd_set_effective_desired_min_tx (bm, bs, now,
689 bs->config_desired_min_tx_nsec);
690 if (BFD_POLL_NOT_NEEDED == bs->poll_state)
692 bfd_set_effective_required_min_rx (bs,
693 bs->config_required_min_rx_nsec);
695 bfd_set_timer (bm, bs, now, handling_wakeup);
698 if (vlib_get_thread_index () == 0)
700 bfd_notify_listeners (bm, BFD_LISTEN_EVENT_UPDATE, bs);
704 /* without RPC - a REGRESSION: state changes are not propagated */
705 bfd_notify_listeners_rpc (bs->bs_idx);
710 bfd_on_config_change (bfd_main_t *bm, bfd_session_t *bs, u64 now)
713 * if remote demand mode is set and we need to do a poll, set the next
714 * timeout so that the session wakes up immediately
716 if (bs->remote_demand && BFD_POLL_NEEDED == bs->poll_state &&
717 bs->poll_state_start_or_timeout_nsec < now)
719 bs->tx_timeout_nsec = now;
721 bfd_recalc_detection_time (bs);
722 bfd_set_timer (bm, bs, now, 0);
726 bfd_add_transport_layer (vlib_main_t * vm, u32 bi, bfd_session_t * bs)
728 switch (bs->transport)
730 case BFD_TRANSPORT_UDP4:
731 BFD_DBG ("Transport bfd via udp4, bs_idx=%u", bs->bs_idx);
732 bfd_add_udp4_transport (vm, bi, bs, 0 /* is_echo */ );
734 case BFD_TRANSPORT_UDP6:
735 BFD_DBG ("Transport bfd via udp6, bs_idx=%u", bs->bs_idx);
736 bfd_add_udp6_transport (vm, bi, bs, 0 /* is_echo */ );
742 bfd_transport_control_frame (vlib_main_t * vm, u32 bi, bfd_session_t * bs)
744 switch (bs->transport)
746 case BFD_TRANSPORT_UDP4:
747 BFD_DBG ("Transport bfd via udp4, bs_idx=%u", bs->bs_idx);
748 return bfd_transport_udp4 (vm, bi, bs, 0 /* is_echo */);
750 case BFD_TRANSPORT_UDP6:
751 BFD_DBG ("Transport bfd via udp6, bs_idx=%u", bs->bs_idx);
752 return bfd_transport_udp6 (vm, bi, bs, 0 /* is_echo */);
759 bfd_echo_add_transport_layer (vlib_main_t * vm, u32 bi, bfd_session_t * bs)
761 switch (bs->transport)
763 case BFD_TRANSPORT_UDP4:
764 BFD_DBG ("Transport bfd echo via udp4, bs_idx=%u", bs->bs_idx);
765 return bfd_add_udp4_transport (vm, bi, bs, 1 /* is_echo */ );
767 case BFD_TRANSPORT_UDP6:
768 BFD_DBG ("Transport bfd echo via udp6, bs_idx=%u", bs->bs_idx);
769 return bfd_add_udp6_transport (vm, bi, bs, 1 /* is_echo */ );
776 bfd_transport_echo (vlib_main_t * vm, u32 bi, bfd_session_t * bs)
778 switch (bs->transport)
780 case BFD_TRANSPORT_UDP4:
781 BFD_DBG ("Transport bfd echo via udp4, bs_idx=%u", bs->bs_idx);
782 return bfd_transport_udp4 (vm, bi, bs, 1 /* is_echo */);
784 case BFD_TRANSPORT_UDP6:
785 BFD_DBG ("Transport bfd echo via udp6, bs_idx=%u", bs->bs_idx);
786 return bfd_transport_udp6 (vm, bi, bs, 1 /* is_echo */);
793 bfd_add_sha1_auth_section (vlib_main_t *vm, vlib_buffer_t *b,
796 bfd_pkt_with_sha1_auth_t *pkt = vlib_buffer_get_current (b);
797 bfd_auth_sha1_t *auth = &pkt->sha1_auth;
798 b->current_length += sizeof (*auth);
799 pkt->pkt.head.length += sizeof (*auth);
800 bfd_pkt_set_auth_present (&pkt->pkt);
801 clib_memset (auth, 0, sizeof (*auth));
802 auth->type_len.type = bs->auth.curr_key->auth_type;
804 * only meticulous authentication types require incrementing seq number
805 * for every message, but doing so doesn't violate the RFC
807 ++bs->auth.local_seq_number;
808 auth->type_len.len = sizeof (bfd_auth_sha1_t);
809 auth->key_id = bs->auth.curr_bfd_key_id;
810 auth->seq_num = clib_host_to_net_u32 (bs->auth.local_seq_number);
812 * first copy the password into the packet, then calculate the hash
813 * and finally replace the password with the calculated hash
815 clib_memcpy (auth->hash, bs->auth.curr_key->key,
816 sizeof (bs->auth.curr_key->key));
817 unsigned char hash[sizeof (auth->hash)];
820 vnet_crypto_op_init (&op, VNET_CRYPTO_OP_SHA1_HASH);
822 op.len = sizeof (*pkt);
824 vnet_crypto_process_ops (vm, &op, 1);
825 BFD_DBG ("hashing: %U", format_hex_bytes, pkt, sizeof (*pkt));
826 clib_memcpy (auth->hash, hash, sizeof (hash));
830 bfd_add_auth_section (vlib_main_t *vm, vlib_buffer_t *b, bfd_session_t *bs)
832 bfd_main_t *bm = &bfd_main;
833 if (bs->auth.curr_key)
835 const bfd_auth_type_e auth_type = bs->auth.curr_key->auth_type;
838 case BFD_AUTH_TYPE_reserved:
840 case BFD_AUTH_TYPE_simple_password:
842 case BFD_AUTH_TYPE_keyed_md5:
844 case BFD_AUTH_TYPE_meticulous_keyed_md5:
845 vlib_log_crit (bm->log_class,
846 "internal error, unexpected BFD auth type '%d'",
849 case BFD_AUTH_TYPE_keyed_sha1:
851 case BFD_AUTH_TYPE_meticulous_keyed_sha1:
852 bfd_add_sha1_auth_section (vm, b, bs);
859 bfd_is_echo_possible (bfd_session_t * bs)
861 if (BFD_STATE_up == bs->local_state && BFD_STATE_up == bs->remote_state &&
862 bs->remote_min_echo_rx_usec > 0)
864 switch (bs->transport)
866 case BFD_TRANSPORT_UDP4:
867 return bfd_udp_is_echo_available (BFD_TRANSPORT_UDP4);
868 case BFD_TRANSPORT_UDP6:
869 return bfd_udp_is_echo_available (BFD_TRANSPORT_UDP6);
876 bfd_init_control_frame (bfd_session_t *bs, vlib_buffer_t *b)
878 bfd_pkt_t *pkt = vlib_buffer_get_current (b);
880 bfd_length = sizeof (bfd_pkt_t);
881 clib_memset (pkt, 0, sizeof (*pkt));
882 bfd_pkt_set_version (pkt, 1);
883 bfd_pkt_set_diag_code (pkt, bs->local_diag);
884 bfd_pkt_set_state (pkt, bs->local_state);
885 pkt->head.detect_mult = bs->local_detect_mult;
886 pkt->head.length = bfd_length;
887 pkt->my_disc = bs->local_discr;
888 pkt->your_disc = bs->remote_discr;
889 pkt->des_min_tx = clib_host_to_net_u32 (bs->config_desired_min_tx_usec);
893 clib_host_to_net_u32 (bfd_nsec_to_usec
894 (bs->effective_required_min_rx_nsec));
899 clib_host_to_net_u32 (bs->config_required_min_rx_usec);
901 pkt->req_min_echo_rx = clib_host_to_net_u32 (1);
902 b->current_length = bfd_length;
906 bfd_send_echo (vlib_main_t *vm, bfd_main_t *bm, bfd_session_t *bs, u64 now)
908 if (!bfd_is_echo_possible (bs))
910 BFD_DBG ("\nSwitching off echo function: %U", format_bfd_session, bs);
914 if (now >= bs->echo_tx_timeout_nsec)
916 BFD_DBG ("\nSending echo packet: %U", format_bfd_session, bs);
918 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
920 vlib_log_crit (bm->log_class, "buffer allocation failure");
923 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
924 ASSERT (b->current_data == 0);
925 bfd_echo_pkt_t *pkt = vlib_buffer_get_current (b);
926 clib_memset (pkt, 0, sizeof (*pkt));
927 pkt->discriminator = bs->local_discr;
928 pkt->expire_time_nsec =
929 now + bs->echo_transmit_interval_nsec * bs->local_detect_mult;
931 bfd_calc_echo_checksum (bs->local_discr, pkt->expire_time_nsec,
933 b->current_length = sizeof (*pkt);
934 if (!bfd_echo_add_transport_layer (vm, bi, bs))
936 BFD_ERR ("cannot send echo packet out, turning echo off");
938 vlib_buffer_free_one (vm, bi);
941 if (!bfd_transport_echo (vm, bi, bs))
943 BFD_ERR ("cannot send echo packet out, turning echo off");
945 vlib_buffer_free_one (vm, bi);
948 bs->echo_last_tx_nsec = now;
949 bfd_calc_next_echo_tx (bs, now);
954 ("No need to send echo packet now, now is %lu, tx_timeout is %lu",
955 now, bs->echo_tx_timeout_nsec);
960 bfd_send_periodic (vlib_main_t *vm, bfd_main_t *bm, bfd_session_t *bs, u64 now)
962 if (!bs->remote_min_rx_usec && BFD_POLL_NOT_NEEDED == bs->poll_state)
964 BFD_DBG ("Remote min rx interval is zero, not sending periodic control "
968 if (BFD_POLL_NOT_NEEDED == bs->poll_state && bs->remote_demand &&
969 BFD_STATE_up == bs->local_state && BFD_STATE_up == bs->remote_state)
972 * A system MUST NOT periodically transmit BFD Control packets if Demand
973 * mode is active on the remote system (bfd.RemoteDemandMode is 1,
974 * bfd.SessionState is Up, and bfd.RemoteSessionState is Up) and a Poll
975 * Sequence is not being transmitted.
977 BFD_DBG ("Remote demand is set, not sending periodic control frame");
980 if (now >= bs->tx_timeout_nsec)
982 BFD_DBG ("\nSending periodic control frame: %U", format_bfd_session,
985 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
987 vlib_log_crit (bm->log_class, "buffer allocation failure");
990 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
991 ASSERT (b->current_data == 0);
992 bfd_init_control_frame (bs, b);
993 switch (bs->poll_state)
995 case BFD_POLL_NEEDED:
996 if (now < bs->poll_state_start_or_timeout_nsec)
998 BFD_DBG ("Cannot start a poll sequence yet, need to wait for "
1000 BFD_CLK_PRN (bs->poll_state_start_or_timeout_nsec -
1004 bs->poll_state_start_or_timeout_nsec = now;
1005 bfd_set_poll_state (bs, BFD_POLL_IN_PROGRESS);
1007 case BFD_POLL_IN_PROGRESS:
1008 case BFD_POLL_IN_PROGRESS_AND_QUEUED:
1009 bfd_pkt_set_poll (vlib_buffer_get_current (b));
1010 BFD_DBG ("Setting poll bit in packet, bs_idx=%u", bs->bs_idx);
1012 case BFD_POLL_NOT_NEEDED:
1016 bfd_add_auth_section (vm, b, bs);
1017 bfd_add_transport_layer (vm, bi, bs);
1018 if (!bfd_transport_control_frame (vm, bi, bs))
1020 vlib_buffer_free_one (vm, bi);
1022 bs->last_tx_nsec = now;
1023 bfd_calc_next_tx (bm, bs, now);
1028 ("No need to send control frame now, now is %lu, tx_timeout is %lu",
1029 now, bs->tx_timeout_nsec);
1034 bfd_init_final_control_frame (vlib_main_t *vm, vlib_buffer_t *b,
1037 BFD_DBG ("Send final control frame for bs_idx=%lu", bs->bs_idx);
1038 bfd_init_control_frame (bs, b);
1039 bfd_pkt_set_final (vlib_buffer_get_current (b));
1040 bfd_add_auth_section (vm, b, bs);
1041 u32 bi = vlib_get_buffer_index (vm, b);
1042 bfd_add_transport_layer (vm, bi, bs);
1043 bs->last_tx_nsec = bfd_time_now_nsec (vm, NULL);
1045 * RFC allows to include changes in final frame, so if there were any
1046 * pending, we already did that, thus we can clear any pending poll needs
1048 bfd_set_poll_state (bs, BFD_POLL_NOT_NEEDED);
1052 bfd_check_rx_timeout (vlib_main_t * vm, bfd_main_t * bm, bfd_session_t * bs,
1053 u64 now, int handling_wakeup)
1055 if (bs->last_rx_nsec + bs->detection_time_nsec <= now)
1057 BFD_DBG ("Rx timeout, session goes down");
1059 * RFC 5880 6.8.1. State Variables
1063 * The remote discriminator for this BFD session. This is the
1064 * discriminator chosen by the remote system, and is totally opaque
1065 * to the local system. This MUST be initialized to zero. If a
1066 * period of a Detection Time passes without the receipt of a valid,
1067 * authenticated BFD packet from the remote system, this variable
1068 * MUST be set to zero.
1070 bs->remote_discr = 0;
1071 bfd_set_diag (bs, BFD_DIAG_CODE_det_time_exp);
1072 bfd_set_state (vm, bm, bs, BFD_STATE_down, handling_wakeup);
1074 * If the remote system does not receive any
1075 * BFD Control packets for a Detection Time, it SHOULD reset
1076 * bfd.RemoteMinRxInterval to its initial value of 1 (per section 6.8.1,
1077 * since it is no longer required to maintain previous session state)
1078 * and then can transmit at its own rate.
1080 bfd_set_remote_required_min_rx (bs, 1);
1083 && bs->echo_last_rx_nsec +
1084 bs->echo_transmit_interval_nsec * bs->local_detect_mult <= now)
1086 BFD_DBG ("Echo rx timeout, session goes down");
1087 bfd_set_diag (bs, BFD_DIAG_CODE_echo_failed);
1088 bfd_set_state (vm, bm, bs, BFD_STATE_down, handling_wakeup);
1093 bfd_on_timeout (vlib_main_t *vm, bfd_main_t *bm, bfd_session_t *bs, u64 now)
1095 BFD_DBG ("Timeout for bs_idx=%lu", bs->bs_idx);
1096 switch (bs->local_state)
1098 case BFD_STATE_admin_down:
1100 case BFD_STATE_down:
1101 bfd_send_periodic (vm, bm, bs, now);
1103 case BFD_STATE_init:
1104 bfd_check_rx_timeout (vm, bm, bs, now, 1);
1105 bfd_send_periodic (vm, bm, bs, now);
1108 bfd_check_rx_timeout (vm, bm, bs, now, 1);
1109 if (BFD_POLL_NOT_NEEDED == bs->poll_state && !bs->echo &&
1110 bfd_is_echo_possible (bs))
1112 /* switch on echo function as main detection method now */
1113 BFD_DBG ("Switching on echo function, bs_idx=%u", bs->bs_idx);
1115 bs->echo_last_rx_nsec = now;
1116 bs->echo_tx_timeout_nsec = now;
1117 bfd_set_effective_required_min_rx (
1118 bs, clib_max (bm->min_required_min_rx_while_echo_nsec,
1119 bs->config_required_min_rx_nsec));
1120 bfd_set_poll_state (bs, BFD_POLL_NEEDED);
1122 bfd_send_periodic (vm, bm, bs, now);
1125 bfd_send_echo (vm, bm, bs, now);
1132 * bfd process node function
1135 bfd_process (vlib_main_t *vm, CLIB_UNUSED (vlib_node_runtime_t *rt),
1136 CLIB_UNUSED (vlib_frame_t *f))
1138 bfd_main_t *bm = &bfd_main;
1140 uword event_type, *event_data = 0;
1142 /* So we can send events to the bfd process */
1143 bm->bfd_process_node_index = bfd_process_node.index;
1148 u64 now = bfd_time_now_nsec (vm, &vm_time);
1149 BFD_DBG ("wakeup, now is %llunsec, vlib_time_now() is %.9f", now,
1153 if (pool_elts (bm->sessions))
1155 u32 first_expires_in_ticks =
1156 TW (tw_timer_first_expires_in_ticks) (&bm->wheel);
1157 if (!first_expires_in_ticks)
1160 ("tw_timer_first_expires_in_ticks(%p) returns 0ticks",
1162 timeout = bm->wheel.next_run_time - vm_time;
1163 BFD_DBG ("wheel.next_run_time is %.9f",
1164 bm->wheel.next_run_time);
1165 u64 next_expire_nsec = now + timeout * SEC_PER_NSEC;
1166 bm->bfd_process_next_wakeup_nsec = next_expire_nsec;
1171 BFD_DBG ("tw_timer_first_expires_in_ticks(%p) returns %luticks",
1172 &bm->wheel, first_expires_in_ticks);
1173 u64 next_expire_nsec =
1174 now + first_expires_in_ticks * bm->nsec_per_tw_tick;
1175 bm->bfd_process_next_wakeup_nsec = next_expire_nsec;
1177 ASSERT (next_expire_nsec - now <= UINT32_MAX);
1178 // cast to u32 to avoid warning
1179 timeout = (u32) (next_expire_nsec - now) * SEC_PER_NSEC;
1181 BFD_DBG ("vlib_process_wait_for_event_or_clock(vm, %.09f)",
1183 (void) vlib_process_wait_for_event_or_clock (vm, timeout);
1188 (void) vlib_process_wait_for_event (vm);
1190 event_type = vlib_process_get_events (vm, &event_data);
1191 now = bfd_time_now_nsec (vm, &vm_time);
1192 uword *session_index;
1195 case ~0: /* no events => timeout */
1196 /* nothing to do here */
1198 case BFD_EVENT_RESCHEDULE:
1199 BFD_DBG ("reschedule event");
1201 bm->bfd_process_wakeup_event_delay_nsec =
1202 now - bm->bfd_process_wakeup_event_start_nsec;
1203 bm->bfd_process_wakeup_events_in_flight--;
1205 /* nothing to do here - reschedule is done automatically after
1206 * each event or timeout */
1208 case BFD_EVENT_NEW_SESSION:
1209 vec_foreach (session_index, event_data)
1212 if (!pool_is_free_index (bm->sessions, *session_index))
1215 pool_elt_at_index (bm->sessions, *session_index);
1216 bfd_send_periodic (vm, bm, bs, now);
1217 bfd_set_timer (bm, bs, now, 1);
1221 BFD_DBG ("Ignoring event for non-existent session index %u",
1222 (u32) * session_index);
1227 case BFD_EVENT_CONFIG_CHANGED:
1228 vec_foreach (session_index, event_data)
1231 if (!pool_is_free_index (bm->sessions, *session_index))
1234 pool_elt_at_index (bm->sessions, *session_index);
1235 bfd_on_config_change (bm, bs, now);
1239 BFD_DBG ("Ignoring event for non-existent session index %u",
1240 (u32) * session_index);
1246 vlib_log_err (bm->log_class, "BUG: event type 0x%wx", event_type);
1249 BFD_DBG ("tw_timer_expire_timers_vec(%p, %.04f);", &bm->wheel, vm_time);
1252 TW (tw_timer_expire_timers_vec) (&bm->wheel, vm_time, expired);
1253 BFD_DBG ("Expired %d elements", vec_len (expired));
1255 vec_foreach (p, expired)
1257 const u32 bs_idx = *p;
1258 if (!pool_is_free_index (bm->sessions, bs_idx))
1260 bfd_session_t *bs = pool_elt_at_index (bm->sessions, bs_idx);
1261 bs->tw_id = 0; /* timer is gone because it expired */
1262 bfd_on_timeout (vm, bm, bs, now);
1263 bfd_set_timer (bm, bs, now, 1);
1269 vec_set_len (expired, 0);
1273 vec_set_len (event_data, 0);
1281 * bfd process node declaration
1283 VLIB_REGISTER_NODE (bfd_process_node, static) = {
1284 .function = bfd_process,
1285 .type = VLIB_NODE_TYPE_PROCESS,
1286 .name = "bfd-process",
1291 static clib_error_t *
1292 bfd_sw_interface_up_down (CLIB_UNUSED (vnet_main_t *vnm),
1293 CLIB_UNUSED (u32 sw_if_index), u32 flags)
1295 // bfd_main_t *bm = &bfd_main;
1296 // vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
1297 if (!(flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
1304 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (bfd_sw_interface_up_down);
1306 static clib_error_t *
1307 bfd_hw_interface_up_down (CLIB_UNUSED (vnet_main_t *vnm),
1308 CLIB_UNUSED (u32 hw_if_index), u32 flags)
1310 // bfd_main_t *bm = &bfd_main;
1311 if (flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
1318 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION (bfd_hw_interface_up_down);
1321 bfd_register_listener (bfd_notify_fn_t fn)
1323 bfd_main_t *bm = &bfd_main;
1325 vec_add1 (bm->listeners, fn);
1331 static clib_error_t *
1332 bfd_main_init (vlib_main_t * vm)
1334 vlib_thread_main_t *tm = &vlib_thread_main;
1335 u32 n_vlib_mains = tm->n_vlib_mains;
1337 setbuf (stdout, NULL);
1339 bfd_main_t *bm = &bfd_main;
1340 bm->random_seed = random_default_seed ();
1342 bm->vnet_main = vnet_get_main ();
1343 clib_memset (&bm->wheel, 0, sizeof (bm->wheel));
1344 bm->nsec_per_tw_tick = (f64) NSEC_PER_SEC / BFD_TW_TPS;
1345 bm->default_desired_min_tx_nsec =
1346 bfd_usec_to_nsec (BFD_DEFAULT_DESIRED_MIN_TX_USEC);
1347 bm->min_required_min_rx_while_echo_nsec =
1348 bfd_usec_to_nsec (BFD_REQUIRED_MIN_RX_USEC_WHILE_ECHO);
1349 BFD_DBG ("tw_timer_wheel_init(%p, %p, %.04f, %u)", &bm->wheel, NULL,
1350 1.00 / BFD_TW_TPS, ~0);
1351 TW (tw_timer_wheel_init) (&bm->wheel, NULL, 1.00 / BFD_TW_TPS, ~0);
1352 bm->log_class = vlib_log_register_class ("bfd", 0);
1353 vlib_log_debug (bm->log_class, "initialized");
1354 bm->owner_thread_index = ~0;
1355 if (n_vlib_mains > 1)
1356 clib_spinlock_init (&bm->lock);
1357 bm->rx_counter.name = "bfd rx session counters";
1358 bm->rx_counter.stat_segment_name = "/bfd/rx-session-counters";
1359 bm->rx_echo_counter.name = "bfd rx session echo counters";
1360 bm->rx_echo_counter.stat_segment_name = "/bfd/rx-session-echo-counters";
1361 bm->tx_counter.name = "bfd tx session counters";
1362 bm->tx_counter.stat_segment_name = "/bfd/tx-session-counters";
1363 bm->tx_echo_counter.name = "bfd tx session echo counters";
1364 bm->tx_echo_counter.stat_segment_name = "/bfd/tx-session-echo-counters";
1368 VLIB_INIT_FUNCTION (bfd_main_init);
1371 bfd_get_session (bfd_main_t * bm, bfd_transport_e t)
1373 bfd_session_t *result;
1377 pool_get (bm->sessions, result);
1378 clib_memset (result, 0, sizeof (*result));
1379 result->bs_idx = result - bm->sessions;
1380 result->transport = t;
1381 const unsigned limit = 1000;
1382 unsigned counter = 0;
1385 result->local_discr = random_u32 (&bm->random_seed);
1386 if (counter > limit)
1388 vlib_log_crit (bm->log_class,
1389 "couldn't allocate unused session discriminator even "
1390 "after %u tries!", limit);
1391 pool_put (bm->sessions, result);
1397 while (hash_get (bm->session_by_disc, result->local_discr));
1398 bfd_set_defaults (bm, result);
1399 hash_set (bm->session_by_disc, result->local_discr, result->bs_idx);
1400 bfd_validate_counters (bm);
1401 vlib_zero_combined_counter (&bm->rx_counter, result->bs_idx);
1402 vlib_zero_combined_counter (&bm->rx_echo_counter, result->bs_idx);
1403 vlib_zero_combined_counter (&bm->tx_counter, result->bs_idx);
1404 vlib_zero_combined_counter (&bm->tx_echo_counter, result->bs_idx);
1410 bfd_put_session (bfd_main_t * bm, bfd_session_t * bs)
1414 vlib_log_info (bm->log_class, "delete session: %U",
1415 format_bfd_session_brief, bs);
1416 if (bs->auth.curr_key)
1418 --bs->auth.curr_key->use_count;
1420 if (bs->auth.next_key)
1422 --bs->auth.next_key->use_count;
1424 hash_unset (bm->session_by_disc, bs->local_discr);
1425 vlib_zero_combined_counter (&bm->rx_counter, bs->bs_idx);
1426 vlib_zero_combined_counter (&bm->rx_echo_counter, bs->bs_idx);
1427 vlib_zero_combined_counter (&bm->tx_counter, bs->bs_idx);
1428 vlib_zero_combined_counter (&bm->tx_echo_counter, bs->bs_idx);
1429 pool_put (bm->sessions, bs);
1434 bfd_find_session_by_idx (bfd_main_t * bm, uword bs_idx)
1436 bfd_lock_check (bm);
1437 if (!pool_is_free_index (bm->sessions, bs_idx))
1439 return pool_elt_at_index (bm->sessions, bs_idx);
1445 bfd_find_session_by_disc (bfd_main_t * bm, u32 disc)
1447 bfd_lock_check (bm);
1448 uword *p = hash_get (bfd_main.session_by_disc, disc);
1451 return pool_elt_at_index (bfd_main.sessions, *p);
1457 * @brief verify bfd packet - common checks
1461 * @return 1 if bfd packet is valid
1464 bfd_verify_pkt_common (const bfd_pkt_t *pkt)
1466 if (1 != bfd_pkt_get_version (pkt))
1468 BFD_ERR ("BFD verification failed - unexpected version: '%d'",
1469 bfd_pkt_get_version (pkt));
1470 return BFD_ERROR_VERSION;
1472 if (pkt->head.length < sizeof (bfd_pkt_t) ||
1473 (bfd_pkt_get_auth_present (pkt) &&
1474 pkt->head.length < sizeof (bfd_pkt_with_common_auth_t)))
1476 BFD_ERR ("BFD verification failed - unexpected length: '%d' (auth "
1478 pkt->head.length, bfd_pkt_get_auth_present (pkt));
1479 return BFD_ERROR_LENGTH;
1481 if (!pkt->head.detect_mult)
1483 BFD_ERR ("BFD verification failed - unexpected detect-mult: '%d'",
1484 pkt->head.detect_mult);
1485 return BFD_ERROR_DETECT_MULTI;
1487 if (bfd_pkt_get_multipoint (pkt))
1489 BFD_ERR ("BFD verification failed - unexpected multipoint: '%d'",
1490 bfd_pkt_get_multipoint (pkt));
1491 return BFD_ERROR_MULTI_POINT;
1495 BFD_ERR ("BFD verification failed - unexpected my-disc: '%d'",
1497 return BFD_ERROR_MY_DISC;
1499 if (!pkt->your_disc)
1501 const u8 pkt_state = bfd_pkt_get_state (pkt);
1502 if (pkt_state != BFD_STATE_down && pkt_state != BFD_STATE_admin_down)
1504 BFD_ERR ("BFD verification failed - unexpected state: '%s' "
1505 "(your-disc is zero)", bfd_state_string (pkt_state));
1506 return BFD_ERROR_YOUR_DISC;
1509 return BFD_ERROR_NONE;
1513 bfd_session_switch_auth_to_next (bfd_session_t * bs)
1515 BFD_DBG ("Switching authentication key from %U to %U for bs_idx=%u",
1516 format_bfd_auth_key, bs->auth.curr_key, format_bfd_auth_key,
1517 bs->auth.next_key, bs->bs_idx);
1518 bs->auth.is_delayed = 0;
1519 if (bs->auth.curr_key)
1521 --bs->auth.curr_key->use_count;
1523 bs->auth.curr_key = bs->auth.next_key;
1524 bs->auth.next_key = NULL;
1525 bs->auth.curr_bfd_key_id = bs->auth.next_bfd_key_id;
1529 bfd_auth_type_is_meticulous (bfd_auth_type_e auth_type)
1531 if (BFD_AUTH_TYPE_meticulous_keyed_md5 == auth_type ||
1532 BFD_AUTH_TYPE_meticulous_keyed_sha1 == auth_type)
1540 bfd_verify_pkt_auth_seq_num (vlib_main_t * vm, bfd_session_t * bs,
1541 u32 received_seq_num, int is_meticulous)
1546 * This variable MUST be set to zero after no packets have been
1547 * received on this session for at least twice the Detection Time.
1549 u64 now = bfd_time_now_nsec (vm, NULL);
1550 if (now - bs->last_rx_nsec > bs->detection_time_nsec * 2)
1552 BFD_DBG ("BFD peer unresponsive for %lu nsec, which is > 2 * "
1553 "detection_time=%u nsec, resetting remote_seq_number_known "
1554 "flag", now - bs->last_rx_nsec, bs->detection_time_nsec * 2);
1555 bs->auth.remote_seq_number_known = 0;
1557 if (bs->auth.remote_seq_number_known)
1559 /* remote sequence number is known, verify its validity */
1560 const u32 max_u32 = 0xffffffff;
1561 /* the calculation might wrap, account for the special case... */
1562 if (bs->auth.remote_seq_number > max_u32 - 3 * bs->local_detect_mult)
1568 * |----------+----------------------------+-----------|
1570 * | remote_seq_num------+
1572 * +-----(remote_seq_num + 3*detect_mult) % * 0xffffffff
1574 * x + y + z = 0xffffffff
1575 * x + z = 3 * detect_mult
1577 const u32 z = max_u32 - bs->auth.remote_seq_number;
1578 const u32 x = 3 * bs->local_detect_mult - z;
1579 if (received_seq_num > x &&
1580 received_seq_num < bs->auth.remote_seq_number + is_meticulous)
1583 ("Recvd sequence number=%u out of ranges <0, %u>, <%u, %u>",
1584 received_seq_num, x,
1585 bs->auth.remote_seq_number + is_meticulous, max_u32);
1592 const u32 min = bs->auth.remote_seq_number + is_meticulous;
1594 bs->auth.remote_seq_number + 3 * bs->local_detect_mult;
1595 if (received_seq_num < min || received_seq_num > max)
1597 BFD_ERR ("Recvd sequence number=%u out of range <%u, %u>",
1598 received_seq_num, min, max);
1607 bfd_verify_pkt_auth_key_sha1 (vlib_main_t *vm, const bfd_pkt_t *pkt,
1608 u32 pkt_size, CLIB_UNUSED (bfd_session_t *bs),
1609 u8 bfd_key_id, bfd_auth_key_t *auth_key)
1611 ASSERT (auth_key->auth_type == BFD_AUTH_TYPE_keyed_sha1 ||
1612 auth_key->auth_type == BFD_AUTH_TYPE_meticulous_keyed_sha1);
1614 bfd_pkt_with_common_auth_t *with_common = (void *) pkt;
1615 if (pkt_size < sizeof (*with_common))
1617 BFD_ERR ("Packet size too small to hold authentication common header");
1620 if (with_common->common_auth.type != auth_key->auth_type)
1622 BFD_ERR ("BFD auth type mismatch, packet auth=%d:%s doesn't match "
1623 "in-use auth=%d:%s",
1624 with_common->common_auth.type,
1625 bfd_auth_type_str (with_common->common_auth.type),
1626 auth_key->auth_type, bfd_auth_type_str (auth_key->auth_type));
1629 bfd_pkt_with_sha1_auth_t *with_sha1 = (void *) pkt;
1630 if (pkt_size < sizeof (*with_sha1) ||
1631 with_sha1->sha1_auth.type_len.len < sizeof (with_sha1->sha1_auth))
1634 ("BFD size mismatch, payload size=%u, expected=%u, auth_len=%u, "
1635 "expected=%u", pkt_size, sizeof (*with_sha1),
1636 with_sha1->sha1_auth.type_len.len, sizeof (with_sha1->sha1_auth));
1639 if (with_sha1->sha1_auth.key_id != bfd_key_id)
1642 ("BFD key ID mismatch, packet key ID=%u doesn't match key ID=%u%s",
1643 with_sha1->sha1_auth.key_id, bfd_key_id,
1645 auth.is_delayed ? " (but a delayed auth change is scheduled)" : "");
1649 u8 hash_from_packet[STRUCT_SIZE_OF (bfd_auth_sha1_t, hash)];
1650 u8 calculated_hash[STRUCT_SIZE_OF (bfd_auth_sha1_t, hash)];
1651 clib_memcpy (hash_from_packet, with_sha1->sha1_auth.hash,
1652 sizeof (with_sha1->sha1_auth.hash));
1653 clib_memcpy (with_sha1->sha1_auth.hash, auth_key->key,
1654 sizeof (auth_key->key));
1655 vnet_crypto_op_t op;
1656 vnet_crypto_op_init (&op, VNET_CRYPTO_OP_SHA1_HASH);
1657 op.src = (u8 *) with_sha1;
1658 op.len = sizeof (*with_sha1);
1659 op.digest = calculated_hash;
1660 vnet_crypto_process_ops (vm, &op, 1);
1662 /* Restore the modified data within the packet */
1663 clib_memcpy (with_sha1->sha1_auth.hash, hash_from_packet,
1664 sizeof (with_sha1->sha1_auth.hash));
1667 memcmp (calculated_hash, hash_from_packet, sizeof (calculated_hash)))
1669 clib_memcpy (with_sha1->sha1_auth.hash, hash_from_packet,
1670 sizeof (hash_from_packet));
1673 BFD_ERR ("SHA1 hash: %U doesn't match the expected value: %U",
1674 format_hex_bytes, hash_from_packet, sizeof (hash_from_packet),
1675 format_hex_bytes, calculated_hash, sizeof (calculated_hash));
1680 bfd_verify_pkt_auth_key (vlib_main_t * vm, const bfd_pkt_t * pkt,
1681 u32 pkt_size, bfd_session_t * bs, u8 bfd_key_id,
1682 bfd_auth_key_t * auth_key)
1684 bfd_main_t *bm = &bfd_main;
1685 switch (auth_key->auth_type)
1687 case BFD_AUTH_TYPE_reserved:
1688 vlib_log_err (bm->log_class,
1689 "internal error, unexpected auth_type=%d:%s",
1690 auth_key->auth_type,
1691 bfd_auth_type_str (auth_key->auth_type));
1693 case BFD_AUTH_TYPE_simple_password:
1695 case BFD_AUTH_TYPE_keyed_md5:
1697 case BFD_AUTH_TYPE_meticulous_keyed_md5:
1700 "internal error, not implemented, unexpected auth_type=%d:%s",
1701 auth_key->auth_type, bfd_auth_type_str (auth_key->auth_type));
1703 case BFD_AUTH_TYPE_keyed_sha1:
1705 case BFD_AUTH_TYPE_meticulous_keyed_sha1:
1708 const u32 seq_num = clib_net_to_host_u32 (((bfd_pkt_with_sha1_auth_t
1711 return bfd_verify_pkt_auth_seq_num (
1713 bfd_auth_type_is_meticulous (auth_key->auth_type)) &&
1714 bfd_verify_pkt_auth_key_sha1 (vm, pkt, pkt_size, bs,
1715 bfd_key_id, auth_key);
1723 * @brief verify bfd packet - authentication
1727 * @return 1 if bfd packet is valid
1730 bfd_verify_pkt_auth (vlib_main_t * vm, const bfd_pkt_t * pkt, u16 pkt_size,
1733 if (bfd_pkt_get_auth_present (pkt))
1735 /* authentication present in packet */
1736 if (!bs->auth.curr_key)
1738 /* currently not using authentication - can we turn it on? */
1739 if (bs->auth.is_delayed && bs->auth.next_key)
1741 /* yes, switch is scheduled - make sure the auth is valid */
1742 if (bfd_verify_pkt_auth_key (vm, pkt, pkt_size, bs,
1743 bs->auth.next_bfd_key_id,
1746 /* auth matches next key, do the switch, packet is valid */
1747 bfd_session_switch_auth_to_next (bs);
1754 /* yes, using authentication, verify the key */
1755 if (bfd_verify_pkt_auth_key (vm, pkt, pkt_size, bs,
1756 bs->auth.curr_bfd_key_id,
1759 /* verification passed, packet is valid */
1764 /* verification failed - but maybe we need to switch key */
1765 if (bs->auth.is_delayed && bs->auth.next_key)
1767 /* delayed switch present, verify if that key works */
1768 if (bfd_verify_pkt_auth_key (vm, pkt, pkt_size, bs,
1769 bs->auth.next_bfd_key_id,
1772 /* auth matches next key, switch key, packet is valid */
1773 bfd_session_switch_auth_to_next (bs);
1782 /* authentication in packet not present */
1783 if (pkt_size > sizeof (*pkt))
1785 BFD_ERR ("BFD verification failed - unexpected packet size '%d' "
1786 "(auth not present)", pkt_size);
1789 if (bs->auth.curr_key)
1791 /* currently authenticating - could we turn it off? */
1792 if (bs->auth.is_delayed && !bs->auth.next_key)
1794 /* yes, delayed switch to NULL key is scheduled */
1795 bfd_session_switch_auth_to_next (bs);
1801 /* no auth in packet, no auth in use - packet is valid */
1809 bfd_consume_pkt (vlib_main_t *vm, bfd_main_t *bm, const bfd_pkt_t *pkt,
1812 bfd_lock_check (bm);
1814 bfd_session_t *bs = bfd_find_session_by_idx (bm, bs_idx);
1815 if (!bs || (pkt->your_disc && pkt->your_disc != bs->local_discr))
1817 return BFD_ERROR_YOUR_DISC;
1819 BFD_DBG ("Scanning bfd packet, bs_idx=%d", bs->bs_idx);
1820 bs->remote_discr = pkt->my_disc;
1821 bs->remote_state = bfd_pkt_get_state (pkt);
1822 bs->remote_demand = bfd_pkt_get_demand (pkt);
1823 bs->remote_diag = bfd_pkt_get_diag_code (pkt);
1824 u64 now = bfd_time_now_nsec (vm, NULL);
1825 bs->last_rx_nsec = now;
1826 if (bfd_pkt_get_auth_present (pkt))
1828 bfd_auth_type_e auth_type =
1829 ((bfd_pkt_with_common_auth_t *) (pkt))->common_auth.type;
1832 case BFD_AUTH_TYPE_reserved:
1834 case BFD_AUTH_TYPE_simple_password:
1836 case BFD_AUTH_TYPE_keyed_md5:
1838 case BFD_AUTH_TYPE_meticulous_keyed_md5:
1839 vlib_log_crit (bm->log_class,
1840 "internal error, unexpected auth_type=%d:%s",
1841 auth_type, bfd_auth_type_str (auth_type));
1843 case BFD_AUTH_TYPE_keyed_sha1:
1845 case BFD_AUTH_TYPE_meticulous_keyed_sha1:
1848 bfd_pkt_with_sha1_auth_t *with_sha1 =
1849 (bfd_pkt_with_sha1_auth_t *) pkt;
1850 bs->auth.remote_seq_number =
1851 clib_net_to_host_u32 (with_sha1->sha1_auth.seq_num);
1852 bs->auth.remote_seq_number_known = 1;
1853 BFD_DBG ("Received sequence number %u",
1854 bs->auth.remote_seq_number);
1859 bs->remote_desired_min_tx_nsec =
1860 bfd_usec_to_nsec (clib_net_to_host_u32 (pkt->des_min_tx));
1861 bs->remote_detect_mult = pkt->head.detect_mult;
1862 bfd_set_remote_required_min_rx (bs, clib_net_to_host_u32 (pkt->req_min_rx));
1863 bfd_set_remote_required_min_echo_rx (
1864 bs, clib_net_to_host_u32 (pkt->req_min_echo_rx));
1865 if (bfd_pkt_get_final (pkt))
1867 if (BFD_POLL_IN_PROGRESS == bs->poll_state)
1869 BFD_DBG ("Poll sequence terminated, bs_idx=%u", bs->bs_idx);
1870 bfd_set_poll_state (bs, BFD_POLL_NOT_NEEDED);
1871 if (BFD_STATE_up == bs->local_state)
1873 bfd_set_effective_desired_min_tx (
1874 bm, bs, now, bs->config_desired_min_tx_nsec);
1875 bfd_set_effective_required_min_rx (
1877 clib_max (bs->echo * bm->min_required_min_rx_while_echo_nsec,
1878 bs->config_required_min_rx_nsec));
1881 else if (BFD_POLL_IN_PROGRESS_AND_QUEUED == bs->poll_state)
1884 * next poll sequence must be delayed by at least the round trip
1885 * time, so calculate that here
1887 BFD_DBG ("Next poll sequence can commence in " BFD_CLK_FMT,
1888 BFD_CLK_PRN (now - bs->poll_state_start_or_timeout_nsec));
1889 bs->poll_state_start_or_timeout_nsec =
1890 now + (now - bs->poll_state_start_or_timeout_nsec);
1892 ("Poll sequence terminated, but another is needed, bs_idx=%u",
1894 bfd_set_poll_state (bs, BFD_POLL_NEEDED);
1897 bfd_calc_next_tx (bm, bs, now);
1898 bfd_set_timer (bm, bs, now, 0);
1899 if (BFD_STATE_admin_down == bs->local_state)
1901 BFD_DBG ("Session is admin-down, ignoring packet, bs_idx=%u",
1903 return BFD_ERROR_ADMIN_DOWN;
1905 if (BFD_STATE_admin_down == bs->remote_state)
1907 bfd_set_diag (bs, BFD_DIAG_CODE_neighbor_sig_down);
1908 bfd_set_state (vm, bm, bs, BFD_STATE_down, 0);
1910 else if (BFD_STATE_down == bs->local_state)
1912 if (BFD_STATE_down == bs->remote_state)
1914 bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
1915 bfd_set_state (vm, bm, bs, BFD_STATE_init, 0);
1917 else if (BFD_STATE_init == bs->remote_state)
1919 bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
1920 bfd_set_state (vm, bm, bs, BFD_STATE_up, 0);
1923 else if (BFD_STATE_init == bs->local_state)
1925 if (BFD_STATE_up == bs->remote_state ||
1926 BFD_STATE_init == bs->remote_state)
1928 bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
1929 bfd_set_state (vm, bm, bs, BFD_STATE_up, 0);
1932 else /* BFD_STATE_up == bs->local_state */
1934 if (BFD_STATE_down == bs->remote_state)
1936 bfd_set_diag (bs, BFD_DIAG_CODE_neighbor_sig_down);
1937 bfd_set_state (vm, bm, bs, BFD_STATE_down, 0);
1940 return BFD_ERROR_NONE;
1944 bfd_consume_echo_pkt (vlib_main_t *vm, bfd_main_t *bm, vlib_buffer_t *b)
1946 bfd_echo_pkt_t *pkt = NULL;
1947 if (b->current_length != sizeof (*pkt))
1951 pkt = vlib_buffer_get_current (b);
1952 bfd_session_t *bs = bfd_find_session_by_disc (bm, pkt->discriminator);
1957 BFD_DBG ("Scanning bfd echo packet, bs_idx=%d", bs->bs_idx);
1959 bfd_calc_echo_checksum (bs->local_discr, pkt->expire_time_nsec,
1961 if (checksum != pkt->checksum)
1963 BFD_DBG ("Invalid echo packet, checksum mismatch");
1966 u64 now = bfd_time_now_nsec (vm, NULL);
1967 if (pkt->expire_time_nsec < now)
1969 BFD_DBG ("Stale packet received, expire time %lu < now %lu",
1970 pkt->expire_time_nsec, now);
1974 bs->echo_last_rx_nsec = now;
1980 format_bfd_session (u8 * s, va_list * args)
1982 const bfd_session_t *bs = va_arg (*args, bfd_session_t *);
1983 s = format (s, "bs_idx=%u local-state=%s remote-state=%s\n"
1984 "local-discriminator=%u remote-discriminator=%u\n"
1985 "local-diag=%s echo-active=%s\n"
1986 "desired-min-tx=%u required-min-rx=%u\n"
1987 "required-min-echo-rx=%u detect-mult=%u\n"
1988 "remote-min-rx=%u remote-min-echo-rx=%u\n"
1989 "remote-demand=%s poll-state=%s\n"
1990 "auth: local-seq-num=%u remote-seq-num=%u\n"
1994 bs->bs_idx, bfd_state_string (bs->local_state),
1995 bfd_state_string (bs->remote_state), bs->local_discr,
1996 bs->remote_discr, bfd_diag_code_string (bs->local_diag),
1997 (bs->echo ? "yes" : "no"), bs->config_desired_min_tx_usec,
1998 bs->config_required_min_rx_usec, 1, bs->local_detect_mult,
1999 bs->remote_min_rx_usec, bs->remote_min_echo_rx_usec,
2000 (bs->remote_demand ? "yes" : "no"),
2001 bfd_poll_state_string (bs->poll_state),
2002 bs->auth.local_seq_number, bs->auth.remote_seq_number,
2003 (bs->auth.is_delayed ? "yes" : "no"),
2004 format_bfd_auth_key, bs->auth.curr_key, format_bfd_auth_key,
2010 format_bfd_session_brief (u8 * s, va_list * args)
2012 const bfd_session_t *bs = va_arg (*args, bfd_session_t *);
2014 format (s, "bs_idx=%u local-state=%s remote-state=%s", bs->bs_idx,
2015 bfd_state_string (bs->local_state),
2016 bfd_state_string (bs->remote_state));
2021 bfd_auth_type_supported (bfd_auth_type_e auth_type)
2023 if (auth_type == BFD_AUTH_TYPE_keyed_sha1 ||
2024 auth_type == BFD_AUTH_TYPE_meticulous_keyed_sha1)
2032 bfd_auth_activate (bfd_session_t * bs, u32 conf_key_id,
2033 u8 bfd_key_id, u8 is_delayed)
2035 bfd_main_t *bm = &bfd_main;
2036 const uword *key_idx_p =
2037 hash_get (bm->auth_key_by_conf_key_id, conf_key_id);
2040 vlib_log_err (bm->log_class,
2041 "authentication key with config ID %u doesn't exist)",
2043 return VNET_API_ERROR_BFD_ENOENT;
2045 const uword key_idx = *key_idx_p;
2046 bfd_auth_key_t *key = pool_elt_at_index (bm->auth_keys, key_idx);
2049 if (bs->auth.next_key == key && bs->auth.next_bfd_key_id == bfd_key_id)
2051 /* already using this key, no changes required */
2054 if (bs->auth.next_key != key)
2057 bs->auth.next_key = key;
2059 bs->auth.next_bfd_key_id = bfd_key_id;
2060 bs->auth.is_delayed = 1;
2064 if (bs->auth.curr_key == key && bs->auth.curr_bfd_key_id == bfd_key_id)
2066 /* already using this key, no changes required */
2070 if (bs->auth.curr_key)
2072 --bs->auth.curr_key->use_count;
2074 bs->auth.curr_key = key;
2075 bs->auth.curr_bfd_key_id = bfd_key_id;
2076 bs->auth.is_delayed = 0;
2078 BFD_DBG ("\nSession auth modified: %U", format_bfd_session, bs);
2079 vlib_log_info (bm->log_class, "session auth modified: %U",
2080 format_bfd_session_brief, bs);
2085 bfd_auth_deactivate (bfd_session_t * bs, u8 is_delayed)
2087 bfd_main_t *bm = &bfd_main;
2090 /* not delayed - deactivate the current key right now */
2091 if (bs->auth.curr_key)
2093 --bs->auth.curr_key->use_count;
2094 bs->auth.curr_key = NULL;
2096 bs->auth.is_delayed = 0;
2100 /* delayed - mark as so */
2101 bs->auth.is_delayed = 1;
2104 * clear the next key unconditionally - either the auth change is not delayed
2105 * in which case the caller expects the session to not use authentication
2106 * from this point forward, or it is delayed, in which case the next_key
2107 * needs to be set to NULL to make it so in the future
2109 if (bs->auth.next_key)
2111 --bs->auth.next_key->use_count;
2112 bs->auth.next_key = NULL;
2114 BFD_DBG ("\nSession auth modified: %U", format_bfd_session, bs);
2115 vlib_log_info (bm->log_class, "session auth modified: %U",
2116 format_bfd_session_brief, bs);
2121 bfd_session_set_params (bfd_main_t * bm, bfd_session_t * bs,
2122 u32 desired_min_tx_usec,
2123 u32 required_min_rx_usec, u8 detect_mult)
2125 if (bs->local_detect_mult != detect_mult ||
2126 bs->config_desired_min_tx_usec != desired_min_tx_usec ||
2127 bs->config_required_min_rx_usec != required_min_rx_usec)
2129 BFD_DBG ("\nChanging session params: %U", format_bfd_session, bs);
2130 switch (bs->poll_state)
2132 case BFD_POLL_NOT_NEEDED:
2133 if (BFD_STATE_up == bs->local_state ||
2134 BFD_STATE_init == bs->local_state)
2136 /* poll sequence is not needed for detect multiplier change */
2137 if (bs->config_desired_min_tx_usec != desired_min_tx_usec ||
2138 bs->config_required_min_rx_usec != required_min_rx_usec)
2140 bfd_set_poll_state (bs, BFD_POLL_NEEDED);
2144 case BFD_POLL_NEEDED:
2145 case BFD_POLL_IN_PROGRESS_AND_QUEUED:
2147 * nothing to do - will be handled in the future poll which is
2148 * already scheduled for execution
2151 case BFD_POLL_IN_PROGRESS:
2152 /* poll sequence is not needed for detect multiplier change */
2153 if (bs->config_desired_min_tx_usec != desired_min_tx_usec ||
2154 bs->config_required_min_rx_usec != required_min_rx_usec)
2156 BFD_DBG ("Poll in progress, queueing extra poll, bs_idx=%u",
2158 bfd_set_poll_state (bs, BFD_POLL_IN_PROGRESS_AND_QUEUED);
2162 bs->local_detect_mult = detect_mult;
2163 bs->config_desired_min_tx_usec = desired_min_tx_usec;
2164 bs->config_desired_min_tx_nsec = bfd_usec_to_nsec (desired_min_tx_usec);
2165 bs->config_required_min_rx_usec = required_min_rx_usec;
2166 bs->config_required_min_rx_nsec =
2167 bfd_usec_to_nsec (required_min_rx_usec);
2168 BFD_DBG ("\nChanged session params: %U", format_bfd_session, bs);
2170 vlib_log_info (bm->log_class, "changed session params: %U",
2171 format_bfd_session_brief, bs);
2172 vlib_process_signal_event (bm->vlib_main, bm->bfd_process_node_index,
2173 BFD_EVENT_CONFIG_CHANGED, bs->bs_idx);
2177 BFD_DBG ("Ignore parameter change - no change, bs_idx=%u", bs->bs_idx);
2183 bfd_auth_set_key (u32 conf_key_id, u8 auth_type, u8 key_len,
2184 const u8 * key_data)
2186 bfd_main_t *bm = &bfd_main;
2187 bfd_auth_key_t *auth_key = NULL;
2188 if (!key_len || key_len > bfd_max_key_len_for_auth_type (auth_type))
2190 vlib_log_err (bm->log_class,
2191 "invalid authentication key length for auth_type=%d:%s "
2192 "(key_len=%u, must be non-zero, expected max=%u)",
2193 auth_type, bfd_auth_type_str (auth_type), key_len,
2194 (u32) bfd_max_key_len_for_auth_type (auth_type));
2195 return VNET_API_ERROR_INVALID_VALUE;
2197 if (!bfd_auth_type_supported (auth_type))
2199 vlib_log_err (bm->log_class, "unsupported auth type=%d:%s", auth_type,
2200 bfd_auth_type_str (auth_type));
2201 return VNET_API_ERROR_BFD_NOTSUPP;
2203 uword *key_idx_p = hash_get (bm->auth_key_by_conf_key_id, conf_key_id);
2206 /* modifying existing key - must not be used */
2207 const uword key_idx = *key_idx_p;
2208 auth_key = pool_elt_at_index (bm->auth_keys, key_idx);
2209 if (auth_key->use_count > 0)
2211 vlib_log_err (bm->log_class,
2212 "authentication key with conf ID %u in use by %u BFD "
2213 "session(s) - cannot modify", conf_key_id,
2214 auth_key->use_count);
2215 return VNET_API_ERROR_BFD_EINUSE;
2220 /* adding new key */
2221 pool_get (bm->auth_keys, auth_key);
2222 auth_key->conf_key_id = conf_key_id;
2223 hash_set (bm->auth_key_by_conf_key_id, conf_key_id,
2224 auth_key - bm->auth_keys);
2226 auth_key->auth_type = auth_type;
2227 clib_memset (auth_key->key, 0, sizeof (auth_key->key));
2228 clib_memcpy (auth_key->key, key_data, key_len);
2233 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;
2266 bfd_main_t bfd_main;
2269 * fd.io coding-style-patch-verification: ON
2272 * eval: (c-set-style "gnu")