src/interface.c

   1 /**
   2  * collectd - src/interface.c
   3  * Copyright (C) 2005-2010  Florian octo Forster
   4  * Copyright (C) 2009       Manuel Sanmartin
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; only version 2 of the License is applicable.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  18  *
  19  * Authors:
  20  *   Florian octo Forster <octo at collectd.org>
  21  *   Sune Marcher <sm at flork.dk>
  22  *   Manuel Sanmartin
  23  **/
  24
  25 #include "collectd.h"
  26 #include "common.h"
  27 #include "plugin.h"
  28 #include "configfile.h"
  29 #include "utils_ignorelist.h"
  30
  31 #if HAVE_SYS_TYPES_H
  32 #  include <sys/types.h>
  33 #endif
  34
  35 /* One cannot include both. This sucks. */
  36 #if HAVE_LINUX_IF_H
  37 #  include <linux/if.h>
  38 #elif HAVE_NET_IF_H
  39 #  include <net/if.h>
  40 #endif
  41
  42 #if HAVE_LINUX_NETDEVICE_H
  43 #  include <linux/netdevice.h>
  44 #endif
  45 #if HAVE_IFADDRS_H
  46 #  include <ifaddrs.h>
  47 #endif
  48
  49 #if HAVE_STATGRAB_H
  50 # include <statgrab.h>
  51 #endif
  52
  53 #if HAVE_PERFSTAT
  54 # include <sys/protosw.h>
  55 # include <libperfstat.h>
  56 #endif
  57
  58 /*
  59  * Various people have reported problems with `getifaddrs' and varying versions
  60  * of `glibc'. That's why it's disabled by default. Since more statistics are
  61  * available this way one may enable it using the `--enable-getifaddrs' option
  62  * of the configure script. -octo
  63  */
  64 #if KERNEL_LINUX
  65 # if !COLLECT_GETIFADDRS
  66 #  undef HAVE_GETIFADDRS
  67 # endif /* !COLLECT_GETIFADDRS */
  68 #endif /* KERNEL_LINUX */
  69
  70 #if HAVE_PERFSTAT
  71 static perfstat_netinterface_t *ifstat;
  72 static int nif;
  73 static int pnif;
  74 #endif /* HAVE_PERFSTAT */
  75
  76 #if !HAVE_GETIFADDRS && !KERNEL_LINUX && !HAVE_LIBKSTAT && !HAVE_LIBSTATGRAB && !HAVE_PERFSTAT
  77 # error "No applicable input method."
  78 #endif
  79
  80 /*
  81  * (Module-)Global variables
  82  */
  83 static const char *config_keys[] =
  84 {
  85         "Interface",
  86         "IgnoreSelected",
  87         NULL
  88 };
  89 static int config_keys_num = 2;
  90
  91 static ignorelist_t *ignorelist = NULL;
  92
  93 #ifdef HAVE_LIBKSTAT
  94 #define MAX_NUMIF 256
  95 extern kstat_ctl_t *kc;
  96 static kstat_t *ksp[MAX_NUMIF];
  97 static int numif = 0;
  98 static _Bool unique_name = 0;
  99 #endif /* HAVE_LIBKSTAT */
 100
 101 static int interface_config (const char *key, const char *value)
 102 {
 103         if (ignorelist == NULL)
 104                 ignorelist = ignorelist_create (/* invert = */ 1);
 105
 106         if (strcasecmp (key, "Interface") == 0)
 107         {
 108                 ignorelist_add (ignorelist, value);
 109         }
 110         else if (strcasecmp (key, "IgnoreSelected") == 0)
 111         {
 112                 int invert = 1;
 113                 if (IS_TRUE (value))
 114                         invert = 0;
 115                 ignorelist_set_invert (ignorelist, invert);
 116         }
 117         else if (strcasecmp (key, "UniqueName") == 0)
 118         {
 119                 #ifdef HAVE_LIBKSTAT
 120                 if (IS_TRUE (value))
 121                         unique_name = 1;
 122                 #else
 123                         WARNING ("interface plugin: the \"UniqueName\" option is only valid on Solaris.");
 124                 #endif /* HAVE_LIBKSTAT */
 125         }
 126         else
 127         {
 128                 return (-1);
 129         }
 130
 131         return (0);
 132 }
 133
 134 #if HAVE_LIBKSTAT
 135 static int interface_init (void)
 136 {
 137         kstat_t *ksp_chain;
 138         derive_t val;
 139
 140         numif = 0;
 141
 142         if (kc == NULL)
 143                 return (-1);
 144
 145         for (numif = 0, ksp_chain = kc->kc_chain;
 146                         (numif < MAX_NUMIF) && (ksp_chain != NULL);
 147                         ksp_chain = ksp_chain->ks_next)
 148         {
 149                 if (strncmp (ksp_chain->ks_class, "net", 3))
 150                         continue;
 151                 if (ksp_chain->ks_type != KSTAT_TYPE_NAMED)
 152                         continue;
 153                 if (kstat_read (kc, ksp_chain, NULL) == -1)
 154                         continue;
 155                 if ((val = get_kstat_value (ksp_chain, "obytes")) == -1LL)
 156                         continue;
 157                 ksp[numif++] = ksp_chain;
 158         }
 159
 160         return (0);
 161 } /* int interface_init */
 162 #endif /* HAVE_LIBKSTAT */
 163
 164 static void if_submit (const char *dev, const char *type,
 165                 derive_t rx,
 166                 derive_t tx)
 167 {
 168         value_t values[2];
 169         value_list_t vl = VALUE_LIST_INIT;
 170
 171         if (ignorelist_match (ignorelist, dev) != 0)
 172                 return;
 173
 174         values[0].derive = rx;
 175         values[1].derive = tx;
 176
 177         vl.values = values;
 178         vl.values_len = 2;
 179         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 180         sstrncpy (vl.plugin, "interface", sizeof (vl.plugin));
 181         sstrncpy (vl.plugin_instance, dev, sizeof (vl.plugin_instance));
 182         sstrncpy (vl.type, type, sizeof (vl.type));
 183
 184         plugin_dispatch_values (&vl);
 185 } /* void if_submit */
 186
 187 static int interface_read (void)
 188 {
 189 #if HAVE_GETIFADDRS
 190         struct ifaddrs *if_list;
 191         struct ifaddrs *if_ptr;
 192
 193 /* Darwin/Mac OS X and possible other *BSDs */
 194 #if HAVE_STRUCT_IF_DATA
 195 #  define IFA_DATA if_data
 196 #  define IFA_RX_BYTES ifi_ibytes
 197 #  define IFA_TX_BYTES ifi_obytes
 198 #  define IFA_RX_PACKT ifi_ipackets
 199 #  define IFA_TX_PACKT ifi_opackets
 200 #  define IFA_RX_ERROR ifi_ierrors
 201 #  define IFA_TX_ERROR ifi_oerrors
 202 /* #endif HAVE_STRUCT_IF_DATA */
 203
 204 #elif HAVE_STRUCT_NET_DEVICE_STATS
 205 #  define IFA_DATA net_device_stats
 206 #  define IFA_RX_BYTES rx_bytes
 207 #  define IFA_TX_BYTES tx_bytes
 208 #  define IFA_RX_PACKT rx_packets
 209 #  define IFA_TX_PACKT tx_packets
 210 #  define IFA_RX_ERROR rx_errors
 211 #  define IFA_TX_ERROR tx_errors
 212 #else
 213 #  error "No suitable type for `struct ifaddrs->ifa_data' found."
 214 #endif
 215
 216         struct IFA_DATA *if_data;
 217
 218         if (getifaddrs (&if_list) != 0)
 219                 return (-1);
 220
 221         for (if_ptr = if_list; if_ptr != NULL; if_ptr = if_ptr->ifa_next)
 222         {
 223                 if (if_ptr->ifa_addr != NULL && if_ptr->ifa_addr->sa_family == AF_LINK) {
 224                         if_data = (struct IFA_DATA *) if_ptr->ifa_data;
 225
 226                         if_submit (if_ptr->ifa_name, "if_octets",
 227                                 if_data->IFA_RX_BYTES,
 228                                 if_data->IFA_TX_BYTES);
 229                         if_submit (if_ptr->ifa_name, "if_packets",
 230                                 if_data->IFA_RX_PACKT,
 231                                 if_data->IFA_TX_PACKT);
 232                         if_submit (if_ptr->ifa_name, "if_errors",
 233                                 if_data->IFA_RX_ERROR,
 234                                 if_data->IFA_TX_ERROR);
 235                 }
 236         }
 237
 238         freeifaddrs (if_list);
 239 /* #endif HAVE_GETIFADDRS */
 240
 241 #elif KERNEL_LINUX
 242         FILE *fh;
 243         char buffer[1024];
 244         derive_t incoming, outgoing;
 245         char *device;
 246
 247         char *dummy;
 248         char *fields[16];
 249         int numfields;
 250
 251         if ((fh = fopen ("/proc/net/dev", "r")) == NULL)
 252         {
 253                 char errbuf[1024];
 254                 WARNING ("interface plugin: fopen: %s",
 255                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 256                 return (-1);
 257         }
 258
 259         while (fgets (buffer, 1024, fh) != NULL)
 260         {
 261                 if (!(dummy = strchr(buffer, ':')))
 262                         continue;
 263                 dummy[0] = '\0';
 264                 dummy++;
 265
 266                 device = buffer;
 267                 while (device[0] == ' ')
 268                         device++;
 269
 270                 if (device[0] == '\0')
 271                         continue;
 272
 273                 numfields = strsplit (dummy, fields, 16);
 274
 275                 if (numfields < 11)
 276                         continue;
 277
 278                 incoming = atoll (fields[0]);
 279                 outgoing = atoll (fields[8]);
 280                 if_submit (device, "if_octets", incoming, outgoing);
 281
 282                 incoming = atoll (fields[1]);
 283                 outgoing = atoll (fields[9]);
 284                 if_submit (device, "if_packets", incoming, outgoing);
 285
 286                 incoming = atoll (fields[2]);
 287                 outgoing = atoll (fields[10]);
 288                 if_submit (device, "if_errors", incoming, outgoing);
 289
 290                 incoming = atoll (fields[3]);
 291                 outgoing = atoll (fields[11]);
 292                 if_submit (device, "if_dropped", incoming, outgoing);
 293         }
 294
 295         fclose (fh);
 296 /* #endif KERNEL_LINUX */
 297
 298 #elif HAVE_LIBKSTAT
 299         int i;
 300         derive_t rx;
 301         derive_t tx;
 302         char iname[DATA_MAX_NAME_LEN];
 303
 304         if (kc == NULL)
 305                 return (-1);
 306
 307         for (i = 0; i < numif; i++)
 308         {
 309                 if (kstat_read (kc, ksp[i], NULL) == -1)
 310                         continue;
 311
 312                 if (unique_name)
 313                         ssnprintf(iname, sizeof(iname), "%s_%d_%s", ksp[i]->ks_module, ksp[i]->ks_instance, ksp[i]->ks_name);
 314                 else
 315                         sstrncpy(iname, ksp[i]->ks_name, sizeof(iname));
 316
 317                 /* try to get 64bit counters */
 318                 rx = get_kstat_value (ksp[i], "rbytes64");
 319                 tx = get_kstat_value (ksp[i], "obytes64");
 320                 /* or fallback to 32bit */
 321                 if (rx == -1LL)
 322                         rx = get_kstat_value (ksp[i], "rbytes");
 323                 if (tx == -1LL)
 324                         tx = get_kstat_value (ksp[i], "obytes");
 325                 if ((rx != -1LL) || (tx != -1LL))
 326                         if_submit (iname, "if_octets", rx, tx);
 327
 328                 /* try to get 64bit counters */
 329                 rx = get_kstat_value (ksp[i], "ipackets64");
 330                 tx = get_kstat_value (ksp[i], "opackets64");
 331                 /* or fallback to 32bit */
 332                 if (rx == -1LL)
 333                         rx = get_kstat_value (ksp[i], "ipackets");
 334                 if (tx == -1LL)
 335                         tx = get_kstat_value (ksp[i], "opackets");
 336                 if ((rx != -1LL) || (tx != -1LL))
 337                         if_submit (iname, "if_packets", rx, tx);
 338
 339                 /* no 64bit error counters yet */
 340                 rx = get_kstat_value (ksp[i], "ierrors");
 341                 tx = get_kstat_value (ksp[i], "oerrors");
 342                 if ((rx != -1LL) || (tx != -1LL))
 343                         if_submit (iname, "if_errors", rx, tx);
 344         }
 345 /* #endif HAVE_LIBKSTAT */
 346
 347 #elif defined(HAVE_LIBSTATGRAB)
 348         sg_network_io_stats *ios;
 349         int i, num;
 350
 351         ios = sg_get_network_io_stats (&num);
 352
 353         for (i = 0; i < num; i++)
 354                 if_submit (ios[i].interface_name, "if_octets", ios[i].rx, ios[i].tx);
 355 /* #endif HAVE_LIBSTATGRAB */
 356
 357 #elif defined(HAVE_PERFSTAT)
 358         perfstat_id_t id;
 359         int i, ifs;
 360
 361         if ((nif =  perfstat_netinterface(NULL, NULL, sizeof(perfstat_netinterface_t), 0)) < 0)
 362         {
 363                 char errbuf[1024];
 364                 WARNING ("interface plugin: perfstat_netinterface: %s",
 365                         sstrerror (errno, errbuf, sizeof (errbuf)));
 366                 return (-1);
 367         }
 368
 369         if (pnif != nif || ifstat == NULL)
 370         {
 371                 free(ifstat);
 372                 ifstat = malloc(nif * sizeof (*ifstat));
 373         }
 374         pnif = nif;
 375
 376         id.name[0]='\0';
 377         if ((ifs = perfstat_netinterface(&id, ifstat, sizeof(perfstat_netinterface_t), nif)) < 0)
 378         {
 379                 char errbuf[1024];
 380                 WARNING ("interface plugin: perfstat_netinterface (interfaces=%d): %s",
 381                         nif, sstrerror (errno, errbuf, sizeof (errbuf)));
 382                 return (-1);
 383         }
 384
 385         for (i = 0; i < ifs; i++)
 386         {
 387                 if_submit (ifstat[i].name, "if_octets", ifstat[i].ibytes, ifstat[i].obytes);
 388                 if_submit (ifstat[i].name, "if_packets", ifstat[i].ipackets ,ifstat[i].opackets);
 389                 if_submit (ifstat[i].name, "if_errors", ifstat[i].ierrors, ifstat[i].oerrors );
 390         }
 391 #endif /* HAVE_PERFSTAT */
 392
 393         return (0);
 394 } /* int interface_read */
 395
 396 void module_register (void)
 397 {
 398         plugin_register_config ("interface", interface_config,
 399                         config_keys, config_keys_num);
 400 #if HAVE_LIBKSTAT
 401         plugin_register_init ("interface", interface_init);
 402 #endif
 403         plugin_register_read ("interface", interface_read);
 404 } /* void module_register */