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