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