src/ping.c

   1 /**
   2  * collectd - src/ping.c
   3  * Copyright (C) 2005-2007  Florian octo Forster
   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  *   Florian octo Forster <octo at verplant.org>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25 #include "configfile.h"
  26
  27 #include <netinet/in.h>
  28 #include "liboping/oping.h"
  29
  30 /*
  31  * Private data types
  32  */
  33 struct hostlist_s
  34 {
  35         char *host;
  36         int   wait_time;
  37         int   wait_left;
  38         struct hostlist_s *next;
  39 };
  40 typedef struct hostlist_s hostlist_t;
  41
  42 /*
  43  * Private variables
  44  */
  45 static pingobj_t *pingobj = NULL;
  46 static hostlist_t *hosts = NULL;
  47
  48 static const char *config_keys[] =
  49 {
  50         "Host",
  51         "TTL",
  52         NULL
  53 };
  54 static int config_keys_num = 2;
  55
  56 /*
  57  * Private functions
  58  */
  59 static void add_hosts (void)
  60 {
  61         hostlist_t *hl_this;
  62         hostlist_t *hl_prev;
  63
  64         hl_this = hosts;
  65         hl_prev = NULL;
  66         while (hl_this != NULL)
  67         {
  68                 DEBUG ("ping plugin: host = %s, wait_left = %i, "
  69                                 "wait_time = %i, next = %p",
  70                                 hl_this->host, hl_this->wait_left,
  71                                 hl_this->wait_time, (void *) hl_this->next);
  72
  73                 if (hl_this->wait_left <= 0)
  74                 {
  75                         if (ping_host_add (pingobj, hl_this->host) == 0)
  76                         {
  77                                 DEBUG ("ping plugin: Successfully added host %s", hl_this->host);
  78                                 /* Remove the host from the linked list */
  79                                 if (hl_prev != NULL)
  80                                         hl_prev->next = hl_this->next;
  81                                 else
  82                                         hosts = hl_this->next;
  83                                 free (hl_this->host);
  84                                 free (hl_this);
  85                                 hl_this = (hl_prev != NULL) ? hl_prev : hosts;
  86                         }
  87                         else
  88                         {
  89                                 WARNING ("ping plugin: Failed adding host "
  90                                                 "`%s': %s", hl_this->host,
  91                                                 ping_get_error (pingobj));
  92                                 hl_this->wait_left = hl_this->wait_time;
  93                                 hl_this->wait_time *= 2;
  94                                 if (hl_this->wait_time > 86400)
  95                                         hl_this->wait_time = 86400;
  96                         }
  97                 }
  98                 else
  99                 {
 100                         hl_this->wait_left -= interval_g;
 101                 }
 102
 103                 if (hl_this != NULL)
 104                 {
 105                         hl_prev = hl_this;
 106                         hl_this = hl_this->next;
 107                 }
 108         }
 109 } /* void add_hosts */
 110
 111 static int ping_init (void)
 112 {
 113         if (pingobj == NULL)
 114                 return (-1);
 115
 116         if (hosts != NULL)
 117                 add_hosts ();
 118
 119         return (0);
 120 } /* int ping_init */
 121
 122 static int ping_config (const char *key, const char *value)
 123 {
 124         if (pingobj == NULL)
 125         {
 126                 if ((pingobj = ping_construct ()) == NULL)
 127                 {
 128                         ERROR ("ping plugin: `ping_construct' failed.");
 129                         return (1);
 130                 }
 131         }
 132
 133         if (strcasecmp (key, "host") == 0)
 134         {
 135                 hostlist_t *hl;
 136                 char *host;
 137
 138                 if ((hl = (hostlist_t *) malloc (sizeof (hostlist_t))) == NULL)
 139                 {
 140                         char errbuf[1024];
 141                         ERROR ("ping plugin: malloc failed: %s",
 142                                         sstrerror (errno, errbuf,
 143                                                 sizeof (errbuf)));
 144                         return (1);
 145                 }
 146                 if ((host = strdup (value)) == NULL)
 147                 {
 148                         char errbuf[1024];
 149                         free (hl);
 150                         ERROR ("ping plugin: strdup failed: %s",
 151                                         sstrerror (errno, errbuf,
 152                                                 sizeof (errbuf)));
 153                         return (1);
 154                 }
 155
 156                 hl->host = host;
 157                 hl->wait_time = 2 * interval_g;
 158                 hl->wait_left = 0;
 159                 hl->next = hosts;
 160                 hosts = hl;
 161         }
 162         else if (strcasecmp (key, "ttl") == 0)
 163         {
 164                 int ttl = atoi (value);
 165                 if (ping_setopt (pingobj, PING_OPT_TTL, (void *) &ttl))
 166                 {
 167                         WARNING ("ping: liboping did not accept the TTL value %i", ttl);
 168                         return (1);
 169                 }
 170         }
 171         else
 172         {
 173                 return (-1);
 174         }
 175
 176         return (0);
 177 }
 178
 179 static void ping_submit (char *host, double latency)
 180 {
 181         value_t values[1];
 182         value_list_t vl = VALUE_LIST_INIT;
 183
 184         values[0].gauge = latency;
 185
 186         vl.values = values;
 187         vl.values_len = 1;
 188         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 189         sstrncpy (vl.plugin, "ping", sizeof (vl.plugin));
 190         sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
 191         sstrncpy (vl.type_instance, host, sizeof (vl.type_instance));
 192         sstrncpy (vl.type, "ping", sizeof (vl.type));
 193
 194         plugin_dispatch_values (&vl);
 195 }
 196
 197 static int ping_read (void)
 198 {
 199         pingobj_iter_t *iter;
 200
 201         char   host[512];
 202         double latency;
 203         size_t buf_len;
 204         int    number_of_hosts;
 205
 206         if (pingobj == NULL)
 207                 return (-1);
 208
 209         if (hosts != NULL)
 210                 add_hosts ();
 211
 212         if (ping_send (pingobj) < 0)
 213         {
 214                 ERROR ("ping plugin: `ping_send' failed: %s",
 215                                 ping_get_error (pingobj));
 216                 return (-1);
 217         }
 218
 219         number_of_hosts = 0;
 220         for (iter = ping_iterator_get (pingobj);
 221                         iter != NULL;
 222                         iter = ping_iterator_next (iter))
 223         {
 224                 buf_len = sizeof (host);
 225                 if (ping_iterator_get_info (iter, PING_INFO_HOSTNAME,
 226                                         host, &buf_len))
 227                 {
 228                         WARNING ("ping plugin: ping_iterator_get_info "
 229                                         "(PING_INFO_HOSTNAME) failed.");
 230                         continue;
 231                 }
 232
 233                 buf_len = sizeof (latency);
 234                 if (ping_iterator_get_info (iter, PING_INFO_LATENCY,
 235                                         &latency, &buf_len))
 236                 {
 237                         WARNING ("ping plugin: ping_iterator_get_info (%s, "
 238                                         "PING_INFO_LATENCY) failed.", host);
 239                         continue;
 240                 }
 241
 242                 DEBUG ("ping plugin: host = %s, latency = %f", host, latency);
 243                 ping_submit (host, latency);
 244                 number_of_hosts++;
 245         }
 246
 247         if ((number_of_hosts == 0) && (getuid () != 0))
 248         {
 249                 ERROR ("ping plugin: All hosts failed. Try starting collectd as root.");
 250         }
 251
 252         return (number_of_hosts == 0 ? -1 : 0);
 253 } /* int ping_read */
 254
 255 void module_register (void)
 256 {
 257         plugin_register_config ("ping", ping_config,
 258                         config_keys, config_keys_num);
 259         plugin_register_init ("ping", ping_init);
 260         plugin_register_read ("ping", ping_read);
 261 } /* void module_register */