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