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