]> git.proxmox.com Git - mirror_frr.git/blobdiff - bgpd/bgp_fsm.h
bgpd isisd lib: fix return on void functions
[mirror_frr.git] / bgpd / bgp_fsm.h
index ce816e231fb361ff177fb7db749e9c3bb9dad825..d021c9884a55acd011696c522b4282ab80f0930d 100644 (file)
@@ -1,43 +1,93 @@
-/* BGP-4 Finite State Machine   
-   From RFC1771 [A Border Gateway Protocol 4 (BGP-4)]
-   Copyright (C) 1998 Kunihiro Ishiguro
+/* 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
+ */
 
-This file is part of GNU Zebra.
+#ifndef _QUAGGA_BGP_FSM_H
+#define _QUAGGA_BGP_FSM_H
 
-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.
+/* 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)
 
-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.
+#define BGP_TIMER_OFF(T)                                                       \
+       do {                                                                   \
+               if (T)                                                         \
+                       THREAD_TIMER_OFF(T);                                   \
+       } while (0)
 
-You should have received a copy of the GNU General Public License
-along with GNU Zebra; see the file COPYING.  If not, write to the Free
-Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.  */
+#define BGP_EVENT_ADD(P, E)                                                    \
+       do {                                                                   \
+               if ((P)->status != Deleted)                                    \
+                       thread_add_event(bm->master, bgp_event, (P), (E),      \
+                                        NULL);                                \
+       } while (0)
 
-/* Macro for BGP read, write and timer thread.  */
-#define BGP_READ_ON(T,F,V)   THREAD_READ_ON(master,T,F,peer,V)
-#define BGP_READ_OFF(X)      THREAD_READ_OFF(X)
+#define BGP_EVENT_FLUSH(P)                                                     \
+       do {                                                                   \
+               assert(peer);                                                  \
+               thread_cancel_event(bm->master, (P));                          \
+       } while (0)
+
+#define BGP_MSEC_JITTER 10
 
-#define BGP_WRITE_ON(T,F,V)  THREAD_WRITE_ON(master,T,F,peer,V)
-#define BGP_WRITE_OFF(X)     THREAD_WRITE_OFF(X)
+/* 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_TIMER_ON(T,F,V)  THREAD_TIMER_ON(master,T,F,peer,V)
-#define BGP_TIMER_OFF(X)     THREAD_TIMER_OFF(X)
+/* 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 *);
 
-#define BGP_EVENT_ADD(P,E) \
-    thread_add_event (master, bgp_event, (P), (E))
+/**
+ * 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 *);
 
-#define BGP_EVENT_DELETE(P) \
-    thread_cancel_event (master, (P))
+/**
+ * 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 *);
 
-/* Prototypes. */
-int bgp_event (struct thread *);
-int bgp_stop (struct peer *peer);
-void bgp_timer_set (struct peer *);
-void bgp_fsm_change_status (struct peer *peer, int status);
-extern char *peer_down_str[];
+#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 */