rename neighbor and neighbor2_list entry, preparation for neighbor refactoring
[olsrd.git] / src / neighbor_table.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42
43 #ifndef _OLSR_NEIGH_TBL
44 #define _OLSR_NEIGH_TBL
45
46 #include "defs.h"
47 #include "olsr_types.h"
48 #include "hashing.h"
49
50
51 struct nbr2_list_entry {
52   struct nbr_entry *nbr2_nbr;     /* backpointer to owning nbr entry */
53   struct neighbor_2_entry *neighbor_2;
54   struct timer_entry *nbr2_list_timer;
55   struct nbr2_list_entry *next;
56   struct nbr2_list_entry *prev;
57 };
58
59 #define OLSR_NBR2_LIST_JITTER 5 /* percent */
60
61 struct nbr_entry {
62   union olsr_ip_addr neighbor_main_addr;
63   uint8_t status;
64   uint8_t willingness;
65   unsigned char is_mpr:1;
66   unsigned char was_mpr:1;             /* Used to detect changes in MPR */
67   unsigned char skip:1;
68   int neighbor_2_nocov;
69   int linkcount;
70   struct nbr2_list_entry neighbor_2_list;
71   struct nbr_entry *next;
72   struct nbr_entry *prev;
73 };
74
75 #define OLSR_FOR_ALL_NBR_ENTRIES(nbr) \
76 { \
77   int _idx; \
78   for (_idx = 0; _idx < HASHSIZE; _idx++) { \
79     for(nbr = neighbortable[_idx].next; \
80         nbr != &neighbortable[_idx]; \
81         nbr = nbr->next)
82 #define OLSR_FOR_ALL_NBR_ENTRIES_END(nbr) }}
83
84
85 /*
86  * The neighbor table
87  */
88 extern struct nbr_entry
89 EXPORT(neighbortable)[HASHSIZE];
90
91      extern struct olsr_cookie_info *nbr2_list_timer_cookie;
92
93      void
94        olsr_init_neighbor_table(void);
95
96      int
97        olsr_delete_neighbor_2_pointer(struct nbr_entry *, struct neighbor_2_entry *);
98
99      struct nbr2_list_entry *olsr_lookup_my_neighbors(const struct nbr_entry *, const union olsr_ip_addr *);
100
101      int
102        olsr_delete_neighbor_table(const union olsr_ip_addr *);
103
104      struct nbr_entry *olsr_insert_neighbor_table(const union olsr_ip_addr *);
105
106      struct nbr_entry *olsr_lookup_neighbor_table(const union olsr_ip_addr *);
107
108      struct nbr_entry *olsr_lookup_neighbor_table_alias(const union olsr_ip_addr *);
109
110      void
111        olsr_time_out_two_hop_neighbors(struct nbr_entry *);
112
113      void
114        olsr_time_out_neighborhood_tables(void);
115      void olsr_expire_nbr2_list(void *);
116
117      void
118        olsr_print_neighbor_table(void);
119
120
121      int
122        update_neighbor_status(struct nbr_entry *, int);
123
124 #endif
125
126 /*
127  * Local Variables:
128  * c-basic-offset: 2
129  * indent-tabs-mode: nil
130  * End:
131  */