Added fixes based on reports from the flawfinder tool, they are not all nessecarry...
[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  * $Id: olsr.c,v 1.35 2004/12/15 17:21:01 kattemat Exp $
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 "lq_route.h"
57 #include "scheduler.h"
58 #include "generate_msg.h"
59 #include "apm.h"
60 #include "misc.h"
61
62 #include <stdarg.h>
63 #include <signal.h>
64
65
66 /**
67  *Checks if a timer has timed out.
68  */
69
70
71 /**
72  *Initiates a "timer", wich is a timeval structure,
73  *with the value given in time_value.
74  *@param time_value the value to initialize the timer with
75  *@param hold_timer the timer itself
76  *@return nada
77  */
78 inline void
79 olsr_init_timer(olsr_u32_t time_value, struct timeval *hold_timer)
80
81   olsr_u16_t  time_value_sec;
82   olsr_u16_t  time_value_msec;
83
84   time_value_sec = time_value/1000;
85   time_value_msec = time_value-(time_value_sec*1000);
86
87   hold_timer->tv_sec = time_value_sec;
88   hold_timer->tv_usec = time_value_msec*1000;   
89 }
90
91
92
93
94
95 /**
96  *Generaties a timestamp a certain number of milliseconds
97  *into the future.
98  *
99  *@param time_value how many milliseconds from now
100  *@param hold_timer the timer itself
101  *@return nada
102  */
103 inline void
104 olsr_get_timestamp(olsr_u32_t delay, struct timeval *hold_timer)
105
106   hold_timer->tv_sec = now.tv_sec + delay / 1000;
107   hold_timer->tv_usec = now.tv_usec + (delay % 1000) * 1000;
108   
109   if (hold_timer->tv_usec > 1000000)
110     {
111       hold_timer->tv_sec++;
112       hold_timer->tv_usec -= 1000000;
113     }
114 }
115
116
117
118 /**
119  *Initialize the message sequence number as a random value
120  */
121 void
122 init_msg_seqno()
123 {
124   message_seqno = random() & 0xFFFF;
125 }
126
127 /**
128  * Get and increment the message sequence number
129  *
130  *@return the seqno
131  */
132 inline olsr_u16_t
133 get_msg_seqno()
134 {
135   return message_seqno++;
136 }
137
138
139 void
140 register_pcf(int (*f)(int, int, int))
141 {
142   struct pcf *new_pcf;
143
144   olsr_printf(1, "Registering pcf function\n");
145
146   new_pcf = olsr_malloc(sizeof(struct pcf), "New PCF");
147
148   new_pcf->function = f;
149   new_pcf->next = pcf_list;
150   pcf_list = new_pcf;
151
152 }
153
154
155 /**
156  *Process changes in neighborhood or/and topology.
157  *Re-calculates the neighborhooh/topology if there
158  *are any updates - then calls the right functions to
159  *update the routing table.
160  *@return 0
161  */
162 void
163 olsr_process_changes()
164 {
165
166   struct pcf *tmp_pc_list;
167
168 #ifdef DEBUG
169   if(changes_neighborhood)
170     olsr_printf(3, "CHANGES IN NEIGHBORHOOD\n");
171   if(changes_topology)
172     olsr_printf(3, "CHANGES IN TOPOLOGY\n");
173   if(changes_hna)
174     olsr_printf(3, "CHANGES IN HNA\n");  
175 #endif
176   
177   if(!changes_neighborhood &&
178      !changes_topology &&
179      !changes_hna)
180     return;
181
182   if (olsr_cnf->debug_level > 0 && olsr_cnf->clear_screen && isatty(1))
183   {
184       clear_console();
185       printf("%s", OLSRD_VERSION_DATE);
186   }
187
188   if (changes_neighborhood)
189     {
190       /* Calculate new mprs, HNA and routing table */
191       if (olsr_cnf->lq_level < 1)
192         {
193           olsr_calculate_mpr();
194         }
195
196       else
197         {
198           olsr_calculate_lq_mpr();
199         }
200
201       if (olsr_cnf->lq_level < 2)
202         {
203           olsr_calculate_routing_table();
204         }
205
206       else
207         {
208           olsr_calculate_lq_routing_table();
209         }
210
211       olsr_calculate_hna_routes();
212     }
213   
214   else if (changes_topology)
215     {
216       /* calculate the routing table and HNA */
217
218       if (olsr_cnf->lq_level < 2)
219         {
220           olsr_calculate_routing_table();
221         }
222
223       else
224         {
225           olsr_calculate_lq_routing_table();
226         }
227
228       olsr_calculate_hna_routes();
229     }
230
231   else if (changes_hna)
232     {
233       /* Update HNA routes */
234       olsr_calculate_hna_routes();
235     }
236   
237   if (olsr_cnf->debug_level > 0)
238     {      
239       if (olsr_cnf->debug_level > 2) 
240         {
241           olsr_print_mid_set();
242           
243           if (olsr_cnf->debug_level > 3)
244             {
245               olsr_print_duplicate_table();
246               olsr_print_hna_set();
247             }
248         }
249       
250       olsr_print_link_set();
251       olsr_print_neighbor_table();
252       olsr_print_tc_table();
253     }
254
255   for(tmp_pc_list = pcf_list; 
256       tmp_pc_list != NULL;
257       tmp_pc_list = tmp_pc_list->next)
258     {
259       tmp_pc_list->function(changes_neighborhood,
260                             changes_topology,
261                             changes_hna);
262     }
263
264   changes_neighborhood = OLSR_FALSE;
265   changes_topology = OLSR_FALSE;
266   changes_hna = OLSR_FALSE;
267
268
269   return;
270 }
271
272
273
274
275
276 /**
277  *Initialize all the tables used(neighbor,
278  *topology, MID,  HNA, MPR, dup).
279  *Also initalizes other variables
280  */
281 void
282 olsr_init_tables()
283 {
284   
285   changes_topology = OLSR_FALSE;
286   changes_neighborhood = OLSR_FALSE;
287   changes_hna = OLSR_FALSE;
288
289   /* Initialize link set */
290   olsr_init_link_set();
291
292   /* Initialize duplicate table */
293   olsr_init_duplicate_table();
294
295   /* Initialize neighbor table */
296   olsr_init_neighbor_table();
297
298   /* Initialize routing table */
299   olsr_init_routing_table();
300
301   /* Initialize two hop table */
302   olsr_init_two_hop_table();
303
304   /* Initialize old route table */
305   olsr_init_old_table();
306
307   /* Initialize topology */
308   olsr_init_tc();
309
310   /* Initialize mpr selector table */
311   olsr_init_mprs_set();
312
313   /* Initialize MID set */
314   olsr_init_mid_set();
315
316   /* Initialize HNA set */
317   olsr_init_hna_set();
318   
319 }
320
321
322
323
324
325
326 /**
327  *Check if a message is to be forwarded and forward
328  *it if necessary.
329  *
330  *@param m the OLSR message recieved
331  *@param originator the originator of this message
332  *@param seqno the seqno of the message
333  *
334  *@returns positive if forwarded
335  */
336 int
337 olsr_forward_message(union olsr_message *m, 
338                      union olsr_ip_addr *originator, 
339                      olsr_u16_t seqno,
340                      struct interface *in_if, 
341                      union olsr_ip_addr *from_addr)
342 {
343   union olsr_ip_addr *src;
344   struct neighbor_entry *neighbor;
345   int msgsize;
346   struct interface *ifn;
347
348
349   if(!olsr_check_dup_table_fwd(originator, seqno, &in_if->ip_addr))
350     {
351 #ifdef DEBUG
352       olsr_printf(3, "Message already forwarded!\n");
353 #endif
354       return 0;
355     }
356
357   /* Lookup sender address */
358   if(!(src = mid_lookup_main_addr(from_addr)))
359     src = from_addr;
360
361
362   if(NULL == (neighbor=olsr_lookup_neighbor_table(src)))
363     return 0;
364
365   if(neighbor->status != SYM)
366     return 0;
367
368   /* Update duplicate table interface */
369   olsr_update_dup_entry(originator, seqno, &in_if->ip_addr);
370
371   
372   /* Check MPR */
373   if(olsr_lookup_mprs_set(src) == NULL)
374     {
375 #ifdef DEBUG
376       olsr_printf(5, "Forward - sender %s not MPR selector\n", olsr_ip_to_string(src));
377 #endif
378       return 0;
379     }
380
381
382   /* Treat TTL hopcnt */
383   if(olsr_cnf->ip_version == AF_INET)
384     {
385       /* IPv4 */
386       m->v4.hopcnt++;
387       m->v4.ttl--; 
388     }
389   else
390     {
391       /* IPv6 */
392       m->v6.hopcnt++;
393       m->v6.ttl--; 
394     }
395
396
397
398   /* Update dup forwarded */
399   olsr_set_dup_forward(originator, seqno);
400
401   /* Update packet data */
402
403
404   msgsize = ntohs(m->v4.olsr_msgsize);
405
406   /* looping trough interfaces */
407   for (ifn = ifnet; ifn ; ifn = ifn->int_next) 
408     { 
409       if(net_output_pending(ifn))
410         {
411           /*
412            * Check if message is to big to be piggybacked
413            */
414           if(net_outbuffer_push(ifn, (olsr_u8_t *)m, msgsize) != msgsize)
415             {
416               /* Send */
417               net_output(ifn);
418               /* Buffer message */
419               set_buffer_timer(ifn);
420               
421               if(net_outbuffer_push(ifn, (olsr_u8_t *)m, msgsize) != msgsize)
422                 {
423                   olsr_printf(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
424                   olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
425                 }
426
427             }
428         }
429       
430       else
431         {
432           /* No forwarding pending */
433           set_buffer_timer(ifn);
434           
435           if(net_outbuffer_push(ifn, (olsr_u8_t *)m, msgsize) != msgsize)
436             {
437               olsr_printf(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
438               olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
439             }
440         }
441     }
442
443   return 1;
444
445 }
446
447
448 void
449 set_buffer_timer(struct interface *ifn)
450 {
451   float jitter;
452   struct timeval jittertimer;
453       
454   /* Set timer */
455   jitter = (float) random()/RAND_MAX;
456   jitter *= max_jitter;
457
458   olsr_init_timer((olsr_u32_t) (jitter*1000), &jittertimer);
459
460   timeradd(&now, &jittertimer, &fwdtimer[ifn->if_nr]);
461
462 }
463
464
465
466 void
467 olsr_init_willingness()
468 {
469   if(olsr_cnf->willingness_auto)
470     olsr_register_scheduler_event(&olsr_update_willingness, NULL, will_int, will_int, NULL);
471 }
472
473 void
474 olsr_update_willingness(void *foo)
475 {
476   int tmp_will;
477
478   tmp_will = olsr_cnf->willingness;
479
480   /* Re-calculate willingness */
481   olsr_cnf->willingness = olsr_calculate_willingness();
482
483   if(tmp_will != olsr_cnf->willingness)
484     {
485       olsr_printf(1, "Local willingness updated: old %d new %d\n", tmp_will, olsr_cnf->willingness);
486     }
487 }
488
489
490 /**
491  *Calculate this nodes willingness to act as a MPR
492  *based on either a fixed value or the power status
493  *of the node using APM
494  *
495  *@return a 8bit value from 0-7 representing the willingness
496  */
497
498 olsr_u8_t
499 olsr_calculate_willingness()
500 {
501   struct olsr_apm_info ainfo;
502
503   /* If fixed willingness */
504   if(!olsr_cnf->willingness_auto)
505     return olsr_cnf->willingness;
506
507 #warning CHANGES IN THE apm INTERFACE(0.4.8)!
508
509   if(apm_read(&ainfo) < 1)
510     return WILL_DEFAULT;
511
512   apm_printinfo(&ainfo);
513
514   /* If AC powered */
515   if(ainfo.ac_line_status == OLSR_AC_POWERED)
516     return 6;
517
518   /* If battery powered 
519    *
520    * juice > 78% will: 3
521    * 78% > juice > 26% will: 2
522    * 26% > juice will: 1
523    */
524   return (ainfo.battery_percentage / 26);
525 }
526
527
528
529 /**
530  *Termination function to be called whenever a error occures
531  *that requires the daemon to terminate
532  *
533  *@param msg the message to write to the syslog and possibly stdout
534  */
535
536 void
537 olsr_exit(const char *msg, int val)
538 {
539   olsr_printf(1, "OLSR EXIT: %s\n", msg);
540   olsr_syslog(OLSR_LOG_ERR, "olsrd exit: %s\n", msg);
541   fflush(stdout);
542   exit_value = val;
543
544   raise(SIGTERM);
545 }
546
547
548 /**
549  *Wrapper for malloc(3) that does error-checking
550  *
551  *@param size the number of bytes to allocalte
552  *@param caller a string identifying the caller for
553  *use in error messaging
554  *
555  *@return a void pointer to the memory allocated
556  */
557 void *
558 olsr_malloc(size_t size, const char *id)
559 {
560   void *ptr;
561
562   if((ptr = malloc(size)) == 0) 
563     {
564       olsr_printf(1, "OUT OF MEMORY: %s\n", strerror(errno));
565       olsr_syslog(OLSR_LOG_ERR, "olsrd: out of memory!: %m\n");
566       olsr_exit((char *)id, EXIT_FAILURE);
567     }
568   return ptr;
569 }
570
571
572 /**
573  *Wrapper for printf that prints to a specific
574  *debuglevel upper limit
575  *
576  */
577
578 inline int
579 olsr_printf(int loglevel, char *format, ...)
580 {
581   va_list arglist;
582
583   if(loglevel <= olsr_cnf->debug_level)
584     {
585       va_start(arglist, format);
586       
587       vprintf(format, arglist);
588       
589       va_end(arglist);
590     }
591
592
593   return 0;
594 }