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