FIX: segfault during neightable timer cleanup
[olsrd.git] / src / two_hop_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_TWO_HOP_TABLE
44 #define _OLSR_TWO_HOP_TABLE
45
46 #include "defs.h"
47 #include "hashing.h"
48 #include "lq_plugin.h"
49
50 #define NB2S_COVERED    0x1     /* node has been covered by a MPR */
51
52
53 struct neighbor_list_entry {
54   struct nbr_entry *neighbor;
55   olsr_linkcost second_hop_linkcost;
56   olsr_linkcost path_linkcost;
57   olsr_linkcost saved_path_linkcost;
58   struct neighbor_list_entry *next;
59   struct neighbor_list_entry *prev;
60 };
61
62
63 struct neighbor_2_entry {
64   union olsr_ip_addr neighbor_2_addr;
65   uint8_t mpr_covered_count;           /*used in mpr calculation */
66   uint8_t processed;                   /*used in mpr calculation */
67   int16_t neighbor_2_pointer;          /* Neighbor count */
68   struct timer_entry *nbr2_list_timer;
69   struct neighbor_list_entry neighbor_2_nblist;
70   struct neighbor_2_entry *prev;
71   struct neighbor_2_entry *next;
72 };
73
74 /*
75  * macros for traversing two-hop neighbors lists.
76  * it is recommended to use this because it hides all the internal
77  * datastructure from the callers.
78  *
79  * the loop prefetches the next node in order to not loose context if
80  * for example the caller wants to delete the current entry.
81  */
82 #define OLSR_FOR_ALL_NBR2_ENTRIES(nbr2) \
83   { \
84   int _idx; \
85   for (_idx = 0; _idx < HASHSIZE; _idx++) { \
86   for(nbr2 = two_hop_neighbortable[_idx].next; \
87   nbr2 != &two_hop_neighbortable[_idx]; \
88   nbr2 = nbr2->next)
89 #define OLSR_FOR_ALL_NBR2_ENTRIES_END(nbr2) }}
90
91 extern struct neighbor_2_entry two_hop_neighbortable[HASHSIZE];
92
93 void olsr_init_two_hop_table(void);
94 void olsr_delete_neighbor_pointer(struct neighbor_2_entry *, struct nbr_entry *);
95 void olsr_delete_two_hop_neighbor_table(struct neighbor_2_entry *);
96 void olsr_insert_two_hop_neighbor_table(struct neighbor_2_entry *);
97 struct neighbor_2_entry *olsr_lookup_two_hop_neighbor_table(const union olsr_ip_addr *);
98 struct neighbor_2_entry *olsr_lookup_two_hop_neighbor_table_mid(const union olsr_ip_addr *);
99 void olsr_link_nbr_nbr2(struct nbr_entry *, struct neighbor_2_entry *, float);
100 void olsr_print_two_hop_neighbor_table(void);
101
102 #endif
103
104 /*
105  * Local Variables:
106  * c-basic-offset: 2
107  * indent-tabs-mode: nil
108  * End:
109  */