FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
bfd_main.c
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 /**
16  * @file
17  * @brief BFD nodes implementation
18  */
19 
20 #if WITH_LIBSSL > 0
21 #include <openssl/sha.h>
22 #endif
23 
24 #if __SSE4_2__
25 #include <x86intrin.h>
26 #endif
27 
28 #include <vlibmemory/api.h>
29 #include <vppinfra/random.h>
30 #include <vppinfra/error.h>
31 #include <vppinfra/hash.h>
32 #include <vppinfra/xxhash.h>
33 #include <vnet/ethernet/ethernet.h>
34 #include <vnet/ethernet/packet.h>
35 #include <vnet/bfd/bfd_debug.h>
36 #include <vnet/bfd/bfd_protocol.h>
37 #include <vnet/bfd/bfd_main.h>
38 #include <vlib/log.h>
39 
40 static u64
41 bfd_calc_echo_checksum (u32 discriminator, u64 expire_time, u32 secret)
42 {
43  u64 checksum = 0;
44 #if defined(clib_crc32c_uses_intrinsics) && !defined (__i386__)
45  checksum = crc32_u64 (0, discriminator);
46  checksum = crc32_u64 (checksum, expire_time);
47  checksum = crc32_u64 (checksum, secret);
48 #else
49  checksum = clib_xxhash (discriminator ^ expire_time ^ secret);
50 #endif
51  return checksum;
52 }
53 
54 static u64
56 {
57  return bm->cpu_cps * ((f64) us / USEC_PER_SECOND);
58 }
59 
60 u32
61 bfd_clocks_to_usec (const bfd_main_t * bm, u64 clocks)
62 {
63  return (clocks / bm->cpu_cps) * USEC_PER_SECOND;
64 }
65 
67 
68 u8 *
69 format_bfd_auth_key (u8 * s, va_list * args)
70 {
71  const bfd_auth_key_t *key = va_arg (*args, bfd_auth_key_t *);
72  if (key)
73  {
74  s = format (s, "{auth-type=%u:%s, conf-key-id=%u, use-count=%u}, ",
76  key->conf_key_id, key->use_count);
77  }
78  else
79  {
80  s = format (s, "{none}");
81  }
82  return s;
83 }
84 
85 /*
86  * We actually send all bfd pkts to the "error" node after scanning
87  * them, so the graph node has only one next-index. The "error-drop"
88  * node automatically bumps our per-node packet counters for us.
89  */
90 typedef enum
91 {
95 
96 static void bfd_on_state_change (bfd_main_t * bm, bfd_session_t * bs, u64 now,
97  int handling_wakeup);
98 
99 static void
101 {
102  bs->local_state = BFD_STATE_down;
103  bs->local_diag = BFD_DIAG_CODE_no_diag;
104  bs->remote_state = BFD_STATE_down;
105  bs->remote_discr = 0;
106  bs->hop_type = BFD_HOP_TYPE_SINGLE;
110  bs->remote_min_rx_usec = 1;
112  bs->remote_min_echo_rx_usec = 0;
114  bs->remote_demand = 0;
115  bs->auth.remote_seq_number = 0;
118  bs->echo_secret = random_u32 (&bm->random_seed);
119 }
120 
121 static void
123 {
124  if (bs->local_diag != code)
125  {
126  BFD_DBG ("set local_diag, bs_idx=%d: '%d:%s'", bs->bs_idx, code,
127  bfd_diag_code_string (code));
128  bs->local_diag = code;
129  }
130 }
131 
132 static void
134  bfd_state_e new_state, int handling_wakeup)
135 {
136  if (bs->local_state != new_state)
137  {
138  BFD_DBG ("Change state, bs_idx=%d: %s->%s", bs->bs_idx,
140  bfd_state_string (new_state));
141  bs->local_state = new_state;
142  bfd_on_state_change (bm, bs, clib_cpu_time_now (), handling_wakeup);
143  }
144 }
145 
146 const char *
148 {
149  switch (state)
150  {
151 #define F(x) \
152  case BFD_POLL_##x: \
153  return "BFD_POLL_" #x;
155 #undef F
156  }
157  return "UNKNOWN";
158 }
159 
160 static void
162 {
163  if (bs->poll_state != state)
164  {
165  BFD_DBG ("Setting poll state=%s, bs_idx=%u",
166  bfd_poll_state_string (state), bs->bs_idx);
167  bs->poll_state = state;
168  }
169 }
170 
171 static void
173 {
176  BFD_DBG ("Recalculated transmit interval " BFD_CLK_FMT,
177  BFD_CLK_PRN (bs->transmit_interval_clocks));
178 }
179 
180 static void
182 {
186  BFD_DBG ("Recalculated echo transmit interval " BFD_CLK_FMT,
187  BFD_CLK_PRN (bs->echo_transmit_interval_clocks));
188 }
189 
190 static void
192 {
193  if (bs->local_detect_mult > 1)
194  {
195  /* common case - 75-100% of transmit interval */
197  (1 - .25 * (random_f64 (&bm->random_seed))) *
199  if (bs->tx_timeout_clocks < now)
200  {
201  /*
202  * the timeout is in the past, which means that either remote
203  * demand mode was set or performance/clock issues ...
204  */
205  BFD_DBG ("Missed %lu transmit events (now is %lu, calc "
206  "tx_timeout is %lu)",
207  (now - bs->tx_timeout_clocks) /
209  bs->tx_timeout_clocks = now;
210  }
211  }
212  else
213  {
214  /* special case - 75-90% of transmit interval */
216  (.9 - .15 * (random_f64 (&bm->random_seed))) *
218  if (bs->tx_timeout_clocks < now)
219  {
220  /*
221  * the timeout is in the past, which means that either remote
222  * demand mode was set or performance/clock issues ...
223  */
224  BFD_DBG ("Missed %lu transmit events (now is %lu, calc "
225  "tx_timeout is %lu)",
226  (now - bs->tx_timeout_clocks) /
228  bs->tx_timeout_clocks = now;
229  }
230  }
231  if (bs->tx_timeout_clocks)
232  {
233  BFD_DBG ("Next transmit in %lu clocks/%.02fs@%lu",
234  bs->tx_timeout_clocks - now,
235  (bs->tx_timeout_clocks - now) / bm->cpu_cps,
236  bs->tx_timeout_clocks);
237  }
238 }
239 
240 static void
242 {
245  if (bs->echo_tx_timeout_clocks < now)
246  {
247  /* huh, we've missed it already, transmit now */
248  BFD_DBG ("Missed %lu echo transmit events (now is %lu, calc tx_timeout "
249  "is %lu)",
250  (now - bs->echo_tx_timeout_clocks) /
252  now, bs->echo_tx_timeout_clocks);
253  bs->echo_tx_timeout_clocks = now;
254  }
255  BFD_DBG ("Next echo transmit in %lu clocks/%.02fs@%lu",
256  bs->echo_tx_timeout_clocks - now,
257  (bs->echo_tx_timeout_clocks - now) / bm->cpu_cps,
259 }
260 
261 static void
263 {
264  if (bs->local_state == BFD_STATE_init || bs->local_state == BFD_STATE_up)
265  {
267  bs->remote_detect_mult *
270  BFD_DBG ("Recalculated detection time %lu clocks/%.2fs",
272  bs->detection_time_clocks / bm->cpu_cps);
273  }
274 }
275 
276 static void
278  int handling_wakeup)
279 {
280  u64 next = 0;
281  u64 rx_timeout = 0;
282  u64 tx_timeout = 0;
283  if (BFD_STATE_up == bs->local_state)
284  {
285  rx_timeout = bs->last_rx_clocks + bs->detection_time_clocks;
286  }
287  if (BFD_STATE_up != bs->local_state ||
288  (!bs->remote_demand && bs->remote_min_rx_usec) ||
289  BFD_POLL_NOT_NEEDED != bs->poll_state)
290  {
291  tx_timeout = bs->tx_timeout_clocks;
292  }
293  if (tx_timeout && rx_timeout)
294  {
295  next = clib_min (tx_timeout, rx_timeout);
296  }
297  else if (tx_timeout)
298  {
299  next = tx_timeout;
300  }
301  else if (rx_timeout)
302  {
303  next = rx_timeout;
304  }
305  if (bs->echo && next > bs->echo_tx_timeout_clocks)
306  {
307  next = bs->echo_tx_timeout_clocks;
308  }
309  BFD_DBG ("bs_idx=%u, tx_timeout=%lu, echo_tx_timeout=%lu, rx_timeout=%lu, "
310  "next=%s",
311  bs->bs_idx, tx_timeout, bs->echo_tx_timeout_clocks, rx_timeout,
312  next == tx_timeout
313  ? "tx" : (next == bs->echo_tx_timeout_clocks ? "echo tx" : "rx"));
314  /* sometimes the wheel expires an event a bit sooner than requested, account
315  for that here */
316  if (next && (now + bm->wheel_inaccuracy > bs->wheel_time_clocks ||
317  next < bs->wheel_time_clocks || !bs->wheel_time_clocks))
318  {
319  int send_signal = 0;
320  bs->wheel_time_clocks = next;
321  BFD_DBG ("timing_wheel_insert(%p, %lu (%ld clocks/%.2fs in the "
322  "future), %u);",
323  &bm->wheel, bs->wheel_time_clocks,
326  bm->cpu_cps, bs->bs_idx);
327  bfd_lock (bm);
329 
330  if (!handling_wakeup)
331  {
332 
333  /* Send only if it is earlier than current awaited wakeup time */
334  send_signal =
336  /*
337  * If the wake-up time is within 2x the delay of the event propagation delay,
338  * avoid the expense of sending the event. The 2x multiplier is to workaround the race whereby
339  * simultaneous event + expired timer create one recurring bogus wakeup/suspend instance,
340  * due to double scheduling of the node on the pending list.
341  */
344  /* Must be no events in flight to send an event */
346 
347  /* If we do send the signal, note this down along with the start timestamp */
348  if (send_signal)
349  {
352  }
353  }
354  bfd_unlock (bm);
355 
356  /* Use the multithreaded event sending so the workers can send events too */
357  if (send_signal)
358  {
362  }
363  }
364 }
365 
366 static void
368  bfd_session_t * bs, u64 now,
369  u64 desired_min_tx_clocks)
370 {
371  bs->effective_desired_min_tx_clocks = desired_min_tx_clocks;
372  BFD_DBG ("Set effective desired min tx to " BFD_CLK_FMT,
373  BFD_CLK_PRN (bs->effective_desired_min_tx_clocks));
374  bfd_recalc_detection_time (bm, bs);
375  bfd_recalc_tx_interval (bm, bs);
377  bfd_calc_next_tx (bm, bs, now);
378 }
379 
380 static void
382  bfd_session_t * bs,
383  u64 required_min_rx_clocks)
384 {
385  bs->effective_required_min_rx_clocks = required_min_rx_clocks;
386  BFD_DBG ("Set effective required min rx to " BFD_CLK_FMT,
387  BFD_CLK_PRN (bs->effective_required_min_rx_clocks));
388  bfd_recalc_detection_time (bm, bs);
389 }
390 
391 static void
393  u64 now, u32 remote_required_min_rx_usec)
394 {
395  if (bs->remote_min_rx_usec != remote_required_min_rx_usec)
396  {
397  bs->remote_min_rx_usec = remote_required_min_rx_usec;
399  bfd_usec_to_clocks (bm, remote_required_min_rx_usec);
400  BFD_DBG ("Set remote min rx to " BFD_CLK_FMT,
401  BFD_CLK_PRN (bs->remote_min_rx_clocks));
402  bfd_recalc_detection_time (bm, bs);
403  bfd_recalc_tx_interval (bm, bs);
404  }
405 }
406 
407 static void
409  u64 now,
410  u32 remote_required_min_echo_rx_usec)
411 {
412  if (bs->remote_min_echo_rx_usec != remote_required_min_echo_rx_usec)
413  {
414  bs->remote_min_echo_rx_usec = remote_required_min_echo_rx_usec;
417  BFD_DBG ("Set remote min echo rx to " BFD_CLK_FMT,
418  BFD_CLK_PRN (bs->remote_min_echo_rx_clocks));
420  }
421 }
422 
423 static void
425  bfd_listen_event_e event, const bfd_session_t * bs)
426 {
427  bfd_notify_fn_t *fn;
428  vec_foreach (fn, bm->listeners)
429  {
430  (*fn) (event, bs);
431  }
432 }
433 
434 void
436 {
437  BFD_DBG ("\nStarting session: %U", format_bfd_session, bs);
438  vlib_log_info (bm->log_class, "start BFD session: %U",
442  bfd_recalc_tx_interval (bm, bs);
445  bfd_notify_listeners (bm, BFD_LISTEN_EVENT_CREATE, bs);
446 }
447 
448 void
450 {
451  bfd_main_t *bm = &bfd_main;
452  u64 now = clib_cpu_time_now ();
453  if (admin_up_down)
454  {
455  BFD_DBG ("Session set admin-up, bs-idx=%u", bs->bs_idx);
456  vlib_log_info (bm->log_class, "set session admin-up: %U",
458  bfd_set_state (bm, bs, BFD_STATE_down, 0);
459  bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
460  bfd_calc_next_tx (bm, bs, now);
461  bfd_set_timer (bm, bs, now, 0);
462  }
463  else
464  {
465  BFD_DBG ("Session set admin-down, bs-idx=%u", bs->bs_idx);
466  vlib_log_info (bm->log_class, "set session admin-down: %U",
468  bfd_set_diag (bs, BFD_DIAG_CODE_admin_down);
469  bfd_set_state (bm, bs, BFD_STATE_admin_down, 0);
470  bfd_calc_next_tx (bm, bs, now);
471  bfd_set_timer (bm, bs, now, 0);
472  }
473 }
474 
475 u8 *
476 bfd_input_format_trace (u8 * s, va_list * args)
477 {
478  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
479  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
480  const bfd_input_trace_t *t = va_arg (*args, bfd_input_trace_t *);
481  const bfd_pkt_t *pkt = (bfd_pkt_t *) t->data;
482  if (t->len > STRUCT_SIZE_OF (bfd_pkt_t, head))
483  {
484  s = format (s, "BFD v%u, diag=%u(%s), state=%u(%s),\n"
485  " flags=(P:%u, F:%u, C:%u, A:%u, D:%u, M:%u), "
486  "detect_mult=%u, length=%u\n",
489  bfd_pkt_get_state (pkt),
491  bfd_pkt_get_poll (pkt), bfd_pkt_get_final (pkt),
494  bfd_pkt_get_multipoint (pkt), pkt->head.detect_mult,
495  pkt->head.length);
496  if (t->len >= sizeof (bfd_pkt_t) &&
497  pkt->head.length >= sizeof (bfd_pkt_t))
498  {
499  s = format (s, " my discriminator: %u\n",
500  clib_net_to_host_u32 (pkt->my_disc));
501  s = format (s, " your discriminator: %u\n",
502  clib_net_to_host_u32 (pkt->your_disc));
503  s = format (s, " desired min tx interval: %u\n",
504  clib_net_to_host_u32 (pkt->des_min_tx));
505  s = format (s, " required min rx interval: %u\n",
506  clib_net_to_host_u32 (pkt->req_min_rx));
507  s = format (s, " required min echo rx interval: %u",
508  clib_net_to_host_u32 (pkt->req_min_echo_rx));
509  }
510  if (t->len >= sizeof (bfd_pkt_with_common_auth_t) &&
511  pkt->head.length >= sizeof (bfd_pkt_with_common_auth_t) &&
513  {
514  const bfd_pkt_with_common_auth_t *with_auth = (void *) pkt;
515  const bfd_auth_common_t *common = &with_auth->common_auth;
516  s = format (s, "\n auth len: %u\n", common->len);
517  s = format (s, " auth type: %u:%s\n", common->type,
518  bfd_auth_type_str (common->type));
519  if (t->len >= sizeof (bfd_pkt_with_sha1_auth_t) &&
520  pkt->head.length >= sizeof (bfd_pkt_with_sha1_auth_t) &&
521  (BFD_AUTH_TYPE_keyed_sha1 == common->type ||
522  BFD_AUTH_TYPE_meticulous_keyed_sha1 == common->type))
523  {
524  const bfd_pkt_with_sha1_auth_t *with_sha1 = (void *) pkt;
525  const bfd_auth_sha1_t *sha1 = &with_sha1->sha1_auth;
526  s = format (s, " seq num: %u\n",
527  clib_net_to_host_u32 (sha1->seq_num));
528  s = format (s, " key id: %u\n", sha1->key_id);
529  s = format (s, " hash: %U", format_hex_bytes, sha1->hash,
530  sizeof (sha1->hash));
531  }
532  }
533  else
534  {
535  s = format (s, "\n");
536  }
537  }
538 
539  return s;
540 }
541 
542 typedef struct
543 {
546 
547 static void
549 {
550  bfd_main_t *bm = &bfd_main;
551  u32 bs_idx = a->bs_idx;
552  u32 valid_bs = 0;
553  bfd_session_t session_data;
554 
555  bfd_lock (bm);
556  if (!pool_is_free_index (bm->sessions, bs_idx))
557  {
558  bfd_session_t *bs = pool_elt_at_index (bm->sessions, bs_idx);
559  clib_memcpy (&session_data, bs, sizeof (bfd_session_t));
560  valid_bs = 1;
561  }
562  else
563  {
564  BFD_DBG ("Ignoring event RPC for non-existent session index %u",
565  bs_idx);
566  }
567  bfd_unlock (bm);
568 
569  if (valid_bs)
570  bfd_event (bm, &session_data);
571 }
572 
573 static void
575 {
576  const u32 data_size = sizeof (bfd_rpc_event_t);
577  u8 data[data_size];
578  bfd_rpc_event_t *event = (bfd_rpc_event_t *) data;
579 
580  event->bs_idx = bs_idx;
582 }
583 
584 typedef struct
585 {
588 
589 static void
591 {
592  bfd_main_t *bm = &bfd_main;
593  u32 bs_idx = a->bs_idx;
594  bfd_lock (bm);
595  if (!pool_is_free_index (bm->sessions, bs_idx))
596  {
597  bfd_session_t *bs = pool_elt_at_index (bm->sessions, bs_idx);
598  bfd_notify_listeners (bm, BFD_LISTEN_EVENT_UPDATE, bs);
599  }
600  else
601  {
602  BFD_DBG ("Ignoring notify RPC for non-existent session index %u",
603  bs_idx);
604  }
605  bfd_unlock (bm);
606 }
607 
608 static void
610 {
611  const u32 data_size = sizeof (bfd_rpc_notify_listeners_t);
612  u8 data[data_size];
614  notify->bs_idx = bs_idx;
616 }
617 
618 static void
620  int handling_wakeup)
621 {
622  BFD_DBG ("\nState changed: %U", format_bfd_session, bs);
623 
624  if (vlib_get_thread_index () == 0)
625  {
626  bfd_event (bm, bs);
627  }
628  else
629  {
630  /* without RPC - a REGRESSION: BFD event are not propagated */
631  bfd_event_rpc (bs->bs_idx);
632  }
633 
634  switch (bs->local_state)
635  {
636  case BFD_STATE_admin_down:
637  bs->echo = 0;
639  clib_max
644  bfd_set_timer (bm, bs, now, handling_wakeup);
645  break;
646  case BFD_STATE_down:
647  bs->echo = 0;
649  clib_max
654  bfd_set_timer (bm, bs, now, handling_wakeup);
655  break;
656  case BFD_STATE_init:
657  bs->echo = 0;
660  bfd_set_timer (bm, bs, now, handling_wakeup);
661  break;
662  case BFD_STATE_up:
665  if (BFD_POLL_NOT_NEEDED == bs->poll_state)
666  {
669  }
670  bfd_set_timer (bm, bs, now, handling_wakeup);
671  break;
672  }
673  if (vlib_get_thread_index () == 0)
674  {
675  bfd_notify_listeners (bm, BFD_LISTEN_EVENT_UPDATE, bs);
676  }
677  else
678  {
679  /* without RPC - a REGRESSION: state changes are not propagated */
681  }
682 }
683 
684 static void
686  bfd_main_t * bm, bfd_session_t * bs, u64 now)
687 {
688  /*
689  * if remote demand mode is set and we need to do a poll, set the next
690  * timeout so that the session wakes up immediately
691  */
692  if (bs->remote_demand && BFD_POLL_NEEDED == bs->poll_state &&
694  {
695  bs->tx_timeout_clocks = now;
696  }
697  bfd_recalc_detection_time (bm, bs);
698  bfd_set_timer (bm, bs, now, 0);
699 }
700 
701 static void
703 {
704  switch (bs->transport)
705  {
706  case BFD_TRANSPORT_UDP4:
707  BFD_DBG ("Transport bfd via udp4, bs_idx=%u", bs->bs_idx);
708  bfd_add_udp4_transport (vm, bi, bs, 0 /* is_echo */ );
709  break;
710  case BFD_TRANSPORT_UDP6:
711  BFD_DBG ("Transport bfd via udp6, bs_idx=%u", bs->bs_idx);
712  bfd_add_udp6_transport (vm, bi, bs, 0 /* is_echo */ );
713  break;
714  }
715 }
716 
717 static int
719 {
720  switch (bs->transport)
721  {
722  case BFD_TRANSPORT_UDP4:
723  BFD_DBG ("Transport bfd via udp4, bs_idx=%u", bs->bs_idx);
724  return bfd_transport_udp4 (vm, bi, bs);
725  break;
726  case BFD_TRANSPORT_UDP6:
727  BFD_DBG ("Transport bfd via udp6, bs_idx=%u", bs->bs_idx);
728  return bfd_transport_udp6 (vm, bi, bs);
729  break;
730  }
731  return 0;
732 }
733 
734 static int
736 {
737  switch (bs->transport)
738  {
739  case BFD_TRANSPORT_UDP4:
740  BFD_DBG ("Transport bfd echo via udp4, bs_idx=%u", bs->bs_idx);
741  return bfd_add_udp4_transport (vm, bi, bs, 1 /* is_echo */ );
742  break;
743  case BFD_TRANSPORT_UDP6:
744  BFD_DBG ("Transport bfd echo via udp6, bs_idx=%u", bs->bs_idx);
745  return bfd_add_udp6_transport (vm, bi, bs, 1 /* is_echo */ );
746  break;
747  }
748  return 0;
749 }
750 
751 static int
753 {
754  switch (bs->transport)
755  {
756  case BFD_TRANSPORT_UDP4:
757  BFD_DBG ("Transport bfd echo via udp4, bs_idx=%u", bs->bs_idx);
758  return bfd_transport_udp4 (vm, bi, bs);
759  break;
760  case BFD_TRANSPORT_UDP6:
761  BFD_DBG ("Transport bfd echo via udp6, bs_idx=%u", bs->bs_idx);
762  return bfd_transport_udp6 (vm, bi, bs);
763  break;
764  }
765  return 0;
766 }
767 
768 #if WITH_LIBSSL > 0
769 static void
770 bfd_add_sha1_auth_section (vlib_buffer_t * b, bfd_session_t * bs)
771 {
772  bfd_pkt_with_sha1_auth_t *pkt = vlib_buffer_get_current (b);
773  bfd_auth_sha1_t *auth = &pkt->sha1_auth;
774  b->current_length += sizeof (*auth);
775  pkt->pkt.head.length += sizeof (*auth);
776  bfd_pkt_set_auth_present (&pkt->pkt);
777  clib_memset (auth, 0, sizeof (*auth));
778  auth->type_len.type = bs->auth.curr_key->auth_type;
779  /*
780  * only meticulous authentication types require incrementing seq number
781  * for every message, but doing so doesn't violate the RFC
782  */
783  ++bs->auth.local_seq_number;
784  auth->type_len.len = sizeof (bfd_auth_sha1_t);
785  auth->key_id = bs->auth.curr_bfd_key_id;
786  auth->seq_num = clib_host_to_net_u32 (bs->auth.local_seq_number);
787  /*
788  * first copy the password into the packet, then calculate the hash
789  * and finally replace the password with the calculated hash
790  */
791  clib_memcpy (auth->hash, bs->auth.curr_key->key,
792  sizeof (bs->auth.curr_key->key));
793  unsigned char hash[sizeof (auth->hash)];
794  SHA1 ((unsigned char *) pkt, sizeof (*pkt), hash);
795  BFD_DBG ("hashing: %U", format_hex_bytes, pkt, sizeof (*pkt));
796  clib_memcpy (auth->hash, hash, sizeof (hash));
797 }
798 #endif
799 
800 static void
802 {
803  bfd_main_t *bm = &bfd_main;
804  if (bs->auth.curr_key)
805  {
806  const bfd_auth_type_e auth_type = bs->auth.curr_key->auth_type;
807  switch (auth_type)
808  {
809  case BFD_AUTH_TYPE_reserved:
810  /* fallthrough */
811  case BFD_AUTH_TYPE_simple_password:
812  /* fallthrough */
813  case BFD_AUTH_TYPE_keyed_md5:
814  /* fallthrough */
815  case BFD_AUTH_TYPE_meticulous_keyed_md5:
817  "internal error, unexpected BFD auth type '%d'",
818  auth_type);
819  break;
820 #if WITH_LIBSSL > 0
821  case BFD_AUTH_TYPE_keyed_sha1:
822  /* fallthrough */
823  case BFD_AUTH_TYPE_meticulous_keyed_sha1:
824  bfd_add_sha1_auth_section (b, bs);
825  break;
826 #else
827  case BFD_AUTH_TYPE_keyed_sha1:
828  /* fallthrough */
829  case BFD_AUTH_TYPE_meticulous_keyed_sha1:
831  "internal error, unexpected BFD auth type '%d'",
832  auth_type);
833  break;
834 #endif
835  }
836  }
837 }
838 
839 static int
841 {
842  if (BFD_STATE_up == bs->local_state && BFD_STATE_up == bs->remote_state &&
843  bs->remote_min_echo_rx_usec > 0)
844  {
845  switch (bs->transport)
846  {
847  case BFD_TRANSPORT_UDP4:
848  return bfd_udp_is_echo_available (BFD_TRANSPORT_UDP4);
849  case BFD_TRANSPORT_UDP6:
850  return bfd_udp_is_echo_available (BFD_TRANSPORT_UDP6);
851  }
852  }
853  return 0;
854 }
855 
856 static void
858  vlib_buffer_t * b)
859 {
860  bfd_pkt_t *pkt = vlib_buffer_get_current (b);
861  u32 bfd_length = 0;
862  bfd_length = sizeof (bfd_pkt_t);
863  clib_memset (pkt, 0, sizeof (*pkt));
864  bfd_pkt_set_version (pkt, 1);
866  bfd_pkt_set_state (pkt, bs->local_state);
867  pkt->head.detect_mult = bs->local_detect_mult;
868  pkt->head.length = bfd_length;
869  pkt->my_disc = bs->local_discr;
870  pkt->your_disc = bs->remote_discr;
871  pkt->des_min_tx = clib_host_to_net_u32 (bs->config_desired_min_tx_usec);
872  if (bs->echo)
873  {
874  pkt->req_min_rx =
875  clib_host_to_net_u32 (bfd_clocks_to_usec
877  }
878  else
879  {
880  pkt->req_min_rx =
881  clib_host_to_net_u32 (bs->config_required_min_rx_usec);
882  }
883  pkt->req_min_echo_rx = clib_host_to_net_u32 (1);
884  b->current_length = bfd_length;
885 }
886 
887 static void
889  bfd_main_t * bm, bfd_session_t * bs, u64 now)
890 {
891  if (!bfd_is_echo_possible (bs))
892  {
893  BFD_DBG ("\nSwitching off echo function: %U", format_bfd_session, bs);
894  bs->echo = 0;
895  return;
896  }
897  /* sometimes the wheel expires an event a bit sooner than requested,
898  account
899  for that here */
900  if (now + bm->wheel_inaccuracy >= bs->echo_tx_timeout_clocks)
901  {
902  BFD_DBG ("\nSending echo packet: %U", format_bfd_session, bs);
903  u32 bi;
904  if (vlib_buffer_alloc (vm, &bi, 1) != 1)
905  {
906  vlib_log_crit (bm->log_class, "buffer allocation failure");
907  return;
908  }
909  vlib_buffer_t *b = vlib_get_buffer (vm, bi);
910  ASSERT (b->current_data == 0);
912  bfd_echo_pkt_t *pkt = vlib_buffer_get_current (b);
913  clib_memset (pkt, 0, sizeof (*pkt));
914  pkt->discriminator = bs->local_discr;
915  pkt->expire_time_clocks =
917  pkt->checksum =
918  bfd_calc_echo_checksum (bs->local_discr, pkt->expire_time_clocks,
919  bs->echo_secret);
920  b->current_length = sizeof (*pkt);
921  if (!bfd_echo_add_transport_layer (vm, bi, bs))
922  {
923  BFD_ERR ("cannot send echo packet out, turning echo off");
924  bs->echo = 0;
925  vlib_buffer_free_one (vm, bi);
926  return;
927  }
928  if (!bfd_transport_echo (vm, bi, bs))
929  {
930  BFD_ERR ("cannot send echo packet out, turning echo off");
931  bs->echo = 0;
932  vlib_buffer_free_one (vm, bi);
933  return;
934  }
935  bs->echo_last_tx_clocks = now;
936  bfd_calc_next_echo_tx (bm, bs, now);
937  }
938  else
939  {
940  BFD_DBG
941  ("No need to send echo packet now, now is %lu, tx_timeout is %lu",
942  now, bs->echo_tx_timeout_clocks);
943  }
944 }
945 
946 static void
948  bfd_main_t * bm, bfd_session_t * bs, u64 now)
949 {
950  if (!bs->remote_min_rx_usec && BFD_POLL_NOT_NEEDED == bs->poll_state)
951  {
952  BFD_DBG ("Remote min rx interval is zero, not sending periodic control "
953  "frame");
954  return;
955  }
956  if (BFD_POLL_NOT_NEEDED == bs->poll_state && bs->remote_demand &&
957  BFD_STATE_up == bs->local_state && BFD_STATE_up == bs->remote_state)
958  {
959  /*
960  * A system MUST NOT periodically transmit BFD Control packets if Demand
961  * mode is active on the remote system (bfd.RemoteDemandMode is 1,
962  * bfd.SessionState is Up, and bfd.RemoteSessionState is Up) and a Poll
963  * Sequence is not being transmitted.
964  */
965  BFD_DBG ("Remote demand is set, not sending periodic control frame");
966  return;
967  }
968  /*
969  * sometimes the wheel expires an event a bit sooner than requested, account
970  * for that here
971  */
972  if (now + bm->wheel_inaccuracy >= bs->tx_timeout_clocks)
973  {
974  BFD_DBG ("\nSending periodic control frame: %U", format_bfd_session,
975  bs);
976  u32 bi;
977  if (vlib_buffer_alloc (vm, &bi, 1) != 1)
978  {
979  vlib_log_crit (bm->log_class, "buffer allocation failure");
980  return;
981  }
982  vlib_buffer_t *b = vlib_get_buffer (vm, bi);
983  ASSERT (b->current_data == 0);
985  bfd_init_control_frame (bm, bs, b);
986  switch (bs->poll_state)
987  {
988  case BFD_POLL_NEEDED:
989  if (now < bs->poll_state_start_or_timeout_clocks)
990  {
991  BFD_DBG ("Cannot start a poll sequence yet, need to wait "
992  "for " BFD_CLK_FMT,
993  BFD_CLK_PRN (bs->poll_state_start_or_timeout_clocks -
994  now));
995  break;
996  }
998  bfd_set_poll_state (bs, BFD_POLL_IN_PROGRESS);
999  /* fallthrough */
1000  case BFD_POLL_IN_PROGRESS:
1001  case BFD_POLL_IN_PROGRESS_AND_QUEUED:
1003  BFD_DBG ("Setting poll bit in packet, bs_idx=%u", bs->bs_idx);
1004  break;
1005  case BFD_POLL_NOT_NEEDED:
1006  /* fallthrough */
1007  break;
1008  }
1009  bfd_add_auth_section (b, bs);
1010  bfd_add_transport_layer (vm, bi, bs);
1011  if (!bfd_transport_control_frame (vm, bi, bs))
1012  {
1013  vlib_buffer_free_one (vm, bi);
1014  }
1015  bs->last_tx_clocks = now;
1016  bfd_calc_next_tx (bm, bs, now);
1017  }
1018  else
1019  {
1020  BFD_DBG
1021  ("No need to send control frame now, now is %lu, tx_timeout is %lu",
1022  now, bs->tx_timeout_clocks);
1023  }
1024 }
1025 
1026 void
1028  bfd_main_t * bm, bfd_session_t * bs,
1029  int is_local)
1030 {
1031  BFD_DBG ("Send final control frame for bs_idx=%lu", bs->bs_idx);
1032  bfd_init_control_frame (bm, bs, b);
1034  bfd_add_auth_section (b, bs);
1035  u32 bi = vlib_get_buffer_index (vm, b);
1036  bfd_add_transport_layer (vm, bi, bs);
1038  /*
1039  * RFC allows to include changes in final frame, so if there were any
1040  * pending, we already did that, thus we can clear any pending poll needs
1041  */
1042  bfd_set_poll_state (bs, BFD_POLL_NOT_NEEDED);
1043 }
1044 
1045 static void
1047  int handling_wakeup)
1048 {
1049  /*
1050  * sometimes the wheel expires an event a bit sooner than requested, account
1051  * for that here
1052  */
1053  if (bs->last_rx_clocks + bs->detection_time_clocks <=
1054  now + bm->wheel_inaccuracy)
1055  {
1056  BFD_DBG ("Rx timeout, session goes down");
1057  bfd_set_diag (bs, BFD_DIAG_CODE_det_time_exp);
1058  bfd_set_state (bm, bs, BFD_STATE_down, handling_wakeup);
1059  /*
1060  * If the remote system does not receive any
1061  * BFD Control packets for a Detection Time, it SHOULD reset
1062  * bfd.RemoteMinRxInterval to its initial value of 1 (per section 6.8.1,
1063  * since it is no longer required to maintain previous session state)
1064  * and then can transmit at its own rate.
1065  */
1066  bfd_set_remote_required_min_rx (bm, bs, now, 1);
1067  }
1068  else if (bs->echo &&
1069  bs->echo_last_rx_clocks +
1071  now + bm->wheel_inaccuracy)
1072  {
1073  BFD_DBG ("Echo rx timeout, session goes down");
1074  bfd_set_diag (bs, BFD_DIAG_CODE_echo_failed);
1075  bfd_set_state (bm, bs, BFD_STATE_down, handling_wakeup);
1076  }
1077 }
1078 
1079 void
1081  bfd_session_t * bs, u64 now)
1082 {
1083  BFD_DBG ("Timeout for bs_idx=%lu", bs->bs_idx);
1084  switch (bs->local_state)
1085  {
1086  case BFD_STATE_admin_down:
1087  bfd_send_periodic (vm, rt, bm, bs, now);
1088  break;
1089  case BFD_STATE_down:
1090  bfd_send_periodic (vm, rt, bm, bs, now);
1091  break;
1092  case BFD_STATE_init:
1093  bfd_check_rx_timeout (bm, bs, now, 1);
1094  bfd_send_periodic (vm, rt, bm, bs, now);
1095  break;
1096  case BFD_STATE_up:
1097  bfd_check_rx_timeout (bm, bs, now, 1);
1098  if (BFD_POLL_NOT_NEEDED == bs->poll_state && !bs->echo &&
1099  bfd_is_echo_possible (bs))
1100  {
1101  /* switch on echo function as main detection method now */
1102  BFD_DBG ("Switching on echo function, bs_idx=%u", bs->bs_idx);
1103  bs->echo = 1;
1104  bs->echo_last_rx_clocks = now;
1105  bs->echo_tx_timeout_clocks = now;
1107  clib_max
1110  bfd_set_poll_state (bs, BFD_POLL_NEEDED);
1111  }
1112  bfd_send_periodic (vm, rt, bm, bs, now);
1113  if (bs->echo)
1114  {
1115  bfd_send_echo (vm, rt, bm, bs, now);
1116  }
1117  break;
1118  }
1119 }
1120 
1121 /*
1122  * bfd process node function
1123  */
1124 static uword
1126 {
1127  bfd_main_t *bm = &bfd_main;
1128  u32 *expired = 0;
1129  uword event_type, *event_data = 0;
1130 
1131  /* So we can send events to the bfd process */
1133 
1134  while (1)
1135  {
1136  u64 now = clib_cpu_time_now ();
1137  bfd_lock (bm);
1138  u64 next_expire = timing_wheel_next_expiring_elt_time (&bm->wheel);
1139  BFD_DBG ("timing_wheel_next_expiring_elt_time(%p) returns %lu",
1140  &bm->wheel, next_expire);
1142  (i64) next_expire >= 0 ? next_expire : ~0;
1143  bfd_unlock (bm);
1144  if ((i64) next_expire < 0)
1145  {
1146  BFD_DBG ("wait for event without timeout");
1147  (void) vlib_process_wait_for_event (vm);
1148  event_type = vlib_process_get_events (vm, &event_data);
1149  }
1150  else
1151  {
1152  f64 timeout = ((i64) next_expire - (i64) now) / bm->cpu_cps;
1153  BFD_DBG ("wait for event with timeout %.02f", timeout);
1154  if (timeout < 0)
1155  {
1156  BFD_DBG ("negative timeout, already expired, skipping wait");
1157  event_type = ~0;
1158  }
1159  else
1160  {
1161  (void) vlib_process_wait_for_event_or_clock (vm, timeout);
1162  event_type = vlib_process_get_events (vm, &event_data);
1163  }
1164  }
1165  now = clib_cpu_time_now ();
1166  uword *session_index;
1167  switch (event_type)
1168  {
1169  case ~0: /* no events => timeout */
1170  /* nothing to do here */
1171  break;
1172  case BFD_EVENT_RESCHEDULE:
1173  bfd_lock (bm);
1177  bfd_unlock (bm);
1178  /* nothing to do here - reschedule is done automatically after
1179  * each event or timeout */
1180  break;
1181  case BFD_EVENT_NEW_SESSION:
1182  vec_foreach (session_index, event_data)
1183  {
1184  bfd_lock (bm);
1185  if (!pool_is_free_index (bm->sessions, *session_index))
1186  {
1187  bfd_session_t *bs =
1188  pool_elt_at_index (bm->sessions, *session_index);
1189  bfd_send_periodic (vm, rt, bm, bs, now);
1190  bfd_set_timer (bm, bs, now, 1);
1191  }
1192  else
1193  {
1194  BFD_DBG ("Ignoring event for non-existent session index %u",
1195  (u32) * session_index);
1196  }
1197  bfd_unlock (bm);
1198  }
1199  break;
1201  vec_foreach (session_index, event_data)
1202  {
1203  bfd_lock (bm);
1204  if (!pool_is_free_index (bm->sessions, *session_index))
1205  {
1206  bfd_session_t *bs =
1207  pool_elt_at_index (bm->sessions, *session_index);
1208  bfd_on_config_change (vm, rt, bm, bs, now);
1209  }
1210  else
1211  {
1212  BFD_DBG ("Ignoring event for non-existent session index %u",
1213  (u32) * session_index);
1214  }
1215  bfd_unlock (bm);
1216  }
1217  break;
1218  default:
1219  vlib_log_err (bm->log_class, "BUG: event type 0x%wx", event_type);
1220  break;
1221  }
1222  BFD_DBG ("advancing wheel, now is %lu", now);
1223  BFD_DBG ("timing_wheel_advance (%p, %lu, %p, 0);", &bm->wheel, now,
1224  expired);
1225  bfd_lock (bm);
1226  expired = timing_wheel_advance (&bm->wheel, now, expired, 0);
1227  BFD_DBG ("Expired %d elements", vec_len (expired));
1228  u32 *p = NULL;
1229  vec_foreach (p, expired)
1230  {
1231  const u32 bs_idx = *p;
1232  if (!pool_is_free_index (bm->sessions, bs_idx))
1233  {
1234  bfd_session_t *bs = pool_elt_at_index (bm->sessions, bs_idx);
1235  bfd_on_timeout (vm, rt, bm, bs, now);
1236  bfd_set_timer (bm, bs, now, 1);
1237  }
1238  }
1239  bfd_unlock (bm);
1240  if (expired)
1241  {
1242  _vec_len (expired) = 0;
1243  }
1244  if (event_data)
1245  {
1246  _vec_len (event_data) = 0;
1247  }
1248  }
1249 
1250  return 0;
1251 }
1252 
1253 /*
1254  * bfd process node declaration
1255  */
1256 /* *INDENT-OFF* */
1258  .function = bfd_process,
1259  .type = VLIB_NODE_TYPE_PROCESS,
1260  .name = "bfd-process",
1261  .n_next_nodes = 0,
1262  .next_nodes = {},
1263 };
1264 /* *INDENT-ON* */
1265 
1266 static clib_error_t *
1268 {
1269  // bfd_main_t *bm = &bfd_main;
1270  // vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
1271  if (!(flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
1272  {
1273  /* TODO */
1274  }
1275  return 0;
1276 }
1277 
1279 
1280 static clib_error_t *
1282 {
1283  // bfd_main_t *bm = &bfd_main;
1284  if (flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
1285  {
1286  /* TODO */
1287  }
1288  return 0;
1289 }
1290 
1292 
1293 void
1295 {
1296  bfd_main_t *bm = &bfd_main;
1297 
1298  vec_add1 (bm->listeners, fn);
1299 }
1300 
1301 /*
1302  * setup function
1303  */
1304 static clib_error_t *
1306 {
1308  u32 n_vlib_mains = tm->n_vlib_mains;
1309 #if BFD_DEBUG
1310  setbuf (stdout, NULL);
1311 #endif
1312  bfd_main_t *bm = &bfd_main;
1314  bm->vlib_main = vm;
1315  bm->vnet_main = vnet_get_main ();
1316  clib_memset (&bm->wheel, 0, sizeof (bm->wheel));
1318  BFD_DBG ("cps is %.2f", bm->cpu_cps);
1323  const u64 now = clib_cpu_time_now ();
1324  timing_wheel_init (&bm->wheel, now, bm->cpu_cps);
1326  bm->log_class = vlib_log_register_class ("bfd", 0);
1327  vlib_log_debug (bm->log_class, "initialized");
1328  bm->owner_thread_index = ~0;
1329  if (n_vlib_mains > 1)
1330  clib_spinlock_init (&bm->lock);
1331  return 0;
1332 }
1333 
1335 
1336 bfd_session_t *
1338 {
1339  bfd_session_t *result;
1340 
1341  bfd_lock (bm);
1342 
1343  pool_get (bm->sessions, result);
1344  clib_memset (result, 0, sizeof (*result));
1345  result->bs_idx = result - bm->sessions;
1346  result->transport = t;
1347  const unsigned limit = 1000;
1348  unsigned counter = 0;
1349  do
1350  {
1351  result->local_discr = random_u32 (&bm->random_seed);
1352  if (counter > limit)
1353  {
1354  vlib_log_crit (bm->log_class,
1355  "couldn't allocate unused session discriminator even "
1356  "after %u tries!", limit);
1357  pool_put (bm->sessions, result);
1358  bfd_unlock (bm);
1359  return NULL;
1360  }
1361  ++counter;
1362  }
1363  while (hash_get (bm->session_by_disc, result->local_discr));
1364  bfd_set_defaults (bm, result);
1365  hash_set (bm->session_by_disc, result->local_discr, result->bs_idx);
1366  bfd_unlock (bm);
1367  return result;
1368 }
1369 
1370 void
1372 {
1373  bfd_lock (bm);
1374 
1375  vlib_log_info (bm->log_class, "delete session: %U",
1377  bfd_notify_listeners (bm, BFD_LISTEN_EVENT_DELETE, bs);
1378  if (bs->auth.curr_key)
1379  {
1380  --bs->auth.curr_key->use_count;
1381  }
1382  if (bs->auth.next_key)
1383  {
1384  --bs->auth.next_key->use_count;
1385  }
1387  pool_put (bm->sessions, bs);
1388  bfd_unlock (bm);
1389 }
1390 
1391 bfd_session_t *
1393 {
1394  bfd_lock_check (bm);
1395  if (!pool_is_free_index (bm->sessions, bs_idx))
1396  {
1397  return pool_elt_at_index (bm->sessions, bs_idx);
1398  }
1399  return NULL;
1400 }
1401 
1402 bfd_session_t *
1404 {
1405  bfd_lock_check (bm);
1406  uword *p = hash_get (bfd_main.session_by_disc, disc);
1407  if (p)
1408  {
1409  return pool_elt_at_index (bfd_main.sessions, *p);
1410  }
1411  return NULL;
1412 }
1413 
1414 /**
1415  * @brief verify bfd packet - common checks
1416  *
1417  * @param pkt
1418  *
1419  * @return 1 if bfd packet is valid
1420  */
1421 int
1422 bfd_verify_pkt_common (const bfd_pkt_t * pkt)
1423 {
1424  if (1 != bfd_pkt_get_version (pkt))
1425  {
1426  BFD_ERR ("BFD verification failed - unexpected version: '%d'",
1427  bfd_pkt_get_version (pkt));
1428  return 0;
1429  }
1430  if (pkt->head.length < sizeof (bfd_pkt_t) ||
1431  (bfd_pkt_get_auth_present (pkt) &&
1432  pkt->head.length < sizeof (bfd_pkt_with_common_auth_t)))
1433  {
1434  BFD_ERR ("BFD verification failed - unexpected length: '%d' (auth "
1435  "present: %d)",
1436  pkt->head.length, bfd_pkt_get_auth_present (pkt));
1437  return 0;
1438  }
1439  if (!pkt->head.detect_mult)
1440  {
1441  BFD_ERR ("BFD verification failed - unexpected detect-mult: '%d'",
1442  pkt->head.detect_mult);
1443  return 0;
1444  }
1445  if (bfd_pkt_get_multipoint (pkt))
1446  {
1447  BFD_ERR ("BFD verification failed - unexpected multipoint: '%d'",
1448  bfd_pkt_get_multipoint (pkt));
1449  return 0;
1450  }
1451  if (!pkt->my_disc)
1452  {
1453  BFD_ERR ("BFD verification failed - unexpected my-disc: '%d'",
1454  pkt->my_disc);
1455  return 0;
1456  }
1457  if (!pkt->your_disc)
1458  {
1459  const u8 pkt_state = bfd_pkt_get_state (pkt);
1460  if (pkt_state != BFD_STATE_down && pkt_state != BFD_STATE_admin_down)
1461  {
1462  BFD_ERR ("BFD verification failed - unexpected state: '%s' "
1463  "(your-disc is zero)", bfd_state_string (pkt_state));
1464  return 0;
1465  }
1466  }
1467  return 1;
1468 }
1469 
1470 static void
1472 {
1473  BFD_DBG ("Switching authentication key from %U to %U for bs_idx=%u",
1475  bs->auth.next_key, bs->bs_idx);
1476  bs->auth.is_delayed = 0;
1477  if (bs->auth.curr_key)
1478  {
1479  --bs->auth.curr_key->use_count;
1480  }
1481  bs->auth.curr_key = bs->auth.next_key;
1482  bs->auth.next_key = NULL;
1484 }
1485 
1486 static int
1488 {
1489  if (BFD_AUTH_TYPE_meticulous_keyed_md5 == auth_type ||
1490  BFD_AUTH_TYPE_meticulous_keyed_sha1 == auth_type)
1491  {
1492  return 1;
1493  }
1494  return 0;
1495 }
1496 
1497 static int
1499  u32 received_seq_num, int is_meticulous)
1500 {
1501  /*
1502  * RFC 5880 6.8.1:
1503  *
1504  * This variable MUST be set to zero after no packets have been
1505  * received on this session for at least twice the Detection Time.
1506  */
1507  u64 now = clib_cpu_time_now ();
1508  if (now - bs->last_rx_clocks > bs->detection_time_clocks * 2)
1509  {
1510  BFD_DBG ("BFD peer unresponsive for %lu clocks, which is > 2 * "
1511  "detection_time=%u clocks, resetting remote_seq_number_known "
1512  "flag",
1513  now - bs->last_rx_clocks, bs->detection_time_clocks * 2);
1514  bs->auth.remote_seq_number_known = 0;
1515  }
1516  if (bs->auth.remote_seq_number_known)
1517  {
1518  /* remote sequence number is known, verify its validity */
1519  const u32 max_u32 = 0xffffffff;
1520  /* the calculation might wrap, account for the special case... */
1521  if (bs->auth.remote_seq_number > max_u32 - 3 * bs->local_detect_mult)
1522  {
1523  /*
1524  * special case
1525  *
1526  * x y z
1527  * |----------+----------------------------+-----------|
1528  * 0 ^ ^ 0xffffffff
1529  * | remote_seq_num------+
1530  * |
1531  * +-----(remote_seq_num + 3*detect_mult) % * 0xffffffff
1532  *
1533  * x + y + z = 0xffffffff
1534  * x + z = 3 * detect_mult
1535  */
1536  const u32 z = max_u32 - bs->auth.remote_seq_number;
1537  const u32 x = 3 * bs->local_detect_mult - z;
1538  if (received_seq_num > x &&
1539  received_seq_num < bs->auth.remote_seq_number + is_meticulous)
1540  {
1541  BFD_ERR
1542  ("Recvd sequence number=%u out of ranges <0, %u>, <%u, %u>",
1543  received_seq_num, x,
1544  bs->auth.remote_seq_number + is_meticulous, max_u32);
1545  return 0;
1546  }
1547  }
1548  else
1549  {
1550  /* regular case */
1551  const u32 min = bs->auth.remote_seq_number + is_meticulous;
1552  const u32 max =
1554  if (received_seq_num < min || received_seq_num > max)
1555  {
1556  BFD_ERR ("Recvd sequence number=%u out of range <%u, %u>",
1557  received_seq_num, min, max);
1558  return 0;
1559  }
1560  }
1561  }
1562  return 1;
1563 }
1564 
1565 static int
1566 bfd_verify_pkt_auth_key_sha1 (const bfd_pkt_t * pkt, u32 pkt_size,
1567  bfd_session_t * bs, u8 bfd_key_id,
1568  bfd_auth_key_t * auth_key)
1569 {
1570  ASSERT (auth_key->auth_type == BFD_AUTH_TYPE_keyed_sha1 ||
1571  auth_key->auth_type == BFD_AUTH_TYPE_meticulous_keyed_sha1);
1572 
1573  u8 result[SHA_DIGEST_LENGTH];
1574  bfd_pkt_with_common_auth_t *with_common = (void *) pkt;
1575  if (pkt_size < sizeof (*with_common))
1576  {
1577  BFD_ERR ("Packet size too small to hold authentication common header");
1578  return 0;
1579  }
1580  if (with_common->common_auth.type != auth_key->auth_type)
1581  {
1582  BFD_ERR ("BFD auth type mismatch, packet auth=%d:%s doesn't match "
1583  "in-use auth=%d:%s",
1584  with_common->common_auth.type,
1585  bfd_auth_type_str (with_common->common_auth.type),
1586  auth_key->auth_type, bfd_auth_type_str (auth_key->auth_type));
1587  return 0;
1588  }
1589  bfd_pkt_with_sha1_auth_t *with_sha1 = (void *) pkt;
1590  if (pkt_size < sizeof (*with_sha1) ||
1591  with_sha1->sha1_auth.type_len.len < sizeof (with_sha1->sha1_auth))
1592  {
1593  BFD_ERR
1594  ("BFD size mismatch, payload size=%u, expected=%u, auth_len=%u, "
1595  "expected=%u", pkt_size, sizeof (*with_sha1),
1596  with_sha1->sha1_auth.type_len.len, sizeof (with_sha1->sha1_auth));
1597  return 0;
1598  }
1599  if (with_sha1->sha1_auth.key_id != bfd_key_id)
1600  {
1601  BFD_ERR
1602  ("BFD key ID mismatch, packet key ID=%u doesn't match key ID=%u%s",
1603  with_sha1->sha1_auth.key_id, bfd_key_id,
1604  bs->
1605  auth.is_delayed ? " (but a delayed auth change is scheduled)" : "");
1606  return 0;
1607  }
1608  SHA_CTX ctx;
1609  if (!SHA1_Init (&ctx))
1610  {
1611  BFD_ERR ("SHA1_Init failed");
1612  return 0;
1613  }
1614  /* ignore last 20 bytes - use the actual key data instead pkt data */
1615  if (!SHA1_Update (&ctx, with_sha1,
1616  sizeof (*with_sha1) - sizeof (with_sha1->sha1_auth.hash)))
1617  {
1618  BFD_ERR ("SHA1_Update failed");
1619  return 0;
1620  }
1621  if (!SHA1_Update (&ctx, auth_key->key, sizeof (auth_key->key)))
1622  {
1623  BFD_ERR ("SHA1_Update failed");
1624  return 0;
1625  }
1626  if (!SHA1_Final (result, &ctx))
1627  {
1628  BFD_ERR ("SHA1_Final failed");
1629  return 0;
1630  }
1631  if (0 == memcmp (result, with_sha1->sha1_auth.hash, SHA_DIGEST_LENGTH))
1632  {
1633  return 1;
1634  }
1635  BFD_ERR ("SHA1 hash: %U doesn't match the expected value: %U",
1636  format_hex_bytes, with_sha1->sha1_auth.hash, SHA_DIGEST_LENGTH,
1637  format_hex_bytes, result, SHA_DIGEST_LENGTH);
1638  return 0;
1639 }
1640 
1641 static int
1642 bfd_verify_pkt_auth_key (const bfd_pkt_t * pkt, u32 pkt_size,
1643  bfd_session_t * bs, u8 bfd_key_id,
1644  bfd_auth_key_t * auth_key)
1645 {
1646  bfd_main_t *bm = &bfd_main;
1647  switch (auth_key->auth_type)
1648  {
1649  case BFD_AUTH_TYPE_reserved:
1650  vlib_log_err (bm->log_class,
1651  "internal error, unexpected auth_type=%d:%s",
1652  auth_key->auth_type,
1653  bfd_auth_type_str (auth_key->auth_type));
1654  return 0;
1655  case BFD_AUTH_TYPE_simple_password:
1656  vlib_log_err (bm->log_class,
1657  "internal error, not implemented, unexpected auth_type=%d:%s",
1658  auth_key->auth_type,
1659  bfd_auth_type_str (auth_key->auth_type));
1660  return 0;
1661  case BFD_AUTH_TYPE_keyed_md5:
1662  /* fallthrough */
1663  case BFD_AUTH_TYPE_meticulous_keyed_md5:
1664  vlib_log_err
1665  (bm->log_class,
1666  "internal error, not implemented, unexpected auth_type=%d:%s",
1667  auth_key->auth_type, bfd_auth_type_str (auth_key->auth_type));
1668  return 0;
1669  case BFD_AUTH_TYPE_keyed_sha1:
1670  /* fallthrough */
1671  case BFD_AUTH_TYPE_meticulous_keyed_sha1:
1672 #if WITH_LIBSSL > 0
1673  do
1674  {
1675  const u32 seq_num = clib_net_to_host_u32 (((bfd_pkt_with_sha1_auth_t
1676  *) pkt)->
1677  sha1_auth.seq_num);
1678  return bfd_verify_pkt_auth_seq_num (bs, seq_num,
1680  (auth_key->auth_type))
1681  && bfd_verify_pkt_auth_key_sha1 (pkt, pkt_size, bs, bfd_key_id,
1682  auth_key);
1683  }
1684  while (0);
1685 #else
1686  vlib_log_err
1687  (bm->log_class,
1688  "internal error, attempt to use SHA1 without SSL support");
1689  return 0;
1690 #endif
1691  }
1692  return 0;
1693 }
1694 
1695 /**
1696  * @brief verify bfd packet - authentication
1697  *
1698  * @param pkt
1699  *
1700  * @return 1 if bfd packet is valid
1701  */
1702 int
1703 bfd_verify_pkt_auth (const bfd_pkt_t * pkt, u16 pkt_size, bfd_session_t * bs)
1704 {
1705  if (bfd_pkt_get_auth_present (pkt))
1706  {
1707  /* authentication present in packet */
1708  if (!bs->auth.curr_key)
1709  {
1710  /* currently not using authentication - can we turn it on? */
1711  if (bs->auth.is_delayed && bs->auth.next_key)
1712  {
1713  /* yes, switch is scheduled - make sure the auth is valid */
1714  if (bfd_verify_pkt_auth_key (pkt, pkt_size, bs,
1715  bs->auth.next_bfd_key_id,
1716  bs->auth.next_key))
1717  {
1718  /* auth matches next key, do the switch, packet is valid */
1720  return 1;
1721  }
1722  }
1723  }
1724  else
1725  {
1726  /* yes, using authentication, verify the key */
1727  if (bfd_verify_pkt_auth_key (pkt, pkt_size, bs,
1728  bs->auth.curr_bfd_key_id,
1729  bs->auth.curr_key))
1730  {
1731  /* verification passed, packet is valid */
1732  return 1;
1733  }
1734  else
1735  {
1736  /* verification failed - but maybe we need to switch key */
1737  if (bs->auth.is_delayed && bs->auth.next_key)
1738  {
1739  /* delayed switch present, verify if that key works */
1740  if (bfd_verify_pkt_auth_key (pkt, pkt_size, bs,
1741  bs->auth.next_bfd_key_id,
1742  bs->auth.next_key))
1743  {
1744  /* auth matches next key, switch key, packet is valid */
1746  return 1;
1747  }
1748  }
1749  }
1750  }
1751  }
1752  else
1753  {
1754  /* authentication in packet not present */
1755  if (pkt_size > sizeof (*pkt))
1756  {
1757  BFD_ERR ("BFD verification failed - unexpected packet size '%d' "
1758  "(auth not present)", pkt_size);
1759  return 0;
1760  }
1761  if (bs->auth.curr_key)
1762  {
1763  /* currently authenticating - could we turn it off? */
1764  if (bs->auth.is_delayed && !bs->auth.next_key)
1765  {
1766  /* yes, delayed switch to NULL key is scheduled */
1768  return 1;
1769  }
1770  }
1771  else
1772  {
1773  /* no auth in packet, no auth in use - packet is valid */
1774  return 1;
1775  }
1776  }
1777  return 0;
1778 }
1779 
1780 void
1781 bfd_consume_pkt (bfd_main_t * bm, const bfd_pkt_t * pkt, u32 bs_idx)
1782 {
1783  bfd_lock_check (bm);
1784 
1785  bfd_session_t *bs = bfd_find_session_by_idx (bm, bs_idx);
1786  if (!bs || (pkt->your_disc && pkt->your_disc != bs->local_discr))
1787  {
1788  return;
1789  }
1790  BFD_DBG ("Scanning bfd packet, bs_idx=%d", bs->bs_idx);
1791  bs->remote_discr = pkt->my_disc;
1792  bs->remote_state = bfd_pkt_get_state (pkt);
1793  bs->remote_demand = bfd_pkt_get_demand (pkt);
1794  bs->remote_diag = bfd_pkt_get_diag_code (pkt);
1795  u64 now = clib_cpu_time_now ();
1796  bs->last_rx_clocks = now;
1797  if (bfd_pkt_get_auth_present (pkt))
1798  {
1799  bfd_auth_type_e auth_type =
1800  ((bfd_pkt_with_common_auth_t *) (pkt))->common_auth.type;
1801  switch (auth_type)
1802  {
1803  case BFD_AUTH_TYPE_reserved:
1804  /* fallthrough */
1805  case BFD_AUTH_TYPE_simple_password:
1806  /* fallthrough */
1807  case BFD_AUTH_TYPE_keyed_md5:
1808  /* fallthrough */
1809  case BFD_AUTH_TYPE_meticulous_keyed_md5:
1810  vlib_log_crit (bm->log_class,
1811  "internal error, unexpected auth_type=%d:%s",
1812  auth_type, bfd_auth_type_str (auth_type));
1813  break;
1814  case BFD_AUTH_TYPE_keyed_sha1:
1815  /* fallthrough */
1816  case BFD_AUTH_TYPE_meticulous_keyed_sha1:
1817  do
1818  {
1819  bfd_pkt_with_sha1_auth_t *with_sha1 =
1820  (bfd_pkt_with_sha1_auth_t *) pkt;
1821  bs->auth.remote_seq_number =
1822  clib_net_to_host_u32 (with_sha1->sha1_auth.seq_num);
1823  bs->auth.remote_seq_number_known = 1;
1824  BFD_DBG ("Received sequence number %u",
1825  bs->auth.remote_seq_number);
1826  }
1827  while (0);
1828  }
1829  }
1831  bfd_usec_to_clocks (bm, clib_net_to_host_u32 (pkt->des_min_tx));
1832  bs->remote_detect_mult = pkt->head.detect_mult;
1833  bfd_set_remote_required_min_rx (bm, bs, now,
1834  clib_net_to_host_u32 (pkt->req_min_rx));
1836  clib_net_to_host_u32
1837  (pkt->req_min_echo_rx));
1838  if (bfd_pkt_get_final (pkt))
1839  {
1840  if (BFD_POLL_IN_PROGRESS == bs->poll_state)
1841  {
1842  BFD_DBG ("Poll sequence terminated, bs_idx=%u", bs->bs_idx);
1843  bfd_set_poll_state (bs, BFD_POLL_NOT_NEEDED);
1844  if (BFD_STATE_up == bs->local_state)
1845  {
1847  clib_max (bs->echo *
1850  }
1851  }
1852  else if (BFD_POLL_IN_PROGRESS_AND_QUEUED == bs->poll_state)
1853  {
1854  /*
1855  * next poll sequence must be delayed by at least the round trip
1856  * time, so calculate that here
1857  */
1858  BFD_DBG ("Next poll sequence can commence in " BFD_CLK_FMT,
1859  BFD_CLK_PRN (now -
1862  now + (now - bs->poll_state_start_or_timeout_clocks);
1863  BFD_DBG
1864  ("Poll sequence terminated, but another is needed, bs_idx=%u",
1865  bs->bs_idx);
1866  bfd_set_poll_state (bs, BFD_POLL_NEEDED);
1867  }
1868  }
1869  bfd_calc_next_tx (bm, bs, now);
1870  bfd_set_timer (bm, bs, now, 0);
1871  if (BFD_STATE_admin_down == bs->local_state)
1872  {
1873  BFD_DBG ("Session is admin-down, ignoring packet, bs_idx=%u",
1874  bs->bs_idx);
1875  return;
1876  }
1877  if (BFD_STATE_admin_down == bs->remote_state)
1878  {
1879  bfd_set_diag (bs, BFD_DIAG_CODE_neighbor_sig_down);
1880  bfd_set_state (bm, bs, BFD_STATE_down, 0);
1881  }
1882  else if (BFD_STATE_down == bs->local_state)
1883  {
1884  if (BFD_STATE_down == bs->remote_state)
1885  {
1886  bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
1887  bfd_set_state (bm, bs, BFD_STATE_init, 0);
1888  }
1889  else if (BFD_STATE_init == bs->remote_state)
1890  {
1891  bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
1892  bfd_set_state (bm, bs, BFD_STATE_up, 0);
1893  }
1894  }
1895  else if (BFD_STATE_init == bs->local_state)
1896  {
1897  if (BFD_STATE_up == bs->remote_state ||
1898  BFD_STATE_init == bs->remote_state)
1899  {
1900  bfd_set_diag (bs, BFD_DIAG_CODE_no_diag);
1901  bfd_set_state (bm, bs, BFD_STATE_up, 0);
1902  }
1903  }
1904  else /* BFD_STATE_up == bs->local_state */
1905  {
1906  if (BFD_STATE_down == bs->remote_state)
1907  {
1908  bfd_set_diag (bs, BFD_DIAG_CODE_neighbor_sig_down);
1909  bfd_set_state (bm, bs, BFD_STATE_down, 0);
1910  }
1911  }
1912 }
1913 
1914 int
1916 {
1917  bfd_echo_pkt_t *pkt = NULL;
1918  if (b->current_length != sizeof (*pkt))
1919  {
1920  return 0;
1921  }
1922  pkt = vlib_buffer_get_current (b);
1923  bfd_session_t *bs = bfd_find_session_by_disc (bm, pkt->discriminator);
1924  if (!bs)
1925  {
1926  return 0;
1927  }
1928  BFD_DBG ("Scanning bfd echo packet, bs_idx=%d", bs->bs_idx);
1929  u64 checksum =
1930  bfd_calc_echo_checksum (bs->local_discr, pkt->expire_time_clocks,
1931  bs->echo_secret);
1932  if (checksum != pkt->checksum)
1933  {
1934  BFD_DBG ("Invalid echo packet, checksum mismatch");
1935  return 1;
1936  }
1937  u64 now = clib_cpu_time_now ();
1938  if (pkt->expire_time_clocks < now)
1939  {
1940  BFD_DBG ("Stale packet received, expire time %lu < now %lu",
1941  pkt->expire_time_clocks, now);
1942  }
1943  else
1944  {
1945  bs->echo_last_rx_clocks = now;
1946  }
1947  return 1;
1948 }
1949 
1950 u8 *
1951 format_bfd_session (u8 * s, va_list * args)
1952 {
1953  const bfd_session_t *bs = va_arg (*args, bfd_session_t *);
1954  u32 indent = format_get_indent (s) + vlib_log_get_indent ();
1955  s = format (s, "bs_idx=%u local-state=%s remote-state=%s\n"
1956  "%Ulocal-discriminator=%u remote-discriminator=%u\n"
1957  "%Ulocal-diag=%s echo-active=%s\n"
1958  "%Udesired-min-tx=%u required-min-rx=%u\n"
1959  "%Urequired-min-echo-rx=%u detect-mult=%u\n"
1960  "%Uremote-min-rx=%u remote-min-echo-rx=%u\n"
1961  "%Uremote-demand=%s poll-state=%s\n"
1962  "%Uauth: local-seq-num=%u remote-seq-num=%u\n"
1963  "%U is-delayed=%s\n"
1964  "%U curr-key=%U\n"
1965  "%U next-key=%U",
1966  bs->bs_idx, bfd_state_string (bs->local_state),
1968  bs->local_discr, bs->remote_discr, format_white_space, indent,
1970  (bs->echo ? "yes" : "no"), format_white_space, indent,
1972  format_white_space, indent, 1, bs->local_detect_mult,
1975  (bs->remote_demand ? "yes" : "no"),
1977  indent, bs->auth.local_seq_number, bs->auth.remote_seq_number,
1978  format_white_space, indent,
1979  (bs->auth.is_delayed ? "yes" : "no"), format_white_space,
1980  indent, format_bfd_auth_key, bs->auth.curr_key,
1982  bs->auth.next_key);
1983  return s;
1984 }
1985 
1986 u8 *
1987 format_bfd_session_brief (u8 * s, va_list * args)
1988 {
1989  const bfd_session_t *bs = va_arg (*args, bfd_session_t *);
1990  s =
1991  format (s, "bs_idx=%u local-state=%s remote-state=%s", bs->bs_idx,
1994  return s;
1995 }
1996 
1997 unsigned
1999 {
2000  if (auth_type == BFD_AUTH_TYPE_keyed_sha1 ||
2001  auth_type == BFD_AUTH_TYPE_meticulous_keyed_sha1)
2002  {
2003  return 1;
2004  }
2005  return 0;
2006 }
2007 
2010  u8 bfd_key_id, u8 is_delayed)
2011 {
2012  bfd_main_t *bm = &bfd_main;
2013  const uword *key_idx_p =
2014  hash_get (bm->auth_key_by_conf_key_id, conf_key_id);
2015  if (!key_idx_p)
2016  {
2017  vlib_log_err (bm->log_class,
2018  "authentication key with config ID %u doesn't exist)",
2019  conf_key_id);
2020  return VNET_API_ERROR_BFD_ENOENT;
2021  }
2022  const uword key_idx = *key_idx_p;
2023  bfd_auth_key_t *key = pool_elt_at_index (bm->auth_keys, key_idx);
2024  if (is_delayed)
2025  {
2026  if (bs->auth.next_key == key)
2027  {
2028  /* already using this key, no changes required */
2029  return 0;
2030  }
2031  bs->auth.next_key = key;
2032  bs->auth.next_bfd_key_id = bfd_key_id;
2033  bs->auth.is_delayed = 1;
2034  }
2035  else
2036  {
2037  if (bs->auth.curr_key == key)
2038  {
2039  /* already using this key, no changes required */
2040  return 0;
2041  }
2042  if (bs->auth.curr_key)
2043  {
2044  --bs->auth.curr_key->use_count;
2045  }
2046  bs->auth.curr_key = key;
2047  bs->auth.curr_bfd_key_id = bfd_key_id;
2048  bs->auth.is_delayed = 0;
2049  }
2050  ++key->use_count;
2051  BFD_DBG ("\nSession auth modified: %U", format_bfd_session, bs);
2052  vlib_log_info (bm->log_class, "session auth modified: %U",
2054  return 0;
2055 }
2056 
2059 {
2060  bfd_main_t *bm = &bfd_main;
2061 #if WITH_LIBSSL > 0
2062  if (!is_delayed)
2063  {
2064  /* not delayed - deactivate the current key right now */
2065  if (bs->auth.curr_key)
2066  {
2067  --bs->auth.curr_key->use_count;
2068  bs->auth.curr_key = NULL;
2069  }
2070  bs->auth.is_delayed = 0;
2071  }
2072  else
2073  {
2074  /* delayed - mark as so */
2075  bs->auth.is_delayed = 1;
2076  }
2077  /*
2078  * clear the next key unconditionally - either the auth change is not delayed
2079  * in which case the caller expects the session to not use authentication
2080  * from this point forward, or it is delayed, in which case the next_key
2081  * needs to be set to NULL to make it so in the future
2082  */
2083  if (bs->auth.next_key)
2084  {
2085  --bs->auth.next_key->use_count;
2086  bs->auth.next_key = NULL;
2087  }
2088  BFD_DBG ("\nSession auth modified: %U", format_bfd_session, bs);
2089  vlib_log_info (bm->log_class, "session auth modified: %U",
2091  return 0;
2092 #else
2093  vlib_log_err (bm->log_class,
2094  "SSL missing, cannot deactivate BFD authentication");
2095  return VNET_API_ERROR_BFD_NOTSUPP;
2096 #endif
2097 }
2098 
2101  u32 desired_min_tx_usec,
2102  u32 required_min_rx_usec, u8 detect_mult)
2103 {
2104  if (bs->local_detect_mult != detect_mult ||
2105  bs->config_desired_min_tx_usec != desired_min_tx_usec ||
2106  bs->config_required_min_rx_usec != required_min_rx_usec)
2107  {
2108  BFD_DBG ("\nChanging session params: %U", format_bfd_session, bs);
2109  switch (bs->poll_state)
2110  {
2111  case BFD_POLL_NOT_NEEDED:
2112  if (BFD_STATE_up == bs->local_state ||
2113  BFD_STATE_init == bs->local_state)
2114  {
2115  /* poll sequence is not needed for detect multiplier change */
2116  if (bs->config_desired_min_tx_usec != desired_min_tx_usec ||
2117  bs->config_required_min_rx_usec != required_min_rx_usec)
2118  {
2119  bfd_set_poll_state (bs, BFD_POLL_NEEDED);
2120  }
2121  }
2122  break;
2123  case BFD_POLL_NEEDED:
2124  case BFD_POLL_IN_PROGRESS_AND_QUEUED:
2125  /*
2126  * nothing to do - will be handled in the future poll which is
2127  * already scheduled for execution
2128  */
2129  break;
2130  case BFD_POLL_IN_PROGRESS:
2131  /* poll sequence is not needed for detect multiplier change */
2132  if (bs->config_desired_min_tx_usec != desired_min_tx_usec ||
2133  bs->config_required_min_rx_usec != required_min_rx_usec)
2134  {
2135  BFD_DBG ("Poll in progress, queueing extra poll, bs_idx=%u",
2136  bs->bs_idx);
2137  bfd_set_poll_state (bs, BFD_POLL_IN_PROGRESS_AND_QUEUED);
2138  }
2139  }
2140 
2141  bs->local_detect_mult = detect_mult;
2142  bs->config_desired_min_tx_usec = desired_min_tx_usec;
2144  bfd_usec_to_clocks (bm, desired_min_tx_usec);
2145  bs->config_required_min_rx_usec = required_min_rx_usec;
2147  bfd_usec_to_clocks (bm, required_min_rx_usec);
2148  BFD_DBG ("\nChanged session params: %U", format_bfd_session, bs);
2149 
2150  vlib_log_info (bm->log_class, "changed session params: %U",
2154  }
2155  else
2156  {
2157  BFD_DBG ("Ignore parameter change - no change, bs_idx=%u", bs->bs_idx);
2158  }
2159  return 0;
2160 }
2161 
2163 bfd_auth_set_key (u32 conf_key_id, u8 auth_type, u8 key_len,
2164  const u8 * key_data)
2165 {
2166  bfd_main_t *bm = &bfd_main;
2167 #if WITH_LIBSSL > 0
2168  bfd_auth_key_t *auth_key = NULL;
2169  if (!key_len || key_len > bfd_max_key_len_for_auth_type (auth_type))
2170  {
2171  vlib_log_err (bm->log_class,
2172  "invalid authentication key length for auth_type=%d:%s "
2173  "(key_len=%u, must be non-zero, expected max=%u)",
2174  auth_type, bfd_auth_type_str (auth_type), key_len,
2175  (u32) bfd_max_key_len_for_auth_type (auth_type));
2176  return VNET_API_ERROR_INVALID_VALUE;
2177  }
2178  if (!bfd_auth_type_supported (auth_type))
2179  {
2180  vlib_log_err (bm->log_class, "unsupported auth type=%d:%s", auth_type,
2181  bfd_auth_type_str (auth_type));
2182  return VNET_API_ERROR_BFD_NOTSUPP;
2183  }
2184  uword *key_idx_p = hash_get (bm->auth_key_by_conf_key_id, conf_key_id);
2185  if (key_idx_p)
2186  {
2187  /* modifying existing key - must not be used */
2188  const uword key_idx = *key_idx_p;
2189  auth_key = pool_elt_at_index (bm->auth_keys, key_idx);
2190  if (auth_key->use_count > 0)
2191  {
2192  vlib_log_err (bm->log_class,
2193  "authentication key with conf ID %u in use by %u BFD "
2194  "session(s) - cannot modify", conf_key_id,
2195  auth_key->use_count);
2196  return VNET_API_ERROR_BFD_EINUSE;
2197  }
2198  }
2199  else
2200  {
2201  /* adding new key */
2202  pool_get (bm->auth_keys, auth_key);
2203  auth_key->conf_key_id = conf_key_id;
2204  hash_set (bm->auth_key_by_conf_key_id, conf_key_id,
2205  auth_key - bm->auth_keys);
2206  }
2207  auth_key->auth_type = auth_type;
2208  clib_memset (auth_key->key, 0, sizeof (auth_key->key));
2209  clib_memcpy (auth_key->key, key_data, key_len);
2210  return 0;
2211 #else
2212  vlib_log_err (bm->log_class,
2213  "SSL missing, cannot manipulate authentication keys");
2214  return VNET_API_ERROR_BFD_NOTSUPP;
2215 #endif
2216 }
2217 
2219 bfd_auth_del_key (u32 conf_key_id)
2220 {
2221 #if WITH_LIBSSL > 0
2222  bfd_auth_key_t *auth_key = NULL;
2223  bfd_main_t *bm = &bfd_main;
2224  uword *key_idx_p = hash_get (bm->auth_key_by_conf_key_id, conf_key_id);
2225  if (key_idx_p)
2226  {
2227  /* deleting existing key - must not be used */
2228  const uword key_idx = *key_idx_p;
2229  auth_key = pool_elt_at_index (bm->auth_keys, key_idx);
2230  if (auth_key->use_count > 0)
2231  {
2232  vlib_log_err (bm->log_class,
2233  "authentication key with conf ID %u in use by %u BFD "
2234  "session(s) - cannot delete", conf_key_id,
2235  auth_key->use_count);
2236  return VNET_API_ERROR_BFD_EINUSE;
2237  }
2238  hash_unset (bm->auth_key_by_conf_key_id, conf_key_id);
2239  clib_memset (auth_key, 0, sizeof (*auth_key));
2240  pool_put (bm->auth_keys, auth_key);
2241  }
2242  else
2243  {
2244  /* no such key */
2245  vlib_log_err (bm->log_class,
2246  "authentication key with conf ID %u does not exist",
2247  conf_key_id);
2248  return VNET_API_ERROR_BFD_ENOENT;
2249  }
2250  return 0;
2251 #else
2252  vlib_log_err (bm->log_class,
2253  "SSL missing, cannot manipulate authentication keys");
2254  return VNET_API_ERROR_BFD_NOTSUPP;
2255 #endif
2256 }
2257 
2259 
2260 /*
2261  * fd.io coding-style-patch-verification: ON
2262  *
2263  * Local Variables:
2264  * eval: (c-set-style "gnu")
2265  * End:
2266  */
vlib_log_class_t vlib_log_register_class(char *class, char *subclass)
Definition: log.c:176
VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(bfd_hw_interface_up_down)
static u64 bfd_usec_to_clocks(const bfd_main_t *bm, u64 us)
Definition: bfd_main.c:55
static int bfd_transport_control_frame(vlib_main_t *vm, u32 bi, bfd_session_t *bs)
Definition: bfd_main.c:718
u8 bfd_pkt_get_auth_present(const bfd_pkt_t *pkt)
Definition: bfd_protocol.c:98
static void bfd_notify_listeners_rpc(u32 bs_idx)
Definition: bfd_main.c:609
static void bfd_recalc_echo_tx_interval(bfd_main_t *bm, bfd_session_t *bs)
Definition: bfd_main.c:181
static void bfd_on_state_change(bfd_main_t *bm, bfd_session_t *bs, u64 now, int handling_wakeup)
Definition: bfd_main.c:619
struct bfd_session_s::@124 auth
authentication information
bfd_session_t * bfd_get_session(bfd_main_t *bm, bfd_transport_e t)
Definition: bfd_main.c:1337
bfd_notify_fn_t * listeners
vector of callback notification functions
Definition: bfd_main.h:319
vnet_api_error_t
Definition: api_errno.h:158
#define hash_set(h, key, value)
Definition: hash.h:255
bfd_auth_type_e auth_type
authentication type for this key
Definition: bfd_main.h:55
void bfd_consume_pkt(bfd_main_t *bm, const bfd_pkt_t *pkt, u32 bs_idx)
Definition: bfd_main.c:1781
#define clib_min(x, y)
Definition: clib.h:295
u8 curr_bfd_key_id
current key ID sent out in bfd packet
Definition: bfd_main.h:220
#define CLIB_UNUSED(x)
Definition: clib.h:82
static uword random_default_seed(void)
Default random seed (unix/linux user-mode)
Definition: random.h:91
static void bfd_set_effective_required_min_rx(bfd_main_t *bm, bfd_session_t *bs, u64 required_min_rx_clocks)
Definition: bfd_main.c:381
static f64 vlib_process_wait_for_event_or_clock(vlib_main_t *vm, f64 dt)
Suspend a cooperative multi-tasking thread Waits for an event, or for the indicated number of seconds...
Definition: node_funcs.h:673
#define hash_unset(h, key)
Definition: hash.h:261
a
Definition: bitmap.h:538
static uword * vlib_process_wait_for_event(vlib_main_t *vm)
Definition: node_funcs.h:593
void bfd_pkt_set_poll(bfd_pkt_t *pkt)
Definition: bfd_protocol.c:66
bfd_main_t bfd_main
Definition: bfd_main.c:2258
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
void bfd_on_timeout(vlib_main_t *vm, vlib_node_runtime_t *rt, bfd_main_t *bm, bfd_session_t *bs, u64 now)
Definition: bfd_main.c:1080
#define BFD_ERR(...)
Definition: bfd_debug.h:75
i16 current_data
signed offset in data[], pre_data[] that we are currently processing.
Definition: buffer.h:110
unsigned long u64
Definition: types.h:89
u32 * auth_key_by_conf_key_id
hashmap - index in pool auth_keys by conf_key_id
Definition: bfd_main.h:316
static void bfd_session_switch_auth_to_next(bfd_session_t *bs)
Definition: bfd_main.c:1471
void timing_wheel_init(timing_wheel_t *w, u64 current_cpu_time, f64 cpu_clocks_per_second)
Definition: timing_wheel.c:21
u8 bfd_pkt_get_diag_code(const bfd_pkt_t *pkt)
Definition: bfd_protocol.c:35
static uword bfd_process(vlib_main_t *vm, vlib_node_runtime_t *rt, vlib_frame_t *f)
Definition: bfd_main.c:1125
bfd_session_t * bfd_find_session_by_disc(bfd_main_t *bm, u32 disc)
Definition: bfd_main.c:1403
u8 * format_bfd_auth_key(u8 *s, va_list *args)
Definition: bfd_main.c:69
u64 timing_wheel_next_expiring_elt_time(timing_wheel_t *w)
Definition: timing_wheel.c:342
#define NULL
Definition: clib.h:58
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
u64 echo_last_rx_clocks
timestamp of last echo packet received
Definition: bfd_main.h:181
f64 clocks_per_second
Definition: time.h:53
int bfd_verify_pkt_common(const bfd_pkt_t *pkt)
verify bfd packet - common checks
Definition: bfd_main.c:1422
static void bfd_set_state(bfd_main_t *bm, bfd_session_t *bs, bfd_state_e new_state, int handling_wakeup)
Definition: bfd_main.c:133
u32 echo_secret
secret used for calculating/checking checksum of echo packets
Definition: bfd_main.h:184
u16 current_length
Nbytes between current data and the end of this buffer.
Definition: buffer.h:113
bfd_diag_code_e local_diag
local diagnostics
Definition: bfd_main.h:100
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:523
static u64 clib_cpu_time_now(void)
Definition: time.h:75
static u64 clib_xxhash(u64 key)
Definition: xxhash.h:58
static void bfd_on_config_change(vlib_main_t *vm, vlib_node_runtime_t *rt, bfd_main_t *bm, bfd_session_t *bs, u64 now)
Definition: bfd_main.c:685
void bfd_put_session(bfd_main_t *bm, bfd_session_t *bs)
Definition: bfd_main.c:1371
u64 last_tx_clocks
timestamp of last packet transmitted
Definition: bfd_main.h:166
static u32 format_get_indent(u8 *s)
Definition: format.h:72
u8 remote_seq_number_known
set to 1 if remote sequence number is known
Definition: bfd_main.h:217
static void bfd_set_remote_required_min_rx(bfd_main_t *bm, bfd_session_t *bs, u64 now, u32 remote_required_min_rx_usec)
Definition: bfd_main.c:392
static void bfd_unlock(bfd_main_t *bm)
Definition: bfd_main.h:385
unsigned bfd_auth_type_supported(bfd_auth_type_e auth_type)
Definition: bfd_main.c:1998
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
clib_time_t clib_time
Definition: main.h:87
uword owner_thread_index
Definition: bfd_main.h:267
bfd_diag_code_e
Definition: bfd_protocol.h:177
static void bfd_add_transport_layer(vlib_main_t *vm, u32 bi, bfd_session_t *bs)
Definition: bfd_main.c:702
void bfd_init_final_control_frame(vlib_main_t *vm, vlib_buffer_t *b, bfd_main_t *bm, bfd_session_t *bs, int is_local)
Definition: bfd_main.c:1027
u32 bfd_process_node_index
background process node index
Definition: bfd_main.h:294
u8 bfd_pkt_get_version(const bfd_pkt_t *pkt)
Definition: bfd_protocol.c:22
u64 remote_min_echo_rx_clocks
remote min echo rx interval (clocks)
Definition: bfd_main.h:139
void timing_wheel_insert(timing_wheel_t *w, u64 insert_cpu_time, u32 user_data)
Definition: timing_wheel.c:294
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:237
u64 effective_required_min_rx_clocks
effective required min rx interval (clocks)
Definition: bfd_main.h:127
vlib_log_class_t log_class
log class
Definition: bfd_main.h:322
bfd_auth_type_e
Definition: bfd_protocol.h:36
unsigned char u8
Definition: types.h:56
u32 remote_seq_number
remote sequence number
Definition: bfd_main.h:214
int bfd_add_udp4_transport(vlib_main_t *vm, u32 bi, const bfd_session_t *bs, int is_echo)
Definition: bfd_udp.c:253
double f64
Definition: types.h:142
#define clib_memcpy(d, s, n)
Definition: string.h:180
timing_wheel_t wheel
timing wheel for scheduling timeouts
Definition: bfd_main.h:285
vnet_api_error_t bfd_auth_deactivate(bfd_session_t *bs, u8 is_delayed)
Definition: bfd_main.c:2058
static int bfd_verify_pkt_auth_seq_num(bfd_session_t *bs, u32 received_seq_num, int is_meticulous)
Definition: bfd_main.c:1498
u64 effective_desired_min_tx_clocks
effective desired min tx interval (clocks)
Definition: bfd_main.h:118
static void bfd_lock_check(bfd_main_t *bm)
Definition: bfd_main.h:401
u32 bfd_clocks_to_usec(const bfd_main_t *bm, u64 clocks)
Definition: bfd_main.c:61
u8 key[20]
key data directly usable for bfd purposes - already padded with zeroes (so we don&#39;t need the actual l...
Definition: bfd_main.h:52
vl_api_interface_index_t sw_if_index
Definition: gre.api:59
const char * bfd_poll_state_string(bfd_poll_state_e state)
Definition: bfd_main.c:147
u64 bfd_process_next_wakeup_clocks
When the bfd process is supposed to wake up next.
Definition: bfd_main.h:279
u32 random_seed
for generating random numbers
Definition: bfd_main.h:310
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:173
static uword vlib_process_get_events(vlib_main_t *vm, uword **data_vector)
Return the first event type which has occurred and a vector of per-event data of that type...
Definition: node_funcs.h:516
u8 * format_white_space(u8 *s, va_list *va)
Definition: std-formats.c:129
int bfd_transport_udp4(vlib_main_t *vm, u32 bi, const struct bfd_session_s *bs)
transport packet over udpv4
Definition: bfd_udp.c:438
u64 remote_min_rx_usec
remote min rx interval (microseconds)
Definition: bfd_main.h:130
static void bfd_rpc_event_cb(const bfd_rpc_event_t *a)
Definition: bfd_main.c:548
u8 * format_hex_bytes(u8 *s, va_list *va)
Definition: std-formats.c:84
u64 tx_timeout_clocks
next time at which to transmit a packet
Definition: bfd_main.h:163
void bfd_event(bfd_main_t *bm, bfd_session_t *bs)
Definition: bfd_api.c:178
void vl_api_rpc_call_main_thread(void *fp, u8 *data, u32 data_length)
Definition: vlib_api.c:607
u64 config_required_min_rx_clocks
configured required min rx interval (clocks)
Definition: bfd_main.h:124
unsigned int u32
Definition: types.h:88
bfd_auth_key_t * next_key
set to next key to use if delayed switch is enabled - in that case the key is switched when first inc...
Definition: bfd_main.h:208
static vlib_node_registration_t bfd_process_node
(constructor) VLIB_REGISTER_NODE (bfd_process_node)
Definition: bfd_main.c:66
#define vlib_log_debug(...)
Definition: log.h:106
static void bfd_set_poll_state(bfd_session_t *bs, bfd_poll_state_e state)
Definition: bfd_main.c:161
static u32 vlib_get_buffer_index(vlib_main_t *vm, void *p)
Translate buffer pointer into buffer index.
Definition: buffer_funcs.h:257
static void bfd_calc_next_echo_tx(bfd_main_t *bm, bfd_session_t *bs, u64 now)
Definition: bfd_main.c:241
bfd_session_t * bfd_find_session_by_idx(bfd_main_t *bm, uword bs_idx)
Definition: bfd_main.c:1392
static void clib_spinlock_init(clib_spinlock_t *p)
Definition: lock.h:63
static u64 bfd_calc_echo_checksum(u32 discriminator, u64 expire_time, u32 secret)
Definition: bfd_main.c:41
u8 remote_demand
1 if remote system sets demand mode, 0 otherwise
Definition: bfd_main.h:148
bfd_session_t * sessions
pool of bfd sessions context data
Definition: bfd_main.h:282
bfd_poll_state_e
Definition: bfd_main.h:64
bfd_auth_key_t * auth_keys
pool of authentication keys
Definition: bfd_main.h:313
#define hash_get(h, key)
Definition: hash.h:249
bfd_transport_e transport
transport type for this session
Definition: bfd_main.h:233
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:519
static clib_error_t * bfd_sw_interface_up_down(vnet_main_t *vnm, u32 sw_if_index, u32 flags)
Definition: bfd_main.c:1267
static void bfd_event_rpc(u32 bs_idx)
Definition: bfd_main.c:574
static void vlib_process_signal_event(vlib_main_t *vm, uword node_index, uword type_opaque, uword data)
Definition: node_funcs.h:934
u32 remote_discr
remote discriminator
Definition: bfd_main.h:109
u64 default_desired_min_tx_clocks
default desired min tx in clocks
Definition: bfd_main.h:304
u64 echo_last_tx_clocks
timestamp of last echo packet transmitted
Definition: bfd_main.h:178
long ctx[MAX_CONNS]
Definition: main.c:144
bfd_poll_state_e poll_state
state info regarding poll sequence
Definition: bfd_main.h:190
u8 bfd_pkt_get_control_plane_independent(const bfd_pkt_t *pkt)
Definition: bfd_protocol.c:84
unsigned short u16
Definition: types.h:57
signed long i64
Definition: types.h:78
f64 cpu_cps
cpu clocks per second
Definition: bfd_main.h:301
void bfd_pkt_set_auth_present(bfd_pkt_t *pkt)
Definition: bfd_protocol.c:104
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:229
BFD global declarations.
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:287
u64 echo_tx_timeout_clocks
next time at which to transmit echo packet
Definition: bfd_main.h:175
static void bfd_set_diag(bfd_session_t *bs, bfd_diag_code_e code)
Definition: bfd_main.c:122
u8 local_detect_mult
configured detect multiplier
Definition: bfd_main.h:145
static int bfd_is_echo_possible(bfd_session_t *bs)
Definition: bfd_main.c:840
u64 last_rx_clocks
timestamp of last packet received
Definition: bfd_main.h:169
vlib_thread_main_t vlib_thread_main
Definition: threads.c:38
int bfd_transport_udp6(vlib_main_t *vm, u32 bi, const struct bfd_session_s *bs)
transport packet over udpv6
Definition: bfd_udp.c:450
vlib_main_t * vm
Definition: in2out_ed.c:1810
int bfd_add_udp6_transport(vlib_main_t *vm, u32 bi, const bfd_session_t *bs, int is_echo)
Definition: bfd_udp.c:308
u8 bfd_pkt_get_final(const bfd_pkt_t *pkt)
Definition: bfd_protocol.c:72
void bfd_pkt_set_final(bfd_pkt_t *pkt)
Definition: bfd_protocol.c:78
static void bfd_notify_listeners(bfd_main_t *bm, bfd_listen_event_e event, const bfd_session_t *bs)
Definition: bfd_main.c:424
bfd_diag_code_e remote_diag
remote diagnostics
Definition: bfd_main.h:103
static void bfd_send_periodic(vlib_main_t *vm, vlib_node_runtime_t *rt, bfd_main_t *bm, bfd_session_t *bs, u64 now)
Definition: bfd_main.c:947
#define BFD_DEFAULT_DESIRED_MIN_TX_USEC
default, slow transmission interval for BFD packets, per spec at least 1s
Definition: bfd_main.h:442
void bfd_session_start(bfd_main_t *bm, bfd_session_t *bs)
Definition: bfd_main.c:435
const char * bfd_auth_type_str(bfd_auth_type_e auth_type)
Definition: bfd_protocol.c:151
u64 transmit_interval_clocks
transmit interval
Definition: bfd_main.h:160
vnet_main_t * vnet_main
Definition: bfd_main.h:298
u8 bfd_pkt_get_multipoint(const bfd_pkt_t *pkt)
Definition: bfd_protocol.c:124
static void bfd_set_effective_desired_min_tx(bfd_main_t *bm, bfd_session_t *bs, u64 now, u64 desired_min_tx_clocks)
Definition: bfd_main.c:367
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169
u32 flags
Definition: vhost_user.h:141
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:218
static void bfd_recalc_tx_interval(bfd_main_t *bm, bfd_session_t *bs)
Definition: bfd_main.c:172
BFD protocol declarations.
static void vlib_process_signal_event_mt(vlib_main_t *vm, uword node_index, uword type_opaque, uword data)
Signal event to process from any thread.
Definition: node_funcs.h:958
bfd_input_next_t
Definition: bfd_main.c:90
u32 config_desired_min_tx_usec
configured desired min tx interval (microseconds)
Definition: bfd_main.h:112
u32 bfd_max_key_len_for_auth_type(bfd_auth_type_e auth_type)
get the maximum length of key data for given auth type
Definition: bfd_protocol.c:138
static void bfd_calc_next_tx(bfd_main_t *bm, bfd_session_t *bs, u64 now)
Definition: bfd_main.c:191
u8 * format_bfd_session(u8 *s, va_list *args)
Definition: bfd_main.c:1951
u32 * timing_wheel_advance(timing_wheel_t *w, u64 advance_cpu_time, u32 *expired_user_data, u64 *next_expiring_element_cpu_time)
Definition: timing_wheel.c:592
const char * bfd_diag_code_string(bfd_diag_code_e diag)
Definition: bfd_protocol.c:164
static void bfd_add_auth_section(vlib_buffer_t *b, bfd_session_t *bs)
Definition: bfd_main.c:801
static int bfd_verify_pkt_auth_key_sha1(const bfd_pkt_t *pkt, u32 pkt_size, bfd_session_t *bs, u8 bfd_key_id, bfd_auth_key_t *auth_key)
Definition: bfd_main.c:1566
u8 bfd_pkt_get_demand(const bfd_pkt_t *pkt)
Definition: bfd_protocol.c:110
vnet_api_error_t bfd_auth_activate(bfd_session_t *bs, u32 conf_key_id, u8 bfd_key_id, u8 is_delayed)
Definition: bfd_main.c:2009
BFD global declarations.
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:284
static void bfd_set_remote_required_min_echo_rx(bfd_main_t *bm, bfd_session_t *bs, u64 now, u32 remote_required_min_echo_rx_usec)
Definition: bfd_main.c:408
u64 poll_state_start_or_timeout_clocks
helper for delayed poll sequence - marks either start of running poll sequence or timeout...
Definition: bfd_main.h:196
bfd_state_e
Definition: bfd_protocol.h:195
u64 detection_time_clocks
detection time
Definition: bfd_main.h:187
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1810
u8 * bfd_input_format_trace(u8 *s, va_list *args)
Definition: bfd_main.c:476
#define BFD_DBG(...)
Definition: bfd_debug.h:74
void bfd_pkt_set_version(bfd_pkt_t *pkt, int version)
Definition: bfd_protocol.c:28
#define ASSERT(truth)
static void bfd_recalc_detection_time(bfd_main_t *bm, bfd_session_t *bs)
Definition: bfd_main.c:262
u64 config_desired_min_tx_clocks
configured desired min tx interval (clocks)
Definition: bfd_main.h:115
u64 bfd_process_wakeup_event_start_clocks
The timestamp of last wakeup event being sent.
Definition: bfd_main.h:273
u32 vlib_log_get_indent()
Definition: log.c:226
u8 data[128]
Definition: ipsec_types.api:87
int bfd_udp_is_echo_available(bfd_transport_e transport)
check if the bfd udp layer is echo-capable at this time
Definition: bfd_udp.c:105
u8 echo
1 is echo function is active, 0 otherwise
Definition: bfd_main.h:154
u64 wheel_time_clocks
set to value of timer in timing wheel, 0 if never set
Definition: bfd_main.h:157
u64 remote_desired_min_tx_clocks
remote desired min tx interval (clocks)
Definition: bfd_main.h:142
u8 bfd_pkt_get_state(const bfd_pkt_t *pkt)
Definition: bfd_protocol.c:48
u32 local_discr
local discriminator
Definition: bfd_main.h:106
static f64 random_f64(u32 *seed)
Generate f64 random number in the interval [0,1].
Definition: random.h:145
bfd_hop_type_e hop_type
BFD hop type.
Definition: bfd_main.h:97
u32 conf_key_id
global configuration key ID
Definition: bfd_main.h:43
vnet_api_error_t bfd_auth_del_key(u32 conf_key_id)
delete existing authentication key
Definition: bfd_main.c:2219
vlib_main_t * vlib_main
convenience variables
Definition: bfd_main.h:297
bfd_state_e local_state
session state
Definition: bfd_main.h:91
static int bfd_echo_add_transport_layer(vlib_main_t *vm, u32 bi, bfd_session_t *bs)
Definition: bfd_main.c:735
#define clib_max(x, y)
Definition: clib.h:288
u32 * session_by_disc
hashmap - bfd session by discriminator
Definition: bfd_main.h:291
int bfd_consume_echo_pkt(bfd_main_t *bm, vlib_buffer_t *b)
Definition: bfd_main.c:1915
vnet_api_error_t bfd_session_set_params(bfd_main_t *bm, bfd_session_t *bs, u32 desired_min_tx_usec, u32 required_min_rx_usec, u8 detect_mult)
Definition: bfd_main.c:2100
void(* bfd_notify_fn_t)(bfd_listen_event_e, const bfd_session_t *)
session nitification call back function type
Definition: bfd_main.h:260
typedef key
Definition: ipsec_types.api:83
struct _vlib_node_registration vlib_node_registration_t
u64 echo_transmit_interval_clocks
transmit interval for echo packets
Definition: bfd_main.h:172
u32 local_seq_number
sequence number incremented occasionally or always (if meticulous)
Definition: bfd_main.h:211
void bfd_register_listener(bfd_notify_fn_t fn)
Register a callback function to receive session notifications.
Definition: bfd_main.c:1294
u32 config_required_min_rx_usec
configured required min rx interval (microseconds)
Definition: bfd_main.h:121
static void bfd_set_timer(bfd_main_t *bm, bfd_session_t *bs, u64 now, int handling_wakeup)
Definition: bfd_main.c:277
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
static void bfd_set_defaults(bfd_main_t *bm, bfd_session_t *bs)
Definition: bfd_main.c:100
u32 use_count
keeps track of how many sessions reference this key
Definition: bfd_main.h:46
#define VLIB_BUFFER_TRACE_TRAJECTORY_INIT(b)
Definition: buffer.h:492
VLIB buffer representation.
Definition: buffer.h:102
#define vlib_log_info(...)
Definition: log.h:105
u64 uword
Definition: types.h:112
u8 next_bfd_key_id
key ID to use when switched to next_key
Definition: bfd_main.h:223
static int bfd_verify_pkt_auth_key(const bfd_pkt_t *pkt, u32 pkt_size, bfd_session_t *bs, u8 bfd_key_id, bfd_auth_key_t *auth_key)
Definition: bfd_main.c:1642
#define vlib_log_crit(...)
Definition: log.h:101
#define F(x)
u8 bfd_pkt_get_poll(const bfd_pkt_t *pkt)
Definition: bfd_protocol.c:60
Linear Congruential Random Number Generator.
int bfd_process_wakeup_events_in_flight
Number of event wakeup RPCs in flight.
Definition: bfd_main.h:270
u64 bfd_process_wakeup_event_delay_clocks
The time it took the last wakeup event to make it to handling.
Definition: bfd_main.h:276
u32 bs_idx
index in bfd_main.sessions pool
Definition: bfd_main.h:88
u8 * format_bfd_session_brief(u8 *s, va_list *args)
Definition: bfd_main.c:1987
static int bfd_transport_echo(vlib_main_t *vm, u32 bi, bfd_session_t *bs)
Definition: bfd_main.c:752
static u32 random_u32(u32 *seed)
32-bit random number generator
Definition: random.h:69
u64 remote_min_echo_rx_usec
remote min echo rx interval (microseconds)
Definition: bfd_main.h:136
vnet_api_error_t bfd_auth_set_key(u32 conf_key_id, u8 auth_type, u8 key_len, const u8 *key_data)
create or modify bfd authentication key
Definition: bfd_main.c:2163
vl_api_dhcp_client_state_t state
Definition: dhcp.api:201
#define STRUCT_SIZE_OF(t, f)
Definition: clib.h:67
#define vec_foreach(var, vec)
Vector iterator.
bfd_state_e remote_state
remote session state
Definition: bfd_main.h:94
const char * bfd_state_string(bfd_state_e state)
Definition: bfd_protocol.c:177
#define vlib_log_err(...)
Definition: log.h:102
bfd packet trace capture
Definition: bfd_main.h:342
u64 min_required_min_rx_while_echo_clocks
minimum required min rx while echo function is active - clocks
Definition: bfd_main.h:307
int bfd_verify_pkt_auth(const bfd_pkt_t *pkt, u16 pkt_size, bfd_session_t *bs)
verify bfd packet - authentication
Definition: bfd_main.c:1703
static void vlib_buffer_free_one(vlib_main_t *vm, u32 buffer_index)
Free one buffer Shorthand to free a single buffer chain.
Definition: buffer_funcs.h:923
#define USEC_PER_SECOND
Definition: bfd_main.h:439
static void bfd_rpc_notify_listeners_cb(const bfd_rpc_notify_listeners_t *a)
Definition: bfd_main.c:590
static int bfd_auth_type_is_meticulous(bfd_auth_type_e auth_type)
Definition: bfd_main.c:1487
bfd_auth_key_t * curr_key
current key in use
Definition: bfd_main.h:202
clib_spinlock_t lock
lock to protect data structures
Definition: bfd_main.h:265
static u32 vlib_buffer_alloc(vlib_main_t *vm, u32 *buffers, u32 n_buffers)
Allocate buffers into supplied array.
Definition: buffer_funcs.h:630
static void bfd_send_echo(vlib_main_t *vm, vlib_node_runtime_t *rt, bfd_main_t *bm, bfd_session_t *bs, u64 now)
Definition: bfd_main.c:888
void bfd_pkt_set_state(bfd_pkt_t *pkt, int value)
Definition: bfd_protocol.c:54
static clib_error_t * bfd_hw_interface_up_down(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: bfd_main.c:1281
u8 remote_detect_mult
remote detect multiplier
Definition: bfd_main.h:151
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:85
void bfd_pkt_set_diag_code(bfd_pkt_t *pkt, int value)
Definition: bfd_protocol.c:41
#define BFD_REQUIRED_MIN_RX_USEC_WHILE_ECHO
minimum required min rx set locally when echo function is used, per spec should be set to at least 1s...
Definition: bfd_main.h:448
u64 remote_min_rx_clocks
remote min rx interval (clocks)
Definition: bfd_main.h:133
u8 is_delayed
set to 1 if delayed action is pending, which might be activation of authentication, change of key or deactivation
Definition: bfd_main.h:229
static clib_error_t * bfd_main_init(vlib_main_t *vm)
Definition: bfd_main.c:1305
static void bfd_lock(bfd_main_t *bm)
Definition: bfd_main.h:368
bfd_transport_e
Definition: bfd_api.h:30
bfd_listen_event_e
Definition: bfd_main.h:250
u64 wheel_inaccuracy
timing wheel inaccuracy, in clocks
Definition: bfd_main.h:288
static void bfd_init_control_frame(bfd_main_t *bm, bfd_session_t *bs, vlib_buffer_t *b)
Definition: bfd_main.c:857
VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(bfd_sw_interface_up_down)
void bfd_session_set_flags(bfd_session_t *bs, u8 admin_up_down)
Definition: bfd_main.c:449
static void bfd_check_rx_timeout(bfd_main_t *bm, bfd_session_t *bs, u64 now, int handling_wakeup)
Definition: bfd_main.c:1046