gateway: introduce and use removeGatewayFromList function
[olsrd.git] / src / olsr.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org)
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 /**
43  * All these functions are global
44  */
45
46 #include "defs.h"
47 #include "builddata.h"
48 #include "olsr.h"
49 #include "link_set.h"
50 #include "two_hop_neighbor_table.h"
51 #include "tc_set.h"
52 #include "duplicate_set.h"
53 #include "mpr_selector_set.h"
54 #include "mid_set.h"
55 #include "mpr.h"
56 #include "lq_mpr.h"
57 #include "olsr_spf.h"
58 #include "scheduler.h"
59 #include "apm.h"
60 #include "misc.h"
61 #include "neighbor_table.h"
62 #include "log.h"
63 #include "lq_packet.h"
64 #include "common/avl.h"
65 #include "net_olsr.h"
66 #include "lq_plugin.h"
67 #include "gateway.h"
68 #include "duplicate_handler.h"
69
70 #include <stdarg.h>
71 #include <signal.h>
72 #include <unistd.h>
73
74 bool changes_topology;
75 bool changes_neighborhood;
76 bool changes_hna;
77 bool changes_force;
78
79 /*COLLECT startup sleeps caused by warnings*/
80
81 #ifdef OLSR_COLLECT_STARTUP_SLEEP
82 static int max_startup_sleep = 0;
83 #endif /* OLSR_COLLECT_STARTUP_SLEEP */
84 static int sum_startup_sleep = 0;
85
86 void olsr_startup_sleep(int s)
87 {
88   sum_startup_sleep += s;
89 #ifdef OLSR_COLLECT_STARTUP_SLEEP
90   if (s > max_startup_sleep) max_startup_sleep=s;
91 #else /* OLSR_COLLECT_STARTUP_SLEEP */
92   sleep(s);
93 #endif /* OLSR_COLLECT_STARTUP_SLEEP */
94 }
95
96 void olsr_do_startup_sleep(void)
97 {
98 #ifdef OLSR_COLLECT_STARTUP_SLEEP
99   if (sum_startup_sleep > max_startup_sleep)
100     printf("OLSR encountered multiple problems on startup, which should delay startup by %i seconds.\nAs this is quite much time, OLSR will sleep only %i seconds.\nBUT YOU SHOULD FIX ABOVE PROBLEMS!\n",
101            sum_startup_sleep,max_startup_sleep);
102   sleep(max_startup_sleep);
103 #else /* OLSR_COLLECT_STARTUP_SLEEP */
104   if (sum_startup_sleep > 0) 
105     printf("olsrd startup was delayed %i seconds due to various nasty error messages.\nYOU SHOULD REALLY FIX ABOVE PROBLEMS!\n",
106            sum_startup_sleep);
107 #endif /* OLSR_COLLECT_STARTUP_SLEEP */
108 }
109
110 /**
111  * Process changes functions
112  */
113
114 struct pcf {
115   int (*function) (int, int, int);
116   struct pcf *next;
117 };
118
119 static struct pcf *pcf_list;
120
121 static uint16_t message_seqno;
122 union olsr_ip_addr all_zero;
123
124 /**
125  *Initialize the message sequence number as a random value
126  */
127 void
128 init_msg_seqno(void)
129 {
130   message_seqno = random() & 0xFFFF;
131 }
132
133 /**
134  * Get and increment the message sequence number
135  *
136  *@return the seqno
137  */
138 uint16_t
139 get_msg_seqno(void)
140 {
141   return message_seqno++;
142 }
143
144 bool
145 olsr_is_bad_duplicate_msg_seqno(uint16_t seqno) {
146   int32_t diff = (int32_t) seqno - (int32_t) message_seqno;
147
148   if (diff < -32768) {
149     diff += 65536;
150   }
151   else if (diff > 32767) {
152     diff -= 65536;
153   }
154   return diff > 0;
155 }
156
157 void
158 register_pcf(int (*f) (int, int, int))
159 {
160   struct pcf *new_pcf;
161
162   OLSR_PRINTF(1, "Registering pcf function\n");
163
164   new_pcf = olsr_malloc(sizeof(struct pcf), "New PCF");
165
166   new_pcf->function = f;
167   new_pcf->next = pcf_list;
168   pcf_list = new_pcf;
169
170 }
171
172 /**
173  *Process changes in neighborhood or/and topology.
174  *Re-calculates the neighborhood/topology if there
175  *are any updates - then calls the right functions to
176  *update the routing table.
177  *@return 0
178  */
179 void
180 olsr_process_changes(void)
181 {
182   struct pcf *tmp_pc_list;
183
184 #ifdef DEBUG
185   if (changes_neighborhood)
186     OLSR_PRINTF(3, "CHANGES IN NEIGHBORHOOD\n");
187   if (changes_topology)
188     OLSR_PRINTF(3, "CHANGES IN TOPOLOGY\n");
189   if (changes_hna)
190     OLSR_PRINTF(3, "CHANGES IN HNA\n");
191 #endif /* DEBUG */
192
193   if (!changes_neighborhood && !changes_topology && !changes_hna)
194     return;
195
196   if (olsr_cnf->debug_level > 0 && olsr_cnf->clear_screen && isatty(1)) {
197     clear_console();
198     printf("       *** %s (%s on %s) ***\n", olsrd_version, build_date, build_host);
199   }
200
201   if (changes_neighborhood) {
202     if (olsr_cnf->lq_level < 1) {
203       olsr_calculate_mpr();
204     } else {
205       olsr_calculate_lq_mpr();
206     }
207   }
208
209   /* calculate the routing table */
210   if (changes_neighborhood || changes_topology || changes_hna) {
211     olsr_calculate_routing_table(false);
212   }
213
214   if (olsr_cnf->debug_level > 0) {
215     if (olsr_cnf->debug_level > 2) {
216       olsr_print_mid_set();
217 #ifdef __linux__
218     olsr_print_gateway_entries();
219 #endif /* __linux__ */
220
221       if (olsr_cnf->debug_level > 3) {
222         if (olsr_cnf->debug_level > 8) {
223           olsr_print_duplicate_table();
224         }
225         olsr_print_hna_set();
226       }
227     }
228     olsr_print_link_set();
229     olsr_print_neighbor_table();
230     olsr_print_two_hop_neighbor_table();
231     if (olsr_cnf->debug_level > 3) {
232       olsr_print_tc_table();
233     }
234   }
235
236   for (tmp_pc_list = pcf_list; tmp_pc_list != NULL; tmp_pc_list = tmp_pc_list->next) {
237     tmp_pc_list->function(changes_neighborhood, changes_topology, changes_hna);
238   }
239
240   changes_neighborhood = false;
241   changes_topology = false;
242   changes_hna = false;
243   changes_force = false;
244 }
245
246 /**
247  *Initialize all the tables used(neighbor,
248  *topology, MID,  HNA, MPR, dup).
249  *Also initalizes other variables
250  */
251 void
252 olsr_init_tables(void)
253 {
254   changes_topology = false;
255   changes_neighborhood = false;
256   changes_hna = false;
257
258   /* Set avl tree comparator */
259   if (olsr_cnf->ipsize == 4) {
260     avl_comp_default = avl_comp_ipv4;
261     avl_comp_prefix_default = avl_comp_ipv4_prefix;
262   } else {
263     avl_comp_default = avl_comp_ipv6;
264     avl_comp_prefix_default = avl_comp_ipv6_prefix;
265   }
266
267   /* Initialize lq plugin set */
268   init_lq_handler_tree();
269
270   /* Initialize link set */
271   olsr_init_link_set();
272
273   /* Initialize duplicate table */
274   olsr_init_duplicate_set();
275
276   /* Initialize neighbor table */
277   olsr_init_neighbor_table();
278
279   /* Initialize routing table */
280   olsr_init_routing_table();
281
282   /* Initialize two hop table */
283   olsr_init_two_hop_table();
284
285   /* Initialize topology */
286   olsr_init_tc();
287
288   /* Initialize mpr selector table */
289   olsr_init_mprs_set();
290
291   /* Initialize MID set */
292   olsr_init_mid_set();
293
294   /* Initialize HNA set */
295   olsr_init_hna_set();
296
297   /* Initialize duplicate handler */
298 #ifndef NO_DUPLICATE_DETECTION_HANDLER
299   olsr_duplicate_handler_init();
300 #endif /* NO_DUPLICATE_DETECTION_HANDLER */
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 to be forwarded
308  *@param in_if the incoming interface
309  *@param from_addr neighbour we received message from
310  *
311  *@returns positive if forwarded
312  */
313 int
314 olsr_forward_message(union olsr_message *m, struct interface *in_if, union olsr_ip_addr *from_addr)
315 {
316   union olsr_ip_addr *src;
317   struct neighbor_entry *neighbor;
318   int msgsize;
319   struct interface *ifn;
320   bool is_ttl_1 = false;
321
322   /*
323    * Sven-Ola: We should not flood the mesh with overdue messages. Because
324    * of a bug in parser.c:parse_packet, we have a lot of messages because
325    * all older olsrd's have lq_fish enabled.
326    */
327   if (AF_INET == olsr_cnf->ip_version) {
328     if (m->v4.ttl < 2 || 255 < (int)m->v4.hopcnt + (int)m->v4.ttl)
329       is_ttl_1 = true;
330   } else {
331     if (m->v6.ttl < 2 || 255 < (int)m->v6.hopcnt + (int)m->v6.ttl)
332       is_ttl_1 = true;
333   }
334
335   /* Lookup sender address */
336   src = mid_lookup_main_addr(from_addr);
337   if (!src)
338     src = from_addr;
339
340   neighbor = olsr_lookup_neighbor_table(src);
341   if (!neighbor)
342     return 0;
343
344   if (neighbor->status != SYM)
345     return 0;
346
347   /* Check MPR */
348   if (olsr_lookup_mprs_set(src) == NULL) {
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 /* DEBUG */
353     return 0;
354   }
355
356   if (olsr_message_is_duplicate(m)) {
357     return 0;
358   }
359
360   /* Treat TTL hopcnt except for ethernet link */
361   if (!is_ttl_1) {
362     if (olsr_cnf->ip_version == AF_INET) {
363       /* IPv4 */
364       m->v4.hopcnt++;
365       m->v4.ttl--;
366     } else {
367       /* IPv6 */
368       m->v6.hopcnt++;
369       m->v6.ttl--;
370     }
371   }
372
373   /* Update packet data */
374   msgsize = ntohs(m->v4.olsr_msgsize);
375
376   /* looping trough interfaces */
377   for (ifn = ifnet; ifn; ifn = ifn->int_next) {
378     /* do not retransmit out through the same interface if it has mode == ether */
379     if (ifn == in_if && ifn->mode == IF_MODE_ETHER) continue;
380
381     /* do not forward TTL 1 messages to non-ether interfaces */
382     if (is_ttl_1 && ifn->mode != IF_MODE_ETHER) continue;
383
384     if (net_output_pending(ifn)) {
385       /*
386        * Check if message is to big to be piggybacked
387        */
388       if (net_outbuffer_push(ifn, m, msgsize) != msgsize) {
389         /* Send */
390         net_output(ifn);
391         /* Buffer message */
392         set_buffer_timer(ifn);
393
394         if (net_outbuffer_push(ifn, m, msgsize) != msgsize) {
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     } else {
400       /* No forwarding pending */
401       set_buffer_timer(ifn);
402
403       if (net_outbuffer_push(ifn, m, msgsize) != msgsize) {
404         OLSR_PRINTF(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
405         olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
406       }
407     }
408   }
409   return 1;
410 }
411
412 void
413 set_buffer_timer(struct interface *ifn)
414 {
415   /* Set timer */
416   ifn->fwdtimer = GET_TIMESTAMP(random() * olsr_cnf->max_jitter * MSEC_PER_SEC / RAND_MAX);
417 }
418
419 void
420 olsr_init_willingness(void)
421 {
422   if (olsr_cnf->willingness_auto) {
423
424     /* Run it first and then periodic. */
425     olsr_update_willingness(NULL);
426
427     olsr_start_timer((unsigned int)olsr_cnf->will_int * MSEC_PER_SEC, 5, OLSR_TIMER_PERIODIC, &olsr_update_willingness, NULL, 0);
428   }
429 }
430
431 void
432 olsr_update_willingness(void *foo __attribute__ ((unused)))
433 {
434   int tmp_will = olsr_cnf->willingness;
435
436   /* Re-calculate willingness */
437   olsr_cnf->willingness = olsr_calculate_willingness();
438
439   if (tmp_will != olsr_cnf->willingness) {
440     OLSR_PRINTF(1, "Local willingness updated: old %d new %d\n", tmp_will, olsr_cnf->willingness);
441   }
442 }
443
444 /**
445  *Calculate this nodes willingness to act as a MPR
446  *based on either a fixed value or the power status
447  *of the node using APM
448  *
449  *@return a 8bit value from 0-7 representing the willingness
450  */
451
452 uint8_t
453 olsr_calculate_willingness(void)
454 {
455   struct olsr_apm_info ainfo;
456
457   /* If fixed willingness */
458   if (!olsr_cnf->willingness_auto)
459     return olsr_cnf->willingness;
460
461   if (apm_read(&ainfo) < 1)
462     return WILL_DEFAULT;
463
464   apm_printinfo(&ainfo);
465
466   /* If AC powered */
467   if (ainfo.ac_line_status == OLSR_AC_POWERED)
468     return 6;
469
470   /* If battery powered
471    *
472    * juice > 78% will: 3
473    * 78% > juice > 26% will: 2
474    * 26% > juice will: 1
475    */
476   return (ainfo.battery_percentage / 26);
477 }
478
479 const char *
480 olsr_msgtype_to_string(uint8_t msgtype)
481 {
482   static char type[20];
483
484   switch (msgtype) {
485   case (HELLO_MESSAGE):
486     return "HELLO";
487   case (TC_MESSAGE):
488     return "TC";
489   case (MID_MESSAGE):
490     return "MID";
491   case (HNA_MESSAGE):
492     return "HNA";
493   case (LQ_HELLO_MESSAGE):
494     return ("LQ-HELLO");
495   case (LQ_TC_MESSAGE):
496     return ("LQ-TC");
497   default:
498     break;
499   }
500
501   snprintf(type, sizeof(type), "UNKNOWN(%d)", msgtype);
502   return type;
503 }
504
505 const char *
506 olsr_link_to_string(uint8_t linktype)
507 {
508   static char type[20];
509
510   switch (linktype) {
511   case (UNSPEC_LINK):
512     return "UNSPEC";
513   case (ASYM_LINK):
514     return "ASYM";
515   case (SYM_LINK):
516     return "SYM";
517   case (LOST_LINK):
518     return "LOST";
519   case (HIDE_LINK):
520     return "HIDE";
521   default:
522     break;
523   }
524
525   snprintf(type, sizeof(type), "UNKNOWN(%d)", linktype);
526   return type;
527 }
528
529 const char *
530 olsr_status_to_string(uint8_t status)
531 {
532   static char type[20];
533
534   switch (status) {
535   case (NOT_NEIGH):
536     return "NOT NEIGH";
537   case (SYM_NEIGH):
538     return "NEIGHBOR";
539   case (MPR_NEIGH):
540     return "MPR";
541   default:
542     break;
543   }
544
545   snprintf(type, sizeof(type), "UNKNOWN(%d)", status);
546   return type;
547 }
548
549 /**
550  *Termination function to be called whenever a error occures
551  *that requires the daemon to terminate
552  *
553  *@param msg the message to write to the syslog and possibly stdout
554  *@param val the exit code
555  */
556
557 void
558 olsr_exit(const char *msg, int val)
559 {
560   OLSR_PRINTF(1, "OLSR EXIT: %s\n", msg);
561   olsr_syslog(OLSR_LOG_ERR, "olsrd exit: %s\n", msg);
562   fflush(stdout);
563   olsr_cnf->exit_value = val;
564
565   raise(SIGTERM);
566
567   /* just to be sure */
568   exit(val);
569 }
570
571 /**
572  * Wrapper for malloc(3) that does error-checking
573  *
574  * @param size the number of bytes to allocalte
575  * @param id a string identifying the caller for
576  * use in error messaging
577  *
578  * @return a void pointer to the memory allocated
579  */
580 void *
581 olsr_malloc(size_t size, const char *id)
582 {
583   void *ptr;
584
585   /*
586    * Not all the callers do a proper cleaning of memory.
587    * Clean it on behalf of those.
588    */
589   ptr = calloc(1, size);
590
591   if (!ptr) {
592     const char *const err_msg = strerror(errno);
593     OLSR_PRINTF(1, "OUT OF MEMORY: %s\n", err_msg);
594     olsr_syslog(OLSR_LOG_ERR, "olsrd: out of memory!: %s\n", err_msg);
595     olsr_exit(id, EXIT_FAILURE);
596   }
597
598   return ptr;
599 }
600
601 /**
602  *Wrapper for printf that prints to a specific
603  *debuglevel upper limit
604  *
605  */
606
607 int
608 olsr_printf(int loglevel, const char *format, ...)
609 {
610   if ((loglevel <= olsr_cnf->debug_level) && debug_handle) {
611     va_list arglist;
612     va_start(arglist, format);
613     vfprintf(debug_handle, format, arglist);
614     va_end(arglist);
615   }
616   return 0;
617 }
618
619 /*
620  * Local Variables:
621  * c-basic-offset: 2
622  * indent-tabs-mode: nil
623  * End:
624  */