* killed lots of #ifdef ... #endif which make the source quite unreadable
[olsrd.git] / src / mid_set.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
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 "ipcalc.h"
43 #include "defs.h"
44 #include "two_hop_neighbor_table.h"
45 #include "mid_set.h"
46 #include "olsr.h"
47 #include "scheduler.h"
48 #include "neighbor_table.h"
49 #include "link_set.h"
50 #include "tc_set.h"
51 #include "packet.h"             /* struct mid_alias */
52 #include "net_olsr.h"
53
54
55 struct mid_entry mid_set[HASHSIZE];
56 struct mid_address reverse_mid_set[HASHSIZE];
57
58 struct mid_entry *mid_lookup_entry_bymain(const union olsr_ip_addr *adr);
59
60 /**
61  * Initialize the MID set
62  *
63  */
64 int
65 olsr_init_mid_set(void)
66 {
67   int idx;
68
69   OLSR_PRINTF(5, "MID: init\n");
70
71   for (idx = 0; idx < HASHSIZE; idx++) {
72     mid_set[idx].next = &mid_set[idx];
73     mid_set[idx].prev = &mid_set[idx];
74
75     reverse_mid_set[idx].next = &reverse_mid_set[idx];
76     reverse_mid_set[idx].prev = &reverse_mid_set[idx];
77   }
78
79   return 1;
80 }
81
82 /**
83  * Wrapper for the timer callback.
84  */
85 static void
86 olsr_expire_mid_entry(void *context)
87 {
88 #ifdef DEBUG
89   struct ipaddr_str buf;
90 #endif
91   struct mid_entry *mid;
92
93   mid = (struct mid_entry *)context;
94   mid->mid_timer = NULL;
95
96 #ifdef DEBUG
97   OLSR_PRINTF(1, "MID info for %s timed out.. deleting it\n",
98               olsr_ip_to_string(&buf, &mid->main_addr));
99 #endif
100
101   olsr_delete_mid_entry(mid);
102 }
103
104
105 /**
106  * Set the mid set expiration timer.
107  *
108  * all timer setting shall be done using this function.
109  * The timer param is a relative timer expressed in milliseconds.
110  */
111 static void
112 olsr_set_mid_timer(struct mid_entry *mid, olsr_reltime rel_timer)
113 {
114
115   olsr_set_timer(&mid->mid_timer, rel_timer, OLSR_MID_JITTER,
116                  OLSR_TIMER_ONESHOT, &olsr_expire_mid_entry, mid, 0);
117 }
118
119
120 /**
121  * Insert a new interface alias to the interface association set.
122  * If the main interface of the association is not yet registered
123  * in the set a new entry is created.
124  *
125  * @param m_addr the main address of the node
126  * @param alias the alias address to insert
127  * @return nada
128  */
129
130 void
131 insert_mid_tuple(union olsr_ip_addr *m_addr, struct mid_address *alias,
132                  olsr_reltime vtime)
133 {
134   struct mid_entry *tmp;
135   struct mid_address *tmp_adr;
136   olsr_u32_t hash, alias_hash;
137   union olsr_ip_addr *registered_m_addr;
138
139   hash = olsr_ip_hashing(m_addr);
140   alias_hash = olsr_ip_hashing(&alias->alias);
141
142   /* Check for registered entry */
143   for (tmp = mid_set[hash].next; tmp != &mid_set[hash]; tmp = tmp->next) {
144     if (ipequal(&tmp->main_addr, m_addr))
145       break;
146   }
147
148   /* Check if alias is already registered with m_addr */
149   registered_m_addr = mid_lookup_main_addr(&alias->alias);
150   if (registered_m_addr != NULL && ipequal(registered_m_addr, m_addr)) {
151
152     /* Alias is already registered with main address. Nothing to do here. */
153     return;
154   }
155
156   /*
157    * Add a rt_path for the alias.
158    */
159   olsr_insert_routing_table(&alias->alias, olsr_cnf->maxplen, m_addr,
160                             OLSR_RT_ORIGIN_MID);
161
162   /*If the address was registered */
163   if (tmp != &mid_set[hash]) {
164     tmp_adr = tmp->aliases;
165     tmp->aliases = alias;
166     alias->main_entry = tmp;
167     QUEUE_ELEM(reverse_mid_set[alias_hash], alias);
168     alias->next_alias = tmp_adr;
169     olsr_set_mid_timer(tmp, vtime);
170   } else {
171
172     /*Create new node */
173     tmp = olsr_malloc(sizeof(struct mid_entry), "MID new alias");
174
175     tmp->aliases = alias;
176     alias->main_entry = tmp;
177     QUEUE_ELEM(reverse_mid_set[alias_hash], alias);
178     tmp->main_addr = *m_addr;
179     olsr_set_mid_timer(tmp, vtime);
180
181     /* Queue */
182     QUEUE_ELEM(mid_set[hash], tmp);
183   }
184
185
186
187   /*
188    * Delete possible duplicate entries in 2 hop set
189    * and delete duplicate neighbor entries. Redirect
190    * link entries to the correct neighbor entry.
191    *
192    *THIS OPTIMIZATION IS NOT SPECIFIED IN RFC3626
193    */
194
195   tmp_adr = alias;
196
197   while (tmp_adr) {
198     struct neighbor_2_entry *tmp_2_neighbor;
199     struct neighbor_entry *tmp_neigh, *real_neigh;
200
201     /* Delete possible 2 hop neighbor */
202     if ((tmp_2_neighbor =
203          olsr_lookup_two_hop_neighbor_table_mid(&tmp_adr->alias)) != NULL) {
204       struct ipaddr_str buf;
205       OLSR_PRINTF(1, "Deleting 2 hop node from MID: %s to ",
206                   olsr_ip_to_string(&buf, &tmp_adr->alias));
207       OLSR_PRINTF(1, "%s\n", olsr_ip_to_string(&buf, m_addr));
208
209       olsr_delete_two_hop_neighbor_table(tmp_2_neighbor);
210
211       changes_neighborhood = OLSR_TRUE;
212     }
213
214     /* Delete a possible neighbor entry */
215     if (((tmp_neigh =
216           olsr_lookup_neighbor_table_alias(&tmp_adr->alias)) != NULL)
217         && ((real_neigh = olsr_lookup_neighbor_table_alias(m_addr)) != NULL))
218     {
219       struct ipaddr_str buf;
220       OLSR_PRINTF(1, "[MID]Deleting bogus neighbor entry %s real ",
221                   olsr_ip_to_string(&buf, &tmp_adr->alias));
222       OLSR_PRINTF(1, "%s\n", olsr_ip_to_string(&buf, m_addr));
223
224       replace_neighbor_link_set(tmp_neigh, real_neigh);
225
226       /* Dequeue */
227       DEQUEUE_ELEM(tmp_neigh);
228       /* Delete */
229       free(tmp_neigh);
230
231       changes_neighborhood = OLSR_TRUE;
232     }
233     tmp_adr = tmp_adr->next_alias;
234   }
235 }
236
237
238 /**
239  * Insert an alias address for a node.
240  * If the main address is not registered
241  * then a new entry is created.
242  *
243  * @param main_add the main address of the node
244  * @param alias the alias address to insert
245  * @param seq the sequence number to register a new node with
246  * @return nada
247  */
248 void
249 insert_mid_alias(union olsr_ip_addr *main_add, const union olsr_ip_addr *alias,
250                  olsr_reltime vtime)
251 {
252   struct neighbor_entry *ne_old, *ne_new;
253   struct mid_entry *me_old;
254   int ne_ref_rp_count;
255   struct ipaddr_str buf1, buf2;
256   struct mid_address *adr;
257   if (!olsr_validate_address(alias))
258     return;
259
260   OLSR_PRINTF(1, "Inserting alias %s for ", olsr_ip_to_string(&buf1, alias));
261   OLSR_PRINTF(1, "%s\n", olsr_ip_to_string(&buf1, main_add));
262
263   adr = olsr_malloc(sizeof(struct mid_address), "Insert MID alias");
264
265   adr->alias = *alias;
266   adr->next_alias = NULL;
267
268   /*
269    * If we have an entry for this alias in neighbortable, we better adjust it's
270    * main address, because otherwise a fatal inconsistency between
271    * neighbortable and link_set will be created by way of this mid entry.
272    */
273   ne_old = olsr_lookup_neighbor_table_alias(alias);
274   if (ne_old != NULL) {
275     OLSR_PRINTF(2,
276                 "Remote main address change detected. Mangling neighbortable to replace %s with %s.\n",
277                 olsr_ip_to_string(&buf1, alias), olsr_ip_to_string(&buf2,
278                                                                    main_add));
279     olsr_delete_neighbor_table(alias);
280     ne_new = olsr_insert_neighbor_table(main_add);
281     /* adjust pointers to neighbortable-entry in link_set */
282     ne_ref_rp_count = replace_neighbor_link_set(ne_old, ne_new);
283     if (ne_ref_rp_count > 0)
284       OLSR_PRINTF(2,
285                   "Performed %d neighbortable-pointer replacements (%p -> %p) in link_set.\n",
286                   ne_ref_rp_count, ne_old, ne_new);
287
288     me_old = mid_lookup_entry_bymain(alias);
289     if (me_old) {
290
291       /* 
292        * we knew aliases to the previous main address;
293        * better forget about them now.
294        */
295       OLSR_PRINTF(2, "I already have an mid entry mapping addresses to this "
296                   "alias address. Removing existing mid entry to preserve consistency of mid_set.\n");
297       olsr_delete_mid_entry(me_old);
298     }
299   }
300
301   insert_mid_tuple(main_add, adr, vtime);
302
303   /*
304    *Recalculate topology
305    */
306   changes_neighborhood = OLSR_TRUE;
307   changes_topology = OLSR_TRUE;
308 }
309
310 /**
311  * Lookup the main address for a alias address
312  *
313  * @param adr the alias address to check
314  * @return the main address registered on the alias
315  * or NULL if not found
316  */
317 union olsr_ip_addr *
318 mid_lookup_main_addr(const union olsr_ip_addr *adr)
319 {
320   olsr_u32_t hash;
321   struct mid_address *tmp_list;
322
323   hash = olsr_ip_hashing(adr);
324
325   /*Traverse MID list */
326   for (tmp_list = reverse_mid_set[hash].next;
327        tmp_list != &reverse_mid_set[hash]; tmp_list = tmp_list->next) {
328     if (ipequal(&tmp_list->alias, adr))
329       return &tmp_list->main_entry->main_addr;
330   }
331   return NULL;
332
333 }
334
335 /*
336  * Find mid entry to an address.
337  *
338  * @param adr the main address to search for
339  * @return a linked list of address structs
340  */
341 struct mid_entry *
342 mid_lookup_entry_bymain(const union olsr_ip_addr *adr)
343 {
344   struct mid_entry *tmp_list;
345   olsr_u32_t hash;
346
347   hash = olsr_ip_hashing(adr);
348
349   /* Check all registered nodes... */
350   for (tmp_list = mid_set[hash].next;
351        tmp_list != &mid_set[hash]; tmp_list = tmp_list->next) {
352     if (ipequal(&tmp_list->main_addr, adr))
353       return tmp_list;
354   }
355   return NULL;
356 }
357
358 /*
359  * Find all aliases for an address.
360  *
361  * @param adr the main address to search for
362  * @return a linked list of addresses structs
363  */
364 struct mid_address *
365 mid_lookup_aliases(const union olsr_ip_addr *adr)
366 {
367   struct mid_entry *tmp = mid_lookup_entry_bymain(adr);
368   return tmp ? tmp->aliases : NULL;
369 }
370
371
372 /**
373  * Update the timer for an MID entry
374  *
375  * @param adr the main address of the entry
376  * @return 1 if the node was updated, 0 if not
377  */
378 int
379 olsr_update_mid_table(const union olsr_ip_addr *adr, olsr_reltime vtime)
380 {
381   olsr_u32_t hash;
382   struct ipaddr_str buf;
383   struct mid_entry *tmp_list = mid_set;
384
385   OLSR_PRINTF(3, "MID: update %s\n", olsr_ip_to_string(&buf, adr));
386   hash = olsr_ip_hashing(adr);
387
388   /* Check all registered nodes... */
389   for (tmp_list = mid_set[hash].next;
390        tmp_list != &mid_set[hash]; tmp_list = tmp_list->next) {
391     /*find match */
392     if (ipequal(&tmp_list->main_addr, adr)) {
393       olsr_set_mid_timer(tmp_list, vtime);
394
395       return 1;
396     }
397   }
398   return 0;
399 }
400
401
402 /**
403  * Remove aliases from 'entry' which are not listed in 'declared_aliases'.
404  *
405  * @param entry the MID entry
406  * @param declared_aliases the list of declared aliases for the MID entry
407  * @return nada
408  */
409 void
410 olsr_prune_aliases(const union olsr_ip_addr *m_addr,
411                    struct mid_alias *declared_aliases)
412 {
413   struct mid_entry *entry;
414   olsr_u32_t hash;
415   struct mid_address *registered_aliases;
416   struct mid_address *previous_alias;
417   struct mid_alias *save_declared_aliases = declared_aliases;
418
419   hash = olsr_ip_hashing(m_addr);
420
421   /* Check for registered entry */
422   for (entry = mid_set[hash].next; entry != &mid_set[hash]; entry = entry->next) {
423     if (ipequal(&entry->main_addr, m_addr))
424       break;
425   }
426   if (entry == &mid_set[hash]) {
427     /* MID entry not found, nothing to prune here */
428     return;
429   }
430
431   registered_aliases = entry->aliases;
432   previous_alias = NULL;
433
434   while (registered_aliases != NULL) {
435     struct mid_address *current_alias = registered_aliases;
436     registered_aliases = registered_aliases->next_alias;
437
438     declared_aliases = save_declared_aliases;
439
440     /* Go through the list of declared aliases to find the matching current alias */
441     while (declared_aliases != 0 &&
442            !ipequal(&current_alias->alias, &declared_aliases->alias_addr)) {
443       declared_aliases = declared_aliases->next;
444     }
445
446     if (declared_aliases == NULL) {
447       struct ipaddr_str buf;
448       /* Current alias not found in list of declared aliases: free current alias */
449       OLSR_PRINTF(1, "MID remove: (%s, ",
450                   olsr_ip_to_string(&buf, &entry->main_addr));
451       OLSR_PRINTF(1, "%s)\n", olsr_ip_to_string(&buf, &current_alias->alias));
452
453       /* Update linked list as seen by 'entry' */
454       if (previous_alias != NULL) {
455         previous_alias->next_alias = current_alias->next_alias;
456       } else {
457         entry->aliases = current_alias->next_alias;
458       }
459
460       /* Remove from hash table */
461       DEQUEUE_ELEM(current_alias);
462
463       /*
464        * Delete the rt_path for the alias.
465        */
466       olsr_delete_routing_table(&current_alias->alias, olsr_cnf->maxplen,
467                                 &entry->main_addr);
468
469       free(current_alias);
470
471       /*
472        *Recalculate topology
473        */
474       changes_neighborhood = OLSR_TRUE;
475       changes_topology = OLSR_TRUE;
476     } else {
477       previous_alias = current_alias;
478     }
479   }
480 }
481
482
483 /**
484  * Delete a MID entry
485  *
486  * @param entry the entry to delete
487  */
488 void
489 olsr_delete_mid_entry(struct mid_entry *mid)
490 {
491   struct mid_address *aliases;
492
493   /* Free aliases */
494   aliases = mid->aliases;
495   while (aliases) {
496     struct mid_address *tmp_aliases = aliases;
497     aliases = aliases->next_alias;
498     DEQUEUE_ELEM(tmp_aliases);
499
500
501     /*
502      * Delete the rt_path for the alias.
503      */
504     olsr_delete_routing_table(&tmp_aliases->alias, olsr_cnf->maxplen,
505                               &mid->main_addr);
506
507     free(tmp_aliases);
508   }
509
510   /*
511    * Kill any pending timers.
512    */
513   if (mid->mid_timer) {
514     olsr_stop_timer(mid->mid_timer);
515     mid->mid_timer = NULL;
516   }
517
518   /* Dequeue */
519   DEQUEUE_ELEM(mid);
520   free(mid);
521 }
522
523
524 /**
525  * Print all MID entries
526  * For debuging purposes
527  */
528 void
529 olsr_print_mid_set(void)
530 {
531   int idx;
532
533   OLSR_PRINTF(1,
534               "\n--- %s ------------------------------------------------- MID\n\n",
535               olsr_wallclock_string());
536
537   for (idx = 0; idx < HASHSIZE; idx++) {
538     struct mid_entry *tmp_list = mid_set[idx].next;
539     /*Traverse MID list */
540     for (tmp_list = mid_set[idx].next; tmp_list != &mid_set[idx];
541          tmp_list = tmp_list->next) {
542       struct mid_address *tmp_addr;
543       struct ipaddr_str buf;
544       OLSR_PRINTF(1, "%s: ", olsr_ip_to_string(&buf, &tmp_list->main_addr));
545       for (tmp_addr = tmp_list->aliases; tmp_addr;
546            tmp_addr = tmp_addr->next_alias) {
547         OLSR_PRINTF(1, " %s ", olsr_ip_to_string(&buf, &tmp_addr->alias));
548       }
549       OLSR_PRINTF(1, "\n");
550     }
551   }
552 }
553
554 /*
555  * Local Variables:
556  * c-basic-offset: 2
557  * End:
558  */