Merge branch 'collectd-5.8'
[collectd.git] / src / wireless.c
index c771b9a..2e597f3 100644 (file)
@@ -1,82 +1,40 @@
 /**
  * collectd - src/wireless.c
- * Copyright (C) 2006  Florian octo Forster
+ * Copyright (C) 2006,2007  Florian octo Forster
  *
- * This program is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License as published by the
- * Free Software Foundation; either version 2 of the License, or (at your
- * option) any later version.
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
  *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
  *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
  *
- * Author:
- *   Florian octo Forster <octo at verplant.org>
+ * Authors:
+ *   Florian octo Forster <octo at collectd.org>
  **/
 
 #include "collectd.h"
+
 #include "common.h"
 #include "plugin.h"
 
-#define MODULE_NAME "wireless"
-#define BUFSIZE 1024
-
-#if defined(KERNEL_LINUX)
-# define WIRELESS_HAVE_READ 1
-#else
-# define WIRELESS_HAVE_READ 0
+#if !KERNEL_LINUX
+#error "No applicable input method."
 #endif
 
 #define WIRELESS_PROC_FILE "/proc/net/wireless"
 
-static char *filename_template = "wireless-%s.rrd";
-
-static char *ds_def[] =
-{
-       "DS:quality:GAUGE:"COLLECTD_HEARTBEAT":0:U",
-       "DS:power:GAUGE:"COLLECTD_HEARTBEAT":U:0",
-       "DS:noise:GAUGE:"COLLECTD_HEARTBEAT":U:0",
-       NULL
-};
-static int ds_num = 3;
-
-#if WIRELESS_HAVE_READ
-static int proc_file_found = 0;
-#endif
-
-static void wireless_init (void)
-{
-#if WIRELESS_HAVE_READ
-       if (access (WIRELESS_PROC_FILE, R_OK) == 0)
-               proc_file_found = 1;
-       else
-               proc_file_found = 0;
-#endif
-
-       return;
-}
-
-static void wireless_write (char *host, char *inst, char *val)
-{
-       char file[BUFSIZE];
-       int status;
-
-       status = snprintf (file, BUFSIZE, filename_template, inst);
-       if (status < 1)
-               return;
-       else if (status >= BUFSIZE)
-               return;
-
-       rrd_update_file (host, file, val, ds_def, ds_num);
-}
-
-#if WIRELESS_HAVE_READ
 #if 0
 static double wireless_dbm_to_watt (double dbm)
 {
@@ -84,120 +42,120 @@ static double wireless_dbm_to_watt (double dbm)
 
        /*
         * dbm = 10 * log_{10} (1000 * power / W)
-        * power = 10^(dbm/10) * W/1000 
+        * power = 10^(dbm/10) * W/1000
         */
 
        watt = pow (10.0, (dbm / 10.0)) / 1000.0;
 
-       return (watt);
+       return watt;
 }
 #endif
 
-static void wireless_submit (char *device,
-               double quality, double power, double noise)
-{
-       char buf[BUFSIZE];
-       int  status;
+static void wireless_submit(const char *plugin_instance, const char *type,
+                            double value) {
+  value_list_t vl = VALUE_LIST_INIT;
 
-       status = snprintf (buf, BUFSIZE, "%u:%f:%f:%f",
-                       (unsigned int) curtime,
-                       quality, power, noise);
-       if ((status < 1) || (status >= BUFSIZE))
-               return;
+  vl.values = &(value_t){.gauge = value};
+  vl.values_len = 1;
+  sstrncpy(vl.plugin, "wireless", sizeof(vl.plugin));
+  sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
+  sstrncpy(vl.type, type, sizeof(vl.type));
 
-       plugin_submit (MODULE_NAME, device, buf);
-}
+  plugin_dispatch_values(&vl);
+} /* void wireless_submit */
 
 #define POWER_MIN -90.0
 #define POWER_MAX -50.0
-static double wireless_percent_to_power (double quality)
-{
-       assert ((quality >= 0.0) && (quality <= 100.0));
+static double wireless_percent_to_power(double quality) {
+  assert((quality >= 0.0) && (quality <= 100.0));
 
-       return ((quality * (POWER_MAX - POWER_MIN)) + POWER_MIN);
+  return (quality * (POWER_MAX - POWER_MIN)) + POWER_MIN;
 } /* double wireless_percent_to_power */
 
-static void wireless_read (void)
-{
+static int wireless_read(void) {
 #ifdef KERNEL_LINUX
-
-       FILE *fh;
-       char buffer[BUFSIZE];
-
-       char   *device;
-       double  quality;
-       double  power;
-       double  noise;
-       
-       char *fields[8];
-       int   numfields;
-
-       int len;
-
-       if (!proc_file_found)
-               return;
-
-       /* there are a variety of names for the wireless device */
-       if ((fh = fopen (WIRELESS_PROC_FILE, "r")) == NULL)
-       {
-               syslog (LOG_WARNING, "wireless: fopen: %s", strerror (errno));
-               return;
-       }
-
-       while (fgets (buffer, BUFSIZE, fh) != NULL)
-       {
-               char *endptr;
-
-               numfields = strsplit (buffer, fields, 8);
-
-               if (numfields < 5)
-                       continue;
-
-               len = strlen (fields[0]) - 1;
-               if (len < 1)
-                       continue;
-               if (fields[0][len] != ':')
-                       continue;
-               fields[0][len] = '\0';
-
-               device  = fields[0];
-
-               quality = strtod (fields[2], &endptr);
-               if (fields[2] == endptr)
-                       quality = -1.0; /* invalid */
-
-               /* power [dBm] < 0.0 */
-               power = strtod (fields[3], &endptr);
-               if (fields[3] == endptr)
-                       power = 1.0; /* invalid */
-               else if ((power >= 0.0) && (power <= 100.0))
-                       power = wireless_percent_to_power (power);
-               else if (power > 100.0)
-                       power = 1.0; /* invalid */
-
-               /* noise [dBm] < 0.0 */
-               noise = strtod (fields[3], &endptr);
-               if (fields[3] == endptr)
-                       noise = 1.0; /* invalid */
-               else if ((noise >= 0.0) && (noise <= 100.0))
-                       noise = wireless_percent_to_power (noise);
-               else if (noise > 100.0)
-                       noise = 1.0; /* invalid */
-
-               wireless_submit (device, quality, power, noise);
-       }
-
-       fclose (fh);
+  FILE *fh;
+  char buffer[1024];
+
+  char *device;
+  double quality;
+  double power;
+  double noise;
+
+  char *fields[8];
+  int numfields;
+
+  int devices_found;
+  size_t len;
+
+  /* there are a variety of names for the wireless device */
+  if ((fh = fopen(WIRELESS_PROC_FILE, "r")) == NULL) {
+    WARNING("wireless: fopen: %s", STRERRNO);
+    return -1;
+  }
+
+  devices_found = 0;
+  while (fgets(buffer, sizeof(buffer), fh) != NULL) {
+    char *endptr;
+
+    numfields = strsplit(buffer, fields, 8);
+
+    if (numfields < 5)
+      continue;
+
+    len = strlen(fields[0]) - 1;
+    if (len < 1)
+      continue;
+    if (fields[0][len] != ':')
+      continue;
+    fields[0][len] = '\0';
+
+    device = fields[0];
+
+    quality = strtod(fields[2], &endptr);
+    if (fields[2] == endptr)
+      quality = -1.0; /* invalid */
+
+    /* power [dBm] < 0.0 */
+    power = strtod(fields[3], &endptr);
+    if (fields[3] == endptr)
+      power = 1.0; /* invalid */
+    else if ((power >= 0.0) && (power <= 100.0))
+      power = wireless_percent_to_power(power);
+    else if ((power > 100.0) && (power <= 256.0))
+      power = power - 256.0;
+    else if (power > 0.0)
+      power = 1.0; /* invalid */
+
+    /* noise [dBm] < 0.0 */
+    noise = strtod(fields[4], &endptr);
+    if (fields[4] == endptr)
+      noise = 1.0; /* invalid */
+    else if ((noise >= 0.0) && (noise <= 100.0))
+      noise = wireless_percent_to_power(noise);
+    else if ((noise > 100.0) && (noise <= 256.0))
+      noise = noise - 256.0;
+    else if (noise > 0.0)
+      noise = 1.0; /* invalid */
+
+    wireless_submit(device, "signal_quality", quality);
+    wireless_submit(device, "signal_power", power);
+    wireless_submit(device, "signal_noise", noise);
+
+    devices_found++;
+  }
+
+  fclose(fh);
+
+  /* If no wireless devices are present return an error, so the plugin
+   * code delays our read function. */
+  if (devices_found == 0)
+    return -1;
 #endif /* KERNEL_LINUX */
-}
-#else
-# define wireless_read NULL
-#endif /* WIRELESS_HAVE_READ */
 
-void module_register (void)
-{
-       plugin_register (MODULE_NAME, wireless_init, wireless_read, wireless_write);
-}
+  return 0;
+} /* int wireless_read */
 
-#undef BUFSIZE
-#undef MODULE_NAME
+void module_register(void) {
+  plugin_register_read("wireless", wireless_read);
+} /* void module_register */