src/nut.c

   1 /**
   2  * collectd - src/nut.c
   3  * Copyright (C) 2007       Florian octo Forster
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *   Florian octo Forster <octo at collectd.org>
  25  **/
  26
  27 #include "collectd.h"
  28 #include "common.h"
  29 #include "plugin.h"
  30
  31 #include <pthread.h>
  32 #include <upsclient.h>
  33
  34 #if HAVE_UPSCONN_T
  35 typedef UPSCONN_t collectd_upsconn_t;
  36 #elif HAVE_UPSCONN
  37 typedef UPSCONN collectd_upsconn_t;
  38 #else
  39 # error "Unable to determine the UPS connection type."
  40 #endif
  41
  42 struct nut_ups_s;
  43 typedef struct nut_ups_s nut_ups_t;
  44 struct nut_ups_s
  45 {
  46   collectd_upsconn_t *conn;
  47   char      *upsname;
  48   char      *hostname;
  49   int        port;
  50   nut_ups_t *next;
  51 };
  52
  53 static nut_ups_t *upslist_head = NULL;
  54
  55 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
  56 static int read_busy = 0;
  57
  58 static const char *config_keys[] =
  59 {
  60   "UPS"
  61 };
  62 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
  63
  64 static void free_nut_ups_t (nut_ups_t *ups)
  65 {
  66   if (ups->conn != NULL)
  67   {
  68     upscli_disconnect (ups->conn);
  69     sfree (ups->conn);
  70   }
  71   sfree (ups->hostname);
  72   sfree (ups->upsname);
  73   sfree (ups);
  74 } /* void free_nut_ups_t */
  75
  76 static int nut_add_ups (const char *name)
  77 {
  78   nut_ups_t *ups;
  79   int status;
  80
  81   DEBUG ("nut plugin: nut_add_ups (name = %s);", name);
  82
  83   ups = calloc (1, sizeof (*ups));
  84   if (ups == NULL)
  85   {
  86     ERROR ("nut plugin: nut_add_ups: calloc failed.");
  87     return (1);
  88   }
  89
  90   status = upscli_splitname (name, &ups->upsname, &ups->hostname,
  91       &ups->port);
  92   if (status != 0)
  93   {
  94     ERROR ("nut plugin: nut_add_ups: upscli_splitname (%s) failed.", name);
  95     free_nut_ups_t (ups);
  96     return (1);
  97   }
  98
  99   if (upslist_head == NULL)
 100     upslist_head = ups;
 101   else
 102   {
 103     nut_ups_t *last = upslist_head;
 104     while (last->next != NULL)
 105       last = last->next;
 106     last->next = ups;
 107   }
 108
 109   return (0);
 110 } /* int nut_add_ups */
 111
 112 static int nut_config (const char *key, const char *value)
 113 {
 114   if (strcasecmp (key, "UPS") == 0)
 115     return (nut_add_ups (value));
 116   else
 117     return (-1);
 118 } /* int nut_config */
 119
 120 static void nut_submit (nut_ups_t *ups, const char *type,
 121     const char *type_instance, gauge_t value)
 122 {
 123   value_t values[1];
 124   value_list_t vl = VALUE_LIST_INIT;
 125
 126   values[0].gauge = value;
 127
 128   vl.values = values;
 129   vl.values_len = STATIC_ARRAY_SIZE (values);
 130   sstrncpy (vl.host,
 131       (strcasecmp (ups->hostname, "localhost") == 0)
 132       ? hostname_g
 133       : ups->hostname,
 134       sizeof (vl.host));
 135   sstrncpy (vl.plugin, "nut", sizeof (vl.plugin));
 136   sstrncpy (vl.plugin_instance, ups->upsname, sizeof (vl.plugin_instance));
 137   sstrncpy (vl.type, type, sizeof (vl.type));
 138   sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 139
 140   plugin_dispatch_values (&vl);
 141 } /* void nut_submit */
 142
 143 static int nut_read_one (nut_ups_t *ups)
 144 {
 145   const char *query[3] = {"VAR", ups->upsname, NULL};
 146   unsigned int query_num = 2;
 147   char **answer;
 148   unsigned int answer_num;
 149   int status;
 150
 151   /* (Re-)Connect if we have no connection */
 152   if (ups->conn == NULL)
 153   {
 154     ups->conn = malloc (sizeof (*ups->conn));
 155     if (ups->conn == NULL)
 156     {
 157       ERROR ("nut plugin: malloc failed.");
 158       return (-1);
 159     }
 160
 161     status = upscli_connect (ups->conn, ups->hostname, ups->port,
 162         UPSCLI_CONN_TRYSSL);
 163     if (status != 0)
 164     {
 165       ERROR ("nut plugin: nut_read_one: upscli_connect (%s, %i) failed: %s",
 166           ups->hostname, ups->port, upscli_strerror (ups->conn));
 167       sfree (ups->conn);
 168       return (-1);
 169     }
 170
 171     INFO ("nut plugin: Connection to (%s, %i) established.",
 172         ups->hostname, ups->port);
 173   } /* if (ups->conn == NULL) */
 174
 175   /* nut plugin: nut_read_one: upscli_list_start (adpos) failed: Protocol
 176    * error */
 177   status = upscli_list_start (ups->conn, query_num, query);
 178   if (status != 0)
 179   {
 180     ERROR ("nut plugin: nut_read_one: upscli_list_start (%s) failed: %s",
 181         ups->upsname, upscli_strerror (ups->conn));
 182     upscli_disconnect (ups->conn);
 183     sfree (ups->conn);
 184     return (-1);
 185   }
 186
 187   while ((status = upscli_list_next (ups->conn, query_num, query,
 188           &answer_num, &answer)) == 1)
 189   {
 190     char  *key;
 191     double value;
 192
 193     if (answer_num < 4)
 194       continue;
 195
 196     key = answer[2];
 197     value = atof (answer[3]);
 198
 199     if (strncmp ("ambient.", key, 8) == 0)
 200     {
 201       if (strcmp ("ambient.humidity", key) == 0)
 202         nut_submit (ups, "humidity", "ambient", value);
 203       else if (strcmp ("ambient.temperature", key) == 0)
 204         nut_submit (ups, "temperature", "ambient", value);
 205     }
 206     else if (strncmp ("battery.", key, 8) == 0)
 207     {
 208       if (strcmp ("battery.charge", key) == 0)
 209         nut_submit (ups, "percent", "charge", value);
 210       else if (strcmp ("battery.current", key) == 0)
 211         nut_submit (ups, "current", "battery", value);
 212       else if (strcmp ("battery.runtime", key) == 0)
 213         nut_submit (ups, "timeleft", "battery", value);
 214       else if (strcmp ("battery.temperature", key) == 0)
 215         nut_submit (ups, "temperature", "battery", value);
 216       else if (strcmp ("battery.voltage", key) == 0)
 217         nut_submit (ups, "voltage", "battery", value);
 218     }
 219     else if (strncmp ("input.", key, 6) == 0)
 220     {
 221       if (strcmp ("input.frequency", key) == 0)
 222         nut_submit (ups, "frequency", "input", value);
 223       else if (strcmp ("input.voltage", key) == 0)
 224         nut_submit (ups, "voltage", "input", value);
 225     }
 226     else if (strncmp ("output.", key, 7) == 0)
 227     {
 228       if (strcmp ("output.current", key) == 0)
 229         nut_submit (ups, "current", "output", value);
 230       else if (strcmp ("output.frequency", key) == 0)
 231         nut_submit (ups, "frequency", "output", value);
 232       else if (strcmp ("output.voltage", key) == 0)
 233         nut_submit (ups, "voltage", "output", value);
 234     }
 235     else if (strncmp ("ups.", key, 4) == 0)
 236     {
 237       if (strcmp ("ups.load", key) == 0)
 238         nut_submit (ups, "percent", "load", value);
 239       else if (strcmp ("ups.power", key) == 0)
 240         nut_submit (ups, "power", "ups", value);
 241       else if (strcmp ("ups.temperature", key) == 0)
 242         nut_submit (ups, "temperature", "ups", value);
 243     }
 244   } /* while (upscli_list_next) */
 245
 246   return (0);
 247 } /* int nut_read_one */
 248
 249 static int nut_read (void)
 250 {
 251   nut_ups_t *ups;
 252   int success = 0;
 253
 254   pthread_mutex_lock (&read_lock);
 255   success = read_busy;
 256   read_busy = 1;
 257   pthread_mutex_unlock (&read_lock);
 258
 259   if (success != 0)
 260     return (0);
 261
 262   for (ups = upslist_head; ups != NULL; ups = ups->next)
 263     if (nut_read_one (ups) == 0)
 264       success++;
 265
 266   pthread_mutex_lock (&read_lock);
 267   read_busy = 0;
 268   pthread_mutex_unlock (&read_lock);
 269
 270   return ((success != 0) ? 0 : -1);
 271 } /* int nut_read */
 272
 273 static int nut_shutdown (void)
 274 {
 275   nut_ups_t *this;
 276   nut_ups_t *next;
 277
 278   this = upslist_head;
 279   while (this != NULL)
 280   {
 281     next = this->next;
 282     free_nut_ups_t (this);
 283     this = next;
 284   }
 285
 286   return (0);
 287 } /* int nut_shutdown */
 288
 289 void module_register (void)
 290 {
 291   plugin_register_config ("nut", nut_config, config_keys, config_keys_num);
 292   plugin_register_read ("nut", nut_read);
 293   plugin_register_shutdown ("nut", nut_shutdown);
 294 } /* void module_register */
 295
 296 /* vim: set sw=2 ts=8 sts=2 tw=78 : */