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