6d1019ce6072907ed7b9cb270bf7dd9a0b044c50
[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,
261                 "Remote main address change detected. Mangling neighbortable to replace %s with %s.\n",
262                 olsr_ip_to_string(&buf1, alias), olsr_ip_to_string(&buf2, main_add));
263     olsr_delete_neighbor_table(alias);
264     ne_new = olsr_insert_neighbor_table(main_add);
265     /* adjust pointers to neighbortable-entry in link_set */
266     ne_ref_rp_count = replace_neighbor_link_set(ne_old, ne_new);
267     if (ne_ref_rp_count > 0)
268       OLSR_PRINTF(2, "Performed %d neighbortable-pointer replacements (%p -> %p) in link_set.\n", ne_ref_rp_count, ne_old, ne_new);
269
270     me_old = mid_lookup_entry_bymain(alias);
271     if (me_old) {
272
273       /*
274        * we knew aliases to the previous main address;
275        * better forget about them now.
276        */
277       OLSR_PRINTF(2,
278                   "I already have an mid entry mapping addresses to this "
279                   "alias address. Removing existing mid entry to preserve consistency of mid_set.\n");
280       olsr_delete_mid_entry(me_old);
281     }
282   }
283
284   insert_mid_tuple(main_add, adr, vtime);
285
286   /*
287    *Recalculate topology
288    */
289   changes_neighborhood = OLSR_TRUE;
290   changes_topology = OLSR_TRUE;
291 }
292
293 /**
294  * Lookup the main address for a alias address
295  *
296  * @param adr the alias address to check
297  * @return the main address registered on the alias
298  * or NULL if not found
299  */
300 union olsr_ip_addr *
301 mid_lookup_main_addr(const union olsr_ip_addr *adr)
302 {
303   olsr_u32_t hash;
304   struct mid_address *tmp_list;
305
306   hash = olsr_ip_hashing(adr);
307
308   /*Traverse MID list */
309   for (tmp_list = reverse_mid_set[hash].next; tmp_list != &reverse_mid_set[hash]; tmp_list = tmp_list->next) {
310     if (ipequal(&tmp_list->alias, adr))
311       return &tmp_list->main_entry->main_addr;
312   }
313   return NULL;
314
315 }
316
317 /*
318  * Find mid entry to an address.
319  *
320  * @param adr the main address to search for
321  * @return a linked list of address structs
322  */
323 struct mid_entry *
324 mid_lookup_entry_bymain(const union olsr_ip_addr *adr)
325 {
326   struct mid_entry *tmp_list;
327   olsr_u32_t hash;
328
329   hash = olsr_ip_hashing(adr);
330
331   /* Check all registered nodes... */
332   for (tmp_list = mid_set[hash].next; tmp_list != &mid_set[hash]; tmp_list = tmp_list->next) {
333     if (ipequal(&tmp_list->main_addr, adr))
334       return tmp_list;
335   }
336   return NULL;
337 }
338
339 /*
340  * Find all aliases for an address.
341  *
342  * @param adr the main address to search for
343  * @return a linked list of addresses structs
344  */
345 struct mid_address *
346 mid_lookup_aliases(const union olsr_ip_addr *adr)
347 {
348   struct mid_entry *tmp = mid_lookup_entry_bymain(adr);
349   return tmp ? tmp->aliases : NULL;
350 }
351
352 /**
353  * Update the timer for an MID entry
354  *
355  * @param adr the main address of the entry
356  * @return 1 if the node was updated, 0 if not
357  */
358 int
359 olsr_update_mid_table(const union olsr_ip_addr *adr, olsr_reltime vtime)
360 {
361   olsr_u32_t hash;
362   struct ipaddr_str buf;
363   struct mid_entry *tmp_list = mid_set;
364
365   OLSR_PRINTF(3, "MID: update %s\n", olsr_ip_to_string(&buf, adr));
366   hash = olsr_ip_hashing(adr);
367
368   /* Check all registered nodes... */
369   for (tmp_list = mid_set[hash].next; tmp_list != &mid_set[hash]; tmp_list = tmp_list->next) {
370     /*find match */
371     if (ipequal(&tmp_list->main_addr, adr)) {
372       olsr_set_mid_timer(tmp_list, vtime);
373
374       return 1;
375     }
376   }
377   return 0;
378 }
379
380 /**
381  * Remove aliases from 'entry' which are not listed in 'declared_aliases'.
382  *
383  * @param entry the MID entry
384  * @param declared_aliases the list of declared aliases for the MID entry
385  * @return nada
386  */
387 void
388 olsr_prune_aliases(const union olsr_ip_addr *m_addr, struct mid_alias *declared_aliases)
389 {
390   struct mid_entry *entry;
391   olsr_u32_t hash;
392   struct mid_address *registered_aliases;
393   struct mid_address *previous_alias;
394   struct mid_alias *save_declared_aliases = declared_aliases;
395
396   hash = olsr_ip_hashing(m_addr);
397
398   /* Check for registered entry */
399   for (entry = mid_set[hash].next; entry != &mid_set[hash]; entry = entry->next) {
400     if (ipequal(&entry->main_addr, m_addr))
401       break;
402   }
403   if (entry == &mid_set[hash]) {
404     /* MID entry not found, nothing to prune here */
405     return;
406   }
407
408   registered_aliases = entry->aliases;
409   previous_alias = NULL;
410
411   while (registered_aliases != NULL) {
412     struct mid_address *current_alias = registered_aliases;
413     registered_aliases = registered_aliases->next_alias;
414
415     declared_aliases = save_declared_aliases;
416
417     /* Go through the list of declared aliases to find the matching current alias */
418     while (declared_aliases != 0 && !ipequal(&current_alias->alias, &declared_aliases->alias_addr)) {
419       declared_aliases = declared_aliases->next;
420     }
421
422     if (declared_aliases == NULL) {
423       struct ipaddr_str buf;
424       /* Current alias not found in list of declared aliases: free current alias */
425       OLSR_PRINTF(1, "MID remove: (%s, ", olsr_ip_to_string(&buf, &entry->main_addr));
426       OLSR_PRINTF(1, "%s)\n", olsr_ip_to_string(&buf, &current_alias->alias));
427
428       /* Update linked list as seen by 'entry' */
429       if (previous_alias != NULL) {
430         previous_alias->next_alias = current_alias->next_alias;
431       } else {
432         entry->aliases = current_alias->next_alias;
433       }
434
435       /* Remove from hash table */
436       DEQUEUE_ELEM(current_alias);
437
438       /*
439        * Delete the rt_path for the alias.
440        */
441       olsr_delete_routing_table(&current_alias->alias, olsr_cnf->maxplen, &entry->main_addr);
442
443       free(current_alias);
444
445       /*
446        *Recalculate topology
447        */
448       changes_neighborhood = OLSR_TRUE;
449       changes_topology = OLSR_TRUE;
450     } else {
451       previous_alias = current_alias;
452     }
453   }
454 }
455
456 /**
457  * Delete a MID entry
458  *
459  * @param entry the entry to delete
460  */
461 void
462 olsr_delete_mid_entry(struct mid_entry *mid)
463 {
464   struct mid_address *aliases;
465
466   /* Free aliases */
467   aliases = mid->aliases;
468   while (aliases) {
469     struct mid_address *tmp_aliases = aliases;
470     aliases = aliases->next_alias;
471     DEQUEUE_ELEM(tmp_aliases);
472
473     /*
474      * Delete the rt_path for the alias.
475      */
476     olsr_delete_routing_table(&tmp_aliases->alias, olsr_cnf->maxplen, &mid->main_addr);
477
478     free(tmp_aliases);
479   }
480
481   /*
482    * Kill any pending timers.
483    */
484   if (mid->mid_timer) {
485     olsr_stop_timer(mid->mid_timer);
486     mid->mid_timer = NULL;
487   }
488
489   /* Dequeue */
490   DEQUEUE_ELEM(mid);
491   free(mid);
492 }
493
494 /**
495  * Print all MID entries
496  * For debuging purposes
497  */
498 void
499 olsr_print_mid_set(void)
500 {
501   int idx;
502
503   OLSR_PRINTF(1, "\n--- %s ------------------------------------------------- MID\n\n", olsr_wallclock_string());
504
505   for (idx = 0; idx < HASHSIZE; idx++) {
506     struct mid_entry *tmp_list = mid_set[idx].next;
507     /*Traverse MID list */
508     for (tmp_list = mid_set[idx].next; tmp_list != &mid_set[idx]; tmp_list = tmp_list->next) {
509       struct mid_address *tmp_addr;
510       struct ipaddr_str buf;
511       OLSR_PRINTF(1, "%s: ", olsr_ip_to_string(&buf, &tmp_list->main_addr));
512       for (tmp_addr = tmp_list->aliases; tmp_addr; tmp_addr = tmp_addr->next_alias) {
513         OLSR_PRINTF(1, " %s ", olsr_ip_to_string(&buf, &tmp_addr->alias));
514       }
515       OLSR_PRINTF(1, "\n");
516     }
517   }
518 }
519
520 /**
521  *Process a received(and parsed) MID message
522  *For every address check if there is a topology node
523  *registered with it and update its addresses.
524  *
525  *@param m the OLSR message received.
526  *@return 1 on success
527  */
528
529 void
530 olsr_input_mid(union olsr_message *m, struct interface *in_if __attribute__ ((unused)), union olsr_ip_addr *from_addr)
531 {
532 #ifdef DEBUG
533   struct ipaddr_str buf;
534 #endif
535   struct mid_alias *tmp_adr;
536   struct mid_message message;
537
538   mid_chgestruct(&message, m);
539
540   if (!olsr_validate_address(&message.mid_origaddr)) {
541     olsr_free_mid_packet(&message);
542     return;
543   }
544 #ifdef DEBUG
545   OLSR_PRINTF(5, "Processing MID from %s...\n", olsr_ip_to_string(&buf, &message.mid_origaddr));
546 #endif
547   tmp_adr = message.mid_addr;
548
549   /*
550    *      If the sender interface (NB: not originator) of this message
551    *      is not in the symmetric 1-hop neighborhood of this node, the
552    *      message MUST be discarded.
553    */
554
555   if (check_neighbor_link(from_addr) != SYM_LINK) {
556     struct ipaddr_str buf;
557     OLSR_PRINTF(2, "Received MID from NON SYM neighbor %s\n", olsr_ip_to_string(&buf, from_addr));
558     olsr_free_mid_packet(&message);
559     return;
560   }
561
562   /* Update the timeout of the MID */
563   olsr_update_mid_table(&message.mid_origaddr, message.vtime);
564
565   while (tmp_adr) {
566     if (!mid_lookup_main_addr(&tmp_adr->alias_addr)) {
567       struct ipaddr_str buf;
568       OLSR_PRINTF(1, "MID new: (%s, ", olsr_ip_to_string(&buf, &message.mid_origaddr));
569       OLSR_PRINTF(1, "%s)\n", olsr_ip_to_string(&buf, &tmp_adr->alias_addr));
570       insert_mid_alias(&message.mid_origaddr, &tmp_adr->alias_addr, message.vtime);
571     }
572     tmp_adr = tmp_adr->next;
573   }
574
575   olsr_prune_aliases(&message.mid_origaddr, message.mid_addr);
576   olsr_free_mid_packet(&message);
577 }
578
579 /*
580  * Local Variables:
581  * c-basic-offset: 2
582  * indent-tabs-mode: nil
583  * End:
584  */