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_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)
  50
  51 #define BGP_MSEC_JITTER 10
  52
  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
  59 /* Prototypes. */
  60 extern void bgp_fsm_nht_update(struct peer *, int valid);
  61 extern int bgp_event(struct thread *);
  62 extern int bgp_event_update(struct peer *, int event);
  63 extern int bgp_stop(struct peer *peer);
  64 extern void bgp_timer_set(struct peer *);
  65 extern int bgp_routeadv_timer(struct thread *);
  66 extern void bgp_fsm_change_status(struct peer *peer, int status);
  67 extern const char *peer_down_str[];
  68 extern void bgp_update_delay_end(struct bgp *);
  69 extern void bgp_maxmed_update(struct bgp *);
  70 extern int bgp_maxmed_onstartup_configured(struct bgp *);
  71 extern int bgp_maxmed_onstartup_active(struct bgp *);
  72
  73 /**
  74  * Start the route advertisement timer (that honors MRAI) for all the
  75  * peers. Typically called at the end of initial convergence, coming
  76  * out of read-only mode.
  77  */
  78 extern void bgp_start_routeadv(struct bgp *);
  79
  80 /**
  81  * See if the route advertisement timer needs to be adjusted for a
  82  * peer. For example, if the last update was written to the peer a
  83  * long while back, we don't need to wait for the periodic advertisement
  84  * timer to expire to send the new set of prefixes. It should fire
  85  * instantly and updates should go out sooner.
  86  */
  87 extern void bgp_adjust_routeadv(struct peer *);
  88
  89 #include "hook.h"
  90 DECLARE_HOOK(peer_backward_transition, (struct peer * peer), (peer))
  91 DECLARE_HOOK(peer_established, (struct peer * peer), (peer))
  92
  93 #endif /* _QUAGGA_BGP_FSM_H */