fd32d16a85f83c1f1a099b8e397f3cd5a7fabbc1
[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;
165   struct interface_lost *lost;
166   struct list_iterator iterator;
167
168   OLSR_FOR_ALL_INTERFACES(iface, iterator) {
169     remove_interface(iface);
170   }
171
172   OLSR_FOR_ALL_LOSTIF_ENTRIES(lost, iterator) {
173     remove_lost_interface_ip(lost);
174   }
175 }
176
177 struct interface *
178 add_interface(struct olsr_if_config *iface) {
179   struct interface *ifp;
180
181   ifp = olsr_cookie_malloc(interface_mem_cookie);
182   ifp->int_name = iface->name;
183
184   if ((os_init_interface(ifp, iface))) {
185     olsr_cookie_free(interface_mem_cookie, ifp);
186     return NULL;
187   }
188
189   ifp->olsr_socket = os_getsocket46(olsr_cnf->ip_version, ifp->int_name, olsr_cnf->olsr_port, BUFSPACE, NULL);
190   ifp->send_socket = os_getsocket46(olsr_cnf->ip_version, ifp->int_name, olsr_cnf->olsr_port, BUFSPACE, &ifp->int_multicast);
191   if (ifp->olsr_socket < 0 || ifp->send_socket < 0) {
192     OLSR_ERROR(LOG_INTERFACE, "Could not initialize socket... exiting!\n\n");
193     olsr_exit(EXIT_FAILURE);
194   }
195
196   set_buffer_timer(ifp);
197
198   /* Register sockets */
199   add_olsr_socket(ifp->olsr_socket, &olsr_input, NULL, NULL, SP_PR_READ);
200   add_olsr_socket(ifp->send_socket, &olsr_input, NULL, NULL, SP_PR_READ);
201
202   os_socket_set_olsr_options(ifp, ifp->olsr_socket);
203   os_socket_set_olsr_options(ifp, ifp->send_socket);
204
205   /*
206    *Initialize packet sequencenumber as a random 16bit value
207    */
208   ifp->olsr_seqnum = random() & 0xFFFF;
209
210   /*
211    * Set main address if it's not set
212    */
213   if (olsr_ipcmp(&all_zero, &olsr_cnf->router_id) == 0) {
214     struct ipaddr_str buf;
215
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_start_timer(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;
267   struct list_iterator iterator;
268
269   OLSR_DEBUG(LOG_INTERFACE, "Checking for updates in the interface set\n");
270
271   for (tmp_if = olsr_cnf->if_configs; tmp_if != NULL; tmp_if = tmp_if->next) {
272
273     if (!tmp_if->cnf->autodetect_chg) {
274       /* Don't check this interface */
275       OLSR_DEBUG(LOG_INTERFACE, "Not checking interface %s\n", tmp_if->name);
276       continue;
277     }
278
279     if (tmp_if->interf) {
280       chk_if_changed(tmp_if);
281     } else {
282       if (add_interface(tmp_if)) {
283         lost = get_lost_interface_ip(&tmp_if->interf->ip_addr);
284         if (lost) {
285           remove_lost_interface_ip(lost);
286         }
287       }
288     }
289   }
290
291   /* clean up lost interface tree */
292   OLSR_FOR_ALL_LOSTIF_ENTRIES(lost, iterator) {
293     if (olsr_isTimedOut(lost->valid_until)) {
294       remove_lost_interface_ip(lost);
295     }
296   }
297 }
298
299 /**
300  * Remove and cleanup a physical interface.
301  */
302 void
303 remove_interface(struct interface *ifp)
304 {
305   if (!ifp) {
306     return;
307   }
308
309   OLSR_INFO(LOG_INTERFACE, "Removing interface %s\n", ifp->int_name);
310
311   os_cleanup_interface(ifp);
312
313   olsr_delete_link_entry_by_if(ifp);
314
315   /*
316    * Call possible ifchange functions registered by plugins
317    */
318   run_ifchg_cbs(ifp, IFCHG_IF_REMOVE);
319
320   /* Dequeue */
321   list_remove(&ifp->int_node);
322
323   /* Remove output buffer */
324   net_remove_buffer(ifp);
325
326   /*
327    * Deregister functions for periodic message generation
328    */
329   olsr_stop_timer(ifp->hello_gen_timer);
330   ifp->hello_gen_timer = NULL;
331
332   /*
333    * Stop interface pacing.
334    */
335   olsr_stop_timer(ifp->buffer_hold_timer);
336   ifp->buffer_hold_timer = NULL;
337
338   /*
339    * remember the IP for some time
340    */
341   add_lost_interface_ip(&ifp->ip_addr, ifp->hello_validity);
342
343   /*
344    * Unlink from config.
345    */
346   unlock_interface(ifp);
347
348   /* Close olsr socket */
349   remove_olsr_socket(ifp->olsr_socket, &olsr_input, NULL);
350   os_close(ifp->olsr_socket);
351   os_close(ifp->send_socket);
352   ifp->olsr_socket = -1;
353
354   ifp->int_name = NULL;
355   unlock_interface(ifp);
356
357   if (list_is_empty(&interface_head) && !olsr_cnf->allow_no_interfaces) {
358     OLSR_ERROR(LOG_INTERFACE, "No more active interfaces - exiting.\n");
359     olsr_exit(EXIT_FAILURE);
360   }
361 }
362
363 void
364 run_ifchg_cbs(struct interface *ifp, int flag)
365 {
366   struct ifchgf *tmp;
367   for (tmp = ifchgf_list; tmp != NULL; tmp = tmp->next) {
368     tmp->function(ifp, flag);
369   }
370 }
371
372 /**
373  * Find the local interface with a given address.
374  *
375  * @param addr the address to check.
376  * @return the interface struct representing the interface
377  * that matched the address.
378  */
379 struct interface *
380 if_ifwithaddr(const union olsr_ip_addr *addr)
381 {
382   struct interface *ifp;
383   struct list_iterator iterator;
384   if (!addr) {
385     return NULL;
386   }
387
388   OLSR_FOR_ALL_INTERFACES(ifp, iterator) {
389     if (olsr_ipcmp(&ifp->ip_addr, addr) == 0) {
390       return ifp;
391     }
392   }
393   return NULL;
394 }
395
396 /**
397  * Find the interface with a given number.
398  *
399  * @param nr the number of the interface to find.
400  * @return return the interface struct representing the interface
401  * that matched the number.
402  */
403 struct interface *
404 if_ifwithsock(int fd)
405 {
406   struct interface *ifp;
407   struct list_iterator iterator;
408
409   OLSR_FOR_ALL_INTERFACES(ifp, iterator) {
410     if (ifp->olsr_socket == fd) {
411       return ifp;
412     }
413     if (ifp->send_socket == fd) {
414       return ifp;
415     }
416   }
417
418   return NULL;
419 }
420
421
422 /**
423  * Find the interface with a given label.
424  *
425  * @param if_name the label of the interface to find.
426  * @return return the interface struct representing the interface
427  * that matched the label.
428  */
429 struct interface *
430 if_ifwithname(const char *if_name)
431 {
432   struct interface *ifp;
433   struct list_iterator iterator;
434
435   OLSR_FOR_ALL_INTERFACES(ifp, iterator) {
436     /* good ol' strcmp should be sufficient here */
437     if (strcmp(ifp->int_name, if_name) == 0) {
438       return ifp;
439     }
440   }
441
442   return NULL;
443 }
444
445 /**
446  * Find the interface with a given interface index.
447  *
448  * @param iif_index of the interface to find.
449  * @return return the interface struct representing the interface
450  * that matched the iif_index.
451  */
452 struct interface *
453 if_ifwithindex(const int if_index)
454 {
455   struct interface *ifp;
456   struct list_iterator iterator;
457   OLSR_FOR_ALL_INTERFACES(ifp, iterator) {
458     if (ifp->if_index == if_index) {
459       return ifp;
460     }
461   }
462
463   return NULL;
464 }
465
466 /**
467  * Get an interface name for a given interface index
468  *
469  * @param iif_index of the interface to find.
470  * @return "" or interface name.
471  */
472 const char *
473 if_ifwithindex_name(const int if_index)
474 {
475   const struct interface *const ifp = if_ifwithindex(if_index);
476   return ifp == NULL ? "void" : ifp->int_name;
477 }
478
479 /**
480  * Lock an interface.
481  */
482 void
483 lock_interface(struct interface *ifp)
484 {
485   assert(ifp);
486
487   ifp->refcount++;
488 }
489
490 /**
491  * Unlock an interface and free it if the refcount went down to zero.
492  */
493 void
494 unlock_interface(struct interface *ifp)
495 {
496   /* Node must have a positive refcount balance */
497   assert(ifp->refcount);
498
499   if (--ifp->refcount) {
500     return;
501   }
502
503   /* Node must be dequeued at this point */
504   assert(!list_node_added(&ifp->int_node));
505
506   /* Free memory */
507   free(ifp->int_name);
508   olsr_cookie_free(interface_mem_cookie, ifp);
509 }
510
511
512 /**
513  * Add an ifchange function. These functions are called on all (non-initial)
514  * changes in the interface set.
515  */
516 void
517 add_ifchgf(ifchg_cb_func f)
518 {
519   struct ifchgf *tmp = olsr_malloc(sizeof(struct ifchgf), "Add ifchgfunction");
520
521   tmp->function = f;
522   tmp->next = ifchgf_list;
523   ifchgf_list = tmp;
524 }
525
526 #if 0
527
528 /*
529  * Remove an ifchange function
530  */
531 int
532 del_ifchgf(ifchg_cb_func f)
533 {
534   struct ifchgf *tmp, *prev;
535
536   for (tmp = ifchgf_list, prev = NULL; tmp != NULL; prev = tmp, tmp = tmp->next) {
537     if (tmp->function == f) {
538       /* Remove entry */
539       if (prev == NULL) {
540         ifchgf_list = tmp->next;
541       } else {
542         prev->next = tmp->next;
543       }
544       free(tmp);
545       return 1;
546     }
547   }
548   return 0;
549 }
550 #endif
551
552 /*
553  * Local Variables:
554  * c-basic-offset: 2
555  * indent-tabs-mode: nil
556  * End:
557  */