Update of licence/copyright note and addition of copyright string
[olsrd.git] / src / main.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas T√łnnesen(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 projcet. For more information see the website or contact
38  * the copyright holders.
39  *
40  * $Id: main.c,v 1.45 2004/11/20 23:46:08 kattemat Exp $
41  */
42
43 #include <unistd.h>
44 #include <signal.h>
45 #include <sys/stat.h>
46
47 #include "defs.h"
48 #include "interfaces.h"
49 #include "local_hna_set.h"
50 #include "scheduler.h"
51 #include "parser.h"
52 #include "generate_msg.h"
53 #include "plugin_loader.h"
54 #include "socket_parser.h"
55 #include "apm.h"
56 #include "link_layer.h"
57 #include "net_os.h"
58
59 #ifdef WIN32
60 #define close(x) closesocket(x)
61 int __stdcall SignalHandler(unsigned long signal);
62 void ListInterfaces(void);
63 void DisableIcmpRedirects(void);
64 #else
65 static void
66 olsr_shutdown(int);
67 #endif
68
69 /*
70  * Local function prototypes
71  */
72 void
73 olsr_reconfigure(int);
74
75 static void
76 print_usage(void);
77
78 static void
79 set_default_values(void);
80
81 static int
82 set_default_ifcnfs(struct olsr_if *, struct if_config_options *);
83
84 static char **olsr_argv;
85
86 static char copyright_string[] = "The olsr.org Optimized Link-State Routing daemon(olsrd) Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org) All rights reserved.";
87
88 /**
89  * Main entrypoint
90  */
91
92 int
93 main(int argc, char *argv[])
94 {
95   /* For address convertions */
96   struct in_addr in;
97   struct in6_addr in6;
98
99   struct if_config_options *default_ifcnf;
100
101   struct stat statbuf;
102   char conf_file_name[FILENAME_MAX];
103   
104   olsr_argv = argv;
105
106 #ifdef WIN32
107   WSADATA WsaData;
108   int len;
109 #endif
110
111   setbuf(stdout, NULL);
112   setbuf(stderr, NULL);
113
114   /* Initialize socket list */
115   olsr_socket_entries = NULL;
116
117 #ifndef WIN32
118   /* Check if user is root */
119   if(getuid() || getgid())
120     {
121       fprintf(stderr, "You must be root(uid = 0) to run olsrd!\nExiting\n\n");
122       exit(EXIT_FAILURE);
123     }
124 #else
125   DisableIcmpRedirects();
126
127   if (WSAStartup(0x0202, &WsaData))
128     {
129       fprintf(stderr, "Could not initialize WinSock.\n");
130       olsr_exit(__func__, EXIT_FAILURE);
131     }
132 #endif
133
134   /* Open syslog */
135   olsr_openlog("olsrd");
136
137   /* Set default values */
138   set_default_values();
139
140   /* Initialize network functions */
141   init_net();
142  
143   /* Get initial timestep */
144   nowtm = NULL;
145   while (nowtm == NULL)
146     {
147       nowtm = gmtime((time_t *)&now.tv_sec);
148     }
149     
150   /* The port to use for OLSR traffic */
151   olsr_udp_port = htons(OLSRPORT);
152     
153   printf("\n *** %s ***\n Build date: %s\n http://www.olsr.org\n\n", 
154          SOFTWARE_VERSION, 
155          __DATE__);
156     
157   /* Using PID as random seed */
158   srandom(getpid());
159
160
161   /*
162    * Set configfile name and
163    * check if a configfile name was given as parameter
164    */
165 #ifdef WIN32
166   GetWindowsDirectory(conf_file_name, FILENAME_MAX - 11);
167   
168   len = strlen(conf_file_name);
169   
170   if (conf_file_name[len - 1] != '\\')
171     conf_file_name[len++] = '\\';
172   
173   strcpy(conf_file_name + len, "olsrd.conf");
174 #else
175   strncpy(conf_file_name, OLSRD_GLOBAL_CONF_FILE, FILENAME_MAX);
176 #endif
177
178   if ((argc > 1) && (strcmp(argv[1], "-f") == 0)) 
179     {
180       argv++; argc--;
181       if(argc == 1)
182         {
183           fprintf(stderr, "You must provide a filename when using the -f switch!\n");
184           exit(EXIT_FAILURE);
185         }
186
187       if (stat(argv[1], &statbuf) < 0)
188         {
189           fprintf(stderr, "Could not find specified config file %s!\n%s\n\n", argv[1], strerror(errno));
190           exit(EXIT_FAILURE);
191         }
192                  
193       strncpy(conf_file_name, argv[1], FILENAME_MAX);
194       argv++; argc--;
195
196     }
197
198   /*
199    * set up configuration prior to processing commandline options
200    */
201   if((olsr_cnf = olsrd_parse_cnf(conf_file_name)) == NULL)
202     {
203       printf("Using default config values(no configfile)\n");
204       olsr_cnf = olsrd_get_default_cnf();
205     }
206   if((default_ifcnf = get_default_if_config()) == NULL)
207     {
208       fprintf(stderr, "No default ifconfig found!\n");
209       exit(EXIT_FAILURE);
210     }
211
212   /*
213    * Process olsrd options.
214    */
215   
216   argv++; argc--;
217   while (argc > 0 && **argv == '-')
218     {
219 #ifdef WIN32
220       /*
221        *Interface list
222        */
223       if (strcmp(*argv, "-int") == 0)
224         {
225           ListInterfaces();
226           exit(0);
227         }
228 #endif
229
230       /*
231        *Configfilename
232        */
233       if(strcmp(*argv, "-f") == 0) 
234         {
235           fprintf(stderr, "Configfilename must ALWAYS be first argument!\n\n");
236           olsr_exit(__func__, EXIT_FAILURE);
237         }
238
239       /*
240        *Use IP version 6
241        */
242       if(strcmp(*argv, "-ipv6") == 0) 
243         {
244           olsr_cnf->ip_version = AF_INET6;
245           argv++; argc--;
246           continue;
247         }
248
249       /*
250        *Broadcast address
251        */
252       if(strcmp(*argv, "-bcast") == 0) 
253         {
254           argv++; argc--;
255           if(!argc)
256             {
257               fprintf(stderr, "You must provide a broadcastaddr when using the -bcast switch!\n");
258               olsr_exit(__func__, EXIT_FAILURE);
259             }
260           if (inet_aton(*argv, &in) == 0)
261             {
262               printf("Invalid broadcast address! %s\nSkipping it!\n", *argv);
263               continue;
264             }
265           memcpy(&default_ifcnf->ipv4_broadcast.v4, &in.s_addr, sizeof(olsr_u32_t));  
266           continue;
267         }
268       
269       /*
270        * Enable additional debugging information to be logged.
271        */
272       if (strcmp(*argv, "-d") == 0) 
273         {
274           argv++; argc--;
275           sscanf(*argv,"%d", &olsr_cnf->debug_level);
276           argv++; argc--;
277           continue;
278         }
279
280                 
281       /*
282        * Interfaces to be used by olsrd.
283        */
284       if (strcmp(*argv, "-i") == 0) 
285         {
286           argv++; argc--;
287           if(!argc || (*argv[0] == '-'))
288             {
289               fprintf(stderr, "You must provide an interface label!\n");
290               olsr_exit(__func__, EXIT_FAILURE);
291             }
292
293           queue_if(*argv);
294           argv++; argc--;
295
296           while((argc) && (**argv != '-'))
297             {
298               queue_if(*argv);
299               argv++; argc--;
300             }
301
302           continue;
303         }
304       /*
305        * Set the hello interval to be used by olsrd.
306        * 
307        */
308       if (strcmp(*argv, "-hint") == 0) 
309         {
310           argv++; argc--;
311           sscanf(*argv,"%f", &default_ifcnf->hello_params.emission_interval);
312           default_ifcnf->hello_params.validity_time = default_ifcnf->hello_params.emission_interval * 3;
313           argv++; argc--;
314           continue;
315         }
316
317       /*
318        * Set the HNA interval to be used by olsrd.
319        * 
320        */
321       if (strcmp(*argv, "-hnaint") == 0) 
322         {
323           argv++; argc--;
324           sscanf(*argv,"%f", &default_ifcnf->hna_params.emission_interval);
325           default_ifcnf->hna_params.validity_time = default_ifcnf->hna_params.emission_interval * 3;
326           argv++; argc--;
327           continue;
328         }
329
330       /*
331        * Set the MID interval to be used by olsrd.
332        * 
333        */
334       if (strcmp(*argv, "-midint") == 0) 
335         {
336           argv++; argc--;
337           sscanf(*argv,"%f", &default_ifcnf->mid_params.emission_interval);
338           default_ifcnf->mid_params.validity_time = default_ifcnf->mid_params.emission_interval * 3;
339           argv++; argc--;
340           continue;
341         }
342
343       /*
344        * Set the tc interval to be used by olsrd.
345        * 
346        */
347       if (strcmp(*argv, "-tcint") == 0) 
348         {
349           argv++; argc--;
350           sscanf(*argv,"%f", &default_ifcnf->tc_params.emission_interval);
351           default_ifcnf->tc_params.validity_time = default_ifcnf->tc_params.emission_interval * 3;
352           argv++; argc--;
353           continue;
354         }
355
356       /*
357        * Set the tos bits to be used by olsrd.
358        * 
359        */
360       if (strcmp(*argv, "-tos") == 0) 
361         {
362           argv++; argc--;
363           sscanf(*argv,"%d",(int *)&olsr_cnf->tos);
364           argv++; argc--;
365           continue;
366         }
367
368
369       /*
370        * Set the polling interval to be used by olsrd.
371        */
372       if (strcmp(*argv, "-T") == 0) 
373         {
374           argv++; argc--;
375           sscanf(*argv,"%f",&olsr_cnf->pollrate);
376           argv++; argc--;
377           continue;
378         }
379
380
381       /*
382        * Should we display the contents of packages beeing sent?
383        */
384       if (strcmp(*argv, "-dispin") == 0) 
385         {
386           argv++; argc--;
387           disp_pack_in = OLSR_TRUE;
388           continue;
389         }
390
391       /*
392        * Should we display the contents of incoming packages?
393        */
394       if (strcmp(*argv, "-dispout") == 0) 
395         {
396           argv++; argc--;
397           disp_pack_out = OLSR_TRUE;
398           continue;
399         }
400
401
402       /*
403        * Should we set up and send on a IPC socket for the front-end?
404        */
405       if (strcmp(*argv, "-ipc") == 0) 
406         {
407           argv++; argc--;
408           olsr_cnf->ipc_connections = 1;
409           olsr_cnf->open_ipc = OLSR_TRUE;
410           continue;
411         }
412
413
414       /*
415        * Display link-layer info(experimental)
416        */
417       if (strcmp(*argv, "-llinfo") == 0) 
418         {
419           argv++; argc--;
420           llinfo = OLSR_TRUE;
421           continue;
422         }
423
424       /*
425        * IPv6 multicast addr
426        */
427       if (strcmp(*argv, "-multi") == 0) 
428         {
429           argv++; argc--;
430           if(inet_pton(AF_INET6, *argv, &in6) < 0)
431             {
432               fprintf(stderr, "Failed converting IP address %s\n", *argv);
433               exit(EXIT_FAILURE);
434             }
435
436           memcpy(&default_ifcnf->ipv6_multi_glbl, &in6, sizeof(struct in6_addr));
437
438           argv++; argc--;
439
440           continue;
441         }
442
443
444       /*
445        * Should we display the contents of packages beeing sent?
446        */
447       if (strcmp(*argv, "-delgw") == 0) 
448         {
449           argv++; argc--;
450           del_gws = OLSR_TRUE;
451           continue;
452         }
453
454
455       print_usage();
456       olsr_exit(__func__, EXIT_FAILURE);
457     }
458
459
460   /* Sanity check configuration */
461   if(olsrd_sanity_check_cnf(olsr_cnf) < 0)
462     {
463       print_usage();
464       fprintf(stderr, "Bad configuration!\n");
465       olsr_exit(__func__, EXIT_FAILURE);      
466     }
467
468   /*
469    * Set configuration for command-line specified interfaces
470    */
471   set_default_ifcnfs(olsr_cnf->interfaces, default_ifcnf);
472
473   /*
474    * Print configuration 
475    */
476   olsrd_print_cnf(olsr_cnf);  
477
478   /*
479    *socket for icotl calls
480    */
481   if ((ioctl_s = socket(olsr_cnf->ip_version, SOCK_DGRAM, 0)) < 0) 
482
483     {
484       olsr_syslog(OLSR_LOG_ERR, "ioctl socket: %m");
485       olsr_exit(__func__, 0);
486     }
487
488 #if defined __FreeBSD__ || defined __MacOSX__
489   if ((rts = socket(PF_ROUTE, SOCK_RAW, 0)) < 0)
490     {
491       olsr_syslog(OLSR_LOG_ERR, "routing socket: %m");
492       olsr_exit(__func__, 0);
493     }
494 #endif
495
496   /*
497    *enable ip forwarding on host
498    */
499   enable_ip_forwarding(olsr_cnf->ip_version);
500
501   /* Initialize parser */
502   olsr_init_parser();
503
504   /* Initialize message sequencnumber */
505   init_msg_seqno();
506
507   /* Initialize dynamic willingness calculation */
508   olsr_init_willingness();
509
510   /*
511    *Set up willingness/APM
512    */
513   if(olsr_cnf->willingness_auto)
514     {
515       if(apm_init() < 0)
516         {
517           olsr_printf(1, "Could not read APM info - setting default willingness(%d)\n", WILL_DEFAULT);
518
519           olsr_syslog(OLSR_LOG_ERR, "Could not read APM info - setting default willingness(%d)\n", WILL_DEFAULT);
520
521           olsr_cnf->willingness_auto = 0;
522           olsr_cnf->willingness = WILL_DEFAULT;
523         }
524       else
525         {
526           olsr_cnf->willingness = olsr_calculate_willingness();
527
528           olsr_printf(1, "Willingness set to %d - next update in %.1f secs\n", olsr_cnf->willingness, will_int);
529         }
530     }
531
532   /**
533    *Set ipsize and minimum packetsize
534    */
535   if(olsr_cnf->ip_version == AF_INET6)
536     {
537       olsr_printf(1, "Using IP version 6\n");
538       ipsize = sizeof(struct in6_addr);
539
540       minsize = (int)sizeof(olsr_u8_t) * 7; /* Minimum packetsize IPv6 */
541     }
542   else
543     {
544       olsr_printf(1, "Using IP version 4\n");
545       ipsize = sizeof(olsr_u32_t);
546
547       minsize = (int)sizeof(olsr_u8_t) * 4; /* Minimum packetsize IPv4 */
548     }
549
550
551   /* Initializing networkinterfaces */
552
553   if(!ifinit())
554     {
555       if(olsr_cnf->allow_no_interfaces)
556         {
557           fprintf(stderr, "No interfaces detected! This might be intentional, but it also might mean that your configuration is fubar.\nI will continue after 5 seconds...\n");
558           sleep(5);
559         }
560       else
561         {
562           fprintf(stderr, "No interfaces detected!\nBailing out!\n");
563           olsr_exit(__func__, EXIT_FAILURE);
564         }
565     }
566
567   /* Print heartbeat to stdout */
568
569   if(olsr_cnf->debug_level > 0 && isatty(STDOUT_FILENO))
570     olsr_register_scheduler_event(&generate_stdout_pulse, NULL, STDOUT_PULSE_INT, 0, NULL);
571   
572   gettimeofday(&now, NULL);
573
574
575   /* Initialize the IPC socket */
576
577   if(olsr_cnf->open_ipc)
578       ipc_init();
579
580 #ifdef linux
581   /* Initialize link-layer notifications */
582   if(llinfo)
583     init_link_layer_notification();
584 #endif
585
586   /* Initialisation of different tables to be used.*/
587   olsr_init_tables();
588
589   /* Load plugins */
590   olsr_load_plugins();
591
592   olsr_printf(1, "Main address: %s\n\n", olsr_ip_to_string(&main_addr));
593
594   /* daemon mode */
595 #ifndef WIN32
596   if (olsr_cnf->debug_level == 0)
597     {
598       printf("%s detattching from the current process...\n", SOFTWARE_VERSION);
599       if (fork() != 0)
600         {
601           exit(EXIT_SUCCESS);
602         }
603       setsid();
604     }
605 #endif
606
607   /*
608    * Start syslog entry
609    */
610   olsr_syslog(OLSR_LOG_INFO, "%s successfully started", SOFTWARE_VERSION);
611
612   /*
613    *signal-handlers
614    */
615
616   /* ctrl-C and friends */
617 #ifdef WIN32
618   SetConsoleCtrlHandler(SignalHandler, OLSR_TRUE);
619 #else
620   signal(SIGHUP, olsr_reconfigure);  
621   signal(SIGINT, olsr_shutdown);  
622   signal(SIGTERM, olsr_shutdown);  
623 #endif
624
625   /* Register socket poll event */
626   olsr_register_timeout_function(&poll_sockets);
627
628   /* Starting scheduler */
629   scheduler();
630
631   /* Stop the compiler from complaining */
632   strlen(copyright_string);
633
634   /* Like we're ever going to reach this ;-) */
635   return 1;
636
637 } /* main */
638
639
640
641 /**
642  * Reconfigure olsrd. Currently kind of a hack...
643  *
644  */
645 #ifndef WIN32
646 void
647 olsr_reconfigure(int signal)
648 {
649   if(!fork())
650     {
651       /* New process */
652       sleep(3);
653       printf("Restarting %s\n", olsr_argv[0]);
654       execv(olsr_argv[0], olsr_argv);
655     }
656   olsr_shutdown(0);
657
658   printf("RECONFIGURING!\n");
659 }
660 #endif
661
662
663 /**
664  *Function called at shutdown
665  *
666  */
667 #ifdef WIN32
668 int __stdcall
669 SignalHandler(unsigned long signal)
670 #else
671 static void
672 olsr_shutdown(int signal)
673 #endif
674 {
675   struct interface *ifn;
676
677   olsr_printf(1, "Received signal %d - shutting down\n", signal);
678
679   olsr_delete_all_kernel_routes();
680
681   olsr_printf(1, "Closing sockets...\n");
682
683   /* front-end IPC socket */
684   if(olsr_cnf->open_ipc)
685     shutdown_ipc();
686
687   /* OLSR sockets */
688   for (ifn = ifnet; ifn; ifn = ifn->int_next) 
689     close(ifn->olsr_socket);
690
691   /* Closing plug-ins */
692   olsr_close_plugins();
693
694   /* Reset network settings */
695   restore_settings(olsr_cnf->ip_version);
696
697   /* ioctl socket */
698   close(ioctl_s);
699
700 #if defined __FreeBSD__ || defined __MacOSX__
701   /* routing socket */
702   close(rts);
703 #endif
704
705   olsr_syslog(OLSR_LOG_INFO, "%s stopped", SOFTWARE_VERSION);
706
707   olsr_printf(1, "\n <<<< %s - terminating >>>>\n           http://www.olsr.org\n", SOFTWARE_VERSION);
708
709   exit(exit_value);
710 }
711
712
713
714
715
716 /**
717  *Sets the default values of variables at startup
718  */
719 static void
720 set_default_values()
721 {
722   memset(&main_addr, 0, sizeof(union olsr_ip_addr));
723   memset(&null_addr6, 0, sizeof (union olsr_ip_addr));
724
725   exit_value = EXIT_SUCCESS; 
726   /* If the application exits by signal it is concidered success,
727    * if not, exit_value is set by the function calling olsr_exit.
728    */
729
730   max_jitter = 0;
731   max_tc_vtime = 0;
732   dup_hold_time = DUP_HOLD_TIME;
733
734   will_int = 10 * HELLO_INTERVAL; /* Willingness update interval */
735
736   llinfo = OLSR_FALSE;
737   del_gws = OLSR_FALSE;
738
739   /* Display packet content */
740   disp_pack_in = OLSR_FALSE;
741   disp_pack_out = OLSR_FALSE;
742 }
743
744
745
746
747 static void
748 print_usage()
749 {
750
751   fprintf(stderr, "An error occured somwhere between your keyboard and your chair!\n"); 
752   fprintf(stderr, "usage: olsrd [-f <configfile>] [ -i interface1 interface2 ... ]\n");
753   fprintf(stderr, "  [-d <debug_level>] [-ipv6] [-multi <IPv6 multicast address>]\n"); 
754   fprintf(stderr, "  [-bcast <broadcastaddr>] [-ipc] [-dispin] [-dispout] [-delgw]\n");
755   fprintf(stderr, "  [-hint <hello interval (secs)>] [-tcint <tc interval (secs)>]\n");
756   fprintf(stderr, "  [-midint <mid interval (secs)>] [-hnaint <hna interval (secs)>]\n");
757   fprintf(stderr, "  [-tos value (int)] [-T <Polling Rate (secs)>]\n"); 
758
759 }
760
761
762 /**
763  * Sets the provided configuration on all unconfigured
764  * interfaces
765  */
766 int
767 set_default_ifcnfs(struct olsr_if *ifs, struct if_config_options *cnf)
768 {
769   int changes = 0;
770
771   while(ifs)
772     {
773       if(ifs->cnf == NULL)
774         {
775           ifs->cnf = olsr_malloc(sizeof(struct if_config_options), "Set default config");
776           *ifs->cnf = *cnf;
777           changes++;
778         }
779       ifs = ifs->next;
780     }
781   return changes;
782 }