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