ospfd/ospf_ism.h

   1 /*
   2  * OSPF version 2  Interface State Machine.
   3  *   From RFC2328 [OSPF Version 2]
   4  * Copyright (C) 1999 Toshiaki Takada
   5  *
   6  * This file is part of GNU Zebra.
   7  *
   8  * GNU Zebra is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License as published by the
  10  * Free Software Foundation; either version 2, or (at your option) any
  11  * later version.
  12  *
  13  * GNU Zebra is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with GNU Zebra; see the file COPYING.  If not, write to the Free
  20  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  21  * 02111-1307, USA.
  22  */
  23
  24 #ifndef _ZEBRA_OSPF_ISM_H
  25 #define _ZEBRA_OSPF_ISM_H
  26
  27 #include "hook.h"
  28
  29 /* OSPF Interface State Machine Status. */
  30 #define ISM_DependUpon                    0
  31 #define ISM_Down                          1
  32 #define ISM_Loopback                      2
  33 #define ISM_Waiting                       3
  34 #define ISM_PointToPoint                  4
  35 #define ISM_DROther                       5
  36 #define ISM_Backup                        6
  37 #define ISM_DR                            7
  38 #define OSPF_ISM_STATE_MAX                8
  39
  40 /* OSPF Interface State Machine Event. */
  41 #define ISM_NoEvent                       0
  42 #define ISM_InterfaceUp                   1
  43 #define ISM_WaitTimer                     2
  44 #define ISM_BackupSeen                    3
  45 #define ISM_NeighborChange                4
  46 #define ISM_LoopInd                       5
  47 #define ISM_UnloopInd                     6
  48 #define ISM_InterfaceDown                 7
  49 #define OSPF_ISM_EVENT_MAX                8
  50
  51 #define OSPF_ISM_WRITE_ON(O)                                                   \
  52         do {                                                                   \
  53                 if (oi->on_write_q == 0) {                                     \
  54                         listnode_add((O)->oi_write_q, oi);                     \
  55                         oi->on_write_q = 1;                                    \
  56                 }                                                              \
  57                 if ((O)->t_write == NULL)                                      \
  58                         (O)->t_write = thread_add_write(master, ospf_write,    \
  59                                                         (O), (O)->fd);         \
  60         } while (0)
  61
  62 /* Macro for OSPF ISM timer turn on. */
  63 #define OSPF_ISM_TIMER_ON(T, F, V)                                             \
  64         do {                                                                   \
  65                 if (!(T))                                                      \
  66                         (T) = thread_add_timer(master, (F), oi, (V));          \
  67         } while (0)
  68 #define OSPF_ISM_TIMER_MSEC_ON(T, F, V)                                        \
  69         do {                                                                   \
  70                 if (!(T))                                                      \
  71                         (T) = thread_add_timer_msec(master, (F), oi, (V));     \
  72         } while (0)
  73
  74 /* convenience macro to set hello timer correctly, according to
  75  * whether fast-hello is set or not
  76  */
  77 #define OSPF_HELLO_TIMER_ON(O)                                                 \
  78         do {                                                                   \
  79                 if (OSPF_IF_PARAM((O), fast_hello))                            \
  80                         OSPF_ISM_TIMER_MSEC_ON(                                \
  81                                 (O)->t_hello, ospf_hello_timer,                \
  82                                 1000 / OSPF_IF_PARAM((O), fast_hello));        \
  83                 else                                                           \
  84                         OSPF_ISM_TIMER_ON((O)->t_hello, ospf_hello_timer,      \
  85                                           OSPF_IF_PARAM((O), v_hello));        \
  86         } while (0)
  87
  88 /* Macro for OSPF ISM timer turn off. */
  89 #define OSPF_ISM_TIMER_OFF(X)                                                  \
  90         do {                                                                   \
  91                 if (X) {                                                       \
  92                         thread_cancel(X);                                      \
  93                         (X) = NULL;                                            \
  94                 }                                                              \
  95         } while (0)
  96
  97 /* Macro for OSPF schedule event. */
  98 #define OSPF_ISM_EVENT_SCHEDULE(I, E)                                          \
  99         thread_add_event(master, ospf_ism_event, (I), (E))
 100
 101 /* Macro for OSPF execute event. */
 102 #define OSPF_ISM_EVENT_EXECUTE(I, E)                                           \
 103         thread_execute(master, ospf_ism_event, (I), (E))
 104
 105 /* Prototypes. */
 106 extern int ospf_ism_event(struct thread *);
 107 extern void ism_change_status(struct ospf_interface *, int);
 108 extern int ospf_hello_timer(struct thread *thread);
 109
 110 DECLARE_HOOK(ospf_ism_change,
 111              (struct ospf_interface * oi, int state, int oldstate),
 112              (oi, state, oldstate))
 113
 114 #endif /* _ZEBRA_OSPF_ISM_H */