Move from fixed cookie array to dynamic tree
[olsrd.git] / src / mpr_selector_set.c
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 #include "mpr_selector_set.h"
42 #include "link_set.h"
43 #include "olsr.h"
44 #include "olsr_logging.h"
45
46 uint16_t ansn = 0;
47
48 static struct olsr_cookie_info *mpr_sel_timer_cookie;
49 static struct olsr_cookie_info *mpr_sel_mem_cookie;
50
51 /* Root of MPR selector tree */
52 static struct avl_tree mprs_tree;
53
54
55 void
56 olsr_init_mprs(void)
57 {
58   OLSR_INFO(LOG_MPRS, "Initialize MPR set...\n");
59
60   avl_init(&mprs_tree, avl_comp_default);
61
62   /*
63    * Get some cookies for getting stats to ease troubleshooting.
64    */
65   mpr_sel_timer_cookie = olsr_alloc_cookie("MPR Selector", OLSR_COOKIE_TYPE_TIMER);
66
67   mpr_sel_mem_cookie = olsr_alloc_cookie("MPR Selector", OLSR_COOKIE_TYPE_MEMORY);
68   olsr_cookie_set_memory_size(mpr_sel_mem_cookie, sizeof(struct mpr_selector));
69 }
70
71 /**
72  * Wrapper for the timer callback.
73  */
74 static void
75 olsr_expire_mpr_sel_entry(void *context)
76 {
77   struct mpr_selector *mpr_sel = context;
78 #if !defined REMOVE_LOG_DEBUG
79   struct ipaddr_str buf;
80 #endif
81   OLSR_DEBUG(LOG_MPRS, "MPRS: Timing out %st\n", olsr_ip_to_string(&buf, &mpr_sel->MS_main_addr));
82
83   mpr_sel->MS_timer = NULL;
84
85   avl_delete(&mprs_tree, &mpr_sel->mprs_node);
86
87   /* Delete entry */
88   olsr_cookie_free(mpr_sel_mem_cookie, mpr_sel);
89   signal_link_changes(true);
90 }
91
92 /**
93  * Lookup an entry in the MPR selector table
94  * based on address
95  *
96  * @param addr the addres to check for
97  *
98  * @return a pointer to the entry or NULL
99  */
100 struct mpr_selector *
101 olsr_lookup_mprs_set(const union olsr_ip_addr *addr)
102 {
103   struct avl_node *node;
104
105   node = avl_find(&mprs_tree, addr);
106   if (node) {
107     return mprs_sel_node_to_mpr_sel(node);
108   }
109   return NULL;
110 }
111
112
113 /**
114  * Update a MPR selector entry or create an new
115  * one if it does not exist
116  *
117  * @param addr the address of the MPR selector
118  * @param vtime tha validity time of the entry
119  *
120  * @return 1 if a new entry was added 0 if not
121  */
122 int
123 olsr_update_mprs_set(const union olsr_ip_addr *addr, olsr_reltime vtime)
124 {
125   int rv;
126 #if !defined REMOVE_LOG_DEBUG
127   struct ipaddr_str buf;
128 #endif
129   struct mpr_selector *mprs;
130
131   mprs = olsr_lookup_mprs_set(addr);
132   if (mprs == NULL) {
133     mprs = olsr_cookie_malloc(mpr_sel_mem_cookie);
134
135     OLSR_DEBUG(LOG_MPRS, "MPRS: adding %s\n", olsr_ip_to_string(&buf, addr));
136
137     /* Fill struct */
138     mprs->MS_main_addr = *addr;
139
140     /* Queue */
141     mprs->mprs_node.key = &mprs->MS_main_addr;
142     avl_insert(&mprs_tree, &mprs->mprs_node, AVL_DUP_NO);
143
144     signal_link_changes(true);
145     rv = 1;
146   } else {
147     OLSR_DEBUG(LOG_MPRS, "MPRS: Update %s\n", olsr_ip_to_string(&buf, addr));
148     rv = 0;
149   }
150   olsr_set_timer(&mprs->MS_timer,
151                  vtime, OLSR_MPR_SEL_JITTER, OLSR_TIMER_ONESHOT, &olsr_expire_mpr_sel_entry, mprs, mpr_sel_timer_cookie);
152   return rv;
153 }
154
155
156 /**
157  *Print the current MPR selector set to STDOUT
158  */
159 void
160 olsr_print_mprs_set(void)
161 {
162 #if !defined REMOVE_LOG_INFO
163   struct ipaddr_str buf;
164   struct mpr_selector *mprs;
165
166   OLSR_INFO(LOG_MPRS, "MPR SELECTORS:\n");
167
168   OLSR_FOR_ALL_MPRS_ENTRIES(mprs) {
169     OLSR_INFO_NH(LOG_MPRS, "\t%s\n", olsr_ip_to_string(&buf, &mprs->MS_main_addr));
170   } OLSR_FOR_ALL_MPRS_ENTRIES_END(mprs);
171 #endif
172 }
173
174 /*
175  * Local Variables:
176  * c-basic-offset: 2
177  * indent-tabs-mode: nil
178  * End:
179  */