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
  29 #include "common.h"
  30 #include "plugin.h"
  31
  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   collectd_upsconn_t *conn;
  46   char *upsname;
  47   char *hostname;
  48   int port;
  49   nut_ups_t *next;
  50 };
  51
  52 static nut_ups_t *upslist_head = NULL;
  53
  54 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
  55 static int read_busy = 0;
  56
  57 static const char *config_keys[] = {"UPS"};
  58 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
  59
  60 static void free_nut_ups_t(nut_ups_t *ups) {
  61   if (ups->conn != NULL) {
  62     upscli_disconnect(ups->conn);
  63     sfree(ups->conn);
  64   }
  65   sfree(ups->hostname);
  66   sfree(ups->upsname);
  67   sfree(ups);
  68 } /* void free_nut_ups_t */
  69
  70 static int nut_add_ups(const char *name) {
  71   nut_ups_t *ups;
  72   int status;
  73
  74   DEBUG("nut plugin: nut_add_ups (name = %s);", name);
  75
  76   ups = calloc(1, sizeof(*ups));
  77   if (ups == NULL) {
  78     ERROR("nut plugin: nut_add_ups: calloc failed.");
  79     return (1);
  80   }
  81
  82   status = upscli_splitname(name, &ups->upsname, &ups->hostname, &ups->port);
  83   if (status != 0) {
  84     ERROR("nut plugin: nut_add_ups: upscli_splitname (%s) failed.", name);
  85     free_nut_ups_t(ups);
  86     return (1);
  87   }
  88
  89   if (upslist_head == NULL)
  90     upslist_head = ups;
  91   else {
  92     nut_ups_t *last = upslist_head;
  93     while (last->next != NULL)
  94       last = last->next;
  95     last->next = ups;
  96   }
  97
  98   return (0);
  99 } /* int nut_add_ups */
 100
 101 static int nut_config(const char *key, const char *value) {
 102   if (strcasecmp(key, "UPS") == 0)
 103     return (nut_add_ups(value));
 104   else
 105     return (-1);
 106 } /* int nut_config */
 107
 108 static void nut_submit(nut_ups_t *ups, const char *type,
 109                        const char *type_instance, gauge_t value) {
 110   value_list_t vl = VALUE_LIST_INIT;
 111
 112   vl.values = &(value_t){.gauge = value};
 113   vl.values_len = 1;
 114   sstrncpy(vl.host,
 115            (strcasecmp(ups->hostname, "localhost") == 0) ? hostname_g
 116                                                          : ups->hostname,
 117            sizeof(vl.host));
 118   sstrncpy(vl.plugin, "nut", sizeof(vl.plugin));
 119   sstrncpy(vl.plugin_instance, ups->upsname, sizeof(vl.plugin_instance));
 120   sstrncpy(vl.type, type, sizeof(vl.type));
 121   sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
 122
 123   plugin_dispatch_values(&vl);
 124 } /* void nut_submit */
 125
 126 static int nut_read_one(nut_ups_t *ups) {
 127   const char *query[3] = {"VAR", ups->upsname, NULL};
 128   unsigned int query_num = 2;
 129   char **answer;
 130   unsigned int answer_num;
 131   int status;
 132
 133   /* (Re-)Connect if we have no connection */
 134   if (ups->conn == NULL) {
 135     ups->conn = malloc(sizeof(*ups->conn));
 136     if (ups->conn == NULL) {
 137       ERROR("nut plugin: malloc failed.");
 138       return (-1);
 139     }
 140
 141     status =
 142         upscli_connect(ups->conn, ups->hostname, ups->port, UPSCLI_CONN_TRYSSL);
 143     if (status != 0) {
 144       ERROR("nut plugin: nut_read_one: upscli_connect (%s, %i) failed: %s",
 145             ups->hostname, ups->port, upscli_strerror(ups->conn));
 146       sfree(ups->conn);
 147       return (-1);
 148     }
 149
 150     INFO("nut plugin: Connection to (%s, %i) established.", ups->hostname,
 151          ups->port);
 152   } /* if (ups->conn == NULL) */
 153
 154   /* nut plugin: nut_read_one: upscli_list_start (adpos) failed: Protocol
 155    * error */
 156   status = upscli_list_start(ups->conn, query_num, query);
 157   if (status != 0) {
 158     ERROR("nut plugin: nut_read_one: upscli_list_start (%s) failed: %s",
 159           ups->upsname, upscli_strerror(ups->conn));
 160     upscli_disconnect(ups->conn);
 161     sfree(ups->conn);
 162     return (-1);
 163   }
 164
 165   while ((status = upscli_list_next(ups->conn, query_num, query, &answer_num,
 166                                     &answer)) == 1) {
 167     char *key;
 168     double value;
 169
 170     if (answer_num < 4)
 171       continue;
 172
 173     key = answer[2];
 174     value = atof(answer[3]);
 175
 176     if (strncmp("ambient.", key, 8) == 0) {
 177       if (strcmp("ambient.humidity", key) == 0)
 178         nut_submit(ups, "humidity", "ambient", value);
 179       else if (strcmp("ambient.temperature", key) == 0)
 180         nut_submit(ups, "temperature", "ambient", value);
 181     } else if (strncmp("battery.", key, 8) == 0) {
 182       if (strcmp("battery.charge", key) == 0)
 183         nut_submit(ups, "percent", "charge", value);
 184       else if (strcmp("battery.current", key) == 0)
 185         nut_submit(ups, "current", "battery", value);
 186       else if (strcmp("battery.runtime", key) == 0)
 187         nut_submit(ups, "timeleft", "battery", value);
 188       else if (strcmp("battery.temperature", key) == 0)
 189         nut_submit(ups, "temperature", "battery", value);
 190       else if (strcmp("battery.voltage", key) == 0)
 191         nut_submit(ups, "voltage", "battery", value);
 192     } else if (strncmp("input.", key, 6) == 0) {
 193       if (strcmp("input.frequency", key) == 0)
 194         nut_submit(ups, "frequency", "input", value);
 195       else if (strcmp("input.voltage", key) == 0)
 196         nut_submit(ups, "voltage", "input", value);
 197     } else if (strncmp("output.", key, 7) == 0) {
 198       if (strcmp("output.current", key) == 0)
 199         nut_submit(ups, "current", "output", value);
 200       else if (strcmp("output.frequency", key) == 0)
 201         nut_submit(ups, "frequency", "output", value);
 202       else if (strcmp("output.voltage", key) == 0)
 203         nut_submit(ups, "voltage", "output", value);
 204     } else if (strncmp("ups.", key, 4) == 0) {
 205       if (strcmp("ups.load", key) == 0)
 206         nut_submit(ups, "percent", "load", value);
 207       else if (strcmp("ups.power", key) == 0)
 208         nut_submit(ups, "power", "ups", value);
 209       else if (strcmp("ups.temperature", key) == 0)
 210         nut_submit(ups, "temperature", "ups", value);
 211     }
 212   } /* while (upscli_list_next) */
 213
 214   return (0);
 215 } /* int nut_read_one */
 216
 217 static int nut_read(void) {
 218   int success = 0;
 219
 220   pthread_mutex_lock(&read_lock);
 221   success = read_busy;
 222   read_busy = 1;
 223   pthread_mutex_unlock(&read_lock);
 224
 225   if (success != 0)
 226     return (0);
 227
 228   for (nut_ups_t *ups = upslist_head; ups != NULL; ups = ups->next)
 229     if (nut_read_one(ups) == 0)
 230       success++;
 231
 232   pthread_mutex_lock(&read_lock);
 233   read_busy = 0;
 234   pthread_mutex_unlock(&read_lock);
 235
 236   return ((success != 0) ? 0 : -1);
 237 } /* int nut_read */
 238
 239 static int nut_shutdown(void) {
 240   nut_ups_t *this;
 241   nut_ups_t *next;
 242
 243   this = upslist_head;
 244   while (this != NULL) {
 245     next = this->next;
 246     free_nut_ups_t(this);
 247     this = next;
 248   }
 249
 250   return (0);
 251 } /* int nut_shutdown */
 252
 253 void module_register(void) {
 254   plugin_register_config("nut", nut_config, config_keys, config_keys_num);
 255   plugin_register_read("nut", nut_read);
 256   plugin_register_shutdown("nut", nut_shutdown);
 257 } /* void module_register */
 258
 259 /* vim: set sw=2 ts=8 sts=2 tw=78 : */