826b5056b70050a13f2c616e5bc5e55dceadcfcf
[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 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_cookie_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_cookie_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_cookie_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_create_memcookie("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;
135   struct list_iterator iterator;
136
137   OLSR_FOR_ALL_FORWARD_DUP_ENTRIES(entry, iterator) {
138     olsr_delete_duplicate_entry(entry);
139   }
140   OLSR_FOR_ALL_PROCESS_DUP_ENTRIES(entry, iterator) {
141     olsr_delete_duplicate_entry(entry);
142   }
143 }
144
145 bool
146 olsr_is_duplicate_message(struct olsr_message *m, bool forwarding, enum duplicate_status *status)
147 {
148   struct avl_tree *tree;
149   struct dup_entry *entry;
150   int diff;
151   uint32_t valid_until;
152   enum duplicate_status dummy = 0;
153
154 #if !defined(REMOVE_LOG_DEBUG)
155   struct ipaddr_str buf;
156 #endif
157
158   if (status == NULL) {
159     status = &dummy;
160   }
161
162   tree = forwarding ? &forward_set : &processing_set;
163
164   valid_until = GET_TIMESTAMP(DUPLICATE_VTIME);
165
166   /* Check if entry exists */
167   entry = (struct dup_entry *)avl_find(tree, &m->originator);
168   if (entry == NULL) {
169     entry = olsr_create_duplicate_entry(&m->originator, m->seqno);
170     if (entry != NULL) {
171       avl_insert(tree, &entry->avl);
172       entry->tree = tree;
173       entry->validity_timer = olsr_start_timer(DUPLICATE_CLEANUP_INTERVAL, DUPLICATE_CLEANUP_JITTER,
174                                                entry, duplicate_timer_info);
175     }
176
177     *status = NEW_OLSR_MESSAGE;
178     return false;               // okay, we process this package
179   }
180
181   /*
182    * Refresh timer.
183    */
184   olsr_change_timer(entry->validity_timer, DUPLICATE_CLEANUP_INTERVAL, DUPLICATE_CLEANUP_JITTER);
185
186   diff = olsr_seqno_diff(m->seqno, entry->seqnr);
187
188   if (diff < -31) {
189     entry->too_low_counter++;
190
191     // client did restart with a lower number ?
192     if (entry->too_low_counter > 16) {
193       entry->too_low_counter = 0;
194       entry->seqnr = m->seqno;
195       entry->array = 1;
196
197       /* start with a new sequence number, so NO duplicate */
198       *status = RESET_SEQNO_OLSR_MESSAGE;
199       return false;
200     }
201     OLSR_DEBUG(LOG_DUPLICATE_SET, "blocked %x from %s\n", m->seqno, olsr_ip_to_string(&buf, &m->originator));
202
203     /* much too old */
204     *status = TOO_OLD_OLSR_MESSAGE;
205     return true;
206   }
207
208   entry->too_low_counter = 0;
209   if (diff <= 0) {
210     uint32_t bitmask = 1 << ((uint32_t) (-diff));
211
212     if ((entry->array & bitmask) != 0) {
213       OLSR_DEBUG(LOG_DUPLICATE_SET, "blocked %x (diff=%d,mask=%08x) from %s\n", m->seqno, diff,
214                  entry->array, olsr_ip_to_string(&buf, &m->originator));
215
216       /* duplicate ! */
217       *status = DUPLICATE_OLSR_MESSAGE;
218       return true;
219     }
220     entry->array |= bitmask;
221     OLSR_DEBUG(LOG_DUPLICATE_SET, "processed %x from %s\n", m->seqno, olsr_ip_to_string(&buf, &m->originator));
222
223     /* no duplicate */
224     *status = OLD_OLSR_MESSAGE;
225     return false;
226   } else if (diff < 32) {
227     entry->array <<= (uint32_t) diff;
228   } else {
229     entry->array = 0;
230   }
231   entry->array |= 1;
232   entry->seqnr = m->seqno;
233   OLSR_DEBUG(LOG_DUPLICATE_SET, "processed %x from %s\n", m->seqno, olsr_ip_to_string(&buf, &m->originator));
234
235   /* no duplicate */
236   *status = NEW_OLSR_MESSAGE;
237   return false;
238 }
239
240 void
241 olsr_print_duplicate_table(void)
242 {
243 #if !defined REMOVE_LOG_INFO
244   /* The whole function makes no sense without it. */
245   struct dup_entry *entry;
246   struct list_iterator iterator;
247   const int ipwidth = olsr_cnf->ip_version == AF_INET ? 15 : 30;
248
249   OLSR_INFO(LOG_DUPLICATE_SET, "\n--- %s ------------------------------------------------- DUPLICATE SET (forwarding)\n\n",
250             olsr_wallclock_string());
251   OLSR_INFO_NH(LOG_DUPLICATE_SET, "%-*s %8s %s\n", ipwidth, "Node IP", "DupArray", "VTime");
252
253   OLSR_FOR_ALL_FORWARD_DUP_ENTRIES(entry, iterator) {
254     struct ipaddr_str addrbuf;
255     OLSR_INFO_NH(LOG_DUPLICATE_SET, "%-*s %08x %s\n",
256                  ipwidth, olsr_ip_to_string(&addrbuf, entry->avl.key), entry->array,
257                  olsr_clock_string(entry->validity_timer->timer_clock));
258   }
259
260     OLSR_INFO(LOG_DUPLICATE_SET, "\n--- %s ------------------------------------------------- DUPLICATE SET (processing)\n\n",
261               olsr_wallclock_string());
262   OLSR_INFO_NH(LOG_DUPLICATE_SET, "%-*s %8s %s\n", ipwidth, "Node IP", "DupArray", "VTime");
263
264   OLSR_FOR_ALL_PROCESS_DUP_ENTRIES(entry, iterator) {
265     struct ipaddr_str addrbuf;
266     OLSR_INFO_NH(LOG_DUPLICATE_SET, "%-*s %08x %s\n",
267                  ipwidth, olsr_ip_to_string(&addrbuf, entry->avl.key), entry->array,
268                  olsr_clock_string(entry->validity_timer->timer_clock));
269   }
270 #endif
271 }
272
273 /*
274  * Local Variables:
275  * c-basic-offset: 2
276  * indent-tabs-mode: nil
277  * End:
278  */