[mirror_frr.git] / bgpd / bgp_fsm.h

/* BGP-4 Finite State Machine
 * From RFC1771 [A Border Gateway Protocol 4 (BGP-4)]
 * Copyright (C) 1998 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra 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, or (at your option) any
 * later version.
 *
 * GNU Zebra 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
 */

#ifndef _QUAGGA_BGP_FSM_H
#define _QUAGGA_BGP_FSM_H

/* Macro for BGP read, write and timer thread.  */
#define BGP_TIMER_ON(T, F, V)                                                  \
	do {                                                                   \
		if ((peer->status != Deleted))                                 \
			thread_add_timer(bm->master, (F), peer, (V), &(T));    \
	} while (0)

#define BGP_TIMER_OFF(T)                                                       \
	do {                                                                   \
		if (T)                                                         \
			THREAD_TIMER_OFF(T);                                   \
	} while (0)

#define BGP_EVENT_ADD(P, E)                                                    \
	do {                                                                   \
		if ((P)->status != Deleted)                                    \
			thread_add_event(bm->master, bgp_event, (P), (E),      \
					 NULL);                                \
	} while (0)

#define BGP_EVENT_FLUSH(P)                                                     \
	do {                                                                   \
		assert(peer);                                                  \
		thread_cancel_event(bm->master, (P));                          \
	} while (0)

#define BGP_MSEC_JITTER 10

/* Status codes for bgp_event_update() */
#define FSM_PEER_NOOP           0
#define FSM_PEER_STOPPED        1
#define FSM_PEER_TRANSFERRED    2
#define FSM_PEER_TRANSITIONED   3

#define BGP_PEER_GR_HELPER_ENABLE(peer)	\
	do {		\
		UNSET_FLAG( \
			peer->peer_gr_new_status_flag,		\
			PEER_GRACEFUL_RESTART_NEW_STATE_RESTART);	\
		SET_FLAG( \
			peer->peer_gr_new_status_flag,	\
			PEER_GRACEFUL_RESTART_NEW_STATE_HELPER);\
	} while (0)

#define BGP_PEER_GR_ENABLE(peer)\
	do {				\
		SET_FLAG(   \
			peer->peer_gr_new_status_flag,	\
			PEER_GRACEFUL_RESTART_NEW_STATE_RESTART); \
		UNSET_FLAG( \
			peer->peer_gr_new_status_flag,	\
			PEER_GRACEFUL_RESTART_NEW_STATE_HELPER);\
	} while (0)

#define BGP_PEER_GR_DISABLE(peer)\
	do {				\
		UNSET_FLAG( \
			peer->peer_gr_new_status_flag,	\
			PEER_GRACEFUL_RESTART_NEW_STATE_RESTART);\
		UNSET_FLAG(\
			peer->peer_gr_new_status_flag, \
			PEER_GRACEFUL_RESTART_NEW_STATE_HELPER);\
	} while (0)

#define BGP_PEER_GR_GLOBAL_INHERIT_SET(peer) \
			SET_FLAG(peer->peer_gr_new_status_flag,	\
				PEER_GRACEFUL_RESTART_NEW_STATE_INHERIT)

#define BGP_PEER_GR_GLOBAL_INHERIT_UNSET(peer)	\
			UNSET_FLAG(peer->peer_gr_new_status_flag, \
				PEER_GRACEFUL_RESTART_NEW_STATE_INHERIT)

#define BGP_PEER_GRACEFUL_RESTART_CAPABLE(peer)                                \
	(CHECK_FLAG(peer->cap, PEER_CAP_RESTART_ADV)                           \
	 && CHECK_FLAG(peer->cap, PEER_CAP_RESTART_RCV))

#define BGP_PEER_RESTARTING_MODE(peer)                                         \
	(CHECK_FLAG(peer->flags, PEER_FLAG_GRACEFUL_RESTART)                   \
	 && CHECK_FLAG(peer->cap, PEER_CAP_RESTART_BIT_ADV)                    \
	 && !CHECK_FLAG(peer->cap, PEER_CAP_RESTART_BIT_RCV))

#define BGP_PEER_HELPER_MODE(peer)                                             \
	(CHECK_FLAG(peer->flags, PEER_FLAG_GRACEFUL_RESTART_HELPER)            \
	 && CHECK_FLAG(peer->cap, PEER_CAP_RESTART_BIT_RCV)                    \
	 && !CHECK_FLAG(peer->cap, PEER_CAP_RESTART_BIT_ADV))

/* Prototypes. */
extern void bgp_fsm_event_update(struct peer *peer, int valid);
extern int bgp_event(struct thread *);
extern int bgp_event_update(struct peer *, int event);
extern int bgp_stop(struct peer *peer);
extern void bgp_timer_set(struct peer *);
extern int bgp_routeadv_timer(struct thread *);
extern void bgp_fsm_change_status(struct peer *peer, int status);
extern const char *const peer_down_str[];
extern void bgp_update_delay_end(struct bgp *);
extern void bgp_maxmed_update(struct bgp *);
extern int bgp_maxmed_onstartup_configured(struct bgp *);
extern int bgp_maxmed_onstartup_active(struct bgp *);

/**
 * Start the route advertisement timer (that honors MRAI) for all the
 * peers. Typically called at the end of initial convergence, coming
 * out of read-only mode.
 */
extern void bgp_start_routeadv(struct bgp *);

/**
 * See if the route advertisement timer needs to be adjusted for a
 * peer. For example, if the last update was written to the peer a
 * long while back, we don't need to wait for the periodic advertisement
 * timer to expire to send the new set of prefixes. It should fire
 * instantly and updates should go out sooner.
 */
extern void bgp_adjust_routeadv(struct peer *);

#include "hook.h"
DECLARE_HOOK(peer_backward_transition, (struct peer *peer), (peer))
DECLARE_HOOK(peer_established, (struct peer *peer), (peer))

int bgp_gr_update_all(struct bgp *bgp, int global_gr_cmd);
int bgp_neighbor_graceful_restart(struct peer *peer, int peer_gr_cmd);
unsigned int bgp_peer_gr_action(struct peer *peer,
		int old_peer_state, int new_peer_state);
void bgp_peer_move_to_gr_mode(struct peer *peer, int new_state);
unsigned int bgp_peer_gr_helper_enable(struct peer *peer);
unsigned int bgp_peer_gr_enable(struct peer *peer);
unsigned int bgp_peer_gr_global_inherit(struct peer *peer);
unsigned int bgp_peer_gr_disable(struct peer *peer);
enum peer_mode bgp_peer_gr_mode_get(struct peer *peer);
enum global_mode bgp_global_gr_mode_get(struct bgp *bgp);
enum peer_mode bgp_get_peer_gr_mode_from_flags(struct peer *peer);
unsigned int bgp_peer_gr_global_inherit_unset(struct peer *peer);
int bgp_gr_lookup_n_update_all_peer(struct bgp *bgp,
		enum global_mode global_new_state,
		enum global_mode global_old_state);
void bgp_peer_gr_flags_update(struct peer *peer);
const char *print_peer_gr_mode(enum peer_mode pr_mode);
const char *print_peer_gr_cmd(enum peer_gr_command pr_gr_cmd);
const char *print_global_gr_mode(enum global_mode gl_mode);
const char *print_global_gr_cmd(enum global_gr_command gl_gr_cmd);
#endif /* _QUAGGA_BGP_FSM_H */
Commit	Line	Data
d62a17ae	1	/* BGP-4 Finite State Machine
896014f4 DL	2	* From RFC1771 [A Border Gateway Protocol 4 (BGP-4)]
	3	* Copyright (C) 1998 Kunihiro Ishiguro
	4	*
	5	* This file is part of GNU Zebra.
	6	*
	7	* GNU Zebra is free software; you can redistribute it and/or modify it
	8	* under the terms of the GNU General Public License as published by the
	9	* Free Software Foundation; either version 2, or (at your option) any
	10	* later version.
	11	*
	12	* GNU Zebra is distributed in the hope that it will be useful, but
	13	* WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	* General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License along
	18	* with this program; see the file COPYING; if not, write to the Free Software
	19	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	20	*/
718e3744	21
00d252cb	22	#ifndef _QUAGGA_BGP_FSM_H
	23	#define _QUAGGA_BGP_FSM_H
	24
718e3744	25	/* Macro for BGP read, write and timer thread. */
d62a17ae	26	#define BGP_TIMER_ON(T, F, V) \
	27	do { \
	28	if ((peer->status != Deleted)) \
	29	thread_add_timer(bm->master, (F), peer, (V), &(T)); \
	30	} while (0)
	31
	32	#define BGP_TIMER_OFF(T) \
	33	do { \
	34	if (T) \
	35	THREAD_TIMER_OFF(T); \
	36	} while (0)
	37
	38	#define BGP_EVENT_ADD(P, E) \
	39	do { \
	40	if ((P)->status != Deleted) \
	41	thread_add_event(bm->master, bgp_event, (P), (E), \
	42	NULL); \
	43	} while (0)
	44
	45	#define BGP_EVENT_FLUSH(P) \
	46	do { \
	47	assert(peer); \
	48	thread_cancel_event(bm->master, (P)); \
	49	} while (0)
718e3744	50
cb1faec9 DS	51	#define BGP_MSEC_JITTER 10
cb1faec9 DS	52
d8151687 QY	53	/* Status codes for bgp_event_update() */
	54	#define FSM_PEER_NOOP 0
	55	#define FSM_PEER_STOPPED 1
	56	#define FSM_PEER_TRANSFERRED 2
	57	#define FSM_PEER_TRANSITIONED 3
	58
b0965c44	59	#define BGP_PEER_GR_HELPER_ENABLE(peer) \
	60	do { \
	61	UNSET_FLAG( \
	62	peer->peer_gr_new_status_flag, \
	63	PEER_GRACEFUL_RESTART_NEW_STATE_RESTART); \
	64	SET_FLAG( \
	65	peer->peer_gr_new_status_flag, \
	66	PEER_GRACEFUL_RESTART_NEW_STATE_HELPER);\
	67	} while (0)
	68
b0965c44	69	#define BGP_PEER_GR_ENABLE(peer)\
	70	do { \
	71	SET_FLAG( \
	72	peer->peer_gr_new_status_flag, \
	73	PEER_GRACEFUL_RESTART_NEW_STATE_RESTART); \
	74	UNSET_FLAG( \
	75	peer->peer_gr_new_status_flag, \
	76	PEER_GRACEFUL_RESTART_NEW_STATE_HELPER);\
	77	} while (0)
	78
b0965c44	79	#define BGP_PEER_GR_DISABLE(peer)\
	80	do { \
	81	UNSET_FLAG( \
	82	peer->peer_gr_new_status_flag, \
	83	PEER_GRACEFUL_RESTART_NEW_STATE_RESTART);\
	84	UNSET_FLAG(\
	85	peer->peer_gr_new_status_flag, \
	86	PEER_GRACEFUL_RESTART_NEW_STATE_HELPER);\
	87	} while (0)
	88
b0965c44	89	#define BGP_PEER_GR_GLOBAL_INHERIT_SET(peer) \
	90	SET_FLAG(peer->peer_gr_new_status_flag, \
	91	PEER_GRACEFUL_RESTART_NEW_STATE_INHERIT)
	92
b0965c44	93	#define BGP_PEER_GR_GLOBAL_INHERIT_UNSET(peer) \
	94	UNSET_FLAG(peer->peer_gr_new_status_flag, \
	95	PEER_GRACEFUL_RESTART_NEW_STATE_INHERIT)
	96
36235319 QY	97	#define BGP_PEER_GRACEFUL_RESTART_CAPABLE(peer) \
	98	(CHECK_FLAG(peer->cap, PEER_CAP_RESTART_ADV) \
	99	&& CHECK_FLAG(peer->cap, PEER_CAP_RESTART_RCV))
f009ff26	100
36235319 QY	101	#define BGP_PEER_RESTARTING_MODE(peer) \
	102	(CHECK_FLAG(peer->flags, PEER_FLAG_GRACEFUL_RESTART) \
	103	&& CHECK_FLAG(peer->cap, PEER_CAP_RESTART_BIT_ADV) \
	104	&& !CHECK_FLAG(peer->cap, PEER_CAP_RESTART_BIT_RCV))
f009ff26	105
36235319 QY	106	#define BGP_PEER_HELPER_MODE(peer) \
	107	(CHECK_FLAG(peer->flags, PEER_FLAG_GRACEFUL_RESTART_HELPER) \
	108	&& CHECK_FLAG(peer->cap, PEER_CAP_RESTART_BIT_RCV) \
	109	&& !CHECK_FLAG(peer->cap, PEER_CAP_RESTART_BIT_ADV))
f009ff26	110
718e3744	111	/* Prototypes. */
fc04a677	112	extern void bgp_fsm_event_update(struct peer *peer, int valid);
d62a17ae	113	extern int bgp_event(struct thread *);
	114	extern int bgp_event_update(struct peer *, int event);
	115	extern int bgp_stop(struct peer *peer);
	116	extern void bgp_timer_set(struct peer *);
	117	extern int bgp_routeadv_timer(struct thread *);
	118	extern void bgp_fsm_change_status(struct peer *peer, int status);
2b64873d	119	extern const char *const peer_down_str[];
d62a17ae	120	extern void bgp_update_delay_end(struct bgp *);
	121	extern void bgp_maxmed_update(struct bgp *);
	122	extern int bgp_maxmed_onstartup_configured(struct bgp *);
	123	extern int bgp_maxmed_onstartup_active(struct bgp *);
00d252cb	124
cb1faec9 DS	125	/**
	126	* Start the route advertisement timer (that honors MRAI) for all the
	127	* peers. Typically called at the end of initial convergence, coming
	128	* out of read-only mode.
	129	*/
d62a17ae	130	extern void bgp_start_routeadv(struct bgp *);
cb1faec9 DS	131
	132	/**
	133	* See if the route advertisement timer needs to be adjusted for a
	134	* peer. For example, if the last update was written to the peer a
	135	* long while back, we don't need to wait for the periodic advertisement
	136	* timer to expire to send the new set of prefixes. It should fire
	137	* instantly and updates should go out sooner.
	138	*/
d62a17ae	139	extern void bgp_adjust_routeadv(struct peer *);
cb1faec9	140
3012671f	141	#include "hook.h"
b0965c44	142	DECLARE_HOOK(peer_backward_transition, (struct peer *peer), (peer))
	143	DECLARE_HOOK(peer_established, (struct peer *peer), (peer))
	144
2ba1fe69	145	int bgp_gr_update_all(struct bgp *bgp, int global_gr_cmd);
36235319	146	int bgp_neighbor_graceful_restart(struct peer *peer, int peer_gr_cmd);
b0965c44	147	unsigned int bgp_peer_gr_action(struct peer *peer,
	148	int old_peer_state, int new_peer_state);
	149	void bgp_peer_move_to_gr_mode(struct peer *peer, int new_state);
	150	unsigned int bgp_peer_gr_helper_enable(struct peer *peer);
	151	unsigned int bgp_peer_gr_enable(struct peer *peer);
	152	unsigned int bgp_peer_gr_global_inherit(struct peer *peer);
	153	unsigned int bgp_peer_gr_disable(struct peer *peer);
	154	enum peer_mode bgp_peer_gr_mode_get(struct peer *peer);
	155	enum global_mode bgp_global_gr_mode_get(struct bgp *bgp);
	156	enum peer_mode bgp_get_peer_gr_mode_from_flags(struct peer *peer);
	157	unsigned int bgp_peer_gr_global_inherit_unset(struct peer *peer);
	158	int bgp_gr_lookup_n_update_all_peer(struct bgp *bgp,
	159	enum global_mode global_new_state,
	160	enum global_mode global_old_state);
b0965c44	161	void bgp_peer_gr_flags_update(struct peer *peer);
2ba1fe69	162	const char *print_peer_gr_mode(enum peer_mode pr_mode);
	163	const char *print_peer_gr_cmd(enum peer_gr_command pr_gr_cmd);
	164	const char *print_global_gr_mode(enum global_mode gl_mode);
	165	const char *print_global_gr_cmd(enum global_gr_command gl_gr_cmd);
00d252cb	166	#endif /* _QUAGGA_BGP_FSM_H */