[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_TMP);
DECLARE_MTYPE(BFDD_CONFIG);
DECLARE_MTYPE(BFDD_LABEL);
DECLARE_MTYPE(BFDD_CONTROL);
DECLARE_MTYPE(BFDD_SESSION_OBSERVER);
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_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 */
};

#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;

	/* 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. */

	/* VTY context data. */
	QOBJ_FIELDS;
};
DECLARE_QOBJ_TYPE(bfd_session);

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;
	bool bso_isinterface;
	bool bso_isaddress;
	union {
		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);
int control_notify_config(const char *op, struct bfd_session *bs);
int control_accept(struct thread *t);


/*
 * bfdd.c
 *
 * Daemon specific code.
 */
struct bfd_global {
	int bg_shop;
	int bg_mhop;
	int bg_shop6;
	int bg_mhop6;
	int bg_echo;
	int bg_echov6;
	struct thread *bg_ev[6];

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

	struct pllist bg_pllist;

	struct obslist bg_obslist;
};
extern struct bfd_global bglobal;
extern struct bfd_diag_str_list diag_list[];
extern 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(void);
int bp_udp_mhop(void);
int bp_udp6_shop(void);
int bp_udp6_mhop(void);
int bp_peer_socket(const struct bfd_session *bs);
int bp_peer_socketv6(const struct bfd_session *bs);
int bp_echo_socket(void);
int bp_echov6_socket(void);

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);

/* BFD hash data structures interface */
void bfd_initialize(void);
void bfd_shutdown(void);
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);


/*
 * ptm_adapter.c
 */
void bfdd_zclient_init(struct zebra_privs_t *bfdd_priv);
void bfdd_zclient_stop(void);

int ptm_bfd_notify(struct bfd_session *bs);

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