Debuginfo allows access to current logging output through telnet.
[olsrd.git] / src / duplicate_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
42 #include "duplicate_set.h"
43 #include "ipcalc.h"
44 #include "common/avl.h"
45 #include "olsr.h"
46 #include "mid_set.h"
47 #include "scheduler.h"
48 #include "olsr_time.h"
49 #include "olsr_memcookie.h"
50 #include "olsr_logging.h"
51
52 #include <stdlib.h>
53
54 struct avl_tree forward_set, processing_set;
55
56 /* Some cookies for stats keeping */
57 static struct olsr_timer_info *duplicate_timer_info = NULL;
58 static struct olsr_memcookie_info *duplicate_mem_cookie = NULL;
59
60 int
61 olsr_seqno_diff(uint16_t reference, uint16_t other)
62 {
63   int diff;
64
65   diff = (int)reference - (int)other;
66
67   // overflow ?
68   if (diff >= (1 << 15)) {
69     diff -= (1 << 16);
70   } else if (diff < -(1 << 15)) {
71     diff += (1 << 16);
72   }
73   return diff;
74 }
75
76 static struct dup_entry *
77 olsr_create_duplicate_entry(union olsr_ip_addr *ip, uint16_t seqnr)
78 {
79   struct dup_entry *entry;
80
81   entry = olsr_memcookie_malloc(duplicate_mem_cookie);
82   if (entry != NULL) {
83     memcpy(&entry->ip, ip, olsr_cnf->ip_version == AF_INET ? sizeof(entry->ip.v4) : sizeof(entry->ip.v6));
84     entry->seqnr = seqnr;
85     entry->too_low_counter = 0;
86     entry->avl.key = &entry->ip;
87     entry->array = 0;
88   }
89   return entry;
90 }
91
92 static void
93 olsr_delete_duplicate_entry(struct dup_entry *entry)
94 {
95   avl_delete(entry->tree, &entry->avl);
96   entry->tree = NULL;
97   olsr_stop_timer(entry->validity_timer);
98   entry->validity_timer = NULL;
99   olsr_memcookie_free(duplicate_mem_cookie, entry);
100 }
101
102 static void
103 olsr_expire_duplicate_entry(void *context)
104 {
105   struct dup_entry *entry = context;
106   entry->validity_timer = NULL;
107
108   olsr_delete_duplicate_entry(entry);
109 }
110
111 void
112 olsr_init_duplicate_set(void)
113 {
114   OLSR_INFO(LOG_DUPLICATE_SET, "Initialize duplicate set...\n");
115
116   avl_init(&forward_set, avl_comp_default, false, NULL);
117   avl_init(&processing_set, avl_comp_default, false, NULL);
118
119   /*
120    * Get some cookies for getting stats to ease troubleshooting.
121    */
122   duplicate_timer_info = olsr_alloc_timerinfo("Duplicate Set", &olsr_expire_duplicate_entry, false);
123
124   duplicate_mem_cookie = olsr_memcookie_add("dup_entry", sizeof(struct dup_entry));
125 }
126
127
128 /**
129  * Clean up the house. Called during shutdown.
130  */
131 void
132 olsr_flush_duplicate_entries(void)
133 {
134   struct dup_entry *entry, *iterator;
135
136   OLSR_FOR_ALL_FORWARD_DUP_ENTRIES(entry, iterator) {
137     olsr_delete_duplicate_entry(entry);
138   }
139   OLSR_FOR_ALL_PROCESS_DUP_ENTRIES(entry, iterator) {
140     olsr_delete_duplicate_entry(entry);
141   }
142 }
143
144 bool
145 olsr_is_duplicate_message(struct olsr_message *m, bool forwarding, enum duplicate_status *status)
146 {
147   struct avl_tree *tree;
148   struct dup_entry *entry;
149   int diff;
150   uint32_t valid_until;
151   enum duplicate_status dummy = 0;
152
153 #if !defined(REMOVE_LOG_DEBUG)
154   struct ipaddr_str buf;
155 #endif
156
157   if (status == NULL) {
158     status = &dummy;
159   }
160
161   tree = forwarding ? &forward_set : &processing_set;
162
163   valid_until = GET_TIMESTAMP(DUPLICATE_VTIME);
164
165   /* Check if entry exists */
166   entry = (struct dup_entry *)avl_find(tree, &m->originator);
167   if (entry == NULL) {
168     entry = olsr_create_duplicate_entry(&m->originator, m->seqno);
169     if (entry != NULL) {
170       avl_insert(tree, &entry->avl);
171       entry->tree = tree;
172       entry->validity_timer = olsr_start_timer(DUPLICATE_CLEANUP_INTERVAL, DUPLICATE_CLEANUP_JITTER,
173                                                entry, duplicate_timer_info);
174     }
175
176     *status = NEW_OLSR_MESSAGE;
177     return false;               // okay, we process this package
178   }
179
180   /*
181    * Refresh timer.
182    */
183   olsr_change_timer(entry->validity_timer, DUPLICATE_CLEANUP_INTERVAL, DUPLICATE_CLEANUP_JITTER);
184
185   diff = olsr_seqno_diff(m->seqno, entry->seqnr);
186
187   if (diff < -31) {
188     entry->too_low_counter++;
189
190     // client did restart with a lower number ?
191     if (entry->too_low_counter > 16) {
192       entry->too_low_counter = 0;
193       entry->seqnr = m->seqno;
194       entry->array = 1;
195
196       /* start with a new sequence number, so NO duplicate */
197       *status = RESET_SEQNO_OLSR_MESSAGE;
198       return false;
199     }
200     OLSR_DEBUG(LOG_DUPLICATE_SET, "blocked %x from %s\n", m->seqno, olsr_ip_to_string(&buf, &m->originator));
201
202     /* much too old */
203     *status = TOO_OLD_OLSR_MESSAGE;
204     return true;
205   }
206
207   entry->too_low_counter = 0;
208   if (diff <= 0) {
209     uint32_t bitmask = 1 << ((uint32_t) (-diff));
210
211     if ((entry->array & bitmask) != 0) {
212       OLSR_DEBUG(LOG_DUPLICATE_SET, "blocked %x (diff=%d,mask=%08x) from %s\n", m->seqno, diff,
213                  entry->array, olsr_ip_to_string(&buf, &m->originator));
214
215       /* duplicate ! */
216       *status = DUPLICATE_OLSR_MESSAGE;
217       return true;
218     }
219     entry->array |= bitmask;
220     OLSR_DEBUG(LOG_DUPLICATE_SET, "processed %x from %s\n", m->seqno, olsr_ip_to_string(&buf, &m->originator));
221
222     /* no duplicate */
223     *status = OLD_OLSR_MESSAGE;
224     return false;
225   } else if (diff < 32) {
226     entry->array <<= (uint32_t) diff;
227   } else {
228     entry->array = 0;
229   }
230   entry->array |= 1;
231   entry->seqnr = m->seqno;
232   OLSR_DEBUG(LOG_DUPLICATE_SET, "processed %x from %s\n", m->seqno, olsr_ip_to_string(&buf, &m->originator));
233
234   /* no duplicate */
235   *status = NEW_OLSR_MESSAGE;
236   return false;
237 }
238
239 void
240 olsr_print_duplicate_table(void)
241 {
242 #if !defined REMOVE_LOG_INFO
243   /* The whole function makes no sense without it. */
244   struct dup_entry *entry, *iterator;
245   const int ipwidth = olsr_cnf->ip_version == AF_INET ? 15 : 30;
246
247   OLSR_INFO(LOG_DUPLICATE_SET, "\n--- %s ------------------------------------------------- DUPLICATE SET (forwarding)\n\n",
248             olsr_wallclock_string());
249   OLSR_INFO_NH(LOG_DUPLICATE_SET, "%-*s %8s %s\n", ipwidth, "Node IP", "DupArray", "VTime");
250
251   OLSR_FOR_ALL_FORWARD_DUP_ENTRIES(entry, iterator) {
252     struct ipaddr_str addrbuf;
253     OLSR_INFO_NH(LOG_DUPLICATE_SET, "%-*s %08x %s\n",
254                  ipwidth, olsr_ip_to_string(&addrbuf, entry->avl.key), entry->array,
255                  olsr_clock_string(entry->validity_timer->timer_clock));
256   }
257
258     OLSR_INFO(LOG_DUPLICATE_SET, "\n--- %s ------------------------------------------------- DUPLICATE SET (processing)\n\n",
259               olsr_wallclock_string());
260   OLSR_INFO_NH(LOG_DUPLICATE_SET, "%-*s %8s %s\n", ipwidth, "Node IP", "DupArray", "VTime");
261
262   OLSR_FOR_ALL_PROCESS_DUP_ENTRIES(entry, iterator) {
263     struct ipaddr_str addrbuf;
264     OLSR_INFO_NH(LOG_DUPLICATE_SET, "%-*s %08x %s\n",
265                  ipwidth, olsr_ip_to_string(&addrbuf, entry->avl.key), entry->array,
266                  olsr_clock_string(entry->validity_timer->timer_clock));
267   }
268 #endif
269 }
270
271 /*
272  * Local Variables:
273  * c-basic-offset: 2
274  * indent-tabs-mode: nil
275  * End:
276  */