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
  27 #include "common.h"
  28 #include "plugin.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         "ReportInactive",
  88 };
  89 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  90
  91 static ignorelist_t *ignorelist = NULL;
  92
  93 static _Bool report_inactive = 1;
  94
  95 #ifdef HAVE_LIBKSTAT
  96 #define MAX_NUMIF 256
  97 extern kstat_ctl_t *kc;
  98 static kstat_t *ksp[MAX_NUMIF];
  99 static int numif = 0;
 100 static _Bool unique_name = 0;
 101 #endif /* HAVE_LIBKSTAT */
 102
 103 static int interface_config (const char *key, const char *value)
 104 {
 105         if (ignorelist == NULL)
 106                 ignorelist = ignorelist_create (/* invert = */ 1);
 107
 108         if (strcasecmp (key, "Interface") == 0)
 109         {
 110                 ignorelist_add (ignorelist, value);
 111         }
 112         else if (strcasecmp (key, "IgnoreSelected") == 0)
 113         {
 114                 int invert = 1;
 115                 if (IS_TRUE (value))
 116                         invert = 0;
 117                 ignorelist_set_invert (ignorelist, invert);
 118         }
 119         else if (strcasecmp (key, "ReportInactive") == 0)
 120                 report_inactive = IS_TRUE (value);
 121         else if (strcasecmp (key, "UniqueName") == 0)
 122         {
 123                 #ifdef HAVE_LIBKSTAT
 124                 if (IS_TRUE (value))
 125                         unique_name = 1;
 126                 #else
 127                         WARNING ("interface plugin: the \"UniqueName\" option is only valid on Solaris.");
 128                 #endif /* HAVE_LIBKSTAT */
 129         }
 130         else
 131         {
 132                 return (-1);
 133         }
 134
 135         return (0);
 136 }
 137
 138 #if HAVE_LIBKSTAT
 139 static int interface_init (void)
 140 {
 141         kstat_t *ksp_chain;
 142
 143         numif = 0;
 144
 145         if (kc == NULL)
 146                 return (-1);
 147
 148         for (numif = 0, ksp_chain = kc->kc_chain;
 149                         (numif < MAX_NUMIF) && (ksp_chain != NULL);
 150                         ksp_chain = ksp_chain->ks_next)
 151         {
 152                 if (strncmp (ksp_chain->ks_class, "net", 3))
 153                         continue;
 154                 if (ksp_chain->ks_type != KSTAT_TYPE_NAMED)
 155                         continue;
 156                 if (kstat_read (kc, ksp_chain, NULL) == -1)
 157                         continue;
 158                 if (get_kstat_value (ksp_chain, "obytes") == -1LL)
 159                         continue;
 160                 ksp[numif++] = ksp_chain;
 161         }
 162
 163         return (0);
 164 } /* int interface_init */
 165 #endif /* HAVE_LIBKSTAT */
 166
 167 static void if_submit (const char *dev, const char *type,
 168                 derive_t rx,
 169                 derive_t tx)
 170 {
 171         value_t values[2];
 172         value_list_t vl = VALUE_LIST_INIT;
 173
 174         if (ignorelist_match (ignorelist, dev) != 0)
 175                 return;
 176
 177         values[0].derive = rx;
 178         values[1].derive = tx;
 179
 180         vl.values = values;
 181         vl.values_len = 2;
 182         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 183         sstrncpy (vl.plugin, "interface", sizeof (vl.plugin));
 184         sstrncpy (vl.plugin_instance, dev, sizeof (vl.plugin_instance));
 185         sstrncpy (vl.type, type, sizeof (vl.type));
 186
 187         plugin_dispatch_values (&vl);
 188 } /* void if_submit */
 189
 190 static int interface_read (void)
 191 {
 192 #if HAVE_GETIFADDRS
 193         struct ifaddrs *if_list;
 194
 195 /* Darwin/Mac OS X and possible other *BSDs */
 196 #if HAVE_STRUCT_IF_DATA
 197 #  define IFA_DATA if_data
 198 #  define IFA_RX_BYTES ifi_ibytes
 199 #  define IFA_TX_BYTES ifi_obytes
 200 #  define IFA_RX_PACKT ifi_ipackets
 201 #  define IFA_TX_PACKT ifi_opackets
 202 #  define IFA_RX_ERROR ifi_ierrors
 203 #  define IFA_TX_ERROR ifi_oerrors
 204 /* #endif HAVE_STRUCT_IF_DATA */
 205
 206 #elif HAVE_STRUCT_NET_DEVICE_STATS
 207 #  define IFA_DATA net_device_stats
 208 #  define IFA_RX_BYTES rx_bytes
 209 #  define IFA_TX_BYTES tx_bytes
 210 #  define IFA_RX_PACKT rx_packets
 211 #  define IFA_TX_PACKT tx_packets
 212 #  define IFA_RX_ERROR rx_errors
 213 #  define IFA_TX_ERROR tx_errors
 214 #else
 215 #  error "No suitable type for `struct ifaddrs->ifa_data' found."
 216 #endif
 217
 218         struct IFA_DATA *if_data;
 219
 220         if (getifaddrs (&if_list) != 0)
 221                 return (-1);
 222
 223         for (struct ifaddrs *if_ptr = if_list; if_ptr != NULL; if_ptr = if_ptr->ifa_next)
 224         {
 225                 if (if_ptr->ifa_addr != NULL && if_ptr->ifa_addr->sa_family == AF_LINK) {
 226                         if_data = (struct IFA_DATA *) if_ptr->ifa_data;
 227
 228                         if (!report_inactive && if_data->IFA_RX_PACKT == 0 && if_data->IFA_TX_PACKT == 0)
 229                                 continue;
 230
 231                         if_submit (if_ptr->ifa_name, "if_octets",
 232                                 if_data->IFA_RX_BYTES,
 233                                 if_data->IFA_TX_BYTES);
 234                         if_submit (if_ptr->ifa_name, "if_packets",
 235                                 if_data->IFA_RX_PACKT,
 236                                 if_data->IFA_TX_PACKT);
 237                         if_submit (if_ptr->ifa_name, "if_errors",
 238                                 if_data->IFA_RX_ERROR,
 239                                 if_data->IFA_TX_ERROR);
 240                 }
 241         }
 242
 243         freeifaddrs (if_list);
 244 /* #endif HAVE_GETIFADDRS */
 245
 246 #elif KERNEL_LINUX
 247         FILE *fh;
 248         char buffer[1024];
 249         derive_t incoming, outgoing;
 250         char *device;
 251
 252         char *dummy;
 253         char *fields[16];
 254         int numfields;
 255
 256         if ((fh = fopen ("/proc/net/dev", "r")) == NULL)
 257         {
 258                 char errbuf[1024];
 259                 WARNING ("interface plugin: fopen: %s",
 260                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 261                 return (-1);
 262         }
 263
 264         while (fgets (buffer, 1024, fh) != NULL)
 265         {
 266                 if (!(dummy = strchr(buffer, ':')))
 267                         continue;
 268                 dummy[0] = '\0';
 269                 dummy++;
 270
 271                 device = buffer;
 272                 while (device[0] == ' ')
 273                         device++;
 274
 275                 if (device[0] == '\0')
 276                         continue;
 277
 278                 numfields = strsplit (dummy, fields, 16);
 279
 280                 if (numfields < 11)
 281                         continue;
 282
 283                 incoming = atoll (fields[1]);
 284                 outgoing = atoll (fields[9]);
 285                 if (!report_inactive && incoming == 0 && outgoing == 0)
 286                         continue;
 287
 288                 if_submit (device, "if_packets", incoming, outgoing);
 289
 290                 incoming = atoll (fields[0]);
 291                 outgoing = atoll (fields[8]);
 292                 if_submit (device, "if_octets", incoming, outgoing);
 293
 294                 incoming = atoll (fields[2]);
 295                 outgoing = atoll (fields[10]);
 296                 if_submit (device, "if_errors", incoming, outgoing);
 297
 298                 incoming = atoll (fields[3]);
 299                 outgoing = atoll (fields[11]);
 300                 if_submit (device, "if_dropped", incoming, outgoing);
 301         }
 302
 303         fclose (fh);
 304 /* #endif KERNEL_LINUX */
 305
 306 #elif HAVE_LIBKSTAT
 307         derive_t rx;
 308         derive_t tx;
 309         char iname[DATA_MAX_NAME_LEN];
 310
 311         if (kc == NULL)
 312                 return (-1);
 313
 314         for (int i = 0; i < numif; i++)
 315         {
 316                 if (kstat_read (kc, ksp[i], NULL) == -1)
 317                         continue;
 318
 319                 if (unique_name)
 320                         ssnprintf(iname, sizeof(iname), "%s_%d_%s", ksp[i]->ks_module, ksp[i]->ks_instance, ksp[i]->ks_name);
 321                 else
 322                         sstrncpy(iname, ksp[i]->ks_name, sizeof(iname));
 323
 324                 /* try to get 64bit counters */
 325                 rx = get_kstat_value (ksp[i], "ipackets64");
 326                 tx = get_kstat_value (ksp[i], "opackets64");
 327                 /* or fallback to 32bit */
 328                 if (rx == -1LL)
 329                         rx = get_kstat_value (ksp[i], "ipackets");
 330                 if (tx == -1LL)
 331                         tx = get_kstat_value (ksp[i], "opackets");
 332                 if (!report_inactive && rx == 0 && tx == 0)
 333                         continue;
 334                 if ((rx != -1LL) || (tx != -1LL))
 335                         if_submit (iname, "if_packets", rx, tx);
 336
 337                 /* try to get 64bit counters */
 338                 rx = get_kstat_value (ksp[i], "rbytes64");
 339                 tx = get_kstat_value (ksp[i], "obytes64");
 340                 /* or fallback to 32bit */
 341                 if (rx == -1LL)
 342                         rx = get_kstat_value (ksp[i], "rbytes");
 343                 if (tx == -1LL)
 344                         tx = get_kstat_value (ksp[i], "obytes");
 345                 if ((rx != -1LL) || (tx != -1LL))
 346                         if_submit (iname, "if_octets", rx, tx);
 347
 348                 /* no 64bit error counters yet */
 349                 rx = get_kstat_value (ksp[i], "ierrors");
 350                 tx = get_kstat_value (ksp[i], "oerrors");
 351                 if ((rx != -1LL) || (tx != -1LL))
 352                         if_submit (iname, "if_errors", rx, tx);
 353         }
 354 /* #endif HAVE_LIBKSTAT */
 355
 356 #elif defined(HAVE_LIBSTATGRAB)
 357         sg_network_io_stats *ios;
 358         int num;
 359
 360         ios = sg_get_network_io_stats (&num);
 361
 362         for (int i = 0; i < num; i++) {
 363                 if (!report_inactive && ios[i].rx == 0 && ios[i].tx == 0)
 364                         continue;
 365                 if_submit (ios[i].interface_name, "if_octets", ios[i].rx, ios[i].tx);
 366         }
 367 /* #endif HAVE_LIBSTATGRAB */
 368
 369 #elif defined(HAVE_PERFSTAT)
 370         perfstat_id_t id;
 371         int ifs;
 372
 373         if ((nif =  perfstat_netinterface(NULL, NULL, sizeof(perfstat_netinterface_t), 0)) < 0)
 374         {
 375                 char errbuf[1024];
 376                 WARNING ("interface plugin: perfstat_netinterface: %s",
 377                         sstrerror (errno, errbuf, sizeof (errbuf)));
 378                 return (-1);
 379         }
 380
 381         if (pnif != nif || ifstat == NULL)
 382         {
 383                 free(ifstat);
 384                 ifstat = malloc(nif * sizeof (*ifstat));
 385         }
 386         pnif = nif;
 387
 388         id.name[0]='\0';
 389         if ((ifs = perfstat_netinterface(&id, ifstat, sizeof(perfstat_netinterface_t), nif)) < 0)
 390         {
 391                 char errbuf[1024];
 392                 WARNING ("interface plugin: perfstat_netinterface (interfaces=%d): %s",
 393                         nif, sstrerror (errno, errbuf, sizeof (errbuf)));
 394                 return (-1);
 395         }
 396
 397         for (int i = 0; i < ifs; i++)
 398         {
 399                 if (!report_inactive && ifstat[i].ipackets == 0 && ifstat[i].opackets == 0)
 400                         continue;
 401
 402                 if_submit (ifstat[i].name, "if_octets", ifstat[i].ibytes, ifstat[i].obytes);
 403                 if_submit (ifstat[i].name, "if_packets", ifstat[i].ipackets ,ifstat[i].opackets);
 404                 if_submit (ifstat[i].name, "if_errors", ifstat[i].ierrors, ifstat[i].oerrors );
 405         }
 406 #endif /* HAVE_PERFSTAT */
 407
 408         return (0);
 409 } /* int interface_read */
 410
 411 void module_register (void)
 412 {
 413         plugin_register_config ("interface", interface_config,
 414                         config_keys, config_keys_num);
 415 #if HAVE_LIBKSTAT
 416         plugin_register_init ("interface", interface_init);
 417 #endif
 418         plugin_register_read ("interface", interface_read);
 419 } /* void module_register */
 420