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