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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * @brief BFD global declarations
19 #ifndef __included_bfd_main_h__
20 #define __included_bfd_main_h__
22 #include <vnet/vnet.h>
23 #include <vnet/bfd/bfd_protocol.h>
24 #include <vnet/bfd/bfd_udp.h>
26 #include <vppinfra/os.h>
27 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
29 #define foreach_bfd_mode(F) \
35 #define F(x) BFD_MODE_##x,
42 /** global configuration key ID */
45 /** keeps track of how many sessions reference this key */
49 * key data directly usable for bfd purposes - already padded with zeroes
50 * (so we don't need the actual length)
54 /** authentication type for this key */
55 bfd_auth_type_e auth_type;
58 #define foreach_bfd_poll_state(F) \
62 F (IN_PROGRESS_AND_QUEUED)
66 #define F(x) BFD_POLL_##x,
67 foreach_bfd_poll_state (F)
74 #define foreach_bfd_hop(F) \
75 F (SINGLE, "single") \
80 #define F(sym, str) BFD_HOP_TYPE_##sym,
85 typedef struct bfd_session_s
87 /** index in bfd_main.sessions pool */
91 bfd_state_e local_state;
93 /** remote session state */
94 bfd_state_e remote_state;
97 bfd_hop_type_e hop_type;
99 /** local diagnostics */
100 bfd_diag_code_e local_diag;
102 /** remote diagnostics */
103 bfd_diag_code_e remote_diag;
105 /** local discriminator */
108 /** remote discriminator */
111 /** configured desired min tx interval (microseconds) */
112 u32 config_desired_min_tx_usec;
114 /** configured desired min tx interval (nsec) */
115 u64 config_desired_min_tx_nsec;
117 /** effective desired min tx interval (nsec) */
118 u64 effective_desired_min_tx_nsec;
120 /** configured required min rx interval (microseconds) */
121 u32 config_required_min_rx_usec;
123 /** configured required min rx interval (nsec) */
124 u64 config_required_min_rx_nsec;
126 /** effective required min rx interval (nsec) */
127 u64 effective_required_min_rx_nsec;
129 /** remote min rx interval (microseconds) */
130 u64 remote_min_rx_usec;
132 /** remote min rx interval (nsec) */
133 u64 remote_min_rx_nsec;
135 /** remote min echo rx interval (microseconds) */
136 u64 remote_min_echo_rx_usec;
138 /** remote min echo rx interval (nsec) */
139 u64 remote_min_echo_rx_nsec;
141 /** remote desired min tx interval (nsec) */
142 u64 remote_desired_min_tx_nsec;
144 /** configured detect multiplier */
145 u8 local_detect_mult;
147 /** 1 if remote system sets demand mode, 0 otherwise */
150 /** remote detect multiplier */
151 u8 remote_detect_mult;
153 /** 1 is echo function is active, 0 otherwise */
156 /** next event time in nsec for this session (0 if no event) */
159 /** timing wheel internal id used to manipulate timer (if set) */
162 /** transmit interval */
163 u64 transmit_interval_nsec;
165 /** next time at which to transmit a packet */
168 /** timestamp of last packet transmitted */
171 /** timestamp of last packet received */
174 /** transmit interval for echo packets */
175 u64 echo_transmit_interval_nsec;
177 /** next time at which to transmit echo packet */
178 u64 echo_tx_timeout_nsec;
180 /** timestamp of last echo packet transmitted */
181 u64 echo_last_tx_nsec;
183 /** timestamp of last echo packet received */
184 u64 echo_last_rx_nsec;
186 /** secret used for calculating/checking checksum of echo packets */
189 /** detection time */
190 u64 detection_time_nsec;
192 /** state info regarding poll sequence */
193 bfd_poll_state_e poll_state;
196 * helper for delayed poll sequence - marks either start of running poll
197 * sequence or timeout, after which we can start the next poll sequnce
199 u64 poll_state_start_or_timeout_nsec;
201 /** authentication information */
204 /** current key in use */
205 bfd_auth_key_t *curr_key;
208 * set to next key to use if delayed switch is enabled - in that case
209 * the key is switched when first incoming packet is signed with next_key
211 bfd_auth_key_t *next_key;
213 /** sequence number incremented occasionally or always (if meticulous) */
214 u32 local_seq_number;
216 /** remote sequence number */
217 u32 remote_seq_number;
219 /** set to 1 if remote sequence number is known */
220 u8 remote_seq_number_known;
222 /** current key ID sent out in bfd packet */
225 /** key ID to use when switched to next_key */
229 * set to 1 if delayed action is pending, which might be activation
230 * of authentication, change of key or deactivation
235 /** transport type for this session */
236 bfd_transport_e transport;
238 /** union of transport-specific data */
241 bfd_udp_session_t udp;
248 #define foreach_bfd_listen_event(F) \
249 F (CREATE, "sesion-created") \
250 F (UPDATE, "session-updated") \
251 F (DELETE, "session-deleted")
255 #define F(sym, str) BFD_LISTEN_EVENT_##sym,
256 foreach_bfd_listen_event (F)
258 } bfd_listen_event_e;
261 * session notification call back function type
263 typedef void (*bfd_notify_fn_t) (bfd_listen_event_e, const bfd_session_t *);
267 /** lock to protect data structures */
268 clib_spinlock_t lock;
269 int lock_recursion_count;
270 uword owner_thread_index;
272 /** Number of event wakeup RPCs in flight. Should be 0 or 1 */
273 int bfd_process_wakeup_events_in_flight;
275 /** The timestamp of last wakeup event being sent */
276 u64 bfd_process_wakeup_event_start_nsec;
278 /** The time it took the last wakeup event to make it to handling */
279 u64 bfd_process_wakeup_event_delay_nsec;
281 /** When the bfd process is supposed to wake up next */
282 u64 bfd_process_next_wakeup_nsec;
284 /** pool of bfd sessions context data */
285 bfd_session_t *sessions;
287 /** timing wheel for scheduling timeouts */
288 TWT (tw_timer_wheel) wheel;
290 /** hashmap - bfd session by discriminator */
291 u32 *session_by_disc;
293 /** background process node index */
294 u32 bfd_process_node_index;
296 /** convenience variables */
297 vlib_main_t *vlib_main;
298 vnet_main_t *vnet_main;
300 /** how many nanoseconds is one timing wheel tick */
301 u64 nsec_per_tw_tick;
303 /** default desired min tx in nsec */
304 u64 default_desired_min_tx_nsec;
306 /** minimum required min rx while echo function is active - nsec */
307 u64 min_required_min_rx_while_echo_nsec;
309 /** for generating random numbers */
312 /** pool of authentication keys */
313 bfd_auth_key_t *auth_keys;
315 /** hashmap - index in pool auth_keys by conf_key_id */
316 u32 *auth_key_by_conf_key_id;
318 /** vector of callback notification functions */
319 bfd_notify_fn_t *listeners;
322 vlib_log_class_t log_class;
326 vlib_combined_counter_main_t rx_counter;
327 vlib_combined_counter_main_t rx_echo_counter;
328 vlib_combined_counter_main_t tx_counter;
329 vlib_combined_counter_main_t tx_echo_counter;
332 extern bfd_main_t bfd_main;
334 /** Packet counters */
335 #define foreach_bfd_error(F) \
336 F (NONE, "good bfd packets (processed)") \
337 F (BAD, "invalid bfd packets") \
338 F (DISABLED, "bfd packets received on disabled interfaces") \
339 F (VERSION, "version") \
340 F (LENGTH, "length") \
341 F (DETECT_MULTI, "detect-multi") \
342 F (MULTI_POINT, "multi-point") \
343 F (MY_DISC, "my-disc") \
344 F (YOUR_DISC, "your-disc") \
345 F (ADMIN_DOWN, "session admin-down")
349 #define F(sym, str) BFD_ERROR_##sym,
350 foreach_bfd_error (F)
355 /** bfd packet trace capture */
364 BFD_EVENT_RESCHEDULE = 1,
365 BFD_EVENT_NEW_SESSION,
366 BFD_EVENT_CONFIG_CHANGED,
367 } bfd_process_event_e;
370 /** echo packet structure */
371 typedef CLIB_PACKED (struct {
372 /** local discriminator */
374 /** expire time of this packet - nsec */
375 u64 expire_time_nsec;
376 /** checksum - based on discriminator, local secret and expire time */
382 bfd_lock (bfd_main_t * bm)
384 uword my_thread_index = __os_thread_index;
386 if (bm->owner_thread_index == my_thread_index
387 && bm->lock_recursion_count > 0)
389 bm->lock_recursion_count++;
393 clib_spinlock_lock_if_init (&bm->lock);
394 bm->lock_recursion_count = 1;
395 bm->owner_thread_index = my_thread_index;
399 bfd_unlock (bfd_main_t * bm)
401 uword my_thread_index = __os_thread_index;
402 ASSERT (bm->owner_thread_index == my_thread_index);
404 if (bm->lock_recursion_count > 1)
406 bm->lock_recursion_count--;
409 bm->lock_recursion_count = 0;
410 bm->owner_thread_index = ~0;
411 clib_spinlock_unlock_if_init (&bm->lock);
415 bfd_lock_check (bfd_main_t * bm)
417 if (PREDICT_FALSE (bm->lock_recursion_count < 1))
418 clib_warning ("lock check failure");
421 u8 *bfd_input_format_trace (u8 * s, va_list * args);
422 bfd_session_t *bfd_get_session (bfd_main_t * bm, bfd_transport_e t);
423 void bfd_put_session (bfd_main_t * bm, bfd_session_t * bs);
424 bfd_session_t *bfd_find_session_by_idx (bfd_main_t * bm, uword bs_idx);
425 bfd_session_t *bfd_find_session_by_disc (bfd_main_t * bm, u32 disc);
426 void bfd_session_start (bfd_main_t * bm, bfd_session_t * bs);
427 void bfd_session_stop (bfd_main_t *bm, bfd_session_t *bs);
428 bfd_error_t bfd_consume_pkt (vlib_main_t *vm, bfd_main_t *bm,
429 const bfd_pkt_t *bfd, u32 bs_idx);
430 bfd_session_t *bfd_consume_echo_pkt (vlib_main_t *vm, bfd_main_t *bm,
432 bfd_error_t bfd_verify_pkt_common (const bfd_pkt_t *pkt);
433 int bfd_verify_pkt_auth (vlib_main_t * vm, const bfd_pkt_t * pkt,
434 u16 pkt_size, bfd_session_t * bs);
435 void bfd_event (bfd_main_t * bm, bfd_session_t * bs);
436 void bfd_init_final_control_frame (vlib_main_t *vm, vlib_buffer_t *b,
438 u8 *format_bfd_session (u8 * s, va_list * args);
439 u8 *format_bfd_session_brief (u8 * s, va_list * args);
440 u8 *format_bfd_auth_key (u8 * s, va_list * args);
441 void bfd_session_set_flags (vlib_main_t * vm, bfd_session_t * bs,
443 unsigned bfd_auth_type_supported (bfd_auth_type_e auth_type);
444 vnet_api_error_t bfd_auth_activate (bfd_session_t * bs, u32 conf_key_id,
445 u8 bfd_key_id, u8 is_delayed);
446 vnet_api_error_t bfd_auth_deactivate (bfd_session_t * bs, u8 is_delayed);
447 vnet_api_error_t bfd_session_set_params (bfd_main_t * bm, bfd_session_t * bs,
448 u32 desired_min_tx_usec,
449 u32 required_min_rx_usec,
452 u32 bfd_nsec_to_usec (u64 nsec);
453 const char *bfd_poll_state_string (bfd_poll_state_e state);
455 #define USEC_PER_MS (1000LL)
456 #define MSEC_PER_SEC (1000LL)
457 #define NSEC_PER_USEC (1000LL)
458 #define USEC_PER_SEC (MSEC_PER_SEC * USEC_PER_MS)
459 #define NSEC_PER_SEC (NSEC_PER_USEC * USEC_PER_SEC)
460 #define SEC_PER_NSEC ((f64)1/NSEC_PER_SEC)
462 /** timing wheel tick-rate, 1ms should be good enough */
463 #define BFD_TW_TPS (MSEC_PER_SEC)
465 /** default, slow transmission interval for BFD packets, per spec at least 1s */
466 #define BFD_DEFAULT_DESIRED_MIN_TX_USEC USEC_PER_SEC
469 * minimum required min rx set locally when echo function is used, per spec
470 * should be set to at least 1s
472 #define BFD_REQUIRED_MIN_RX_USEC_WHILE_ECHO USEC_PER_SEC
475 * Register a callback function to receive session notifications.
477 void bfd_register_listener (bfd_notify_fn_t fn);
479 #endif /* __included_bfd_main_h__ */
482 * fd.io coding-style-patch-verification: ON
485 * eval: (c-set-style "gnu")