Namespace cleanup of scheduler, remove "polling" sockets
[olsrd.git] / src / main.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
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 #include <unistd.h>
43 #include <signal.h>
44 #include <sys/stat.h>
45 #include <assert.h>
46 #include <errno.h>
47
48 #include "defs.h"
49 #include "common/avl.h"
50 #include "common/avl_olsr_comp.h"
51 #include "olsr.h"
52 #include "ipcalc.h"
53 #include "scheduler.h"
54 #include "parser.h"
55 #include "plugin_loader.h"
56 #include "os_apm.h"
57 #include "net_olsr.h"
58 #include "olsr_cfg_gen.h"
59 #include "common/string.h"
60 #include "mid_set.h"
61 #include "duplicate_set.h"
62 #include "olsr_comport.h"
63 #include "neighbor_table.h"
64 #include "olsr_logging.h"
65 #include "olsr_callbacks.h"
66 #include "os_apm.h"
67 #include "os_net.h"
68 #include "os_kernel_routes.h"
69 #include "os_time.h"
70 #include "os_system.h"
71
72 #if defined linux
73 #include <linux/types.h>
74 #include <linux/rtnetlink.h>
75 #include <fcntl.h>
76 #endif
77
78 #define STDOUT_PULSE_INT 600    /* msec */
79
80 #ifdef WIN32
81 int __stdcall SignalHandler(unsigned long signo);
82 #else
83 static void signal_shutdown(int);
84 #endif
85 static void olsr_shutdown(void);
86
87 /*
88  * Local function prototypes
89  */
90 #ifndef WIN32
91 static void signal_reconfigure(int);
92 #endif
93
94 /* Global stuff externed in olsr_cfg.h */
95 struct olsr_config *olsr_cnf;          /* The global configuration */
96
97 volatile enum app_state app_state = STATE_INIT;
98
99 static char copyright_string[] __attribute__ ((unused)) =
100   "The olsr.org Optimized Link-State Routing daemon(olsrd) Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org) All rights reserved.";
101
102 static char pulsedata[] = "\\|/-";
103 static uint8_t pulse_state = 0;
104
105 static struct olsr_timer_entry *hna_gen_timer;
106 static struct olsr_timer_entry *mid_gen_timer;
107 static struct olsr_timer_entry *tc_gen_timer;
108
109 static void
110 generate_stdout_pulse(void *foo __attribute__ ((unused)))
111 {
112   if (pulsedata[++pulse_state] == '\0') {
113     pulse_state = 0;
114   }
115   fprintf(stderr, "%c\r", pulsedata[pulse_state]);
116 }
117
118 /**
119  * Main entrypoint
120  */
121
122 int
123 main(int argc, char *argv[])
124 {
125   /* Some cookies for stats keeping */
126   static struct olsr_timer_info *pulse_timer_info = NULL;
127   static struct olsr_timer_info *tc_gen_timer_info = NULL;
128   static struct olsr_timer_info *mid_gen_timer_info = NULL;
129   static struct olsr_timer_info *hna_gen_timer_info = NULL;
130
131   char conf_file_name[FILENAME_MAX];
132   char parse_msg[FILENAME_MAX + 256];
133   int exitcode = 0;
134 #if !defined(REMOVE_LOG_INFO) || !defined(REMOVE_LOG_ERROR)
135   struct ipaddr_str buf;
136 #endif
137 #ifdef WIN32
138   WSADATA WsaData;
139   size_t len;
140 #endif
141
142   /* paranoia checks */
143   assert(sizeof(uint8_t) == 1);
144   assert(sizeof(uint16_t) == 2);
145   assert(sizeof(uint32_t) == 4);
146   assert(sizeof(int8_t) == 1);
147   assert(sizeof(int16_t) == 2);
148   assert(sizeof(int32_t) == 4);
149
150   setbuf(stdout, NULL);
151   setbuf(stderr, NULL);
152
153   /* Using PID as random seed */
154   srandom(getpid());
155
156   /* call os dependent argument preprocessor */
157   os_arg(&argc, argv);
158
159   /*
160    * Set default configfile name
161    */
162 #ifdef WIN32
163 #ifndef WINCE
164   GetWindowsDirectory(conf_file_name, sizeof(conf_file_name) - 1 - strlen(OLSRD_CONF_FILE_NAME));
165 #else
166   conf_file_name[0] = 0;
167 #endif
168
169   len = strlen(conf_file_name);
170
171   if (len == 0 || conf_file_name[len - 1] != '\\') {
172     conf_file_name[len++] = '\\';
173   }
174
175   strscpy(conf_file_name + len, OLSRD_CONF_FILE_NAME, sizeof(conf_file_name) - len);
176 #else
177   strscpy(conf_file_name, OLSRD_GLOBAL_CONF_FILE, sizeof(conf_file_name));
178 #endif
179
180   /*
181    * set up configuration prior to processing commandline options
182    */
183   switch (olsr_parse_cfg(argc, argv, conf_file_name, parse_msg, &olsr_cnf)) {
184   case CFG_ERROR:
185     if (parse_msg[0])
186       fprintf(stderr, "Error: %s\n", parse_msg);
187     os_exit(EXIT_FAILURE);
188     break;
189   case CFG_WARN:
190     if (parse_msg[0])
191       fprintf(stderr, "Warning: %s\n", parse_msg);
192     /* No exit */
193     break;
194   case CFG_EXIT:
195     os_exit(EXIT_SUCCESS);
196     break;
197   case CFG_OK:
198     /* Continue */
199     break;
200   }
201
202   /* Set avl tree comparator */
203   if (olsr_cnf->ipsize == 4) {
204     avl_comp_default = avl_comp_ipv4;
205     avl_comp_addr_origin_default = avl_comp_ipv4_addr_origin;
206     avl_comp_prefix_default = avl_comp_ipv4_prefix;
207     avl_comp_prefix_origin_default = avl_comp_ipv4_prefix_origin;
208   } else {
209     avl_comp_default = avl_comp_ipv6;
210     avl_comp_addr_origin_default = avl_comp_ipv6_addr_origin;
211     avl_comp_prefix_default = avl_comp_ipv6_prefix;
212     avl_comp_prefix_origin_default = avl_comp_ipv6_prefix_origin;
213   }
214
215   /* initialize logging */
216   olsr_log_init();
217
218   OLSR_INFO(LOG_MAIN, "\n *** %s ***\n Build date: %s on %s\n http://www.olsr.org\n\n", olsrd_version, build_date, build_host);
219
220   /* Sanity check configuration */
221   if (olsr_sanity_check_cfg(olsr_cnf) < 0) {
222     olsr_exit(EXIT_FAILURE);
223   }
224
225   /* setup os specific global options */
226   os_init();
227
228 #ifndef WIN32
229   /* Check if user is root */
230   if (geteuid()) {
231     OLSR_ERROR(LOG_MAIN, "You must be root(uid = 0) to run olsrd!\nExiting\n\n");
232     olsr_exit(EXIT_FAILURE);
233   }
234 #else
235   if (WSAStartup(0x0202, &WsaData)) {
236     OLSR_ERROR(LOG_MAIN, "Could not initialize WinSock.\n");
237     olsr_exit(EXIT_FAILURE);
238   }
239 #endif
240
241   /* initialize cookie system */
242   olsr_memcookie_init();
243
244   /* Initialize timers and scheduler part */
245   olsr_init_timers();
246
247   /* initialize callback system */
248   olsr_callback_init();
249
250   /* generate global timers */
251   pulse_timer_info = olsr_timer_add("Stdout pulse", &generate_stdout_pulse, true);
252   tc_gen_timer_info = olsr_timer_add("TC generation", &olsr_output_lq_tc, true);
253   mid_gen_timer_info = olsr_timer_add("MID generation", &generate_mid, true);
254   hna_gen_timer_info = olsr_timer_add("HNA generation", &generate_hna, true);
255
256   /* initialize plugin system */
257   olsr_init_pluginsystem();
258   olsr_plugins_init(true);
259
260   /* initialisation of different tables to be used. */
261   olsr_init_tables();
262
263   /* enable lq-plugins */
264   olsr_plugins_enable(PLUGIN_TYPE_LQ, true);
265
266   /* initialize built in server services */
267   olsr_com_init(true);
268
269   /* Initialize net */
270   init_net();
271
272   /* Initialize SPF */
273   olsr_init_spf();
274
275   /*
276    * socket for ioctl calls
277    */
278   olsr_cnf->ioctl_s = socket(olsr_cnf->ip_version, SOCK_DGRAM, 0);
279   if (olsr_cnf->ioctl_s < 0) {
280     OLSR_ERROR(LOG_MAIN, "ioctl socket: %s\n", strerror(errno));
281     olsr_exit(EXIT_FAILURE);
282   }
283 #if defined linux
284   olsr_cnf->rtnl_s = socket(PF_NETLINK, SOCK_DGRAM, NETLINK_ROUTE);
285   if (olsr_cnf->rtnl_s < 0) {
286     OLSR_ERROR(LOG_MAIN, "rtnetlink socket: %s\n", strerror(errno));
287     olsr_exit(EXIT_FAILURE);
288   }
289   os_socket_set_nonblocking(olsr_cnf->rtnl_s);
290
291   /* Create rule for RtTable to resolve route insertion problems*/
292   if ( ( olsr_cnf->rt_table < 253) & ( olsr_cnf->rt_table > 0 ) ) {
293     OLSR_WARN(LOG_NETWORKING,"make sure to have correct policy routing rules (destination based rules are required, or a dummy rule with prio like 65535)");
294     /*olsr_netlink_rule(olsr_cnf->ip_version, olsr_cnf->rt_table, RTM_NEWRULE);*/
295   }
296 #endif
297
298 /*
299  * create routing socket
300  */
301 #if defined __FreeBSD__ || defined __MacOSX__ || defined __NetBSD__ || defined __OpenBSD__
302   olsr_cnf->rts_bsd = socket(PF_ROUTE, SOCK_RAW, 0);
303   if (olsr_cnf->rts_bsd < 0) {
304     OLSR_ERROR(LOG_MAIN, "routing socket: %s\n", strerror(errno));
305     olsr_exit(EXIT_FAILURE);
306   }
307 #endif
308
309   /* Initialize parser */
310   olsr_init_parser();
311
312   /* Initialize route-exporter */
313   olsr_init_export_route();
314
315   /* Initialize message sequencnumber */
316   init_msg_seqno();
317
318   /* Initialize dynamic willingness calculation */
319   olsr_init_willingness();
320
321   /*
322    *Set up willingness/APM
323    */
324   if (olsr_cnf->willingness_auto) {
325     olsr_calculate_willingness();
326   }
327
328 #if defined linux
329   /* Initializing lo:olsr if necessary */
330   if (olsr_cnf->source_ip_mode) {
331     OLSR_INFO(LOG_NETWORKING, "Initializing lo:olsr interface for source ip mode...\n");
332     if (olsr_os_localhost_if(&olsr_cnf->router_id, true) <= 0) {
333       OLSR_ERROR(LOG_NETWORKING, "Cannot create lo:olsr interface for ip '%s'\n", olsr_ip_to_string(&buf, &olsr_cnf->router_id));
334       olsr_exit(EXIT_FAILURE);
335     }
336   }
337 #endif
338
339   /* Initializing networkinterfaces */
340   if (!init_interfaces()) {
341     if (olsr_cnf->allow_no_interfaces) {
342       OLSR_INFO(LOG_MAIN,
343                 "No interfaces detected! This might be intentional, but it also might mean that your configuration is fubar.\nI will continue after 5 seconds...\n");
344       os_sleep(5);
345     } else {
346       OLSR_ERROR(LOG_MAIN, "No interfaces detected!\nBailing out!\n");
347       olsr_exit(EXIT_FAILURE);
348     }
349   }
350
351   /* Print heartbeat to stdout */
352
353 #if !defined WINCE
354   if (olsr_cnf->log_target_stderr > 0 && isatty(STDOUT_FILENO)) {
355     olsr_timer_start(STDOUT_PULSE_INT, 0, NULL, pulse_timer_info);
356   }
357 #endif
358
359   /* daemon mode */
360 #ifndef WIN32
361   if (!olsr_cnf->no_fork) {
362     OLSR_INFO(LOG_MAIN, "%s detaching from the current process...\n", olsrd_version);
363     if (daemon(0, 0) < 0) {
364       OLSR_ERROR(LOG_MAIN, "daemon(3) failed: %s\n", strerror(errno));
365       olsr_exit(EXIT_FAILURE);
366     }
367   }
368 #endif
369
370   /* activate LQ algorithm */
371   init_lq_handler();
372
373   OLSR_INFO(LOG_MAIN, "Main address: %s\n\n", olsr_ip_to_string(&buf, &olsr_cnf->router_id));
374
375   /* Start syslog entry */
376   OLSR_INFO(LOG_MAIN, "%s successfully started", olsrd_version);
377
378   /*
379    *signal-handlers
380    */
381
382   /* ctrl-C and friends */
383 #ifdef WIN32
384 #ifndef WINCE
385   SetConsoleCtrlHandler(SignalHandler, true);
386 #endif
387 #else
388   {
389     struct sigaction act;
390     sigemptyset(&act.sa_mask);
391     act.sa_flags = 0;
392     act.sa_handler = signal_reconfigure;
393     sigaction(SIGHUP, &act, NULL);
394     act.sa_handler = signal_shutdown;
395     sigaction(SIGINT, &act, NULL);
396     sigaction(SIGQUIT, &act, NULL);
397     sigaction(SIGILL, &act, NULL);
398     sigaction(SIGABRT, &act, NULL);
399 //  sigaction(SIGSEGV, &act, NULL);
400     sigaction(SIGTERM, &act, NULL);
401     act.sa_handler = SIG_IGN;
402     sigaction(SIGPIPE, &act, NULL);
403     // Ignoring SIGUSR1 and SIGUSR1 by default to be able to use them in plugins
404     sigaction(SIGUSR1, &act, NULL);
405     sigaction(SIGUSR2, &act, NULL);
406   }
407 #endif
408
409   link_changes = false;
410
411   tc_gen_timer =
412     olsr_timer_start(olsr_cnf->tc_params.emission_interval, TC_JITTER, NULL, tc_gen_timer_info);
413   mid_gen_timer =
414     olsr_timer_start(olsr_cnf->mid_params.emission_interval, MID_JITTER, NULL, mid_gen_timer_info);
415   hna_gen_timer =
416     olsr_timer_start(olsr_cnf->hna_params.emission_interval, HNA_JITTER, NULL, hna_gen_timer_info);
417
418   /* enable default plugins */
419   olsr_plugins_enable(PLUGIN_TYPE_DEFAULT, true);
420
421   /* Starting scheduler */
422   app_state = STATE_RUNNING;
423   olsr_scheduler();
424
425   olsr_timer_stop(tc_gen_timer);
426   tc_gen_timer = NULL;
427
428   olsr_timer_stop(mid_gen_timer);
429   mid_gen_timer = NULL;
430
431   olsr_timer_stop(hna_gen_timer);
432   hna_gen_timer = NULL;
433
434   exitcode = olsr_cnf->exit_value;
435   switch (app_state) {
436   case STATE_INIT:
437     OLSR_ERROR(LOG_MAIN, "terminating and got \"init\"?");
438     exitcode = EXIT_FAILURE;
439     break;
440   case STATE_RUNNING:
441     OLSR_ERROR(LOG_MAIN, "terminating and got \"running\"?");
442     exitcode = EXIT_FAILURE;
443     break;
444 #ifndef WIN32
445   case STATE_RECONFIGURE:
446     /* if we are started with -nofork, we do not weant to go into the
447      * background here. So we can simply be the child process.
448      */
449     switch (olsr_cnf->no_fork ? 0 : fork()) {
450       int i;
451     case 0:
452       /* child process */
453       for (i = sysconf(_SC_OPEN_MAX); --i > STDERR_FILENO;) {
454         close(i);
455       }
456       os_sleep(1);
457       OLSR_INFO(LOG_MAIN, "Restarting %s\n", argv[0]);
458       execv(argv[0], argv);
459       /* if we reach this, the exev() failed */
460       OLSR_ERROR(LOG_MAIN, "execv() failed: %s", strerror(errno));
461       /* and we simply shutdown */
462       exitcode = EXIT_FAILURE;
463       break;
464     case -1:
465       /* fork() failes */
466       OLSR_ERROR(LOG_MAIN, "fork() failed: %s", strerror(errno));
467       /* and we simply shutdown */
468       exitcode = EXIT_FAILURE;
469       break;
470     default:
471       /* parent process */
472       OLSR_INFO(LOG_MAIN, "Reconfiguring OLSR\n");
473       break;
474     }
475     /* fall through */
476 #endif
477   case STATE_SHUTDOWN:
478     olsr_shutdown();
479     break;
480   };
481
482   return exitcode;
483 }                               /* main */
484
485 #ifndef WIN32
486
487 /**
488  * Request reconfiguration of olsrd.
489  *
490  *@param signal the signal that triggered this callback
491  */
492 static void
493 signal_reconfigure(int signo __attribute__ ((unused)))
494 {
495   const int save_errno = errno;
496   OLSR_INFO(LOG_MAIN, "Received signal %d - requesting reconfiguration", signo);
497   app_state = STATE_RECONFIGURE;
498   errno = save_errno;
499 }
500
501 #endif
502
503 /**
504  *Function called at shutdown. Signal handler
505  *
506  * @param signal the signal that triggered this call
507  */
508 #ifdef WIN32
509 int __stdcall
510 SignalHandler(unsigned long signo)
511 #else
512 static void
513 signal_shutdown(int signo __attribute__ ((unused)))
514 #endif
515 {
516   const int save_errno = errno;
517   OLSR_INFO(LOG_MAIN, "Received signal %d - requesting shutdown", (int)signo);
518   app_state = STATE_SHUTDOWN;
519   errno = save_errno;
520 #ifdef WIN32
521   return 0;
522 #endif
523 }
524
525 static void
526 olsr_shutdown(void)
527 {
528   struct mid_entry *mid, *iterator;
529
530   olsr_delete_all_kernel_routes();
531
532   /* Flush MID database */
533   OLSR_FOR_ALL_MID_ENTRIES(mid, iterator) {
534     olsr_delete_mid_entry(mid);
535   }
536
537   /* Flush TC database */
538   olsr_delete_all_tc_entries();
539
540   OLSR_INFO(LOG_MAIN, "Closing sockets...\n");
541
542   /* kill http/telnet server */
543   olsr_com_destroy();
544
545   /* Flush duplicate set */
546   olsr_flush_duplicate_entries();
547
548   /* Shut down LQ plugin */
549   deinit_lq_handler();
550
551   /* Closing plug-ins */
552   olsr_destroy_pluginsystem();
553
554   /* Remove active interfaces */
555   destroy_interfaces();
556
557 #if defined linux
558   /* delete lo:olsr if neccesarry */
559   if (olsr_cnf->source_ip_mode) {
560     olsr_os_localhost_if(&olsr_cnf->router_id, false);
561   }
562 #endif
563
564   /* ioctl socket */
565   os_close(olsr_cnf->ioctl_s);
566
567 #if defined linux
568   /*if ((olsr_cnf->rttable < 253) & (olsr_cnf->rttable > 0)) {
569     olsr_netlink_rule(olsr_cnf->ip_version, olsr_cnf->rttable, RTM_DELRULE);
570   }*/
571
572   os_close(olsr_cnf->rtnl_s);
573 #endif
574
575 #if defined __FreeBSD__ || defined __MacOSX__ || defined __NetBSD__ || defined __OpenBSD__
576   /* routing socket */
577   os_close(olsr_cnf->rts_bsd);
578 #endif
579
580   /* Close and delete all sockets */
581   olsr_socket_cleanup();
582
583   /* Stop and delete all timers. */
584   olsr_flush_timers();
585
586   /* Remove parser hooks */
587   olsr_deinit_parser();
588
589   /* Remove IP filters */
590   deinit_netfilters();
591
592   /* release callback system */
593   olsr_callback_cleanup();
594
595   /* Free cookies and memory pools attached. */
596   olsr_memcookie_cleanup();
597
598   /* Reset os_specific global options */
599   os_cleanup();
600
601   OLSR_INFO(LOG_MAIN, "\n <<<< %s - terminating >>>>\n           http://www.olsr.org\n", olsrd_version);
602
603   /* cleanup logging system */
604   olsr_log_cleanup();
605
606   /* Flush config */
607   olsr_free_cfg(olsr_cnf);
608 }
609
610 /*
611  * Local Variables:
612  * c-basic-offset: 2
613  * indent-tabs-mode: nil
614  * End:
615  */