[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_READ_ON(T, F, V)                                                   \
	do {                                                                   \
		if ((peer->status != Deleted))                                 \
			thread_add_read(bm->master, (F), peer, (V), &(T));     \
	} while (0)

#define BGP_READ_OFF(T)                                                        \
	do {                                                                   \
		if (T)                                                         \
			THREAD_READ_OFF(T);                                    \
	} while (0)

#define BGP_WRITE_ON(T, F, V)                                                  \
	do {                                                                   \
		if ((peer)->status != Deleted)                                 \
			thread_add_write(bm->master, (F), (peer), (V), &(T));  \
	} while (0)

#define BGP_PEER_WRITE_ON(T, F, V, peer)                                       \
	do {                                                                   \
		if ((peer)->status != Deleted)                                 \
			thread_add_write(bm->master, (F), (peer), (V), &(T));  \
	} while (0)

#define BGP_WRITE_OFF(T)                                                       \
	do {                                                                   \
		if (T)                                                         \
			THREAD_WRITE_OFF(T);                                   \
	} while (0)

#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

/* Prototypes. */
extern void bgp_fsm_nht_update(struct 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 *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))

#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_READ_ON(T, F, V) \
	27	do { \
	28	if ((peer->status != Deleted)) \
	29	thread_add_read(bm->master, (F), peer, (V), &(T)); \
	30	} while (0)
	31
	32	#define BGP_READ_OFF(T) \
	33	do { \
	34	if (T) \
	35	THREAD_READ_OFF(T); \
	36	} while (0)
	37
	38	#define BGP_WRITE_ON(T, F, V) \
	39	do { \
	40	if ((peer)->status != Deleted) \
	41	thread_add_write(bm->master, (F), (peer), (V), &(T)); \
	42	} while (0)
	43
	44	#define BGP_PEER_WRITE_ON(T, F, V, peer) \
	45	do { \
	46	if ((peer)->status != Deleted) \
	47	thread_add_write(bm->master, (F), (peer), (V), &(T)); \
	48	} while (0)
	49
	50	#define BGP_WRITE_OFF(T) \
	51	do { \
	52	if (T) \
	53	THREAD_WRITE_OFF(T); \
	54	} while (0)
	55
	56	#define BGP_TIMER_ON(T, F, V) \
	57	do { \
	58	if ((peer->status != Deleted)) \
	59	thread_add_timer(bm->master, (F), peer, (V), &(T)); \
	60	} while (0)
	61
	62	#define BGP_TIMER_OFF(T) \
	63	do { \
	64	if (T) \
	65	THREAD_TIMER_OFF(T); \
	66	} while (0)
	67
	68	#define BGP_EVENT_ADD(P, E) \
	69	do { \
	70	if ((P)->status != Deleted) \
	71	thread_add_event(bm->master, bgp_event, (P), (E), \
	72	NULL); \
	73	} while (0)
	74
	75	#define BGP_EVENT_FLUSH(P) \
	76	do { \
	77	assert(peer); \
	78	thread_cancel_event(bm->master, (P)); \
	79	} while (0)
718e3744	80
cb1faec9 DS	81	#define BGP_MSEC_JITTER 10
cb1faec9 DS	82
718e3744	83	/* Prototypes. */
fc9a856f	84	extern void bgp_fsm_nht_update(struct peer *, int valid);
d62a17ae	85	extern int bgp_event(struct thread *);
	86	extern int bgp_event_update(struct peer *, int event);
	87	extern int bgp_stop(struct peer *peer);
	88	extern void bgp_timer_set(struct peer *);
	89	extern int bgp_routeadv_timer(struct thread *);
	90	extern void bgp_fsm_change_status(struct peer *peer, int status);
fd79ac91	91	extern const char *peer_down_str[];
d62a17ae	92	extern void bgp_update_delay_end(struct bgp *);
	93	extern void bgp_maxmed_update(struct bgp *);
	94	extern int bgp_maxmed_onstartup_configured(struct bgp *);
	95	extern int bgp_maxmed_onstartup_active(struct bgp *);
00d252cb	96
cb1faec9 DS	97	/**
	98	* Start the route advertisement timer (that honors MRAI) for all the
	99	* peers. Typically called at the end of initial convergence, coming
	100	* out of read-only mode.
	101	*/
d62a17ae	102	extern void bgp_start_routeadv(struct bgp *);
cb1faec9 DS	103
	104	/**
	105	* See if the route advertisement timer needs to be adjusted for a
	106	* peer. For example, if the last update was written to the peer a
	107	* long while back, we don't need to wait for the periodic advertisement
	108	* timer to expire to send the new set of prefixes. It should fire
	109	* instantly and updates should go out sooner.
	110	*/
d62a17ae	111	extern void bgp_adjust_routeadv(struct peer *);
cb1faec9	112
3012671f	113	#include "hook.h"
d62a17ae	114	DECLARE_HOOK(peer_backward_transition, (struct peer * peer), (peer))
d62a17ae	115	DECLARE_HOOK(peer_established, (struct peer * peer), (peer))
3012671f	116
00d252cb	117	#endif /* _QUAGGA_BGP_FSM_H */