FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
bfd_main.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2016 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /**
16  * @file
17  * @brief BFD 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,
37 #undef F
38 } bfd_mode_e;
39 
40 typedef struct
41 {
42  /** global configuration key ID */
44 
45  /** keeps track of how many sessions reference this key */
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 */
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,
68 #undef F
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,
82 #undef F
84 
85 typedef struct bfd_session_s
86 {
87  /** index in bfd_main.sessions pool */
89 
90  /** session state */
92 
93  /** remote session state */
95 
96  /** BFD hop type */
97  bfd_hop_type_e hop_type;
98 
99  /** local diagnostics */
101 
102  /** remote diagnostics */
104 
105  /** local discriminator */
107 
108  /** remote discriminator */
110 
111  /** configured desired min tx interval (microseconds) */
113 
114  /** configured desired min tx interval (clocks) */
116 
117  /** effective desired min tx interval (clocks) */
119 
120  /** configured required min rx interval (microseconds) */
122 
123  /** configured required min rx interval (clocks) */
125 
126  /** effective required min rx interval (clocks) */
128 
129  /** remote min rx interval (microseconds) */
131 
132  /** remote min rx interval (clocks) */
134 
135  /** remote min echo rx interval (microseconds) */
137 
138  /** remote min echo rx interval (clocks) */
140 
141  /** remote desired min tx interval (clocks) */
143 
144  /** configured detect multiplier */
146 
147  /** 1 if remote system sets demand mode, 0 otherwise */
149 
150  /** remote detect multiplier */
152 
153  /** 1 is echo function is active, 0 otherwise */
155 
156  /** set to value of timer in timing wheel, 0 if never set */
158 
159  /** transmit interval */
161 
162  /** next time at which to transmit a packet */
164 
165  /** timestamp of last packet transmitted */
167 
168  /** timestamp of last packet received */
170 
171  /** transmit interval for echo packets */
173 
174  /** next time at which to transmit echo packet */
176 
177  /** timestamp of last echo packet transmitted */
179 
180  /** timestamp of last echo packet received */
182 
183  /** secret used for calculating/checking checksum of echo packets */
185 
186  /** detection time */
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  */
197 
198  /** authentication information */
199  struct
200  {
201  /** current key in use */
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  */
209 
210  /** sequence number incremented occasionally or always (if meticulous) */
212 
213  /** remote sequence number */
215 
216  /** set to 1 if remote sequence number is known */
218 
219  /** current key ID sent out in bfd packet */
221 
222  /** key ID to use when switched to next_key */
224 
225  /**
226  * set to 1 if delayed action is pending, which might be activation
227  * of authentication, change of key or deactivation
228  */
230  } auth;
231 
232  /** transport type for this session */
234 
235  /** union of transport-specific data */
236  union
237  {
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,
254 #undef F
256 
257 /**
258  * session nitification call back function type
259  */
261 
262 typedef struct
263 {
264  /** lock to protect data structures */
268 
269  /** Number of event wakeup RPCs in flight. Should be 0 or 1 */
271 
272  /** The timestamp of last wakeup event being sent */
274 
275  /** The time it took the last wakeup event to make it to handling */
277 
278  /** When the bfd process is supposed to wake up next */
280 
281  /** pool of bfd sessions context data */
283 
284  /** timing wheel for scheduling timeouts */
286 
287  /** timing wheel inaccuracy, in clocks */
289 
290  /** hashmap - bfd session by discriminator */
292 
293  /** background process node index */
295 
296  /** convenience variables */
299 
300  /** cpu clocks per second */
302 
303  /** default desired min tx in clocks */
305 
306  /** minimum required min rx while echo function is active - clocks */
308 
309  /** for generating random numbers */
311 
312  /** pool of authentication keys */
314 
315  /** hashmap - index in pool auth_keys by conf_key_id */
317 
318  /** vector of callback notification functions */
320 
321  /** 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,
337 #undef F
338  BFD_N_ERROR,
339 } bfd_error_t;
340 
341 /** bfd packet trace capture */
342 typedef struct
343 {
345  u8 data[400];
347 
348 typedef enum
349 {
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
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 
380  bm->lock_recursion_count = 1;
381  bm->owner_thread_index = my_thread_index;
382 }
383 
384 static inline void
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;
398 }
399 
400 static inline void
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);
409 void bfd_put_session (bfd_main_t * bm, bfd_session_t * bs);
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);
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);
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);
428  u8 bfd_key_id, u8 is_delayed);
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  */
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  */
int lock_recursion_count
Definition: bfd_main.h:266
bfd_notify_fn_t * listeners
vector of callback notification functions
Definition: bfd_main.h:319
vnet_api_error_t
Definition: api_errno.h:153
bfd_main_t bfd_main
Definition: bfd_main.c:2258
bfd_auth_type_e auth_type
authentication type for this key
Definition: bfd_main.h:55
u8 curr_bfd_key_id
current key ID sent out in bfd packet
Definition: bfd_main.h:220
bfd_session_t * bfd_get_session(bfd_main_t *bm, bfd_transport_e t)
Definition: bfd_main.c:1337
struct bfd_session_s bfd_session_t
unsigned long u64
Definition: types.h:89
u32 * auth_key_by_conf_key_id
hashmap - index in pool auth_keys by conf_key_id
Definition: bfd_main.h:316
u64 echo_last_rx_clocks
timestamp of last echo packet received
Definition: bfd_main.h:181
static_always_inline void clib_spinlock_unlock_if_init(clib_spinlock_t *p)
Definition: lock.h:98
u32 echo_secret
secret used for calculating/checking checksum of echo packets
Definition: bfd_main.h:184
bfd_session_t * bfd_find_session_by_idx(bfd_main_t *bm, uword bs_idx)
Definition: bfd_main.c:1392
bfd_diag_code_e local_diag
local diagnostics
Definition: bfd_main.h:100
#define foreach_bfd_hop(F)
hop types
Definition: bfd_main.h:74
#define foreach_bfd_listen_event(F)
listener events
Definition: bfd_main.h:245
struct bfd_session_s::@50 auth
authentication information
u64 last_tx_clocks
timestamp of last packet transmitted
Definition: bfd_main.h:166
void bfd_register_listener(bfd_notify_fn_t fn)
Register a callback function to receive session notifications.
Definition: bfd_main.c:1294
u8 remote_seq_number_known
set to 1 if remote sequence number is known
Definition: bfd_main.h:217
static void bfd_unlock(bfd_main_t *bm)
Definition: bfd_main.h:385
int bfd_verify_pkt_common(const bfd_pkt_t *pkt)
verify bfd packet - common checks
Definition: bfd_main.c:1422
u8 data[128]
Definition: ipsec.api:248
uword owner_thread_index
Definition: bfd_main.h:267
bfd_diag_code_e
Definition: bfd_protocol.h:177
typedef CLIB_PACKED(struct { u32 discriminator;u64 expire_time_clocks;u64 checksum;}) bfd_echo_pkt_t
echo packet structure
u32 bfd_process_node_index
background process node index
Definition: bfd_main.h:294
u64 remote_min_echo_rx_clocks
remote min echo rx interval (clocks)
Definition: bfd_main.h:139
bfd_hop_type_e
Definition: bfd_main.h:78
u64 effective_required_min_rx_clocks
effective required min rx interval (clocks)
Definition: bfd_main.h:127
void bfd_put_session(bfd_main_t *bm, bfd_session_t *bs)
Definition: bfd_main.c:1371
#define foreach_bfd_mode(F)
Definition: bfd_main.h:29
vlib_log_class_t log_class
log class
Definition: bfd_main.h:322
u8 * bfd_input_format_trace(u8 *s, va_list *args)
Definition: bfd_main.c:476
bfd_auth_type_e
Definition: bfd_protocol.h:36
unsigned char u8
Definition: types.h:56
u32 remote_seq_number
remote sequence number
Definition: bfd_main.h:214
unsigned bfd_auth_type_supported(bfd_auth_type_e auth_type)
Definition: bfd_main.c:1998
bfd_error_t
Definition: bfd_main.h:333
double f64
Definition: types.h:142
timing_wheel_t wheel
timing wheel for scheduling timeouts
Definition: bfd_main.h:285
u64 effective_desired_min_tx_clocks
effective desired min tx interval (clocks)
Definition: bfd_main.h:118
static void bfd_lock_check(bfd_main_t *bm)
Definition: bfd_main.h:401
u32 vlib_log_class_t
Definition: vlib.h:50
bfd_mode_e
Definition: bfd_main.h:33
u64 bfd_process_next_wakeup_clocks
When the bfd process is supposed to wake up next.
Definition: bfd_main.h:279
u32 random_seed
for generating random numbers
Definition: bfd_main.h:310
int bfd_verify_pkt_auth(const bfd_pkt_t *pkt, u16 pkt_size, bfd_session_t *bs)
verify bfd packet - authentication
Definition: bfd_main.c:1703
#define foreach_bfd_error(F)
Packet counters.
Definition: bfd_main.h:328
void bfd_consume_pkt(bfd_main_t *bm, const bfd_pkt_t *bfd, u32 bs_idx)
Definition: bfd_main.c:1781
u64 remote_min_rx_usec
remote min rx interval (microseconds)
Definition: bfd_main.h:130
UDP transport specific data embedded in bfd_session&#39;s union.
Definition: bfd_udp.h:44
u64 tx_timeout_clocks
next time at which to transmit a packet
Definition: bfd_main.h:163
int bfd_consume_echo_pkt(bfd_main_t *bm, vlib_buffer_t *b)
Definition: bfd_main.c:1915
u64 config_required_min_rx_clocks
configured required min rx interval (clocks)
Definition: bfd_main.h:124
unsigned int u32
Definition: types.h:88
bfd_auth_key_t * next_key
set to next key to use if delayed switch is enabled - in that case the key is switched when first inc...
Definition: bfd_main.h:208
void bfd_event(bfd_main_t *bm, bfd_session_t *bs)
Definition: bfd_api.c:200
void bfd_session_set_flags(bfd_session_t *bs, u8 admin_up_down)
Definition: bfd_main.c:449
u8 remote_demand
1 if remote system sets demand mode, 0 otherwise
Definition: bfd_main.h:148
bfd_session_t * sessions
pool of bfd sessions context data
Definition: bfd_main.h:282
bfd_poll_state_e
Definition: bfd_main.h:64
bfd_auth_key_t * auth_keys
pool of authentication keys
Definition: bfd_main.h:313
bfd_transport_e transport
transport type for this session
Definition: bfd_main.h:233
u32 remote_discr
remote discriminator
Definition: bfd_main.h:109
u64 default_desired_min_tx_clocks
default desired min tx in clocks
Definition: bfd_main.h:304
u64 echo_last_tx_clocks
timestamp of last echo packet transmitted
Definition: bfd_main.h:178
bfd_poll_state_e poll_state
state info regarding poll sequence
Definition: bfd_main.h:190
u8 * format_bfd_session_brief(u8 *s, va_list *args)
Definition: bfd_main.c:1987
bfd_process_event_e
Definition: bfd_main.h:348
unsigned short u16
Definition: types.h:57
f64 cpu_cps
cpu clocks per second
Definition: bfd_main.h:301
u8 * format_bfd_session(u8 *s, va_list *args)
Definition: bfd_main.c:1951
u64 echo_tx_timeout_clocks
next time at which to transmit echo packet
Definition: bfd_main.h:175
u8 local_detect_mult
configured detect multiplier
Definition: bfd_main.h:145
#define PREDICT_FALSE(x)
Definition: clib.h:111
vnet_api_error_t bfd_auth_deactivate(bfd_session_t *bs, u8 is_delayed)
Definition: bfd_main.c:2058
u64 last_rx_clocks
timestamp of last packet received
Definition: bfd_main.h:169
bfd_udp_session_t udp
Definition: bfd_main.h:238
bfd_diag_code_e remote_diag
remote diagnostics
Definition: bfd_main.h:103
vnet_api_error_t bfd_session_set_params(bfd_main_t *bm, bfd_session_t *bs, u32 desired_min_tx_usec, u32 required_min_rx_usec, u8 detect_mult)
Definition: bfd_main.c:2100
u64 transmit_interval_clocks
transmit interval
Definition: bfd_main.h:160
vnet_main_t * vnet_main
Definition: bfd_main.h:298
#define foreach_bfd_poll_state(F)
Definition: bfd_main.h:58
vnet_api_error_t bfd_auth_activate(bfd_session_t *bs, u32 conf_key_id, u8 bfd_key_id, u8 is_delayed)
Definition: bfd_main.c:2009
BFD protocol declarations.
u32 config_desired_min_tx_usec
configured desired min tx interval (microseconds)
Definition: bfd_main.h:112
#define clib_warning(format, args...)
Definition: error.h:59
u64 poll_state_start_or_timeout_clocks
helper for delayed poll sequence - marks either start of running poll sequence or timeout...
Definition: bfd_main.h:196
bfd_state_e
Definition: bfd_protocol.h:195
u64 detection_time_clocks
detection time
Definition: bfd_main.h:187
void bfd_session_start(bfd_main_t *bm, bfd_session_t *bs)
Definition: bfd_main.c:435
#define ASSERT(truth)
u64 config_desired_min_tx_clocks
configured desired min tx interval (clocks)
Definition: bfd_main.h:115
u64 bfd_process_wakeup_event_start_clocks
The timestamp of last wakeup event being sent.
Definition: bfd_main.h:273
u32 bfd_clocks_to_usec(const bfd_main_t *bm, u64 clocks)
Definition: bfd_main.c:61
u8 echo
1 is echo function is active, 0 otherwise
Definition: bfd_main.h:154
#define F(x)
Definition: bfd_main.h:335
u64 wheel_time_clocks
set to value of timer in timing wheel, 0 if never set
Definition: bfd_main.h:157
u64 remote_desired_min_tx_clocks
remote desired min tx interval (clocks)
Definition: bfd_main.h:142
u8 * format_bfd_auth_key(u8 *s, va_list *args)
Definition: bfd_main.c:69
u32 local_discr
local discriminator
Definition: bfd_main.h:106
bfd_hop_type_e hop_type
BFD hop type.
Definition: bfd_main.h:97
u32 conf_key_id
global configuration key ID
Definition: bfd_main.h:43
vlib_main_t * vlib_main
convenience variables
Definition: bfd_main.h:297
bfd_state_e local_state
session state
Definition: bfd_main.h:91
u32 * session_by_disc
hashmap - bfd session by discriminator
Definition: bfd_main.h:291
void(* bfd_notify_fn_t)(bfd_listen_event_e, const bfd_session_t *)
session nitification call back function type
Definition: bfd_main.h:260
u64 echo_transmit_interval_clocks
transmit interval for echo packets
Definition: bfd_main.h:172
u32 local_seq_number
sequence number incremented occasionally or always (if meticulous)
Definition: bfd_main.h:211
u32 config_required_min_rx_usec
configured required min rx interval (microseconds)
Definition: bfd_main.h:121
BFD UDP transport layer declarations.
void bfd_init_final_control_frame(vlib_main_t *vm, vlib_buffer_t *b, bfd_main_t *bm, bfd_session_t *bs, int is_local)
Definition: bfd_main.c:1027
u32 use_count
keeps track of how many sessions reference this key
Definition: bfd_main.h:46
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
u8 next_bfd_key_id
key ID to use when switched to next_key
Definition: bfd_main.h:223
typedef key
Definition: ipsec.api:244
int bfd_process_wakeup_events_in_flight
Number of event wakeup RPCs in flight.
Definition: bfd_main.h:270
u64 bfd_process_wakeup_event_delay_clocks
The time it took the last wakeup event to make it to handling.
Definition: bfd_main.h:276
u32 bs_idx
index in bfd_main.sessions pool
Definition: bfd_main.h:88
u64 remote_min_echo_rx_usec
remote min echo rx interval (microseconds)
Definition: bfd_main.h:136
bfd_state_e remote_state
remote session state
Definition: bfd_main.h:94
bfd_session_t * bfd_find_session_by_disc(bfd_main_t *bm, u32 disc)
Definition: bfd_main.c:1403
const char * bfd_poll_state_string(bfd_poll_state_e state)
Definition: bfd_main.c:147
bfd packet trace capture
Definition: bfd_main.h:342
u64 min_required_min_rx_while_echo_clocks
minimum required min rx while echo function is active - clocks
Definition: bfd_main.h:307
bfd_auth_key_t * curr_key
current key in use
Definition: bfd_main.h:202
clib_spinlock_t lock
lock to protect data structures
Definition: bfd_main.h:265
static_always_inline void clib_spinlock_lock_if_init(clib_spinlock_t *p)
Definition: lock.h:82
u8 remote_detect_mult
remote detect multiplier
Definition: bfd_main.h:151
u64 remote_min_rx_clocks
remote min rx interval (clocks)
Definition: bfd_main.h:133
u8 is_delayed
set to 1 if delayed action is pending, which might be activation of authentication, change of key or deactivation
Definition: bfd_main.h:229
static void bfd_lock(bfd_main_t *bm)
Definition: bfd_main.h:368
bfd_transport_e
Definition: bfd_api.h:30
bfd_listen_event_e
Definition: bfd_main.h:250
u64 wheel_inaccuracy
timing wheel inaccuracy, in clocks
Definition: bfd_main.h:288