added the SPF refactoring 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.55 2007/07/05 22:43:47 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       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(void)
259 {  
260   changes_topology = OLSR_FALSE;
261   changes_neighborhood = OLSR_FALSE;
262   changes_hna = OLSR_FALSE;
263
264   /* Set avl tree comparator */
265   if (olsr_cnf->ipsize == 4) {
266     avl_comp_default = 0;
267   } else {
268     avl_comp_default = avl_comp_ipv6;
269   }
270
271   /* Initialize link set */
272   olsr_init_link_set();
273
274   /* Initialize duplicate table */
275   olsr_init_duplicate_table();
276
277   /* Initialize neighbor table */
278   olsr_init_neighbor_table();
279
280   /* Initialize routing table */
281   olsr_init_routing_table();
282
283   /* Initialize two hop table */
284   olsr_init_two_hop_table();
285
286   /* Initialize old route table */
287   olsr_init_old_table();
288
289   /* Initialize topology */
290   olsr_init_tc();
291
292   /* Initialize mpr selector table */
293   olsr_init_mprs_set();
294
295   /* Initialize MID set */
296   olsr_init_mid_set();
297
298   /* Initialize HNA set */
299   olsr_init_hna_set();  
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   src = mid_lookup_main_addr(from_addr);
335   if(!src)
336     src = from_addr;
337
338   neighbor=olsr_lookup_neighbor_table(src);
339   if(!neighbor)
340     return 0;
341
342   if(neighbor->status != SYM)
343     return 0;
344
345   /* Update duplicate table interface */
346   olsr_update_dup_entry(originator, seqno, &in_if->ip_addr);
347
348   
349   /* Check MPR */
350   if(olsr_lookup_mprs_set(src) == NULL)
351     {
352 #ifdef DEBUG
353       OLSR_PRINTF(5, "Forward - sender %s not MPR selector\n", olsr_ip_to_string(src));
354 #endif
355       return 0;
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   /* Update dup forwarded */
373   olsr_set_dup_forward(originator, seqno);
374
375   /* Update packet data */
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, 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, 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       else
401         {
402           /* No forwarding pending */
403           set_buffer_timer(ifn);
404           
405           if(net_outbuffer_push(ifn, m, msgsize) != msgsize)
406             {
407               OLSR_PRINTF(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
408               olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
409             }
410         }
411     }
412   return 1;
413 }
414
415
416 void
417 set_buffer_timer(struct interface *ifn)
418 {
419   float jitter;
420       
421   /* Set timer */
422   jitter = (float) random()/RAND_MAX;
423   jitter *= olsr_cnf->max_jitter;
424
425   ifn->fwdtimer = GET_TIMESTAMP(jitter*1000);
426 }
427
428 void
429 olsr_init_willingness(void)
430 {
431   if(olsr_cnf->willingness_auto)
432     olsr_register_scheduler_event(&olsr_update_willingness, 
433                                   NULL, olsr_cnf->will_int, olsr_cnf->will_int, NULL);
434 }
435
436 void
437 olsr_update_willingness(void *foo __attribute__((unused)))
438 {
439   int tmp_will = olsr_cnf->willingness;
440
441   /* Re-calculate willingness */
442   olsr_cnf->willingness = olsr_calculate_willingness();
443
444   if(tmp_will != olsr_cnf->willingness)
445     {
446       OLSR_PRINTF(1, "Local willingness updated: old %d new %d\n", tmp_will, olsr_cnf->willingness);
447     }
448 }
449
450
451 /**
452  *Calculate this nodes willingness to act as a MPR
453  *based on either a fixed value or the power status
454  *of the node using APM
455  *
456  *@return a 8bit value from 0-7 representing the willingness
457  */
458
459 olsr_u8_t
460 olsr_calculate_willingness(void)
461 {
462   struct olsr_apm_info ainfo;
463
464   /* If fixed willingness */
465   if(!olsr_cnf->willingness_auto)
466     return olsr_cnf->willingness;
467
468   if(apm_read(&ainfo) < 1)
469     return WILL_DEFAULT;
470
471   apm_printinfo(&ainfo);
472
473   /* If AC powered */
474   if(ainfo.ac_line_status == OLSR_AC_POWERED)
475     return 6;
476
477   /* If battery powered 
478    *
479    * juice > 78% will: 3
480    * 78% > juice > 26% will: 2
481    * 26% > juice will: 1
482    */
483   return (ainfo.battery_percentage / 26);
484 }
485
486 const char *
487 olsr_msgtype_to_string(olsr_u8_t msgtype)
488 {
489   static char type[20];
490
491   switch(msgtype)
492     {
493     case(HELLO_MESSAGE):
494       return "HELLO";
495     case(TC_MESSAGE):
496       return "TC";
497     case(MID_MESSAGE):
498       return "MID";
499     case(HNA_MESSAGE):
500       return "HNA";
501     case(LQ_HELLO_MESSAGE):
502       return("LQ-HELLO");
503     case(LQ_TC_MESSAGE):
504       return("LQ-TC");
505     default:
506       break;
507     }
508
509   snprintf(type, 20, "UNKNOWN(%d)", msgtype);
510   return type;
511 }
512
513
514 const char *
515 olsr_link_to_string(olsr_u8_t linktype)
516 {
517   static char type[20];
518
519   switch(linktype)
520     {
521     case(UNSPEC_LINK):
522       return "UNSPEC";
523     case(ASYM_LINK):
524       return "ASYM";
525     case(SYM_LINK):
526       return "SYM";
527     case(LOST_LINK):
528       return "LOST";
529     case(HIDE_LINK):
530       return "HIDE";
531     default:
532       break;
533     }
534
535   snprintf(type, 20, "UNKNOWN(%d)", linktype);
536   return type;
537 }
538
539
540 const char *
541 olsr_status_to_string(olsr_u8_t status)
542 {
543   static char type[20];
544
545   switch(status)
546     {
547     case(NOT_NEIGH):
548       return "NOT NEIGH";
549     case(SYM_NEIGH):
550       return "NEIGHBOR";
551     case(MPR_NEIGH):
552       return "MPR";
553     default:
554       break;
555     }
556
557   snprintf(type, 20, "UNKNOWN(%d)", status);
558   return type;
559 }
560
561
562 /**
563  *Termination function to be called whenever a error occures
564  *that requires the daemon to terminate
565  *
566  *@param msg the message to write to the syslog and possibly stdout
567  */
568
569 void
570 olsr_exit(const char *msg, int val)
571 {
572   OLSR_PRINTF(1, "OLSR EXIT: %s\n", msg);
573   olsr_syslog(OLSR_LOG_ERR, "olsrd exit: %s\n", msg);
574   fflush(stdout);
575   olsr_cnf->exit_value = val;
576
577   raise(SIGTERM);
578 }
579
580
581 /**
582  *Wrapper for malloc(3) that does error-checking
583  *
584  *@param size the number of bytes to allocalte
585  *@param caller a string identifying the caller for
586  *use in error messaging
587  *
588  *@return a void pointer to the memory allocated
589  */
590 void *
591 olsr_malloc(size_t size, const char *id)
592 {
593   void *ptr;
594
595   if((ptr = malloc(size)) == 0) 
596     {
597       const char * const err_msg = strerror(errno);
598       OLSR_PRINTF(1, "OUT OF MEMORY: %s\n", err_msg);
599       olsr_syslog(OLSR_LOG_ERR, "olsrd: out of memory!: %s\n", err_msg);
600       olsr_exit(id, EXIT_FAILURE);
601     }
602   return ptr;
603 }
604
605
606 /**
607  *Wrapper for printf that prints to a specific
608  *debuglevel upper limit
609  *
610  */
611
612 int
613 olsr_printf(int loglevel, char *format, ...)
614 {
615   if((loglevel <= olsr_cnf->debug_level) && debug_handle)
616     {
617       va_list arglist;
618       va_start(arglist, format);
619       vfprintf(debug_handle, format, arglist);
620       va_end(arglist);
621     }
622   return 0;
623 }