* killed lots of #ifdef ... #endif which make the source quite unreadable
[olsrd.git] / src / olsr.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without 
7  * modification, are permitted provided that the following conditions 
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright 
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright 
13  *   notice, this list of conditions and the following disclaimer in 
14  *   the documentation and/or other materials provided with the 
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its 
17  *   contributors may be used to endorse or promote products derived 
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  */
40
41 /**
42  * All these functions are global
43  */
44
45 #include "defs.h"
46 #include "olsr.h"
47 #include "link_set.h"
48 #include "two_hop_neighbor_table.h"
49 #include "tc_set.h"
50 #include "duplicate_set.h"
51 #include "mpr_selector_set.h"
52 #include "mid_set.h"
53 #include "mpr.h"
54 #include "lq_mpr.h"
55 #include "olsr_spf.h"
56 #include "scheduler.h"
57 #include "apm.h"
58 #include "misc.h"
59 #include "neighbor_table.h"
60 #include "log.h"
61 #include "lq_packet.h"
62 #include "common/avl.h"
63 #include "net_olsr.h"
64 #include "lq_plugin.h"
65
66 #include <stdarg.h>
67 #include <signal.h>
68
69
70 olsr_bool changes_topology;
71 olsr_bool changes_neighborhood;
72 olsr_bool changes_hna;
73 olsr_bool changes_force;
74
75 /**
76  * Process changes functions
77  */
78
79 struct pcf
80 {
81   int (*function)(int, int, int);
82   struct pcf *next;
83 };
84
85 static struct pcf *pcf_list;
86
87 static olsr_u16_t message_seqno;
88 union olsr_ip_addr all_zero;
89
90 /**
91  *Initialize the message sequence number as a random value
92  */
93 void
94 init_msg_seqno(void)
95 {
96   message_seqno = random() & 0xFFFF;
97 }
98
99 /**
100  * Get and increment the message sequence number
101  *
102  *@return the seqno
103  */
104 olsr_u16_t
105 get_msg_seqno(void)
106 {
107   return message_seqno++;
108 }
109
110
111 void
112 register_pcf(int (*f)(int, int, int))
113 {
114   struct pcf *new_pcf;
115
116   OLSR_PRINTF(1, "Registering pcf function\n");
117
118   new_pcf = olsr_malloc(sizeof(struct pcf), "New PCF");
119
120   new_pcf->function = f;
121   new_pcf->next = pcf_list;
122   pcf_list = new_pcf;
123
124 }
125
126
127 /**
128  *Process changes in neighborhood or/and topology.
129  *Re-calculates the neighborhood/topology if there
130  *are any updates - then calls the right functions to
131  *update the routing table.
132  *@return 0
133  */
134 void
135 olsr_process_changes(void)
136 {
137   struct pcf *tmp_pc_list;
138
139 #ifdef DEBUG
140   if(changes_neighborhood)
141     OLSR_PRINTF(3, "CHANGES IN NEIGHBORHOOD\n");
142   if(changes_topology)
143     OLSR_PRINTF(3, "CHANGES IN TOPOLOGY\n");
144   if(changes_hna)
145     OLSR_PRINTF(3, "CHANGES IN HNA\n");
146 #endif
147   
148   if(!changes_force &&
149      2 <= olsr_cnf->lq_level &&
150      0 >= olsr_cnf->lq_dlimit)
151     return;
152     
153   if(!changes_neighborhood &&
154      !changes_topology &&
155      !changes_hna)
156     return;
157
158   if (olsr_cnf->debug_level > 0 && olsr_cnf->clear_screen && isatty(1))
159   {
160       clear_console();
161       printf("       *** %s (%s on %s) ***\n", olsrd_version, build_date, build_host);
162   }
163
164   if (changes_neighborhood) {
165     if (olsr_cnf->lq_level < 1) {
166       olsr_calculate_mpr();
167     } else {
168       olsr_calculate_lq_mpr();
169     }
170   }
171
172   /* calculate the routing table */
173   if (changes_neighborhood || changes_topology || changes_hna) {
174     olsr_calculate_routing_table();
175   }
176   
177   if (olsr_cnf->debug_level > 0)
178     {      
179       if (olsr_cnf->debug_level > 2) 
180         {
181           olsr_print_mid_set();
182           
183           if (olsr_cnf->debug_level > 3)
184             {
185              if (olsr_cnf->debug_level > 8)
186                {
187                  olsr_print_duplicate_table();
188                }
189               olsr_print_hna_set();
190             }
191         }
192
193 #if 1     
194       olsr_print_link_set();
195       olsr_print_neighbor_table();
196       olsr_print_two_hop_neighbor_table();
197       olsr_print_tc_table();
198 #endif
199     }
200
201   for(tmp_pc_list = pcf_list; 
202       tmp_pc_list != NULL;
203       tmp_pc_list = tmp_pc_list->next)
204     {
205       tmp_pc_list->function(changes_neighborhood,
206                             changes_topology,
207                             changes_hna);
208     }
209
210   changes_neighborhood = OLSR_FALSE;
211   changes_topology = OLSR_FALSE;
212   changes_hna = OLSR_FALSE;
213   changes_force = OLSR_FALSE;
214 }
215
216 /*
217  * Callback for the periodic route calculation.
218  */
219 void
220 olsr_trigger_forced_update(void *unused __attribute__((unused))) {
221
222   changes_force = OLSR_TRUE;
223   changes_neighborhood = OLSR_TRUE;
224   changes_topology = OLSR_TRUE;
225   changes_hna = OLSR_TRUE;
226   
227   olsr_process_changes();
228 }
229
230 /**
231  *Initialize all the tables used(neighbor,
232  *topology, MID,  HNA, MPR, dup).
233  *Also initalizes other variables
234  */
235 void
236 olsr_init_tables(void)
237 {  
238   changes_topology = OLSR_FALSE;
239   changes_neighborhood = OLSR_FALSE;
240   changes_hna = OLSR_FALSE;
241
242   /* Set avl tree comparator */
243   if (olsr_cnf->ipsize == 4) {
244     avl_comp_default = avl_comp_ipv4;
245     avl_comp_prefix_default = avl_comp_ipv4_prefix;
246   } else {
247     avl_comp_default = avl_comp_ipv6;
248     avl_comp_prefix_default = avl_comp_ipv6_prefix;
249   }
250
251   /* Initialize lq plugin set */
252   init_lq_handler_tree();
253   
254   /* Initialize link set */
255   olsr_init_link_set();
256
257   /* Initialize duplicate table */
258   olsr_init_duplicate_set();
259
260   /* Initialize neighbor table */
261   olsr_init_neighbor_table();
262
263   /* Initialize routing table */
264   olsr_init_routing_table();
265
266   /* Initialize two hop table */
267   olsr_init_two_hop_table();
268
269   /* Initialize topology */
270   olsr_init_tc();
271
272   /* Initialize mpr selector table */
273   olsr_init_mprs_set();
274
275   /* Initialize MID set */
276   olsr_init_mid_set();
277
278   /* Initialize HNA set */
279   olsr_init_hna_set();  
280
281 #if 0
282   /* Initialize Layer 1/2 database */
283   olsr_initialize_layer12();
284 #endif
285   
286   /* Start periodic SPF and RIB recalculation */
287   if (olsr_cnf->lq_dinter > 0.0) {
288     olsr_start_timer((unsigned int)(olsr_cnf->lq_dinter * MSEC_PER_SEC), 5,
289                      OLSR_TIMER_PERIODIC, &olsr_trigger_forced_update, NULL, 0);
290   }
291 }
292
293 /**
294  *Check if a message is to be forwarded and forward
295  *it if necessary.
296  *
297  *@param m the OLSR message recieved
298  *@param originator the originator of this message
299  *@param seqno the seqno of the message
300  *
301  *@returns positive if forwarded
302  */
303 int
304 olsr_forward_message(union olsr_message *m, 
305                      union olsr_ip_addr *from_addr)
306 {
307   union olsr_ip_addr *src;
308   struct neighbor_entry *neighbor;
309   int msgsize;
310   struct interface *ifn;
311
312   /*
313    * Sven-Ola: We should not flood the mesh with overdue messages. Because
314    * of a bug in parser.c:parse_packet, we have a lot of messages because
315    * all older olsrd's have lq_fish enabled.
316    */
317   if (AF_INET == olsr_cnf->ip_version)
318   {
319     if (2 > m->v4.ttl || 255 < (int)m->v4.hopcnt + (int)m->v4.ttl) return 0;
320   }
321   else
322   {
323     if (2 > m->v6.ttl || 255 < (int)m->v6.hopcnt + (int)m->v6.ttl) return 0;
324   }
325
326   /* Lookup sender address */
327   src = mid_lookup_main_addr(from_addr);
328   if(!src)
329     src = from_addr;
330
331   neighbor=olsr_lookup_neighbor_table(src);
332   if(!neighbor)
333     return 0;
334
335   if(neighbor->status != SYM)
336     return 0;
337
338   /* Check MPR */
339   if(olsr_lookup_mprs_set(src) == NULL)
340     {
341 #ifdef DEBUG
342       struct ipaddr_str buf;
343       OLSR_PRINTF(5, "Forward - sender %s not MPR selector\n", olsr_ip_to_string(&buf, src));
344 #endif
345       return 0;
346     }
347
348   /* Treat TTL hopcnt */
349   if(olsr_cnf->ip_version == AF_INET)
350     {
351       /* IPv4 */
352       m->v4.hopcnt++;
353       m->v4.ttl--; 
354     }
355   else
356     {
357       /* IPv6 */
358       m->v6.hopcnt++;
359       m->v6.ttl--; 
360     }
361
362   /* Update packet data */
363   msgsize = ntohs(m->v4.olsr_msgsize);
364
365   /* looping trough interfaces */
366   for (ifn = ifnet; ifn ; ifn = ifn->int_next) 
367     { 
368       if(net_output_pending(ifn))
369         {
370           /*
371            * Check if message is to big to be piggybacked
372            */
373           if(net_outbuffer_push(ifn, m, msgsize) != msgsize)
374             {
375               /* Send */
376               net_output(ifn);
377               /* Buffer message */
378               set_buffer_timer(ifn);
379               
380               if(net_outbuffer_push(ifn, m, msgsize) != msgsize)
381                 {
382                   OLSR_PRINTF(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
383                   olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
384                 }
385             }
386         }
387       else
388         {
389           /* No forwarding pending */
390           set_buffer_timer(ifn);
391           
392           if(net_outbuffer_push(ifn, m, msgsize) != msgsize)
393             {
394               OLSR_PRINTF(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
395               olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
396             }
397         }
398     }
399   return 1;
400 }
401
402
403 void
404 set_buffer_timer(struct interface *ifn)
405 {      
406   /* Set timer */
407   ifn->fwdtimer = GET_TIMESTAMP(random() * olsr_cnf->max_jitter * 1000 / RAND_MAX);
408 }
409
410 void
411 olsr_init_willingness(void)
412 {
413   if (olsr_cnf->willingness_auto) {
414
415     /* Run it first and then periodic. */
416     olsr_update_willingness(NULL);
417
418     olsr_start_timer((unsigned int)olsr_cnf->will_int * MSEC_PER_SEC, 5,
419                      OLSR_TIMER_PERIODIC, &olsr_update_willingness, NULL, 0);
420   }
421 }
422
423 void
424 olsr_update_willingness(void *foo __attribute__((unused)))
425 {
426   int tmp_will = olsr_cnf->willingness;
427
428   /* Re-calculate willingness */
429   olsr_cnf->willingness = olsr_calculate_willingness();
430
431   if(tmp_will != olsr_cnf->willingness)
432     {
433       OLSR_PRINTF(1, "Local willingness updated: old %d new %d\n", tmp_will, olsr_cnf->willingness);
434     }
435 }
436
437
438 /**
439  *Calculate this nodes willingness to act as a MPR
440  *based on either a fixed value or the power status
441  *of the node using APM
442  *
443  *@return a 8bit value from 0-7 representing the willingness
444  */
445
446 olsr_u8_t
447 olsr_calculate_willingness(void)
448 {
449   struct olsr_apm_info ainfo;
450
451   /* If fixed willingness */
452   if(!olsr_cnf->willingness_auto)
453     return olsr_cnf->willingness;
454
455   if(apm_read(&ainfo) < 1)
456     return WILL_DEFAULT;
457
458   apm_printinfo(&ainfo);
459
460   /* If AC powered */
461   if(ainfo.ac_line_status == OLSR_AC_POWERED)
462     return 6;
463
464   /* If battery powered 
465    *
466    * juice > 78% will: 3
467    * 78% > juice > 26% will: 2
468    * 26% > juice will: 1
469    */
470   return (ainfo.battery_percentage / 26);
471 }
472
473 const char *
474 olsr_msgtype_to_string(olsr_u8_t msgtype)
475 {
476   static char type[20];
477
478   switch(msgtype)
479     {
480     case(HELLO_MESSAGE):
481       return "HELLO";
482     case(TC_MESSAGE):
483       return "TC";
484     case(MID_MESSAGE):
485       return "MID";
486     case(HNA_MESSAGE):
487       return "HNA";
488     case(LQ_HELLO_MESSAGE):
489       return("LQ-HELLO");
490     case(LQ_TC_MESSAGE):
491       return("LQ-TC");
492     default:
493       break;
494     }
495
496   snprintf(type, sizeof(type), "UNKNOWN(%d)", msgtype);
497   return type;
498 }
499
500
501 const char *
502 olsr_link_to_string(olsr_u8_t linktype)
503 {
504   static char type[20];
505
506   switch(linktype)
507     {
508     case(UNSPEC_LINK):
509       return "UNSPEC";
510     case(ASYM_LINK):
511       return "ASYM";
512     case(SYM_LINK):
513       return "SYM";
514     case(LOST_LINK):
515       return "LOST";
516     case(HIDE_LINK):
517       return "HIDE";
518     default:
519       break;
520     }
521
522   snprintf(type, sizeof(type), "UNKNOWN(%d)", linktype);
523   return type;
524 }
525
526
527 const char *
528 olsr_status_to_string(olsr_u8_t status)
529 {
530   static char type[20];
531
532   switch(status)
533     {
534     case(NOT_NEIGH):
535       return "NOT NEIGH";
536     case(SYM_NEIGH):
537       return "NEIGHBOR";
538     case(MPR_NEIGH):
539       return "MPR";
540     default:
541       break;
542     }
543
544   snprintf(type, sizeof(type), "UNKNOWN(%d)", status);
545   return type;
546 }
547
548
549 /**
550  *Termination function to be called whenever a error occures
551  *that requires the daemon to terminate
552  *
553  *@param msg the message to write to the syslog and possibly stdout
554  */
555
556 void
557 olsr_exit(const char *msg, int val)
558 {
559   OLSR_PRINTF(1, "OLSR EXIT: %s\n", msg);
560   olsr_syslog(OLSR_LOG_ERR, "olsrd exit: %s\n", msg);
561   fflush(stdout);
562   olsr_cnf->exit_value = val;
563
564   raise(SIGTERM);
565 }
566
567
568 /**
569  * Wrapper for malloc(3) that does error-checking
570  *
571  * @param size the number of bytes to allocalte
572  * @param caller a string identifying the caller for
573  * use in error messaging
574  *
575  * @return a void pointer to the memory allocated
576  */
577 void *
578 olsr_malloc(size_t size, const char *id)
579 {
580   void *ptr;
581
582   /*
583    * Not all the callers do a proper cleaning of memory.
584    * Clean it on behalf of those.
585    */
586   ptr = calloc(1, size);
587
588   if (!ptr) {
589       const char * const err_msg = strerror(errno);
590       OLSR_PRINTF(1, "OUT OF MEMORY: %s\n", err_msg);
591       olsr_syslog(OLSR_LOG_ERR, "olsrd: out of memory!: %s\n", err_msg);
592       olsr_exit(id, EXIT_FAILURE);
593   }
594
595 #if 0 
596   /* useful for debugging */
597   olsr_printf(1, "MEMORY: alloc %s %p, %u bytes\n",
598               id, ptr, size);
599 #endif
600
601   return ptr;
602 }
603
604
605 /**
606  *Wrapper for printf that prints to a specific
607  *debuglevel upper limit
608  *
609  */
610
611 int
612 olsr_printf(int loglevel, const char *format, ...)
613 {
614   if((loglevel <= olsr_cnf->debug_level) && debug_handle)
615     {
616       va_list arglist;
617       va_start(arglist, format);
618       vfprintf(debug_handle, format, arglist);
619       va_end(arglist);
620     }
621   return 0;
622 }
623
624 /*
625  * Local Variables:
626  * c-basic-offset: 2
627  * End:
628  */