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