2 * collectd - src/netlink.c
3 * Copyright (C) 2007-2010 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 collectd.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 <libmnl/libmnl.h>
40 //#include <linux/if.h>
41 //#include <linux/if_link.h>
43 typedef struct ir_ignorelist_s
48 struct ir_ignorelist_s *next;
51 static int ir_ignorelist_invert = 1;
52 static ir_ignorelist_t *ir_ignorelist_head = NULL;
54 static struct mnl_socket *nl;
56 static char **iflist = NULL;
57 static size_t iflist_len = 0;
59 static const char *config_keys[] =
68 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
70 static int add_ignorelist (const char *dev, const char *type,
73 ir_ignorelist_t *entry;
75 entry = (ir_ignorelist_t *) malloc (sizeof (ir_ignorelist_t));
79 memset (entry, '\0', sizeof (ir_ignorelist_t));
81 if (strcasecmp (dev, "All") != 0)
83 entry->device = strdup (dev);
84 if (entry->device == NULL)
91 entry->type = strdup (type);
92 if (entry->type == NULL)
94 sfree (entry->device);
101 entry->inst = strdup (inst);
102 if (entry->inst == NULL)
105 sfree (entry->device);
111 entry->next = ir_ignorelist_head;
112 ir_ignorelist_head = entry;
115 } /* int add_ignorelist */
118 * Checks wether a data set should be ignored. Returns `true' is the value
119 * should be ignored, `false' otherwise.
121 static int check_ignorelist (const char *dev,
122 const char *type, const char *type_instance)
126 assert ((dev != NULL) && (type != NULL));
128 if (ir_ignorelist_head == NULL)
129 return (ir_ignorelist_invert ? 0 : 1);
131 for (i = ir_ignorelist_head; i != NULL; i = i->next)
133 /* i->device == NULL => match all devices */
134 if ((i->device != NULL)
135 && (strcasecmp (i->device, dev) != 0))
138 if (strcasecmp (i->type, type) != 0)
141 if ((i->inst != NULL) && (type_instance != NULL)
142 && (strcasecmp (i->inst, type_instance) != 0))
145 DEBUG ("netlink plugin: check_ignorelist: "
146 "(dev = %s; type = %s; inst = %s) matched "
147 "(dev = %s; type = %s; inst = %s)",
149 type_instance == NULL ? "(nil)" : type_instance,
150 i->device == NULL ? "(nil)" : i->device,
152 i->inst == NULL ? "(nil)" : i->inst);
154 return (ir_ignorelist_invert ? 0 : 1);
157 return (ir_ignorelist_invert);
158 } /* int check_ignorelist */
160 static void submit_one (const char *dev, const char *type,
161 const char *type_instance, derive_t value)
164 value_list_t vl = VALUE_LIST_INIT;
166 values[0].derive = value;
170 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
171 sstrncpy (vl.plugin, "netlink", sizeof (vl.plugin));
172 sstrncpy (vl.plugin_instance, dev, sizeof (vl.plugin_instance));
173 sstrncpy (vl.type, type, sizeof (vl.type));
175 if (type_instance != NULL)
176 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
178 plugin_dispatch_values (&vl);
179 } /* void submit_one */
181 static void submit_two (const char *dev, const char *type,
182 const char *type_instance,
183 derive_t rx, derive_t tx)
186 value_list_t vl = VALUE_LIST_INIT;
188 values[0].derive = rx;
189 values[1].derive = tx;
193 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
194 sstrncpy (vl.plugin, "netlink", sizeof (vl.plugin));
195 sstrncpy (vl.plugin_instance, dev, sizeof (vl.plugin_instance));
196 sstrncpy (vl.type, type, sizeof (vl.type));
198 if (type_instance != NULL)
199 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
201 plugin_dispatch_values (&vl);
202 } /* void submit_two */
204 static int update_iflist (struct ifinfomsg *msg, const char *dev)
206 /* Update the `iflist'. It's used to know which interfaces exist and query
207 * them later for qdiscs and classes. */
208 if ((msg->ifi_index >= 0) && ((size_t) msg->ifi_index >= iflist_len))
212 temp = (char **) realloc (iflist, (msg->ifi_index + 1) * sizeof (char *));
215 ERROR ("netlink plugin: update_iflist: realloc failed.");
219 memset (temp + iflist_len, '\0',
220 (msg->ifi_index + 1 - iflist_len) * sizeof (char *));
222 iflist_len = msg->ifi_index + 1;
224 if ((iflist[msg->ifi_index] == NULL)
225 || (strcmp (iflist[msg->ifi_index], dev) != 0))
227 sfree (iflist[msg->ifi_index]);
228 iflist[msg->ifi_index] = strdup (dev);
234 static void check_ignorelist_and_submit (const char *dev,
235 struct rtnl_link_stats *stats)
238 if (check_ignorelist (dev, "interface", NULL) == 0)
240 submit_two (dev, "if_octets", NULL, stats->rx_bytes, stats->tx_bytes);
241 submit_two (dev, "if_packets", NULL, stats->rx_packets, stats->tx_packets);
242 submit_two (dev, "if_errors", NULL, stats->rx_errors, stats->tx_errors);
246 DEBUG ("netlink plugin: Ignoring %s/interface.", dev);
249 if (check_ignorelist (dev, "if_detail", NULL) == 0)
251 submit_two (dev, "if_dropped", NULL, stats->rx_dropped, stats->tx_dropped);
252 submit_one (dev, "if_multicast", NULL, stats->multicast);
253 submit_one (dev, "if_collisions", NULL, stats->collisions);
255 submit_one (dev, "if_rx_errors", "length", stats->rx_length_errors);
256 submit_one (dev, "if_rx_errors", "over", stats->rx_over_errors);
257 submit_one (dev, "if_rx_errors", "crc", stats->rx_crc_errors);
258 submit_one (dev, "if_rx_errors", "frame", stats->rx_frame_errors);
259 submit_one (dev, "if_rx_errors", "fifo", stats->rx_fifo_errors);
260 submit_one (dev, "if_rx_errors", "missed", stats->rx_missed_errors);
262 submit_one (dev, "if_tx_errors", "aborted", stats->tx_aborted_errors);
263 submit_one (dev, "if_tx_errors", "carrier", stats->tx_carrier_errors);
264 submit_one (dev, "if_tx_errors", "fifo", stats->tx_fifo_errors);
265 submit_one (dev, "if_tx_errors", "heartbeat", stats->tx_heartbeat_errors);
266 submit_one (dev, "if_tx_errors", "window", stats->tx_window_errors);
270 DEBUG ("netlink plugin: Ignoring %s/if_detail.", dev);
275 static int link_filter_cb (const struct nlmsghdr *nlh,
276 void __attribute__((unused)) *args)
278 struct ifinfomsg *ifm = mnl_nlmsg_get_payload (nlh);
280 struct rtnl_link_stats *stats = NULL;
281 const char *dev = NULL;
283 if (nlh->nlmsg_type != RTM_NEWLINK)
285 ERROR ("netlink plugin: link_filter_cb: Don't know how to handle type %i.",
290 mnl_attr_for_each (attr, nlh, sizeof (*ifm))
292 if (mnl_attr_get_type (attr) != IFLA_IFNAME)
295 if (mnl_attr_validate (attr, MNL_TYPE_STRING) < 0)
297 ERROR ("netlink plugin: link_filter_cb: IFLA_IFNAME mnl_attr_validate failed.");
301 dev = mnl_attr_get_str (attr);
302 if (update_iflist (ifm, dev) < 0)
309 ERROR ("netlink plugin: link_filter_cb: dev == NULL");
313 mnl_attr_for_each (attr, nlh, sizeof (*ifm))
315 if (mnl_attr_get_type (attr) != IFLA_STATS)
318 if (mnl_attr_validate2 (attr, MNL_TYPE_UNSPEC, sizeof (*stats)) < 0)
320 ERROR ("netlink plugin: link_filter_cb: IFLA_STATS mnl_attr_validate2 failed.");
323 stats = mnl_attr_get_payload (attr);
325 check_ignorelist_and_submit (dev, stats);
331 DEBUG ("netlink plugin: link_filter: No statistics for interface %s.", dev);
336 } /* int link_filter_cb */
339 static int qos_attr_cb (const struct nlattr *attr, void *data)
341 struct gnet_stats_basic *bs = *(struct gnet_stats_basic **)data;
343 /* skip unsupported attribute in user-space */
344 if (mnl_attr_type_valid (attr, TCA_STATS_MAX) < 0)
347 if (mnl_attr_get_type (attr) == TCA_STATS_BASIC)
349 if (mnl_attr_validate2 (attr, MNL_TYPE_UNSPEC, sizeof (*bs)) < 0)
351 ERROR ("netlink plugin: qos_attr_cb: TCA_STATS_BASIC mnl_attr_validate2 failed.");
354 bs = mnl_attr_get_payload (attr);
362 static int qos_filter_cb (const struct nlmsghdr *nlh, void *args)
364 struct tcmsg *tm = mnl_nlmsg_get_payload (nlh);
367 int wanted_ifindex = *((int *) args);
370 const char *kind = NULL;
372 /* char *type_instance; */
374 char tc_inst[DATA_MAX_NAME_LEN];
376 int __attribute__((unused)) stats_submitted = 0;
378 if (nlh->nlmsg_type == RTM_NEWQDISC)
380 else if (nlh->nlmsg_type == RTM_NEWTCLASS)
382 else if (nlh->nlmsg_type == RTM_NEWTFILTER)
386 ERROR ("netlink plugin: qos_filter_cb: Don't know how to handle type %i.",
391 if (tm->tcm_ifindex != wanted_ifindex)
393 DEBUG ("netlink plugin: qos_filter_cb: Got %s for interface #%i, "
395 tc_type, tm->tcm_ifindex, wanted_ifindex);
399 if ((tm->tcm_ifindex >= 0)
400 && ((size_t) tm->tcm_ifindex >= iflist_len))
402 ERROR ("netlink plugin: qos_filter_cb: tm->tcm_ifindex = %i "
403 ">= iflist_len = %zu",
404 tm->tcm_ifindex, iflist_len);
408 dev = iflist[tm->tcm_ifindex];
411 ERROR ("netlink plugin: qos_filter_cb: iflist[%i] == NULL",
416 mnl_attr_for_each (attr, nlh, sizeof (*tm))
418 if (mnl_attr_get_type (attr) != TCA_KIND)
421 if (mnl_attr_validate (attr, MNL_TYPE_STRING) < 0)
423 ERROR ("netlink plugin: qos_filter_cb: TCA_KIND mnl_attr_validate failed.");
427 kind = mnl_attr_get_str (attr);
433 ERROR ("netlink plugin: qos_filter_cb: kind == NULL");
438 uint32_t numberic_id;
440 numberic_id = tm->tcm_handle;
441 if (strcmp (tc_type, "filter") == 0)
442 numberic_id = tm->tcm_parent;
444 ssnprintf (tc_inst, sizeof (tc_inst), "%s-%x:%x",
447 numberic_id & 0x0000FFFF);
450 DEBUG ("netlink plugin: qos_filter_cb: got %s for %s (%i).",
451 tc_type, dev, tm->tcm_ifindex);
453 if (check_ignorelist (dev, tc_type, tc_inst))
457 mnl_attr_for_each (attr, nlh, sizeof (*tm))
459 struct gnet_stats_basic *bs = NULL;
461 if (mnl_attr_get_type (attr) != TCA_STATS2)
464 if (mnl_attr_validate (attr, MNL_TYPE_NESTED) < 0)
466 ERROR ("netlink plugin: qos_filter_cb: TCA_STATS2 mnl_attr_validate failed.");
470 mnl_attr_parse_nested (attr, qos_attr_cb, &bs);
474 char type_instance[DATA_MAX_NAME_LEN];
478 ssnprintf (type_instance, sizeof (type_instance), "%s-%s",
481 submit_one (dev, "ipt_bytes", type_instance, bs->bytes);
482 submit_one (dev, "ipt_packets", type_instance, bs->packets);
487 #endif /* TCA_STATS2 */
490 mnl_attr_for_each (attr, nlh, sizeof (*tm))
492 struct tc_stats *ts = NULL;
494 if (mnl_attr_get_type (attr) != TCA_STATS)
497 if (mnl_attr_validate2 (attr, MNL_TYPE_UNSPEC, sizeof (*ts)) < 0)
499 ERROR ("netlink plugin: qos_filter_cb: TCA_STATS mnl_attr_validate2 failed.");
502 ts = mnl_attr_get_payload (attr);
504 if (!stats_submitted && ts != NULL)
506 char type_instance[DATA_MAX_NAME_LEN];
508 ssnprintf (type_instance, sizeof (type_instance), "%s-%s",
511 submit_one (dev, "ipt_bytes", type_instance, ts->bytes);
512 submit_one (dev, "ipt_packets", type_instance, ts->packets);
518 #endif /* TCA_STATS */
520 #if !(HAVE_TCA_STATS && HAVE_TCA_STATS2)
521 DEBUG ("netlink plugin: qos_filter_cb: Have neither TCA_STATS2 nor "
526 } /* int qos_filter_cb */
528 static int ir_config (const char *key, const char *value)
535 new_val = strdup (value);
539 fields_num = strsplit (new_val, fields, STATIC_ARRAY_SIZE (fields));
540 if ((fields_num < 1) || (fields_num > 8))
546 if ((strcasecmp (key, "Interface") == 0)
547 || (strcasecmp (key, "VerboseInterface") == 0))
551 ERROR ("netlink plugin: Invalid number of fields for option "
552 "`%s'. Got %i, expected 1.", key, fields_num);
557 add_ignorelist (fields[0], "interface", NULL);
558 if (strcasecmp (key, "VerboseInterface") == 0)
559 add_ignorelist (fields[0], "if_detail", NULL);
563 else if ((strcasecmp (key, "QDisc") == 0)
564 || (strcasecmp (key, "Class") == 0)
565 || (strcasecmp (key, "Filter") == 0))
567 if ((fields_num < 1) || (fields_num > 2))
569 ERROR ("netlink plugin: Invalid number of fields for option "
570 "`%s'. Got %i, expected 1 or 2.", key, fields_num);
575 add_ignorelist (fields[0], key,
576 (fields_num == 2) ? fields[1] : NULL);
580 else if (strcasecmp (key, "IgnoreSelected") == 0)
584 ERROR ("netlink plugin: Invalid number of fields for option "
585 "`IgnoreSelected'. Got %i, expected 1.", fields_num);
590 if (IS_TRUE (fields[0]))
591 ir_ignorelist_invert = 0;
593 ir_ignorelist_invert = 1;
601 } /* int ir_config */
603 static int ir_init (void)
605 nl = mnl_socket_open (NETLINK_ROUTE);
608 ERROR ("netlink plugin: ir_init: mnl_socket_open failed.");
612 if (mnl_socket_bind (nl, 0, MNL_SOCKET_AUTOPID) < 0)
614 ERROR ("netlink plugin: ir_init: mnl_socket_bind failed.");
621 static int ir_read (void)
623 char buf[MNL_SOCKET_BUFFER_SIZE];
624 struct nlmsghdr *nlh;
627 unsigned int seq, portid;
631 static const int type_id[] = { RTM_GETQDISC, RTM_GETTCLASS, RTM_GETTFILTER };
632 static const char *type_name[] = { "qdisc", "class", "filter" };
634 portid = mnl_socket_get_portid (nl);
636 nlh = mnl_nlmsg_put_header (buf);
637 nlh->nlmsg_type = RTM_GETLINK;
638 nlh->nlmsg_flags = NLM_F_REQUEST | NLM_F_DUMP;
639 nlh->nlmsg_seq = seq = time (NULL);
640 rt = mnl_nlmsg_put_extra_header (nlh, sizeof (*rt));
641 rt->rtgen_family = AF_PACKET;
643 if (mnl_socket_sendto (nl, nlh, nlh->nlmsg_len) < 0)
645 ERROR ("netlink plugin: ir_read: rtnl_wilddump_request failed.");
649 ret = mnl_socket_recvfrom (nl, buf, sizeof (buf));
652 ret = mnl_cb_run (buf, ret, seq, portid, link_filter_cb, NULL);
653 if (ret <= MNL_CB_STOP)
655 ret = mnl_socket_recvfrom (nl, buf, sizeof (buf));
659 ERROR ("netlink plugin: ir_read: mnl_socket_recvfrom failed.");
663 /* `link_filter_cb' will update `iflist' which is used here to iterate
664 * over all interfaces. */
665 for (ifindex = 1; ifindex < iflist_len; ifindex++)
670 if (iflist[ifindex] == NULL)
673 for (type_index = 0; type_index < STATIC_ARRAY_SIZE (type_id); type_index++)
675 if (check_ignorelist (iflist[ifindex], type_name[type_index], NULL))
677 DEBUG ("netlink plugin: ir_read: check_ignorelist (%s, %s, (nil)) "
678 "== TRUE", iflist[ifindex], type_name[type_index]);
682 DEBUG ("netlink plugin: ir_read: querying %s from %s (%lu).",
683 type_name[type_index], iflist[ifindex], ifindex);
685 nlh = mnl_nlmsg_put_header (buf);
686 nlh->nlmsg_type = type_id[type_index];
687 nlh->nlmsg_flags = NLM_F_REQUEST | NLM_F_DUMP;
688 nlh->nlmsg_seq = seq = time (NULL);
689 tm = mnl_nlmsg_put_extra_header (nlh, sizeof (*tm));
690 tm->tcm_family = AF_PACKET;
691 tm->tcm_ifindex = ifindex;
693 if (mnl_socket_sendto (nl, nlh, nlh->nlmsg_len) < 0)
695 ERROR ("netlink plugin: ir_read: mnl_socket_sendto failed.");
699 ret = mnl_socket_recvfrom (nl, buf, sizeof (buf));
702 ret = mnl_cb_run (buf, ret, seq, portid, qos_filter_cb, &ifindex);
703 if (ret <= MNL_CB_STOP)
705 ret = mnl_socket_recvfrom (nl, buf, sizeof (buf));
709 ERROR ("netlink plugin: ir_read:mnl_socket_recvfrom failed.");
713 } /* for (type_index) */
714 } /* for (if_index) */
719 static int ir_shutdown (void)
723 mnl_socket_close (nl);
728 } /* int ir_shutdown */
730 void module_register (void)
732 plugin_register_config ("netlink", ir_config, config_keys, config_keys_num);
733 plugin_register_init ("netlink", ir_init);
734 plugin_register_read ("netlink", ir_read);
735 plugin_register_shutdown ("netlink", ir_shutdown);
736 } /* void module_register */
739 * vim: set shiftwidth=2 softtabstop=2 tabstop=8 :