]> git.proxmox.com Git - mirror_frr.git/blob - bgpd/bgp_fsm.h
Merge remote-tracking branch 'origin/stable/2.0'
[mirror_frr.git] / bgpd / bgp_fsm.h
1 /* BGP-4 Finite State Machine
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 */
21
22 #ifndef _QUAGGA_BGP_FSM_H
23 #define _QUAGGA_BGP_FSM_H
24
25 /* Macro for BGP read, write and timer thread. */
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), NULL); \
72 } while (0)
73
74 #define BGP_EVENT_FLUSH(P) \
75 do { \
76 assert (peer); \
77 thread_cancel_event (bm->master, (P)); \
78 } while (0)
79
80 #define BGP_MSEC_JITTER 10
81
82 /* Prototypes. */
83 extern void bgp_fsm_nht_update(struct peer *, int valid);
84 extern int bgp_event (struct thread *);
85 extern int bgp_event_update (struct peer *, int event);
86 extern int bgp_stop (struct peer *peer);
87 extern void bgp_timer_set (struct peer *);
88 extern int bgp_routeadv_timer (struct thread *);
89 extern void bgp_fsm_change_status (struct peer *peer, int status);
90 extern const char *peer_down_str[];
91 extern void bgp_update_delay_end (struct bgp *);
92 extern void bgp_maxmed_update (struct bgp *);
93 extern int bgp_maxmed_onstartup_configured (struct bgp *);
94 extern int bgp_maxmed_onstartup_active (struct bgp *);
95
96 /**
97 * Start the route advertisement timer (that honors MRAI) for all the
98 * peers. Typically called at the end of initial convergence, coming
99 * out of read-only mode.
100 */
101 extern void bgp_start_routeadv (struct bgp *);
102
103 /**
104 * See if the route advertisement timer needs to be adjusted for a
105 * peer. For example, if the last update was written to the peer a
106 * long while back, we don't need to wait for the periodic advertisement
107 * timer to expire to send the new set of prefixes. It should fire
108 * instantly and updates should go out sooner.
109 */
110 extern void bgp_adjust_routeadv (struct peer *);
111
112 #include "hook.h"
113 DECLARE_HOOK(peer_backward_transition, (struct peer *peer), (peer))
114 DECLARE_HOOK(peer_established, (struct peer *peer), (peer))
115
116 #endif /* _QUAGGA_BGP_FSM_H */