48170a233ab6e5716ae32c85552f8c54c930cd5f
[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 "lq_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();
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_table();
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
267 /**
268  *Check if a message is to be forwarded and forward
269  *it if necessary.
270  *
271  *@param m the OLSR message recieved
272  *@param originator the originator of this message
273  *@param seqno the seqno of the message
274  *
275  *@returns positive if forwarded
276  */
277 int
278 olsr_forward_message(union olsr_message *m, 
279                      union olsr_ip_addr *originator, 
280                      olsr_u16_t seqno,
281                      struct interface *in_if, 
282                      union olsr_ip_addr *from_addr)
283 {
284   union olsr_ip_addr *src;
285   struct neighbor_entry *neighbor;
286   int msgsize;
287   struct interface *ifn;
288
289   /*
290    * Sven-Ola: We should not flood the mesh with overdue messages. Because
291    * of a bug in parser.c:parse_packet, we have a lot of messages because
292    * all older olsrd's have lq_fish enabled.
293    */
294   if (AF_INET == olsr_cnf->ip_version)
295   {
296     if (2 > m->v4.ttl || 255 < (int)m->v4.hopcnt + (int)m->v4.ttl) return 0;
297   }
298   else
299   {
300     if (2 > m->v6.ttl || 255 < (int)m->v6.hopcnt + (int)m->v6.ttl) return 0;
301   }
302
303   if(!olsr_check_dup_table_fwd(originator, seqno, &in_if->ip_addr))
304     {
305 #ifdef DEBUG
306       OLSR_PRINTF(3, "Message already forwarded!\n");
307 #endif
308       return 0;
309     }
310
311   /* Lookup sender address */
312   src = mid_lookup_main_addr(from_addr);
313   if(!src)
314     src = from_addr;
315
316   neighbor=olsr_lookup_neighbor_table(src);
317   if(!neighbor)
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 #ifndef NODEBUG
332       struct ipaddr_str buf;
333 #endif
334       OLSR_PRINTF(5, "Forward - sender %s not MPR selector\n", olsr_ip_to_string(&buf, src));
335 #endif
336       return 0;
337     }
338
339   /* Treat TTL hopcnt */
340   if(olsr_cnf->ip_version == AF_INET)
341     {
342       /* IPv4 */
343       m->v4.hopcnt++;
344       m->v4.ttl--; 
345     }
346   else
347     {
348       /* IPv6 */
349       m->v6.hopcnt++;
350       m->v6.ttl--; 
351     }
352
353   /* Update dup forwarded */
354   olsr_set_dup_forward(originator, seqno);
355
356   /* Update packet data */
357   msgsize = ntohs(m->v4.olsr_msgsize);
358
359   /* looping trough interfaces */
360   for (ifn = ifnet; ifn ; ifn = ifn->int_next) 
361     { 
362       if(net_output_pending(ifn))
363         {
364           /*
365            * Check if message is to big to be piggybacked
366            */
367           if(net_outbuffer_push(ifn, m, msgsize) != msgsize)
368             {
369               /* Send */
370               net_output(ifn);
371               /* Buffer message */
372               set_buffer_timer(ifn);
373               
374               if(net_outbuffer_push(ifn, m, msgsize) != msgsize)
375                 {
376                   OLSR_PRINTF(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
377                   olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
378                 }
379             }
380         }
381       else
382         {
383           /* No forwarding pending */
384           set_buffer_timer(ifn);
385           
386           if(net_outbuffer_push(ifn, m, msgsize) != msgsize)
387             {
388               OLSR_PRINTF(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
389               olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
390             }
391         }
392     }
393   return 1;
394 }
395
396
397 void
398 set_buffer_timer(struct interface *ifn)
399 {      
400   /* Set timer */
401   ifn->fwdtimer = GET_TIMESTAMP(random() * olsr_cnf->max_jitter * 1000 / RAND_MAX);
402 }
403
404 void
405 olsr_init_willingness(void)
406 {
407   if(olsr_cnf->willingness_auto)
408     olsr_register_scheduler_event(&olsr_update_willingness, 
409                                   NULL, olsr_cnf->will_int, olsr_cnf->will_int, NULL);
410 }
411
412 void
413 olsr_update_willingness(void *foo __attribute__((unused)))
414 {
415   int tmp_will = olsr_cnf->willingness;
416
417   /* Re-calculate willingness */
418   olsr_cnf->willingness = olsr_calculate_willingness();
419
420   if(tmp_will != olsr_cnf->willingness)
421     {
422       OLSR_PRINTF(1, "Local willingness updated: old %d new %d\n", tmp_will, olsr_cnf->willingness);
423     }
424 }
425
426
427 /**
428  *Calculate this nodes willingness to act as a MPR
429  *based on either a fixed value or the power status
430  *of the node using APM
431  *
432  *@return a 8bit value from 0-7 representing the willingness
433  */
434
435 olsr_u8_t
436 olsr_calculate_willingness(void)
437 {
438   struct olsr_apm_info ainfo;
439
440   /* If fixed willingness */
441   if(!olsr_cnf->willingness_auto)
442     return olsr_cnf->willingness;
443
444   if(apm_read(&ainfo) < 1)
445     return WILL_DEFAULT;
446
447   apm_printinfo(&ainfo);
448
449   /* If AC powered */
450   if(ainfo.ac_line_status == OLSR_AC_POWERED)
451     return 6;
452
453   /* If battery powered 
454    *
455    * juice > 78% will: 3
456    * 78% > juice > 26% will: 2
457    * 26% > juice will: 1
458    */
459   return (ainfo.battery_percentage / 26);
460 }
461
462 const char *
463 olsr_msgtype_to_string(olsr_u8_t msgtype)
464 {
465   static char type[20];
466
467   switch(msgtype)
468     {
469     case(HELLO_MESSAGE):
470       return "HELLO";
471     case(TC_MESSAGE):
472       return "TC";
473     case(MID_MESSAGE):
474       return "MID";
475     case(HNA_MESSAGE):
476       return "HNA";
477     case(LQ_HELLO_MESSAGE):
478       return("LQ-HELLO");
479     case(LQ_TC_MESSAGE):
480       return("LQ-TC");
481     default:
482       break;
483     }
484
485   snprintf(type, sizeof(type), "UNKNOWN(%d)", msgtype);
486   return type;
487 }
488
489
490 const char *
491 olsr_link_to_string(olsr_u8_t linktype)
492 {
493   static char type[20];
494
495   switch(linktype)
496     {
497     case(UNSPEC_LINK):
498       return "UNSPEC";
499     case(ASYM_LINK):
500       return "ASYM";
501     case(SYM_LINK):
502       return "SYM";
503     case(LOST_LINK):
504       return "LOST";
505     case(HIDE_LINK):
506       return "HIDE";
507     default:
508       break;
509     }
510
511   snprintf(type, sizeof(type), "UNKNOWN(%d)", linktype);
512   return type;
513 }
514
515
516 const char *
517 olsr_status_to_string(olsr_u8_t status)
518 {
519   static char type[20];
520
521   switch(status)
522     {
523     case(NOT_NEIGH):
524       return "NOT NEIGH";
525     case(SYM_NEIGH):
526       return "NEIGHBOR";
527     case(MPR_NEIGH):
528       return "MPR";
529     default:
530       break;
531     }
532
533   snprintf(type, sizeof(type), "UNKNOWN(%d)", status);
534   return type;
535 }
536
537
538 /**
539  *Termination function to be called whenever a error occures
540  *that requires the daemon to terminate
541  *
542  *@param msg the message to write to the syslog and possibly stdout
543  */
544
545 void
546 olsr_exit(const char *msg, int val)
547 {
548   OLSR_PRINTF(1, "OLSR EXIT: %s\n", msg);
549   olsr_syslog(OLSR_LOG_ERR, "olsrd exit: %s\n", msg);
550   fflush(stdout);
551   olsr_cnf->exit_value = val;
552
553   raise(SIGTERM);
554 }
555
556
557 /**
558  *Wrapper for malloc(3) that does error-checking
559  *
560  *@param size the number of bytes to allocalte
561  *@param caller a string identifying the caller for
562  *use in error messaging
563  *
564  *@return a void pointer to the memory allocated
565  */
566 void *
567 olsr_malloc(size_t size, const char *id)
568 {
569   void *ptr = malloc(size);
570   if(ptr == 0) 
571     {
572       const char * const err_msg = strerror(errno);
573       OLSR_PRINTF(1, "OUT OF MEMORY: %s\n", err_msg);
574       olsr_syslog(OLSR_LOG_ERR, "olsrd: out of memory!: %s\n", err_msg);
575       olsr_exit(id, EXIT_FAILURE);
576     }
577   return ptr;
578 }
579
580
581 /**
582  *Wrapper for printf that prints to a specific
583  *debuglevel upper limit
584  *
585  */
586
587 int
588 olsr_printf(int loglevel, const char *format, ...)
589 {
590   if((loglevel <= olsr_cnf->debug_level) && debug_handle)
591     {
592       va_list arglist;
593       va_start(arglist, format);
594       vfprintf(debug_handle, format, arglist);
595       va_end(arglist);
596     }
597   return 0;
598 }
599
600 /*
601  * Local Variables:
602  * c-basic-offset: 2
603  * End:
604  */