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