src/vnet/bfd/bfd_main.h

   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 global declarations
  18  */
  19 #ifndef __included_bfd_main_h__
  20 #define __included_bfd_main_h__
  21
  22 #include <vppinfra/timing_wheel.h>
  23 #include <vnet/vnet.h>
  24 #include <vnet/bfd/bfd_protocol.h>
  25 #include <vnet/bfd/bfd_udp.h>
  26 #include <vlib/log.h>
  27 #include <vppinfra/os.h>
  28
  29 #define foreach_bfd_mode(F) \
  30   F (asynchronous)          \
  31   F (demand)
  32
  33 typedef enum
  34 {
  35 #define F(x) BFD_MODE_##x,
  36   foreach_bfd_mode (F)
  37 #undef F
  38 } bfd_mode_e;
  39
  40 typedef struct
  41 {
  42   /** global configuration key ID */
  43   u32 conf_key_id;
  44
  45   /** keeps track of how many sessions reference this key */
  46   u32 use_count;
  47
  48   /**
  49    * key data directly usable for bfd purposes - already padded with zeroes
  50    * (so we don't need the actual length)
  51    */
  52   u8 key[20];
  53
  54   /** authentication type for this key */
  55   bfd_auth_type_e auth_type;
  56 } bfd_auth_key_t;
  57
  58 #define foreach_bfd_poll_state(F) \
  59   F (NOT_NEEDED)                  \
  60   F (NEEDED)                      \
  61   F (IN_PROGRESS)                 \
  62   F (IN_PROGRESS_AND_QUEUED)
  63
  64 typedef enum
  65 {
  66 #define F(x) BFD_POLL_##x,
  67   foreach_bfd_poll_state (F)
  68 #undef F
  69 } bfd_poll_state_e;
  70
  71 /**
  72  * hop types
  73  */
  74 #define foreach_bfd_hop(F)                     \
  75   F (SINGLE, "single")                         \
  76   F (MULTI,  "multi")                          \
  77
  78 typedef enum
  79 {
  80 #define F(sym, str) BFD_HOP_TYPE_##sym,
  81   foreach_bfd_hop (F)
  82 #undef F
  83 } bfd_hop_type_e;
  84
  85 typedef struct bfd_session_s
  86 {
  87   /** index in bfd_main.sessions pool */
  88   u32 bs_idx;
  89
  90   /** session state */
  91   bfd_state_e local_state;
  92
  93   /** remote session state */
  94   bfd_state_e remote_state;
  95
  96   /** BFD hop type */
  97   bfd_hop_type_e hop_type;
  98
  99   /** local diagnostics */
 100   bfd_diag_code_e local_diag;
 101
 102   /** remote diagnostics */
 103   bfd_diag_code_e remote_diag;
 104
 105   /** local discriminator */
 106   u32 local_discr;
 107
 108   /** remote discriminator */
 109   u32 remote_discr;
 110
 111   /** configured desired min tx interval (microseconds) */
 112   u32 config_desired_min_tx_usec;
 113
 114   /** configured desired min tx interval (clocks) */
 115   u64 config_desired_min_tx_clocks;
 116
 117   /** effective desired min tx interval (clocks) */
 118   u64 effective_desired_min_tx_clocks;
 119
 120   /** configured required min rx interval (microseconds) */
 121   u32 config_required_min_rx_usec;
 122
 123   /** configured required min rx interval (clocks) */
 124   u64 config_required_min_rx_clocks;
 125
 126   /** effective required min rx interval (clocks) */
 127   u64 effective_required_min_rx_clocks;
 128
 129   /** remote min rx interval (microseconds) */
 130   u64 remote_min_rx_usec;
 131
 132   /** remote min rx interval (clocks) */
 133   u64 remote_min_rx_clocks;
 134
 135   /** remote min echo rx interval (microseconds) */
 136   u64 remote_min_echo_rx_usec;
 137
 138   /** remote min echo rx interval (clocks) */
 139   u64 remote_min_echo_rx_clocks;
 140
 141   /** remote desired min tx interval (clocks) */
 142   u64 remote_desired_min_tx_clocks;
 143
 144   /** configured detect multiplier */
 145   u8 local_detect_mult;
 146
 147   /** 1 if remote system sets demand mode, 0 otherwise */
 148   u8 remote_demand;
 149
 150   /** remote detect multiplier */
 151   u8 remote_detect_mult;
 152
 153   /** 1 is echo function is active, 0 otherwise */
 154   u8 echo;
 155
 156   /** set to value of timer in timing wheel, 0 if never set */
 157   u64 wheel_time_clocks;
 158
 159   /** transmit interval */
 160   u64 transmit_interval_clocks;
 161
 162   /** next time at which to transmit a packet */
 163   u64 tx_timeout_clocks;
 164
 165   /** timestamp of last packet transmitted */
 166   u64 last_tx_clocks;
 167
 168   /** timestamp of last packet received */
 169   u64 last_rx_clocks;
 170
 171   /** transmit interval for echo packets */
 172   u64 echo_transmit_interval_clocks;
 173
 174   /** next time at which to transmit echo packet */
 175   u64 echo_tx_timeout_clocks;
 176
 177   /** timestamp of last echo packet transmitted */
 178   u64 echo_last_tx_clocks;
 179
 180   /** timestamp of last echo packet received */
 181   u64 echo_last_rx_clocks;
 182
 183   /** secret used for calculating/checking checksum of echo packets */
 184   u32 echo_secret;
 185
 186   /** detection time */
 187   u64 detection_time_clocks;
 188
 189   /** state info regarding poll sequence */
 190   bfd_poll_state_e poll_state;
 191
 192   /**
 193    * helper for delayed poll sequence - marks either start of running poll
 194    * sequence or timeout, after which we can start the next poll sequnce
 195    */
 196   u64 poll_state_start_or_timeout_clocks;
 197
 198   /** authentication information */
 199   struct
 200   {
 201     /** current key in use */
 202     bfd_auth_key_t *curr_key;
 203
 204     /**
 205      * set to next key to use if delayed switch is enabled - in that case
 206      * the key is switched when first incoming packet is signed with next_key
 207      */
 208     bfd_auth_key_t *next_key;
 209
 210     /** sequence number incremented occasionally or always (if meticulous) */
 211     u32 local_seq_number;
 212
 213     /** remote sequence number */
 214     u32 remote_seq_number;
 215
 216     /** set to 1 if remote sequence number is known */
 217     u8 remote_seq_number_known;
 218
 219     /** current key ID sent out in bfd packet */
 220     u8 curr_bfd_key_id;
 221
 222     /** key ID to use when switched to next_key */
 223     u8 next_bfd_key_id;
 224
 225     /**
 226      * set to 1 if delayed action is pending, which might be activation
 227      * of authentication, change of key or deactivation
 228      */
 229     u8 is_delayed;
 230   } auth;
 231
 232   /** transport type for this session */
 233   bfd_transport_e transport;
 234
 235   /** union of transport-specific data */
 236   union
 237   {
 238     bfd_udp_session_t udp;
 239   };
 240 } bfd_session_t;
 241
 242 /**
 243  * listener events
 244  */
 245 #define foreach_bfd_listen_event(F)            \
 246   F (CREATE, "sesion-created")                 \
 247   F (UPDATE, "session-updated")                \
 248   F (DELETE, "session-deleted")
 249
 250 typedef enum
 251 {
 252 #define F(sym, str) BFD_LISTEN_EVENT_##sym,
 253   foreach_bfd_listen_event (F)
 254 #undef F
 255 } bfd_listen_event_e;
 256
 257 /**
 258  * session nitification call back function type
 259  */
 260 typedef void (*bfd_notify_fn_t) (bfd_listen_event_e, const bfd_session_t *);
 261
 262 typedef struct
 263 {
 264   /** lock to protect data structures */
 265   clib_spinlock_t lock;
 266   int lock_recursion_count;
 267   uword owner_thread_index;
 268
 269   /** Number of event wakeup RPCs in flight. Should be 0 or 1 */
 270   int bfd_process_wakeup_events_in_flight;
 271
 272   /** The timestamp of last wakeup event being sent */
 273   u64 bfd_process_wakeup_event_start_clocks;
 274
 275   /** The time it took the last wakeup event to make it to handling */
 276   u64 bfd_process_wakeup_event_delay_clocks;
 277
 278   /** When the bfd process is supposed to wake up next */
 279   u64 bfd_process_next_wakeup_clocks;
 280
 281   /** pool of bfd sessions context data */
 282   bfd_session_t *sessions;
 283
 284   /** timing wheel for scheduling timeouts */
 285   timing_wheel_t wheel;
 286
 287   /** timing wheel inaccuracy, in clocks */
 288   u64 wheel_inaccuracy;
 289
 290   /** hashmap - bfd session by discriminator */
 291   u32 *session_by_disc;
 292
 293   /** background process node index */
 294   u32 bfd_process_node_index;
 295
 296   /** convenience variables */
 297   vlib_main_t *vlib_main;
 298   vnet_main_t *vnet_main;
 299
 300   /** cpu clocks per second */
 301   f64 cpu_cps;
 302
 303   /** default desired min tx in clocks */
 304   u64 default_desired_min_tx_clocks;
 305
 306   /** minimum required min rx while echo function is active - clocks */
 307   u64 min_required_min_rx_while_echo_clocks;
 308
 309   /** for generating random numbers */
 310   u32 random_seed;
 311
 312   /** pool of authentication keys */
 313   bfd_auth_key_t *auth_keys;
 314
 315   /** hashmap - index in pool auth_keys by conf_key_id */
 316   u32 *auth_key_by_conf_key_id;
 317
 318   /** vector of callback notification functions */
 319   bfd_notify_fn_t *listeners;
 320
 321   /** log class */
 322   vlib_log_class_t log_class;
 323 } bfd_main_t;
 324
 325 extern bfd_main_t bfd_main;
 326
 327 /** Packet counters */
 328 #define foreach_bfd_error(F)               \
 329   F (NONE, "good bfd packets (processed)") \
 330   F (BAD, "invalid bfd packets")           \
 331   F (DISABLED, "bfd packets received on disabled interfaces")
 332
 333 typedef enum
 334 {
 335 #define F(sym, str) BFD_ERROR_##sym,
 336   foreach_bfd_error (F)
 337 #undef F
 338     BFD_N_ERROR,
 339 } bfd_error_t;
 340
 341 /** bfd packet trace capture */
 342 typedef struct
 343 {
 344   u32 len;
 345   u8 data[400];
 346 } bfd_input_trace_t;
 347
 348 typedef enum
 349 {
 350   BFD_EVENT_RESCHEDULE = 1,
 351   BFD_EVENT_NEW_SESSION,
 352   BFD_EVENT_CONFIG_CHANGED,
 353 } bfd_process_event_e;
 354
 355 /* *INDENT-OFF* */
 356 /** echo packet structure */
 357 typedef CLIB_PACKED (struct {
 358   /** local discriminator */
 359   u32 discriminator;
 360   /** expire time of this packet - clocks */
 361   u64 expire_time_clocks;
 362   /** checksum - based on discriminator, local secret and expire time */
 363   u64 checksum;
 364 }) bfd_echo_pkt_t;
 365 /* *INDENT-ON* */
 366
 367 static inline void
 368 bfd_lock (bfd_main_t * bm)
 369 {
 370   uword my_thread_index = __os_thread_index;
 371
 372   if (bm->owner_thread_index == my_thread_index
 373       && bm->lock_recursion_count > 0)
 374     {
 375       bm->lock_recursion_count++;
 376       return;
 377     }
 378
 379   clib_spinlock_lock_if_init (&bm->lock);
 380   bm->lock_recursion_count = 1;
 381   bm->owner_thread_index = my_thread_index;
 382 }
 383
 384 static inline void
 385 bfd_unlock (bfd_main_t * bm)
 386 {
 387   uword my_thread_index = __os_thread_index;
 388   ASSERT (bm->owner_thread_index == my_thread_index);
 389
 390   if (bm->lock_recursion_count > 1)
 391     {
 392       bm->lock_recursion_count--;
 393       return;
 394     }
 395   bm->lock_recursion_count = 0;
 396   bm->owner_thread_index = ~0;
 397   clib_spinlock_unlock_if_init (&bm->lock);
 398 }
 399
 400 static inline void
 401 bfd_lock_check (bfd_main_t * bm)
 402 {
 403   if (PREDICT_FALSE (bm->lock_recursion_count < 1))
 404     clib_warning ("lock check failure");
 405 }
 406
 407 u8 *bfd_input_format_trace (u8 * s, va_list * args);
 408 bfd_session_t *bfd_get_session (bfd_main_t * bm, bfd_transport_e t);
 409 void bfd_put_session (bfd_main_t * bm, bfd_session_t * bs);
 410 bfd_session_t *bfd_find_session_by_idx (bfd_main_t * bm, uword bs_idx);
 411 bfd_session_t *bfd_find_session_by_disc (bfd_main_t * bm, u32 disc);
 412 void bfd_session_start (bfd_main_t * bm, bfd_session_t * bs);
 413 void bfd_consume_pkt (bfd_main_t * bm, const bfd_pkt_t * bfd, u32 bs_idx);
 414 int bfd_consume_echo_pkt (bfd_main_t * bm, vlib_buffer_t * b);
 415 int bfd_verify_pkt_common (const bfd_pkt_t * pkt);
 416 int bfd_verify_pkt_auth (const bfd_pkt_t * pkt, u16 pkt_size,
 417                          bfd_session_t * bs);
 418 void bfd_event (bfd_main_t * bm, bfd_session_t * bs);
 419 void bfd_init_final_control_frame (vlib_main_t * vm, vlib_buffer_t * b,
 420                                    bfd_main_t * bm, bfd_session_t * bs,
 421                                    int is_local);
 422 u8 *format_bfd_session (u8 * s, va_list * args);
 423 u8 *format_bfd_session_brief (u8 * s, va_list * args);
 424 u8 *format_bfd_auth_key (u8 * s, va_list * args);
 425 void bfd_session_set_flags (bfd_session_t * bs, u8 admin_up_down);
 426 unsigned bfd_auth_type_supported (bfd_auth_type_e auth_type);
 427 vnet_api_error_t bfd_auth_activate (bfd_session_t * bs, u32 conf_key_id,
 428                                     u8 bfd_key_id, u8 is_delayed);
 429 vnet_api_error_t bfd_auth_deactivate (bfd_session_t * bs, u8 is_delayed);
 430 vnet_api_error_t bfd_session_set_params (bfd_main_t * bm, bfd_session_t * bs,
 431                                          u32 desired_min_tx_usec,
 432                                          u32 required_min_rx_usec,
 433                                          u8 detect_mult);
 434
 435 u32 bfd_clocks_to_usec (const bfd_main_t * bm, u64 clocks);
 436 const char *bfd_poll_state_string (bfd_poll_state_e state);
 437
 438 #define USEC_PER_MS 1000LL
 439 #define USEC_PER_SECOND (1000 * USEC_PER_MS)
 440
 441 /** default, slow transmission interval for BFD packets, per spec at least 1s */
 442 #define BFD_DEFAULT_DESIRED_MIN_TX_USEC USEC_PER_SECOND
 443
 444 /**
 445  * minimum required min rx set locally when echo function is used, per spec
 446  * should be set to at least 1s
 447  */
 448 #define BFD_REQUIRED_MIN_RX_USEC_WHILE_ECHO USEC_PER_SECOND
 449
 450 /**
 451  * Register a callback function to receive session notifications.
 452  */
 453 void bfd_register_listener (bfd_notify_fn_t fn);
 454
 455 #endif /* __included_bfd_main_h__ */
 456
 457 /*
 458  * fd.io coding-style-patch-verification: ON
 459  *
 460  * Local Variables:
 461  * eval: (c-set-style "gnu")
 462  * End:
 463  */