fa35a24895c5d72a8919c601bf4a2e77910b4a6b
[olsrd.git] / src / olsr.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas Tonnesen(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 "olsr_spf.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 #include "lq_plugin.h"
65
66 #include <stdarg.h>
67 #include <errno.h>
68 #include <unistd.h>
69 #include <stdlib.h>
70
71
72 olsr_bool changes_topology;
73 olsr_bool changes_neighborhood;
74 olsr_bool changes_hna;
75 olsr_bool changes_force;
76
77 /**
78  * Process changes functions
79  */
80
81 struct pcf
82 {
83   int (*function)(int, int, int);
84   struct pcf *next;
85 };
86
87 static struct pcf *pcf_list;
88
89 static olsr_u16_t message_seqno;
90
91 /* initialize it with all zeroes */
92 const union olsr_ip_addr all_zero = { .v6 = IN6ADDR_ANY_INIT };
93
94 /**
95  *Initialize the message sequence number as a random value
96  */
97 void
98 init_msg_seqno(void)
99 {
100   message_seqno = random() & 0xFFFF;
101 }
102
103 /**
104  * Get and increment the message sequence number
105  *
106  *@return the seqno
107  */
108 olsr_u16_t
109 get_msg_seqno(void)
110 {
111   return message_seqno++;
112 }
113
114
115 void
116 register_pcf(int (*f)(int, int, int))
117 {
118   struct pcf *new_pcf;
119
120   OLSR_PRINTF(1, "Registering pcf function\n");
121
122   new_pcf = olsr_malloc(sizeof(struct pcf), "New PCF");
123
124   new_pcf->function = f;
125   new_pcf->next = pcf_list;
126   pcf_list = new_pcf;
127
128 }
129
130
131 /**
132  *Process changes in neighborhood or/and topology.
133  *Re-calculates the neighborhood/topology if there
134  *are any updates - then calls the right functions to
135  *update the routing table.
136  *@return 0
137  */
138 void
139 olsr_process_changes(void)
140 {
141   struct pcf *tmp_pc_list;
142
143 #ifdef DEBUG
144   if(changes_neighborhood)
145     OLSR_PRINTF(3, "CHANGES IN NEIGHBORHOOD\n");
146   if(changes_topology)
147     OLSR_PRINTF(3, "CHANGES IN TOPOLOGY\n");
148   if(changes_hna)
149     OLSR_PRINTF(3, "CHANGES IN HNA\n");
150 #endif
151
152   if(!changes_force &&
153      2 <= olsr_cnf->lq_level &&
154      0 >= olsr_cnf->lq_dlimit)
155     return;
156
157   if(!changes_neighborhood &&
158      !changes_topology &&
159      !changes_hna)
160     return;
161
162   if (olsr_cnf->debug_level > 0 && olsr_cnf->clear_screen && isatty(1))
163   {
164       clear_console();
165       printf("       *** %s (%s on %s) ***\n", olsrd_version, build_date, build_host);
166   }
167
168   if (changes_neighborhood) {
169     if (olsr_cnf->lq_level < 1) {
170       olsr_calculate_mpr();
171     } else {
172       olsr_calculate_lq_mpr();
173     }
174   }
175
176   /* calculate the routing table */
177   if (changes_neighborhood || changes_topology || changes_hna) {
178     olsr_calculate_routing_table();
179   }
180
181   if (olsr_cnf->debug_level > 0)
182     {
183       if (olsr_cnf->debug_level > 2)
184         {
185           olsr_print_mid_set();
186
187           if (olsr_cnf->debug_level > 3)
188             {
189              if (olsr_cnf->debug_level > 8)
190                {
191                  olsr_print_duplicate_table();
192                }
193               olsr_print_hna_set();
194             }
195         }
196
197 #if 1
198       olsr_print_link_set();
199       olsr_print_neighbor_table();
200       olsr_print_two_hop_neighbor_table();
201       olsr_print_tc_table();
202 #endif
203     }
204
205   for(tmp_pc_list = pcf_list;
206       tmp_pc_list != NULL;
207       tmp_pc_list = tmp_pc_list->next)
208     {
209       tmp_pc_list->function(changes_neighborhood,
210                             changes_topology,
211                             changes_hna);
212     }
213
214   changes_neighborhood = OLSR_FALSE;
215   changes_topology = OLSR_FALSE;
216   changes_hna = OLSR_FALSE;
217   changes_force = OLSR_FALSE;
218 }
219
220 /*
221  * Callback for the periodic route calculation.
222  */
223 void
224 olsr_trigger_forced_update(void *unused __attribute__((unused))) {
225
226   changes_force = OLSR_TRUE;
227   changes_neighborhood = OLSR_TRUE;
228   changes_topology = OLSR_TRUE;
229   changes_hna = OLSR_TRUE;
230
231   olsr_process_changes();
232 }
233
234 /**
235  *Initialize all the tables used(neighbor,
236  *topology, MID,  HNA, MPR, dup).
237  *Also initalizes other variables
238  */
239 void
240 olsr_init_tables(void)
241 {
242   /* Some cookies for stats keeping */
243   static struct olsr_cookie_info *periodic_spf_timer_cookie = NULL;
244
245   changes_topology = OLSR_FALSE;
246   changes_neighborhood = OLSR_FALSE;
247   changes_hna = OLSR_FALSE;
248
249   /* Set avl tree comparator */
250   if (olsr_cnf->ipsize == 4) {
251     avl_comp_default = avl_comp_ipv4;
252     avl_comp_prefix_default = avl_comp_ipv4_prefix;
253   } else {
254     avl_comp_default = avl_comp_ipv6;
255     avl_comp_prefix_default = avl_comp_ipv6_prefix;
256   }
257
258   /* Initialize lq plugin set */
259   init_lq_handler_tree();
260
261   /* Initialize link set */
262   olsr_init_link_set();
263
264   /* Initialize duplicate table */
265   olsr_init_duplicate_set();
266
267   /* Initialize neighbor table */
268   olsr_init_neighbor_table();
269
270   /* Initialize routing table */
271   olsr_init_routing_table();
272
273   /* Initialize two hop table */
274   olsr_init_two_hop_table();
275
276   /* Initialize topology */
277   olsr_init_tc();
278
279   /* Initialize MID set */
280   olsr_init_mid_set();
281
282   /* Initialize HNA set */
283   olsr_init_hna_set();
284
285   /* Initialize MPRS */
286   olsr_init_mprs();
287
288 #if 0
289   /* Initialize Layer 1/2 database */
290   olsr_initialize_layer12();
291 #endif
292
293   /* Start periodic SPF and RIB recalculation */
294   if (olsr_cnf->lq_dinter > 0.0) {
295     periodic_spf_timer_cookie = olsr_alloc_cookie("Periodic SPF",
296                                                   OLSR_COOKIE_TYPE_TIMER);
297     olsr_start_timer((unsigned int)(olsr_cnf->lq_dinter * MSEC_PER_SEC), 5,
298                      OLSR_TIMER_PERIODIC, &olsr_trigger_forced_update, NULL,
299                      periodic_spf_timer_cookie->ci_id);
300   }
301 }
302
303 /**
304  *Check if a message is to be forwarded and forward
305  *it if necessary.
306  *
307  *@param m the OLSR message recieved
308  *
309  *@returns positive if forwarded
310  */
311 int
312 olsr_forward_message(union olsr_message *m,
313                      union olsr_ip_addr *from_addr)
314 {
315   union olsr_ip_addr *src;
316   struct neighbor_entry *neighbor;
317   int msgsize;
318   struct interface *ifn;
319
320   /*
321    * Sven-Ola: We should not flood the mesh with overdue messages. Because
322    * of a bug in parser.c:parse_packet, we have a lot of messages because
323    * all older olsrd's have lq_fish enabled.
324    */
325   if (AF_INET == olsr_cnf->ip_version)
326   {
327     if (m->v4.ttl < 2 || 255 < (int)m->v4.hopcnt + (int)m->v4.ttl) return 0;
328   }
329   else
330   {
331     if (m->v6.ttl < 2|| 255 < (int)m->v6.hopcnt + (int)m->v6.ttl) return 0;
332   }
333
334   /* Lookup sender address */
335   src = olsr_lookup_main_addr_by_alias(from_addr);
336   if(!src)
337     src = from_addr;
338
339   neighbor=olsr_lookup_neighbor_table(src);
340   if(!neighbor)
341     return 0;
342
343   if(neighbor->status != SYM)
344     return 0;
345
346   /* Check MPR */
347   if(olsr_lookup_mprs_set(src) == NULL)
348     {
349 #ifdef DEBUG
350       struct ipaddr_str buf;
351       OLSR_PRINTF(5, "Forward - sender %s not MPR selector\n", olsr_ip_to_string(&buf, src));
352 #endif
353       return 0;
354     }
355
356   /* check if we already forwarded this message */
357   if (olsr_message_is_duplicate(m)) {
358     return 0; /* it's a duplicate, forget about it */
359   }
360
361   /* Treat TTL hopcnt */
362   if(olsr_cnf->ip_version == AF_INET)
363     {
364       /* IPv4 */
365       m->v4.hopcnt++;
366       m->v4.ttl--;
367     }
368   else
369     {
370       /* IPv6 */
371       m->v6.hopcnt++;
372       m->v6.ttl--;
373     }
374
375   /* Update packet data */
376   msgsize = ntohs(m->v4.olsr_msgsize);
377
378   /* looping trough interfaces */
379   for (ifn = ifnet; ifn ; ifn = ifn->int_next)
380     {
381       if(net_output_pending(ifn))
382         {
383           /*
384            * Check if message is to big to be piggybacked
385            */
386           if(net_outbuffer_push(ifn, m, msgsize) != msgsize)
387             {
388               /* Send */
389               net_output(ifn);
390               /* Buffer message */
391               set_buffer_timer(ifn);
392
393               if(net_outbuffer_push(ifn, m, msgsize) != msgsize)
394                 {
395                   OLSR_PRINTF(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
396                   olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
397                 }
398             }
399         }
400       else
401         {
402           /* No forwarding pending */
403           set_buffer_timer(ifn);
404
405           if(net_outbuffer_push(ifn, 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   return 1;
413 }
414
415 /**
416  * Wrapper for the timer callback.
417  */
418 static void
419 olsr_expire_buffer_timer(void *context)
420 {
421   struct interface *ifn;
422
423   ifn = (struct interface *)context;
424
425   /*
426    * Clear the pointer to indicate that this timer has
427    * been expired and needs to be restarted in case there
428    * will be another message queued in the future.
429    */
430   ifn->buffer_hold_timer = NULL;
431
432 #ifdef DEBUG
433   OLSR_PRINTF(1, "Buffer Holdtimer for %s timed out\n", ifn->int_name);
434 #endif
435
436   /*
437    * Do we have something to emit ?
438    */
439   if (!net_output_pending(ifn)) {
440     return;
441   }
442
443   net_output(ifn);
444 }
445
446 /*
447  * set_buffer_timer
448  *
449  * Kick a hold-down timer which defers building of a message.
450  * This has the desired effect that olsr messages get bigger.
451  */
452 void
453 set_buffer_timer(struct interface *ifn)
454 {
455
456   /*
457    * Bail if there is already a timer running.
458    */
459   if (ifn->buffer_hold_timer) {
460     return;
461   }
462
463   /*
464    * This is the first message since the last time this interface has
465    * been drained. Flush the buffer in second or so.
466    */
467   ifn->buffer_hold_timer =
468     olsr_start_timer(OLSR_BUFFER_HOLD_TIME, OLSR_BUFFER_HOLD_JITTER,
469                      OLSR_TIMER_ONESHOT, &olsr_expire_buffer_timer, ifn,
470                      buffer_hold_timer_cookie->ci_id);
471 }
472
473 void
474 olsr_init_willingness(void)
475 {
476   /* Some cookies for stats keeping */
477   static struct olsr_cookie_info *willingness_timer_cookie = NULL;
478
479   if (olsr_cnf->willingness_auto) {
480
481     /* Run it first and then periodic. */
482     olsr_update_willingness(NULL);
483
484     willingness_timer_cookie = olsr_alloc_cookie("Update Willingness",
485                                                  OLSR_COOKIE_TYPE_TIMER);
486     olsr_start_timer((unsigned int)olsr_cnf->will_int * MSEC_PER_SEC, 5,
487                      OLSR_TIMER_PERIODIC, &olsr_update_willingness, NULL,
488                      willingness_timer_cookie->ci_id);
489   }
490 }
491
492 void
493 olsr_update_willingness(void *foo __attribute__((unused)))
494 {
495   int tmp_will = olsr_cnf->willingness;
496
497   /* Re-calculate willingness */
498   olsr_cnf->willingness = olsr_calculate_willingness();
499
500   if(tmp_will != olsr_cnf->willingness)
501     {
502       OLSR_PRINTF(1, "Local willingness updated: old %d new %d\n", tmp_will, olsr_cnf->willingness);
503     }
504 }
505
506
507 /**
508  *Calculate this nodes willingness to act as a MPR
509  *based on either a fixed value or the power status
510  *of the node using APM
511  *
512  *@return a 8bit value from 0-7 representing the willingness
513  */
514
515 olsr_u8_t
516 olsr_calculate_willingness(void)
517 {
518   struct olsr_apm_info ainfo;
519
520   /* If fixed willingness */
521   if(!olsr_cnf->willingness_auto)
522     return olsr_cnf->willingness;
523
524   if(apm_read(&ainfo) < 1)
525     return WILL_DEFAULT;
526
527   apm_printinfo(&ainfo);
528
529   /* If AC powered */
530   if(ainfo.ac_line_status == OLSR_AC_POWERED)
531     return 6;
532
533   /* If battery powered
534    *
535    * juice > 78% will: 3
536    * 78% > juice > 26% will: 2
537    * 26% > juice will: 1
538    */
539   return (ainfo.battery_percentage / 26);
540 }
541
542 const char *
543 olsr_msgtype_to_string(olsr_u8_t msgtype)
544 {
545   static char type[20];
546
547   switch(msgtype)
548     {
549     case(HELLO_MESSAGE):
550       return "HELLO";
551     case(TC_MESSAGE):
552       return "TC";
553     case(MID_MESSAGE):
554       return "MID";
555     case(HNA_MESSAGE):
556       return "HNA";
557     case(LQ_HELLO_MESSAGE):
558       return("LQ-HELLO");
559     case(LQ_TC_MESSAGE):
560       return("LQ-TC");
561     default:
562       break;
563     }
564
565   snprintf(type, sizeof(type), "UNKNOWN(%d)", msgtype);
566   return type;
567 }
568
569
570 const char *
571 olsr_link_to_string(olsr_u8_t linktype)
572 {
573   static char type[20];
574
575   switch(linktype)
576     {
577     case(UNSPEC_LINK):
578       return "UNSPEC";
579     case(ASYM_LINK):
580       return "ASYM";
581     case(SYM_LINK):
582       return "SYM";
583     case(LOST_LINK):
584       return "LOST";
585     case(HIDE_LINK):
586       return "HIDE";
587     default:
588       break;
589     }
590
591   snprintf(type, sizeof(type), "UNKNOWN(%d)", linktype);
592   return type;
593 }
594
595
596 const char *
597 olsr_status_to_string(olsr_u8_t status)
598 {
599   static char type[20];
600
601   switch(status)
602     {
603     case(NOT_NEIGH):
604       return "NOT NEIGH";
605     case(SYM_NEIGH):
606       return "NEIGHBOR";
607     case(MPR_NEIGH):
608       return "MPR";
609     default:
610       break;
611     }
612
613   snprintf(type, sizeof(type), "UNKNOWN(%d)", status);
614   return type;
615 }
616
617
618 /**
619  *Termination function to be called whenever a error occures
620  *that requires the daemon to terminate
621  *
622  *@param msg the message to write to the syslog and possibly stdout
623  */
624
625 void
626 olsr_exit(const char *msg, int val)
627 {
628   OLSR_PRINTF(1, "OLSR EXIT: %s\n", msg);
629   olsr_syslog(OLSR_LOG_ERR, "olsrd exit: %s\n", msg);
630   fflush(stdout);
631   olsr_cnf->exit_value = val;
632   app_state = STATE_SHUTDOWN;
633 }
634
635
636 /**
637  * Wrapper for malloc(3) that does error-checking
638  *
639  * @param size the number of bytes to allocalte
640  * @param caller a string identifying the caller for
641  * use in error messaging
642  *
643  * @return a void pointer to the memory allocated
644  */
645 void *
646 olsr_malloc(size_t size, const char *id)
647 {
648   void *ptr;
649
650   /*
651    * Not all the callers do a proper cleaning of memory.
652    * Clean it on behalf of those.
653    */
654   ptr = calloc(1, size);
655
656   if (!ptr) {
657       const char * const err_msg = strerror(errno);
658       OLSR_PRINTF(1, "OUT OF MEMORY: %s\n", err_msg);
659       olsr_syslog(OLSR_LOG_ERR, "olsrd: out of memory!: %s\n", err_msg);
660       olsr_exit(id, EXIT_FAILURE);
661   }
662
663 #if 0
664   /* useful for debugging */
665   olsr_printf(1, "MEMORY: alloc %s %p, %u bytes\n",
666               id, ptr, size);
667 #endif
668
669   return ptr;
670 }
671
672
673 /**
674  *Wrapper for printf that prints to a specific
675  *debuglevel upper limit
676  *
677  */
678
679 int
680 olsr_printf(int loglevel, const char *format, ...)
681 {
682   if((loglevel <= olsr_cnf->debug_level) && debug_handle)
683     {
684       va_list arglist;
685       va_start(arglist, format);
686       vfprintf(debug_handle, format, arglist);
687       va_end(arglist);
688     }
689   return 0;
690 }
691
692 /*
693  * Local Variables:
694  * c-basic-offset: 2
695  * indent-tabs-mode: nil
696  * End:
697  */