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