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