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