1 /*********************************************************************
2 * Copyright 2014,2015,2016,2017 Cumulus Networks, Inc. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the Free
6 * Software Foundation; either version 2 of the License, or (at your option)
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along
15 * with this program; see the file COPYING; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 * bfd.h: implements the BFD protocol.
24 #include <netinet/in.h>
31 #include "lib/libfrr.h"
33 #include "lib/queue.h"
39 #define BFDD_JSON_CONV_OPTIONS (JSON_C_TO_STRING_PRETTY)
41 #define BFDD_JSON_CONV_OPTIONS (0)
45 DECLARE_MTYPE(BFDD_CONTROL
);
46 DECLARE_MTYPE(BFDD_NOTIFICATION
);
49 uint32_t desired_min_tx
;
50 uint32_t required_min_rx
;
51 uint32_t required_min_echo
;
56 uint32_t remote_discr
;
60 * Format of control packet. From section 4)
72 struct bfd_discrs discrs
;
73 struct bfd_timers timers
;
77 * Format of Echo packet.
93 /* Macros for manipulating control packets */
94 #define BFD_VERMASK 0x03
95 #define BFD_DIAGMASK 0x1F
96 #define BFD_GETVER(diag) ((diag >> 5) & BFD_VERMASK)
97 #define BFD_SETVER(diag, val) ((diag) |= (val & BFD_VERMASK) << 5)
100 #define BFD_FBIT 0x10
101 #define BFD_CBIT 0x08
102 #define BFD_ABIT 0x04
103 #define BFD_DEMANDBIT 0x02
104 #define BFD_SETDEMANDBIT(flags, val) \
107 flags |= BFD_DEMANDBIT; \
109 #define BFD_SETPBIT(flags, val) \
114 #define BFD_GETPBIT(flags) (flags & BFD_PBIT)
115 #define BFD_SETFBIT(flags, val) \
120 #define BFD_GETFBIT(flags) (flags & BFD_FBIT)
121 #define BFD_SETSTATE(flags, val) \
124 flags |= (val & 0x3) << 6; \
126 #define BFD_GETSTATE(flags) ((flags >> 6) & 0x3)
127 #define BFD_SETCBIT(flags, val) \
132 #define BFD_GETCBIT(flags) (flags & BFD_FBIT)
133 #define BFD_ECHO_VERSION 1
134 #define BFD_ECHO_PKT_LEN sizeof(struct bfd_echo_pkt)
136 enum bfd_diagnosticis
{
138 /* Control Detection Time Expired. */
139 BD_CONTROL_EXPIRED
= 1,
140 /* Echo Function Failed. */
142 /* Neighbor Signaled Session Down. */
143 BD_NEIGHBOR_DOWN
= 3,
144 /* Forwarding Plane Reset. */
145 BD_FORWARDING_RESET
= 4,
148 /* Concatenated Path Down. */
149 BD_CONCATPATH_DOWN
= 6,
150 /* Administratively Down. */
152 /* Reverse Concatenated Path Down. */
153 BD_REVCONCATPATH_DOWN
= 8,
154 /* 9..31: reserved. */
157 /* BFD session flags */
158 enum bfd_session_flags
{
159 BFD_SESS_FLAG_NONE
= 0,
160 BFD_SESS_FLAG_ECHO
= 1 << 0, /* BFD Echo functionality */
161 BFD_SESS_FLAG_ECHO_ACTIVE
= 1 << 1, /* BFD Echo Packets are being sent
164 BFD_SESS_FLAG_MH
= 1 << 2, /* BFD Multi-hop session */
165 BFD_SESS_FLAG_IPV6
= 1 << 4, /* BFD IPv6 session */
166 BFD_SESS_FLAG_SEND_EVT_ACTIVE
= 1 << 5, /* send event timer active */
167 BFD_SESS_FLAG_SEND_EVT_IGNORE
= 1 << 6, /* ignore send event when timer
170 BFD_SESS_FLAG_SHUTDOWN
= 1 << 7, /* disable BGP peer function */
171 BFD_SESS_FLAG_CONFIG
= 1 << 8, /* Session configured with bfd NB API */
172 BFD_SESS_FLAG_CBIT
= 1 << 9, /* CBIT is set */
173 BFD_SESS_FLAG_PASSIVE
= 1 << 10, /* Passive mode */
177 * BFD session hash key.
179 * This structure must not have any padding bytes because their value is
180 * unspecified after the struct assignment. Even when all fields of two keys
181 * are the same, if the padding bytes are different, then the calculated hash
182 * value is different, and the hash lookup will fail.
184 * Currently, the structure fields are correctly aligned, and the "packed"
185 * attribute is added as a precaution. "family" and "mhop" fields are two-bytes
186 * to eliminate unaligned memory access to "peer" and "local".
191 struct in6_addr peer
;
192 struct in6_addr local
;
193 char ifname
[MAXNAMELEN
];
194 char vrfname
[MAXNAMELEN
];
195 } __attribute__((packed
));
197 struct bfd_session_stats
{
198 uint64_t rx_ctrl_pkt
;
199 uint64_t tx_ctrl_pkt
;
200 uint64_t rx_echo_pkt
;
201 uint64_t tx_echo_pkt
;
203 uint64_t session_down
;
204 uint64_t znotification
;
208 * BFD session profile to override default configurations.
214 /** Session detection multiplier. */
215 uint8_t detection_multiplier
;
216 /** Desired transmission interval (in microseconds). */
218 /** Minimum required receive interval (in microseconds). */
220 /** Administrative state. */
224 /** Minimum expected TTL value. */
227 /** Echo mode (only applies to single hop). */
229 /** Desired echo transmission interval (in microseconds). */
230 uint32_t min_echo_tx
;
231 /** Minimum required echo receive interval (in microseconds). */
232 uint32_t min_echo_rx
;
234 /** Profile list entry. */
235 TAILQ_ENTRY(bfd_profile
) entry
;
238 /** Profile list type. */
239 TAILQ_HEAD(bfdproflist
, bfd_profile
);
241 /* bfd_session shortcut label forwarding. */
244 struct bfd_config_timers
{
245 uint32_t desired_min_tx
;
246 uint32_t required_min_rx
;
247 uint32_t desired_min_echo_tx
;
248 uint32_t required_min_echo_rx
;
252 * Session state information
256 /* protocol state per RFC 5880*/
258 struct bfd_discrs discrs
;
262 uint8_t remote_detect_mult
;
266 /** BFD profile name. */
268 /** BFD pre configured profile. */
269 struct bfd_profile
*profile
;
270 /** BFD peer configuration (without profile). */
271 struct bfd_profile peer_profile
;
274 struct bfd_config_timers timers
;
275 struct bfd_timers cur_timers
;
277 struct thread
*echo_recvtimer_ev
;
278 struct thread
*recvtimer_ev
;
280 uint64_t echo_xmt_TO
;
281 struct thread
*xmttimer_ev
;
282 struct thread
*echo_xmttimer_ev
;
283 uint64_t echo_detect_TO
;
285 /* software object state */
288 /* This and the localDiscr are the keys to state info */
290 struct peer_label
*pl
;
292 struct bfd_dplane_ctx
*bdc
;
293 struct sockaddr_any local_address
;
294 struct interface
*ifp
;
299 /* BFD session flags */
300 enum bfd_session_flags flags
;
302 struct bfd_session_stats stats
;
304 struct timeval uptime
; /* last up time */
305 struct timeval downtime
; /* last down time */
307 /* Remote peer data (for debugging mostly) */
309 struct bfd_timers remote_timers
;
311 uint64_t refcount
; /* number of pointers referencing this. */
315 TAILQ_ENTRY(peer_label
) pl_entry
;
317 struct bfd_session
*pl_bs
;
318 char pl_label
[MAXNAMELEN
];
320 TAILQ_HEAD(pllist
, peer_label
);
322 struct bfd_diag_str_list
{
327 struct bfd_state_str_list
{
332 struct bfd_session_observer
{
333 struct bfd_session
*bso_bs
;
334 char bso_entryname
[MAXNAMELEN
];
335 struct prefix bso_addr
;
337 TAILQ_ENTRY(bfd_session_observer
) bso_entry
;
339 TAILQ_HEAD(obslist
, bfd_session_observer
);
342 /* States defined per 4.1 */
343 #define PTM_BFD_ADM_DOWN 0
344 #define PTM_BFD_DOWN 1
345 #define PTM_BFD_INIT 2
349 /* Various constants */
350 /* Retrieved from ptm_timer.h from Cumulus PTM sources. */
351 #define BFD_DEF_DEMAND 0
352 #define BFD_DEFDETECTMULT 3
353 #define BFD_DEFDESIREDMINTX (300 * 1000) /* microseconds. */
354 #define BFD_DEFREQUIREDMINRX (300 * 1000) /* microseconds. */
355 #define BFD_DEF_DES_MIN_ECHO_TX (50 * 1000) /* microseconds. */
356 #define BFD_DEF_REQ_MIN_ECHO_RX (50 * 1000) /* microseconds. */
357 #define BFD_DEF_SLOWTX (1000 * 1000) /* microseconds. */
358 /** Minimum multi hop TTL. */
359 #define BFD_DEF_MHOP_TTL 254
360 #define BFD_PKT_LEN 24 /* Length of control packet */
361 #define BFD_TTL_VAL 255
362 #define BFD_RCV_TTL_VAL 1
363 #define BFD_TOS_VAL 0xC0
364 #define BFD_PKT_INFO_VAL 1
365 #define BFD_IPV6_PKT_INFO_VAL 1
366 #define BFD_IPV6_ONLY_VAL 1
367 #define BFD_SRCPORTINIT 49152
368 #define BFD_SRCPORTMAX 65535
369 #define BFD_DEFDESTPORT 3784
370 #define BFD_DEF_ECHO_PORT 3785
371 #define BFD_DEF_MHOP_DEST_PORT 4784
376 * Daemon control code to speak with local consumers.
379 /* See 'bfdctrl.h' for client protocol definitions. */
381 struct bfd_control_buffer
{
385 struct bfd_control_msg
*bcb_bcm
;
390 struct bfd_control_queue
{
391 TAILQ_ENTRY(bfd_control_queue
) bcq_entry
;
393 struct bfd_control_buffer bcq_bcb
;
395 TAILQ_HEAD(bcqueue
, bfd_control_queue
);
397 struct bfd_notify_peer
{
398 TAILQ_ENTRY(bfd_notify_peer
) bnp_entry
;
400 struct bfd_session
*bnp_bs
;
402 TAILQ_HEAD(bnplist
, bfd_notify_peer
);
404 struct bfd_control_socket
{
405 TAILQ_ENTRY(bfd_control_socket
) bcs_entry
;
408 struct thread
*bcs_ev
;
409 struct thread
*bcs_outev
;
410 struct bcqueue bcs_bcqueue
;
412 /* Notification data */
414 struct bnplist bcs_bnplist
;
416 enum bc_msg_version bcs_version
;
417 enum bc_msg_type bcs_type
;
419 /* Message buffering */
420 struct bfd_control_buffer bcs_bin
;
421 struct bfd_control_buffer
*bcs_bout
;
423 TAILQ_HEAD(bcslist
, bfd_control_socket
);
425 int control_init(const char *path
);
426 void control_shutdown(void);
427 int control_notify(struct bfd_session
*bs
, uint8_t notify_state
);
428 int control_notify_config(const char *op
, struct bfd_session
*bs
);
429 void control_accept(struct thread
*t
);
435 * Daemon specific code.
437 struct bfd_vrf_global
{
446 struct thread
*bg_ev
[6];
449 /* Forward declaration of data plane context struct. */
450 struct bfd_dplane_ctx
;
451 TAILQ_HEAD(dplane_queue
, bfd_dplane_ctx
);
455 struct thread
*bg_csockev
;
456 struct bcslist bg_bcslist
;
458 struct pllist bg_pllist
;
460 struct obslist bg_obslist
;
462 struct zebra_privs_t bfdd_privs
;
465 * Daemon is exit()ing? Use this to avoid actions that expect a
466 * running system or to avoid unnecessary operations when quitting.
470 /* Distributed BFD items. */
473 struct thread
*bg_dplane_sockev
;
474 struct dplane_queue bg_dplaneq
;
477 /* Show distributed BFD debug messages. */
479 /* Show all peer state changes events. */
480 bool debug_peer_event
;
482 * Show zebra message exchanges:
483 * - Interface add/delete.
484 * - Local address add/delete.
489 * Show network level debug information:
490 * - Echo packets without session.
491 * - Unavailable peer sessions.
492 * - Network system call failures.
497 extern struct bfd_global bglobal
;
498 extern const struct bfd_diag_str_list diag_list
[];
499 extern const struct bfd_state_str_list state_list
[];
501 void socket_close(int *s
);
507 * Contains the code related with loading/reloading configuration.
509 int parse_config(const char *fname
);
510 int config_request_add(const char *jsonstr
);
511 int config_request_del(const char *jsonstr
);
512 char *config_response(const char *status
, const char *error
);
513 char *config_notify(struct bfd_session
*bs
);
514 char *config_notify_config(const char *op
, struct bfd_session
*bs
);
516 typedef int (*bpc_handle
)(struct bfd_peer_cfg
*, void *arg
);
517 int config_notify_request(struct bfd_control_socket
*bcs
, const char *jsonstr
,
520 struct peer_label
*pl_new(const char *label
, struct bfd_session
*bs
);
521 struct peer_label
*pl_find(const char *label
);
522 void pl_free(struct peer_label
*pl
);
526 * logging - alias to zebra log
528 #define zlog_fatal(msg, ...) \
530 zlog_err(msg, ##__VA_ARGS__); \
539 * Contains the code related with receiving/seding, packing/unpacking BFD data.
541 int bp_set_ttlv6(int sd
, uint8_t value
);
542 int bp_set_ttl(int sd
, uint8_t value
);
543 int bp_set_tosv6(int sd
, uint8_t value
);
544 int bp_set_tos(int sd
, uint8_t value
);
545 int bp_bind_dev(int sd
, const char *dev
);
547 int bp_udp_shop(const struct vrf
*vrf
);
548 int bp_udp_mhop(const struct vrf
*vrf
);
549 int bp_udp6_shop(const struct vrf
*vrf
);
550 int bp_udp6_mhop(const struct vrf
*vrf
);
551 int bp_peer_socket(const struct bfd_session
*bs
);
552 int bp_peer_socketv6(const struct bfd_session
*bs
);
553 int bp_echo_socket(const struct vrf
*vrf
);
554 int bp_echov6_socket(const struct vrf
*vrf
);
556 void ptm_bfd_snd(struct bfd_session
*bfd
, int fbit
);
557 void ptm_bfd_echo_snd(struct bfd_session
*bfd
);
559 void bfd_recv_cb(struct thread
*t
);
565 * Contains the code related with event loop.
567 typedef void (*bfd_ev_cb
)(struct thread
*t
);
569 void bfd_recvtimer_update(struct bfd_session
*bs
);
570 void bfd_echo_recvtimer_update(struct bfd_session
*bs
);
571 void bfd_xmttimer_update(struct bfd_session
*bs
, uint64_t jitter
);
572 void bfd_echo_xmttimer_update(struct bfd_session
*bs
, uint64_t jitter
);
574 void bfd_xmttimer_delete(struct bfd_session
*bs
);
575 void bfd_echo_xmttimer_delete(struct bfd_session
*bs
);
576 void bfd_recvtimer_delete(struct bfd_session
*bs
);
577 void bfd_echo_recvtimer_delete(struct bfd_session
*bs
);
579 void bfd_recvtimer_assign(struct bfd_session
*bs
, bfd_ev_cb cb
, int sd
);
580 void bfd_echo_recvtimer_assign(struct bfd_session
*bs
, bfd_ev_cb cb
, int sd
);
581 void bfd_xmttimer_assign(struct bfd_session
*bs
, bfd_ev_cb cb
);
582 void bfd_echo_xmttimer_assign(struct bfd_session
*bs
, bfd_ev_cb cb
);
588 * BFD protocol specific code.
590 int bfd_session_enable(struct bfd_session
*bs
);
591 void bfd_session_disable(struct bfd_session
*bs
);
592 struct bfd_session
*ptm_bfd_sess_new(struct bfd_peer_cfg
*bpc
);
593 int ptm_bfd_sess_del(struct bfd_peer_cfg
*bpc
);
594 void ptm_bfd_sess_dn(struct bfd_session
*bfd
, uint8_t diag
);
595 void ptm_bfd_sess_up(struct bfd_session
*bfd
);
596 void ptm_bfd_echo_stop(struct bfd_session
*bfd
);
597 void ptm_bfd_echo_start(struct bfd_session
*bfd
);
598 void ptm_bfd_xmt_TO(struct bfd_session
*bfd
, int fbit
);
599 void ptm_bfd_start_xmt_timer(struct bfd_session
*bfd
, bool is_echo
);
600 struct bfd_session
*ptm_bfd_sess_find(struct bfd_pkt
*cp
,
601 struct sockaddr_any
*peer
,
602 struct sockaddr_any
*local
,
603 struct interface
*ifp
,
607 struct bfd_session
*bs_peer_find(struct bfd_peer_cfg
*bpc
);
608 int bfd_session_update_label(struct bfd_session
*bs
, const char *nlabel
);
609 void bfd_set_polling(struct bfd_session
*bs
);
610 void bs_state_handler(struct bfd_session
*bs
, int nstate
);
611 void bs_echo_timer_handler(struct bfd_session
*bs
);
612 void bs_final_handler(struct bfd_session
*bs
);
613 void bs_set_slow_timers(struct bfd_session
*bs
);
614 const char *satostr(const struct sockaddr_any
*sa
);
615 const char *diag2str(uint8_t diag
);
616 int strtosa(const char *addr
, struct sockaddr_any
*sa
);
617 void integer2timestr(uint64_t time
, char *buf
, size_t buflen
);
618 const char *bs_to_string(const struct bfd_session
*bs
);
620 int bs_observer_add(struct bfd_session
*bs
);
621 void bs_observer_del(struct bfd_session_observer
*bso
);
623 void bs_to_bpc(struct bfd_session
*bs
, struct bfd_peer_cfg
*bpc
);
625 void gen_bfd_key(struct bfd_key
*key
, struct sockaddr_any
*peer
,
626 struct sockaddr_any
*local
, bool mhop
, const char *ifname
,
627 const char *vrfname
);
628 struct bfd_session
*bfd_session_new(void);
629 struct bfd_session
*bs_registrate(struct bfd_session
*bs
);
630 void bfd_session_free(struct bfd_session
*bs
);
631 const struct bfd_session
*bfd_session_next(const struct bfd_session
*bs
,
633 void bfd_sessions_remove_manual(void);
634 void bfd_profiles_remove(void);
637 * Set the BFD session echo state.
639 * \param bs the BFD session.
640 * \param echo the echo operational state.
642 void bfd_set_echo(struct bfd_session
*bs
, bool echo
);
645 * Set the BFD session functional state.
647 * \param bs the BFD session.
648 * \param shutdown the operational value.
650 void bfd_set_shutdown(struct bfd_session
*bs
, bool shutdown
);
653 * Set the BFD session passive mode.
655 * \param bs the BFD session.
656 * \param passive the passive mode.
658 void bfd_set_passive_mode(struct bfd_session
*bs
, bool passive
);
661 * Picks the BFD session configuration from the appropriated source:
662 * if using the default peer configuration prefer profile (if it exists),
663 * otherwise use session.
665 * \param bs the BFD session.
667 void bfd_session_apply(struct bfd_session
*bs
);
669 /* BFD hash data structures interface */
670 void bfd_initialize(void);
671 void bfd_shutdown(void);
672 void bfd_vrf_init(void);
673 void bfd_vrf_terminate(void);
674 struct bfd_vrf_global
*bfd_vrf_look_by_session(struct bfd_session
*bfd
);
675 struct bfd_session
*bfd_id_lookup(uint32_t id
);
676 struct bfd_session
*bfd_key_lookup(struct bfd_key key
);
678 struct bfd_session
*bfd_id_delete(uint32_t id
);
679 struct bfd_session
*bfd_key_delete(struct bfd_key key
);
681 bool bfd_id_insert(struct bfd_session
*bs
);
682 bool bfd_key_insert(struct bfd_session
*bs
);
684 typedef void (*hash_iter_func
)(struct hash_bucket
*hb
, void *arg
);
685 void bfd_id_iterate(hash_iter_func hif
, void *arg
);
686 void bfd_key_iterate(hash_iter_func hif
, void *arg
);
688 unsigned long bfd_get_session_count(void);
690 /* Export callback functions for `event.c`. */
691 extern struct thread_master
*master
;
693 void bfd_recvtimer_cb(struct thread
*t
);
694 void bfd_echo_recvtimer_cb(struct thread
*t
);
695 void bfd_xmt_cb(struct thread
*t
);
696 void bfd_echo_xmt_cb(struct thread
*t
);
698 extern struct in6_addr zero_addr
;
701 * Creates a new profile entry and insert into the global list.
703 * \param name the BFD profile name.
705 * \returns `NULL` if it already exists otherwise the new entry.
707 struct bfd_profile
*bfd_profile_new(const char *name
);
710 * Search for configured BFD profiles (profile name is case insensitive).
712 * \param name the BFD profile name.
714 * \returns `NULL` if it doesn't exist otherwise the entry.
716 struct bfd_profile
*bfd_profile_lookup(const char *name
);
719 * Removes profile from list and free memory.
721 * \param bp the BFD profile.
723 void bfd_profile_free(struct bfd_profile
*bp
);
726 * Apply a profile configuration to an existing BFD session. The non default
727 * values will not be overriden.
729 * NOTE: if the profile doesn't exist yet, then the profile will be applied
730 * once it begins to exist.
732 * \param profile_name the BFD profile name.
733 * \param bs the BFD session.
735 void bfd_profile_apply(const char *profname
, struct bfd_session
*bs
);
738 * Remove any applied profile from session and revert the session
741 * \param bs the BFD session.
743 void bfd_profile_remove(struct bfd_session
*bs
);
746 * Apply new profile values to sessions using it.
748 * \param[in] bp the BFD profile that got updated.
750 void bfd_profile_update(struct bfd_profile
*bp
);
755 * BFD daemon vty shell commands.
757 void bfdd_vty_init(void);
763 * BFD daemon CLI implementation.
765 void bfdd_cli_init(void);
771 void bfdd_zclient_init(struct zebra_privs_t
*bfdd_priv
);
772 void bfdd_zclient_stop(void);
773 void bfdd_zclient_unregister(vrf_id_t vrf_id
);
774 void bfdd_zclient_register(vrf_id_t vrf_id
);
775 void bfdd_sessions_enable_vrf(struct vrf
*vrf
);
776 void bfdd_sessions_disable_vrf(struct vrf
*vrf
);
778 int ptm_bfd_notify(struct bfd_session
*bs
, uint8_t notify_state
);
785 * Initialize BFD data plane infrastructure for distributed BFD implementation.
787 * \param sa socket address.
788 * \param salen socket address structure length.
789 * \param client `true` means connecting socket, `false` listening socket.
791 void bfd_dplane_init(const struct sockaddr
*sa
, socklen_t salen
, bool client
);
794 * Attempts to delegate the BFD session liveness detection to hardware.
796 * \param bs the BFD session data structure.
799 * `0` on success and BFD daemon should do nothing or `-1` on failure
800 * and we should fallback to software implementation.
802 int bfd_dplane_add_session(struct bfd_session
*bs
);
805 * Send new session settings to data plane.
807 * \param bs the BFD session to update.
809 int bfd_dplane_update_session(const struct bfd_session
*bs
);
812 * Deletes session from data plane.
814 * \param bs the BFD session to delete.
816 * \returns `0` on success otherwise `-1`.
818 int bfd_dplane_delete_session(struct bfd_session
*bs
);
821 * Asks the data plane for updated counters and update the session data
824 * \param bs the BFD session that needs updating.
826 * \returns `0` on success otherwise `-1` on failure.
828 int bfd_dplane_update_session_counters(struct bfd_session
*bs
);
830 void bfd_dplane_show_counters(struct vty
*vty
);