src/vnet/bfd/bfd_main.c

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