Namespace cleanup of scheduler, remove "polling" sockets
[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 "mid_set.h"
45 #include "olsr.h"
46 #include "scheduler.h"
47 #include "neighbor_table.h"
48 #include "link_set.h"
49 #include "tc_set.h"
50 #include "net_olsr.h"
51 #include "olsr_memcookie.h"
52 #include "olsr_logging.h"
53 #include "olsr_protocol.h"
54
55 #include <assert.h>
56 #include <stdlib.h>
57
58 static struct mid_entry *olsr_lookup_mid_entry(const union olsr_ip_addr *);
59 static void olsr_expire_mid_entries(void *context);
60
61 /* Root of the MID tree */
62 struct avl_tree mid_tree;
63
64 /* validity timer of MID entries */
65 static struct olsr_memcookie_info *mid_address_mem_cookie = NULL;
66 static struct olsr_timer_info *mid_validity_timer_info = NULL;
67
68 /**
69  * Initialize the MID set
70  */
71 void
72 olsr_init_mid_set(void)
73 {
74   OLSR_INFO(LOG_MID, "Initialize MID set...\n");
75
76   avl_init(&mid_tree, avl_comp_default, false, NULL);
77
78   /*
79    * Get some cookies for getting stats to ease troubleshooting.
80    */
81   mid_validity_timer_info = olsr_timer_add("MID validity", &olsr_expire_mid_entries, false);
82
83   mid_address_mem_cookie = olsr_memcookie_add("MID address", 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 mid_entry *mid = 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, &mid->mid_alias_addr));
98
99   olsr_delete_mid_entry(mid);
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 mid_entry *mid, uint32_t rel_timer)
110 {
111   olsr_timer_set(&mid->mid_timer, rel_timer, OLSR_MID_JITTER, mid, mid_validity_timer_info);
112 }
113
114 /**
115  * Delete possible duplicate entries in tc set.
116  * This optimization is not specified in rfc3626.
117  */
118 static void
119 olsr_flush_tc_duplicates(struct mid_entry *alias) {
120   struct tc_entry *tc;
121   tc = olsr_lookup_tc_entry(&alias->mid_alias_addr);
122   if (tc) {
123     olsr_delete_tc_entry(tc);
124   }
125 }
126
127 /**
128  * Delete possible duplicate entries in 2 hop set
129  * and delete duplicate neighbor entries. Redirect
130  * link entries to the correct neighbor entry.
131  * This optimization is not specified in rfc3626.
132  */
133 static void
134 olsr_flush_nbr2_duplicates(struct tc_entry *tc)
135 {
136   struct mid_entry *alias, *iterator;
137 #if !defined REMOVE_LOG_DEBUG
138   struct ipaddr_str buf1, buf2;
139 #endif
140
141   OLSR_FOR_ALL_TC_MID_ENTRIES(tc, alias, iterator) {
142     struct nbr_entry *nbr;
143     struct nbr2_entry *nbr2 = olsr_lookup_nbr2_entry(&alias->mid_alias_addr, false);
144
145     /* Delete possible 2 hop neighbor */
146     if (nbr2) {
147       OLSR_DEBUG(LOG_MID, "Delete 2hop neighbor: %s to %s\n",
148                  olsr_ip_to_string(&buf1, &alias->mid_alias_addr), olsr_ip_to_string(&buf2, &tc->addr));
149
150       olsr_delete_nbr2_entry(nbr2);
151       changes_neighborhood = true;
152     }
153
154     /* Delete a possible neighbor entry */
155     nbr = olsr_lookup_nbr_entry(&alias->mid_alias_addr, false);
156     if (nbr) {
157       struct nbr_entry *real_nbr = olsr_lookup_nbr_entry(&tc->addr, false);
158       if (real_nbr) {
159
160         OLSR_DEBUG(LOG_MID, "Delete bogus neighbor entry %s (real %s)\n",
161                    olsr_ip_to_string(&buf1, &alias->mid_alias_addr), olsr_ip_to_string(&buf2, &tc->addr));
162
163         replace_neighbor_link_set(nbr, real_nbr);
164
165         olsr_delete_nbr_entry(nbr);
166
167         changes_neighborhood = true;
168       }
169     }
170   }
171 }
172
173 /**
174  * If we have an entry for this alias in neighbortable, we better adjust it's
175  * main address, because otherwise a fatal inconsistency between
176  * neighbortable and link_set will be created by way of this mid entry.
177  */
178 static void
179 olsr_fixup_mid_main_addr(const union olsr_ip_addr *main_addr, const union olsr_ip_addr *alias_addr)
180 {
181   struct nbr_entry *nbr_new, *nbr_old;
182   struct mid_entry *mid_old;
183   int ne_ref_rp_count;
184 #if !defined REMOVE_LOG_DEBUG
185   struct ipaddr_str buf1, buf2;
186 #endif
187
188   nbr_old = olsr_lookup_nbr_entry(alias_addr, false);
189   if (!nbr_old) {
190     return;
191   }
192
193   OLSR_DEBUG(LOG_MID, "Main address change %s -> %s detected.\n",
194              olsr_ip_to_string(&buf1, alias_addr), olsr_ip_to_string(&buf2, main_addr));
195
196   olsr_delete_nbr_entry(nbr_old);
197   nbr_new = olsr_add_nbr_entry(main_addr);
198
199   /* Adjust pointers to neighbortable-entry in link_set */
200   ne_ref_rp_count = replace_neighbor_link_set(nbr_old, nbr_new);
201
202   if (ne_ref_rp_count > 0) {
203     OLSR_DEBUG(LOG_MID, "Performed %d neighbortable-pointer replacements "
204                "(%p -> %p) in link_set.\n", ne_ref_rp_count, nbr_old, nbr_new);
205   }
206
207   mid_old = olsr_lookup_mid_entry(alias_addr);
208   if (mid_old) {
209     /*
210      * We knew aliases to the previous main address.
211      * Better forget about them now.
212      */
213     OLSR_DEBUG(LOG_MID, "Flush aliases for old main address.\n");
214     olsr_flush_mid_entries(mid_old->mid_tc);
215   }
216 }
217
218 /**
219  * Insert a fresh alias address for a node.
220  *
221  * @param main_add the main address of the node
222  * @param alias the alias address to insert
223  * @param vtime the validity time
224  * @param seq the sequence number to register a new node with
225  */
226 static struct mid_entry *
227 olsr_insert_mid_entry(const union olsr_ip_addr *main_addr,
228                       const union olsr_ip_addr *alias_addr, uint32_t vtime)
229 {
230   struct tc_entry *tc;
231   struct mid_entry *alias;
232 #if !defined REMOVE_LOG_DEBUG
233   struct ipaddr_str buf1, buf2;
234 #endif
235
236   OLSR_DEBUG(LOG_MID, "Inserting alias %s for %s\n", olsr_ip_to_string(&buf1, alias_addr), olsr_ip_to_string(&buf2, main_addr));
237
238   /*
239    * Locate first the hookup point
240    */
241   tc = olsr_locate_tc_entry(main_addr);
242   assert(tc);
243
244   alias = olsr_memcookie_malloc(mid_address_mem_cookie);
245   alias->mid_alias_addr = *alias_addr;
246   alias->mid_tc = tc;
247
248   /*
249    * Insert into the per-tc mid subtree.
250    */
251   alias->mid_tc_node.key = &alias->mid_alias_addr;
252   avl_insert(&tc->mid_tree, &alias->mid_tc_node);
253
254   /*
255    * Insert into the global mid tree.
256    */
257   alias->mid_node.key = &alias->mid_alias_addr;
258   avl_insert(&mid_tree, &alias->mid_node);
259
260   /*
261    * Add a rt_path for the alias.
262    */
263   olsr_insert_routing_table(&alias->mid_alias_addr, 8 * olsr_cnf->ipsize, main_addr, OLSR_RT_ORIGIN_MID);
264
265   olsr_set_mid_timer(alias, vtime);
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, uint32_t vtime)
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     /* Refresh the timer. */
296     olsr_set_mid_timer(alias, vtime);
297     return;
298   }
299
300   /*
301    * This is a fresh alias.
302    */
303   alias = olsr_insert_mid_entry(main_addr, alias_addr, vtime);
304
305   /*
306    * Do the needful if one of our neighbors has changed its main address.
307    */
308   olsr_fixup_mid_main_addr(main_addr, alias_addr);
309   olsr_flush_nbr2_duplicates(alias->mid_tc);
310   olsr_flush_tc_duplicates(alias);
311
312   /*
313    * Recalculate topology.
314    */
315   changes_neighborhood = true;
316   changes_topology = true;
317 }
318
319 /**
320  * Lookup a MID alias hanging off a tc_entry by address
321  *
322  * @param adr the alias address to check
323  * @return the MID address entry or NULL if not found
324  */
325 struct mid_entry *
326 olsr_lookup_tc_mid_entry(struct tc_entry *tc, const union olsr_ip_addr *adr)
327 {
328   struct mid_entry *mid;
329   mid = avl_find_element(&tc->mid_tree, adr, mid, mid_tc_node);
330   return mid;
331 }
332
333 /**
334  * Lookup an MID alias by address in the global tree.
335  *
336  * @param adr the alias address to check
337  * @return the MID address entry or NULL if not found
338  */
339 static struct mid_entry *
340 olsr_lookup_mid_entry(const union olsr_ip_addr *adr)
341 {
342   struct mid_entry *mid;
343   mid = avl_find_element(&mid_tree, adr, mid, mid_node);
344   return mid;
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   /* kill timer */
377   olsr_timer_stop(alias->mid_timer);
378   alias->mid_timer = NULL;
379
380   /*
381    * Delete the rt_path for the alias.
382    */
383   olsr_delete_routing_table(&alias->mid_alias_addr, 8 * olsr_cnf->ipsize, &tc->addr, OLSR_RT_ORIGIN_MID);
384
385   /*
386    * Remove from the per-tc tree.
387    */
388   avl_delete(&tc->mid_tree, &alias->mid_tc_node);
389
390   /*
391    * Remove from the global tree.
392    */
393   avl_delete(&mid_tree, &alias->mid_node);
394
395   olsr_memcookie_free(mid_address_mem_cookie, alias);
396 }
397
398 /**
399  * Delete all the MID aliases hanging off a tc entry.
400  *
401  * @param entry the tc entry holding the aliases.
402  */
403 void
404 olsr_flush_mid_entries(struct tc_entry *tc)
405 {
406   struct mid_entry *alias, *iterator;
407   OLSR_FOR_ALL_TC_MID_ENTRIES(tc, alias, iterator) {
408     olsr_delete_mid_entry(alias);
409   }
410 }
411
412 /**
413  * Print all MID entries
414  * For debuging purposes
415  */
416 void
417 olsr_print_mid_set(void)
418 {
419 #if !defined REMOVE_LOG_INFO
420   struct tc_entry *tc, *tc_iterator;
421   struct mid_entry *alias, *mid_iterator;
422   struct ipaddr_str buf1, buf2;
423
424   OLSR_INFO(LOG_MID, "\n--- %s ------------------------------------------------- MID\n\n", olsr_timer_getWallclockString());
425
426   OLSR_FOR_ALL_TC_ENTRIES(tc, tc_iterator) {
427     OLSR_FOR_ALL_TC_MID_ENTRIES(tc, alias, mid_iterator) {
428       OLSR_INFO_NH(LOG_MID, "%-15s: %s\n", olsr_ip_to_string(&buf1, &tc->addr), olsr_ip_to_string(&buf2, &alias->mid_alias_addr));
429     }
430   }
431 #endif
432 }
433
434 /**
435  * Process an incoming MID message.
436  */
437 void
438 olsr_input_mid(struct olsr_message *msg,
439     struct interface *input_if __attribute__ ((unused)),
440     union olsr_ip_addr *from_addr, enum duplicate_status status)
441 {
442   const uint8_t *curr;
443   union olsr_ip_addr alias;
444   struct tc_entry *tc;
445 #if !defined REMOVE_LOG_DEBUG
446   struct ipaddr_str buf;
447 #endif
448
449   /* We are only interested in MID message types. */
450   if (msg->type != MID_MESSAGE) {
451     return;
452   }
453
454   /*
455    * If the sender interface (NB: not originator) of this message
456    * is not in the symmetric 1-hop neighborhood of this node, the
457    * message MUST be discarded.
458    */
459   if (check_neighbor_link(from_addr) != SYM_LINK) {
460     OLSR_DEBUG(LOG_MID, "Received MID from NON SYM neighbor %s\n", olsr_ip_to_string(&buf, from_addr));
461     return;
462   }
463
464   tc = olsr_locate_tc_entry(&msg->originator);
465
466   if (status != RESET_SEQNO_OLSR_MESSAGE && tc->mid_seq != -1 && olsr_seqno_diff(msg->seqno, tc->mid_seq) <= 0) {
467     /* this MID is too old, discard it */
468     OLSR_DEBUG(LOG_MID, "Received too old mid from %s: %d < %d\n",
469         olsr_ip_to_string(&buf, from_addr), msg->seqno, tc->mid_seq);
470     return;
471   }
472   tc->mid_seq = msg->seqno;
473
474   OLSR_DEBUG(LOG_MID, "Processing MID from %s with %d aliases, seq 0x%04x\n",
475              olsr_ip_to_string(&buf, &msg->originator), (int)((msg->end - msg->payload)/olsr_cnf->ipsize), msg->seqno);
476
477
478   curr = msg->payload;
479
480
481   /*
482    * Now walk the list of alias advertisements one by one.
483    */
484   while (curr + olsr_cnf->ipsize <= msg->end) {
485     pkt_get_ipaddress(&curr, &alias);
486     olsr_update_mid_entry(&msg->originator, &alias, msg->vtime);
487   }
488 }
489
490 void
491 generate_mid(void *p  __attribute__ ((unused))) {
492   struct interface *ifp, *allif, *iterator;
493   struct olsr_message msg;
494   uint8_t msg_buffer[MAXMESSAGESIZE - OLSR_HEADERSIZE] __attribute__ ((aligned));
495   uint8_t *curr = msg_buffer;
496   uint8_t *length_field, *last;
497   bool sendMID = false;
498
499   OLSR_INFO(LOG_PACKET_CREATION, "Building MID\n-------------------\n");
500
501   msg.type = MID_MESSAGE;
502   msg.vtime = olsr_cnf->mid_params.validity_time;
503   msg.size = 0; // fill in later
504   msg.originator = olsr_cnf->router_id;
505   msg.ttl = MAX_TTL;
506   msg.hopcnt = 0;
507   msg.seqno = get_msg_seqno();
508
509   curr = msg_buffer;
510
511   length_field = olsr_put_msg_hdr(&curr, &msg);
512
513   last = msg_buffer + sizeof(msg_buffer) - olsr_cnf->ipsize;
514   OLSR_FOR_ALL_INTERFACES(allif, iterator) {
515     if (olsr_ipcmp(&olsr_cnf->router_id, &allif->ip_addr) != 0) {
516       if (curr > last) {
517         OLSR_WARN(LOG_MID, "Warning, too many interfaces for MID packet\n");
518         return;
519       }
520       pkt_put_ipaddress(&curr, &allif->ip_addr);
521       sendMID = true;
522     }
523   }
524
525   if (!sendMID) {
526     return;
527   }
528
529   pkt_put_u16(&length_field, curr - msg_buffer);
530
531   OLSR_FOR_ALL_INTERFACES(ifp, iterator) {
532     if (net_outbuffer_bytes_left(ifp) < curr - msg_buffer) {
533       net_output(ifp);
534       set_buffer_timer(ifp);
535     }
536     net_outbuffer_push(ifp, msg_buffer, curr - msg_buffer);
537   }
538 }
539 /*
540  * Local Variables:
541  * c-basic-offset: 2
542  * indent-tabs-mode: nil
543  * End:
544  */