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