[mirror_frr.git] / bfdd / bfd.h

/*********************************************************************
 * Copyright 2014,2015,2016,2017 Cumulus Networks, Inc.  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * bfd.h: implements the BFD protocol.
 */

#ifndef _BFD_H_
#define _BFD_H_

#include <netinet/in.h>

#include <stdbool.h>
#include <stdarg.h>
#include <stdint.h>

#include "lib/hash.h"
#include "lib/libfrr.h"
#include "lib/qobj.h"
#include "lib/queue.h"
#include "lib/vrf.h"

#include "bfdctl.h"

#ifdef BFD_DEBUG
#define BFDD_JSON_CONV_OPTIONS (JSON_C_TO_STRING_PRETTY)
#else
#define BFDD_JSON_CONV_OPTIONS (0)
#endif

DECLARE_MGROUP(BFDD)
DECLARE_MTYPE(BFDD_CONTROL)
DECLARE_MTYPE(BFDD_NOTIFICATION)

struct bfd_timers {
	uint32_t desired_min_tx;
	uint32_t required_min_rx;
	uint32_t required_min_echo;
};

struct bfd_discrs {
	uint32_t my_discr;
	uint32_t remote_discr;
};

/*
 * Format of control packet.  From section 4)
 */
struct bfd_pkt {
	union {
		uint32_t byteFields;
		struct {
			uint8_t diag;
			uint8_t flags;
			uint8_t detect_mult;
			uint8_t len;
		};
	};
	struct bfd_discrs discrs;
	struct bfd_timers timers;
};

/*
 * Format of Echo packet.
 */
struct bfd_echo_pkt {
	union {
		uint32_t byteFields;
		struct {
			uint8_t ver;
			uint8_t len;
			uint16_t reserved;
		};
	};
	uint32_t my_discr;
	uint8_t pad[16];
};


/* Macros for manipulating control packets */
#define BFD_VERMASK 0x03
#define BFD_DIAGMASK 0x1F
#define BFD_GETVER(diag) ((diag >> 5) & BFD_VERMASK)
#define BFD_SETVER(diag, val) ((diag) |= (val & BFD_VERMASK) << 5)
#define BFD_VERSION 1
#define BFD_PBIT 0x20
#define BFD_FBIT 0x10
#define BFD_CBIT 0x08
#define BFD_ABIT 0x04
#define BFD_DEMANDBIT 0x02
#define BFD_SETDEMANDBIT(flags, val)                                           \
	{                                                                      \
		if ((val))                                                     \
			flags |= BFD_DEMANDBIT;                                \
	}
#define BFD_SETPBIT(flags, val)                                                \
	{                                                                      \
		if ((val))                                                     \
			flags |= BFD_PBIT;                                     \
	}
#define BFD_GETPBIT(flags) (flags & BFD_PBIT)
#define BFD_SETFBIT(flags, val)                                                \
	{                                                                      \
		if ((val))                                                     \
			flags |= BFD_FBIT;                                     \
	}
#define BFD_GETFBIT(flags) (flags & BFD_FBIT)
#define BFD_SETSTATE(flags, val)                                               \
	{                                                                      \
		if ((val))                                                     \
			flags |= (val & 0x3) << 6;                             \
	}
#define BFD_GETSTATE(flags) ((flags >> 6) & 0x3)
#define BFD_SETCBIT(flags, val)                                                \
	{                                                                      \
		if ((val))                                                     \
			flags |= val;                                          \
	}
#define BFD_GETCBIT(flags) (flags & BFD_FBIT)
#define BFD_ECHO_VERSION 1
#define BFD_ECHO_PKT_LEN sizeof(struct bfd_echo_pkt)

enum bfd_diagnosticis {
	BD_OK = 0,
	/* Control Detection Time Expired. */
	BD_CONTROL_EXPIRED = 1,
	/* Echo Function Failed. */
	BD_ECHO_FAILED = 2,
	/* Neighbor Signaled Session Down. */
	BD_NEIGHBOR_DOWN = 3,
	/* Forwarding Plane Reset. */
	BD_FORWARDING_RESET = 4,
	/* Path Down. */
	BD_PATH_DOWN = 5,
	/* Concatenated Path Down. */
	BD_CONCATPATH_DOWN = 6,
	/* Administratively Down. */
	BD_ADMIN_DOWN = 7,
	/* Reverse Concatenated Path Down. */
	BD_REVCONCATPATH_DOWN = 8,
	/* 9..31: reserved. */
};

/* BFD session flags */
enum bfd_session_flags {
	BFD_SESS_FLAG_NONE = 0,
	BFD_SESS_FLAG_ECHO = 1 << 0,	/* BFD Echo functionality */
	BFD_SESS_FLAG_ECHO_ACTIVE = 1 << 1, /* BFD Echo Packets are being sent
					     * actively
					     */
	BFD_SESS_FLAG_MH = 1 << 2,	  /* BFD Multi-hop session */
	BFD_SESS_FLAG_IPV6 = 1 << 4,	/* BFD IPv6 session */
	BFD_SESS_FLAG_SEND_EVT_ACTIVE = 1 << 5, /* send event timer active */
	BFD_SESS_FLAG_SEND_EVT_IGNORE = 1 << 6, /* ignore send event when timer
						 * expires
						 */
	BFD_SESS_FLAG_SHUTDOWN = 1 << 7,	/* disable BGP peer function */
	BFD_SESS_FLAG_CONFIG = 1 << 8,	/* Session configured with bfd NB API */
	BFD_SESS_FLAG_CBIT = 1 << 9,	/* CBIT is set */
};

#define BFD_SET_FLAG(field, flag) (field |= flag)
#define BFD_UNSET_FLAG(field, flag) (field &= ~flag)
#define BFD_CHECK_FLAG(field, flag) (field & flag)

/* BFD session hash keys */
struct bfd_key {
	uint16_t family;
	uint8_t mhop;
	struct in6_addr peer;
	struct in6_addr local;
	char ifname[MAXNAMELEN];
	char vrfname[MAXNAMELEN];
};

struct bfd_session_stats {
	uint64_t rx_ctrl_pkt;
	uint64_t tx_ctrl_pkt;
	uint64_t rx_echo_pkt;
	uint64_t tx_echo_pkt;
	uint64_t session_up;
	uint64_t session_down;
	uint64_t znotification;
};

/* bfd_session shortcut label forwarding. */
struct peer_label;

/*
 * Session state information
 */
struct bfd_session {

	/* protocol state per RFC 5880*/
	uint8_t ses_state;
	struct bfd_discrs discrs;
	uint8_t local_diag;
	uint8_t demand_mode;
	uint8_t detect_mult;
	uint8_t remote_detect_mult;
	uint8_t mh_ttl;
	uint8_t remote_cbit;

	/* Timers */
	struct bfd_timers timers;
	struct bfd_timers cur_timers;
	uint64_t detect_TO;
	struct thread *echo_recvtimer_ev;
	struct thread *recvtimer_ev;
	uint64_t xmt_TO;
	uint64_t echo_xmt_TO;
	struct thread *xmttimer_ev;
	struct thread *echo_xmttimer_ev;
	uint64_t echo_detect_TO;

	/* software object state */
	uint8_t polling;

	/* This and the localDiscr are the keys to state info */
	struct bfd_key key;
	struct peer_label *pl;

	struct sockaddr_any local_address;
	struct interface *ifp;
	struct vrf *vrf;

	int sock;

	/* BFD session flags */
	enum bfd_session_flags flags;

	struct bfd_session_stats stats;

	struct timeval uptime;   /* last up time */
	struct timeval downtime; /* last down time */

	/* Remote peer data (for debugging mostly) */
	uint8_t remote_diag;
	struct bfd_timers remote_timers;

	uint64_t refcount; /* number of pointers referencing this. */
};

struct peer_label {
	TAILQ_ENTRY(peer_label) pl_entry;

	struct bfd_session *pl_bs;
	char pl_label[MAXNAMELEN];
};
TAILQ_HEAD(pllist, peer_label);

struct bfd_diag_str_list {
	const char *str;
	int type;
};

struct bfd_state_str_list {
	const char *str;
	int type;
};

struct bfd_session_observer {
	struct bfd_session *bso_bs;
	char bso_entryname[MAXNAMELEN];
	struct prefix bso_addr;

	TAILQ_ENTRY(bfd_session_observer) bso_entry;
};
TAILQ_HEAD(obslist, bfd_session_observer);


/* States defined per 4.1 */
#define PTM_BFD_ADM_DOWN 0
#define PTM_BFD_DOWN 1
#define PTM_BFD_INIT 2
#define PTM_BFD_UP 3


/* Various constants */
/* Retrieved from ptm_timer.h from Cumulus PTM sources. */
#define BFD_DEF_DEMAND 0
#define BFD_DEFDETECTMULT 3
#define BFD_DEFDESIREDMINTX (300 * 1000) /* microseconds. */
#define BFD_DEFREQUIREDMINRX (300 * 1000) /* microseconds. */
#define BFD_DEF_REQ_MIN_ECHO (50 * 1000) /* microseconds. */
#define BFD_DEF_SLOWTX (1000 * 1000) /* microseconds. */
#define BFD_DEF_MHOP_TTL 5
#define BFD_PKT_LEN 24 /* Length of control packet */
#define BFD_TTL_VAL 255
#define BFD_RCV_TTL_VAL 1
#define BFD_TOS_VAL 0xC0
#define BFD_PKT_INFO_VAL 1
#define BFD_IPV6_PKT_INFO_VAL 1
#define BFD_IPV6_ONLY_VAL 1
#define BFD_SRCPORTINIT 49152
#define BFD_SRCPORTMAX 65535
#define BFD_DEFDESTPORT 3784
#define BFD_DEF_ECHO_PORT 3785
#define BFD_DEF_MHOP_DEST_PORT 4784

/*
 * control.c
 *
 * Daemon control code to speak with local consumers.
 */

/* See 'bfdctrl.h' for client protocol definitions. */

struct bfd_control_buffer {
	size_t bcb_left;
	size_t bcb_pos;
	union {
		struct bfd_control_msg *bcb_bcm;
		uint8_t *bcb_buf;
	};
};

struct bfd_control_queue {
	TAILQ_ENTRY(bfd_control_queue) bcq_entry;

	struct bfd_control_buffer bcq_bcb;
};
TAILQ_HEAD(bcqueue, bfd_control_queue);

struct bfd_notify_peer {
	TAILQ_ENTRY(bfd_notify_peer) bnp_entry;

	struct bfd_session *bnp_bs;
};
TAILQ_HEAD(bnplist, bfd_notify_peer);

struct bfd_control_socket {
	TAILQ_ENTRY(bfd_control_socket) bcs_entry;

	int bcs_sd;
	struct thread *bcs_ev;
	struct thread *bcs_outev;
	struct bcqueue bcs_bcqueue;

	/* Notification data */
	uint64_t bcs_notify;
	struct bnplist bcs_bnplist;

	enum bc_msg_version bcs_version;
	enum bc_msg_type bcs_type;

	/* Message buffering */
	struct bfd_control_buffer bcs_bin;
	struct bfd_control_buffer *bcs_bout;
};
TAILQ_HEAD(bcslist, bfd_control_socket);

int control_init(const char *path);
void control_shutdown(void);
int control_notify(struct bfd_session *bs, uint8_t notify_state);
int control_notify_config(const char *op, struct bfd_session *bs);
int control_accept(struct thread *t);


/*
 * bfdd.c
 *
 * Daemon specific code.
 */
struct bfd_vrf_global {
	int bg_shop;
	int bg_mhop;
	int bg_shop6;
	int bg_mhop6;
	int bg_echo;
	int bg_echov6;
	struct vrf *vrf;

	struct thread *bg_ev[6];
};

struct bfd_global {
	int bg_csock;
	struct thread *bg_csockev;
	struct bcslist bg_bcslist;

	struct pllist bg_pllist;

	struct obslist bg_obslist;

	struct zebra_privs_t bfdd_privs;
};
extern struct bfd_global bglobal;
extern const struct bfd_diag_str_list diag_list[];
extern const struct bfd_state_str_list state_list[];

void socket_close(int *s);


/*
 * config.c
 *
 * Contains the code related with loading/reloading configuration.
 */
int parse_config(const char *fname);
int config_request_add(const char *jsonstr);
int config_request_del(const char *jsonstr);
char *config_response(const char *status, const char *error);
char *config_notify(struct bfd_session *bs);
char *config_notify_config(const char *op, struct bfd_session *bs);

typedef int (*bpc_handle)(struct bfd_peer_cfg *, void *arg);
int config_notify_request(struct bfd_control_socket *bcs, const char *jsonstr,
			  bpc_handle bh);

struct peer_label *pl_new(const char *label, struct bfd_session *bs);
struct peer_label *pl_find(const char *label);
void pl_free(struct peer_label *pl);


/*
 * log.c
 *
 * Contains code that does the logging procedures. Might implement multiple
 * backends (e.g. zebra log, syslog or other logging lib).
 */
enum blog_level {
	/* level vs syslog equivalent */
	BLOG_DEBUG = 0,   /* LOG_DEBUG */
	BLOG_INFO = 1,    /* LOG_INFO */
	BLOG_WARNING = 2, /* LOG_WARNING */
	BLOG_ERROR = 3,   /* LOG_ERR */
	BLOG_FATAL = 4,   /* LOG_CRIT */
};

void log_init(int foreground, enum blog_level level,
	      struct frr_daemon_info *fdi);
void log_info(const char *fmt, ...);
void log_debug(const char *fmt, ...);
void log_warning(const char *fmt, ...);
void log_error(const char *fmt, ...);
void log_fatal(const char *fmt, ...);


/*
 * bfd_packet.c
 *
 * Contains the code related with receiving/seding, packing/unpacking BFD data.
 */
int bp_set_ttlv6(int sd, uint8_t value);
int bp_set_ttl(int sd, uint8_t value);
int bp_set_tosv6(int sd, uint8_t value);
int bp_set_tos(int sd, uint8_t value);
int bp_bind_dev(int sd, const char *dev);

int bp_udp_shop(const struct vrf *vrf);
int bp_udp_mhop(const struct vrf *vrf);
int bp_udp6_shop(const struct vrf *vrf);
int bp_udp6_mhop(const struct vrf *vrf);
int bp_peer_socket(const struct bfd_session *bs);
int bp_peer_socketv6(const struct bfd_session *bs);
int bp_echo_socket(const struct vrf *vrf);
int bp_echov6_socket(const struct vrf *vrf);

void ptm_bfd_snd(struct bfd_session *bfd, int fbit);
void ptm_bfd_echo_snd(struct bfd_session *bfd);

int bfd_recv_cb(struct thread *t);


/*
 * event.c
 *
 * Contains the code related with event loop.
 */
typedef void (*bfd_ev_cb)(struct thread *t);

void bfd_recvtimer_update(struct bfd_session *bs);
void bfd_echo_recvtimer_update(struct bfd_session *bs);
void bfd_xmttimer_update(struct bfd_session *bs, uint64_t jitter);
void bfd_echo_xmttimer_update(struct bfd_session *bs, uint64_t jitter);

void bfd_xmttimer_delete(struct bfd_session *bs);
void bfd_echo_xmttimer_delete(struct bfd_session *bs);
void bfd_recvtimer_delete(struct bfd_session *bs);
void bfd_echo_recvtimer_delete(struct bfd_session *bs);

void bfd_recvtimer_assign(struct bfd_session *bs, bfd_ev_cb cb, int sd);
void bfd_echo_recvtimer_assign(struct bfd_session *bs, bfd_ev_cb cb, int sd);
void bfd_xmttimer_assign(struct bfd_session *bs, bfd_ev_cb cb);
void bfd_echo_xmttimer_assign(struct bfd_session *bs, bfd_ev_cb cb);


/*
 * bfd.c
 *
 * BFD protocol specific code.
 */
int bfd_session_enable(struct bfd_session *bs);
void bfd_session_disable(struct bfd_session *bs);
struct bfd_session *ptm_bfd_sess_new(struct bfd_peer_cfg *bpc);
int ptm_bfd_sess_del(struct bfd_peer_cfg *bpc);
void ptm_bfd_sess_dn(struct bfd_session *bfd, uint8_t diag);
void ptm_bfd_sess_up(struct bfd_session *bfd);
void ptm_bfd_echo_stop(struct bfd_session *bfd);
void ptm_bfd_echo_start(struct bfd_session *bfd);
void ptm_bfd_xmt_TO(struct bfd_session *bfd, int fbit);
void ptm_bfd_start_xmt_timer(struct bfd_session *bfd, bool is_echo);
struct bfd_session *ptm_bfd_sess_find(struct bfd_pkt *cp,
				      struct sockaddr_any *peer,
				      struct sockaddr_any *local,
				      ifindex_t ifindex, vrf_id_t vrfid,
				      bool is_mhop);

struct bfd_session *bs_peer_find(struct bfd_peer_cfg *bpc);
int bfd_session_update_label(struct bfd_session *bs, const char *nlabel);
void bfd_set_polling(struct bfd_session *bs);
void bs_state_handler(struct bfd_session *bs, int nstate);
void bs_echo_timer_handler(struct bfd_session *bs);
void bs_final_handler(struct bfd_session *bs);
void bs_set_slow_timers(struct bfd_session *bs);
const char *satostr(struct sockaddr_any *sa);
const char *diag2str(uint8_t diag);
int strtosa(const char *addr, struct sockaddr_any *sa);
void integer2timestr(uint64_t time, char *buf, size_t buflen);
const char *bs_to_string(const struct bfd_session *bs);

int bs_observer_add(struct bfd_session *bs);
void bs_observer_del(struct bfd_session_observer *bso);

void bs_to_bpc(struct bfd_session *bs, struct bfd_peer_cfg *bpc);

void gen_bfd_key(struct bfd_key *key, struct sockaddr_any *peer,
		 struct sockaddr_any *local, bool mhop, const char *ifname,
		 const char *vrfname);
struct bfd_session *bfd_session_new(void);
struct bfd_session *bs_registrate(struct bfd_session *bs);
void bfd_session_free(struct bfd_session *bs);
const struct bfd_session *bfd_session_next(const struct bfd_session *bs,
					   bool mhop);
void bfd_sessions_remove_manual(void);

/* BFD hash data structures interface */
void bfd_initialize(void);
void bfd_shutdown(void);
void bfd_vrf_init(void);
void bfd_vrf_terminate(void);
struct bfd_vrf_global *bfd_vrf_look_by_session(struct bfd_session *bfd);
struct bfd_session *bfd_id_lookup(uint32_t id);
struct bfd_session *bfd_key_lookup(struct bfd_key key);

struct bfd_session *bfd_id_delete(uint32_t id);
struct bfd_session *bfd_key_delete(struct bfd_key key);

bool bfd_id_insert(struct bfd_session *bs);
bool bfd_key_insert(struct bfd_session *bs);

typedef void (*hash_iter_func)(struct hash_bucket *hb, void *arg);
void bfd_id_iterate(hash_iter_func hif, void *arg);
void bfd_key_iterate(hash_iter_func hif, void *arg);

/* Export callback functions for `event.c`. */
extern struct thread_master *master;

int bfd_recvtimer_cb(struct thread *t);
int bfd_echo_recvtimer_cb(struct thread *t);
int bfd_xmt_cb(struct thread *t);
int bfd_echo_xmt_cb(struct thread *t);

extern struct in6_addr zero_addr;


/*
 * bfdd_vty.c
 *
 * BFD daemon vty shell commands.
 */
void bfdd_vty_init(void);


/*
 * bfdd_cli.c
 *
 * BFD daemon CLI implementation.
 */
void bfdd_cli_init(void);


/*
 * ptm_adapter.c
 */
void bfdd_zclient_init(struct zebra_privs_t *bfdd_priv);
void bfdd_zclient_stop(void);
void bfdd_zclient_unregister(vrf_id_t vrf_id);
void bfdd_zclient_register(vrf_id_t vrf_id);
void bfdd_sessions_enable_vrf(struct vrf *vrf);
void bfdd_sessions_disable_vrf(struct vrf *vrf);
void bfd_session_update_vrf_name(struct bfd_session *bs, struct vrf *vrf);

int ptm_bfd_notify(struct bfd_session *bs, uint8_t notify_state);

#endif /* _BFD_H_ */
Commit	Line	Data
e9e2c950 RZ	1	/*********************************************************************
	2	* Copyright 2014,2015,2016,2017 Cumulus Networks, Inc. All rights reserved.
	3	*
	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)
	7	* any later version.
	8	*
	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
	12	* more details.
	13	*
	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
	17	*
	18	* bfd.h: implements the BFD protocol.
	19	*/
	20
	21	#ifndef _BFD_H_
	22	#define _BFD_H_
	23
	24	#include <netinet/in.h>
	25
	26	#include <stdbool.h>
	27	#include <stdarg.h>
	28	#include <stdint.h>
	29
	30	#include "lib/hash.h"
	31	#include "lib/libfrr.h"
	32	#include "lib/qobj.h"
	33	#include "lib/queue.h"
80edb675	34	#include "lib/vrf.h"
e9e2c950 RZ	35
	36	#include "bfdctl.h"
	37
e9e2c950 RZ	38	#ifdef BFD_DEBUG
	39	#define BFDD_JSON_CONV_OPTIONS (JSON_C_TO_STRING_PRETTY)
	40	#else
	41	#define BFDD_JSON_CONV_OPTIONS (0)
	42	#endif
	43
1b88c3cb DL	44	DECLARE_MGROUP(BFDD)
	45	DECLARE_MTYPE(BFDD_CONTROL)
	46	DECLARE_MTYPE(BFDD_NOTIFICATION)
e9e2c950 RZ	47
	48	struct bfd_timers {
	49	uint32_t desired_min_tx;
	50	uint32_t required_min_rx;
	51	uint32_t required_min_echo;
	52	};
	53
	54	struct bfd_discrs {
	55	uint32_t my_discr;
	56	uint32_t remote_discr;
	57	};
	58
	59	/*
	60	* Format of control packet. From section 4)
	61	*/
	62	struct bfd_pkt {
	63	union {
	64	uint32_t byteFields;
	65	struct {
	66	uint8_t diag;
	67	uint8_t flags;
	68	uint8_t detect_mult;
	69	uint8_t len;
	70	};
	71	};
	72	struct bfd_discrs discrs;
	73	struct bfd_timers timers;
	74	};
	75
	76	/*
	77	* Format of Echo packet.
	78	*/
	79	struct bfd_echo_pkt {
	80	union {
	81	uint32_t byteFields;
	82	struct {
	83	uint8_t ver;
	84	uint8_t len;
	85	uint16_t reserved;
	86	};
	87	};
	88	uint32_t my_discr;
	89	uint8_t pad[16];
	90	};
	91
	92
	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)
	98	#define BFD_VERSION 1
	99	#define BFD_PBIT 0x20
	100	#define BFD_FBIT 0x10
	101	#define BFD_CBIT 0x08
	102	#define BFD_ABIT 0x04
	103	#define BFD_DEMANDBIT 0x02
e9e2c950 RZ	104	#define BFD_SETDEMANDBIT(flags, val) \
	105	{ \
	106	if ((val)) \
	107	flags \|= BFD_DEMANDBIT; \
	108	}
	109	#define BFD_SETPBIT(flags, val) \
	110	{ \
	111	if ((val)) \
	112	flags \|= BFD_PBIT; \
	113	}
	114	#define BFD_GETPBIT(flags) (flags & BFD_PBIT)
	115	#define BFD_SETFBIT(flags, val) \
	116	{ \
	117	if ((val)) \
	118	flags \|= BFD_FBIT; \
	119	}
	120	#define BFD_GETFBIT(flags) (flags & BFD_FBIT)
	121	#define BFD_SETSTATE(flags, val) \
	122	{ \
	123	if ((val)) \
	124	flags \|= (val & 0x3) << 6; \
	125	}
	126	#define BFD_GETSTATE(flags) ((flags >> 6) & 0x3)
9beff0bd PG	127	#define BFD_SETCBIT(flags, val) \
	128	{ \
	129	if ((val)) \
	130	flags \|= val; \
	131	}
	132	#define BFD_GETCBIT(flags) (flags & BFD_FBIT)
e9e2c950 RZ	133	#define BFD_ECHO_VERSION 1
e9e2c950 RZ	134	#define BFD_ECHO_PKT_LEN sizeof(struct bfd_echo_pkt)
e9e2c950	135
40675ea9 RZ	136	enum bfd_diagnosticis {
	137	BD_OK = 0,
	138	/* Control Detection Time Expired. */
	139	BD_CONTROL_EXPIRED = 1,
	140	/* Echo Function Failed. */
	141	BD_ECHO_FAILED = 2,
	142	/* Neighbor Signaled Session Down. */
	143	BD_NEIGHBOR_DOWN = 3,
	144	/* Forwarding Plane Reset. */
	145	BD_FORWARDING_RESET = 4,
	146	/* Path Down. */
	147	BD_PATH_DOWN = 5,
	148	/* Concatenated Path Down. */
	149	BD_CONCATPATH_DOWN = 6,
	150	/* Administratively Down. */
	151	BD_ADMIN_DOWN = 7,
	152	/* Reverse Concatenated Path Down. */
	153	BD_REVCONCATPATH_DOWN = 8,
	154	/* 9..31: reserved. */
	155	};
	156
e9e2c950 RZ	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
	162	* actively
	163	*/
	164	BFD_SESS_FLAG_MH = 1 << 2, /* BFD Multi-hop session */
e9e2c950 RZ	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
	168	* expires
	169	*/
	170	BFD_SESS_FLAG_SHUTDOWN = 1 << 7, /* disable BGP peer function */
6bdb4a42	171	BFD_SESS_FLAG_CONFIG = 1 << 8, /* Session configured with bfd NB API */
9beff0bd	172	BFD_SESS_FLAG_CBIT = 1 << 9, /* CBIT is set */
e9e2c950 RZ	173	};
	174
	175	#define BFD_SET_FLAG(field, flag) (field \|= flag)
	176	#define BFD_UNSET_FLAG(field, flag) (field &= ~flag)
	177	#define BFD_CHECK_FLAG(field, flag) (field & flag)
	178
	179	/* BFD session hash keys */
79b4a6fc RZ	180	struct bfd_key {
	181	uint16_t family;
	182	uint8_t mhop;
	183	struct in6_addr peer;
	184	struct in6_addr local;
	185	char ifname[MAXNAMELEN];
	186	char vrfname[MAXNAMELEN];
e9e2c950 RZ	187	};
	188
	189	struct bfd_session_stats {
	190	uint64_t rx_ctrl_pkt;
	191	uint64_t tx_ctrl_pkt;
	192	uint64_t rx_echo_pkt;
	193	uint64_t tx_echo_pkt;
0684c9b1 RZ	194	uint64_t session_up;
	195	uint64_t session_down;
	196	uint64_t znotification;
e9e2c950 RZ	197	};
e9e2c950 RZ	198
e9e2c950 RZ	199	/* bfd_session shortcut label forwarding. */
	200	struct peer_label;
	201
	202	/*
	203	* Session state information
	204	*/
	205	struct bfd_session {
	206
	207	/* protocol state per RFC 5880*/
	208	uint8_t ses_state;
	209	struct bfd_discrs discrs;
	210	uint8_t local_diag;
	211	uint8_t demand_mode;
	212	uint8_t detect_mult;
	213	uint8_t remote_detect_mult;
	214	uint8_t mh_ttl;
9beff0bd	215	uint8_t remote_cbit;
e9e2c950 RZ	216
	217	/* Timers */
	218	struct bfd_timers timers;
f43b9368	219	struct bfd_timers cur_timers;
e9e2c950 RZ	220	uint64_t detect_TO;
	221	struct thread *echo_recvtimer_ev;
	222	struct thread *recvtimer_ev;
	223	uint64_t xmt_TO;
	224	uint64_t echo_xmt_TO;
	225	struct thread *xmttimer_ev;
	226	struct thread *echo_xmttimer_ev;
	227	uint64_t echo_detect_TO;
	228
	229	/* software object state */
	230	uint8_t polling;
	231
	232	/* This and the localDiscr are the keys to state info */
79b4a6fc	233	struct bfd_key key;
e9e2c950	234	struct peer_label *pl;
e9e2c950 RZ	235
e9e2c950 RZ	236	struct sockaddr_any local_address;
80edb675	237	struct interface *ifp;
b333abc2	238	struct vrf *vrf;
79b4a6fc RZ	239
79b4a6fc RZ	240	int sock;
e9e2c950 RZ	241
	242	/* BFD session flags */
	243	enum bfd_session_flags flags;
	244
e9e2c950	245	struct bfd_session_stats stats;
e9e2c950 RZ	246
	247	struct timeval uptime; /* last up time */
	248	struct timeval downtime; /* last down time */
	249
	250	/* Remote peer data (for debugging mostly) */
	251	uint8_t remote_diag;
	252	struct bfd_timers remote_timers;
	253
	254	uint64_t refcount; /* number of pointers referencing this. */
e9e2c950	255	};
e9e2c950 RZ	256
	257	struct peer_label {
	258	TAILQ_ENTRY(peer_label) pl_entry;
	259
	260	struct bfd_session *pl_bs;
	261	char pl_label[MAXNAMELEN];
	262	};
	263	TAILQ_HEAD(pllist, peer_label);
	264
	265	struct bfd_diag_str_list {
	266	const char *str;
	267	int type;
	268	};
	269
	270	struct bfd_state_str_list {
	271	const char *str;
	272	int type;
	273	};
	274
d245e522 RZ	275	struct bfd_session_observer {
d245e522 RZ	276	struct bfd_session *bso_bs;
ced291de RZ	277	char bso_entryname[MAXNAMELEN];
ced291de RZ	278	struct prefix bso_addr;
d245e522 RZ	279
	280	TAILQ_ENTRY(bfd_session_observer) bso_entry;
	281	};
	282	TAILQ_HEAD(obslist, bfd_session_observer);
	283
e9e2c950 RZ	284
	285	/* States defined per 4.1 */
	286	#define PTM_BFD_ADM_DOWN 0
	287	#define PTM_BFD_DOWN 1
	288	#define PTM_BFD_INIT 2
	289	#define PTM_BFD_UP 3
	290
	291
	292	/* Various constants */
	293	/* Retrieved from ptm_timer.h from Cumulus PTM sources. */
e9e2c950 RZ	294	#define BFD_DEF_DEMAND 0
e9e2c950 RZ	295	#define BFD_DEFDETECTMULT 3
33400b46 RZ	296	#define BFD_DEFDESIREDMINTX (300 * 1000) /* microseconds. */
	297	#define BFD_DEFREQUIREDMINRX (300 * 1000) /* microseconds. */
	298	#define BFD_DEF_REQ_MIN_ECHO (50 * 1000) /* microseconds. */
	299	#define BFD_DEF_SLOWTX (1000 * 1000) /* microseconds. */
e9e2c950 RZ	300	#define BFD_DEF_MHOP_TTL 5
	301	#define BFD_PKT_LEN 24 /* Length of control packet */
	302	#define BFD_TTL_VAL 255
	303	#define BFD_RCV_TTL_VAL 1
	304	#define BFD_TOS_VAL 0xC0
	305	#define BFD_PKT_INFO_VAL 1
	306	#define BFD_IPV6_PKT_INFO_VAL 1
	307	#define BFD_IPV6_ONLY_VAL 1
545d3f70 RZ	308	#define BFD_SRCPORTINIT 49152
545d3f70 RZ	309	#define BFD_SRCPORTMAX 65535
e9e2c950 RZ	310	#define BFD_DEFDESTPORT 3784
	311	#define BFD_DEF_ECHO_PORT 3785
	312	#define BFD_DEF_MHOP_DEST_PORT 4784
e9e2c950 RZ	313
	314	/*
	315	* control.c
	316	*
	317	* Daemon control code to speak with local consumers.
	318	*/
	319
	320	/* See 'bfdctrl.h' for client protocol definitions. */
	321
	322	struct bfd_control_buffer {
	323	size_t bcb_left;
	324	size_t bcb_pos;
	325	union {
	326	struct bfd_control_msg *bcb_bcm;
	327	uint8_t *bcb_buf;
	328	};
	329	};
	330
	331	struct bfd_control_queue {
	332	TAILQ_ENTRY(bfd_control_queue) bcq_entry;
	333
	334	struct bfd_control_buffer bcq_bcb;
	335	};
	336	TAILQ_HEAD(bcqueue, bfd_control_queue);
	337
	338	struct bfd_notify_peer {
	339	TAILQ_ENTRY(bfd_notify_peer) bnp_entry;
	340
	341	struct bfd_session *bnp_bs;
	342	};
	343	TAILQ_HEAD(bnplist, bfd_notify_peer);
	344
	345	struct bfd_control_socket {
	346	TAILQ_ENTRY(bfd_control_socket) bcs_entry;
	347
	348	int bcs_sd;
	349	struct thread *bcs_ev;
	350	struct thread *bcs_outev;
	351	struct bcqueue bcs_bcqueue;
	352
	353	/* Notification data */
	354	uint64_t bcs_notify;
	355	struct bnplist bcs_bnplist;
	356
	357	enum bc_msg_version bcs_version;
	358	enum bc_msg_type bcs_type;
	359
	360	/* Message buffering */
	361	struct bfd_control_buffer bcs_bin;
	362	struct bfd_control_buffer *bcs_bout;
	363	};
	364	TAILQ_HEAD(bcslist, bfd_control_socket);
	365
	366	int control_init(const char *path);
	367	void control_shutdown(void);
7555dc61	368	int control_notify(struct bfd_session *bs, uint8_t notify_state);
e9e2c950 RZ	369	int control_notify_config(const char op, struct bfd_session bs);
	370	int control_accept(struct thread *t);
	371
	372
	373	/*
	374	* bfdd.c
	375	*
	376	* Daemon specific code.
	377	*/
7bcadbae	378	struct bfd_vrf_global {
e9e2c950 RZ	379	int bg_shop;
	380	int bg_mhop;
	381	int bg_shop6;
	382	int bg_mhop6;
	383	int bg_echo;
2f11c53f	384	int bg_echov6;
7bcadbae PG	385	struct vrf *vrf;
7bcadbae PG	386
e9e2c950	387	struct thread *bg_ev[6];
7bcadbae	388	};
e9e2c950	389
7bcadbae	390	struct bfd_global {
e9e2c950 RZ	391	int bg_csock;
	392	struct thread *bg_csockev;
	393	struct bcslist bg_bcslist;
	394
	395	struct pllist bg_pllist;
d245e522 RZ	396
d245e522 RZ	397	struct obslist bg_obslist;
f21536d2 PG	398
f21536d2 PG	399	struct zebra_privs_t bfdd_privs;
e9e2c950 RZ	400	};
e9e2c950 RZ	401	extern struct bfd_global bglobal;
2b64873d DL	402	extern const struct bfd_diag_str_list diag_list[];
2b64873d DL	403	extern const struct bfd_state_str_list state_list[];
e9e2c950 RZ	404
	405	void socket_close(int *s);
	406
	407
	408	/*
	409	* config.c
	410	*
	411	* Contains the code related with loading/reloading configuration.
	412	*/
	413	int parse_config(const char *fname);
	414	int config_request_add(const char *jsonstr);
	415	int config_request_del(const char *jsonstr);
	416	char config_response(const char status, const char *error);
	417	char config_notify(struct bfd_session bs);
	418	char config_notify_config(const char op, struct bfd_session *bs);
	419
	420	typedef int (bpc_handle)(struct bfd_peer_cfg , void *arg);
	421	int config_notify_request(struct bfd_control_socket bcs, const char jsonstr,
	422	bpc_handle bh);
	423
	424	struct peer_label pl_new(const char label, struct bfd_session *bs);
	425	struct peer_label pl_find(const char label);
	426	void pl_free(struct peer_label *pl);
	427
	428
	429	/*
	430	* log.c
	431	*
	432	* Contains code that does the logging procedures. Might implement multiple
	433	* backends (e.g. zebra log, syslog or other logging lib).
	434	*/
	435	enum blog_level {
	436	/* level vs syslog equivalent */
	437	BLOG_DEBUG = 0, /* LOG_DEBUG */
	438	BLOG_INFO = 1, /* LOG_INFO */
	439	BLOG_WARNING = 2, /* LOG_WARNING */
	440	BLOG_ERROR = 3, /* LOG_ERR */
	441	BLOG_FATAL = 4, /* LOG_CRIT */
	442	};
	443
	444	void log_init(int foreground, enum blog_level level,
	445	struct frr_daemon_info *fdi);
	446	void log_info(const char *fmt, ...);
	447	void log_debug(const char *fmt, ...);
	448	void log_warning(const char *fmt, ...);
	449	void log_error(const char *fmt, ...);
	450	void log_fatal(const char *fmt, ...);
	451
e9e2c950 RZ	452
	453	/*
	454	* bfd_packet.c
	455	*
	456	* Contains the code related with receiving/seding, packing/unpacking BFD data.
	457	*/
6e01e275 RZ	458	int bp_set_ttlv6(int sd, uint8_t value);
	459	int bp_set_ttl(int sd, uint8_t value);
	460	int bp_set_tosv6(int sd, uint8_t value);
	461	int bp_set_tos(int sd, uint8_t value);
e9e2c950 RZ	462	int bp_bind_dev(int sd, const char *dev);
e9e2c950 RZ	463
4a9feb66 RZ	464	int bp_udp_shop(const struct vrf *vrf);
	465	int bp_udp_mhop(const struct vrf *vrf);
	466	int bp_udp6_shop(const struct vrf *vrf);
	467	int bp_udp6_mhop(const struct vrf *vrf);
9f37770f RZ	468	int bp_peer_socket(const struct bfd_session *bs);
9f37770f RZ	469	int bp_peer_socketv6(const struct bfd_session *bs);
4a9feb66 RZ	470	int bp_echo_socket(const struct vrf *vrf);
4a9feb66 RZ	471	int bp_echov6_socket(const struct vrf *vrf);
e9e2c950 RZ	472
	473	void ptm_bfd_snd(struct bfd_session *bfd, int fbit);
	474	void ptm_bfd_echo_snd(struct bfd_session *bfd);
	475
	476	int bfd_recv_cb(struct thread *t);
	477
e9e2c950 RZ	478
	479	/*
	480	* event.c
	481	*
	482	* Contains the code related with event loop.
	483	*/
	484	typedef void (bfd_ev_cb)(struct thread t);
	485
	486	void bfd_recvtimer_update(struct bfd_session *bs);
	487	void bfd_echo_recvtimer_update(struct bfd_session *bs);
	488	void bfd_xmttimer_update(struct bfd_session *bs, uint64_t jitter);
	489	void bfd_echo_xmttimer_update(struct bfd_session *bs, uint64_t jitter);
	490
	491	void bfd_xmttimer_delete(struct bfd_session *bs);
	492	void bfd_echo_xmttimer_delete(struct bfd_session *bs);
	493	void bfd_recvtimer_delete(struct bfd_session *bs);
	494	void bfd_echo_recvtimer_delete(struct bfd_session *bs);
	495
	496	void bfd_recvtimer_assign(struct bfd_session *bs, bfd_ev_cb cb, int sd);
	497	void bfd_echo_recvtimer_assign(struct bfd_session *bs, bfd_ev_cb cb, int sd);
	498	void bfd_xmttimer_assign(struct bfd_session *bs, bfd_ev_cb cb);
	499	void bfd_echo_xmttimer_assign(struct bfd_session *bs, bfd_ev_cb cb);
	500
	501
	502	/*
	503	* bfd.c
	504	*
	505	* BFD protocol specific code.
	506	*/
9f37770f RZ	507	int bfd_session_enable(struct bfd_session *bs);
9f37770f RZ	508	void bfd_session_disable(struct bfd_session *bs);
e9e2c950	509	struct bfd_session ptm_bfd_sess_new(struct bfd_peer_cfg bpc);
bc50bcc8 PG	510	int ptm_bfd_sess_del(struct bfd_peer_cfg *bpc);
	511	void ptm_bfd_sess_dn(struct bfd_session *bfd, uint8_t diag);
	512	void ptm_bfd_sess_up(struct bfd_session *bfd);
8bd859f6	513	void ptm_bfd_echo_stop(struct bfd_session *bfd);
e9e2c950 RZ	514	void ptm_bfd_echo_start(struct bfd_session *bfd);
	515	void ptm_bfd_xmt_TO(struct bfd_session *bfd, int fbit);
	516	void ptm_bfd_start_xmt_timer(struct bfd_session *bfd, bool is_echo);
9f37770f RZ	517	struct bfd_session ptm_bfd_sess_find(struct bfd_pkt cp,
	518	struct sockaddr_any *peer,
	519	struct sockaddr_any *local,
	520	ifindex_t ifindex, vrf_id_t vrfid,
	521	bool is_mhop);
e9e2c950 RZ	522
	523	struct bfd_session bs_peer_find(struct bfd_peer_cfg bpc);
	524	int bfd_session_update_label(struct bfd_session bs, const char nlabel);
d3f3a2c4	525	void bfd_set_polling(struct bfd_session *bs);
9f37770f RZ	526	void bs_state_handler(struct bfd_session *bs, int nstate);
	527	void bs_echo_timer_handler(struct bfd_session *bs);
	528	void bs_final_handler(struct bfd_session *bs);
b912b189	529	void bs_set_slow_timers(struct bfd_session *bs);
e9e2c950 RZ	530	const char satostr(struct sockaddr_any sa);
	531	const char *diag2str(uint8_t diag);
	532	int strtosa(const char addr, struct sockaddr_any sa);
	533	void integer2timestr(uint64_t time, char *buf, size_t buflen);
79b4a6fc	534	const char bs_to_string(const struct bfd_session bs);
e9e2c950	535
9f37770f RZ	536	int bs_observer_add(struct bfd_session *bs);
9f37770f RZ	537	void bs_observer_del(struct bfd_session_observer *bso);
d245e522	538
79b4a6fc RZ	539	void bs_to_bpc(struct bfd_session bs, struct bfd_peer_cfg bpc);
79b4a6fc RZ	540
014cab13 RZ	541	void gen_bfd_key(struct bfd_key key, struct sockaddr_any peer,
	542	struct sockaddr_any local, bool mhop, const char ifname,
	543	const char *vrfname);
	544	struct bfd_session *bfd_session_new(void);
	545	struct bfd_session bs_registrate(struct bfd_session bs);
	546	void bfd_session_free(struct bfd_session *bs);
adc26455 RZ	547	const struct bfd_session bfd_session_next(const struct bfd_session bs,
adc26455 RZ	548	bool mhop);
2a573ff6	549	void bfd_sessions_remove_manual(void);
adc26455	550
e9e2c950 RZ	551	/* BFD hash data structures interface */
	552	void bfd_initialize(void);
	553	void bfd_shutdown(void);
9fc0bc5c	554	void bfd_vrf_init(void);
7bcadbae PG	555	void bfd_vrf_terminate(void);
7bcadbae PG	556	struct bfd_vrf_global bfd_vrf_look_by_session(struct bfd_session bfd);
e9e2c950	557	struct bfd_session *bfd_id_lookup(uint32_t id);
79b4a6fc	558	struct bfd_session *bfd_key_lookup(struct bfd_key key);
e9e2c950 RZ	559
e9e2c950 RZ	560	struct bfd_session *bfd_id_delete(uint32_t id);
79b4a6fc	561	struct bfd_session *bfd_key_delete(struct bfd_key key);
e9e2c950 RZ	562
e9e2c950 RZ	563	bool bfd_id_insert(struct bfd_session *bs);
79b4a6fc	564	bool bfd_key_insert(struct bfd_session *bs);
e9e2c950	565
e3b78da8	566	typedef void (hash_iter_func)(struct hash_bucket hb, void *arg);
e9e2c950	567	void bfd_id_iterate(hash_iter_func hif, void *arg);
79b4a6fc	568	void bfd_key_iterate(hash_iter_func hif, void *arg);
e9e2c950 RZ	569
	570	/* Export callback functions for `event.c`. */
	571	extern struct thread_master *master;
	572
	573	int bfd_recvtimer_cb(struct thread *t);
	574	int bfd_echo_recvtimer_cb(struct thread *t);
	575	int bfd_xmt_cb(struct thread *t);
	576	int bfd_echo_xmt_cb(struct thread *t);
	577
79b4a6fc RZ	578	extern struct in6_addr zero_addr;
79b4a6fc RZ	579
e9e2c950	580
c2f29cf3 RZ	581	/*
	582	* bfdd_vty.c
	583	*
	584	* BFD daemon vty shell commands.
	585	*/
	586	void bfdd_vty_init(void);
	587
	588
adc26455 RZ	589	/*
	590	* bfdd_cli.c
	591	*
	592	* BFD daemon CLI implementation.
	593	*/
	594	void bfdd_cli_init(void);
	595
	596
d3af6147 RZ	597	/*
	598	* ptm_adapter.c
	599	*/
	600	void bfdd_zclient_init(struct zebra_privs_t *bfdd_priv);
	601	void bfdd_zclient_stop(void);
54aadda1 PG	602	void bfdd_zclient_unregister(vrf_id_t vrf_id);
54aadda1 PG	603	void bfdd_zclient_register(vrf_id_t vrf_id);
d24af713 PG	604	void bfdd_sessions_enable_vrf(struct vrf *vrf);
d24af713 PG	605	void bfdd_sessions_disable_vrf(struct vrf *vrf);
f06e248c	606	void bfd_session_update_vrf_name(struct bfd_session bs, struct vrf vrf);
d3af6147	607
7555dc61	608	int ptm_bfd_notify(struct bfd_session *bs, uint8_t notify_state);
d3af6147	609
e9e2c950	610	#endif /* _BFD_H_ */