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
  27 #define foreach_bfd_mode(F) \
  28   F (asynchronous)          \
  29   F (demand)
  30
  31 typedef enum
  32 {
  33 #define F(x) BFD_MODE_##x,
  34   foreach_bfd_mode (F)
  35 #undef F
  36 } bfd_mode_e;
  37
  38 typedef struct
  39 {
  40   /* global configuration key ID */
  41   u32 conf_key_id;
  42
  43   /* keeps track of how many sessions reference this key */
  44   u32 use_count;
  45
  46   /*
  47    * key data directly usable for bfd purposes - already padded with zeroes
  48    * (so we don't need the actual length)
  49    */
  50   u8 key[20];
  51
  52   /* authentication type for this key */
  53   bfd_auth_type_e auth_type;
  54 } bfd_auth_key_t;
  55
  56 #define foreach_bfd_poll_state(F) \
  57   F (NOT_NEEDED)                  \
  58   F (NEEDED)                      \
  59   F (IN_PROGRESS)                 \
  60   F (IN_PROGRESS_AND_QUEUED)
  61
  62 typedef enum
  63 {
  64 #define F(x) BFD_POLL_##x,
  65   foreach_bfd_poll_state (F)
  66 #undef F
  67 } bfd_poll_state_e;
  68
  69 typedef struct bfd_session_s
  70 {
  71   /* index in bfd_main.sessions pool */
  72   u32 bs_idx;
  73
  74   /* session state */
  75   bfd_state_e local_state;
  76
  77   /* remote session state */
  78   bfd_state_e remote_state;
  79
  80   /* local diagnostics */
  81   bfd_diag_code_e local_diag;
  82
  83   /* remote diagnostics */
  84   bfd_diag_code_e remote_diag;
  85
  86   /* local discriminator */
  87   u32 local_discr;
  88
  89   /* remote discriminator */
  90   u32 remote_discr;
  91
  92   /* configured desired min tx interval (microseconds) */
  93   u32 config_desired_min_tx_usec;
  94
  95   /* configured desired min tx interval (clocks) */
  96   u64 config_desired_min_tx_clocks;
  97
  98   /* effective desired min tx interval (clocks) */
  99   u64 effective_desired_min_tx_clocks;
 100
 101   /* configured required min rx interval (microseconds) */
 102   u32 config_required_min_rx_usec;
 103
 104   /* configured required min rx interval (clocks) */
 105   u64 config_required_min_rx_clocks;
 106
 107   /* effective required min rx interval (clocks) */
 108   u64 effective_required_min_rx_clocks;
 109
 110   /* remote min rx interval (microseconds) */
 111   u64 remote_min_rx_usec;
 112
 113   /* remote min rx interval (clocks) */
 114   u64 remote_min_rx_clocks;
 115
 116   /* remote min echo rx interval (microseconds) */
 117   u64 remote_min_echo_rx_usec;
 118
 119   /* remote min echo rx interval (clocks) */
 120   u64 remote_min_echo_rx_clocks;
 121
 122   /* remote desired min tx interval (clocks) */
 123   u64 remote_desired_min_tx_clocks;
 124
 125   /* configured detect multiplier */
 126   u8 local_detect_mult;
 127
 128   /* 1 if remote system sets demand mode, 0 otherwise */
 129   u8 remote_demand;
 130
 131   /* remote detect multiplier */
 132   u8 remote_detect_mult;
 133
 134   /* 1 is echo function is active, 0 otherwise */
 135   u8 echo;
 136
 137   /* set to value of timer in timing wheel, 0 if never set */
 138   u64 wheel_time_clocks;
 139
 140   /* transmit interval */
 141   u64 transmit_interval_clocks;
 142
 143   /* next time at which to transmit a packet */
 144   u64 tx_timeout_clocks;
 145
 146   /* timestamp of last packet transmitted */
 147   u64 last_tx_clocks;
 148
 149   /* timestamp of last packet received */
 150   u64 last_rx_clocks;
 151
 152   /* transmit interval for echo packets */
 153   u64 echo_transmit_interval_clocks;
 154
 155   /* next time at which to transmit echo packet */
 156   u64 echo_tx_timeout_clocks;
 157
 158   /* timestamp of last echo packet transmitted */
 159   u64 echo_last_tx_clocks;
 160
 161   /* timestamp of last echo packet received */
 162   u64 echo_last_rx_clocks;
 163
 164   /* secret used for calculating/checking checksum of echo packets */
 165   u32 echo_secret;
 166
 167   /* detection time */
 168   u64 detection_time_clocks;
 169
 170   /* state info regarding poll sequence */
 171   bfd_poll_state_e poll_state;
 172
 173   /*
 174    * helper for delayed poll sequence - marks either start of running poll
 175    * sequence or timeout, after which we can start the next poll sequnce
 176    */
 177   u64 poll_state_start_or_timeout_clocks;
 178
 179   /* authentication information */
 180   struct
 181   {
 182     /* current key in use */
 183     bfd_auth_key_t *curr_key;
 184
 185     /*
 186      * set to next key to use if delayed switch is enabled - in that case
 187      * the key is switched when first incoming packet is signed with next_key
 188      */
 189     bfd_auth_key_t *next_key;
 190
 191     /* sequence number incremented occasionally or always (if meticulous) */
 192     u32 local_seq_number;
 193
 194     /* remote sequence number */
 195     u32 remote_seq_number;
 196
 197     /* set to 1 if remote sequence number is known */
 198     u8 remote_seq_number_known;
 199
 200     /* current key ID sent out in bfd packet */
 201     u8 curr_bfd_key_id;
 202
 203     /* key ID to use when switched to next_key */
 204     u8 next_bfd_key_id;
 205
 206     /*
 207      * set to 1 if delayed action is pending, which might be activation
 208      * of authentication, change of key or deactivation
 209      */
 210     u8 is_delayed;
 211   } auth;
 212
 213   /* transport type for this session */
 214   bfd_transport_e transport;
 215
 216   /* union of transport-specific data */
 217   union
 218   {
 219     bfd_udp_session_t udp;
 220   };
 221 } bfd_session_t;
 222
 223 typedef struct
 224 {
 225   /* pool of bfd sessions context data */
 226   bfd_session_t *sessions;
 227
 228   /* timing wheel for scheduling timeouts */
 229   timing_wheel_t wheel;
 230
 231   /* timing wheel inaccuracy, in clocks */
 232   u64 wheel_inaccuracy;
 233
 234   /* hashmap - bfd session by discriminator */
 235   u32 *session_by_disc;
 236
 237   /* background process node index */
 238   u32 bfd_process_node_index;
 239
 240   /* convenience variables */
 241   vlib_main_t *vlib_main;
 242   vnet_main_t *vnet_main;
 243
 244   /* cpu clocks per second */
 245   f64 cpu_cps;
 246
 247   /* default desired min tx in clocks */
 248   u64 default_desired_min_tx_clocks;
 249
 250   /* minimum required min rx while echo function is active - clocks */
 251   u64 min_required_min_rx_while_echo_clocks;
 252
 253   /* for generating random numbers */
 254   u32 random_seed;
 255
 256   /* pool of authentication keys */
 257   bfd_auth_key_t *auth_keys;
 258
 259   /* hashmap - index in pool auth_keys by conf_key_id */
 260   u32 *auth_key_by_conf_key_id;
 261
 262 } bfd_main_t;
 263
 264 extern bfd_main_t bfd_main;
 265
 266 /* Packet counters */
 267 #define foreach_bfd_error(F)               \
 268   F (NONE, "good bfd packets (processed)") \
 269   F (BAD, "invalid bfd packets")           \
 270   F (DISABLED, "bfd packets received on disabled interfaces")
 271
 272 typedef enum
 273 {
 274 #define F(sym, str) BFD_ERROR_##sym,
 275   foreach_bfd_error (F)
 276 #undef F
 277     BFD_N_ERROR,
 278 } bfd_error_t;
 279
 280 /* bfd packet trace capture */
 281 typedef struct
 282 {
 283   u32 len;
 284   u8 data[400];
 285 } bfd_input_trace_t;
 286
 287 enum
 288 {
 289   BFD_EVENT_RESCHEDULE = 1,
 290   BFD_EVENT_NEW_SESSION,
 291   BFD_EVENT_CONFIG_CHANGED,
 292 } bfd_process_event_e;
 293
 294 /* echo packet structure */
 295 /* *INDENT-OFF* */
 296 typedef CLIB_PACKED (struct {
 297   /* local discriminator */
 298   u32 discriminator;
 299   /* expire time of this packet - clocks */
 300   u64 expire_time_clocks;
 301   /* checksum - based on discriminator, local secret and expire time */
 302   u64 checksum;
 303 }) bfd_echo_pkt_t;
 304 /* *INDENT-ON* */
 305
 306 u8 *bfd_input_format_trace (u8 * s, va_list * args);
 307 bfd_session_t *bfd_get_session (bfd_main_t * bm, bfd_transport_e t);
 308 void bfd_put_session (bfd_main_t * bm, bfd_session_t * bs);
 309 bfd_session_t *bfd_find_session_by_idx (bfd_main_t * bm, uword bs_idx);
 310 bfd_session_t *bfd_find_session_by_disc (bfd_main_t * bm, u32 disc);
 311 void bfd_session_start (bfd_main_t * bm, bfd_session_t * bs);
 312 void bfd_consume_pkt (bfd_main_t * bm, const bfd_pkt_t * bfd, u32 bs_idx);
 313 int bfd_consume_echo_pkt (bfd_main_t * bm, vlib_buffer_t * b);
 314 int bfd_verify_pkt_common (const bfd_pkt_t * pkt);
 315 int bfd_verify_pkt_auth (const bfd_pkt_t * pkt, u16 pkt_size,
 316                          bfd_session_t * bs);
 317 void bfd_event (bfd_main_t * bm, bfd_session_t * bs);
 318 void bfd_init_final_control_frame (vlib_main_t * vm, vlib_buffer_t * b,
 319                                    bfd_main_t * bm, bfd_session_t * bs);
 320 u8 *format_bfd_session (u8 * s, va_list * args);
 321 u8 *format_bfd_auth_key (u8 * s, va_list * args);
 322 void bfd_session_set_flags (bfd_session_t * bs, u8 admin_up_down);
 323 unsigned bfd_auth_type_supported (bfd_auth_type_e auth_type);
 324 vnet_api_error_t bfd_auth_activate (bfd_session_t * bs, u32 conf_key_id,
 325                                     u8 bfd_key_id, u8 is_delayed);
 326 vnet_api_error_t bfd_auth_deactivate (bfd_session_t * bs, u8 is_delayed);
 327 vnet_api_error_t bfd_session_set_params (bfd_main_t * bm, bfd_session_t * bs,
 328                                          u32 desired_min_tx_usec,
 329                                          u32 required_min_rx_usec,
 330                                          u8 detect_mult);
 331
 332 u32 bfd_clocks_to_usec (const bfd_main_t * bm, u64 clocks);
 333 const char *bfd_poll_state_string (bfd_poll_state_e state);
 334
 335 #define USEC_PER_MS 1000LL
 336 #define USEC_PER_SECOND (1000 * USEC_PER_MS)
 337
 338 /* default, slow transmission interval for BFD packets, per spec at least 1s */
 339 #define BFD_DEFAULT_DESIRED_MIN_TX_USEC USEC_PER_SECOND
 340
 341 /*
 342  * minimum required min rx set locally when echo function is used, per spec
 343  * should be set to at least 1s
 344  */
 345 #define BFD_REQUIRED_MIN_RX_USEC_WHILE_ECHO USEC_PER_SECOND
 346
 347 #endif /* __included_bfd_main_h__ */
 348
 349 /*
 350  * fd.io coding-style-patch-verification: ON
 351  *
 352  * Local Variables:
 353  * eval: (c-set-style "gnu")
 354  * End:
 355  */