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