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 <vppinfra/random.h>
21 #include <vppinfra/error.h>
22 #include <vppinfra/hash.h>
23 #include <vnet/ethernet/ethernet.h>
24 #include <vnet/ethernet/packet.h>
25 #include <vnet/bfd/bfd_debug.h>
26 #include <vnet/bfd/bfd_protocol.h>
27 #include <vnet/bfd/bfd_main.h>
29 #include <openssl/sha.h>
33 bfd_usec_to_clocks (const bfd_main_t * bm, u64 us)
35 return bm->cpu_cps * ((f64) us / USEC_PER_SECOND);
38 static vlib_node_registration_t bfd_process_node;
40 /* set to 0 here, real values filled at startup */
41 static u32 bfd_node_index_by_transport[] = {
42 #define F(t, n) [BFD_TRANSPORT_##t] = 0,
43 foreach_bfd_transport (F)
48 format_bfd_auth_key (u8 * s, va_list * args)
50 const bfd_auth_key_t *key = va_arg (*args, bfd_auth_key_t *);
53 s = format (s, "{auth-type=%u:%s, conf-key-id=%u, use-count=%u}, ",
54 key->auth_type, bfd_auth_type_str (key->auth_type),
55 key->conf_key_id, key->use_count);
59 s = format (s, "{none}");
65 * We actually send all bfd pkts to the "error" node after scanning
66 * them, so the graph node has only one next-index. The "error-drop"
67 * node automatically bumps our per-node packet counters for us.
71 BFD_INPUT_NEXT_NORMAL,
75 static void bfd_on_state_change (bfd_main_t * bm, bfd_session_t * bs, u64 now,
79 bfd_set_defaults (bfd_main_t * bm, bfd_session_t * bs)
81 bs->local_state = BFD_STATE_down;
82 bs->local_diag = BFD_DIAG_CODE_no_diag;
83 bs->remote_state = BFD_STATE_down;
86 bs->config_desired_min_tx_usec = BFD_DEFAULT_DESIRED_MIN_TX_US;
87 bs->config_desired_min_tx_clocks = bm->default_desired_min_tx_clocks;
88 bs->effective_desired_min_tx_clocks = bm->default_desired_min_tx_clocks;
89 bs->remote_min_rx_usec = 1;
90 bs->remote_min_rx_clocks = bfd_usec_to_clocks (bm, bs->remote_min_rx_usec);
91 bs->remote_demand = 0;
92 bs->auth.remote_seq_number = 0;
93 bs->auth.remote_seq_number_known = 0;
94 bs->auth.local_seq_number = random_u32 (&bm->random_seed);
98 bfd_set_diag (bfd_session_t * bs, bfd_diag_code_e code)
100 if (bs->local_diag != code)
102 BFD_DBG ("set local_diag, bs_idx=%d: '%d:%s'", bs->bs_idx, code,
103 bfd_diag_code_string (code));
104 bs->local_diag = code;
109 bfd_set_state (bfd_main_t * bm, bfd_session_t * bs,
110 bfd_state_e new_state, int handling_wakeup)
112 if (bs->local_state != new_state)
114 BFD_DBG ("Change state, bs_idx=%d: %s->%s", bs->bs_idx,
115 bfd_state_string (bs->local_state),
116 bfd_state_string (new_state));
117 bs->local_state = new_state;
118 bfd_on_state_change (bm, bs, clib_cpu_time_now (), handling_wakeup);
123 bfd_recalc_tx_interval (bfd_main_t * bm, bfd_session_t * bs)
125 if (!bs->local_demand)
127 bs->transmit_interval_clocks =
128 clib_max (bs->effective_desired_min_tx_clocks,
129 bs->remote_min_rx_clocks);
135 BFD_DBG ("Recalculated transmit interval %lu clocks/%.2fs",
136 bs->transmit_interval_clocks,
137 bs->transmit_interval_clocks / bm->cpu_cps);
141 bfd_calc_next_tx (bfd_main_t * bm, bfd_session_t * bs, u64 now)
143 if (!bs->local_demand)
145 if (bs->local_detect_mult > 1)
147 /* common case - 75-100% of transmit interval */
148 bs->tx_timeout_clocks = bs->last_tx_clocks +
149 (1 - .25 * (random_f64 (&bm->random_seed))) *
150 bs->transmit_interval_clocks;
151 if (bs->tx_timeout_clocks < now)
153 /* huh, we've missed it already, transmit now */
154 BFD_DBG ("Missed %lu transmit events (now is %lu, calc "
155 "tx_timeout is %lu)",
156 (now - bs->tx_timeout_clocks) /
157 bs->transmit_interval_clocks,
158 now, bs->tx_timeout_clocks);
159 bs->tx_timeout_clocks = now;
164 /* special case - 75-90% of transmit interval */
165 bs->tx_timeout_clocks =
167 (.9 - .15 * (random_f64 (&bm->random_seed))) *
168 bs->transmit_interval_clocks;
169 if (bs->tx_timeout_clocks < now)
171 /* huh, we've missed it already, transmit now */
172 BFD_DBG ("Missed %lu transmit events (now is %lu, calc "
173 "tx_timeout is %lu)",
174 (now - bs->tx_timeout_clocks) /
175 bs->transmit_interval_clocks,
176 now, bs->tx_timeout_clocks);
177 bs->tx_timeout_clocks = now;
185 if (bs->tx_timeout_clocks)
187 BFD_DBG ("Next transmit in %lu clocks/%.02fs@%lu",
188 bs->tx_timeout_clocks - now,
189 (bs->tx_timeout_clocks - now) / bm->cpu_cps,
190 bs->tx_timeout_clocks);
195 bfd_recalc_detection_time (bfd_main_t * bm, bfd_session_t * bs)
197 if (!bs->local_demand)
199 /* asynchronous mode */
200 bs->detection_time_clocks =
201 bs->remote_detect_mult *
202 clib_max (bs->effective_required_min_rx_clocks,
203 bs->remote_desired_min_tx_clocks);
208 bs->detection_time_clocks =
209 bs->local_detect_mult * clib_max (bs->config_desired_min_tx_clocks,
210 bs->remote_min_rx_clocks);
212 BFD_DBG ("Recalculated detection time %lu clocks/%.2fs",
213 bs->detection_time_clocks,
214 bs->detection_time_clocks / bm->cpu_cps);
218 bfd_set_timer (bfd_main_t * bm, bfd_session_t * bs, u64 now,
223 if (BFD_STATE_up == bs->local_state)
225 rx_timeout = bs->last_rx_clocks + bs->detection_time_clocks;
227 if (bs->tx_timeout_clocks && rx_timeout)
229 next = clib_min (bs->tx_timeout_clocks, rx_timeout);
231 else if (bs->tx_timeout_clocks)
233 next = bs->tx_timeout_clocks;
239 BFD_DBG ("bs_idx=%u, tx_timeout=%lu, rx_timeout=%lu, next=%s", bs->bs_idx,
240 bs->tx_timeout_clocks, rx_timeout,
241 next == bs->tx_timeout_clocks ? "tx" : "rx");
242 /* sometimes the wheel expires an event a bit sooner than requested, account
244 if (next && (now + bm->wheel_inaccuracy > bs->wheel_time_clocks ||
245 next < bs->wheel_time_clocks || !bs->wheel_time_clocks))
247 bs->wheel_time_clocks = next;
248 BFD_DBG ("timing_wheel_insert(%p, %lu (%ld clocks/%.2fs in the "
250 &bm->wheel, bs->wheel_time_clocks,
251 (i64) bs->wheel_time_clocks - clib_cpu_time_now (),
252 (i64) (bs->wheel_time_clocks - clib_cpu_time_now ()) /
253 bm->cpu_cps, bs->bs_idx);
254 timing_wheel_insert (&bm->wheel, bs->wheel_time_clocks, bs->bs_idx);
255 if (!handling_wakeup)
257 vlib_process_signal_event (bm->vlib_main,
258 bm->bfd_process_node_index,
259 BFD_EVENT_RESCHEDULE, bs->bs_idx);
265 bfd_set_effective_desired_min_tx (bfd_main_t * bm,
266 bfd_session_t * bs, u64 now,
267 u64 desired_min_tx_clocks)
269 bs->effective_desired_min_tx_clocks = desired_min_tx_clocks;
270 BFD_DBG ("Set effective desired min tx to " BFD_CLK_FMT,
271 BFD_CLK_PRN (bs->effective_desired_min_tx_clocks));
272 bfd_recalc_detection_time (bm, bs);
273 bfd_recalc_tx_interval (bm, bs);
274 bfd_calc_next_tx (bm, bs, now);
278 bfd_set_effective_required_min_rx (bfd_main_t * bm,
279 bfd_session_t * bs, u64 now,
280 u64 required_min_rx_clocks)
282 bs->effective_required_min_rx_clocks = required_min_rx_clocks;
283 BFD_DBG ("Set effective required min rx to " BFD_CLK_FMT,
284 BFD_CLK_PRN (bs->effective_required_min_rx_clocks));
285 bfd_recalc_detection_time (bm, bs);
289 bfd_set_remote_required_min_rx (bfd_main_t * bm, bfd_session_t * bs,
291 u32 remote_required_min_rx_usec,
294 bs->remote_min_rx_usec = remote_required_min_rx_usec;
295 bs->remote_min_rx_clocks =
296 bfd_usec_to_clocks (bm, remote_required_min_rx_usec);
297 BFD_DBG ("Set remote min rx to " BFD_CLK_FMT,
298 BFD_CLK_PRN (bs->remote_min_rx_clocks));
299 bfd_recalc_detection_time (bm, bs);
300 bfd_recalc_tx_interval (bm, bs);
301 bfd_calc_next_tx (bm, bs, now);
302 bfd_set_timer (bm, bs, now, handling_wakeup);
306 bfd_session_start (bfd_main_t * bm, bfd_session_t * bs)
308 BFD_DBG ("%U", format_bfd_session, bs);
309 bfd_recalc_tx_interval (bm, bs);
310 vlib_process_signal_event (bm->vlib_main, bm->bfd_process_node_index,
311 BFD_EVENT_NEW_SESSION, bs->bs_idx);
315 bfd_del_session (uword bs_idx)
317 const bfd_main_t *bm = &bfd_main;
318 if (!pool_is_free_index (bm->sessions, bs_idx))
320 bfd_session_t *bs = pool_elt_at_index (bm->sessions, bs_idx);
321 pool_put (bm->sessions, bs);
326 BFD_ERR ("no such session");
327 return VNET_API_ERROR_BFD_ENOENT;
333 bfd_session_set_flags (bfd_session_t * bs, u8 admin_up_down)
335 bfd_main_t *bm = &bfd_main;
338 bfd_set_state (bm, bs, BFD_STATE_down, 0);
342 bfd_set_diag (bs, BFD_DIAG_CODE_neighbor_sig_down);
343 bfd_set_state (bm, bs, BFD_STATE_admin_down, 0);
348 bfd_input_format_trace (u8 * s, va_list * args)
350 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
351 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
352 const bfd_input_trace_t *t = va_arg (*args, bfd_input_trace_t *);
353 const bfd_pkt_t *pkt = (bfd_pkt_t *) t->data;
354 if (t->len > STRUCT_SIZE_OF (bfd_pkt_t, head))
356 s = format (s, "BFD v%u, diag=%u(%s), state=%u(%s),\n"
357 " flags=(P:%u, F:%u, C:%u, A:%u, D:%u, M:%u), "
358 "detect_mult=%u, length=%u\n",
359 bfd_pkt_get_version (pkt), bfd_pkt_get_diag_code (pkt),
360 bfd_diag_code_string (bfd_pkt_get_diag_code (pkt)),
361 bfd_pkt_get_state (pkt),
362 bfd_state_string (bfd_pkt_get_state (pkt)),
363 bfd_pkt_get_poll (pkt), bfd_pkt_get_final (pkt),
364 bfd_pkt_get_control_plane_independent (pkt),
365 bfd_pkt_get_auth_present (pkt), bfd_pkt_get_demand (pkt),
366 bfd_pkt_get_multipoint (pkt), pkt->head.detect_mult,
368 if (t->len >= sizeof (bfd_pkt_t) &&
369 pkt->head.length >= sizeof (bfd_pkt_t))
371 s = format (s, " my discriminator: %u\n",
372 clib_net_to_host_u32 (pkt->my_disc));
373 s = format (s, " your discriminator: %u\n",
374 clib_net_to_host_u32 (pkt->your_disc));
375 s = format (s, " desired min tx interval: %u\n",
376 clib_net_to_host_u32 (pkt->des_min_tx));
377 s = format (s, " required min rx interval: %u\n",
378 clib_net_to_host_u32 (pkt->req_min_rx));
379 s = format (s, " required min echo rx interval: %u",
380 clib_net_to_host_u32 (pkt->req_min_echo_rx));
382 if (t->len >= sizeof (bfd_pkt_with_common_auth_t) &&
383 pkt->head.length >= sizeof (bfd_pkt_with_common_auth_t) &&
384 bfd_pkt_get_auth_present (pkt))
386 const bfd_pkt_with_common_auth_t *with_auth = (void *) pkt;
387 const bfd_auth_common_t *common = &with_auth->common_auth;
388 s = format (s, "\n auth len: %u\n", common->len);
389 s = format (s, " auth type: %u:%s\n", common->type,
390 bfd_auth_type_str (common->type));
391 if (t->len >= sizeof (bfd_pkt_with_sha1_auth_t) &&
392 pkt->head.length >= sizeof (bfd_pkt_with_sha1_auth_t) &&
393 (BFD_AUTH_TYPE_keyed_sha1 == common->type ||
394 BFD_AUTH_TYPE_meticulous_keyed_sha1 == common->type))
396 const bfd_pkt_with_sha1_auth_t *with_sha1 = (void *) pkt;
397 const bfd_auth_sha1_t *sha1 = &with_sha1->sha1_auth;
398 s = format (s, " seq num: %u\n",
399 clib_net_to_host_u32 (sha1->seq_num));
400 s = format (s, " key id: %u\n", sha1->key_id);
401 s = format (s, " hash: %U", format_hex_bytes, sha1->hash,
402 sizeof (sha1->hash));
407 s = format (s, "\n");
415 bfd_on_state_change (bfd_main_t * bm, bfd_session_t * bs, u64 now,
418 BFD_DBG ("State changed: %U", format_bfd_session, bs);
420 switch (bs->local_state)
422 case BFD_STATE_admin_down:
423 bfd_set_effective_desired_min_tx (bm, bs, now,
425 (bs->config_desired_min_tx_clocks,
426 bm->default_desired_min_tx_clocks));
427 bfd_set_effective_required_min_rx (bm, bs, now,
428 bs->config_required_min_rx_clocks);
429 bfd_set_timer (bm, bs, now, handling_wakeup);
432 bfd_set_effective_desired_min_tx (bm, bs, now,
434 (bs->config_desired_min_tx_clocks,
435 bm->default_desired_min_tx_clocks));
436 bfd_set_effective_required_min_rx (bm, bs, now,
437 bs->config_required_min_rx_clocks);
438 bfd_set_timer (bm, bs, now, handling_wakeup);
441 bfd_set_effective_desired_min_tx (bm, bs, now,
443 (bs->config_desired_min_tx_clocks,
444 bm->default_desired_min_tx_clocks));
445 bfd_set_timer (bm, bs, now, handling_wakeup);
448 bfd_set_effective_desired_min_tx (bm, bs, now,
449 bs->config_desired_min_tx_clocks);
450 if (POLL_NOT_NEEDED == bs->poll_state)
452 bfd_set_effective_required_min_rx (bm, bs, now,
453 bs->config_required_min_rx_clocks);
455 bfd_set_timer (bm, bs, now, handling_wakeup);
461 bfd_on_config_change (vlib_main_t * vm, vlib_node_runtime_t * rt,
462 bfd_main_t * bm, bfd_session_t * bs, u64 now)
464 if (bs->remote_demand)
466 /* TODO - initiate poll sequence here */
470 /* asynchronous - poll is part of periodic - nothing to do here */
472 bfd_recalc_detection_time (bm, bs);
473 bfd_set_timer (bm, bs, now, 0);
477 bfd_add_transport_layer (vlib_main_t * vm, vlib_buffer_t * b,
480 switch (bs->transport)
482 case BFD_TRANSPORT_UDP4:
483 BFD_DBG ("Transport bfd via udp4, bs_idx=%u", bs->bs_idx);
484 bfd_add_udp4_transport (vm, b, bs);
486 case BFD_TRANSPORT_UDP6:
487 BFD_DBG ("Transport bfd via udp6, bs_idx=%u", bs->bs_idx);
488 bfd_add_udp6_transport (vm, b, bs);
493 static vlib_buffer_t *
494 bfd_create_frame_to_next_node (vlib_main_t * vm, bfd_session_t * bs)
497 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
499 clib_warning ("buffer allocation failure");
503 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
504 ASSERT (b->current_data == 0);
507 vlib_get_frame_to_node (vm, bfd_node_index_by_transport[bs->transport]);
509 u32 *to_next = vlib_frame_vector_args (f);
513 vlib_put_frame_to_node (vm, bfd_node_index_by_transport[bs->transport], f);
519 bfd_add_sha1_auth_section (vlib_buffer_t * b, bfd_session_t * bs)
521 bfd_pkt_with_sha1_auth_t *pkt = vlib_buffer_get_current (b);
522 bfd_auth_sha1_t *auth = &pkt->sha1_auth;
523 b->current_length += sizeof (*auth);
524 pkt->pkt.head.length += sizeof (*auth);
525 bfd_pkt_set_auth_present (&pkt->pkt);
526 memset (auth, 0, sizeof (*auth));
527 auth->type_len.type = bs->auth.curr_key->auth_type;
529 * only meticulous authentication types require incrementing seq number
530 * for every message, but doing so doesn't violate the RFC
532 ++bs->auth.local_seq_number;
533 auth->type_len.len = sizeof (bfd_auth_sha1_t);
534 auth->key_id = bs->auth.curr_bfd_key_id;
535 auth->seq_num = clib_host_to_net_u32 (bs->auth.local_seq_number);
537 * first copy the password into the packet, then calculate the hash
538 * and finally replace the password with the calculated hash
540 clib_memcpy (auth->hash, bs->auth.curr_key->key,
541 sizeof (bs->auth.curr_key->key));
542 unsigned char hash[sizeof (auth->hash)];
543 SHA1 ((unsigned char *) pkt, sizeof (*pkt), hash);
544 BFD_DBG ("hashing: %U", format_hex_bytes, pkt, sizeof (*pkt));
545 clib_memcpy (auth->hash, hash, sizeof (hash));
550 bfd_add_auth_section (vlib_buffer_t * b, bfd_session_t * bs)
552 if (bs->auth.curr_key)
554 const bfd_auth_type_e auth_type = bs->auth.curr_key->auth_type;
557 case BFD_AUTH_TYPE_reserved:
559 case BFD_AUTH_TYPE_simple_password:
561 case BFD_AUTH_TYPE_keyed_md5:
563 case BFD_AUTH_TYPE_meticulous_keyed_md5:
564 clib_warning ("Internal error, unexpected BFD auth type '%d'",
568 case BFD_AUTH_TYPE_keyed_sha1:
570 case BFD_AUTH_TYPE_meticulous_keyed_sha1:
571 bfd_add_sha1_auth_section (b, bs);
574 case BFD_AUTH_TYPE_keyed_sha1:
576 case BFD_AUTH_TYPE_meticulous_keyed_sha1:
577 clib_warning ("Internal error, unexpected BFD auth type '%d'",
586 bfd_init_control_frame (vlib_buffer_t * b, bfd_session_t * bs)
588 bfd_pkt_t *pkt = vlib_buffer_get_current (b);
591 bfd_length = sizeof (bfd_pkt_t);
592 memset (pkt, 0, sizeof (*pkt));
593 bfd_pkt_set_version (pkt, 1);
594 bfd_pkt_set_diag_code (pkt, bs->local_diag);
595 bfd_pkt_set_state (pkt, bs->local_state);
596 if (bs->local_demand && BFD_STATE_up == bs->local_state &&
597 BFD_STATE_up == bs->remote_state)
599 bfd_pkt_set_demand (pkt);
601 pkt->head.detect_mult = bs->local_detect_mult;
602 pkt->head.length = clib_host_to_net_u32 (bfd_length);
603 pkt->my_disc = bs->local_discr;
604 pkt->your_disc = bs->remote_discr;
605 pkt->des_min_tx = clib_host_to_net_u32 (bs->config_desired_min_tx_usec);
606 pkt->req_min_rx = clib_host_to_net_u32 (bs->config_required_min_rx_usec);
607 pkt->req_min_echo_rx = clib_host_to_net_u32 (1);
608 b->current_length = bfd_length;
612 bfd_send_periodic (vlib_main_t * vm, vlib_node_runtime_t * rt,
613 bfd_main_t * bm, bfd_session_t * bs, u64 now,
616 if (!bs->remote_min_rx_usec)
619 ("bfd.RemoteMinRxInterval is zero, not sending periodic control "
623 if (POLL_NOT_NEEDED == bs->poll_state && bs->remote_demand &&
624 BFD_STATE_up == bs->local_state && BFD_STATE_up == bs->remote_state)
627 * A system MUST NOT periodically transmit BFD Control packets if Demand
628 * mode is active on the remote system (bfd.RemoteDemandMode is 1,
629 * bfd.SessionState is Up, and bfd.RemoteSessionState is Up) and a Poll
630 * Sequence is not being transmitted.
632 BFD_DBG ("bfd.RemoteDemand is non-zero, not sending periodic control "
636 /* sometimes the wheel expires an event a bit sooner than requested, account
638 if (now + bm->wheel_inaccuracy >= bs->tx_timeout_clocks)
640 BFD_DBG ("Send periodic control frame for bs_idx=%lu: %U", bs->bs_idx,
641 format_bfd_session, bs);
642 vlib_buffer_t *b = bfd_create_frame_to_next_node (vm, bs);
647 bfd_init_control_frame (b, bs);
648 if (POLL_NOT_NEEDED != bs->poll_state)
650 /* here we are either beginning a new poll sequence or retrying .. */
651 bfd_pkt_set_poll (vlib_buffer_get_current (b));
652 bs->poll_state = POLL_IN_PROGRESS;
653 BFD_DBG ("Setting poll bit in packet, bs_idx=%u", bs->bs_idx);
655 bfd_add_auth_section (b, bs);
656 bfd_add_transport_layer (vm, b, bs);
657 bs->last_tx_clocks = now;
658 bfd_calc_next_tx (bm, bs, now);
663 ("No need to send control frame now, now is %lu, tx_timeout is %lu",
664 now, bs->tx_timeout_clocks);
666 bfd_set_timer (bm, bs, now, handling_wakeup);
670 bfd_init_final_control_frame (vlib_main_t * vm, vlib_buffer_t * b,
673 BFD_DBG ("Send final control frame for bs_idx=%lu", bs->bs_idx);
674 bfd_init_control_frame (b, bs);
675 bfd_pkt_set_final (vlib_buffer_get_current (b));
676 bfd_add_auth_section (b, bs);
677 bfd_add_transport_layer (vm, b, bs);
678 bs->last_tx_clocks = clib_cpu_time_now ();
680 * RFC allows to include changes in final frame, so if there were any
681 * pending, we already did that, thus we can clear any pending poll needs
683 bs->poll_state = POLL_NOT_NEEDED;
687 bfd_check_rx_timeout (bfd_main_t * bm, bfd_session_t * bs, u64 now,
690 /* sometimes the wheel expires an event a bit sooner than requested, account
692 if (bs->last_rx_clocks + bs->detection_time_clocks <=
693 now + bm->wheel_inaccuracy)
695 BFD_DBG ("Rx timeout, session goes down");
696 bfd_set_diag (bs, BFD_DIAG_CODE_det_time_exp);
697 bfd_set_state (bm, bs, BFD_STATE_down, handling_wakeup);
699 * If the remote system does not receive any
700 * BFD Control packets for a Detection Time, it SHOULD reset
701 * bfd.RemoteMinRxInterval to its initial value of 1 (per section 6.8.1,
702 * since it is no longer required to maintain previous session state)
703 * and then can transmit at its own rate.
705 bfd_set_remote_required_min_rx (bm, bs, now, 1, handling_wakeup);
710 bfd_on_timeout (vlib_main_t * vm, vlib_node_runtime_t * rt, bfd_main_t * bm,
711 bfd_session_t * bs, u64 now)
713 BFD_DBG ("Timeout for bs_idx=%lu", bs->bs_idx);
714 switch (bs->local_state)
716 case BFD_STATE_admin_down:
717 BFD_ERR ("Unexpected timeout when in %s state",
718 bfd_state_string (bs->local_state));
722 bfd_send_periodic (vm, rt, bm, bs, now, 1);
725 BFD_ERR ("Unexpected timeout when in %s state",
726 bfd_state_string (bs->local_state));
730 bfd_check_rx_timeout (bm, bs, now, 1);
731 bfd_send_periodic (vm, rt, bm, bs, now, 1);
737 * bfd process node function
740 bfd_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
742 bfd_main_t *bm = &bfd_main;
744 uword event_type, *event_data = 0;
746 /* So we can send events to the bfd process */
747 bm->bfd_process_node_index = bfd_process_node.index;
751 u64 now = clib_cpu_time_now ();
752 u64 next_expire = timing_wheel_next_expiring_elt_time (&bm->wheel);
753 BFD_DBG ("timing_wheel_next_expiring_elt_time(%p) returns %lu",
754 &bm->wheel, next_expire);
755 if ((i64) next_expire < 0)
757 BFD_DBG ("wait for event without timeout");
758 (void) vlib_process_wait_for_event (vm);
759 event_type = vlib_process_get_events (vm, &event_data);
763 f64 timeout = ((i64) next_expire - (i64) now) / bm->cpu_cps;
764 BFD_DBG ("wait for event with timeout %.02f", timeout);
767 BFD_DBG ("negative timeout, already expired, skipping wait");
772 (void) vlib_process_wait_for_event_or_clock (vm, timeout);
773 event_type = vlib_process_get_events (vm, &event_data);
776 now = clib_cpu_time_now ();
779 case ~0: /* no events => timeout */
780 /* nothing to do here */
782 case BFD_EVENT_RESCHEDULE:
783 /* nothing to do here - reschedule is done automatically after
784 * each event or timeout */
786 case BFD_EVENT_NEW_SESSION:
787 if (!pool_is_free_index (bm->sessions, *event_data))
790 pool_elt_at_index (bm->sessions, *event_data);
791 bfd_send_periodic (vm, rt, bm, bs, now, 1);
795 BFD_DBG ("Ignoring event for non-existent session index %u",
799 case BFD_EVENT_CONFIG_CHANGED:
800 if (!pool_is_free_index (bm->sessions, *event_data))
803 pool_elt_at_index (bm->sessions, *event_data);
804 bfd_on_config_change (vm, rt, bm, bs, now);
808 BFD_DBG ("Ignoring event for non-existent session index %u",
813 clib_warning ("BUG: event type 0x%wx", event_type);
816 BFD_DBG ("advancing wheel, now is %lu", now);
817 BFD_DBG ("timing_wheel_advance (%p, %lu, %p, 0);", &bm->wheel, now,
819 expired = timing_wheel_advance (&bm->wheel, now, expired, 0);
820 BFD_DBG ("Expired %d elements", vec_len (expired));
822 vec_foreach (p, expired)
824 const u32 bs_idx = *p;
825 if (!pool_is_free_index (bm->sessions, bs_idx))
827 bfd_session_t *bs = pool_elt_at_index (bm->sessions, bs_idx);
828 bfd_on_timeout (vm, rt, bm, bs, now);
833 _vec_len (expired) = 0;
837 _vec_len (event_data) = 0;
845 * bfd process node declaration
848 VLIB_REGISTER_NODE (bfd_process_node, static) = {
849 .function = bfd_process,
850 .type = VLIB_NODE_TYPE_PROCESS,
851 .name = "bfd-process",
857 static clib_error_t *
858 bfd_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
860 // bfd_main_t *bm = &bfd_main;
861 // vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
862 if (!(flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
869 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (bfd_sw_interface_up_down);
871 static clib_error_t *
872 bfd_hw_interface_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
874 // bfd_main_t *bm = &bfd_main;
875 if (flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
882 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION (bfd_hw_interface_up_down);
887 static clib_error_t *
888 bfd_main_init (vlib_main_t * vm)
891 setbuf (stdout, NULL);
893 bfd_main_t *bm = &bfd_main;
894 bm->random_seed = random_default_seed ();
896 bm->vnet_main = vnet_get_main ();
897 memset (&bm->wheel, 0, sizeof (bm->wheel));
898 bm->cpu_cps = vm->clib_time.clocks_per_second;
899 BFD_DBG ("cps is %.2f", bm->cpu_cps);
900 bm->default_desired_min_tx_clocks =
901 bfd_usec_to_clocks (bm, BFD_DEFAULT_DESIRED_MIN_TX_US);
902 const u64 now = clib_cpu_time_now ();
903 timing_wheel_init (&bm->wheel, now, bm->cpu_cps);
904 bm->wheel_inaccuracy = 2 << bm->wheel.log2_clocks_per_bin;
906 vlib_node_t *node = NULL;
908 node = vlib_get_node_by_name (vm, (u8 *)n); \
909 bfd_node_index_by_transport[BFD_TRANSPORT_##t] = node->index; \
910 BFD_DBG ("node '%s' has index %u", n, node->index);
911 foreach_bfd_transport (F);
916 VLIB_INIT_FUNCTION (bfd_main_init);
919 bfd_get_session (bfd_main_t * bm, bfd_transport_t t)
921 bfd_session_t *result;
922 pool_get (bm->sessions, result);
923 memset (result, 0, sizeof (*result));
924 result->bs_idx = result - bm->sessions;
925 result->transport = t;
926 result->local_discr = random_u32 (&bm->random_seed);
927 bfd_set_defaults (bm, result);
928 hash_set (bm->session_by_disc, result->local_discr, result->bs_idx);
933 bfd_put_session (bfd_main_t * bm, bfd_session_t * bs)
935 if (bs->auth.curr_key)
937 --bs->auth.curr_key->use_count;
939 if (bs->auth.next_key)
941 --bs->auth.next_key->use_count;
943 hash_unset (bm->session_by_disc, bs->local_discr);
944 pool_put (bm->sessions, bs);
948 bfd_find_session_by_idx (bfd_main_t * bm, uword bs_idx)
950 if (!pool_is_free_index (bm->sessions, bs_idx))
952 return pool_elt_at_index (bm->sessions, bs_idx);
958 bfd_find_session_by_disc (bfd_main_t * bm, u32 disc)
960 uword *p = hash_get (bfd_main.session_by_disc, disc);
963 return pool_elt_at_index (bfd_main.sessions, *p);
969 * @brief verify bfd packet - common checks
973 * @return 1 if bfd packet is valid
976 bfd_verify_pkt_common (const bfd_pkt_t * pkt)
978 if (1 != bfd_pkt_get_version (pkt))
980 BFD_ERR ("BFD verification failed - unexpected version: '%d'",
981 bfd_pkt_get_version (pkt));
984 if (pkt->head.length < sizeof (bfd_pkt_t) ||
985 (bfd_pkt_get_auth_present (pkt) &&
986 pkt->head.length < sizeof (bfd_pkt_with_common_auth_t)))
988 BFD_ERR ("BFD verification failed - unexpected length: '%d' (auth "
990 pkt->head.length, bfd_pkt_get_auth_present (pkt));
993 if (!pkt->head.detect_mult)
995 BFD_ERR ("BFD verification failed - unexpected detect-mult: '%d'",
996 pkt->head.detect_mult);
999 if (bfd_pkt_get_multipoint (pkt))
1001 BFD_ERR ("BFD verification failed - unexpected multipoint: '%d'",
1002 bfd_pkt_get_multipoint (pkt));
1007 BFD_ERR ("BFD verification failed - unexpected my-disc: '%d'",
1011 if (!pkt->your_disc)
1013 const u8 pkt_state = bfd_pkt_get_state (pkt);
1014 if (pkt_state != BFD_STATE_down && pkt_state != BFD_STATE_admin_down)
1016 BFD_ERR ("BFD verification failed - unexpected state: '%s' "
1017 "(your-disc is zero)", bfd_state_string (pkt_state));
1025 bfd_session_switch_auth_to_next (bfd_session_t * bs)
1027 BFD_DBG ("Switching authentication key from %U to %U for bs_idx=%u",
1028 format_bfd_auth_key, bs->auth.curr_key, format_bfd_auth_key,
1029 bs->auth.next_key, bs->bs_idx);
1030 bs->auth.is_delayed = 0;
1031 if (bs->auth.curr_key)
1033 --bs->auth.curr_key->use_count;
1035 bs->auth.curr_key = bs->auth.next_key;
1036 bs->auth.next_key = NULL;
1037 bs->auth.curr_bfd_key_id = bs->auth.next_bfd_key_id;
1041 bfd_auth_type_is_meticulous (bfd_auth_type_e auth_type)
1043 if (BFD_AUTH_TYPE_meticulous_keyed_md5 == auth_type ||
1044 BFD_AUTH_TYPE_meticulous_keyed_sha1 == auth_type)
1052 bfd_verify_pkt_auth_seq_num (bfd_session_t * bs,
1053 u32 received_seq_num, int is_meticulous)
1058 * This variable MUST be set to zero after no packets have been
1059 * received on this session for at least twice the Detection Time.
1061 u64 now = clib_cpu_time_now ();
1062 if (now - bs->last_rx_clocks > bs->detection_time_clocks * 2)
1064 BFD_DBG ("BFD peer unresponsive for %lu clocks, which is > 2 * "
1065 "detection_time=%u clocks, resetting remote_seq_number_known "
1067 now - bs->last_rx_clocks, bs->detection_time_clocks * 2);
1068 bs->auth.remote_seq_number_known = 0;
1070 if (bs->auth.remote_seq_number_known)
1072 /* remote sequence number is known, verify its validity */
1073 const u32 max_u32 = 0xffffffff;
1074 /* the calculation might wrap, account for the special case... */
1075 if (bs->auth.remote_seq_number > max_u32 - 3 * bs->local_detect_mult)
1081 * |----------+----------------------------+-----------|
1083 * | remote_seq_num------+
1085 * +-----(remote_seq_num + 3*detect_mult) % * 0xffffffff
1087 * x + y + z = 0xffffffff
1088 * x + z = 3 * detect_mult
1090 const u32 z = max_u32 - bs->auth.remote_seq_number;
1091 const u32 x = 3 * bs->local_detect_mult - z;
1092 if (received_seq_num > x &&
1093 received_seq_num < bs->auth.remote_seq_number + is_meticulous)
1096 ("Recvd sequence number=%u out of ranges <0, %u>, <%u, %u>",
1097 received_seq_num, x,
1098 bs->auth.remote_seq_number + is_meticulous, max_u32);
1105 const u32 min = bs->auth.remote_seq_number + is_meticulous;
1107 bs->auth.remote_seq_number + 3 * bs->local_detect_mult;
1108 if (received_seq_num < min || received_seq_num > max)
1110 BFD_ERR ("Recvd sequence number=%u out of range <%u, %u>",
1111 received_seq_num, min, max);
1120 bfd_verify_pkt_auth_key_sha1 (const bfd_pkt_t * pkt, u32 pkt_size,
1121 bfd_session_t * bs, u8 bfd_key_id,
1122 bfd_auth_key_t * auth_key)
1124 ASSERT (auth_key->auth_type == BFD_AUTH_TYPE_keyed_sha1 ||
1125 auth_key->auth_type == BFD_AUTH_TYPE_meticulous_keyed_sha1);
1127 u8 result[SHA_DIGEST_LENGTH];
1128 bfd_pkt_with_common_auth_t *with_common = (void *) pkt;
1129 if (pkt_size < sizeof (*with_common))
1131 BFD_ERR ("Packet size too small to hold authentication common header");
1134 if (with_common->common_auth.type != auth_key->auth_type)
1136 BFD_ERR ("BFD auth type mismatch, packet auth=%d:%s doesn't match "
1137 "in-use auth=%d:%s",
1138 with_common->common_auth.type,
1139 bfd_auth_type_str (with_common->common_auth.type),
1140 auth_key->auth_type, bfd_auth_type_str (auth_key->auth_type));
1143 bfd_pkt_with_sha1_auth_t *with_sha1 = (void *) pkt;
1144 if (pkt_size < sizeof (*with_sha1) ||
1145 with_sha1->sha1_auth.type_len.len < sizeof (with_sha1->sha1_auth))
1148 ("BFD size mismatch, payload size=%u, expected=%u, auth_len=%u, "
1149 "expected=%u", pkt_size, sizeof (*with_sha1),
1150 with_sha1->sha1_auth.type_len.len, sizeof (with_sha1->sha1_auth));
1153 if (with_sha1->sha1_auth.key_id != bfd_key_id)
1156 ("BFD key ID mismatch, packet key ID=%u doesn't match key ID=%u%s",
1157 with_sha1->sha1_auth.key_id, bfd_key_id,
1159 auth.is_delayed ? " (but a delayed auth change is scheduled)" : "");
1163 if (!SHA1_Init (&ctx))
1165 BFD_ERR ("SHA1_Init failed");
1168 /* ignore last 20 bytes - use the actual key data instead pkt data */
1169 if (!SHA1_Update (&ctx, with_sha1,
1170 sizeof (*with_sha1) - sizeof (with_sha1->sha1_auth.hash)))
1172 BFD_ERR ("SHA1_Update failed");
1175 if (!SHA1_Update (&ctx, auth_key->key, sizeof (auth_key->key)))
1177 BFD_ERR ("SHA1_Update failed");
1180 if (!SHA1_Final (result, &ctx))
1182 BFD_ERR ("SHA1_Final failed");
1185 if (0 == memcmp (result, with_sha1->sha1_auth.hash, SHA_DIGEST_LENGTH))
1189 BFD_ERR ("SHA1 hash: %U doesn't match the expected value: %U",
1190 format_hex_bytes, with_sha1->sha1_auth.hash, SHA_DIGEST_LENGTH,
1191 format_hex_bytes, result, SHA_DIGEST_LENGTH);
1196 bfd_verify_pkt_auth_key (const bfd_pkt_t * pkt, u32 pkt_size,
1197 bfd_session_t * bs, u8 bfd_key_id,
1198 bfd_auth_key_t * auth_key)
1200 switch (auth_key->auth_type)
1202 case BFD_AUTH_TYPE_reserved:
1203 clib_warning ("Internal error, unexpected auth_type=%d:%s",
1204 auth_key->auth_type,
1205 bfd_auth_type_str (auth_key->auth_type));
1207 case BFD_AUTH_TYPE_simple_password:
1209 ("Internal error, not implemented, unexpected auth_type=%d:%s",
1210 auth_key->auth_type, bfd_auth_type_str (auth_key->auth_type));
1212 case BFD_AUTH_TYPE_keyed_md5:
1214 case BFD_AUTH_TYPE_meticulous_keyed_md5:
1216 ("Internal error, not implemented, unexpected auth_type=%d:%s",
1217 auth_key->auth_type, bfd_auth_type_str (auth_key->auth_type));
1219 case BFD_AUTH_TYPE_keyed_sha1:
1221 case BFD_AUTH_TYPE_meticulous_keyed_sha1:
1225 const u32 seq_num = clib_net_to_host_u32 (((bfd_pkt_with_sha1_auth_t
1228 return bfd_verify_pkt_auth_seq_num (bs, seq_num,
1229 bfd_auth_type_is_meticulous
1230 (auth_key->auth_type))
1231 && bfd_verify_pkt_auth_key_sha1 (pkt, pkt_size, bs, bfd_key_id,
1237 ("Internal error, attempt to use SHA1 without SSL support");
1245 * @brief verify bfd packet - authentication
1249 * @return 1 if bfd packet is valid
1252 bfd_verify_pkt_auth (const bfd_pkt_t * pkt, u16 pkt_size, bfd_session_t * bs)
1254 if (bfd_pkt_get_auth_present (pkt))
1256 /* authentication present in packet */
1257 if (!bs->auth.curr_key)
1259 /* currently not using authentication - can we turn it on? */
1260 if (bs->auth.is_delayed && bs->auth.next_key)
1262 /* yes, switch is scheduled - make sure the auth is valid */
1263 if (bfd_verify_pkt_auth_key (pkt, pkt_size, bs,
1264 bs->auth.next_bfd_key_id,
1267 /* auth matches next key, do the switch, packet is valid */
1268 bfd_session_switch_auth_to_next (bs);
1275 /* yes, using authentication, verify the key */
1276 if (bfd_verify_pkt_auth_key (pkt, pkt_size, bs,
1277 bs->auth.curr_bfd_key_id,
1280 /* verification passed, packet is valid */
1285 /* verification failed - but maybe we need to switch key */
1286 if (bs->auth.is_delayed && bs->auth.next_key)
1288 /* delayed switch present, verify if that key works */
1289 if (bfd_verify_pkt_auth_key (pkt, pkt_size, bs,
1290 bs->auth.next_bfd_key_id,
1293 /* auth matches next key, switch key, packet is valid */
1294 bfd_session_switch_auth_to_next (bs);
1303 /* authentication in packet not present */
1304 if (pkt_size > sizeof (*pkt))
1306 BFD_ERR ("BFD verification failed - unexpected packet size '%d' "
1307 "(auth not present)", pkt_size);
1310 if (bs->auth.curr_key)
1312 /* currently authenticating - could we turn it off? */
1313 if (bs->auth.is_delayed && !bs->auth.next_key)
1315 /* yes, delayed switch to NULL key is scheduled */
1316 bfd_session_switch_auth_to_next (bs);
1322 /* no auth in packet, no auth in use - packet is valid */
1330 bfd_consume_pkt (bfd_main_t * bm, const bfd_pkt_t * pkt, u32 bs_idx)
1332 bfd_session_t *bs = bfd_find_session_by_idx (bm, bs_idx);
1337 BFD_DBG ("Scanning bfd packet, bs_idx=%d", bs->bs_idx);
1338 bs->remote_discr = pkt->my_disc;
1339 bs->remote_state = bfd_pkt_get_state (pkt);
1340 bs->remote_demand = bfd_pkt_get_demand (pkt);
1341 u64 now = clib_cpu_time_now ();
1342 bs->last_rx_clocks = now;
1343 if (bfd_pkt_get_auth_present (pkt))
1345 bfd_auth_type_e auth_type =
1346 ((bfd_pkt_with_common_auth_t *) (pkt))->common_auth.type;
1349 case BFD_AUTH_TYPE_reserved:
1351 case BFD_AUTH_TYPE_simple_password:
1353 case BFD_AUTH_TYPE_keyed_md5:
1355 case BFD_AUTH_TYPE_meticulous_keyed_md5:
1356 clib_warning ("Internal error, unexpected auth_type=%d:%s",
1357 auth_type, bfd_auth_type_str (auth_type));
1359 case BFD_AUTH_TYPE_keyed_sha1:
1361 case BFD_AUTH_TYPE_meticulous_keyed_sha1:
1364 bfd_pkt_with_sha1_auth_t *with_sha1 =
1365 (bfd_pkt_with_sha1_auth_t *) pkt;
1366 bs->auth.remote_seq_number =
1367 clib_net_to_host_u32 (with_sha1->sha1_auth.seq_num);
1368 bs->auth.remote_seq_number_known = 1;
1369 BFD_DBG ("Received sequence number %u",
1370 bs->auth.remote_seq_number);
1375 bs->remote_desired_min_tx_clocks =
1376 bfd_usec_to_clocks (bm, clib_net_to_host_u32 (pkt->des_min_tx));
1377 bs->remote_detect_mult = pkt->head.detect_mult;
1378 bfd_set_remote_required_min_rx (bm, bs, now,
1379 clib_net_to_host_u32 (pkt->req_min_rx), 0);
1381 If the Required Min Echo RX Interval field is zero, the
1382 transmission of Echo packets, if any, MUST cease.
1384 If a Poll Sequence is being transmitted by the local system and
1385 the Final (F) bit in the received packet is set, the Poll Sequence
1390 if (bs->poll_state == POLL_IN_PROGRESS && bfd_pkt_get_final (pkt))
1392 bs->poll_state = POLL_NOT_NEEDED;
1393 BFD_DBG ("Poll sequence terminated, bs_idx=%u", bs->bs_idx);
1394 if (BFD_STATE_up == bs->local_state)
1396 bfd_set_effective_required_min_rx (bm, bs, now,
1397 bs->config_required_min_rx_clocks);
1398 bfd_recalc_detection_time (bm, bs);
1399 bfd_set_timer (bm, bs, now, 0);
1402 if (BFD_STATE_admin_down == bs->local_state)
1404 if (BFD_STATE_admin_down == bs->remote_state)
1406 bfd_set_diag (bs, BFD_DIAG_CODE_neighbor_sig_down);
1407 bfd_set_state (bm, bs, BFD_STATE_down, 0);
1409 else if (BFD_STATE_down == bs->local_state)
1411 if (BFD_STATE_down == bs->remote_state)
1413 bfd_set_state (bm, bs, BFD_STATE_init, 0);
1415 else if (BFD_STATE_init == bs->remote_state)
1417 bfd_set_state (bm, bs, BFD_STATE_up, 0);
1420 else if (BFD_STATE_init == bs->local_state)
1422 if (BFD_STATE_up == bs->remote_state ||
1423 BFD_STATE_init == bs->remote_state)
1425 bfd_set_state (bm, bs, BFD_STATE_up, 0);
1428 else /* BFD_STATE_up == bs->local_state */
1430 if (BFD_STATE_down == bs->remote_state)
1432 bfd_set_diag (bs, BFD_DIAG_CODE_neighbor_sig_down);
1433 bfd_set_state (bm, bs, BFD_STATE_down, 0);
1439 bfd_poll_state_string (bfd_poll_state_e state)
1446 foreach_bfd_poll_state (F)
1453 format_bfd_session (u8 * s, va_list * args)
1455 const bfd_session_t *bs = va_arg (*args, bfd_session_t *);
1456 s = format (s, "BFD(%u): bfd.SessionState=%s, "
1457 "bfd.RemoteSessionState=%s, "
1458 "bfd.LocalDiscr=%u, "
1459 "bfd.RemoteDiscr=%u, "
1460 "bfd.LocalDiag=%s, "
1461 "bfd.DesiredMinTxInterval=%u, "
1462 "bfd.RequiredMinRxInterval=%u, "
1463 "bfd.RequiredMinEchoRxInterval=%u, "
1464 "bfd.RemoteMinRxInterval=%u, "
1465 "bfd.DemandMode=%s, "
1466 "bfd.RemoteDemandMode=%s, "
1467 "bfd.DetectMult=%u, "
1468 "Auth: {local-seq-num=%u, "
1469 "remote-seq-num=%u, "
1474 bs->bs_idx, bfd_state_string (bs->local_state),
1475 bfd_state_string (bs->remote_state), bs->local_discr,
1476 bs->remote_discr, bfd_diag_code_string (bs->local_diag),
1477 bs->config_desired_min_tx_usec, bs->config_required_min_rx_usec,
1478 1, bs->remote_min_rx_usec, (bs->local_demand ? "yes" : "no"),
1479 (bs->remote_demand ? "yes" : "no"), bs->local_detect_mult,
1480 bs->auth.local_seq_number, bs->auth.remote_seq_number,
1481 (bs->auth.is_delayed ? "yes" : "no"), format_bfd_auth_key,
1482 bs->auth.curr_key, format_bfd_auth_key, bs->auth.next_key,
1483 bfd_poll_state_string (bs->poll_state));
1488 bfd_auth_type_supported (bfd_auth_type_e auth_type)
1490 if (auth_type == BFD_AUTH_TYPE_keyed_sha1 ||
1491 auth_type == BFD_AUTH_TYPE_meticulous_keyed_sha1)
1499 bfd_auth_activate (bfd_session_t * bs, u32 conf_key_id,
1500 u8 bfd_key_id, u8 is_delayed)
1502 bfd_main_t *bm = &bfd_main;
1503 const uword *key_idx_p =
1504 hash_get (bm->auth_key_by_conf_key_id, conf_key_id);
1507 clib_warning ("Authentication key with config ID %u doesn't exist)",
1509 return VNET_API_ERROR_BFD_ENOENT;
1511 const uword key_idx = *key_idx_p;
1512 bfd_auth_key_t *key = pool_elt_at_index (bm->auth_keys, key_idx);
1515 if (bs->auth.next_key == key)
1517 /* already using this key, no changes required */
1520 bs->auth.next_key = key;
1521 bs->auth.next_bfd_key_id = bfd_key_id;
1522 bs->auth.is_delayed = 1;
1526 if (bs->auth.curr_key == key)
1528 /* already using this key, no changes required */
1531 if (bs->auth.curr_key)
1533 --bs->auth.curr_key->use_count;
1535 bs->auth.curr_key = key;
1536 bs->auth.curr_bfd_key_id = bfd_key_id;
1537 bs->auth.is_delayed = 0;
1540 BFD_DBG ("Session auth modified: %U", format_bfd_session, bs);
1545 bfd_auth_deactivate (bfd_session_t * bs, u8 is_delayed)
1550 /* not delayed - deactivate the current key right now */
1551 if (bs->auth.curr_key)
1553 --bs->auth.curr_key->use_count;
1554 bs->auth.curr_key = NULL;
1556 bs->auth.is_delayed = 0;
1560 /* delayed - mark as so */
1561 bs->auth.is_delayed = 1;
1564 * clear the next key unconditionally - either the auth change is not delayed
1565 * in which case the caller expects the session to not use authentication
1566 * from this point forward, or it is delayed, in which case the next_key
1567 * needs to be set to NULL to make it so in the future
1569 if (bs->auth.next_key)
1571 --bs->auth.next_key->use_count;
1572 bs->auth.next_key = NULL;
1574 BFD_DBG ("Session auth modified: %U", format_bfd_session, bs);
1577 clib_warning ("SSL missing, cannot deactivate BFD authentication");
1578 return VNET_API_ERROR_BFD_NOTSUPP;
1583 bfd_session_set_params (bfd_main_t * bm, bfd_session_t * bs,
1584 u32 desired_min_tx_usec,
1585 u32 required_min_rx_usec, u8 detect_mult)
1587 if (bs->local_detect_mult != detect_mult ||
1588 bs->config_desired_min_tx_usec != desired_min_tx_usec ||
1589 bs->config_required_min_rx_usec != required_min_rx_usec)
1591 BFD_DBG ("Changing session params: %U", format_bfd_session, bs);
1592 switch (bs->poll_state)
1594 case POLL_NOT_NEEDED:
1595 if (BFD_STATE_up == bs->local_state ||
1596 BFD_STATE_init == bs->local_state)
1598 /* poll sequence is not needed for detect multiplier change */
1599 if (bs->config_desired_min_tx_usec != desired_min_tx_usec ||
1600 bs->config_required_min_rx_usec != required_min_rx_usec)
1602 bs->poll_state = POLL_NEEDED;
1603 BFD_DBG ("Set poll state=%s, bs_idx=%u",
1604 bfd_poll_state_string (bs->poll_state),
1612 case POLL_IN_PROGRESS:
1613 /* can't change params now ... */
1614 BFD_ERR ("Poll in progress, cannot change params for session with "
1615 "bs_idx=%u", bs->bs_idx);
1616 return VNET_API_ERROR_BFD_EAGAIN;
1619 bs->local_detect_mult = detect_mult;
1620 bs->config_desired_min_tx_usec = desired_min_tx_usec;
1621 bs->config_desired_min_tx_clocks =
1622 bfd_usec_to_clocks (bm, desired_min_tx_usec);
1623 bs->config_required_min_rx_usec = required_min_rx_usec;
1624 bs->config_required_min_rx_clocks =
1625 bfd_usec_to_clocks (bm, required_min_rx_usec);
1626 BFD_DBG ("Changed session params: %U", format_bfd_session, bs);
1628 vlib_process_signal_event (bm->vlib_main, bm->bfd_process_node_index,
1629 BFD_EVENT_CONFIG_CHANGED, bs->bs_idx);
1633 BFD_DBG ("Ignore parameter change - no change, bs_idx=%u", bs->bs_idx);
1638 bfd_main_t bfd_main;
1641 * fd.io coding-style-patch-verification: ON
1644 * eval: (c-set-style "gnu")