2 * collectd - src/netlink.c
3 * Copyright (C) 2007 Florian octo Forster
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.
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.
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
19 * Florian octo Forster <octo at verplant.org>
26 #include <asm/types.h>
27 #include <sys/socket.h>
29 #include <linux/netlink.h>
30 #include <linux/rtnetlink.h>
31 #if HAVE_LINUX_GEN_STATS_H
32 # include <linux/gen_stats.h>
34 #if HAVE_LINUX_PKT_SCHED_H
35 # include <linux/pkt_sched.h>
39 # include <libnetlink.h>
40 #elif HAVE_IPROUTE_LIBNETLINK_H
41 # include <iproute/libnetlink.h>
42 #elif HAVE_LINUX_LIBNETLINK_H
43 # include <linux/libnetlink.h>
46 typedef struct ir_ignorelist_s
51 struct ir_ignorelist_s *next;
54 static int ir_ignorelist_invert = 1;
55 static ir_ignorelist_t *ir_ignorelist_head = NULL;
57 static struct rtnl_handle rth;
59 static char **iflist = NULL;
60 static size_t iflist_len = 0;
62 static const char *config_keys[] =
71 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
73 static int add_ignorelist (const char *dev, const char *type,
76 ir_ignorelist_t *entry;
78 entry = (ir_ignorelist_t *) malloc (sizeof (ir_ignorelist_t));
82 memset (entry, '\0', sizeof (ir_ignorelist_t));
84 if (strcasecmp (dev, "All") != 0)
86 entry->device = strdup (dev);
87 if (entry->device == NULL)
94 entry->type = strdup (type);
95 if (entry->type == NULL)
97 sfree (entry->device);
104 entry->inst = strdup (inst);
105 if (entry->inst == NULL)
108 sfree (entry->device);
114 entry->next = ir_ignorelist_head;
115 ir_ignorelist_head = entry;
118 } /* int add_ignorelist */
121 * Checks wether a data set should be ignored. Returns `true' is the value
122 * should be ignored, `false' otherwise.
124 static int check_ignorelist (const char *dev,
125 const char *type, const char *type_instance)
129 assert ((dev != NULL) && (type != NULL));
131 if (ir_ignorelist_head == NULL)
132 return (ir_ignorelist_invert ? 0 : 1);
134 for (i = ir_ignorelist_head; i != NULL; i = i->next)
136 /* i->device == NULL => match all devices */
137 if ((i->device != NULL)
138 && (strcasecmp (i->device, dev) != 0))
141 if (strcasecmp (i->type, type) != 0)
144 if ((i->inst != NULL) && (type_instance != NULL)
145 && (strcasecmp (i->inst, type_instance) != 0))
148 DEBUG ("netlink plugin: check_ignorelist: "
149 "(dev = %s; type = %s; inst = %s) matched "
150 "(dev = %s; type = %s; inst = %s)",
152 type_instance == NULL ? "(nil)" : type_instance,
153 i->device == NULL ? "(nil)" : i->device,
155 i->inst == NULL ? "(nil)" : i->inst);
157 return (ir_ignorelist_invert ? 0 : 1);
160 return (ir_ignorelist_invert);
161 } /* int check_ignorelist */
163 static void submit_one (const char *dev, const char *type,
164 const char *type_instance, counter_t value)
167 value_list_t vl = VALUE_LIST_INIT;
169 values[0].counter = value;
173 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
174 sstrncpy (vl.plugin, "netlink", sizeof (vl.plugin));
175 sstrncpy (vl.plugin_instance, dev, sizeof (vl.plugin_instance));
176 sstrncpy (vl.type, type, sizeof (vl.type));
178 if (type_instance != NULL)
179 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
181 plugin_dispatch_values (&vl);
182 } /* void submit_one */
184 static void submit_two (const char *dev, const char *type,
185 const char *type_instance,
186 counter_t rx, counter_t tx)
189 value_list_t vl = VALUE_LIST_INIT;
191 values[0].counter = rx;
192 values[1].counter = tx;
196 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
197 sstrncpy (vl.plugin, "netlink", sizeof (vl.plugin));
198 sstrncpy (vl.plugin_instance, dev, sizeof (vl.plugin_instance));
199 sstrncpy (vl.type, type, sizeof (vl.type));
201 if (type_instance != NULL)
202 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
204 plugin_dispatch_values (&vl);
205 } /* void submit_two */
207 static int link_filter (const struct sockaddr_nl __attribute__((unused)) *sa,
208 struct nlmsghdr *nmh, void __attribute__((unused)) *args)
210 struct ifinfomsg *msg;
212 struct rtattr *attrs[IFLA_MAX + 1];
213 struct rtnl_link_stats *stats;
217 if (nmh->nlmsg_type != RTM_NEWLINK)
219 ERROR ("netlink plugin: link_filter: Don't know how to handle type %i.",
224 msg = NLMSG_DATA (nmh);
226 msg_len = nmh->nlmsg_len - sizeof (struct ifinfomsg);
229 ERROR ("netlink plugin: link_filter: msg_len = %i < 0;", msg_len);
233 memset (attrs, '\0', sizeof (attrs));
234 if (parse_rtattr (attrs, IFLA_MAX, IFLA_RTA (msg), msg_len) != 0)
236 ERROR ("netlink plugin: link_filter: parse_rtattr failed.");
240 if (attrs[IFLA_IFNAME] == NULL)
242 ERROR ("netlink plugin: link_filter: attrs[IFLA_IFNAME] == NULL");
245 dev = RTA_DATA (attrs[IFLA_IFNAME]);
247 /* Update the `iflist'. It's used to know which interfaces exist and query
248 * them later for qdiscs and classes. */
249 if ((msg->ifi_index >= 0) && ((size_t) msg->ifi_index >= iflist_len))
253 temp = (char **) realloc (iflist, (msg->ifi_index + 1) * sizeof (char *));
256 ERROR ("netlink plugin: link_filter: realloc failed.");
260 memset (temp + iflist_len, '\0',
261 (msg->ifi_index + 1 - iflist_len) * sizeof (char *));
263 iflist_len = msg->ifi_index + 1;
265 if ((iflist[msg->ifi_index] == NULL)
266 || (strcmp (iflist[msg->ifi_index], dev) != 0))
268 sfree (iflist[msg->ifi_index]);
269 iflist[msg->ifi_index] = strdup (dev);
272 if (attrs[IFLA_STATS] == NULL)
274 DEBUG ("netlink plugin: link_filter: No statistics for interface %s.", dev);
277 stats = RTA_DATA (attrs[IFLA_STATS]);
279 if (check_ignorelist (dev, "interface", NULL) == 0)
281 submit_two (dev, "if_octets", NULL, stats->rx_bytes, stats->tx_bytes);
282 submit_two (dev, "if_packets", NULL, stats->rx_packets, stats->tx_packets);
283 submit_two (dev, "if_errors", NULL, stats->rx_errors, stats->tx_errors);
287 DEBUG ("netlink plugin: Ignoring %s/interface.", dev);
290 if (check_ignorelist (dev, "if_detail", NULL) == 0)
292 submit_two (dev, "if_dropped", NULL, stats->rx_dropped, stats->tx_dropped);
293 submit_one (dev, "if_multicast", NULL, stats->multicast);
294 submit_one (dev, "if_collisions", NULL, stats->collisions);
296 submit_one (dev, "if_rx_errors", "length", stats->rx_length_errors);
297 submit_one (dev, "if_rx_errors", "over", stats->rx_over_errors);
298 submit_one (dev, "if_rx_errors", "crc", stats->rx_crc_errors);
299 submit_one (dev, "if_rx_errors", "frame", stats->rx_frame_errors);
300 submit_one (dev, "if_rx_errors", "fifo", stats->rx_fifo_errors);
301 submit_one (dev, "if_rx_errors", "missed", stats->rx_missed_errors);
303 submit_one (dev, "if_tx_errors", "aborted", stats->tx_aborted_errors);
304 submit_one (dev, "if_tx_errors", "carrier", stats->tx_carrier_errors);
305 submit_one (dev, "if_tx_errors", "fifo", stats->tx_fifo_errors);
306 submit_one (dev, "if_tx_errors", "heartbeat", stats->tx_heartbeat_errors);
307 submit_one (dev, "if_tx_errors", "window", stats->tx_window_errors);
311 DEBUG ("netlink plugin: Ignoring %s/if_detail.", dev);
315 } /* int link_filter */
317 static int qos_filter (const struct sockaddr_nl __attribute__((unused)) *sa,
318 struct nlmsghdr *nmh, void *args)
322 struct rtattr *attrs[TCA_MAX + 1];
324 int wanted_ifindex = *((int *) args);
328 /* char *type_instance; */
330 char tc_inst[DATA_MAX_NAME_LEN];
332 if (nmh->nlmsg_type == RTM_NEWQDISC)
334 else if (nmh->nlmsg_type == RTM_NEWTCLASS)
336 else if (nmh->nlmsg_type == RTM_NEWTFILTER)
340 ERROR ("netlink plugin: qos_filter: Don't know how to handle type %i.",
345 msg = NLMSG_DATA (nmh);
347 msg_len = nmh->nlmsg_len - sizeof (struct tcmsg);
350 ERROR ("netlink plugin: qos_filter: msg_len = %i < 0;", msg_len);
354 if (msg->tcm_ifindex != wanted_ifindex)
356 DEBUG ("netlink plugin: qos_filter: Got %s for interface #%i, "
358 tc_type, msg->tcm_ifindex, wanted_ifindex);
362 if ((msg->tcm_ifindex >= 0)
363 && ((size_t) msg->tcm_ifindex >= iflist_len))
365 ERROR ("netlink plugin: qos_filter: msg->tcm_ifindex = %i "
366 ">= iflist_len = %zu",
367 msg->tcm_ifindex, iflist_len);
371 dev = iflist[msg->tcm_ifindex];
374 ERROR ("netlink plugin: qos_filter: iflist[%i] == NULL",
379 memset (attrs, '\0', sizeof (attrs));
380 if (parse_rtattr (attrs, TCA_MAX, TCA_RTA (msg), msg_len) != 0)
382 ERROR ("netlink plugin: qos_filter: parse_rtattr failed.");
386 if (attrs[TCA_KIND] == NULL)
388 ERROR ("netlink plugin: qos_filter: attrs[TCA_KIND] == NULL");
393 uint32_t numberic_id;
395 numberic_id = msg->tcm_handle;
396 if (strcmp (tc_type, "filter") == 0)
397 numberic_id = msg->tcm_parent;
399 ssnprintf (tc_inst, sizeof (tc_inst), "%s-%x:%x",
400 (const char *) RTA_DATA (attrs[TCA_KIND]),
402 numberic_id & 0x0000FFFF);
405 DEBUG ("netlink plugin: qos_filter: got %s for %s (%i).",
406 tc_type, dev, msg->tcm_ifindex);
408 if (check_ignorelist (dev, tc_type, tc_inst))
412 if (attrs[TCA_STATS2])
414 struct rtattr *attrs_stats[TCA_STATS_MAX + 1];
416 memset (attrs_stats, '\0', sizeof (attrs_stats));
417 parse_rtattr_nested (attrs_stats, TCA_STATS_MAX, attrs[TCA_STATS2]);
419 if (attrs_stats[TCA_STATS_BASIC])
421 struct gnet_stats_basic bs;
422 char type_instance[DATA_MAX_NAME_LEN];
424 ssnprintf (type_instance, sizeof (type_instance), "%s-%s",
427 memset (&bs, '\0', sizeof (bs));
428 memcpy (&bs, RTA_DATA (attrs_stats[TCA_STATS_BASIC]),
429 MIN (RTA_PAYLOAD (attrs_stats[TCA_STATS_BASIC]), sizeof(bs)));
431 submit_one (dev, "ipt_bytes", type_instance, bs.bytes);
432 submit_one (dev, "ipt_packets", type_instance, bs.packets);
435 #endif /* TCA_STATS2 */
436 #if HAVE_TCA_STATS && HAVE_TCA_STATS2
440 if (attrs[TCA_STATS] != NULL)
443 char type_instance[DATA_MAX_NAME_LEN];
445 ssnprintf (type_instance, sizeof (type_instance), "%s-%s",
448 memset(&ts, '\0', sizeof (ts));
449 memcpy(&ts, RTA_DATA (attrs[TCA_STATS]),
450 MIN (RTA_PAYLOAD (attrs[TCA_STATS]), sizeof (ts)));
452 submit_one (dev, "ipt_bytes", type_instance, ts.bytes);
453 submit_one (dev, "ipt_packets", type_instance, ts.packets);
455 #endif /* TCA_STATS */
456 #if HAVE_TCA_STATS || HAVE_TCA_STATS2
460 DEBUG ("netlink plugin: qos_filter: Have neither TCA_STATS2 nor "
465 } /* int qos_filter */
467 static int ir_config (const char *key, const char *value)
474 new_val = strdup (value);
478 fields_num = strsplit (new_val, fields, STATIC_ARRAY_SIZE (fields));
479 if ((fields_num < 1) || (fields_num > 8))
485 if ((strcasecmp (key, "Interface") == 0)
486 || (strcasecmp (key, "VerboseInterface") == 0))
490 ERROR ("netlink plugin: Invalid number of fields for option "
491 "`%s'. Got %i, expected 1.", key, fields_num);
496 add_ignorelist (fields[0], "interface", NULL);
497 if (strcasecmp (key, "VerboseInterface") == 0)
498 add_ignorelist (fields[0], "if_detail", NULL);
502 else if ((strcasecmp (key, "QDisc") == 0)
503 || (strcasecmp (key, "Class") == 0)
504 || (strcasecmp (key, "Filter") == 0))
506 if ((fields_num < 1) || (fields_num > 2))
508 ERROR ("netlink plugin: Invalid number of fields for option "
509 "`%s'. Got %i, expected 1 or 2.", key, fields_num);
514 add_ignorelist (fields[0], key,
515 (fields_num == 2) ? fields[1] : NULL);
519 else if (strcasecmp (key, "IgnoreSelected") == 0)
523 ERROR ("netlink plugin: Invalid number of fields for option "
524 "`IgnoreSelected'. Got %i, expected 1.", fields_num);
529 if (IS_TRUE (fields[0]))
530 ir_ignorelist_invert = 0;
532 ir_ignorelist_invert = 1;
540 } /* int ir_config */
542 static int ir_init (void)
544 memset (&rth, '\0', sizeof (rth));
546 if (rtnl_open (&rth, 0) != 0)
548 ERROR ("netlink plugin: ir_init: rtnl_open failed.");
555 static int ir_read (void)
561 static const int type_id[] = { RTM_GETQDISC, RTM_GETTCLASS, RTM_GETTFILTER };
562 static const char *type_name[] = { "qdisc", "class", "filter" };
564 memset (&im, '\0', sizeof (im));
565 im.ifi_type = AF_UNSPEC;
567 if (rtnl_dump_request (&rth, RTM_GETLINK, &im, sizeof (im)) < 0)
569 ERROR ("netlink plugin: ir_read: rtnl_dump_request failed.");
573 if (rtnl_dump_filter (&rth, link_filter, /* arg1 = */ NULL,
576 ERROR ("netlink plugin: ir_read: rtnl_dump_filter failed.");
580 /* `link_filter' will update `iflist' which is used here to iterate over all
582 for (ifindex = 0; (size_t) ifindex < iflist_len; ifindex++)
586 if (iflist[ifindex] == NULL)
589 for (type_index = 0; type_index < STATIC_ARRAY_SIZE (type_id); type_index++)
591 if (check_ignorelist (iflist[ifindex], type_name[type_index], NULL))
593 DEBUG ("netlink plugin: ir_read: check_ignorelist (%s, %s, (nil)) "
594 "== TRUE", iflist[ifindex], type_name[type_index]);
598 DEBUG ("netlink plugin: ir_read: querying %s from %s (%i).",
599 type_name[type_index], iflist[ifindex], ifindex);
601 memset (&tm, '\0', sizeof (tm));
602 tm.tcm_family = AF_UNSPEC;
603 tm.tcm_ifindex = ifindex;
605 if (rtnl_dump_request (&rth, type_id[type_index], &tm, sizeof (tm)) < 0)
607 ERROR ("netlink plugin: ir_read: rtnl_dump_request failed.");
611 if (rtnl_dump_filter (&rth, qos_filter, (void *) &ifindex,
614 ERROR ("netlink plugin: ir_read: rtnl_dump_filter failed.");
617 } /* for (type_index) */
618 } /* for (if_index) */
623 static int ir_shutdown (void)
625 if ((rth.fd != 0) || (rth.seq != 0) || (rth.dump != 0))
628 memset (&rth, '\0', sizeof (rth));
632 } /* int ir_shutdown */
634 void module_register (void)
636 plugin_register_config ("netlink", ir_config, config_keys, config_keys_num);
637 plugin_register_init ("netlink", ir_init);
638 plugin_register_read ("netlink", ir_read);
639 plugin_register_shutdown ("netlink", ir_shutdown);
640 } /* void module_register */
643 * vim: set shiftwidth=2 softtabstop=2 tabstop=8 :