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