Fix bug in duplicate set
[olsrd.git] / src / duplicate_set.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2008 Henning Rogge <rogge@fgan.de>
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 "mantissa.h"
49
50 static void olsr_cleanup_duplicate_entry(void *unused);
51
52 struct avl_tree duplicate_set;
53 struct timer_entry *duplicate_cleanup_timer;
54
55 void
56 olsr_init_duplicate_set(void)
57 {
58   avl_init(&duplicate_set, olsr_cnf->ip_version == AF_INET ? &avl_comp_ipv4 : &avl_comp_ipv6);
59
60   olsr_set_timer(&duplicate_cleanup_timer, DUPLICATE_CLEANUP_INTERVAL, DUPLICATE_CLEANUP_JITTER, OLSR_TIMER_PERIODIC,
61                  &olsr_cleanup_duplicate_entry, NULL, 0);
62 }
63
64 struct dup_entry *
65 olsr_create_duplicate_entry(void *ip, uint16_t seqnr)
66 {
67   struct dup_entry *entry;
68   entry = olsr_malloc(sizeof(struct dup_entry), "New duplicate entry");
69   if (entry != NULL) {
70     memcpy(&entry->ip, ip, olsr_cnf->ip_version == AF_INET ? sizeof(entry->ip.v4) : sizeof(entry->ip.v6));
71     entry->seqnr = seqnr;
72     entry->too_low_counter = 0;
73     entry->avl.key = &entry->ip;
74     entry->array = 0;
75   }
76   return entry;
77 }
78
79 static void
80 olsr_cleanup_duplicate_entry(void __attribute__ ((unused)) * unused)
81 {
82   struct dup_entry *entry;
83
84   OLSR_FOR_ALL_DUP_ENTRIES(entry) {
85     if (TIMED_OUT(entry->valid_until)) {
86       avl_delete(&duplicate_set, &entry->avl);
87       free(entry);
88     }
89   }
90   OLSR_FOR_ALL_DUP_ENTRIES_END(entry);
91 }
92
93 int
94 olsr_message_is_duplicate(union olsr_message *m)
95 {
96   struct dup_entry *entry;
97   int diff;
98   void *mainIp;
99   uint32_t valid_until;
100   struct ipaddr_str buf;
101   uint16_t seqnr;
102   void *ip;
103
104   if (olsr_cnf->ip_version == AF_INET) {
105     seqnr = ntohs(m->v4.seqno);
106     ip = &m->v4.originator;
107   } else {
108     seqnr = ntohs(m->v6.seqno);
109     ip = &m->v6.originator;
110   }
111
112   // get main address
113   mainIp = mid_lookup_main_addr(ip);
114   if (mainIp == NULL) {
115     mainIp = ip;
116   }
117
118   valid_until = GET_TIMESTAMP(DUPLICATE_VTIME);
119
120   entry = (struct dup_entry *)avl_find(&duplicate_set, ip);
121   if (entry == NULL) {
122     entry = olsr_create_duplicate_entry(ip, seqnr);
123     if (entry != NULL) {
124       avl_insert(&duplicate_set, &entry->avl, 0);
125       entry->valid_until = valid_until;
126     }
127     return false;               // okay, we process this package
128   }
129
130   diff = (int)seqnr - (int)(entry->seqnr);
131
132   // update timestamp
133   if (valid_until > entry->valid_until) {
134     entry->valid_until = valid_until;
135   }
136   // overflow ?
137   if (diff > (1 << 15)) {
138     diff -= (1 << 16);
139   }
140   else if (diff < -(1 << 15)) {
141       diff += (1 << 16);
142   }
143
144   if (diff < -31) {
145     entry->too_low_counter++;
146
147     // client did restart with a lower number ?
148     if (entry->too_low_counter > 16) {
149       entry->too_low_counter = 0;
150       entry->seqnr = seqnr;
151       entry->array = 1;
152       return false;             /* start with a new sequence number, so NO duplicate */
153     }
154     OLSR_PRINTF(9, "blocked %x from %s\n", seqnr, olsr_ip_to_string(&buf, mainIp));
155     return true;                /* duplicate ! */
156   }
157
158   entry->too_low_counter = 0;
159   if (diff <= 0) {
160     uint32_t bitmask = 1 << ((uint32_t) (-diff));
161
162     if ((entry->array & bitmask) != 0) {
163       OLSR_PRINTF(9, "blocked %x (diff=%d,mask=%08x) from %s\n", seqnr, diff, entry->array, olsr_ip_to_string(&buf, mainIp));
164       return true;              /* duplicate ! */
165     }
166     entry->array |= bitmask;
167     OLSR_PRINTF(9, "processed %x from %s\n", seqnr, olsr_ip_to_string(&buf, mainIp));
168     return false;               /* no duplicate */
169   } else if (diff < 32) {
170     entry->array <<= (uint32_t) diff;
171   } else {
172     entry->array = 0;
173   }
174   entry->array |= 1;
175   entry->seqnr = seqnr;
176   OLSR_PRINTF(9, "processed %x from %s\n", seqnr, olsr_ip_to_string(&buf, mainIp));
177   return false;                 /* no duplicate */
178 }
179
180 void
181 olsr_print_duplicate_table(void)
182 {
183 #ifndef NODEBUG
184   /* The whole function makes no sense without it. */
185   struct dup_entry *entry;
186   const int ipwidth = olsr_cnf->ip_version == AF_INET ? 15 : 30;
187   struct ipaddr_str addrbuf;
188
189   OLSR_PRINTF(1, "\n--- %s ------------------------------------------------- DUPLICATE SET\n\n" "%-*s %8s %s\n",
190               olsr_wallclock_string(), ipwidth, "Node IP", "DupArray", "VTime");
191
192   OLSR_FOR_ALL_DUP_ENTRIES(entry) {
193     OLSR_PRINTF(1, "%-*s %08x %s\n", ipwidth, olsr_ip_to_string(&addrbuf, (union olsr_ip_addr *)(entry->avl.key)),
194                 entry->array, olsr_clock_string(entry->valid_until));
195   } OLSR_FOR_ALL_DUP_ENTRIES_END(entry);
196 #endif
197 }
198
199 /*
200  * Local Variables:
201  * c-basic-offset: 2
202  * indent-tabs-mode: nil
203  * End:
204  */