new etx_ff (freifunk) routing plugin
[olsrd.git] / src / duplicate_set.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3 <<<<<<< /home/rogge/develop/olsrd/olsrd-linkset-refactoring/src/duplicate_set.c
4  * Copyright (c) 2008 Henning Rogge <rogge@fgan.de>
5 =======
6  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
7  * Copyright (c) 2008 Henning Rogge <rogge@fgan.de>
8 >>>>>>> /tmp/duplicate_set.c~other.bvK6d3
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without 
12  * modification, are permitted provided that the following conditions 
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright 
16  *   notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright 
18  *   notice, this list of conditions and the following disclaimer in 
19  *   the documentation and/or other materials provided with the 
20  *   distribution.
21  * * Neither the name of olsr.org, olsrd nor the names of its 
22  *   contributors may be used to endorse or promote products derived 
23  *   from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  * Visit http://www.olsr.org for more information.
39  *
40  * If you find this software useful feel free to make a donation
41  * to the project. For more information see the website or contact
42  * the copyright holders.
43  *
44  */
45
46 #include "duplicate_set.h"
47 #include "ipcalc.h"
48 #include "common/avl.h"
49 #include "olsr.h"
50 #include "mid_set.h"
51 #include "scheduler.h"
52 #include "mantissa.h"
53
54 static void olsr_cleanup_duplicate_entry(void *unused);
55
56 struct avl_tree duplicate_set;
57 struct timer_entry *duplicate_cleanup_timer;
58
59
60 void olsr_init_duplicate_set(void) {
61   avl_init(&duplicate_set, olsr_cnf->ip_version == AF_INET ? &avl_comp_ipv4 : &avl_comp_ipv6);
62   
63   olsr_set_timer(&duplicate_cleanup_timer, DUPLICATE_CLEANUP_INTERVAL,
64      DUPLICATE_CLEANUP_JITTER, OLSR_TIMER_PERIODIC,
65      &olsr_cleanup_duplicate_entry, NULL, 0);
66 }
67
68 struct dup_entry *olsr_create_duplicate_entry(void *ip, olsr_u16_t seqnr) {
69   struct dup_entry *entry;
70   entry = olsr_malloc(sizeof(struct dup_entry), "New duplicate entry");
71   if (entry != NULL) {
72     memcpy (&entry->ip, ip, olsr_cnf->ip_version == AF_INET ? sizeof(entry->ip.v4) : sizeof(entry->ip.v6)); 
73     entry->seqnr = seqnr;
74     entry->too_low_counter = 0;
75     entry->avl.key = &entry->ip;
76   }
77   return entry;
78 }
79
80 static void olsr_cleanup_duplicate_entry(void __attribute__ ((unused)) *unused) {
81   struct dup_entry *entry;
82   
83   OLSR_FOR_ALL_DUP_ENTRIES(entry) {
84     if (TIMED_OUT(entry->valid_until)) {
85       avl_delete(&duplicate_set, &entry->avl);
86       free (entry);
87     }
88   } OLSR_FOR_ALL_DUP_ENTRIES_END(entry);
89 }
90
91 int olsr_shall_process_message(void *ip, olsr_u16_t seqnr) {
92   struct dup_entry *entry;
93   int diff;
94   void *mainIp;
95   clock_t valid_until;
96   
97 #ifndef NODEBUG
98   struct ipaddr_str buf;
99 #endif  
100   // get main address
101   mainIp = mid_lookup_main_addr(ip);
102   if (mainIp == NULL) {
103     mainIp = ip;
104   }
105   
106   valid_until = GET_TIMESTAMP(DUPLICATE_VTIME);
107   
108   entry = (struct dup_entry *)avl_find(&duplicate_set, ip);
109   if (entry == NULL) {
110     entry = olsr_create_duplicate_entry(ip, seqnr);
111     if (entry != NULL) {
112       avl_insert(&duplicate_set, &entry->avl, 0);
113       entry->valid_until = valid_until;
114     }
115     return 1; // okay, we process this package
116   }
117
118   diff = (int)seqnr - (int)(entry->seqnr);
119   
120   // update timestamp
121   if (valid_until > entry->valid_until) {
122     entry->valid_until = valid_until;
123   }
124   
125   // overflow ?
126   if (diff > (1<<15)) {
127     diff -= (1<<16);
128   }
129   
130   if (diff < -31) {
131     entry->too_low_counter ++;
132     
133     // client did restart with a lower number ?
134     if (entry->too_low_counter > 16) {
135       entry->too_low_counter = 0;
136       entry->seqnr = seqnr;
137       entry->array = 1;
138       return 1;
139     }
140     OLSR_PRINTF(9, "blocked %x from %s\n", seqnr, olsr_ip_to_string(&buf, mainIp));
141     return 0;
142   }
143   
144   entry->too_low_counter = 0;
145   if (diff <= 0) {
146     olsr_u32_t bitmask = 1 << ((olsr_u32_t) (-diff));
147     
148     if ((entry->array & bitmask) != 0) {
149       OLSR_PRINTF(9, "blocked %x (diff=%d,mask=%08x) from %s\n", seqnr, diff, entry->array, olsr_ip_to_string(&buf, mainIp));
150       return 0;
151     }
152     entry->array |= bitmask;
153     OLSR_PRINTF(9, "processed %x from %s\n", seqnr, olsr_ip_to_string(&buf, mainIp));
154     return 1;
155   }
156   else if (diff < 32) {
157     entry->array <<= (olsr_u32_t)diff;
158   }
159   else {
160     entry->array = 0;
161   }
162   entry->array |= 1;
163   entry->seqnr = seqnr;
164   OLSR_PRINTF(9, "processed %x from %s\n", seqnr, olsr_ip_to_string(&buf, mainIp));
165   return 1;
166 }
167
168 void olsr_print_duplicate_table(void) {
169 #ifndef NODEBUG
170   /* The whole function makes no sense without it. */
171   struct dup_entry *entry;
172   const int ipwidth = olsr_cnf->ip_version == AF_INET ? 15 : 30;
173   struct ipaddr_str addrbuf;
174   
175   OLSR_PRINTF(1,
176         "\n--- %s ------------------------------------------------- DUPLICATE SET\n\n"
177         "%-*s %8s %s\n", olsr_wallclock_string(), ipwidth,
178         "Node IP", "DupArray", "VTime");
179
180   OLSR_FOR_ALL_DUP_ENTRIES(entry) {
181     OLSR_PRINTF(1, "%-*s %08x %s\n",
182         ipwidth, olsr_ip_to_string(&addrbuf, (union olsr_ip_addr *)(entry->avl.key)),
183         entry->array,
184         olsr_clock_string(entry->valid_until));
185   } OLSR_FOR_ALL_DUP_ENTRIES_END(entry);
186 #endif
187 }