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