Namespace cleanup of scheduler, remove "polling" sockets
[olsrd.git] / src / interfaces.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 "defs.h"
43 #include "interfaces.h"
44 #include "scheduler.h"
45 #include "olsr.h"
46 #include "parser.h"
47 #include "net_olsr.h"
48 #include "ipcalc.h"
49 #include "common/string.h"
50 #include "common/avl.h"
51 #include "olsr_logging.h"
52 #include "os_net.h"
53
54 #include <signal.h>
55 #include <unistd.h>
56 #include <assert.h>
57
58 #define BUFSPACE  (127*1024)    /* max. input buffer size to request */
59
60 /* The interface list head */
61 struct list_entity interface_head;
62
63 /* tree of lost interface IPs */
64 struct avl_tree interface_lost_tree;
65
66 /* Ifchange functions */
67 struct ifchgf {
68   ifchg_cb_func function;
69   struct ifchgf *next;
70 };
71
72 static struct ifchgf *ifchgf_list = NULL;
73
74
75 /* Some cookies for stats keeping */
76 static struct olsr_memcookie_info *interface_mem_cookie = NULL;
77 static struct olsr_memcookie_info *interface_lost_mem_cookie = NULL;
78
79 static struct olsr_timer_info *interface_poll_timerinfo = NULL;
80 static struct olsr_timer_info *hello_gen_timerinfo = NULL;
81
82 static void check_interface_updates(void *);
83
84 /**
85  * Do initialization of various data needed for network interface management.
86  * This function also tries to set up the given interfaces.
87  *
88  * @return if more than zero interfaces were configured
89  */
90 bool
91 init_interfaces(void)
92 {
93   struct olsr_if_config *tmp_if;
94
95   /* Initial values */
96   list_init_head(&interface_head);
97   avl_init(&interface_lost_tree, avl_comp_default, false, NULL);
98
99   /*
100    * Get some cookies for getting stats to ease troubleshooting.
101    */
102   interface_mem_cookie = olsr_memcookie_add("Interface", sizeof(struct interface));
103
104   interface_lost_mem_cookie = olsr_memcookie_add("Interface lost", sizeof(struct interface_lost));
105
106   interface_poll_timerinfo = olsr_timer_add("Interface Polling", &check_interface_updates, true);
107   hello_gen_timerinfo = olsr_timer_add("Hello Generation", &generate_hello, true);
108
109   OLSR_INFO(LOG_INTERFACE, "\n ---- Interface configuration ---- \n\n");
110
111   /* Run trough all interfaces immediately */
112   for (tmp_if = olsr_cnf->if_configs; tmp_if != NULL; tmp_if = tmp_if->next) {
113     add_interface(tmp_if);
114   }
115
116   /* Kick a periodic timer for the network interface update function */
117   olsr_timer_start(olsr_cnf->nic_chgs_pollrate, 5,
118                    NULL, interface_poll_timerinfo);
119
120   return (!list_is_empty(&interface_head));
121 }
122
123 static void remove_lost_interface_ip(struct interface_lost *lost) {
124 #if !defined(REMOVE_LOG_DEBUG)
125   struct ipaddr_str buf;
126 #endif
127
128   OLSR_DEBUG(LOG_INTERFACE, "Remove %s from lost interface list\n",
129       olsr_ip_to_string(&buf, &lost->ip));
130   avl_delete(&interface_lost_tree, &lost->node);
131   olsr_memcookie_free(interface_lost_mem_cookie, lost);
132 }
133
134 static void add_lost_interface_ip(union olsr_ip_addr *ip, uint32_t hello_timeout) {
135   struct interface_lost *lost;
136 #if !defined(REMOVE_LOG_DEBUG)
137   struct ipaddr_str buf;
138 #endif
139
140   lost = olsr_memcookie_malloc(interface_lost_mem_cookie);
141   lost->node.key = &lost->ip;
142   lost->ip = *ip;
143   lost->valid_until = olsr_timer_getAbsolute(hello_timeout * 2);
144   avl_insert(&interface_lost_tree, &lost->node);
145
146   OLSR_DEBUG(LOG_INTERFACE, "Added %s to lost interface list for %d ms\n",
147       olsr_ip_to_string(&buf, ip), hello_timeout*2);
148 }
149
150 static struct interface_lost *get_lost_interface_ip(union olsr_ip_addr *ip) {
151   struct interface_lost *lost;
152   assert(ip);
153   lost = avl_find_element(&interface_lost_tree, ip, lost, node);
154   return lost;
155 }
156
157 bool
158 is_lost_interface_ip(union olsr_ip_addr *ip) {
159   assert(ip);
160   return get_lost_interface_ip(ip) != NULL;
161 }
162
163 void destroy_interfaces(void) {
164   struct interface *iface, *iface_iterator;
165   struct interface_lost *lost, *lost_iterator;
166
167   OLSR_FOR_ALL_INTERFACES(iface, iface_iterator) {
168     remove_interface(iface);
169   }
170
171   OLSR_FOR_ALL_LOSTIF_ENTRIES(lost, lost_iterator) {
172     remove_lost_interface_ip(lost);
173   }
174 }
175
176 struct interface *
177 add_interface(struct olsr_if_config *iface) {
178   struct interface *ifp;
179
180   ifp = olsr_memcookie_malloc(interface_mem_cookie);
181   ifp->int_name = iface->name;
182
183   if ((os_init_interface(ifp, iface))) {
184     olsr_memcookie_free(interface_mem_cookie, ifp);
185     return NULL;
186   }
187
188   ifp->olsr_socket = os_getsocket46(olsr_cnf->ip_version, ifp->int_name, olsr_cnf->olsr_port, BUFSPACE, NULL);
189   ifp->send_socket = os_getsocket46(olsr_cnf->ip_version, ifp->int_name, olsr_cnf->olsr_port, BUFSPACE, &ifp->int_multicast);
190   if (ifp->olsr_socket < 0 || ifp->send_socket < 0) {
191     OLSR_ERROR(LOG_INTERFACE, "Could not initialize socket... exiting!\n\n");
192     olsr_exit(EXIT_FAILURE);
193   }
194
195   set_buffer_timer(ifp);
196
197   /* Register sockets */
198   olsr_socket_add(ifp->olsr_socket, &olsr_input, NULL, OLSR_SOCKET_READ);
199   olsr_socket_add(ifp->send_socket, &olsr_input, NULL, OLSR_SOCKET_READ);
200
201   os_socket_set_olsr_options(ifp, ifp->olsr_socket, &ifp->int_multicast);
202   os_socket_set_olsr_options(ifp, ifp->send_socket, &ifp->int_multicast);
203
204   /*
205    *Initialize packet sequencenumber as a random 16bit value
206    */
207   ifp->olsr_seqnum = random() & 0xFFFF;
208
209   /*
210    * Set main address if it's not set
211    */
212   if (olsr_ipcmp(&all_zero, &olsr_cnf->router_id) == 0) {
213 #if !defined(REMOVE_LOG_INFO)
214     struct ipaddr_str buf;
215 #endif
216     olsr_cnf->router_id = ifp->ip_addr;
217     OLSR_INFO(LOG_INTERFACE, "New main address: %s\n", olsr_ip_to_string(&buf, &olsr_cnf->router_id));
218
219     /* initialize representation of this node in tc_set */
220     olsr_change_myself_tc();
221   }
222
223   /* Set up buffer */
224   net_add_buffer(ifp);
225
226   /*
227    * Register functions for periodic message generation
228    */
229   ifp->hello_gen_timer =
230     olsr_timer_start(iface->cnf->hello_params.emission_interval,
231                      HELLO_JITTER, ifp, hello_gen_timerinfo);
232   ifp->hello_interval = iface->cnf->hello_params.emission_interval;
233   ifp->hello_validity = iface->cnf->hello_params.validity_time;
234
235   ifp->mode = iface->cnf->mode;
236
237   /*
238    * Call possible ifchange functions registered by plugins
239    */
240   run_ifchg_cbs(ifp, IFCHG_IF_ADD);
241
242   /*
243    * The interface is ready, lock it.
244    */
245   lock_interface(ifp);
246
247   /*
248    * Link to config.
249    */
250   iface->interf = ifp;
251   lock_interface(iface->interf);
252
253   /* Queue */
254   list_add_before(&interface_head, &ifp->int_node);
255
256   return ifp;
257 }
258
259 /**
260  * Callback function for periodic check of interface parameters.
261  */
262 static void
263 check_interface_updates(void *foo __attribute__ ((unused)))
264 {
265   struct olsr_if_config *tmp_if;
266   struct interface_lost *lost, *iterator;
267
268   OLSR_DEBUG(LOG_INTERFACE, "Checking for updates in the interface set\n");
269
270   for (tmp_if = olsr_cnf->if_configs; tmp_if != NULL; tmp_if = tmp_if->next) {
271
272     if (!tmp_if->cnf->autodetect_chg) {
273       /* Don't check this interface */
274       OLSR_DEBUG(LOG_INTERFACE, "Not checking interface %s\n", tmp_if->name);
275       continue;
276     }
277
278     if (tmp_if->interf) {
279       chk_if_changed(tmp_if);
280     } else {
281       if (add_interface(tmp_if)) {
282         lost = get_lost_interface_ip(&tmp_if->interf->ip_addr);
283         if (lost) {
284           remove_lost_interface_ip(lost);
285         }
286       }
287     }
288   }
289
290   /* clean up lost interface tree */
291   OLSR_FOR_ALL_LOSTIF_ENTRIES(lost, iterator) {
292     if (olsr_timer_isTimedOut(lost->valid_until)) {
293       remove_lost_interface_ip(lost);
294     }
295   }
296 }
297
298 /**
299  * Remove and cleanup a physical interface.
300  */
301 void
302 remove_interface(struct interface *ifp)
303 {
304   if (!ifp) {
305     return;
306   }
307
308   OLSR_INFO(LOG_INTERFACE, "Removing interface %s\n", ifp->int_name);
309
310   os_cleanup_interface(ifp);
311
312   olsr_delete_link_entry_by_if(ifp);
313
314   /*
315    * Call possible ifchange functions registered by plugins
316    */
317   run_ifchg_cbs(ifp, IFCHG_IF_REMOVE);
318
319   /* Dequeue */
320   list_remove(&ifp->int_node);
321
322   /* Remove output buffer */
323   net_remove_buffer(ifp);
324
325   /*
326    * Deregister functions for periodic message generation
327    */
328   olsr_timer_stop(ifp->hello_gen_timer);
329   ifp->hello_gen_timer = NULL;
330
331   /*
332    * Stop interface pacing.
333    */
334   olsr_timer_stop(ifp->buffer_hold_timer);
335   ifp->buffer_hold_timer = NULL;
336
337   /*
338    * remember the IP for some time
339    */
340   add_lost_interface_ip(&ifp->ip_addr, ifp->hello_validity);
341
342   /*
343    * Unlink from config.
344    */
345   unlock_interface(ifp);
346
347   /* Close olsr socket */
348   olsr_socket_remove(ifp->olsr_socket, &olsr_input);
349   os_close(ifp->olsr_socket);
350   os_close(ifp->send_socket);
351   ifp->olsr_socket = -1;
352
353   ifp->int_name = NULL;
354   unlock_interface(ifp);
355
356   if (list_is_empty(&interface_head) && !olsr_cnf->allow_no_interfaces) {
357     OLSR_ERROR(LOG_INTERFACE, "No more active interfaces - exiting.\n");
358     olsr_exit(EXIT_FAILURE);
359   }
360 }
361
362 void
363 run_ifchg_cbs(struct interface *ifp, int flag)
364 {
365   struct ifchgf *tmp;
366   for (tmp = ifchgf_list; tmp != NULL; tmp = tmp->next) {
367     tmp->function(ifp, flag);
368   }
369 }
370
371 /**
372  * Find the local interface with a given address.
373  *
374  * @param addr the address to check.
375  * @return the interface struct representing the interface
376  * that matched the address.
377  */
378 struct interface *
379 if_ifwithaddr(const union olsr_ip_addr *addr)
380 {
381   struct interface *ifp, *iterator;
382   if (!addr) {
383     return NULL;
384   }
385
386   OLSR_FOR_ALL_INTERFACES(ifp, iterator) {
387     if (olsr_ipcmp(&ifp->ip_addr, addr) == 0) {
388       return ifp;
389     }
390   }
391   return NULL;
392 }
393
394 /**
395  * Find the interface with a given number.
396  *
397  * @param nr the number of the interface to find.
398  * @return return the interface struct representing the interface
399  * that matched the number.
400  */
401 struct interface *
402 if_ifwithsock(int fd)
403 {
404   struct interface *ifp, *iterator;
405
406   OLSR_FOR_ALL_INTERFACES(ifp, iterator) {
407     if (ifp->olsr_socket == fd) {
408       return ifp;
409     }
410     if (ifp->send_socket == fd) {
411       return ifp;
412     }
413   }
414
415   return NULL;
416 }
417
418
419 /**
420  * Find the interface with a given label.
421  *
422  * @param if_name the label of the interface to find.
423  * @return return the interface struct representing the interface
424  * that matched the label.
425  */
426 struct interface *
427 if_ifwithname(const char *if_name)
428 {
429   struct interface *ifp, *iterator;
430
431   OLSR_FOR_ALL_INTERFACES(ifp, iterator) {
432     /* good ol' strcmp should be sufficient here */
433     if (strcmp(ifp->int_name, if_name) == 0) {
434       return ifp;
435     }
436   }
437
438   return NULL;
439 }
440
441 /**
442  * Find the interface with a given interface index.
443  *
444  * @param iif_index of the interface to find.
445  * @return return the interface struct representing the interface
446  * that matched the iif_index.
447  */
448 struct interface *
449 if_ifwithindex(const int if_index)
450 {
451   struct interface *ifp, *iterator;
452   OLSR_FOR_ALL_INTERFACES(ifp, iterator) {
453     if (ifp->if_index == if_index) {
454       return ifp;
455     }
456   }
457
458   return NULL;
459 }
460
461 /**
462  * Get an interface name for a given interface index
463  *
464  * @param iif_index of the interface to find.
465  * @return "" or interface name.
466  */
467 const char *
468 if_ifwithindex_name(const int if_index)
469 {
470   const struct interface *const ifp = if_ifwithindex(if_index);
471   return ifp == NULL ? "void" : ifp->int_name;
472 }
473
474 /**
475  * Lock an interface.
476  */
477 void
478 lock_interface(struct interface *ifp)
479 {
480   assert(ifp);
481
482   ifp->refcount++;
483 }
484
485 /**
486  * Unlock an interface and free it if the refcount went down to zero.
487  */
488 void
489 unlock_interface(struct interface *ifp)
490 {
491   /* Node must have a positive refcount balance */
492   assert(ifp->refcount);
493
494   if (--ifp->refcount) {
495     return;
496   }
497
498   /* Node must be dequeued at this point */
499   assert(!list_node_added(&ifp->int_node));
500
501   /* Free memory */
502   free(ifp->int_name);
503   olsr_memcookie_free(interface_mem_cookie, ifp);
504 }
505
506
507 /**
508  * Add an ifchange function. These functions are called on all (non-initial)
509  * changes in the interface set.
510  */
511 void
512 add_ifchgf(ifchg_cb_func f)
513 {
514   struct ifchgf *tmp = olsr_malloc(sizeof(struct ifchgf), "Add ifchgfunction");
515
516   tmp->function = f;
517   tmp->next = ifchgf_list;
518   ifchgf_list = tmp;
519 }
520
521 #if 0
522
523 /*
524  * Remove an ifchange function
525  */
526 int
527 del_ifchgf(ifchg_cb_func f)
528 {
529   struct ifchgf *tmp, *prev;
530
531   for (tmp = ifchgf_list, prev = NULL; tmp != NULL; prev = tmp, tmp = tmp->next) {
532     if (tmp->function == f) {
533       /* Remove entry */
534       if (prev == NULL) {
535         ifchgf_list = tmp->next;
536       } else {
537         prev->next = tmp->next;
538       }
539       free(tmp);
540       return 1;
541     }
542   }
543   return 0;
544 }
545 #endif
546
547 /*
548  * Local Variables:
549  * c-basic-offset: 2
550  * indent-tabs-mode: nil
551  * End:
552  */