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 along
  19  * with this program; see the file COPYING; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  21  */
  22
  23 #ifndef _ZEBRA_OSPF_ISM_H
  24 #define _ZEBRA_OSPF_ISM_H
  25
  26 #include "hook.h"
  27
  28 /* OSPF Interface State Machine Status. */
  29 #define ISM_DependUpon                    0
  30 #define ISM_Down                          1
  31 #define ISM_Loopback                      2
  32 #define ISM_Waiting                       3
  33 #define ISM_PointToPoint                  4
  34 #define ISM_DROther                       5
  35 #define ISM_Backup                        6
  36 #define ISM_DR                            7
  37 #define OSPF_ISM_STATE_MAX                8
  38
  39 /* OSPF Interface State Machine Event. */
  40 #define ISM_NoEvent                       0
  41 #define ISM_InterfaceUp                   1
  42 #define ISM_WaitTimer                     2
  43 #define ISM_BackupSeen                    3
  44 #define ISM_NeighborChange                4
  45 #define ISM_LoopInd                       5
  46 #define ISM_UnloopInd                     6
  47 #define ISM_InterfaceDown                 7
  48 #define OSPF_ISM_EVENT_MAX                8
  49
  50 #define OSPF_ISM_WRITE_ON(O) \
  51   do \
  52     { \
  53       if (oi->on_write_q == 0) \
  54         { \
  55           listnode_add ((O)->oi_write_q, oi); \
  56           oi->on_write_q = 1; \
  57         } \
  58       thread_add_write (master, ospf_write, (O), (O)->fd, &(O)->t_write); \
  59     } while (0)
  60
  61 /* Macro for OSPF ISM timer turn on. */
  62 #define OSPF_ISM_TIMER_ON(T,F,V) \
  63     thread_add_timer (master, (F), oi, (V), &(T))
  64
  65 #define OSPF_ISM_TIMER_MSEC_ON(T,F,V) \
  66     thread_add_timer_msec (master, (F), oi, (V), &(T))
  67
  68 /* convenience macro to set hello timer correctly, according to
  69  * whether fast-hello is set or not
  70  */
  71 #define OSPF_HELLO_TIMER_ON(O) \
  72   do { \
  73     if (OSPF_IF_PARAM ((O), fast_hello)) \
  74         OSPF_ISM_TIMER_MSEC_ON ((O)->t_hello, ospf_hello_timer, \
  75                                 1000 / OSPF_IF_PARAM ((O), fast_hello)); \
  76     else \
  77         OSPF_ISM_TIMER_ON ((O)->t_hello, ospf_hello_timer, \
  78                                 OSPF_IF_PARAM ((O), v_hello)); \
  79   } while (0)
  80
  81 /* Macro for OSPF ISM timer turn off. */
  82 #define OSPF_ISM_TIMER_OFF(X) \
  83   do { \
  84     if (X) \
  85       { \
  86         thread_cancel (X); \
  87         (X) = NULL; \
  88       } \
  89   } while (0)
  90
  91 /* Macro for OSPF schedule event. */
  92 #define OSPF_ISM_EVENT_SCHEDULE(I,E) \
  93       thread_add_event (master, ospf_ism_event, (I), (E), NULL)
  94
  95 /* Macro for OSPF execute event. */
  96 #define OSPF_ISM_EVENT_EXECUTE(I,E) \
  97       thread_execute (master, ospf_ism_event, (I), (E))
  98
  99 /* Prototypes. */
 100 extern int ospf_ism_event (struct thread *);
 101 extern void ism_change_status (struct ospf_interface *, int);
 102 extern int ospf_hello_timer (struct thread *thread);
 103
 104 DECLARE_HOOK(ospf_ism_change,
 105                 (struct ospf_interface *oi, int state, int oldstate),
 106                 (oi, state, oldstate))
 107
 108 #endif /* _ZEBRA_OSPF_ISM_H */