* applied hunks from Erik Tromps patch at http://home.tiscali.nl/levab001/olsrd-0...
[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.50 2007/02/04 22:47:45 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              if (olsr_cnf->debug_level > 8)
217                {
218                  olsr_print_duplicate_table();
219                }
220               olsr_print_hna_set();
221             }
222         }
223       
224       olsr_print_link_set();
225       olsr_print_neighbor_table();
226       olsr_print_two_hop_neighbor_table();
227       olsr_print_tc_table();
228     }
229
230   for(tmp_pc_list = pcf_list; 
231       tmp_pc_list != NULL;
232       tmp_pc_list = tmp_pc_list->next)
233     {
234       tmp_pc_list->function(changes_neighborhood,
235                             changes_topology,
236                             changes_hna);
237     }
238
239   changes_neighborhood = OLSR_FALSE;
240   changes_topology = OLSR_FALSE;
241   changes_hna = OLSR_FALSE;
242   changes_force = OLSR_FALSE;
243
244
245   return;
246 }
247
248
249
250
251
252 /**
253  *Initialize all the tables used(neighbor,
254  *topology, MID,  HNA, MPR, dup).
255  *Also initalizes other variables
256  */
257 void
258 olsr_init_tables()
259 {
260   
261   changes_topology = OLSR_FALSE;
262   changes_neighborhood = OLSR_FALSE;
263   changes_hna = OLSR_FALSE;
264
265   /* Initialize link set */
266   olsr_init_link_set();
267
268   /* Initialize duplicate table */
269   olsr_init_duplicate_table();
270
271   /* Initialize neighbor table */
272   olsr_init_neighbor_table();
273
274   /* Initialize routing table */
275   olsr_init_routing_table();
276
277   /* Initialize two hop table */
278   olsr_init_two_hop_table();
279
280   /* Initialize old route table */
281   olsr_init_old_table();
282
283   /* Initialize topology */
284   olsr_init_tc();
285
286   /* Initialize mpr selector table */
287   olsr_init_mprs_set();
288
289   /* Initialize MID set */
290   olsr_init_mid_set();
291
292   /* Initialize HNA set */
293   olsr_init_hna_set();
294   
295 }
296
297
298
299
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 recieved
307  *@param originator the originator of this message
308  *@param seqno the seqno of the message
309  *
310  *@returns positive if forwarded
311  */
312 int
313 olsr_forward_message(union olsr_message *m, 
314                      union olsr_ip_addr *originator, 
315                      olsr_u16_t seqno,
316                      struct interface *in_if, 
317                      union olsr_ip_addr *from_addr)
318 {
319   union olsr_ip_addr *src;
320   struct neighbor_entry *neighbor;
321   int msgsize;
322   struct interface *ifn;
323
324
325   if(!olsr_check_dup_table_fwd(originator, seqno, &in_if->ip_addr))
326     {
327 #ifdef DEBUG
328       OLSR_PRINTF(3, "Message already forwarded!\n")
329 #endif
330       return 0;
331     }
332
333   /* Lookup sender address */
334   if(!(src = mid_lookup_main_addr(from_addr)))
335     src = from_addr;
336
337
338   if(NULL == (neighbor=olsr_lookup_neighbor_table(src)))
339     return 0;
340
341   if(neighbor->status != SYM)
342     return 0;
343
344   /* Update duplicate table interface */
345   olsr_update_dup_entry(originator, seqno, &in_if->ip_addr);
346
347   
348   /* Check MPR */
349   if(olsr_lookup_mprs_set(src) == NULL)
350     {
351 #ifdef DEBUG
352       OLSR_PRINTF(5, "Forward - sender %s not MPR selector\n", olsr_ip_to_string(src))
353 #endif
354       return 0;
355     }
356
357
358   /* Treat TTL hopcnt */
359   if(olsr_cnf->ip_version == AF_INET)
360     {
361       /* IPv4 */
362       m->v4.hopcnt++;
363       m->v4.ttl--; 
364     }
365   else
366     {
367       /* IPv6 */
368       m->v6.hopcnt++;
369       m->v6.ttl--; 
370     }
371
372
373
374   /* Update dup forwarded */
375   olsr_set_dup_forward(originator, seqno);
376
377   /* Update packet data */
378
379
380   msgsize = ntohs(m->v4.olsr_msgsize);
381
382   /* looping trough interfaces */
383   for (ifn = ifnet; ifn ; ifn = ifn->int_next) 
384     { 
385       if(net_output_pending(ifn))
386         {
387           /*
388            * Check if message is to big to be piggybacked
389            */
390           if(net_outbuffer_push(ifn, (olsr_u8_t *)m, msgsize) != msgsize)
391             {
392               /* Send */
393               net_output(ifn);
394               /* Buffer message */
395               set_buffer_timer(ifn);
396               
397               if(net_outbuffer_push(ifn, (olsr_u8_t *)m, msgsize) != msgsize)
398                 {
399                   OLSR_PRINTF(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize)
400                   olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
401                 }
402
403             }
404         }
405       
406       else
407         {
408           /* No forwarding pending */
409           set_buffer_timer(ifn);
410           
411           if(net_outbuffer_push(ifn, (olsr_u8_t *)m, msgsize) != msgsize)
412             {
413               OLSR_PRINTF(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize)
414               olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
415             }
416         }
417     }
418
419   return 1;
420
421 }
422
423
424 void
425 set_buffer_timer(struct interface *ifn)
426 {
427   float jitter;
428       
429   /* Set timer */
430   jitter = (float) random()/RAND_MAX;
431   jitter *= olsr_cnf->max_jitter;
432
433   ifn->fwdtimer = GET_TIMESTAMP(jitter*1000);
434
435 }
436
437
438
439 void
440 olsr_init_willingness()
441 {
442   if(olsr_cnf->willingness_auto)
443     olsr_register_scheduler_event(&olsr_update_willingness, 
444                                   NULL, olsr_cnf->will_int, olsr_cnf->will_int, NULL);
445 }
446
447 void
448 olsr_update_willingness(void *foo)
449 {
450   int tmp_will;
451
452   tmp_will = olsr_cnf->willingness;
453
454   /* Re-calculate willingness */
455   olsr_cnf->willingness = olsr_calculate_willingness();
456
457   if(tmp_will != olsr_cnf->willingness)
458     {
459       OLSR_PRINTF(1, "Local willingness updated: old %d new %d\n", tmp_will, olsr_cnf->willingness)
460     }
461 }
462
463
464 /**
465  *Calculate this nodes willingness to act as a MPR
466  *based on either a fixed value or the power status
467  *of the node using APM
468  *
469  *@return a 8bit value from 0-7 representing the willingness
470  */
471
472 olsr_u8_t
473 olsr_calculate_willingness()
474 {
475   struct olsr_apm_info ainfo;
476
477   /* If fixed willingness */
478   if(!olsr_cnf->willingness_auto)
479     return olsr_cnf->willingness;
480
481   if(apm_read(&ainfo) < 1)
482     return WILL_DEFAULT;
483
484   apm_printinfo(&ainfo);
485
486   /* If AC powered */
487   if(ainfo.ac_line_status == OLSR_AC_POWERED)
488     return 6;
489
490   /* If battery powered 
491    *
492    * juice > 78% will: 3
493    * 78% > juice > 26% will: 2
494    * 26% > juice will: 1
495    */
496   return (ainfo.battery_percentage / 26);
497 }
498
499 const char *
500 olsr_msgtype_to_string(olsr_u8_t msgtype)
501 {
502   static char type[20];
503
504   switch(msgtype)
505     {
506     case(HELLO_MESSAGE):
507       return "HELLO";
508     case(TC_MESSAGE):
509       return "TC";
510     case(MID_MESSAGE):
511       return "MID";
512     case(HNA_MESSAGE):
513       return "HNA";
514     case(LQ_HELLO_MESSAGE):
515       return("LQ-HELLO");
516     case(LQ_TC_MESSAGE):
517       return("LQ-TC");
518     default:
519       break;
520     }
521
522   snprintf(type, 20, "UNKNOWN(%d)", msgtype);
523   return type;
524 }
525
526
527 const char *
528 olsr_link_to_string(olsr_u8_t linktype)
529 {
530   static char type[20];
531
532   switch(linktype)
533     {
534     case(UNSPEC_LINK):
535       return "UNSPEC";
536     case(ASYM_LINK):
537       return "ASYM";
538     case(SYM_LINK):
539       return "SYM";
540     case(LOST_LINK):
541       return "LOST";
542     case(HIDE_LINK):
543       return "HIDE";
544     default:
545       break;
546     }
547
548   snprintf(type, 20, "UNKNOWN(%d)", linktype);
549   return type;
550 }
551
552
553 const char *
554 olsr_status_to_string(olsr_u8_t status)
555 {
556   static char type[20];
557
558   switch(status)
559     {
560     case(NOT_NEIGH):
561       return "NOT NEIGH";
562     case(SYM_NEIGH):
563       return "NEIGHBOR";
564     case(MPR_NEIGH):
565       return "MPR";
566     default:
567       break;
568     }
569
570   snprintf(type, 20, "UNKNOWN(%d)", status);
571   return type;
572 }
573
574
575 /**
576  *Termination function to be called whenever a error occures
577  *that requires the daemon to terminate
578  *
579  *@param msg the message to write to the syslog and possibly stdout
580  */
581
582 void
583 olsr_exit(const char *msg, int val)
584 {
585   OLSR_PRINTF(1, "OLSR EXIT: %s\n", msg)
586   olsr_syslog(OLSR_LOG_ERR, "olsrd exit: %s\n", msg);
587   fflush(stdout);
588   olsr_cnf->exit_value = val;
589
590   raise(SIGTERM);
591 }
592
593
594 /**
595  *Wrapper for malloc(3) that does error-checking
596  *
597  *@param size the number of bytes to allocalte
598  *@param caller a string identifying the caller for
599  *use in error messaging
600  *
601  *@return a void pointer to the memory allocated
602  */
603 void *
604 olsr_malloc(size_t size, const char *id)
605 {
606   void *ptr;
607
608   if((ptr = malloc(size)) == 0) 
609     {
610       OLSR_PRINTF(1, "OUT OF MEMORY: %s\n", strerror(errno))
611       olsr_syslog(OLSR_LOG_ERR, "olsrd: out of memory!: %m\n");
612       olsr_exit((char *)id, EXIT_FAILURE);
613     }
614   return ptr;
615 }
616
617
618 /**
619  *Wrapper for printf that prints to a specific
620  *debuglevel upper limit
621  *
622  */
623
624 int
625 olsr_printf(int loglevel, char *format, ...)
626 {
627   va_list arglist;
628
629   if((loglevel <= olsr_cnf->debug_level) && debug_handle)
630     {
631       va_start(arglist, format);
632       
633       vfprintf(debug_handle, format, arglist);
634       
635       va_end(arglist);
636     }
637
638
639   return 0;
640 }