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