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