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