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