78316ca6b6b8fbb234757e35f49a58491ecb0cea
[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 #ifdef LINUX_NETLINK_ROUTING
220     olsr_print_gateway_entries();
221 #endif
222
223       if (olsr_cnf->debug_level > 3) {
224         if (olsr_cnf->debug_level > 8) {
225           olsr_print_duplicate_table();
226         }
227         olsr_print_hna_set();
228       }
229     }
230     olsr_print_link_set();
231     olsr_print_neighbor_table();
232     olsr_print_two_hop_neighbor_table();
233     olsr_print_tc_table();
234   }
235
236   for (tmp_pc_list = pcf_list; tmp_pc_list != NULL; tmp_pc_list = tmp_pc_list->next) {
237     tmp_pc_list->function(changes_neighborhood, changes_topology, changes_hna);
238   }
239
240   changes_neighborhood = false;
241   changes_topology = false;
242   changes_hna = false;
243   changes_force = false;
244 }
245
246 /*
247  * Callback for the periodic route calculation.
248  */
249 void
250 olsr_trigger_forced_update(void *unused __attribute__ ((unused)))
251 {
252
253   changes_force = true;
254   changes_neighborhood = true;
255   changes_topology = true;
256   changes_hna = true;
257
258   olsr_process_changes();
259 }
260
261 /**
262  *Initialize all the tables used(neighbor,
263  *topology, MID,  HNA, MPR, dup).
264  *Also initalizes other variables
265  */
266 void
267 olsr_init_tables(void)
268 {
269   changes_topology = false;
270   changes_neighborhood = false;
271   changes_hna = false;
272
273   /* Set avl tree comparator */
274   if (olsr_cnf->ipsize == 4) {
275     avl_comp_default = avl_comp_ipv4;
276     avl_comp_prefix_default = avl_comp_ipv4_prefix;
277   } else {
278     avl_comp_default = avl_comp_ipv6;
279     avl_comp_prefix_default = avl_comp_ipv6_prefix;
280   }
281
282   /* Initialize lq plugin set */
283   init_lq_handler_tree();
284
285   /* Initialize link set */
286   olsr_init_link_set();
287
288   /* Initialize duplicate table */
289   olsr_init_duplicate_set();
290
291   /* Initialize neighbor table */
292   olsr_init_neighbor_table();
293
294   /* Initialize routing table */
295   olsr_init_routing_table();
296
297   /* Initialize two hop table */
298   olsr_init_two_hop_table();
299
300   /* Initialize topology */
301   olsr_init_tc();
302
303   /* Initialize mpr selector table */
304   olsr_init_mprs_set();
305
306   /* Initialize MID set */
307   olsr_init_mid_set();
308
309   /* Initialize HNA set */
310   olsr_init_hna_set();
311
312   /* Initialize duplicate handler */
313 #ifndef NO_DUPLICATE_DETECTION_HANDLER
314   olsr_duplicate_handler_init();
315 #endif
316
317   /* Start periodic SPF and RIB recalculation */
318   if (olsr_cnf->lq_dinter > 0.0) {
319     olsr_start_timer((unsigned int)(olsr_cnf->lq_dinter * MSEC_PER_SEC), 5, OLSR_TIMER_PERIODIC, &olsr_trigger_forced_update, NULL,
320                      0);
321   }
322 }
323
324 /**
325  *Check if a message is to be forwarded and forward
326  *it if necessary.
327  *
328  *@param m the OLSR message to be forwarded
329  *@param neighbour we received message from
330  *
331  *@returns positive if forwarded
332  */
333 int
334 olsr_forward_message(union olsr_message *m, struct interface *in_if, union olsr_ip_addr *from_addr)
335 {
336   union olsr_ip_addr *src;
337   struct neighbor_entry *neighbor;
338   int msgsize;
339   struct interface *ifn;
340
341
342   /*
343    * Sven-Ola: We should not flood the mesh with overdue messages. Because
344    * of a bug in parser.c:parse_packet, we have a lot of messages because
345    * all older olsrd's have lq_fish enabled.
346    */
347   if (AF_INET == olsr_cnf->ip_version) {
348     if (m->v4.ttl < 2 || 255 < (int)m->v4.hopcnt + (int)m->v4.ttl)
349       return 0;
350   } else {
351     if (m->v6.ttl < 2 || 255 < (int)m->v6.hopcnt + (int)m->v6.ttl)
352       return 0;
353   }
354
355   /* Lookup sender address */
356   src = mid_lookup_main_addr(from_addr);
357   if (!src)
358     src = from_addr;
359
360   neighbor = olsr_lookup_neighbor_table(src);
361   if (!neighbor)
362     return 0;
363
364   if (neighbor->status != SYM)
365     return 0;
366
367   /* Check MPR */
368   if (olsr_lookup_mprs_set(src) == NULL) {
369 #ifdef DEBUG
370     struct ipaddr_str buf;
371     OLSR_PRINTF(5, "Forward - sender %s not MPR selector\n", olsr_ip_to_string(&buf, src));
372 #endif
373     return 0;
374   }
375
376   if (olsr_message_is_duplicate(m)) {
377     return 0;
378   }
379
380   /* Treat TTL hopcnt */
381   if (olsr_cnf->ip_version == AF_INET) {
382     /* IPv4 */
383     m->v4.hopcnt++;
384     m->v4.ttl--;
385   } else {
386     /* IPv6 */
387     m->v6.hopcnt++;
388     m->v6.ttl--;
389   }
390
391   /* Update packet data */
392   msgsize = ntohs(m->v4.olsr_msgsize);
393
394   /* looping trough interfaces */
395   for (ifn = ifnet; ifn; ifn = ifn->int_next) {
396     if (net_output_pending(ifn)) {
397
398       /* dont forward to incoming interface if interface is mode ether */
399       if (in_if->mode == IF_MODE_ETHER && ifn == in_if) continue;
400
401       /*
402        * Check if message is to big to be piggybacked
403        */
404       if (net_outbuffer_push(ifn, m, msgsize) != msgsize) {
405         /* Send */
406         net_output(ifn);
407         /* Buffer message */
408         set_buffer_timer(ifn);
409
410         if (net_outbuffer_push(ifn, m, msgsize) != msgsize) {
411           OLSR_PRINTF(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
412           olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
413         }
414       }
415     } else {
416       /* No forwarding pending */
417       set_buffer_timer(ifn);
418
419       if (net_outbuffer_push(ifn, m, msgsize) != msgsize) {
420         OLSR_PRINTF(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
421         olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
422       }
423     }
424   }
425   return 1;
426 }
427
428 void
429 set_buffer_timer(struct interface *ifn)
430 {
431   /* Set timer */
432   ifn->fwdtimer = GET_TIMESTAMP(random() * olsr_cnf->max_jitter * MSEC_PER_SEC / RAND_MAX);
433 }
434
435 void
436 olsr_init_willingness(void)
437 {
438   if (olsr_cnf->willingness_auto) {
439
440     /* Run it first and then periodic. */
441     olsr_update_willingness(NULL);
442
443     olsr_start_timer((unsigned int)olsr_cnf->will_int * MSEC_PER_SEC, 5, OLSR_TIMER_PERIODIC, &olsr_update_willingness, NULL, 0);
444   }
445 }
446
447 void
448 olsr_update_willingness(void *foo __attribute__ ((unused)))
449 {
450   int tmp_will = olsr_cnf->willingness;
451
452   /* Re-calculate willingness */
453   olsr_cnf->willingness = olsr_calculate_willingness();
454
455   if (tmp_will != olsr_cnf->willingness) {
456     OLSR_PRINTF(1, "Local willingness updated: old %d new %d\n", tmp_will, olsr_cnf->willingness);
457   }
458 }
459
460 /**
461  *Calculate this nodes willingness to act as a MPR
462  *based on either a fixed value or the power status
463  *of the node using APM
464  *
465  *@return a 8bit value from 0-7 representing the willingness
466  */
467
468 uint8_t
469 olsr_calculate_willingness(void)
470 {
471   struct olsr_apm_info ainfo;
472
473   /* If fixed willingness */
474   if (!olsr_cnf->willingness_auto)
475     return olsr_cnf->willingness;
476
477   if (apm_read(&ainfo) < 1)
478     return WILL_DEFAULT;
479
480   apm_printinfo(&ainfo);
481
482   /* If AC powered */
483   if (ainfo.ac_line_status == OLSR_AC_POWERED)
484     return 6;
485
486   /* If battery powered
487    *
488    * juice > 78% will: 3
489    * 78% > juice > 26% will: 2
490    * 26% > juice will: 1
491    */
492   return (ainfo.battery_percentage / 26);
493 }
494
495 const char *
496 olsr_msgtype_to_string(uint8_t msgtype)
497 {
498   static char type[20];
499
500   switch (msgtype) {
501   case (HELLO_MESSAGE):
502     return "HELLO";
503   case (TC_MESSAGE):
504     return "TC";
505   case (MID_MESSAGE):
506     return "MID";
507   case (HNA_MESSAGE):
508     return "HNA";
509   case (LQ_HELLO_MESSAGE):
510     return ("LQ-HELLO");
511   case (LQ_TC_MESSAGE):
512     return ("LQ-TC");
513   default:
514     break;
515   }
516
517   snprintf(type, sizeof(type), "UNKNOWN(%d)", msgtype);
518   return type;
519 }
520
521 const char *
522 olsr_link_to_string(uint8_t linktype)
523 {
524   static char type[20];
525
526   switch (linktype) {
527   case (UNSPEC_LINK):
528     return "UNSPEC";
529   case (ASYM_LINK):
530     return "ASYM";
531   case (SYM_LINK):
532     return "SYM";
533   case (LOST_LINK):
534     return "LOST";
535   case (HIDE_LINK):
536     return "HIDE";
537   default:
538     break;
539   }
540
541   snprintf(type, sizeof(type), "UNKNOWN(%d)", linktype);
542   return type;
543 }
544
545 const char *
546 olsr_status_to_string(uint8_t status)
547 {
548   static char type[20];
549
550   switch (status) {
551   case (NOT_NEIGH):
552     return "NOT NEIGH";
553   case (SYM_NEIGH):
554     return "NEIGHBOR";
555   case (MPR_NEIGH):
556     return "MPR";
557   default:
558     break;
559   }
560
561   snprintf(type, sizeof(type), "UNKNOWN(%d)", status);
562   return type;
563 }
564
565 /**
566  *Termination function to be called whenever a error occures
567  *that requires the daemon to terminate
568  *
569  *@param msg the message to write to the syslog and possibly stdout
570  */
571
572 void
573 olsr_exit(const char *msg, int val)
574 {
575   OLSR_PRINTF(1, "OLSR EXIT: %s\n", msg);
576   olsr_syslog(OLSR_LOG_ERR, "olsrd exit: %s\n", msg);
577   fflush(stdout);
578   olsr_cnf->exit_value = val;
579
580   raise(SIGTERM);
581 }
582
583 /**
584  * Wrapper for malloc(3) that does error-checking
585  *
586  * @param size the number of bytes to allocalte
587  * @param caller a string identifying the caller for
588  * use in error messaging
589  *
590  * @return a void pointer to the memory allocated
591  */
592 void *
593 olsr_malloc(size_t size, const char *id)
594 {
595   void *ptr;
596
597   /*
598    * Not all the callers do a proper cleaning of memory.
599    * Clean it on behalf of those.
600    */
601   ptr = calloc(1, size);
602
603   if (!ptr) {
604     const char *const err_msg = strerror(errno);
605     OLSR_PRINTF(1, "OUT OF MEMORY: %s\n", err_msg);
606     olsr_syslog(OLSR_LOG_ERR, "olsrd: out of memory!: %s\n", err_msg);
607     olsr_exit(id, EXIT_FAILURE);
608   }
609 #if 0
610   /* useful for debugging */
611   olsr_printf(1, "MEMORY: alloc %s %p, %u bytes\n", id, ptr, size);
612 #endif
613
614   return ptr;
615 }
616
617 /**
618  *Wrapper for printf that prints to a specific
619  *debuglevel upper limit
620  *
621  */
622
623 int
624 olsr_printf(int loglevel, const char *format, ...)
625 {
626   if ((loglevel <= olsr_cnf->debug_level) && debug_handle) {
627     va_list arglist;
628     va_start(arglist, format);
629     vfprintf(debug_handle, format, arglist);
630     va_end(arglist);
631   }
632   return 0;
633 }
634
635 /*
636  * Local Variables:
637  * c-basic-offset: 2
638  * indent-tabs-mode: nil
639  * End:
640  */