Update to new avl/list iteration macros
[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_cookie_info *interface_mem_cookie = NULL;
77 static struct olsr_cookie_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_create_memcookie("Interface", sizeof(struct interface));
103
104   interface_lost_mem_cookie = olsr_create_memcookie("Interface lost", sizeof(struct interface_lost));
105
106   interface_poll_timerinfo = olsr_alloc_timerinfo("Interface Polling", &check_interface_updates, true);
107   hello_gen_timerinfo = olsr_alloc_timerinfo("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_start_timer(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_cookie_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_cookie_malloc(interface_lost_mem_cookie);
141   lost->node.key = &lost->ip;
142   lost->ip = *ip;
143   lost->valid_until = olsr_getTimestamp(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_cookie_malloc(interface_mem_cookie);
181   ifp->int_name = iface->name;
182
183   if ((os_init_interface(ifp, iface))) {
184     olsr_cookie_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   add_olsr_socket(ifp->olsr_socket, &olsr_input, NULL, NULL, SP_PR_READ);
199   add_olsr_socket(ifp->send_socket, &olsr_input, NULL, NULL, SP_PR_READ);
200
201   os_socket_set_olsr_options(ifp, ifp->olsr_socket);
202   os_socket_set_olsr_options(ifp, ifp->send_socket);
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     struct ipaddr_str buf;
214
215     olsr_cnf->router_id = ifp->ip_addr;
216     OLSR_INFO(LOG_INTERFACE, "New main address: %s\n", olsr_ip_to_string(&buf, &olsr_cnf->router_id));
217
218     /* initialize representation of this node in tc_set */
219     olsr_change_myself_tc();
220   }
221
222   /* Set up buffer */
223   net_add_buffer(ifp);
224
225   /*
226    * Register functions for periodic message generation
227    */
228   ifp->hello_gen_timer =
229     olsr_start_timer(iface->cnf->hello_params.emission_interval,
230                      HELLO_JITTER, ifp, hello_gen_timerinfo);
231   ifp->hello_interval = iface->cnf->hello_params.emission_interval;
232   ifp->hello_validity = iface->cnf->hello_params.validity_time;
233
234   ifp->mode = iface->cnf->mode;
235
236   /*
237    * Call possible ifchange functions registered by plugins
238    */
239   run_ifchg_cbs(ifp, IFCHG_IF_ADD);
240
241   /*
242    * The interface is ready, lock it.
243    */
244   lock_interface(ifp);
245
246   /*
247    * Link to config.
248    */
249   iface->interf = ifp;
250   lock_interface(iface->interf);
251
252   /* Queue */
253   list_add_before(&interface_head, &ifp->int_node);
254
255   return ifp;
256 }
257
258 /**
259  * Callback function for periodic check of interface parameters.
260  */
261 static void
262 check_interface_updates(void *foo __attribute__ ((unused)))
263 {
264   struct olsr_if_config *tmp_if;
265   struct interface_lost *lost, *iterator;
266
267   OLSR_DEBUG(LOG_INTERFACE, "Checking for updates in the interface set\n");
268
269   for (tmp_if = olsr_cnf->if_configs; tmp_if != NULL; tmp_if = tmp_if->next) {
270
271     if (!tmp_if->cnf->autodetect_chg) {
272       /* Don't check this interface */
273       OLSR_DEBUG(LOG_INTERFACE, "Not checking interface %s\n", tmp_if->name);
274       continue;
275     }
276
277     if (tmp_if->interf) {
278       chk_if_changed(tmp_if);
279     } else {
280       if (add_interface(tmp_if)) {
281         lost = get_lost_interface_ip(&tmp_if->interf->ip_addr);
282         if (lost) {
283           remove_lost_interface_ip(lost);
284         }
285       }
286     }
287   }
288
289   /* clean up lost interface tree */
290   OLSR_FOR_ALL_LOSTIF_ENTRIES(lost, iterator) {
291     if (olsr_isTimedOut(lost->valid_until)) {
292       remove_lost_interface_ip(lost);
293     }
294   }
295 }
296
297 /**
298  * Remove and cleanup a physical interface.
299  */
300 void
301 remove_interface(struct interface *ifp)
302 {
303   if (!ifp) {
304     return;
305   }
306
307   OLSR_INFO(LOG_INTERFACE, "Removing interface %s\n", ifp->int_name);
308
309   os_cleanup_interface(ifp);
310
311   olsr_delete_link_entry_by_if(ifp);
312
313   /*
314    * Call possible ifchange functions registered by plugins
315    */
316   run_ifchg_cbs(ifp, IFCHG_IF_REMOVE);
317
318   /* Dequeue */
319   list_remove(&ifp->int_node);
320
321   /* Remove output buffer */
322   net_remove_buffer(ifp);
323
324   /*
325    * Deregister functions for periodic message generation
326    */
327   olsr_stop_timer(ifp->hello_gen_timer);
328   ifp->hello_gen_timer = NULL;
329
330   /*
331    * Stop interface pacing.
332    */
333   olsr_stop_timer(ifp->buffer_hold_timer);
334   ifp->buffer_hold_timer = NULL;
335
336   /*
337    * remember the IP for some time
338    */
339   add_lost_interface_ip(&ifp->ip_addr, ifp->hello_validity);
340
341   /*
342    * Unlink from config.
343    */
344   unlock_interface(ifp);
345
346   /* Close olsr socket */
347   remove_olsr_socket(ifp->olsr_socket, &olsr_input, NULL);
348   os_close(ifp->olsr_socket);
349   os_close(ifp->send_socket);
350   ifp->olsr_socket = -1;
351
352   ifp->int_name = NULL;
353   unlock_interface(ifp);
354
355   if (list_is_empty(&interface_head) && !olsr_cnf->allow_no_interfaces) {
356     OLSR_ERROR(LOG_INTERFACE, "No more active interfaces - exiting.\n");
357     olsr_exit(EXIT_FAILURE);
358   }
359 }
360
361 void
362 run_ifchg_cbs(struct interface *ifp, int flag)
363 {
364   struct ifchgf *tmp;
365   for (tmp = ifchgf_list; tmp != NULL; tmp = tmp->next) {
366     tmp->function(ifp, flag);
367   }
368 }
369
370 /**
371  * Find the local interface with a given address.
372  *
373  * @param addr the address to check.
374  * @return the interface struct representing the interface
375  * that matched the address.
376  */
377 struct interface *
378 if_ifwithaddr(const union olsr_ip_addr *addr)
379 {
380   struct interface *ifp, *iterator;
381   if (!addr) {
382     return NULL;
383   }
384
385   OLSR_FOR_ALL_INTERFACES(ifp, iterator) {
386     if (olsr_ipcmp(&ifp->ip_addr, addr) == 0) {
387       return ifp;
388     }
389   }
390   return NULL;
391 }
392
393 /**
394  * Find the interface with a given number.
395  *
396  * @param nr the number of the interface to find.
397  * @return return the interface struct representing the interface
398  * that matched the number.
399  */
400 struct interface *
401 if_ifwithsock(int fd)
402 {
403   struct interface *ifp, *iterator;
404
405   OLSR_FOR_ALL_INTERFACES(ifp, iterator) {
406     if (ifp->olsr_socket == fd) {
407       return ifp;
408     }
409     if (ifp->send_socket == fd) {
410       return ifp;
411     }
412   }
413
414   return NULL;
415 }
416
417
418 /**
419  * Find the interface with a given label.
420  *
421  * @param if_name the label of the interface to find.
422  * @return return the interface struct representing the interface
423  * that matched the label.
424  */
425 struct interface *
426 if_ifwithname(const char *if_name)
427 {
428   struct interface *ifp, *iterator;
429
430   OLSR_FOR_ALL_INTERFACES(ifp, iterator) {
431     /* good ol' strcmp should be sufficient here */
432     if (strcmp(ifp->int_name, if_name) == 0) {
433       return ifp;
434     }
435   }
436
437   return NULL;
438 }
439
440 /**
441  * Find the interface with a given interface index.
442  *
443  * @param iif_index of the interface to find.
444  * @return return the interface struct representing the interface
445  * that matched the iif_index.
446  */
447 struct interface *
448 if_ifwithindex(const int if_index)
449 {
450   struct interface *ifp, *iterator;
451   OLSR_FOR_ALL_INTERFACES(ifp, iterator) {
452     if (ifp->if_index == if_index) {
453       return ifp;
454     }
455   }
456
457   return NULL;
458 }
459
460 /**
461  * Get an interface name for a given interface index
462  *
463  * @param iif_index of the interface to find.
464  * @return "" or interface name.
465  */
466 const char *
467 if_ifwithindex_name(const int if_index)
468 {
469   const struct interface *const ifp = if_ifwithindex(if_index);
470   return ifp == NULL ? "void" : ifp->int_name;
471 }
472
473 /**
474  * Lock an interface.
475  */
476 void
477 lock_interface(struct interface *ifp)
478 {
479   assert(ifp);
480
481   ifp->refcount++;
482 }
483
484 /**
485  * Unlock an interface and free it if the refcount went down to zero.
486  */
487 void
488 unlock_interface(struct interface *ifp)
489 {
490   /* Node must have a positive refcount balance */
491   assert(ifp->refcount);
492
493   if (--ifp->refcount) {
494     return;
495   }
496
497   /* Node must be dequeued at this point */
498   assert(!list_node_added(&ifp->int_node));
499
500   /* Free memory */
501   free(ifp->int_name);
502   olsr_cookie_free(interface_mem_cookie, ifp);
503 }
504
505
506 /**
507  * Add an ifchange function. These functions are called on all (non-initial)
508  * changes in the interface set.
509  */
510 void
511 add_ifchgf(ifchg_cb_func f)
512 {
513   struct ifchgf *tmp = olsr_malloc(sizeof(struct ifchgf), "Add ifchgfunction");
514
515   tmp->function = f;
516   tmp->next = ifchgf_list;
517   ifchgf_list = tmp;
518 }
519
520 #if 0
521
522 /*
523  * Remove an ifchange function
524  */
525 int
526 del_ifchgf(ifchg_cb_func f)
527 {
528   struct ifchgf *tmp, *prev;
529
530   for (tmp = ifchgf_list, prev = NULL; tmp != NULL; prev = tmp, tmp = tmp->next) {
531     if (tmp->function == f) {
532       /* Remove entry */
533       if (prev == NULL) {
534         ifchgf_list = tmp->next;
535       } else {
536         prev->next = tmp->next;
537       }
538       free(tmp);
539       return 1;
540     }
541   }
542   return 0;
543 }
544 #endif
545
546 /*
547  * Local Variables:
548  * c-basic-offset: 2
549  * indent-tabs-mode: nil
550  * End:
551  */