Merge branch 'stable' into tunnel
[olsrd.git] / src / olsr.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org)
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 /**
43  * All these functions are global
44  */
45
46 #include "defs.h"
47 #include "olsr.h"
48 #include "link_set.h"
49 #include "two_hop_neighbor_table.h"
50 #include "tc_set.h"
51 #include "duplicate_set.h"
52 #include "mpr_selector_set.h"
53 #include "mid_set.h"
54 #include "mpr.h"
55 #include "lq_mpr.h"
56 #include "olsr_spf.h"
57 #include "scheduler.h"
58 #include "apm.h"
59 #include "misc.h"
60 #include "neighbor_table.h"
61 #include "log.h"
62 #include "lq_packet.h"
63 #include "common/avl.h"
64 #include "net_olsr.h"
65 #include "lq_plugin.h"
66 #include "gateway.h"
67 #include "duplicate_handler.h"
68
69 #include <stdarg.h>
70 #include <signal.h>
71 #include <unistd.h>
72
73 bool changes_topology;
74 bool changes_neighborhood;
75 bool changes_hna;
76 bool changes_force;
77
78 /*COLLECT startup sleeps caused by warnings*/
79
80 #ifdef OLSR_COLLECT_STARTUP_SLEEP
81 static int max_startup_sleep = 0;
82 #endif
83 static int sum_startup_sleep = 0;
84
85 void olsr_startup_sleep(int s)
86 {
87   sum_startup_sleep += s;
88 #ifdef OLSR_COLLECT_STARTUP_SLEEP
89   if (s > max_startup_sleep) max_startup_sleep=s;
90 #else
91   sleep(s);
92 #endif
93 }
94
95 void olsr_do_startup_sleep(void)
96 {
97 #ifdef OLSR_COLLECT_STARTUP_SLEEP
98   if (sum_startup_sleep > max_startup_sleep)
99     printf("OLSR encountered multiple problems on startup, which should delay startup by %i seconds.\nAs this is quite much time, OLSR will sleep only %i seconds.\nBUT YOU SHOULD FIX ABOVE PROBLEMS!\n",
100            sum_startup_sleep,max_startup_sleep);
101   sleep(max_startup_sleep);
102 #else
103   if (sum_startup_sleep > 0) 
104     printf("olsrd startup was delayed %i seconds due to various nasty error messages.\nYOU SHOULD REALLY FIX ABOVE PROBLEMS!\n",
105            sum_startup_sleep);
106 #endif
107 }
108
109 /**
110  * Process changes functions
111  */
112
113 struct pcf {
114   int (*function) (int, int, int);
115   struct pcf *next;
116 };
117
118 static struct pcf *pcf_list;
119
120 static uint16_t message_seqno;
121 union olsr_ip_addr all_zero;
122
123 /**
124  *Initialize the message sequence number as a random value
125  */
126 void
127 init_msg_seqno(void)
128 {
129   message_seqno = random() & 0xFFFF;
130 }
131
132 /**
133  * Get and increment the message sequence number
134  *
135  *@return the seqno
136  */
137 uint16_t
138 get_msg_seqno(void)
139 {
140   return message_seqno++;
141 }
142
143 bool
144 olsr_is_bad_duplicate_msg_seqno(uint16_t seqno) {
145   int32_t diff = (int32_t) seqno - (int32_t) message_seqno;
146
147   if (diff < -32768) {
148     diff += 65536;
149   }
150   else if (diff > 32767) {
151     diff -= 65536;
152   }
153   return diff > 0;
154 }
155
156 void
157 register_pcf(int (*f) (int, int, int))
158 {
159   struct pcf *new_pcf;
160
161   OLSR_PRINTF(1, "Registering pcf function\n");
162
163   new_pcf = olsr_malloc(sizeof(struct pcf), "New PCF");
164
165   new_pcf->function = f;
166   new_pcf->next = pcf_list;
167   pcf_list = new_pcf;
168
169 }
170
171 /**
172  *Process changes in neighborhood or/and topology.
173  *Re-calculates the neighborhood/topology if there
174  *are any updates - then calls the right functions to
175  *update the routing table.
176  *@return 0
177  */
178 void
179 olsr_process_changes(void)
180 {
181   struct pcf *tmp_pc_list;
182
183 #ifdef DEBUG
184   if (changes_neighborhood)
185     OLSR_PRINTF(3, "CHANGES IN NEIGHBORHOOD\n");
186   if (changes_topology)
187     OLSR_PRINTF(3, "CHANGES IN TOPOLOGY\n");
188   if (changes_hna)
189     OLSR_PRINTF(3, "CHANGES IN HNA\n");
190 #endif
191
192   if (!changes_force && 2 <= olsr_cnf->lq_level && 0 >= olsr_cnf->lq_dlimit)
193     return;
194
195   if (!changes_neighborhood && !changes_topology && !changes_hna)
196     return;
197
198   if (olsr_cnf->debug_level > 0 && olsr_cnf->clear_screen && isatty(1)) {
199     clear_console();
200     printf("       *** %s (%s on %s) ***\n", olsrd_version, build_date, build_host);
201   }
202
203   if (changes_neighborhood) {
204     if (olsr_cnf->lq_level < 1) {
205       olsr_calculate_mpr();
206     } else {
207       olsr_calculate_lq_mpr();
208     }
209   }
210
211   /* calculate the routing table */
212   if (changes_neighborhood || changes_topology || changes_hna) {
213     olsr_calculate_routing_table();
214   }
215
216   if (olsr_cnf->debug_level > 0) {
217     if (olsr_cnf->debug_level > 2) {
218       olsr_print_mid_set();
219
220       if (olsr_cnf->debug_level > 3) {
221         if (olsr_cnf->debug_level > 8) {
222           olsr_print_duplicate_table();
223         }
224         olsr_print_hna_set();
225       }
226     }
227 #if 1
228     olsr_print_link_set();
229     olsr_print_neighbor_table();
230     olsr_print_two_hop_neighbor_table();
231     olsr_print_tc_table();
232
233     // TODO push this to debug level 3 or 4
234     olsr_print_gateway();
235 #endif
236   }
237
238   for (tmp_pc_list = pcf_list; tmp_pc_list != NULL; tmp_pc_list = tmp_pc_list->next) {
239     tmp_pc_list->function(changes_neighborhood, changes_topology, changes_hna);
240   }
241
242   changes_neighborhood = false;
243   changes_topology = false;
244   changes_hna = false;
245   changes_force = false;
246 }
247
248 /*
249  * Callback for the periodic route calculation.
250  */
251 void
252 olsr_trigger_forced_update(void *unused __attribute__ ((unused)))
253 {
254
255   changes_force = true;
256   changes_neighborhood = true;
257   changes_topology = true;
258   changes_hna = true;
259
260   olsr_process_changes();
261 }
262
263 /**
264  *Initialize all the tables used(neighbor,
265  *topology, MID,  HNA, MPR, dup).
266  *Also initalizes other variables
267  */
268 void
269 olsr_init_tables(void)
270 {
271   changes_topology = false;
272   changes_neighborhood = false;
273   changes_hna = false;
274
275   /* Set avl tree comparator */
276   if (olsr_cnf->ipsize == 4) {
277     avl_comp_default = avl_comp_ipv4;
278     avl_comp_prefix_default = avl_comp_ipv4_prefix;
279   } else {
280     avl_comp_default = avl_comp_ipv6;
281     avl_comp_prefix_default = avl_comp_ipv6_prefix;
282   }
283
284   /* Initialize lq plugin set */
285   init_lq_handler_tree();
286
287   /* Initialize link set */
288   olsr_init_link_set();
289
290   /* Initialize duplicate table */
291   olsr_init_duplicate_set();
292
293   /* Initialize neighbor table */
294   olsr_init_neighbor_table();
295
296   /* Initialize routing table */
297   olsr_init_routing_table();
298
299   /* Initialize two hop table */
300   olsr_init_two_hop_table();
301
302   /* Initialize topology */
303   olsr_init_tc();
304
305   /* Initialize mpr selector table */
306   olsr_init_mprs_set();
307
308   /* Initialize MID set */
309   olsr_init_mid_set();
310
311   /* Initialize HNA set */
312   olsr_init_hna_set();
313
314   /* Initialize smart gateways */
315   olsr_init_gateways();
316
317   /* Initialize duplicate handler */
318 #ifndef NO_DUPLICATE_DETECTION_HANDLER
319   olsr_duplicate_handler_init();
320 #endif
321
322   /* Start periodic SPF and RIB recalculation */
323   if (olsr_cnf->lq_dinter > 0.0) {
324     olsr_start_timer((unsigned int)(olsr_cnf->lq_dinter * MSEC_PER_SEC), 5, OLSR_TIMER_PERIODIC, &olsr_trigger_forced_update, NULL,
325                      0);
326   }
327 }
328
329 /**
330  *Check if a message is to be forwarded and forward
331  *it if necessary.
332  *
333  *@param m the OLSR message to be forwarded
334  *@param neighbour we received message from
335  *
336  *@returns positive if forwarded
337  */
338 int
339 olsr_forward_message(union olsr_message *m, struct interface *in_if, union olsr_ip_addr *from_addr)
340 {
341   union olsr_ip_addr *src;
342   struct neighbor_entry *neighbor;
343   int msgsize;
344   struct interface *ifn;
345
346
347   /*
348    * Sven-Ola: We should not flood the mesh with overdue messages. Because
349    * of a bug in parser.c:parse_packet, we have a lot of messages because
350    * all older olsrd's have lq_fish enabled.
351    */
352   if (AF_INET == olsr_cnf->ip_version) {
353     if (m->v4.ttl < 2 || 255 < (int)m->v4.hopcnt + (int)m->v4.ttl)
354       return 0;
355   } else {
356     if (m->v6.ttl < 2 || 255 < (int)m->v6.hopcnt + (int)m->v6.ttl)
357       return 0;
358   }
359
360   /* Lookup sender address */
361   src = mid_lookup_main_addr(from_addr);
362   if (!src)
363     src = from_addr;
364
365   neighbor = olsr_lookup_neighbor_table(src);
366   if (!neighbor)
367     return 0;
368
369   if (neighbor->status != SYM)
370     return 0;
371
372   /* Check MPR */
373   if (olsr_lookup_mprs_set(src) == NULL) {
374 #ifdef DEBUG
375     struct ipaddr_str buf;
376     OLSR_PRINTF(5, "Forward - sender %s not MPR selector\n", olsr_ip_to_string(&buf, src));
377 #endif
378     return 0;
379   }
380
381   if (olsr_message_is_duplicate(m)) {
382     return 0;
383   }
384
385   /* Treat TTL hopcnt */
386   if (olsr_cnf->ip_version == AF_INET) {
387     /* IPv4 */
388     m->v4.hopcnt++;
389     m->v4.ttl--;
390   } else {
391     /* IPv6 */
392     m->v6.hopcnt++;
393     m->v6.ttl--;
394   }
395
396   /* Update packet data */
397   msgsize = ntohs(m->v4.olsr_msgsize);
398
399   /* looping trough interfaces */
400   for (ifn = ifnet; ifn; ifn = ifn->int_next) {
401     if (net_output_pending(ifn)) {
402
403       /* dont forward to incoming interface if interface is mode ether */
404       if (in_if->mode == IF_MODE_ETHER && ifn == in_if) continue;
405
406       /*
407        * Check if message is to big to be piggybacked
408        */
409       if (net_outbuffer_push(ifn, m, msgsize) != msgsize) {
410         /* Send */
411         net_output(ifn);
412         /* Buffer message */
413         set_buffer_timer(ifn);
414
415         if (net_outbuffer_push(ifn, m, msgsize) != msgsize) {
416           OLSR_PRINTF(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
417           olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
418         }
419       }
420     } else {
421       /* No forwarding pending */
422       set_buffer_timer(ifn);
423
424       if (net_outbuffer_push(ifn, m, msgsize) != msgsize) {
425         OLSR_PRINTF(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
426         olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
427       }
428     }
429   }
430   return 1;
431 }
432
433 void
434 set_buffer_timer(struct interface *ifn)
435 {
436   /* Set timer */
437   ifn->fwdtimer = GET_TIMESTAMP(random() * olsr_cnf->max_jitter * MSEC_PER_SEC / RAND_MAX);
438 }
439
440 void
441 olsr_init_willingness(void)
442 {
443   if (olsr_cnf->willingness_auto) {
444
445     /* Run it first and then periodic. */
446     olsr_update_willingness(NULL);
447
448     olsr_start_timer((unsigned int)olsr_cnf->will_int * MSEC_PER_SEC, 5, OLSR_TIMER_PERIODIC, &olsr_update_willingness, NULL, 0);
449   }
450 }
451
452 void
453 olsr_update_willingness(void *foo __attribute__ ((unused)))
454 {
455   int tmp_will = olsr_cnf->willingness;
456
457   /* Re-calculate willingness */
458   olsr_cnf->willingness = olsr_calculate_willingness();
459
460   if (tmp_will != olsr_cnf->willingness) {
461     OLSR_PRINTF(1, "Local willingness updated: old %d new %d\n", tmp_will, olsr_cnf->willingness);
462   }
463 }
464
465 /**
466  *Calculate this nodes willingness to act as a MPR
467  *based on either a fixed value or the power status
468  *of the node using APM
469  *
470  *@return a 8bit value from 0-7 representing the willingness
471  */
472
473 uint8_t
474 olsr_calculate_willingness(void)
475 {
476   struct olsr_apm_info ainfo;
477
478   /* If fixed willingness */
479   if (!olsr_cnf->willingness_auto)
480     return olsr_cnf->willingness;
481
482   if (apm_read(&ainfo) < 1)
483     return WILL_DEFAULT;
484
485   apm_printinfo(&ainfo);
486
487   /* If AC powered */
488   if (ainfo.ac_line_status == OLSR_AC_POWERED)
489     return 6;
490
491   /* If battery powered
492    *
493    * juice > 78% will: 3
494    * 78% > juice > 26% will: 2
495    * 26% > juice will: 1
496    */
497   return (ainfo.battery_percentage / 26);
498 }
499
500 const char *
501 olsr_msgtype_to_string(uint8_t msgtype)
502 {
503   static char type[20];
504
505   switch (msgtype) {
506   case (HELLO_MESSAGE):
507     return "HELLO";
508   case (TC_MESSAGE):
509     return "TC";
510   case (MID_MESSAGE):
511     return "MID";
512   case (HNA_MESSAGE):
513     return "HNA";
514   case (LQ_HELLO_MESSAGE):
515     return ("LQ-HELLO");
516   case (LQ_TC_MESSAGE):
517     return ("LQ-TC");
518   default:
519     break;
520   }
521
522   snprintf(type, sizeof(type), "UNKNOWN(%d)", msgtype);
523   return type;
524 }
525
526 const char *
527 olsr_link_to_string(uint8_t linktype)
528 {
529   static char type[20];
530
531   switch (linktype) {
532   case (UNSPEC_LINK):
533     return "UNSPEC";
534   case (ASYM_LINK):
535     return "ASYM";
536   case (SYM_LINK):
537     return "SYM";
538   case (LOST_LINK):
539     return "LOST";
540   case (HIDE_LINK):
541     return "HIDE";
542   default:
543     break;
544   }
545
546   snprintf(type, sizeof(type), "UNKNOWN(%d)", linktype);
547   return type;
548 }
549
550 const char *
551 olsr_status_to_string(uint8_t status)
552 {
553   static char type[20];
554
555   switch (status) {
556   case (NOT_NEIGH):
557     return "NOT NEIGH";
558   case (SYM_NEIGH):
559     return "NEIGHBOR";
560   case (MPR_NEIGH):
561     return "MPR";
562   default:
563     break;
564   }
565
566   snprintf(type, sizeof(type), "UNKNOWN(%d)", status);
567   return type;
568 }
569
570 /**
571  *Termination function to be called whenever a error occures
572  *that requires the daemon to terminate
573  *
574  *@param msg the message to write to the syslog and possibly stdout
575  */
576
577 void
578 olsr_exit(const char *msg, int val)
579 {
580   OLSR_PRINTF(1, "OLSR EXIT: %s\n", msg);
581   olsr_syslog(OLSR_LOG_ERR, "olsrd exit: %s\n", msg);
582   fflush(stdout);
583   olsr_cnf->exit_value = val;
584
585   raise(SIGTERM);
586 }
587
588 /**
589  * Wrapper for malloc(3) that does error-checking
590  *
591  * @param size the number of bytes to allocalte
592  * @param caller a string identifying the caller for
593  * use in error messaging
594  *
595  * @return a void pointer to the memory allocated
596  */
597 void *
598 olsr_malloc(size_t size, const char *id)
599 {
600   void *ptr;
601
602   /*
603    * Not all the callers do a proper cleaning of memory.
604    * Clean it on behalf of those.
605    */
606   ptr = calloc(1, size);
607
608   if (!ptr) {
609     const char *const err_msg = strerror(errno);
610     OLSR_PRINTF(1, "OUT OF MEMORY: %s\n", err_msg);
611     olsr_syslog(OLSR_LOG_ERR, "olsrd: out of memory!: %s\n", err_msg);
612     olsr_exit(id, EXIT_FAILURE);
613   }
614 #if 0
615   /* useful for debugging */
616   olsr_printf(1, "MEMORY: alloc %s %p, %u bytes\n", id, ptr, size);
617 #endif
618
619   return ptr;
620 }
621
622 /**
623  *Wrapper for printf that prints to a specific
624  *debuglevel upper limit
625  *
626  */
627
628 int
629 olsr_printf(int loglevel, const char *format, ...)
630 {
631   if ((loglevel <= olsr_cnf->debug_level) && debug_handle) {
632     va_list arglist;
633     va_start(arglist, format);
634     vfprintf(debug_handle, format, arglist);
635     va_end(arglist);
636   }
637   return 0;
638 }
639
640 /*
641  * Local Variables:
642  * c-basic-offset: 2
643  * indent-tabs-mode: nil
644  * End:
645  */