src/collectd.c

   1 /**
   2  * collectd - src/collectd.c
   3  * Copyright (C) 2005-2007  Florian octo Forster
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at verplant.org>
  20  *   Alvaro Barcellos <alvaro.barcellos at gmail.com>
  21  **/
  22
  23 #include "collectd.h"
  24 #include "common.h"
  25
  26 #include <sys/types.h>
  27 #include <sys/socket.h>
  28 #include <netdb.h>
  29
  30 #include <pthread.h>
  31
  32 #include "plugin.h"
  33 #include "configfile.h"
  34
  35 #if HAVE_STATGRAB_H
  36 # include <statgrab.h>
  37 #endif
  38
  39 /*
  40  * Global variables
  41  */
  42 char hostname_g[DATA_MAX_NAME_LEN];
  43 int  interval_g;
  44 #if HAVE_LIBKSTAT
  45 kstat_ctl_t *kc;
  46 #endif /* HAVE_LIBKSTAT */
  47
  48 static int loop = 0;
  49
  50 static void *do_flush (void __attribute__((unused)) *arg)
  51 {
  52         INFO ("Flushing all data.");
  53         plugin_flush (NULL, -1, NULL);
  54         INFO ("Finished flushing all data.");
  55         pthread_exit (NULL);
  56         return NULL;
  57 }
  58
  59 static void sig_int_handler (int __attribute__((unused)) signal)
  60 {
  61         loop++;
  62 }
  63
  64 static void sig_term_handler (int __attribute__((unused)) signal)
  65 {
  66         loop++;
  67 }
  68
  69 static void sig_usr1_handler (int __attribute__((unused)) signal)
  70 {
  71         pthread_t      thread;
  72         pthread_attr_t attr;
  73
  74         /* flushing the data might take a while,
  75          * so it should be done asynchronously */
  76         pthread_attr_init (&attr);
  77         pthread_attr_setdetachstate (&attr, PTHREAD_CREATE_DETACHED);
  78         pthread_create (&thread, &attr, do_flush, NULL);
  79 }
  80
  81 static int init_hostname (void)
  82 {
  83         const char *str;
  84
  85         struct addrinfo  ai_hints;
  86         struct addrinfo *ai_list;
  87         struct addrinfo *ai_ptr;
  88         int status;
  89
  90         str = global_option_get ("Hostname");
  91         if (str != NULL)
  92         {
  93                 sstrncpy (hostname_g, str, sizeof (hostname_g));
  94                 return (0);
  95         }
  96
  97         if (gethostname (hostname_g, sizeof (hostname_g)) != 0)
  98         {
  99                 fprintf (stderr, "`gethostname' failed and no "
 100                                 "hostname was configured.\n");
 101                 return (-1);
 102         }
 103
 104         str = global_option_get ("FQDNLookup");
 105         if (IS_FALSE (str))
 106                 return (0);
 107
 108         memset (&ai_hints, '\0', sizeof (ai_hints));
 109         ai_hints.ai_flags = AI_CANONNAME;
 110
 111         status = getaddrinfo (hostname_g, NULL, &ai_hints, &ai_list);
 112         if (status != 0)
 113         {
 114                 ERROR ("Looking up \"%s\" failed. You have set the "
 115                                 "\"FQDNLookup\" option, but I cannot resolve "
 116                                 "my hostname to a fully qualified domain "
 117                                 "name. Please fix you network "
 118                                 "configuration.", hostname_g);
 119                 return (-1);
 120         }
 121
 122         for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 123         {
 124                 if (ai_ptr->ai_canonname == NULL)
 125                         continue;
 126
 127                 sstrncpy (hostname_g, ai_ptr->ai_canonname, sizeof (hostname_g));
 128                 break;
 129         }
 130
 131         freeaddrinfo (ai_list);
 132         return (0);
 133 } /* int init_hostname */
 134
 135 static int init_global_variables (void)
 136 {
 137         const char *str;
 138
 139         str = global_option_get ("Interval");
 140         if (str == NULL)
 141                 str = "10";
 142         interval_g = atoi (str);
 143         if (interval_g <= 0)
 144         {
 145                 fprintf (stderr, "Cannot set the interval to a correct value.\n"
 146                                 "Please check your settings.\n");
 147                 return (-1);
 148         }
 149         DEBUG ("interval_g = %i;", interval_g);
 150
 151         if (init_hostname () != 0)
 152                 return (-1);
 153         DEBUG ("hostname_g = %s;", hostname_g);
 154
 155         return (0);
 156 } /* int init_global_variables */
 157
 158 static int change_basedir (const char *orig_dir)
 159 {
 160         char *dir = strdup (orig_dir);
 161         int dirlen;
 162         int status;
 163
 164         if (dir == NULL)
 165         {
 166                 char errbuf[1024];
 167                 ERROR ("strdup failed: %s",
 168                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 169                 return (-1);
 170         }
 171
 172         dirlen = strlen (dir);
 173         while ((dirlen > 0) && (dir[dirlen - 1] == '/'))
 174                 dir[--dirlen] = '\0';
 175
 176         if (dirlen <= 0)
 177                 return (-1);
 178
 179         status = chdir (dir);
 180         free (dir);
 181
 182         if (status != 0)
 183         {
 184                 if (errno == ENOENT)
 185                 {
 186                         if (mkdir (orig_dir, 0755) == -1)
 187                         {
 188                                 char errbuf[1024];
 189                                 ERROR ("change_basedir: mkdir (%s): %s", orig_dir,
 190                                                 sstrerror (errno, errbuf,
 191                                                         sizeof (errbuf)));
 192                                 return (-1);
 193                         }
 194                         else if (chdir (orig_dir) == -1)
 195                         {
 196                                 char errbuf[1024];
 197                                 ERROR ("chdir (%s): %s", orig_dir,
 198                                                 sstrerror (errno, errbuf,
 199                                                         sizeof (errbuf)));
 200                                 return (-1);
 201                         }
 202                 }
 203                 else
 204                 {
 205                         char errbuf[1024];
 206                         ERROR ("chdir (%s): %s", orig_dir,
 207                                         sstrerror (errno, errbuf,
 208                                                 sizeof (errbuf)));
 209                         return (-1);
 210                 }
 211         }
 212
 213         return (0);
 214 } /* static int change_basedir (char *dir) */
 215
 216 #if HAVE_LIBKSTAT
 217 static void update_kstat (void)
 218 {
 219         if (kc == NULL)
 220         {
 221                 if ((kc = kstat_open ()) == NULL)
 222                         ERROR ("Unable to open kstat control structure");
 223         }
 224         else
 225         {
 226                 kid_t kid;
 227                 kid = kstat_chain_update (kc);
 228                 if (kid > 0)
 229                 {
 230                         INFO ("kstat chain has been updated");
 231                         plugin_init_all ();
 232                 }
 233                 else if (kid < 0)
 234                         ERROR ("kstat chain update failed");
 235                 /* else: everything works as expected */
 236         }
 237
 238         return;
 239 } /* static void update_kstat (void) */
 240 #endif /* HAVE_LIBKSTAT */
 241
 242 /* TODO
 243  * Remove all settings but `-f' and `-C'
 244  */
 245 static void exit_usage (int status)
 246 {
 247         printf ("Usage: "PACKAGE" [OPTIONS]\n\n"
 248
 249                         "Available options:\n"
 250                         "  General:\n"
 251                         "    -C <file>       Configuration file.\n"
 252                         "                    Default: "CONFIGFILE"\n"
 253                         "    -t              Test config and exit.\n"
 254                         "    -T              Test plugin read and exit.\n"
 255                         "    -P <file>       PID-file.\n"
 256                         "                    Default: "PIDFILE"\n"
 257 #if COLLECT_DAEMON
 258                         "    -f              Don't fork to the background.\n"
 259 #endif
 260                         "    -h              Display help (this message)\n"
 261                         "\nBuiltin defaults:\n"
 262                         "  Config file       "CONFIGFILE"\n"
 263                         "  PID file          "PIDFILE"\n"
 264                         "  Plugin directory  "PLUGINDIR"\n"
 265                         "  Data directory    "PKGLOCALSTATEDIR"\n"
 266                         "\n"PACKAGE" "VERSION", http://collectd.org/\n"
 267                         "by Florian octo Forster <octo@verplant.org>\n"
 268                         "for contributions see `AUTHORS'\n");
 269         exit (status);
 270 } /* static void exit_usage (int status) */
 271
 272 static int do_init (void)
 273 {
 274 #if HAVE_LIBKSTAT
 275         kc = NULL;
 276         update_kstat ();
 277 #endif
 278
 279 #if HAVE_LIBSTATGRAB
 280         if (sg_init ())
 281         {
 282                 ERROR ("sg_init: %s", sg_str_error (sg_get_error ()));
 283                 return (-1);
 284         }
 285
 286         if (sg_drop_privileges ())
 287         {
 288                 ERROR ("sg_drop_privileges: %s", sg_str_error (sg_get_error ()));
 289                 return (-1);
 290         }
 291 #endif
 292
 293         plugin_init_all ();
 294
 295         return (0);
 296 } /* int do_init () */
 297
 298
 299 static int do_loop (void)
 300 {
 301         struct timeval tv_now;
 302         struct timeval tv_next;
 303         struct timeval tv_wait;
 304         struct timespec ts_wait;
 305
 306         while (loop == 0)
 307         {
 308                 if (gettimeofday (&tv_next, NULL) < 0)
 309                 {
 310                         char errbuf[1024];
 311                         ERROR ("gettimeofday failed: %s",
 312                                         sstrerror (errno, errbuf,
 313                                                 sizeof (errbuf)));
 314                         return (-1);
 315                 }
 316                 tv_next.tv_sec += interval_g;
 317
 318 #if HAVE_LIBKSTAT
 319                 update_kstat ();
 320 #endif
 321
 322                 /* Issue all plugins */
 323                 plugin_read_all ();
 324
 325                 if (gettimeofday (&tv_now, NULL) < 0)
 326                 {
 327                         char errbuf[1024];
 328                         ERROR ("gettimeofday failed: %s",
 329                                         sstrerror (errno, errbuf,
 330                                                 sizeof (errbuf)));
 331                         return (-1);
 332                 }
 333
 334                 if (timeval_cmp (tv_next, tv_now, &tv_wait) <= 0)
 335                 {
 336                         WARNING ("Not sleeping because the next interval is "
 337                                         "%i.%06i seconds in the past!",
 338                                         (int) tv_wait.tv_sec, (int) tv_wait.tv_usec);
 339                         continue;
 340                 }
 341
 342                 ts_wait.tv_sec  = tv_wait.tv_sec;
 343                 ts_wait.tv_nsec = (long) (1000 * tv_wait.tv_usec);
 344
 345                 while ((loop == 0) && (nanosleep (&ts_wait, &ts_wait) == -1))
 346                 {
 347                         if (errno != EINTR)
 348                         {
 349                                 char errbuf[1024];
 350                                 ERROR ("nanosleep failed: %s",
 351                                                 sstrerror (errno, errbuf,
 352                                                         sizeof (errbuf)));
 353                                 return (-1);
 354                         }
 355                 }
 356         } /* while (loop == 0) */
 357
 358         DEBUG ("return (0);");
 359         return (0);
 360 } /* int do_loop */
 361
 362 static int do_shutdown (void)
 363 {
 364         plugin_shutdown_all ();
 365         return (0);
 366 } /* int do_shutdown */
 367
 368 #if COLLECT_DAEMON
 369 static int pidfile_create (void)
 370 {
 371         FILE *fh;
 372         const char *file = global_option_get ("PIDFile");
 373
 374         if ((fh = fopen (file, "w")) == NULL)
 375         {
 376                 char errbuf[1024];
 377                 ERROR ("fopen (%s): %s", file,
 378                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 379                 return (1);
 380         }
 381
 382         fprintf (fh, "%i\n", (int) getpid ());
 383         fclose(fh);
 384
 385         return (0);
 386 } /* static int pidfile_create (const char *file) */
 387
 388 static int pidfile_remove (void)
 389 {
 390         const char *file = global_option_get ("PIDFile");
 391
 392         DEBUG ("unlink (%s)", (file != NULL) ? file : "<null>");
 393         return (unlink (file));
 394 } /* static int pidfile_remove (const char *file) */
 395 #endif /* COLLECT_DAEMON */
 396
 397 int main (int argc, char **argv)
 398 {
 399         struct sigaction sig_int_action;
 400         struct sigaction sig_term_action;
 401         struct sigaction sig_usr1_action;
 402         struct sigaction sig_pipe_action;
 403         char *configfile = CONFIGFILE;
 404         int test_config  = 0;
 405         int test_readall = 0;
 406         const char *basedir;
 407 #if COLLECT_DAEMON
 408         struct sigaction sig_chld_action;
 409         pid_t pid;
 410         int daemonize    = 1;
 411 #endif
 412         int exit_status = 0;
 413
 414         /* read options */
 415         while (1)
 416         {
 417                 int c;
 418
 419                 c = getopt (argc, argv, "htTC:"
 420 #if COLLECT_DAEMON
 421                                 "fP:"
 422 #endif
 423                 );
 424
 425                 if (c == -1)
 426                         break;
 427
 428                 switch (c)
 429                 {
 430                         case 'C':
 431                                 configfile = optarg;
 432                                 break;
 433                         case 't':
 434                                 test_config = 1;
 435                                 break;
 436                         case 'T':
 437                                 test_readall = 1;
 438                                 global_option_set ("ReadThreads", "-1");
 439 #if COLLECT_DAEMON
 440                                 daemonize = 0;
 441 #endif /* COLLECT_DAEMON */
 442                                 break;
 443 #if COLLECT_DAEMON
 444                         case 'P':
 445                                 global_option_set ("PIDFile", optarg);
 446                                 break;
 447                         case 'f':
 448                                 daemonize = 0;
 449                                 break;
 450 #endif /* COLLECT_DAEMON */
 451                         case 'h':
 452                                 exit_usage (0);
 453                                 break;
 454                         default:
 455                                 exit_usage (1);
 456                 } /* switch (c) */
 457         } /* while (1) */
 458
 459         if (optind < argc)
 460                 exit_usage (1);
 461
 462         /*
 463          * Read options from the config file, the environment and the command
 464          * line (in that order, with later options overwriting previous ones in
 465          * general).
 466          * Also, this will automatically load modules.
 467          */
 468         if (cf_read (configfile))
 469         {
 470                 fprintf (stderr, "Error: Reading the config file failed!\n"
 471                                 "Read the syslog for details.\n");
 472                 return (1);
 473         }
 474
 475         /*
 476          * Change directory. We do this _after_ reading the config and loading
 477          * modules to relative paths work as expected.
 478          */
 479         if ((basedir = global_option_get ("BaseDir")) == NULL)
 480         {
 481                 fprintf (stderr, "Don't have a basedir to use. This should not happen. Ever.");
 482                 return (1);
 483         }
 484         else if (change_basedir (basedir))
 485         {
 486                 fprintf (stderr, "Error: Unable to change to directory `%s'.\n", basedir);
 487                 return (1);
 488         }
 489
 490         /*
 491          * Set global variables or, if that failes, exit. We cannot run with
 492          * them being uninitialized. If nothing is configured, then defaults
 493          * are being used. So this means that the user has actually done
 494          * something wrong.
 495          */
 496         if (init_global_variables () != 0)
 497                 return (1);
 498
 499         if (test_config)
 500                 return (0);
 501
 502 #if COLLECT_DAEMON
 503         /*
 504          * fork off child
 505          */
 506         memset (&sig_chld_action, '\0', sizeof (sig_chld_action));
 507         sig_chld_action.sa_handler = SIG_IGN;
 508         sigaction (SIGCHLD, &sig_chld_action, NULL);
 509
 510         if (daemonize)
 511         {
 512                 if ((pid = fork ()) == -1)
 513                 {
 514                         /* error */
 515                         char errbuf[1024];
 516                         fprintf (stderr, "fork: %s",
 517                                         sstrerror (errno, errbuf,
 518                                                 sizeof (errbuf)));
 519                         return (1);
 520                 }
 521                 else if (pid != 0)
 522                 {
 523                         /* parent */
 524                         /* printf ("Running (PID %i)\n", pid); */
 525                         return (0);
 526                 }
 527
 528                 /* Detach from session */
 529                 setsid ();
 530
 531                 /* Write pidfile */
 532                 if (pidfile_create ())
 533                         exit (2);
 534
 535                 /* close standard descriptors */
 536                 close (2);
 537                 close (1);
 538                 close (0);
 539
 540                 if (open ("/dev/null", O_RDWR) != 0)
 541                 {
 542                         ERROR ("Error: Could not connect `STDIN' to `/dev/null'");
 543                         return (1);
 544                 }
 545                 if (dup (0) != 1)
 546                 {
 547                         ERROR ("Error: Could not connect `STDOUT' to `/dev/null'");
 548                         return (1);
 549                 }
 550                 if (dup (0) != 2)
 551                 {
 552                         ERROR ("Error: Could not connect `STDERR' to `/dev/null'");
 553                         return (1);
 554                 }
 555         } /* if (daemonize) */
 556 #endif /* COLLECT_DAEMON */
 557
 558         memset (&sig_pipe_action, '\0', sizeof (sig_pipe_action));
 559         sig_pipe_action.sa_handler = SIG_IGN;
 560         sigaction (SIGPIPE, &sig_pipe_action, NULL);
 561
 562         /*
 563          * install signal handlers
 564          */
 565         memset (&sig_int_action, '\0', sizeof (sig_int_action));
 566         sig_int_action.sa_handler = sig_int_handler;
 567         if (0 != sigaction (SIGINT, &sig_int_action, NULL)) {
 568                 char errbuf[1024];
 569                 ERROR ("Error: Failed to install a signal handler for signal INT: %s",
 570                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 571                 return (1);
 572         }
 573
 574         memset (&sig_term_action, '\0', sizeof (sig_term_action));
 575         sig_term_action.sa_handler = sig_term_handler;
 576         if (0 != sigaction (SIGTERM, &sig_term_action, NULL)) {
 577                 char errbuf[1024];
 578                 ERROR ("Error: Failed to install a signal handler for signal TERM: %s",
 579                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 580                 return (1);
 581         }
 582
 583         memset (&sig_usr1_action, '\0', sizeof (sig_usr1_action));
 584         sig_usr1_action.sa_handler = sig_usr1_handler;
 585         if (0 != sigaction (SIGUSR1, &sig_usr1_action, NULL)) {
 586                 char errbuf[1024];
 587                 ERROR ("Error: Failed to install a signal handler for signal USR1: %s",
 588                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 589                 return (1);
 590         }
 591
 592         /*
 593          * run the actual loops
 594          */
 595         do_init ();
 596
 597         if (test_readall)
 598         {
 599                 if (plugin_read_all_once () != 0)
 600                         exit_status = 1;
 601         }
 602         else
 603         {
 604                 INFO ("Initialization complete, entering read-loop.");
 605                 do_loop ();
 606         }
 607
 608         /* close syslog */
 609         INFO ("Exiting normally.");
 610
 611         do_shutdown ();
 612
 613 #if COLLECT_DAEMON
 614         if (daemonize)
 615                 pidfile_remove ();
 616 #endif /* COLLECT_DAEMON */
 617
 618         return (exit_status);
 619 } /* int main */