rename neighbor and neighbor2_list entry, preparation for neighbor refactoring
[olsrd.git] / src / mid_set.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
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 "net_olsr.h"
52 #include "olsr_cookie.h"
53 #include "olsr_logging.h"
54
55 #include <stdlib.h>
56
57 static struct mid_entry *olsr_lookup_mid_entry(const union olsr_ip_addr *);
58 static void olsr_prune_mid_entries(const union olsr_ip_addr *main_addr, uint16_t mid_seqno);
59
60 /* Root of the MID tree */
61 struct avl_tree mid_tree;
62
63 /* Some cookies for stats keeping */
64 static struct olsr_cookie_info *mid_validity_timer_cookie = NULL;
65 static struct olsr_cookie_info *mid_address_mem_cookie = NULL;
66
67 /**
68  * Initialize the MID set
69  */
70 void
71 olsr_init_mid_set(void)
72 {
73   OLSR_INFO(LOG_MID, "Initialize MID set...\n");
74
75   avl_init(&mid_tree, avl_comp_default);
76
77   /*
78    * Get some cookies for getting stats to ease troubleshooting.
79    */
80   mid_validity_timer_cookie = olsr_alloc_cookie("MID validity", OLSR_COOKIE_TYPE_TIMER);
81
82   mid_address_mem_cookie = olsr_alloc_cookie("MID address", OLSR_COOKIE_TYPE_MEMORY);
83   olsr_cookie_set_memory_size(mid_address_mem_cookie, sizeof(struct mid_entry));
84 }
85
86 /**
87  * Wrapper for the timer callback.
88  */
89 static void
90 olsr_expire_mid_entries(void *context)
91 {
92   struct tc_entry *tc = context;
93 #if !defined REMOVE_LOG_DEBUG
94   struct ipaddr_str buf;
95 #endif
96
97   OLSR_DEBUG(LOG_MID, "MID aliases for %s timed out\n", olsr_ip_to_string(&buf, &tc->addr));
98
99   olsr_flush_mid_entries(tc);
100 }
101
102 /**
103  * Set the mid set expiration timer.
104  *
105  * all timer setting shall be done using this function.
106  * The timer param is a relative timer expressed in milliseconds.
107  */
108 static void
109 olsr_set_mid_timer(struct tc_entry *tc, olsr_reltime rel_timer)
110 {
111   olsr_set_timer(&tc->mid_timer, rel_timer, OLSR_MID_JITTER,
112                  OLSR_TIMER_ONESHOT, &olsr_expire_mid_entries, tc, mid_validity_timer_cookie->ci_id);
113 }
114
115 /**
116  * Delete possible duplicate entries in 2 hop set
117  * and delete duplicate neighbor entries. Redirect
118  * link entries to the correct neighbor entry.
119  * This optimization is not specified in rfc3626.
120  */
121 static void
122 olsr_flush_nbr2_duplicates(struct mid_entry *alias)
123 {
124   struct tc_entry *tc = alias->mid_tc;
125 #if !defined REMOVE_LOG_DEBUG
126   struct ipaddr_str buf1, buf2;
127 #endif
128
129   OLSR_FOR_ALL_TC_MID_ENTRIES(tc, alias) {
130     struct nbr_entry *nbr;
131     struct neighbor_2_entry *nbr2 = olsr_lookup_two_hop_neighbor_table_mid(&alias->mid_alias_addr);
132
133     /* Delete possible 2 hop neighbor */
134     if (nbr2) {
135       OLSR_DEBUG(LOG_MID, "Delete 2hop neighbor: %s to %s\n",
136                  olsr_ip_to_string(&buf1, &alias->mid_alias_addr), olsr_ip_to_string(&buf2, &tc->addr));
137
138       olsr_delete_two_hop_neighbor_table(nbr2);
139       changes_neighborhood = true;
140     }
141
142     /* Delete a possible neighbor entry */
143     nbr = olsr_lookup_neighbor_table_alias(&alias->mid_alias_addr);
144     if (nbr) {
145       struct nbr_entry *real_nbr = olsr_lookup_neighbor_table_alias(&tc->addr);
146       if (real_nbr) {
147
148         OLSR_DEBUG(LOG_MID, "Delete bogus neighbor entry %s (real %s)\n",
149                    olsr_ip_to_string(&buf1, &alias->mid_alias_addr), olsr_ip_to_string(&buf2, &tc->addr));
150
151         replace_neighbor_link_set(nbr, real_nbr);
152
153         /* Dequeue */
154         DEQUEUE_ELEM(nbr);
155         /* Delete */
156         free(nbr);
157
158         changes_neighborhood = true;
159       }
160     }
161   }
162   OLSR_FOR_ALL_TC_MID_ENTRIES_END(tc, mid_alias);
163 }
164
165 /**
166  * If we have an entry for this alias in neighbortable, we better adjust it's
167  * main address, because otherwise a fatal inconsistency between
168  * neighbortable and link_set will be created by way of this mid entry.
169  */
170 static void
171 olsr_fixup_mid_main_addr(const union olsr_ip_addr *main_addr, const union olsr_ip_addr *alias_addr)
172 {
173   struct nbr_entry *nbr_new, *nbr_old = olsr_lookup_neighbor_table_alias(alias_addr);
174   struct mid_entry *mid_old;
175   int ne_ref_rp_count;
176 #if !defined REMOVE_LOG_DEBUG
177   struct ipaddr_str buf1, buf2;
178 #endif
179
180   if (!nbr_old) {
181     return;
182   }
183
184   OLSR_DEBUG(LOG_MID, "Main address change %s -> %s detected.\n",
185              olsr_ip_to_string(&buf1, alias_addr), olsr_ip_to_string(&buf2, main_addr));
186
187   olsr_delete_neighbor_table(alias_addr);
188   nbr_new = olsr_insert_neighbor_table(main_addr);
189
190   /* Adjust pointers to neighbortable-entry in link_set */
191   ne_ref_rp_count = replace_neighbor_link_set(nbr_old, nbr_new);
192
193   if (ne_ref_rp_count > 0) {
194     OLSR_DEBUG(LOG_MID, "Performed %d neighbortable-pointer replacements "
195                "(%p -> %p) in link_set.\n", ne_ref_rp_count, nbr_old, nbr_new);
196   }
197
198   mid_old = olsr_lookup_mid_entry(alias_addr);
199   if (mid_old) {
200     /*
201      * We knew aliases to the previous main address.
202      * Better forget about them now.
203      */
204     OLSR_DEBUG(LOG_MID, "Flush aliases for old main address.\n");
205     olsr_flush_mid_entries(mid_old->mid_tc);
206   }
207 }
208
209 /**
210  * Insert a fresh alias address for a node.
211  *
212  * @param main_add the main address of the node
213  * @param alias the alias address to insert
214  * @param vtime the validity time
215  * @param seq the sequence number to register a new node with
216  */
217 static struct mid_entry *
218 olsr_insert_mid_entry(const union olsr_ip_addr *main_addr,
219                       const union olsr_ip_addr *alias_addr, olsr_reltime vtime, uint16_t mid_seqno)
220 {
221   struct tc_entry *tc;
222   struct mid_entry *alias;
223 #if !defined REMOVE_LOG_DEBUG
224   struct ipaddr_str buf1, buf2;
225 #endif
226
227   OLSR_DEBUG(LOG_MID, "Inserting alias %s for %s\n", olsr_ip_to_string(&buf1, alias_addr), olsr_ip_to_string(&buf2, main_addr));
228
229   /*
230    * Locate first the hookup point
231    */
232   tc = olsr_locate_tc_entry(main_addr);
233
234   alias = olsr_cookie_malloc(mid_address_mem_cookie);
235   alias->mid_alias_addr = *alias_addr;
236   alias->mid_tc = tc;
237   olsr_lock_tc_entry(tc);
238
239   /*
240    * Insert into the per-tc mid subtree.
241    */
242   alias->mid_tc_node.key = &alias->mid_alias_addr;
243   avl_insert(&tc->mid_tree, &alias->mid_tc_node, AVL_DUP_NO);
244
245   /*
246    * Insert into the global mid tree.
247    */
248   alias->mid_node.key = &alias->mid_alias_addr;
249   avl_insert(&mid_tree, &alias->mid_node, AVL_DUP_NO);
250
251   /*
252    * Add a rt_path for the alias.
253    */
254   olsr_insert_routing_table(&alias->mid_alias_addr, 8 * olsr_cnf->ipsize, main_addr, OLSR_RT_ORIGIN_MID);
255
256   /*
257    * Start the timer. Because we provide the TC reference
258    * as callback data for the timer we need to lock
259    * the underlying TC entry again.
260    */
261   olsr_set_mid_timer(alias->mid_tc, vtime);
262   olsr_lock_tc_entry(tc);
263
264   /* Set sequence number for alias purging */
265   alias->mid_seqno = mid_seqno;
266
267   return alias;
268 }
269
270 /**
271  * Update an alias address for a node.
272  * If the main address is not registered
273  * then a new entry is created.
274  *
275  * @param main_add the main address of the node
276  * @param alias the alias address to insert
277  * @param vtime the validity time
278  * @param seq the sequence number to register a new node with
279  */
280 static void
281 olsr_update_mid_entry(const union olsr_ip_addr *main_addr,
282                       const union olsr_ip_addr *alias_addr, olsr_reltime vtime, uint16_t mid_seqno)
283 {
284   struct mid_entry *alias;
285
286   if (!olsr_validate_address(alias_addr)) {
287     return;
288   }
289
290   /*
291    * Check first if the alias already exists.
292    */
293   alias = olsr_lookup_mid_entry(alias_addr);
294   if (alias) {
295     /* Update sequence number for alias purging */
296     alias->mid_seqno = mid_seqno;
297
298     /* XXX handle main IP address changes */
299
300     /* Refresh the timer. */
301     olsr_set_mid_timer(alias->mid_tc, vtime);
302     return;
303   }
304
305   /*
306    * This is a fresh alias.
307    */
308   alias = olsr_insert_mid_entry(main_addr, alias_addr, vtime, mid_seqno);
309
310   /*
311    * Do the needful if one of our neighbors has changed its main address.
312    */
313   olsr_fixup_mid_main_addr(main_addr, alias_addr);
314   olsr_flush_nbr2_duplicates(alias);
315
316   /*
317    * Recalculate topology.
318    */
319   changes_neighborhood = true;
320   changes_topology = true;
321 }
322
323 /**
324  * Lookup a MID alias hanging off a tc_entry by address
325  *
326  * @param adr the alias address to check
327  * @return the MID address entry or NULL if not found
328  */
329 struct mid_entry *
330 olsr_lookup_tc_mid_entry(struct tc_entry *tc, const union olsr_ip_addr *adr)
331 {
332   return (alias_tree2mid(avl_find(&tc->mid_tree, adr)));
333 }
334
335 /**
336  * Lookup an MID alias by address in the global tree.
337  *
338  * @param adr the alias address to check
339  * @return the MID address entry or NULL if not found
340  */
341 static struct mid_entry *
342 olsr_lookup_mid_entry(const union olsr_ip_addr *adr)
343 {
344   return (global_tree2mid(avl_find(&mid_tree, adr)));
345 }
346
347 /**
348  * Lookup the main address for an MID alias address
349  *
350  * @param adr the alias address to check
351  * @return the main address registered on the alias
352  * or NULL if not found
353  */
354 union olsr_ip_addr *
355 olsr_lookup_main_addr_by_alias(const union olsr_ip_addr *adr)
356 {
357   struct mid_entry *alias;
358
359   alias = olsr_lookup_mid_entry(adr);
360
361   return (alias ? &alias->mid_tc->addr : NULL);
362 }
363
364 /**
365  * Delete a single MID alias.
366  *
367  * @param alias the alias to delete.
368  */
369 void
370 olsr_delete_mid_entry(struct mid_entry *alias)
371 {
372   struct tc_entry *tc;
373
374   tc = alias->mid_tc;
375
376   /*
377    * Delete the rt_path for the alias.
378    */
379   olsr_delete_routing_table(&alias->mid_alias_addr, 8 * olsr_cnf->ipsize, &tc->addr, OLSR_RT_ORIGIN_MID);
380
381   /*
382    * Remove from the per-tc tree.
383    */
384   avl_delete(&tc->mid_tree, &alias->mid_tc_node);
385
386   /*
387    * Remove from the global tree.
388    */
389   avl_delete(&mid_tree, &alias->mid_node);
390
391   olsr_unlock_tc_entry(tc);
392
393   olsr_cookie_free(mid_address_mem_cookie, alias);
394 }
395
396 /**
397  * Delete all the MID aliases hanging off a tc entry.
398  *
399  * @param entry the tc entry holding the aliases.
400  */
401 void
402 olsr_flush_mid_entries(struct tc_entry *tc)
403 {
404   struct mid_entry *alias;
405
406   OLSR_FOR_ALL_TC_MID_ENTRIES(tc, alias) {
407     olsr_delete_mid_entry(alias);
408   } OLSR_FOR_ALL_TC_MID_ENTRIES_END(tc, alias);
409
410   /*
411    * Kill any pending timers.
412    */
413   olsr_set_mid_timer(tc, 0);
414   olsr_unlock_tc_entry(tc);
415 }
416
417 /**
418  * Remove aliases from 'entry' which are not matching
419  * the most recent message sequence number. This gets
420  * called after receiving a MID message for garbage
421  * collection of the old entries.
422  *
423  * @param main_addr the root of MID entries.
424  * @param mid_seqno the most recent message sequence number
425  */
426 static void
427 olsr_prune_mid_entries(const union olsr_ip_addr *main_addr, uint16_t mid_seqno)
428 {
429   struct tc_entry *tc = olsr_locate_tc_entry(main_addr);
430   struct mid_entry *alias;
431   OLSR_FOR_ALL_TC_MID_ENTRIES(tc, alias) {
432     if (alias->mid_seqno != mid_seqno) {
433       olsr_delete_mid_entry(alias);
434     }
435   }
436   OLSR_FOR_ALL_TC_MID_ENTRIES_END(tc, alias);
437 }
438
439 /**
440  * Print all MID entries
441  * For debuging purposes
442  */
443 void
444 olsr_print_mid_set(void)
445 {
446 #if !defined REMOVE_LOG_INFO
447   struct tc_entry *tc;
448   struct mid_entry *alias;
449   struct ipaddr_str buf1, buf2;
450
451   OLSR_INFO(LOG_MID, "\n--- %s ------------------------------------------------- MID\n\n", olsr_wallclock_string());
452
453   OLSR_FOR_ALL_TC_ENTRIES(tc) {
454     bool first = true;
455     OLSR_FOR_ALL_TC_MID_ENTRIES(tc, alias) {
456       OLSR_INFO_NH(LOG_MID, "%-15s: %s\n",
457                    first ? olsr_ip_to_string(&buf1, &tc->addr) : "", olsr_ip_to_string(&buf2, &alias->mid_alias_addr));
458       first = false;
459     } OLSR_FOR_ALL_TC_MID_ENTRIES_END(tc, alias);
460   } OLSR_FOR_ALL_TC_ENTRIES_END(tc);
461 #endif
462 }
463
464 /**
465  * Process an incoming MID message.
466  */
467 bool
468 olsr_input_mid(union olsr_message *msg, struct interface *input_if __attribute__ ((unused)), union olsr_ip_addr *from_addr)
469 {
470   uint16_t msg_size, msg_seq;
471   uint8_t type, ttl, msg_hops;
472   const unsigned char *curr;
473   olsr_reltime vtime;
474   union olsr_ip_addr originator, alias;
475   int alias_count;
476 #if !defined REMOVE_LOG_DEBUG
477   struct ipaddr_str buf;
478 #endif
479
480   curr = (void *)msg;
481   if (!msg) {
482     return false;
483   }
484
485   /* We are only interested in MID message types. */
486   pkt_get_u8(&curr, &type);
487   if (type != MID_MESSAGE) {
488     return false;
489   }
490
491   pkt_get_reltime(&curr, &vtime);
492   pkt_get_u16(&curr, &msg_size);
493
494   pkt_get_ipaddress(&curr, &originator);
495
496   /* Copy header values */
497   pkt_get_u8(&curr, &ttl);
498   pkt_get_u8(&curr, &msg_hops);
499   pkt_get_u16(&curr, &msg_seq);
500
501   if (!olsr_validate_address(&originator)) {
502     return false;
503   }
504
505   /*
506    * If the sender interface (NB: not originator) of this message
507    * is not in the symmetric 1-hop neighborhood of this node, the
508    * message MUST be discarded.
509    */
510   if (check_neighbor_link(from_addr) != SYM_LINK) {
511     OLSR_DEBUG(LOG_MID, "Received MID from NON SYM neighbor %s\n", olsr_ip_to_string(&buf, from_addr));
512     return false;
513   }
514
515
516   /*
517    * How many aliases ?
518    */
519   alias_count = (msg_size - 12) / olsr_cnf->ipsize;
520
521   OLSR_DEBUG(LOG_MID, "Processing MID from %s with %d aliases, seq 0x%04x\n",
522              olsr_ip_to_string(&buf, &originator), alias_count, msg_seq);
523   /*
524    * Now walk the list of alias advertisements one by one.
525    */
526   while (alias_count) {
527     pkt_get_ipaddress(&curr, &alias);
528     olsr_update_mid_entry(&originator, &alias, vtime, msg_seq);
529     alias_count--;
530   }
531
532   /*
533    * Prune the aliases that did not get refreshed by this advertisment.
534    */
535   olsr_prune_mid_entries(&originator, msg_seq);
536
537   /* Forward the message */
538   return true;
539 }
540
541 /*
542  * Local Variables:
543  * c-basic-offset: 2
544  * indent-tabs-mode: nil
545  * End:
546  */