Improved duplicate/sequencenumber handling. Small change in message handler callback...
[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_cookie.h"
50 #include "olsr_logging.h"
51
52 #include <stdlib.h>
53
54 static void olsr_cleanup_duplicate_entry(void *unused);
55
56 static struct avl_tree forward_set, processing_set;
57 static struct timer_entry *duplicate_cleanup_timer;
58
59 /* Some cookies for stats keeping */
60 static struct olsr_cookie_info *duplicate_timer_cookie = NULL;
61 static struct olsr_cookie_info *duplicate_mem_cookie = NULL;
62
63 int olsr_seqno_diff(uint16_t reference, uint16_t other) {
64   int diff;
65
66   diff = (int)reference - (int)other;
67
68   // overflow ?
69   if (diff >= (1 << 15)) {
70     diff -= (1 << 16);
71   }
72   else if (diff < -(1 << 15)) {
73     diff += (1 << 16);
74   }
75   return diff;
76 }
77
78 void
79 olsr_init_duplicate_set(void)
80 {
81   OLSR_INFO(LOG_DUPLICATE_SET, "Initialize duplicate set...\n");
82
83   avl_init(&forward_set, avl_comp_default);
84   avl_init(&processing_set, avl_comp_default);
85
86   /*
87    * Get some cookies for getting stats to ease troubleshooting.
88    */
89   duplicate_timer_cookie = olsr_alloc_cookie("Duplicate Set", OLSR_COOKIE_TYPE_TIMER);
90
91   duplicate_mem_cookie = olsr_alloc_cookie("dup_entry", OLSR_COOKIE_TYPE_MEMORY);
92   olsr_cookie_set_memory_size(duplicate_mem_cookie, sizeof(struct dup_entry));
93
94   olsr_set_timer(&duplicate_cleanup_timer, DUPLICATE_CLEANUP_INTERVAL,
95                  DUPLICATE_CLEANUP_JITTER, OLSR_TIMER_PERIODIC, &olsr_cleanup_duplicate_entry, NULL, duplicate_timer_cookie);
96 }
97
98 static struct dup_entry *
99 olsr_create_duplicate_entry(union olsr_ip_addr *ip, uint16_t seqnr)
100 {
101   struct dup_entry *entry;
102   entry = olsr_cookie_malloc(duplicate_mem_cookie);
103   if (entry != NULL) {
104     memcpy(&entry->ip, ip, olsr_cnf->ip_version == AF_INET ? sizeof(entry->ip.v4) : sizeof(entry->ip.v6));
105     entry->seqnr = seqnr;
106     entry->too_low_counter = 0;
107     entry->avl.key = &entry->ip;
108     entry->array = 0;
109   }
110   return entry;
111 }
112
113 static void
114 olsr_delete_duplicate_entry(struct dup_entry *entry, bool forward)
115 {
116   avl_delete(forward ? &forward_set : &processing_set, &entry->avl);
117   olsr_cookie_free(duplicate_mem_cookie, entry);
118 }
119
120 static void
121 olsr_cleanup_duplicate_entry(void __attribute__ ((unused)) * unused)
122 {
123   struct dup_entry *entry;
124
125   OLSR_FOR_ALL_DUP_ENTRIES(entry, true) {
126     if (TIMED_OUT(entry->valid_until)) {
127       olsr_delete_duplicate_entry(entry, true);
128     }
129   }
130   OLSR_FOR_ALL_DUP_ENTRIES_END(entry);
131   OLSR_FOR_ALL_DUP_ENTRIES(entry, false) {
132     if (TIMED_OUT(entry->valid_until)) {
133       olsr_delete_duplicate_entry(entry, false);
134     }
135   }
136   OLSR_FOR_ALL_DUP_ENTRIES_END(entry);
137 }
138
139 /**
140  * Clean up the house. Called during shutdown.
141  */
142 void
143 olsr_flush_duplicate_entries(void)
144 {
145   struct dup_entry *entry;
146
147   olsr_stop_timer(duplicate_cleanup_timer);
148   duplicate_cleanup_timer = NULL;
149
150   OLSR_FOR_ALL_DUP_ENTRIES(entry, true) {
151     olsr_delete_duplicate_entry(entry, true);
152   } OLSR_FOR_ALL_DUP_ENTRIES_END(entry);
153   OLSR_FOR_ALL_DUP_ENTRIES(entry, false) {
154     olsr_delete_duplicate_entry(entry, false);
155   } OLSR_FOR_ALL_DUP_ENTRIES_END(entry);
156 }
157
158 bool
159 olsr_is_duplicate_message(union olsr_message *m, bool forwarding, enum duplicate_status *status)
160 {
161   struct avl_tree *tree;
162   struct dup_entry *entry;
163   int diff;
164   union olsr_ip_addr *mainIp;
165   uint32_t valid_until;
166   uint16_t seqnr;
167   union olsr_ip_addr *ip;
168   enum duplicate_status dummy = 0;
169
170 #if !defined(REMOVE_LOG_DEBUG)
171   struct ipaddr_str buf;
172 #endif
173
174   if (status == NULL) {
175     status = &dummy;
176   }
177
178   tree = forwarding ? &forward_set : &processing_set;
179   if (olsr_cnf->ip_version == AF_INET) {
180     seqnr = ntohs(m->v4.seqno);
181     ip = (union olsr_ip_addr *)&m->v4.originator;
182   } else {
183     seqnr = ntohs(m->v6.seqno);
184     ip = (union olsr_ip_addr *)&m->v6.originator;
185   }
186
187   // get main address
188   mainIp = olsr_lookup_main_addr_by_alias(ip);
189   if (mainIp == NULL) {
190     mainIp = ip;
191   }
192
193   valid_until = GET_TIMESTAMP(DUPLICATE_VTIME);
194
195   entry = (struct dup_entry *)avl_find(tree, ip);
196   if (entry == NULL) {
197     entry = olsr_create_duplicate_entry(ip, seqnr);
198     if (entry != NULL) {
199       avl_insert(tree, &entry->avl, 0);
200       entry->valid_until = valid_until;
201     }
202
203     *status = NEW_OLSR_MESSAGE;
204     return false;               // okay, we process this package
205   }
206
207   diff = olsr_seqno_diff(seqnr, entry->seqnr);
208
209   // update timestamp
210   if (valid_until > entry->valid_until) {
211     entry->valid_until = valid_until;
212   }
213
214   if (diff < -31) {
215     entry->too_low_counter++;
216
217     // client did restart with a lower number ?
218     if (entry->too_low_counter > 16) {
219       entry->too_low_counter = 0;
220       entry->seqnr = seqnr;
221       entry->array = 1;
222
223       /* start with a new sequence number, so NO duplicate */
224       *status = RESET_SEQNO_OLSR_MESSAGE;
225       return false;
226     }
227     OLSR_DEBUG(LOG_DUPLICATE_SET, "blocked %x from %s\n", seqnr, olsr_ip_to_string(&buf, mainIp));
228
229     /* much too old */
230     *status = TOO_OLD_OLSR_MESSAGE;
231     return true;
232   }
233
234   entry->too_low_counter = 0;
235   if (diff <= 0) {
236     uint32_t bitmask = 1 << ((uint32_t) (-diff));
237
238     if ((entry->array & bitmask) != 0) {
239       OLSR_DEBUG(LOG_DUPLICATE_SET, "blocked %x (diff=%d,mask=%08x) from %s\n", seqnr, diff,
240                  entry->array, olsr_ip_to_string(&buf, mainIp));
241
242       /* duplicate ! */
243       *status = DUPLICATE_OLSR_MESSAGE;
244       return true;
245     }
246     entry->array |= bitmask;
247     OLSR_DEBUG(LOG_DUPLICATE_SET, "processed %x from %s\n", seqnr, olsr_ip_to_string(&buf, mainIp));
248
249     /* no duplicate */
250     *status = OLD_OLSR_MESSAGE;
251     return false;
252   } else if (diff < 32) {
253     entry->array <<= (uint32_t) diff;
254   } else {
255     entry->array = 0;
256   }
257   entry->array |= 1;
258   entry->seqnr = seqnr;
259   OLSR_DEBUG(LOG_DUPLICATE_SET, "processed %x from %s\n", seqnr, olsr_ip_to_string(&buf, mainIp));
260
261   /* no duplicate */
262   *status = NEW_OLSR_MESSAGE;
263   return false;
264 }
265
266 void
267 olsr_print_duplicate_table(void)
268 {
269 #if !defined REMOVE_LOG_INFO
270   /* The whole function makes no sense without it. */
271   struct dup_entry *entry;
272   const int ipwidth = olsr_cnf->ip_version == AF_INET ? 15 : 30;
273
274   OLSR_INFO(LOG_DUPLICATE_SET, "\n--- %s ------------------------------------------------- DUPLICATE SET (forwarding)\n\n",
275             olsr_wallclock_string());
276   OLSR_INFO_NH(LOG_DUPLICATE_SET, "%-*s %8s %s\n", ipwidth, "Node IP", "DupArray", "VTime");
277
278   OLSR_FOR_ALL_DUP_ENTRIES(entry, true) {
279     struct ipaddr_str addrbuf;
280     OLSR_INFO_NH(LOG_DUPLICATE_SET, "%-*s %08x %s\n",
281                  ipwidth, olsr_ip_to_string(&addrbuf, entry->avl.key), entry->array, olsr_clock_string(entry->valid_until));
282   } OLSR_FOR_ALL_DUP_ENTRIES_END(entry);
283
284   OLSR_INFO(LOG_DUPLICATE_SET, "\n--- %s ------------------------------------------------- DUPLICATE SET (processing)\n\n",
285             olsr_wallclock_string());
286   OLSR_INFO_NH(LOG_DUPLICATE_SET, "%-*s %8s %s\n", ipwidth, "Node IP", "DupArray", "VTime");
287
288   OLSR_FOR_ALL_DUP_ENTRIES(entry, false) {
289     struct ipaddr_str addrbuf;
290     OLSR_INFO_NH(LOG_DUPLICATE_SET, "%-*s %08x %s\n",
291                  ipwidth, olsr_ip_to_string(&addrbuf, entry->avl.key), entry->array, olsr_clock_string(entry->valid_until));
292   } OLSR_FOR_ALL_DUP_ENTRIES_END(entry);
293 #endif
294 }
295
296 /*
297  * Local Variables:
298  * c-basic-offset: 2
299  * indent-tabs-mode: nil
300  * End:
301  */