Automated merge with http://gredler.at/hg/olsrd/
[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  */
40
41 /**
42  * All these functions are global
43  */
44
45 #include "defs.h"
46 #include "olsr.h"
47 #include "link_set.h"
48 #include "two_hop_neighbor_table.h"
49 #include "tc_set.h"
50 #include "duplicate_set.h"
51 #include "mpr_selector_set.h"
52 #include "mid_set.h"
53 #include "mpr.h"
54 #include "lq_mpr.h"
55 #include "olsr_spf.h"
56 #include "scheduler.h"
57 #include "apm.h"
58 #include "misc.h"
59 #include "neighbor_table.h"
60 #include "log.h"
61 #include "lq_packet.h"
62 #include "common/avl.h"
63 #include "net_olsr.h"
64 #include "lq_plugin.h"
65
66 #include <stdarg.h>
67 #include <signal.h>
68
69
70 olsr_bool changes_topology;
71 olsr_bool changes_neighborhood;
72 olsr_bool changes_hna;
73 olsr_bool changes_force;
74
75 /**
76  * Process changes functions
77  */
78
79 struct pcf
80 {
81   int (*function)(int, int, int);
82   struct pcf *next;
83 };
84
85 static struct pcf *pcf_list;
86
87 static olsr_u16_t message_seqno;
88
89 /**
90  *Initialize the message sequence number as a random value
91  */
92 void
93 init_msg_seqno(void)
94 {
95   message_seqno = random() & 0xFFFF;
96 }
97
98 /**
99  * Get and increment the message sequence number
100  *
101  *@return the seqno
102  */
103 olsr_u16_t
104 get_msg_seqno(void)
105 {
106   return message_seqno++;
107 }
108
109
110 void
111 register_pcf(int (*f)(int, int, int))
112 {
113   struct pcf *new_pcf;
114
115   OLSR_PRINTF(1, "Registering pcf function\n");
116
117   new_pcf = olsr_malloc(sizeof(struct pcf), "New PCF");
118
119   new_pcf->function = f;
120   new_pcf->next = pcf_list;
121   pcf_list = new_pcf;
122
123 }
124
125
126 /**
127  *Process changes in neighborhood or/and topology.
128  *Re-calculates the neighborhooh/topology if there
129  *are any updates - then calls the right functions to
130  *update the routing table.
131  *@return 0
132  */
133 void
134 olsr_process_changes(void)
135 {
136   struct pcf *tmp_pc_list;
137
138 #ifdef DEBUG
139   if(changes_neighborhood)
140     OLSR_PRINTF(3, "CHANGES IN NEIGHBORHOOD\n");
141   if(changes_topology)
142     OLSR_PRINTF(3, "CHANGES IN TOPOLOGY\n");
143   if(changes_hna)
144     OLSR_PRINTF(3, "CHANGES IN HNA\n");
145 #endif
146   
147   if(!changes_force &&
148      2 <= olsr_cnf->lq_level &&
149      0 >= olsr_cnf->lq_dlimit)
150     return;
151     
152   if(!changes_neighborhood &&
153      !changes_topology &&
154      !changes_hna)
155     return;
156
157   if (olsr_cnf->debug_level > 0 && olsr_cnf->clear_screen && isatty(1))
158   {
159       clear_console();
160       printf("       *** %s (%s on %s) ***\n", olsrd_version, build_date, build_host);
161   }
162
163   if (changes_neighborhood) {
164     if (olsr_cnf->lq_level < 1) {
165       olsr_calculate_mpr();
166     } else {
167       olsr_calculate_lq_mpr();
168     }
169   }
170
171   /* calculate the routing table */
172   if (changes_neighborhood || changes_topology || changes_hna) {
173     olsr_calculate_routing_table();
174   }
175   
176   if (olsr_cnf->debug_level > 0)
177     {      
178       if (olsr_cnf->debug_level > 2) 
179         {
180           olsr_print_mid_set();
181           
182           if (olsr_cnf->debug_level > 3)
183             {
184              if (olsr_cnf->debug_level > 8)
185                {
186                  olsr_print_duplicate_table();
187                }
188               olsr_print_hna_set();
189             }
190         }
191
192 #if 1     
193       olsr_print_link_set();
194       olsr_print_neighbor_table();
195       olsr_print_two_hop_neighbor_table();
196       olsr_print_tc_table();
197 #endif
198     }
199
200   for(tmp_pc_list = pcf_list; 
201       tmp_pc_list != NULL;
202       tmp_pc_list = tmp_pc_list->next)
203     {
204       tmp_pc_list->function(changes_neighborhood,
205                             changes_topology,
206                             changes_hna);
207     }
208
209   changes_neighborhood = OLSR_FALSE;
210   changes_topology = OLSR_FALSE;
211   changes_hna = OLSR_FALSE;
212   changes_force = OLSR_FALSE;
213 }
214
215 /*
216  * Callback for the periodic route calculation.
217  */
218 void
219 olsr_trigger_forced_update(void *unused __attribute__((unused))) {
220
221   changes_force = OLSR_TRUE;
222   changes_neighborhood = OLSR_TRUE;
223   changes_topology = OLSR_TRUE;
224   changes_hna = OLSR_TRUE;
225   
226   olsr_process_changes();
227 }
228
229 /**
230  *Initialize all the tables used(neighbor,
231  *topology, MID,  HNA, MPR, dup).
232  *Also initalizes other variables
233  */
234 void
235 olsr_init_tables(void)
236 {  
237   changes_topology = OLSR_FALSE;
238   changes_neighborhood = OLSR_FALSE;
239   changes_hna = OLSR_FALSE;
240
241   /* Set avl tree comparator */
242   if (olsr_cnf->ipsize == 4) {
243     avl_comp_default = avl_comp_ipv4;
244     avl_comp_prefix_default = avl_comp_ipv4_prefix;
245   } else {
246     avl_comp_default = avl_comp_ipv6;
247     avl_comp_prefix_default = avl_comp_ipv6_prefix;
248   }
249
250   /* Initialize lq plugin set */
251   init_lq_handler_tree();
252   
253   /* Initialize link set */
254   olsr_init_link_set();
255
256   /* Initialize duplicate table */
257   olsr_init_duplicate_set();
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 #if 0
281   /* Initialize Layer 1/2 database */
282   olsr_initialize_layer12();
283 #endif
284   
285   /* Start periodic SPF and RIB recalculation */
286   if (olsr_cnf->lq_dinter > 0.0) {
287     olsr_start_timer((unsigned int)(olsr_cnf->lq_dinter * MSEC_PER_SEC), 5,
288                      OLSR_TIMER_PERIODIC, &olsr_trigger_forced_update, NULL, 0);
289   }
290 }
291
292 /**
293  *Check if a message is to be forwarded and forward
294  *it if necessary.
295  *
296  *@param m the OLSR message recieved
297  *@param originator the originator of this message
298  *@param seqno the seqno of the message
299  *
300  *@returns positive if forwarded
301  */
302 int
303 olsr_forward_message(union olsr_message *m, 
304                      union olsr_ip_addr *from_addr)
305 {
306   union olsr_ip_addr *src;
307   struct neighbor_entry *neighbor;
308   int msgsize;
309   struct interface *ifn;
310
311   /*
312    * Sven-Ola: We should not flood the mesh with overdue messages. Because
313    * of a bug in parser.c:parse_packet, we have a lot of messages because
314    * all older olsrd's have lq_fish enabled.
315    */
316   if (AF_INET == olsr_cnf->ip_version)
317   {
318     if (2 > m->v4.ttl || 255 < (int)m->v4.hopcnt + (int)m->v4.ttl) return 0;
319   }
320   else
321   {
322     if (2 > m->v6.ttl || 255 < (int)m->v6.hopcnt + (int)m->v6.ttl) 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   /* Check MPR */
338   if(olsr_lookup_mprs_set(src) == NULL)
339     {
340 #ifdef DEBUG
341 #ifndef NODEBUG
342       struct ipaddr_str buf;
343 #endif
344       OLSR_PRINTF(5, "Forward - sender %s not MPR selector\n", olsr_ip_to_string(&buf, src));
345 #endif
346       return 0;
347     }
348
349   /* Treat TTL hopcnt */
350   if(olsr_cnf->ip_version == AF_INET)
351     {
352       /* IPv4 */
353       m->v4.hopcnt++;
354       m->v4.ttl--; 
355     }
356   else
357     {
358       /* IPv6 */
359       m->v6.hopcnt++;
360       m->v6.ttl--; 
361     }
362
363   /* Update packet data */
364   msgsize = ntohs(m->v4.olsr_msgsize);
365
366   /* looping trough interfaces */
367   for (ifn = ifnet; ifn ; ifn = ifn->int_next) 
368     { 
369       if(net_output_pending(ifn))
370         {
371           /*
372            * Check if message is to big to be piggybacked
373            */
374           if(net_outbuffer_push(ifn, m, msgsize) != msgsize)
375             {
376               /* Send */
377               net_output(ifn);
378               /* Buffer message */
379               set_buffer_timer(ifn);
380               
381               if(net_outbuffer_push(ifn, m, msgsize) != msgsize)
382                 {
383                   OLSR_PRINTF(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
384                   olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
385                 }
386             }
387         }
388       else
389         {
390           /* No forwarding pending */
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   return 1;
401 }
402
403
404 void
405 set_buffer_timer(struct interface *ifn)
406 {      
407   /* Set timer */
408   ifn->fwdtimer = GET_TIMESTAMP(random() * olsr_cnf->max_jitter * 1000 / RAND_MAX);
409 }
410
411 void
412 olsr_init_willingness(void)
413 {
414   if (olsr_cnf->willingness_auto) {
415
416     /* Run it first and then periodic. */
417     olsr_update_willingness(NULL);
418
419     olsr_start_timer((unsigned int)olsr_cnf->will_int * MSEC_PER_SEC, 5,
420                      OLSR_TIMER_PERIODIC, &olsr_update_willingness, NULL, 0);
421   }
422 }
423
424 void
425 olsr_update_willingness(void *foo __attribute__((unused)))
426 {
427   int tmp_will = olsr_cnf->willingness;
428
429   /* Re-calculate willingness */
430   olsr_cnf->willingness = olsr_calculate_willingness();
431
432   if(tmp_will != olsr_cnf->willingness)
433     {
434       OLSR_PRINTF(1, "Local willingness updated: old %d new %d\n", tmp_will, olsr_cnf->willingness);
435     }
436 }
437
438
439 /**
440  *Calculate this nodes willingness to act as a MPR
441  *based on either a fixed value or the power status
442  *of the node using APM
443  *
444  *@return a 8bit value from 0-7 representing the willingness
445  */
446
447 olsr_u8_t
448 olsr_calculate_willingness(void)
449 {
450   struct olsr_apm_info ainfo;
451
452   /* If fixed willingness */
453   if(!olsr_cnf->willingness_auto)
454     return olsr_cnf->willingness;
455
456   if(apm_read(&ainfo) < 1)
457     return WILL_DEFAULT;
458
459   apm_printinfo(&ainfo);
460
461   /* If AC powered */
462   if(ainfo.ac_line_status == OLSR_AC_POWERED)
463     return 6;
464
465   /* If battery powered 
466    *
467    * juice > 78% will: 3
468    * 78% > juice > 26% will: 2
469    * 26% > juice will: 1
470    */
471   return (ainfo.battery_percentage / 26);
472 }
473
474 const char *
475 olsr_msgtype_to_string(olsr_u8_t msgtype)
476 {
477   static char type[20];
478
479   switch(msgtype)
480     {
481     case(HELLO_MESSAGE):
482       return "HELLO";
483     case(TC_MESSAGE):
484       return "TC";
485     case(MID_MESSAGE):
486       return "MID";
487     case(HNA_MESSAGE):
488       return "HNA";
489     case(LQ_HELLO_MESSAGE):
490       return("LQ-HELLO");
491     case(LQ_TC_MESSAGE):
492       return("LQ-TC");
493     default:
494       break;
495     }
496
497   snprintf(type, sizeof(type), "UNKNOWN(%d)", msgtype);
498   return type;
499 }
500
501
502 const char *
503 olsr_link_to_string(olsr_u8_t linktype)
504 {
505   static char type[20];
506
507   switch(linktype)
508     {
509     case(UNSPEC_LINK):
510       return "UNSPEC";
511     case(ASYM_LINK):
512       return "ASYM";
513     case(SYM_LINK):
514       return "SYM";
515     case(LOST_LINK):
516       return "LOST";
517     case(HIDE_LINK):
518       return "HIDE";
519     default:
520       break;
521     }
522
523   snprintf(type, sizeof(type), "UNKNOWN(%d)", linktype);
524   return type;
525 }
526
527
528 const char *
529 olsr_status_to_string(olsr_u8_t status)
530 {
531   static char type[20];
532
533   switch(status)
534     {
535     case(NOT_NEIGH):
536       return "NOT NEIGH";
537     case(SYM_NEIGH):
538       return "NEIGHBOR";
539     case(MPR_NEIGH):
540       return "MPR";
541     default:
542       break;
543     }
544
545   snprintf(type, sizeof(type), "UNKNOWN(%d)", status);
546   return type;
547 }
548
549
550 /**
551  *Termination function to be called whenever a error occures
552  *that requires the daemon to terminate
553  *
554  *@param msg the message to write to the syslog and possibly stdout
555  */
556
557 void
558 olsr_exit(const char *msg, int val)
559 {
560   OLSR_PRINTF(1, "OLSR EXIT: %s\n", msg);
561   olsr_syslog(OLSR_LOG_ERR, "olsrd exit: %s\n", msg);
562   fflush(stdout);
563   olsr_cnf->exit_value = val;
564
565   raise(SIGTERM);
566 }
567
568
569 /**
570  * Wrapper for malloc(3) that does error-checking
571  *
572  * @param size the number of bytes to allocalte
573  * @param caller a string identifying the caller for
574  * use in error messaging
575  *
576  * @return a void pointer to the memory allocated
577  */
578 void *
579 olsr_malloc(size_t size, const char *id)
580 {
581   void *ptr;
582
583   /*
584    * Not all the callers do a proper cleaning of memory.
585    * Clean it on behalf of those.
586    */
587   ptr = calloc(1, size);
588
589   if (!ptr) {
590       const char * const err_msg = strerror(errno);
591       OLSR_PRINTF(1, "OUT OF MEMORY: %s\n", err_msg);
592       olsr_syslog(OLSR_LOG_ERR, "olsrd: out of memory!: %s\n", err_msg);
593       olsr_exit(id, EXIT_FAILURE);
594   }
595
596 #if 0 
597   /* useful for debugging */
598   olsr_printf(1, "MEMORY: alloc %s %p, %u bytes\n",
599               id, ptr, size);
600 #endif
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, const 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 }
624
625 /*
626  * Local Variables:
627  * c-basic-offset: 2
628  * End:
629  */