ospf6d/ospf6_neighbor.h

   1 /*
   2  * Copyright (C) 2003 Yasuhiro Ohara
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with GNU Zebra; see the file COPYING.  If not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 #ifndef OSPF6_NEIGHBOR_H
  23 #define OSPF6_NEIGHBOR_H
  24
  25 #include "hook.h"
  26
  27 /* Debug option */
  28 extern unsigned char conf_debug_ospf6_neighbor;
  29 #define OSPF6_DEBUG_NEIGHBOR_STATE   0x01
  30 #define OSPF6_DEBUG_NEIGHBOR_EVENT   0x02
  31 #define OSPF6_DEBUG_NEIGHBOR_ON(level) \
  32   (conf_debug_ospf6_neighbor |= (level))
  33 #define OSPF6_DEBUG_NEIGHBOR_OFF(level) \
  34   (conf_debug_ospf6_neighbor &= ~(level))
  35 #define IS_OSPF6_DEBUG_NEIGHBOR(level) \
  36   (conf_debug_ospf6_neighbor & OSPF6_DEBUG_NEIGHBOR_ ## level)
  37
  38 /* Neighbor structure */
  39 struct ospf6_neighbor
  40 {
  41   /* Neighbor Router ID String */
  42   char name[32];
  43
  44   /* OSPFv3 Interface this neighbor belongs to */
  45   struct ospf6_interface *ospf6_if;
  46
  47   /* Neighbor state */
  48   u_char state;
  49
  50   /* timestamp of last changing state */
  51   u_int32_t state_change;
  52   struct timeval last_changed;
  53
  54   /* Neighbor Router ID */
  55   u_int32_t router_id;
  56
  57   /* Neighbor Interface ID */
  58   ifindex_t ifindex;
  59
  60   /* Router Priority of this neighbor */
  61   u_char priority;
  62
  63   u_int32_t drouter;
  64   u_int32_t bdrouter;
  65   u_int32_t prev_drouter;
  66   u_int32_t prev_bdrouter;
  67
  68   /* Options field (Capability) */
  69   char options[3];
  70
  71   /* IPaddr of I/F on our side link */
  72   struct in6_addr linklocal_addr;
  73
  74   /* For Database Exchange */
  75   u_char               dbdesc_bits;
  76   u_int32_t            dbdesc_seqnum;
  77   /* Last received Database Description packet */
  78   struct ospf6_dbdesc  dbdesc_last;
  79
  80   /* LS-list */
  81   struct ospf6_lsdb *summary_list;
  82   struct ospf6_lsdb *request_list;
  83   struct ospf6_lsdb *retrans_list;
  84
  85   /* LSA list for message transmission */
  86   struct ospf6_lsdb *dbdesc_list;
  87   struct ospf6_lsdb *lsreq_list;
  88   struct ospf6_lsdb *lsupdate_list;
  89   struct ospf6_lsdb *lsack_list;
  90
  91   struct ospf6_lsa *last_ls_req;
  92
  93   /* Inactivity timer */
  94   struct thread *inactivity_timer;
  95
  96   /* Thread for sending message */
  97   struct thread *thread_send_dbdesc;
  98   struct thread *thread_send_lsreq;
  99   struct thread *thread_send_lsupdate;
 100   struct thread *thread_send_lsack;
 101
 102   /* BFD information */
 103   void *bfd_info;
 104 };
 105
 106 /* Neighbor state */
 107 #define OSPF6_NEIGHBOR_DOWN     1
 108 #define OSPF6_NEIGHBOR_ATTEMPT  2
 109 #define OSPF6_NEIGHBOR_INIT     3
 110 #define OSPF6_NEIGHBOR_TWOWAY   4
 111 #define OSPF6_NEIGHBOR_EXSTART  5
 112 #define OSPF6_NEIGHBOR_EXCHANGE 6
 113 #define OSPF6_NEIGHBOR_LOADING  7
 114 #define OSPF6_NEIGHBOR_FULL     8
 115
 116 /* Neighbor Events */
 117 #define OSPF6_NEIGHBOR_EVENT_NO_EVENT             0
 118 #define OSPF6_NEIGHBOR_EVENT_HELLO_RCVD           1
 119 #define OSPF6_NEIGHBOR_EVENT_TWOWAY_RCVD          2
 120 #define OSPF6_NEIGHBOR_EVENT_NEGOTIATION_DONE     3
 121 #define OSPF6_NEIGHBOR_EVENT_EXCHANGE_DONE        4
 122 #define OSPF6_NEIGHBOR_EVENT_LOADING_DONE         5
 123 #define OSPF6_NEIGHBOR_EVENT_ADJ_OK               6
 124 #define OSPF6_NEIGHBOR_EVENT_SEQNUMBER_MISMATCH   7
 125 #define OSPF6_NEIGHBOR_EVENT_BAD_LSREQ            8
 126 #define OSPF6_NEIGHBOR_EVENT_ONEWAY_RCVD          9
 127 #define OSPF6_NEIGHBOR_EVENT_INACTIVITY_TIMER    10
 128 #define OSPF6_NEIGHBOR_EVENT_MAX_EVENT           11
 129
 130 static const char *ospf6_neighbor_event_str[] =
 131   {
 132     "NoEvent",
 133     "HelloReceived",
 134     "2-WayReceived",
 135     "NegotiationDone",
 136     "ExchangeDone",
 137     "LoadingDone",
 138     "AdjOK?",
 139     "SeqNumberMismatch",
 140     "BadLSReq",
 141     "1-WayReceived",
 142     "InactivityTimer",
 143   };
 144
 145 static inline const char *ospf6_neighbor_event_string (int event)
 146 {
 147   #define OSPF6_NEIGHBOR_UNKNOWN_EVENT_STRING "UnknownEvent"
 148
 149   if (event < OSPF6_NEIGHBOR_EVENT_MAX_EVENT)
 150       return ospf6_neighbor_event_str[event];
 151   return OSPF6_NEIGHBOR_UNKNOWN_EVENT_STRING;
 152 }
 153
 154 extern const char *ospf6_neighbor_state_str[];
 155
 156
 157 /* Function Prototypes */
 158 int ospf6_neighbor_cmp (void *va, void *vb);
 159 void ospf6_neighbor_dbex_init (struct ospf6_neighbor *on);
 160
 161 struct ospf6_neighbor *ospf6_neighbor_lookup (u_int32_t,
 162                                               struct ospf6_interface *);
 163 struct ospf6_neighbor *ospf6_neighbor_create (u_int32_t,
 164                                               struct ospf6_interface *);
 165 void ospf6_neighbor_delete (struct ospf6_neighbor *);
 166
 167 /* Neighbor event */
 168 extern int hello_received (struct thread *);
 169 extern int twoway_received (struct thread *);
 170 extern int negotiation_done (struct thread *);
 171 extern int exchange_done (struct thread *);
 172 extern int loading_done (struct thread *);
 173 extern int adj_ok (struct thread *);
 174 extern int seqnumber_mismatch (struct thread *);
 175 extern int bad_lsreq (struct thread *);
 176 extern int oneway_received (struct thread *);
 177 extern int inactivity_timer (struct thread *);
 178 extern void ospf6_check_nbr_loading (struct ospf6_neighbor *);
 179
 180 extern void ospf6_neighbor_init (void);
 181 extern int config_write_ospf6_debug_neighbor (struct vty *vty);
 182 extern void install_element_ospf6_debug_neighbor (void);
 183
 184 DECLARE_HOOK(ospf6_neighbor_change,
 185                 (struct ospf6_neighbor *on, int state, int next_state),
 186                 (on, state, next_state))
 187
 188 #endif /* OSPF6_NEIGHBOR_H */