Import Upstream version 1.2.2
[quagga-debian.git] / 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 /* Debug option */
26 extern unsigned char conf_debug_ospf6_neighbor;
27 #define OSPF6_DEBUG_NEIGHBOR_STATE   0x01
28 #define OSPF6_DEBUG_NEIGHBOR_EVENT   0x02
29 #define OSPF6_DEBUG_NEIGHBOR_ON(level) \
30   (conf_debug_ospf6_neighbor |= (level))
31 #define OSPF6_DEBUG_NEIGHBOR_OFF(level) \
32   (conf_debug_ospf6_neighbor &= ~(level))
33 #define IS_OSPF6_DEBUG_NEIGHBOR(level) \
34   (conf_debug_ospf6_neighbor & OSPF6_DEBUG_NEIGHBOR_ ## level)
35
36 /* Neighbor structure */
37 struct ospf6_neighbor
38 {
39   /* Neighbor Router ID String */
40   char name[32];
41
42   /* OSPFv3 Interface this neighbor belongs to */
43   struct ospf6_interface *ospf6_if;
44
45   /* Neighbor state */
46   u_char state;
47
48   /* timestamp of last changing state */
49   u_int32_t state_change;
50   struct timeval last_changed;
51
52   /* Neighbor Router ID */
53   u_int32_t router_id;
54
55   /* Neighbor Interface ID */
56   ifindex_t ifindex;
57
58   /* Router Priority of this neighbor */
59   u_char priority;
60
61   u_int32_t drouter;
62   u_int32_t bdrouter;
63   u_int32_t prev_drouter;
64   u_int32_t prev_bdrouter;
65
66   /* Options field (Capability) */
67   char options[3];
68
69   /* IPaddr of I/F on our side link */
70   struct in6_addr linklocal_addr;
71
72   /* For Database Exchange */
73   u_char               dbdesc_bits;
74   u_int32_t            dbdesc_seqnum;
75   /* Last received Database Description packet */
76   struct ospf6_dbdesc  dbdesc_last;
77
78   /* LS-list */
79   struct ospf6_lsdb *summary_list;
80   struct ospf6_lsdb *request_list;
81   struct ospf6_lsdb *retrans_list;
82
83   /* LSA list for message transmission */
84   struct ospf6_lsdb *dbdesc_list;
85   struct ospf6_lsdb *lsreq_list;
86   struct ospf6_lsdb *lsupdate_list;
87   struct ospf6_lsdb *lsack_list;
88
89   struct ospf6_lsa *last_ls_req;
90
91   /* Inactivity timer */
92   struct thread *inactivity_timer;
93
94   /* Thread for sending message */
95   struct thread *thread_send_dbdesc;
96   struct thread *thread_send_lsreq;
97   struct thread *thread_send_lsupdate;
98   struct thread *thread_send_lsack;
99 };
100
101 /* Neighbor state */
102 #define OSPF6_NEIGHBOR_DOWN     1
103 #define OSPF6_NEIGHBOR_ATTEMPT  2
104 #define OSPF6_NEIGHBOR_INIT     3
105 #define OSPF6_NEIGHBOR_TWOWAY   4
106 #define OSPF6_NEIGHBOR_EXSTART  5
107 #define OSPF6_NEIGHBOR_EXCHANGE 6
108 #define OSPF6_NEIGHBOR_LOADING  7
109 #define OSPF6_NEIGHBOR_FULL     8
110
111 /* Neighbor Events */
112 #define OSPF6_NEIGHBOR_EVENT_NO_EVENT             0
113 #define OSPF6_NEIGHBOR_EVENT_HELLO_RCVD           1
114 #define OSPF6_NEIGHBOR_EVENT_TWOWAY_RCVD          2
115 #define OSPF6_NEIGHBOR_EVENT_NEGOTIATION_DONE     3
116 #define OSPF6_NEIGHBOR_EVENT_EXCHANGE_DONE        4
117 #define OSPF6_NEIGHBOR_EVENT_LOADING_DONE         5
118 #define OSPF6_NEIGHBOR_EVENT_ADJ_OK               6
119 #define OSPF6_NEIGHBOR_EVENT_SEQNUMBER_MISMATCH   7
120 #define OSPF6_NEIGHBOR_EVENT_BAD_LSREQ            8
121 #define OSPF6_NEIGHBOR_EVENT_ONEWAY_RCVD          9
122 #define OSPF6_NEIGHBOR_EVENT_INACTIVITY_TIMER    10
123 #define OSPF6_NEIGHBOR_EVENT_MAX_EVENT           11
124
125 extern const char *ospf6_neighbor_state_str[];
126
127 /* Function Prototypes */
128 int ospf6_neighbor_cmp (void *va, void *vb);
129 void ospf6_neighbor_dbex_init (struct ospf6_neighbor *on);
130
131 struct ospf6_neighbor *ospf6_neighbor_lookup (u_int32_t,
132                                               struct ospf6_interface *);
133 struct ospf6_neighbor *ospf6_neighbor_create (u_int32_t,
134                                               struct ospf6_interface *);
135 void ospf6_neighbor_delete (struct ospf6_neighbor *);
136
137 /* Neighbor event */
138 extern int hello_received (struct thread *);
139 extern int twoway_received (struct thread *);
140 extern int negotiation_done (struct thread *);
141 extern int exchange_done (struct thread *);
142 extern int loading_done (struct thread *);
143 extern int adj_ok (struct thread *);
144 extern int seqnumber_mismatch (struct thread *);
145 extern int bad_lsreq (struct thread *);
146 extern int oneway_received (struct thread *);
147 extern int inactivity_timer (struct thread *);
148 extern void ospf6_check_nbr_loading (struct ospf6_neighbor *);
149
150 extern void ospf6_neighbor_init (void);
151 extern int config_write_ospf6_debug_neighbor (struct vty *vty);
152 extern void install_element_ospf6_debug_neighbor (void);
153
154 #endif /* OSPF6_NEIGHBOR_H */