548832258d329bc270118ef92e94a31b6acd403e
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 **/
25 #include "collectd.h"
26 #include "common.h"
27 #include "plugin.h"
28 #include "configfile.h"
29 #include "utils_ignorelist.h"
31 #if HAVE_SYS_TYPES_H
32 # include <sys/types.h>
33 #endif
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
42 #if HAVE_LINUX_NETDEVICE_H
43 # include <linux/netdevice.h>
44 #endif
45 #if HAVE_IFADDRS_H
46 # include <ifaddrs.h>
47 #endif
49 #if HAVE_STATGRAB_H
50 # include <statgrab.h>
51 #endif
53 #if HAVE_PERFSTAT
54 # include <sys/protosw.h>
55 # include <libperfstat.h>
56 #endif
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 */
70 #if HAVE_PERFSTAT
71 static perfstat_netinterface_t *ifstat;
72 static int nif;
73 static int pnif;
74 #endif /* HAVE_PERFSTAT */
76 #if !HAVE_GETIFADDRS && !KERNEL_LINUX && !HAVE_LIBKSTAT && !HAVE_LIBSTATGRAB && !HAVE_PERFSTAT
77 # error "No applicable input method."
78 #endif
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);
91 static ignorelist_t *ignorelist = NULL;
93 static _Bool report_inactive = 1;
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 */
103 static int interface_config (const char *key, const char *value)
104 {
105 if (ignorelist == NULL)
106 ignorelist = ignorelist_create (/* invert = */ 1);
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 }
135 return (0);
136 }
138 #if HAVE_LIBKSTAT
139 static int interface_init (void)
140 {
141 kstat_t *ksp_chain;
143 numif = 0;
145 if (kc == NULL)
146 return (-1);
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 }
163 return (0);
164 } /* int interface_init */
165 #endif /* HAVE_LIBKSTAT */
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;
174 if (ignorelist_match (ignorelist, dev) != 0)
175 return;
177 values[0].derive = rx;
178 values[1].derive = tx;
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));
187 plugin_dispatch_values (&vl);
188 } /* void if_submit */
190 static int interface_read (void)
191 {
192 #if HAVE_GETIFADDRS
193 struct ifaddrs *if_list;
194 struct ifaddrs *if_ptr;
196 /* Darwin/Mac OS X and possible other *BSDs */
197 #if HAVE_STRUCT_IF_DATA
198 # define IFA_DATA if_data
199 # define IFA_RX_BYTES ifi_ibytes
200 # define IFA_TX_BYTES ifi_obytes
201 # define IFA_RX_PACKT ifi_ipackets
202 # define IFA_TX_PACKT ifi_opackets
203 # define IFA_RX_ERROR ifi_ierrors
204 # define IFA_TX_ERROR ifi_oerrors
205 /* #endif HAVE_STRUCT_IF_DATA */
207 #elif HAVE_STRUCT_NET_DEVICE_STATS
208 # define IFA_DATA net_device_stats
209 # define IFA_RX_BYTES rx_bytes
210 # define IFA_TX_BYTES tx_bytes
211 # define IFA_RX_PACKT rx_packets
212 # define IFA_TX_PACKT tx_packets
213 # define IFA_RX_ERROR rx_errors
214 # define IFA_TX_ERROR tx_errors
215 #else
216 # error "No suitable type for `struct ifaddrs->ifa_data' found."
217 #endif
219 struct IFA_DATA *if_data;
221 if (getifaddrs (&if_list) != 0)
222 return (-1);
224 for (if_ptr = if_list; if_ptr != NULL; if_ptr = if_ptr->ifa_next)
225 {
226 if (if_ptr->ifa_addr != NULL && if_ptr->ifa_addr->sa_family == AF_LINK) {
227 if_data = (struct IFA_DATA *) if_ptr->ifa_data;
229 if (!report_inactive && if_data->IFA_RX_PACKT == 0 && if_data->IFA_TX_PACKT == 0)
230 continue;
232 if_submit (if_ptr->ifa_name, "if_octets",
233 if_data->IFA_RX_BYTES,
234 if_data->IFA_TX_BYTES);
235 if_submit (if_ptr->ifa_name, "if_packets",
236 if_data->IFA_RX_PACKT,
237 if_data->IFA_TX_PACKT);
238 if_submit (if_ptr->ifa_name, "if_errors",
239 if_data->IFA_RX_ERROR,
240 if_data->IFA_TX_ERROR);
241 }
242 }
244 freeifaddrs (if_list);
245 /* #endif HAVE_GETIFADDRS */
247 #elif KERNEL_LINUX
248 FILE *fh;
249 char buffer[1024];
250 derive_t incoming, outgoing;
251 char *device;
253 char *dummy;
254 char *fields[16];
255 int numfields;
257 if ((fh = fopen ("/proc/net/dev", "r")) == NULL)
258 {
259 char errbuf[1024];
260 WARNING ("interface plugin: fopen: %s",
261 sstrerror (errno, errbuf, sizeof (errbuf)));
262 return (-1);
263 }
265 while (fgets (buffer, 1024, fh) != NULL)
266 {
267 if (!(dummy = strchr(buffer, ':')))
268 continue;
269 dummy[0] = '\0';
270 dummy++;
272 device = buffer;
273 while (device[0] == ' ')
274 device++;
276 if (device[0] == '\0')
277 continue;
279 numfields = strsplit (dummy, fields, 16);
281 if (numfields < 11)
282 continue;
284 incoming = atoll (fields[1]);
285 outgoing = atoll (fields[9]);
286 if (!report_inactive && incoming == 0 && outgoing == 0)
287 continue;
289 if_submit (device, "if_packets", incoming, outgoing);
291 incoming = atoll (fields[0]);
292 outgoing = atoll (fields[8]);
293 if_submit (device, "if_octets", incoming, outgoing);
295 incoming = atoll (fields[2]);
296 outgoing = atoll (fields[10]);
297 if_submit (device, "if_errors", incoming, outgoing);
299 incoming = atoll (fields[3]);
300 outgoing = atoll (fields[11]);
301 if_submit (device, "if_dropped", incoming, outgoing);
302 }
304 fclose (fh);
305 /* #endif KERNEL_LINUX */
307 #elif HAVE_LIBKSTAT
308 int i;
309 derive_t rx;
310 derive_t tx;
311 char iname[DATA_MAX_NAME_LEN];
313 if (kc == NULL)
314 return (-1);
316 for (i = 0; i < numif; i++)
317 {
318 if (kstat_read (kc, ksp[i], NULL) == -1)
319 continue;
321 if (unique_name)
322 ssnprintf(iname, sizeof(iname), "%s_%d_%s", ksp[i]->ks_module, ksp[i]->ks_instance, ksp[i]->ks_name);
323 else
324 sstrncpy(iname, ksp[i]->ks_name, sizeof(iname));
326 /* try to get 64bit counters */
327 rx = get_kstat_value (ksp[i], "ipackets64");
328 tx = get_kstat_value (ksp[i], "opackets64");
329 /* or fallback to 32bit */
330 if (rx == -1LL)
331 rx = get_kstat_value (ksp[i], "ipackets");
332 if (tx == -1LL)
333 tx = get_kstat_value (ksp[i], "opackets");
334 if (!report_inactive && rx == 0 && tx == 0)
335 continue;
336 if ((rx != -1LL) || (tx != -1LL))
337 if_submit (iname, "if_packets", rx, tx);
339 /* try to get 64bit counters */
340 rx = get_kstat_value (ksp[i], "rbytes64");
341 tx = get_kstat_value (ksp[i], "obytes64");
342 /* or fallback to 32bit */
343 if (rx == -1LL)
344 rx = get_kstat_value (ksp[i], "rbytes");
345 if (tx == -1LL)
346 tx = get_kstat_value (ksp[i], "obytes");
347 if ((rx != -1LL) || (tx != -1LL))
348 if_submit (iname, "if_octets", rx, tx);
350 /* no 64bit error counters yet */
351 rx = get_kstat_value (ksp[i], "ierrors");
352 tx = get_kstat_value (ksp[i], "oerrors");
353 if ((rx != -1LL) || (tx != -1LL))
354 if_submit (iname, "if_errors", rx, tx);
355 }
356 /* #endif HAVE_LIBKSTAT */
358 #elif defined(HAVE_LIBSTATGRAB)
359 sg_network_io_stats *ios;
360 int i, num;
362 ios = sg_get_network_io_stats (&num);
364 for (i = 0; i < num; i++) {
365 if (!report_inactive && ios[i].rx == 0 && ios[i].tx == 0)
366 continue;
367 if_submit (ios[i].interface_name, "if_octets", ios[i].rx, ios[i].tx);
368 }
369 /* #endif HAVE_LIBSTATGRAB */
371 #elif defined(HAVE_PERFSTAT)
372 perfstat_id_t id;
373 int i, ifs;
375 if ((nif = perfstat_netinterface(NULL, NULL, sizeof(perfstat_netinterface_t), 0)) < 0)
376 {
377 char errbuf[1024];
378 WARNING ("interface plugin: perfstat_netinterface: %s",
379 sstrerror (errno, errbuf, sizeof (errbuf)));
380 return (-1);
381 }
383 if (pnif != nif || ifstat == NULL)
384 {
385 free(ifstat);
386 ifstat = malloc(nif * sizeof (*ifstat));
387 }
388 pnif = nif;
390 id.name[0]='\0';
391 if ((ifs = perfstat_netinterface(&id, ifstat, sizeof(perfstat_netinterface_t), nif)) < 0)
392 {
393 char errbuf[1024];
394 WARNING ("interface plugin: perfstat_netinterface (interfaces=%d): %s",
395 nif, sstrerror (errno, errbuf, sizeof (errbuf)));
396 return (-1);
397 }
399 for (i = 0; i < ifs; i++)
400 {
401 if (!report_inactive && ifstat[i].ipackets == 0 && ifstat[i].opackets == 0)
402 continue;
404 if_submit (ifstat[i].name, "if_octets", ifstat[i].ibytes, ifstat[i].obytes);
405 if_submit (ifstat[i].name, "if_packets", ifstat[i].ipackets ,ifstat[i].opackets);
406 if_submit (ifstat[i].name, "if_errors", ifstat[i].ierrors, ifstat[i].oerrors );
407 }
408 #endif /* HAVE_PERFSTAT */
410 return (0);
411 } /* int interface_read */
413 void module_register (void)
414 {
415 plugin_register_config ("interface", interface_config,
416 config_keys, config_keys_num);
417 #if HAVE_LIBKSTAT
418 plugin_register_init ("interface", interface_init);
419 #endif
420 plugin_register_read ("interface", interface_read);
421 } /* void module_register */