src/uptime.c

   1 /**
   2  * collectd - src/uptime.c
   3  * Copyright (C) 2009   Marco Chiappero
   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  *   Marco Chiappero <marco at absence.it>
  20  **/
  21
  22 #include "collectd.h"
  23
  24 #include "common.h"
  25 #include "plugin.h"
  26
  27 #if KERNEL_LINUX
  28 #define UPTIME_FILE "/proc/uptime"
  29 /* Using /proc filesystem to retrieve the boot time, Linux only. */
  30 /* #endif KERNEL_LINUX */
  31
  32 #elif HAVE_LIBKSTAT
  33 /* Using kstats chain to retrieve the boot time on Solaris / OpenSolaris systems
  34  */
  35 /* #endif HAVE_LIBKSTAT */
  36
  37 #elif HAVE_SYS_SYSCTL_H
  38 #include <sys/sysctl.h>
  39 /* Using sysctl interface to retrieve the boot time on *BSD / Darwin / OS X
  40  * systems */
  41 /* #endif HAVE_SYS_SYSCTL_H */
  42
  43 #elif HAVE_PERFSTAT
  44 #include <libperfstat.h>
  45 #include <sys/protosw.h>
  46 /* Using perfstat_cpu_total to retrive the boot time in AIX */
  47 /* #endif HAVE_PERFSTAT */
  48
  49 #else
  50 #error "No applicable input method."
  51 #endif
  52
  53 /*
  54  * Global variables
  55  */
  56 /* boottime always used, no OS distinction */
  57 static time_t boottime;
  58
  59 #if HAVE_LIBKSTAT
  60 extern kstat_ctl_t *kc;
  61 #endif /* #endif HAVE_LIBKSTAT */
  62
  63 static void uptime_submit(gauge_t value) {
  64   value_list_t vl = VALUE_LIST_INIT;
  65
  66   vl.values = &(value_t){.gauge = value};
  67   vl.values_len = 1;
  68
  69   sstrncpy(vl.plugin, "uptime", sizeof(vl.plugin));
  70   sstrncpy(vl.type, "uptime", sizeof(vl.type));
  71
  72   plugin_dispatch_values(&vl);
  73 }
  74
  75 static int uptime_init(void) /* {{{ */
  76 {
  77 /*
  78  * On most unix systems the uptime is calculated by looking at the boot
  79  * time (stored in unix time, since epoch) and the current one. We are
  80  * going to do the same, reading the boot time value while executing
  81  * the uptime_init function (there is no need to read, every time the
  82  * plugin_read is called, a value that won't change). However, since
  83  * uptime_init is run only once, if the function fails in retrieving
  84  * the boot time, the plugin is unregistered and there is no chance to
  85  * try again later. Nevertheless, this is very unlikely to happen.
  86  */
  87
  88 #if KERNEL_LINUX
  89   FILE *fh = fopen(UPTIME_FILE, "r");
  90   if (fh == NULL) {
  91     char errbuf[1024];
  92     ERROR("uptime plugin: Cannot open " UPTIME_FILE ": %s",
  93           sstrerror(errno, errbuf, sizeof(errbuf)));
  94     return -1;
  95   }
  96
  97   double uptime_seconds = 0.0;
  98   if (fscanf(fh, "%lf", &uptime_seconds) != 1) {
  99     ERROR("uptime plugin: No value read from " UPTIME_FILE "");
 100     fclose(fh);
 101     return -1;
 102   }
 103
 104   fclose(fh);
 105
 106   if (uptime_seconds == 0.0) {
 107     ERROR("uptime plugin: uptime read from " UPTIME_FILE ", "
 108           "but it is zero!");
 109     return -1;
 110   }
 111
 112   boottime = time(NULL) - (long)uptime_seconds;
 113 /* #endif KERNEL_LINUX */
 114
 115 #elif HAVE_LIBKSTAT
 116   kstat_t *ksp;
 117   kstat_named_t *knp;
 118
 119   ksp = NULL;
 120   knp = NULL;
 121
 122   /* kstats chain already opened by update_kstat (using *kc), verify everything
 123    * went fine. */
 124   if (kc == NULL) {
 125     ERROR("uptime plugin: kstat chain control structure not available.");
 126     return -1;
 127   }
 128
 129   ksp = kstat_lookup(kc, "unix", 0, "system_misc");
 130   if (ksp == NULL) {
 131     ERROR("uptime plugin: Cannot find unix:0:system_misc kstat.");
 132     return -1;
 133   }
 134
 135   if (kstat_read(kc, ksp, NULL) < 0) {
 136     ERROR("uptime plugin: kstat_read failed.");
 137     return -1;
 138   }
 139
 140   knp = (kstat_named_t *)kstat_data_lookup(ksp, "boot_time");
 141   if (knp == NULL) {
 142     ERROR("uptime plugin: kstat_data_lookup (boot_time) failed.");
 143     return -1;
 144   }
 145
 146   boottime = (time_t)knp->value.ui32;
 147
 148   if (boottime == 0) {
 149     ERROR("uptime plugin: kstat_data_lookup returned success, "
 150           "but `boottime' is zero!");
 151     return -1;
 152   }
 153 /* #endif HAVE_LIBKSTAT */
 154
 155 #elif HAVE_SYS_SYSCTL_H
 156   struct timeval boottv = {0};
 157   size_t boottv_len;
 158   int status;
 159
 160   int mib[] = {CTL_KERN, KERN_BOOTTIME};
 161
 162   boottv_len = sizeof(boottv);
 163
 164   status = sysctl(mib, STATIC_ARRAY_SIZE(mib), &boottv, &boottv_len,
 165                   /* new_value = */ NULL, /* new_length = */ 0);
 166   if (status != 0) {
 167     char errbuf[1024];
 168     ERROR("uptime plugin: No value read from sysctl interface: %s",
 169           sstrerror(errno, errbuf, sizeof(errbuf)));
 170     return -1;
 171   }
 172
 173   boottime = boottv.tv_sec;
 174
 175   if (boottime == 0) {
 176     ERROR("uptime plugin: sysctl(3) returned success, "
 177           "but `boottime' is zero!");
 178     return -1;
 179   }
 180 /* #endif HAVE_SYS_SYSCTL_H */
 181
 182 #elif HAVE_PERFSTAT
 183   int status;
 184   perfstat_cpu_total_t cputotal;
 185   int hertz;
 186
 187   status = perfstat_cpu_total(NULL, &cputotal, sizeof(perfstat_cpu_total_t), 1);
 188   if (status < 0) {
 189     char errbuf[1024];
 190     ERROR("uptime plugin: perfstat_cpu_total: %s",
 191           sstrerror(errno, errbuf, sizeof(errbuf)));
 192     return -1;
 193   }
 194
 195   hertz = sysconf(_SC_CLK_TCK);
 196   if (hertz <= 0)
 197     hertz = HZ;
 198
 199   boottime = time(NULL) - cputotal.lbolt / hertz;
 200 #endif /* HAVE_PERFSTAT */
 201
 202   return 0;
 203 } /* }}} int uptime_init */
 204
 205 static int uptime_read(void) {
 206   gauge_t uptime;
 207   time_t elapsed;
 208
 209   /* calculate the amount of time elapsed since boot, AKA uptime */
 210   elapsed = time(NULL) - boottime;
 211
 212   uptime = (gauge_t)elapsed;
 213
 214   uptime_submit(uptime);
 215
 216   return 0;
 217 }
 218
 219 void module_register(void) {
 220   plugin_register_init("uptime", uptime_init);
 221   plugin_register_read("uptime", uptime_read);
 222 } /* void module_register */